HFile Class Reference

Inheritance diagram for HFile:

Collaboration diagram for HFile:

Public Member Functions
	__construct ()
	parse_file ($file)
	to_perl ($stub, $tofile=1)
	to_php ($stub, $tofile=1)
	_get_categories ()
	_dump_linkscripts ()
	_dump_perl_linkscripts ()
	_dump_perl_defaultscripts ()
	_dump_colours ()
	_dump_var ($variable, $name)
	_dump_array ($array, $name)
	_dump_perl_array ($array, $name)
	_dump_hash ($hash, $name)
	_dump_perl_hash ($hash, $name)

Detailed Description

Definition at line 21 of file HFile.php.

Constructor & Destructor Documentation

__construct()

HFile::__construct

(

)

Definition at line 24 of file HFile.php.

References array.

        {
                # Language name.
                $this->lang_name                        = "";
                # Language configuration hashtable.
                $this->indent_depth                     = 8;
                 
                $this->config                           = array();
                $color                                  = 0;
                $parsing                                = "";
                $this->validkeys                        = array();
                
                $this->indent                           = array();
                $this->unindent                         = array();
                $this->blockcommenton                   = array();
                $this->blockcommentoff                  = array();
                $this->linecommenton                    = array();
                $this->preprocessors                    = array();
                
                # Zoning
                $this->zones                            = array();
                
                # Hashtable of keywords - maps from keyword to colour.
                $this->keywords                         = array();
                
                # Used for conversion from keyword -> regexp.
                $this->keypats                          = array();
                
                # Which colours to use for each 'level'.
                $this->colours                          = array("blue", "purple", "gray", "brown", "blue", "purple", "gray", "brown");
                $this->quotecolour                      = "blue";
                $this->blockcommentcolour               = "green";
                $this->linecommentcolour                = "green";
                $this->stringchars                      = array();
                $this->delimiters                       = array();
                $this->escchar                          = "\\";
                
                # Caches for the harvesters.
                $this->comcache                         = "";
                $this->stringcache                      = "";
                
                # Toggles
                $this->perl                             = 0;
                $this->notrim                           = 0;
                $this->nocase                           = 0;
        }

Member Function Documentation

_dump_array()

HFile::_dump_array	(		$array,
			$name
	)

Definition at line 232 of file HFile.php.

Referenced by _dump_colours(), and to_php().

        {
                $first = 1;
                print $name."   = array(";
                foreach($array as $a)
                {
                        if (!$first) print ", "; else $first = 0;
                        print "\"".addslashes($a)."\"";
                }
                print ");\n";
        }

Here is the caller graph for this function:

_dump_colours()

HFile::_dump_colours

(

)

Definition at line 217 of file HFile.php.

References _dump_array(), and array.

Referenced by to_php().

        {
                $usedcols = array();
                foreach($this->used_categories as $c)
                {
                        array_push($usedcols, $this->colours[$c-1]);
                }
                $this->_dump_array($usedcols, "\$this->colours        ");
        }

Here is the call graph for this function:

Here is the caller graph for this function:

_dump_hash()

HFile::_dump_hash	(		$hash,
			$name
	)

Definition at line 256 of file HFile.php.

Referenced by _dump_linkscripts(), and to_php().

        {
                $first = 1;
                print $name."   = array(";
                foreach(array_keys($hash) as $k)
                {
                        if (!$first) print ", "; else $first = 0;
                        print "\n                       \"".addslashes($k)."\"";
                        print " => \"".addslashes($hash[$k])."\"";
                }
                print ");\n";
        }

Here is the caller graph for this function:

_dump_linkscripts()

HFile::_dump_linkscripts

(

)

Definition at line 177 of file HFile.php.

References _dump_hash(), and array.

Referenced by to_php().

        {
                print "
# Each category can specify a PHP function that takes in the function name, and returns a string
# to put in its place. This can be used to generate links, images, etc.\n\n";
                
                $linkhash = array();
                
                foreach($this->used_categories as $c)
                {
                        $linkhash{$c} = "donothing";
                }
                
                $this->_dump_hash($linkhash, "\$this->linkscripts    ");
                print "}\n";
                print "\n# DoNothing link function\n\n";
                print "function donothing(\$keywordin)\n{\n     return \$keywordin;\n}\n";
        }

Here is the call graph for this function:

Here is the caller graph for this function:

_dump_perl_array()

HFile::_dump_perl_array	(		$array,
			$name
	)

Definition at line 244 of file HFile.php.

Referenced by to_perl().

        {
                $first = 1;
                print $name."   = [";
                foreach($array as $a)
                {
                        if (!$first) print ", "; else $first = 0;
                        print "\"".addslashes($a)."\"";
                }
                print "];\n";
        }

Here is the caller graph for this function:

_dump_perl_defaultscripts()

HFile::_dump_perl_defaultscripts

(

)

Definition at line 211 of file HFile.php.

Referenced by to_perl().

        {
                print "\n# DoNothing link function\n\n";
                print "sub donothing\n{\nmy ( \$self ) = @_;\nreturn;\n}\n";
        }

Here is the caller graph for this function:

_dump_perl_hash()

HFile::_dump_perl_hash	(		$hash,
			$name
	)

Definition at line 269 of file HFile.php.

Referenced by _dump_perl_linkscripts(), and to_perl().

        {
                $first = 1;
                print $name."   = {";
                foreach(array_keys($hash) as $k)
                {
                        if (!$first) print ", "; else $first = 0;
                        print "\n                       \"".addslashes($k)."\"";
                        print " => \"".addslashes($hash[$k])."\"";
                }
                print "};\n";
        }

Here is the caller graph for this function:

_dump_perl_linkscripts()

HFile::_dump_perl_linkscripts

(

)

Definition at line 196 of file HFile.php.

