/*
    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.Generic;
using dnSpy.Contracts.Text;
using dnSpy.Contracts.Text.Classification;
using Microsoft.VisualStudio.Text.Classification;

namespace dnSpy.Contracts.TreeView.Text {
	/// <summary>
	/// Treeview node classifier context passed to <see cref="ITextClassifier"/>s that classify treeview nodes
	/// </summary>
	public class TreeViewNodeClassifierContext : TextClassifierContext {
		/// <summary>
		/// Gets the treeview
		/// </summary>
		public ITreeView TreeView { get; }

		/// <summary>
		/// Gets the node to classify
		/// </summary>
		public TreeNodeData Node { get; }

		/// <summary>
		/// true if the content will be shown in a tooltip
		/// </summary>
		public bool IsToolTip { get; }

		/// <summary>
		/// Constructor
		/// </summary>
		/// <param name="text">Text to classify</param>
		/// <param name="treeView">Treeview</param>
		/// <param name="node">Node to classify</param>
		/// <param name="isToolTip">true if the content will be shown in a tooltip</param>
		/// <param name="colorize">true if it should be colorized</param>
		/// <param name="colors">Default colors or null. It doesn't have to be sorted and elements can overlap. The colors
		/// must be <see cref="IClassificationType"/>s or <see cref="TextColor"/>s</param>
		public TreeViewNodeClassifierContext(string text, ITreeView treeView, TreeNodeData node, bool isToolTip, bool colorize, IReadOnlyCollection<SpanData<object>>? colors = null)
			: base(text, string.Empty, colorize, colors) {
			TreeView = treeView ?? throw new ArgumentNullException(nameof(treeView));
			Node = node ?? throw new ArgumentNullException(nameof(node));
			IsToolTip = isToolTip;
		}
	}
}