Dnspy/dnSpy/dnSpy.Contracts.DnSpy/Hex/Files/BufferField.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.Hex.Files {
	/// <summary>
	/// A field
	/// </summary>
	public abstract class BufferField {
		/// <summary>
		/// Constructor
		/// </summary>
		/// <param name="data">Data type</param>
		protected BufferField(BufferData data) => Data = data ?? throw new ArgumentNullException(nameof(data));

		/// <summary>
		/// Gets the name
		/// </summary>
		public abstract string Name { get; }

		/// <summary>
		/// Gets the data type
		/// </summary>
		public BufferData Data { get; }

		/// <summary>
		/// Writes the field name
		/// </summary>
		/// <param name="formatter">Formatter</param>
		public abstract void WriteName(HexFieldFormatter formatter);
	}

	/// <summary>
	/// A field in a structure
	/// </summary>
	public class StructField : BufferField {
		/// <summary>
		/// Gets the field name
		/// </summary>
		public sealed override string Name => name;
		readonly string name;

		/// <summary>
		/// Constructor
		/// </summary>
		/// <param name="name">Name</param>
		/// <param name="data">Data type</param>
		public StructField(string name, BufferData data)
			: base(data) => this.name = name ?? throw new ArgumentNullException(nameof(name));

		/// <summary>
		/// Writes the field name
		/// </summary>
		/// <param name="formatter">Formatter</param>
		public sealed override void WriteName(HexFieldFormatter formatter) => formatter.WriteField(Name);
	}

	/// <summary>
	/// A field in a structure
	/// </summary>
	public class StructField<TData> : StructField where TData : BufferData {
		/// <summary>
		/// Gets the data type
		/// </summary>
		public new TData Data => (TData)base.Data;

		/// <summary>
		/// Constructor
		/// </summary>
		/// <param name="name">Name</param>
		/// <param name="data">Data type</param>
		public StructField(string name, TData data)
			: base(name, data) {
		}
	}

	/// <summary>
	/// An array field
	/// </summary>
	public class ArrayField : BufferField {
		readonly uint index;

		/// <summary>
		/// Gets the name
		/// </summary>
		public sealed override string Name => index.ToString();

		/// <summary>
		/// Constructor
		/// </summary>
		/// <param name="data">Data type</param>
		/// <param name="index">Array index</param>
		public ArrayField(BufferData data, uint index)
			: base(data) => this.index = index;

		/// <summary>
		/// Writes the field name
		/// </summary>
		/// <param name="formatter">Formatter</param>
		public sealed override void WriteName(HexFieldFormatter formatter) => formatter.WriteArrayField(index);
	}

	/// <summary>
	/// An array field
	/// </summary>
	public class ArrayField<TData> : ArrayField where TData : BufferData {
		/// <summary>
		/// Gets the data type
		/// </summary>
		public new TData Data => (TData)base.Data;

		/// <summary>
		/// Constructor
		/// </summary>
		/// <param name="data">Data type</param>
		/// <param name="index">Array index</param>
		public ArrayField(TData data, uint index)
			: base(data, index) {
		}
	}
}