/*
    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.Threading.Tasks;

namespace dnSpy.Contracts.Documents.Tabs {
	/// <summary>
	/// <see cref="DocumentTabContent"/> that creates its output asynchronously in another thread
	/// </summary>
	public abstract class AsyncDocumentTabContent : DocumentTabContent {
		/// <summary>
		/// Returns true if <see cref="CreateContentAsync(IAsyncShowContext)"/>
		/// should be called
		/// </summary>
		/// <param name="ctx">Context</param>
		/// <returns></returns>
		public abstract bool NeedAsyncWork(IShowContext ctx);

		/// <summary>
		/// Called in the worker thread
		/// </summary>
		/// <param name="ctx">Context</param>
		public abstract Task CreateContentAsync(IAsyncShowContext ctx);

		/// <summary>
		/// Called in the main UI thread after the worker thread has exited or was interrupted
		/// </summary>
		/// <param name="ctx">Context</param>
		/// <param name="result">Result</param>
		public abstract void OnShowAsync(IShowContext ctx, IAsyncShowResult result);
	}
}