BizHawk/BizHawk.MultiClient/tools/Watch/Watch.cs

using System;
using System.Globalization;
using System.Collections.Generic;

namespace BizHawk.MultiClient
{
	public abstract class Watch
	{
		public enum WatchSize { Byte = 1, Word = 2, DWord = 4, Separator = 0 };
		public enum DisplayType { Separator, Signed, Unsigned, Hex, Binary, FixedPoint_12_4, FixedPoint_20_12, Float };
		public enum PreviousType { OriginalValue = 0, LastSearch = 1, LastFrame = 2, LastChange = 3 };

		public static string DisplayTypeToString(DisplayType type)
		{
			switch (type)
			{
				default:
					return type.ToString();
				case DisplayType.FixedPoint_12_4:
					return "Fixed Point 12.4";
				case DisplayType.FixedPoint_20_12:
					return "Fixed Point 20.12";
			}
		}

		public static DisplayType StringToDisplayType(string name)
		{
			switch (name)
			{
				default:
					return (DisplayType)Enum.Parse(typeof(DisplayType), name);
				case "Fixed Point 12.4":
					return DisplayType.FixedPoint_12_4;
				case "Fixed Point 20.12":
					return DisplayType.FixedPoint_20_12;
			}
		}

		protected int _address;
		protected MemoryDomain _domain;
		protected DisplayType _type;
		protected bool _bigEndian;

		public abstract int? Value { get; }
		public abstract string ValueString { get; }
		public abstract WatchSize Size { get; }

		public abstract int? Previous { get; }
		public abstract string PreviousStr { get; }
		public abstract void ResetPrevious();

		public abstract bool Poke(string value);

		public virtual DisplayType Type { get { return _type; } set { _type = value; } }
		public virtual bool BigEndian { get { return _bigEndian; } set { _bigEndian = value; } }

		public MemoryDomain Domain { get { return _domain; } }

		public virtual int? Address { get { return _address; } }

		public virtual string AddressString { get { return _address.ToString(AddressFormatStr); } }

		public virtual bool IsSeparator { get { return false; } }

		public char SizeAsChar
		{
			get
			{
				switch (Size)
				{
					default:
					case WatchSize.Separator:
						return 'S';
					case WatchSize.Byte:
						return 'b';
					case WatchSize.Word:
						return 'w';
					case WatchSize.DWord:
						return 'd';
				}
			}
		}

		public static WatchSize SizeFromChar(char c)
		{
			switch (c)
			{
				default:
				case 'S':
					return WatchSize.Separator;
				case 'b':
					return WatchSize.Byte;
				case 'w':
					return WatchSize.Word;
				case 'd':
					return WatchSize.DWord;
			}
		}

		public char TypeAsChar
		{
			get
			{
				switch (Type)
				{
					default:
					case DisplayType.Separator:
						return '_';
					case DisplayType.Unsigned:
						return 's';
					case DisplayType.Signed:
						return 'u';
					case DisplayType.Hex:
						return 'h';
					case DisplayType.Binary:
						return 'b';
					case DisplayType.FixedPoint_12_4:
						return '1';
					case DisplayType.FixedPoint_20_12:
						return '2';
					case DisplayType.Float:
						return 'f';
				}
			}
		}

		public static DisplayType DisplayTypeFromChar(char c)
		{
			switch (c)
			{
				default:
				case '_':
					return DisplayType.Separator;
				case 'u':
					return DisplayType.Unsigned;
				case 's':
					return DisplayType.Signed;
				case 'h':
					return DisplayType.Hex;
				case 'b':
					return DisplayType.Binary;
				case '1':
					return DisplayType.FixedPoint_12_4;
				case '2':
					return DisplayType.FixedPoint_20_12;
				case 'f':
					return DisplayType.Float;
			}
		}

		public string AddressFormatStr
		{
			get
			{
				if (_domain != null)
				{
					return "X" + IntHelpers.GetNumDigits(_domain.Size - 1).ToString();
				}
				else
				{
					return "";
				}
			}
		}

		protected byte GetByte()
		{
			return _domain.PeekByte(_address);
		}

		protected ushort GetWord()
		{
			if (_bigEndian)
			{
				return (ushort)((_domain.PeekByte(_address) << 8) | (_domain.PeekByte(_address + 1)));
			}
			else
			{
				return (ushort)((_domain.PeekByte(_address)) | (_domain.PeekByte(_address + 1) << 8));
			}
		}

		protected uint GetDWord()
		{
			if (_bigEndian)
			{
				return (uint)((_domain.PeekByte(_address) << 24)
					| (_domain.PeekByte(_address + 1) << 16)
					| (_domain.PeekByte(_address + 2) << 8)
					| (_domain.PeekByte(_address + 3) << 0));
			}
			else
			{
				return (uint)((_domain.PeekByte(_address) << 0)
					| (_domain.PeekByte(_address + 1) << 8)
					| (_domain.PeekByte(_address + 2) << 16)
					| (_domain.PeekByte(_address + 3) << 24));
			}
		}

		protected void PokeByte(byte val)
		{
			_domain.PokeByte(_address, val);
		}

		protected void PokeWord(ushort val)
		{
			if (_bigEndian)
			{
				_domain.PokeByte(_address + 0, (byte)(val >> 8));
				_domain.PokeByte(_address + 1, (byte)(val));
			}
			else
			{
				_domain.PokeByte(_address + 0, (byte)(val));
				_domain.PokeByte(_address + 1, (byte)(val >> 8));
			}
		}

		protected void PokeDWord(uint val)
		{
			if (_bigEndian)
			{
				_domain.PokeByte(_address + 0, (byte)(val >> 24));
				_domain.PokeByte(_address + 1, (byte)(val >> 16));
				_domain.PokeByte(_address + 2, (byte)(val >> 8));
				_domain.PokeByte(_address + 3, (byte)(val));
			}
			else
			{
				_domain.PokeByte(_address + 0, (byte)(val));
				_domain.PokeByte(_address + 1, (byte)(val >> 8));
				_domain.PokeByte(_address + 2, (byte)(val >> 16));
				_domain.PokeByte(_address + 3, (byte)(val >> 24));
			}
		}

		public static Watch GenerateWatch(MemoryDomain domain, int address, WatchSize size, bool details)
		{
			switch (size)
			{
				default:
				case WatchSize.Separator:
					return new SeparatorWatch();
				case WatchSize.Byte:
					if (details)
					{
						return new DetailedByteWatch(domain, address);
					}
					else
					{
						return new ByteWatch(domain, address);
					}
				case WatchSize.Word:
					if (details)
					{
						return new DetailedWordWatch(domain, address);
					}
					else
					{
						return new WordWatch(domain, address);
					}
				case WatchSize.DWord:
					if (details)
					{
						return new DetailedDWordWatch(domain, address);
					}
					else
					{
						return new DWordWatch(domain, address);
					}
			}
		}

		public static Watch GenerateWatch(MemoryDomain domain, int address, WatchSize size, DisplayType type, bool bigendian, int prev, int changecount)
		{
			switch (size)
			{
				default:
				case WatchSize.Separator:
					return new SeparatorWatch();
				case WatchSize.Byte:
					return new DetailedByteWatch(domain, address, type, bigendian, (byte)prev, changecount);
				case WatchSize.Word:
					return new DetailedWordWatch(domain, address, type, bigendian, (ushort)prev, changecount);
				case WatchSize.DWord:
					return new DetailedDWordWatch(domain, address, type, bigendian, (uint)prev, changecount);
			}
		}

		public static List<DisplayType> AvailableTypes(WatchSize size)
		{
			switch (size)
			{
				default:
				case WatchSize.Separator:
					return SeparatorWatch.ValidTypes;
				case WatchSize.Byte:
					return ByteWatch.ValidTypes;
				case WatchSize.Word:
					return WordWatch.ValidTypes;
				case WatchSize.DWord:
					return DWordWatch.ValidTypes;
			}
		}

		/// <summary>
		/// Temparary support of the legacy watch object
		/// </summary>
		/// <param name="watch"></param>
		/// <returns></returns>
		public static Watch ConvertLegacyWatch(Watch_Legacy watch)
		{
			Watch w = GenerateWatch(
				watch.Domain,
				watch.Address,
				SizeFromChar(watch.TypeChar),
				!String.IsNullOrWhiteSpace(watch.Notes)
				);

			w.Type = DisplayTypeFromChar(watch.SignedChar);

			if (!String.IsNullOrWhiteSpace(watch.Notes))
			{
				(w as IWatchDetails).Notes = watch.Notes;
			}

			return w;
		}
	}

	public interface IWatchDetails
	{
		int ChangeCount { get; }
		void ClearChangeCount();
		string Diff { get; }
		string Notes { get; set; }
		void Update();
	}

	public class SeparatorWatch : Watch
	{
		public static SeparatorWatch Instance
		{
			get { return new SeparatorWatch(); }
		}

		public override int? Address
		{
			get { return null; }
		}

		public override int? Value
		{
			get { return null; }
		}

		public override int? Previous
		{
			get { return null; }
		}

		public override string AddressString
		{
			get { return String.Empty; }
		}

		public override string ValueString
		{
			get { return String.Empty; }
		}

		public override string PreviousStr
		{
			get { return String.Empty; }
		}

		public override string ToString()
		{
			return "----";
		}

		public override bool IsSeparator
		{
			get { return true; }
		}

		public override WatchSize Size
		{
			get { return WatchSize.Separator; }
		}

		public static List<DisplayType> ValidTypes
		{
			get { return new List<DisplayType> { DisplayType.Separator }; }
		}

		public override DisplayType Type
		{
			get { return DisplayType.Separator; }
		}

		public override bool Poke(string value)
		{
			return false;
		}

		public override void ResetPrevious()
		{
			return;
		}
	}

	public class ByteWatch : Watch
	{
		protected byte _previous;

		public ByteWatch(MemoryDomain domain, int address)
		{
			_address = address;
			_domain = domain;
			_previous = GetByte();
		}

		public override int? Address
		{
			get { return _address; }
		}

		public override int? Value
		{
			get { return GetByte(); }
		}

		public override string ValueString
		{
			get { return FormatValue(GetByte()); }
		}

		public override int? Previous
		{
			get { return _previous; }
		}

		public override string PreviousStr
		{
			get { return FormatValue(_previous); }
		}

		public override void ResetPrevious()
		{
			_previous = GetByte();
		}

		public override string ToString()
		{
			return AddressString + ": " + ValueString;
		}

		public override bool IsSeparator
		{
			get { return false; }
		}

		public override WatchSize Size
		{
			get { return WatchSize.Byte; }
		}

		public static List<DisplayType> ValidTypes
		{
			get
			{
				return new List<DisplayType>
				{
					DisplayType.Unsigned, DisplayType.Signed, DisplayType.Hex, DisplayType.Binary
				};
			}
		}

		protected string FormatValue(byte val)
		{
			switch (Type)
			{
				default:
				case DisplayType.Unsigned:
					return val.ToString();
				case DisplayType.Signed:
					return ((sbyte)val).ToString();
				case DisplayType.Hex:
					return String.Format("{0:X2}", val);
				case DisplayType.Binary:
					return Convert.ToString(val, 2).PadLeft(8, '0').Insert(4, " ");
			}
		}

		public override bool Poke(string value)
		{
			try
			{
				byte val = 0;
				switch (Type)
				{
					case DisplayType.Unsigned:
						if (InputValidate.IsValidUnsignedNumber(value))
						{
							val = (byte)int.Parse(value);
						}
						else
						{
							return false;
						}
						break;
					case DisplayType.Signed:
						if (InputValidate.IsValidSignedNumber(value))
						{
							val = (byte)(sbyte)int.Parse(value);
						}
						else
						{
							return false;
						}
						break;
					case DisplayType.Hex:
						if (InputValidate.IsValidHexNumber(value))
						{
							val = (byte)int.Parse(value, NumberStyles.HexNumber);
						}
						else
						{
							return false;
						}
						break;
					case DisplayType.Binary:
						if (InputValidate.IsValidBinaryNumber(value))
						{
							val = (byte)Convert.ToInt32(value, 2);
						}
						else
						{
							return false;
						}
						break;
				}

				PokeByte(val);
				return true;
			}
			catch
			{
				return false;
			}
		}
	}

	public sealed class DetailedByteWatch : ByteWatch, IWatchDetails
	{
		private byte _value;

		public DetailedByteWatch(MemoryDomain domain, int address)
			: base(domain, address)
		{
			Notes = String.Empty;
			_value = GetByte();
		}

		public DetailedByteWatch(MemoryDomain domain, int address, DisplayType type, bool bigEndian, byte prev, int changeCount)
			: this(domain, address)
		{
			_previous = prev;
			ChangeCount = changeCount;
			_type = type;
			_bigEndian = bigEndian;
		}

		public override string ToString()
		{
			return Notes + ": " + ValueString;
		}

		public int ChangeCount { get; private set; }
		public void ClearChangeCount() { ChangeCount = 0; }

		public string Diff
		{
			get
			{
				string diff = String.Empty;
				int diffVal = _value - _previous;
				if (diffVal > 0)
				{
					diff = "+";
				}
				else if (diffVal < 0)
				{
					diff = "-";
				}
				return diff + FormatValue((byte)(_previous - _value));
			}
		}

		public string Notes { get; set; }

		public void Update()
		{
			switch (Global.Config.RamWatchDefinePrevious)
			{
				case PreviousType.LastSearch: //TODO
				case PreviousType.OriginalValue:
					/*Do Nothing*/
					break;
				case PreviousType.LastChange:
					var temp = _value;
					_value = GetByte();
					if (_value != temp)
					{
						_previous = _value;
						ChangeCount++;
					}
					break;
				case PreviousType.LastFrame:
					_previous = _value;
					_value = GetByte();
					if (_value != Previous)
					{
						ChangeCount++;
					}
					break;
			}
		}
	}

	public class WordWatch : Watch
	{
		protected ushort _previous;

		public WordWatch(MemoryDomain domain, int address)
		{
			_domain = domain;
			_address = address;
			_previous = GetWord();
		}

		public override int? Value
		{
			get { return GetWord(); }
		}

		public override int? Previous
		{
			get { return _previous; }
		}

		public override string PreviousStr
		{
			get { return FormatValue(_previous); }
		}

		public override void ResetPrevious()
		{
			_previous = GetWord();
		}

		public override WatchSize Size
		{
			get { return WatchSize.Word; }
		}

		public static List<DisplayType> ValidTypes
		{
			get
			{
				return new List<DisplayType>
				{
					DisplayType.Unsigned, DisplayType.Signed, DisplayType.Hex, DisplayType.FixedPoint_12_4, DisplayType.Binary
				};
			}
		}

		public override string ValueString
		{
			get { return FormatValue(GetWord()); }
		}

		public override string ToString()
		{
			return AddressString + ": " + ValueString;
		}

		protected string FormatValue(ushort val)
		{
			switch (Type)
			{
				default:
				case DisplayType.Unsigned:
					return val.ToString();
				case DisplayType.Signed:
					return ((short)val).ToString();
				case DisplayType.Hex:
					return String.Format("{0:X4}", val);
				case DisplayType.FixedPoint_12_4:
					return String.Format("{0:F4}", (val / 16.0));
				case DisplayType.Binary:
					return Convert.ToString(val, 2).PadLeft(16, '0').Insert(8, " ").Insert(4, " ").Insert(14, " ");
			}
		}

		public override bool Poke(string value)
		{
			try
			{
				ushort val = 0;
				switch (Type)
				{
					case DisplayType.Unsigned:
						if (InputValidate.IsValidUnsignedNumber(value))
						{
							val = (ushort)int.Parse(value);
						}
						else
						{
							return false;
						}
						break;
					case DisplayType.Signed:
						if (InputValidate.IsValidSignedNumber(value))
						{
							val = (ushort)(short)int.Parse(value);
						}
						else
						{
							return false;
						}
						break;
					case DisplayType.Hex:
						if (InputValidate.IsValidHexNumber(value))
						{
							val = (ushort)int.Parse(value, NumberStyles.HexNumber);
						}
						else
						{
							return false;
						}
						break;
					case DisplayType.Binary:
						if (InputValidate.IsValidBinaryNumber(value))
						{
							val = (ushort)Convert.ToInt32(value, 2);
						}
						else
						{
							return false;
						}
						break;
					case DisplayType.FixedPoint_12_4:
						if (InputValidate.IsValidFixedPointNumber(value))
						{
							//TODO
						}
						else
						{
							return false;
						}
						break;
				}
				PokeWord(val);
				return true;
			}
			catch
			{
				return false;
			}
		}
	}

	public sealed class DetailedWordWatch : WordWatch, IWatchDetails
	{
		private ushort _value;

		public DetailedWordWatch(MemoryDomain domain, int address)
			: base(domain, address)
		{
			Notes = String.Empty;
			_value = GetWord();
		}

		public DetailedWordWatch(MemoryDomain domain, int address, DisplayType type, bool bigEndian, ushort prev, int changeCount)
			: this(domain, address)
		{
			_previous = prev;
			ChangeCount = changeCount;
			_type = type;
			_bigEndian = bigEndian;
		}

		public override string ToString()
		{
			return Notes + ": " + ValueString;
		}

		public int ChangeCount { get; private set; }
		public void ClearChangeCount() { ChangeCount = 0; }

		public string Diff
		{
			get { return FormatValue((ushort)(_previous - _value)); }
		}

		public string Notes { get; set; }

		public void Update()
		{
			switch (Global.Config.RamWatchDefinePrevious)
			{
				case PreviousType.LastSearch: //TODO
				case PreviousType.OriginalValue:
					/*Do Nothing*/
					break;
				case PreviousType.LastChange:
					var temp = _value;
					_value = GetWord();

					if (_value != temp)
					{
						_previous = temp;
						ChangeCount++;
					}
					break;
				case PreviousType.LastFrame:
					_previous = _value;
					_value = GetWord();
					if (_value != Previous)
					{
						ChangeCount++;
					}
					break;
			}
		}
	}

	public class DWordWatch : Watch
	{
		protected uint _previous;

		public DWordWatch(MemoryDomain domain, int address)
		{
			_domain = domain;
			_address = address;
			_previous = GetDWord();
		}

		public override int? Value
		{
			get { return (int)GetDWord(); }
		}

		public override int? Previous
		{
			get { return (int)_previous; }
		}

		public override string PreviousStr
		{
			get { return FormatValue(_previous); }
		}

		public override void ResetPrevious()
		{
			_previous = GetWord();
		}

		public override WatchSize Size
		{
			get { return WatchSize.DWord; }
		}

		public static List<DisplayType> ValidTypes
		{
			get
			{
				return new List<DisplayType>
					{
					DisplayType.Unsigned, DisplayType.Signed, DisplayType.Hex, DisplayType.FixedPoint_20_12, DisplayType.Float
				};
			}
		}

		public override string ValueString
		{
			get { return FormatValue(GetDWord()); }
		}

		public override string ToString()
		{
			return AddressString + ": " + ValueString;
		}

		protected string FormatValue(uint val)
		{
			switch (Type)
			{
				default:
				case DisplayType.Unsigned:
					return val.ToString();
				case DisplayType.Signed:
					return ((int)val).ToString();
				case DisplayType.Hex:
					return String.Format("{0:X8}", val);
				case DisplayType.FixedPoint_20_12:
					return String.Format("{0:F5}", (val / 4096.0));
				case DisplayType.Float:
					byte[] bytes = BitConverter.GetBytes(val);
					float _float = BitConverter.ToSingle(bytes, 0);
					return String.Format("{0:F6}", _float);
			}
		}

		public override bool Poke(string value)
		{
			try
			{
				uint val = 0;
				switch (Type)
				{
					case DisplayType.Unsigned:
						if (InputValidate.IsValidUnsignedNumber(value))
						{
							val = (uint)int.Parse(value);
						}
						else
						{
							return false;
						}
						break;
					case DisplayType.Signed:
						if (InputValidate.IsValidSignedNumber(value))
						{
							val = (uint)int.Parse(value);
						}
						else
						{
							return false;
						}
						break;
					case DisplayType.Hex:
						if (InputValidate.IsValidHexNumber(value))
						{
							val = (uint)int.Parse(value, NumberStyles.HexNumber);
						}
						else
						{
							return false;
						}
						break;
					case DisplayType.FixedPoint_20_12:
						if (InputValidate.IsValidFixedPointNumber(value))
						{
							//TODO
						}
						else
						{
							return false;
						}
						break;
					case DisplayType.Float:
						if (InputValidate.IsValidDecimalNumber(value))
						{
							//TODO
						}
						else
						{
							return false;
						}
						break;
				}
				PokeDWord(val);
				return true;
			}
			catch
			{
				return false;
			}
		}
	}

	public sealed class DetailedDWordWatch : DWordWatch, IWatchDetails
	{
		private uint _value;

		public DetailedDWordWatch(MemoryDomain domain, int address)
			: base(domain, address)
		{
			Notes = String.Empty;
			_value = GetDWord();
		}

		public DetailedDWordWatch(MemoryDomain domain, int address, DisplayType type, bool bigEndian, uint prev, int changeCount)
			: this(domain, address)
		{
			_previous = prev;
			ChangeCount = changeCount;
			_type = type;
			_bigEndian = bigEndian;
		}

		public override string ToString()
		{
			return Notes + ": " + ValueString;
		}
		public int ChangeCount { get; private set; }
		public void ClearChangeCount() { ChangeCount = 0; }

		public string Diff
		{
			get { return FormatValue(_previous - _value); }
		}

		public string Notes { get; set; }

		public void Update()
		{
			switch (Global.Config.RamWatchDefinePrevious)
			{
				case PreviousType.LastSearch: //TODO
				case PreviousType.OriginalValue:
					/*Do Nothing*/
					break;
				case PreviousType.LastChange:
					var temp = _value;
					_value = GetDWord();
					if (_value != temp)
					{
						_previous = _value;
						ChangeCount++;
					}
					break;
				case PreviousType.LastFrame:
					_previous = _value;
					_value = GetDWord();
					if (_value != Previous)
					{
						ChangeCount++;
					}
					break;
			}
		}
	}
}