Class CodeMatch

A CodeInstruction match

Inheritance
System.Object
CodeInstruction
CodeMatch
Inherited Members
Namespace: HarmonyLib
Assembly: 0Harmony.dll
Syntax
public class CodeMatch : CodeInstruction

Constructors

| Improve this Doc View Source

CodeMatch(CodeInstruction, String)

Creates a code match

Declaration
public CodeMatch(CodeInstruction instruction, string name = null)
Parameters
Type Name Description
CodeInstruction instruction

The CodeInstruction
System.String name

An optional name
| Improve this Doc View Source

CodeMatch(Func<CodeInstruction, Boolean>, String)

Creates a code match

Declaration
public CodeMatch(Func<CodeInstruction, bool> predicate, string name = null)
Parameters
Type Name Description
System.Func<CodeInstruction, System.Boolean> predicate

The predicate
System.String name

An optional name
| Improve this Doc View Source

CodeMatch(Expression<Action>, String)

Creates a code match that calls a method

Declaration
public CodeMatch(Expression<Action> expression, string name = null)
Parameters
Type Name Description
System.Linq.Expressions.Expression<System.Action> expression

The lambda expression using the method
System.String name

The optional name
| Improve this Doc View Source

CodeMatch(LambdaExpression, String)

Creates a code match that calls a method

Declaration
public CodeMatch(LambdaExpression expression, string name = null)
Parameters
Type Name Description
System.Linq.Expressions.LambdaExpression expression

The lambda expression using the method
System.String name

The optional name
| Improve this Doc View Source

CodeMatch(Nullable<OpCode>, Object, String)

Creates a code match

Declaration
public CodeMatch(OpCode? opcode = null, object operand = null, string name = null)
Parameters
Type Name Description
System.Nullable<System.Reflection.Emit.OpCode> opcode

The optional opcode
System.Object operand

The optional operand
System.String name

The optional name

Fields

| Improve this Doc View Source

jumpsFrom

The jumps from the match

Declaration
public List<int> jumpsFrom
Field Value
Type Description
System.Collections.Generic.List<System.Int32>
| Improve this Doc View Source

jumpsTo

The jumps to the match

Declaration
public List<int> jumpsTo
Field Value
Type Description
System.Collections.Generic.List<System.Int32>
| Improve this Doc View Source

name

The name of the match

Declaration
public string name
Field Value
Type Description
System.String
| Improve this Doc View Source

opcodeSet

The matched opcodes

Declaration
public HashSet<OpCode> opcodeSet
Field Value
Type Description
System.Collections.Generic.HashSet<System.Reflection.Emit.OpCode>
| Improve this Doc View Source

operands

The matched operands

Declaration
public List<object> operands
Field Value
Type Description
System.Collections.Generic.List<System.Object>
| Improve this Doc View Source

predicate

The match predicate

Declaration
public Func<CodeInstruction, bool> predicate
Field Value
Type Description
System.Func<CodeInstruction, System.Boolean>

Properties

| Improve this Doc View Source

opcodes

The matched opcodes

