From 32271899c307ab01d741bb23b2a07abd1f05b38a Mon Sep 17 00:00:00 2001 From: Hathor86 Date: Tue, 1 Dec 2015 22:16:28 +0100 Subject: [PATCH] Comments on Watch derived class; started on watchlist + Moved WatchList.cs to specific directory (just a matter of ordering) + Mark some properties and methods in watchlist as obsolete + Create Comparer class that are used for sorting (Only domain and address atm, other a still stored with linq). Unlike OrderBy in LINQ, it doesn't create a new list for sorting (so it saves memory), furthermore, it runs faster. Finally, change to type of Watch.Address from nullable lon to regular long (the rare times watch.Address.Value was used, there wasn't any check of null and so, program would have crashed - InvalidOperationException -) --- .../BizHawk.Client.Common.csproj | 4 +- BizHawk.Client.Common/tools/Cheat.cs | 16 +- .../tools/RamSearchEngine.cs | 2 +- .../tools/Watch/ByteWatch.cs | 257 +++++++++--------- .../tools/Watch/DwordWatch.cs | 231 ++++++++++------ .../tools/Watch/SeparatorWatch.cs | 62 ++++- BizHawk.Client.Common/tools/Watch/Watch.cs | 39 ++- .../Watch/WatchList/WatchAddressComparer.cs | 94 +++++++ .../Watch/WatchList/WatchDomainComparer.cs | 94 +++++++ .../tools/Watch/{ => WatchList}/WatchList.cs | 168 ++++++++---- .../tools/Watch/WordWatch.cs | 228 +++++++++++----- .../tools/Watch/RamSearch.cs | 14 +- .../tools/Watch/RamWatch.cs | 28 +- .../tools/Watch/WatchEditor.cs | 6 +- 14 files changed, 850 insertions(+), 393 deletions(-) create mode 100644 BizHawk.Client.Common/tools/Watch/WatchList/WatchAddressComparer.cs create mode 100644 BizHawk.Client.Common/tools/Watch/WatchList/WatchDomainComparer.cs rename BizHawk.Client.Common/tools/Watch/{ => WatchList}/WatchList.cs (77%) diff --git a/BizHawk.Client.Common/BizHawk.Client.Common.csproj b/BizHawk.Client.Common/BizHawk.Client.Common.csproj index c2fc4366cc..51de386cc8 100644 --- a/BizHawk.Client.Common/BizHawk.Client.Common.csproj +++ b/BizHawk.Client.Common/BizHawk.Client.Common.csproj @@ -239,7 +239,9 @@ - + + + diff --git a/BizHawk.Client.Common/tools/Cheat.cs b/BizHawk.Client.Common/tools/Cheat.cs index 3af9f60748..2b5c4a971d 100644 --- a/BizHawk.Client.Common/tools/Cheat.cs +++ b/BizHawk.Client.Common/tools/Cheat.cs @@ -248,12 +248,12 @@ namespace BizHawk.Client.Common case WatchSize.Separator: return false; case WatchSize.Byte: - return (_watch.Address ?? 0) == addr; + return _watch.Address == addr; case WatchSize.Word: - return (addr == (_watch.Address ?? 0)) || (addr == (_watch.Address ?? 0) + 1); + return (addr == _watch.Address) || (addr == (_watch.Address) + 1); case WatchSize.DWord: - return (addr == (_watch.Address ?? 0)) || (addr == (_watch.Address ?? 0) + 1) || - (addr == (_watch.Address ?? 0) + 2) || (addr == (_watch.Address ?? 0) + 3); + return (addr == (_watch.Address)) || (addr == (_watch.Address) + 1) || + (addr == (_watch.Address) + 2) || (addr == (_watch.Address) + 3); } } @@ -271,22 +271,22 @@ namespace BizHawk.Client.Common case WatchSize.Byte: return (byte?)_val; case WatchSize.Word: - if (addr == (_watch.Address ?? 0)) + if (addr == (_watch.Address)) { return (byte)(_val >> 8); } return (byte)(_val & 0xFF); case WatchSize.DWord: - if (addr == (_watch.Address ?? 0)) + if (addr == (_watch.Address)) { return (byte)((_val >> 24) & 0xFF); } - else if (addr == (_watch.Address ?? 0) + 1) + else if (addr == (_watch.Address) + 1) { return (byte)((_val >> 16) & 0xFF); } - else if (addr == ((_watch.Address ?? 0)) + 2) + else if (addr == ((_watch.Address)) + 2) { return (byte)((_val >> 8) & 0xFF); } diff --git a/BizHawk.Client.Common/tools/RamSearchEngine.cs b/BizHawk.Client.Common/tools/RamSearchEngine.cs index 5a59a92819..61a1aad5ed 100644 --- a/BizHawk.Client.Common/tools/RamSearchEngine.cs +++ b/BizHawk.Client.Common/tools/RamSearchEngine.cs @@ -346,7 +346,7 @@ namespace BizHawk.Client.Common _history.AddState(_watchList); } - var addresses = watches.Select(x => x.Address ?? 0); + var addresses = watches.Select(x => x.Address); var removeList = _watchList.Where(x => !addresses.Contains(x.Address)).ToList(); } diff --git a/BizHawk.Client.Common/tools/Watch/ByteWatch.cs b/BizHawk.Client.Common/tools/Watch/ByteWatch.cs index 4510823f33..18b62e4078 100644 --- a/BizHawk.Client.Common/tools/Watch/ByteWatch.cs +++ b/BizHawk.Client.Common/tools/Watch/ByteWatch.cs @@ -80,136 +80,6 @@ namespace BizHawk.Client.Common _previous = GetByte(); } - /// - /// Update the Watch (read it from - /// - public override void Update() - { - switch (Global.Config.RamWatchDefinePrevious) - { - case PreviousType.Original: - return; - 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; - } - } - - #endregion - - //TODO: Implements IFormattable - public string FormatValue(byte val) - { - switch (Type) - { - default: - case DisplayType.Unsigned: - return val.ToString(); - case DisplayType.Signed: - return ((sbyte)val).ToString(); - case DisplayType.Hex: - return val.ToHexString(2); - case DisplayType.Binary: - return Convert.ToString(val, 2).PadLeft(8, '0').Insert(4, " "); - } - } - - #endregion - - /*public override string ToString() - { - return Notes + ": " + ValueString; - }*/ - - #region Properties - - #region Implements - - /// - /// Get a string representation of difference - /// between current value and the previous one - /// - public override string Diff - { - get - { - string diff = string.Empty; - byte diffVal = Convert.ToByte(_value - _previous); - if (diffVal > 0) - { - diff = "+"; - } - else if (diffVal < 0) - { - diff = "-"; - } - - return string.Format("{0}{1}", diff, FormatValue(diffVal)); - } - } - - /// - /// Get the maximum possible value - /// - public override uint MaxValue - { - get - { - return byte.MaxValue; - } - } - - /// - /// Get the current value - /// - public override int Value - { - get - { - return GetByte(); - } - } - - /// - /// Gets the current value - /// but with stuff I don't understand - /// - /// zero 15-nov-2015 - bypass LIAR LOGIC, see fdc9ea2aa922876d20ba897fb76909bf75fa6c92 https://github.com/TASVideos/BizHawk/issues/326 - public override int ValueNoFreeze - { - get - { - return GetByte(true); - } - } - - /// - /// Get a string representation of the current value - /// - public override string ValueString - { - get - { - return FormatValue(_value); - } - } - /// /// Try to sets the value into the /// at the current address @@ -290,6 +160,131 @@ namespace BizHawk.Client.Common } } + /// + /// Update the Watch (read it from + /// + public override void Update() + { + switch (Global.Config.RamWatchDefinePrevious) + { + case PreviousType.Original: + return; + 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; + } + } + + #endregion Implements + + //TODO: Implements IFormattable + public string FormatValue(byte val) + { + switch (Type) + { + default: + case DisplayType.Unsigned: + return val.ToString(); + case DisplayType.Signed: + return ((sbyte)val).ToString(); + case DisplayType.Hex: + return val.ToHexString(2); + case DisplayType.Binary: + return Convert.ToString(val, 2).PadLeft(8, '0').Insert(4, " "); + } + } + + #endregion + + #region Properties + + #region Implements + + /// + /// Get a string representation of difference + /// between current value and the previous one + /// + public override string Diff + { + get + { + string diff = string.Empty; + byte diffVal = Convert.ToByte(_value - _previous); + if (diffVal > 0) + { + diff = "+"; + } + else if (diffVal < 0) + { + diff = "-"; + } + + return string.Format("{0}{1}", diff, FormatValue(diffVal)); + } + } + + /// + /// Get the maximum possible value + /// + public override uint MaxValue + { + get + { + return byte.MaxValue; + } + } + + /// + /// Get the current value + /// + public override int Value + { + get + { + return GetByte(); + } + } + + /// + /// Gets the current value + /// but with stuff I don't understand + /// + /// zero 15-nov-2015 - bypass LIAR LOGIC, see fdc9ea2aa922876d20ba897fb76909bf75fa6c92 https://github.com/TASVideos/BizHawk/issues/326 + public override int ValueNoFreeze + { + get + { + return GetByte(true); + } + } + + /// + /// Get a string representation of the current value + /// + public override string ValueString + { + get + { + return FormatValue(_value); + } + } + /// /// Get the previous value /// @@ -314,6 +309,6 @@ namespace BizHawk.Client.Common #endregion Implements - #endregion + #endregion } } diff --git a/BizHawk.Client.Common/tools/Watch/DwordWatch.cs b/BizHawk.Client.Common/tools/Watch/DwordWatch.cs index 3c556046c8..860aad7ee7 100644 --- a/BizHawk.Client.Common/tools/Watch/DwordWatch.cs +++ b/BizHawk.Client.Common/tools/Watch/DwordWatch.cs @@ -9,6 +9,9 @@ using System.Text; namespace BizHawk.Client.Common { + /// + /// This class holds a double word (32 bits) + /// public sealed class DWordWatch : Watch { #region Fields @@ -20,6 +23,18 @@ namespace BizHawk.Client.Common #region cTor(s) + /// + /// Inialize a new instance of + /// + /// where you want to track + /// The address you want to track + /// How you you want to display the value See + /// Specify the endianess. true for big endian + /// A custom note about the + /// Current value + /// Previous value + /// How many times value has changed + /// Occurs when a is incompatible with internal DWordWatch(MemoryDomain domain, long address, DisplayType type, bool bigEndian, string note, uint value, uint previous, int changeCount) : base(domain, address, WatchSize.DWord, type, bigEndian, note) { @@ -28,15 +43,13 @@ namespace BizHawk.Client.Common this._changecount = changeCount; } - internal DWordWatch(MemoryDomain domain, long address, DisplayType type, bool bigEndian, string note) - :this(domain, address, type, bigEndian, note, 0, 0, 0) - { - _previous = GetDWord(); - _value = GetDWord(); - } - #endregion + #region Methods + + /// + /// Enumerate wich are valid for a + /// public static IEnumerable ValidTypes { get @@ -51,80 +64,31 @@ namespace BizHawk.Client.Common } } + #region Implements + + /// + /// Get a list a that can be used for this + /// + /// An enumartion that contains all valid public override IEnumerable AvailableTypes() { - yield return DisplayType.Unsigned; - yield return DisplayType.Signed; - yield return DisplayType.Hex; - yield return DisplayType.Binary; - yield return DisplayType.FixedPoint_20_12; - yield return DisplayType.FixedPoint_16_16; - yield return DisplayType.Float; - } - - public override int Value - { - get { return (int)GetDWord(); } - } - - public override int ValueNoFreeze - { - get { return (int)GetDWord(true); } - } - - public override int Previous - { - get { return (int)_previous; } - } - - public override string PreviousStr - { - get { return FormatValue(_previous); } + return ValidTypes; } + /// + /// Reset the previous value; set it to the current one + /// public override void ResetPrevious() { _previous = GetWord(); } - public override uint MaxValue - { - get { return uint.MaxValue; } - } - - public override string ValueString - { - get { return FormatValue(GetDWord()); } - } - - /*public override string ToString() - { - return Notes + ": " + ValueString; - }*/ - - public string FormatValue(uint val) - { - switch (Type) - { - default: - case DisplayType.Unsigned: - return val.ToString(); - case DisplayType.Signed: - return ((int)val).ToString(); - case DisplayType.Hex: - return val.ToHexString(8); - case DisplayType.FixedPoint_20_12: - return string.Format("{0:0.######}", val / 4096.0); - case DisplayType.FixedPoint_16_16: - return string.Format("{0:0.######}", val / 65536.0); - case DisplayType.Float: - var bytes = BitConverter.GetBytes(val); - var _float = BitConverter.ToSingle(bytes, 0); - //return string.Format("{0:0.######}", _float); - return _float.ToString(); // adelikat: decided that we like sci notation instead of spooky rounding - } - } - + /// + /// Try to sets the value into the + /// at the current address + /// + /// Value to set + /// True if value successfully sets; othewise, false public override bool Poke(string value) { try @@ -221,11 +185,9 @@ namespace BizHawk.Client.Common } } - public override string Diff - { - get { return FormatValue(_previous - _value); } - } - + /// + /// Update the Watch (read it from + /// public override void Update() { switch (Global.Config.RamWatchDefinePrevious) @@ -253,5 +215,120 @@ namespace BizHawk.Client.Common break; } } + + #endregion Implements + + //TODO: Implements IFormattable + public string FormatValue(uint val) + { + switch (Type) + { + default: + case DisplayType.Unsigned: + return val.ToString(); + case DisplayType.Signed: + return ((int)val).ToString(); + case DisplayType.Hex: + return val.ToHexString(8); + case DisplayType.FixedPoint_20_12: + return string.Format("{0:0.######}", val / 4096.0); + case DisplayType.FixedPoint_16_16: + return string.Format("{0:0.######}", val / 65536.0); + case DisplayType.Float: + var bytes = BitConverter.GetBytes(val); + var _float = BitConverter.ToSingle(bytes, 0); + //return string.Format("{0:0.######}", _float); + return _float.ToString(); // adelikat: decided that we like sci notation instead of spooky rounding + } + } + + #endregion + + #region Properties + + #region Implements + + /// + /// Get a string representation of difference + /// between current value and the previous one + /// + public override string Diff + { + get + { + return FormatValue(_previous - _value); + } + } + + /// + /// Get the maximum possible value + /// + public override uint MaxValue + { + get + { + return uint.MaxValue; + } + } + + /// + /// Get the current value + /// + public override int Value + { + get + { + return (int)GetDWord(); + } + } + + /// + /// Gets the current value + /// but with stuff I don't understand + /// + public override int ValueNoFreeze + { + get + { + return (int)GetDWord(true); + } + } + + /// + /// Get a string representation of the current value + /// + public override string ValueString + { + get + { + return FormatValue(GetDWord()); + } + } + + /// + /// Get the previous value + /// + public override int Previous + { + get + { + return (int)_previous; + } + } + + /// + /// Get a string representation of the previous value + /// + public override string PreviousStr + { + get + { + return FormatValue(_previous); + } + } + + #endregion Implements + + #endregion } } diff --git a/BizHawk.Client.Common/tools/Watch/SeparatorWatch.cs b/BizHawk.Client.Common/tools/Watch/SeparatorWatch.cs index 2d95d60eaf..e00d522ee6 100644 --- a/BizHawk.Client.Common/tools/Watch/SeparatorWatch.cs +++ b/BizHawk.Client.Common/tools/Watch/SeparatorWatch.cs @@ -3,69 +3,117 @@ using System.Collections.Generic; namespace BizHawk.Client.Common { + /// + /// This class holds a separator for RamWatch + /// Use the static property Instance to get it + /// public sealed class SeparatorWatch : Watch { + /// + /// Initialize a new separator instance + /// internal SeparatorWatch() :base(null, 0, WatchSize.Separator, DisplayType.Separator, true, string.Empty) { } + /// + /// Gets the separator instance + /// public static SeparatorWatch Instance { get { return new SeparatorWatch(); } } + /// + /// Get the appropriate DisplayType + /// + /// DisplayType.Separator nothing else + public override IEnumerable AvailableTypes() + { + yield return DisplayType.Separator; + } + + #region Stuff to ignore + + /// + /// Ignore that stuff + /// public override int Value { get { return 0; } } + /// + /// Ignore that stuff + /// public override int ValueNoFreeze { get { return 0; } } + /// + /// Ignore that stuff + /// public override int Previous { get { return 0; } - } + } + /// + /// Ignore that stuff + /// public override string ValueString { get { return string.Empty; } } + /// + /// Ignore that stuff + /// public override string PreviousStr { get { return string.Empty; } } - + public override string ToString() { return "----"; - } + } + /// + /// Ignore that stuff + /// public override bool Poke(string value) { return false; } + /// + /// Ignore that stuff + /// public override void ResetPrevious() { return; } + /// + /// Ignore that stuff + /// public override string Diff { get { return string.Empty; } } + /// + /// Ignore that stuff + /// public override uint MaxValue { get { return 0; } } + /// + /// Ignore that stuff + /// public override void Update() { return; } - public override IEnumerable AvailableTypes() - { - yield return DisplayType.Separator; - } + #endregion } } diff --git a/BizHawk.Client.Common/tools/Watch/Watch.cs b/BizHawk.Client.Common/tools/Watch/Watch.cs index 252bdc1e60..3f6f9b5030 100644 --- a/BizHawk.Client.Common/tools/Watch/Watch.cs +++ b/BizHawk.Client.Common/tools/Watch/Watch.cs @@ -327,8 +327,8 @@ namespace BizHawk.Client.Common #endregion Abstracts - #region Protected - + #region Protected + protected byte GetByte(bool bypassFreeze = false) { if (!bypassFreeze && Global.CheatList.IsActive(_domain, _address)) @@ -429,10 +429,16 @@ namespace BizHawk.Client.Common /// True if both object are equals; otherwise, false public bool Equals(Watch other) { - return !object.ReferenceEquals(other, null) && - this._domain == other._domain && - this._address == other._address && - this._size == other._size; + if (object.ReferenceEquals(other, null)) + { + return false; + } + else + { + return this._domain == other._domain && + this._address == other._address && + this._size == other._size; + } } #endregion IEquatable @@ -478,7 +484,7 @@ namespace BizHawk.Client.Common { return 1; } - else if (_address.Equals(other._address)) + else if (_address.Equals(other._address)) { return ((int)_size).CompareTo((int)other._size); } @@ -518,7 +524,7 @@ namespace BizHawk.Client.Common /// int that can serves as a unique representation of current Watch public override int GetHashCode() { - return this.Domain.GetHashCode() + (int)(this.Address ?? 0); + return this.Domain.GetHashCode() + (int)(this.Address); } /// @@ -539,7 +545,7 @@ namespace BizHawk.Client.Common public override string ToString() { return string.Format("{0}\t{1}\t{2}\t{3}\t{4}\t{5}" - , (Address ?? 0).ToHexString((Domain.Size - 1).NumHexDigits()) + , Address.ToHexString((Domain.Size - 1).NumHexDigits()) , SizeAsChar , TypeAsChar , Convert.ToInt32(BigEndian) @@ -605,7 +611,7 @@ namespace BizHawk.Client.Common /// /// Gets the address in the /// - public long? Address + public long Address { get { @@ -699,9 +705,16 @@ namespace BizHawk.Client.Common { return _domain; } - set + internal set { - _domain = value; + if (_domain.Name == value.Name) + { + _domain = value; + } + else + { + throw new InvalidOperationException("You cannot set diffrent domain to a watch on the fly"); + } } } @@ -719,7 +732,7 @@ namespace BizHawk.Client.Common } else { - return null; + return string.Empty; } } } diff --git a/BizHawk.Client.Common/tools/Watch/WatchList/WatchAddressComparer.cs b/BizHawk.Client.Common/tools/Watch/WatchList/WatchAddressComparer.cs new file mode 100644 index 0000000000..e17f4b4c30 --- /dev/null +++ b/BizHawk.Client.Common/tools/Watch/WatchList/WatchAddressComparer.cs @@ -0,0 +1,94 @@ +using System.Collections.Generic; + +namespace BizHawk.Client.Common +{ + /// + /// This class hold a collection + /// Different memory domain can be mixed + /// + public sealed partial class WatchList + { + /// + /// Netsed private class that define how to compare two + /// based on their address + /// + private struct WatchAddressComparer + : IEqualityComparer, + IComparer + { + /// + /// Compare two between them + /// and determine wich one comes first. + /// If they are equals, comapraison will done one the domain and next on size + /// + /// First + /// True if are equal; otherwise, false + /// + public int Compare(Watch x, Watch y) + { + if (Equals(x, y)) + { + return 0; + } + else if (x.Address.Equals(y.Address)) + { + if (x.Domain.Name.Equals(y.Domain.Name)) + { + return x.Size.CompareTo(y.Size); + } + else + { + return x.Domain.Name.CompareTo(y.Domain.Name); + } + } + else + { + return x.Address.CompareTo(y.Address); + } + } + + /// + /// Determine if two are equals + /// + /// First + /// Second + /// True if are equal; otherwise, false + public bool Equals(Watch x, Watch y) + { + if (object.ReferenceEquals(x, null)) + { + if (object.ReferenceEquals(y, null)) + { + return true; + } + else + { + return false; + } + } + else if (object.ReferenceEquals(y, null)) + { + return false; + } + else if (object.ReferenceEquals(x, y)) + { + return true; + } + else + { + return x.Address.Equals(y.Address); + } + } + + /// + /// Get the hash value of specified + /// + /// Watch to get hash + /// int that can serves as a unique representation of current Watch + public int GetHashCode(Watch obj) + { + return obj.GetHashCode(); + } + } +} +} diff --git a/BizHawk.Client.Common/tools/Watch/WatchList/WatchDomainComparer.cs b/BizHawk.Client.Common/tools/Watch/WatchList/WatchDomainComparer.cs new file mode 100644 index 0000000000..39e3778a46 --- /dev/null +++ b/BizHawk.Client.Common/tools/Watch/WatchList/WatchDomainComparer.cs @@ -0,0 +1,94 @@ +using System.Collections.Generic; + +namespace BizHawk.Client.Common +{ + /// + /// This class hold a collection + /// Different memory domain can be mixed + /// + public sealed partial class WatchList + { + /// + /// Netsed private class that define how to compare two + /// based on their domain + /// + private struct WatchDomainComparer + : IEqualityComparer, + IComparer + { + /// + /// Compare two between them + /// and determine wich one comes first. + /// If they are equals, comapraison will done one the address and next on size + /// + /// First + /// True if are equal; otherwise, false + /// + public int Compare(Watch x, Watch y) + { + if(Equals(x, y)) + { + return 0; + } + else if(x.Domain.Name.Equals(y.Domain.Name)) + { + if (x.Address.Equals(y.Address)) + { + return x.Size.CompareTo(y.Size); + } + else + { + return x.Address.CompareTo(y.Address); + } + } + else + { + return x.Domain.Name.CompareTo(y.Domain.Name); + } + } + + /// + /// Determine if two are equals + /// + /// First + /// Second + /// True if are equal; otherwise, false + public bool Equals(Watch x, Watch y) + { + if(object.ReferenceEquals(x, null)) + { + if(object.ReferenceEquals(y, null)) + { + return true; + } + else + { + return false; + } + } + else if(object.ReferenceEquals(y, null)) + { + return false; + } + else if(object.ReferenceEquals(x,y)) + { + return true; + } + else + { + return x.Domain.Name.Equals(y.Domain.Name); + } + } + + /// + /// Get the hash value of specified + /// + /// Watch to get hash + /// int that can serves as a unique representation of current Watch + public int GetHashCode(Watch obj) + { + return obj.GetHashCode(); + } + } + } +} diff --git a/BizHawk.Client.Common/tools/Watch/WatchList.cs b/BizHawk.Client.Common/tools/Watch/WatchList/WatchList.cs similarity index 77% rename from BizHawk.Client.Common/tools/Watch/WatchList.cs rename to BizHawk.Client.Common/tools/Watch/WatchList/WatchList.cs index 02d77df715..c0775068b7 100644 --- a/BizHawk.Client.Common/tools/Watch/WatchList.cs +++ b/BizHawk.Client.Common/tools/Watch/WatchList/WatchList.cs @@ -1,23 +1,27 @@ -using System.Collections; +using System; +using System.Collections; using System.Collections.Generic; using System.Globalization; using System.IO; using System.Linq; using System.Text; +using System.Threading.Tasks; using BizHawk.Common.NumberExtensions; using BizHawk.Common.StringExtensions; using BizHawk.Emulation.Common; + namespace BizHawk.Client.Common { - public class WatchList : IList + /// + /// This class hold a collection + /// Different memory domain can be mixed + /// + public sealed partial class WatchList + : IList { - private IMemoryDomains _memoryDomains; - private List _watchList = new List(); - private MemoryDomain _domain; - private string _currentFilename = string.Empty; - private string _systemid; + #region Fields public const string ADDRESS = "AddressColumn"; public const string VALUE = "ValueColumn"; @@ -27,14 +31,62 @@ namespace BizHawk.Client.Common public const string DOMAIN = "DomainColumn"; public const string NOTES = "NotesColumn"; + private static readonly WatchDomainComparer domainComparer = new WatchDomainComparer(); + private static readonly WatchAddressComparer addressComparer = new WatchAddressComparer(); + + private static IMemoryDomains _memoryDomains; + + private List _watchList = new List(0); + private MemoryDomain _domain; + private string _currentFilename = string.Empty; + private string _systemid; + + #endregion + + #region cTor(s) + + /// + /// Initialize a new instance of that will + /// contains a set of + /// + /// All available memomry domains + /// Domain you want to watch + /// System identifier (NES, SNES, ...) + [Obsolete("Use the constructor with two parameters instead")] public WatchList(IMemoryDomains core, MemoryDomain domain, string systemid) { - _memoryDomains = core; + if (_memoryDomains == null) + { + _memoryDomains = core; + } _domain = domain; _systemid = systemid; } - public void RefreshDomans(IMemoryDomains core, MemoryDomain domain) + /// + /// Initialize a new instance of that will + /// contains a set of + /// + /// All available memomry domains + /// Domain you want to watch + /// System identifier (NES, SNES, ...) + public WatchList(IMemoryDomains core, string systemid) + { + if (_memoryDomains == null) + { + _memoryDomains = core; + } + //TODO: Remove this after tests + _domain = core.MainMemory; + _systemid = systemid; + } + + #endregion + + #region Methods + + [Obsolete("Use the method with single parameter instead")] + public void RefreshDomains(IMemoryDomains core, MemoryDomain domain) { _memoryDomains = core; _domain = domain; @@ -47,8 +99,21 @@ namespace BizHawk.Client.Common } }); } - - public enum WatchPrevDef { LastSearch, Original, LastFrame, LastChange } + + public void RefreshDomains(IMemoryDomains core) + { + _memoryDomains = core; + Parallel.ForEach(_watchList, watch => + { + watch.Domain = core[watch.Domain.Name]; + watch.ResetPrevious(); + watch.Update(); + watch.ClearChangeCount(); + } + ); + } + + #endregion public string AddressFormatStr // TODO: this is probably compensating for not using the ToHex string extension { @@ -65,19 +130,30 @@ namespace BizHawk.Client.Common public int Count { - get { return _watchList.Count; } + get + { + return _watchList.Count; + } } public int WatchCount { - get { return _watchList.Count(w => !w.IsSeparator); } + get + { + return _watchList.Count(watch => !watch.IsSeparator); + } } + [Obsolete("Use count property instead")] public int ItemCount { - get { return _watchList.Count; } + get + { + return Count; + } } + [Obsolete("Use domain from individual watch instead")] public MemoryDomain Domain { get { return _domain; } @@ -117,23 +193,12 @@ namespace BizHawk.Client.Common case ADDRESS: if (reverse) { - _watchList = _watchList - .OrderByDescending(x => x.Address) - .ThenBy(x => x.Domain.Name) - .ThenBy(x => x.Size) - .ThenBy(x => x.Type) - .ThenBy(x => x.BigEndian) - .ToList(); + _watchList.Sort(addressComparer); + _watchList.Reverse(); } else { - _watchList = _watchList - .OrderBy(x => x.Address) - .ThenBy(x => x.Domain.Name) - .ThenBy(x => x.Size) - .ThenBy(x => x.Type) - .ThenBy(x => x.BigEndian) - .ToList(); + _watchList.Sort(); } break; @@ -165,7 +230,7 @@ namespace BizHawk.Client.Common { _watchList = _watchList .OrderByDescending(x => x.PreviousStr) - .ThenBy(x => x.Address ?? 0) + .ThenBy(x => x.Address) .ThenBy(x => x.Size) .ThenBy(x => x.Type) .ToList(); @@ -174,7 +239,7 @@ namespace BizHawk.Client.Common { _watchList = _watchList .OrderBy(x => x.PreviousStr) - .ThenBy(x => x.Address ?? 0) + .ThenBy(x => x.Address) .ThenBy(x => x.Size) .ThenBy(x => x.Type) .ToList(); @@ -186,7 +251,7 @@ namespace BizHawk.Client.Common { _watchList = _watchList .OrderByDescending(x => x.Diff) - .ThenBy(x => x.Address ?? 0) + .ThenBy(x => x.Address) .ThenBy(x => x.Size) .ThenBy(x => x.Type) .ToList(); @@ -195,7 +260,7 @@ namespace BizHawk.Client.Common { _watchList = _watchList .OrderBy(x => x.Diff) - .ThenBy(x => x.Address ?? 0) + .ThenBy(x => x.Address) .ThenBy(x => x.Size) .ThenBy(x => x.Type) .ToList(); @@ -207,7 +272,7 @@ namespace BizHawk.Client.Common { _watchList = _watchList .OrderByDescending(x => x.ChangeCount) - .ThenBy(x => x.Address ?? 0) + .ThenBy(x => x.Address) .ThenBy(x => x.Size) .ThenBy(x => x.Type) .ToList(); @@ -216,7 +281,7 @@ namespace BizHawk.Client.Common { _watchList = _watchList .OrderBy(x => x.ChangeCount) - .ThenBy(x => x.Address ?? 0) + .ThenBy(x => x.Address) .ThenBy(x => x.Size) .ThenBy(x => x.Type) .ToList(); @@ -226,23 +291,12 @@ namespace BizHawk.Client.Common case DOMAIN: if (reverse) { - _watchList = _watchList - .OrderByDescending(x => x.Domain) - .ThenBy(x => x.Address ?? 0) - .ThenBy(x => x.Size) - .ThenBy(x => x.Type) - .ThenBy(x => x.BigEndian) - .ToList(); + _watchList.Sort(domainComparer); + _watchList.Reverse(); } else { - _watchList = _watchList - .OrderBy(x => x.Domain) - .ThenBy(x => x.Address ?? 0) - .ThenBy(x => x.Size) - .ThenBy(x => x.Type) - .ThenBy(x => x.BigEndian) - .ToList(); + _watchList.Sort(domainComparer); } break; @@ -251,7 +305,7 @@ namespace BizHawk.Client.Common { _watchList = _watchList .OrderByDescending(x => x.Notes) - .ThenBy(x => x.Address ?? 0) + .ThenBy(x => x.Address) .ThenBy(x => x.Size) .ThenBy(x => x.Type) .ToList(); @@ -260,7 +314,7 @@ namespace BizHawk.Client.Common { _watchList = _watchList .OrderBy(x => x.Notes) - .ThenBy(x => x.Address ?? 0) + .ThenBy(x => x.Address) .ThenBy(x => x.Size) .ThenBy(x => x.Type) .ToList(); @@ -279,11 +333,11 @@ namespace BizHawk.Client.Common public void UpdateValues() { - foreach (var watch in _watchList) + Parallel.ForEach(_watchList, watch => { watch.Update(); - } - } + }); + } public void Add(Watch watch) { @@ -412,7 +466,7 @@ namespace BizHawk.Client.Common CurrentFileName = file.FullName; return Save(); } - + return false; } @@ -476,7 +530,7 @@ namespace BizHawk.Client.Common { isOldBizHawkWatch = true; // This supports the legacy .wch format from 1.0.5 and earlier } - else + else { continue; // If not 4, something is wrong with this line, ignore it } @@ -532,9 +586,9 @@ namespace BizHawk.Client.Common memDomain, addr, size, - type, + type, bigEndian, - notes)); + notes)); _domain = _memoryDomains[domain]; } diff --git a/BizHawk.Client.Common/tools/Watch/WordWatch.cs b/BizHawk.Client.Common/tools/Watch/WordWatch.cs index 9f0c575a2e..d0e393be9c 100644 --- a/BizHawk.Client.Common/tools/Watch/WordWatch.cs +++ b/BizHawk.Client.Common/tools/Watch/WordWatch.cs @@ -1,13 +1,17 @@ -using BizHawk.Common.NumberExtensions; -using BizHawk.Common.StringExtensions; -using BizHawk.Emulation.Common; -using System; +using System; using System.Collections.Generic; using System.Globalization; using System.Linq; +using BizHawk.Common.NumberExtensions; +using BizHawk.Common.StringExtensions; +using BizHawk.Emulation.Common; + namespace BizHawk.Client.Common { + /// + /// This class holds a word (16 bits) + /// public sealed class WordWatch : Watch { #region Fields @@ -19,6 +23,18 @@ namespace BizHawk.Client.Common #region cTor(s) + /// + /// Inialize a new instance of + /// + /// where you want to track + /// The address you want to track + /// How you you want to display the value See + /// Specify the endianess. true for big endian + /// A custom note about the + /// Current value + /// Previous value + /// How many times value has changed + /// Occurs when a is incompatible with internal WordWatch(MemoryDomain domain, long address, DisplayType type, bool bigEndian, string note, ushort value, ushort previous, int changeCount) : base(domain, address, WatchSize.Word, type, bigEndian, note) { @@ -27,15 +43,13 @@ namespace BizHawk.Client.Common this._changecount = changeCount; } - internal WordWatch(MemoryDomain domain, long address, DisplayType type, bool bigEndian, string note) - :this(domain, address, type, bigEndian, note, 0, 0, 0) - { - _previous = GetWord(); - _value = GetWord(); - } - #endregion + #region Methods + + /// + /// Enumerate wich are valid for a + /// public static IEnumerable ValidTypes { get @@ -48,73 +62,31 @@ namespace BizHawk.Client.Common } } + #region Implements + + /// + /// Get a list a that can be used for this + /// + /// An enumartion that contains all valid public override IEnumerable AvailableTypes() { - yield return DisplayType.Unsigned; - yield return DisplayType.Signed; - yield return DisplayType.Hex; - yield return DisplayType.Binary; - yield return DisplayType.FixedPoint_12_4; - } - - public override uint MaxValue - { - get { return ushort.MaxValue; } - } - - public override int Value - { - get { return GetWord(); } - } - - public override int ValueNoFreeze - { - get { return GetWord(true); } - } - - public override int Previous - { - get { return _previous; } - } - - public override string PreviousStr - { - get { return FormatValue(_previous); } + return ValidTypes; } + /// + /// Reset the previous value; set it to the current one + /// public override void ResetPrevious() { _previous = GetWord(); } - public override string ValueString - { - get { return FormatValue(GetWord()); } - } - - /*public override string ToString() - { - return Notes + ": " + ValueString; - }*/ - - public string FormatValue(ushort val) - { - switch (Type) - { - default: - case DisplayType.Unsigned: - return val.ToString(); - case DisplayType.Signed: - return ((short)val).ToString(); - case DisplayType.Hex: - return val.ToHexString(4); - 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, " "); - } - } - + /// + /// Try to sets the value into the + /// at the current address + /// + /// Value to set + /// True if value successfully sets; othewise, false public override bool Poke(string value) { try @@ -199,11 +171,9 @@ namespace BizHawk.Client.Common } } - public override string Diff - { - get { return FormatValue((ushort)(_previous - _value)); } - } - + /// + /// Update the Watch (read it from + /// public override void Update() { switch (Global.Config.RamWatchDefinePrevious) @@ -232,5 +202,115 @@ namespace BizHawk.Client.Common break; } } + + #endregion Implements + + //TODO: Implements IFormattable + public string FormatValue(ushort val) + { + switch (Type) + { + default: + case DisplayType.Unsigned: + return val.ToString(); + case DisplayType.Signed: + return ((short)val).ToString(); + case DisplayType.Hex: + return val.ToHexString(4); + 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, " "); + } + } + + #endregion + + #region Properties + + #region Implements + + /// + /// Get a string representation of difference + /// between current value and the previous one + /// + public override string Diff + { + get + { + return FormatValue((ushort)(_previous - _value)); + } + } + + /// + /// Get the maximum possible value + /// + public override uint MaxValue + { + get + { + return ushort.MaxValue; + } + } + + /// + /// Gets the current value + /// + public override int Value + { + get + { + return GetWord(); + } + } + + /// + /// Gets the current value + /// but with stuff I don't understand + /// + public override int ValueNoFreeze + { + get + { + return GetWord(true); + } + } + + /// + /// Get a string representation of the current value + /// + public override string ValueString + { + get + { + return FormatValue(GetWord()); + } + } + + /// + /// Get the previous value + /// + public override int Previous + { + get + { + return _previous; + } + } + + /// + /// Get a string representation of the previous value + /// + public override string PreviousStr + { + get + { + return FormatValue(_previous); + } + } + + #endregion Implements + + #endregion } } diff --git a/BizHawk.Client.EmuHawk/tools/Watch/RamSearch.cs b/BizHawk.Client.EmuHawk/tools/Watch/RamSearch.cs index b225c9065a..64bee85ee6 100644 --- a/BizHawk.Client.EmuHawk/tools/Watch/RamSearch.cs +++ b/BizHawk.Client.EmuHawk/tools/Watch/RamSearch.cs @@ -172,10 +172,10 @@ namespace BizHawk.Client.EmuHawk { var nextColor = Color.White; - var isCheat = Global.CheatList.IsActive(_settings.Domain, _searches[index].Address ?? 0); - var isWeeded = Settings.PreviewMode && !_forcePreviewClear && _searches.Preview(_searches[index].Address ?? 0); + var isCheat = Global.CheatList.IsActive(_settings.Domain, _searches[index].Address); + var isWeeded = Settings.PreviewMode && !_forcePreviewClear && _searches.Preview(_searches[index].Address); - if (_searches[index].Address.Value >= _searches[index].Domain.Size) + if (_searches[index].Address >= _searches[index].Domain.Size) { nextColor = Color.PeachPuff; } @@ -852,7 +852,7 @@ namespace BizHawk.Client.EmuHawk watches.Load(file.FullName, append); var watchList = watches.Where(x => !x.IsSeparator); - var addresses = watchList.Select(x => x.Address ?? 0).ToList(); + var addresses = watchList.Select(x => x.Address).ToList(); if (truncate) { @@ -1319,7 +1319,7 @@ namespace BizHawk.Client.EmuHawk private void FreezeAddressMenuItem_Click(object sender, EventArgs e) { - var allCheats = SelectedWatches.All(x => Global.CheatList.IsActive(x.Domain, x.Address ?? 0)); + var allCheats = SelectedWatches.All(x => Global.CheatList.IsActive(x.Domain, x.Address)); if (allCheats) { SelectedWatches.UnfreezeAll(); @@ -1463,7 +1463,7 @@ namespace BizHawk.Client.EmuHawk var allCheats = true; foreach (var index in SelectedIndices) { - if (!Global.CheatList.IsActive(_settings.Domain, _searches[index].Address ?? 0)) + if (!Global.CheatList.IsActive(_settings.Domain, _searches[index].Address)) { allCheats = false; } @@ -1490,7 +1490,7 @@ namespace BizHawk.Client.EmuHawk { if (SelectedWatches.Any()) { - ToolHelpers.ViewInHexEditor(_searches.Domain, SelectedWatches.Select(x => x.Address ?? 0), SelectedSize); + ToolHelpers.ViewInHexEditor(_searches.Domain, SelectedWatches.Select(x => x.Address), SelectedSize); } } diff --git a/BizHawk.Client.EmuHawk/tools/Watch/RamWatch.cs b/BizHawk.Client.EmuHawk/tools/Watch/RamWatch.cs index e98fc906ea..fa6438be1a 100644 --- a/BizHawk.Client.EmuHawk/tools/Watch/RamWatch.cs +++ b/BizHawk.Client.EmuHawk/tools/Watch/RamWatch.cs @@ -219,7 +219,7 @@ namespace BizHawk.Client.EmuHawk if (_watches != null && !string.IsNullOrWhiteSpace(_watches.CurrentFileName)) { - _watches.RefreshDomans(_memoryDomains, _memoryDomains.MainMemory); + _watches.RefreshDomains(_memoryDomains, _memoryDomains.MainMemory); _watches.Reload(); SetPlatformAndMemoryDomainLabel(); UpdateStatusBar(); @@ -251,7 +251,7 @@ namespace BizHawk.Client.EmuHawk { for (var i = 0; i < _watches.Count; i++) { - var frozen = !_watches[i].IsSeparator && Global.CheatList.IsActive(_watches[i].Domain, _watches[i].Address ?? 0); + var frozen = !_watches[i].IsSeparator && Global.CheatList.IsActive(_watches[i].Domain, _watches[i].Address); GlobalWin.OSD.AddGUIText( _watches[i].ToString(), Global.Config.DispRamWatchx, @@ -286,7 +286,7 @@ namespace BizHawk.Client.EmuHawk return true; } - if (Global.CheatList.IsActive(_watches.Domain, watch.Address ?? 0)) + if (Global.CheatList.IsActive(_watches.Domain, watch.Address)) { return true; } @@ -321,7 +321,7 @@ namespace BizHawk.Client.EmuHawk { for (var i = 0; i < _watches.Count; i++) { - var frozen = !_watches[i].IsSeparator && Global.CheatList.IsActive(_watches[i].Domain, _watches[i].Address ?? 0); + var frozen = !_watches[i].IsSeparator && Global.CheatList.IsActive(_watches[i].Domain, _watches[i].Address); GlobalWin.OSD.AddGUIText( _watches[i].ToString(), Global.Config.DispRamWatchx, @@ -585,7 +585,7 @@ namespace BizHawk.Client.EmuHawk } } - ErrorIconButton.Visible = _watches.Where(watch => !watch.IsSeparator).Any(watch => (watch.Address ?? 0) >= watch.Domain.Size); + ErrorIconButton.Visible = _watches.Where(watch => !watch.IsSeparator).Any(watch => (watch.Address) >= watch.Domain.Size); MessageLabel.Text = message; } @@ -608,11 +608,11 @@ namespace BizHawk.Client.EmuHawk { color = BackColor; } - else if (_watches[index].Address.Value >= _watches[index].Domain.Size) + else if (_watches[index].Address >= _watches[index].Domain.Size) { color = Color.PeachPuff; } - else if (Global.CheatList.IsActive(_watches.Domain, _watches[index].Address ?? 0)) + else if (Global.CheatList.IsActive(_watches.Domain, _watches[index].Address)) { color = Color.LightCyan; } @@ -813,7 +813,7 @@ namespace BizHawk.Client.EmuHawk private void FreezeAddressMenuItem_Click(object sender, EventArgs e) { - var allCheats = SelectedWatches.All(x => Global.CheatList.IsActive(x.Domain, x.Address ?? 0)); + var allCheats = SelectedWatches.All(x => Global.CheatList.IsActive(x.Domain, x.Address)); if (allCheats) { SelectedWatches.UnfreezeAll(); @@ -1074,7 +1074,7 @@ namespace BizHawk.Client.EmuHawk SelectedIndices.Any() && SelectedWatches.All(w => w.Domain.CanPoke()); - var allCheats = _watches.All(x => Global.CheatList.IsActive(x.Domain, x.Address ?? 0)); + var allCheats = _watches.All(x => Global.CheatList.IsActive(x.Domain, x.Address)); if (allCheats) { @@ -1108,11 +1108,11 @@ namespace BizHawk.Client.EmuHawk if (selected.Select(x => x.Domain).Distinct().Count() > 1) { - ToolHelpers.ViewInHexEditor(selected[0].Domain, new List { selected.First().Address ?? 0 }, selected.First().Size); + ToolHelpers.ViewInHexEditor(selected[0].Domain, new List { selected.First().Address }, selected.First().Size); } else { - ToolHelpers.ViewInHexEditor(selected.First().Domain, selected.Select(x => x.Address ?? 0), selected.First().Size); + ToolHelpers.ViewInHexEditor(selected.First().Domain, selected.Select(x => x.Address ), selected.First().Size); } } } @@ -1127,7 +1127,7 @@ namespace BizHawk.Client.EmuHawk foreach (var watch in selected) { - debugger.AddBreakpoint((uint)watch.Address.Value, MemoryCallbackType.Read); + debugger.AddBreakpoint((uint)watch.Address, MemoryCallbackType.Read); } } } @@ -1142,7 +1142,7 @@ namespace BizHawk.Client.EmuHawk foreach (var watch in selected) { - debugger.AddBreakpoint((uint)watch.Address.Value, MemoryCallbackType.Write); + debugger.AddBreakpoint((uint)watch.Address, MemoryCallbackType.Write); } } } @@ -1194,7 +1194,7 @@ namespace BizHawk.Client.EmuHawk private void ErrorIconButton_Click(object sender, EventArgs e) { var items = _watches - .Where(watch => (watch.Address ?? 0) >= watch.Domain.Size) + .Where(watch => (watch.Address) >= watch.Domain.Size) .ToList(); foreach (var item in items) diff --git a/BizHawk.Client.EmuHawk/tools/Watch/WatchEditor.cs b/BizHawk.Client.EmuHawk/tools/Watch/WatchEditor.cs index 159630392a..aed8c75af3 100644 --- a/BizHawk.Client.EmuHawk/tools/Watch/WatchEditor.cs +++ b/BizHawk.Client.EmuHawk/tools/Watch/WatchEditor.cs @@ -96,7 +96,7 @@ namespace BizHawk.Client.EmuHawk else { NotesBox.Text = _watchList[0].Notes; - AddressBox.SetFromLong(_watchList[0].Address ?? 0); + AddressBox.SetFromLong(_watchList[0].Address); } SetBigEndianCheckBox(); @@ -267,7 +267,7 @@ namespace BizHawk.Client.EmuHawk { _watchList.Add(Watch.GenerateWatch( watch.Domain, - watch.Address ?? 0, + watch.Address, watch.Size, watch.Type, watch.BigEndian, @@ -308,7 +308,7 @@ namespace BizHawk.Client.EmuHawk _watchList[i] = Watch.GenerateWatch( _watchList[i].Domain, - _watchList.Count == 1 ? AddressBox.ToRawInt() ?? 0 : _watchList[i].Address ?? 0, + _watchList.Count == 1 ? AddressBox.ToRawInt() ?? 0 : _watchList[i].Address, size, _watchList[i].Type, _watchList[i].BigEndian,