Skip to content

Commit e719f1f

Browse files
committed
Deployed 8f71a0c with MkDocs version: 1.6.1
1 parent a9c22b4 commit e719f1f

File tree

13 files changed

+700
-368
lines changed

13 files changed

+700
-368
lines changed

api/abstract/index.html

Lines changed: 160 additions & 94 deletions
Large diffs are not rendered by default.

api/base/index.html

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,14 @@
127127

128128

129129

130-
<div class="doc doc-children">
130+
131+
132+
133+
134+
135+
136+
137+
<div class="doc doc-children">
131138

132139

133140

@@ -152,6 +159,7 @@ <h2 id="cstruct.base.BIG_ENDIAN" class="doc doc-heading">
152159
<div class="doc doc-contents ">
153160

154161
<p>Big-endian, std. size &amp; alignment</p>
162+
155163
</div>
156164

157165
</div>
@@ -173,6 +181,7 @@ <h2 id="cstruct.base.LITTLE_ENDIAN" class="doc doc-heading">
173181
<div class="doc doc-contents ">
174182

175183
<p>Little-endian, std. size &amp; alignment</p>
184+
176185
</div>
177186

178187
</div>
@@ -194,6 +203,7 @@ <h2 id="cstruct.base.NATIVE_ORDER" class="doc doc-heading">
194203
<div class="doc doc-contents ">
195204

196205
<p>Native order, size &amp; alignment</p>
206+
197207
</div>
198208

199209
</div>
@@ -202,6 +212,7 @@ <h2 id="cstruct.base.NATIVE_ORDER" class="doc doc-heading">
202212

203213

204214

215+
205216
</div>
206217

207218
</div>

api/c_expr/index.html

Lines changed: 43 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,15 @@
127127

128128

129129

130-
<div class="doc doc-children">
130+
131+
132+
133+
134+
135+
136+
137+
<div class="doc doc-children">
138+
131139

132140

133141

@@ -173,7 +181,7 @@ <h2 id="cstruct.c_expr.c_eval" class="doc doc-heading">
173181
<ul class="first simple">
174182
<li>
175183
<b><code>expr</code></b>
176-
(<code>str</code>)
184+
(<code><span title="str">str</span></code>)
177185
178186
<div class="doc-md-description">
179187
<p>C expression</p>
@@ -196,7 +204,7 @@ <h2 id="cstruct.c_expr.c_eval" class="doc doc-heading">
196204
<td class="field-body">
197205
<ul class="first simple">
198206
<li>
199-
<b><code>result</code></b>( <code><span title="typing.Union">Union</span>[int, float]</code>
207+
<b><code>result</code></b>( <code><span title="typing.Union">Union</span>[<span title="int">int</span>, <span title="float">float</span>]</code>
200208
) –
201209
<div class="doc-md-description">
202210
<p>the expression evaluation result</p>
@@ -230,10 +238,10 @@ <h2 id="cstruct.c_expr.c_eval" class="doc doc-heading">
230238
</tr>
231239
</tbody>
232240
</table>
233-
<details class="quote">
241+
242+
<details class="mkdocstrings-source">
234243
<summary>Source code in <code>cstruct/c_expr.py</code></summary>
235-
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">39</span>
236-
<span class="normal">40</span>
244+
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">40</span>
237245
<span class="normal">41</span>
238246
<span class="normal">42</span>
239247
<span class="normal">43</span>
@@ -259,7 +267,8 @@ <h2 id="cstruct.c_expr.c_eval" class="doc doc-heading">
259267
<span class="normal">63</span>
260268
<span class="normal">64</span>
261269
<span class="normal">65</span>
262-
<span class="normal">66</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">c_eval</span><span class="p">(</span><span class="n">expr</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">]:</span>
270+
<span class="normal">66</span>
271+
<span class="normal">67</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">c_eval</span><span class="p">(</span><span class="n">expr</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">]:</span>
263272
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
264273
<span class="sd"> Evaluate a C arithmetic/logic expression and return the result</span>
265274

