Skip to content

Commit

Permalink
documentation for mainframe
Browse files Browse the repository at this point in the history
  • Loading branch information
MRO committed Dec 19, 2023
1 parent 0aaec4f commit 604f930
Show file tree
Hide file tree
Showing 5 changed files with 134 additions and 6 deletions.
14 changes: 14 additions & 0 deletions doc/_sources/mainframe.txt
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,11 @@ Data division
.. automethod:: cast.analysers.mainframe.Extension.end_redefines


.. automethod:: cast.analysers.mainframe.Extension.start_renames

.. automethod:: cast.analysers.mainframe.Extension.end_renames


.. automethod:: cast.analysers.mainframe.Extension.start_indexed_by

.. automethod:: cast.analysers.mainframe.Extension.end_indexed_by
Expand Down Expand Up @@ -977,6 +982,11 @@ Expressions
.. automethod:: cast.analysers.mainframe.Extension.end_integer_literal


.. automethod:: cast.analysers.mainframe.Extension.start_real_literal

.. automethod:: cast.analysers.mainframe.Extension.end_real_literal


.. automethod:: cast.analysers.mainframe.Extension.start_boolean_literal

.. automethod:: cast.analysers.mainframe.Extension.end_boolean_literal
Expand Down Expand Up @@ -1133,6 +1143,10 @@ Constants
:show-inheritance:
:members:

.. autoclass:: cast.analysers.mainframe.RealLiteral
:show-inheritance:
:members:


.. note::
Figurative constants come into those classes and the method get_name() will give the constant.
Expand Down
32 changes: 28 additions & 4 deletions doc/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -1162,12 +1162,12 @@ <h2 id="E">E</h2>
<dt><a href="mainframe.html#cast.analysers.mainframe.Extension.end_not_at_end">end_not_at_end() (cast.analysers.mainframe.Extension method)</a>
</dt>

</dl></td>
<td style="width: 33%" valign="top"><dl>

<dt><a href="mainframe.html#cast.analysers.mainframe.Extension.end_not_at_end_of_page">end_not_at_end_of_page() (cast.analysers.mainframe.Extension method)</a>
</dt>

</dl></td>
<td style="width: 33%" valign="top"><dl>

<dt><a href="mainframe.html#cast.analysers.mainframe.Extension.end_not_invalid_key">end_not_invalid_key() (cast.analysers.mainframe.Extension method)</a>
</dt>
Expand Down Expand Up @@ -1319,6 +1319,10 @@ <h2 id="E">E</h2>
</dt>


<dt><a href="mainframe.html#cast.analysers.mainframe.Extension.end_real_literal">end_real_literal() (cast.analysers.mainframe.Extension method)</a>
</dt>


<dt><a href="mainframe.html#cast.analysers.mainframe.Extension.end_records">end_records() (cast.analysers.mainframe.Extension method)</a>
</dt>

Expand All @@ -1335,6 +1339,10 @@ <h2 id="E">E</h2>
</dt>


<dt><a href="mainframe.html#cast.analysers.mainframe.Extension.end_renames">end_renames() (cast.analysers.mainframe.Extension method)</a>
</dt>


<dt><a href="mainframe.html#cast.analysers.mainframe.Extension.end_replace">end_replace() (cast.analysers.mainframe.Extension method)</a>
</dt>

Expand Down Expand Up @@ -3054,6 +3062,10 @@ <h2 id="G">G</h2>
</dt>


<dt><a href="mainframe.html#cast.analysers.mainframe.RealLiteral.get_value">(cast.analysers.mainframe.RealLiteral method)</a>
</dt>


<dt><a href="mainframe.html#cast.analysers.mainframe.StringLiteral.get_value">(cast.analysers.mainframe.StringLiteral method)</a>
</dt>

Expand Down Expand Up @@ -4455,6 +4467,10 @@ <h2 id="R">R</h2>
</dt>


<dt><a href="mainframe.html#cast.analysers.mainframe.RealLiteral">RealLiteral (class in cast.analysers.mainframe)</a>
</dt>


<dt><a href="code_reference.html#cast.analysers.Reference">Reference (class in cast.analysers)</a>
</dt>

