path: root/main/src/core/MonoDevelop.Ide/MonoDevelop.Ide.Editor/TextEditorViewContent.cs

//
// TextEditorViewContent.cs
//
// Author:
//       Mike Krüger <mkrueger@xamarin.com>
//
// Copyright (c) 2014 Xamarin Inc. (http://xamarin.com)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
using System;
using MonoDevelop.Ide.Gui;
using MonoDevelop.Projects;
using MonoDevelop.Ide.Gui.Content;
using MonoDevelop.Components.Commands;
using MonoDevelop.Ide.Commands;
using System.Collections;
using System.Collections.Generic;
using MonoDevelop.Ide.TypeSystem;
using System.IO;
using MonoDevelop.Core.Text;
using System.Text;
using Gtk;
using ICSharpCode.NRefactory.TypeSystem;
using System.Linq;
using MonoDevelop.Ide.Editor.Extension;
using ICSharpCode.NRefactory.Refactoring;
using MonoDevelop.Components;
using MonoDevelop.Core;
using System.Threading.Tasks;
using System.Threading;
using Microsoft.CodeAnalysis;
using Gdk;
using MonoDevelop.Ide.CodeFormatting;
using System.Collections.Immutable;
using Microsoft.VisualStudio.CodingConventions;
using Microsoft.VisualStudio.Text;
using Microsoft.VisualStudio.Text.Editor;

namespace MonoDevelop.Ide.Editor
{
	/// <summary>
	/// The TextEditor object needs to be available through BaseViewContent.GetContent therefore we need to insert a 
	/// decorator in between.
	/// </summary>
	[Obsolete]
	class TextEditorViewContent : ViewContent, ICommandRouter
	{
		readonly TextEditor textEditor;
		readonly ITextEditorImpl textEditorImpl;

		MonoDevelop.Projects.Policies.PolicyContainer policyContainer;

		public TextEditorViewContent (TextEditor textEditor, ITextEditorImpl textEditorImpl)
		{
			if (textEditor == null)
				throw new ArgumentNullException (nameof (textEditor));
			if (textEditorImpl == null)
				throw new ArgumentNullException (nameof (textEditorImpl));
			this.textEditor = textEditor;
			this.textEditorImpl = textEditorImpl;
			this.textEditor.MimeTypeChanged += UpdateTextEditorOptions;
			DefaultSourceEditorOptions.Instance.Changed += UpdateTextEditorOptions;
			textEditorImpl.ViewContent.ContentNameChanged += ViewContent_ContentNameChanged;
			textEditorImpl.ViewContent.DirtyChanged += ViewContent_DirtyChanged; 
			textEditor.Options = DefaultSourceEditorOptions.Instance.Create ();
		}

		protected override void OnContentNameChanged ()
		{
			base.OnContentNameChanged ();
			if (ContentName != textEditorImpl.ContentName && !string.IsNullOrEmpty (textEditorImpl.ContentName))
				AutoSave.RemoveAutoSaveFile (textEditorImpl.ContentName);
			if (ContentName != null) // Happens when a file is converted to an untitled file, but even in that case the text editor should be associated with the old location, otherwise typing can be messed up due to change of .editconfig settings etc.
				textEditor.FileName = ContentName;
			if (this.WorkbenchWindow?.Document != null)
				textEditor.InitializeExtensionChain (this.WorkbenchWindow.Document);
			UpdateTextEditorOptions (null, null);
		}

		void ViewContent_ContentNameChanged (object sender, EventArgs e)
		{
			this.ContentName = textEditorImpl.ViewContent.ContentName;
		}

		void ViewContent_DirtyChanged (object sender, EventArgs e)
		{
			OnDirtyChanged ();
		}

		void HandleDirtyChanged (object sender, EventArgs e)
		{
			IsDirty = textEditorImpl.ViewContent.IsDirty;
			InformAutoSave ();
		}

		void HandleTextChanged (object sender, TextChangeEventArgs e)
		{
			InformAutoSave ();
		}

		CancellationTokenSource editorOptionsUpdateCancellationSource;
		void UpdateTextEditorOptions (object sender, EventArgs e)
		{
			editorOptionsUpdateCancellationSource?.Cancel ();
			editorOptionsUpdateCancellationSource = new CancellationTokenSource ();
			UpdateStyleParent (Project, textEditor.MimeType, editorOptionsUpdateCancellationSource.Token).Ignore ();
		}

