ITextEditorResolver.cs

//
// ITextEditorResolver.cs
//
// Author:
//   Mike Krüger <mkrueger@novell.com>
//
// Copyright (C) 2009 Novell, Inc (http://www.novell.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 System.Collections.Generic;
using System.Linq;
using Mono.TextEditor;
using Mono.Addins;
using ICSharpCode.NRefactory.TypeSystem;
using ICSharpCode.NRefactory.Semantics;
using MonoDevelop.Ide.TypeSystem;

namespace MonoDevelop.Ide.Gui.Content
{
	public interface ITextEditorResolver
	{
		ResolveResult GetLanguageItem (int offset);
		ResolveResult GetLanguageItem (int offset, string expression);
	}
	
	public interface ITextEditorResolverProvider
	{
		ResolveResult GetLanguageItem (MonoDevelop.Ide.Gui.Document document, int offset, out DomRegion expressionRegion);
		ResolveResult GetLanguageItem (MonoDevelop.Ide.Gui.Document document, int offset, string identifier);

		string CreateTooltip (MonoDevelop.Ide.Gui.Document document, int offset, ResolveResult result, string errorInformations, Gdk.ModifierType modifierState);

	}
	
	public interface ITextEditorMemberPositionProvider
	{
		IUnresolvedTypeDefinition GetTypeAt (int offset);
		IUnresolvedMember GetMemberAt (int offset);
	}
	
	
	public static class TextEditorResolverService
	{
		static List<TextEditorResolverProviderCodon> providers = new List<TextEditorResolverProviderCodon> ();
		
		static TextEditorResolverService ()
		{
			AddinManager.AddExtensionNodeHandler ("/MonoDevelop/Ide/TextEditorResolver", delegate(object sender, ExtensionNodeEventArgs args) {
				switch (args.Change) {
				case ExtensionChange.Add:
					providers.Add ((TextEditorResolverProviderCodon) args.ExtensionNode);
					break;
				case ExtensionChange.Remove:
					providers.Remove ((TextEditorResolverProviderCodon) args.ExtensionNode);
					break;
				}
			});
		}
		
		public static ITextEditorResolverProvider GetProvider (string mimeType)
		{
			TextEditorResolverProviderCodon codon = providers.FirstOrDefault (p => p.MimeType == mimeType);
			if (codon == null)
				return null;
			return codon.CreateResolver ();
		}

		public static ResolveResult GetLanguageItem (this MonoDevelop.Ide.Gui.Document document, int offset, out DomRegion expressionRegion)
		{
			if (document == null)
				throw new System.ArgumentNullException ("document");

			var textEditorResolver = TextEditorResolverService.GetProvider (document.Editor.Document.MimeType);
			if (textEditorResolver != null) {
				return textEditorResolver.GetLanguageItem (document, offset, out expressionRegion);
			}
			expressionRegion = DomRegion.Empty;
			return null;
		}
	}
	
	[ExtensionNode (Description="A codon for text editor providers.")]
	public class TextEditorResolverProviderCodon : ExtensionNode
	{
		[NodeAttribute("mimeType", "Mime type for this text editor provider")]
		string mimeType = null;
		
		[NodeAttribute("class", "Class name.")]
		string className = null;
		
		public string MimeType {
			get { return this.mimeType; }
		}
		
		public ITextEditorResolverProvider CreateResolver ()
		{
			return (ITextEditorResolverProvider) Addin.CreateInstance (className, true);
		}
	}
}