Whether CSS IDs should be added to the code

Flag to decide if multi line spans are allowed. Set it to false to make sure each tag is closed before and reopened after each linefeed.

The style for the actual code

Whether important blocks should be recognised or not

Deprecated.

Todo:

REMOVE THIS FUNCTIONALITY!

The encoding to use for entity encoding NOTE: Used with Escape Char Sequences to fix UTF-8 handling (cf. SF#2037598)

The error message associated with an error

Todo:

check err reporting works

Possible error messages

The content of the footer block

The style of the footer block

Tells if a block around the highlighted source should be forced if not using line numbering

The content of the header block

The style of the header block

The type of header to use. Can be one of the following values:

- GESHI_HEADER_PRE: Source is outputted in a "pre" HTML element. - GESHI_HEADER_DIV: Source is outputted in a "div" HTML element. - GESHI_HEADER_NONE: No header is outputted.

Lines that should be highlighted extra

Styles of extra-highlighted lines

Styles of lines that should be highlighted extra

Styles for important parts of the code

Deprecated.

Todo:

As above - rethink the whole idea of important blocks as it is buggy and will be hard to implement in 1.2

Should keywords be linked?

The language to use when highlighting

The data for the language used

The path to the language files

Array of permissions for which lexics should be highlighted

The line ending If null, nl2br() will be used on the result string. Otherwise, all instances of \n will be replaced with $line_ending

The "nth" value for fancy line highlighting

Flag for how line numbers are displayed

Number at which line numbers should start at

Line number styles

Line number styles for fancy lines

The styles for hyperlinks in the code

Default target for keyword links

Currently loaded language file

Since:

1.0.7.22

The overall class for this code block

The overall ID for this code block

The overall style for this code block

Wether the caches needed for parsing are built or not

Since:

1.0.8

Whether highlighting is strict or not

The size of tab stops

Style for line numbers when GESHI_HEADER_PRE_TABLE is chosen

The time it took to parse the code

Whether to use CSS classes in output

Should we use language-defined tab stop widths?

Creates a new GeSHi object, with source and language

Parameters:

The - source code to highlight

The - language to highlight the source with

The - path to the language file directory. This is deprecated! I've backported the auto path detection from the 1.1.X dev branch, so now it should be automatically set correctly. If you have renamed the language directory however, you will still need to set the path using this parameter or {@link GeSHi->set_language_path()}

Since:

1.0.0

Adds a keyword to a keyword group for highlighting

Parameters:

The - key of the keyword group to add the keyword to

The - word to add to the keyword group

Since:

1.0.0

Creates a new keyword group

Parameters:

The - key of the keyword group to create

The - styles for the keyword group

Whether - the keyword group is case sensitive ornot

The - words to use for the keyword group

Since:

1.0.0

Disables all highlighting

Since:

1.0.0

Todo:

Rewrite with array traversal

Deprecated:

In favour of enable_highlighting

Sets whether CSS classes should be used to highlight the source. Default is off, calling this method with no arguments will turn it on

Parameters:

Whether - to turn classes on or not

Since:

1.0.0

Enables all highlighting

The optional flag parameter was added in version 1.0.7.21 and can be used to enable (true) or disable (false) all highlighting.

Since:

1.0.0

Parameters:

A - flag specifying whether to enable or disable all highlighting

Todo:

Rewrite with array traversal

Whether CSS IDs should be added to each line

Parameters:

If - true, IDs will be added to each line.

Since:

1.0.2

Sets whether context-important blocks are highlighted

Parameters:

Tells - whether to enable or disable highlighting of important blocks

Todo:

REMOVE THIS SHIZ FROM GESHI!

Deprecated.

Since:

1.0.2

Sets whether to force a surrounding block around the highlighted code or not

Parameters:

Tells - whether to enable or disable this feature

Since:

1.0.7.20

Turns linking of keywords on or off.

Parameters:

If - true, links will be added to keywords

Since:

1.0.2

Sets whether line numbers should be displayed.

Valid values for the first parameter are:

- GESHI_NO_LINE_NUMBERS: Line numbers will not be displayed - GESHI_NORMAL_LINE_NUMBERS: Line numbers will be displayed - GESHI_FANCY_LINE_NUMBERS: Fancy line numbers will be displayed

For fancy line numbers, the second parameter is used to signal which lines are to be fancy. For example, if the value of this parameter is 5 then every 5th line will be fancy.

Parameters:

How - line numbers should be displayed

Defines - which lines are fancy

Since:

1.0.0

Sets wether spans and other HTML markup generated by GeSHi can span over multiple lines or not. Defaults to true to reduce overhead. Set it to false if you want to manipulate the output or manually display the code in an ordered list.

Parameters:

Wether - multiline spans are allowed or not

Since:

1.0.7.22

Enables/disables strict highlighting. Default is off, calling this method without parameters will turn it on. See documentation for more details on strict mode and where to use it.

Parameters:

Whether - to enable strict mode or not

Since:

1.0.0

Returns an error message associated with the last GeSHi operation, or false if no error has occured

Returns:

An error message if there has been an error, else false

Since:

1.0.0

Gets a human-readable language name (thanks to Simon Patterson for the idea :))