		uint autoSaveTimer = 0;
		Task autoSaveTask;
		void InformAutoSave ()
		{
			if (isDisposed)
				return;
			RemoveAutoSaveTimer ();
			autoSaveTimer = GLib.Timeout.Add (500, delegate {
				autoSaveTimer = 0;
				if (autoSaveTask != null && !autoSaveTask.IsCompleted)
					return false;

				autoSaveTask = AutoSave.InformAutoSaveThread (textEditor.CreateSnapshot (), textEditor.FileName, IsDirty);
				return false;
			});
		}


		void RemoveAutoSaveTimer ()
		{
			if (autoSaveTimer == 0)
				return;
			GLib.Source.Remove (autoSaveTimer);
			autoSaveTimer = 0;
		}

		void RemovePolicyChangeHandler ()
		{
			if (policyContainer != null)
				policyContainer.PolicyChanged -= HandlePolicyChanged;
		}

		async Task UpdateStyleParent (MonoDevelop.Projects.Project styleParent, string mimeType, CancellationToken token)
		{
			RemovePolicyChangeHandler ();

			if (string.IsNullOrEmpty (mimeType))
				mimeType = "text/plain";

			var mimeTypes = DesktopService.GetMimeTypeInheritanceChain (mimeType);

			if (styleParent != null)
				policyContainer = styleParent.Policies;
			else
				policyContainer = MonoDevelop.Projects.Policies.PolicyService.DefaultPolicies;
			var currentPolicy = policyContainer.Get<TextStylePolicy> (mimeTypes);
			policyContainer.PolicyChanged += HandlePolicyChanged;
			((DefaultSourceEditorOptions)textEditor.Options).UpdateStylePolicy (currentPolicy);

			var context = await EditorConfigService.GetEditorConfigContext (textEditor.FileName, token);
			if (context == null)
				return;
			((DefaultSourceEditorOptions)textEditor.Options).SetContext (context);
		}

		void HandlePolicyChanged (object sender, MonoDevelop.Projects.Policies.PolicyChangedEventArgs args)
		{
			var mimeTypes = DesktopService.GetMimeTypeInheritanceChain (textEditor.MimeType);
			var currentPolicy = policyContainer.Get<TextStylePolicy> (mimeTypes);
			((DefaultSourceEditorOptions)textEditor.Options).UpdateStylePolicy (currentPolicy);
		}

		void CancelDocumentParsedUpdate ()
		{
			src.Cancel ();
			src = new CancellationTokenSource ();
		}

		CancellationTokenSource src = new CancellationTokenSource ();

		async Task RunFirstTimeFoldUpdate (string text)
		{
			if (string.IsNullOrEmpty (text)) 
				return;

			try {
				ParsedDocument parsedDocument = null;

				var foldingParser = TypeSystemService.GetFoldingParser (textEditor.MimeType);
				if (foldingParser != null) {
					parsedDocument = foldingParser.Parse (textEditor.FileName, text);
				} else {
					var normalParser = TypeSystemService.GetParser (textEditor.MimeType);
					if (normalParser != null) {
						parsedDocument = await normalParser.Parse(
							new TypeSystem.ParseOptions {
								FileName = textEditor.FileName,
								Content = new StringTextSource(text),
								Project = Project
							});
					}
				}
				if (parsedDocument != null) {
					await FoldingTextEditorExtension.UpdateFoldings (textEditor, parsedDocument, textEditor.CaretLocation, true);
				}
			} catch (Exception e) {
				LoggingService.LogError ("Error running first time fold update", e);
			}
		}

		#region IViewFContent implementation

		public override async Task Load (FileOpenInformation fileOpenInformation)
		{
			textEditorImpl.ViewContent.DirtyChanged -= HandleDirtyChanged;
			textEditor.TextChanged -= HandleTextChanged;
			await textEditorImpl.ViewContent.Load (fileOpenInformation);
			await RunFirstTimeFoldUpdate (textEditor.Text);
			textEditorImpl.InformLoadComplete ();
			textEditor.TextChanged += HandleTextChanged;
			textEditorImpl.ViewContent.DirtyChanged += HandleDirtyChanged;
		}

		public override async Task LoadNew (Stream content, string mimeType)
		{
			textEditor.MimeType = mimeType;
			string text = null;
			if (content != null) {
				var res = await TextFileUtility.GetTextAsync (content);
				text = textEditor.Text = res.Text;
				textEditor.Encoding = res.Encoding;
			}
			await RunFirstTimeFoldUpdate (text);
			textEditorImpl.InformLoadComplete ();
		}

