Implement Go To Definition for Razor

Author: KirillOsenkov

main/src/addins/CSharpBinding/MonoDevelop.Ide.Completion.Presentation/MonoDevelopContainedDocument.cs

@@ -54,6 +54,8 @@ public class MonoDevelopContainedDocument : IMonoDevelopHostDocument
 		public IMonoDevelopContainedLanguageHost ContainedLanguageHost { get; private set; }
 		private readonly HostType _hostType;
 
+		public IProjectionBuffer TopBuffer => DataBuffer;
+
 		// _workspace will only be set once the Workspace is available
 		private Workspace _workspace;
 

main/src/core/MonoDevelop.Ide/MonoDevelop.Ide.RoslynServices/MonoDevelopDocumentNavigationService.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Composition;
+using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.CodeAnalysis;
@@ -9,7 +10,10 @@
 using Microsoft.CodeAnalysis.Options;
 using Microsoft.CodeAnalysis.Text;
 using Microsoft.VisualStudio.Text;
+using Microsoft.VisualStudio.Text.Projection;
 using MonoDevelop.Core;
+using MonoDevelop.Ide.Composition;
+using MonoDevelop.Ide.Editor.Projection;
 using MonoDevelop.Ide.TypeSystem;
 
 namespace MonoDevelop.Ide.RoslynServices
