obfuz/Plugins/dnlib/DotNet/ParamDef.cs

420 lines
12 KiB
C#
Raw Normal View History

2025-04-08 20:31:44 +08:00
// dnlib: See LICENSE.txt for more info
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Threading;
using dnlib.DotNet.MD;
using dnlib.DotNet.Pdb;
using dnlib.Threading;
namespace dnlib.DotNet {
/// <summary>
/// A high-level representation of a row in the Param table
/// </summary>
[DebuggerDisplay("{Sequence} {Name}")]
public abstract class ParamDef : IHasConstant, IHasCustomAttribute, IHasFieldMarshal, IHasCustomDebugInformation {
/// <summary>
/// The row id in its table
/// </summary>
protected uint rid;
#if THREAD_SAFE
readonly Lock theLock = Lock.Create();
#endif
/// <inheritdoc/>
public MDToken MDToken => new MDToken(Table.Param, rid);
/// <inheritdoc/>
public uint Rid {
get => rid;
set => rid = value;
}
/// <inheritdoc/>
public int HasConstantTag => 1;
/// <inheritdoc/>
public int HasCustomAttributeTag => 4;
/// <inheritdoc/>
public int HasFieldMarshalTag => 1;
/// <summary>
/// Gets the declaring method
/// </summary>
public MethodDef DeclaringMethod {
get => declaringMethod;
internal set => declaringMethod = value;
}
/// <summary/>
protected MethodDef declaringMethod;
/// <summary>
/// From column Param.Flags
/// </summary>
public ParamAttributes Attributes {
get => (ParamAttributes)attributes;
set => attributes = (int)value;
}
/// <summary>Attributes</summary>
protected int attributes;
/// <summary>
/// From column Param.Sequence
/// </summary>
public ushort Sequence {
get => sequence;
set => sequence = value;
}
/// <summary/>
protected ushort sequence;
/// <summary>
/// From column Param.Name
/// </summary>
public UTF8String Name {
get => name;
set => name = value;
}
/// <summary>Name</summary>
protected UTF8String name;
/// <inheritdoc/>
public MarshalType MarshalType {
get {
if (!marshalType_isInitialized)
InitializeMarshalType();
return marshalType;
}
set {
#if THREAD_SAFE
theLock.EnterWriteLock(); try {
#endif
marshalType = value;
marshalType_isInitialized = true;
#if THREAD_SAFE
} finally { theLock.ExitWriteLock(); }
#endif
}
}
/// <summary/>
protected MarshalType marshalType;
/// <summary/>
protected bool marshalType_isInitialized;
void InitializeMarshalType() {
#if THREAD_SAFE
theLock.EnterWriteLock(); try {
#endif
if (marshalType_isInitialized)
return;
marshalType = GetMarshalType_NoLock();
marshalType_isInitialized = true;
#if THREAD_SAFE
} finally { theLock.ExitWriteLock(); }
#endif
}
/// <summary>Called to initialize <see cref="marshalType"/></summary>
protected virtual MarshalType GetMarshalType_NoLock() => null;
/// <summary>Reset <see cref="MarshalType"/></summary>
protected void ResetMarshalType() => marshalType_isInitialized = false;
/// <inheritdoc/>
public Constant Constant {
get {
if (!constant_isInitialized)
InitializeConstant();
return constant;
}
set {
#if THREAD_SAFE
theLock.EnterWriteLock(); try {
#endif
constant = value;
constant_isInitialized = true;
#if THREAD_SAFE
} finally { theLock.ExitWriteLock(); }
#endif
}
}
/// <summary/>
protected Constant constant;
/// <summary/>
protected bool constant_isInitialized;
void InitializeConstant() {
#if THREAD_SAFE
theLock.EnterWriteLock(); try {
#endif
if (constant_isInitialized)
return;
constant = GetConstant_NoLock();
constant_isInitialized = true;
#if THREAD_SAFE
} finally { theLock.ExitWriteLock(); }
#endif
}
/// <summary>Called to initialize <see cref="constant"/></summary>
protected virtual Constant GetConstant_NoLock() => null;
/// <summary>Reset <see cref="Constant"/></summary>
protected void ResetConstant() => constant_isInitialized = false;
/// <summary>
/// Gets all custom attributes
/// </summary>
public CustomAttributeCollection CustomAttributes {
get {
if (customAttributes is null)
InitializeCustomAttributes();
return customAttributes;
}
}
/// <summary/>
protected CustomAttributeCollection customAttributes;
/// <summary>Initializes <see cref="customAttributes"/></summary>
protected virtual void InitializeCustomAttributes() =>
Interlocked.CompareExchange(ref customAttributes, new CustomAttributeCollection(), null);
/// <inheritdoc/>
public bool HasCustomAttributes => CustomAttributes.Count > 0;
/// <inheritdoc/>
public int HasCustomDebugInformationTag => 4;
/// <inheritdoc/>
public bool HasCustomDebugInfos => CustomDebugInfos.Count > 0;
/// <summary>
/// Gets all custom debug infos
/// </summary>
public IList<PdbCustomDebugInfo> CustomDebugInfos {
get {
if (customDebugInfos is null)
InitializeCustomDebugInfos();
return customDebugInfos;
}
}
/// <summary/>
protected IList<PdbCustomDebugInfo> customDebugInfos;
/// <summary>Initializes <see cref="customDebugInfos"/></summary>
protected virtual void InitializeCustomDebugInfos() =>
Interlocked.CompareExchange(ref customDebugInfos, new List<PdbCustomDebugInfo>(), null);
/// <summary>
/// <c>true</c> if <see cref="Constant"/> is not <c>null</c>
/// </summary>
public bool HasConstant => Constant is not null;
/// <summary>
/// Gets the constant element type or <see cref="dnlib.DotNet.ElementType.End"/> if there's no constant
/// </summary>
public ElementType ElementType {
get {
var c = Constant;
return c is null ? ElementType.End : c.Type;
}
}
/// <summary>
/// <c>true</c> if <see cref="MarshalType"/> is not <c>null</c>
/// </summary>
public bool HasMarshalType => MarshalType is not null;
/// <inheritdoc/>
public string FullName {
get {
var n = name;
if (UTF8String.IsNullOrEmpty(n))
return $"A_{sequence}";
return n.String;
}
}
/// <summary>
/// Set or clear flags in <see cref="attributes"/>
/// </summary>
/// <param name="set"><c>true</c> if flags should be set, <c>false</c> if flags should
/// be cleared</param>
/// <param name="flags">Flags to set or clear</param>
void ModifyAttributes(bool set, ParamAttributes flags) {
if (set)
attributes |= (int)flags;
else
attributes &= ~(int)flags;
}
/// <summary>
/// Gets/sets the <see cref="ParamAttributes.In"/> bit
/// </summary>
public bool IsIn {
get => ((ParamAttributes)attributes & ParamAttributes.In) != 0;
set => ModifyAttributes(value, ParamAttributes.In);
}
/// <summary>
/// Gets/sets the <see cref="ParamAttributes.Out"/> bit
/// </summary>
public bool IsOut {
get => ((ParamAttributes)attributes & ParamAttributes.Out) != 0;
set => ModifyAttributes(value, ParamAttributes.Out);
}
/// <summary>
/// Gets/sets the <see cref="ParamAttributes.Lcid"/> bit
/// </summary>
public bool IsLcid {
get => ((ParamAttributes)attributes & ParamAttributes.Lcid) != 0;
set => ModifyAttributes(value, ParamAttributes.Lcid);
}
/// <summary>
/// Gets/sets the <see cref="ParamAttributes.Retval"/> bit
/// </summary>
public bool IsRetval {
get => ((ParamAttributes)attributes & ParamAttributes.Retval) != 0;
set => ModifyAttributes(value, ParamAttributes.Retval);
}
/// <summary>
/// Gets/sets the <see cref="ParamAttributes.Optional"/> bit
/// </summary>
public bool IsOptional {
get => ((ParamAttributes)attributes & ParamAttributes.Optional) != 0;
set => ModifyAttributes(value, ParamAttributes.Optional);
}
/// <summary>
/// Gets/sets the <see cref="ParamAttributes.HasDefault"/> bit
/// </summary>
public bool HasDefault {
get => ((ParamAttributes)attributes & ParamAttributes.HasDefault) != 0;
set => ModifyAttributes(value, ParamAttributes.HasDefault);
}
/// <summary>
/// Gets/sets the <see cref="ParamAttributes.HasFieldMarshal"/> bit
/// </summary>
public bool HasFieldMarshal {
get => ((ParamAttributes)attributes & ParamAttributes.HasFieldMarshal) != 0;
set => ModifyAttributes(value, ParamAttributes.HasFieldMarshal);
}
}
/// <summary>
/// A Param row created by the user and not present in the original .NET file
/// </summary>
public class ParamDefUser : ParamDef {
/// <summary>
/// Default constructor
/// </summary>
public ParamDefUser() {
}
/// <summary>
/// Constructor
/// </summary>
/// <param name="name">Name</param>
public ParamDefUser(UTF8String name)
: this(name, 0) {
}
/// <summary>
/// Constructor
/// </summary>
/// <param name="name">Name</param>
/// <param name="sequence">Sequence</param>
public ParamDefUser(UTF8String name, ushort sequence)
: this(name, sequence, 0) {
}
/// <summary>
/// Constructor
/// </summary>
/// <param name="name">Name</param>
/// <param name="sequence">Sequence</param>
/// <param name="flags">Flags</param>
public ParamDefUser(UTF8String name, ushort sequence, ParamAttributes flags) {
this.name = name;
this.sequence = sequence;
attributes = (int)flags;
}
}
/// <summary>
/// Created from a row in the Param table
/// </summary>
sealed class ParamDefMD : ParamDef, IMDTokenProviderMD {
/// <summary>The module where this instance is located</summary>
readonly ModuleDefMD readerModule;
readonly uint origRid;
/// <inheritdoc/>
public uint OrigRid => origRid;
/// <inheritdoc/>
protected override MarshalType GetMarshalType_NoLock() =>
readerModule.ReadMarshalType(Table.Param, origRid, GenericParamContext.Create(declaringMethod));
/// <inheritdoc/>
protected override Constant GetConstant_NoLock() =>
readerModule.ResolveConstant(readerModule.Metadata.GetConstantRid(Table.Param, origRid));
/// <inheritdoc/>
protected override void InitializeCustomAttributes() {
var list = readerModule.Metadata.GetCustomAttributeRidList(Table.Param, origRid);
var tmp = new CustomAttributeCollection(list.Count, list, (list2, index) => readerModule.ReadCustomAttribute(list[index]));
Interlocked.CompareExchange(ref customAttributes, tmp, null);
}
/// <inheritdoc/>
protected override void InitializeCustomDebugInfos() {
var list = new List<PdbCustomDebugInfo>();
readerModule.InitializeCustomDebugInfos(new MDToken(MDToken.Table, origRid), GenericParamContext.Create(declaringMethod), list);
Interlocked.CompareExchange(ref customDebugInfos, list, null);
}
/// <summary>
/// Constructor
/// </summary>
/// <param name="readerModule">The module which contains this <c>Param</c> row</param>
/// <param name="rid">Row ID</param>
/// <exception cref="ArgumentNullException">If <paramref name="readerModule"/> is <c>null</c></exception>
/// <exception cref="ArgumentException">If <paramref name="rid"/> is invalid</exception>
public ParamDefMD(ModuleDefMD readerModule, uint rid) {
#if DEBUG
if (readerModule is null)
throw new ArgumentNullException("readerModule");
if (readerModule.TablesStream.ParamTable.IsInvalidRID(rid))
throw new BadImageFormatException($"Param rid {rid} does not exist");
#endif
origRid = rid;
this.rid = rid;
this.readerModule = readerModule;
bool b = readerModule.TablesStream.TryReadParamRow(origRid, out var row);
Debug.Assert(b);
attributes = row.Flags;
sequence = row.Sequence;
name = readerModule.StringsStream.ReadNoNull(row.Name);
declaringMethod = readerModule.GetOwner(this);
}
internal ParamDefMD InitializeAll() {
MemberMDInitializer.Initialize(DeclaringMethod);
MemberMDInitializer.Initialize(Attributes);
MemberMDInitializer.Initialize(Sequence);
MemberMDInitializer.Initialize(Name);
MemberMDInitializer.Initialize(MarshalType);
MemberMDInitializer.Initialize(Constant);
MemberMDInitializer.Initialize(CustomAttributes);
return this;
}
}
}