References _dump_perl_hash(), and array.

Referenced by to_perl().

        {
                print "
# Each category can specify a Perl function that takes in the function name, and returns a string
# to put in its place. This can be used to generate links, images, etc.\n\n";

                $linkhash = array();
                foreach($this->used_categories as $c)
                {
                        $linkhash{$c} = "donothing";
                }

                $this->_dump_perl_hash($linkhash, "\$self->{linkscripts}        ");
        }

Here is the call graph for this function:

Here is the caller graph for this function:

_dump_var()

HFile::_dump_var	(		$variable,
			$name
	)

Definition at line 227 of file HFile.php.

Referenced by to_perl(), and to_php().

        {
                print $name."   = \"".addslashes($variable)."\";\n";
        }

Here is the caller graph for this function:

_get_categories()

HFile::_get_categories

(

)

Definition at line 165 of file HFile.php.

References array.

Referenced by to_perl(), and to_php().

        {
                $usedcats = array();
                
                foreach(array_keys($this->keywords) as $k)
                {
                        $cat = $this->keywords[$k];
                        if (!in_array($cat, $usedcats)) array_push($usedcats, $cat);
                }
                return $usedcats;
        }

Here is the caller graph for this function:

parse_file()

HFile::parse_file

(

$file

)

Definition at line 71 of file HFile.php.

        {
                print "This method should not be called from here, but from an extending configuration class.<br>";
        }

to_perl()

HFile::to_perl	(		$stub,
			$tofile = 1
	)

Definition at line 76 of file HFile.php.

References _dump_perl_array(), _dump_perl_defaultscripts(), _dump_perl_hash(), _dump_perl_linkscripts(), _dump_var(), and _get_categories().

        {
                $this->used_categories = $this->_get_categories();
                print "
package HFile::$stub;

###############################
#
# Beautifier Perl HFile
# Language: $stub
#
###############################

use Beautifier::HFile;
@ISA = qw(HFile);
sub new
{
        my( \$class ) = @_;
        my \$self = {};
        bless \$self, \$class;

        # Flags:
";
                $this->_dump_var($this->nocase,                         "       \$self->{nocase}         ");
                $this->_dump_var($this->notrim,                         "       \$self->{notrim}         ");
                $this->_dump_var($this->perl,                           "       \$self->{perl}           ");
                $this->_dump_perl_array($this->indent,                  "       \$self->{indent}         ");
                $this->_dump_perl_array($this->unindent,                "       \$self->{unindent}       ");
                $this->_dump_perl_array($this->stringchars,             "       \$self->{stringchars}    ");
                $this->_dump_perl_array($this->delimiters,              "       \$self->{delimiters}     ");
                $this->_dump_var($this->escchar,                        "       \$self->{escchar}        ");
                $this->_dump_perl_array($this->linecommenton,           "       \$self->{linecommenton}  ");
                $this->_dump_perl_array($this->blockcommenton,          "       \$self->{blockcommenton} ");
                $this->_dump_perl_array($this->blockcommentoff,         "       \$self->{blockcommentoff}");
                $this->_dump_perl_hash($this->keywords,                 "       \$self->{keywords}       ");                    
                $this->_dump_perl_linkscripts();        
print "
        return \$self;
}

";

                $this->_dump_perl_defaultscripts();
print "1;\n";
        }

Here is the call graph for this function:

to_php()

HFile::to_php	(		$stub,
			$tofile = 1
	)

Definition at line 122 of file HFile.php.

References _dump_array(), _dump_colours(), _dump_hash(), _dump_linkscripts(), _dump_var(), and _get_categories().

        {
        
                
                $this->used_categories = $this->_get_categories();
                
                if ($tofile) print "<?php\n"; else print "&lt;?\n";
                print "require_once('psh.php');\n";
                print "class psh_$stub extends psh\n{\n";
                print "function psh_$stub(){\n";
                print "\$this->psh();\n";
                print "######################################\n";
                print "# Beautifier Highlighting Configuration File \n";
                print "# $this->lang_name\n";
                print "######################################\n";
                print "# Flags\n\n";
                $this->_dump_var($this->nocase,                         "\$this->nocase            ");
                $this->_dump_var($this->notrim,                         "\$this->notrim            ");
                $this->_dump_var($this->perl,                           "\$this->perl              ");
                print "\n# Colours\n\n";
                $this->_dump_colours(); 
                $this->_dump_var("blue",                                "\$this->quotecolour       ");
                $this->_dump_var("green",                               "\$this->blockcommentcolour");
                $this->_dump_var("green",                               "\$this->linecommentcolour ");
                print "\n# Indent Strings\n\n"; 
                $this->_dump_array($this->indent,                       "\$this->indent            ");
                $this->_dump_array($this->unindent,                     "\$this->unindent          ");
                print "\n# String characters and delimiters\n\n";
                $this->_dump_array($this->stringchars,                  "\$this->stringchars       ");
                $this->_dump_array($this->delimiters,                   "\$this->delimiters        ");
                $this->_dump_var  ($this->escchar,                      "\$this->escchar           ");
                print "\n# Comment settings\n\n";
                $this->_dump_array($this->linecommenton,                "\$this->linecommenton     ");
                $this->_dump_var  ($this->blockcommenton,               "\$this->blockcommenton    ");
                $this->_dump_var  ($this->blockcommentoff,              "\$this->blockcommentoff   ");
                print "\n# Keywords (keyword mapping to colour number)\n\n";
                $this->_dump_hash ($this->keywords,                     "\$this->keywords          ");
                print "\n# Special extensions\n";
                $this->_dump_linkscripts();
                print "}\n";
                if ($tofile) print "\n?>"; else print "\n?&gt;";
        }

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• Services/COPage/syntax_highlight/php/Beautifier/HFile.php