@@ -343,7 +352,7 @@ <h2 id="cstruct.c_expr.eval_attribute_node" class="doc doc-heading">
343352
<td class="field-body">
344353
<ul class="first simple">
345354
<li>
346-
<b><code>result</code></b>( <code><span title="typing.Union">Union</span>[int, float]</code>
355+
<b><code>result</code></b>( <code><span title="typing.Union">Union</span>[<span title="int">int</span>, <span title="float">float</span>]</code>
347356
) –
348357
<div class="doc-md-description">
349358
<p>the attribute value</p>
@@ -384,10 +393,10 @@ <h2 id="cstruct.c_expr.eval_attribute_node" class="doc doc-heading">
384393
</tr>
385394
</tbody>
386395
</table>
387-
<details class="quote">
396+
397+
<details class="mkdocstrings-source">
388398
<summary>Source code in <code>cstruct/c_expr.py</code></summary>
389-
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">69</span>
390-
<span class="normal">70</span>
399+
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">70</span>
391400
<span class="normal">71</span>
392401
<span class="normal">72</span>
393402
<span class="normal">73</span>
@@ -409,7 +418,8 @@ <h2 id="cstruct.c_expr.eval_attribute_node" class="doc doc-heading">
409418
<span class="normal">89</span>
410419
<span class="normal">90</span>
411420
<span class="normal">91</span>
412-
<span class="normal">92</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">eval_attribute_node</span><span class="p">(</span><span class="n">node</span><span class="p">:</span> <span class="n">ast</span><span class="o">.</span><span class="n">Attribute</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">]:</span>
421+
<span class="normal">92</span>
422+
<span class="normal">93</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">eval_attribute_node</span><span class="p">(</span><span class="n">node</span><span class="p">:</span> <span class="n">ast</span><span class="o">.</span><span class="n">Attribute</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">]:</span>
413423
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
414424
<span class="sd"> Evaluate node attribute, e.g. &#39;self.x&#39;</span>
415425
<span class="sd"> Only &#39;self&#39; is allowed. The attribute must be a number.</span>
@@ -452,17 +462,18 @@ <h2 id="cstruct.c_expr.eval_compare" class="doc doc-heading">
452462

453463
<p>Evaluate a compare node</p>
454464

455-
<details class="quote">
465+
466+
<details class="mkdocstrings-source">
456467
<summary>Source code in <code>cstruct/c_expr.py</code></summary>
457-
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">119</span>
458-
<span class="normal">120</span>
468+
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">120</span>
459469
<span class="normal">121</span>
460470
<span class="normal">122</span>
461471
<span class="normal">123</span>
462472
<span class="normal">124</span>
463473
<span class="normal">125</span>
464474
<span class="normal">126</span>
465-
<span class="normal">127</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">eval_compare</span><span class="p">(</span><span class="n">node</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
475+
<span class="normal">127</span>
476+
<span class="normal">128</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">eval_compare</span><span class="p">(</span><span class="n">node</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
466477
<span class="s2">&quot;Evaluate a compare node&quot;</span>
467478
<span class="n">right</span> <span class="o">=</span> <span class="n">eval_node</span><span class="p">(</span><span class="n">node</span><span class="o">.</span><span class="n">left</span><span class="p">)</span>
468479
<span class="k">for</span> <span class="n">operation</span><span class="p">,</span> <span class="n">comp</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">node</span><span class="o">.</span><span class="n">ops</span><span class="p">,</span> <span class="n">node</span><span class="o">.</span><span class="n">comparators</span><span class="p">):</span>
@@ -490,16 +501,17 @@ <h2 id="cstruct.c_expr.eval_div" class="doc doc-heading">
490501

491502
<p>Evaluate div node (integer/float)</p>
492503