Declaration
[Obsolete("Use opcodeSet instead")]
public List<OpCode> opcodes { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.Reflection.Emit.OpCode>

Methods

| Improve this Doc View Source

Branches(String)

Creates a code match for branching

Declaration
public static CodeMatch Branches(string name = null)
Parameters
Type Name Description
System.String name

An optional name
Returns
Type Description
CodeMatch

A new code match
| Improve this Doc View Source

Calls(Expression<Action>)

Creates a code match that calls a method

Declaration
public static CodeMatch Calls(Expression<Action> expression)
Parameters
Type Name Description
System.Linq.Expressions.Expression<System.Action> expression

The lambda expression using the method
Returns
Type Description
CodeMatch

A new code match
| Improve this Doc View Source

Calls(LambdaExpression)

Creates a code match that calls a method

Declaration
public static CodeMatch Calls(LambdaExpression expression)
Parameters
Type Name Description
System.Linq.Expressions.LambdaExpression expression

The lambda expression using the method
Returns
Type Description
CodeMatch

A new code match
| Improve this Doc View Source

Calls(MethodInfo)

Tests if the code instruction calls the method/constructor

Declaration
public static CodeMatch Calls(MethodInfo method)
Parameters
Type Name Description
System.Reflection.MethodInfo method

The method
Returns
Type Description
CodeMatch

A new code match
| Improve this Doc View Source

IsLdarg(Nullable<Int32>)

Tests for any form of Ldarg*

Declaration
public static CodeMatch IsLdarg(int? n = null)
Parameters
Type Name Description
System.Nullable<System.Int32> n

The (optional) index
Returns
Type Description
CodeMatch

A new code match
| Improve this Doc View Source

IsLdarga(Nullable<Int32>)

Tests for Ldarga/Ldarga_S

Declaration
public static CodeMatch IsLdarga(int? n = null)
Parameters
Type Name Description
System.Nullable<System.Int32> n

The (optional) index
Returns
Type Description
CodeMatch

A new code match
| Improve this Doc View Source

IsLdloc(LocalBuilder)

Tests for any form of Ldloc*

Declaration
public static CodeMatch IsLdloc(LocalBuilder variable = null)
Parameters
Type Name Description
System.Reflection.Emit.LocalBuilder variable

The optional local variable
Returns
Type Description
CodeMatch

A new code match
| Improve this Doc View Source

IsStarg(Nullable<Int32>)

Tests for Starg/Starg_S

Declaration
public static CodeMatch IsStarg(int? n = null)
Parameters
Type Name Description
System.Nullable<System.Int32> n

The (optional) index
Returns
Type Description
CodeMatch

A new code match
| Improve this Doc View Source

IsStloc(LocalBuilder)

Tests for any form of Stloc*

Declaration
public static CodeMatch IsStloc(LocalBuilder variable = null)
Parameters
Type Name Description
System.Reflection.Emit.LocalBuilder variable

The optional local variable
Returns
Type Description
CodeMatch

A new code match
| Improve this Doc View Source

LoadsArgument(Boolean, String)

Creates a code match for argument loads

Declaration
public static CodeMatch LoadsArgument(bool useAddress = false, string name = null)
Parameters
Type Name Description
System.Boolean useAddress

Whether to match for address loads
System.String name

An optional name
Returns
Type Description
CodeMatch

A new code match
| Improve this Doc View Source

LoadsConstant()

Tests if the code instruction loads a constant

Declaration
public static CodeMatch LoadsConstant()
Returns
Type Description
CodeMatch

A new code match
| Improve this Doc View Source

LoadsConstant(Double)

Tests if the code instruction loads a floating point constant

Declaration
public static CodeMatch LoadsConstant(double number)
Parameters
Type Name Description
System.Double number

The floating point constant
Returns
Type Description
CodeMatch

A new code match
| Improve this Doc View Source

LoadsConstant(Enum)

Tests if the code instruction loads an enum constant

Declaration
public static CodeMatch LoadsConstant(Enum e)
Parameters
Type Name Description
System.Enum e

The enum
Returns
Type Description
CodeMatch

A new code match
| Improve this Doc View Source

LoadsConstant(Int64)

Tests if the code instruction loads an integer constant

Declaration
public static CodeMatch LoadsConstant(long number)
Parameters
Type Name Description
System.Int64 number

The integer constant
Returns
Type Description
CodeMatch

A new code match
| Improve this Doc View Source

LoadsConstant(String)

Tests if the code instruction loads a string constant

Declaration
public static CodeMatch LoadsConstant(string str)
Parameters
Type Name Description
System.String str

The string
Returns
Type Description
CodeMatch

A new code match
| Improve this Doc View Source

LoadsField(FieldInfo, Boolean)

Tests if the code instruction loads a field

Declaration
public static CodeMatch LoadsField(FieldInfo field, bool byAddress = false)
Parameters
Type Name Description
System.Reflection.FieldInfo field

The field
System.Boolean byAddress

Set to true if the address of the field is loaded
Returns
Type Description
CodeMatch

A new code match
| Improve this Doc View Source

LoadsLocal(Boolean, String)

Creates a code match for local loads

Declaration
public static CodeMatch LoadsLocal(bool useAddress = false, string name = null)
Parameters
Type Name Description
System.Boolean useAddress

Whether to match for address loads
System.String name

An optional name
Returns
Type Description
CodeMatch

A new code match
| Improve this Doc View Source

StoresArgument(String)

Creates a code match for argument stores

Declaration
public static CodeMatch StoresArgument(string name = null)
Parameters
Type Name Description
System.String name

An optional name
Returns
Type Description
CodeMatch

A new code match
| Improve this Doc View Source

StoresField(FieldInfo)

Tests if the code instruction stores a field

Declaration
public static CodeMatch StoresField(FieldInfo field)
Parameters
Type Name Description
System.Reflection.FieldInfo field

The field
Returns
Type Description
CodeMatch

A new code match
| Improve this Doc View Source

StoresLocal(String)

Creates a code match for local stores

Declaration
public static CodeMatch StoresLocal(string name = null)
Parameters
Type Name Description
System.String name

An optional name
Returns
Type Description
CodeMatch

A new code match
| Improve this Doc View Source

ToString()

Returns a string that represents the match

Declaration
public override string ToString()
Returns
Type Description
System.String

A string representation
Overrides
| Improve this Doc View Source

WithOpcodes(HashSet<OpCode>, Object, String)

Creates a code match

Declaration
public static CodeMatch WithOpcodes(HashSet<OpCode> opcodes, object operand = null, string name = null)
Parameters
Type Name Description
System.Collections.Generic.HashSet<System.Reflection.Emit.OpCode> opcodes

The opcodes
System.Object operand

The optional operand
System.String name

The optional name
Returns
Type Description
CodeMatch

Extension Methods