SharpDevelop/src/Main/Base/Project/Src/Gui/Pads/CompilerMessageView/CompilerMessageView.cs

// <file>
//     <copyright see="prj:///doc/copyright.txt"/>
//     <license see="prj:///doc/license.txt"/>
//     <owner name="Mike Krüger" email="mike@icsharpcode.net"/>
//     <version value="$version"/>
// </file>

using System;
using System.Collections;
using System.Collections.Generic;
using System.Text;
using System.Threading;
using System.Windows.Forms;
using System.Drawing;
using System.CodeDom.Compiler;
using System.IO;
using System.Diagnostics;
using ICSharpCode.Core;
using ICSharpCode.SharpDevelop.Gui.OptionPanels;
using ICSharpCode.SharpDevelop.Project;
using ICSharpCode.TextEditor;

namespace ICSharpCode.SharpDevelop.Gui
{
	/// <summary>
	/// This class displays the errors and warnings which the compiler outputs and
	/// allows the user to jump to the source of the warnig / error
	/// </summary>
	public class CompilerMessageView : AbstractPadContent, IClipboardHandler
	{
		static CompilerMessageView instance;
		
		public static CompilerMessageView Instance {
			get {
				return instance;
			}
		}
		
//		RichTextBox textEditorControl = new RichTextBox();
		
		TextEditorControl textEditorControl = new TextEditorControl();
		Panel             myPanel           = new Panel();
		
		List<MessageViewCategory> messageCategories = new List<MessageViewCategory>();
		
		int selectedCategory = 0;
		public int SelectedCategoryIndex {
			get {
				return selectedCategory;
			}
			set {
				if (selectedCategory != value) {
					selectedCategory = value;
					OnSelectedCategoryIndexChanged(EventArgs.Empty);
				}
			}
		}
		
		public bool WordWrap {
			get {
				return properties.Get("WordWrap", true);
			}
			set {
				properties.Set("WordWrap", value);
			}
		}
		
		public MessageViewCategory SelectedMessageViewCategory {
			get {
				if (selectedCategory >= 0) {
					return messageCategories[selectedCategory];
				}
				return null;
			}
		}
		
		// The compiler message view properties.
		Properties 	properties	      = null;
		
		public List<MessageViewCategory> MessageCategories {
			get {
				return messageCategories;
			}
		}
		
		public override Control Control {
			get {
				return myPanel;
			}
		}
		
		public CompilerMessageView()
		{
			instance = this;
			
			AddCategory(TaskService.BuildMessageViewCategory);
			
			myPanel.SuspendLayout();
			textEditorControl.Dock              = DockStyle.Fill;
			textEditorControl.ShowLineNumbers   = false;
			textEditorControl.ShowInvalidLines  = false;
			textEditorControl.EnableFolding     = false;
			textEditorControl.IsIconBarVisible  = false;
			textEditorControl.Document.ReadOnly = true;
			textEditorControl.ShowHRuler        = false;
			textEditorControl.ShowVRuler        = false;
			textEditorControl.ShowSpaces        = false;
			textEditorControl.ShowTabs          = false;
			textEditorControl.ShowEOLMarkers    = false;
			
			textEditorControl.ContextMenuStrip = MenuService.CreateContextMenu(this, "/SharpDevelop/Pads/CompilerMessageView/ContextMenu");
			
			properties = (Properties)PropertyService.Get(OutputWindowOptionsPanel.OutputWindowsProperty, new Properties());
			
			textEditorControl.Font     = FontSelectionPanel.ParseFont(properties.Get("DefaultFont", new Font("Courier New", 10).ToString()).ToString());
			properties.PropertyChanged += new PropertyChangedEventHandler(PropertyChanged);
			
			textEditorControl.MouseDown += new MouseEventHandler(TextEditorControlMouseDown);
			textEditorControl.BackColor = SystemColors.Window;
			
			ToolStrip toolStrip = ToolbarService.CreateToolStrip(this, "/SharpDevelop/Pads/CompilerMessageView/Toolbar");
			toolStrip.Stretch   = true;
			toolStrip.GripStyle = System.Windows.Forms.ToolStripGripStyle.Hidden;
			
			myPanel.Controls.AddRange(new Control[] { textEditorControl, toolStrip} );
			
			SetWordWrap();
			myPanel.ResumeLayout(false);
			SetText(StringParser.Parse(messageCategories[selectedCategory].Text));
		}
		
