Temporarily converging CodeLens and LineLens monikers into Lens

Author: psfinaki

docs/tooling-features.md

@@ -42,7 +42,7 @@ Most of the syntax operations require an entire document's source text or parse
 |---------|---------------|---------------|-----------------|
 | Most code fixes | Current document's typecheck data | Set (1 or more) of suggested text replacements | S-M |
 | Semantic classification | Current document's typecheck data | Spans of text with semantic classification type for all constructs in a document | S-L |
-| Code lenses | Current document's typecheck data and top-level declarations (for showing signatures); graph of all projects that reference the current one (for showing references) | Signature data for each top-level construct; spans of text for each reference to a top-level construct with navigation information | S-XL |
+| Lenses | Current document's typecheck data and top-level declarations (for showing signatures); graph of all projects that reference the current one (for showing references) | Signature data for each top-level construct; spans of text for each reference to a top-level construct with navigation information | S-XL |
 | Code generation / refactorings | Current document's typecheck data and/or current resolved symbol/symbols | Text replacement(s) | S-L |
 | Code completion | Current document's typecheck data and currently-resolved symbol user is typing at | List of all symbols in scope that are "completable" based on where completion is invoked | S-L |
 | Editor tooltips | Current document's typecheck data and resolved symbol where user invoked a tooltip | F# tooltip data based on inspecting a type and its declarations, then pretty-printing them | S-XL |

vsintegration/src/FSharp.Editor/Common/Constants.fs

@@ -83,7 +83,7 @@ module internal Guids =
 
     [<Literal>]
     /// "00BE7FD9-8145-4A2E-A1BF-3BAF0F4F47DD"
-    let codeLensOptionPageIdString = "00BE7FD9-8145-4A2E-A1BF-3BAF0F4F47DD"
+    let lensOptionPageIdString = "00BE7FD9-8145-4A2E-A1BF-3BAF0F4F47DD"
 
     [<Literal>]
     /// "8FDA964A-263D-4B4E-9560-29897535217C"

vsintegration/src/FSharp.Editor/FSharp.Editor.fsproj

@@ -126,9 +126,9 @@
     <Compile Include="Build\SetGlobalPropertiesForSdkProjects.fs" />
     <Compile Include="AutomaticCompletion\BraceCompletionSessionProvider.fsi" />
     <Compile Include="AutomaticCompletion\BraceCompletionSessionProvider.fs" />
-    <Compile Include="CodeLens\AbstractCodeLensDisplayService.fs" />
-    <Compile Include="CodeLens\FSharpCodeLensService.fs" />
-    <Compile Include="CodeLens\CodeLensProvider.fs" />
+    <Compile Include="Lens\LensDisplayService.fs" />
+    <Compile Include="Lens\LensService.fs" />
+    <Compile Include="Lens\LensProvider.fs" />
   </ItemGroup>
 
   <ItemGroup>

vsintegration/src/FSharp.Editor/FSharp.Editor.resx

@@ -178,7 +178,7 @@
     <value>Advanced</value>
   </data>
   <data name="6013" xml:space="preserve">
-    <value>CodeLens</value>
+    <value>Lens</value>
   </data>
   <data name="6014" xml:space="preserve">
     <value>Formatting</value>

vsintegration/src/FSharp.Editor/LanguageService/LanguageService.fs

@@ -198,7 +198,7 @@ type internal FSharpSettingsFactory
 [<ProvideLanguageEditorOptionPage(typeof<OptionsUI.CodeFixesOptionPage>, "F#", null, "Code Fixes", "6010")>]
 [<ProvideLanguageEditorOptionPage(typeof<OptionsUI.LanguageServicePerformanceOptionPage>, "F#", null, "Performance", "6011")>]
 [<ProvideLanguageEditorOptionPage(typeof<OptionsUI.AdvancedSettingsOptionPage>, "F#", null, "Advanced", "6012")>]
-[<ProvideLanguageEditorOptionPage(typeof<OptionsUI.CodeLensOptionPage>, "F#", null, "CodeLens", "6013")>]
+[<ProvideLanguageEditorOptionPage(typeof<OptionsUI.LensOptionPage>, "F#", null, "Lens", "6013")>]
 [<ProvideLanguageEditorOptionPage(typeof<OptionsUI.FormattingOptionPage>, "F#", null, "Formatting", "6014")>]
 [<ProvideFSharpVersionRegistration(FSharpConstants.projectPackageGuidString, "Microsoft Visual F#")>]
 // 64 represents a hex number. It needs to be greater than 37 so the TextMate editor will not be chosen as higher priority.

