First commit

This commit is contained in:
Pierre Hubert
2016-11-19 12:08:12 +01:00
commit 990540b2b9
4706 changed files with 931207 additions and 0 deletions

110
3rdparty/luminous/docs/html/annotated.html vendored Executable file
View File

@ -0,0 +1,110 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: Class List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li class="current"><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Class List</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
<table class="directory">
<tr id="row_0_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classluminous.html" target="_self">luminous</a></td><td class="desc">Users' API</td></tr>
<tr id="row_1_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classLuminousEmbeddedWebScript.html" target="_self">LuminousEmbeddedWebScript</a></td><td class="desc">Superclass for languages which may nest, i.e. web languages</td></tr>
<tr id="row_2_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classLuminousFilters.html" target="_self">LuminousFilters</a></td><td class="desc">A collection of useful common filters</td></tr>
<tr id="row_3_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classLuminousOptions.html" target="_self">LuminousOptions</a></td><td class="desc">Options class</td></tr>
<tr id="row_4_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classLuminousScanner.html" target="_self">LuminousScanner</a></td><td class="desc">Base class for all scanners</td></tr>
<tr id="row_5_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classLuminousSimpleScanner.html" target="_self">LuminousSimpleScanner</a></td><td class="desc">A largely automated scanner</td></tr>
<tr id="row_6_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classLuminousStatefulScanner.html" target="_self">LuminousStatefulScanner</a></td><td class="desc">Experimental transition table driven scanner</td></tr>
<tr id="row_7_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classLuminousStringSearch.html" target="_self">LuminousStringSearch</a></td><td class="desc">A basic preg_match wrapper which caches its results</td></tr>
<tr id="row_8_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classLuminousTokenPresets.html" target="_self">LuminousTokenPresets</a></td><td class="desc">A set of pre-defined patterns to match various common tokens</td></tr>
<tr id="row_9_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classLuminousUtils.html" target="_self">LuminousUtils</a></td><td class="desc">A set of utility functions for scanners</td></tr>
<tr id="row_10_" class="even"><td class="entry"><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classScanner.html" target="_self">Scanner</a></td><td class="desc">Base string scanning class</td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:51 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

BIN
3rdparty/luminous/docs/html/bc_s.png vendored Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 680 B

BIN
3rdparty/luminous/docs/html/bdwn.png vendored Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 147 B

View File

@ -0,0 +1,170 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: Member List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">LuminousEmbeddedWebScript Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="classLuminousEmbeddedWebScript.html">LuminousEmbeddedWebScript</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#af3887911498a250b2cb1fe737dd87df1">$case_sensitive</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html#aba37db3108b9a5ec0fda7f18a66fb317">$child_scanners</a></td><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html">LuminousEmbeddedWebScript</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html#a278925946650e3c9e2094283512697d1">$clean_exit</a></td><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html">LuminousEmbeddedWebScript</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html#ace2c028e88c2c295c9f92214eff51f2b">$dirty_exit_recovery</a></td><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html">LuminousEmbeddedWebScript</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html#a9627fb0cc01060902259ee3c9212fad2">$embedded_html</a></td><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html">LuminousEmbeddedWebScript</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html#a5fdc96de06443379f9dd48de9b80040b">$embedded_server</a></td><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html">LuminousEmbeddedWebScript</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html#a463a354548b9e9bf913ca47faf03808a">$exit_state</a></td><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html">LuminousEmbeddedWebScript</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#aca257c4da52076f42c6e53d9d0d33dd1">$filters</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#adb13455bbeb076cd0f031f050ef31a82">$ident_map</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html#aa33f76adc9164f8160785e8f70ff2420">$interrupt</a></td><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html">LuminousEmbeddedWebScript</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a30aaa5d3076a9f28d00f167a1c4eac34">$rule_tag_map</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html#a298f32256c797af02dbb7dbf3b2d2040">$script_tags</a></td><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html">LuminousEmbeddedWebScript</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html#a11065fbf564b463206673a07a0498457">$server_tags</a></td><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html">LuminousEmbeddedWebScript</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#ab5a30262ceb4324fdfaac1a7d217ba36">$state_</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#ad3d9ad7f7f14bc9de3dd6b68225ce21c">$stream_filters</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#ab29032700812b580e5d09b6128202286">$tokens</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a615d93f42d9290b9fad4d84cc2fd84ec">$user_defs</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a22a1e366c9fbe4e837de693258c5c739">$version</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a493a069a6ba279b279865111b8e8ffd4">__construct</a>($src=null)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html#a6d78a3253fb12358ce13ca7650c6629b">add_child_scanner</a>($name, $scanner)</td><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html">LuminousEmbeddedWebScript</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a17a50bdadaa49f0638638d5c6da7090c">add_filter</a>($arg1, $arg2, $arg3=null)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a047ae1afbf5563184e3dc67ecfb90a8c">add_identifier_mapping</a>($name, $matches)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a4cb6935d759ee0c75fa01b75e2d0ec04">add_pattern</a>($name, $pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a32eb459cd8ad20b8ea3403907d7f2e52">add_stream_filter</a>($arg1, $arg2=null)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a77abc2d2de424e73d1ee659fd9001e4a">bol</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#ae483fc35eae064c75f8b5ca105826757">check</a>($pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html#a77deb48d41b8a791900a3d5c50813faf">dirty_exit</a>($token_name)</td><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html">LuminousEmbeddedWebScript</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a8ad6032d3a1f955608905c10a864aee6">eol</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a23543739aee09e2e1961a556a9672c7d">eos</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a154d424c925ed0d58e033f1e71ceef03">get</a>($n=1)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#ac8beec743c18d54cec51273b3bb7f3b5">get_next</a>($patterns)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a21f59cd38d7ed3ccd43955386b6aa14e">get_next_named</a>($patterns)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a57774c7a298bb43c1c4406a830d386a6">get_next_strpos</a>($patterns)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a094a64c9eb09e38ab43c865e1a4482c9">guess_language</a>($src, $info)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a0a7907663241caffb546ef22bb35d870">highlight</a>($src)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a90bacd70c30eb1d76659c0586f0683d2">index</a>($pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#af0aecba631e56a3005157cfbe84d6b67">init</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a12220a789d49b7e8f42cf873966b6756">main</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a6efd3dada50a424d7f30b7f9afac5fc0">map_identifier_filter</a>($token)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a17ac6e2abcb54a6dfaa9abaf95ed839e">match</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#aa933ee80eb310785c75ab7b03ed01885">match_group</a>($g=0)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a9271f0acf8d19f83fa45ee3ee1d3eab5">match_groups</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#aa5520e0fc7df54d7a25d75037e6cdc8a">match_pos</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#ae974cbfb732f008a79482ffc4f11d398">nestable_token</a>($token_name, $open, $close)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a5e03667fd1cdc1d1fd40a4bc15570b12">next_match</a>($consume_and_log=true)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a3028e787442cf1ed9252397ed029b223">peek</a>($n=1)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a614e490335cf64375c52d57edfb398ad">pop</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a546cafdcfc3adeb19959ae14dff10996">pos</a>($new_pos=null)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a947d15fe4bd13b64afd5eaba8d4d3819">pos_shift</a>($offset)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#add1da033592e8f944660b9e29088a2ac">push</a>($state)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#aa61dbaafd8801e40094cbff52f7b22f1">record</a>($string, $type, $pre_escaped=false)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a48fabeb9791b36ace2b46dd8f91a4afa">record_range</a>($from, $to, $type)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a80c4b9fff3a38e90e04cda38eb075040">remove_filter</a>($name)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a79c559549e2dd73c3f1892e7609e84a6">remove_pattern</a>($name)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a25c4c1f42c64a07ce87c19f3992a0fba">remove_stream_filter</a>($name)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a89d1448f666d1be3d5037c69f24eb516">reset</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#aeae50ecaf6b98a0b76f47c3d04b8deb3">rest</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html#aa5f8bbf0166d4d6531d33ad3319f85e5">resume</a>()</td><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html">LuminousEmbeddedWebScript</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a4cc936af136b39a54db6c7212c04cee7">rule_mapper_filter</a>($tokens)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a78ddb203c30c2f9e69755ec00c341add">scan</a>($pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#aa0e261d4b0c2fce43ba3c264036afd72">scan_until</a>($pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html#a08ce3d66e8ff9217903f68c2a2aa6120">script_break</a>($token_name, $match=null, $pos=null)</td><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html">LuminousEmbeddedWebScript</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html#a9725d508c1411b029b43feeab9491af4">server_break</a>($token_name, $match=null, $pos=null)</td><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html">LuminousEmbeddedWebScript</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#ab06dcdea11ff9a78168547b4c84c650c">skip_whitespace</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a4156922baa33783377f7904fd2d4cee5">start</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a23e2cf34969c3d39cd34a4b5ce6810ca">state</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html#a468d0f77b948817731d32f866b360586">string</a>($str=null)</td><td class="entry"><a class="el" href="classLuminousEmbeddedWebScript.html">LuminousEmbeddedWebScript</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a809c11561c650c7784edd3d06243b8b5">tagged</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a185d6e780752848cb282add6d9f936bb">terminate</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#ae381e3000c83ae4cb2259d0ae77a14ab">token_array</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a6f6665b8df561788b1b2dea40bb394ae">unscan</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a463b3eb270a7afb960ee642bccc0d1b6">user_def_filter</a>($token)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:50 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,592 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: LuminousEmbeddedWebScript Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classLuminousEmbeddedWebScript-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">LuminousEmbeddedWebScript Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Superclass for languages which may nest, i.e. web languages.
<a href="classLuminousEmbeddedWebScript.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for LuminousEmbeddedWebScript:</div>
<div class="dyncontent">
<div class="center"><img src="classLuminousEmbeddedWebScript__inherit__graph.png" border="0" usemap="#LuminousEmbeddedWebScript_inherit__map" alt="Inheritance graph"/></div>
<map name="LuminousEmbeddedWebScript_inherit__map" id="LuminousEmbeddedWebScript_inherit__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for LuminousEmbeddedWebScript:</div>
<div class="dyncontent">
<div class="center"><img src="classLuminousEmbeddedWebScript__coll__graph.png" border="0" usemap="#LuminousEmbeddedWebScript_coll__map" alt="Collaboration graph"/></div>
<map name="LuminousEmbeddedWebScript_coll__map" id="LuminousEmbeddedWebScript_coll__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6d78a3253fb12358ce13ca7650c6629b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6d78a3253fb12358ce13ca7650c6629b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousEmbeddedWebScript.html#a6d78a3253fb12358ce13ca7650c6629b">add_child_scanner</a> ($name, $scanner)</td></tr>
<tr class="memdesc:a6d78a3253fb12358ce13ca7650c6629b"><td class="mdescLeft">&#160;</td><td class="mdescRight">adds a child scanner Adds a child scanner and indexes it against a name, convenience function <br/></td></tr>
<tr class="memitem:a77deb48d41b8a791900a3d5c50813faf"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousEmbeddedWebScript.html#a77deb48d41b8a791900a3d5c50813faf">dirty_exit</a> ($token_name)</td></tr>
<tr class="memdesc:a77deb48d41b8a791900a3d5c50813faf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the exit data to signify the exit is dirty and will need recovering from. <a href="#a77deb48d41b8a791900a3d5c50813faf"></a><br/></td></tr>
<tr class="memitem:aa5f8bbf0166d4d6531d33ad3319f85e5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousEmbeddedWebScript.html#aa5f8bbf0166d4d6531d33ad3319f85e5">resume</a> ()</td></tr>
<tr class="memdesc:aa5f8bbf0166d4d6531d33ad3319f85e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attempts to recover from a dirty exit. <a href="#aa5f8bbf0166d4d6531d33ad3319f85e5"></a><br/></td></tr>
<tr class="memitem:a08ce3d66e8ff9217903f68c2a2aa6120"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousEmbeddedWebScript.html#a08ce3d66e8ff9217903f68c2a2aa6120">script_break</a> ($token_name, $<a class="el" href="classScanner.html#a17ac6e2abcb54a6dfaa9abaf95ed839e">match</a>=null, $<a class="el" href="classScanner.html#a546cafdcfc3adeb19959ae14dff10996">pos</a>=null)</td></tr>
<tr class="memdesc:a08ce3d66e8ff9217903f68c2a2aa6120"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks for a script terminator tag inside a matched token. <a href="#a08ce3d66e8ff9217903f68c2a2aa6120"></a><br/></td></tr>
<tr class="memitem:a9725d508c1411b029b43feeab9491af4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousEmbeddedWebScript.html#a9725d508c1411b029b43feeab9491af4">server_break</a> ($token_name, $<a class="el" href="classScanner.html#a17ac6e2abcb54a6dfaa9abaf95ed839e">match</a>=null, $<a class="el" href="classScanner.html#a546cafdcfc3adeb19959ae14dff10996">pos</a>=null)</td></tr>
<tr class="memdesc:a9725d508c1411b029b43feeab9491af4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks for a server-side script inside a matched token. <a href="#a9725d508c1411b029b43feeab9491af4"></a><br/></td></tr>
<tr class="memitem:a468d0f77b948817731d32f866b360586"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousEmbeddedWebScript.html#a468d0f77b948817731d32f866b360586">string</a> ($str=null)</td></tr>
<tr class="memdesc:a468d0f77b948817731d32f866b360586"><td class="mdescLeft">&#160;</td><td class="mdescRight">Getter and setter for the source string. <a href="#a468d0f77b948817731d32f866b360586"></a><br/></td></tr>
<tr class="inherit_header pub_methods_classLuminousScanner"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classLuminousScanner')"><img src="closed.png" alt="-"/>&nbsp;Public Member Functions inherited from <a class="el" href="classLuminousScanner.html">LuminousScanner</a></td></tr>
<tr class="memitem:a493a069a6ba279b279865111b8e8ffd4 inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a493a069a6ba279b279865111b8e8ffd4"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a493a069a6ba279b279865111b8e8ffd4">__construct</a> ($src=null)</td></tr>
<tr class="memdesc:a493a069a6ba279b279865111b8e8ffd4 inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor <br/></td></tr>
<tr class="memitem:a17a50bdadaa49f0638638d5c6da7090c inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a17a50bdadaa49f0638638d5c6da7090c">add_filter</a> ($arg1, $arg2, $arg3=null)</td></tr>
<tr class="memdesc:a17a50bdadaa49f0638638d5c6da7090c inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add an individual token filter. <a href="#a17a50bdadaa49f0638638d5c6da7090c"></a><br/></td></tr>
<tr class="memitem:a047ae1afbf5563184e3dc67ecfb90a8c inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a047ae1afbf5563184e3dc67ecfb90a8c">add_identifier_mapping</a> ($name, $matches)</td></tr>
<tr class="memdesc:a047ae1afbf5563184e3dc67ecfb90a8c inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds an identifier mapping which is later analysed by map_identifier_filter. <a href="#a047ae1afbf5563184e3dc67ecfb90a8c"></a><br/></td></tr>
<tr class="memitem:a32eb459cd8ad20b8ea3403907d7f2e52 inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a32eb459cd8ad20b8ea3403907d7f2e52">add_stream_filter</a> ($arg1, $arg2=null)</td></tr>
<tr class="memdesc:a32eb459cd8ad20b8ea3403907d7f2e52 inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a stream filter. <a href="#a32eb459cd8ad20b8ea3403907d7f2e52"></a><br/></td></tr>
<tr class="memitem:a0a7907663241caffb546ef22bb35d870 inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a0a7907663241caffb546ef22bb35d870">highlight</a> ($src)</td></tr>
<tr class="memdesc:a0a7907663241caffb546ef22bb35d870 inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Public convenience function for setting the string and highlighting it. <a href="#a0a7907663241caffb546ef22bb35d870"></a><br/></td></tr>
<tr class="memitem:af0aecba631e56a3005157cfbe84d6b67 inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#af0aecba631e56a3005157cfbe84d6b67">init</a> ()</td></tr>
<tr class="memdesc:af0aecba631e56a3005157cfbe84d6b67 inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set up the scanner immediately prior to tokenization. <a href="#af0aecba631e56a3005157cfbe84d6b67"></a><br/></td></tr>
<tr class="memitem:a12220a789d49b7e8f42cf873966b6756 inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a12220a789d49b7e8f42cf873966b6756">main</a> ()</td></tr>
<tr class="memdesc:a12220a789d49b7e8f42cf873966b6756 inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">the method responsible for tokenization <a href="#a12220a789d49b7e8f42cf873966b6756"></a><br/></td></tr>
<tr class="memitem:a6efd3dada50a424d7f30b7f9afac5fc0 inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a6efd3dada50a424d7f30b7f9afac5fc0">map_identifier_filter</a> ($token)</td></tr>
<tr class="memdesc:a6efd3dada50a424d7f30b7f9afac5fc0 inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Identifier mapping filter. <a href="#a6efd3dada50a424d7f30b7f9afac5fc0"></a><br/></td></tr>
<tr class="memitem:ae974cbfb732f008a79482ffc4f11d398 inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#ae974cbfb732f008a79482ffc4f11d398">nestable_token</a> ($token_name, $open, $close)</td></tr>
<tr class="memdesc:ae974cbfb732f008a79482ffc4f11d398 inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handles tokens that may nest inside themselves. <a href="#ae974cbfb732f008a79482ffc4f11d398"></a><br/></td></tr>
<tr class="memitem:a614e490335cf64375c52d57edfb398ad inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a614e490335cf64375c52d57edfb398ad">pop</a> ()</td></tr>
<tr class="memdesc:a614e490335cf64375c52d57edfb398ad inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pops the top element of the stack, and returns it. <a href="#a614e490335cf64375c52d57edfb398ad"></a><br/></td></tr>
<tr class="memitem:add1da033592e8f944660b9e29088a2ac inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="add1da033592e8f944660b9e29088a2ac"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#add1da033592e8f944660b9e29088a2ac">push</a> ($<a class="el" href="classLuminousScanner.html#a23e2cf34969c3d39cd34a4b5ce6810ca">state</a>)</td></tr>
<tr class="memdesc:add1da033592e8f944660b9e29088a2ac inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pushes some data onto the stack. <br/></td></tr>
<tr class="memitem:aa61dbaafd8801e40094cbff52f7b22f1 inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#aa61dbaafd8801e40094cbff52f7b22f1">record</a> ($<a class="el" href="classScanner.html#a577a70297f4d3da0aa2ce4decc66eeea">string</a>, $type, $pre_escaped=false)</td></tr>
<tr class="memdesc:aa61dbaafd8801e40094cbff52f7b22f1 inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Records a string as a given token type. <a href="#aa61dbaafd8801e40094cbff52f7b22f1"></a><br/></td></tr>
<tr class="memitem:a48fabeb9791b36ace2b46dd8f91a4afa inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a48fabeb9791b36ace2b46dd8f91a4afa">record_range</a> ($from, $to, $type)</td></tr>
<tr class="memdesc:a48fabeb9791b36ace2b46dd8f91a4afa inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper function to record a range of the string. <a href="#a48fabeb9791b36ace2b46dd8f91a4afa"></a><br/></td></tr>
<tr class="memitem:a80c4b9fff3a38e90e04cda38eb075040 inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80c4b9fff3a38e90e04cda38eb075040"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a80c4b9fff3a38e90e04cda38eb075040">remove_filter</a> ($name)</td></tr>
<tr class="memdesc:a80c4b9fff3a38e90e04cda38eb075040 inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes the individual filter(s) with the given name. <br/></td></tr>
<tr class="memitem:a25c4c1f42c64a07ce87c19f3992a0fba inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a25c4c1f42c64a07ce87c19f3992a0fba"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a25c4c1f42c64a07ce87c19f3992a0fba">remove_stream_filter</a> ($name)</td></tr>
<tr class="memdesc:a25c4c1f42c64a07ce87c19f3992a0fba inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes the stream filter(s) with the given name. <br/></td></tr>
<tr class="memitem:ab06dcdea11ff9a78168547b4c84c650c inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#ab06dcdea11ff9a78168547b4c84c650c">skip_whitespace</a> ()</td></tr>
<tr class="memdesc:ab06dcdea11ff9a78168547b4c84c650c inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Skips whitespace, and records it as a null token. <a href="#ab06dcdea11ff9a78168547b4c84c650c"></a><br/></td></tr>
<tr class="memitem:a4156922baa33783377f7904fd2d4cee5 inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4156922baa33783377f7904fd2d4cee5"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a4156922baa33783377f7904fd2d4cee5">start</a> ()</td></tr>
<tr class="memdesc:a4156922baa33783377f7904fd2d4cee5 inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flushes the token stream. <br/></td></tr>
<tr class="memitem:a23e2cf34969c3d39cd34a4b5ce6810ca inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a23e2cf34969c3d39cd34a4b5ce6810ca"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a23e2cf34969c3d39cd34a4b5ce6810ca">state</a> ()</td></tr>
<tr class="memdesc:a23e2cf34969c3d39cd34a4b5ce6810ca inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the top element on $state_ or null if it is empty. <br/></td></tr>
<tr class="memitem:a809c11561c650c7784edd3d06243b8b5 inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a809c11561c650c7784edd3d06243b8b5">tagged</a> ()</td></tr>
<tr class="memdesc:a809c11561c650c7784edd3d06243b8b5 inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the XML representation of the token stream. <a href="#a809c11561c650c7784edd3d06243b8b5"></a><br/></td></tr>
<tr class="memitem:ae381e3000c83ae4cb2259d0ae77a14ab inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#ae381e3000c83ae4cb2259d0ae77a14ab">token_array</a> ()</td></tr>
<tr class="memdesc:ae381e3000c83ae4cb2259d0ae77a14ab inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the token array. <a href="#ae381e3000c83ae4cb2259d0ae77a14ab"></a><br/></td></tr>
<tr class="inherit_header pub_methods_classScanner"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classScanner')"><img src="closed.png" alt="-"/>&nbsp;Public Member Functions inherited from <a class="el" href="classScanner.html">Scanner</a></td></tr>
<tr class="memitem:a4cb6935d759ee0c75fa01b75e2d0ec04 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a4cb6935d759ee0c75fa01b75e2d0ec04">add_pattern</a> ($name, $pattern)</td></tr>
<tr class="memdesc:a4cb6935d759ee0c75fa01b75e2d0ec04 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allows the caller to add a predefined named pattern. <a href="#a4cb6935d759ee0c75fa01b75e2d0ec04"></a><br/></td></tr>
<tr class="memitem:a77abc2d2de424e73d1ee659fd9001e4a inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a77abc2d2de424e73d1ee659fd9001e4a">bol</a> ()</td></tr>
<tr class="memdesc:a77abc2d2de424e73d1ee659fd9001e4a inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Beginning of line? <a href="#a77abc2d2de424e73d1ee659fd9001e4a"></a><br/></td></tr>
<tr class="memitem:ae483fc35eae064c75f8b5ca105826757 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#ae483fc35eae064c75f8b5ca105826757">check</a> ($pattern)</td></tr>
<tr class="memdesc:ae483fc35eae064c75f8b5ca105826757 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Non-consuming lookahead. <a href="#ae483fc35eae064c75f8b5ca105826757"></a><br/></td></tr>
<tr class="memitem:a8ad6032d3a1f955608905c10a864aee6 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a8ad6032d3a1f955608905c10a864aee6">eol</a> ()</td></tr>
<tr class="memdesc:a8ad6032d3a1f955608905c10a864aee6 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">End of line? <a href="#a8ad6032d3a1f955608905c10a864aee6"></a><br/></td></tr>
<tr class="memitem:a23543739aee09e2e1961a556a9672c7d inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a23543739aee09e2e1961a556a9672c7d">eos</a> ()</td></tr>
<tr class="memdesc:a23543739aee09e2e1961a556a9672c7d inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">End of string? <a href="#a23543739aee09e2e1961a556a9672c7d"></a><br/></td></tr>
<tr class="memitem:a154d424c925ed0d58e033f1e71ceef03 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a154d424c925ed0d58e033f1e71ceef03">get</a> ($n=1)</td></tr>
<tr class="memdesc:a154d424c925ed0d58e033f1e71ceef03 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Consume a given number of bytes. <a href="#a154d424c925ed0d58e033f1e71ceef03"></a><br/></td></tr>
<tr class="memitem:ac8beec743c18d54cec51273b3bb7f3b5 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#ac8beec743c18d54cec51273b3bb7f3b5">get_next</a> ($patterns)</td></tr>
<tr class="memdesc:ac8beec743c18d54cec51273b3bb7f3b5 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Look for the next occurrence of a set of patterns. <a href="#ac8beec743c18d54cec51273b3bb7f3b5"></a><br/></td></tr>
<tr class="memitem:a21f59cd38d7ed3ccd43955386b6aa14e inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a21f59cd38d7ed3ccd43955386b6aa14e">get_next_named</a> ($patterns)</td></tr>
<tr class="memdesc:a21f59cd38d7ed3ccd43955386b6aa14e inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the index of the next occurrence of a named pattern. <a href="#a21f59cd38d7ed3ccd43955386b6aa14e"></a><br/></td></tr>
<tr class="memitem:a57774c7a298bb43c1c4406a830d386a6 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a57774c7a298bb43c1c4406a830d386a6">get_next_strpos</a> ($patterns)</td></tr>
<tr class="memdesc:a57774c7a298bb43c1c4406a830d386a6 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Look for the next occurrence of a set of substrings. <a href="#a57774c7a298bb43c1c4406a830d386a6"></a><br/></td></tr>
<tr class="memitem:a90bacd70c30eb1d76659c0586f0683d2 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a90bacd70c30eb1d76659c0586f0683d2">index</a> ($pattern)</td></tr>
<tr class="memdesc:a90bacd70c30eb1d76659c0586f0683d2 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the index of the next occurrence of a pattern. <a href="#a90bacd70c30eb1d76659c0586f0683d2"></a><br/></td></tr>
<tr class="memitem:a17ac6e2abcb54a6dfaa9abaf95ed839e inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a17ac6e2abcb54a6dfaa9abaf95ed839e">match</a> ()</td></tr>
<tr class="memdesc:a17ac6e2abcb54a6dfaa9abaf95ed839e inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the result of the most recent match operation. <a href="#a17ac6e2abcb54a6dfaa9abaf95ed839e"></a><br/></td></tr>
<tr class="memitem:aa933ee80eb310785c75ab7b03ed01885 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#aa933ee80eb310785c75ab7b03ed01885">match_group</a> ($g=0)</td></tr>
<tr class="memdesc:aa933ee80eb310785c75ab7b03ed01885 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a group from the most recent match operation. <a href="#aa933ee80eb310785c75ab7b03ed01885"></a><br/></td></tr>
<tr class="memitem:a9271f0acf8d19f83fa45ee3ee1d3eab5 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a9271f0acf8d19f83fa45ee3ee1d3eab5">match_groups</a> ()</td></tr>
<tr class="memdesc:a9271f0acf8d19f83fa45ee3ee1d3eab5 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the match groups of the most recent match operation. <a href="#a9271f0acf8d19f83fa45ee3ee1d3eab5"></a><br/></td></tr>
<tr class="memitem:aa5520e0fc7df54d7a25d75037e6cdc8a inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#aa5520e0fc7df54d7a25d75037e6cdc8a">match_pos</a> ()</td></tr>
<tr class="memdesc:aa5520e0fc7df54d7a25d75037e6cdc8a inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the position (offset) of the most recent match. <a href="#aa5520e0fc7df54d7a25d75037e6cdc8a"></a><br/></td></tr>
<tr class="memitem:a5e03667fd1cdc1d1fd40a4bc15570b12 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a5e03667fd1cdc1d1fd40a4bc15570b12">next_match</a> ($consume_and_log=true)</td></tr>
<tr class="memdesc:a5e03667fd1cdc1d1fd40a4bc15570b12 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Automation function: returns the next occurrence of any known patterns. <a href="#a5e03667fd1cdc1d1fd40a4bc15570b12"></a><br/></td></tr>
<tr class="memitem:a3028e787442cf1ed9252397ed029b223 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a3028e787442cf1ed9252397ed029b223">peek</a> ($n=1)</td></tr>
<tr class="memdesc:a3028e787442cf1ed9252397ed029b223 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lookahead into the string a given number of bytes. <a href="#a3028e787442cf1ed9252397ed029b223"></a><br/></td></tr>
<tr class="memitem:a546cafdcfc3adeb19959ae14dff10996 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a546cafdcfc3adeb19959ae14dff10996">pos</a> ($new_pos=null)</td></tr>
<tr class="memdesc:a546cafdcfc3adeb19959ae14dff10996 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Getter and setter for the current position (string pointer). <a href="#a546cafdcfc3adeb19959ae14dff10996"></a><br/></td></tr>
<tr class="memitem:a947d15fe4bd13b64afd5eaba8d4d3819 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a947d15fe4bd13b64afd5eaba8d4d3819">pos_shift</a> ($offset)</td></tr>
<tr class="memdesc:a947d15fe4bd13b64afd5eaba8d4d3819 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Moves the string pointer by a given offset. <a href="#a947d15fe4bd13b64afd5eaba8d4d3819"></a><br/></td></tr>
<tr class="memitem:a79c559549e2dd73c3f1892e7609e84a6 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a79c559549e2dd73c3f1892e7609e84a6">remove_pattern</a> ($name)</td></tr>
<tr class="memdesc:a79c559549e2dd73c3f1892e7609e84a6 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allows the caller to remove a named pattern. <a href="#a79c559549e2dd73c3f1892e7609e84a6"></a><br/></td></tr>
<tr class="memitem:a89d1448f666d1be3d5037c69f24eb516 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a89d1448f666d1be3d5037c69f24eb516">reset</a> ()</td></tr>
<tr class="memdesc:a89d1448f666d1be3d5037c69f24eb516 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the scanner. <a href="#a89d1448f666d1be3d5037c69f24eb516"></a><br/></td></tr>
<tr class="memitem:aeae50ecaf6b98a0b76f47c3d04b8deb3 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#aeae50ecaf6b98a0b76f47c3d04b8deb3">rest</a> ()</td></tr>
<tr class="memdesc:aeae50ecaf6b98a0b76f47c3d04b8deb3 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the remaining string. <a href="#aeae50ecaf6b98a0b76f47c3d04b8deb3"></a><br/></td></tr>
<tr class="memitem:a78ddb203c30c2f9e69755ec00c341add inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a78ddb203c30c2f9e69755ec00c341add">scan</a> ($pattern)</td></tr>
<tr class="memdesc:a78ddb203c30c2f9e69755ec00c341add inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scans at the current pointer. <a href="#a78ddb203c30c2f9e69755ec00c341add"></a><br/></td></tr>
<tr class="memitem:aa0e261d4b0c2fce43ba3c264036afd72 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#aa0e261d4b0c2fce43ba3c264036afd72">scan_until</a> ($pattern)</td></tr>
<tr class="memdesc:aa0e261d4b0c2fce43ba3c264036afd72 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scans until the start of a pattern. <a href="#aa0e261d4b0c2fce43ba3c264036afd72"></a><br/></td></tr>
<tr class="memitem:a185d6e780752848cb282add6d9f936bb inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a185d6e780752848cb282add6d9f936bb">terminate</a> ()</td></tr>
<tr class="memdesc:a185d6e780752848cb282add6d9f936bb inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ends scanning of a string. <a href="#a185d6e780752848cb282add6d9f936bb"></a><br/></td></tr>
<tr class="memitem:a6f6665b8df561788b1b2dea40bb394ae inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a6f6665b8df561788b1b2dea40bb394ae">unscan</a> ()</td></tr>
<tr class="memdesc:a6f6665b8df561788b1b2dea40bb394ae inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Revert the most recent scanning operation. <a href="#a6f6665b8df561788b1b2dea40bb394ae"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a278925946650e3c9e2094283512697d1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousEmbeddedWebScript.html#a278925946650e3c9e2094283512697d1">$clean_exit</a> = true</td></tr>
<tr class="memdesc:a278925946650e3c9e2094283512697d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clean exit or inconvenient, mid-token forced exit. <a href="#a278925946650e3c9e2094283512697d1"></a><br/></td></tr>
<tr class="memitem:a9627fb0cc01060902259ee3c9212fad2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousEmbeddedWebScript.html#a9627fb0cc01060902259ee3c9212fad2">$embedded_html</a> = false</td></tr>
<tr class="memdesc:a9627fb0cc01060902259ee3c9212fad2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the source embedded in HTML? <a href="#a9627fb0cc01060902259ee3c9212fad2"></a><br/></td></tr>
<tr class="memitem:a5fdc96de06443379f9dd48de9b80040b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousEmbeddedWebScript.html#a5fdc96de06443379f9dd48de9b80040b">$embedded_server</a> = false</td></tr>
<tr class="memdesc:a5fdc96de06443379f9dd48de9b80040b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the source embedded in a server-side script (e.g. PHP)? <a href="#a5fdc96de06443379f9dd48de9b80040b"></a><br/></td></tr>
<tr class="memitem:aa33f76adc9164f8160785e8f70ff2420"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa33f76adc9164f8160785e8f70ff2420"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousEmbeddedWebScript.html#aa33f76adc9164f8160785e8f70ff2420">$interrupt</a> = false</td></tr>
<tr class="memdesc:aa33f76adc9164f8160785e8f70ff2420"><td class="mdescLeft">&#160;</td><td class="mdescRight">I think this is ignored and obsolete. <br/></td></tr>
<tr class="memitem:a298f32256c797af02dbb7dbf3b2d2040"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a298f32256c797af02dbb7dbf3b2d2040"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousEmbeddedWebScript.html#a298f32256c797af02dbb7dbf3b2d2040">$script_tags</a></td></tr>
<tr class="memdesc:a298f32256c797af02dbb7dbf3b2d2040"><td class="mdescLeft">&#160;</td><td class="mdescRight">closing HTML tag for our code, e.g &lt;/script&gt; <br/></td></tr>
<tr class="memitem:a11065fbf564b463206673a07a0498457"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a11065fbf564b463206673a07a0498457"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousEmbeddedWebScript.html#a11065fbf564b463206673a07a0498457">$server_tags</a> = '/&lt;\?/'</td></tr>
<tr class="memdesc:a11065fbf564b463206673a07a0498457"><td class="mdescLeft">&#160;</td><td class="mdescRight">Opening tag for server-side code. This is a regular expression. <br/></td></tr>
<tr class="inherit_header pub_attribs_classLuminousScanner"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classLuminousScanner')"><img src="closed.png" alt="-"/>&nbsp;Public Attributes inherited from <a class="el" href="classLuminousScanner.html">LuminousScanner</a></td></tr>
<tr class="memitem:a22a1e366c9fbe4e837de693258c5c739 inherit pub_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22a1e366c9fbe4e837de693258c5c739"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a22a1e366c9fbe4e837de693258c5c739">$version</a> = 'master'</td></tr>
<tr class="memdesc:a22a1e366c9fbe4e837de693258c5c739 inherit pub_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">scanner version. <br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:aba37db3108b9a5ec0fda7f18a66fb317"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousEmbeddedWebScript.html#aba37db3108b9a5ec0fda7f18a66fb317">$child_scanners</a> = array()</td></tr>
<tr class="memdesc:aba37db3108b9a5ec0fda7f18a66fb317"><td class="mdescLeft">&#160;</td><td class="mdescRight">Child scanners. <a href="#aba37db3108b9a5ec0fda7f18a66fb317"></a><br/></td></tr>
<tr class="memitem:ace2c028e88c2c295c9f92214eff51f2b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousEmbeddedWebScript.html#ace2c028e88c2c295c9f92214eff51f2b">$dirty_exit_recovery</a> = array()</td></tr>
<tr class="memdesc:ace2c028e88c2c295c9f92214eff51f2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Recovery patterns for when we reach an untimely interrupt. <a href="#ace2c028e88c2c295c9f92214eff51f2b"></a><br/></td></tr>
<tr class="memitem:a463a354548b9e9bf913ca47faf03808a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousEmbeddedWebScript.html#a463a354548b9e9bf913ca47faf03808a">$exit_state</a> = null</td></tr>
<tr class="memdesc:a463a354548b9e9bf913ca47faf03808a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name of interrupted token, in case of a dirty exit. <a href="#a463a354548b9e9bf913ca47faf03808a"></a><br/></td></tr>
<tr class="inherit_header pro_attribs_classLuminousScanner"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classLuminousScanner')"><img src="closed.png" alt="-"/>&nbsp;Protected Attributes inherited from <a class="el" href="classLuminousScanner.html">LuminousScanner</a></td></tr>
<tr class="memitem:af3887911498a250b2cb1fe737dd87df1 inherit pro_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#af3887911498a250b2cb1fe737dd87df1">$case_sensitive</a> = true</td></tr>
<tr class="memdesc:af3887911498a250b2cb1fe737dd87df1 inherit pro_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether or not the language is case sensitive. <a href="#af3887911498a250b2cb1fe737dd87df1"></a><br/></td></tr>
<tr class="memitem:aca257c4da52076f42c6e53d9d0d33dd1 inherit pro_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#aca257c4da52076f42c6e53d9d0d33dd1">$filters</a> = array()</td></tr>
<tr class="memdesc:aca257c4da52076f42c6e53d9d0d33dd1 inherit pro_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Individual token filters. <a href="#aca257c4da52076f42c6e53d9d0d33dd1"></a><br/></td></tr>
<tr class="memitem:adb13455bbeb076cd0f031f050ef31a82 inherit pro_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#adb13455bbeb076cd0f031f050ef31a82">$ident_map</a> = array()</td></tr>
<tr class="memdesc:adb13455bbeb076cd0f031f050ef31a82 inherit pro_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">A map of identifiers and their corresponding token names. <a href="#adb13455bbeb076cd0f031f050ef31a82"></a><br/></td></tr>
<tr class="memitem:a30aaa5d3076a9f28d00f167a1c4eac34 inherit pro_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a30aaa5d3076a9f28d00f167a1c4eac34">$rule_tag_map</a> = array()</td></tr>
<tr class="memdesc:a30aaa5d3076a9f28d00f167a1c4eac34 inherit pro_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rule remappings. <a href="#a30aaa5d3076a9f28d00f167a1c4eac34"></a><br/></td></tr>
<tr class="memitem:ab5a30262ceb4324fdfaac1a7d217ba36 inherit pro_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#ab5a30262ceb4324fdfaac1a7d217ba36">$state_</a> = array()</td></tr>
<tr class="memdesc:ab5a30262ceb4324fdfaac1a7d217ba36 inherit pro_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">State stack. <a href="#ab5a30262ceb4324fdfaac1a7d217ba36"></a><br/></td></tr>
<tr class="memitem:ad3d9ad7f7f14bc9de3dd6b68225ce21c inherit pro_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#ad3d9ad7f7f14bc9de3dd6b68225ce21c">$stream_filters</a> = array()</td></tr>
<tr class="memdesc:ad3d9ad7f7f14bc9de3dd6b68225ce21c inherit pro_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Token stream filters. <a href="#ad3d9ad7f7f14bc9de3dd6b68225ce21c"></a><br/></td></tr>
<tr class="memitem:ab29032700812b580e5d09b6128202286 inherit pro_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#ab29032700812b580e5d09b6128202286">$tokens</a> = array()</td></tr>
<tr class="memdesc:ab29032700812b580e5d09b6128202286 inherit pro_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">The token stream. <a href="#ab29032700812b580e5d09b6128202286"></a><br/></td></tr>
<tr class="memitem:a615d93f42d9290b9fad4d84cc2fd84ec inherit pro_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a615d93f42d9290b9fad4d84cc2fd84ec">$user_defs</a></td></tr>
<tr class="memdesc:a615d93f42d9290b9fad4d84cc2fd84ec inherit pro_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Identifier remappings based on definitions identified in the source code. <a href="#a615d93f42d9290b9fad4d84cc2fd84ec"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_classLuminousScanner"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classLuminousScanner')"><img src="closed.png" alt="-"/>&nbsp;Static Public Member Functions inherited from <a class="el" href="classLuminousScanner.html">LuminousScanner</a></td></tr>
<tr class="memitem:a094a64c9eb09e38ab43c865e1a4482c9 inherit pub_static_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a094a64c9eb09e38ab43c865e1a4482c9">guess_language</a> ($src, $info)</td></tr>
<tr class="memdesc:a094a64c9eb09e38ab43c865e1a4482c9 inherit pub_static_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Language guessing. <a href="#a094a64c9eb09e38ab43c865e1a4482c9"></a><br/></td></tr>
<tr class="inherit_header pro_methods_classLuminousScanner"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classLuminousScanner')"><img src="closed.png" alt="-"/>&nbsp;Protected Member Functions inherited from <a class="el" href="classLuminousScanner.html">LuminousScanner</a></td></tr>
<tr class="memitem:a4cc936af136b39a54db6c7212c04cee7 inherit pro_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a4cc936af136b39a54db6c7212c04cee7">rule_mapper_filter</a> ($tokens)</td></tr>
<tr class="memdesc:a4cc936af136b39a54db6c7212c04cee7 inherit pro_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rule re-mapper filter. <a href="#a4cc936af136b39a54db6c7212c04cee7"></a><br/></td></tr>
<tr class="memitem:a463b3eb270a7afb960ee642bccc0d1b6 inherit pro_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a463b3eb270a7afb960ee642bccc0d1b6">user_def_filter</a> ($token)</td></tr>
<tr class="memdesc:a463b3eb270a7afb960ee642bccc0d1b6 inherit pro_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Filter to highlight identifiers whose definitions are in the source. <a href="#a463b3eb270a7afb960ee642bccc0d1b6"></a><br/></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Superclass for languages which may nest, i.e. web languages. </p>
<p>Web languages get their own special class because they have to deal with server-script code embedded inside them and the potential for languages nested under them (PHP has HTML, HTML has CSS and JavaScript)</p>
<p>The relationship is strictly hierarchical, not recursive descent Meeting a '&lt;?' in CSS bubbles up to HTML and then up to PHP (or whatever). The top-level scanner is ultimately what should have sub-scanner code embedded in its own token stream.</p>
<p>The scanners should be persistent, so only one JavaScript scanner exists even if there are 20 javascript tags. This is so they can keep persistent state, which might be necessary if they are interrupted by server-side tags. For this reason, the <a class="el" href="classLuminousScanner.html#a12220a789d49b7e8f42cf873966b6756" title="the method responsible for tokenization">main()</a> method might be called multiple times, therefore each web sub-scanner should </p>
<ul>
<li>Not rely on keeping state related data in <a class="el" href="classLuminousScanner.html#a12220a789d49b7e8f42cf873966b6756" title="the method responsible for tokenization">main()</a>'s function scope, make it a class variable </li>
<li>flush its token stream every time <a class="el" href="classLuminousScanner.html#a12220a789d49b7e8f42cf873966b6756" title="the method responsible for tokenization">main()</a> is called</li>
</ul>
<p>The init method of the class should be used to set relevant rules based on whether or not the embedded flags are set; and therefore the embedded flags should be set before init is called. </p>
</div><h2>Member Function Documentation</h2>
<a class="anchor" id="a77deb48d41b8a791900a3d5c50813faf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousEmbeddedWebScript::dirty_exit </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$token_name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the exit data to signify the exit is dirty and will need recovering from. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$token_name</td><td>the name of the token which is being interrupted</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Exception</td><td>if no recovery data is associated with the given token. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa5f8bbf0166d4d6531d33ad3319f85e5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousEmbeddedWebScript::resume </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Attempts to recover from a dirty exit. </p>
<p>This method should be called on <b>every</b> iteration of the main loop when <a class="el" href="classLuminousEmbeddedWebScript.html#a278925946650e3c9e2094283512697d1" title="Clean exit or inconvenient, mid-token forced exit.">LuminousEmbeddedWebScript::$clean_exit</a> is <b>FALSE</b>. It will attempt to recover from an interruption which left the scanner in the middle of a token. The remainder of the token will be in <a class="el" href="classScanner.html#a17ac6e2abcb54a6dfaa9abaf95ed839e" title="Get the result of the most recent match operation.">Scanner::match()</a> as usual.</p>
<dl class="section return"><dt>Returns</dt><dd>the name of the token which was interrupted</dd></dl>
<dl class="section note"><dt>Note</dt><dd>there is no reason why a scanner should fail to recover from this, and failing is classed as an implementation error, therefore assertions will be failed and errors will be spewed forth. A failure can either be because no recovery regex is set, or that the recovery regex did not match. The former should never have been tagged as a dirty exit and the latter should be rewritten so it must definitely match, even if the match is zero-length or the remainder of the string. </dd></dl>
</div>
</div>
<a class="anchor" id="a08ce3d66e8ff9217903f68c2a2aa6120"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousEmbeddedWebScript::script_break </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$token_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$match</em> = <code>null</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$pos</em> = <code>null</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks for a script terminator tag inside a matched token. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$token_name</td><td>The token name of the matched text </td></tr>
<tr><td class="paramname">$match</td><td>The string from the last match. If this is left <code>NULL</code> then <a class="el" href="classScanner.html#a17ac6e2abcb54a6dfaa9abaf95ed839e" title="Get the result of the most recent match operation.">Scanner::match()</a> is assumed to hold the match. </td></tr>
<tr><td class="paramname">$pos</td><td>The position of the last match. If this is left <code>NULL</code> then <a class="el" href="classScanner.html#aa5520e0fc7df54d7a25d75037e6cdc8a" title="Get the position (offset) of the most recent match.">Scanner::match_pos()</a> is assumed to hold the offset. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>TRUE</code> if the scanner should break, else <code>FALSE</code> </dd></dl>
<p>This method checks whether the string provided as match contains the string in LuminousEmbeddedWebScript::script_tags. If yes, then it records the substring as $token_name, advances the scan pointer to immediately before the script tags, and returns <code>TRUE</code>. Returning <code>TRUE</code> is a signal that the scanner should break immediately and let its parent scanner take over.</p>
<p>This condition is a 'clean_exit'. </p>
</div>
</div>
<a class="anchor" id="a9725d508c1411b029b43feeab9491af4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousEmbeddedWebScript::server_break </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$token_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$match</em> = <code>null</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$pos</em> = <code>null</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks for a server-side script inside a matched token. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$token_name</td><td>The token name of the matched text </td></tr>
<tr><td class="paramname">$match</td><td>The string from the last match. If this is left <code>NULL</code> then <a class="el" href="classScanner.html#a17ac6e2abcb54a6dfaa9abaf95ed839e" title="Get the result of the most recent match operation.">Scanner::match()</a> is assumed to hold the match. </td></tr>
<tr><td class="paramname">$pos</td><td>The position of the last match. If this is left <code>NULL</code> then <a class="el" href="classScanner.html#aa5520e0fc7df54d7a25d75037e6cdc8a" title="Get the position (offset) of the most recent match.">Scanner::match_pos()</a> is assumed to hold the offset. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>TRUE</code> if the scanner should break, else <code>FALSE</code> </dd></dl>
<p>This method checks whether an interruption by a server-side script tag, LuminousEmbeddedWebScript::server_tags, occurs within a matched token. If it does, this method records the substring up until that point as the provided $token_name, and also sets up a 'dirty exit'. This means that some type was interrupted and we expect to have to recover from it when the server-side language's scanner has ended.</p>
<p>Returning <code>TRUE</code> is a signal that the scanner should break immediately and let its parent scanner take over. </p>
</div>
</div>
<a class="anchor" id="a468d0f77b948817731d32f866b360586"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousEmbeddedWebScript::string </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$s</em> = <code>null</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Getter and setter for the source string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$s</td><td>The new source string (leave as <code>NULL</code> to use this method as a getter) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The current source string</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This method triggers a <a class="el" href="classScanner.html#a89d1448f666d1be3d5037c69f24eb516" title="Reset the scanner.">reset()</a> </dd>
<dd>
Any strings passed into this method are converted to Unix line endings, i.e. <code>\n</code> </dd></dl>
<p>Reimplemented from <a class="el" href="classScanner.html#a577a70297f4d3da0aa2ce4decc66eeea">Scanner</a>.</p>
</div>
</div>
<h2>Member Data Documentation</h2>
<a class="anchor" id="aba37db3108b9a5ec0fda7f18a66fb317"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousEmbeddedWebScript::$child_scanners = array()</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Child scanners. </p>
<p>Persistent storage of child scanners, name =&gt; scanner (instance) </p>
</div>
</div>
<a class="anchor" id="a278925946650e3c9e2094283512697d1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousEmbeddedWebScript::$clean_exit = true</td>
</tr>
</table>
</div><div class="memdoc">
<p>Clean exit or inconvenient, mid-token forced exit. </p>
<p>Signifies whether the program exited due to inconvenient interruption by a parent language (i.e. a server-side langauge), or whether it reached a legitimate break. A server-side language isn't necessarily a dirty exit, but if it comes in the middle of a token it is, because we need to resume from it later. e.g.:</p>
<p>var x = "this is \&lt;?php echo 'a' ?\&gt; string"; </p>
</div>
</div>
<a class="anchor" id="ace2c028e88c2c295c9f92214eff51f2b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousEmbeddedWebScript::$dirty_exit_recovery = array()</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Recovery patterns for when we reach an untimely interrupt. </p>
<p>If we reach a dirty exit, when we resume we need to figure out how to continue consuming the rule that was interrupted. So essentially, this will be a regex which matches the rule without start delimiters.</p>
<p>This is a map of rule =&gt; pattern </p>
</div>
</div>
<a class="anchor" id="a9627fb0cc01060902259ee3c9212fad2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousEmbeddedWebScript::$embedded_html = false</td>
</tr>
</table>
</div><div class="memdoc">
<p>Is the source embedded in HTML? </p>
<p>Embedded in HTML? i.e. do we need to observe tag terminators like &lt;/script&gt; </p>
</div>
</div>
<a class="anchor" id="a5fdc96de06443379f9dd48de9b80040b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousEmbeddedWebScript::$embedded_server = false</td>
</tr>
</table>
</div><div class="memdoc">
<p>Is the source embedded in a server-side script (e.g. PHP)? </p>
<p>Embedded in a server side language? i.e. do we need to break at (for example) &lt;? tags? </p>
</div>
</div>
<a class="anchor" id="a463a354548b9e9bf913ca47faf03808a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousEmbeddedWebScript::$exit_state = null</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Name of interrupted token, in case of a dirty exit. </p>
<p>exit state logs our exit state in the case of a dirty exit: this is the rule that was interrupted. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/core/<a class="el" href="scanner_8class_8php.html">scanner.class.php</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:50 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,10 @@
digraph "LuminousEmbeddedWebScript"
{
edge [fontname="FreeSans",fontsize="10",labelfontname="FreeSans",labelfontsize="10"];
node [fontname="FreeSans",fontsize="10",shape=record];
Node1 [label="LuminousEmbeddedWebScript",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled" fontcolor="black"];
Node2 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node2 [label="LuminousScanner",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classLuminousScanner.html",tooltip="the base class for all scanners"];
Node3 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node3 [label="Scanner",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classScanner.html",tooltip="Base string scanning class."];
}

View File

@ -0,0 +1 @@
ee377fd5e8791c84c193d0a31cdf7c0e

View File

@ -0,0 +1,10 @@
digraph "LuminousEmbeddedWebScript"
{
edge [fontname="FreeSans",fontsize="10",labelfontname="FreeSans",labelfontsize="10"];
node [fontname="FreeSans",fontsize="10",shape=record];
Node1 [label="LuminousEmbeddedWebScript",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled" fontcolor="black"];
Node2 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node2 [label="LuminousScanner",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classLuminousScanner.html",tooltip="the base class for all scanners"];
Node3 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node3 [label="Scanner",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classScanner.html",tooltip="Base string scanning class."];
}

View File

@ -0,0 +1 @@
ee377fd5e8791c84c193d0a31cdf7c0e

View File

@ -0,0 +1,108 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: Member List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">LuminousFilters Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="classLuminousFilters.html">LuminousFilters</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classLuminousFilters.html#a623942677616891fd8d941061401c623">clean_ident</a>($token)</td><td class="entry"><a class="el" href="classLuminousFilters.html">LuminousFilters</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousFilters.html#a83a7be7573ac5b70247e1f07546f70fa">comment_note</a>($token)</td><td class="entry"><a class="el" href="classLuminousFilters.html">LuminousFilters</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousFilters.html#a84e0e2847f7d6b7001894a80c8305ab9">doxygen_arg_length</a>($command)</td><td class="entry"><a class="el" href="classLuminousFilters.html">LuminousFilters</a></td><td class="entry"><span class="mlabel">private</span><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousFilters.html#a164114c951d4149d2c0abbbbaa803cf8">doxygenize</a>($token)</td><td class="entry"><a class="el" href="classLuminousFilters.html">LuminousFilters</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousFilters.html#af3797a9501d392f65449b638d47230b6">doxygenize_cb</a>($matches)</td><td class="entry"><a class="el" href="classLuminousFilters.html">LuminousFilters</a></td><td class="entry"><span class="mlabel">private</span><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousFilters.html#a58ce94f1a8180ac0ecab1378d1d969d2">generic_doc_comment</a>($token)</td><td class="entry"><a class="el" href="classLuminousFilters.html">LuminousFilters</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousFilters.html#a7b50fe8611c983dad41808f9da83386c">oo_stream_filter</a>($tokens)</td><td class="entry"><a class="el" href="classLuminousFilters.html">LuminousFilters</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousFilters.html#a474345e7d70bcebb971cecada698499f">pcre</a>($token, $delimited=true)</td><td class="entry"><a class="el" href="classLuminousFilters.html">LuminousFilters</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousFilters.html#a3ff3ab9bf79e1e3ccc6f93e711e4396f">string</a>($token)</td><td class="entry"><a class="el" href="classLuminousFilters.html">LuminousFilters</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousFilters.html#a10fb6fd692505d6efeabc37754343288">upper_to_constant</a>($token)</td><td class="entry"><a class="el" href="classLuminousFilters.html">LuminousFilters</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:50 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,284 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: LuminousFilters Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pri-static-methods">Static Private Member Functions</a> &#124;
<a href="classLuminousFilters-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">LuminousFilters Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A collection of useful common filters.
<a href="classLuminousFilters.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a623942677616891fd8d941061401c623"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a623942677616891fd8d941061401c623"></a>
static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousFilters.html#a623942677616891fd8d941061401c623">clean_ident</a> ($token)</td></tr>
<tr class="memdesc:a623942677616891fd8d941061401c623"><td class="mdescLeft">&#160;</td><td class="mdescRight">Translates anything of type 'IDENT' to the null type. <br/></td></tr>
<tr class="memitem:a83a7be7573ac5b70247e1f07546f70fa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a83a7be7573ac5b70247e1f07546f70fa"></a>
static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousFilters.html#a83a7be7573ac5b70247e1f07546f70fa">comment_note</a> ($token)</td></tr>
<tr class="memdesc:a83a7be7573ac5b70247e1f07546f70fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Highlights comment notes Highlights keywords in comments, i.e. "NOTE", "XXX", "FIXME", "TODO", "HACK", "BUG". <br/></td></tr>
<tr class="memitem:a164114c951d4149d2c0abbbbaa803cf8"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousFilters.html#a164114c951d4149d2c0abbbbaa803cf8">doxygenize</a> ($token)</td></tr>
<tr class="memdesc:a164114c951d4149d2c0abbbbaa803cf8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Highlights doc-comment tags inside a comment block. <a href="#a164114c951d4149d2c0abbbbaa803cf8"></a><br/></td></tr>
<tr class="memitem:a58ce94f1a8180ac0ecab1378d1d969d2"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousFilters.html#a58ce94f1a8180ac0ecab1378d1d969d2">generic_doc_comment</a> ($token)</td></tr>
<tr class="memdesc:a58ce94f1a8180ac0ecab1378d1d969d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generic filter to highlight JavaDoc, PHPDoc, Doxygen, JSdoc, and similar doc comment syntax. <a href="#a58ce94f1a8180ac0ecab1378d1d969d2"></a><br/></td></tr>
<tr class="memitem:a7b50fe8611c983dad41808f9da83386c"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousFilters.html#a7b50fe8611c983dad41808f9da83386c">oo_stream_filter</a> ($tokens)</td></tr>
<tr class="memdesc:a7b50fe8611c983dad41808f9da83386c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attempts to apply OO syntax highlighting. <a href="#a7b50fe8611c983dad41808f9da83386c"></a><br/></td></tr>
<tr class="memitem:a474345e7d70bcebb971cecada698499f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a474345e7d70bcebb971cecada698499f"></a>
static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousFilters.html#a474345e7d70bcebb971cecada698499f">pcre</a> ($token, $delimited=true)</td></tr>
<tr class="memdesc:a474345e7d70bcebb971cecada698499f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tries to highlight PCRE style regular expression syntax. <br/></td></tr>
<tr class="memitem:a3ff3ab9bf79e1e3ccc6f93e711e4396f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ff3ab9bf79e1e3ccc6f93e711e4396f"></a>
static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousFilters.html#a3ff3ab9bf79e1e3ccc6f93e711e4396f">string</a> ($token)</td></tr>
<tr class="memdesc:a3ff3ab9bf79e1e3ccc6f93e711e4396f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Highlights generic escape sequences in strings Highlights escape sequences in strings. There is no checking on which sequences are legal, this is simply a generic function which checks for \u... unicode, \d... octal, \x... hex and finally just any character following a backslash. <br/></td></tr>
<tr class="memitem:a10fb6fd692505d6efeabc37754343288"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a10fb6fd692505d6efeabc37754343288"></a>
static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousFilters.html#a10fb6fd692505d6efeabc37754343288">upper_to_constant</a> ($token)</td></tr>
<tr class="memdesc:a10fb6fd692505d6efeabc37754343288"><td class="mdescLeft">&#160;</td><td class="mdescRight">Translates any token type of an uppercase/numeric IDENT to 'CONSTANT'. <br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pri-static-methods"></a>
Static Private Member Functions</h2></td></tr>
<tr class="memitem:a84e0e2847f7d6b7001894a80c8305ab9"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousFilters.html#a84e0e2847f7d6b7001894a80c8305ab9">doxygen_arg_length</a> ($command)</td></tr>
<tr class="memdesc:a84e0e2847f7d6b7001894a80c8305ab9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the expected number of arguments to a doc-comment command/tag. <a href="#a84e0e2847f7d6b7001894a80c8305ab9"></a><br/></td></tr>
<tr class="memitem:af3797a9501d392f65449b638d47230b6"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousFilters.html#af3797a9501d392f65449b638d47230b6">doxygenize_cb</a> ($matches)</td></tr>
<tr class="memdesc:af3797a9501d392f65449b638d47230b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">callback to doxygenize Highlights Doxygen-esque doc-comment syntax. This is a callback to <a class="el" href="classLuminousFilters.html#a164114c951d4149d2c0abbbbaa803cf8" title="Highlights doc-comment tags inside a comment block.">doxygenize()</a>. <a href="#af3797a9501d392f65449b638d47230b6"></a><br/></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A collection of useful common filters. </p>
<p>Filters are either stream filters or individual filters. Stream filters operate on the entire token stream, and return the new token stream. Individual filters operate on individual tokens (bound by type), and return the new token. Any publicly available member here is one of those, therefore the return and param documents are omitted. </p>
</div><h2>Member Function Documentation</h2>
<a class="anchor" id="a84e0e2847f7d6b7001894a80c8305ab9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static LuminousFilters::doxygen_arg_length </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$command</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the expected number of arguments to a doc-comment command/tag. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$command</td><td>the name of the command </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The expected number of arguments for a command, this is either 0 or 1 at the moment </dd></dl>
</div>
</div>
<a class="anchor" id="a164114c951d4149d2c0abbbbaa803cf8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static LuminousFilters::doxygenize </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$token</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Highlights doc-comment tags inside a comment block. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classLuminousFilters.html#a58ce94f1a8180ac0ecab1378d1d969d2" title="Generic filter to highlight JavaDoc, PHPDoc, Doxygen, JSdoc, and similar doc comment syntax...">generic_doc_comment</a> </dd></dl>
</div>
</div>
<a class="anchor" id="af3797a9501d392f65449b638d47230b6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static LuminousFilters::doxygenize_cb </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$matches</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>callback to doxygenize Highlights Doxygen-esque doc-comment syntax. This is a callback to <a class="el" href="classLuminousFilters.html#a164114c951d4149d2c0abbbbaa803cf8" title="Highlights doc-comment tags inside a comment block.">doxygenize()</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>the highlighted string </dd></dl>
</div>
</div>
<a class="anchor" id="a58ce94f1a8180ac0ecab1378d1d969d2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static LuminousFilters::generic_doc_comment </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$token</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Generic filter to highlight JavaDoc, PHPDoc, Doxygen, JSdoc, and similar doc comment syntax. </p>
<p>A cursory check will be performed to try to validate that the token really is a doc-comment, it does this by checking for common formats.</p>
<p>If the check is successful, the token will be switched to type 'DOCCOMMENT' and its doc-tags will be highlighted</p>
<p>This is a wrapper around <a class="el" href="classLuminousFilters.html#a164114c951d4149d2c0abbbbaa803cf8" title="Highlights doc-comment tags inside a comment block.">doxygenize()</a>. If the checks are not necessary, or incorrect for your situation, you may instead choose to use <a class="el" href="classLuminousFilters.html#a164114c951d4149d2c0abbbbaa803cf8" title="Highlights doc-comment tags inside a comment block.">doxygenize()</a> directly. </p>
</div>
</div>
<a class="anchor" id="a7b50fe8611c983dad41808f9da83386c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static LuminousFilters::oo_stream_filter </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$tokens</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Attempts to apply OO syntax highlighting. </p>
<p>Tries to apply generic OO syntax highlighting. Any identifer immediately preceding a '.', '::' or '-&gt;' token is mapped to an 'OO'. Any identifer token immediatel following any of those tokens is mapped to an 'OBJ'. This is a stream filter. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/core/filters.class.php</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:50 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,126 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: Member List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">LuminousOptions Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="classLuminousOptions.html">LuminousOptions</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classLuminousOptions.html#a1408903d6d4fb2251935576f07ad984c">$auto_link</a></td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousOptions.html#acbbe98bf278f669a047aa3fafc63f00e">$cache</a></td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousOptions.html#a40a7a05710c6e07ffc2670dff2dc4f99">$cache_age</a></td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousOptions.html#a4dd6a94185818e0ce25382ac380dede8">$failure_tag</a></td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousOptions.html#a9ca11e80317fb5a8d2d4cc45a775f0f1">$format</a></td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousOptions.html#a90ef29c5d273d023c501a1cd1f50f4de">$highlight_lines</a></td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousOptions.html#abf723d25b5f09ae6354998967477f6ac">$html_strict</a></td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousOptions.html#a45fe559dc1ab53dd722c466652848b0c">$include_javascript</a></td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousOptions.html#ad2127af1b05b4c02a02a03509cd42ba9">$include_jquery</a></td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousOptions.html#a053180f6c41b62a4e0742a000655aea9">$line_numbers</a></td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousOptions.html#a30027aaad70cc92226e871c4c6c4824a">$max_height</a></td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousOptions.html#a7cb3de376e2f841d98ba0e20c177a3aa">$relative_root</a></td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousOptions.html#acf2a3ca0e41e847db7fc4e30e7c4608f">$sql_function</a></td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousOptions.html#a49151dba0f00d1357fba1b1c68096eb5">$start_line</a></td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousOptions.html#a4fc507972ad86defd3bcd0c4f721e44b">$theme</a></td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>$verbose</b> (defined in <a class="el" href="classLuminousOptions.html">LuminousOptions</a>)</td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousOptions.html#a2d5811ef7a32a459d55de9e211c324c9">$wrap_width</a></td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>__get</b>($name) (defined in <a class="el" href="classLuminousOptions.html">LuminousOptions</a>)</td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"class="even"><td class="entry"><b>__set</b>($name, $value) (defined in <a class="el" href="classLuminousOptions.html">LuminousOptions</a>)</td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>check_type</b>($value, $type, $nullable=false) (defined in <a class="el" href="classLuminousOptions.html">LuminousOptions</a>)</td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"><span class="mlabel">private</span><span class="mlabel">static</span></td></tr>
<tr bgcolor="#f0f0f0"class="even"><td class="entry"><b>LuminousOptions</b>($opts=null) (defined in <a class="el" href="classLuminousOptions.html">LuminousOptions</a>)</td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>set</b>($nameOrArray, $value=null) (defined in <a class="el" href="classLuminousOptions.html">LuminousOptions</a>)</td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"class="even"><td class="entry"><b>set_bool</b>($key, $value) (defined in <a class="el" href="classLuminousOptions.html">LuminousOptions</a>)</td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>set_format</b>($value) (defined in <a class="el" href="classLuminousOptions.html">LuminousOptions</a>)</td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr bgcolor="#f0f0f0"class="even"><td class="entry"><b>set_height</b>($value) (defined in <a class="el" href="classLuminousOptions.html">LuminousOptions</a>)</td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>set_start_line</b>($value) (defined in <a class="el" href="classLuminousOptions.html">LuminousOptions</a>)</td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr bgcolor="#f0f0f0"class="even"><td class="entry"><b>set_string</b>($key, $value, $nullable=false) (defined in <a class="el" href="classLuminousOptions.html">LuminousOptions</a>)</td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>set_theme</b>($value) (defined in <a class="el" href="classLuminousOptions.html">LuminousOptions</a>)</td><td class="entry"><a class="el" href="classLuminousOptions.html">LuminousOptions</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:50 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,543 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: LuminousOptions Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-static-methods">Static Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classLuminousOptions-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">LuminousOptions Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Options class.
<a href="classLuminousOptions.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab93ed5304452028701c1a7d216e0935b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab93ed5304452028701c1a7d216e0935b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>__get</b> ($name)</td></tr>
<tr class="memitem:acdf6ab45200157d952c12b144fd1e3d8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acdf6ab45200157d952c12b144fd1e3d8"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>__set</b> ($name, $value)</td></tr>
<tr class="memitem:a60b1031aeda5fd4fe1a50ac4c04dcfa1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a60b1031aeda5fd4fe1a50ac4c04dcfa1"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>LuminousOptions</b> ($opts=null)</td></tr>
<tr class="memitem:a6cdd73174a150c31b76e95e44f928371"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6cdd73174a150c31b76e95e44f928371"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>set</b> ($nameOrArray, $value=null)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a94bd8eb6b7e34c1545c1566756237843"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a94bd8eb6b7e34c1545c1566756237843"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>set_bool</b> ($key, $value)</td></tr>
<tr class="memitem:abb6497b127a0ecb880047bd403a39467"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb6497b127a0ecb880047bd403a39467"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>set_format</b> ($value)</td></tr>
<tr class="memitem:adc102dcaacbf1b07a72371ce0ea1e6f4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc102dcaacbf1b07a72371ce0ea1e6f4"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>set_height</b> ($value)</td></tr>
<tr class="memitem:a6f3f96fcaf08e4bb8528d080864ea904"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6f3f96fcaf08e4bb8528d080864ea904"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>set_start_line</b> ($value)</td></tr>
<tr class="memitem:a53eca04faeaf5aa02ff70417364a9e68"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a53eca04faeaf5aa02ff70417364a9e68"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>set_string</b> ($key, $value, $nullable=false)</td></tr>
<tr class="memitem:acbfacef6b12cf7d4abedc1138d64b9fb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acbfacef6b12cf7d4abedc1138d64b9fb"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>set_theme</b> ($value)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pri-static-methods"></a>
Static Private Member Functions</h2></td></tr>
<tr class="memitem:a90f18707e15a1043a96d04f8ecf2c77b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a90f18707e15a1043a96d04f8ecf2c77b"></a>
static&#160;</td><td class="memItemRight" valign="bottom"><b>check_type</b> ($value, $type, $nullable=false)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a1408903d6d4fb2251935576f07ad984c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#a1408903d6d4fb2251935576f07ad984c">$auto_link</a> = true</td></tr>
<tr class="memdesc:a1408903d6d4fb2251935576f07ad984c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hyperlinking. <a href="#a1408903d6d4fb2251935576f07ad984c"></a><br/></td></tr>
<tr class="memitem:acbbe98bf278f669a047aa3fafc63f00e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acbbe98bf278f669a047aa3fafc63f00e"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#acbbe98bf278f669a047aa3fafc63f00e">$cache</a> = true</td></tr>
<tr class="memdesc:acbbe98bf278f669a047aa3fafc63f00e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether to use the built-in cache. <br/></td></tr>
<tr class="memitem:a40a7a05710c6e07ffc2670dff2dc4f99"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#a40a7a05710c6e07ffc2670dff2dc4f99">$cache_age</a> = 7776000</td></tr>
<tr class="memdesc:a40a7a05710c6e07ffc2670dff2dc4f99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum age of cache files in seconds. <a href="#a40a7a05710c6e07ffc2670dff2dc4f99"></a><br/></td></tr>
<tr class="memitem:a4dd6a94185818e0ce25382ac380dede8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#a4dd6a94185818e0ce25382ac380dede8">$failure_tag</a> = 'pre'</td></tr>
<tr class="memdesc:a4dd6a94185818e0ce25382ac380dede8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Failure recovery. <a href="#a4dd6a94185818e0ce25382ac380dede8"></a><br/></td></tr>
<tr class="memitem:a9ca11e80317fb5a8d2d4cc45a775f0f1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#a9ca11e80317fb5a8d2d4cc45a775f0f1">$format</a> = 'html'</td></tr>
<tr class="memdesc:a9ca11e80317fb5a8d2d4cc45a775f0f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Output format. <a href="#a9ca11e80317fb5a8d2d4cc45a775f0f1"></a><br/></td></tr>
<tr class="memitem:a90ef29c5d273d023c501a1cd1f50f4de"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#a90ef29c5d273d023c501a1cd1f50f4de">$highlight_lines</a> = array()</td></tr>
<tr class="memdesc:a90ef29c5d273d023c501a1cd1f50f4de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Highlighting of lines. <a href="#a90ef29c5d273d023c501a1cd1f50f4de"></a><br/></td></tr>
<tr class="memitem:abf723d25b5f09ae6354998967477f6ac"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#abf723d25b5f09ae6354998967477f6ac">$html_strict</a> = false</td></tr>
<tr class="memdesc:abf723d25b5f09ae6354998967477f6ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">HTML strict standards mode. <a href="#abf723d25b5f09ae6354998967477f6ac"></a><br/></td></tr>
<tr class="memitem:a45fe559dc1ab53dd722c466652848b0c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#a45fe559dc1ab53dd722c466652848b0c">$include_javascript</a> = false</td></tr>
<tr class="memdesc:a45fe559dc1ab53dd722c466652848b0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">JavaScript extras. <a href="#a45fe559dc1ab53dd722c466652848b0c"></a><br/></td></tr>
<tr class="memitem:ad2127af1b05b4c02a02a03509cd42ba9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#ad2127af1b05b4c02a02a03509cd42ba9">$include_jquery</a> = false</td></tr>
<tr class="memdesc:ad2127af1b05b4c02a02a03509cd42ba9"><td class="mdescLeft">&#160;</td><td class="mdescRight">jQuery <a href="#ad2127af1b05b4c02a02a03509cd42ba9"></a><br/></td></tr>
<tr class="memitem:a053180f6c41b62a4e0742a000655aea9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#a053180f6c41b62a4e0742a000655aea9">$line_numbers</a> = true</td></tr>
<tr class="memdesc:a053180f6c41b62a4e0742a000655aea9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Line numbering. <a href="#a053180f6c41b62a4e0742a000655aea9"></a><br/></td></tr>
<tr class="memitem:a30027aaad70cc92226e871c4c6c4824a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#a30027aaad70cc92226e871c4c6c4824a">$max_height</a> = -1</td></tr>
<tr class="memdesc:a30027aaad70cc92226e871c4c6c4824a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Widget height constraint. <a href="#a30027aaad70cc92226e871c4c6c4824a"></a><br/></td></tr>
<tr class="memitem:a7cb3de376e2f841d98ba0e20c177a3aa"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#a7cb3de376e2f841d98ba0e20c177a3aa">$relative_root</a> = null</td></tr>
<tr class="memdesc:a7cb3de376e2f841d98ba0e20c177a3aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Location of Luminous relative to your document root. <a href="#a7cb3de376e2f841d98ba0e20c177a3aa"></a><br/></td></tr>
<tr class="memitem:acf2a3ca0e41e847db7fc4e30e7c4608f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#acf2a3ca0e41e847db7fc4e30e7c4608f">$sql_function</a> = null</td></tr>
<tr class="memdesc:acf2a3ca0e41e847db7fc4e30e7c4608f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines an SQL function which can execute queries on a database. <a href="#acf2a3ca0e41e847db7fc4e30e7c4608f"></a><br/></td></tr>
<tr class="memitem:a49151dba0f00d1357fba1b1c68096eb5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#a49151dba0f00d1357fba1b1c68096eb5">$start_line</a> = 1</td></tr>
<tr class="memdesc:a49151dba0f00d1357fba1b1c68096eb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Line number of first line. <a href="#a49151dba0f00d1357fba1b1c68096eb5"></a><br/></td></tr>
<tr class="memitem:a4fc507972ad86defd3bcd0c4f721e44b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#a4fc507972ad86defd3bcd0c4f721e44b">$theme</a> = 'luminous_light.css'</td></tr>
<tr class="memdesc:a4fc507972ad86defd3bcd0c4f721e44b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Theme. <a href="#a4fc507972ad86defd3bcd0c4f721e44b"></a><br/></td></tr>
<tr class="memitem:a7547828a8a6fbf02ffe6015d1f0cfb6d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7547828a8a6fbf02ffe6015d1f0cfb6d"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>$verbose</b> = true</td></tr>
<tr class="memitem:a2d5811ef7a32a459d55de9e211c324c9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#a2d5811ef7a32a459d55de9e211c324c9">$wrap_width</a> = -1</td></tr>
<tr class="memdesc:a2d5811ef7a32a459d55de9e211c324c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Word wrapping. <a href="#a2d5811ef7a32a459d55de9e211c324c9"></a><br/></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Options class. </p>
<dl class="section warning"><dt>Warning</dt><dd>This object's structure isn't guaranteed to be stable so don't read or write these directly. As a user, you should be using <a class="el" href="classluminous.html#ace722a2ba2c2251eabccf6f0d18bcbe9" title="Sets the given option to the given value.">luminous::set()</a> and <a class="el" href="classluminous.html#af5888c20eb26757b5bd9af198e44ec96" title="Gets a setting&#39;s value.">luminous::setting()</a></dd></dl>
<p>We use a fair bit of PHP trickery in the implementation here. The keener among you will notice that the options are all private: don't worry about that. We override the __set() method to apply option specific validation. Options can be written to as normal.</p>
<p>The option variable names correspond with option strings that can be passed through <a class="el" href="classluminous.html#ace722a2ba2c2251eabccf6f0d18bcbe9" title="Sets the given option to the given value.">luminous::set()</a>, however, for historical reasons, underscores can be replaced with dashed in the call. </p>
</div><h2>Member Data Documentation</h2>
<a class="anchor" id="a1408903d6d4fb2251935576f07ad984c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousOptions::$auto_link = true</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Hyperlinking. </p>
<p>If the formatter supports hyper-linking, this setting controls whether or not URLs will be automatically linked </p>
</div>
</div>
<a class="anchor" id="a40a7a05710c6e07ffc2670dff2dc4f99"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousOptions::$cache_age = 7776000</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum age of cache files in seconds. </p>
<p>Cache files which have not been read for this length of time will be removed from the file system. The file's 'mtime' is used to calculate when it was last used, and a cache hit triggers a 'touch'</p>
<p>Set to -1 or 0 to disable cache purges </p>
</div>
</div>
<a class="anchor" id="a4dd6a94185818e0ce25382ac380dede8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousOptions::$failure_tag = 'pre'</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Failure recovery. </p>
<p>If Luminous hits some kind of unrecoverable internal error, it should return the input source code back to you. If you want, it can be wrapped in an HTML tag. Hopefully you will never see this. </p>
</div>
</div>
<a class="anchor" id="a9ca11e80317fb5a8d2d4cc45a775f0f1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousOptions::$format = 'html'</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Output format. </p>
<p>Chooses which output format to use. Current valid settings are: </p>
<ul>
<li>'html' - standard HTML element, contained in a &lt;div&gt; with class 'luminous', CSS is not included and must be included on the page separately (probably with <a class="el" href="classluminous.html#aec66d6c5d22ff1254f8c5ff73fb0f71d" title="Gets the markup you need to include in your web page.">luminous::head_html()</a>) </li>
<li>'html-full' - A complete HTML document. CSS is included. </li>
<li>'html-inline' - Very similar to 'html' but geared towards inline display. Probably not very useful. </li>
<li>'latex' - A full LaTeX document </li>
<li>'none' or <code>NULL</code> - No formatter. Internal XML format is returned. You probably don't want this. </li>
</ul>
</div>
</div>
<a class="anchor" id="a90ef29c5d273d023c501a1cd1f50f4de"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousOptions::$highlight_lines = array()</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Highlighting of lines. </p>
<p>If the formatter supports highlighting lines, this setting allows the caller to specify the set of line numbers to highlight </p>
</div>
</div>
<a class="anchor" id="abf723d25b5f09ae6354998967477f6ac"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousOptions::$html_strict = false</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>HTML strict standards mode. </p>
<p>The HTML4-strict doctype disallows a few things which are technically useful. Set this to true if you don't want Luminous to break validation on your HTML4-strict document. Luminous should be valid HTML4 loose/transitional and HTML5 without needing to enable this. </p>
</div>
</div>
<a class="anchor" id="a45fe559dc1ab53dd722c466652848b0c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousOptions::$include_javascript = false</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>JavaScript extras. </p>
<p>controls whether <a class="el" href="classluminous.html#aec66d6c5d22ff1254f8c5ff73fb0f71d" title="Gets the markup you need to include in your web page.">luminous::head_html()</a> outputs the javascript 'extras'. </p>
</div>
</div>
<a class="anchor" id="ad2127af1b05b4c02a02a03509cd42ba9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousOptions::$include_jquery = false</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>jQuery </p>
<p>Controls whether <a class="el" href="classluminous.html#aec66d6c5d22ff1254f8c5ff73fb0f71d" title="Gets the markup you need to include in your web page.">luminous::head_html()</a> outputs jQuery, which is required for the JavaScript extras. This has no effect if $include_javascript is false. </p>
</div>
</div>
<a class="anchor" id="a053180f6c41b62a4e0742a000655aea9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousOptions::$line_numbers = true</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Line numbering. </p>
<p>If the formatter supports line numbering, this setting controls whether or not lines should be numbered </p>
</div>
</div>
<a class="anchor" id="a30027aaad70cc92226e871c4c6c4824a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousOptions::$max_height = -1</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Widget height constraint. </p>
<p>If the formatter supports heigh constraint, this setting controls whether or not to constrain the widget's height, and to what. </p>
</div>
</div>
<a class="anchor" id="a7cb3de376e2f841d98ba0e20c177a3aa"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousOptions::$relative_root = null</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Location of Luminous relative to your document root. </p>
<p>If you use <a class="el" href="classluminous.html#aec66d6c5d22ff1254f8c5ff73fb0f71d" title="Gets the markup you need to include in your web page.">luminous::head_html()</a>, it has to try to figure out the path to the style/ directory so that it can return a correct URL to the necessary stylesheets. Luminous may get this wrong in some situations, specifically it is currently impossible to get this right if Luminous exists on the filesystem outside of the document root, and you have used a symbolic link to put it inside. For this reason, this setting allows you to override the path.</p>
<p>e.g. If you set this to '/extern/highlighter', the stylesheets will be linked with &lt;link rel='stylesheet' href='/extern/highlighter/style/luminous.css'&gt; </p>
</div>
</div>
<a class="anchor" id="acf2a3ca0e41e847db7fc4e30e7c4608f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousOptions::$sql_function = null</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Defines an SQL function which can execute queries on a database. </p>
<p>An SQL database can be used as a replacement for the file-system cache database. This function should act similarly to the mysql_query function: it should take a single argument (the query string) and return: </p>
<ul>
<li>boolean <code>false</code> if the query fails </li>
<li>boolean <code>true</code> if the query succeeds but has no return value </li>
<li>An array of associative arrays if the query returns rows (each element is a row, and each row is an map keyed by field name) </li>
</ul>
</div>
</div>
<a class="anchor" id="a49151dba0f00d1357fba1b1c68096eb5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousOptions::$start_line = 1</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Line number of first line. </p>
<p>If the formatter supports line numbering, this setting controls number of the first line </p>
</div>
</div>
<a class="anchor" id="a4fc507972ad86defd3bcd0c4f721e44b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousOptions::$theme = 'luminous_light.css'</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Theme. </p>
<p>The default theme to use. This is observed by the HTML-full and LaTeX formatters, it is also read by <a class="el" href="classluminous.html#aec66d6c5d22ff1254f8c5ff73fb0f71d" title="Gets the markup you need to include in your web page.">luminous::head_html()</a>.</p>
<p>This should be a valid theme which exists in style/ </p>
</div>
</div>
<a class="anchor" id="a2d5811ef7a32a459d55de9e211c324c9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousOptions::$wrap_width = -1</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Word wrapping. </p>
<p>If the formatter supports line wrapping, lines will be wrapped at this number of characters (0 or -1 to disable) </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/options.class.php</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:50 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,156 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: Member List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">LuminousScanner Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="classLuminousScanner.html">LuminousScanner</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#af3887911498a250b2cb1fe737dd87df1">$case_sensitive</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#aca257c4da52076f42c6e53d9d0d33dd1">$filters</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#adb13455bbeb076cd0f031f050ef31a82">$ident_map</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a30aaa5d3076a9f28d00f167a1c4eac34">$rule_tag_map</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#ab5a30262ceb4324fdfaac1a7d217ba36">$state_</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#ad3d9ad7f7f14bc9de3dd6b68225ce21c">$stream_filters</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#ab29032700812b580e5d09b6128202286">$tokens</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a615d93f42d9290b9fad4d84cc2fd84ec">$user_defs</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a22a1e366c9fbe4e837de693258c5c739">$version</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a493a069a6ba279b279865111b8e8ffd4">__construct</a>($src=null)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a17a50bdadaa49f0638638d5c6da7090c">add_filter</a>($arg1, $arg2, $arg3=null)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a047ae1afbf5563184e3dc67ecfb90a8c">add_identifier_mapping</a>($name, $matches)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a4cb6935d759ee0c75fa01b75e2d0ec04">add_pattern</a>($name, $pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a32eb459cd8ad20b8ea3403907d7f2e52">add_stream_filter</a>($arg1, $arg2=null)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a77abc2d2de424e73d1ee659fd9001e4a">bol</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#ae483fc35eae064c75f8b5ca105826757">check</a>($pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a8ad6032d3a1f955608905c10a864aee6">eol</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a23543739aee09e2e1961a556a9672c7d">eos</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a154d424c925ed0d58e033f1e71ceef03">get</a>($n=1)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#ac8beec743c18d54cec51273b3bb7f3b5">get_next</a>($patterns)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a21f59cd38d7ed3ccd43955386b6aa14e">get_next_named</a>($patterns)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a57774c7a298bb43c1c4406a830d386a6">get_next_strpos</a>($patterns)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a094a64c9eb09e38ab43c865e1a4482c9">guess_language</a>($src, $info)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a0a7907663241caffb546ef22bb35d870">highlight</a>($src)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a90bacd70c30eb1d76659c0586f0683d2">index</a>($pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#af0aecba631e56a3005157cfbe84d6b67">init</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a12220a789d49b7e8f42cf873966b6756">main</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a6efd3dada50a424d7f30b7f9afac5fc0">map_identifier_filter</a>($token)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a17ac6e2abcb54a6dfaa9abaf95ed839e">match</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#aa933ee80eb310785c75ab7b03ed01885">match_group</a>($g=0)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a9271f0acf8d19f83fa45ee3ee1d3eab5">match_groups</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#aa5520e0fc7df54d7a25d75037e6cdc8a">match_pos</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#ae974cbfb732f008a79482ffc4f11d398">nestable_token</a>($token_name, $open, $close)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a5e03667fd1cdc1d1fd40a4bc15570b12">next_match</a>($consume_and_log=true)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a3028e787442cf1ed9252397ed029b223">peek</a>($n=1)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a614e490335cf64375c52d57edfb398ad">pop</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a546cafdcfc3adeb19959ae14dff10996">pos</a>($new_pos=null)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a947d15fe4bd13b64afd5eaba8d4d3819">pos_shift</a>($offset)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#add1da033592e8f944660b9e29088a2ac">push</a>($state)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#aa61dbaafd8801e40094cbff52f7b22f1">record</a>($string, $type, $pre_escaped=false)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a48fabeb9791b36ace2b46dd8f91a4afa">record_range</a>($from, $to, $type)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a80c4b9fff3a38e90e04cda38eb075040">remove_filter</a>($name)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a79c559549e2dd73c3f1892e7609e84a6">remove_pattern</a>($name)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a25c4c1f42c64a07ce87c19f3992a0fba">remove_stream_filter</a>($name)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a89d1448f666d1be3d5037c69f24eb516">reset</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#aeae50ecaf6b98a0b76f47c3d04b8deb3">rest</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a4cc936af136b39a54db6c7212c04cee7">rule_mapper_filter</a>($tokens)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a78ddb203c30c2f9e69755ec00c341add">scan</a>($pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#aa0e261d4b0c2fce43ba3c264036afd72">scan_until</a>($pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#ab06dcdea11ff9a78168547b4c84c650c">skip_whitespace</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a4156922baa33783377f7904fd2d4cee5">start</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a23e2cf34969c3d39cd34a4b5ce6810ca">state</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a577a70297f4d3da0aa2ce4decc66eeea">string</a>($s=null)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a809c11561c650c7784edd3d06243b8b5">tagged</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a185d6e780752848cb282add6d9f936bb">terminate</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#ae381e3000c83ae4cb2259d0ae77a14ab">token_array</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a6f6665b8df561788b1b2dea40bb394ae">unscan</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a463b3eb270a7afb960ee642bccc0d1b6">user_def_filter</a>($token)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:50 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,984 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: LuminousScanner Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classLuminousScanner-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">LuminousScanner Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>the base class for all scanners
<a href="classLuminousScanner.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for LuminousScanner:</div>
<div class="dyncontent">
<div class="center"><img src="classLuminousScanner__inherit__graph.png" border="0" usemap="#LuminousScanner_inherit__map" alt="Inheritance graph"/></div>
<map name="LuminousScanner_inherit__map" id="LuminousScanner_inherit__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for LuminousScanner:</div>
<div class="dyncontent">
<div class="center"><img src="classLuminousScanner__coll__graph.png" border="0" usemap="#LuminousScanner_coll__map" alt="Collaboration graph"/></div>
<map name="LuminousScanner_coll__map" id="LuminousScanner_coll__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a493a069a6ba279b279865111b8e8ffd4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a493a069a6ba279b279865111b8e8ffd4"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a493a069a6ba279b279865111b8e8ffd4">__construct</a> ($src=null)</td></tr>
<tr class="memdesc:a493a069a6ba279b279865111b8e8ffd4"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor <br/></td></tr>
<tr class="memitem:a17a50bdadaa49f0638638d5c6da7090c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a17a50bdadaa49f0638638d5c6da7090c">add_filter</a> ($arg1, $arg2, $arg3=null)</td></tr>
<tr class="memdesc:a17a50bdadaa49f0638638d5c6da7090c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add an individual token filter. <a href="#a17a50bdadaa49f0638638d5c6da7090c"></a><br/></td></tr>
<tr class="memitem:a047ae1afbf5563184e3dc67ecfb90a8c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a047ae1afbf5563184e3dc67ecfb90a8c">add_identifier_mapping</a> ($name, $matches)</td></tr>
<tr class="memdesc:a047ae1afbf5563184e3dc67ecfb90a8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds an identifier mapping which is later analysed by map_identifier_filter. <a href="#a047ae1afbf5563184e3dc67ecfb90a8c"></a><br/></td></tr>
<tr class="memitem:a32eb459cd8ad20b8ea3403907d7f2e52"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a32eb459cd8ad20b8ea3403907d7f2e52">add_stream_filter</a> ($arg1, $arg2=null)</td></tr>
<tr class="memdesc:a32eb459cd8ad20b8ea3403907d7f2e52"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a stream filter. <a href="#a32eb459cd8ad20b8ea3403907d7f2e52"></a><br/></td></tr>
<tr class="memitem:a0a7907663241caffb546ef22bb35d870"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a0a7907663241caffb546ef22bb35d870">highlight</a> ($src)</td></tr>
<tr class="memdesc:a0a7907663241caffb546ef22bb35d870"><td class="mdescLeft">&#160;</td><td class="mdescRight">Public convenience function for setting the string and highlighting it. <a href="#a0a7907663241caffb546ef22bb35d870"></a><br/></td></tr>
<tr class="memitem:af0aecba631e56a3005157cfbe84d6b67"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#af0aecba631e56a3005157cfbe84d6b67">init</a> ()</td></tr>
<tr class="memdesc:af0aecba631e56a3005157cfbe84d6b67"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set up the scanner immediately prior to tokenization. <a href="#af0aecba631e56a3005157cfbe84d6b67"></a><br/></td></tr>
<tr class="memitem:a12220a789d49b7e8f42cf873966b6756"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a12220a789d49b7e8f42cf873966b6756">main</a> ()</td></tr>
<tr class="memdesc:a12220a789d49b7e8f42cf873966b6756"><td class="mdescLeft">&#160;</td><td class="mdescRight">the method responsible for tokenization <a href="#a12220a789d49b7e8f42cf873966b6756"></a><br/></td></tr>
<tr class="memitem:a6efd3dada50a424d7f30b7f9afac5fc0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a6efd3dada50a424d7f30b7f9afac5fc0">map_identifier_filter</a> ($token)</td></tr>
<tr class="memdesc:a6efd3dada50a424d7f30b7f9afac5fc0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Identifier mapping filter. <a href="#a6efd3dada50a424d7f30b7f9afac5fc0"></a><br/></td></tr>
<tr class="memitem:ae974cbfb732f008a79482ffc4f11d398"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#ae974cbfb732f008a79482ffc4f11d398">nestable_token</a> ($token_name, $open, $close)</td></tr>
<tr class="memdesc:ae974cbfb732f008a79482ffc4f11d398"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handles tokens that may nest inside themselves. <a href="#ae974cbfb732f008a79482ffc4f11d398"></a><br/></td></tr>
<tr class="memitem:a614e490335cf64375c52d57edfb398ad"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a614e490335cf64375c52d57edfb398ad">pop</a> ()</td></tr>
<tr class="memdesc:a614e490335cf64375c52d57edfb398ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pops the top element of the stack, and returns it. <a href="#a614e490335cf64375c52d57edfb398ad"></a><br/></td></tr>
<tr class="memitem:add1da033592e8f944660b9e29088a2ac"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="add1da033592e8f944660b9e29088a2ac"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#add1da033592e8f944660b9e29088a2ac">push</a> ($<a class="el" href="classLuminousScanner.html#a23e2cf34969c3d39cd34a4b5ce6810ca">state</a>)</td></tr>
<tr class="memdesc:add1da033592e8f944660b9e29088a2ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pushes some data onto the stack. <br/></td></tr>
<tr class="memitem:aa61dbaafd8801e40094cbff52f7b22f1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#aa61dbaafd8801e40094cbff52f7b22f1">record</a> ($<a class="el" href="classScanner.html#a577a70297f4d3da0aa2ce4decc66eeea">string</a>, $type, $pre_escaped=false)</td></tr>
<tr class="memdesc:aa61dbaafd8801e40094cbff52f7b22f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Records a string as a given token type. <a href="#aa61dbaafd8801e40094cbff52f7b22f1"></a><br/></td></tr>
<tr class="memitem:a48fabeb9791b36ace2b46dd8f91a4afa"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a48fabeb9791b36ace2b46dd8f91a4afa">record_range</a> ($from, $to, $type)</td></tr>
<tr class="memdesc:a48fabeb9791b36ace2b46dd8f91a4afa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper function to record a range of the string. <a href="#a48fabeb9791b36ace2b46dd8f91a4afa"></a><br/></td></tr>
<tr class="memitem:a80c4b9fff3a38e90e04cda38eb075040"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80c4b9fff3a38e90e04cda38eb075040"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a80c4b9fff3a38e90e04cda38eb075040">remove_filter</a> ($name)</td></tr>
<tr class="memdesc:a80c4b9fff3a38e90e04cda38eb075040"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes the individual filter(s) with the given name. <br/></td></tr>
<tr class="memitem:a25c4c1f42c64a07ce87c19f3992a0fba"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a25c4c1f42c64a07ce87c19f3992a0fba"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a25c4c1f42c64a07ce87c19f3992a0fba">remove_stream_filter</a> ($name)</td></tr>
<tr class="memdesc:a25c4c1f42c64a07ce87c19f3992a0fba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes the stream filter(s) with the given name. <br/></td></tr>
<tr class="memitem:ab06dcdea11ff9a78168547b4c84c650c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#ab06dcdea11ff9a78168547b4c84c650c">skip_whitespace</a> ()</td></tr>
<tr class="memdesc:ab06dcdea11ff9a78168547b4c84c650c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Skips whitespace, and records it as a null token. <a href="#ab06dcdea11ff9a78168547b4c84c650c"></a><br/></td></tr>
<tr class="memitem:a4156922baa33783377f7904fd2d4cee5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4156922baa33783377f7904fd2d4cee5"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a4156922baa33783377f7904fd2d4cee5">start</a> ()</td></tr>
<tr class="memdesc:a4156922baa33783377f7904fd2d4cee5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flushes the token stream. <br/></td></tr>
<tr class="memitem:a23e2cf34969c3d39cd34a4b5ce6810ca"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a23e2cf34969c3d39cd34a4b5ce6810ca"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a23e2cf34969c3d39cd34a4b5ce6810ca">state</a> ()</td></tr>
<tr class="memdesc:a23e2cf34969c3d39cd34a4b5ce6810ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the top element on $state_ or null if it is empty. <br/></td></tr>
<tr class="memitem:a809c11561c650c7784edd3d06243b8b5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a809c11561c650c7784edd3d06243b8b5">tagged</a> ()</td></tr>
<tr class="memdesc:a809c11561c650c7784edd3d06243b8b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the XML representation of the token stream. <a href="#a809c11561c650c7784edd3d06243b8b5"></a><br/></td></tr>
<tr class="memitem:ae381e3000c83ae4cb2259d0ae77a14ab"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#ae381e3000c83ae4cb2259d0ae77a14ab">token_array</a> ()</td></tr>
<tr class="memdesc:ae381e3000c83ae4cb2259d0ae77a14ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the token array. <a href="#ae381e3000c83ae4cb2259d0ae77a14ab"></a><br/></td></tr>
<tr class="inherit_header pub_methods_classScanner"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classScanner')"><img src="closed.png" alt="-"/>&nbsp;Public Member Functions inherited from <a class="el" href="classScanner.html">Scanner</a></td></tr>
<tr class="memitem:a4cb6935d759ee0c75fa01b75e2d0ec04 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a4cb6935d759ee0c75fa01b75e2d0ec04">add_pattern</a> ($name, $pattern)</td></tr>
<tr class="memdesc:a4cb6935d759ee0c75fa01b75e2d0ec04 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allows the caller to add a predefined named pattern. <a href="#a4cb6935d759ee0c75fa01b75e2d0ec04"></a><br/></td></tr>
<tr class="memitem:a77abc2d2de424e73d1ee659fd9001e4a inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a77abc2d2de424e73d1ee659fd9001e4a">bol</a> ()</td></tr>
<tr class="memdesc:a77abc2d2de424e73d1ee659fd9001e4a inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Beginning of line? <a href="#a77abc2d2de424e73d1ee659fd9001e4a"></a><br/></td></tr>
<tr class="memitem:ae483fc35eae064c75f8b5ca105826757 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#ae483fc35eae064c75f8b5ca105826757">check</a> ($pattern)</td></tr>
<tr class="memdesc:ae483fc35eae064c75f8b5ca105826757 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Non-consuming lookahead. <a href="#ae483fc35eae064c75f8b5ca105826757"></a><br/></td></tr>
<tr class="memitem:a8ad6032d3a1f955608905c10a864aee6 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a8ad6032d3a1f955608905c10a864aee6">eol</a> ()</td></tr>
<tr class="memdesc:a8ad6032d3a1f955608905c10a864aee6 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">End of line? <a href="#a8ad6032d3a1f955608905c10a864aee6"></a><br/></td></tr>
<tr class="memitem:a23543739aee09e2e1961a556a9672c7d inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a23543739aee09e2e1961a556a9672c7d">eos</a> ()</td></tr>
<tr class="memdesc:a23543739aee09e2e1961a556a9672c7d inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">End of string? <a href="#a23543739aee09e2e1961a556a9672c7d"></a><br/></td></tr>
<tr class="memitem:a154d424c925ed0d58e033f1e71ceef03 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a154d424c925ed0d58e033f1e71ceef03">get</a> ($n=1)</td></tr>
<tr class="memdesc:a154d424c925ed0d58e033f1e71ceef03 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Consume a given number of bytes. <a href="#a154d424c925ed0d58e033f1e71ceef03"></a><br/></td></tr>
<tr class="memitem:ac8beec743c18d54cec51273b3bb7f3b5 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#ac8beec743c18d54cec51273b3bb7f3b5">get_next</a> ($patterns)</td></tr>
<tr class="memdesc:ac8beec743c18d54cec51273b3bb7f3b5 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Look for the next occurrence of a set of patterns. <a href="#ac8beec743c18d54cec51273b3bb7f3b5"></a><br/></td></tr>
<tr class="memitem:a21f59cd38d7ed3ccd43955386b6aa14e inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a21f59cd38d7ed3ccd43955386b6aa14e">get_next_named</a> ($patterns)</td></tr>
<tr class="memdesc:a21f59cd38d7ed3ccd43955386b6aa14e inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the index of the next occurrence of a named pattern. <a href="#a21f59cd38d7ed3ccd43955386b6aa14e"></a><br/></td></tr>
<tr class="memitem:a57774c7a298bb43c1c4406a830d386a6 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a57774c7a298bb43c1c4406a830d386a6">get_next_strpos</a> ($patterns)</td></tr>
<tr class="memdesc:a57774c7a298bb43c1c4406a830d386a6 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Look for the next occurrence of a set of substrings. <a href="#a57774c7a298bb43c1c4406a830d386a6"></a><br/></td></tr>
<tr class="memitem:a90bacd70c30eb1d76659c0586f0683d2 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a90bacd70c30eb1d76659c0586f0683d2">index</a> ($pattern)</td></tr>
<tr class="memdesc:a90bacd70c30eb1d76659c0586f0683d2 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the index of the next occurrence of a pattern. <a href="#a90bacd70c30eb1d76659c0586f0683d2"></a><br/></td></tr>
<tr class="memitem:a17ac6e2abcb54a6dfaa9abaf95ed839e inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a17ac6e2abcb54a6dfaa9abaf95ed839e">match</a> ()</td></tr>
<tr class="memdesc:a17ac6e2abcb54a6dfaa9abaf95ed839e inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the result of the most recent match operation. <a href="#a17ac6e2abcb54a6dfaa9abaf95ed839e"></a><br/></td></tr>
<tr class="memitem:aa933ee80eb310785c75ab7b03ed01885 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#aa933ee80eb310785c75ab7b03ed01885">match_group</a> ($g=0)</td></tr>
<tr class="memdesc:aa933ee80eb310785c75ab7b03ed01885 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a group from the most recent match operation. <a href="#aa933ee80eb310785c75ab7b03ed01885"></a><br/></td></tr>
<tr class="memitem:a9271f0acf8d19f83fa45ee3ee1d3eab5 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a9271f0acf8d19f83fa45ee3ee1d3eab5">match_groups</a> ()</td></tr>
<tr class="memdesc:a9271f0acf8d19f83fa45ee3ee1d3eab5 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the match groups of the most recent match operation. <a href="#a9271f0acf8d19f83fa45ee3ee1d3eab5"></a><br/></td></tr>
<tr class="memitem:aa5520e0fc7df54d7a25d75037e6cdc8a inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#aa5520e0fc7df54d7a25d75037e6cdc8a">match_pos</a> ()</td></tr>
<tr class="memdesc:aa5520e0fc7df54d7a25d75037e6cdc8a inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the position (offset) of the most recent match. <a href="#aa5520e0fc7df54d7a25d75037e6cdc8a"></a><br/></td></tr>
<tr class="memitem:a5e03667fd1cdc1d1fd40a4bc15570b12 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a5e03667fd1cdc1d1fd40a4bc15570b12">next_match</a> ($consume_and_log=true)</td></tr>
<tr class="memdesc:a5e03667fd1cdc1d1fd40a4bc15570b12 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Automation function: returns the next occurrence of any known patterns. <a href="#a5e03667fd1cdc1d1fd40a4bc15570b12"></a><br/></td></tr>
<tr class="memitem:a3028e787442cf1ed9252397ed029b223 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a3028e787442cf1ed9252397ed029b223">peek</a> ($n=1)</td></tr>
<tr class="memdesc:a3028e787442cf1ed9252397ed029b223 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lookahead into the string a given number of bytes. <a href="#a3028e787442cf1ed9252397ed029b223"></a><br/></td></tr>
<tr class="memitem:a546cafdcfc3adeb19959ae14dff10996 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a546cafdcfc3adeb19959ae14dff10996">pos</a> ($new_pos=null)</td></tr>
<tr class="memdesc:a546cafdcfc3adeb19959ae14dff10996 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Getter and setter for the current position (string pointer). <a href="#a546cafdcfc3adeb19959ae14dff10996"></a><br/></td></tr>
<tr class="memitem:a947d15fe4bd13b64afd5eaba8d4d3819 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a947d15fe4bd13b64afd5eaba8d4d3819">pos_shift</a> ($offset)</td></tr>
<tr class="memdesc:a947d15fe4bd13b64afd5eaba8d4d3819 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Moves the string pointer by a given offset. <a href="#a947d15fe4bd13b64afd5eaba8d4d3819"></a><br/></td></tr>
<tr class="memitem:a79c559549e2dd73c3f1892e7609e84a6 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a79c559549e2dd73c3f1892e7609e84a6">remove_pattern</a> ($name)</td></tr>
<tr class="memdesc:a79c559549e2dd73c3f1892e7609e84a6 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allows the caller to remove a named pattern. <a href="#a79c559549e2dd73c3f1892e7609e84a6"></a><br/></td></tr>
<tr class="memitem:a89d1448f666d1be3d5037c69f24eb516 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a89d1448f666d1be3d5037c69f24eb516">reset</a> ()</td></tr>
<tr class="memdesc:a89d1448f666d1be3d5037c69f24eb516 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the scanner. <a href="#a89d1448f666d1be3d5037c69f24eb516"></a><br/></td></tr>
<tr class="memitem:aeae50ecaf6b98a0b76f47c3d04b8deb3 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#aeae50ecaf6b98a0b76f47c3d04b8deb3">rest</a> ()</td></tr>
<tr class="memdesc:aeae50ecaf6b98a0b76f47c3d04b8deb3 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the remaining string. <a href="#aeae50ecaf6b98a0b76f47c3d04b8deb3"></a><br/></td></tr>
<tr class="memitem:a78ddb203c30c2f9e69755ec00c341add inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a78ddb203c30c2f9e69755ec00c341add">scan</a> ($pattern)</td></tr>
<tr class="memdesc:a78ddb203c30c2f9e69755ec00c341add inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scans at the current pointer. <a href="#a78ddb203c30c2f9e69755ec00c341add"></a><br/></td></tr>
<tr class="memitem:aa0e261d4b0c2fce43ba3c264036afd72 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#aa0e261d4b0c2fce43ba3c264036afd72">scan_until</a> ($pattern)</td></tr>
<tr class="memdesc:aa0e261d4b0c2fce43ba3c264036afd72 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scans until the start of a pattern. <a href="#aa0e261d4b0c2fce43ba3c264036afd72"></a><br/></td></tr>
<tr class="memitem:a577a70297f4d3da0aa2ce4decc66eeea inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a577a70297f4d3da0aa2ce4decc66eeea">string</a> ($s=null)</td></tr>
<tr class="memdesc:a577a70297f4d3da0aa2ce4decc66eeea inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Getter and setter for the source string. <a href="#a577a70297f4d3da0aa2ce4decc66eeea"></a><br/></td></tr>
<tr class="memitem:a185d6e780752848cb282add6d9f936bb inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a185d6e780752848cb282add6d9f936bb">terminate</a> ()</td></tr>
<tr class="memdesc:a185d6e780752848cb282add6d9f936bb inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ends scanning of a string. <a href="#a185d6e780752848cb282add6d9f936bb"></a><br/></td></tr>
<tr class="memitem:a6f6665b8df561788b1b2dea40bb394ae inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a6f6665b8df561788b1b2dea40bb394ae">unscan</a> ()</td></tr>
<tr class="memdesc:a6f6665b8df561788b1b2dea40bb394ae inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Revert the most recent scanning operation. <a href="#a6f6665b8df561788b1b2dea40bb394ae"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a094a64c9eb09e38ab43c865e1a4482c9"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a094a64c9eb09e38ab43c865e1a4482c9">guess_language</a> ($src, $info)</td></tr>
<tr class="memdesc:a094a64c9eb09e38ab43c865e1a4482c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Language guessing. <a href="#a094a64c9eb09e38ab43c865e1a4482c9"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a22a1e366c9fbe4e837de693258c5c739"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22a1e366c9fbe4e837de693258c5c739"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a22a1e366c9fbe4e837de693258c5c739">$version</a> = 'master'</td></tr>
<tr class="memdesc:a22a1e366c9fbe4e837de693258c5c739"><td class="mdescLeft">&#160;</td><td class="mdescRight">scanner version. <br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a4cc936af136b39a54db6c7212c04cee7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a4cc936af136b39a54db6c7212c04cee7">rule_mapper_filter</a> ($tokens)</td></tr>
<tr class="memdesc:a4cc936af136b39a54db6c7212c04cee7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rule re-mapper filter. <a href="#a4cc936af136b39a54db6c7212c04cee7"></a><br/></td></tr>
<tr class="memitem:a463b3eb270a7afb960ee642bccc0d1b6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a463b3eb270a7afb960ee642bccc0d1b6">user_def_filter</a> ($token)</td></tr>
<tr class="memdesc:a463b3eb270a7afb960ee642bccc0d1b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Filter to highlight identifiers whose definitions are in the source. <a href="#a463b3eb270a7afb960ee642bccc0d1b6"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:af3887911498a250b2cb1fe737dd87df1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#af3887911498a250b2cb1fe737dd87df1">$case_sensitive</a> = true</td></tr>
<tr class="memdesc:af3887911498a250b2cb1fe737dd87df1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether or not the language is case sensitive. <a href="#af3887911498a250b2cb1fe737dd87df1"></a><br/></td></tr>
<tr class="memitem:aca257c4da52076f42c6e53d9d0d33dd1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#aca257c4da52076f42c6e53d9d0d33dd1">$filters</a> = array()</td></tr>
<tr class="memdesc:aca257c4da52076f42c6e53d9d0d33dd1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Individual token filters. <a href="#aca257c4da52076f42c6e53d9d0d33dd1"></a><br/></td></tr>
<tr class="memitem:adb13455bbeb076cd0f031f050ef31a82"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#adb13455bbeb076cd0f031f050ef31a82">$ident_map</a> = array()</td></tr>
<tr class="memdesc:adb13455bbeb076cd0f031f050ef31a82"><td class="mdescLeft">&#160;</td><td class="mdescRight">A map of identifiers and their corresponding token names. <a href="#adb13455bbeb076cd0f031f050ef31a82"></a><br/></td></tr>
<tr class="memitem:a30aaa5d3076a9f28d00f167a1c4eac34"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a30aaa5d3076a9f28d00f167a1c4eac34">$rule_tag_map</a> = array()</td></tr>
<tr class="memdesc:a30aaa5d3076a9f28d00f167a1c4eac34"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rule remappings. <a href="#a30aaa5d3076a9f28d00f167a1c4eac34"></a><br/></td></tr>
<tr class="memitem:ab5a30262ceb4324fdfaac1a7d217ba36"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#ab5a30262ceb4324fdfaac1a7d217ba36">$state_</a> = array()</td></tr>
<tr class="memdesc:ab5a30262ceb4324fdfaac1a7d217ba36"><td class="mdescLeft">&#160;</td><td class="mdescRight">State stack. <a href="#ab5a30262ceb4324fdfaac1a7d217ba36"></a><br/></td></tr>
<tr class="memitem:ad3d9ad7f7f14bc9de3dd6b68225ce21c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#ad3d9ad7f7f14bc9de3dd6b68225ce21c">$stream_filters</a> = array()</td></tr>
<tr class="memdesc:ad3d9ad7f7f14bc9de3dd6b68225ce21c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Token stream filters. <a href="#ad3d9ad7f7f14bc9de3dd6b68225ce21c"></a><br/></td></tr>
<tr class="memitem:ab29032700812b580e5d09b6128202286"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#ab29032700812b580e5d09b6128202286">$tokens</a> = array()</td></tr>
<tr class="memdesc:ab29032700812b580e5d09b6128202286"><td class="mdescLeft">&#160;</td><td class="mdescRight">The token stream. <a href="#ab29032700812b580e5d09b6128202286"></a><br/></td></tr>
<tr class="memitem:a615d93f42d9290b9fad4d84cc2fd84ec"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a615d93f42d9290b9fad4d84cc2fd84ec">$user_defs</a></td></tr>
<tr class="memdesc:a615d93f42d9290b9fad4d84cc2fd84ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Identifier remappings based on definitions identified in the source code. <a href="#a615d93f42d9290b9fad4d84cc2fd84ec"></a><br/></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>the base class for all scanners </p>
<p><a class="el" href="classLuminousScanner.html" title="the base class for all scanners">LuminousScanner</a> is the base class for all language scanners. Here we provide a set of methods comprising a highlighting layer. This includes recording a token stream, and ultimately being responsible for producing some XML representing the token stream.</p>
<p>We also define here some filters which rely on state information expected to be recorded into the instance variables.</p>
<p>Highlighting a string at this level is a four-stage process: </p>
<pre class="fragment"> @li string() - set the string
@li init() - set up the scanner
@li main() - perform tokenization
@li tagged() - build the XML
</pre><p>A note on tokens: Tokens are stored as an array with the following indices: </p>
<ul>
<li>0: Token name (e.g. 'COMMENT' </li>
<li>1: Token string (e.g. '// foo') </li>
<li>2: escaped? (bool) Because it's often more convenient to embed nested tokens by tagging token string, we need to escape it. This index stores whether or nto it has been escaped. </li>
</ul>
</div><h2>Member Function Documentation</h2>
<a class="anchor" id="a17a50bdadaa49f0638638d5c6da7090c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousScanner::add_filter </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$arg1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$arg2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$arg3</em> = <code>null</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add an individual token filter. </p>
<p>Adds an indivdual token filter. The filter is bound to the given token_name. The filter is a callback which should take a token and return a token.</p>
<p>The arguments are: [name], token_name, filter</p>
<p>Name is an optional argument. </p>
</div>
</div>
<a class="anchor" id="a047ae1afbf5563184e3dc67ecfb90a8c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousScanner::add_identifier_mapping </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$matches</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds an identifier mapping which is later analysed by map_identifier_filter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$name</td><td>The token name </td></tr>
<tr><td class="paramname">$matches</td><td>an array of identifiers which correspond to this token name, i.e. add_identifier_mapping('KEYWORD', array('if', 'else', ...));</td></tr>
</table>
</dd>
</dl>
<p>This method observes <a class="el" href="classLuminousScanner.html#af3887911498a250b2cb1fe737dd87df1" title="Whether or not the language is case sensitive.">LuminousScanner::$case_sensitive</a> </p>
</div>
</div>
<a class="anchor" id="a32eb459cd8ad20b8ea3403907d7f2e52"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousScanner::add_stream_filter </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$arg1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$arg2</em> = <code>null</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a stream filter. </p>
<p>A stream filter receives the entire token stream and should return it.</p>
<p>The parameters are: ([name], filter). Name is an optional argument. </p>
</div>
</div>
<a class="anchor" id="a094a64c9eb09e38ab43c865e1a4482c9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static LuminousScanner::guess_language </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$info</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Language guessing. </p>
<p>Each real language scanner should override this method and implement a simple guessing function to estimate how likely the input source code is to be the language which they recognise.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$src</td><td>the input source code </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The estimated chance that the source code is in the same language as the one the scanner tokenizes, as a real number between 0 (least likely) and 1 (most likely), inclusive </dd></dl>
</div>
</div>
<a class="anchor" id="a0a7907663241caffb546ef22bb35d870"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousScanner::highlight </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$src</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Public convenience function for setting the string and highlighting it. </p>
<p>Alias for: $s-&gt;string($src) $s-&gt;<a class="el" href="classLuminousScanner.html#af0aecba631e56a3005157cfbe84d6b67" title="Set up the scanner immediately prior to tokenization.">init()</a>; $s-&gt;<a class="el" href="classLuminousScanner.html#a12220a789d49b7e8f42cf873966b6756" title="the method responsible for tokenization">main()</a>; return $s-&gt;<a class="el" href="classLuminousScanner.html#a809c11561c650c7784edd3d06243b8b5" title="Returns the XML representation of the token stream.">tagged()</a>;</p>
<dl class="section return"><dt>Returns</dt><dd>the highlighted string, as an XML string </dd></dl>
</div>
</div>
<a class="anchor" id="af0aecba631e56a3005157cfbe84d6b67"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousScanner::init </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set up the scanner immediately prior to tokenization. </p>
<p>The init method is always called prior to <a class="el" href="classLuminousScanner.html#a12220a789d49b7e8f42cf873966b6756" title="the method responsible for tokenization">main()</a>. At this stage, all configuration variables are assumed to have been set, and it's now time for the scanner to perform any last set-up information. This may include actually finalizing its rule patterns. Some scanners may not need to override this if they are in no way dynamic. </p>
</div>
</div>
<a class="anchor" id="a12220a789d49b7e8f42cf873966b6756"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousScanner::main </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>the method responsible for tokenization </p>
<p>The main method is fully responsible for tokenizing the string stored in <a class="el" href="classScanner.html#a577a70297f4d3da0aa2ce4decc66eeea" title="Getter and setter for the source string.">string()</a> at the time of its call. By the time main returns, it should have consumed the whole of the string and populated the token array. </p>
<p>Reimplemented in <a class="el" href="classLuminousStatefulScanner.html#a7da6f0be6bafd50f0a785b6ba8e951aa">LuminousStatefulScanner</a>, and <a class="el" href="classLuminousSimpleScanner.html#a0962d46ec52780dd2f91a84e073ce654">LuminousSimpleScanner</a>.</p>
</div>
</div>
<a class="anchor" id="a6efd3dada50a424d7f30b7f9afac5fc0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousScanner::map_identifier_filter </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$token</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Identifier mapping filter. </p>
<p>Tries to map any 'IDENT' token to a TOKEN_NAME in <a class="el" href="classLuminousScanner.html#adb13455bbeb076cd0f031f050ef31a82" title="A map of identifiers and their corresponding token names.">LuminousScanner::$ident_map</a> This is implemented as the filter 'map-ident' </p>
</div>
</div>
<a class="anchor" id="ae974cbfb732f008a79482ffc4f11d398"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousScanner::nestable_token </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$token_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$open</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$close</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Handles tokens that may nest inside themselves. </p>
<p>Convenience function. It's fairly common for many languages to allow things like nestable comments. Handling these is easy but fairly long winded, so this function will take an opening and closing delimiter and consume the token until it is fully closed, or until the end of the string in the case that it is unterminated.</p>
<p>When the function returns, the token will have been consumed and appended to the token stream.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$token_name</td><td>the name of the token </td></tr>
<tr><td class="paramname">$open</td><td>the opening delimiter pattern (regex), e.g. '% /\* x' </td></tr>
<tr><td class="paramname">$close</td><td>the closing delimiter pattern (regex), e.g. '% \* /x'</td></tr>
</table>
</dd>
</dl>
<dl class="section warning"><dt>Warning</dt><dd>Although PCRE provides recursive regular expressions, this function is far preferable. A recursive regex will easily crash PCRE on garbage input due to it having a fairly small stack: this function is much more resilient.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Exception</td><td>if called at a non-matching point (i.e. <code>$this-&gt;scan($open)</code> does not match) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a614e490335cf64375c52d57edfb398ad"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousScanner::pop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pops the top element of the stack, and returns it. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Exception</td><td>if the state stack is empty </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa61dbaafd8801e40094cbff52f7b22f1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousScanner::record </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$string</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$pre_escaped</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Records a string as a given token type. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$string</td><td>The string to record </td></tr>
<tr><td class="paramname">$type</td><td>The name of the token the string represents </td></tr>
<tr><td class="paramname">$pre_escaped</td><td>Luminous works towards getting this in XML and therefore at some point, the $string has to be escaped. If you have already escaped it for some reason (or if you got it from another scanner), then you want to set this to <code>TRUE</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classLuminousUtils.html#a25ba2a727a415d71c3d57fd03bdf95ea" title="Escapes a string suitable for use in XML.">LuminousUtils::escape_string</a> </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Exception</td><td>if $string is <code>NULL</code> </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classLuminousStatefulScanner.html#a04c01a23de9f1d42e5b4921879326ee4">LuminousStatefulScanner</a>.</p>
</div>
</div>
<a class="anchor" id="a48fabeb9791b36ace2b46dd8f91a4afa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousScanner::record_range </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$from</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$to</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$type</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Helper function to record a range of the string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$from</td><td>the start index </td></tr>
<tr><td class="paramname">$to</td><td>the end index </td></tr>
<tr><td class="paramname">$type</td><td>the type of the token This is shorthand for <code> $this-&gt;record(substr($this-&gt;<a class="el" href="classScanner.html#a577a70297f4d3da0aa2ce4decc66eeea" title="Getter and setter for the source string.">string()</a>, $from, $to-$from)</code></td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">RangeException</td><td>if the range is invalid (i.e. $to &lt; $from)</td></tr>
</table>
</dd>
</dl>
<p>An empty range (i.e. $to === $from) is allowed, but it is essentially a no-op. </p>
<p>Reimplemented in <a class="el" href="classLuminousStatefulScanner.html#a9f8177050d802bad05d961c15b6a8536">LuminousStatefulScanner</a>.</p>
</div>
</div>
<a class="anchor" id="a4cc936af136b39a54db6c7212c04cee7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousScanner::rule_mapper_filter </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$tokens</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Rule re-mapper filter. </p>
<p>Re-maps token rules according to the LuminousScanner::rule_tag_map map. This is called as the filter 'rule-map' </p>
</div>
</div>
<a class="anchor" id="ab06dcdea11ff9a78168547b4c84c650c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousScanner::skip_whitespace </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Skips whitespace, and records it as a null token. </p>
<p>Convenience function </p>
</div>
</div>
<a class="anchor" id="a809c11561c650c7784edd3d06243b8b5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousScanner::tagged </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the XML representation of the token stream. </p>
<p>This function triggers the generation of the XML output. </p>
<dl class="section return"><dt>Returns</dt><dd>An XML-string which represents the tokens recorded by the scanner. </dd></dl>
<p>Reimplemented in <a class="el" href="classLuminousStatefulScanner.html#a22ca39b6b85a796a5438840fbddc7c0a">LuminousStatefulScanner</a>.</p>
</div>
</div>
<a class="anchor" id="ae381e3000c83ae4cb2259d0ae77a14ab"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousScanner::token_array </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the token array. </p>
<dl class="section return"><dt>Returns</dt><dd>The token array </dd></dl>
</div>
</div>
<a class="anchor" id="a463b3eb270a7afb960ee642bccc0d1b6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousScanner::user_def_filter </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$token</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Filter to highlight identifiers whose definitions are in the source. </p>
<p>maps anything recorded in LuminousScanner::user_defs to the recorded type. This is called as the filter 'user-defs' </p>
</div>
</div>
<h2>Member Data Documentation</h2>
<a class="anchor" id="af3887911498a250b2cb1fe737dd87df1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousScanner::$case_sensitive = true</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Whether or not the language is case sensitive. </p>
<p>Whether or not the scanner is dealing with a case sensitive language. This currently affects map_identifier_filter </p>
</div>
</div>
<a class="anchor" id="aca257c4da52076f42c6e53d9d0d33dd1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousScanner::$filters = array()</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Individual token filters. </p>
<p>A list of lists, each filter is an array: (name, token_name, callback) </p>
</div>
</div>
<a class="anchor" id="adb13455bbeb076cd0f031f050ef31a82"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousScanner::$ident_map = array()</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A map of identifiers and their corresponding token names. </p>
<p>A map of recognised identifiers, in the form identifier_string =&gt; TOKEN_NAME</p>
<p>This is currently used by map_identifier_filter </p>
</div>
</div>
<a class="anchor" id="a30aaa5d3076a9f28d00f167a1c4eac34"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousScanner::$rule_tag_map = array()</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Rule remappings. </p>
<p>A map to handle re-mapping of rules, in the form: OLD_TOKEN_NAME =&gt; NEW_TOKEN_NAME</p>
<p>This is used by <a class="el" href="classLuminousScanner.html#a4cc936af136b39a54db6c7212c04cee7" title="Rule re-mapper filter.">rule_mapper_filter()</a> </p>
</div>
</div>
<a class="anchor" id="ab5a30262ceb4324fdfaac1a7d217ba36"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousScanner::$state_ = array()</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>State stack. </p>
<p>A stack of the scanner's state, should the scanner wish to use a stack based state mechanism.</p>
<p>The top element can be retrieved (but not popped) with stack()</p>
<p>TODO More useful functions for manipulating the stack </p>
</div>
</div>
<a class="anchor" id="ad3d9ad7f7f14bc9de3dd6b68225ce21c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousScanner::$stream_filters = array()</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Token stream filters. </p>
<p>A list of lists, each filter is an array: (name, callback) </p>
</div>
</div>
<a class="anchor" id="ab29032700812b580e5d09b6128202286"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousScanner::$tokens = array()</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The token stream. </p>
<p>The token stream is recorded as a flat array of tokens. A token is made up of 3 parts, and stored as an array: </p>
<ul>
<li>0 =&gt; Token name </li>
<li>1 =&gt; Token string (from input source code) </li>
<li>2 =&gt; XML-Escaped? </li>
</ul>
</div>
</div>
<a class="anchor" id="a615d93f42d9290b9fad4d84cc2fd84ec"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousScanner::$user_defs</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Identifier remappings based on definitions identified in the source code. </p>
<p>A map of remappings of user-defined types/functions. This is a map of identifier_string =&gt; TOKEN_NAME</p>
<p>This is used by <a class="el" href="classLuminousScanner.html#a463b3eb270a7afb960ee642bccc0d1b6" title="Filter to highlight identifiers whose definitions are in the source.">user_def_filter()</a> </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/core/<a class="el" href="scanner_8class_8php.html">scanner.class.php</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:50 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,8 @@
digraph "LuminousScanner"
{
edge [fontname="FreeSans",fontsize="10",labelfontname="FreeSans",labelfontsize="10"];
node [fontname="FreeSans",fontsize="10",shape=record];
Node1 [label="LuminousScanner",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled" fontcolor="black"];
Node2 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node2 [label="Scanner",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classScanner.html",tooltip="Base string scanning class."];
}

View File

@ -0,0 +1 @@
17c7f8fc0e7f63e671ab379e9082d371

View File

@ -0,0 +1,14 @@
digraph "LuminousScanner"
{
edge [fontname="FreeSans",fontsize="10",labelfontname="FreeSans",labelfontsize="10"];
node [fontname="FreeSans",fontsize="10",shape=record];
Node1 [label="LuminousScanner",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled" fontcolor="black"];
Node2 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node2 [label="Scanner",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classScanner.html",tooltip="Base string scanning class."];
Node1 -> Node3 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node3 [label="LuminousEmbeddedWebScript",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classLuminousEmbeddedWebScript.html",tooltip="Superclass for languages which may nest, i.e. web languages."];
Node1 -> Node4 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node4 [label="LuminousSimpleScanner",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classLuminousSimpleScanner.html",tooltip="A largely automated scanner."];
Node4 -> Node5 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node5 [label="LuminousStatefulScanner",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classLuminousStatefulScanner.html",tooltip="Experimental transition table driven scanner."];
}

View File

@ -0,0 +1 @@
6cc0cd0412917d97ae2aced2e0c73ed6

View File

@ -0,0 +1,157 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: Member List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">LuminousSimpleScanner Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="classLuminousSimpleScanner.html">LuminousSimpleScanner</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#af3887911498a250b2cb1fe737dd87df1">$case_sensitive</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#aca257c4da52076f42c6e53d9d0d33dd1">$filters</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#adb13455bbeb076cd0f031f050ef31a82">$ident_map</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousSimpleScanner.html#a6fe26909e26aeb6659a95bfbb8bb05d0">$overrides</a></td><td class="entry"><a class="el" href="classLuminousSimpleScanner.html">LuminousSimpleScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a30aaa5d3076a9f28d00f167a1c4eac34">$rule_tag_map</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#ab5a30262ceb4324fdfaac1a7d217ba36">$state_</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#ad3d9ad7f7f14bc9de3dd6b68225ce21c">$stream_filters</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#ab29032700812b580e5d09b6128202286">$tokens</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a615d93f42d9290b9fad4d84cc2fd84ec">$user_defs</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a22a1e366c9fbe4e837de693258c5c739">$version</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a493a069a6ba279b279865111b8e8ffd4">__construct</a>($src=null)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a17a50bdadaa49f0638638d5c6da7090c">add_filter</a>($arg1, $arg2, $arg3=null)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a047ae1afbf5563184e3dc67ecfb90a8c">add_identifier_mapping</a>($name, $matches)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a4cb6935d759ee0c75fa01b75e2d0ec04">add_pattern</a>($name, $pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a32eb459cd8ad20b8ea3403907d7f2e52">add_stream_filter</a>($arg1, $arg2=null)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a77abc2d2de424e73d1ee659fd9001e4a">bol</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#ae483fc35eae064c75f8b5ca105826757">check</a>($pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a8ad6032d3a1f955608905c10a864aee6">eol</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a23543739aee09e2e1961a556a9672c7d">eos</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a154d424c925ed0d58e033f1e71ceef03">get</a>($n=1)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#ac8beec743c18d54cec51273b3bb7f3b5">get_next</a>($patterns)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a21f59cd38d7ed3ccd43955386b6aa14e">get_next_named</a>($patterns)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a57774c7a298bb43c1c4406a830d386a6">get_next_strpos</a>($patterns)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a094a64c9eb09e38ab43c865e1a4482c9">guess_language</a>($src, $info)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a0a7907663241caffb546ef22bb35d870">highlight</a>($src)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a90bacd70c30eb1d76659c0586f0683d2">index</a>($pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#af0aecba631e56a3005157cfbe84d6b67">init</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousSimpleScanner.html#a0962d46ec52780dd2f91a84e073ce654">main</a>()</td><td class="entry"><a class="el" href="classLuminousSimpleScanner.html">LuminousSimpleScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a6efd3dada50a424d7f30b7f9afac5fc0">map_identifier_filter</a>($token)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a17ac6e2abcb54a6dfaa9abaf95ed839e">match</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#aa933ee80eb310785c75ab7b03ed01885">match_group</a>($g=0)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a9271f0acf8d19f83fa45ee3ee1d3eab5">match_groups</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#aa5520e0fc7df54d7a25d75037e6cdc8a">match_pos</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#ae974cbfb732f008a79482ffc4f11d398">nestable_token</a>($token_name, $open, $close)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a5e03667fd1cdc1d1fd40a4bc15570b12">next_match</a>($consume_and_log=true)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a3028e787442cf1ed9252397ed029b223">peek</a>($n=1)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a614e490335cf64375c52d57edfb398ad">pop</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a546cafdcfc3adeb19959ae14dff10996">pos</a>($new_pos=null)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a947d15fe4bd13b64afd5eaba8d4d3819">pos_shift</a>($offset)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#add1da033592e8f944660b9e29088a2ac">push</a>($state)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#aa61dbaafd8801e40094cbff52f7b22f1">record</a>($string, $type, $pre_escaped=false)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a48fabeb9791b36ace2b46dd8f91a4afa">record_range</a>($from, $to, $type)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a80c4b9fff3a38e90e04cda38eb075040">remove_filter</a>($name)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a79c559549e2dd73c3f1892e7609e84a6">remove_pattern</a>($name)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a25c4c1f42c64a07ce87c19f3992a0fba">remove_stream_filter</a>($name)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a89d1448f666d1be3d5037c69f24eb516">reset</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#aeae50ecaf6b98a0b76f47c3d04b8deb3">rest</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a4cc936af136b39a54db6c7212c04cee7">rule_mapper_filter</a>($tokens)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a78ddb203c30c2f9e69755ec00c341add">scan</a>($pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#aa0e261d4b0c2fce43ba3c264036afd72">scan_until</a>($pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#ab06dcdea11ff9a78168547b4c84c650c">skip_whitespace</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a4156922baa33783377f7904fd2d4cee5">start</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a23e2cf34969c3d39cd34a4b5ce6810ca">state</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a577a70297f4d3da0aa2ce4decc66eeea">string</a>($s=null)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a809c11561c650c7784edd3d06243b8b5">tagged</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a185d6e780752848cb282add6d9f936bb">terminate</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#ae381e3000c83ae4cb2259d0ae77a14ab">token_array</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a6f6665b8df561788b1b2dea40bb394ae">unscan</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a463b3eb270a7afb960ee642bccc0d1b6">user_def_filter</a>($token)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:50 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,312 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: LuminousSimpleScanner Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classLuminousSimpleScanner-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">LuminousSimpleScanner Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A largely automated scanner.
<a href="classLuminousSimpleScanner.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for LuminousSimpleScanner:</div>
<div class="dyncontent">
<div class="center"><img src="classLuminousSimpleScanner__inherit__graph.png" border="0" usemap="#LuminousSimpleScanner_inherit__map" alt="Inheritance graph"/></div>
<map name="LuminousSimpleScanner_inherit__map" id="LuminousSimpleScanner_inherit__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for LuminousSimpleScanner:</div>
<div class="dyncontent">
<div class="center"><img src="classLuminousSimpleScanner__coll__graph.png" border="0" usemap="#LuminousSimpleScanner_coll__map" alt="Collaboration graph"/></div>
<map name="LuminousSimpleScanner_coll__map" id="LuminousSimpleScanner_coll__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0962d46ec52780dd2f91a84e073ce654"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousSimpleScanner.html#a0962d46ec52780dd2f91a84e073ce654">main</a> ()</td></tr>
<tr class="memdesc:a0962d46ec52780dd2f91a84e073ce654"><td class="mdescLeft">&#160;</td><td class="mdescRight">the method responsible for tokenization <a href="#a0962d46ec52780dd2f91a84e073ce654"></a><br/></td></tr>
<tr class="inherit_header pub_methods_classLuminousScanner"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classLuminousScanner')"><img src="closed.png" alt="-"/>&nbsp;Public Member Functions inherited from <a class="el" href="classLuminousScanner.html">LuminousScanner</a></td></tr>
<tr class="memitem:a493a069a6ba279b279865111b8e8ffd4 inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a493a069a6ba279b279865111b8e8ffd4"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a493a069a6ba279b279865111b8e8ffd4">__construct</a> ($src=null)</td></tr>
<tr class="memdesc:a493a069a6ba279b279865111b8e8ffd4 inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor <br/></td></tr>
<tr class="memitem:a17a50bdadaa49f0638638d5c6da7090c inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a17a50bdadaa49f0638638d5c6da7090c">add_filter</a> ($arg1, $arg2, $arg3=null)</td></tr>
<tr class="memdesc:a17a50bdadaa49f0638638d5c6da7090c inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add an individual token filter. <a href="#a17a50bdadaa49f0638638d5c6da7090c"></a><br/></td></tr>
<tr class="memitem:a047ae1afbf5563184e3dc67ecfb90a8c inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a047ae1afbf5563184e3dc67ecfb90a8c">add_identifier_mapping</a> ($name, $matches)</td></tr>
<tr class="memdesc:a047ae1afbf5563184e3dc67ecfb90a8c inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds an identifier mapping which is later analysed by map_identifier_filter. <a href="#a047ae1afbf5563184e3dc67ecfb90a8c"></a><br/></td></tr>
<tr class="memitem:a32eb459cd8ad20b8ea3403907d7f2e52 inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a32eb459cd8ad20b8ea3403907d7f2e52">add_stream_filter</a> ($arg1, $arg2=null)</td></tr>
<tr class="memdesc:a32eb459cd8ad20b8ea3403907d7f2e52 inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a stream filter. <a href="#a32eb459cd8ad20b8ea3403907d7f2e52"></a><br/></td></tr>
<tr class="memitem:a0a7907663241caffb546ef22bb35d870 inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a0a7907663241caffb546ef22bb35d870">highlight</a> ($src)</td></tr>
<tr class="memdesc:a0a7907663241caffb546ef22bb35d870 inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Public convenience function for setting the string and highlighting it. <a href="#a0a7907663241caffb546ef22bb35d870"></a><br/></td></tr>
<tr class="memitem:af0aecba631e56a3005157cfbe84d6b67 inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#af0aecba631e56a3005157cfbe84d6b67">init</a> ()</td></tr>
<tr class="memdesc:af0aecba631e56a3005157cfbe84d6b67 inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set up the scanner immediately prior to tokenization. <a href="#af0aecba631e56a3005157cfbe84d6b67"></a><br/></td></tr>
<tr class="memitem:a6efd3dada50a424d7f30b7f9afac5fc0 inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a6efd3dada50a424d7f30b7f9afac5fc0">map_identifier_filter</a> ($token)</td></tr>
<tr class="memdesc:a6efd3dada50a424d7f30b7f9afac5fc0 inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Identifier mapping filter. <a href="#a6efd3dada50a424d7f30b7f9afac5fc0"></a><br/></td></tr>
<tr class="memitem:ae974cbfb732f008a79482ffc4f11d398 inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#ae974cbfb732f008a79482ffc4f11d398">nestable_token</a> ($token_name, $open, $close)</td></tr>
<tr class="memdesc:ae974cbfb732f008a79482ffc4f11d398 inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handles tokens that may nest inside themselves. <a href="#ae974cbfb732f008a79482ffc4f11d398"></a><br/></td></tr>
<tr class="memitem:a614e490335cf64375c52d57edfb398ad inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a614e490335cf64375c52d57edfb398ad">pop</a> ()</td></tr>
<tr class="memdesc:a614e490335cf64375c52d57edfb398ad inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pops the top element of the stack, and returns it. <a href="#a614e490335cf64375c52d57edfb398ad"></a><br/></td></tr>
<tr class="memitem:add1da033592e8f944660b9e29088a2ac inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="add1da033592e8f944660b9e29088a2ac"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#add1da033592e8f944660b9e29088a2ac">push</a> ($<a class="el" href="classLuminousScanner.html#a23e2cf34969c3d39cd34a4b5ce6810ca">state</a>)</td></tr>
<tr class="memdesc:add1da033592e8f944660b9e29088a2ac inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pushes some data onto the stack. <br/></td></tr>
<tr class="memitem:aa61dbaafd8801e40094cbff52f7b22f1 inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#aa61dbaafd8801e40094cbff52f7b22f1">record</a> ($<a class="el" href="classScanner.html#a577a70297f4d3da0aa2ce4decc66eeea">string</a>, $type, $pre_escaped=false)</td></tr>
<tr class="memdesc:aa61dbaafd8801e40094cbff52f7b22f1 inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Records a string as a given token type. <a href="#aa61dbaafd8801e40094cbff52f7b22f1"></a><br/></td></tr>
<tr class="memitem:a48fabeb9791b36ace2b46dd8f91a4afa inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a48fabeb9791b36ace2b46dd8f91a4afa">record_range</a> ($from, $to, $type)</td></tr>
<tr class="memdesc:a48fabeb9791b36ace2b46dd8f91a4afa inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper function to record a range of the string. <a href="#a48fabeb9791b36ace2b46dd8f91a4afa"></a><br/></td></tr>
<tr class="memitem:a80c4b9fff3a38e90e04cda38eb075040 inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80c4b9fff3a38e90e04cda38eb075040"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a80c4b9fff3a38e90e04cda38eb075040">remove_filter</a> ($name)</td></tr>
<tr class="memdesc:a80c4b9fff3a38e90e04cda38eb075040 inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes the individual filter(s) with the given name. <br/></td></tr>
<tr class="memitem:a25c4c1f42c64a07ce87c19f3992a0fba inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a25c4c1f42c64a07ce87c19f3992a0fba"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a25c4c1f42c64a07ce87c19f3992a0fba">remove_stream_filter</a> ($name)</td></tr>
<tr class="memdesc:a25c4c1f42c64a07ce87c19f3992a0fba inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes the stream filter(s) with the given name. <br/></td></tr>
<tr class="memitem:ab06dcdea11ff9a78168547b4c84c650c inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#ab06dcdea11ff9a78168547b4c84c650c">skip_whitespace</a> ()</td></tr>
<tr class="memdesc:ab06dcdea11ff9a78168547b4c84c650c inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Skips whitespace, and records it as a null token. <a href="#ab06dcdea11ff9a78168547b4c84c650c"></a><br/></td></tr>
<tr class="memitem:a4156922baa33783377f7904fd2d4cee5 inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4156922baa33783377f7904fd2d4cee5"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a4156922baa33783377f7904fd2d4cee5">start</a> ()</td></tr>
<tr class="memdesc:a4156922baa33783377f7904fd2d4cee5 inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flushes the token stream. <br/></td></tr>
<tr class="memitem:a23e2cf34969c3d39cd34a4b5ce6810ca inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a23e2cf34969c3d39cd34a4b5ce6810ca"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a23e2cf34969c3d39cd34a4b5ce6810ca">state</a> ()</td></tr>
<tr class="memdesc:a23e2cf34969c3d39cd34a4b5ce6810ca inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the top element on $state_ or null if it is empty. <br/></td></tr>
<tr class="memitem:a809c11561c650c7784edd3d06243b8b5 inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a809c11561c650c7784edd3d06243b8b5">tagged</a> ()</td></tr>
<tr class="memdesc:a809c11561c650c7784edd3d06243b8b5 inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the XML representation of the token stream. <a href="#a809c11561c650c7784edd3d06243b8b5"></a><br/></td></tr>
<tr class="memitem:ae381e3000c83ae4cb2259d0ae77a14ab inherit pub_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#ae381e3000c83ae4cb2259d0ae77a14ab">token_array</a> ()</td></tr>
<tr class="memdesc:ae381e3000c83ae4cb2259d0ae77a14ab inherit pub_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the token array. <a href="#ae381e3000c83ae4cb2259d0ae77a14ab"></a><br/></td></tr>
<tr class="inherit_header pub_methods_classScanner"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classScanner')"><img src="closed.png" alt="-"/>&nbsp;Public Member Functions inherited from <a class="el" href="classScanner.html">Scanner</a></td></tr>
<tr class="memitem:a4cb6935d759ee0c75fa01b75e2d0ec04 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a4cb6935d759ee0c75fa01b75e2d0ec04">add_pattern</a> ($name, $pattern)</td></tr>
<tr class="memdesc:a4cb6935d759ee0c75fa01b75e2d0ec04 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allows the caller to add a predefined named pattern. <a href="#a4cb6935d759ee0c75fa01b75e2d0ec04"></a><br/></td></tr>
<tr class="memitem:a77abc2d2de424e73d1ee659fd9001e4a inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a77abc2d2de424e73d1ee659fd9001e4a">bol</a> ()</td></tr>
<tr class="memdesc:a77abc2d2de424e73d1ee659fd9001e4a inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Beginning of line? <a href="#a77abc2d2de424e73d1ee659fd9001e4a"></a><br/></td></tr>
<tr class="memitem:ae483fc35eae064c75f8b5ca105826757 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#ae483fc35eae064c75f8b5ca105826757">check</a> ($pattern)</td></tr>
<tr class="memdesc:ae483fc35eae064c75f8b5ca105826757 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Non-consuming lookahead. <a href="#ae483fc35eae064c75f8b5ca105826757"></a><br/></td></tr>
<tr class="memitem:a8ad6032d3a1f955608905c10a864aee6 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a8ad6032d3a1f955608905c10a864aee6">eol</a> ()</td></tr>
<tr class="memdesc:a8ad6032d3a1f955608905c10a864aee6 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">End of line? <a href="#a8ad6032d3a1f955608905c10a864aee6"></a><br/></td></tr>
<tr class="memitem:a23543739aee09e2e1961a556a9672c7d inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a23543739aee09e2e1961a556a9672c7d">eos</a> ()</td></tr>
<tr class="memdesc:a23543739aee09e2e1961a556a9672c7d inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">End of string? <a href="#a23543739aee09e2e1961a556a9672c7d"></a><br/></td></tr>
<tr class="memitem:a154d424c925ed0d58e033f1e71ceef03 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a154d424c925ed0d58e033f1e71ceef03">get</a> ($n=1)</td></tr>
<tr class="memdesc:a154d424c925ed0d58e033f1e71ceef03 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Consume a given number of bytes. <a href="#a154d424c925ed0d58e033f1e71ceef03"></a><br/></td></tr>
<tr class="memitem:ac8beec743c18d54cec51273b3bb7f3b5 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#ac8beec743c18d54cec51273b3bb7f3b5">get_next</a> ($patterns)</td></tr>
<tr class="memdesc:ac8beec743c18d54cec51273b3bb7f3b5 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Look for the next occurrence of a set of patterns. <a href="#ac8beec743c18d54cec51273b3bb7f3b5"></a><br/></td></tr>
<tr class="memitem:a21f59cd38d7ed3ccd43955386b6aa14e inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a21f59cd38d7ed3ccd43955386b6aa14e">get_next_named</a> ($patterns)</td></tr>
<tr class="memdesc:a21f59cd38d7ed3ccd43955386b6aa14e inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the index of the next occurrence of a named pattern. <a href="#a21f59cd38d7ed3ccd43955386b6aa14e"></a><br/></td></tr>
<tr class="memitem:a57774c7a298bb43c1c4406a830d386a6 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a57774c7a298bb43c1c4406a830d386a6">get_next_strpos</a> ($patterns)</td></tr>
<tr class="memdesc:a57774c7a298bb43c1c4406a830d386a6 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Look for the next occurrence of a set of substrings. <a href="#a57774c7a298bb43c1c4406a830d386a6"></a><br/></td></tr>
<tr class="memitem:a90bacd70c30eb1d76659c0586f0683d2 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a90bacd70c30eb1d76659c0586f0683d2">index</a> ($pattern)</td></tr>
<tr class="memdesc:a90bacd70c30eb1d76659c0586f0683d2 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the index of the next occurrence of a pattern. <a href="#a90bacd70c30eb1d76659c0586f0683d2"></a><br/></td></tr>
<tr class="memitem:a17ac6e2abcb54a6dfaa9abaf95ed839e inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a17ac6e2abcb54a6dfaa9abaf95ed839e">match</a> ()</td></tr>
<tr class="memdesc:a17ac6e2abcb54a6dfaa9abaf95ed839e inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the result of the most recent match operation. <a href="#a17ac6e2abcb54a6dfaa9abaf95ed839e"></a><br/></td></tr>
<tr class="memitem:aa933ee80eb310785c75ab7b03ed01885 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#aa933ee80eb310785c75ab7b03ed01885">match_group</a> ($g=0)</td></tr>
<tr class="memdesc:aa933ee80eb310785c75ab7b03ed01885 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a group from the most recent match operation. <a href="#aa933ee80eb310785c75ab7b03ed01885"></a><br/></td></tr>
<tr class="memitem:a9271f0acf8d19f83fa45ee3ee1d3eab5 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a9271f0acf8d19f83fa45ee3ee1d3eab5">match_groups</a> ()</td></tr>
<tr class="memdesc:a9271f0acf8d19f83fa45ee3ee1d3eab5 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the match groups of the most recent match operation. <a href="#a9271f0acf8d19f83fa45ee3ee1d3eab5"></a><br/></td></tr>
<tr class="memitem:aa5520e0fc7df54d7a25d75037e6cdc8a inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#aa5520e0fc7df54d7a25d75037e6cdc8a">match_pos</a> ()</td></tr>
<tr class="memdesc:aa5520e0fc7df54d7a25d75037e6cdc8a inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the position (offset) of the most recent match. <a href="#aa5520e0fc7df54d7a25d75037e6cdc8a"></a><br/></td></tr>
<tr class="memitem:a5e03667fd1cdc1d1fd40a4bc15570b12 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a5e03667fd1cdc1d1fd40a4bc15570b12">next_match</a> ($consume_and_log=true)</td></tr>
<tr class="memdesc:a5e03667fd1cdc1d1fd40a4bc15570b12 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Automation function: returns the next occurrence of any known patterns. <a href="#a5e03667fd1cdc1d1fd40a4bc15570b12"></a><br/></td></tr>
<tr class="memitem:a3028e787442cf1ed9252397ed029b223 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a3028e787442cf1ed9252397ed029b223">peek</a> ($n=1)</td></tr>
<tr class="memdesc:a3028e787442cf1ed9252397ed029b223 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lookahead into the string a given number of bytes. <a href="#a3028e787442cf1ed9252397ed029b223"></a><br/></td></tr>
<tr class="memitem:a546cafdcfc3adeb19959ae14dff10996 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a546cafdcfc3adeb19959ae14dff10996">pos</a> ($new_pos=null)</td></tr>
<tr class="memdesc:a546cafdcfc3adeb19959ae14dff10996 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Getter and setter for the current position (string pointer). <a href="#a546cafdcfc3adeb19959ae14dff10996"></a><br/></td></tr>
<tr class="memitem:a947d15fe4bd13b64afd5eaba8d4d3819 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a947d15fe4bd13b64afd5eaba8d4d3819">pos_shift</a> ($offset)</td></tr>
<tr class="memdesc:a947d15fe4bd13b64afd5eaba8d4d3819 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Moves the string pointer by a given offset. <a href="#a947d15fe4bd13b64afd5eaba8d4d3819"></a><br/></td></tr>
<tr class="memitem:a79c559549e2dd73c3f1892e7609e84a6 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a79c559549e2dd73c3f1892e7609e84a6">remove_pattern</a> ($name)</td></tr>
<tr class="memdesc:a79c559549e2dd73c3f1892e7609e84a6 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allows the caller to remove a named pattern. <a href="#a79c559549e2dd73c3f1892e7609e84a6"></a><br/></td></tr>
<tr class="memitem:a89d1448f666d1be3d5037c69f24eb516 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a89d1448f666d1be3d5037c69f24eb516">reset</a> ()</td></tr>
<tr class="memdesc:a89d1448f666d1be3d5037c69f24eb516 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the scanner. <a href="#a89d1448f666d1be3d5037c69f24eb516"></a><br/></td></tr>
<tr class="memitem:aeae50ecaf6b98a0b76f47c3d04b8deb3 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#aeae50ecaf6b98a0b76f47c3d04b8deb3">rest</a> ()</td></tr>
<tr class="memdesc:aeae50ecaf6b98a0b76f47c3d04b8deb3 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the remaining string. <a href="#aeae50ecaf6b98a0b76f47c3d04b8deb3"></a><br/></td></tr>
<tr class="memitem:a78ddb203c30c2f9e69755ec00c341add inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a78ddb203c30c2f9e69755ec00c341add">scan</a> ($pattern)</td></tr>
<tr class="memdesc:a78ddb203c30c2f9e69755ec00c341add inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scans at the current pointer. <a href="#a78ddb203c30c2f9e69755ec00c341add"></a><br/></td></tr>
<tr class="memitem:aa0e261d4b0c2fce43ba3c264036afd72 inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#aa0e261d4b0c2fce43ba3c264036afd72">scan_until</a> ($pattern)</td></tr>
<tr class="memdesc:aa0e261d4b0c2fce43ba3c264036afd72 inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scans until the start of a pattern. <a href="#aa0e261d4b0c2fce43ba3c264036afd72"></a><br/></td></tr>
<tr class="memitem:a577a70297f4d3da0aa2ce4decc66eeea inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a577a70297f4d3da0aa2ce4decc66eeea">string</a> ($s=null)</td></tr>
<tr class="memdesc:a577a70297f4d3da0aa2ce4decc66eeea inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Getter and setter for the source string. <a href="#a577a70297f4d3da0aa2ce4decc66eeea"></a><br/></td></tr>
<tr class="memitem:a185d6e780752848cb282add6d9f936bb inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a185d6e780752848cb282add6d9f936bb">terminate</a> ()</td></tr>
<tr class="memdesc:a185d6e780752848cb282add6d9f936bb inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ends scanning of a string. <a href="#a185d6e780752848cb282add6d9f936bb"></a><br/></td></tr>
<tr class="memitem:a6f6665b8df561788b1b2dea40bb394ae inherit pub_methods_classScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScanner.html#a6f6665b8df561788b1b2dea40bb394ae">unscan</a> ()</td></tr>
<tr class="memdesc:a6f6665b8df561788b1b2dea40bb394ae inherit pub_methods_classScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Revert the most recent scanning operation. <a href="#a6f6665b8df561788b1b2dea40bb394ae"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a6fe26909e26aeb6659a95bfbb8bb05d0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousSimpleScanner.html#a6fe26909e26aeb6659a95bfbb8bb05d0">$overrides</a> = array()</td></tr>
<tr class="memdesc:a6fe26909e26aeb6659a95bfbb8bb05d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overrides array. <a href="#a6fe26909e26aeb6659a95bfbb8bb05d0"></a><br/></td></tr>
<tr class="inherit_header pro_attribs_classLuminousScanner"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classLuminousScanner')"><img src="closed.png" alt="-"/>&nbsp;Protected Attributes inherited from <a class="el" href="classLuminousScanner.html">LuminousScanner</a></td></tr>
<tr class="memitem:af3887911498a250b2cb1fe737dd87df1 inherit pro_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#af3887911498a250b2cb1fe737dd87df1">$case_sensitive</a> = true</td></tr>
<tr class="memdesc:af3887911498a250b2cb1fe737dd87df1 inherit pro_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether or not the language is case sensitive. <a href="#af3887911498a250b2cb1fe737dd87df1"></a><br/></td></tr>
<tr class="memitem:aca257c4da52076f42c6e53d9d0d33dd1 inherit pro_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#aca257c4da52076f42c6e53d9d0d33dd1">$filters</a> = array()</td></tr>
<tr class="memdesc:aca257c4da52076f42c6e53d9d0d33dd1 inherit pro_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Individual token filters. <a href="#aca257c4da52076f42c6e53d9d0d33dd1"></a><br/></td></tr>
<tr class="memitem:adb13455bbeb076cd0f031f050ef31a82 inherit pro_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#adb13455bbeb076cd0f031f050ef31a82">$ident_map</a> = array()</td></tr>
<tr class="memdesc:adb13455bbeb076cd0f031f050ef31a82 inherit pro_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">A map of identifiers and their corresponding token names. <a href="#adb13455bbeb076cd0f031f050ef31a82"></a><br/></td></tr>
<tr class="memitem:a30aaa5d3076a9f28d00f167a1c4eac34 inherit pro_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a30aaa5d3076a9f28d00f167a1c4eac34">$rule_tag_map</a> = array()</td></tr>
<tr class="memdesc:a30aaa5d3076a9f28d00f167a1c4eac34 inherit pro_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rule remappings. <a href="#a30aaa5d3076a9f28d00f167a1c4eac34"></a><br/></td></tr>
<tr class="memitem:ab5a30262ceb4324fdfaac1a7d217ba36 inherit pro_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#ab5a30262ceb4324fdfaac1a7d217ba36">$state_</a> = array()</td></tr>
<tr class="memdesc:ab5a30262ceb4324fdfaac1a7d217ba36 inherit pro_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">State stack. <a href="#ab5a30262ceb4324fdfaac1a7d217ba36"></a><br/></td></tr>
<tr class="memitem:ad3d9ad7f7f14bc9de3dd6b68225ce21c inherit pro_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#ad3d9ad7f7f14bc9de3dd6b68225ce21c">$stream_filters</a> = array()</td></tr>
<tr class="memdesc:ad3d9ad7f7f14bc9de3dd6b68225ce21c inherit pro_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Token stream filters. <a href="#ad3d9ad7f7f14bc9de3dd6b68225ce21c"></a><br/></td></tr>
<tr class="memitem:ab29032700812b580e5d09b6128202286 inherit pro_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#ab29032700812b580e5d09b6128202286">$tokens</a> = array()</td></tr>
<tr class="memdesc:ab29032700812b580e5d09b6128202286 inherit pro_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">The token stream. <a href="#ab29032700812b580e5d09b6128202286"></a><br/></td></tr>
<tr class="memitem:a615d93f42d9290b9fad4d84cc2fd84ec inherit pro_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a615d93f42d9290b9fad4d84cc2fd84ec">$user_defs</a></td></tr>
<tr class="memdesc:a615d93f42d9290b9fad4d84cc2fd84ec inherit pro_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Identifier remappings based on definitions identified in the source code. <a href="#a615d93f42d9290b9fad4d84cc2fd84ec"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_classLuminousScanner"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classLuminousScanner')"><img src="closed.png" alt="-"/>&nbsp;Static Public Member Functions inherited from <a class="el" href="classLuminousScanner.html">LuminousScanner</a></td></tr>
<tr class="memitem:a094a64c9eb09e38ab43c865e1a4482c9 inherit pub_static_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a094a64c9eb09e38ab43c865e1a4482c9">guess_language</a> ($src, $info)</td></tr>
<tr class="memdesc:a094a64c9eb09e38ab43c865e1a4482c9 inherit pub_static_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Language guessing. <a href="#a094a64c9eb09e38ab43c865e1a4482c9"></a><br/></td></tr>
<tr class="inherit_header pub_attribs_classLuminousScanner"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classLuminousScanner')"><img src="closed.png" alt="-"/>&nbsp;Public Attributes inherited from <a class="el" href="classLuminousScanner.html">LuminousScanner</a></td></tr>
<tr class="memitem:a22a1e366c9fbe4e837de693258c5c739 inherit pub_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22a1e366c9fbe4e837de693258c5c739"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a22a1e366c9fbe4e837de693258c5c739">$version</a> = 'master'</td></tr>
<tr class="memdesc:a22a1e366c9fbe4e837de693258c5c739 inherit pub_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">scanner version. <br/></td></tr>
<tr class="inherit_header pro_methods_classLuminousScanner"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classLuminousScanner')"><img src="closed.png" alt="-"/>&nbsp;Protected Member Functions inherited from <a class="el" href="classLuminousScanner.html">LuminousScanner</a></td></tr>
<tr class="memitem:a4cc936af136b39a54db6c7212c04cee7 inherit pro_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a4cc936af136b39a54db6c7212c04cee7">rule_mapper_filter</a> ($tokens)</td></tr>
<tr class="memdesc:a4cc936af136b39a54db6c7212c04cee7 inherit pro_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rule re-mapper filter. <a href="#a4cc936af136b39a54db6c7212c04cee7"></a><br/></td></tr>
<tr class="memitem:a463b3eb270a7afb960ee642bccc0d1b6 inherit pro_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a463b3eb270a7afb960ee642bccc0d1b6">user_def_filter</a> ($token)</td></tr>
<tr class="memdesc:a463b3eb270a7afb960ee642bccc0d1b6 inherit pro_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Filter to highlight identifiers whose definitions are in the source. <a href="#a463b3eb270a7afb960ee642bccc0d1b6"></a><br/></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A largely automated scanner. </p>
<p><a class="el" href="classLuminousSimpleScanner.html" title="A largely automated scanner.">LuminousSimpleScanner</a> implements a <a class="el" href="classLuminousSimpleScanner.html#a0962d46ec52780dd2f91a84e073ce654" title="the method responsible for tokenization">main()</a> method and observes the patterns added with <a class="el" href="classScanner.html#a4cb6935d759ee0c75fa01b75e2d0ec04" title="Allows the caller to add a predefined named pattern.">Scanner::add_pattern()</a></p>
<p>An overrides array allows the caller to override the handling of any token. If an override is set for a token, the override is called when that token is reached and the caller should consume it. If the callback fails to advance the string pointer, an Exception is thrown. </p>
</div><h2>Member Function Documentation</h2>
<a class="anchor" id="a0962d46ec52780dd2f91a84e073ce654"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousSimpleScanner::main </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>the method responsible for tokenization </p>
<p>The main method is fully responsible for tokenizing the string stored in <a class="el" href="classScanner.html#a577a70297f4d3da0aa2ce4decc66eeea" title="Getter and setter for the source string.">string()</a> at the time of its call. By the time main returns, it should have consumed the whole of the string and populated the token array. </p>
<p>Reimplemented from <a class="el" href="classLuminousScanner.html#a12220a789d49b7e8f42cf873966b6756">LuminousScanner</a>.</p>
<p>Reimplemented in <a class="el" href="classLuminousStatefulScanner.html#a7da6f0be6bafd50f0a785b6ba8e951aa">LuminousStatefulScanner</a>.</p>
</div>
</div>
<h2>Member Data Documentation</h2>
<a class="anchor" id="a6fe26909e26aeb6659a95bfbb8bb05d0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousSimpleScanner::$overrides = array()</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Overrides array. </p>
<p>A map of TOKEN_NAME =&gt; callback.</p>
<p>The callbacks are fired by <a class="el" href="classLuminousSimpleScanner.html#a0962d46ec52780dd2f91a84e073ce654" title="the method responsible for tokenization">main()</a> when the TOKEN_NAME rule matches. The callback receives the match_groups array, but the scanner is <a class="el" href="classScanner.html#a6f6665b8df561788b1b2dea40bb394ae" title="Revert the most recent scanning operation.">unscan()</a>ed before the callback is fired, so that the <a class="el" href="classScanner.html#a546cafdcfc3adeb19959ae14dff10996" title="Getter and setter for the current position (string pointer).">pos()</a> is directly in front of the match. The callback is responsible for consuming the token appropriately. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/core/<a class="el" href="scanner_8class_8php.html">scanner.class.php</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:50 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,10 @@
digraph "LuminousSimpleScanner"
{
edge [fontname="FreeSans",fontsize="10",labelfontname="FreeSans",labelfontsize="10"];
node [fontname="FreeSans",fontsize="10",shape=record];
Node1 [label="LuminousSimpleScanner",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled" fontcolor="black"];
Node2 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node2 [label="LuminousScanner",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classLuminousScanner.html",tooltip="the base class for all scanners"];
Node3 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node3 [label="Scanner",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classScanner.html",tooltip="Base string scanning class."];
}

View File

@ -0,0 +1 @@
d0776ca5c85fd8c658f8adc4d8bbd899

View File

@ -0,0 +1,12 @@
digraph "LuminousSimpleScanner"
{
edge [fontname="FreeSans",fontsize="10",labelfontname="FreeSans",labelfontsize="10"];
node [fontname="FreeSans",fontsize="10",shape=record];
Node1 [label="LuminousSimpleScanner",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled" fontcolor="black"];
Node2 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node2 [label="LuminousScanner",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classLuminousScanner.html",tooltip="the base class for all scanners"];
Node3 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node3 [label="Scanner",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classScanner.html",tooltip="Base string scanning class."];
Node1 -> Node4 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node4 [label="LuminousStatefulScanner",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classLuminousStatefulScanner.html",tooltip="Experimental transition table driven scanner."];
}

View File

@ -0,0 +1 @@
8b031124734f96c10bc8c16398fbc819

View File

@ -0,0 +1,176 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: Member List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">LuminousStatefulScanner Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#af3887911498a250b2cb1fe737dd87df1">$case_sensitive</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#aca257c4da52076f42c6e53d9d0d33dd1">$filters</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#adb13455bbeb076cd0f031f050ef31a82">$ident_map</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousStatefulScanner.html#ac48a7493e46607197259fabaa18196ad">$last_state</a></td><td class="entry"><a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousStatefulScanner.html#a33e625b6e207b9fa8d02306938480519">$legal_transitions</a></td><td class="entry"><a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousSimpleScanner.html#a6fe26909e26aeb6659a95bfbb8bb05d0">$overrides</a></td><td class="entry"><a class="el" href="classLuminousSimpleScanner.html">LuminousSimpleScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousStatefulScanner.html#acbb00a72f935a8c45261383760542b1d">$patterns</a></td><td class="entry"><a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a30aaa5d3076a9f28d00f167a1c4eac34">$rule_tag_map</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousStatefulScanner.html#a98a1d160d07f04e2ba8388e6b73db524">$setup</a></td><td class="entry"><a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#ab5a30262ceb4324fdfaac1a7d217ba36">$state_</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#ad3d9ad7f7f14bc9de3dd6b68225ce21c">$stream_filters</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousStatefulScanner.html#aceb7c9c79698251183e07afb1ddf4228">$token_tree_stack</a></td><td class="entry"><a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#ab29032700812b580e5d09b6128202286">$tokens</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousStatefulScanner.html#a58cb6b0100f05e310f90a8bf79608a3b">$transition_rule_cache</a></td><td class="entry"><a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousStatefulScanner.html#a74653deca3c7705eb06a250e7283060a">$transitions</a></td><td class="entry"><a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a615d93f42d9290b9fad4d84cc2fd84ec">$user_defs</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a22a1e366c9fbe4e837de693258c5c739">$version</a></td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a493a069a6ba279b279865111b8e8ffd4">__construct</a>($src=null)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a17a50bdadaa49f0638638d5c6da7090c">add_filter</a>($arg1, $arg2, $arg3=null)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a047ae1afbf5563184e3dc67ecfb90a8c">add_identifier_mapping</a>($name, $matches)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousStatefulScanner.html#a459218c633ecc5a0fb3d08e52e0a9c28">add_pattern</a>($name, $pattern, $end=null, $consume=true)</td><td class="entry"><a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a4cb6935d759ee0c75fa01b75e2d0ec04">LuminousSimpleScanner::add_pattern</a>($name, $pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a32eb459cd8ad20b8ea3403907d7f2e52">add_stream_filter</a>($arg1, $arg2=null)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousStatefulScanner.html#a6bbd65f0e100d22077501c800af7926a">add_transition</a>($from, $to)</td><td class="entry"><a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a77abc2d2de424e73d1ee659fd9001e4a">bol</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#ae483fc35eae064c75f8b5ca105826757">check</a>($pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousStatefulScanner.html#aa33c01d00bf3a5f15fb0945deb742cec">collapse_token_tree</a>($node)</td><td class="entry"><a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a8ad6032d3a1f955608905c10a864aee6">eol</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a23543739aee09e2e1961a556a9672c7d">eos</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a154d424c925ed0d58e033f1e71ceef03">get</a>($n=1)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#ac8beec743c18d54cec51273b3bb7f3b5">get_next</a>($patterns)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a21f59cd38d7ed3ccd43955386b6aa14e">get_next_named</a>($patterns)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a57774c7a298bb43c1c4406a830d386a6">get_next_strpos</a>($patterns)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a094a64c9eb09e38ab43c865e1a4482c9">guess_language</a>($src, $info)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a0a7907663241caffb546ef22bb35d870">highlight</a>($src)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a90bacd70c30eb1d76659c0586f0683d2">index</a>($pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#af0aecba631e56a3005157cfbe84d6b67">init</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousStatefulScanner.html#a0babe803eeec59e0a77f03c658a5e6b3">load_transitions</a>()</td><td class="entry"><a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousStatefulScanner.html#a7da6f0be6bafd50f0a785b6ba8e951aa">main</a>()</td><td class="entry"><a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a6efd3dada50a424d7f30b7f9afac5fc0">map_identifier_filter</a>($token)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a17ac6e2abcb54a6dfaa9abaf95ed839e">match</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#aa933ee80eb310785c75ab7b03ed01885">match_group</a>($g=0)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a9271f0acf8d19f83fa45ee3ee1d3eab5">match_groups</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#aa5520e0fc7df54d7a25d75037e6cdc8a">match_pos</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#ae974cbfb732f008a79482ffc4f11d398">nestable_token</a>($token_name, $open, $close)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousStatefulScanner.html#a132f05a948d43ec4cb103490cce2cedf">next_end_data</a>()</td><td class="entry"><a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a5e03667fd1cdc1d1fd40a4bc15570b12">next_match</a>($consume_and_log=true)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousStatefulScanner.html#a33a49c8b634b1f9d6048a341b82efab3">next_start_data</a>()</td><td class="entry"><a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a3028e787442cf1ed9252397ed029b223">peek</a>($n=1)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a614e490335cf64375c52d57edfb398ad">pop</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousStatefulScanner.html#ae4de8e437cdeb7cda6cb39b53427bd65">pop_state</a>()</td><td class="entry"><a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a546cafdcfc3adeb19959ae14dff10996">pos</a>($new_pos=null)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a947d15fe4bd13b64afd5eaba8d4d3819">pos_shift</a>($offset)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#add1da033592e8f944660b9e29088a2ac">push</a>($state)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousStatefulScanner.html#abd592ef2dce9cd10e790792b45218f3c">push_child</a>($child)</td><td class="entry"><a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousStatefulScanner.html#a4ce70df919d944c9e85fce4072a27ff2">push_state</a>($state_data)</td><td class="entry"><a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousStatefulScanner.html#a04c01a23de9f1d42e5b4921879326ee4">record</a>($str, $dummy1=null, $dummy2=null)</td><td class="entry"><a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousStatefulScanner.html#a9f8177050d802bad05d961c15b6a8536">record_range</a>($from, $to, $type=null)</td><td class="entry"><a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousStatefulScanner.html#a09266805f976b3fd9ee501bfebd69598">record_token</a>($str, $type)</td><td class="entry"><a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a80c4b9fff3a38e90e04cda38eb075040">remove_filter</a>($name)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a79c559549e2dd73c3f1892e7609e84a6">remove_pattern</a>($name)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a25c4c1f42c64a07ce87c19f3992a0fba">remove_stream_filter</a>($name)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a89d1448f666d1be3d5037c69f24eb516">reset</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#aeae50ecaf6b98a0b76f47c3d04b8deb3">rest</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a4cc936af136b39a54db6c7212c04cee7">rule_mapper_filter</a>($tokens)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a78ddb203c30c2f9e69755ec00c341add">scan</a>($pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#aa0e261d4b0c2fce43ba3c264036afd72">scan_until</a>($pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousStatefulScanner.html#a52c545680b3fe2f57c701957a6b52a84">setup</a>()</td><td class="entry"><a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#ab06dcdea11ff9a78168547b4c84c650c">skip_whitespace</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a4156922baa33783377f7904fd2d4cee5">start</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousScanner.html#a23e2cf34969c3d39cd34a4b5ce6810ca">state</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousStatefulScanner.html#a11c34191804f4842d49ab86be27000a0">state_name</a>()</td><td class="entry"><a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a577a70297f4d3da0aa2ce4decc66eeea">string</a>($s=null)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousStatefulScanner.html#a22ca39b6b85a796a5438840fbddc7c0a">tagged</a>()</td><td class="entry"><a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a185d6e780752848cb282add6d9f936bb">terminate</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#ae381e3000c83ae4cb2259d0ae77a14ab">token_array</a>()</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a6f6665b8df561788b1b2dea40bb394ae">unscan</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousScanner.html#a463b3eb270a7afb960ee642bccc0d1b6">user_def_filter</a>($token)</td><td class="entry"><a class="el" href="classLuminousScanner.html">LuminousScanner</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:50 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,790 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: LuminousStatefulScanner Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classLuminousStatefulScanner-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">LuminousStatefulScanner Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Experimental transition table driven scanner.
<a href="classLuminousStatefulScanner.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for LuminousStatefulScanner:</div>
<div class="dyncontent">
<div class="center"><img src="classLuminousStatefulScanner__inherit__graph.png" border="0" usemap="#LuminousStatefulScanner_inherit__map" alt="Inheritance graph"/></div>
<map name="LuminousStatefulScanner_inherit__map" id="LuminousStatefulScanner_inherit__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for LuminousStatefulScanner:</div>
<div class="dyncontent">
<div class="center"><img src="classLuminousStatefulScanner__coll__graph.png" border="0" usemap="#LuminousStatefulScanner_coll__map" alt="Collaboration graph"/></div>
<map name="LuminousStatefulScanner_coll__map" id="LuminousStatefulScanner_coll__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a459218c633ecc5a0fb3d08e52e0a9c28"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStatefulScanner.html#a459218c633ecc5a0fb3d08e52e0a9c28">add_pattern</a> ($name, $pattern, $end=null, $consume=true)</td></tr>
<tr class="memdesc:a459218c633ecc5a0fb3d08e52e0a9c28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a pattern. <a href="#a459218c633ecc5a0fb3d08e52e0a9c28"></a><br/></td></tr>
<tr class="memitem:a6bbd65f0e100d22077501c800af7926a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStatefulScanner.html#a6bbd65f0e100d22077501c800af7926a">add_transition</a> ($from, $to)</td></tr>
<tr class="memdesc:a6bbd65f0e100d22077501c800af7926a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a state transition. <a href="#a6bbd65f0e100d22077501c800af7926a"></a><br/></td></tr>
<tr class="memitem:a0babe803eeec59e0a77f03c658a5e6b3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStatefulScanner.html#a0babe803eeec59e0a77f03c658a5e6b3">load_transitions</a> ()</td></tr>
<tr class="memdesc:a0babe803eeec59e0a77f03c658a5e6b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads legal state transitions for the current state. <a href="#a0babe803eeec59e0a77f03c658a5e6b3"></a><br/></td></tr>
<tr class="memitem:a7da6f0be6bafd50f0a785b6ba8e951aa"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStatefulScanner.html#a7da6f0be6bafd50f0a785b6ba8e951aa">main</a> ()</td></tr>
<tr class="memitem:a132f05a948d43ec4cb103490cce2cedf"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStatefulScanner.html#a132f05a948d43ec4cb103490cce2cedf">next_end_data</a> ()</td></tr>
<tr class="memdesc:a132f05a948d43ec4cb103490cce2cedf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Looks for the next state-pop sequence (close/end) for the current state. <a href="#a132f05a948d43ec4cb103490cce2cedf"></a><br/></td></tr>
<tr class="memitem:a33a49c8b634b1f9d6048a341b82efab3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStatefulScanner.html#a33a49c8b634b1f9d6048a341b82efab3">next_start_data</a> ()</td></tr>
<tr class="memdesc:a33a49c8b634b1f9d6048a341b82efab3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Looks for the next legal state transition. <a href="#a33a49c8b634b1f9d6048a341b82efab3"></a><br/></td></tr>
<tr class="memitem:ae4de8e437cdeb7cda6cb39b53427bd65"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStatefulScanner.html#ae4de8e437cdeb7cda6cb39b53427bd65">pop_state</a> ()</td></tr>
<tr class="memdesc:ae4de8e437cdeb7cda6cb39b53427bd65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pops a state from the stack. <a href="#ae4de8e437cdeb7cda6cb39b53427bd65"></a><br/></td></tr>
<tr class="memitem:abd592ef2dce9cd10e790792b45218f3c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStatefulScanner.html#abd592ef2dce9cd10e790792b45218f3c">push_child</a> ($child)</td></tr>
<tr class="memitem:a4ce70df919d944c9e85fce4072a27ff2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStatefulScanner.html#a4ce70df919d944c9e85fce4072a27ff2">push_state</a> ($state_data)</td></tr>
<tr class="memdesc:a4ce70df919d944c9e85fce4072a27ff2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pushes a state. <a href="#a4ce70df919d944c9e85fce4072a27ff2"></a><br/></td></tr>
<tr class="memitem:a04c01a23de9f1d42e5b4921879326ee4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStatefulScanner.html#a04c01a23de9f1d42e5b4921879326ee4">record</a> ($str, $dummy1=null, $dummy2=null)</td></tr>
<tr class="memitem:a9f8177050d802bad05d961c15b6a8536"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStatefulScanner.html#a9f8177050d802bad05d961c15b6a8536">record_range</a> ($from, $to, $type=null)</td></tr>
<tr class="memdesc:a9f8177050d802bad05d961c15b6a8536"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper function to record a range of the string. <a href="#a9f8177050d802bad05d961c15b6a8536"></a><br/></td></tr>
<tr class="memitem:a09266805f976b3fd9ee501bfebd69598"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStatefulScanner.html#a09266805f976b3fd9ee501bfebd69598">record_token</a> ($str, $type)</td></tr>
<tr class="memdesc:a09266805f976b3fd9ee501bfebd69598"><td class="mdescLeft">&#160;</td><td class="mdescRight">Records a complete token This is shorthand for pushing a new node onto the stack, recording its text, and then popping it. <a href="#a09266805f976b3fd9ee501bfebd69598"></a><br/></td></tr>
<tr class="memitem:a11c34191804f4842d49ab86be27000a0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStatefulScanner.html#a11c34191804f4842d49ab86be27000a0">state_name</a> ()</td></tr>
<tr class="memdesc:a11c34191804f4842d49ab86be27000a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the name of the current state. <a href="#a11c34191804f4842d49ab86be27000a0"></a><br/></td></tr>
<tr class="memitem:a22ca39b6b85a796a5438840fbddc7c0a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStatefulScanner.html#a22ca39b6b85a796a5438840fbddc7c0a">tagged</a> ()</td></tr>
<tr class="memdesc:a22ca39b6b85a796a5438840fbddc7c0a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the XML representation of the token stream. <a href="#a22ca39b6b85a796a5438840fbddc7c0a"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:aa33c01d00bf3a5f15fb0945deb742cec"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStatefulScanner.html#aa33c01d00bf3a5f15fb0945deb742cec">collapse_token_tree</a> ($node)</td></tr>
<tr class="memitem:a52c545680b3fe2f57c701957a6b52a84"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStatefulScanner.html#a52c545680b3fe2f57c701957a6b52a84">setup</a> ()</td></tr>
<tr class="memdesc:a52c545680b3fe2f57c701957a6b52a84"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets up the FSM. <a href="#a52c545680b3fe2f57c701957a6b52a84"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a33e625b6e207b9fa8d02306938480519"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStatefulScanner.html#a33e625b6e207b9fa8d02306938480519">$legal_transitions</a> = array()</td></tr>
<tr class="memdesc:a33e625b6e207b9fa8d02306938480519"><td class="mdescLeft">&#160;</td><td class="mdescRight">Legal transitions for the current state. <a href="#a33e625b6e207b9fa8d02306938480519"></a><br/></td></tr>
<tr class="memitem:acbb00a72f935a8c45261383760542b1d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStatefulScanner.html#acbb00a72f935a8c45261383760542b1d">$patterns</a> = array()</td></tr>
<tr class="memdesc:acbb00a72f935a8c45261383760542b1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pattern list. <a href="#acbb00a72f935a8c45261383760542b1d"></a><br/></td></tr>
<tr class="memitem:aceb7c9c79698251183e07afb1ddf4228"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStatefulScanner.html#aceb7c9c79698251183e07afb1ddf4228">$token_tree_stack</a> = array()</td></tr>
<tr class="memdesc:aceb7c9c79698251183e07afb1ddf4228"><td class="mdescLeft">&#160;</td><td class="mdescRight">The token tree. <a href="#aceb7c9c79698251183e07afb1ddf4228"></a><br/></td></tr>
<tr class="memitem:a74653deca3c7705eb06a250e7283060a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a74653deca3c7705eb06a250e7283060a"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStatefulScanner.html#a74653deca3c7705eb06a250e7283060a">$transitions</a> = array()</td></tr>
<tr class="memdesc:a74653deca3c7705eb06a250e7283060a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transition table. <br/></td></tr>
<tr class="inherit_header pro_attribs_classLuminousSimpleScanner"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classLuminousSimpleScanner')"><img src="closed.png" alt="-"/>&nbsp;Protected Attributes inherited from <a class="el" href="classLuminousSimpleScanner.html">LuminousSimpleScanner</a></td></tr>
<tr class="memitem:a6fe26909e26aeb6659a95bfbb8bb05d0 inherit pro_attribs_classLuminousSimpleScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousSimpleScanner.html#a6fe26909e26aeb6659a95bfbb8bb05d0">$overrides</a> = array()</td></tr>
<tr class="memdesc:a6fe26909e26aeb6659a95bfbb8bb05d0 inherit pro_attribs_classLuminousSimpleScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overrides array. <a href="#a6fe26909e26aeb6659a95bfbb8bb05d0"></a><br/></td></tr>
<tr class="inherit_header pro_attribs_classLuminousScanner"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classLuminousScanner')"><img src="closed.png" alt="-"/>&nbsp;Protected Attributes inherited from <a class="el" href="classLuminousScanner.html">LuminousScanner</a></td></tr>
<tr class="memitem:af3887911498a250b2cb1fe737dd87df1 inherit pro_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#af3887911498a250b2cb1fe737dd87df1">$case_sensitive</a> = true</td></tr>
<tr class="memdesc:af3887911498a250b2cb1fe737dd87df1 inherit pro_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether or not the language is case sensitive. <a href="#af3887911498a250b2cb1fe737dd87df1"></a><br/></td></tr>
<tr class="memitem:aca257c4da52076f42c6e53d9d0d33dd1 inherit pro_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#aca257c4da52076f42c6e53d9d0d33dd1">$filters</a> = array()</td></tr>
<tr class="memdesc:aca257c4da52076f42c6e53d9d0d33dd1 inherit pro_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Individual token filters. <a href="#aca257c4da52076f42c6e53d9d0d33dd1"></a><br/></td></tr>
<tr class="memitem:adb13455bbeb076cd0f031f050ef31a82 inherit pro_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#adb13455bbeb076cd0f031f050ef31a82">$ident_map</a> = array()</td></tr>
<tr class="memdesc:adb13455bbeb076cd0f031f050ef31a82 inherit pro_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">A map of identifiers and their corresponding token names. <a href="#adb13455bbeb076cd0f031f050ef31a82"></a><br/></td></tr>
<tr class="memitem:a30aaa5d3076a9f28d00f167a1c4eac34 inherit pro_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a30aaa5d3076a9f28d00f167a1c4eac34">$rule_tag_map</a> = array()</td></tr>
<tr class="memdesc:a30aaa5d3076a9f28d00f167a1c4eac34 inherit pro_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rule remappings. <a href="#a30aaa5d3076a9f28d00f167a1c4eac34"></a><br/></td></tr>
<tr class="memitem:ab5a30262ceb4324fdfaac1a7d217ba36 inherit pro_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#ab5a30262ceb4324fdfaac1a7d217ba36">$state_</a> = array()</td></tr>
<tr class="memdesc:ab5a30262ceb4324fdfaac1a7d217ba36 inherit pro_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">State stack. <a href="#ab5a30262ceb4324fdfaac1a7d217ba36"></a><br/></td></tr>
<tr class="memitem:ad3d9ad7f7f14bc9de3dd6b68225ce21c inherit pro_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#ad3d9ad7f7f14bc9de3dd6b68225ce21c">$stream_filters</a> = array()</td></tr>
<tr class="memdesc:ad3d9ad7f7f14bc9de3dd6b68225ce21c inherit pro_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Token stream filters. <a href="#ad3d9ad7f7f14bc9de3dd6b68225ce21c"></a><br/></td></tr>
<tr class="memitem:ab29032700812b580e5d09b6128202286 inherit pro_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#ab29032700812b580e5d09b6128202286">$tokens</a> = array()</td></tr>
<tr class="memdesc:ab29032700812b580e5d09b6128202286 inherit pro_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">The token stream. <a href="#ab29032700812b580e5d09b6128202286"></a><br/></td></tr>
<tr class="memitem:a615d93f42d9290b9fad4d84cc2fd84ec inherit pro_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a615d93f42d9290b9fad4d84cc2fd84ec">$user_defs</a></td></tr>
<tr class="memdesc:a615d93f42d9290b9fad4d84cc2fd84ec inherit pro_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Identifier remappings based on definitions identified in the source code. <a href="#a615d93f42d9290b9fad4d84cc2fd84ec"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:ac48a7493e46607197259fabaa18196ad"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStatefulScanner.html#ac48a7493e46607197259fabaa18196ad">$last_state</a> = null</td></tr>
<tr class="memitem:a98a1d160d07f04e2ba8388e6b73db524"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStatefulScanner.html#a98a1d160d07f04e2ba8388e6b73db524">$setup</a> = false</td></tr>
<tr class="memitem:a58cb6b0100f05e310f90a8bf79608a3b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStatefulScanner.html#a58cb6b0100f05e310f90a8bf79608a3b">$transition_rule_cache</a> = array()</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_classLuminousScanner"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classLuminousScanner')"><img src="closed.png" alt="-"/>&nbsp;Static Public Member Functions inherited from <a class="el" href="classLuminousScanner.html">LuminousScanner</a></td></tr>
<tr class="memitem:a094a64c9eb09e38ab43c865e1a4482c9 inherit pub_static_methods_classLuminousScanner"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a094a64c9eb09e38ab43c865e1a4482c9">guess_language</a> ($src, $info)</td></tr>
<tr class="memdesc:a094a64c9eb09e38ab43c865e1a4482c9 inherit pub_static_methods_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Language guessing. <a href="#a094a64c9eb09e38ab43c865e1a4482c9"></a><br/></td></tr>
<tr class="inherit_header pub_attribs_classLuminousScanner"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classLuminousScanner')"><img src="closed.png" alt="-"/>&nbsp;Public Attributes inherited from <a class="el" href="classLuminousScanner.html">LuminousScanner</a></td></tr>
<tr class="memitem:a22a1e366c9fbe4e837de693258c5c739 inherit pub_attribs_classLuminousScanner"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22a1e366c9fbe4e837de693258c5c739"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousScanner.html#a22a1e366c9fbe4e837de693258c5c739">$version</a> = 'master'</td></tr>
<tr class="memdesc:a22a1e366c9fbe4e837de693258c5c739 inherit pub_attribs_classLuminousScanner"><td class="mdescLeft">&#160;</td><td class="mdescRight">scanner version. <br/></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Experimental transition table driven scanner. </p>
<p>The stateful scanner follows a transition table and generates a hierarchical token tree. As such, the states follow a hierarchical parent-&gt;child relationship rather than a strict from-&gt;to</p>
<p>A node in the token tree looks like this:</p>
<div class="fragment"><div class="line">array(<span class="stringliteral">&#39;token_name&#39;</span> =&gt; <span class="stringliteral">&#39;name&#39;</span>,<span class="stringliteral">&#39;children&#39;</span> =&gt; array(...)) </div>
</div><!-- fragment --><p>Children is an ordered list and its elements may be either other token nodes or just strings. We override tagged to try to collapse this into XML while still applying filters.</p>
<p>We now store patterns as the following tuple: </p>
<div class="fragment"><div class="line">($name, $open_pattern, $teminate_pattern). </div>
</div><!-- fragment --><p> The termination pattern may be null, in which case the $open_pattern is complete. No transitions can occur within a complete state because the patterns' match is fixed.</p>
<p>We have two stacks. One is <a class="el" href="classLuminousStatefulScanner.html#aceb7c9c79698251183e07afb1ddf4228" title="The token tree.">LuminousStatefulScanner::$token_tree_stack</a>, which stores the token tree, and the other is a standard state stack which stores the current state data. State data is currently a pattern, as the above tuple.</p>
<dl class="section warning"><dt>Warning</dt><dd>Currently 'stream filters' are not applied, because we at no point end up with a flat stream of tokens. Although the rule name remapper is applied. </dd></dl>
</div><h2>Member Function Documentation</h2>
<a class="anchor" id="a459218c633ecc5a0fb3d08e52e0a9c28"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousStatefulScanner::add_pattern </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$pattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$end</em> = <code>null</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$consume</em> = <code>true</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a pattern. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$name</td><td>the name of the pattern/state </td></tr>
<tr><td class="paramname">$pattern</td><td>Either the entire pattern, or just its opening delimiter </td></tr>
<tr><td class="paramname">$end</td><td>If $pattern was just the opening delimiter, $end is the closing delimiter. Separating the two delimiters like this makes the state flexible length, as state transitions can occur inside it. </td></tr>
<tr><td class="paramname">$consume</td><td>Not currently observed. Might never be. Don't specify this yet. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6bbd65f0e100d22077501c800af7926a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousStatefulScanner::add_transition </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$from</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$to</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a state transition. </p>
<p>This is a helper function for LuminousStatefulScanner::transitions, you can specify it directly instead </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$from</td><td>The parent state </td></tr>
<tr><td class="paramname">$to</td><td>The child state </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa33c01d00bf3a5f15fb0945deb742cec"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousStatefulScanner::collapse_token_tree </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$node</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Recursive function to collapse the token tree into XML </p>
</div>
</div>
<a class="anchor" id="a0babe803eeec59e0a77f03c658a5e6b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousStatefulScanner::load_transitions </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads legal state transitions for the current state. </p>
<p>Loads in legal state transitions into the legal_transitions array according to the current state </p>
</div>
</div>
<a class="anchor" id="a7da6f0be6bafd50f0a785b6ba8e951aa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousStatefulScanner::main </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Generic main function which observes the transition table </p>
<p>Reimplemented from <a class="el" href="classLuminousSimpleScanner.html#a0962d46ec52780dd2f91a84e073ce654">LuminousSimpleScanner</a>.</p>
</div>
</div>
<a class="anchor" id="a132f05a948d43ec4cb103490cce2cedf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousStatefulScanner::next_end_data </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Looks for the next state-pop sequence (close/end) for the current state. </p>
<dl class="section return"><dt>Returns</dt><dd>Data in the same format as get_next: a tuple of (next, matches). If no match is found, next is -1 and matches is null </dd></dl>
</div>
</div>
<a class="anchor" id="a33a49c8b634b1f9d6048a341b82efab3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousStatefulScanner::next_start_data </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Looks for the next legal state transition. </p>
<dl class="section return"><dt>Returns</dt><dd>A tuple of (pattern_data, next, matches). If no match is found, next is -1 and pattern_data and matches is null </dd></dl>
</div>
</div>
<a class="anchor" id="ae4de8e437cdeb7cda6cb39b53427bd65"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousStatefulScanner::pop_state </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pops a state from the stack. </p>
<p>The top token on the token_tree_stack is popped and appended as a child to the new top token.</p>
<p>The top state on the state stack is popped and discarded. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Exception</td><td>if there is only the initial state on the stack (we cannot pop the initial state, because then we have no state at all) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="abd592ef2dce9cd10e790792b45218f3c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousStatefulScanner::push_child </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$child</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pushes a new token onto the stack as a child of the currently active token</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classLuminousStatefulScanner.html#a4ce70df919d944c9e85fce4072a27ff2" title="Pushes a state.">push_state</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a4ce70df919d944c9e85fce4072a27ff2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousStatefulScanner::push_state </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$state_data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pushes a state. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$state_data</td><td>A tuple of ($name, $open_pattern, $teminate_pattern). This should be as it is stored in LuminousStatefulScanner::patterns</td></tr>
</table>
</dd>
</dl>
<p>This actually causes two push operations. One is onto the token_tree_stack, and the other is onto the actual stack. The former creates a new token, the latter is used for state information </p>
</div>
</div>
<a class="anchor" id="a04c01a23de9f1d42e5b4921879326ee4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousStatefulScanner::record </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$dummy1</em> = <code>null</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$dummy2</em> = <code>null</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Records a string as a child of the currently active token </p>
<dl class="section warning"><dt>Warning</dt><dd>the second and third parameters are not applicable to this method, they are only present to suppress PHP warnings. If you set them, an exception is thrown. </dd></dl>
<p>Reimplemented from <a class="el" href="classLuminousScanner.html#aa61dbaafd8801e40094cbff52f7b22f1">LuminousScanner</a>.</p>
</div>
</div>
<a class="anchor" id="a9f8177050d802bad05d961c15b6a8536"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousStatefulScanner::record_range </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$from</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$to</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$type</em> = <code>null</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Helper function to record a range of the string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$from</td><td>the start index </td></tr>
<tr><td class="paramname">$to</td><td>the end index </td></tr>
<tr><td class="paramname">$type</td><td>dummy argument This is shorthand for <code> $this-&gt;record(substr($this-&gt;<a class="el" href="classScanner.html#a577a70297f4d3da0aa2ce4decc66eeea" title="Getter and setter for the source string.">string()</a>, $from, $to-$from)</code></td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">RangeException</td><td>if the range is invalid (i.e. $to &lt; $from)</td></tr>
</table>
</dd>
</dl>
<p>An empty range (i.e. $to === $from) is allowed, but it is essentially a no-op. </p>
<p>Reimplemented from <a class="el" href="classLuminousScanner.html#a48fabeb9791b36ace2b46dd8f91a4afa">LuminousScanner</a>.</p>
</div>
</div>
<a class="anchor" id="a09266805f976b3fd9ee501bfebd69598"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousStatefulScanner::record_token </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$type</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Records a complete token This is shorthand for pushing a new node onto the stack, recording its text, and then popping it. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$str</td><td>the string </td></tr>
<tr><td class="paramname">$type</td><td>the token type </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a52c545680b3fe2f57c701957a6b52a84"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousStatefulScanner::setup </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets up the FSM. </p>
<p>If the caller has omitted to specify an initial state then one is created, with valid transitions to all other known states. We also push the initial state onto the tree stack, and add a type mapping from the initial type to <code>NULL</code>. </p>
</div>
</div>
<a class="anchor" id="a11c34191804f4842d49ab86be27000a0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousStatefulScanner::state_name </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the name of the current state. </p>
<dl class="section return"><dt>Returns</dt><dd>The name of the current state </dd></dl>
</div>
</div>
<a class="anchor" id="a22ca39b6b85a796a5438840fbddc7c0a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousStatefulScanner::tagged </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the XML representation of the token stream. </p>
<p>This function triggers the generation of the XML output. </p>
<dl class="section return"><dt>Returns</dt><dd>An XML-string which represents the tokens recorded by the scanner. </dd></dl>
<p>Reimplemented from <a class="el" href="classLuminousScanner.html#a809c11561c650c7784edd3d06243b8b5">LuminousScanner</a>.</p>
</div>
</div>
<h2>Member Data Documentation</h2>
<a class="anchor" id="ac48a7493e46607197259fabaa18196ad"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousStatefulScanner::$last_state = null</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>remembers the state on the last iteration so we know whether or not to load in a new transition-set </p>
</div>
</div>
<a class="anchor" id="a33e625b6e207b9fa8d02306938480519"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousStatefulScanner::$legal_transitions = array()</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Legal transitions for the current state. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classLuminousStatefulScanner.html#a0babe803eeec59e0a77f03c658a5e6b3" title="Loads legal state transitions for the current state.">LuminousStatefulScanner::load_transitions()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="acbb00a72f935a8c45261383760542b1d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousStatefulScanner::$patterns = array()</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Pattern list. </p>
<p>Pattern array. Each pattern is a tuple of </p>
<div class="fragment"><div class="line">($name, $open_pattern, $teminate_pattern) </div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="a98a1d160d07f04e2ba8388e6b73db524"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousStatefulScanner::$setup = false</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Records whether or not the FSM has been set up for the first time. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classLuminousStatefulScanner.html#a52c545680b3fe2f57c701957a6b52a84" title="Sets up the FSM.">setup()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aceb7c9c79698251183e07afb1ddf4228"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousStatefulScanner::$token_tree_stack = array()</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The token tree. </p>
<p>The tokens we end up with are a tree which we build as we go along. The easiest way to build it is to keep track of the currently active node on top of a stack. When the node is completed, we pop it and insert it as a child of the element which is now at the top of the stack.</p>
<p>At the end of the process we end up with one element in here which is the root node. </p>
</div>
</div>
<a class="anchor" id="a58cb6b0100f05e310f90a8bf79608a3b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousStatefulScanner::$transition_rule_cache = array()</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Cache of transition rules </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classLuminousStatefulScanner.html#a33a49c8b634b1f9d6048a341b82efab3" title="Looks for the next legal state transition.">next_start_data()</a> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/core/<a class="el" href="scanner_8class_8php.html">scanner.class.php</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:50 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,12 @@
digraph "LuminousStatefulScanner"
{
edge [fontname="FreeSans",fontsize="10",labelfontname="FreeSans",labelfontsize="10"];
node [fontname="FreeSans",fontsize="10",shape=record];
Node1 [label="LuminousStatefulScanner",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled" fontcolor="black"];
Node2 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node2 [label="LuminousSimpleScanner",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classLuminousSimpleScanner.html",tooltip="A largely automated scanner."];
Node3 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node3 [label="LuminousScanner",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classLuminousScanner.html",tooltip="the base class for all scanners"];
Node4 -> Node3 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node4 [label="Scanner",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classScanner.html",tooltip="Base string scanning class."];
}

View File

@ -0,0 +1 @@
925d04e34bf229b55a19a86471dd93bf

View File

@ -0,0 +1,12 @@
digraph "LuminousStatefulScanner"
{
edge [fontname="FreeSans",fontsize="10",labelfontname="FreeSans",labelfontsize="10"];
node [fontname="FreeSans",fontsize="10",shape=record];
Node1 [label="LuminousStatefulScanner",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled" fontcolor="black"];
Node2 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node2 [label="LuminousSimpleScanner",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classLuminousSimpleScanner.html",tooltip="A largely automated scanner."];
Node3 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node3 [label="LuminousScanner",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classLuminousScanner.html",tooltip="the base class for all scanners"];
Node4 -> Node3 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node4 [label="Scanner",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classScanner.html",tooltip="Base string scanning class."];
}

View File

@ -0,0 +1 @@
925d04e34bf229b55a19a86471dd93bf

View File

@ -0,0 +1,102 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: Member List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">LuminousStringSearch Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="classLuminousStringSearch.html">LuminousStringSearch</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classLuminousStringSearch.html#a409d9de167e4668acbe3da71f2bfa277">$cache</a></td><td class="entry"><a class="el" href="classLuminousStringSearch.html">LuminousStringSearch</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousStringSearch.html#a2ed7bad26a3e255195bb00c12a50e49c">$string</a></td><td class="entry"><a class="el" href="classLuminousStringSearch.html">LuminousStringSearch</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr bgcolor="#f0f0f0"class="even"><td class="entry"><b>__construct</b>($str) (defined in <a class="el" href="classLuminousStringSearch.html">LuminousStringSearch</a>)</td><td class="entry"><a class="el" href="classLuminousStringSearch.html">LuminousStringSearch</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousStringSearch.html#ae6b1a2b900b6d8593cfd93272bc72ef2">match</a>($search, $index, &amp;$matches)</td><td class="entry"><a class="el" href="classLuminousStringSearch.html">LuminousStringSearch</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:50 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,191 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: LuminousStringSearch Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classLuminousStringSearch-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">LuminousStringSearch Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A basic preg_match wrapper which caches its results.
<a href="classLuminousStringSearch.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:add9f60d00e3eaea29d0e577e84292256"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="add9f60d00e3eaea29d0e577e84292256"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>__construct</b> ($str)</td></tr>
<tr class="memitem:ae6b1a2b900b6d8593cfd93272bc72ef2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStringSearch.html#ae6b1a2b900b6d8593cfd93272bc72ef2">match</a> ($search, $index, &amp;$matches)</td></tr>
<tr class="memdesc:ae6b1a2b900b6d8593cfd93272bc72ef2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs a search for the given pattern past the given index. <a href="#ae6b1a2b900b6d8593cfd93272bc72ef2"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a409d9de167e4668acbe3da71f2bfa277"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStringSearch.html#a409d9de167e4668acbe3da71f2bfa277">$cache</a> = array()</td></tr>
<tr class="memitem:a2ed7bad26a3e255195bb00c12a50e49c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2ed7bad26a3e255195bb00c12a50e49c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStringSearch.html#a2ed7bad26a3e255195bb00c12a50e49c">$string</a></td></tr>
<tr class="memdesc:a2ed7bad26a3e255195bb00c12a50e49c"><td class="mdescLeft">&#160;</td><td class="mdescRight">A copy of the string to operate on. <br/></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A basic preg_match wrapper which caches its results. </p>
<dl class="section note"><dt>Note</dt><dd>This class is used by <a class="el" href="classScanner.html" title="Base string scanning class.">Scanner</a> and should not need to be used by anything else.</dd></dl>
<p>A class encapsulating the process of searching for a substring efficiently it handles caching of results.</p>
<dl class="section warning"><dt>Warning</dt><dd>One instance should be used only incrementally along a string. i.e. do not call it with index = 5 then index = 1.</dd></dl>
</div><h2>Member Function Documentation</h2>
<a class="anchor" id="ae6b1a2b900b6d8593cfd93272bc72ef2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousStringSearch::match </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$search</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&amp;&#160;</td>
<td class="paramname"><em>$matches</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs a search for the given pattern past the given index. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$search</td><td>the pattern to search for </td></tr>
<tr><td class="paramname">$index</td><td>the minimum string index (offset) of a result </td></tr>
<tr><td class="paramname">$matches</td><td>a reference to the return location of the match groups </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the index or false if no match is found. </dd></dl>
</div>
</div>
<h2>Member Data Documentation</h2>
<a class="anchor" id="a409d9de167e4668acbe3da71f2bfa277"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousStringSearch::$cache = array()</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The cache is stored as a map of pattern =&gt; result, the result is an array of: (0=&gt;index, 1=&gt;match_groups), OR, it is false if there are no more results left in the string. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/core/strsearch.class.php</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:50 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,110 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: Member List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">LuminousTokenPresets Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="classLuminousTokenPresets.html">LuminousTokenPresets</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classLuminousTokenPresets.html#a2a1bb95d9131701b61a28b085f4d3653">$C_COMMENT_ML</a></td><td class="entry"><a class="el" href="classLuminousTokenPresets.html">LuminousTokenPresets</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousTokenPresets.html#aeb1c122a80cc1b3d00eb6eb112da4b1f">$C_COMMENT_SL</a></td><td class="entry"><a class="el" href="classLuminousTokenPresets.html">LuminousTokenPresets</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousTokenPresets.html#a74183f045ac39cf2b30e1bdc98c3a34c">$CHAR</a></td><td class="entry"><a class="el" href="classLuminousTokenPresets.html">LuminousTokenPresets</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousTokenPresets.html#ae5053efc9d68d6c83988d0c29dd0bf60">$DOUBLE_STR</a></td><td class="entry"><a class="el" href="classLuminousTokenPresets.html">LuminousTokenPresets</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousTokenPresets.html#a622c25d34fdb4f6fd66c774a0e8e2a91">$DOUBLE_STR_SL</a></td><td class="entry"><a class="el" href="classLuminousTokenPresets.html">LuminousTokenPresets</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousTokenPresets.html#a7230e06c64a6f4ce165e12f5bd39ec6a">$NUM_HEX</a></td><td class="entry"><a class="el" href="classLuminousTokenPresets.html">LuminousTokenPresets</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousTokenPresets.html#a92cf3ef1206f3045feec2d651266dd76">$NUM_REAL</a></td><td class="entry"><a class="el" href="classLuminousTokenPresets.html">LuminousTokenPresets</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousTokenPresets.html#aed7c53313969df00c41b6dc62862f12d">$PERL_COMMENT</a></td><td class="entry"><a class="el" href="classLuminousTokenPresets.html">LuminousTokenPresets</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousTokenPresets.html#a2af434cd51ac824e7c386bf6856bdb52">$SINGLE_STR</a></td><td class="entry"><a class="el" href="classLuminousTokenPresets.html">LuminousTokenPresets</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousTokenPresets.html#ad012cf604ed4da5e3ef57338527fd5df">$SINGLE_STR_SL</a></td><td class="entry"><a class="el" href="classLuminousTokenPresets.html">LuminousTokenPresets</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousTokenPresets.html#a20e568ce1f9f82efa80f781033cb7e9c">$SQL_SINGLE_STR</a></td><td class="entry"><a class="el" href="classLuminousTokenPresets.html">LuminousTokenPresets</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousTokenPresets.html#a7757feb38c55d3fffe8afe16957af183">$SQL_SINGLE_STR_BSLASH</a></td><td class="entry"><a class="el" href="classLuminousTokenPresets.html">LuminousTokenPresets</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:50 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,172 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: LuminousTokenPresets Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="classLuminousTokenPresets-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">LuminousTokenPresets Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A set of pre-defined patterns to match various common tokens.
<a href="classLuminousTokenPresets.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a2a1bb95d9131701b61a28b085f4d3653"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2a1bb95d9131701b61a28b085f4d3653"></a>
static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousTokenPresets.html#a2a1bb95d9131701b61a28b085f4d3653">$C_COMMENT_ML</a> = '% / \* (?&gt; [^\\*]+ | \\*(?!/) )* (?: \\*/ | $) %sx'</td></tr>
<tr class="memdesc:a2a1bb95d9131701b61a28b085f4d3653"><td class="mdescLeft">&#160;</td><td class="mdescRight">Multiline C style comment. <br/></td></tr>
<tr class="memitem:aeb1c122a80cc1b3d00eb6eb112da4b1f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb1c122a80cc1b3d00eb6eb112da4b1f"></a>
static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousTokenPresets.html#aeb1c122a80cc1b3d00eb6eb112da4b1f">$C_COMMENT_SL</a> = '% // .* %x'</td></tr>
<tr class="memdesc:aeb1c122a80cc1b3d00eb6eb112da4b1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Single line c++ style comment. <br/></td></tr>
<tr class="memitem:a74183f045ac39cf2b30e1bdc98c3a34c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a74183f045ac39cf2b30e1bdc98c3a34c"></a>
static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousTokenPresets.html#a74183f045ac39cf2b30e1bdc98c3a34c">$CHAR</a> = &quot;(?: \\\\(?: x[A-F0-9]{1,2}| . ) | . ) (?: '|\$)/ixm&quot;</td></tr>
<tr class="memdesc:a74183f045ac39cf2b30e1bdc98c3a34c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Single quoted c-style character. <br/></td></tr>
<tr class="memitem:ae5053efc9d68d6c83988d0c29dd0bf60"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae5053efc9d68d6c83988d0c29dd0bf60"></a>
static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousTokenPresets.html#ae5053efc9d68d6c83988d0c29dd0bf60">$DOUBLE_STR</a> = '/&quot; (?&gt; [^&quot;\\\\]+ | \\\\.)* (?:&quot;|$)/xs'</td></tr>
<tr class="memdesc:ae5053efc9d68d6c83988d0c29dd0bf60"><td class="mdescLeft">&#160;</td><td class="mdescRight">multi-line double quoted string using backslash escapes <br/></td></tr>
<tr class="memitem:a622c25d34fdb4f6fd66c774a0e8e2a91"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a622c25d34fdb4f6fd66c774a0e8e2a91"></a>
static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousTokenPresets.html#a622c25d34fdb4f6fd66c774a0e8e2a91">$DOUBLE_STR_SL</a> = &quot;/\&quot;(?&gt; [^\\\\\&quot;\n]+ | \\\\.)*(?:\$|\&quot;)/xms&quot;</td></tr>
<tr class="memdesc:a622c25d34fdb4f6fd66c774a0e8e2a91"><td class="mdescLeft">&#160;</td><td class="mdescRight">single line double quoted string using backslash escapes <br/></td></tr>
<tr class="memitem:a7230e06c64a6f4ce165e12f5bd39ec6a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7230e06c64a6f4ce165e12f5bd39ec6a"></a>
static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousTokenPresets.html#a7230e06c64a6f4ce165e12f5bd39ec6a">$NUM_HEX</a> = '/0[Xx][a-fA-F0-9]+/'</td></tr>
<tr class="memdesc:a7230e06c64a6f4ce165e12f5bd39ec6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">hexadecimal literal <br/></td></tr>
<tr class="memitem:a92cf3ef1206f3045feec2d651266dd76"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousTokenPresets.html#a92cf3ef1206f3045feec2d651266dd76">$NUM_REAL</a></td></tr>
<tr class="memdesc:a92cf3ef1206f3045feec2d651266dd76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Real number, i.e. an integer or a float, optionally with an exponent. <a href="#a92cf3ef1206f3045feec2d651266dd76"></a><br/></td></tr>
<tr class="memitem:aed7c53313969df00c41b6dc62862f12d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed7c53313969df00c41b6dc62862f12d"></a>
static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousTokenPresets.html#aed7c53313969df00c41b6dc62862f12d">$PERL_COMMENT</a> = '/#.*/'</td></tr>
<tr class="memdesc:aed7c53313969df00c41b6dc62862f12d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Perl/Python/Ruby style hash-comment (single line) <br/></td></tr>
<tr class="memitem:a2af434cd51ac824e7c386bf6856bdb52"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2af434cd51ac824e7c386bf6856bdb52"></a>
static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousTokenPresets.html#a2af434cd51ac824e7c386bf6856bdb52">$SINGLE_STR</a> = &quot;/' (?&gt; [^'\\\\]+ | \\\\.)* (?:'|\$)/xs&quot;</td></tr>
<tr class="memdesc:a2af434cd51ac824e7c386bf6856bdb52"><td class="mdescLeft">&#160;</td><td class="mdescRight">multi-line single quote string using backslash escapes <br/></td></tr>
<tr class="memitem:ad012cf604ed4da5e3ef57338527fd5df"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad012cf604ed4da5e3ef57338527fd5df"></a>
static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousTokenPresets.html#ad012cf604ed4da5e3ef57338527fd5df">$SINGLE_STR_SL</a> = &quot;/'(?&gt; [^\\\\'\n]+ | \\\\.)*(?:\$|')/xms&quot;</td></tr>
<tr class="memdesc:ad012cf604ed4da5e3ef57338527fd5df"><td class="mdescLeft">&#160;</td><td class="mdescRight">single line single quoted string using backslash escapes <br/></td></tr>
<tr class="memitem:a20e568ce1f9f82efa80f781033cb7e9c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a20e568ce1f9f82efa80f781033cb7e9c"></a>
static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousTokenPresets.html#a20e568ce1f9f82efa80f781033cb7e9c">$SQL_SINGLE_STR</a> = &quot;/ ' (?&gt; [^']+ | '' )* (?: '|\$)/x&quot;</td></tr>
<tr class="memdesc:a20e568ce1f9f82efa80f781033cb7e9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">SQL style single quoted string using '' to escape. <br/></td></tr>
<tr class="memitem:a7757feb38c55d3fffe8afe16957af183"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7757feb38c55d3fffe8afe16957af183"></a>
static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousTokenPresets.html#a7757feb38c55d3fffe8afe16957af183">$SQL_SINGLE_STR_BSLASH</a> = &quot;/ ' (?&gt; [^'\\\\]+ | '' | \\\\. )* (?: '|\$)/x&quot;</td></tr>
<tr class="memdesc:a7757feb38c55d3fffe8afe16957af183"><td class="mdescLeft">&#160;</td><td class="mdescRight">SQL style single quoted string using '' or \' to escape. <br/></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A set of pre-defined patterns to match various common tokens. </p>
</div><h2>Member Data Documentation</h2>
<a class="anchor" id="a92cf3ef1206f3045feec2d651266dd76"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousTokenPresets::$NUM_REAL</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line"> <span class="stringliteral">&#39;/</span></div>
<div class="line"><span class="stringliteral"> (?: \d+ (?: \.\d+ )? | \.?\d+) # int, fraction or significand </span></div>
<div class="line"><span class="stringliteral"> (?:e[+-]?\d+)? # exponent</span></div>
<div class="line"><span class="stringliteral"> /ix&#39;</span></div>
</div><!-- fragment -->
<p>Real number, i.e. an integer or a float, optionally with an exponent. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/core/tokenpresets.class.php</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:50 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,103 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: Member List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">LuminousUtils Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="classLuminousUtils.html">LuminousUtils</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classLuminousUtils.html#a2ac54e45d680481dcce190154d8ff0d9">balance_delimiter</a>($delimiter)</td><td class="entry"><a class="el" href="classLuminousUtils.html">LuminousUtils</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousUtils.html#a25ba2a727a415d71c3d57fd03bdf95ea">escape_string</a>($string)</td><td class="entry"><a class="el" href="classLuminousUtils.html">LuminousUtils</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousUtils.html#a5f41f0e028071fb66f201a13d244cc8a">escape_token</a>($token)</td><td class="entry"><a class="el" href="classLuminousUtils.html">LuminousUtils</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classLuminousUtils.html#ab2cb0b63cfbf8767c8e5a2837ae8d4c7">pcre_error_decode</a>($errcode)</td><td class="entry"><a class="el" href="classLuminousUtils.html">LuminousUtils</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classLuminousUtils.html#a50b5bcd2eb6e5c5c452899e42fe2fcc8">tag_block</a>($type, $block, $split_multiline=true)</td><td class="entry"><a class="el" href="classLuminousUtils.html">LuminousUtils</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:51 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,309 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: LuminousUtils Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classLuminousUtils-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">LuminousUtils Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A set of utility functions for scanners.
<a href="classLuminousUtils.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a2ac54e45d680481dcce190154d8ff0d9"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousUtils.html#a2ac54e45d680481dcce190154d8ff0d9">balance_delimiter</a> ($delimiter)</td></tr>
<tr class="memdesc:a2ac54e45d680481dcce190154d8ff0d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tries to balance a delimiter. <a href="#a2ac54e45d680481dcce190154d8ff0d9"></a><br/></td></tr>
<tr class="memitem:a25ba2a727a415d71c3d57fd03bdf95ea"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousUtils.html#a25ba2a727a415d71c3d57fd03bdf95ea">escape_string</a> ($string)</td></tr>
<tr class="memdesc:a25ba2a727a415d71c3d57fd03bdf95ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Escapes a string suitable for use in XML. <a href="#a25ba2a727a415d71c3d57fd03bdf95ea"></a><br/></td></tr>
<tr class="memitem:a5f41f0e028071fb66f201a13d244cc8a"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousUtils.html#a5f41f0e028071fb66f201a13d244cc8a">escape_token</a> ($token)</td></tr>
<tr class="memdesc:a5f41f0e028071fb66f201a13d244cc8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Escapes a token so its string is suitable for use in XML. <a href="#a5f41f0e028071fb66f201a13d244cc8a"></a><br/></td></tr>
<tr class="memitem:ab2cb0b63cfbf8767c8e5a2837ae8d4c7"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousUtils.html#ab2cb0b63cfbf8767c8e5a2837ae8d4c7">pcre_error_decode</a> ($errcode)</td></tr>
<tr class="memdesc:ab2cb0b63cfbf8767c8e5a2837ae8d4c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decodes PCRE error codes to human readable strings. <a href="#ab2cb0b63cfbf8767c8e5a2837ae8d4c7"></a><br/></td></tr>
<tr class="memitem:a50b5bcd2eb6e5c5c452899e42fe2fcc8"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousUtils.html#a50b5bcd2eb6e5c5c452899e42fe2fcc8">tag_block</a> ($type, $block, $split_multiline=true)</td></tr>
<tr class="memdesc:a50b5bcd2eb6e5c5c452899e42fe2fcc8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wraps a block of text in an XML tag. <a href="#a50b5bcd2eb6e5c5c452899e42fe2fcc8"></a><br/></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A set of utility functions for scanners. </p>
</div><h2>Member Function Documentation</h2>
<a class="anchor" id="a2ac54e45d680481dcce190154d8ff0d9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static LuminousUtils::balance_delimiter </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$delimiter</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Tries to balance a delimiter. </p>
<p>Tries to 'balance' a single character delimiter, i.e: '(' is mapped to ')' '{' is mapped to '}', '[' is mapped to ']', '&lt;' is mapped to '&gt;' Any other character is mapped to itself.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$delimiter</td><td>the left/opening delimiter to try to balance </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The corresponding close delimiter character, or the input character. </dd></dl>
</div>
</div>
<a class="anchor" id="a25ba2a727a415d71c3d57fd03bdf95ea"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static LuminousUtils::escape_string </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$string</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Escapes a string suitable for use in XML. </p>
<p>Escapes a string according to the Luminous internal escaping format (this is currently htmlspecialchars with ENT_NOQUOTES.) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$string</td><td>the string to escape </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the escaped string </dd></dl>
</div>
</div>
<a class="anchor" id="a5f41f0e028071fb66f201a13d244cc8a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static LuminousUtils::escape_token </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$token</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Escapes a token so its string is suitable for use in XML. </p>
<p>Escapes a token. If the token is already escaped, nothing changes. If the token is not escaped, the escaped flag is set (index 2) and the token text (index 1) is escaped according to the internal escaping format </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$token</td><td>the token to escape </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the escaped token </dd></dl>
</div>
</div>
<a class="anchor" id="ab2cb0b63cfbf8767c8e5a2837ae8d4c7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static LuminousUtils::pcre_error_decode </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$errcode</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Decodes PCRE error codes to human readable strings. </p>
<p>Decodes a PCRE error code, which was returned by preg_last_error(), to something readable </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$errcode</td><td>the error code </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the error description, as string. This is currently the same as the constant name, so the constant PREG_NO_ERROR is mapped to the string 'PREG_NO_ERROR' </dd></dl>
</div>
</div>
<a class="anchor" id="a50b5bcd2eb6e5c5c452899e42fe2fcc8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static LuminousUtils::tag_block </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$block</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$split_multiline</em> = <code>true</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Wraps a block of text in an XML tag. </p>
<p>Tags a block of text. The block is assumed to have been escaped correctly with <a class="el" href="classLuminousUtils.html#a25ba2a727a415d71c3d57fd03bdf95ea" title="Escapes a string suitable for use in XML.">LuminousUtils::escape_string</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$type</td><td>the type to tag the string as, this is the token name </td></tr>
<tr><td class="paramname">$block</td><td>the block of text </td></tr>
<tr><td class="paramname">$split_multiline</td><td>if this is set to true, the tags are closed at the end of each line and re-opened again on the next line. This is useful for output formats like HTML, where spanning multiple lines could break the markup </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The tagged block of text. This resembles an XML fragment. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/core/utils.class.php</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:50 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,134 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: Member List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Scanner Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="classScanner.html">Scanner</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a1df8db865da4a56e83848e66c2fdd86c">$index</a></td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a7ffc9d830a0a2a0468f23e6150f662ab">$match_history</a></td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#ae07cbb19db97a18f93090e761243d890">$patterns</a></td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a289bba9fedd00d7e2219d30f547ac392">$src</a></td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a3d1a7f67acfa79b0ea574418e4a478a7">$src_len</a></td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a26970234bb2dde880548b084a0ade5e2">$ss</a></td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#ad1d5baf8c44c848eb7625ccf71d2e98b">__check</a>($pattern, $instant=true, $consume=true, $consume_match=true, $log=true)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a36dc435076406066ee020bea8b3f46b2">__construct</a>($src=null)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#ad2854d57ce631547fca7d250a67dfb5d">__consume</a>($pos, $consume_match, $match_data)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a3b0b80f32a1dfd96c8cd9b7fe7f3f759">__log_match</a>($index, $match_pos, $match_data)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a4cb6935d759ee0c75fa01b75e2d0ec04">add_pattern</a>($name, $pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a77abc2d2de424e73d1ee659fd9001e4a">bol</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#ae483fc35eae064c75f8b5ca105826757">check</a>($pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a8ad6032d3a1f955608905c10a864aee6">eol</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a23543739aee09e2e1961a556a9672c7d">eos</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a154d424c925ed0d58e033f1e71ceef03">get</a>($n=1)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#ac8beec743c18d54cec51273b3bb7f3b5">get_next</a>($patterns)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a21f59cd38d7ed3ccd43955386b6aa14e">get_next_named</a>($patterns)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a57774c7a298bb43c1c4406a830d386a6">get_next_strpos</a>($patterns)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a90bacd70c30eb1d76659c0586f0683d2">index</a>($pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a17ac6e2abcb54a6dfaa9abaf95ed839e">match</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#aa933ee80eb310785c75ab7b03ed01885">match_group</a>($g=0)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a9271f0acf8d19f83fa45ee3ee1d3eab5">match_groups</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#aa5520e0fc7df54d7a25d75037e6cdc8a">match_pos</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a5e03667fd1cdc1d1fd40a4bc15570b12">next_match</a>($consume_and_log=true)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a3028e787442cf1ed9252397ed029b223">peek</a>($n=1)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a546cafdcfc3adeb19959ae14dff10996">pos</a>($new_pos=null)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a947d15fe4bd13b64afd5eaba8d4d3819">pos_shift</a>($offset)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a79c559549e2dd73c3f1892e7609e84a6">remove_pattern</a>($name)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a89d1448f666d1be3d5037c69f24eb516">reset</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#aeae50ecaf6b98a0b76f47c3d04b8deb3">rest</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a78ddb203c30c2f9e69755ec00c341add">scan</a>($pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#aa0e261d4b0c2fce43ba3c264036afd72">scan_until</a>($pattern)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a577a70297f4d3da0aa2ce4decc66eeea">string</a>($s=null)</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classScanner.html#a185d6e780752848cb282add6d9f936bb">terminate</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classScanner.html#a6f6665b8df561788b1b2dea40bb394ae">unscan</a>()</td><td class="entry"><a class="el" href="classScanner.html">Scanner</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:51 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

1028
3rdparty/luminous/docs/html/classScanner.html vendored Executable file

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,14 @@
digraph "Scanner"
{
edge [fontname="FreeSans",fontsize="10",labelfontname="FreeSans",labelfontsize="10"];
node [fontname="FreeSans",fontsize="10",shape=record];
Node1 [label="Scanner",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled" fontcolor="black"];
Node1 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node2 [label="LuminousScanner",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classLuminousScanner.html",tooltip="the base class for all scanners"];
Node2 -> Node3 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node3 [label="LuminousEmbeddedWebScript",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classLuminousEmbeddedWebScript.html",tooltip="Superclass for languages which may nest, i.e. web languages."];
Node2 -> Node4 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node4 [label="LuminousSimpleScanner",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classLuminousSimpleScanner.html",tooltip="A largely automated scanner."];
Node4 -> Node5 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node5 [label="LuminousStatefulScanner",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classLuminousStatefulScanner.html",tooltip="Experimental transition table driven scanner."];
}

View File

@ -0,0 +1 @@
6d1eba7c26e209408319d311ae8dae58

105
3rdparty/luminous/docs/html/classes.html vendored Executable file
View File

@ -0,0 +1,105 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: Class Index</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Class Index</div> </div>
</div><!--header-->
<div class="contents">
<div class="qindex"><a class="qindex" href="#letter_L">L</a>&#160;|&#160;<a class="qindex" href="#letter_S">S</a></div>
<table style="margin: 10px; white-space: nowrap;" align="center" width="95%" border="0" cellspacing="0" cellpadding="0">
<tr><td rowspan="2" valign="bottom"><a name="letter_L"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;L&#160;&#160;</div></td></tr></table>
</td><td valign="top"><a class="el" href="classLuminousEmbeddedWebScript.html">LuminousEmbeddedWebScript</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classLuminousScanner.html">LuminousScanner</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classLuminousStringSearch.html">LuminousStringSearch</a>&#160;&#160;&#160;</td><td rowspan="2" valign="bottom"><a name="letter_S"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;S&#160;&#160;</div></td></tr></table>
</td></tr>
<tr><td valign="top"><a class="el" href="classLuminousFilters.html">LuminousFilters</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classLuminousSimpleScanner.html">LuminousSimpleScanner</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classLuminousTokenPresets.html">LuminousTokenPresets</a>&#160;&#160;&#160;</td></tr>
<tr><td valign="top"><a class="el" href="classluminous.html">luminous</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classLuminousOptions.html">LuminousOptions</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classLuminousStatefulScanner.html">LuminousStatefulScanner</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classLuminousUtils.html">LuminousUtils</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classScanner.html">Scanner</a>&#160;&#160;&#160;</td></tr>
<tr><td></td><td></td><td></td><td></td><td></td></tr>
</table>
<div class="qindex"><a class="qindex" href="#letter_L">L</a>&#160;|&#160;<a class="qindex" href="#letter_S">S</a></div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:51 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,114 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: Member List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">luminous Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="classluminous.html">luminous</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classluminous.html#a2091154c8802bc577130f6bf4b9fe7c5">__guess_language_cmp</a>($a, $b)</td><td class="entry"><a class="el" href="classluminous.html">luminous</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classluminous.html#ac10179e43dc878063150584091c1dcb4">cache_errors</a>()</td><td class="entry"><a class="el" href="classluminous.html">luminous</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classluminous.html#a5495a0831fcb35ccb4e46d54748916e1">formatter</a>()</td><td class="entry"><a class="el" href="classluminous.html">luminous</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classluminous.html#ae6d5094890e6590efe54c33fb9ed23f6">guess_language</a>($src, $confidence=0.05, $default= 'plain')</td><td class="entry"><a class="el" href="classluminous.html">luminous</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classluminous.html#a44f8e7eb81316db20d4e6969b7fe8ef5">guess_language_full</a>($src)</td><td class="entry"><a class="el" href="classluminous.html">luminous</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classluminous.html#aec66d6c5d22ff1254f8c5ff73fb0f71d">head_html</a>()</td><td class="entry"><a class="el" href="classluminous.html">luminous</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classluminous.html#a51d6db398127b5b7a1bbb27af6a0790e">highlight</a>($scanner, $source, $cache_or_settings=null)</td><td class="entry"><a class="el" href="classluminous.html">luminous</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classluminous.html#abe612a3df76685834bcd8afaffee544b">highlight_file</a>($scanner, $file, $cache_or_settings=null)</td><td class="entry"><a class="el" href="classluminous.html">luminous</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classluminous.html#a49d5450bc78c1bfc1bc5aeaff954c39f">register_scanner</a>($language_code, $classname, $readable_language, $path, $dependencies=null)</td><td class="entry"><a class="el" href="classluminous.html">luminous</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classluminous.html#ae77609b01703562b0bfed047a7f48767">root</a>()</td><td class="entry"><a class="el" href="classluminous.html">luminous</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classluminous.html#a1234abdb40eb18ceba4a5bcc12f9e89f">scanners</a>()</td><td class="entry"><a class="el" href="classluminous.html">luminous</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classluminous.html#ace722a2ba2c2251eabccf6f0d18bcbe9">set</a>($option, $value=null)</td><td class="entry"><a class="el" href="classluminous.html">luminous</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classluminous.html#af5888c20eb26757b5bd9af198e44ec96">setting</a>($option)</td><td class="entry"><a class="el" href="classluminous.html">luminous</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classluminous.html#a0bfdea509586ce343d2e6001ad33ccd0">theme</a>($theme)</td><td class="entry"><a class="el" href="classluminous.html">luminous</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classluminous.html#a069fa20b026732cc6366743f3688a822">theme_exists</a>($theme)</td><td class="entry"><a class="el" href="classluminous.html">luminous</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classluminous.html#a9bb8a124a3d5cff72a9756edabc7419a">themes</a>()</td><td class="entry"><a class="el" href="classluminous.html">luminous</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:50 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

763
3rdparty/luminous/docs/html/classluminous.html vendored Executable file
View File

@ -0,0 +1,763 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: luminous Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classluminous-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">luminous Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Users' API.
<a href="classluminous.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a2091154c8802bc577130f6bf4b9fe7c5"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classluminous.html#a2091154c8802bc577130f6bf4b9fe7c5">__guess_language_cmp</a> ($a, $b)</td></tr>
<tr class="memitem:ac10179e43dc878063150584091c1dcb4"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classluminous.html#ac10179e43dc878063150584091c1dcb4">cache_errors</a> ()</td></tr>
<tr class="memdesc:ac10179e43dc878063150584091c1dcb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a list of cache errors encountered during the most recent highlight. <a href="#ac10179e43dc878063150584091c1dcb4"></a><br/></td></tr>
<tr class="memitem:a5495a0831fcb35ccb4e46d54748916e1"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classluminous.html#a5495a0831fcb35ccb4e46d54748916e1">formatter</a> ()</td></tr>
<tr class="memdesc:a5495a0831fcb35ccb4e46d54748916e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a formatter instance. <a href="#a5495a0831fcb35ccb4e46d54748916e1"></a><br/></td></tr>
<tr class="memitem:ae6d5094890e6590efe54c33fb9ed23f6"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classluminous.html#ae6d5094890e6590efe54c33fb9ed23f6">guess_language</a> ($src, $confidence=0.05, $default= 'plain')</td></tr>
<tr class="memdesc:ae6d5094890e6590efe54c33fb9ed23f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attempts to guess the language of a piece of source code. <a href="#ae6d5094890e6590efe54c33fb9ed23f6"></a><br/></td></tr>
<tr class="memitem:a44f8e7eb81316db20d4e6969b7fe8ef5"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classluminous.html#a44f8e7eb81316db20d4e6969b7fe8ef5">guess_language_full</a> ($src)</td></tr>
<tr class="memdesc:a44f8e7eb81316db20d4e6969b7fe8ef5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attempts to guess the language of a piece of source code. <a href="#a44f8e7eb81316db20d4e6969b7fe8ef5"></a><br/></td></tr>
<tr class="memitem:aec66d6c5d22ff1254f8c5ff73fb0f71d"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classluminous.html#aec66d6c5d22ff1254f8c5ff73fb0f71d">head_html</a> ()</td></tr>
<tr class="memdesc:aec66d6c5d22ff1254f8c5ff73fb0f71d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the markup you need to include in your web page. <a href="#aec66d6c5d22ff1254f8c5ff73fb0f71d"></a><br/></td></tr>
<tr class="memitem:a51d6db398127b5b7a1bbb27af6a0790e"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classluminous.html#a51d6db398127b5b7a1bbb27af6a0790e">highlight</a> ($scanner, $source, $cache_or_settings=null)</td></tr>
<tr class="memdesc:a51d6db398127b5b7a1bbb27af6a0790e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Highlights a string according to the current settings. <a href="#a51d6db398127b5b7a1bbb27af6a0790e"></a><br/></td></tr>
<tr class="memitem:abe612a3df76685834bcd8afaffee544b"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classluminous.html#abe612a3df76685834bcd8afaffee544b">highlight_file</a> ($scanner, $file, $cache_or_settings=null)</td></tr>
<tr class="memdesc:abe612a3df76685834bcd8afaffee544b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Highlights a file according to the current setings. <a href="#abe612a3df76685834bcd8afaffee544b"></a><br/></td></tr>
<tr class="memitem:a49d5450bc78c1bfc1bc5aeaff954c39f"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classluminous.html#a49d5450bc78c1bfc1bc5aeaff954c39f">register_scanner</a> ($language_code, $classname, $readable_language, $path, $dependencies=null)</td></tr>
<tr class="memdesc:a49d5450bc78c1bfc1bc5aeaff954c39f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a scanner. <a href="#a49d5450bc78c1bfc1bc5aeaff954c39f"></a><br/></td></tr>
<tr class="memitem:ae77609b01703562b0bfed047a7f48767"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classluminous.html#ae77609b01703562b0bfed047a7f48767">root</a> ()</td></tr>
<tr class="memdesc:ae77609b01703562b0bfed047a7f48767"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the full filesystem path to Luminous. <a href="#ae77609b01703562b0bfed047a7f48767"></a><br/></td></tr>
<tr class="memitem:a1234abdb40eb18ceba4a5bcc12f9e89f"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classluminous.html#a1234abdb40eb18ceba4a5bcc12f9e89f">scanners</a> ()</td></tr>
<tr class="memdesc:a1234abdb40eb18ceba4a5bcc12f9e89f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a list of registered scanners. <a href="#a1234abdb40eb18ceba4a5bcc12f9e89f"></a><br/></td></tr>
<tr class="memitem:ace722a2ba2c2251eabccf6f0d18bcbe9"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classluminous.html#ace722a2ba2c2251eabccf6f0d18bcbe9">set</a> ($option, $value=null)</td></tr>
<tr class="memdesc:ace722a2ba2c2251eabccf6f0d18bcbe9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the given option to the given value. <a href="#ace722a2ba2c2251eabccf6f0d18bcbe9"></a><br/></td></tr>
<tr class="memitem:af5888c20eb26757b5bd9af198e44ec96"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classluminous.html#af5888c20eb26757b5bd9af198e44ec96">setting</a> ($option)</td></tr>
<tr class="memdesc:af5888c20eb26757b5bd9af198e44ec96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a setting's value. <a href="#af5888c20eb26757b5bd9af198e44ec96"></a><br/></td></tr>
<tr class="memitem:a0bfdea509586ce343d2e6001ad33ccd0"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classluminous.html#a0bfdea509586ce343d2e6001ad33ccd0">theme</a> ($theme)</td></tr>
<tr class="memdesc:a0bfdea509586ce343d2e6001ad33ccd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads a CSS theme file Gets the CSS-string content of a theme file. Use this function for reading themes as it involves security checks against reading arbitrary files. <a href="#a0bfdea509586ce343d2e6001ad33ccd0"></a><br/></td></tr>
<tr class="memitem:a069fa20b026732cc6366743f3688a822"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classluminous.html#a069fa20b026732cc6366743f3688a822">theme_exists</a> ($<a class="el" href="classluminous.html#a0bfdea509586ce343d2e6001ad33ccd0">theme</a>)</td></tr>
<tr class="memdesc:a069fa20b026732cc6366743f3688a822"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether a theme exists. <a href="#a069fa20b026732cc6366743f3688a822"></a><br/></td></tr>
<tr class="memitem:a9bb8a124a3d5cff72a9756edabc7419a"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classluminous.html#a9bb8a124a3d5cff72a9756edabc7419a">themes</a> ()</td></tr>
<tr class="memdesc:a9bb8a124a3d5cff72a9756edabc7419a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a list of installed themes. <a href="#a9bb8a124a3d5cff72a9756edabc7419a"></a><br/></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Users' API. </p>
</div><h2>Member Function Documentation</h2>
<a class="anchor" id="a2091154c8802bc577130f6bf4b9fe7c5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static luminous::__guess_language_cmp </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$b</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Comparison function for <a class="el" href="classluminous.html#ae6d5094890e6590efe54c33fb9ed23f6" title="Attempts to guess the language of a piece of source code.">guess_language()</a>'s sorting </p>
</div>
</div>
<a class="anchor" id="ac10179e43dc878063150584091c1dcb4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static luminous::cache_errors </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a list of cache errors encountered during the most recent highlight. </p>
<dl class="section return"><dt>Returns</dt><dd>An array of errors the cache encountered (which may be empty), or <code>FALSE</code> if the cache is not enabled </dd></dl>
</div>
</div>
<a class="anchor" id="a5495a0831fcb35ccb4e46d54748916e1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static luminous::formatter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a formatter instance. </p>
<dl class="section return"><dt>Returns</dt><dd>an instance of a LuminousFormatter according to the current format setting</dd></dl>
<p>This shouldn't be necessary for general usage, it is only implemented for testing. </p>
</div>
</div>
<a class="anchor" id="ae6d5094890e6590efe54c33fb9ed23f6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static luminous::guess_language </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$confidence</em> = <code>0.05</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$default</em> = <code>'plain'</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Attempts to guess the language of a piece of source code. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$src</td><td>The source code whose language is to be guessed </td></tr>
<tr><td class="paramname">$confidence</td><td>The desired confidence level: if this is 0.05 but the best guess has a confidence of 0.04, then $default is returned. Note that the confidence level returned by scanners is quite arbitrary, so don't set this to '1' thinking that'll give you better results. A realistic confidence is likely to be quite low, because a scanner will only return 1 if it's able to pick out a shebang (#!) line or something else definitive. If there exists no such identifier, a 'strong' confidence which is right most of the time might be as low as 0.1. Therefore it is recommended to keep this between 0.01 and 0.10. </td></tr>
<tr><td class="paramname">$default</td><td>The default name to return in the event that no scanner thinks this source belongs to them (at the desired confidence).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A valid code for the best scanner, or $default.</dd></dl>
<p>This is a wrapper around <a class="el" href="classluminous.html#a44f8e7eb81316db20d4e6969b7fe8ef5" title="Attempts to guess the language of a piece of source code.">luminous::guess_language_full</a> </p>
</div>
</div>
<a class="anchor" id="a44f8e7eb81316db20d4e6969b7fe8ef5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static luminous::guess_language_full </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$src</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Attempts to guess the language of a piece of source code. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$src</td><td>The source code whose language is to be guessed </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An array - the array is ordered by probability, with the most probable language coming first in the array. Each array element is an array which represents a language (scanner), and has the keys: <ul>
<li><code>'language'</code> =&gt; Human-readable language description, </li>
<li><code>'codes'</code> =&gt; valid codes for the language (array), </li>
<li><code>'p'</code> =&gt; the probability (between 0.0 and 1.0 inclusive),</li>
</ul>
note that <code>'language'</code> and <code>'codes'</code> are the key =&gt; value pair from <a class="el" href="classluminous.html#a1234abdb40eb18ceba4a5bcc12f9e89f" title="Gets a list of registered scanners.">luminous::scanners()</a></dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>Language guessing is inherently unreliable but should be right about 80% of the time on common languages. Bear in mind that guessing is going to be severely hampered in the case that one language is used to generate code in another language.</dd></dl>
<p>Usage for this function will be something like this: </p>
<div class="fragment"><div class="line">$guesses = <a class="code" href="classluminous.html#ae6d5094890e6590efe54c33fb9ed23f6" title="Attempts to guess the language of a piece of source code.">luminous::guess_language</a>($src);</div>
<div class="line">$output = <a class="code" href="classluminous.html#a51d6db398127b5b7a1bbb27af6a0790e" title="Highlights a string according to the current settings.">luminous::highlight</a>($guesses[0][<span class="stringliteral">&#39;codes&#39;</span>][0], $src);</div>
</div><!-- fragment --><dl class="section see"><dt>See Also</dt><dd><a class="el" href="classluminous.html#ae6d5094890e6590efe54c33fb9ed23f6" title="Attempts to guess the language of a piece of source code.">luminous::guess_language</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aec66d6c5d22ff1254f8c5ff73fb0f71d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static luminous::head_html </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the markup you need to include in your web page. </p>
<dl class="section return"><dt>Returns</dt><dd>a string representing everything that needs to be printed in the &lt;head&gt; section of a website.</dd></dl>
<p>This is influenced by the following settings: relative-root, include-javascript, include-jquery theme </p>
</div>
</div>
<a class="anchor" id="a51d6db398127b5b7a1bbb27af6a0790e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static luminous::highlight </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$scanner</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$cache_or_settings</em> = <code>null</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Highlights a string according to the current settings. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$scanner</td><td>The scanner to use, this can either be a langauge code, or it can be an instance of <a class="el" href="classLuminousScanner.html" title="the base class for all scanners">LuminousScanner</a>. </td></tr>
<tr><td class="paramname">$source</td><td>The source string </td></tr>
<tr><td class="paramname">$cache</td><td>Whether or not to use the cache </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the highlighted source code.</dd></dl>
<p>To specify different output formats or other options, see <a class="el" href="classluminous.html#ace722a2ba2c2251eabccf6f0d18bcbe9" title="Sets the given option to the given value.">set()</a>. </p>
</div>
</div>
<a class="anchor" id="abe612a3df76685834bcd8afaffee544b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static luminous::highlight_file </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$scanner</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$cache_or_settings</em> = <code>null</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Highlights a file according to the current setings. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$scanner</td><td>The scanner to use, this can either be a langauge code, or it can be an instance of <a class="el" href="classLuminousScanner.html" title="the base class for all scanners">LuminousScanner</a>. </td></tr>
<tr><td class="paramname">$file</td><td>the source string </td></tr>
<tr><td class="paramname">$cache</td><td>Whether or not to use the cache </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the highlighted source code.</dd></dl>
<p>To specify different output formats or other options, see <a class="el" href="classluminous.html#ace722a2ba2c2251eabccf6f0d18bcbe9" title="Sets the given option to the given value.">set()</a>. </p>
</div>
</div>
<a class="anchor" id="a49d5450bc78c1bfc1bc5aeaff954c39f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static luminous::register_scanner </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$language_code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$classname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$readable_language</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$dependencies</em> = <code>null</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers a scanner. </p>
<p>Registers a scanner with Luminous's scanner table. Utilising this function means that Luminous will handle instantiation and inclusion of the scanner's source file in a lazy-manner.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$language_code</td><td>A string or array of strings designating the aliases by which this scanner may be accessed </td></tr>
<tr><td class="paramname">$classname</td><td>The class name of the scanner, as string. If you leave this as 'null', it will be treated as a dummy file (you can use this to handle a set of non-circular include rules, if you run into problems). </td></tr>
<tr><td class="paramname">$readable_language</td><td>A human readable language name </td></tr>
<tr><td class="paramname">$path</td><td>The path to the source file containing your scanner </td></tr>
<tr><td class="paramname">dependencies</td><td>An array of other scanners which this scanner depends on (as sub-scanners, or superclasses). Each item in the array should be a $language_code for another scanner. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae77609b01703562b0bfed047a7f48767"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static luminous::root </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the full filesystem path to Luminous. </p>
<dl class="section return"><dt>Returns</dt><dd>what Luminous thinks its location is on the filesystem </dd></dl>
</div>
</div>
<a class="anchor" id="a1234abdb40eb18ceba4a5bcc12f9e89f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static luminous::scanners </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a list of registered scanners. </p>
<dl class="section return"><dt>Returns</dt><dd>a list of scanners currently registered. The list is in the format:</dd></dl>
<p>language_name =&gt; codes,</p>
<p>where language_name is a string, and codes is an array of strings.</p>
<p>The array is sorted alphabetically by key. </p>
</div>
</div>
<a class="anchor" id="ace722a2ba2c2251eabccf6f0d18bcbe9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static luminous::set </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$option</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$value</em> = <code>null</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the given option to the given value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$option</td><td>The name of the setting (corresponds to an attribute name in <a class="el" href="classLuminousOptions.html" title="Options class.">LuminousOptions</a>) </td></tr>
<tr><td class="paramname">$value</td><td>The new value of the setting </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Exception</td><td>if the option is unrecognised (and in various other validation failures), </td></tr>
<tr><td class="paramname">InvalidArgumentException</td><td>if the argument fails the type-validation check</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This function can also accept multiple settings if $option is a map of option_name=&gt;value</dd></dl>
<p>Options are stored in <a class="el" href="classLuminousOptions.html" title="Options class.">LuminousOptions</a>, which provides documentation of each option.</p>
<dl class="section note"><dt>Note</dt><dd>as of 0.7 this is a thin wrapper around LuminousOptions::set()</dd></dl>
<dl class="section see"><dt>See Also</dt><dd>LuminousOptions::set </dd></dl>
</div>
</div>
<a class="anchor" id="af5888c20eb26757b5bd9af198e44ec96"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static luminous::setting </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$option</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a setting's value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$option</td><td>The name of the setting (corresponds to an attribute name in <a class="el" href="classLuminousOptions.html" title="Options class.">LuminousOptions</a>) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The value of the given setting </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Exception</td><td>if the option is unrecognised</td></tr>
</table>
</dd>
</dl>
<p>Options are stored in <a class="el" href="classLuminousOptions.html" title="Options class.">LuminousOptions</a>, which provides documentation of each option. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classLuminousOptions.html" title="Options class.">LuminousOptions</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a0bfdea509586ce343d2e6001ad33ccd0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static luminous::theme </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$theme</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a CSS theme file Gets the CSS-string content of a theme file. Use this function for reading themes as it involves security checks against reading arbitrary files. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$theme</td><td>The name of the theme to retrieve, which may or may not include the .css suffix. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the content of a theme; this is the actual CSS text. </dd></dl>
</div>
</div>
<a class="anchor" id="a069fa20b026732cc6366743f3688a822"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static luminous::theme_exists </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$theme</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks whether a theme exists. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$theme</td><td>the name of a theme, which should be suffixed with .css </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>TRUE</code> if a theme exists in style/, else <code>FALSE</code> </dd></dl>
</div>
</div>
<a class="anchor" id="a9bb8a124a3d5cff72a9756edabc7419a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static luminous::themes </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a list of installed themes. </p>
<dl class="section return"><dt>Returns</dt><dd>the list of theme files present in style/. Each theme will simply be a filename, and will end in .css, and will not have any directory prefix. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/luminous.php</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:50 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

BIN
3rdparty/luminous/docs/html/closed.png vendored Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 132 B

View File

@ -0,0 +1,104 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: src/utils/ Directory Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_313caf1132e152dd9b58bea13a4052ca.html">utils</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">utils Directory Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Directory dependency graph for src/utils/:</div>
<div class="dyncontent">
<div class="center"><img src="dir_313caf1132e152dd9b58bea13a4052ca_dep.png" border="0" usemap="#dir__313caf1132e152dd9b58bea13a4052ca__dep" alt="src/utils/"/></div>
<map name="dir__313caf1132e152dd9b58bea13a4052ca__dep" id="dir__313caf1132e152dd9b58bea13a4052ca__dep">
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="files"></a>
Files</h2></td></tr>
<tr class="memitem:cssparser_8class_8php"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>cssparser.class.php</b></td></tr>
</table>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:51 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,9 @@
digraph "src/utils/" {
compound=true
node [ fontsize="10", fontname="FreeSans"];
edge [ labelfontsize="10", labelfontname="FreeSans"];
subgraph clusterdir_68267d1309a1af8e8297ef4c3efbcdba {
graph [ bgcolor="#ddddee", pencolor="black", label="src" fontname="FreeSans", fontsize="10", URL="dir_68267d1309a1af8e8297ef4c3efbcdba.html"]
dir_313caf1132e152dd9b58bea13a4052ca [shape=box, label="utils", style="filled", fillcolor="#eeeeff", pencolor="black", URL="dir_313caf1132e152dd9b58bea13a4052ca.html"];
}
}

View File

@ -0,0 +1 @@
14ed9bee32b380a051d58a8ce2e2dbf6

View File

@ -0,0 +1,117 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: src/ Directory Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">src Directory Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Directory dependency graph for src/:</div>
<div class="dyncontent">
<div class="center"><img src="dir_68267d1309a1af8e8297ef4c3efbcdba_dep.png" border="0" usemap="#dir__68267d1309a1af8e8297ef4c3efbcdba__dep" alt="src/"/></div>
<map name="dir__68267d1309a1af8e8297ef4c3efbcdba__dep" id="dir__68267d1309a1af8e8297ef4c3efbcdba__dep">
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="subdirs"></a>
Directories</h2></td></tr>
<tr class="memitem:dir_6dd2d287d08a289e9849dd6e2f6b9333"><td class="memItemLeft" align="right" valign="top">directory &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="dir_6dd2d287d08a289e9849dd6e2f6b9333.html">cache</a></td></tr>
<tr class="memitem:dir_aebb8dcc11953d78e620bbef0b9e2183"><td class="memItemLeft" align="right" valign="top">directory &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="dir_aebb8dcc11953d78e620bbef0b9e2183.html">core</a></td></tr>
<tr class="memitem:dir_c5f232a4203c130ceb9aba0edfa2d75b"><td class="memItemLeft" align="right" valign="top">directory &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="dir_c5f232a4203c130ceb9aba0edfa2d75b.html">formatters</a></td></tr>
<tr class="memitem:dir_313caf1132e152dd9b58bea13a4052ca"><td class="memItemLeft" align="right" valign="top">directory &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="dir_313caf1132e152dd9b58bea13a4052ca.html">utils</a></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="files"></a>
Files</h2></td></tr>
<tr class="memitem:cli_8php"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>cli.php</b></td></tr>
<tr class="memitem:debug_8php"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>debug.php</b></td></tr>
<tr class="memitem:doxygen_8php"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>doxygen.php</b></td></tr>
<tr class="memitem:load__scanners_8php"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>load_scanners.php</b></td></tr>
<tr class="memitem:luminous_8php"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>luminous.php</b></td></tr>
<tr class="memitem:options_8class_8php"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>options.class.php</b></td></tr>
<tr class="memitem:scanners_8class_8php"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>scanners.class.php</b></td></tr>
</table>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:51 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,13 @@
digraph "src/" {
compound=true
node [ fontsize="10", fontname="FreeSans"];
edge [ labelfontsize="10", labelfontname="FreeSans"];
subgraph clusterdir_68267d1309a1af8e8297ef4c3efbcdba {
graph [ bgcolor="#eeeeff", pencolor="black", label="" URL="dir_68267d1309a1af8e8297ef4c3efbcdba.html"];
dir_68267d1309a1af8e8297ef4c3efbcdba [shape=plaintext label="src"];
dir_6dd2d287d08a289e9849dd6e2f6b9333 [shape=box label="cache" color="black" fillcolor="white" style="filled" URL="dir_6dd2d287d08a289e9849dd6e2f6b9333.html"];
dir_aebb8dcc11953d78e620bbef0b9e2183 [shape=box label="core" color="black" fillcolor="white" style="filled" URL="dir_aebb8dcc11953d78e620bbef0b9e2183.html"];
dir_c5f232a4203c130ceb9aba0edfa2d75b [shape=box label="formatters" color="black" fillcolor="white" style="filled" URL="dir_c5f232a4203c130ceb9aba0edfa2d75b.html"];
dir_313caf1132e152dd9b58bea13a4052ca [shape=box label="utils" color="black" fillcolor="white" style="filled" URL="dir_313caf1132e152dd9b58bea13a4052ca.html"];
}
}

View File

@ -0,0 +1 @@
ea5a906a4ee15e1c0423c26f91d7d95b

View File

@ -0,0 +1,106 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: src/cache/ Directory Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_6dd2d287d08a289e9849dd6e2f6b9333.html">cache</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">cache Directory Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Directory dependency graph for src/cache/:</div>
<div class="dyncontent">
<div class="center"><img src="dir_6dd2d287d08a289e9849dd6e2f6b9333_dep.png" border="0" usemap="#dir__6dd2d287d08a289e9849dd6e2f6b9333__dep" alt="src/cache/"/></div>
<map name="dir__6dd2d287d08a289e9849dd6e2f6b9333__dep" id="dir__6dd2d287d08a289e9849dd6e2f6b9333__dep">
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="files"></a>
Files</h2></td></tr>
<tr class="memitem:cache_8class_8php"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>cache.class.php</b></td></tr>
<tr class="memitem:fscache_8class_8php"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>fscache.class.php</b></td></tr>
<tr class="memitem:sqlcache_8class_8php"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>sqlcache.class.php</b></td></tr>
</table>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:51 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,9 @@
digraph "src/cache/" {
compound=true
node [ fontsize="10", fontname="FreeSans"];
edge [ labelfontsize="10", labelfontname="FreeSans"];
subgraph clusterdir_68267d1309a1af8e8297ef4c3efbcdba {
graph [ bgcolor="#ddddee", pencolor="black", label="src" fontname="FreeSans", fontsize="10", URL="dir_68267d1309a1af8e8297ef4c3efbcdba.html"]
dir_6dd2d287d08a289e9849dd6e2f6b9333 [shape=box, label="cache", style="filled", fillcolor="#eeeeff", pencolor="black", URL="dir_6dd2d287d08a289e9849dd6e2f6b9333.html"];
}
}

View File

@ -0,0 +1 @@
5c39fc25b0e4de7db2c37ad7c33f890f

View File

@ -0,0 +1,109 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: src/core/ Directory Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_aebb8dcc11953d78e620bbef0b9e2183.html">core</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">core Directory Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Directory dependency graph for src/core/:</div>
<div class="dyncontent">
<div class="center"><img src="dir_aebb8dcc11953d78e620bbef0b9e2183_dep.png" border="0" usemap="#dir__aebb8dcc11953d78e620bbef0b9e2183__dep" alt="src/core/"/></div>
<map name="dir__aebb8dcc11953d78e620bbef0b9e2183__dep" id="dir__aebb8dcc11953d78e620bbef0b9e2183__dep">
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="files"></a>
Files</h2></td></tr>
<tr class="memitem:filters_8class_8php"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>filters.class.php</b></td></tr>
<tr class="memitem:scanner_8class_8php"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="scanner_8class_8php.html">scanner.class.php</a></td></tr>
<tr class="memdesc:scanner_8class_8php"><td class="mdescLeft">&#160;</td><td class="mdescRight">The base scanner classes. <br/></td></tr>
<tr class="memitem:strsearch_8class_8php"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>strsearch.class.php</b></td></tr>
<tr class="memitem:tokenpresets_8class_8php"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>tokenpresets.class.php</b></td></tr>
<tr class="memitem:utils_8class_8php"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>utils.class.php</b></td></tr>
</table>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:51 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,9 @@
digraph "src/core/" {
compound=true
node [ fontsize="10", fontname="FreeSans"];
edge [ labelfontsize="10", labelfontname="FreeSans"];
subgraph clusterdir_68267d1309a1af8e8297ef4c3efbcdba {
graph [ bgcolor="#ddddee", pencolor="black", label="src" fontname="FreeSans", fontsize="10", URL="dir_68267d1309a1af8e8297ef4c3efbcdba.html"]
dir_aebb8dcc11953d78e620bbef0b9e2183 [shape=box, label="core", style="filled", fillcolor="#eeeeff", pencolor="black", URL="dir_aebb8dcc11953d78e620bbef0b9e2183.html"];
}
}

View File

@ -0,0 +1 @@
b0288eb09403aa3a868d724b461f23ff

View File

@ -0,0 +1,107 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: src/formatters/ Directory Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_c5f232a4203c130ceb9aba0edfa2d75b.html">formatters</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">formatters Directory Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Directory dependency graph for src/formatters/:</div>
<div class="dyncontent">
<div class="center"><img src="dir_c5f232a4203c130ceb9aba0edfa2d75b_dep.png" border="0" usemap="#dir__c5f232a4203c130ceb9aba0edfa2d75b__dep" alt="src/formatters/"/></div>
<map name="dir__c5f232a4203c130ceb9aba0edfa2d75b__dep" id="dir__c5f232a4203c130ceb9aba0edfa2d75b__dep">
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="files"></a>
Files</h2></td></tr>
<tr class="memitem:formatter_8class_8php"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>formatter.class.php</b></td></tr>
<tr class="memitem:htmlformatter_8class_8php"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>htmlformatter.class.php</b></td></tr>
<tr class="memitem:identityformatter_8class_8php"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>identityformatter.class.php</b></td></tr>
<tr class="memitem:latexformatter_8class_8php"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>latexformatter.class.php</b></td></tr>
</table>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:51 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,9 @@
digraph "src/formatters/" {
compound=true
node [ fontsize="10", fontname="FreeSans"];
edge [ labelfontsize="10", labelfontname="FreeSans"];
subgraph clusterdir_68267d1309a1af8e8297ef4c3efbcdba {
graph [ bgcolor="#ddddee", pencolor="black", label="src" fontname="FreeSans", fontsize="10", URL="dir_68267d1309a1af8e8297ef4c3efbcdba.html"]
dir_c5f232a4203c130ceb9aba0edfa2d75b [shape=box, label="formatters", style="filled", fillcolor="#eeeeff", pencolor="black", URL="dir_c5f232a4203c130ceb9aba0edfa2d75b.html"];
}
}

View File

@ -0,0 +1 @@
7d43d727dcf6dd9c51a92964a0931388

1163
3rdparty/luminous/docs/html/doxygen.css vendored Executable file

File diff suppressed because it is too large Load Diff

BIN
3rdparty/luminous/docs/html/doxygen.png vendored Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

78
3rdparty/luminous/docs/html/dynsections.js vendored Executable file
View File

@ -0,0 +1,78 @@
function toggleVisibility(linkObj)
{
var base = $(linkObj).attr('id');
var summary = $('#'+base+'-summary');
var content = $('#'+base+'-content');
var trigger = $('#'+base+'-trigger');
var src=$(trigger).attr('src');
if (content.is(':visible')===true) {
content.hide();
summary.show();
$(linkObj).addClass('closed').removeClass('opened');
$(trigger).attr('src',src.substring(0,src.length-8)+'closed.png');
} else {
content.show();
summary.hide();
$(linkObj).removeClass('closed').addClass('opened');
$(trigger).attr('src',src.substring(0,src.length-10)+'open.png');
}
return false;
}
function updateStripes()
{
$('table.directory tr').
removeClass('even').filter(':visible:even').addClass('even');
}
function toggleLevel(level)
{
$('table.directory tr').each(function(){
var l = this.id.split('_').length-1;
var i = $('#img'+this.id.substring(3));
var a = $('#arr'+this.id.substring(3));
if (l<level+1) {
i.attr('src','ftv2folderopen.png');
a.attr('src','ftv2mnode.png');
$(this).show();
} else if (l==level+1) {
i.attr('src','ftv2folderclosed.png');
a.attr('src','ftv2pnode.png');
$(this).show();
} else {
$(this).hide();
}
});
updateStripes();
}
function toggleFolder(id)
{
var n = $('[id^=row_'+id+']');
var i = $('[id^=img_'+id+']');
var a = $('[id^=arr_'+id+']');
var c = n.slice(1);
if (c.filter(':first').is(':visible')===true) {
i.attr('src','ftv2folderclosed.png');
a.attr('src','ftv2pnode.png');
c.hide();
} else {
i.attr('src','ftv2folderopen.png');
a.attr('src','ftv2mnode.png');
c.show();
}
updateStripes();
}
function toggleInherit(id)
{
var rows = $('tr.inherit.'+id);
var img = $('tr.inherit_header.'+id+' img');
var src = $(img).attr('src');
if (rows.filter(':first').is(':visible')===true) {
rows.css('display','none');
$(img).attr('src',src.substring(0,src.length-8)+'closed.png');
} else {
rows.css('display','table-row'); // using show() causes jump in firefox
$(img).attr('src',src.substring(0,src.length-10)+'open.png');
}
}

100
3rdparty/luminous/docs/html/files.html vendored Executable file
View File

@ -0,0 +1,100 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: File List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li class="current"><a href="files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">File List</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock">Here is a list of all documented files with brief descriptions:</div><div class="directory">
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><img id="arr_0_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('0_')"/><img id="img_0_" src="ftv2folderopen.png" alt="-" width="24" height="22" onclick="toggleFolder('0_')"/><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html" target="_self">src</a></td><td class="desc"></td></tr>
<tr id="row_0_0_"><td class="entry"><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img id="arr_0_0_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('0_0_')"/><img id="img_0_0_" src="ftv2folderopen.png" alt="-" width="24" height="22" onclick="toggleFolder('0_0_')"/><a class="el" href="dir_aebb8dcc11953d78e620bbef0b9e2183.html" target="_self">core</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_" class="even"><td class="entry"><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><img src="ftv2doc.png" alt="*" width="24" height="22" /><a class="el" href="scanner_8class_8php.html" target="_self">scanner.class.php</a></td><td class="desc">The base scanner classes</td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:51 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

BIN
3rdparty/luminous/docs/html/ftv2blank.png vendored Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 B

BIN
3rdparty/luminous/docs/html/ftv2cl.png vendored Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 453 B

BIN
3rdparty/luminous/docs/html/ftv2doc.png vendored Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 746 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 616 B

BIN
3rdparty/luminous/docs/html/ftv2folderopen.png vendored Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 597 B

BIN
3rdparty/luminous/docs/html/ftv2lastnode.png vendored Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 B

BIN
3rdparty/luminous/docs/html/ftv2link.png vendored Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 746 B

BIN
3rdparty/luminous/docs/html/ftv2mlastnode.png vendored Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 246 B

BIN
3rdparty/luminous/docs/html/ftv2mnode.png vendored Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 246 B

BIN
3rdparty/luminous/docs/html/ftv2mo.png vendored Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 403 B

BIN
3rdparty/luminous/docs/html/ftv2node.png vendored Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 B

BIN
3rdparty/luminous/docs/html/ftv2ns.png vendored Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 388 B

BIN
3rdparty/luminous/docs/html/ftv2plastnode.png vendored Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 229 B

BIN
3rdparty/luminous/docs/html/ftv2pnode.png vendored Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 229 B

BIN
3rdparty/luminous/docs/html/ftv2splitbar.png vendored Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 314 B

BIN
3rdparty/luminous/docs/html/ftv2vertline.png vendored Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 B

684
3rdparty/luminous/docs/html/functions.html vendored Executable file
View File

@ -0,0 +1,684 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: Class Members</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li class="current"><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<div id="navrow3" class="tabs2">
<ul class="tablist">
<li class="current"><a href="functions.html"><span>All</span></a></li>
<li><a href="functions_func.html"><span>Functions</span></a></li>
<li><a href="functions_vars.html"><span>Variables</span></a></li>
</ul>
</div>
<div id="navrow4" class="tabs3">
<ul class="tablist">
<li><a href="#index_0x24"><span>$</span></a></li>
<li><a href="#index__"><span>_</span></a></li>
<li><a href="#index_a"><span>a</span></a></li>
<li><a href="#index_b"><span>b</span></a></li>
<li><a href="#index_c"><span>c</span></a></li>
<li><a href="#index_d"><span>d</span></a></li>
<li><a href="#index_e"><span>e</span></a></li>
<li><a href="#index_f"><span>f</span></a></li>
<li><a href="#index_g"><span>g</span></a></li>
<li><a href="#index_h"><span>h</span></a></li>
<li><a href="#index_i"><span>i</span></a></li>
<li><a href="#index_l"><span>l</span></a></li>
<li><a href="#index_m"><span>m</span></a></li>
<li><a href="#index_n"><span>n</span></a></li>
<li><a href="#index_o"><span>o</span></a></li>
<li><a href="#index_p"><span>p</span></a></li>
<li><a href="#index_r"><span>r</span></a></li>
<li><a href="#index_s"><span>s</span></a></li>
<li><a href="#index_t"><span>t</span></a></li>
<li><a href="#index_u"><span>u</span></a></li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="contents">
<div class="textblock">Here is a list of all documented class members with links to the class documentation for each member:</div>
<h3><a class="anchor" id="index_0x24"></a>- $ -</h3><ul>
<li>$auto_link
: <a class="el" href="classLuminousOptions.html#a1408903d6d4fb2251935576f07ad984c">LuminousOptions</a>
</li>
<li>$C_COMMENT_ML
: <a class="el" href="classLuminousTokenPresets.html#a2a1bb95d9131701b61a28b085f4d3653">LuminousTokenPresets</a>
</li>
<li>$C_COMMENT_SL
: <a class="el" href="classLuminousTokenPresets.html#aeb1c122a80cc1b3d00eb6eb112da4b1f">LuminousTokenPresets</a>
</li>
<li>$cache
: <a class="el" href="classLuminousStringSearch.html#a409d9de167e4668acbe3da71f2bfa277">LuminousStringSearch</a>
, <a class="el" href="classLuminousOptions.html#acbbe98bf278f669a047aa3fafc63f00e">LuminousOptions</a>
</li>
<li>$cache_age
: <a class="el" href="classLuminousOptions.html#a40a7a05710c6e07ffc2670dff2dc4f99">LuminousOptions</a>
</li>
<li>$case_sensitive
: <a class="el" href="classLuminousScanner.html#af3887911498a250b2cb1fe737dd87df1">LuminousScanner</a>
</li>
<li>$CHAR
: <a class="el" href="classLuminousTokenPresets.html#a74183f045ac39cf2b30e1bdc98c3a34c">LuminousTokenPresets</a>
</li>
<li>$child_scanners
: <a class="el" href="classLuminousEmbeddedWebScript.html#aba37db3108b9a5ec0fda7f18a66fb317">LuminousEmbeddedWebScript</a>
</li>
<li>$clean_exit
: <a class="el" href="classLuminousEmbeddedWebScript.html#a278925946650e3c9e2094283512697d1">LuminousEmbeddedWebScript</a>
</li>
<li>$dirty_exit_recovery
: <a class="el" href="classLuminousEmbeddedWebScript.html#ace2c028e88c2c295c9f92214eff51f2b">LuminousEmbeddedWebScript</a>
</li>
<li>$DOUBLE_STR
: <a class="el" href="classLuminousTokenPresets.html#ae5053efc9d68d6c83988d0c29dd0bf60">LuminousTokenPresets</a>
</li>
<li>$DOUBLE_STR_SL
: <a class="el" href="classLuminousTokenPresets.html#a622c25d34fdb4f6fd66c774a0e8e2a91">LuminousTokenPresets</a>
</li>
<li>$embedded_html
: <a class="el" href="classLuminousEmbeddedWebScript.html#a9627fb0cc01060902259ee3c9212fad2">LuminousEmbeddedWebScript</a>
</li>
<li>$embedded_server
: <a class="el" href="classLuminousEmbeddedWebScript.html#a5fdc96de06443379f9dd48de9b80040b">LuminousEmbeddedWebScript</a>
</li>
<li>$exit_state
: <a class="el" href="classLuminousEmbeddedWebScript.html#a463a354548b9e9bf913ca47faf03808a">LuminousEmbeddedWebScript</a>
</li>
<li>$failure_tag
: <a class="el" href="classLuminousOptions.html#a4dd6a94185818e0ce25382ac380dede8">LuminousOptions</a>
</li>
<li>$filters
: <a class="el" href="classLuminousScanner.html#aca257c4da52076f42c6e53d9d0d33dd1">LuminousScanner</a>
</li>
<li>$format
: <a class="el" href="classLuminousOptions.html#a9ca11e80317fb5a8d2d4cc45a775f0f1">LuminousOptions</a>
</li>
<li>$highlight_lines
: <a class="el" href="classLuminousOptions.html#a90ef29c5d273d023c501a1cd1f50f4de">LuminousOptions</a>
</li>
<li>$html_strict
: <a class="el" href="classLuminousOptions.html#abf723d25b5f09ae6354998967477f6ac">LuminousOptions</a>
</li>
<li>$ident_map
: <a class="el" href="classLuminousScanner.html#adb13455bbeb076cd0f031f050ef31a82">LuminousScanner</a>
</li>
<li>$include_javascript
: <a class="el" href="classLuminousOptions.html#a45fe559dc1ab53dd722c466652848b0c">LuminousOptions</a>
</li>
<li>$include_jquery
: <a class="el" href="classLuminousOptions.html#ad2127af1b05b4c02a02a03509cd42ba9">LuminousOptions</a>
</li>
<li>$index
: <a class="el" href="classScanner.html#a1df8db865da4a56e83848e66c2fdd86c">Scanner</a>
</li>
<li>$interrupt
: <a class="el" href="classLuminousEmbeddedWebScript.html#aa33f76adc9164f8160785e8f70ff2420">LuminousEmbeddedWebScript</a>
</li>
<li>$last_state
: <a class="el" href="classLuminousStatefulScanner.html#ac48a7493e46607197259fabaa18196ad">LuminousStatefulScanner</a>
</li>
<li>$legal_transitions
: <a class="el" href="classLuminousStatefulScanner.html#a33e625b6e207b9fa8d02306938480519">LuminousStatefulScanner</a>
</li>
<li>$line_numbers
: <a class="el" href="classLuminousOptions.html#a053180f6c41b62a4e0742a000655aea9">LuminousOptions</a>
</li>
<li>$match_history
: <a class="el" href="classScanner.html#a7ffc9d830a0a2a0468f23e6150f662ab">Scanner</a>
</li>
<li>$max_height
: <a class="el" href="classLuminousOptions.html#a30027aaad70cc92226e871c4c6c4824a">LuminousOptions</a>
</li>
<li>$NUM_HEX
: <a class="el" href="classLuminousTokenPresets.html#a7230e06c64a6f4ce165e12f5bd39ec6a">LuminousTokenPresets</a>
</li>
<li>$NUM_REAL
: <a class="el" href="classLuminousTokenPresets.html#a92cf3ef1206f3045feec2d651266dd76">LuminousTokenPresets</a>
</li>
<li>$overrides
: <a class="el" href="classLuminousSimpleScanner.html#a6fe26909e26aeb6659a95bfbb8bb05d0">LuminousSimpleScanner</a>
</li>
<li>$patterns
: <a class="el" href="classScanner.html#ae07cbb19db97a18f93090e761243d890">Scanner</a>
, <a class="el" href="classLuminousStatefulScanner.html#acbb00a72f935a8c45261383760542b1d">LuminousStatefulScanner</a>
</li>
<li>$PERL_COMMENT
: <a class="el" href="classLuminousTokenPresets.html#aed7c53313969df00c41b6dc62862f12d">LuminousTokenPresets</a>
</li>
<li>$relative_root
: <a class="el" href="classLuminousOptions.html#a7cb3de376e2f841d98ba0e20c177a3aa">LuminousOptions</a>
</li>
<li>$rule_tag_map
: <a class="el" href="classLuminousScanner.html#a30aaa5d3076a9f28d00f167a1c4eac34">LuminousScanner</a>
</li>
<li>$script_tags
: <a class="el" href="classLuminousEmbeddedWebScript.html#a298f32256c797af02dbb7dbf3b2d2040">LuminousEmbeddedWebScript</a>
</li>
<li>$server_tags
: <a class="el" href="classLuminousEmbeddedWebScript.html#a11065fbf564b463206673a07a0498457">LuminousEmbeddedWebScript</a>
</li>
<li>$setup
: <a class="el" href="classLuminousStatefulScanner.html#a98a1d160d07f04e2ba8388e6b73db524">LuminousStatefulScanner</a>
</li>
<li>$SINGLE_STR
: <a class="el" href="classLuminousTokenPresets.html#a2af434cd51ac824e7c386bf6856bdb52">LuminousTokenPresets</a>
</li>
<li>$SINGLE_STR_SL
: <a class="el" href="classLuminousTokenPresets.html#ad012cf604ed4da5e3ef57338527fd5df">LuminousTokenPresets</a>
</li>
<li>$sql_function
: <a class="el" href="classLuminousOptions.html#acf2a3ca0e41e847db7fc4e30e7c4608f">LuminousOptions</a>
</li>
<li>$SQL_SINGLE_STR
: <a class="el" href="classLuminousTokenPresets.html#a20e568ce1f9f82efa80f781033cb7e9c">LuminousTokenPresets</a>
</li>
<li>$SQL_SINGLE_STR_BSLASH
: <a class="el" href="classLuminousTokenPresets.html#a7757feb38c55d3fffe8afe16957af183">LuminousTokenPresets</a>
</li>
<li>$src
: <a class="el" href="classScanner.html#a289bba9fedd00d7e2219d30f547ac392">Scanner</a>
</li>
<li>$src_len
: <a class="el" href="classScanner.html#a3d1a7f67acfa79b0ea574418e4a478a7">Scanner</a>
</li>
<li>$ss
: <a class="el" href="classScanner.html#a26970234bb2dde880548b084a0ade5e2">Scanner</a>
</li>
<li>$start_line
: <a class="el" href="classLuminousOptions.html#a49151dba0f00d1357fba1b1c68096eb5">LuminousOptions</a>
</li>
<li>$state_
: <a class="el" href="classLuminousScanner.html#ab5a30262ceb4324fdfaac1a7d217ba36">LuminousScanner</a>
</li>
<li>$stream_filters
: <a class="el" href="classLuminousScanner.html#ad3d9ad7f7f14bc9de3dd6b68225ce21c">LuminousScanner</a>
</li>
<li>$string
: <a class="el" href="classLuminousStringSearch.html#a2ed7bad26a3e255195bb00c12a50e49c">LuminousStringSearch</a>
</li>
<li>$theme
: <a class="el" href="classLuminousOptions.html#a4fc507972ad86defd3bcd0c4f721e44b">LuminousOptions</a>
</li>
<li>$token_tree_stack
: <a class="el" href="classLuminousStatefulScanner.html#aceb7c9c79698251183e07afb1ddf4228">LuminousStatefulScanner</a>
</li>
<li>$tokens
: <a class="el" href="classLuminousScanner.html#ab29032700812b580e5d09b6128202286">LuminousScanner</a>
</li>
<li>$transition_rule_cache
: <a class="el" href="classLuminousStatefulScanner.html#a58cb6b0100f05e310f90a8bf79608a3b">LuminousStatefulScanner</a>
</li>
<li>$transitions
: <a class="el" href="classLuminousStatefulScanner.html#a74653deca3c7705eb06a250e7283060a">LuminousStatefulScanner</a>
</li>
<li>$user_defs
: <a class="el" href="classLuminousScanner.html#a615d93f42d9290b9fad4d84cc2fd84ec">LuminousScanner</a>
</li>
<li>$version
: <a class="el" href="classLuminousScanner.html#a22a1e366c9fbe4e837de693258c5c739">LuminousScanner</a>
</li>
<li>$wrap_width
: <a class="el" href="classLuminousOptions.html#a2d5811ef7a32a459d55de9e211c324c9">LuminousOptions</a>
</li>
</ul>
<h3><a class="anchor" id="index__"></a>- _ -</h3><ul>
<li>__check()
: <a class="el" href="classScanner.html#ad1d5baf8c44c848eb7625ccf71d2e98b">Scanner</a>
</li>
<li>__construct()
: <a class="el" href="classScanner.html#a36dc435076406066ee020bea8b3f46b2">Scanner</a>
, <a class="el" href="classLuminousScanner.html#a493a069a6ba279b279865111b8e8ffd4">LuminousScanner</a>
</li>
<li>__consume()
: <a class="el" href="classScanner.html#ad2854d57ce631547fca7d250a67dfb5d">Scanner</a>
</li>
<li>__guess_language_cmp()
: <a class="el" href="classluminous.html#a2091154c8802bc577130f6bf4b9fe7c5">luminous</a>
</li>
<li>__log_match()
: <a class="el" href="classScanner.html#a3b0b80f32a1dfd96c8cd9b7fe7f3f759">Scanner</a>
</li>
</ul>
<h3><a class="anchor" id="index_a"></a>- a -</h3><ul>
<li>add_child_scanner()
: <a class="el" href="classLuminousEmbeddedWebScript.html#a6d78a3253fb12358ce13ca7650c6629b">LuminousEmbeddedWebScript</a>
</li>
<li>add_filter()
: <a class="el" href="classLuminousScanner.html#a17a50bdadaa49f0638638d5c6da7090c">LuminousScanner</a>
</li>
<li>add_identifier_mapping()
: <a class="el" href="classLuminousScanner.html#a047ae1afbf5563184e3dc67ecfb90a8c">LuminousScanner</a>
</li>
<li>add_pattern()
: <a class="el" href="classLuminousStatefulScanner.html#a459218c633ecc5a0fb3d08e52e0a9c28">LuminousStatefulScanner</a>
, <a class="el" href="classScanner.html#a4cb6935d759ee0c75fa01b75e2d0ec04">Scanner</a>
</li>
<li>add_stream_filter()
: <a class="el" href="classLuminousScanner.html#a32eb459cd8ad20b8ea3403907d7f2e52">LuminousScanner</a>
</li>
<li>add_transition()
: <a class="el" href="classLuminousStatefulScanner.html#a6bbd65f0e100d22077501c800af7926a">LuminousStatefulScanner</a>
</li>
</ul>
<h3><a class="anchor" id="index_b"></a>- b -</h3><ul>
<li>balance_delimiter()
: <a class="el" href="classLuminousUtils.html#a2ac54e45d680481dcce190154d8ff0d9">LuminousUtils</a>
</li>
<li>bol()
: <a class="el" href="classScanner.html#a77abc2d2de424e73d1ee659fd9001e4a">Scanner</a>
</li>
</ul>
<h3><a class="anchor" id="index_c"></a>- c -</h3><ul>
<li>cache_errors()
: <a class="el" href="classluminous.html#ac10179e43dc878063150584091c1dcb4">luminous</a>
</li>
<li>check()
: <a class="el" href="classScanner.html#ae483fc35eae064c75f8b5ca105826757">Scanner</a>
</li>
<li>clean_ident()
: <a class="el" href="classLuminousFilters.html#a623942677616891fd8d941061401c623">LuminousFilters</a>
</li>
<li>collapse_token_tree()
: <a class="el" href="classLuminousStatefulScanner.html#aa33c01d00bf3a5f15fb0945deb742cec">LuminousStatefulScanner</a>
</li>
<li>comment_note()
: <a class="el" href="classLuminousFilters.html#a83a7be7573ac5b70247e1f07546f70fa">LuminousFilters</a>
</li>
</ul>
<h3><a class="anchor" id="index_d"></a>- d -</h3><ul>
<li>dirty_exit()
: <a class="el" href="classLuminousEmbeddedWebScript.html#a77deb48d41b8a791900a3d5c50813faf">LuminousEmbeddedWebScript</a>
</li>
<li>doxygen_arg_length()
: <a class="el" href="classLuminousFilters.html#a84e0e2847f7d6b7001894a80c8305ab9">LuminousFilters</a>
</li>
<li>doxygenize()
: <a class="el" href="classLuminousFilters.html#a164114c951d4149d2c0abbbbaa803cf8">LuminousFilters</a>
</li>
<li>doxygenize_cb()
: <a class="el" href="classLuminousFilters.html#af3797a9501d392f65449b638d47230b6">LuminousFilters</a>
</li>
</ul>
<h3><a class="anchor" id="index_e"></a>- e -</h3><ul>
<li>eol()
: <a class="el" href="classScanner.html#a8ad6032d3a1f955608905c10a864aee6">Scanner</a>
</li>
<li>eos()
: <a class="el" href="classScanner.html#a23543739aee09e2e1961a556a9672c7d">Scanner</a>
</li>
<li>escape_string()
: <a class="el" href="classLuminousUtils.html#a25ba2a727a415d71c3d57fd03bdf95ea">LuminousUtils</a>
</li>
<li>escape_token()
: <a class="el" href="classLuminousUtils.html#a5f41f0e028071fb66f201a13d244cc8a">LuminousUtils</a>
</li>
</ul>
<h3><a class="anchor" id="index_f"></a>- f -</h3><ul>
<li>formatter()
: <a class="el" href="classluminous.html#a5495a0831fcb35ccb4e46d54748916e1">luminous</a>
</li>
</ul>
<h3><a class="anchor" id="index_g"></a>- g -</h3><ul>
<li>generic_doc_comment()
: <a class="el" href="classLuminousFilters.html#a58ce94f1a8180ac0ecab1378d1d969d2">LuminousFilters</a>
</li>
<li>get()
: <a class="el" href="classScanner.html#a154d424c925ed0d58e033f1e71ceef03">Scanner</a>
</li>
<li>get_next()
: <a class="el" href="classScanner.html#ac8beec743c18d54cec51273b3bb7f3b5">Scanner</a>
</li>
<li>get_next_named()
: <a class="el" href="classScanner.html#a21f59cd38d7ed3ccd43955386b6aa14e">Scanner</a>
</li>
<li>get_next_strpos()
: <a class="el" href="classScanner.html#a57774c7a298bb43c1c4406a830d386a6">Scanner</a>
</li>
<li>guess_language()
: <a class="el" href="classLuminousScanner.html#a094a64c9eb09e38ab43c865e1a4482c9">LuminousScanner</a>
, <a class="el" href="classluminous.html#ae6d5094890e6590efe54c33fb9ed23f6">luminous</a>
</li>
<li>guess_language_full()
: <a class="el" href="classluminous.html#a44f8e7eb81316db20d4e6969b7fe8ef5">luminous</a>
</li>
</ul>
<h3><a class="anchor" id="index_h"></a>- h -</h3><ul>
<li>head_html()
: <a class="el" href="classluminous.html#aec66d6c5d22ff1254f8c5ff73fb0f71d">luminous</a>
</li>
<li>highlight()
: <a class="el" href="classLuminousScanner.html#a0a7907663241caffb546ef22bb35d870">LuminousScanner</a>
, <a class="el" href="classluminous.html#a51d6db398127b5b7a1bbb27af6a0790e">luminous</a>
</li>
<li>highlight_file()
: <a class="el" href="classluminous.html#abe612a3df76685834bcd8afaffee544b">luminous</a>
</li>
</ul>
<h3><a class="anchor" id="index_i"></a>- i -</h3><ul>
<li>index()
: <a class="el" href="classScanner.html#a90bacd70c30eb1d76659c0586f0683d2">Scanner</a>
</li>
<li>init()
: <a class="el" href="classLuminousScanner.html#af0aecba631e56a3005157cfbe84d6b67">LuminousScanner</a>
</li>
</ul>
<h3><a class="anchor" id="index_l"></a>- l -</h3><ul>
<li>load_transitions()
: <a class="el" href="classLuminousStatefulScanner.html#a0babe803eeec59e0a77f03c658a5e6b3">LuminousStatefulScanner</a>
</li>
</ul>
<h3><a class="anchor" id="index_m"></a>- m -</h3><ul>
<li>main()
: <a class="el" href="classLuminousScanner.html#a12220a789d49b7e8f42cf873966b6756">LuminousScanner</a>
, <a class="el" href="classLuminousSimpleScanner.html#a0962d46ec52780dd2f91a84e073ce654">LuminousSimpleScanner</a>
, <a class="el" href="classLuminousStatefulScanner.html#a7da6f0be6bafd50f0a785b6ba8e951aa">LuminousStatefulScanner</a>
</li>
<li>map_identifier_filter()
: <a class="el" href="classLuminousScanner.html#a6efd3dada50a424d7f30b7f9afac5fc0">LuminousScanner</a>
</li>
<li>match()
: <a class="el" href="classScanner.html#a17ac6e2abcb54a6dfaa9abaf95ed839e">Scanner</a>
, <a class="el" href="classLuminousStringSearch.html#ae6b1a2b900b6d8593cfd93272bc72ef2">LuminousStringSearch</a>
</li>
<li>match_group()
: <a class="el" href="classScanner.html#aa933ee80eb310785c75ab7b03ed01885">Scanner</a>
</li>
<li>match_groups()
: <a class="el" href="classScanner.html#a9271f0acf8d19f83fa45ee3ee1d3eab5">Scanner</a>
</li>
<li>match_pos()
: <a class="el" href="classScanner.html#aa5520e0fc7df54d7a25d75037e6cdc8a">Scanner</a>
</li>
</ul>
<h3><a class="anchor" id="index_n"></a>- n -</h3><ul>
<li>nestable_token()
: <a class="el" href="classLuminousScanner.html#ae974cbfb732f008a79482ffc4f11d398">LuminousScanner</a>
</li>
<li>next_end_data()
: <a class="el" href="classLuminousStatefulScanner.html#a132f05a948d43ec4cb103490cce2cedf">LuminousStatefulScanner</a>
</li>
<li>next_match()
: <a class="el" href="classScanner.html#a5e03667fd1cdc1d1fd40a4bc15570b12">Scanner</a>
</li>
<li>next_start_data()
: <a class="el" href="classLuminousStatefulScanner.html#a33a49c8b634b1f9d6048a341b82efab3">LuminousStatefulScanner</a>
</li>
</ul>
<h3><a class="anchor" id="index_o"></a>- o -</h3><ul>
<li>oo_stream_filter()
: <a class="el" href="classLuminousFilters.html#a7b50fe8611c983dad41808f9da83386c">LuminousFilters</a>
</li>
</ul>
<h3><a class="anchor" id="index_p"></a>- p -</h3><ul>
<li>pcre()
: <a class="el" href="classLuminousFilters.html#a474345e7d70bcebb971cecada698499f">LuminousFilters</a>
</li>
<li>pcre_error_decode()
: <a class="el" href="classLuminousUtils.html#ab2cb0b63cfbf8767c8e5a2837ae8d4c7">LuminousUtils</a>
</li>
<li>peek()
: <a class="el" href="classScanner.html#a3028e787442cf1ed9252397ed029b223">Scanner</a>
</li>
<li>pop()
: <a class="el" href="classLuminousScanner.html#a614e490335cf64375c52d57edfb398ad">LuminousScanner</a>
</li>
<li>pop_state()
: <a class="el" href="classLuminousStatefulScanner.html#ae4de8e437cdeb7cda6cb39b53427bd65">LuminousStatefulScanner</a>
</li>
<li>pos()
: <a class="el" href="classScanner.html#a546cafdcfc3adeb19959ae14dff10996">Scanner</a>
</li>
<li>pos_shift()
: <a class="el" href="classScanner.html#a947d15fe4bd13b64afd5eaba8d4d3819">Scanner</a>
</li>
<li>push()
: <a class="el" href="classLuminousScanner.html#add1da033592e8f944660b9e29088a2ac">LuminousScanner</a>
</li>
<li>push_child()
: <a class="el" href="classLuminousStatefulScanner.html#abd592ef2dce9cd10e790792b45218f3c">LuminousStatefulScanner</a>
</li>
<li>push_state()
: <a class="el" href="classLuminousStatefulScanner.html#a4ce70df919d944c9e85fce4072a27ff2">LuminousStatefulScanner</a>
</li>
</ul>
<h3><a class="anchor" id="index_r"></a>- r -</h3><ul>
<li>record()
: <a class="el" href="classLuminousScanner.html#aa61dbaafd8801e40094cbff52f7b22f1">LuminousScanner</a>
, <a class="el" href="classLuminousStatefulScanner.html#a04c01a23de9f1d42e5b4921879326ee4">LuminousStatefulScanner</a>
</li>
<li>record_range()
: <a class="el" href="classLuminousStatefulScanner.html#a9f8177050d802bad05d961c15b6a8536">LuminousStatefulScanner</a>
, <a class="el" href="classLuminousScanner.html#a48fabeb9791b36ace2b46dd8f91a4afa">LuminousScanner</a>
</li>
<li>record_token()
: <a class="el" href="classLuminousStatefulScanner.html#a09266805f976b3fd9ee501bfebd69598">LuminousStatefulScanner</a>
</li>
<li>register_scanner()
: <a class="el" href="classluminous.html#a49d5450bc78c1bfc1bc5aeaff954c39f">luminous</a>
</li>
<li>remove_filter()
: <a class="el" href="classLuminousScanner.html#a80c4b9fff3a38e90e04cda38eb075040">LuminousScanner</a>
</li>
<li>remove_pattern()
: <a class="el" href="classScanner.html#a79c559549e2dd73c3f1892e7609e84a6">Scanner</a>
</li>
<li>remove_stream_filter()
: <a class="el" href="classLuminousScanner.html#a25c4c1f42c64a07ce87c19f3992a0fba">LuminousScanner</a>
</li>
<li>reset()
: <a class="el" href="classScanner.html#a89d1448f666d1be3d5037c69f24eb516">Scanner</a>
</li>
<li>rest()
: <a class="el" href="classScanner.html#aeae50ecaf6b98a0b76f47c3d04b8deb3">Scanner</a>
</li>
<li>resume()
: <a class="el" href="classLuminousEmbeddedWebScript.html#aa5f8bbf0166d4d6531d33ad3319f85e5">LuminousEmbeddedWebScript</a>
</li>
<li>root()
: <a class="el" href="classluminous.html#ae77609b01703562b0bfed047a7f48767">luminous</a>
</li>
<li>rule_mapper_filter()
: <a class="el" href="classLuminousScanner.html#a4cc936af136b39a54db6c7212c04cee7">LuminousScanner</a>
</li>
</ul>
<h3><a class="anchor" id="index_s"></a>- s -</h3><ul>
<li>scan()
: <a class="el" href="classScanner.html#a78ddb203c30c2f9e69755ec00c341add">Scanner</a>
</li>
<li>scan_until()
: <a class="el" href="classScanner.html#aa0e261d4b0c2fce43ba3c264036afd72">Scanner</a>
</li>
<li>scanners()
: <a class="el" href="classluminous.html#a1234abdb40eb18ceba4a5bcc12f9e89f">luminous</a>
</li>
<li>script_break()
: <a class="el" href="classLuminousEmbeddedWebScript.html#a08ce3d66e8ff9217903f68c2a2aa6120">LuminousEmbeddedWebScript</a>
</li>
<li>server_break()
: <a class="el" href="classLuminousEmbeddedWebScript.html#a9725d508c1411b029b43feeab9491af4">LuminousEmbeddedWebScript</a>
</li>
<li>set()
: <a class="el" href="classluminous.html#ace722a2ba2c2251eabccf6f0d18bcbe9">luminous</a>
</li>
<li>setting()
: <a class="el" href="classluminous.html#af5888c20eb26757b5bd9af198e44ec96">luminous</a>
</li>
<li>setup()
: <a class="el" href="classLuminousStatefulScanner.html#a52c545680b3fe2f57c701957a6b52a84">LuminousStatefulScanner</a>
</li>
<li>skip_whitespace()
: <a class="el" href="classLuminousScanner.html#ab06dcdea11ff9a78168547b4c84c650c">LuminousScanner</a>
</li>
<li>start()
: <a class="el" href="classLuminousScanner.html#a4156922baa33783377f7904fd2d4cee5">LuminousScanner</a>
</li>
<li>state()
: <a class="el" href="classLuminousScanner.html#a23e2cf34969c3d39cd34a4b5ce6810ca">LuminousScanner</a>
</li>
<li>state_name()
: <a class="el" href="classLuminousStatefulScanner.html#a11c34191804f4842d49ab86be27000a0">LuminousStatefulScanner</a>
</li>
<li>string()
: <a class="el" href="classScanner.html#a577a70297f4d3da0aa2ce4decc66eeea">Scanner</a>
, <a class="el" href="classLuminousEmbeddedWebScript.html#a468d0f77b948817731d32f866b360586">LuminousEmbeddedWebScript</a>
, <a class="el" href="classLuminousFilters.html#a3ff3ab9bf79e1e3ccc6f93e711e4396f">LuminousFilters</a>
</li>
</ul>
<h3><a class="anchor" id="index_t"></a>- t -</h3><ul>
<li>tag_block()
: <a class="el" href="classLuminousUtils.html#a50b5bcd2eb6e5c5c452899e42fe2fcc8">LuminousUtils</a>
</li>
<li>tagged()
: <a class="el" href="classLuminousScanner.html#a809c11561c650c7784edd3d06243b8b5">LuminousScanner</a>
, <a class="el" href="classLuminousStatefulScanner.html#a22ca39b6b85a796a5438840fbddc7c0a">LuminousStatefulScanner</a>
</li>
<li>terminate()
: <a class="el" href="classScanner.html#a185d6e780752848cb282add6d9f936bb">Scanner</a>
</li>
<li>theme()
: <a class="el" href="classluminous.html#a0bfdea509586ce343d2e6001ad33ccd0">luminous</a>
</li>
<li>theme_exists()
: <a class="el" href="classluminous.html#a069fa20b026732cc6366743f3688a822">luminous</a>
</li>
<li>themes()
: <a class="el" href="classluminous.html#a9bb8a124a3d5cff72a9756edabc7419a">luminous</a>
</li>
<li>token_array()
: <a class="el" href="classLuminousScanner.html#ae381e3000c83ae4cb2259d0ae77a14ab">LuminousScanner</a>
</li>
</ul>
<h3><a class="anchor" id="index_u"></a>- u -</h3><ul>
<li>unscan()
: <a class="el" href="classScanner.html#a6f6665b8df561788b1b2dea40bb394ae">Scanner</a>
</li>
<li>upper_to_constant()
: <a class="el" href="classLuminousFilters.html#a10fb6fd692505d6efeabc37754343288">LuminousFilters</a>
</li>
<li>user_def_filter()
: <a class="el" href="classLuminousScanner.html#a463b3eb270a7afb960ee642bccc0d1b6">LuminousScanner</a>
</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:51 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,497 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: Class Members - Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li class="current"><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<div id="navrow3" class="tabs2">
<ul class="tablist">
<li><a href="functions.html"><span>All</span></a></li>
<li class="current"><a href="functions_func.html"><span>Functions</span></a></li>
<li><a href="functions_vars.html"><span>Variables</span></a></li>
</ul>
</div>
<div id="navrow4" class="tabs3">
<ul class="tablist">
<li><a href="#index__"><span>_</span></a></li>
<li><a href="#index_a"><span>a</span></a></li>
<li><a href="#index_b"><span>b</span></a></li>
<li><a href="#index_c"><span>c</span></a></li>
<li><a href="#index_d"><span>d</span></a></li>
<li><a href="#index_e"><span>e</span></a></li>
<li><a href="#index_f"><span>f</span></a></li>
<li><a href="#index_g"><span>g</span></a></li>
<li><a href="#index_h"><span>h</span></a></li>
<li><a href="#index_i"><span>i</span></a></li>
<li><a href="#index_l"><span>l</span></a></li>
<li><a href="#index_m"><span>m</span></a></li>
<li><a href="#index_n"><span>n</span></a></li>
<li><a href="#index_o"><span>o</span></a></li>
<li><a href="#index_p"><span>p</span></a></li>
<li><a href="#index_r"><span>r</span></a></li>
<li><a href="#index_s"><span>s</span></a></li>
<li><a href="#index_t"><span>t</span></a></li>
<li><a href="#index_u"><span>u</span></a></li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="contents">
&#160;
<h3><a class="anchor" id="index__"></a>- _ -</h3><ul>
<li>__check()
: <a class="el" href="classScanner.html#ad1d5baf8c44c848eb7625ccf71d2e98b">Scanner</a>
</li>
<li>__construct()
: <a class="el" href="classScanner.html#a36dc435076406066ee020bea8b3f46b2">Scanner</a>
, <a class="el" href="classLuminousScanner.html#a493a069a6ba279b279865111b8e8ffd4">LuminousScanner</a>
</li>
<li>__consume()
: <a class="el" href="classScanner.html#ad2854d57ce631547fca7d250a67dfb5d">Scanner</a>
</li>
<li>__guess_language_cmp()
: <a class="el" href="classluminous.html#a2091154c8802bc577130f6bf4b9fe7c5">luminous</a>
</li>
<li>__log_match()
: <a class="el" href="classScanner.html#a3b0b80f32a1dfd96c8cd9b7fe7f3f759">Scanner</a>
</li>
</ul>
<h3><a class="anchor" id="index_a"></a>- a -</h3><ul>
<li>add_child_scanner()
: <a class="el" href="classLuminousEmbeddedWebScript.html#a6d78a3253fb12358ce13ca7650c6629b">LuminousEmbeddedWebScript</a>
</li>
<li>add_filter()
: <a class="el" href="classLuminousScanner.html#a17a50bdadaa49f0638638d5c6da7090c">LuminousScanner</a>
</li>
<li>add_identifier_mapping()
: <a class="el" href="classLuminousScanner.html#a047ae1afbf5563184e3dc67ecfb90a8c">LuminousScanner</a>
</li>
<li>add_pattern()
: <a class="el" href="classLuminousStatefulScanner.html#a459218c633ecc5a0fb3d08e52e0a9c28">LuminousStatefulScanner</a>
, <a class="el" href="classScanner.html#a4cb6935d759ee0c75fa01b75e2d0ec04">Scanner</a>
</li>
<li>add_stream_filter()
: <a class="el" href="classLuminousScanner.html#a32eb459cd8ad20b8ea3403907d7f2e52">LuminousScanner</a>
</li>
<li>add_transition()
: <a class="el" href="classLuminousStatefulScanner.html#a6bbd65f0e100d22077501c800af7926a">LuminousStatefulScanner</a>
</li>
</ul>
<h3><a class="anchor" id="index_b"></a>- b -</h3><ul>
<li>balance_delimiter()
: <a class="el" href="classLuminousUtils.html#a2ac54e45d680481dcce190154d8ff0d9">LuminousUtils</a>
</li>
<li>bol()
: <a class="el" href="classScanner.html#a77abc2d2de424e73d1ee659fd9001e4a">Scanner</a>
</li>
</ul>
<h3><a class="anchor" id="index_c"></a>- c -</h3><ul>
<li>cache_errors()
: <a class="el" href="classluminous.html#ac10179e43dc878063150584091c1dcb4">luminous</a>
</li>
<li>check()
: <a class="el" href="classScanner.html#ae483fc35eae064c75f8b5ca105826757">Scanner</a>
</li>
<li>clean_ident()
: <a class="el" href="classLuminousFilters.html#a623942677616891fd8d941061401c623">LuminousFilters</a>
</li>
<li>collapse_token_tree()
: <a class="el" href="classLuminousStatefulScanner.html#aa33c01d00bf3a5f15fb0945deb742cec">LuminousStatefulScanner</a>
</li>
<li>comment_note()
: <a class="el" href="classLuminousFilters.html#a83a7be7573ac5b70247e1f07546f70fa">LuminousFilters</a>
</li>
</ul>
<h3><a class="anchor" id="index_d"></a>- d -</h3><ul>
<li>dirty_exit()
: <a class="el" href="classLuminousEmbeddedWebScript.html#a77deb48d41b8a791900a3d5c50813faf">LuminousEmbeddedWebScript</a>
</li>
<li>doxygen_arg_length()
: <a class="el" href="classLuminousFilters.html#a84e0e2847f7d6b7001894a80c8305ab9">LuminousFilters</a>
</li>
<li>doxygenize()
: <a class="el" href="classLuminousFilters.html#a164114c951d4149d2c0abbbbaa803cf8">LuminousFilters</a>
</li>
<li>doxygenize_cb()
: <a class="el" href="classLuminousFilters.html#af3797a9501d392f65449b638d47230b6">LuminousFilters</a>
</li>
</ul>
<h3><a class="anchor" id="index_e"></a>- e -</h3><ul>
<li>eol()
: <a class="el" href="classScanner.html#a8ad6032d3a1f955608905c10a864aee6">Scanner</a>
</li>
<li>eos()
: <a class="el" href="classScanner.html#a23543739aee09e2e1961a556a9672c7d">Scanner</a>
</li>
<li>escape_string()
: <a class="el" href="classLuminousUtils.html#a25ba2a727a415d71c3d57fd03bdf95ea">LuminousUtils</a>
</li>
<li>escape_token()
: <a class="el" href="classLuminousUtils.html#a5f41f0e028071fb66f201a13d244cc8a">LuminousUtils</a>
</li>
</ul>
<h3><a class="anchor" id="index_f"></a>- f -</h3><ul>
<li>formatter()
: <a class="el" href="classluminous.html#a5495a0831fcb35ccb4e46d54748916e1">luminous</a>
</li>
</ul>
<h3><a class="anchor" id="index_g"></a>- g -</h3><ul>
<li>generic_doc_comment()
: <a class="el" href="classLuminousFilters.html#a58ce94f1a8180ac0ecab1378d1d969d2">LuminousFilters</a>
</li>
<li>get()
: <a class="el" href="classScanner.html#a154d424c925ed0d58e033f1e71ceef03">Scanner</a>
</li>
<li>get_next()
: <a class="el" href="classScanner.html#ac8beec743c18d54cec51273b3bb7f3b5">Scanner</a>
</li>
<li>get_next_named()
: <a class="el" href="classScanner.html#a21f59cd38d7ed3ccd43955386b6aa14e">Scanner</a>
</li>
<li>get_next_strpos()
: <a class="el" href="classScanner.html#a57774c7a298bb43c1c4406a830d386a6">Scanner</a>
</li>
<li>guess_language()
: <a class="el" href="classLuminousScanner.html#a094a64c9eb09e38ab43c865e1a4482c9">LuminousScanner</a>
, <a class="el" href="classluminous.html#ae6d5094890e6590efe54c33fb9ed23f6">luminous</a>
</li>
<li>guess_language_full()
: <a class="el" href="classluminous.html#a44f8e7eb81316db20d4e6969b7fe8ef5">luminous</a>
</li>
</ul>
<h3><a class="anchor" id="index_h"></a>- h -</h3><ul>
<li>head_html()
: <a class="el" href="classluminous.html#aec66d6c5d22ff1254f8c5ff73fb0f71d">luminous</a>
</li>
<li>highlight()
: <a class="el" href="classLuminousScanner.html#a0a7907663241caffb546ef22bb35d870">LuminousScanner</a>
, <a class="el" href="classluminous.html#a51d6db398127b5b7a1bbb27af6a0790e">luminous</a>
</li>
<li>highlight_file()
: <a class="el" href="classluminous.html#abe612a3df76685834bcd8afaffee544b">luminous</a>
</li>
</ul>
<h3><a class="anchor" id="index_i"></a>- i -</h3><ul>
<li>index()
: <a class="el" href="classScanner.html#a90bacd70c30eb1d76659c0586f0683d2">Scanner</a>
</li>
<li>init()
: <a class="el" href="classLuminousScanner.html#af0aecba631e56a3005157cfbe84d6b67">LuminousScanner</a>
</li>
</ul>
<h3><a class="anchor" id="index_l"></a>- l -</h3><ul>
<li>load_transitions()
: <a class="el" href="classLuminousStatefulScanner.html#a0babe803eeec59e0a77f03c658a5e6b3">LuminousStatefulScanner</a>
</li>
</ul>
<h3><a class="anchor" id="index_m"></a>- m -</h3><ul>
<li>main()
: <a class="el" href="classLuminousScanner.html#a12220a789d49b7e8f42cf873966b6756">LuminousScanner</a>
, <a class="el" href="classLuminousSimpleScanner.html#a0962d46ec52780dd2f91a84e073ce654">LuminousSimpleScanner</a>
, <a class="el" href="classLuminousStatefulScanner.html#a7da6f0be6bafd50f0a785b6ba8e951aa">LuminousStatefulScanner</a>
</li>
<li>map_identifier_filter()
: <a class="el" href="classLuminousScanner.html#a6efd3dada50a424d7f30b7f9afac5fc0">LuminousScanner</a>
</li>
<li>match()
: <a class="el" href="classScanner.html#a17ac6e2abcb54a6dfaa9abaf95ed839e">Scanner</a>
, <a class="el" href="classLuminousStringSearch.html#ae6b1a2b900b6d8593cfd93272bc72ef2">LuminousStringSearch</a>
</li>
<li>match_group()
: <a class="el" href="classScanner.html#aa933ee80eb310785c75ab7b03ed01885">Scanner</a>
</li>
<li>match_groups()
: <a class="el" href="classScanner.html#a9271f0acf8d19f83fa45ee3ee1d3eab5">Scanner</a>
</li>
<li>match_pos()
: <a class="el" href="classScanner.html#aa5520e0fc7df54d7a25d75037e6cdc8a">Scanner</a>
</li>
</ul>
<h3><a class="anchor" id="index_n"></a>- n -</h3><ul>
<li>nestable_token()
: <a class="el" href="classLuminousScanner.html#ae974cbfb732f008a79482ffc4f11d398">LuminousScanner</a>
</li>
<li>next_end_data()
: <a class="el" href="classLuminousStatefulScanner.html#a132f05a948d43ec4cb103490cce2cedf">LuminousStatefulScanner</a>
</li>
<li>next_match()
: <a class="el" href="classScanner.html#a5e03667fd1cdc1d1fd40a4bc15570b12">Scanner</a>
</li>
<li>next_start_data()
: <a class="el" href="classLuminousStatefulScanner.html#a33a49c8b634b1f9d6048a341b82efab3">LuminousStatefulScanner</a>
</li>
</ul>
<h3><a class="anchor" id="index_o"></a>- o -</h3><ul>
<li>oo_stream_filter()
: <a class="el" href="classLuminousFilters.html#a7b50fe8611c983dad41808f9da83386c">LuminousFilters</a>
</li>
</ul>
<h3><a class="anchor" id="index_p"></a>- p -</h3><ul>
<li>pcre()
: <a class="el" href="classLuminousFilters.html#a474345e7d70bcebb971cecada698499f">LuminousFilters</a>
</li>
<li>pcre_error_decode()
: <a class="el" href="classLuminousUtils.html#ab2cb0b63cfbf8767c8e5a2837ae8d4c7">LuminousUtils</a>
</li>
<li>peek()
: <a class="el" href="classScanner.html#a3028e787442cf1ed9252397ed029b223">Scanner</a>
</li>
<li>pop()
: <a class="el" href="classLuminousScanner.html#a614e490335cf64375c52d57edfb398ad">LuminousScanner</a>
</li>
<li>pop_state()
: <a class="el" href="classLuminousStatefulScanner.html#ae4de8e437cdeb7cda6cb39b53427bd65">LuminousStatefulScanner</a>
</li>
<li>pos()
: <a class="el" href="classScanner.html#a546cafdcfc3adeb19959ae14dff10996">Scanner</a>
</li>
<li>pos_shift()
: <a class="el" href="classScanner.html#a947d15fe4bd13b64afd5eaba8d4d3819">Scanner</a>
</li>
<li>push()
: <a class="el" href="classLuminousScanner.html#add1da033592e8f944660b9e29088a2ac">LuminousScanner</a>
</li>
<li>push_child()
: <a class="el" href="classLuminousStatefulScanner.html#abd592ef2dce9cd10e790792b45218f3c">LuminousStatefulScanner</a>
</li>
<li>push_state()
: <a class="el" href="classLuminousStatefulScanner.html#a4ce70df919d944c9e85fce4072a27ff2">LuminousStatefulScanner</a>
</li>
</ul>
<h3><a class="anchor" id="index_r"></a>- r -</h3><ul>
<li>record()
: <a class="el" href="classLuminousScanner.html#aa61dbaafd8801e40094cbff52f7b22f1">LuminousScanner</a>
, <a class="el" href="classLuminousStatefulScanner.html#a04c01a23de9f1d42e5b4921879326ee4">LuminousStatefulScanner</a>
</li>
<li>record_range()
: <a class="el" href="classLuminousStatefulScanner.html#a9f8177050d802bad05d961c15b6a8536">LuminousStatefulScanner</a>
, <a class="el" href="classLuminousScanner.html#a48fabeb9791b36ace2b46dd8f91a4afa">LuminousScanner</a>
</li>
<li>record_token()
: <a class="el" href="classLuminousStatefulScanner.html#a09266805f976b3fd9ee501bfebd69598">LuminousStatefulScanner</a>
</li>
<li>register_scanner()
: <a class="el" href="classluminous.html#a49d5450bc78c1bfc1bc5aeaff954c39f">luminous</a>
</li>
<li>remove_filter()
: <a class="el" href="classLuminousScanner.html#a80c4b9fff3a38e90e04cda38eb075040">LuminousScanner</a>
</li>
<li>remove_pattern()
: <a class="el" href="classScanner.html#a79c559549e2dd73c3f1892e7609e84a6">Scanner</a>
</li>
<li>remove_stream_filter()
: <a class="el" href="classLuminousScanner.html#a25c4c1f42c64a07ce87c19f3992a0fba">LuminousScanner</a>
</li>
<li>reset()
: <a class="el" href="classScanner.html#a89d1448f666d1be3d5037c69f24eb516">Scanner</a>
</li>
<li>rest()
: <a class="el" href="classScanner.html#aeae50ecaf6b98a0b76f47c3d04b8deb3">Scanner</a>
</li>
<li>resume()
: <a class="el" href="classLuminousEmbeddedWebScript.html#aa5f8bbf0166d4d6531d33ad3319f85e5">LuminousEmbeddedWebScript</a>
</li>
<li>root()
: <a class="el" href="classluminous.html#ae77609b01703562b0bfed047a7f48767">luminous</a>
</li>
<li>rule_mapper_filter()
: <a class="el" href="classLuminousScanner.html#a4cc936af136b39a54db6c7212c04cee7">LuminousScanner</a>
</li>
</ul>
<h3><a class="anchor" id="index_s"></a>- s -</h3><ul>
<li>scan()
: <a class="el" href="classScanner.html#a78ddb203c30c2f9e69755ec00c341add">Scanner</a>
</li>
<li>scan_until()
: <a class="el" href="classScanner.html#aa0e261d4b0c2fce43ba3c264036afd72">Scanner</a>
</li>
<li>scanners()
: <a class="el" href="classluminous.html#a1234abdb40eb18ceba4a5bcc12f9e89f">luminous</a>
</li>
<li>script_break()
: <a class="el" href="classLuminousEmbeddedWebScript.html#a08ce3d66e8ff9217903f68c2a2aa6120">LuminousEmbeddedWebScript</a>
</li>
<li>server_break()
: <a class="el" href="classLuminousEmbeddedWebScript.html#a9725d508c1411b029b43feeab9491af4">LuminousEmbeddedWebScript</a>
</li>
<li>set()
: <a class="el" href="classluminous.html#ace722a2ba2c2251eabccf6f0d18bcbe9">luminous</a>
</li>
<li>setting()
: <a class="el" href="classluminous.html#af5888c20eb26757b5bd9af198e44ec96">luminous</a>
</li>
<li>setup()
: <a class="el" href="classLuminousStatefulScanner.html#a52c545680b3fe2f57c701957a6b52a84">LuminousStatefulScanner</a>
</li>
<li>skip_whitespace()
: <a class="el" href="classLuminousScanner.html#ab06dcdea11ff9a78168547b4c84c650c">LuminousScanner</a>
</li>
<li>start()
: <a class="el" href="classLuminousScanner.html#a4156922baa33783377f7904fd2d4cee5">LuminousScanner</a>
</li>
<li>state()
: <a class="el" href="classLuminousScanner.html#a23e2cf34969c3d39cd34a4b5ce6810ca">LuminousScanner</a>
</li>
<li>state_name()
: <a class="el" href="classLuminousStatefulScanner.html#a11c34191804f4842d49ab86be27000a0">LuminousStatefulScanner</a>
</li>
<li>string()
: <a class="el" href="classScanner.html#a577a70297f4d3da0aa2ce4decc66eeea">Scanner</a>
, <a class="el" href="classLuminousEmbeddedWebScript.html#a468d0f77b948817731d32f866b360586">LuminousEmbeddedWebScript</a>
, <a class="el" href="classLuminousFilters.html#a3ff3ab9bf79e1e3ccc6f93e711e4396f">LuminousFilters</a>
</li>
</ul>
<h3><a class="anchor" id="index_t"></a>- t -</h3><ul>
<li>tag_block()
: <a class="el" href="classLuminousUtils.html#a50b5bcd2eb6e5c5c452899e42fe2fcc8">LuminousUtils</a>
</li>
<li>tagged()
: <a class="el" href="classLuminousScanner.html#a809c11561c650c7784edd3d06243b8b5">LuminousScanner</a>
, <a class="el" href="classLuminousStatefulScanner.html#a22ca39b6b85a796a5438840fbddc7c0a">LuminousStatefulScanner</a>
</li>
<li>terminate()
: <a class="el" href="classScanner.html#a185d6e780752848cb282add6d9f936bb">Scanner</a>
</li>
<li>theme()
: <a class="el" href="classluminous.html#a0bfdea509586ce343d2e6001ad33ccd0">luminous</a>
</li>
<li>theme_exists()
: <a class="el" href="classluminous.html#a069fa20b026732cc6366743f3688a822">luminous</a>
</li>
<li>themes()
: <a class="el" href="classluminous.html#a9bb8a124a3d5cff72a9756edabc7419a">luminous</a>
</li>
<li>token_array()
: <a class="el" href="classLuminousScanner.html#ae381e3000c83ae4cb2259d0ae77a14ab">LuminousScanner</a>
</li>
</ul>
<h3><a class="anchor" id="index_u"></a>- u -</h3><ul>
<li>unscan()
: <a class="el" href="classScanner.html#a6f6665b8df561788b1b2dea40bb394ae">Scanner</a>
</li>
<li>upper_to_constant()
: <a class="el" href="classLuminousFilters.html#a10fb6fd692505d6efeabc37754343288">LuminousFilters</a>
</li>
<li>user_def_filter()
: <a class="el" href="classLuminousScanner.html#a463b3eb270a7afb960ee642bccc0d1b6">LuminousScanner</a>
</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:51 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,289 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: Class Members - Variables</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li class="current"><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<div id="navrow3" class="tabs2">
<ul class="tablist">
<li><a href="functions.html"><span>All</span></a></li>
<li><a href="functions_func.html"><span>Functions</span></a></li>
<li class="current"><a href="functions_vars.html"><span>Variables</span></a></li>
</ul>
</div>
<div id="navrow4" class="tabs3">
<ul class="tablist">
<li><a href="#index_0x24"><span>$</span></a></li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="contents">
&#160;
<h3><a class="anchor" id="index_0x24"></a>- $ -</h3><ul>
<li>$auto_link
: <a class="el" href="classLuminousOptions.html#a1408903d6d4fb2251935576f07ad984c">LuminousOptions</a>
</li>
<li>$C_COMMENT_ML
: <a class="el" href="classLuminousTokenPresets.html#a2a1bb95d9131701b61a28b085f4d3653">LuminousTokenPresets</a>
</li>
<li>$C_COMMENT_SL
: <a class="el" href="classLuminousTokenPresets.html#aeb1c122a80cc1b3d00eb6eb112da4b1f">LuminousTokenPresets</a>
</li>
<li>$cache
: <a class="el" href="classLuminousStringSearch.html#a409d9de167e4668acbe3da71f2bfa277">LuminousStringSearch</a>
, <a class="el" href="classLuminousOptions.html#acbbe98bf278f669a047aa3fafc63f00e">LuminousOptions</a>
</li>
<li>$cache_age
: <a class="el" href="classLuminousOptions.html#a40a7a05710c6e07ffc2670dff2dc4f99">LuminousOptions</a>
</li>
<li>$case_sensitive
: <a class="el" href="classLuminousScanner.html#af3887911498a250b2cb1fe737dd87df1">LuminousScanner</a>
</li>
<li>$CHAR
: <a class="el" href="classLuminousTokenPresets.html#a74183f045ac39cf2b30e1bdc98c3a34c">LuminousTokenPresets</a>
</li>
<li>$child_scanners
: <a class="el" href="classLuminousEmbeddedWebScript.html#aba37db3108b9a5ec0fda7f18a66fb317">LuminousEmbeddedWebScript</a>
</li>
<li>$clean_exit
: <a class="el" href="classLuminousEmbeddedWebScript.html#a278925946650e3c9e2094283512697d1">LuminousEmbeddedWebScript</a>
</li>
<li>$dirty_exit_recovery
: <a class="el" href="classLuminousEmbeddedWebScript.html#ace2c028e88c2c295c9f92214eff51f2b">LuminousEmbeddedWebScript</a>
</li>
<li>$DOUBLE_STR
: <a class="el" href="classLuminousTokenPresets.html#ae5053efc9d68d6c83988d0c29dd0bf60">LuminousTokenPresets</a>
</li>
<li>$DOUBLE_STR_SL
: <a class="el" href="classLuminousTokenPresets.html#a622c25d34fdb4f6fd66c774a0e8e2a91">LuminousTokenPresets</a>
</li>
<li>$embedded_html
: <a class="el" href="classLuminousEmbeddedWebScript.html#a9627fb0cc01060902259ee3c9212fad2">LuminousEmbeddedWebScript</a>
</li>
<li>$embedded_server
: <a class="el" href="classLuminousEmbeddedWebScript.html#a5fdc96de06443379f9dd48de9b80040b">LuminousEmbeddedWebScript</a>
</li>
<li>$exit_state
: <a class="el" href="classLuminousEmbeddedWebScript.html#a463a354548b9e9bf913ca47faf03808a">LuminousEmbeddedWebScript</a>
</li>
<li>$failure_tag
: <a class="el" href="classLuminousOptions.html#a4dd6a94185818e0ce25382ac380dede8">LuminousOptions</a>
</li>
<li>$filters
: <a class="el" href="classLuminousScanner.html#aca257c4da52076f42c6e53d9d0d33dd1">LuminousScanner</a>
</li>
<li>$format
: <a class="el" href="classLuminousOptions.html#a9ca11e80317fb5a8d2d4cc45a775f0f1">LuminousOptions</a>
</li>
<li>$highlight_lines
: <a class="el" href="classLuminousOptions.html#a90ef29c5d273d023c501a1cd1f50f4de">LuminousOptions</a>
</li>
<li>$html_strict
: <a class="el" href="classLuminousOptions.html#abf723d25b5f09ae6354998967477f6ac">LuminousOptions</a>
</li>
<li>$ident_map
: <a class="el" href="classLuminousScanner.html#adb13455bbeb076cd0f031f050ef31a82">LuminousScanner</a>
</li>
<li>$include_javascript
: <a class="el" href="classLuminousOptions.html#a45fe559dc1ab53dd722c466652848b0c">LuminousOptions</a>
</li>
<li>$include_jquery
: <a class="el" href="classLuminousOptions.html#ad2127af1b05b4c02a02a03509cd42ba9">LuminousOptions</a>
</li>
<li>$index
: <a class="el" href="classScanner.html#a1df8db865da4a56e83848e66c2fdd86c">Scanner</a>
</li>
<li>$interrupt
: <a class="el" href="classLuminousEmbeddedWebScript.html#aa33f76adc9164f8160785e8f70ff2420">LuminousEmbeddedWebScript</a>
</li>
<li>$last_state
: <a class="el" href="classLuminousStatefulScanner.html#ac48a7493e46607197259fabaa18196ad">LuminousStatefulScanner</a>
</li>
<li>$legal_transitions
: <a class="el" href="classLuminousStatefulScanner.html#a33e625b6e207b9fa8d02306938480519">LuminousStatefulScanner</a>
</li>
<li>$line_numbers
: <a class="el" href="classLuminousOptions.html#a053180f6c41b62a4e0742a000655aea9">LuminousOptions</a>
</li>
<li>$match_history
: <a class="el" href="classScanner.html#a7ffc9d830a0a2a0468f23e6150f662ab">Scanner</a>
</li>
<li>$max_height
: <a class="el" href="classLuminousOptions.html#a30027aaad70cc92226e871c4c6c4824a">LuminousOptions</a>
</li>
<li>$NUM_HEX
: <a class="el" href="classLuminousTokenPresets.html#a7230e06c64a6f4ce165e12f5bd39ec6a">LuminousTokenPresets</a>
</li>
<li>$NUM_REAL
: <a class="el" href="classLuminousTokenPresets.html#a92cf3ef1206f3045feec2d651266dd76">LuminousTokenPresets</a>
</li>
<li>$overrides
: <a class="el" href="classLuminousSimpleScanner.html#a6fe26909e26aeb6659a95bfbb8bb05d0">LuminousSimpleScanner</a>
</li>
<li>$patterns
: <a class="el" href="classScanner.html#ae07cbb19db97a18f93090e761243d890">Scanner</a>
, <a class="el" href="classLuminousStatefulScanner.html#acbb00a72f935a8c45261383760542b1d">LuminousStatefulScanner</a>
</li>
<li>$PERL_COMMENT
: <a class="el" href="classLuminousTokenPresets.html#aed7c53313969df00c41b6dc62862f12d">LuminousTokenPresets</a>
</li>
<li>$relative_root
: <a class="el" href="classLuminousOptions.html#a7cb3de376e2f841d98ba0e20c177a3aa">LuminousOptions</a>
</li>
<li>$rule_tag_map
: <a class="el" href="classLuminousScanner.html#a30aaa5d3076a9f28d00f167a1c4eac34">LuminousScanner</a>
</li>
<li>$script_tags
: <a class="el" href="classLuminousEmbeddedWebScript.html#a298f32256c797af02dbb7dbf3b2d2040">LuminousEmbeddedWebScript</a>
</li>
<li>$server_tags
: <a class="el" href="classLuminousEmbeddedWebScript.html#a11065fbf564b463206673a07a0498457">LuminousEmbeddedWebScript</a>
</li>
<li>$setup
: <a class="el" href="classLuminousStatefulScanner.html#a98a1d160d07f04e2ba8388e6b73db524">LuminousStatefulScanner</a>
</li>
<li>$SINGLE_STR
: <a class="el" href="classLuminousTokenPresets.html#a2af434cd51ac824e7c386bf6856bdb52">LuminousTokenPresets</a>
</li>
<li>$SINGLE_STR_SL
: <a class="el" href="classLuminousTokenPresets.html#ad012cf604ed4da5e3ef57338527fd5df">LuminousTokenPresets</a>
</li>
<li>$sql_function
: <a class="el" href="classLuminousOptions.html#acf2a3ca0e41e847db7fc4e30e7c4608f">LuminousOptions</a>
</li>
<li>$SQL_SINGLE_STR
: <a class="el" href="classLuminousTokenPresets.html#a20e568ce1f9f82efa80f781033cb7e9c">LuminousTokenPresets</a>
</li>
<li>$SQL_SINGLE_STR_BSLASH
: <a class="el" href="classLuminousTokenPresets.html#a7757feb38c55d3fffe8afe16957af183">LuminousTokenPresets</a>
</li>
<li>$src
: <a class="el" href="classScanner.html#a289bba9fedd00d7e2219d30f547ac392">Scanner</a>
</li>
<li>$src_len
: <a class="el" href="classScanner.html#a3d1a7f67acfa79b0ea574418e4a478a7">Scanner</a>
</li>
<li>$ss
: <a class="el" href="classScanner.html#a26970234bb2dde880548b084a0ade5e2">Scanner</a>
</li>
<li>$start_line
: <a class="el" href="classLuminousOptions.html#a49151dba0f00d1357fba1b1c68096eb5">LuminousOptions</a>
</li>
<li>$state_
: <a class="el" href="classLuminousScanner.html#ab5a30262ceb4324fdfaac1a7d217ba36">LuminousScanner</a>
</li>
<li>$stream_filters
: <a class="el" href="classLuminousScanner.html#ad3d9ad7f7f14bc9de3dd6b68225ce21c">LuminousScanner</a>
</li>
<li>$string
: <a class="el" href="classLuminousStringSearch.html#a2ed7bad26a3e255195bb00c12a50e49c">LuminousStringSearch</a>
</li>
<li>$theme
: <a class="el" href="classLuminousOptions.html#a4fc507972ad86defd3bcd0c4f721e44b">LuminousOptions</a>
</li>
<li>$token_tree_stack
: <a class="el" href="classLuminousStatefulScanner.html#aceb7c9c79698251183e07afb1ddf4228">LuminousStatefulScanner</a>
</li>
<li>$tokens
: <a class="el" href="classLuminousScanner.html#ab29032700812b580e5d09b6128202286">LuminousScanner</a>
</li>
<li>$transition_rule_cache
: <a class="el" href="classLuminousStatefulScanner.html#a58cb6b0100f05e310f90a8bf79608a3b">LuminousStatefulScanner</a>
</li>
<li>$transitions
: <a class="el" href="classLuminousStatefulScanner.html#a74653deca3c7705eb06a250e7283060a">LuminousStatefulScanner</a>
</li>
<li>$user_defs
: <a class="el" href="classLuminousScanner.html#a615d93f42d9290b9fad4d84cc2fd84ec">LuminousScanner</a>
</li>
<li>$version
: <a class="el" href="classLuminousScanner.html#a22a1e366c9fbe4e837de693258c5c739">LuminousScanner</a>
</li>
<li>$wrap_width
: <a class="el" href="classLuminousOptions.html#a2d5811ef7a32a459d55de9e211c324c9">LuminousOptions</a>
</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:51 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

22
3rdparty/luminous/docs/html/graph_legend.dot vendored Executable file
View File

@ -0,0 +1,22 @@
digraph "Graph Legend"
{
edge [fontname="FreeSans",fontsize="10",labelfontname="FreeSans",labelfontsize="10"];
node [fontname="FreeSans",fontsize="10",shape=record];
Node9 [shape="box",label="Inherited",fontsize="10",height=0.2,width=0.4,fontname="FreeSans",fillcolor="grey75",style="filled" fontcolor="black"];
Node10 -> Node9 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node10 [shape="box",label="PublicBase",fontsize="10",height=0.2,width=0.4,fontname="FreeSans",color="black",URL="$classPublicBase.html"];
Node11 -> Node10 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node11 [shape="box",label="Truncated",fontsize="10",height=0.2,width=0.4,fontname="FreeSans",color="red",URL="$classTruncated.html"];
Node13 -> Node9 [dir="back",color="darkgreen",fontsize="10",style="solid",fontname="FreeSans"];
Node13 [shape="box",label="ProtectedBase",fontsize="10",height=0.2,width=0.4,fontname="FreeSans",color="black",URL="$classProtectedBase.html"];
Node14 -> Node9 [dir="back",color="firebrick4",fontsize="10",style="solid",fontname="FreeSans"];
Node14 [shape="box",label="PrivateBase",fontsize="10",height=0.2,width=0.4,fontname="FreeSans",color="black",URL="$classPrivateBase.html"];
Node15 -> Node9 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node15 [shape="box",label="Undocumented",fontsize="10",height=0.2,width=0.4,fontname="FreeSans",color="grey75"];
Node16 -> Node9 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="FreeSans"];
Node16 [shape="box",label="Templ< int >",fontsize="10",height=0.2,width=0.4,fontname="FreeSans",color="black",URL="$classTempl.html"];
Node17 -> Node16 [dir="back",color="orange",fontsize="10",style="dashed",label="< int >",fontname="FreeSans"];
Node17 [shape="box",label="Templ< T >",fontsize="10",height=0.2,width=0.4,fontname="FreeSans",color="black",URL="$classTempl.html"];
Node18 -> Node9 [dir="back",color="darkorchid3",fontsize="10",style="dashed",label="m_usedClass",fontname="FreeSans"];
Node18 [shape="box",label="Used",fontsize="10",height=0.2,width=0.4,fontname="FreeSans",color="black",URL="$classUsed.html"];
}

152
3rdparty/luminous/docs/html/graph_legend.html vendored Executable file
View File

@ -0,0 +1,152 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: Graph Legend</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Graph Legend</div> </div>
</div><!--header-->
<div class="contents">
<p>This page explains how to interpret the graphs that are generated by doxygen.</p>
<p>Consider the following example: </p>
<div class="fragment"><div class="line"><span class="comment">/*! Invisible class because of truncation */</span></div>
<div class="line"><span class="keyword">class </span>Invisible { };</div>
<div class="line"><span class="comment"></span></div>
<div class="line"><span class="comment">/*! Truncated class, inheritance relation is hidden */</span></div>
<div class="line"><span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };</div>
<div class="line"></div>
<div class="line"><span class="comment">/* Class not documented with doxygen comments */</span></div>
<div class="line"><span class="keyword">class </span>Undocumented { };</div>
<div class="line"><span class="comment"></span></div>
<div class="line"><span class="comment">/*! Class that is inherited using public inheritance */</span></div>
<div class="line"><span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };</div>
<div class="line"><span class="comment"></span></div>
<div class="line"><span class="comment">/*! A template class */</span></div>
<div class="line"><span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };</div>
<div class="line"><span class="comment"></span></div>
<div class="line"><span class="comment">/*! Class that is inherited using protected inheritance */</span></div>
<div class="line"><span class="keyword">class </span>ProtectedBase { };</div>
<div class="line"><span class="comment"></span></div>
<div class="line"><span class="comment">/*! Class that is inherited using private inheritance */</span></div>
<div class="line"><span class="keyword">class </span>PrivateBase { };</div>
<div class="line"><span class="comment"></span></div>
<div class="line"><span class="comment">/*! Class that is used by the Inherited class */</span></div>
<div class="line"><span class="keyword">class </span>Used { };</div>
<div class="line"><span class="comment"></span></div>
<div class="line"><span class="comment">/*! Super class that inherits a number of other classes */</span></div>
<div class="line"><span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,</div>
<div class="line"> <span class="keyword">protected</span> ProtectedBase,</div>
<div class="line"> <span class="keyword">private</span> PrivateBase,</div>
<div class="line"> <span class="keyword">public</span> Undocumented,</div>
<div class="line"> <span class="keyword">public</span> Templ&lt;int&gt;</div>
<div class="line">{</div>
<div class="line"> <span class="keyword">private</span>:</div>
<div class="line"> Used *m_usedClass;</div>
<div class="line">};</div>
</div><!-- fragment --><p> This will result in the following graph:</p>
<center><div class="image">
<img src="graph_legend.png" />
</div>
</center><p>The boxes in the above graph have the following meaning: </p>
<ul>
<li>
A filled gray box represents the struct or class for which the graph is generated. </li>
<li>
A box with a black border denotes a documented struct or class. </li>
<li>
A box with a grey border denotes an undocumented struct or class. </li>
<li>
A box with a red border denotes a documented struct or class forwhich not all inheritance/containment relations are shown. A graph is truncated if it does not fit within the specified boundaries. </li>
</ul>
<p>The arrows have the following meaning: </p>
<ul>
<li>
A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
<li>
A dark green arrow is used for protected inheritance. </li>
<li>
A dark red arrow is used for private inheritance. </li>
<li>
A purple dashed arrow is used if a class is contained or used by another class. The arrow is labeled with the variable(s) through which the pointed class or struct is accessible. </li>
<li>
A yellow dashed arrow denotes a relation between a template instance and the template class it was instantiated from. The arrow is labeled with the template parameters of the instance. </li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:51 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1 @@
6ba764f90c0f7463ae4482bca4fe18ee

112
3rdparty/luminous/docs/html/hierarchy.html vendored Executable file
View File

@ -0,0 +1,112 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: Class Hierarchy</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li class="current"><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Class Hierarchy</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock">
<p><a href="inherits.html">Go to the graphical class hierarchy</a></p>
This inheritance list is sorted roughly, but not completely, alphabetically:</div><div class="directory">
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span><span onclick="javascript:toggleLevel(4);">4</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classluminous.html" target="_self">luminous</a></td><td class="desc">Users' API</td></tr>
<tr id="row_1_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classLuminousFilters.html" target="_self">LuminousFilters</a></td><td class="desc">A collection of useful common filters</td></tr>
<tr id="row_2_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classLuminousOptions.html" target="_self">LuminousOptions</a></td><td class="desc">Options class</td></tr>
<tr id="row_3_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classLuminousStringSearch.html" target="_self">LuminousStringSearch</a></td><td class="desc">A basic preg_match wrapper which caches its results</td></tr>
<tr id="row_4_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classLuminousTokenPresets.html" target="_self">LuminousTokenPresets</a></td><td class="desc">A set of pre-defined patterns to match various common tokens</td></tr>
<tr id="row_5_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classLuminousUtils.html" target="_self">LuminousUtils</a></td><td class="desc">A set of utility functions for scanners</td></tr>
<tr id="row_6_" class="even"><td class="entry"><img id="arr_6_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('6_')"/><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classScanner.html" target="_self">Scanner</a></td><td class="desc">Base string scanning class</td></tr>
<tr id="row_6_0_"><td class="entry"><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img id="arr_6_0_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('6_0_')"/><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classLuminousScanner.html" target="_self">LuminousScanner</a></td><td class="desc">Base class for all scanners</td></tr>
<tr id="row_6_0_0_" class="even"><td class="entry"><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classLuminousEmbeddedWebScript.html" target="_self">LuminousEmbeddedWebScript</a></td><td class="desc">Superclass for languages which may nest, i.e. web languages</td></tr>
<tr id="row_6_0_1_"><td class="entry"><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img id="arr_6_0_1_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('6_0_1_')"/><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classLuminousSimpleScanner.html" target="_self">LuminousSimpleScanner</a></td><td class="desc">A largely automated scanner</td></tr>
<tr id="row_6_0_1_0_" class="even"><td class="entry"><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classLuminousStatefulScanner.html" target="_self">LuminousStatefulScanner</a></td><td class="desc">Experimental transition table driven scanner</td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:51 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

92
3rdparty/luminous/docs/html/index.html vendored Executable file
View File

@ -0,0 +1,92 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
&#160;<span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li class="current"><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Luminous Documentation</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>This is the API documentation for Luminous, a PHP syntax highlighter. This is mostly for development purposes, and not a lot of use to users.</p>
<p>However, users may be interested in the <a class="el" href="classluminous.html">user's API </a> and the <a class="el" href="classLuminousOptions.html" title="Options class.">LuminousOptions</a> class</p>
<p>Luminous site: <a href="http://luminous.asgaard.co.uk">http://luminous.asgaard.co.uk</a></p>
<p>User's documentation: <a href="http://luminous.asgaard.co.uk/index.php/docs/show/index">http://luminous.asgaard.co.uk/index.php/docs/show/index</a> </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:51 for Luminous by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>

View File

@ -0,0 +1,7 @@
digraph "Graphical Class Hierarchy"
{
edge [fontname="FreeSans",fontsize="10",labelfontname="FreeSans",labelfontsize="10"];
node [fontname="FreeSans",fontsize="10",shape=record];
rankdir="LR";
Node1 [label="luminous",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classluminous.html",tooltip="Users&#39; API."];
}

View File

@ -0,0 +1 @@
7ee7c3f617d580bda5d193eba78a7075

View File

@ -0,0 +1,7 @@
digraph "Graphical Class Hierarchy"
{
edge [fontname="FreeSans",fontsize="10",labelfontname="FreeSans",labelfontsize="10"];
node [fontname="FreeSans",fontsize="10",shape=record];
rankdir="LR";
Node1 [label="LuminousFilters",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classLuminousFilters.html",tooltip="A collection of useful common filters."];
}

View File

@ -0,0 +1 @@
a65ae1f665a9d346c99f7bbed1d9e9a4

View File

@ -0,0 +1,7 @@
digraph "Graphical Class Hierarchy"
{
edge [fontname="FreeSans",fontsize="10",labelfontname="FreeSans",labelfontsize="10"];
node [fontname="FreeSans",fontsize="10",shape=record];
rankdir="LR";
Node1 [label="LuminousOptions",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classLuminousOptions.html",tooltip="Options class."];
}

View File

@ -0,0 +1 @@
2da286aa4c403e2d30a59337ea799ee0

View File

@ -0,0 +1,7 @@
digraph "Graphical Class Hierarchy"
{
edge [fontname="FreeSans",fontsize="10",labelfontname="FreeSans",labelfontsize="10"];
node [fontname="FreeSans",fontsize="10",shape=record];
rankdir="LR";
Node1 [label="LuminousStringSearch",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classLuminousStringSearch.html",tooltip="A basic preg_match wrapper which caches its results."];
}

View File

@ -0,0 +1 @@
5199f0a6c43ff1f03ce63a684a62029b

View File

@ -0,0 +1,7 @@
digraph "Graphical Class Hierarchy"
{
edge [fontname="FreeSans",fontsize="10",labelfontname="FreeSans",labelfontsize="10"];
node [fontname="FreeSans",fontsize="10",shape=record];
rankdir="LR";
Node1 [label="LuminousTokenPresets",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classLuminousTokenPresets.html",tooltip="A set of pre-defined patterns to match various common tokens."];
}

View File

@ -0,0 +1 @@
a1ccaae75c2b6463e8cdc1cfd9e4afd1

View File

@ -0,0 +1,7 @@
digraph "Graphical Class Hierarchy"
{
edge [fontname="FreeSans",fontsize="10",labelfontname="FreeSans",labelfontsize="10"];
node [fontname="FreeSans",fontsize="10",shape=record];
rankdir="LR";
Node1 [label="LuminousUtils",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classLuminousUtils.html",tooltip="A set of utility functions for scanners."];
}

View File

@ -0,0 +1 @@
d3cef82f8d8363352efb31abd6f549fc

Some files were not shown because too many files have changed in this diff Show More