using Mono.Cecil; using Mono.Cecil.Cil; namespace StardewModdingAPI.Framework.ModLoading.Finders { /// Finds incompatible CIL instructions that reference a given property. internal class PropertyFinder : IInstructionHandler { /********* ** Properties *********/ /// The full type name for which to find references. private readonly string FullTypeName; /// The property name for which to find references. private readonly string PropertyName; /// The result to return for matching instructions. private readonly InstructionHandleResult Result; /********* ** Accessors *********/ /// A brief noun phrase indicating what the instruction finder matches. public string NounPhrase { get; } /********* ** Public methods *********/ /// Construct an instance. /// The full type name for which to find references. /// The property name for which to find references. /// The result to return for matching instructions. public PropertyFinder(string fullTypeName, string propertyName, InstructionHandleResult result) { this.FullTypeName = fullTypeName; this.PropertyName = propertyName; this.Result = result; this.NounPhrase = $"{fullTypeName}.{propertyName} property"; } /// Perform the predefined logic for a method if applicable. /// The mod containing the instruction. /// The assembly module containing the instruction. /// The method definition containing the instruction. /// Metadata for mapping assemblies to the current platform. /// Whether the mod was compiled on a different platform. public virtual InstructionHandleResult Handle(IModMetadata mod, ModuleDefinition module, MethodDefinition method, PlatformAssemblyMap assemblyMap, bool platformChanged) { return InstructionHandleResult.None; } /// Perform the predefined logic for an instruction if applicable. /// The mod containing the instruction. /// The assembly module containing the instruction. /// The CIL processor. /// The instruction to handle. /// Metadata for mapping assemblies to the current platform. /// Whether the mod was compiled on a different platform. public virtual InstructionHandleResult Handle(IModMetadata mod, ModuleDefinition module, ILProcessor cil, Instruction instruction, PlatformAssemblyMap assemblyMap, bool platformChanged) { return this.IsMatch(instruction) ? this.Result : InstructionHandleResult.None; } /********* ** Protected methods *********/ /// Get whether a CIL instruction matches. /// The IL instruction. protected bool IsMatch(Instruction instruction) { MethodReference methodRef = RewriteHelper.AsMethodReference(instruction); return methodRef != null && methodRef.DeclaringType.FullName == this.FullTypeName && (methodRef.Name == "get_" + this.PropertyName || methodRef.Name == "set_" + this.PropertyName); } } }