using IPA.Loader.Features;
|
|
using IPA.Utilities;
|
|
using Mono.Cecil;
|
|
using System.Collections.Generic;
|
|
using System.IO;
|
|
using System.Reflection;
|
|
using Version = SemVer.Version;
|
|
#if NET3
|
|
using Net3_Proxy;
|
|
#endif
|
|
|
|
namespace IPA.Loader
|
|
{
|
|
/// <summary>
|
|
/// A class which describes a loaded plugin.
|
|
/// </summary>
|
|
public class PluginMetadata
|
|
{
|
|
/// <summary>
|
|
/// The assembly the plugin was loaded from.
|
|
/// </summary>
|
|
/// <value>the loaded Assembly that contains the plugin main type</value>
|
|
public Assembly Assembly { get; internal set; }
|
|
|
|
/// <summary>
|
|
/// The TypeDefinition for the main type of the plugin.
|
|
/// </summary>
|
|
/// <value>the Cecil definition for the plugin main type</value>
|
|
public TypeDefinition PluginType { get; internal set; }
|
|
|
|
/// <summary>
|
|
/// The human readable name of the plugin.
|
|
/// </summary>
|
|
/// <value>the name of the plugin</value>
|
|
public string Name { get; internal set; }
|
|
|
|
/// <summary>
|
|
/// The BeatMods ID of the plugin, or null if it doesn't have one.
|
|
/// </summary>
|
|
/// <value>the updater ID of the plugin</value>
|
|
public string Id { get; internal set; }
|
|
|
|
/// <summary>
|
|
/// The version of the plugin.
|
|
/// </summary>
|
|
/// <value>the version of the plugin</value>
|
|
public Version Version { get; internal set; }
|
|
|
|
/// <summary>
|
|
/// The file the plugin was loaded from.
|
|
/// </summary>
|
|
/// <value>the file the plugin was loaded from</value>
|
|
public FileInfo File { get; internal set; }
|
|
|
|
// ReSharper disable once UnusedAutoPropertyAccessor.Global
|
|
/// <summary>
|
|
/// The features this plugin requests.
|
|
/// </summary>
|
|
/// <value>the list of features requested by the plugin</value>
|
|
public IReadOnlyList<Feature> Features => InternalFeatures;
|
|
|
|
internal readonly List<Feature> InternalFeatures = new List<Feature>();
|
|
|
|
internal bool IsSelf;
|
|
|
|
/// <summary>
|
|
/// Whether or not this metadata object represents a bare manifest.
|
|
/// </summary>
|
|
/// <value><see langword="true"/> if it is bare, <see langword="false"/> otherwise</value>
|
|
public bool IsBare { get; internal set; }
|
|
|
|
private PluginManifest manifest;
|
|
|
|
internal HashSet<PluginMetadata> Dependencies { get; } = new HashSet<PluginMetadata>();
|
|
|
|
internal PluginManifest Manifest
|
|
{
|
|
get => manifest;
|
|
set
|
|
{
|
|
manifest = value;
|
|
Name = value.Name;
|
|
Version = value.Version;
|
|
Id = value.Id;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// The <see cref="IPA.RuntimeOptions"/> that the plugin specified in its <see cref="PluginAttribute"/>.
|
|
/// </summary>
|
|
public RuntimeOptions RuntimeOptions { get; internal set; }
|
|
/// <summary>
|
|
/// Whether the plugin referred to by this metadata object is a BSIPA 4 attribute plugin.
|
|
/// </summary>
|
|
/// <value><see langword="true"/> if the plugin is a BSIPA 4 plugin, <see langword="false"/> if it is a BSIPA 3 plugin.</value>
|
|
public bool IsAttributePlugin { get; internal set; } = false;
|
|
|
|
/// <summary>
|
|
/// Gets all of the metadata as a readable string.
|
|
/// </summary>
|
|
/// <returns>the readable printable metadata string</returns>
|
|
public override string ToString() => $"{Name}({Id}@{Version})({PluginType?.FullName}) from '{Utils.GetRelativePath(File?.FullName, UnityGame.InstallPath)}'";
|
|
}
|
|
}
|