WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Commit 00dad09

Browse files
actions-useractions-user
committed
Update docs from rizinorg/cutter
Original Commit: 8723a470c6f53aa3ee23447e4ac22532c35f234a Make CutterCore::core API harder to misuse. (#3473)
1 parent 5a8ce83 commit 00dad09

File tree

7 files changed

+36
-13
lines changed

7 files changed

+36
-13
lines changed

‎docs/api.html‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1138,6 +1138,7 @@ <h3>Navigation</h3>
11381138
<li class="toctree-l4"><a class="reference internal" href="api/core/classCutterCore.html#_CPPv4N10CutterCore26triggerGraphOptionsChangedEv"><code class="docutils literal notranslate"><span class="pre">triggerGraphOptionsChanged()</span></code></a></li>
11391139
<li class="toctree-l4"><a class="reference internal" href="api/core/classCutterCore.html#_CPPv4N10CutterCore7messageERK7QStringb"><code class="docutils literal notranslate"><span class="pre">message()</span></code></a></li>
11401140
<li class="toctree-l4"><a class="reference internal" href="api/core/classCutterCore.html#_CPPv4N10CutterCore14getSectionListEv"><code class="docutils literal notranslate"><span class="pre">getSectionList()</span></code></a></li>
1141+
<li class="toctree-l4"><a class="reference internal" href="api/core/classCutterCore.html#_CPPv4N10CutterCore4lockEv"><code class="docutils literal notranslate"><span class="pre">lock()</span></code></a></li>
11411142
<li class="toctree-l4"><a class="reference internal" href="api/core/classCutterCore.html#_CPPv4N10CutterCore4coreEv"><code class="docutils literal notranslate"><span class="pre">core()</span></code></a></li>
11421143
<li class="toctree-l4"><a class="reference internal" href="api/core/classCutterCore.html#_CPPv4N10CutterCore16getBBHighlighterEv"><code class="docutils literal notranslate"><span class="pre">getBBHighlighter()</span></code></a></li>
11431144
<li class="toctree-l4"><a class="reference internal" href="api/core/classCutterCore.html#_CPPv4N10CutterCore16getBIHighlighterEv"><code class="docutils literal notranslate"><span class="pre">getBIHighlighter()</span></code></a></li>
@@ -1454,8 +1455,10 @@ <h3>Navigation</h3>
14541455
<li class="toctree-l4"><a class="reference internal" href="api/core/classRzCoreLocked.html#_CPPv4N12RzCoreLockedaSERK12RzCoreLocked"><code class="docutils literal notranslate"><span class="pre">operator=()</span></code></a></li>
14551456
<li class="toctree-l4"><a class="reference internal" href="api/core/classRzCoreLocked.html#_CPPv4N12RzCoreLocked12RzCoreLockedERR12RzCoreLocked"><code class="docutils literal notranslate"><span class="pre">RzCoreLocked()</span></code></a></li>
14561457
<li class="toctree-l4"><a class="reference internal" href="api/core/classRzCoreLocked.html#_CPPv4N12RzCoreLockedD0Ev"><code class="docutils literal notranslate"><span class="pre">~RzCoreLocked()</span></code></a></li>
1457-
<li class="toctree-l4"><a class="reference internal" href="api/core/classRzCoreLocked.html#_CPPv4NK12RzCoreLockedcvP6RzCoreEv"><code class="docutils literal notranslate"><span class="pre">operator</span> <span class="pre">RzCore</span> <span class="pre">*()</span></code></a></li>
1458-
<li class="toctree-l4"><a class="reference internal" href="api/core/classRzCoreLocked.html#_CPPv4NK12RzCoreLockedptEv"><code class="docutils literal notranslate"><span class="pre">operator-&gt;()</span></code></a></li>
1458+
<li class="toctree-l4"><a class="reference internal" href="api/core/classRzCoreLocked.html#_CPPv4NR12RzCoreLockedcvP6RzCoreEv"><code class="docutils literal notranslate"><span class="pre">operator</span> <span class="pre">RzCore</span> <span class="pre">*()</span></code></a></li>
1459+
<li class="toctree-l4"><a class="reference internal" href="api/core/classRzCoreLocked.html#_CPPv4NR12RzCoreLockedptEv"><code class="docutils literal notranslate"><span class="pre">operator-&gt;()</span></code></a></li>
1460+
<li class="toctree-l4"><a class="reference internal" href="api/core/classRzCoreLocked.html#_CPPv4NO12RzCoreLockedcvP6RzCoreEv"><code class="docutils literal notranslate"><span class="pre">operator</span> <span class="pre">RzCore</span> <span class="pre">*()</span></code></a></li>
1461+
<li class="toctree-l4"><a class="reference internal" href="api/core/classRzCoreLocked.html#_CPPv4NO12RzCoreLockedptEv"><code class="docutils literal notranslate"><span class="pre">operator-&gt;()</span></code></a></li>
14591462
</ul>
14601463
</li>
14611464
</ul>

‎docs/api/core/classCutterCore.html‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1849,6 +1849,11 @@ <h1>CutterCore<a class="headerlink" href="#cuttercore" title="Link to this headi
18491849
<span id="_CPPv3N10CutterCore14getSectionListEv"></span><span id="_CPPv2N10CutterCore14getSectionListEv"></span><span id="CutterCore::getSectionList"></span><span class="target" id="classCutterCore_1a413a08d06b4362fc5cac037c77d67f1d"></span><span class="n"><span class="pre">QStringList</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">getSectionList</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N10CutterCore14getSectionListEv" title="Link to this definition"></a><br /></dt>
18501850
<dd></dd></dl>
18511851

1852+
<dl class="cpp function">
1853+
<dt class="sig sig-object cpp" id="_CPPv4N10CutterCore4lockEv">
1854+
<span id="_CPPv3N10CutterCore4lockEv"></span><span id="_CPPv2N10CutterCore4lockEv"></span><span id="CutterCore::lock"></span><span class="target" id="classCutterCore_1ad73d8fb33a503b7777e23022194aff26"></span><a class="reference internal" href="classRzCoreLocked.html#_CPPv412RzCoreLocked" title="RzCoreLocked"><span class="n"><span class="pre">RzCoreLocked</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">lock</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N10CutterCore4lockEv" title="Link to this definition"></a><br /></dt>
1855+
<dd></dd></dl>
1856+
18521857
<dl class="cpp function">
18531858
<dt class="sig sig-object cpp" id="_CPPv4N10CutterCore4coreEv">
18541859
<span id="_CPPv3N10CutterCore4coreEv"></span><span id="_CPPv2N10CutterCore4coreEv"></span><span id="CutterCore::core"></span><span class="target" id="classCutterCore_1a13c3fceccbd9a97ef59e2767abc491c2"></span><a class="reference internal" href="classRzCoreLocked.html#_CPPv412RzCoreLocked" title="RzCoreLocked"><span class="n"><span class="pre">RzCoreLocked</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">core</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N10CutterCore4coreEv" title="Link to this definition"></a><br /></dt>

‎docs/api/core/classRzCoreLocked.html‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,13 +84,23 @@ <h1>RzCoreLocked<a class="headerlink" href="#rzcorelocked" title="Link to this h
8484
<dd></dd></dl>
8585

8686
<dl class="cpp function">
87-
<dt class="sig sig-object cpp" id="_CPPv4NK12RzCoreLockedcvP6RzCoreEv">
88-
<span id="_CPPv3NK12RzCoreLockedcvP6RzCoreEv"></span><span id="_CPPv2NK12RzCoreLockedcvP6RzCoreEv"></span><span id="RzCoreLocked::castto-RzCoreP-operatorC"></span><span class="target" id="classRzCoreLocked_1ae7e43746772aa38f44dba8414ad5a63b"></span><span class="sig-name descname"><span class="k"><span class="pre">operator</span></span><span class="w"> </span><span class="n"><span class="pre">RzCore</span></span><span class="p"><span class="pre">*</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK12RzCoreLockedcvP6RzCoreEv" title="Link to this definition"></a><br /></dt>
87+
<dt class="sig sig-object cpp" id="_CPPv4NR12RzCoreLockedcvP6RzCoreEv">
88+
<span id="_CPPv3NR12RzCoreLockedcvP6RzCoreEv"></span><span id="_CPPv2NR12RzCoreLockedcvP6RzCoreEv"></span><span id="RzCoreLocked::castto-RzCoreP-operatorR"></span><span class="target" id="classRzCoreLocked_1a53da77bc2dff98a47c23198905ee420d"></span><span class="sig-name descname"><span class="k"><span class="pre">operator</span></span><span class="w"> </span><span class="n"><span class="pre">RzCore</span></span><span class="p"><span class="pre">*</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><a class="headerlink" href="#_CPPv4NR12RzCoreLockedcvP6RzCoreEv" title="Link to this definition"></a><br /></dt>
8989
<dd></dd></dl>
9090

9191
<dl class="cpp function">
92-
<dt class="sig sig-object cpp" id="_CPPv4NK12RzCoreLockedptEv">
93-
<span id="_CPPv3NK12RzCoreLockedptEv"></span><span id="_CPPv2NK12RzCoreLockedptEv"></span><span id="RzCoreLocked::pointer-operatorC"></span><span class="target" id="classRzCoreLocked_1ab1532f190fbb5bf575d1a7dc59982736"></span><span class="n"><span class="pre">RzCore</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="k"><span class="pre">operator</span></span><span class="o"><span class="pre">-&gt;</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK12RzCoreLockedptEv" title="Link to this definition"></a><br /></dt>
92+
<dt class="sig sig-object cpp" id="_CPPv4NR12RzCoreLockedptEv">
93+
<span id="_CPPv3NR12RzCoreLockedptEv"></span><span id="_CPPv2NR12RzCoreLockedptEv"></span><span id="RzCoreLocked::pointer-operatorR"></span><span class="target" id="classRzCoreLocked_1a2d30ce2dc8bb60d0945f060a91e65eb4"></span><span class="n"><span class="pre">RzCore</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="k"><span class="pre">operator</span></span><span class="o"><span class="pre">-&gt;</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><a class="headerlink" href="#_CPPv4NR12RzCoreLockedptEv" title="Link to this definition"></a><br /></dt>
94+
<dd></dd></dl>
95+
96+
<dl class="cpp function">
97+
<dt class="sig sig-object cpp" id="_CPPv4NO12RzCoreLockedcvP6RzCoreEv">
98+
<span id="_CPPv3NO12RzCoreLockedcvP6RzCoreEv"></span><span id="_CPPv2NO12RzCoreLockedcvP6RzCoreEv"></span><span id="RzCoreLocked::castto-RzCoreP-operatorO"></span><span class="target" id="classRzCoreLocked_1a5e5d6ef172ae92a1644d2d46799b1acb"></span><span class="sig-name descname"><span class="k"><span class="pre">operator</span></span><span class="w"> </span><span class="n"><span class="pre">RzCore</span></span><span class="p"><span class="pre">*</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">&amp;&amp;</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">delete</span></span><a class="headerlink" href="#_CPPv4NO12RzCoreLockedcvP6RzCoreEv" title="Link to this definition"></a><br /></dt>
99+
<dd></dd></dl>
100+
101+
<dl class="cpp function">
102+
<dt class="sig sig-object cpp" id="_CPPv4NO12RzCoreLockedptEv">
103+
<span id="_CPPv3NO12RzCoreLockedptEv"></span><span id="_CPPv2NO12RzCoreLockedptEv"></span><span id="RzCoreLocked::pointer-operatorO"></span><span class="target" id="classRzCoreLocked_1a9161cf9faa3e4b556a96b26a6b32e19b"></span><span class="n"><span class="pre">RzCore</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="k"><span class="pre">operator</span></span><span class="o"><span class="pre">-&gt;</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">&amp;&amp;</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">delete</span></span><a class="headerlink" href="#_CPPv4NO12RzCoreLockedptEv" title="Link to this definition"></a><br /></dt>
94104
<dd></dd></dl>
95105

96106
</div>

‎docs/api/corelist.html‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -348,6 +348,7 @@ <h1>Core<a class="headerlink" href="#core" title="Link to this heading">¶</a></
348348
<li class="toctree-l3"><a class="reference internal" href="core/classCutterCore.html#_CPPv4N10CutterCore26triggerGraphOptionsChangedEv"><code class="docutils literal notranslate"><span class="pre">triggerGraphOptionsChanged()</span></code></a></li>
349349
<li class="toctree-l3"><a class="reference internal" href="core/classCutterCore.html#_CPPv4N10CutterCore7messageERK7QStringb"><code class="docutils literal notranslate"><span class="pre">message()</span></code></a></li>
350350
<li class="toctree-l3"><a class="reference internal" href="core/classCutterCore.html#_CPPv4N10CutterCore14getSectionListEv"><code class="docutils literal notranslate"><span class="pre">getSectionList()</span></code></a></li>
351+
<li class="toctree-l3"><a class="reference internal" href="core/classCutterCore.html#_CPPv4N10CutterCore4lockEv"><code class="docutils literal notranslate"><span class="pre">lock()</span></code></a></li>
351352
<li class="toctree-l3"><a class="reference internal" href="core/classCutterCore.html#_CPPv4N10CutterCore4coreEv"><code class="docutils literal notranslate"><span class="pre">core()</span></code></a></li>
352353
<li class="toctree-l3"><a class="reference internal" href="core/classCutterCore.html#_CPPv4N10CutterCore16getBBHighlighterEv"><code class="docutils literal notranslate"><span class="pre">getBBHighlighter()</span></code></a></li>
353354
<li class="toctree-l3"><a class="reference internal" href="core/classCutterCore.html#_CPPv4N10CutterCore16getBIHighlighterEv"><code class="docutils literal notranslate"><span class="pre">getBIHighlighter()</span></code></a></li>
@@ -664,8 +665,10 @@ <h1>Core<a class="headerlink" href="#core" title="Link to this heading">¶</a></
664665
<li class="toctree-l3"><a class="reference internal" href="core/classRzCoreLocked.html#_CPPv4N12RzCoreLockedaSERK12RzCoreLocked"><code class="docutils literal notranslate"><span class="pre">operator=()</span></code></a></li>
665666
<li class="toctree-l3"><a class="reference internal" href="core/classRzCoreLocked.html#_CPPv4N12RzCoreLocked12RzCoreLockedERR12RzCoreLocked"><code class="docutils literal notranslate"><span class="pre">RzCoreLocked()</span></code></a></li>
666667
<li class="toctree-l3"><a class="reference internal" href="core/classRzCoreLocked.html#_CPPv4N12RzCoreLockedD0Ev"><code class="docutils literal notranslate"><span class="pre">~RzCoreLocked()</span></code></a></li>
667-
<li class="toctree-l3"><a class="reference internal" href="core/classRzCoreLocked.html#_CPPv4NK12RzCoreLockedcvP6RzCoreEv"><code class="docutils literal notranslate"><span class="pre">operator</span> <span class="pre">RzCore</span> <span class="pre">*()</span></code></a></li>
668-
<li class="toctree-l3"><a class="reference internal" href="core/classRzCoreLocked.html#_CPPv4NK12RzCoreLockedptEv"><code class="docutils literal notranslate"><span class="pre">operator-&gt;()</span></code></a></li>
668+
<li class="toctree-l3"><a class="reference internal" href="core/classRzCoreLocked.html#_CPPv4NR12RzCoreLockedcvP6RzCoreEv"><code class="docutils literal notranslate"><span class="pre">operator</span> <span class="pre">RzCore</span> <span class="pre">*()</span></code></a></li>
669+
<li class="toctree-l3"><a class="reference internal" href="core/classRzCoreLocked.html#_CPPv4NR12RzCoreLockedptEv"><code class="docutils literal notranslate"><span class="pre">operator-&gt;()</span></code></a></li>
670+
<li class="toctree-l3"><a class="reference internal" href="core/classRzCoreLocked.html#_CPPv4NO12RzCoreLockedcvP6RzCoreEv"><code class="docutils literal notranslate"><span class="pre">operator</span> <span class="pre">RzCore</span> <span class="pre">*()</span></code></a></li>
671+
<li class="toctree-l3"><a class="reference internal" href="core/classRzCoreLocked.html#_CPPv4NO12RzCoreLockedptEv"><code class="docutils literal notranslate"><span class="pre">operator-&gt;()</span></code></a></li>
669672
</ul>
670673
</li>
671674
</ul>

‎docs/genindex.html‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1773,10 +1773,10 @@ <h2 id="C">C</h2>
17731773
</li>
17741774
<li><a href="api/core/classCutterCore.html#_CPPv4N10CutterCore9editBytesE3RVARK7QString">CutterCore::editBytes (C++ function)</a>
17751775
</li>
1776-
</ul></td>
1777-
<td style="width: 33%; vertical-align: top;"><ul>
17781776
<li><a href="api/core/classCutterCore.html#_CPPv4N10CutterCore15editBytesEndianE3RVARK7QString">CutterCore::editBytesEndian (C++ function)</a>
17791777
</li>
1778+
</ul></td>
1779+
<td style="width: 33%; vertical-align: top;"><ul>
17801780
<li><a href="api/core/classCutterCore.html#_CPPv4N10CutterCore15editInstructionE3RVARK7QStringb">CutterCore::editInstruction (C++ function)</a>
17811781
</li>
17821782
<li><a href="api/core/classCutterCore.html#_CPPv4N10CutterCore16enableBreakpointE3RVA">CutterCore::enableBreakpoint (C++ function)</a>
@@ -2064,6 +2064,8 @@ <h2 id="C">C</h2>
20642064
<li><a href="api/core/classCutterCore.html#_CPPv4N10CutterCore7loadPDBERK7QString">CutterCore::loadPDB (C++ function)</a>
20652065
</li>
20662066
<li><a href="api/core/classCutterCore.html#_CPPv4N10CutterCore10loadScriptERK7QString">CutterCore::loadScript (C++ function)</a>
2067+
</li>
2068+
<li><a href="api/core/classCutterCore.html#_CPPv4N10CutterCore4lockEv">CutterCore::lock (C++ function)</a>
20672069
</li>
20682070
<li><a href="api/core/classCutterCore.html#_CPPv4N10CutterCore7mapFileE7QString3RVA">CutterCore::mapFile (C++ function)</a>
20692071
</li>
@@ -5303,9 +5305,9 @@ <h2 id="R">R</h2>
53035305
</li>
53045306
<li><a href="api/core/classRzCoreLocked.html#_CPPv412RzCoreLocked">RzCoreLocked (C++ class)</a>
53055307
</li>
5306-
<li><a href="api/core/classRzCoreLocked.html#_CPPv4NK12RzCoreLockedcvP6RzCoreEv">RzCoreLocked::operator RzCore* (C++ function)</a>
5308+
<li><a href="api/core/classRzCoreLocked.html#_CPPv4NO12RzCoreLockedcvP6RzCoreEv">RzCoreLocked::operator RzCore* (C++ function)</a>, <a href="api/core/classRzCoreLocked.html#_CPPv4NR12RzCoreLockedcvP6RzCoreEv">[1]</a>
53075309
</li>
5308-
<li><a href="api/core/classRzCoreLocked.html#_CPPv4NK12RzCoreLockedptEv">RzCoreLocked::operator-&gt; (C++ function)</a>
5310+
<li><a href="api/core/classRzCoreLocked.html#_CPPv4NO12RzCoreLockedptEv">RzCoreLocked::operator-&gt; (C++ function)</a>, <a href="api/core/classRzCoreLocked.html#_CPPv4NR12RzCoreLockedptEv">[1]</a>
53095311
</li>
53105312
<li><a href="api/core/classRzCoreLocked.html#_CPPv4N12RzCoreLockedaSERK12RzCoreLocked">RzCoreLocked::operator= (C++ function)</a>
53115313
</li>

‎docs/objects.inv‎

91 Bytes
Binary file not shown.

‎docs/searchindex.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)