ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-12 10:17:22 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

refactor(SignatureAttribute): Fields => Properties

Browse source
This commit is contained in:
goat 2022-01-26 03:57:59 +01:00
parent 4dc0096ff3
commit ff362f113e
No known key found for this signature in database
GPG key ID: 7773BB5B43BA52E5
1 changed files with 45 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

90
Dalamud/Utility/Signatures/SignatureAttribute.cs
View file

@ -11,53 +11,9 @@ namespace Dalamud.Utility.Signatures
/// </summary>
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
[MeansImplicitUse(ImplicitUseKindFlags.Assign, ImplicitUseTargetFlags.Itself)]
// ReSharper disable once ClassNeverInstantiated.Global
// ReSharper disable once ClassNeverInstantiated.Global
public sealed class SignatureAttribute : Attribute
{
/// <summary>
/// The memory signature for this field/property.
/// </summary>
public readonly string Signature;
/// <summary>
/// The way this signature should be used. By default, this is guessed using
/// simple heuristics, but it can be manually specified if SignatureHelper can't
/// figure it out.
///
/// <seealso cref="SignatureUseFlags"/>
/// </summary>
public SignatureUseFlags UseFlags = SignatureUseFlags.Auto;
/// <summary>
/// The type of scan to perform. By default, this scans the text section of
/// the executable, but this should be set to StaticAddress for static
/// addresses.
/// </summary>
public ScanType ScanType = ScanType.Text;
/// <summary>
/// The detour name if this signature is for a hook. SignatureHelper will search
/// the type containing this field/property for a method that matches the
/// hook's delegate type, but if it doesn't find one or finds more than one,
/// it will fail. You can specify the name of the method here to avoid this.
/// </summary>
public string? DetourName;
/// <summary>
/// When <see cref="UseFlags"/> is set to Offset, this is the offset from
/// the signature to read memory from.
/// </summary>
public int Offset;
/// <summary>
/// When a signature is fallible, any errors while resolving it will be
/// logged in the Dalamud log and the field/property will not have its value
/// set. When a signature is not fallible, any errors will be thrown as
/// exceptions instead. If fallibility is not specified, it is inferred
/// based on if the field/property is nullable.
/// </summary>
public Fallibility Fallibility = Fallibility.Auto;
/// <summary>
/// Initializes a new instance of the <see cref="SignatureAttribute"/> class.
/// </summary>
@ -66,5 +22,49 @@ namespace Dalamud.Utility.Signatures
{
this.Signature = signature;
}
/// <summary>
/// Gets the memory signature for this field/property.
/// </summary>
public string Signature { get; init; }
/// <summary>
/// Gets the way this signature should be used. By default, this is guessed using
/// simple heuristics, but it can be manually specified if SignatureHelper can't
/// figure it out.
///
/// <seealso cref="SignatureUseFlags"/>
/// </summary>
public SignatureUseFlags UseFlags { get; init; } = SignatureUseFlags.Auto;
/// <summary>
/// Gets the type of scan to perform. By default, this scans the text section of
/// the executable, but this should be set to StaticAddress for static
/// addresses.
/// </summary>
public ScanType ScanType { get; init; } = ScanType.Text;
/// <summary>
/// Gets the detour name if this signature is for a hook. SignatureHelper will search
/// the type containing this field/property for a method that matches the
/// hook's delegate type, but if it doesn't find one or finds more than one,
/// it will fail. You can specify the name of the method here to avoid this.
/// </summary>
public string? DetourName { get; init; }
/// <summary>
/// Gets the offset from the signature to read memory from, when <see cref="UseFlags"/> is set to Offset.
/// </summary>
public int Offset { get; init; }
/// <summary>
/// Gets the fallibility of the signature.
/// When a signature is fallible, any errors while resolving it will be
/// logged in the Dalamud log and the field/property will not have its value
/// set. When a signature is not fallible, any errors will be thrown as
/// exceptions instead. If fallibility is not specified, it is inferred
/// based on if the field/property is nullable.
/// </summary>
public Fallibility Fallibility { get; init; } = Fallibility.Auto;
}
}