@@ -19,11 +23,14 @@ internal sealed class VisualStudioDocumentNavigationServiceFactory : IWorkspaceS
 	{
 		private readonly IDocumentNavigationService _singleton;
 
+		[Import]
+		public IBufferGraphFactoryService BufferGraphFactoryService { get; set; }
+
 		[ImportingConstructor]
 		[Obsolete (MefConstruction.ImportingConstructorMessage, error: true)]
 		private VisualStudioDocumentNavigationServiceFactory ()
 		{
-			_singleton = new MonoDevelopDocumentNavigationService ();
+			_singleton = new MonoDevelopDocumentNavigationService (this);
 		}
 
 		public IWorkspaceService CreateService (HostWorkspaceServices workspaceServices)
@@ -34,6 +41,13 @@ public IWorkspaceService CreateService (HostWorkspaceServices workspaceServices)
 
 	class MonoDevelopDocumentNavigationService : IDocumentNavigationService
 	{
+		private VisualStudioDocumentNavigationServiceFactory factory;
+
+		public MonoDevelopDocumentNavigationService (VisualStudioDocumentNavigationServiceFactory visualStudioDocumentNavigationServiceFactory)
+		{
+			this.factory = visualStudioDocumentNavigationServiceFactory;
+		}
+
 		public bool CanNavigateToSpan (Workspace workspace, DocumentId documentId, TextSpan textSpan)
 		{
 			// Navigation should not change the context of linked files and Shared Projects.
@@ -99,7 +113,7 @@ public bool TryNavigateToSpan (Workspace workspace, DocumentId documentId, TextS
 
 			Runtime.AssertMainThread ();
 
-			var document = OpenDocument (workspace, documentId, options);
+			var document = workspace.CurrentSolution.GetDocument (documentId);
 			if (document == null) {
 				return false;
 			}
@@ -127,7 +141,7 @@ public bool TryNavigateToLineAndOffset (Workspace workspace, DocumentId document
 
 			Runtime.AssertMainThread ();
 
-			var document = OpenDocument (workspace, documentId, options);
+			var document = workspace.CurrentSolution.GetDocument (documentId);
 			if (document == null) {
 				return false;
 			}
@@ -149,7 +163,7 @@ public bool TryNavigateToPosition (Workspace workspace, DocumentId documentId, i
 
 			Runtime.AssertMainThread ();
 
-			var document = OpenDocument (workspace, documentId, options);
+			var document = workspace.CurrentSolution.GetDocument (documentId);
 			if (document == null) {
 				return false;
 			}
@@ -222,13 +236,41 @@ private static Document OpenDocument (Workspace workspace, DocumentId documentId
 
 		private bool NavigateTo (Document document, TextSpan span)
 		{
+			string filePath = document.FilePath;
+			filePath = GetActualFilePathToOpen (filePath);
 			var proj = (document.Project.Solution.Workspace as MonoDevelopWorkspace)?.GetMonoProject (document.Project);
-			var task = IdeApp.Workbench.OpenDocument (new Gui.FileOpenInformation (document.FilePath, proj) {
+			var task = IdeApp.Workbench.OpenDocument (new Gui.FileOpenInformation (filePath, proj) {
 				Offset = span.Start
 			});
 			return true;
 		}
 
+		/// <summary>
+		/// Razor: Strip the .g.cs since we want to open the corresponding .cshtml or .razor document.
+		///
+		/// In Visual Studio for Windows the underlying C# buffer is added to the workspace with the
+		/// .cshtml or .razor extension (without the .g.cs) part, so they don't have to worry about
+		/// this. In our case we have an assumption somewhere that all C# documents in the workspace
+		/// have the .cs extension, so we're adding the .g.cs part that we need to strip here.
+		/// 
+		/// This is not great to hardcode application-specific logic here, but we don't anticipate
+		/// more scenarios where we want to open a different file than requested, so it doesn't
+		/// warrant an extension point at this time.
+		/// </summary>
+		string GetActualFilePathToOpen (string filePath)
+		{
+			if (filePath == null) {
+				return null;
+			}
+
+			if (filePath.EndsWith (".cshtml.g.cs", StringComparison.OrdinalIgnoreCase) ||
+				filePath.EndsWith (".razor.g.cs", StringComparison.OrdinalIgnoreCase)) {
+				filePath = filePath.Substring (0, filePath.Length - ".g.cs".Length);
+			}
+
+			return filePath;
+		}
+
 		private bool IsSecondaryBuffer (Workspace workspace, Document document)
 		{
 			var containedDocument = MonoDevelopHostDocumentRegistration.FromDocument (document);
@@ -239,23 +281,33 @@ private bool IsSecondaryBuffer (Workspace workspace, Document document)
 			return true;
 		}
 
-		public static bool TryMapSpanFromSecondaryBufferToPrimaryBuffer (TextSpan spanInSecondaryBuffer, Microsoft.CodeAnalysis.Workspace workspace, Document document, out TextSpan spanInPrimaryBuffer)
+		public bool TryMapSpanFromSecondaryBufferToPrimaryBuffer (TextSpan spanInSecondaryBuffer, Microsoft.CodeAnalysis.Workspace workspace, Document document, out TextSpan spanInPrimaryBuffer)
 		{
 			spanInPrimaryBuffer = default;
 
 			var containedDocument = MonoDevelopHostDocumentRegistration.FromDocument (document);
 			if (containedDocument == null) {
 				return false;
 			}
-			throw new NotImplementedException ();
-			//var bufferCoordinator = containedDocument.BufferCoordinator;
 
-			//var primary = new VsTextSpan [1];
-			//var hresult = bufferCoordinator.MapSecondaryToPrimarySpan (spanInSecondaryBuffer, primary);
+			var projectionBuffer = containedDocument.TopBuffer;
+
+			var bufferGraph = factory.BufferGraphFactoryService.CreateBufferGraph (projectionBuffer);
 
-			//spanInPrimaryBuffer = primary [0];
+			if (document.TryGetText(out var sourceText) && sourceText.Container.TryGetTextBuffer() is ITextBuffer languageBuffer) {
+				var secondarySnapshot = languageBuffer.CurrentSnapshot;
+				var snapshotSpanInSecondaryBuffer = new SnapshotSpan (secondarySnapshot, new Span (spanInSecondaryBuffer.Start, spanInSecondaryBuffer.Length));
+				var topBufferSnapshotSpan = bufferGraph.MapUpToSnapshot (
+					snapshotSpanInSecondaryBuffer,
+					SpanTrackingMode.EdgeExclusive,
+					projectionBuffer.CurrentSnapshot).FirstOrDefault();
+				if (topBufferSnapshotSpan != default) {
+					spanInPrimaryBuffer = new TextSpan (topBufferSnapshotSpan.Start, topBufferSnapshotSpan.Length);
+					return true;
+				}
+			}
 
-			//return ErrorHandler.Succeeded (hresult);
+			return false;
 		}
 
 		private bool CanMapFromSecondaryBufferToPrimaryBuffer (Workspace workspace, Document document, TextSpan spanInSecondaryBuffer)

main/src/core/MonoDevelop.Ide/MonoDevelop.Ide.TypeSystem/IMonoDevelopHostDocument.cs

@@ -6,7 +6,8 @@
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.Text;
 using Microsoft.VisualStudio.Text;
-
+using Microsoft.VisualStudio.Text.Projection;
+
 namespace MonoDevelop.Ide.TypeSystem
 {
 	interface IMonoDevelopHostDocument
@@ -15,6 +16,8 @@ interface IMonoDevelopHostDocument
 		/// Updates the text of the document.
 		/// </summary>
 		void UpdateText (SourceText newText);
+
+		IProjectionBuffer TopBuffer { get; }
 	}
 
 	static class MonoDevelopHostDocumentRegistration