vsintegration/src/FSharp.Editor/CodeLens/AbstractCodeLensDisplayService.fs renamed to vsintegration/src/FSharp.Editor/Lens/LensDisplayService.fs

@@ -12,7 +12,7 @@ open System.Threading
 open System.Windows
 open System.Collections.Generic
 
-type CodeLensDisplayService (view : IWpfTextView, buffer : ITextBuffer) as self =
+type LensDisplayService (view : IWpfTextView, buffer : ITextBuffer) as self =
 
     // Add buffer changed event handler
     do (
@@ -21,7 +21,7 @@ type CodeLensDisplayService (view : IWpfTextView, buffer : ITextBuffer) as self
        )
 
     /// <summary>
-    /// Enqueing an unit signals to the tagger that all visible line lens must be layouted again,
+    /// Enqueing an unit signals to the tagger that all visible lens must be layouted again,
     /// to respect single line changes.
     /// </summary>
     member val RelayoutRequested : Queue<_> = Queue() with get
@@ -46,7 +46,7 @@ type CodeLensDisplayService (view : IWpfTextView, buffer : ITextBuffer) as self
     /// Text view for accessing the adornment layer.
     member val View: IWpfTextView = view
 
-    member val CodeLensLayer = view.GetAdornmentLayer "LineLens"
+    member val LensLayer = view.GetAdornmentLayer "Lens"
 
     /// Tracks the recent first + last visible line numbers for adornment layout logic.
     member val RecentFirstVsblLineNmbr = 0 with get, set
@@ -154,30 +154,30 @@ type CodeLensDisplayService (view : IWpfTextView, buffer : ITextBuffer) as self
             self.RelayoutRequested.Enqueue(())
          with e ->
 #if DEBUG
-            logErrorf "Error in line lens provider: %A" e
+            logErrorf "Error in lens provider: %A" e
 #else
             ignore e
 #endif
 
-    /// Public non-thread-safe method to add line lens for a given tracking span.
-    /// Returns an UIElement which can be used to add Ui elements and to remove the line lens later.
-    member self.AddCodeLens (trackingSpan:ITrackingSpan) =
-        if trackingSpan.TextBuffer <> buffer then failwith "TrackingSpan text buffer does not equal with CodeLens text buffer"
+    /// Public non-thread-safe method to add lens for a given tracking span.
+    /// Returns an UIElement which can be used to add Ui elements and to remove the lens later.
+    member self.AddLens (trackingSpan:ITrackingSpan) =
+        if trackingSpan.TextBuffer <> buffer then failwith "TrackingSpan text buffer does not equal with Lens text buffer"
         let Grid = self.AddTrackingSpan trackingSpan
         self.RelayoutRequested.Enqueue(())
         Grid :> UIElement
 
-    /// Public non-thread-safe method to remove line lens for a given tracking span.
-    member self.RemoveCodeLens (trackingSpan:ITrackingSpan) =
+    /// Public non-thread-safe method to remove lens for a given tracking span.
+    member self.RemoveLens (trackingSpan:ITrackingSpan) =
         if self.UiElements.ContainsKey trackingSpan then
             let Grid = self.UiElements.[trackingSpan]
             Grid.Children.Clear()
             self.UiElements.Remove trackingSpan |> ignore
             try
-                self.CodeLensLayer.RemoveAdornment(Grid) 
+                self.LensLayer.RemoveAdornment(Grid) 
             with e ->
 #if DEBUG
-                logExceptionWithContext(e, "Removing line lens")
+                logExceptionWithContext(e, "Removing lens")
 #else
                 ignore e
 #endif
@@ -200,16 +200,16 @@ type CodeLensDisplayService (view : IWpfTextView, buffer : ITextBuffer) as self
             logWarningf "No tracking span is accociated with this line number %d!" lineNumber
 #endif
 
-    member self.AddUiElementToCodeLens (trackingSpan:ITrackingSpan, uiElement:UIElement) =
+    member self.AddUiElementToLens (trackingSpan:ITrackingSpan, uiElement:UIElement) =
         let Grid = self.UiElements.[trackingSpan]
         Grid.Children.Add uiElement |> ignore
 
