//  This file (AbstractSetUnitEquipmentAmountCommand.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2009 IBBoard
// 
//  The file and the library/program it is in are licensed under the GNU LGPL license, either version 3 of the License or (at your option) any later version. Please see COPYING.LGPL for more information and the full license.
// 

using System;
using IBBoard.Commands;
using IBBoard.Lang;
using IBBoard.WarFoundry.API.Objects;

namespace IBBoard.WarFoundry.API.Commands
{
	/// <summary>
	/// Abstract parent class for commands that set the amount of an equipment item a unit has to a fixed numeric or ratio value
	/// </summary>
	public abstract class AbstractSetUnitEquipmentAmountCommand : Command
	{
		private Unit unit;
		private UnitEquipmentItem equip;
		private double oldAmount;
		private bool oldAmountWasRatio;
		
		public AbstractSetUnitEquipmentAmountCommand(Unit unit, UnitEquipmentItem item)
		{
			this.unit = unit;
			equip = item;
			oldAmount = unit.GetEquipmentAmount(equip);
			oldAmountWasRatio = unit.GetEquipmentAmountIsRatio(equip);
		}

		public override bool CanExecute()
		{
			return (unit!=null && equip!=null);
		}

		public override string Description
		{
			get
			{
				return "Set " + StringManipulation.CutToLength(equip.Name, 20) + " ratio for " + StringManipulation.CutToLength(unit.Name, 20) + " to " + GetNewAmountString();
			}
		}

		/// <summary>
		/// Gets the string representation for the new amount of the equipment item to take
		/// </summary>
		/// <returns>
		/// the string representation for the new amount of the equipment item to take
		/// </returns>
		protected abstract string GetNewAmountString();

		public override string UndoDescription
		{
			get {
				return "Set " + StringManipulation.CutToLength(equip.Name, 20) + " ratio for " + StringManipulation.CutToLength(unit.Name, 20) + " to " + GetOldAmountString();
			}
		}

		/// <summary>
		/// Gets the string representation for the old amount of the equipment item to take
		/// </summary>
		/// <returns>
		/// the string representation for the old amount of the equipment item to take
		/// </returns>
		protected string GetOldAmountString()
		{
			string oldAmountString;
			if (oldAmountWasRatio)
			{
				oldAmountString = UnitEquipmentRatioSelection.GetEquipmentAmountString(oldAmount);
			}
			else
			{
				oldAmountString = UnitEquipmentNumericSelection.GetEquipmentAmountString(oldAmount);
			}

			return oldAmountString;
		}


		public override bool Execute()
		{
			this.Redo();
			return true;
		}

		public override void Undo ()
		{
			if (oldAmountWasRatio)
			{
				unit.SetEquipmentRatio(equip, oldAmount);
			}
			else
			{
				unit.SetEquipmentAmount(equip, (int)oldAmount);
			}
		}


		public UnitEquipmentItem EquipItem
		{
			get { return equip; }
		}

		public Unit Unit
		{
			get { return unit; }
		}
	}
}