Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Describe "^instruction" in documentation #7049

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Describe "^instruction" in documentation #7049

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions GhidraDocs/languages/html/sleigh_constructors.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,20 @@
an operand. An initial ‘^’ character can also facilitate certain
recursive constructions.
</p>
<div class="informalexample"><pre class="programlisting">
:^instruction is <span class="weak">...</span>
</pre></div>
<p>
</p>
<p>
In the example above, the ‘^’ character is prepended to the reserved
<span class="emphasis"><em>instruction</em></span> identifier to create
a “pure recursive” constructor. Constructors of this form are often employed
to perform generic actions for multiple instructions (such as handling instruction prefixes).
These constructors must be designed with care, as infinite recursion is possible with improper constraints
(see <a class="xref" href="sleigh_constructors.html#sleigh_constraints" title="7.4.1. Constraints">Section 7.4.1, “Constraints”</a> and
<a class="xref" href="sleigh_tokens.html#sleigh_context_variables" title="6.4. Context Variables">Section 6.4, “Context Variables”</a>).
</p>
</div>
</div>
<div class="sect2">
Expand Down