diff options
Diffstat (limited to 'main/src/core/MonoDevelop.Ide/MonoDevelop.Ide.Editor.Extension/TextEditorExtension.cs')
-rw-r--r-- | main/src/core/MonoDevelop.Ide/MonoDevelop.Ide.Editor.Extension/TextEditorExtension.cs | 107 |
1 files changed, 107 insertions, 0 deletions
diff --git a/main/src/core/MonoDevelop.Ide/MonoDevelop.Ide.Editor.Extension/TextEditorExtension.cs b/main/src/core/MonoDevelop.Ide/MonoDevelop.Ide.Editor.Extension/TextEditorExtension.cs new file mode 100644 index 0000000000..6dcb523e19 --- /dev/null +++ b/main/src/core/MonoDevelop.Ide/MonoDevelop.Ide.Editor.Extension/TextEditorExtension.cs @@ -0,0 +1,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; + } + } +}
\ No newline at end of file |