		public override Task Save (FileSaveInformation fileSaveInformation)
		{
			if (!string.IsNullOrEmpty (fileSaveInformation.FileName))
				AutoSave.RemoveAutoSaveFile (fileSaveInformation.FileName);
			return textEditorImpl.ViewContent.Save (fileSaveInformation);
		}

		public override Task Save ()
		{
			if (!string.IsNullOrEmpty (textEditorImpl.ContentName))
				AutoSave.RemoveAutoSaveFile (textEditorImpl.ContentName);
			return textEditorImpl.ViewContent.Save ();
		}

		public override void DiscardChanges ()
		{
			if (autoSaveTask != null)
				autoSaveTask.Wait (TimeSpan.FromSeconds (5));
			RemoveAutoSaveTimer ();
			if (!string.IsNullOrEmpty (textEditorImpl.ContentName))
				AutoSave.RemoveAutoSaveFile (textEditorImpl.ContentName);
			textEditorImpl.ViewContent.DiscardChanges ();
		}

		protected override void OnSetProject (MonoDevelop.Projects.Project project)
		{
			base.OnSetProject (project);
			textEditorImpl.ViewContent.Project = project;
			UpdateTextEditorOptions (null, null);
		}

		public override ProjectReloadCapability ProjectReloadCapability {
			get {
				return textEditorImpl.ViewContent.ProjectReloadCapability;
			}
		}

		#endregion

		#region BaseViewContent implementation

		protected override IEnumerable<object> OnGetContents (Type type)
		{
			foreach (var r in base.OnGetContents (type))
				yield return r;

			if (type == typeof(ITextBuffer)) {
				yield return textEditor.TextView.TextBuffer;
				yield break;
			}
			if (type == typeof (ITextView)) {
				yield return textEditor.TextView;
				yield break;
			}

			if (type.IsAssignableFrom (typeof (TextEditor))) {
				yield return textEditor;
				yield break;
			}

			var ext = textEditorImpl.EditorExtension;
			while (ext != null) {
				foreach (var r in ext.OnGetContents (type))
					yield return r;
				ext = ext.Next;
			}

			foreach (var r in textEditorImpl.ViewContent.GetContents (type))
				yield return r;
		}

		protected override void OnWorkbenchWindowChanged ()
		{
			base.OnWorkbenchWindowChanged ();
			textEditorImpl.ViewContent.WorkbenchWindow = WorkbenchWindow;
		}

		public override Control Control {
			get {
				return textEditor;
			}
		}

		public override string TabPageLabel {
			get {
				return textEditorImpl.ViewContent.TabPageLabel;
			}
		}

		public override string TabAccessibilityDescription {
			get {
				return textEditorImpl.ViewContent.TabAccessibilityDescription;
			}
		}

		public override bool IsDirty {
			get { return textEditorImpl.ViewContent.IsDirty; }
			set {
				textEditorImpl.ViewContent.IsDirty = value;
			}
		}


		#endregion

		#region IDisposable implementation
		bool isDisposed;

		public override void Dispose ()
		{
			if (isDisposed)
				return;
			
			base.Dispose ();

			isDisposed = true;
			EditorConfigService.RemoveEditConfigContext (textEditor.FileName).Ignore ();
			CancelDocumentParsedUpdate ();
			textEditorImpl.ViewContent.DirtyChanged -= HandleDirtyChanged;
			textEditor.MimeTypeChanged -= UpdateTextEditorOptions;
			textEditor.TextChanged -= HandleTextChanged;
			textEditorImpl.ViewContent.ContentNameChanged -= ViewContent_ContentNameChanged;
			textEditorImpl.ViewContent.DirtyChanged -= ViewContent_DirtyChanged; ;

			DefaultSourceEditorOptions.Instance.Changed -= UpdateTextEditorOptions;
			RemovePolicyChangeHandler ();
			editorOptionsUpdateCancellationSource?.Cancel ();
			RemoveAutoSaveTimer ();
			textEditor.Dispose ();
		}

		#endregion

		#region ICommandRouter implementation

		object ICommandRouter.GetNextCommandTarget ()
		{
			return textEditor;
		}

		#endregion

		public override void GrabFocus ()
		{
			textEditor.GrabFocus ();
			DefaultSourceEditorOptions.SetUseAsyncCompletion (false);
		}
	}
}