-    member self.AddUiElementToCodeLensOnce (trackingSpan:ITrackingSpan, uiElement:UIElement)=
+    member self.AddUiElementToLensOnce (trackingSpan:ITrackingSpan, uiElement:UIElement)=
         let Grid = self.UiElements.[trackingSpan]
         if uiElement |> Grid.Children.Contains |> not then
-            self.AddUiElementToCodeLens (trackingSpan, uiElement)
+            self.AddUiElementToLens (trackingSpan, uiElement)
 
-    member self.RemoveUiElementFromCodeLens (trackingSpan:ITrackingSpan, uiElement:UIElement) =
+    member self.RemoveUiElementFromLens (trackingSpan:ITrackingSpan, uiElement:UIElement) =
         let Grid = self.UiElements.[trackingSpan]
         Grid.Children.Remove(uiElement) |> ignore
 
@@ -317,7 +317,7 @@ type CodeLensDisplayService (view : IWpfTextView, buffer : ITextBuffer) as self
             // and would consume too much performance
             do! Async.Sleep(5) |> liftAsync // Skip at least one frames
             do! Async.SwitchToContext self.UiContext |> liftAsync
-            let layer = self.CodeLensLayer
+            let layer = self.LensLayer
             do! Async.Sleep(495) |> liftAsync
             try
                 for visibleLineNumber in visibleLineNumbers do

vsintegration/src/FSharp.Editor/CodeLens/CodeLensProvider.fs renamed to vsintegration/src/FSharp.Editor/Lens/LensProvider.fs

@@ -17,7 +17,7 @@ open Microsoft.CodeAnalysis.ExternalAccess.FSharp.Editor.Shared.Utilities
 [<Export(typeof<IViewTaggerProvider>)>]
 [<ContentType(FSharpConstants.FSharpContentTypeName)>]
 [<TextViewRole(PredefinedTextViewRoles.Document)>]
-type internal CodeLensProvider  
+type internal LensProvider  
     [<ImportingConstructor>]
     (
         [<Import(typeof<SVsServiceProvider>)>] serviceProvider: IServiceProvider,
@@ -32,32 +32,32 @@ type internal CodeLensProvider
         | true, document -> Some document
         | _ -> None
 
-    let lineLensProviders = ResizeArray()
+    let lensProviders = ResizeArray()
     let componentModel = Package.GetGlobalService(typeof<ComponentModelHost.SComponentModel>) :?> ComponentModelHost.IComponentModel
     let workspace = componentModel.GetService<VisualStudioWorkspace>()
 
-    let addLineLensProvider wpfView buffer =
+    let addLensProvider wpfView buffer =
         textDocumentFactory
         |> tryGetTextDocument buffer
         |> Option.map (fun document -> workspace.CurrentSolution.GetDocumentIdsWithFilePath(document.FilePath))
         |> Option.bind Seq.tryHead
         |> Option.map (fun documentId ->
-            let service = FSharpCodeLensService(serviceProvider, workspace, documentId, buffer, metadataAsSource, componentModel.GetService(), typeMap, CodeLensDisplayService(wpfView, buffer), settings)
+            let service = LensService(serviceProvider, workspace, documentId, buffer, metadataAsSource, componentModel.GetService(), typeMap, LensDisplayService(wpfView, buffer), settings)
             let provider = (wpfView, service)
-            wpfView.Closed.Add (fun _ -> lineLensProviders.Remove provider |> ignore)
-            lineLensProviders.Add(provider))
+            wpfView.Closed.Add (fun _ -> lensProviders.Remove provider |> ignore)
+            lensProviders.Add(provider))
 
-    [<Export(typeof<AdornmentLayerDefinition>); Name("LineLens");
+    [<Export(typeof<AdornmentLayerDefinition>); Name("Lens");
       Order(Before = PredefinedAdornmentLayers.Text);
       TextViewRole(PredefinedTextViewRoles.Document)>]
-    member val LineLensAdornmentLayerDefinition : AdornmentLayerDefinition = null with get, set
+    member val LensAdornmentLayerDefinition : AdornmentLayerDefinition = null with get, set
 
     interface IWpfTextViewCreationListener with
         override _.TextViewCreated view =
-            if settings.CodeLens.Enabled then
+            if settings.Lens.Enabled then
                 let provider = 
-                    lineLensProviders 
+                    lensProviders 
                     |> Seq.tryFind (fun (v, _) -> v = view)
 
                 if provider.IsNone then
-                    addLineLensProvider view (view.TextBuffer) |> ignore
+                    addLensProvider view (view.TextBuffer) |> ignore