Dnspy/dnSpy/dnSpy.Contracts.Debugger/Engine/DbgEngineThread.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;
using System.Collections.ObjectModel;

namespace dnSpy.Contracts.Debugger.Engine {
	/// <summary>
	/// A class that can update a <see cref="DbgThread"/>
	/// </summary>
	public abstract class DbgEngineThread {
		/// <summary>
		/// Gets the thread
		/// </summary>
		public abstract DbgThread Thread { get; }

		/// <summary>
		/// Removes the thread and disposes of it. The engine has paused the program.
		/// </summary>
		/// <param name="messageFlags">Message flags</param>
		public abstract void Remove(DbgEngineMessageFlags messageFlags);

		/// <summary>
		/// Properties to update
		/// </summary>
		[Flags]
		public enum UpdateOptions {
			/// <summary>
			/// No option is enabled
			/// </summary>
			None				= 0,

			/// <summary>
			/// Update <see cref="DbgThread.AppDomain"/>
			/// </summary>
			AppDomain			= 0x00000001,

			/// <summary>
			/// Update <see cref="DbgThread.Kind"/>
			/// </summary>
			Kind				= 0x00000002,

			/// <summary>
			/// Update <see cref="DbgThread.Id"/>
			/// </summary>
			Id					= 0x00000004,

			/// <summary>
			/// Update <see cref="DbgThread.ManagedId"/>
			/// </summary>
			ManagedId			= 0x00000008,

			/// <summary>
			/// Update <see cref="DbgThread.Name"/>
			/// </summary>
			Name				= 0x00000010,

			/// <summary>
			/// Update <see cref="DbgThread.SuspendedCount"/>
			/// </summary>
			SuspendedCount		= 0x00000020,

			/// <summary>
			/// Update <see cref="DbgThread.State"/>
			/// </summary>
			State				= 0x00000040,
		}

		/// <summary>
		/// Updates <see cref="DbgThread.AppDomain"/>
		/// </summary>
		/// <param name="appDomain">New value</param>
		public void UpdateAppDomain(DbgAppDomain appDomain) => Update(UpdateOptions.AppDomain, appDomain: appDomain);

		/// <summary>
		/// Updates <see cref="DbgThread.Kind"/>
		/// </summary>
		/// <param name="kind">New value</param>
		public void UpdateKind(string kind) => Update(UpdateOptions.Kind, kind: kind);

		/// <summary>
		/// Updates <see cref="DbgThread.Id"/>
		/// </summary>
		/// <param name="id">New value</param>
		public void UpdateId(ulong id) => Update(UpdateOptions.Id, id: id);

		/// <summary>
		/// Updates <see cref="DbgThread.ManagedId"/>
		/// </summary>
		/// <param name="managedId">New value</param>
		public void UpdateManagedId(ulong? managedId) => Update(UpdateOptions.ManagedId, managedId: managedId);

		/// <summary>
		/// Updates <see cref="DbgThread.Name"/>
		/// </summary>
		/// <param name="name">New value</param>
		public void UpdateName(string name) => Update(UpdateOptions.Name, name: name);

		/// <summary>
		/// Updates <see cref="DbgThread.SuspendedCount"/>
		/// </summary>
		/// <param name="suspendedCount">New value</param>
		public void UpdateSuspendedCount(int suspendedCount) => Update(UpdateOptions.SuspendedCount, suspendedCount: suspendedCount);

		/// <summary>
		/// Updates <see cref="DbgThread.State"/>
		/// </summary>
		/// <param name="state">New value</param>
		public void UpdateState(ReadOnlyCollection<DbgStateInfo> state) => Update(UpdateOptions.State, state: state);

		/// <summary>
		/// Updates <see cref="DbgThread"/> properties
		/// </summary>
		/// <param name="options">Options</param>
		/// <param name="appDomain">New <see cref="DbgThread.AppDomain"/> value</param>
		/// <param name="kind">New <see cref="DbgThread.Kind"/> value</param>
		/// <param name="id">New <see cref="DbgThread.Id"/> value</param>
		/// <param name="managedId">New <see cref="DbgThread.ManagedId"/> value</param>
		/// <param name="name">New <see cref="DbgThread.Name"/> value</param>
		/// <param name="suspendedCount">New <see cref="DbgThread.SuspendedCount"/> value</param>
		/// <param name="state">New <see cref="DbgThread.State"/> value</param>
		public abstract void Update(UpdateOptions options, DbgAppDomain? appDomain = null, string? kind = null, ulong id = 0, ulong? managedId = null, string? name = null, int suspendedCount = 0, ReadOnlyCollection<DbgStateInfo>? state = null);
	}
}