Returns:

The name for the current language

Since:

1.0.2

Given a file extension, this method returns either a valid geshi language name, or the empty string if it couldn't be found

Parameters:

The - extension to get a language name for

A - lookup array to use instead of the default one

Since:

1.0.5

Todo:

Re-think about how this method works (maybe make it private and/or make it a extension->lang lookup?)

static?

Get current setting for multiline spans, see GeSHi->enable_multiline_span().

See Also:

enable_multiline_span

Returns the tab width to use, based on the current language and user preference

Returns:

Tab width

Since:

1.0.7.20

Returns a stylesheet for the highlighted code. If $economy mode is true, we only return the stylesheet declarations that matter for this code block instead of the whole thing

Parameters:

Whether - to use economy mode or not

Returns:

A stylesheet built on the data for the current language

Since:

1.0.0

Gets the time taken to parse the code

Returns:

The time taken to parse the code

Since:

1.0.2

Specifies which lines to highlight extra

The extra style parameter was added in 1.0.7.21.

Parameters:

An - array of line numbers to highlight, or just a line number on its own.

A - string specifying the style to use for this line. If null is specified, the default style is used. If false is specified, the line will be removed from special highlighting

Since:

1.0.2

Todo:

Some data replication here that could be cut down on

Given a file name, this method loads its contents in, and attempts to set the language automatically. An optional lookup table can be passed for looking up the language name. If not specified a default table is used

The language table is in the form

array(
'lang_name' => array('extension', 'extension', ...),
'lang_name' ...
);

Parameters:

The - filename to load the source from

A - lookup array to use instead of the default one

Todo:

Complete rethink of this and above method

Since:

1.0.5

compile optimized regexp list for keyword group

Parameters:

The - key of the keyword group to compile & optimize

Since:

1.0.8

Returns the code in $this->source, highlighted and surrounded by the nessecary HTML.

This should only be called ONCE, cos it's SLOW! If you want to highlight the same source multiple times, you're better off doing a whole lot of str_replaces to replace the <span>s

Since:

1.0.0

Removes a keyword from a keyword group

Parameters:

The - key of the keyword group to remove the keyword from

The - word to remove from the keyword group

Wether - to automatically recompile the optimized regexp list or not. Note: if you set this to false and @see GeSHi->parse_code() was already called once, for the current language, you have to manually call @see GeSHi->optimize_keyword_group() or the removed keyword will stay in cache and still be highlighted! On the other hand it might be too expensive to recompile the regexp list for every removal if you want to remove a lot of keywords.

Since:

1.0.0

Removes a keyword group

Parameters:

The - key of the keyword group to remove

Since:

1.0.0

Turns highlighting on/off for brackets

This method is DEPRECATED: use set_symbols_highlighting instead. This method will be remove in 1.2.X

Parameters:

Whether - to turn highlighting for brackets on or off

Since:

1.0.0

Deprecated:

