summaryrefslogtreecommitdiff
path: root/src/SMAPI/Framework/ModLoading/Rewriters/FieldReplaceRewriter.cs
blob: d5f4cf4a155b5dc67f95c25117f04d19643d4841 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
using System;
using System.Collections.Generic;
using System.Reflection;
using Mono.Cecil;
using Mono.Cecil.Cil;
using StardewModdingAPI.Framework.ModLoading.Framework;

namespace StardewModdingAPI.Framework.ModLoading.Rewriters
{
    /// <summary>Rewrites references to one field with another.</summary>
    internal class FieldReplaceRewriter : BaseInstructionHandler
    {
        /*********
        ** Fields
        *********/
        /// <summary>The new fields to reference indexed by the old field/type names.</summary>
        private readonly Dictionary<string, Dictionary<string, FieldInfo>> FieldMaps = new();


        /*********
        ** Public methods
        *********/
        /// <summary>Construct an instance.</summary>
        public FieldReplaceRewriter()
            : base(defaultPhrase: "field replacement") { } // will be overridden when a field is replaced

        /// <summary>Add a field to replace.</summary>
        /// <param name="fromType">The type whose field to rewrite.</param>
        /// <param name="fromFieldName">The field name to rewrite.</param>
        /// <param name="toType">The new type which will have the field.</param>
        /// <param name="toFieldName">The new field name to reference.</param>
        public FieldReplaceRewriter AddField(Type fromType, string fromFieldName, Type toType, string toFieldName)
        {
            // validate parameters
            if (fromType == null)
                throw new InvalidOperationException("Can't replace a field on a null source type.");
            if (toType == null)
                throw new InvalidOperationException("Can't replace a field on a null target type.");

            // get full type name
            string? fromTypeName = fromType.FullName;
            if (fromTypeName == null)
                throw new InvalidOperationException($"Can't replace field for invalid type reference {toType}.");

            // get target field
            FieldInfo? toField = toType.GetField(toFieldName);
            if (toField == null)
                throw new InvalidOperationException($"The {toType.FullName} class doesn't have a {toFieldName} field.");

            // add mapping
            if (!this.FieldMaps.TryGetValue(fromTypeName, out var fieldMap))
                this.FieldMaps[fromTypeName] = fieldMap = new();
            fieldMap[fromFieldName] = toField;

            return this;
        }

        /// <inheritdoc />
        public override bool Handle(ModuleDefinition module, ILProcessor cil, Instruction instruction)
        {
            FieldReference? fieldRef = RewriteHelper.AsFieldReference(instruction);
            string? declaringType = fieldRef?.DeclaringType?.FullName;

            // get mapped field
            if (declaringType == null || !this.FieldMaps.TryGetValue(declaringType, out var fieldMap) || !fieldMap.TryGetValue(fieldRef!.Name, out FieldInfo? toField))
                return false;

            // replace with new field
            this.Phrases.Add($"{fieldRef.DeclaringType!.Name}.{fieldRef.Name} field");
            instruction.Operand = module.ImportReference(toField);
            return this.MarkRewritten();
        }
    }
}