Avoid rooting document instances in NavigateToSearchResult

Author: sharwell

src/EditorFeatures/CSharpTest/NavigateTo/NavigateToSearcherTests.cs

@@ -270,7 +270,7 @@ public TestNavigateToSearchResult(TestWorkspace workspace, TextSpan sourceSpan)
                 _sourceSpan = sourceSpan;
             }
 
-            public Document Document => _workspace.CurrentSolution.Projects.Single().Documents.Single();
+            public INavigableItem.NavigableDocument Document => INavigableItem.NavigableDocument.FromDocument(_workspace.CurrentSolution.Projects.Single().Documents.Single());
             public TextSpan SourceSpan => _sourceSpan;
 
             public string AdditionalInformation => throw new NotImplementedException();

src/EditorFeatures/Core.Wpf/NavigateTo/DefaultNavigateToPreviewService.cs

@@ -4,14 +4,16 @@
 
 #nullable disable
 
+using Microsoft.CodeAnalysis.Navigation;
 using Microsoft.VisualStudio.Language.NavigateTo.Interfaces;
+using Microsoft.VisualStudio.Shell.Interop;
 
 namespace Microsoft.CodeAnalysis.Editor.Implementation.NavigateTo
 {
     internal sealed class DefaultNavigateToPreviewService : INavigateToPreviewService
     {
-        public int GetProvisionalViewingStatus(Document document)
-            => 0;
+        public __VSPROVISIONALVIEWINGSTATUS GetProvisionalViewingStatus(INavigableItem.NavigableDocument document)
+            => __VSPROVISIONALVIEWINGSTATUS.PVS_Disabled;
 
         public bool CanPreview(Document document)
             => true;

src/EditorFeatures/Core.Wpf/NavigateTo/INavigateToPreviewService.cs

@@ -5,13 +5,15 @@
 #nullable disable
 
 using Microsoft.CodeAnalysis.Host;
+using Microsoft.CodeAnalysis.Navigation;
 using Microsoft.VisualStudio.Language.NavigateTo.Interfaces;
+using Microsoft.VisualStudio.Shell.Interop;
 
 namespace Microsoft.CodeAnalysis.Editor.Implementation.NavigateTo
 {
     internal interface INavigateToPreviewService : IWorkspaceService
     {
-        int GetProvisionalViewingStatus(Document document);
+        __VSPROVISIONALVIEWINGSTATUS GetProvisionalViewingStatus(INavigableItem.NavigableDocument document);
         bool CanPreview(Document document);
         void PreviewItem(INavigateToItemDisplay itemDisplay);
     }

src/EditorFeatures/Core.Wpf/NavigateTo/NavigateToItemDisplay.cs

@@ -16,6 +16,7 @@
 using Microsoft.CodeAnalysis.Text.Shared.Extensions;
 using Microsoft.VisualStudio.Imaging.Interop;
 using Microsoft.VisualStudio.Language.NavigateTo.Interfaces;
+using Microsoft.VisualStudio.Shell.Interop;
 using Microsoft.VisualStudio.Text;
 using Microsoft.VisualStudio.Utilities;
 using Roslyn.Utilities;
@@ -63,7 +64,7 @@ private ReadOnlyCollection<DescriptionItem> CreateDescriptionItems()
                 return new List<DescriptionItem>().AsReadOnly();
             }
 
-            var sourceText = document.GetTextSynchronously(CancellationToken.None);
+            var sourceText = document.GetTextSynchronously(document.Workspace.CurrentSolution, CancellationToken.None);
             var span = NavigateToUtilities.GetBoundedSpan(_searchResult.NavigableItem, sourceText);
 
             var items = new List<DescriptionItem>
@@ -111,13 +112,13 @@ public int GetProvisionalViewingStatus()
             var document = _searchResult.NavigableItem.Document;
             if (document == null)
             {
-                return 0;
+                return (int)__VSPROVISIONALVIEWINGSTATUS.PVS_Disabled;
             }
 
-            var workspace = document.Project.Solution.Workspace;
+            var workspace = document.Workspace;
             var previewService = workspace.Services.GetService<INavigateToPreviewService>();
 
-            return previewService.GetProvisionalViewingStatus(document);
+            return (int)previewService.GetProvisionalViewingStatus(document);
         }
 
         public void PreviewItem()
@@ -128,7 +129,7 @@ public void PreviewItem()
                 return;
             }
 
-            var workspace = document.Project.Solution.Workspace;
+            var workspace = document.Workspace;
             var previewService = workspace.Services.GetService<INavigateToPreviewService>();
 
             previewService.PreviewItem(this);

src/EditorFeatures/Core.Wpf/Peek/PeekableItemSource.cs