		void SetWordWrap()
		{
//			bool wordWrap = properties.Get("WordWrap", true);
//			textEditorControl.WordWrap = wordWrap;
//			if (wordWrap) {
//				textEditorControl.ScrollBars = RichTextBoxScrollBars.ForcedBoth;
//			} else {
//				textEditorControl.ScrollBars = RichTextBoxScrollBars.ForcedVertical;
//			}
		}
		
		public override void RedrawContent()
		{
//			messageCategory.Items.Clear();
//			foreach (MessageViewCategory category in messageCategories) {
//				messageCategory.Items.Add(StringParser.Parse(category.DisplayCategory));
//			}
		}
		
		#region Category handling
		public void AddCategory(MessageViewCategory category)
		{
			messageCategories.Add(category);
			category.Cleared      += new EventHandler(CategoryTextCleared);
			category.TextSet      += new TextEventHandler(CategoryTextSet);
			category.TextAppended += new TextEventHandler(CategoryTextAppended);
			
			OnMessageCategoryAdded(EventArgs.Empty);
		}
		
		void CategoryTextCleared(object sender, EventArgs e)
		{
			MessageViewCategory category = (MessageViewCategory)sender;
			SelectCategory(category.Category);
			WorkbenchSingleton.SafeThreadCall(this, "ClearText");
		}
		void ClearText()
		{
			textEditorControl.Text = "";
			textEditorControl.Refresh();
		}
		
		void CategoryTextSet(object sender, TextEventArgs e)
		{
			MessageViewCategory category = (MessageViewCategory)sender;
			SelectCategory(category.Category);
			WorkbenchSingleton.SafeThreadCall(this, "SetText", StringParser.Parse(messageCategories[selectedCategory].Text));
		}
		
		void CategoryTextAppended(object sender, TextEventArgs e)
		{
			MessageViewCategory category = (MessageViewCategory)sender;
			int oldCategory = SelectedCategoryIndex;
			SelectCategory(category.Category);
			if (oldCategory != SelectedCategoryIndex)
				WorkbenchSingleton.SafeThreadCall(this, "SetText", StringParser.Parse(messageCategories[selectedCategory].Text));
			else
				WorkbenchSingleton.SafeThreadCall(this, "AppendText", StringParser.Parse(e.Text));
		}
		
		void AppendText(string text)
		{
			if (text != null) {
				textEditorControl.Document.ReadOnly = false;
				textEditorControl.Document.Insert(textEditorControl.Document.TextLength, text);
				textEditorControl.Document.ReadOnly = true;
				textEditorControl.ActiveTextAreaControl.Caret.Position = new Point(0, textEditorControl.Document.TotalNumberOfLines);
				textEditorControl.ActiveTextAreaControl.ScrollTo(textEditorControl.Document.TotalNumberOfLines);
			}
		}
		
		void SetText(string text)
		{
			if (text == null) {
				text = String.Empty;
			}
			textEditorControl.Text = text;
			textEditorControl.Refresh();
//			textEditorControl.Select(text.Length , 0);
//			textEditorControl.Select();
//			textEditorControl.ScrollToCaret();
		}
		
		
		public void SelectCategory(string categoryName)
		{
			for (int i = 0; i < messageCategories.Count; ++i) {
				MessageViewCategory category = (MessageViewCategory)messageCategories[i];
				if (category.Category == categoryName) {
					SelectedCategoryIndex = i;
					break;
				}
			}
			ActivateThisPad();
		}
		
		public MessageViewCategory GetCategory(string categoryName)
		{
			foreach (MessageViewCategory category in messageCategories) {
				if (category.Category == categoryName) {
					return category;
				}
			}
			return null;
		}
		#endregion
		
		delegate void StringDelegate(string text);
		
		/// <summary>
		/// Makes this pad visible (usually BEFORE build or debug events)
		/// </summary>
		void ActivateThisPad()
		{
			WorkbenchSingleton.Workbench.WorkbenchLayout.ActivatePad(this.GetType().FullName);
		}
		
		void MessageCategorySelectedIndexChanged(object sender, EventArgs e)
		{
			WorkbenchSingleton.SafeThreadCall(this, "SetText", StringParser.Parse(messageCategories[selectedCategory].Text));
		}
		
