GeSHi - Generic Syntax Highlighter
The GeSHi class for Generic Syntax Highlighting. Please refer to the documentation at http://qbnz.com/highlighter/documentation.php for more information about how to use this class.
For changes, release notes, TODOs etc, see the relevant files in the docs/ directory.
This file is part of GeSHi.
GeSHi is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
GeSHi is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with GeSHi; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Class | Description |
---|---|
GeSHi | The GeSHi Class. |
Links in the source in the :active state
The key of the regex array defining what bracket group in a
Strict mode always applies
The key of the regex array defining what bracket group in a
Leave keywords found as the case that they are
Lowercase keywords found
Uppercase keywords found
The key of the regex array defining a custom keyword to use
Used in language files to mark comments
The ender for important parts of the source
GeSHi could not open a file for reading (generally a language file)
The header type passed to GeSHi->set_header_type() was invalid
The line number type passed to GeSHi->enable_line_numbers() was invalid
No sourcecode to highlight was specified
The language specified does not exist
Use fancy line numbers when building the result
Use a "div" to surround the source
Use nothing to surround the source
Use a "pre" to surround the source
Use a "table" to surround the source:
<table> <thead><tr><td colspan="2">$header</td></tr></thead> <tbody><tr><td>
$linenumbers</td><td>
$code></td></tr></tbody> <tfooter><tr><td colspan="2">$footer</td></tr></tfoot> </table>
this is essentially only a workaround for Firefox, see sf#1651996 or take a look at https://bugzilla.mozilla.org/show_bug.cgi?id=365805
Use a pre to wrap lines when line numbers are enabled or to wrap the whole code.
Links in the source in the :hover state
The language file directory for GeSHi
Links in the source in the :link state
it's also important not to generate too long regular expressions
some old PHP / PCRE subpatterns only support up to xxx subpatterns in
Strict mode *might* apply, and can be enabled or
The key of the regex array defining any modifiers to the regular expression
Strict mode never applies (this is the most common)
Use normal line numbers when building the result
Use no line numbers when building the result
Number format to highlight binary numbers with a prefix 0b (C)
Number format to highlight binary numbers with a prefix %
Number format to highlight binary numbers with a suffix "b"
Number format to highlight floating-point numbers without support for scientific notation
Number format to highlight floating-point numbers without support for scientific notation
Number format to highlight floating-point numbers with support for scientific notation (E) and optional leading zero
Number format to highlight floating-point numbers with support for scientific notation (E) and required leading digit
Number format to highlight hex numbers with a prefix 0x
Number format to highlight hex numbers with a prefix $
Number format to highlight hex numbers with a suffix of h
Basic number format for integers
Enhanced number format for integers like seen in C
Number format to highlight octal numbers with a leading zero
Number format to highlight octal numbers with a prefix 0o (logtalk)
Number format to highlight octal numbers with a leading @ (Used in HiSofts Devpac series).
Number format to highlight octal numbers with a suffix of o
Used to work around missing PHP features *
The key of the regex array defining what bracket group in a
The root directory for GeSHi
The key of the regex array defining what to search for
Tells GeSHi to be paranoid about security settings
The starter for important parts of the source
The version of this GeSHi file
Links in the source in the :visited state
Easy way to highlight stuff. Behaves just like highlight_string
Documentation generated on Mon, 25 Jun 2012 13:55:00 -0500 by phpDocumentor 1.4.4