493-
<details class="quote">
504+
505+
<details class="mkdocstrings-source">
494506
<summary>Source code in <code>cstruct/c_expr.py</code></summary>
495-
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">130</span>
496-
<span class="normal">131</span>
507+
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">131</span>
497508
<span class="normal">132</span>
498509
<span class="normal">133</span>
499510
<span class="normal">134</span>
500511
<span class="normal">135</span>
501512
<span class="normal">136</span>
502-
<span class="normal">137</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">eval_div</span><span class="p">(</span><span class="n">node</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">]:</span>
513+
<span class="normal">137</span>
514+
<span class="normal">138</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">eval_div</span><span class="p">(</span><span class="n">node</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">]:</span>
503515
<span class="s2">&quot;Evaluate div node (integer/float)&quot;</span>
504516
<span class="n">left</span> <span class="o">=</span> <span class="n">eval_node</span><span class="p">(</span><span class="n">node</span><span class="o">.</span><span class="n">left</span><span class="p">)</span>
505517
<span class="n">right</span> <span class="o">=</span> <span class="n">eval_node</span><span class="p">(</span><span class="n">node</span><span class="o">.</span><span class="n">right</span><span class="p">)</span>
@@ -526,14 +538,15 @@ <h2 id="cstruct.c_expr.eval_get" class="doc doc-heading">
526538

527539
<p>Get definition/struct by name</p>
528540

529-
<details class="quote">
541+
542+
<details class="mkdocstrings-source">
530543
<summary>Source code in <code>cstruct/c_expr.py</code></summary>
531-
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">111</span>
532-
<span class="normal">112</span>
544+
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">112</span>
533545
<span class="normal">113</span>
534546
<span class="normal">114</span>
535547
<span class="normal">115</span>
536-
<span class="normal">116</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">eval_get</span><span class="p">(</span><span class="n">node</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">,</span> <span class="n">Type</span><span class="p">[</span><span class="s2">&quot;AbstractCStruct&quot;</span><span class="p">]]:</span>
548+
<span class="normal">116</span>
549+
<span class="normal">117</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">eval_get</span><span class="p">(</span><span class="n">node</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">,</span> <span class="n">Type</span><span class="p">[</span><span class="s2">&quot;AbstractCStruct&quot;</span><span class="p">]]:</span>
537550
<span class="s2">&quot;Get definition/struct by name&quot;</span>
538551
<span class="k">try</span><span class="p">:</span>
539552
<span class="k">return</span> <span class="n">DEFINES</span><span class="p">[</span><span class="n">node</span><span class="o">.</span><span class="n">id</span><span class="p">]</span>
@@ -558,10 +571,10 @@ <h2 id="cstruct.c_expr.get_cstruct_context" class="doc doc-heading">
558571

559572
<p>Get the calling CStruct instance from the stack (if any)</p>
560573

561-
<details class="quote">
574+
575+
<details class="mkdocstrings-source">
562576
<summary>Source code in <code>cstruct/c_expr.py</code></summary>
563-
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">149</span>
564-
<span class="normal">150</span>
577+
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">150</span>
565578
<span class="normal">151</span>
566579
<span class="normal">152</span>
567580
<span class="normal">153</span>
@@ -571,11 +584,12 @@ <h2 id="cstruct.c_expr.get_cstruct_context" class="doc doc-heading">
571584
<span class="normal">157</span>
572585
<span class="normal">158</span>
573586
<span class="normal">159</span>
574-
<span class="normal">160</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">get_cstruct_context</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="s2">&quot;AbstractCStruct&quot;</span><span class="p">]:</span>
587+
<span class="normal">160</span>
588+
<span class="normal">161</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">get_cstruct_context</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="s2">&quot;AbstractCStruct&quot;</span><span class="p">]:</span>
575589
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
576590
<span class="sd"> Get the calling CStruct instance from the stack (if any)</span>
577591
<span class="sd"> &quot;&quot;&quot;</span>
578-
<span class="kn">from</span> <span class="nn">.abstract</span> <span class="kn">import</span> <span class="n">AbstractCStruct</span>
592+
<span class="kn">from</span><span class="w"> </span><span class="nn">.abstract</span><span class="w"> </span><span class="kn">import</span> <span class="n">AbstractCStruct</span>
579593

580594
<span class="n">stack</span> <span class="o">=</span> <span class="n">inspect</span><span class="o">.</span><span class="n">stack</span><span class="p">()</span>
581595
<span class="k">for</span> <span class="n">frame</span> <span class="ow">in</span> <span class="n">stack</span><span class="p">:</span>

0 commit comments

Comments
 (0)