Expand Down Expand Up @@ -5158,8 +5174,6 @@ <h2 id="S">S</h2>
<dt><a href="mainframe.html#cast.analysers.mainframe.Extension.start_logical_expression">start_logical_expression() (cast.analysers.mainframe.Extension method)</a>
</dt>

</dl></td>
<td style="width: 33%" valign="top"><dl>

<dt><a href="analysers_specif.html#cast.analysers.abap.Extension.start_member">start_member() (cast.analysers.abap.Extension method)</a>
</dt>
Expand All @@ -5174,6 +5188,8 @@ <h2 id="S">S</h2>
</dt>

</dl></dd>
</dl></td>
<td style="width: 33%" valign="top"><dl>

<dt><a href="mainframe.html#cast.analysers.mainframe.Extension.start_merge">start_merge() (cast.analysers.mainframe.Extension method)</a>
</dt>
Expand Down Expand Up @@ -5381,6 +5397,10 @@ <h2 id="S">S</h2>
</dt>


<dt><a href="mainframe.html#cast.analysers.mainframe.Extension.start_real_literal">start_real_literal() (cast.analysers.mainframe.Extension method)</a>
</dt>


<dt><a href="mainframe.html#cast.analysers.mainframe.Extension.start_records">start_records() (cast.analysers.mainframe.Extension method)</a>
</dt>

Expand All @@ -5397,6 +5417,10 @@ <h2 id="S">S</h2>
</dt>


<dt><a href="mainframe.html#cast.analysers.mainframe.Extension.start_renames">start_renames() (cast.analysers.mainframe.Extension method)</a>
</dt>


<dt><a href="mainframe.html#cast.analysers.mainframe.Extension.start_replace">start_replace() (cast.analysers.mainframe.Extension method)</a>
</dt>

Expand Down
92 changes: 91 additions & 1 deletion doc/mainframe.html
Original file line number Diff line number Diff line change
Expand Up @@ -1103,6 +1103,30 @@ <h4>Data division<a class="headerlink" href="#data-division" title="Permalink to
</div>
</dd></dl>

<dl class="method">
<dt id="cast.analysers.mainframe.Extension.start_renames">
<tt class="descname">start_renames</tt><big>(</big><em>node</em><big>)</big><a class="headerlink" href="#cast.analysers.mainframe.Extension.start_renames" title="Permalink to this definition"></a></dt>
<dd><p>Called at the beginning of a RENAMES ...</p>
<p>node is either of type
<tt class="xref py py-class docutils literal"><span class="pre">cast.analyzers.mainframe.SavedData</span></tt> or
<tt class="xref py py-class docutils literal"><span class="pre">cast.analyzers.mainframe.UnsavedData</span></tt></p>
<div class="versionadded">
<p><span class="versionmodified">New in version com.castsoftware.mainframe.1.2.1-funcrel.</span></p>
</div>
</dd></dl>

<dl class="method">
<dt id="cast.analysers.mainframe.Extension.end_renames">
<tt class="descname">end_renames</tt><big>(</big><em>node</em><big>)</big><a class="headerlink" href="#cast.analysers.mainframe.Extension.end_renames" title="Permalink to this definition"></a></dt>
<dd><p>Called at the end of a RENAMES ...</p>
<p>node is either of type
<tt class="xref py py-class docutils literal"><span class="pre">cast.analyzers.mainframe.SavedData</span></tt> or
<tt class="xref py py-class docutils literal"><span class="pre">cast.analyzers.mainframe.UnsavedData</span></tt></p>
<div class="versionadded">
<p><span class="versionmodified">New in version com.castsoftware.mainframe.1.2.1-funcrel.</span></p>
</div>
</dd></dl>

<dl class="method">
<dt id="cast.analysers.mainframe.Extension.start_indexed_by">
<tt class="descname">start_indexed_by</tt><big>(</big><em>node</em><big>)</big><a class="headerlink" href="#cast.analysers.mainframe.Extension.start_indexed_by" title="Permalink to this definition"></a></dt>
Expand Down Expand Up @@ -6189,6 +6213,46 @@ <h4>Expressions<a class="headerlink" href="#expressions" title="Permalink to thi
<p>&#64;type literal:cast.analyzer.mainframe.IntegerLiteral</p>
</dd></dl>

