source: trunk/sources/HeuristicLab.Parameters/3.3/OptionalValueParameter.cs @ 11868

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2014 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.Drawing;
using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;

namespace HeuristicLab.Parameters {
  /// <summary>
  /// A parameter whose value is defined in the parameter itself or is null.
  /// </summary>
  [Item("OptionalValueParameter", "A parameter whose value is defined in the parameter itself or is null.")]
  [StorableClass]
  public class OptionalValueParameter<T> : Parameter, IValueParameter<T> where T : class, IItem {
    public override Image ItemImage {
      get {
        if (value != null) return value.ItemImage;
        else return base.ItemImage;
      }
    }

    [Storable]
    private T value;
    public virtual T Value {
      get { return this.value; }
      set {
        if (value != this.value) {
          DeregisterValueEvents();
          this.value = value;
          RegisterValueEvents();
          OnValueChanged();
        }
      }
    }
    IItem IValueParameter.Value {
      get { return Value; }
      set {
        T val = value as T;
        if ((value != null) && (val == null))
          throw new InvalidOperationException(
            string.Format("Type mismatch. Value is not a \"{0}\".",
                          typeof(T).GetPrettyName())
          );
        Value = val;
      }
    }

    [Storable(DefaultValue = true)]
    private bool getsCollected;
    public bool GetsCollected {
      get { return getsCollected; }
      set {
        if (value != getsCollected) {
          getsCollected = value;
          OnGetsCollectedChanged();
        }
      }
    }

    [Storable(DefaultValue = true)]
    private bool reactOnValueToStringChangedAndValueItemImageChanged;
    /// <summary>
    ///   True if this parameter should react on the ToStringChanged and ItemImageChanged events of its value, otherwise false.
    /// </summary>
    /// <remarks>
    ///   In some rare cases when the value of the parameter is not deeply cloned, this property has to be set to false
    ///   to avoid a memory leak (cf. ticket #1268). In all other cases this property should always be true.
    /// </remarks>
    public bool ReactOnValueToStringChangedAndValueItemImageChanged {
      get { return reactOnValueToStringChangedAndValueItemImageChanged; }
      set {
        if (value != reactOnValueToStringChangedAndValueItemImageChanged) {
          reactOnValueToStringChangedAndValueItemImageChanged = value;
          if (reactOnValueToStringChangedAndValueItemImageChanged) {
            RegisterValueEvents();
            OnToStringChanged();
            OnItemImageChanged();
          } else
            DeregisterValueEvents();
        }
      }
    }

    #region Constructors
    [StorableConstructor]
    protected OptionalValueParameter(bool deserializing) : base(deserializing) { }
    protected OptionalValueParameter(OptionalValueParameter<T> original, Cloner cloner)
      : base(original, cloner) {
      value = cloner.Clone(original.value);
      getsCollected = original.getsCollected;
      reactOnValueToStringChangedAndValueItemImageChanged = original.reactOnValueToStringChangedAndValueItemImageChanged;
      RegisterValueEvents();
    }
    public OptionalValueParameter()
      : base("Anonymous", typeof(T)) {
      this.getsCollected = true;
      this.reactOnValueToStringChangedAndValueItemImageChanged = true;
    }
    public OptionalValueParameter(string name)
      : base(name, typeof(T)) {
      this.getsCollected = true;
      this.reactOnValueToStringChangedAndValueItemImageChanged = true;
    }
    public OptionalValueParameter(string name, bool getsCollected)
      : base(name, typeof(T)) {
      this.getsCollected = getsCollected;
      this.reactOnValueToStringChangedAndValueItemImageChanged = true;
    }
    public OptionalValueParameter(string name, T value)
      : base(name, typeof(T)) {
      this.value = value;
      this.getsCollected = true;
      this.reactOnValueToStringChangedAndValueItemImageChanged = true;
      RegisterValueEvents();
    }
    public OptionalValueParameter(string name, T value, bool getsCollected)
      : base(name, typeof(T)) {
      this.value = value;
      this.getsCollected = getsCollected;
      this.reactOnValueToStringChangedAndValueItemImageChanged = true;
      RegisterValueEvents();
    }
    public OptionalValueParameter(string name, string description)
      : base(name, description, typeof(T)) {
      this.getsCollected = true;
      this.reactOnValueToStringChangedAndValueItemImageChanged = true;
    }
    public OptionalValueParameter(string name, string description, bool getsCollected)
      : base(name, description, typeof(T)) {
      this.getsCollected = getsCollected;
      this.reactOnValueToStringChangedAndValueItemImageChanged = true;
    }
    public OptionalValueParameter(string name, string description, T value)
      : base(name, description, typeof(T)) {
      this.value = value;
      this.getsCollected = true;
      this.reactOnValueToStringChangedAndValueItemImageChanged = true;
      RegisterValueEvents();
    }
    public OptionalValueParameter(string name, string description, T value, bool getsCollected)
      : base(name, description, typeof(T)) {
      this.value = value;
      this.getsCollected = getsCollected;
      this.reactOnValueToStringChangedAndValueItemImageChanged = true;
      RegisterValueEvents();
    }
    #endregion

    [StorableHook(HookType.AfterDeserialization)]
    private void AfterDeserialization() {
      RegisterValueEvents();
    }

    public override IDeepCloneable Clone(Cloner cloner) {
      return new OptionalValueParameter<T>(this, cloner);
    }

    public override string ToString() {
      if (reactOnValueToStringChangedAndValueItemImageChanged)
        return Name + ": " + (Value != null ? Value.ToString() : "null");
      else
        return Name;
    }

    protected override IItem GetActualValue() {
      return Value;
    }
    protected override void SetActualValue(IItem value) {
      ((IValueParameter)this).Value = value;
    }

    public event EventHandler ValueChanged;
    protected virtual void OnValueChanged() {
      EventHandler handler = ValueChanged;
      if (handler != null) handler(this, EventArgs.Empty);
      OnItemImageChanged();
      OnToStringChanged();
    }
    public event EventHandler GetsCollectedChanged;
    protected virtual void OnGetsCollectedChanged() {
      EventHandler handler = GetsCollectedChanged;
      if (handler != null) handler(this, EventArgs.Empty);
    }

    private void RegisterValueEvents() {
      if ((value != null) && reactOnValueToStringChangedAndValueItemImageChanged) {
        value.ItemImageChanged += new EventHandler(Value_ItemImageChanged);
        value.ToStringChanged += new EventHandler(Value_ToStringChanged);
      }
    }
    private void DeregisterValueEvents() {
      if (value != null) {
        value.ItemImageChanged -= new EventHandler(Value_ItemImageChanged);
        value.ToStringChanged -= new EventHandler(Value_ToStringChanged);
      }
    }
    private void Value_ItemImageChanged(object sender, EventArgs e) {
      OnItemImageChanged();
    }
    private void Value_ToStringChanged(object sender, EventArgs e) {
      OnToStringChanged();
    }
  }
}