source: branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/Manager/PluginDescription.cs @ 2505

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2008 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
 *
 * This file is part of HeuristicLab.
 *
 * HeuristicLab is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * HeuristicLab is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
 */
#endregion

using System;
using System.Collections.Generic;
using System.Text;

namespace HeuristicLab.PluginInfrastructure.Manager {
  /// <summary>
  /// Holds information of loaded plugins that is needed for plugin management.
  /// Used to represent plugins in AppDomains without loading the plugin assemblies.
  /// </summary>
  [Serializable]
  internal sealed class PluginDescription : IPluginDescription {
    private int nTimesLoaded;

    private string name;
    /// <summary>
    /// Gets or sets the name of the plugin.
    /// </summary>
    public string Name {
      get { return name; }
      internal set { name = value; }
    }
    private Version version;
    /// <summary>
    /// Gets or sets the version of the plugin.
    /// </summary>
    internal Version Version {
      get { return version; }
      set { version = value; }
    }
    private DateTime buildDate;
    /// <summary>
    /// Gets or sets the build date of the plugin.
    /// </summary>
    internal DateTime BuildDate {
      get { return buildDate; }
      set { buildDate = value; }
    }

    private PluginState pluginState;
    /// <summary>
    /// Gets or sets the plugin state.
    /// </summary>
    public PluginState PluginState {
      get { return pluginState; }
    }


    private List<string> files = new List<string>();
    /// <summary>
    /// Gets the names of all files that belong to this plugin.
    /// These files are deleted when the plugin is removed or updated.
    /// </summary>
    internal IEnumerable<string> Files {
      get { return files; }
    }

    internal void AddFiles(IEnumerable<string> fileNames) {
      files.AddRange(fileNames);
    }

    private List<PluginDescription> dependencies = new List<PluginDescription>();
    /// <summary>
    /// Gets all dependencies of the plugin.
    /// </summary>
    internal IEnumerable<PluginDescription> Dependencies {
      get { return dependencies; }
    }

    internal void AddDependency(PluginDescription dependency) {
      dependencies.Add(dependency);
    }


    private List<string> assemblies = new List<string>();
    /// <summary>
    /// Gets the names of the assemblies that belong to this plugin.
    /// </summary>
    internal IEnumerable<string> Assemblies {
      get { return assemblies; }
      // set { assemblies = value; }
    }

    internal void AddAssemblies(IEnumerable<string> assemblyNames) {
      assemblies.AddRange(assemblyNames);
    }

    internal PluginDescription() {
      pluginState = PluginState.Undefined;
    }

    internal void Disable() {
      if (pluginState != PluginState.Undefined)
        throw new InvalidOperationException("Can't disabled a plugin in state " + pluginState);
      pluginState = PluginState.Disabled;
    }

    internal void Enable() {
      if (pluginState != PluginState.Undefined)
        throw new InvalidOperationException("Can't enabled a plugin in state " + pluginState);
      pluginState = PluginState.Enabled;
    }

    internal void Load() {
      if (!(pluginState == PluginState.Enabled || pluginState == PluginState.Loaded))
        throw new InvalidOperationException("Can't loaded a plugin in state " + pluginState);
      pluginState = PluginState.Loaded;
      nTimesLoaded++;
    }

    internal void Unload() {
      if (pluginState != PluginState.Loaded)
        throw new InvalidOperationException("Can't unload a plugin in state " + pluginState);
      nTimesLoaded--;
      if (nTimesLoaded == 0) pluginState = PluginState.Enabled;
    }


    /// <summary>
    /// Gets the string representation of the plugin.
    /// </summary>
    /// <returns>The name of the plugin.</returns>
    public override string ToString() {
      return Name;
    }

    // equals and hashcode have to be implemented because we want to compare PluginDescriptions from 
    // different AppDomains and serialization destroys reference equality
    /// <summary>
    /// Checks whether the given object is equal to the current plugin.
    /// </summary>
    /// <param name="obj">The object to compare.</param>
    /// <returns><c>true</c> if it is equal, <c>false</c> otherwise.</returns>
    public override bool Equals(object obj) {
      PluginDescription other = obj as PluginDescription;
      if (other == null) return false;

      return other.Name == this.Name && other.Version == this.Version;
    }
    /// <summary>
    /// Gets the hash code of the current plugin.
    /// </summary>
    /// <returns>The hash code of the plugin.</returns>
    public override int GetHashCode() {
      if (version != null) {
        return name.GetHashCode() + version.GetHashCode();
      } else return name.GetHashCode();
    }
  }
}