/wsgi/web2py/applications/examples/static/epydoc/web2py.gluon.highlight.Highlighter-class.html
HTML | 449 lines | 412 code | 24 blank | 13 comment | 0 complexity | 1bce82550bb5a1f6e4cb6893b22cb699 MD5 | raw file
Possible License(s): BSD-2-Clause, MPL-2.0-no-copyleft-exception, MIT, Apache-2.0, BSD-3-Clause, LGPL-2.1
- <?xml version="1.0" encoding="ascii"?>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
- <head>
- <title>web2py.gluon.highlight.Highlighter</title>
- <link rel="stylesheet" href="epydoc.css" type="text/css" />
- <script type="text/javascript" src="epydoc.js"></script>
- </head>
- <body bgcolor="white" text="black" link="blue" vlink="#204080"
- alink="#204080">
- <!-- ==================== NAVIGATION BAR ==================== -->
- <table class="navbar" border="0" width="100%" cellpadding="0"
- bgcolor="#a0c0ff" cellspacing="0">
- <tr valign="middle">
- <!-- Home link -->
- <th> <a
- href="web2py.gluon-module.html">Home</a> </th>
- <!-- Tree link -->
- <th> <a
- href="module-tree.html">Trees</a> </th>
- <!-- Index link -->
- <th> <a
- href="identifier-index.html">Indices</a> </th>
- <!-- Help link -->
- <th> <a
- href="help.html">Help</a> </th>
- <!-- Project homepage -->
- <th class="navbar" align="right" width="100%">
- <table border="0" cellpadding="0" cellspacing="0">
- <tr><th class="navbar" align="center"
- ><a class="navbar" target="_top" href="http://www.web2py.com">web2py Web Framework</a></th>
- </tr></table></th>
- </tr>
- </table>
- <table width="100%" cellpadding="0" cellspacing="0">
- <tr valign="top">
- <td width="100%">
- <span class="breadcrumbs">
- Package web2py ::
- <a href="web2py.gluon-module.html">Package gluon</a> ::
- <a href="web2py.gluon.highlight-module.html">Module highlight</a> ::
- Class Highlighter
- </span>
- </td>
- <td>
- <table cellpadding="0" cellspacing="0">
- <!-- hide/show private -->
- <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
- onclick="toggle_private();">hide private</a>]</span></td></tr>
- <tr><td align="right"><span class="options"
- >[<a href="frames.html" target="_top">frames</a
- >] | <a href="web2py.gluon.highlight.Highlighter-class.html"
- target="_top">no frames</a>]</span></td></tr>
- </table>
- </td>
- </tr>
- </table>
- <!-- ==================== CLASS DESCRIPTION ==================== -->
- <h1 class="epydoc">Class Highlighter</h1><span class="codelink"><a href="web2py.gluon.highlight-pysrc.html#Highlighter">source code</a></span><br /><br />
- <pre class="base-tree">
- object --+
- |
- <strong class="uidshort">Highlighter</strong>
- </pre>
- <hr />
- Do syntax highlighting.<br /><br />
- <!-- ==================== INSTANCE METHODS ==================== -->
- <a name="section-InstanceMethods"></a>
- <table class="summary" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr bgcolor="#70b0f0" class="table-header">
- <td colspan="2" class="table-header">
- <table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr valign="top">
- <td align="left"><span class="table-header">Instance Methods</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-InstanceMethods"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="web2py.gluon.highlight.Highlighter-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
- <span class="summary-sig-arg">mode</span>,
- <span class="summary-sig-arg">link</span>=<span class="summary-sig-default">threading.local()</span>,
- <span class="summary-sig-arg">styles</span>=<span class="summary-sig-default">threading.local()</span>)</span><br />
- Initialise highlighter:...</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="web2py.gluon.highlight-pysrc.html#Highlighter.__init__">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a name="c_tokenizer"></a><span class="summary-sig-name">c_tokenizer</span>(<span class="summary-sig-arg">self</span>,
- <span class="summary-sig-arg">token</span>,
- <span class="summary-sig-arg">match</span>,
- <span class="summary-sig-arg">style</span>)</span><br />
- Callback for C specific highlighting.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="web2py.gluon.highlight-pysrc.html#Highlighter.c_tokenizer">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a name="python_tokenizer"></a><span class="summary-sig-name">python_tokenizer</span>(<span class="summary-sig-arg">self</span>,
- <span class="summary-sig-arg">token</span>,
- <span class="summary-sig-arg">match</span>,
- <span class="summary-sig-arg">style</span>)</span><br />
- Callback for python specific highlighting.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="web2py.gluon.highlight-pysrc.html#Highlighter.python_tokenizer">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a name="html_tokenizer"></a><span class="summary-sig-name">html_tokenizer</span>(<span class="summary-sig-arg">self</span>,
- <span class="summary-sig-arg">token</span>,
- <span class="summary-sig-arg">match</span>,
- <span class="summary-sig-arg">style</span>)</span><br />
- Callback for HTML specific highlighting.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="web2py.gluon.highlight-pysrc.html#Highlighter.html_tokenizer">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="web2py.gluon.highlight.Highlighter-class.html#highlight" class="summary-sig-name">highlight</a>(<span class="summary-sig-arg">self</span>,
- <span class="summary-sig-arg">data</span>)</span><br />
- Syntax highlight some python code.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="web2py.gluon.highlight-pysrc.html#Highlighter.highlight">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a name="change_style"></a><span class="summary-sig-name">change_style</span>(<span class="summary-sig-arg">self</span>,
- <span class="summary-sig-arg">token</span>,
- <span class="summary-sig-arg">style</span>)</span><br />
- Generate output to change from existing style to another style
- only.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="web2py.gluon.highlight-pysrc.html#Highlighter.change_style">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td colspan="2" class="summary">
- <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
- <code>__delattr__</code>,
- <code>__getattribute__</code>,
- <code>__hash__</code>,
- <code>__new__</code>,
- <code>__reduce__</code>,
- <code>__reduce_ex__</code>,
- <code>__repr__</code>,
- <code>__setattr__</code>,
- <code>__str__</code>
- </p>
- </td>
- </tr>
- </table>
- <!-- ==================== CLASS VARIABLES ==================== -->
- <a name="section-ClassVariables"></a>
- <table class="summary" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr bgcolor="#70b0f0" class="table-header">
- <td colspan="2" class="table-header">
- <table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr valign="top">
- <td align="left"><span class="table-header">Class Variables</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-ClassVariables"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <a href="web2py.gluon.highlight.Highlighter-class.html#all_styles" class="summary-name">all_styles</a> = <code title="{'C': (<function c_tokenizer at 0xeb91b8>,
- (('COMMENT',
- re.compile(r'//.*\r?\n'),
- 'color: green; font-style: italic'),
- ('MULTILINECOMMENT',
- re.compile(r'(?s)/\*.*?\*/'),
- 'color: green; font-style: italic'),
- ('PREPROCESSOR', re.compile(r'(?s)\s*#.*?[^\\]\s*\n'), 'color:\
- ..."><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">C</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code><function c_tokenizer at 0xeb91b8><code class="variable-op">, </code><code class="variable-group">(</code><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">COM</code><code class="variable-ellipsis">...</code></code>
- </td>
- </tr>
- </table>
- <!-- ==================== PROPERTIES ==================== -->
- <a name="section-Properties"></a>
- <table class="summary" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr bgcolor="#70b0f0" class="table-header">
- <td colspan="2" class="table-header">
- <table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr valign="top">
- <td align="left"><span class="table-header">Properties</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-Properties"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td colspan="2" class="summary">
- <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
- <code>__class__</code>
- </p>
- </td>
- </tr>
- </table>
- <!-- ==================== METHOD DETAILS ==================== -->
- <a name="section-MethodDetails"></a>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr bgcolor="#70b0f0" class="table-header">
- <td colspan="2" class="table-header">
- <table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr valign="top">
- <td align="left"><span class="table-header">Method Details</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-MethodDetails"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <a name="__init__"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
- <span class="sig-arg">mode</span>,
- <span class="sig-arg">link</span>=<span class="sig-default">threading.local()</span>,
- <span class="sig-arg">styles</span>=<span class="sig-default">threading.local()</span>)</span>
- <br /><em class="fname">(Constructor)</em>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="web2py.gluon.highlight-pysrc.html#Highlighter.__init__">source code</a></span>
- </td>
- </table>
-
- <pre class="literalblock">
- Initialise highlighter:
- mode = language (PYTHON, WEB2PY,C, CPP, HTML, HTML_PLAIN)
- </pre>
- <dl class="fields">
- <dt>Overrides:
- object.__init__
- </dt>
- </dl>
- </td></tr></table>
- </div>
- <a name="highlight"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">highlight</span>(<span class="sig-arg">self</span>,
- <span class="sig-arg">data</span>)</span>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="web2py.gluon.highlight-pysrc.html#Highlighter.highlight">source code</a></span>
- </td>
- </table>
-
- Syntax highlight some python code. Returns html version of code.
- <dl class="fields">
- </dl>
- </td></tr></table>
- </div>
- <br />
- <!-- ==================== CLASS VARIABLE DETAILS ==================== -->
- <a name="section-ClassVariableDetails"></a>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr bgcolor="#70b0f0" class="table-header">
- <td colspan="2" class="table-header">
- <table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr valign="top">
- <td align="left"><span class="table-header">Class Variable Details</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-ClassVariableDetails"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <a name="all_styles"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <h3 class="epydoc">all_styles</h3>
-
- <dl class="fields">
- </dl>
- <dl class="fields">
- <dt>Value:</dt>
- <dd><table><tr><td><pre class="variable">
- <code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">C</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code><function c_tokenizer at 0xeb91b8><code class="variable-op">,</code>
- <code class="variable-group">(</code><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">COMMENT</code><code class="variable-quote">'</code><code class="variable-op">,</code>
- re.compile(r'//.<code class="re-op">*</code>\r<code class="re-op">?</code>\n')<code class="variable-op">,</code>
- <code class="variable-quote">'</code><code class="variable-string">color: green; font-style: italic</code><code class="variable-quote">'</code><code class="variable-group">)</code><code class="variable-op">,</code>
- <code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">MULTILINECOMMENT</code><code class="variable-quote">'</code><code class="variable-op">,</code>
- re.compile(r'<code class="re-flags">(?s)</code>/\*.<code class="re-op">*?</code>\*/')<code class="variable-op">,</code>
- <code class="variable-quote">'</code><code class="variable-string">color: green; font-style: italic</code><code class="variable-quote">'</code><code class="variable-group">)</code><code class="variable-op">,</code>
- <code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">PREPROCESSOR</code><code class="variable-quote">'</code><code class="variable-op">, </code>re.compile(r'<code class="re-flags">(?s)</code>\s<code class="re-op">*</code>#.<code class="re-op">*?</code><code class="re-group">[^</code>\\<code class="re-group">]</code>\s<code class="re-op">*</code>\n')<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">color:</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
- <code class="variable-ellipsis">...</code>
- </pre></td></tr></table>
- </dd>
- </dl>
- </td></tr></table>
- </div>
- <br />
- <!-- ==================== NAVIGATION BAR ==================== -->
- <table class="navbar" border="0" width="100%" cellpadding="0"
- bgcolor="#a0c0ff" cellspacing="0">
- <tr valign="middle">
- <!-- Home link -->
- <th> <a
- href="web2py.gluon-module.html">Home</a> </th>
- <!-- Tree link -->
- <th> <a
- href="module-tree.html">Trees</a> </th>
- <!-- Index link -->
- <th> <a
- href="identifier-index.html">Indices</a> </th>
- <!-- Help link -->
- <th> <a
- href="help.html">Help</a> </th>
- <!-- Project homepage -->
- <th class="navbar" align="right" width="100%">
- <table border="0" cellpadding="0" cellspacing="0">
- <tr><th class="navbar" align="center"
- ><a class="navbar" target="_top" href="http://www.web2py.com">web2py Web Framework</a></th>
- </tr></table></th>
- </tr>
- </table>
- <table border="0" cellpadding="0" cellspacing="0" width="100%%">
- <tr>
- <td align="left" class="footer">
- Generated by Epydoc 3.0beta1 on Sun Oct 21 16:56:51 2012
- </td>
- <td align="right" class="footer">
- <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
- </td>
- </tr>
- </table>
- <script type="text/javascript">
- <!--
- // Private objects are initially displayed (because if
- // javascript is turned off then we want them to be
- // visible); but by default, we want to hide them. So hide
- // them unless we have a cookie that says to show them.
- checkCookie()
- // -->
- </script>
-
- </body>
- </html>