using System;
using System.Collections.Generic;
using System.Reflection;
namespace StardewModdingAPI.Framework
{
/// Manages deprecation warnings.
internal class DeprecationManager
{
/*********
** Properties
*********/
/// The deprecations which have already been logged (as 'mod name::noun phrase::version').
private readonly HashSet LoggedDeprecations = new HashSet(StringComparer.InvariantCultureIgnoreCase);
/// Encapsulates monitoring and logging for a given module.
private readonly IMonitor Monitor;
/// Tracks the installed mods.
private readonly ModRegistry ModRegistry;
/*********
** Public methods
*********/
/// Construct an instance.
/// Encapsulates monitoring and logging for a given module.
/// Tracks the installed mods.
public DeprecationManager(IMonitor monitor, ModRegistry modRegistry)
{
this.Monitor = monitor;
this.ModRegistry = modRegistry;
}
/// Log a deprecation warning.
/// A noun phrase describing what is deprecated.
/// The SMAPI version which deprecated it.
/// How deprecated the code is.
public void Warn(string nounPhrase, string version, DeprecationLevel severity)
{
this.Warn(this.ModRegistry.GetModFromStack(), nounPhrase, version, severity);
}
/// Log a deprecation warning.
/// The friendly mod name which used the deprecated code.
/// A noun phrase describing what is deprecated.
/// The SMAPI version which deprecated it.
/// How deprecated the code is.
public void Warn(string source, string nounPhrase, string version, DeprecationLevel severity)
{
// ignore if already warned
if (!this.MarkWarned(source ?? "", nounPhrase, version))
return;
// build message
string message = source != null
? $"{source} used {nounPhrase}, which is deprecated since SMAPI {version}."
: $"An unknown mod used {nounPhrase}, which is deprecated since SMAPI {version}.";
message += severity != DeprecationLevel.PendingRemoval
? " This will break in a future version of SMAPI."
: " It will be removed soon, so the mod will break if it's not updated.";
if (source == null)
message += $"{Environment.NewLine}{Environment.StackTrace}";
// log message
switch (severity)
{
case DeprecationLevel.Notice:
this.Monitor.Log(message, LogLevel.Trace);
break;
case DeprecationLevel.Info:
this.Monitor.Log(message, LogLevel.Warn);
break;
case DeprecationLevel.PendingRemoval:
this.Monitor.Log(message, LogLevel.Warn);
break;
default:
throw new NotImplementedException($"Unknown deprecation level '{severity}'");
}
}
/// Mark a deprecation warning as already logged.
/// A noun phrase describing what is deprecated (e.g. "the Extensions.AsInt32 method").
/// The SMAPI version which deprecated it.
/// Returns whether the deprecation was successfully marked as warned. Returns false if it was already marked.
public bool MarkWarned(string nounPhrase, string version)
{
return this.MarkWarned(this.ModRegistry.GetModFromStack(), nounPhrase, version);
}
/// Mark a deprecation warning as already logged.
/// The friendly name of the assembly which used the deprecated code.
/// A noun phrase describing what is deprecated (e.g. "the Extensions.AsInt32 method").
/// The SMAPI version which deprecated it.
/// Returns whether the deprecation was successfully marked as warned. Returns false if it was already marked.
public bool MarkWarned(string source, string nounPhrase, string version)
{
if (string.IsNullOrWhiteSpace(source))
throw new InvalidOperationException("The deprecation source cannot be empty.");
string key = $"{source}::{nounPhrase}::{version}";
if (this.LoggedDeprecations.Contains(key))
return false;
this.LoggedDeprecations.Add(key);
return true;
}
/// Get whether a type implements the given virtual method.
/// The type to check.
/// The base type which declares the virtual method.
/// The method name.
/// The expected argument types.
internal bool IsVirtualMethodImplemented(Type subtype, Type baseType, string name, Type[] argumentTypes)
{
MethodInfo method = subtype.GetMethod(nameof(Mod.Entry), argumentTypes);
return method.DeclaringType != baseType;
}
}
}