summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI/Framework/ModRegistry.cs
blob: ba56a4478021a3d9cd9be01837e2a8bd95cdc8a5 (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
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Reflection;

namespace StardewModdingAPI.Framework
{
    /// <summary>Tracks the installed mods.</summary>
    internal class ModRegistry
    {
        /*********
        ** Properties
        *********/
        /// <summary>The friendly mod names treated as deprecation warning sources (assembly full name => mod name).</summary>
        private readonly IDictionary<string, string> ModNamesByAssembly = new Dictionary<string, string>();


        /*********
        ** Public methods
        *********/
        /// <summary>Register a mod as a possible source of deprecation warnings.</summary>
        /// <param name="manifest">The mod manifest.</param>
        /// <param name="assembly">The mod assembly.</param>
        public void Add(Manifest manifest, Assembly assembly)
        {
            this.ModNamesByAssembly[assembly.FullName] = manifest.Name;
        }

        /// <summary>Get the friendly name for the closest assembly registered as a source of deprecation warnings.</summary>
        /// <returns>Returns the source name, or <c>null</c> if no registered assemblies were found.</returns>
        public string GetModFromStack()
        {
            // get stack frames
            StackTrace stack = new StackTrace();
            StackFrame[] frames = stack.GetFrames();
            if (frames == null)
                return null;

            // search stack for a source assembly
            foreach (StackFrame frame in frames)
            {
                // get assembly name
                MethodBase method = frame.GetMethod();
                Type type = method.ReflectedType;
                if (type == null)
                    continue;
                string assemblyName = type.Assembly.FullName;

                // get name if it's a registered source
                if (this.ModNamesByAssembly.ContainsKey(assemblyName))
                    return this.ModNamesByAssembly[assemblyName];
            }

            // no known assembly found
            return null;
        }
    }
}