Files
pardeike-Harmony/docs/api/Harmony.DynamicTools.html
T

366 lines
16 KiB
HTML

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class DynamicTools
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class DynamicTools
">
<meta name="generator" content="docfx 2.40.7.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="Harmony.DynamicTools">
<h1 id="Harmony_DynamicTools" data-uid="Harmony.DynamicTools" class="text-break">Class DynamicTools
</h1>
<div class="markdown level0 summary"><p>Creating dynamic methods</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">DynamicTools</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Harmony.html">Harmony</a></h6>
<h6><strong>Assembly</strong>: 0Harmony.dll</h6>
<h5 id="Harmony_DynamicTools_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static class DynamicTools</code></pre>
</div>
<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=Harmony_DynamicTools_CreateDynamicMethod_System_Reflection_MethodBase_System_String_.md&amp;value=---%0Auid%3A%20Harmony.DynamicTools.CreateDynamicMethod(System.Reflection.MethodBase%2CSystem.String)%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/Tools/DynamicTools.cs/#L17">View Source</a>
</span>
<a id="Harmony_DynamicTools_CreateDynamicMethod_" data-uid="Harmony.DynamicTools.CreateDynamicMethod*"></a>
<h4 id="Harmony_DynamicTools_CreateDynamicMethod_System_Reflection_MethodBase_System_String_" data-uid="Harmony.DynamicTools.CreateDynamicMethod(System.Reflection.MethodBase,System.String)">CreateDynamicMethod(MethodBase, String)</h4>
<div class="markdown level1 summary"><p>Creates a new dynamic method based on the signature of an existing method</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static DynamicMethod CreateDynamicMethod(MethodBase original, string suffix)</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.Reflection.MethodBase</span></td>
<td><span class="parametername">original</span></td>
<td><p>The original method</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">suffix</span></td>
<td><p>A suffix for the new method name</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><span class="xref">System.Reflection.Emit.DynamicMethod</span></td>
<td><p>The new and so far empty dynamic method, ready to be implemented</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=Harmony_DynamicTools_DeclareLocalVariable_System_Reflection_Emit_ILGenerator_System_Type_.md&amp;value=---%0Auid%3A%20Harmony.DynamicTools.DeclareLocalVariable(System.Reflection.Emit.ILGenerator%2CSystem.Type)%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/Tools/DynamicTools.cs/#L93">View Source</a>
</span>
<a id="Harmony_DynamicTools_DeclareLocalVariable_" data-uid="Harmony.DynamicTools.DeclareLocalVariable*"></a>
<h4 id="Harmony_DynamicTools_DeclareLocalVariable_System_Reflection_Emit_ILGenerator_System_Type_" data-uid="Harmony.DynamicTools.DeclareLocalVariable(System.Reflection.Emit.ILGenerator,System.Type)">DeclareLocalVariable(ILGenerator, Type)</h4>
<div class="markdown level1 summary"><p>Creates a local variable</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static LocalBuilder DeclareLocalVariable(ILGenerator generator, Type type)</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.Reflection.Emit.ILGenerator</span></td>
<td><span class="parametername">generator</span></td>
<td><p>A IL generator to generate the variable with</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Type</span></td>
<td><span class="parametername">type</span></td>
<td><p>The variable type</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><span class="xref">System.Reflection.Emit.LocalBuilder</span></td>
<td><p>A LocalBuilder representing the new variable</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=Harmony_DynamicTools_DeclareLocalVariables_System_Reflection_MethodBase_System_Reflection_Emit_ILGenerator_System_Boolean_.md&amp;value=---%0Auid%3A%20Harmony.DynamicTools.DeclareLocalVariables(System.Reflection.MethodBase%2CSystem.Reflection.Emit.ILGenerator%2CSystem.Boolean)%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/Tools/DynamicTools.cs/#L74">View Source</a>
</span>
<a id="Harmony_DynamicTools_DeclareLocalVariables_" data-uid="Harmony.DynamicTools.DeclareLocalVariables*"></a>
<h4 id="Harmony_DynamicTools_DeclareLocalVariables_System_Reflection_MethodBase_System_Reflection_Emit_ILGenerator_System_Boolean_" data-uid="Harmony.DynamicTools.DeclareLocalVariables(System.Reflection.MethodBase,System.Reflection.Emit.ILGenerator,System.Boolean)">DeclareLocalVariables(MethodBase, ILGenerator, Boolean)</h4>
<div class="markdown level1 summary"><p>Creates local variables by copying them from an original method</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static LocalBuilder[] DeclareLocalVariables(MethodBase original, ILGenerator generator, bool logOutput = true)</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.Reflection.MethodBase</span></td>
<td><span class="parametername">original</span></td>
<td><p>The original method</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Reflection.Emit.ILGenerator</span></td>
<td><span class="parametername">generator</span></td>
<td><p>A IL generator to generate the variables with</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">logOutput</span></td>
<td><p>Set to true to log the actions to the debug log</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><span class="xref">System.Reflection.Emit.LocalBuilder</span>[]</td>
<td><p>An array of newly defined variables, each represented by a LocalBuilder</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=Harmony_DynamicTools_PrepareDynamicMethod_System_Reflection_Emit_DynamicMethod_.md&amp;value=---%0Auid%3A%20Harmony.DynamicTools.PrepareDynamicMethod(System.Reflection.Emit.DynamicMethod)%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/Tools/DynamicTools.cs/#L134">View Source</a>
</span>
<a id="Harmony_DynamicTools_PrepareDynamicMethod_" data-uid="Harmony.DynamicTools.PrepareDynamicMethod*"></a>
<h4 id="Harmony_DynamicTools_PrepareDynamicMethod_System_Reflection_Emit_DynamicMethod_" data-uid="Harmony.DynamicTools.PrepareDynamicMethod(System.Reflection.Emit.DynamicMethod)">PrepareDynamicMethod(DynamicMethod)</h4>
<div class="markdown level1 summary"><p>Prepares a dynamic method so it is jitted</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void PrepareDynamicMethod(DynamicMethod method)</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.Reflection.Emit.DynamicMethod</span></td>
<td><span class="parametername">method</span></td>
<td><p>The dynamic method</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=Harmony_DynamicTools.md&amp;value=---%0Auid%3A%20Harmony.DynamicTools%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/Tools/DynamicTools.cs/#L10" 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>