Dnspy/dnSpy/dnSpy.Contracts.Debugger/Exceptions/DbgExceptionId.cs

/*
    Copyright (C) 2014-2019 de4dot@gmail.com

    This file is part of dnSpy

    dnSpy 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.

    dnSpy 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 dnSpy.  If not, see <http://www.gnu.org/licenses/>.
*/

using System;

namespace dnSpy.Contracts.Debugger.Exceptions {
	/// <summary>
	/// Exception ID
	/// </summary>
	public readonly struct DbgExceptionId : IEquatable<DbgExceptionId> {
		readonly string category;
		readonly string? name;
		readonly int code;
		readonly Flags flags;

		[Flags]
		enum Flags : byte {
			KindMask	= 3,
		}

		/// <summary>
		/// Gets the id kind
		/// </summary>
		public DbgExceptionIdKind Kind => (DbgExceptionIdKind)(flags & Flags.KindMask);

		/// <summary>
		/// Exception category, same as <see cref="DbgExceptionCategoryDefinition.Name"/>
		/// </summary>
		public string Category => category;

		/// <summary>
		/// Name of exception (case insensitive). This property is only valid if <see cref="HasName"/> is true
		/// </summary>
		public string? Name => name;

		/// <summary>
		/// Exception code. This property is only valid if <see cref="HasCode"/> is true
		/// </summary>
		public int Code => code;

		/// <summary>
		/// true if the exception has a code, and not a name
		/// </summary>
		public bool HasCode => Kind == DbgExceptionIdKind.Code;

		/// <summary>
		/// true if the exception has a name, and not a code
		/// </summary>
		public bool HasName => Kind == DbgExceptionIdKind.Name;

		/// <summary>
		/// true if this is the default exception ID
		/// </summary>
		public bool IsDefaultId => Kind == DbgExceptionIdKind.DefaultId;

		/// <summary>
		/// Constructor for default ids
		/// </summary>
		/// <param name="category">Exception category, same as <see cref="DbgExceptionCategoryDefinition.Name"/></param>
		public DbgExceptionId(string category) {
			this.category = category ?? throw new ArgumentNullException(nameof(category));
			name = null;
			code = 0;
			flags = (Flags)DbgExceptionIdKind.DefaultId;
		}

		/// <summary>
		/// Constructor
		/// </summary>
		/// <param name="category">Exception category, same as <see cref="DbgExceptionCategoryDefinition.Name"/></param>
		/// <param name="name">Name of exception, must not be null</param>
		public DbgExceptionId(string category, string name) {
			this.category = category ?? throw new ArgumentNullException(nameof(category));
			this.name = name ?? throw new ArgumentNullException(nameof(name));
			code = 0;
			flags = (Flags)DbgExceptionIdKind.Name;
		}

		/// <summary>
		/// Constructor
		/// </summary>
		/// <param name="category">Exception category, same as <see cref="DbgExceptionCategoryDefinition.Name"/></param>
		/// <param name="code">Exception code</param>
		public DbgExceptionId(string category, int code) {
			this.category = category ?? throw new ArgumentNullException(nameof(category));
			name = null;
			this.code = code;
			flags = (Flags)DbgExceptionIdKind.Code;
		}

		/// <summary>
		/// Constructor
		/// </summary>
		/// <param name="category">Exception category, same as <see cref="DbgExceptionCategoryDefinition.Name"/></param>
		/// <param name="code">Exception code</param>
		public DbgExceptionId(string category, uint code)
			: this(category, (int)code) {
		}

#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
		public static bool operator ==(DbgExceptionId left, DbgExceptionId right) => left.Equals(right);
		public static bool operator !=(DbgExceptionId left, DbgExceptionId right) => !left.Equals(right);
#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member

		/// <summary>
		/// Equals()
		/// </summary>
		/// <param name="other">Other instance</param>
		/// <returns></returns>
		public bool Equals(DbgExceptionId other) {
			if (flags != other.flags)
				return false;
			if (Kind == DbgExceptionIdKind.Code) {
				if (code != other.code)
					return false;
			}
			else {
				if (!StringComparer.OrdinalIgnoreCase.Equals(name, other.name))
					return false;
			}
			if (!StringComparer.Ordinal.Equals(category, other.category))
				return false;
			return true;
		}

		/// <summary>
		/// Equals()
		/// </summary>
		/// <param name="obj"></param>
		/// <returns></returns>
		public override bool Equals(object? obj) => obj is DbgExceptionId other && Equals(other);

		/// <summary>
		/// Gets the hashcode
		/// </summary>
		/// <returns></returns>
		public override int GetHashCode() {
			int hc = (int)flags ^ StringComparer.Ordinal.GetHashCode(category ?? string.Empty);
			if (Kind == DbgExceptionIdKind.Code)
				hc ^= code;
			else
				hc ^= StringComparer.OrdinalIgnoreCase.GetHashCode(name ?? string.Empty);
			return hc;
		}

		/// <summary>
		/// ToString()
		/// </summary>
		/// <returns></returns>
		public override string ToString() {
			if (category is null)
				return "<not-initialized>";
			switch (Kind) {
			case DbgExceptionIdKind.DefaultId:	return category + " - <<default>>";
			case DbgExceptionIdKind.Code:		return "0x" + code.ToString("X8");
			case DbgExceptionIdKind.Name:		return category + " - " + name;
			default:							return "???";
			}
		}
	}

	/// <summary>
	/// <see cref="DbgExceptionId"/> kind
	/// </summary>
	public enum DbgExceptionIdKind {
		/// <summary>
		/// Default ID
		/// </summary>
		DefaultId,

		/// <summary>
		/// Code
		/// </summary>
		Code,

		/// <summary>
		/// Name
		/// </summary>
		Name,
	}
}