Add sphinx documentation, integrated into our navigation and colour scheme
[ndcode_site.git] / sphinx / bison_lr1dfa.html
1
2 <!DOCTYPE html>
3
4 <html xmlns="http://www.w3.org/1999/xhtml">
5   <head>
6     <meta charset="utf-8" />
7     <title>The bison_lr1dfa module &#8212; Ï€yacc  documentation</title>
8     <link rel="stylesheet" href="_static/classic.css" type="text/css" />
9     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
10     
11     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
12     <script src="_static/jquery.js"></script>
13     <script src="_static/underscore.js"></script>
14     <script src="_static/doctools.js"></script>
15     <script src="_static/language_data.js"></script>
16     
17     <link rel="index" title="Index" href="genindex.html" />
18     <link rel="search" title="Search" href="search.html" />
19     <link rel="next" title="The cli module" href="cli.html" />
20     <link rel="prev" title="The bisect_set module" href="bisect_set.html" /> 
21   </head><body>
22     <div class="related" role="navigation" aria-label="related navigation">
23       <h3>Navigation</h3>
24       <ul>
25         <li class="right" style="margin-right: 10px">
26           <a href="genindex.html" title="General Index"
27              accesskey="I">index</a></li>
28         <li class="right" >
29           <a href="py-modindex.html" title="Python Module Index"
30              >modules</a> |</li>
31         <li class="right" >
32           <a href="cli.html" title="The cli module"
33              accesskey="N">next</a> |</li>
34         <li class="right" >
35           <a href="bisect_set.html" title="The bisect_set module"
36              accesskey="P">previous</a> |</li>
37         <li class="nav-item nav-item-0"><a href="index.html">Ï€yacc  documentation</a> &#187;</li> 
38       </ul>
39     </div>  
40
41     <div class="document">
42       <div class="documentwrapper">
43         <div class="bodywrapper">
44           <div class="body" role="main">
45             
46   <div class="section" id="module-ndcode.piyacc.bison_lr1dfa">
47 <span id="the-bison-lr1dfa-module"></span><h1>The <code class="docutils literal notranslate"><span class="pre">bison_lr1dfa</span></code> module<a class="headerlink" href="#module-ndcode.piyacc.bison_lr1dfa" title="Permalink to this headline">¶</a></h1>
48 <p>Module for constructing Bison-compatible automata. That is, automata that can
49 be executed using Bison’s default skeleton.</p>
50 <dl class="class">
51 <dt id="ndcode.piyacc.bison_lr1dfa.BisonLR1DFA">
52 <em class="property">class </em><code class="sig-prename descclassname">ndcode.piyacc.bison_lr1dfa.</code><code class="sig-name descname">BisonLR1DFA</code><span class="sig-paren">(</span><em class="sig-param">translate</em>, <em class="sig-param">rules</em>, <em class="sig-param">accessing_symbols</em>, <em class="sig-param">default_action</em>, <em class="sig-param">default_goto</em>, <em class="sig-param">entry_base</em>, <em class="sig-param">entries</em>, <em class="sig-param">action_pointer</em>, <em class="sig-param">goto_pointer</em>, <em class="sig-param">n_terminals</em><span class="sig-paren">)</span><a class="headerlink" href="#ndcode.piyacc.bison_lr1dfa.BisonLR1DFA" title="Permalink to this definition">¶</a></dt>
53 <dd><p>Class which holds a Bison-compatible automaton.</p>
54 <p>Normally all of the fields of the class are computed ahead of time by
55 <code class="docutils literal notranslate"><span class="pre">LR1DFA.to_bison_lr1dfa()</span></code> and then passed into the constructor here.</p>
56 <p>At the moment, this class doesn’t have any methods, it simply holds the data
57 which will be needed to populate a Bison skeleton. In the future we might add
58 methods for executing the automaton directly on a stream of lexical tokens.</p>
59 </dd></dl>
60
61 </div>
62
63
64           </div>
65         </div>
66       </div>
67       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
68         <div class="sphinxsidebarwrapper">
69   <h4>Previous topic</h4>
70   <p class="topless"><a href="bisect_set.html"
71                         title="previous chapter">The <code class="docutils literal notranslate"><span class="pre">bisect_set</span></code> module</a></p>
72   <h4>Next topic</h4>
73   <p class="topless"><a href="cli.html"
74                         title="next chapter">The <code class="docutils literal notranslate"><span class="pre">cli</span></code> module</a></p>
75   <div role="note" aria-label="source link">
76     <h3>This Page</h3>
77     <ul class="this-page-menu">
78       <li><a href="_sources/bison_lr1dfa.rst.txt"
79             rel="nofollow">Show Source</a></li>
80     </ul>
81    </div>
82 <div id="searchbox" style="display: none" role="search">
83   <h3 id="searchlabel">Quick search</h3>
84     <div class="searchformwrapper">
85     <form class="search" action="search.html" method="get">
86       <input type="text" name="q" aria-labelledby="searchlabel" />
87       <input type="submit" value="Go" />
88     </form>
89     </div>
90 </div>
91 <script>$('#searchbox').show(0);</script>
92         </div>
93       </div>
94       <div class="clearer"></div>
95     </div>
96     <div class="related" role="navigation" aria-label="related navigation">
97       <h3>Navigation</h3>
98       <ul>
99         <li class="right" style="margin-right: 10px">
100           <a href="genindex.html" title="General Index"
101              >index</a></li>
102         <li class="right" >
103           <a href="py-modindex.html" title="Python Module Index"
104              >modules</a> |</li>
105         <li class="right" >
106           <a href="cli.html" title="The cli module"
107              >next</a> |</li>
108         <li class="right" >
109           <a href="bisect_set.html" title="The bisect_set module"
110              >previous</a> |</li>
111         <li class="nav-item nav-item-0"><a href="index.html">Ï€yacc  documentation</a> &#187;</li> 
112       </ul>
113     </div>
114     <div class="footer" role="contentinfo">
115         &#169; Copyright 2020, NDCODE project.
116       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.1.
117     </div>
118   </body>
119 </html>