@@ -136,7 +136,7 @@ private static async IAsyncEnumerable<IPeekableItem> GetPeekableItemsForNavigabl
                     if (await navigationService.CanNavigateToPositionAsync(
                             workspace, document.Id, item.SourceSpan.Start, cancellationToken).ConfigureAwait(false))
                     {
-                        var text = await document.GetTextAsync(cancellationToken).ConfigureAwait(false);
+                        var text = await document.GetTextAsync(project.Solution, cancellationToken).ConfigureAwait(false);
                         var linePositionSpan = text.Lines.GetLinePositionSpan(item.SourceSpan);
                         if (document.FilePath != null)
                         {

src/EditorFeatures/Core/CodeDefinitionWindow/DefinitionContextTracker.cs

@@ -171,7 +171,7 @@ internal async Task<ImmutableArray<CodeDefinitionWindowLocation>> GetContextFrom
                 {
                     if (await navigationService.CanNavigateToSpanAsync(workspace, item.Document.Id, item.SourceSpan, cancellationToken).ConfigureAwait(false))
                     {
-                        var text = await item.Document.GetTextAsync(cancellationToken).ConfigureAwait(false);
+                        var text = await item.Document.GetTextAsync(document.Project.Solution, cancellationToken).ConfigureAwait(false);
                         var linePositionSpan = text.Lines.GetLinePositionSpan(item.SourceSpan);
 
                         if (item.Document.FilePath != null)

src/EditorFeatures/Core/NavigateTo/NavigateToHelpers.cs

@@ -35,7 +35,7 @@ private static async Task NavigateToAsync(
             if (document == null)
                 return;
 
-            var workspace = document.Project.Solution.Workspace;
+            var workspace = document.Workspace;
             var navigationService = workspace.Services.GetRequiredService<IDocumentNavigationService>();
 
             // Document tabs opened by NavigateTo are carefully created as preview or regular tabs

src/EditorFeatures/Test2/CodeDefinitionWindow/CrossLanguageCodeDefinitionWindowTests.vb

@@ -22,10 +22,10 @@ Namespace Microsoft.CodeAnalysis.Editor.CodeDefinitionWindow.UnitTests
         Private Class FakeNavigableItem
             Implements INavigableItem
 
-            Private ReadOnly _document As Document
+            Private ReadOnly _document As INavigableItem.NavigableDocument
 
             Public Sub New(document As Document)
-                _document = document
+                _document = INavigableItem.NavigableDocument.FromDocument(document)
             End Sub
 
             Public ReadOnly Property ChildItems As ImmutableArray(Of INavigableItem) Implements INavigableItem.ChildItems
@@ -46,7 +46,7 @@ Namespace Microsoft.CodeAnalysis.Editor.CodeDefinitionWindow.UnitTests
                 End Get
             End Property
 
-            Public ReadOnly Property Document As Document Implements INavigableItem.Document
+            Public ReadOnly Property Document As INavigableItem.NavigableDocument Implements INavigableItem.Document
                 Get
                     Return _document
                 End Get

src/Features/Core/Portable/ExternalAccess/VSTypeScript/VSTypeScriptNavigableItemWrapper.cs

@@ -12,10 +12,12 @@ namespace Microsoft.CodeAnalysis.ExternalAccess.VSTypeScript
     internal sealed class VSTypeScriptNavigableItemWrapper : INavigableItem
     {
         private readonly IVSTypeScriptNavigableItem _navigableItem;
+        private readonly INavigableItem.NavigableDocument _navigableDocument;
 
         public VSTypeScriptNavigableItemWrapper(IVSTypeScriptNavigableItem navigableItem)
         {
             _navigableItem = navigableItem;
+            _navigableDocument = INavigableItem.NavigableDocument.FromDocument(navigableItem.Document);
         }
 
         public Glyph Glyph => _navigableItem.Glyph;
@@ -26,7 +28,7 @@ public VSTypeScriptNavigableItemWrapper(IVSTypeScriptNavigableItem navigableItem
 
         public bool IsImplicitlyDeclared => _navigableItem.IsImplicitlyDeclared;
 
-        public Document Document => _navigableItem.Document;
+        public INavigableItem.NavigableDocument Document => _navigableDocument;
 
         public TextSpan SourceSpan => _navigableItem.SourceSpan;
 

src/Features/Core/Portable/NavigateTo/RoslynNavigateToItem.cs

@@ -5,7 +5,6 @@
 using System;
 using System.Collections.Generic;
 using System.Collections.Immutable;
-using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Runtime.Serialization;
 using System.Threading;
@@ -16,7 +15,6 @@
 using Microsoft.CodeAnalysis.PooledObjects;
 using Microsoft.CodeAnalysis.Shared.Extensions;
 using Microsoft.CodeAnalysis.Text;
-using Roslyn.Utilities;
 
 namespace Microsoft.CodeAnalysis.NavigateTo
 {
@@ -108,7 +106,7 @@ private class NavigateToSearchResult : INavigateToSearchResult, INavigableItem
             /// <summary>
             /// The <see cref="Document"/> that <see cref="_item"/> is contained within.
             /// </summary>
-            private readonly Document _itemDocument;
+            private readonly INavigableItem.NavigableDocument _itemDocument;
 
             /// <summary>
             /// The document the user was editing when they invoked the navigate-to operation.
@@ -124,35 +122,35 @@ public NavigateToSearchResult(
                 Document? activeDocument)
             {
                 _item = item;
-                _itemDocument = itemDocument;
+                _itemDocument = INavigableItem.NavigableDocument.FromDocument(itemDocument);
                 if (activeDocument is not null)
                     _activeDocument = (activeDocument.Id, activeDocument.Folders);
 
-                _additionalInformation = ComputeAdditionalInformation();
+                _additionalInformation = ComputeAdditionalInformation(in item, itemDocument);
                 _secondarySort = new Lazy<string>(ComputeSecondarySort);
             }
 
-            private string ComputeAdditionalInformation()
+            private static string ComputeAdditionalInformation(in RoslynNavigateToItem item, Document itemDocument)
             {
                 // For partial types, state what file they're in so the user can disambiguate the results.
-                var combinedProjectName = ComputeCombinedProjectName();
-                return (_item.DeclaredSymbolInfo.IsPartial, IsNonNestedNamedType()) switch
+                var combinedProjectName = ComputeCombinedProjectName(in item, itemDocument);
+                return (item.DeclaredSymbolInfo.IsPartial, IsNonNestedNamedType(in item)) switch
                 {
-                    (true, true) => string.Format(FeaturesResources._0_dash_1, _itemDocument.Name, combinedProjectName),
-                    (true, false) => string.Format(FeaturesResources.in_0_1_2, _item.DeclaredSymbolInfo.ContainerDisplayName, _itemDocument.Name, combinedProjectName),
+                    (true, true) => string.Format(FeaturesResources._0_dash_1, itemDocument.Name, combinedProjectName),
+                    (true, false) => string.Format(FeaturesResources.in_0_1_2, item.DeclaredSymbolInfo.ContainerDisplayName, itemDocument.Name, combinedProjectName),
                     (false, true) => string.Format(FeaturesResources.project_0, combinedProjectName),
-                    (false, false) => string.Format(FeaturesResources.in_0_project_1, _item.DeclaredSymbolInfo.ContainerDisplayName, combinedProjectName),
+                    (false, false) => string.Format(FeaturesResources.in_0_project_1, item.DeclaredSymbolInfo.ContainerDisplayName, combinedProjectName),
                 };
             }
 
-            private string ComputeCombinedProjectName()
+            private static string ComputeCombinedProjectName(in RoslynNavigateToItem item, Document itemDocument)
             {
                 // If there aren't any additional matches in other projects, we don't need to merge anything.
-                if (_item.AdditionalMatchingProjects.Length > 0)
+                if (item.AdditionalMatchingProjects.Length > 0)
                 {
                     // First get the simple project name and flavor for the actual project we got a hit in.  If we can't
                     // figure this out, we can't create a merged name.
-                    var firstProject = _itemDocument.Project;
+                    var firstProject = itemDocument.Project;
                     var (firstProjectName, firstProjectFlavor) = firstProject.State.NameAndFlavor;
 
                     if (firstProjectName != null)
@@ -165,7 +163,7 @@ private string ComputeCombinedProjectName()
                         // Now, do the same for the other projects where we had a match. As above, if we can't figure out the
                         // simple name/flavor, or if the simple project name doesn't match the simple project name we started
                         // with then we can't merge these.
-                        foreach (var additionalProjectId in _item.AdditionalMatchingProjects)
+                        foreach (var additionalProjectId in item.AdditionalMatchingProjects)
                         {
                             var additionalProject = solution.GetRequiredProject(additionalProjectId);
                             var (projectName, projectFlavor) = additionalProject.State.NameAndFlavor;
@@ -181,17 +179,17 @@ private string ComputeCombinedProjectName()
                 }
 
                 // Couldn't compute a merged project name (or only had one project).  Just return the name of hte project itself.
-                return _itemDocument.Project.Name;
+                return itemDocument.Project.Name;
             }
 
             string INavigateToSearchResult.AdditionalInformation => _additionalInformation;
 
-            private bool IsNonNestedNamedType()
-                => !_item.DeclaredSymbolInfo.IsNestedType && IsNamedType();
+            private static bool IsNonNestedNamedType(in RoslynNavigateToItem item)
+                => !item.DeclaredSymbolInfo.IsNestedType && IsNamedType(in item);
 
-            private bool IsNamedType()
+            private static bool IsNamedType(in RoslynNavigateToItem item)
             {
-                switch (_item.DeclaredSymbolInfo.Kind)
+                switch (item.DeclaredSymbolInfo.Kind)
                 {
                     case DeclaredSymbolInfoKind.Class:
                     case DeclaredSymbolInfoKind.Record:
@@ -356,7 +354,7 @@ ImmutableArray<TaggedText> INavigableItem.DisplayTaggedParts
             /// </summary>
             bool INavigableItem.IsImplicitlyDeclared => false;
 
-            Document INavigableItem.Document => _itemDocument;
+            INavigableItem.NavigableDocument INavigableItem.Document => _itemDocument;
 
             TextSpan INavigableItem.SourceSpan => _item.DeclaredSymbolInfo.Span;