In favour of set_symbols_highlighting

Sets the styles for brackets. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority

This method is DEPRECATED: use set_symbols_style instead. This method will be removed in 1.2.X

Parameters:

The - style to make the brackets

Whether - to merge the new styles with the old or just to overwrite them

Since:

1.0.0

Deprecated:

In favour of set_symbols_style

Sets the case that keywords should use when found. Use the constants:

- GESHI_CAPS_NO_CHANGE: leave keywords as-is - GESHI_CAPS_UPPER: convert all keywords to uppercase where found - GESHI_CAPS_LOWER: convert all keywords to lowercase where found

Parameters:

A - constant specifying what to do with matched keywords

Since:

1.0.1

Sets whether a set of keywords are checked for in a case sensitive manner

Parameters:

The - key of the keyword group to change the case sensitivity of

Whether - to check in a case sensitive manner or not

Since:

1.0.0

Sets the style for the actual code. This should be a string containing valid stylesheet declarations. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority

Note: Use this method to override any style changes you made to the line numbers if you are using line numbers, else the line of code will have the same style as the line number! Consult the GeSHi documentation for more information about this.

Parameters:

The - style to use for actual code

Whether - to merge the current styles with the new styles

Since:

1.0.2

Turns highlighting on/off for comment groups

Parameters:

The - key of the comment group to turn on or off

Whether - to turn highlighting for that group on or off

Since:

1.0.0

Sets the styles for comment groups. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority

Parameters:

The - key of the comment group to change the styles of

The - style to make the comments

Whether - to merge the new styles with the old or just to overwrite them

Since:

1.0.0

Sets the encoding used for htmlspecialchars(), for international support.

NOTE: This is not needed for now because htmlspecialchars() is not being used (it has a security hole in PHP4 that has not been patched). Maybe in a future version it may make a return for speed reasons, but I doubt it.

Parameters:

The - encoding to use for the source

Since:

1.0.3

Turns highlighting on/off for escaped characters

Parameters:

Whether - to turn highlighting for escape characters on or off

Since:

1.0.0

Sets the styles for escaped characters. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority

Parameters:

The - style to make the escape characters

Whether - to merge the new styles with the old or just to overwrite them

Since:

1.0.0

Sets the content of the footer block

Parameters:

The - content of the footer block

Since:

1.0.2

Sets the style for the footer content

Parameters:

The - style for the footer content

Since:

1.0.2

Sets the content of the header block

Parameters:

The - content of the header block

Since:

1.0.2

Sets the style for the header content

Parameters:

The - style for the header content

Since:

1.0.2

Sets the type of header to be used.

If GESHI_HEADER_DIV is used, the code is surrounded in a "div".This means more source code but more control over tab width and line-wrapping. GESHI_HEADER_PRE means that a "pre" is used - less source, but less control. Default is GESHI_HEADER_PRE.

From 1.0.7.2, you can use GESHI_HEADER_NONE to specify that no header code should be outputted.

Parameters:

The - type of header to be used

Since:

1.0.0

Sets the style for extra-highlighted lines

Parameters:

The - style for extra-highlighted lines

Since:

1.0.2

Sets styles for important parts of the code

Parameters:

The - styles to use on important parts of the code

Since:

1.0.2

Turns highlighting on/off for a keyword group

Parameters:

The - key of the keyword group to turn on or off

Whether - to turn highlighting for that group on or off

Since:

1.0.0

Sets the style for a keyword group. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority

Parameters:

The - key of the keyword group to change the styles of

The - style to make the keywords

Whether - to merge the new styles with the old or just to overwrite them

Since:

1.0.0

Sets the language for this object

Note:

since 1.0.8 this function won't reset language-settings by default anymore! if you need this set $force_reset = true

Parameters:

The - name of the language to use

Since:

1.0.0

Sets the path to the directory containing the language files. Note that this path is relative to the directory of the script that included geshi.php, NOT geshi.php itself.

Parameters:

The - path to the language directory

Since:

1.0.0

Deprecated:

The path to the language files should now be automatically detected, so this method should no longer be needed. The 1.1.X branch handles manual setting of the path differently so this method will disappear in 1.2.0.

Sets the line-ending

Parameters:

The - new line-ending

Since:

1.0.2

Sets the styles for the line numbers.

Parameters:

The - style for the line numbers that are "normal"

If - a string, this is the style of the line numbers that are "fancy", otherwise if boolean then this defines whether the normal styles should be merged with the new normal styles or not

If - set, is the flag for whether to merge the "fancy" styles with the current styles or not

Since:

1.0.2

Sets styles for links in code

Parameters:

A - constant that specifies what state the style is being set for - e.g. :hover or :visited

The - styles to use for that state

Since:

1.0.2

Sets the target for links in code

Parameters:

The - target for links in the code, e.g. _blank

Since:

1.0.3

Turns highlighting on/off for methods

Parameters:

Whether - to turn highlighting for methods on or off

Since:

1.0.0

Sets the styles for methods. $key is a number that references the appropriate "object splitter" - see the language file for the language you are highlighting to get this number. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority

Parameters:

The - key of the object splitter to change the styles of

The - style to make the methods

Whether - to merge the new styles with the old or just to overwrite them

Since:

1.0.0

Turns highlighting on/off for numbers

Parameters:

Whether - to turn highlighting for numbers on or off

Since:

1.0.0

Sets the styles for numbers. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority

Parameters:

The - style to make the numbers

Whether - to merge the new styles with the old or just to overwrite them

Since:

1.0.0

Sets the overall classname for this block of code. This class can then be used in a stylesheet to style this object's output

Parameters:

The - class name to use for this block of code

Since:

1.0.0

Sets the overall id for this block of code. This id can then be used in a stylesheet to style this object's output

Parameters:

The - ID to use for this block of code

Since:

1.0.0

Sets the styles for the code that will be outputted when this object is parsed. The style should be a string of valid stylesheet declarations

Parameters:

The - overall style for the outputted code block

Whether - to merge the styles with the current styles or not

Since:

1.0.0

Turns highlighting on/off for regexps

Parameters:

The - key of the regular expression group to turn on or off

Whether - to turn highlighting for the regular expression group on or off

Since:

1.0.0

Sets the styles for regexps. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority

Parameters:

The - style to make the regular expression matches

Whether - to merge the new styles with the old or just to overwrite them

Since:

1.0.0

Sets the source code for this object

Parameters:

The - source code to highlight

Since:

1.0.0

Turns highlighting on/off for strings

Parameters:

Whether - to turn highlighting for strings on or off

Since:

1.0.0

Sets the styles for strings. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority

Parameters:

The - style to make the escape characters

Whether - to merge the new styles with the old or just to overwrite them

Since:

1.0.0

Turns highlighting on/off for symbols

Parameters:

Whether - to turn highlighting for symbols on or off

Since:

1.0.0

Sets the styles for symbols. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority

Parameters:

The - style to make the symbols

Whether - to merge the new styles with the old or just to overwrite them

Tells - the group of symbols for which style should be set.

Since:

1.0.1

Sets how many spaces a tab is substituted for

Widths below zero are ignored

Parameters:

The - tab width

Since:

1.0.0

Sets the base URL to be used for keywords

Parameters:

The - key of the keyword group to set the URL for

The - URL to set for the group. If {FNAME} is in the url somewhere, it is replaced by the keyword that the URL is being made for

Since:

1.0.2

Sets whether or not to use tab-stop width specifed by language

Parameters:

Whether - to use language-specific tab-stop widths

Since:

1.0.7.20

Sets what number line numbers should start at. Should be a positive integer, and will be converted to one.

Warning: Using this method will add the "start" attribute to the <ol> that is used for line numbering. This is not valid XHTML strict, so if that's what you care about then don't use this method. Firefox is getting support for the CSS method of doing this in 1.1 and Opera has support for the CSS method, but (of course) IE doesn't so it's not worth doing it the CSS way yet.

Parameters:

The - number to start line numbers at

Since:

1.0.2