		/// <summary>
		/// Occurs when the mouse pointer is over the control and a
		/// mouse button is pressed.
		/// </summary>
		void TextEditorControlMouseDown(object sender, MouseEventArgs e)
		{
//			// Double click?
//			if (e.Clicks == 2) {
//				// Any text?
//				if (textEditorControl.Text.Length > 0) {
//
//					// Parse text line double clicked.
//					Point point = new Point(e.X, e.Y);
//
//					int charIndex = textEditorControl.GetCharIndexFromPosition(point);
//					string textLine = GetTextLine(charIndex, textEditorControl.Text);
//
//					FileLineReference lineReference = OutputTextLineParser.GetFileLineReference(textLine);
//					if (lineReference != null) {
//						// Open matching file.
//						JumpToFilePosition(Path.GetFullPath(lineReference.FileName),
//						                   lineReference.Line,
//						                   lineReference.Column);
//					}
//				}
//			}
		}
		/// <summary>
		/// Gets the line of text that includes the specified
		/// character index.
		/// </summary>
		/// <remarks>
		/// This is used instead of using the <see cref="RichTextBox.Lines"/>
		/// array since we have to take into account word wrapping.
		/// </remarks>
		string GetTextLine(int charIndex, string textLines)
		{
			Debug.Assert(charIndex < textLines.Length, String.Concat("CharIndex out of range. charIndex=", charIndex, ", textLines.Length=", textLines.Length));
			
			string textLine = String.Empty;
			
			int lineStartIndex = 0;
			int lineLength = 0;
			bool wasFound = false;
			
			for (int i = 0; i < textLines.Length; ++i) {
				char ch = textLines[i];
				
				if (ch == '\r' || ch == '\n') {
					// End of line.
					if (i >= charIndex) {
						// Found line.
						textLine = textLines.Substring(lineStartIndex, lineLength);
						wasFound = true;
						break;
					} else {
						lineStartIndex = i + 1;
						lineLength = 0;
					}
				} else {
					++lineLength;
				}
			}
			
			if (!wasFound && (lineLength > 0)) {
				textLine = textLines.Substring(lineStartIndex, lineLength);
			}
			
			return textLine;
		}
		
		/// <summary>
		/// Jumps to the specified file line number and position.
		/// </summary>
		/// <param name="filename">The filename.</param>
		/// <param name="line">The line number.</param>
		/// <param name="column">The line column</param>
		private void JumpToFilePosition(string filename, int line, int column)
		{
			FileService.JumpToFilePosition(filename, line, column);
		}
		
		/// <summary>
		/// Changes wordwrap settings if that property has changed.
		/// </summary>
		void PropertyChanged(object sender, PropertyChangedEventArgs e)
		{
			if (e.Key == "WordWrap") {
				SetWordWrap();
			}
			if (e.Key == "DefaultFont") {
				textEditorControl.Font = FontSelectionPanel.ParseFont(properties.Get("DefaultFont", new Font("Courier New", 10).ToString()).ToString());
			}
		}
		
		protected virtual void OnMessageCategoryAdded(EventArgs e)
		{
			if (MessageCategoryAdded != null) {
				MessageCategoryAdded(this, e);
			}
		}
		
		protected virtual void OnSelectedCategoryIndexChanged(EventArgs e)
		{
			if (SelectedCategoryIndexChanged != null) {
				SelectedCategoryIndexChanged(this, e);
			}
		}
		
		public event EventHandler MessageCategoryAdded;
		public event EventHandler SelectedCategoryIndexChanged;
		
		#region ICSharpCode.SharpDevelop.Gui.IClipboardHandler interface implementation
		public bool EnableCut {
			get {
				return false;
			}
		}
		
		public bool EnableCopy {
			get {
				return true;
			}
		}
		
		public bool EnablePaste {
			get {
				return false;
			}
		}
		
		public bool EnableDelete {
			get {
				return false;
			}
		}
		
		public bool EnableSelectAll {
			get {
				return true;
			}
		}
		
		public void Cut()
		{
		}
		
		public void Copy()
		{
			new ICSharpCode.TextEditor.Actions.Copy().Execute(textEditorControl.ActiveTextAreaControl.TextArea);
		}
		
		public void Paste()
		{
		}
		
		public void Delete()
		{
		}
		
		public void SelectAll()
		{
			new ICSharpCode.TextEditor.Actions.SelectWholeDocument().Execute(textEditorControl.ActiveTextAreaControl.TextArea);
//			textEditorControl.SelectAll();
		}
		#endregion
		
	}
}