<dl class="method">
<dt id="cast.analysers.mainframe.Extension.start_real_literal">
<tt class="descname">start_real_literal</tt><big>(</big><em>literal</em><big>)</big><a class="headerlink" href="#cast.analysers.mainframe.Extension.start_real_literal" title="Permalink to this definition"></a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>literal</strong> (<a class="reference internal" href="#cast.analysers.mainframe.RealLiteral" title="cast.analysers.mainframe.RealLiteral"><em>cast.analysers.mainframe.RealLiteral</em></a>) &#8211; the node</td>
</tr>
</tbody>
</table>
<dl class="docutils">
<dt>&#64;type literal:cast.analyzer.mainframe.IntegerLiteral</dt>
<dd><div class="first last versionadded">
<p><span class="versionmodified">New in version com.castsoftware.mainframe.1.3.0-alpha1.</span></p>
</div>
</dd>
</dl>
</dd></dl>

<dl class="method">
<dt id="cast.analysers.mainframe.Extension.end_real_literal">
<tt class="descname">end_real_literal</tt><big>(</big><em>literal</em><big>)</big><a class="headerlink" href="#cast.analysers.mainframe.Extension.end_real_literal" title="Permalink to this definition"></a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>literal</strong> (<a class="reference internal" href="#cast.analysers.mainframe.RealLiteral" title="cast.analysers.mainframe.RealLiteral"><em>cast.analysers.mainframe.RealLiteral</em></a>) &#8211; the node</td>
</tr>
</tbody>
</table>
<dl class="docutils">
<dt>&#64;type literal:cast.analyzer.mainframe.RealLiteral</dt>
<dd><div class="first last versionadded">
<p><span class="versionmodified">New in version com.castsoftware.mainframe.1.3.0-alpha1.</span></p>
</div>
</dd>
</dl>
</dd></dl>

<dl class="method">
<dt id="cast.analysers.mainframe.Extension.start_boolean_literal">
<tt class="descname">start_boolean_literal</tt><big>(</big><em>literal</em><big>)</big><a class="headerlink" href="#cast.analysers.mainframe.Extension.start_boolean_literal" title="Permalink to this definition"></a></dt>
Expand Down Expand Up @@ -6524,7 +6588,7 @@ <h4>Expressions<a class="headerlink" href="#expressions" title="Permalink to thi
</table>
<p>&#64;type node:Node</p>
<div class="versionadded">
<p><span class="versionmodified">New in version com.castsoftware.mainframe.1.0.7-funcrel.</span></p>
<p><span class="versionmodified">New in version com.castsoftware.mainframe.1.0.7-funcrel: </span>From version com.castsoftware.mainframe.1.3.0-alpha1 function name is available through node.get_name()</p>
</div>
</dd></dl>

Expand Down Expand Up @@ -7644,6 +7708,32 @@ <h3>AST Node types<a class="headerlink" href="#ast-node-types" title="Permalink

</dd></dl>

<dl class="class">
<dt id="cast.analysers.mainframe.RealLiteral">
<em class="property">class </em><tt class="descclassname">cast.analysers.mainframe.</tt><tt class="descname">RealLiteral</tt><a class="headerlink" href="#cast.analysers.mainframe.RealLiteral" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#cast.analysers.mainframe.UnsavedObject" title="cast.analysers.mainframe.UnsavedObject"><tt class="xref py py-class docutils literal"><span class="pre">cast.analysers.mainframe.UnsavedObject</span></tt></a></p>
<p>A real literal in an AST.</p>
<p>For example</p>
<div class="highlight-python"><div class="highlight"><pre>MOVE -3.4 to VAR.
-
</pre></div>
</div>
<dl class="method">
<dt id="cast.analysers.mainframe.RealLiteral.get_value">
<tt class="descname">get_value</tt><big>(</big><big>)</big><a class="headerlink" href="#cast.analysers.mainframe.RealLiteral.get_value" title="Permalink to this definition"></a></dt>
<dd><p>Return the real value.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">float</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Figurative constants come into those classes and the method get_name() will give the constant.
Expand Down
Binary file modified doc/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion doc/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 604f930

Please sign in to comment.