admin/pardeike-Harmony
1
0
Fork 0
mirror of https://github.com/pardeike/Harmony synced 2026-06-08 16:40:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
08b830aea8fee6c06cba612776ef64e5e023e365
pardeike-Harmony/docs/api/HarmonyLib.CodeInstruction.html
T
pardeike-bot 012b552808 Update documentation
2019-05-01 14:05:29 +00:00

496 lines
22 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class CodeInstruction
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class CodeInstruction
">
<meta name="generator" content="docfx 2.42.0.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="HarmonyLib.CodeInstruction">
<h1 id="HarmonyLib_CodeInstruction" data-uid="HarmonyLib.CodeInstruction" class="text-break">Class CodeInstruction
</h1>
<div class="markdown level0 summary"><p>An abstract wrapper around OpCode and their operands. Used by transpilers</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">CodeInstruction</span></div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="HarmonyLib.html">HarmonyLib</a></h6>
<h6><strong>Assembly</strong>: 0Harmony.dll</h6>
<h5 id="HarmonyLib_CodeInstruction_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class CodeInstruction : object</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeInstruction__ctor_HarmonyLib_CodeInstruction_.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeInstruction.%23ctor(HarmonyLib.CodeInstruction)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/CodeInstruction.cs/#L32">View Source</a>
</span>
<a id="HarmonyLib_CodeInstruction__ctor_" data-uid="HarmonyLib.CodeInstruction.#ctor*"></a>
<h4 id="HarmonyLib_CodeInstruction__ctor_HarmonyLib_CodeInstruction_" data-uid="HarmonyLib.CodeInstruction.#ctor(HarmonyLib.CodeInstruction)">CodeInstruction(CodeInstruction)</h4>
<div class="markdown level1 summary"><p>Create a full copy (including labels and exception blocks) of a CodeInstruction</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CodeInstruction(CodeInstruction instruction)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="HarmonyLib.CodeInstruction.html">CodeInstruction</a></td>
<td><span class="parametername">instruction</span></td>
<td><p>The instruction to copy</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeInstruction__ctor_OpCode_System_Object_.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeInstruction.%23ctor(OpCode%2CSystem.Object)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/CodeInstruction.cs/#L23">View Source</a>
</span>
<a id="HarmonyLib_CodeInstruction__ctor_" data-uid="HarmonyLib.CodeInstruction.#ctor*"></a>
<h4 id="HarmonyLib_CodeInstruction__ctor_OpCode_System_Object_" data-uid="HarmonyLib.CodeInstruction.#ctor(OpCode,System.Object)">CodeInstruction(OpCode, Object)</h4>
<div class="markdown level1 summary"><p>Creates a new CodeInstruction with a given opcode and optional operand</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CodeInstruction(OpCode opcode, object operand = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">OpCode</span></td>
<td><span class="parametername">opcode</span></td>
<td><p>The code</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Object</span></td>
<td><span class="parametername">operand</span></td>
<td><p>The operand</p>
</td>
</tr>
</tbody>
</table>
<h3 id="fields">Fields
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeInstruction_blocks.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeInstruction.blocks%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/CodeInstruction.cs/#L17">View Source</a>
</span>
<h4 id="HarmonyLib_CodeInstruction_blocks" data-uid="HarmonyLib.CodeInstruction.blocks">blocks</h4>
<div class="markdown level1 summary"><p>All exception block boundaries defined on this instruction</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;ExceptionBlock&gt; blocks</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">List</span>&lt;<a class="xref" href="HarmonyLib.ExceptionBlock.html">ExceptionBlock</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeInstruction_labels.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeInstruction.labels%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/CodeInstruction.cs/#L15">View Source</a>
</span>
<h4 id="HarmonyLib_CodeInstruction_labels" data-uid="HarmonyLib.CodeInstruction.labels">labels</h4>
<div class="markdown level1 summary"><p>All labels defined on this instruction</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;Label&gt; labels</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">List</span>&lt;<span class="xref">Label</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeInstruction_opcode.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeInstruction.opcode%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/CodeInstruction.cs/#L11">View Source</a>
</span>
<h4 id="HarmonyLib_CodeInstruction_opcode" data-uid="HarmonyLib.CodeInstruction.opcode">opcode</h4>
<div class="markdown level1 summary"><p>The opcode</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public OpCode opcode</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">OpCode</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeInstruction_operand.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeInstruction.operand%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/CodeInstruction.cs/#L13">View Source</a>
</span>
<h4 id="HarmonyLib_CodeInstruction_operand" data-uid="HarmonyLib.CodeInstruction.operand">operand</h4>
<div class="markdown level1 summary"><p>The operand</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public object operand</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Object</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeInstruction_Clone.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeInstruction.Clone%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/CodeInstruction.cs/#L43">View Source</a>
</span>
<a id="HarmonyLib_CodeInstruction_Clone_" data-uid="HarmonyLib.CodeInstruction.Clone*"></a>
<h4 id="HarmonyLib_CodeInstruction_Clone" data-uid="HarmonyLib.CodeInstruction.Clone">Clone()</h4>
<div class="markdown level1 summary"><p>Clones a CodeInstruction and resets its labels and exception blocks</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CodeInstruction Clone()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="HarmonyLib.CodeInstruction.html">CodeInstruction</a></td>
<td><p>A lightweight copy of this code instruction</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeInstruction_Clone_OpCode_.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeInstruction.Clone(OpCode)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/CodeInstruction.cs/#L56">View Source</a>
</span>
<a id="HarmonyLib_CodeInstruction_Clone_" data-uid="HarmonyLib.CodeInstruction.Clone*"></a>
<h4 id="HarmonyLib_CodeInstruction_Clone_OpCode_" data-uid="HarmonyLib.CodeInstruction.Clone(OpCode)">Clone(OpCode)</h4>
<div class="markdown level1 summary"><p>Clones a CodeInstruction, resets labels and exception blocks and sets its opcode</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CodeInstruction Clone(OpCode opcode)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">OpCode</span></td>
<td><span class="parametername">opcode</span></td>
<td><p>The opcode</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="HarmonyLib.CodeInstruction.html">CodeInstruction</a></td>
<td><p>A copy of this CodeInstruction with a new opcode</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeInstruction_Clone_System_Object_.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeInstruction.Clone(System.Object)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/CodeInstruction.cs/#L67">View Source</a>
</span>
<a id="HarmonyLib_CodeInstruction_Clone_" data-uid="HarmonyLib.CodeInstruction.Clone*"></a>
<h4 id="HarmonyLib_CodeInstruction_Clone_System_Object_" data-uid="HarmonyLib.CodeInstruction.Clone(System.Object)">Clone(Object)</h4>
<div class="markdown level1 summary"><p>Clones a CodeInstruction, resets labels and exception blocks and sets its operand</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CodeInstruction Clone(object operand)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Object</span></td>
<td><span class="parametername">operand</span></td>
<td><p>The opcode</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="HarmonyLib.CodeInstruction.html">CodeInstruction</a></td>
<td><p>A copy of this CodeInstruction with a new operand</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeInstruction_ToString.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeInstruction.ToString%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/CodeInstruction.cs/#L77">View Source</a>
</span>
<a id="HarmonyLib_CodeInstruction_ToString_" data-uid="HarmonyLib.CodeInstruction.ToString*"></a>
<h4 id="HarmonyLib_CodeInstruction_ToString" data-uid="HarmonyLib.CodeInstruction.ToString">ToString()</h4>
<div class="markdown level1 summary"><p>Returns a string representation of the code instruction</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><p>A string representation of the code instruction</p>
</td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeInstruction.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeInstruction%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/CodeInstruction.cs/#L8" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink