Merge pull request #75460 from davidwengier/NavigateToMappedSpan

Navigate to the mapped span when navigating to a mapped file
dotnet · Oct 10, 2024 · c9dd07d · c9dd07d
2 parents ee185b2 + 6feb9ff
commit c9dd07d
Showing 1 changed file with 16 additions and 9 deletions.
diff --git a/src/VisualStudio/Core/Def/Workspace/VisualStudioDocumentNavigationService.cs b/src/VisualStudio/Core/Def/Workspace/VisualStudioDocumentNavigationService.cs
@@ -107,6 +107,7 @@ public async Task<bool> CanNavigateToPositionAsync(
             documentId,
             _ => Task.FromResult(textSpan),
             text => GetVsTextSpan(text, textSpan, allowInvalidSpan),
+            (text, span) => GetVsTextSpan(text, span, allowInvalidSpan),
             cancellationToken).ConfigureAwait(false);
     }
 
@@ -119,7 +120,8 @@ public async Task<bool> CanNavigateToPositionAsync(
         return await GetNavigableLocationAsync(workspace,
             documentId,
             document => GetTextSpanFromPositionAsync(document, position, virtualSpace, cancellationToken),
-            text => GetVsTextSpan(text, position, virtualSpace),
+            text => GetVsTextSpanFromPosition(text, position, virtualSpace),
+            (text, span) => GetVsTextSpan(text, span, allowInvalidSpan: false),
             cancellationToken).ConfigureAwait(false);
 
         static async Task<TextSpan> GetTextSpanFromPositionAsync(Document document, int position, int virtualSpace, CancellationToken cancellationToken)
@@ -133,7 +135,7 @@ static async Task<TextSpan> GetTextSpanFromPositionAsync(Document document, int
             return text.Lines.GetTextSpan(new LinePositionSpan(linePosition, linePosition));
         }
 
-        static VsTextSpan GetVsTextSpan(SourceText text, int position, int virtualSpace)
+        static VsTextSpan GetVsTextSpanFromPosition(SourceText text, int position, int virtualSpace)
         {
             var boundedPosition = GetPositionWithinDocumentBounds(position, text.Length);
             if (boundedPosition != position)
@@ -156,10 +158,11 @@ static VsTextSpan GetVsTextSpan(SourceText text, int position, int virtualSpace)
         DocumentId documentId,
         Func<Document, Task<TextSpan>> getTextSpanForMappingAsync,
         Func<SourceText, VsTextSpan> getVsTextSpan,
+        Func<SourceText, TextSpan, VsTextSpan> getVsTextSpanForMapping,
         CancellationToken cancellationToken)
     {
         var callback = await GetNavigationCallbackAsync(
-            workspace, documentId, getTextSpanForMappingAsync, getVsTextSpan, cancellationToken).ConfigureAwait(true);
+            workspace, documentId, getTextSpanForMappingAsync, getVsTextSpan, getVsTextSpanForMapping, cancellationToken).ConfigureAwait(true);
         if (callback == null)
             return null;
 
@@ -179,6 +182,7 @@ static VsTextSpan GetVsTextSpan(SourceText text, int position, int virtualSpace)
         DocumentId documentId,
         Func<Document, Task<TextSpan>> getTextSpanForMappingAsync,
         Func<SourceText, VsTextSpan> getVsTextSpan,
+        Func<SourceText, TextSpan, VsTextSpan> getVsTextSpanForMapping,
         CancellationToken cancellationToken)
     {
         // Navigation should not change the context of linked files and Shared Projects.
@@ -209,26 +213,29 @@ static VsTextSpan GetVsTextSpan(SourceText text, int position, int virtualSpace)
         var spanMappingService = document.DocumentServiceProvider.GetService<ISpanMappingService>();
         if (spanMappingService != null)
         {
-            var mappedSpan = await GetMappedSpanAsync(
+            var mappedSpanResult = await GetMappedSpanAsync(
                 spanMappingService,
                 document,
                 await getTextSpanForMappingAsync(document).ConfigureAwait(false),
                 cancellationToken).ConfigureAwait(false);
-            if (mappedSpan.HasValue)
+            if (mappedSpanResult is { IsDefault: false } mappedSpan)
             {
                 // Check if the mapped file matches one already in the workspace.
                 // If so use the workspace APIs to navigate to it.  Otherwise use VS APIs to navigate to the file path.
-                var documentIdsForFilePath = solution.GetDocumentIdsWithFilePath(mappedSpan.Value.FilePath);
+                var documentIdsForFilePath = solution.GetDocumentIdsWithFilePath(mappedSpan.FilePath);
                 if (!documentIdsForFilePath.IsEmpty)
                 {
                     // If the mapped file maps to the same document that was passed in, then re-use the documentId to preserve context.
                     // Otherwise, just pick one of the ids to use for navigation.
                     var documentIdToNavigate = documentIdsForFilePath.Contains(documentId) ? documentId : documentIdsForFilePath.First();
-                    return GetNavigationCallback(documentIdToNavigate, workspace, getVsTextSpan);
+                    return GetNavigationCallback(
+                        documentIdToNavigate,
+                        workspace,
+                        sourceText => getVsTextSpanForMapping(sourceText, mappedSpan.Span));
                 }
 
                 return await GetNavigableLocationForMappedFileAsync(
-                    workspace, document, mappedSpan.Value, cancellationToken).ConfigureAwait(false);
+                    workspace, document, mappedSpan, cancellationToken).ConfigureAwait(false);
             }
         }
 
@@ -253,7 +260,7 @@ await getTextSpanForMappingAsync(document).ConfigureAwait(false),
                 return false;
 
             // Now that we've opened the document reacquire the corresponding Document in the current solution.
-            var document = workspace.CurrentSolution.GetDocument(documentId);
+            var document = workspace.CurrentSolution.GetTextDocument(documentId);
             if (document == null)
                 return false;