PageRenderTime 53ms CodeModel.GetById 21ms RepoModel.GetById 1ms app.codeStats 0ms

/wsgi/web2py/applications/examples/static/epydoc/web2py.gluon.highlight.Highlighter-class.html

https://github.com/saffih/openshift_web2py
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
  1. <?xml version="1.0" encoding="ascii"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  3. "DTD/xhtml1-transitional.dtd">
  4. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  5. <head>
  6. <title>web2py.gluon.highlight.Highlighter</title>
  7. <link rel="stylesheet" href="epydoc.css" type="text/css" />
  8. <script type="text/javascript" src="epydoc.js"></script>
  9. </head>
  10. <body bgcolor="white" text="black" link="blue" vlink="#204080"
  11. alink="#204080">
  12. <!-- ==================== NAVIGATION BAR ==================== -->
  13. <table class="navbar" border="0" width="100%" cellpadding="0"
  14. bgcolor="#a0c0ff" cellspacing="0">
  15. <tr valign="middle">
  16. <!-- Home link -->
  17. <th>&nbsp;&nbsp;&nbsp;<a
  18. href="web2py.gluon-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
  19. <!-- Tree link -->
  20. <th>&nbsp;&nbsp;&nbsp;<a
  21. href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  22. <!-- Index link -->
  23. <th>&nbsp;&nbsp;&nbsp;<a
  24. href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  25. <!-- Help link -->
  26. <th>&nbsp;&nbsp;&nbsp;<a
  27. href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  28. <!-- Project homepage -->
  29. <th class="navbar" align="right" width="100%">
  30. <table border="0" cellpadding="0" cellspacing="0">
  31. <tr><th class="navbar" align="center"
  32. ><a class="navbar" target="_top" href="http://www.web2py.com">web2py Web Framework</a></th>
  33. </tr></table></th>
  34. </tr>
  35. </table>
  36. <table width="100%" cellpadding="0" cellspacing="0">
  37. <tr valign="top">
  38. <td width="100%">
  39. <span class="breadcrumbs">
  40. Package&nbsp;web2py ::
  41. <a href="web2py.gluon-module.html">Package&nbsp;gluon</a> ::
  42. <a href="web2py.gluon.highlight-module.html">Module&nbsp;highlight</a> ::
  43. Class&nbsp;Highlighter
  44. </span>
  45. </td>
  46. <td>
  47. <table cellpadding="0" cellspacing="0">
  48. <!-- hide/show private -->
  49. <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  50. onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  51. <tr><td align="right"><span class="options"
  52. >[<a href="frames.html" target="_top">frames</a
  53. >]&nbsp;|&nbsp;<a href="web2py.gluon.highlight.Highlighter-class.html"
  54. target="_top">no&nbsp;frames</a>]</span></td></tr>
  55. </table>
  56. </td>
  57. </tr>
  58. </table>
  59. <!-- ==================== CLASS DESCRIPTION ==================== -->
  60. <h1 class="epydoc">Class Highlighter</h1><span class="codelink"><a href="web2py.gluon.highlight-pysrc.html#Highlighter">source&nbsp;code</a></span><br /><br />
  61. <pre class="base-tree">
  62. object --+
  63. |
  64. <strong class="uidshort">Highlighter</strong>
  65. </pre>
  66. <hr />
  67. Do syntax highlighting.<br /><br />
  68. <!-- ==================== INSTANCE METHODS ==================== -->
  69. <a name="section-InstanceMethods"></a>
  70. <table class="summary" border="1" cellpadding="3"
  71. cellspacing="0" width="100%" bgcolor="white">
  72. <tr bgcolor="#70b0f0" class="table-header">
  73. <td colspan="2" class="table-header">
  74. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  75. <tr valign="top">
  76. <td align="left"><span class="table-header">Instance Methods</span></td>
  77. <td align="right" valign="top"
  78. ><span class="options">[<a href="#section-InstanceMethods"
  79. class="privatelink" onclick="toggle_private();"
  80. >hide private</a>]</span></td>
  81. </tr>
  82. </table>
  83. </td>
  84. </tr>
  85. <tr>
  86. <td width="15%" align="right" valign="top" class="summary">
  87. <span class="summary-type">&nbsp;</span>
  88. </td><td class="summary">
  89. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  90. <tr>
  91. <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>,
  92. <span class="summary-sig-arg">mode</span>,
  93. <span class="summary-sig-arg">link</span>=<span class="summary-sig-default">threading.local()</span>,
  94. <span class="summary-sig-arg">styles</span>=<span class="summary-sig-default">threading.local()</span>)</span><br />
  95. Initialise highlighter:...</td>
  96. <td align="right" valign="top">
  97. <span class="codelink"><a href="web2py.gluon.highlight-pysrc.html#Highlighter.__init__">source&nbsp;code</a></span>
  98. </td>
  99. </tr>
  100. </table>
  101. </td>
  102. </tr>
  103. <tr>
  104. <td width="15%" align="right" valign="top" class="summary">
  105. <span class="summary-type">&nbsp;</span>
  106. </td><td class="summary">
  107. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  108. <tr>
  109. <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>,
  110. <span class="summary-sig-arg">token</span>,
  111. <span class="summary-sig-arg">match</span>,
  112. <span class="summary-sig-arg">style</span>)</span><br />
  113. Callback for C specific highlighting.</td>
  114. <td align="right" valign="top">
  115. <span class="codelink"><a href="web2py.gluon.highlight-pysrc.html#Highlighter.c_tokenizer">source&nbsp;code</a></span>
  116. </td>
  117. </tr>
  118. </table>
  119. </td>
  120. </tr>
  121. <tr>
  122. <td width="15%" align="right" valign="top" class="summary">
  123. <span class="summary-type">&nbsp;</span>
  124. </td><td class="summary">
  125. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  126. <tr>
  127. <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>,
  128. <span class="summary-sig-arg">token</span>,
  129. <span class="summary-sig-arg">match</span>,
  130. <span class="summary-sig-arg">style</span>)</span><br />
  131. Callback for python specific highlighting.</td>
  132. <td align="right" valign="top">
  133. <span class="codelink"><a href="web2py.gluon.highlight-pysrc.html#Highlighter.python_tokenizer">source&nbsp;code</a></span>
  134. </td>
  135. </tr>
  136. </table>
  137. </td>
  138. </tr>
  139. <tr>
  140. <td width="15%" align="right" valign="top" class="summary">
  141. <span class="summary-type">&nbsp;</span>
  142. </td><td class="summary">
  143. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  144. <tr>
  145. <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>,
  146. <span class="summary-sig-arg">token</span>,
  147. <span class="summary-sig-arg">match</span>,
  148. <span class="summary-sig-arg">style</span>)</span><br />
  149. Callback for HTML specific highlighting.</td>
  150. <td align="right" valign="top">
  151. <span class="codelink"><a href="web2py.gluon.highlight-pysrc.html#Highlighter.html_tokenizer">source&nbsp;code</a></span>
  152. </td>
  153. </tr>
  154. </table>
  155. </td>
  156. </tr>
  157. <tr>
  158. <td width="15%" align="right" valign="top" class="summary">
  159. <span class="summary-type">&nbsp;</span>
  160. </td><td class="summary">
  161. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  162. <tr>
  163. <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>,
  164. <span class="summary-sig-arg">data</span>)</span><br />
  165. Syntax highlight some python code.</td>
  166. <td align="right" valign="top">
  167. <span class="codelink"><a href="web2py.gluon.highlight-pysrc.html#Highlighter.highlight">source&nbsp;code</a></span>
  168. </td>
  169. </tr>
  170. </table>
  171. </td>
  172. </tr>
  173. <tr>
  174. <td width="15%" align="right" valign="top" class="summary">
  175. <span class="summary-type">&nbsp;</span>
  176. </td><td class="summary">
  177. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  178. <tr>
  179. <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>,
  180. <span class="summary-sig-arg">token</span>,
  181. <span class="summary-sig-arg">style</span>)</span><br />
  182. Generate output to change from existing style to another style
  183. only.</td>
  184. <td align="right" valign="top">
  185. <span class="codelink"><a href="web2py.gluon.highlight-pysrc.html#Highlighter.change_style">source&nbsp;code</a></span>
  186. </td>
  187. </tr>
  188. </table>
  189. </td>
  190. </tr>
  191. <tr>
  192. <td colspan="2" class="summary">
  193. <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
  194. <code>__delattr__</code>,
  195. <code>__getattribute__</code>,
  196. <code>__hash__</code>,
  197. <code>__new__</code>,
  198. <code>__reduce__</code>,
  199. <code>__reduce_ex__</code>,
  200. <code>__repr__</code>,
  201. <code>__setattr__</code>,
  202. <code>__str__</code>
  203. </p>
  204. </td>
  205. </tr>
  206. </table>
  207. <!-- ==================== CLASS VARIABLES ==================== -->
  208. <a name="section-ClassVariables"></a>
  209. <table class="summary" border="1" cellpadding="3"
  210. cellspacing="0" width="100%" bgcolor="white">
  211. <tr bgcolor="#70b0f0" class="table-header">
  212. <td colspan="2" class="table-header">
  213. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  214. <tr valign="top">
  215. <td align="left"><span class="table-header">Class Variables</span></td>
  216. <td align="right" valign="top"
  217. ><span class="options">[<a href="#section-ClassVariables"
  218. class="privatelink" onclick="toggle_private();"
  219. >hide private</a>]</span></td>
  220. </tr>
  221. </table>
  222. </td>
  223. </tr>
  224. <tr>
  225. <td width="15%" align="right" valign="top" class="summary">
  226. <span class="summary-type">&nbsp;</span>
  227. </td><td class="summary">
  228. <a href="web2py.gluon.highlight.Highlighter-class.html#all_styles" class="summary-name">all_styles</a> = <code title="{'C': (&lt;function c_tokenizer at 0xeb91b8&gt;,
  229. (('COMMENT',
  230. re.compile(r'//.*\r?\n'),
  231. 'color: green; font-style: italic'),
  232. ('MULTILINECOMMENT',
  233. re.compile(r'(?s)/\*.*?\*/'),
  234. 'color: green; font-style: italic'),
  235. ('PREPROCESSOR', re.compile(r'(?s)\s*#.*?[^\\]\s*\n'), 'color:\
  236. ..."><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>&lt;function c_tokenizer at 0xeb91b8&gt;<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>
  237. </td>
  238. </tr>
  239. </table>
  240. <!-- ==================== PROPERTIES ==================== -->
  241. <a name="section-Properties"></a>
  242. <table class="summary" border="1" cellpadding="3"
  243. cellspacing="0" width="100%" bgcolor="white">
  244. <tr bgcolor="#70b0f0" class="table-header">
  245. <td colspan="2" class="table-header">
  246. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  247. <tr valign="top">
  248. <td align="left"><span class="table-header">Properties</span></td>
  249. <td align="right" valign="top"
  250. ><span class="options">[<a href="#section-Properties"
  251. class="privatelink" onclick="toggle_private();"
  252. >hide private</a>]</span></td>
  253. </tr>
  254. </table>
  255. </td>
  256. </tr>
  257. <tr>
  258. <td colspan="2" class="summary">
  259. <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
  260. <code>__class__</code>
  261. </p>
  262. </td>
  263. </tr>
  264. </table>
  265. <!-- ==================== METHOD DETAILS ==================== -->
  266. <a name="section-MethodDetails"></a>
  267. <table class="details" border="1" cellpadding="3"
  268. cellspacing="0" width="100%" bgcolor="white">
  269. <tr bgcolor="#70b0f0" class="table-header">
  270. <td colspan="2" class="table-header">
  271. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  272. <tr valign="top">
  273. <td align="left"><span class="table-header">Method Details</span></td>
  274. <td align="right" valign="top"
  275. ><span class="options">[<a href="#section-MethodDetails"
  276. class="privatelink" onclick="toggle_private();"
  277. >hide private</a>]</span></td>
  278. </tr>
  279. </table>
  280. </td>
  281. </tr>
  282. </table>
  283. <a name="__init__"></a>
  284. <div>
  285. <table class="details" border="1" cellpadding="3"
  286. cellspacing="0" width="100%" bgcolor="white">
  287. <tr><td>
  288. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  289. <tr valign="top"><td>
  290. <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
  291. <span class="sig-arg">mode</span>,
  292. <span class="sig-arg">link</span>=<span class="sig-default">threading.local()</span>,
  293. <span class="sig-arg">styles</span>=<span class="sig-default">threading.local()</span>)</span>
  294. <br /><em class="fname">(Constructor)</em>
  295. </h3>
  296. </td><td align="right" valign="top"
  297. ><span class="codelink"><a href="web2py.gluon.highlight-pysrc.html#Highlighter.__init__">source&nbsp;code</a></span>&nbsp;
  298. </td>
  299. </table>
  300. <pre class="literalblock">
  301. Initialise highlighter:
  302. mode = language (PYTHON, WEB2PY,C, CPP, HTML, HTML_PLAIN)
  303. </pre>
  304. <dl class="fields">
  305. <dt>Overrides:
  306. object.__init__
  307. </dt>
  308. </dl>
  309. </td></tr></table>
  310. </div>
  311. <a name="highlight"></a>
  312. <div>
  313. <table class="details" border="1" cellpadding="3"
  314. cellspacing="0" width="100%" bgcolor="white">
  315. <tr><td>
  316. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  317. <tr valign="top"><td>
  318. <h3 class="epydoc"><span class="sig"><span class="sig-name">highlight</span>(<span class="sig-arg">self</span>,
  319. <span class="sig-arg">data</span>)</span>
  320. </h3>
  321. </td><td align="right" valign="top"
  322. ><span class="codelink"><a href="web2py.gluon.highlight-pysrc.html#Highlighter.highlight">source&nbsp;code</a></span>&nbsp;
  323. </td>
  324. </table>
  325. Syntax highlight some python code. Returns html version of code.
  326. <dl class="fields">
  327. </dl>
  328. </td></tr></table>
  329. </div>
  330. <br />
  331. <!-- ==================== CLASS VARIABLE DETAILS ==================== -->
  332. <a name="section-ClassVariableDetails"></a>
  333. <table class="details" border="1" cellpadding="3"
  334. cellspacing="0" width="100%" bgcolor="white">
  335. <tr bgcolor="#70b0f0" class="table-header">
  336. <td colspan="2" class="table-header">
  337. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  338. <tr valign="top">
  339. <td align="left"><span class="table-header">Class Variable Details</span></td>
  340. <td align="right" valign="top"
  341. ><span class="options">[<a href="#section-ClassVariableDetails"
  342. class="privatelink" onclick="toggle_private();"
  343. >hide private</a>]</span></td>
  344. </tr>
  345. </table>
  346. </td>
  347. </tr>
  348. </table>
  349. <a name="all_styles"></a>
  350. <div>
  351. <table class="details" border="1" cellpadding="3"
  352. cellspacing="0" width="100%" bgcolor="white">
  353. <tr><td>
  354. <h3 class="epydoc">all_styles</h3>
  355. <dl class="fields">
  356. </dl>
  357. <dl class="fields">
  358. <dt>Value:</dt>
  359. <dd><table><tr><td><pre class="variable">
  360. <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>&lt;function c_tokenizer at 0xeb91b8&gt;<code class="variable-op">,</code>
  361. <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>
  362. re.compile(r'//.<code class="re-op">*</code>\r<code class="re-op">?</code>\n')<code class="variable-op">,</code>
  363. <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>
  364. <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>
  365. re.compile(r'<code class="re-flags">(?s)</code>/\*.<code class="re-op">*?</code>\*/')<code class="variable-op">,</code>
  366. <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>
  367. <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>
  368. <code class="variable-ellipsis">...</code>
  369. </pre></td></tr></table>
  370. </dd>
  371. </dl>
  372. </td></tr></table>
  373. </div>
  374. <br />
  375. <!-- ==================== NAVIGATION BAR ==================== -->
  376. <table class="navbar" border="0" width="100%" cellpadding="0"
  377. bgcolor="#a0c0ff" cellspacing="0">
  378. <tr valign="middle">
  379. <!-- Home link -->
  380. <th>&nbsp;&nbsp;&nbsp;<a
  381. href="web2py.gluon-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
  382. <!-- Tree link -->
  383. <th>&nbsp;&nbsp;&nbsp;<a
  384. href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  385. <!-- Index link -->
  386. <th>&nbsp;&nbsp;&nbsp;<a
  387. href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  388. <!-- Help link -->
  389. <th>&nbsp;&nbsp;&nbsp;<a
  390. href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  391. <!-- Project homepage -->
  392. <th class="navbar" align="right" width="100%">
  393. <table border="0" cellpadding="0" cellspacing="0">
  394. <tr><th class="navbar" align="center"
  395. ><a class="navbar" target="_top" href="http://www.web2py.com">web2py Web Framework</a></th>
  396. </tr></table></th>
  397. </tr>
  398. </table>
  399. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
  400. <tr>
  401. <td align="left" class="footer">
  402. Generated by Epydoc 3.0beta1 on Sun Oct 21 16:56:51 2012
  403. </td>
  404. <td align="right" class="footer">
  405. <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
  406. </td>
  407. </tr>
  408. </table>
  409. <script type="text/javascript">
  410. <!--
  411. // Private objects are initially displayed (because if
  412. // javascript is turned off then we want them to be
  413. // visible); but by default, we want to hide them. So hide
  414. // them unless we have a cookie that says to show them.
  415. checkCookie()
  416. // -->
  417. </script>
  418. </body>
  419. </html>