Welcome to mirror list, hosted at ThFree Co, Russian Federation.

TextEditorExtension.cs « MonoDevelop.Ide.Editor.Extension « MonoDevelop.Ide « core « src « main - github.com/mono/monodevelop.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 6dcb523e19edebbc66b900d9c89b61abfe4a25a7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
//
// AbstractEditorExtension.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.Components.Commands;
using MonoDevelop.Core;
using MonoDevelop.Ide.Editor;
using MonoDevelop.Ide.Gui;
using MonoDevelop.Ide.TypeSystem;

namespace MonoDevelop.Ide.Editor.Extension
{
	public abstract class TextEditorExtension : ICommandRouter, IDisposable
	{
		public DocumentContext DocumentContext {
			get;
			protected set;
		}

		public TextEditor Editor {
			get;
			protected set;
		}

		internal TextEditorExtension Next {
			get;
			set;
		}

		protected internal void Initialize (TextEditor editor, DocumentContext context)
		{
			if (editor == null)
				throw new ArgumentNullException ("editor");
			if (context == null)
				throw new ArgumentNullException ("context");
			if (DocumentContext != null)
				throw new InvalidOperationException ("Extension is already initialized.");
			DocumentContext = context;
			Editor = editor;
			Initialize ();
		}

		protected virtual void Initialize ()
		{
		}

		public virtual bool IsValidInContext (DocumentContext context)
		{
			return true;
		}

		/// <summary>
		/// Return true if the key press should be processed by the editor.
		/// When a key is pressed, and before the key is processed by the editor, this method will be invoked.
		/// </summary>
		public virtual bool KeyPress (KeyDescriptor descriptor)
		{
			return Next == null || Next.KeyPress (descriptor);
		}

		public virtual void Dispose ()
		{
		}

		void CheckInitialized ()
		{
			if (DocumentContext == null)
				throw new InvalidOperationException ("Editor extension not yet initialized");
		}

		object ICommandRouter.GetNextCommandTarget ()
		{
			return Next;
		}
	}

	class TextEditorExtensionMarker : TextEditorExtension
	{
		public override bool IsValidInContext (DocumentContext context)
		{
			return false;
		}
	}
}