/*
    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.Disassembly {
	/// <summary>
	/// Contains the code that will be disassembled
	/// </summary>
	public readonly struct NativeCode {
		/// <summary>
		/// Gets the code kind
		/// </summary>
		public NativeCodeKind Kind { get; }

		/// <summary>
		/// Gets the optimization kind
		/// </summary>
		public NativeCodeOptimization Optimization { get; }

		/// <summary>
		/// All blocks to disassemble
		/// </summary>
		public NativeCodeBlock[] Blocks { get; }

		/// <summary>
		/// Extra optional info, or null if none
		/// </summary>
		public NativeCodeInfo? CodeInfo { get; }

		/// <summary>
		/// Variable info or null
		/// </summary>
		public NativeVariableInfo[]? VariableInfo { get; }

		/// <summary>
		/// Method name or null
		/// </summary>
		public string? MethodName { get; }

		/// <summary>
		/// Short method name or null
		/// </summary>
		public string? ShortMethodName { get; }

		/// <summary>
		/// Module name or null
		/// </summary>
		public string? ModuleName { get; }

		/// <summary>
		/// Constructor
		/// </summary>
		/// <param name="kind">Code kind</param>
		/// <param name="optimization">Optimization kind</param>
		/// <param name="blocks">All blocks to disassemble</param>
		/// <param name="codeInfo">Extra code info or null</param>
		/// <param name="variableInfo">Variable info or null</param>
		/// <param name="methodName">Method name or null</param>
		/// <param name="shortMethodName">Short method name or null</param>
		/// <param name="moduleName">Module name or null</param>
		public NativeCode(NativeCodeKind kind, NativeCodeOptimization optimization, NativeCodeBlock[] blocks, NativeCodeInfo? codeInfo, NativeVariableInfo[]? variableInfo, string? methodName, string? shortMethodName, string? moduleName) {
			Kind = kind;
			Optimization = optimization;
			Blocks = blocks ?? throw new ArgumentNullException(nameof(blocks));
			CodeInfo = codeInfo;
			VariableInfo = variableInfo;
			MethodName = methodName;
			ShortMethodName = shortMethodName;
			ModuleName = moduleName;
		}
	}

	/// <summary>
	/// Base class of extra info a disassembler can use
	/// </summary>
	public abstract class NativeCodeInfo {
	}
}