Members hidden from IntelliSense are now also omitted in QuickInfo - fixes #50

forki · latkin · commit ac5562263390 · 2015-01-21T17:49:41.000-08:00
closes #73 commit e127dfa Author: Steffen Forkmann <steffen.forkmann@msu-solutions.de> Date: Wed Jan 21 10:52:10 2015 +0100 fix typos in XmlDocumentation.fs and ast.fs commit 6f99029 Author: Steffen Forkmann <steffen.forkmann@msu-solutions.de> Date: Wed Jan 21 12:17:58 2015 +0100 Obsolete members are now also omitted in QuickInfo - references #50 commit ae54746 Author: Steffen Forkmann <steffen.forkmann@msu-solutions.de> Date: Wed Jan 21 12:17:16 2015 +0100 Capturing broken QuickTip for obsolete methods in test - references #50 commit 1e38a8a Author: Steffen Forkmann <steffen.forkmann@msu-solutions.de> Date: Wed Jan 21 10:51:23 2015 +0100 Members hidden from IntelliSense are now also omitted in QuickInfo - fixes #50 commit 5f27136 Author: Steffen Forkmann <steffen.forkmann@msu-solutions.de> Date: Sun Jan 18 10:49:41 2015 +0100 Capturing broken QuickTips for hidden methods in test - references #50
diff --git a/src/fsharp/NicePrint.fs b/src/fsharp/NicePrint.fs
@@ -1500,7 +1500,8 @@ module private TastDefinitionPrinting =
                                       // Don't print individual methods forming interface implementations - these are currently never exported 
                                       not (isInterfaceTy denv.g oty)
                                   | [] -> true)
-              |> List.filter (fun v -> denv.showObsoleteMembers || not (HasFSharpAttribute denv.g denv.g.attrib_SystemObsolete v.Attribs))
+              |> List.filter (fun v -> denv.showObsoleteMembers || not (Infos.AttributeChecking.CheckFSharpAttributesForObsolete denv.g v.Attribs))
+              |> List.filter (fun v -> denv.showHiddenMembers || not (Infos.AttributeChecking.CheckFSharpAttributesForHidden denv.g v.Attribs))
           // sort 
           let sortKey (v:ValRef) = (not v.IsConstructor,    // constructors before others 
                                     v.Id.idText,            // sort by name 
diff --git a/src/fsharp/ast.fs b/src/fsharp/ast.fs
@@ -51,7 +51,7 @@ type XmlDocCollector() =
         lazy (savedLines.ToArray() |> Array.sortWith (fun (_,p1) (_,p2) -> posCompare p1 p2))
 
     let check() = 
-        assert (not savedLinesAsArray.IsValueCreated && "can't add more XmlDoc elements to XmlDocCOllector after extracting first XmlDoc from the overall results" <> "")
+        assert (not savedLinesAsArray.IsValueCreated && "can't add more XmlDoc elements to XmlDocCollector after extracting first XmlDoc from the overall results" <> "")
 
     member x.AddGrabPoint(pos) = 
         check()
diff --git a/src/fsharp/fsc.fs b/src/fsharp/fsc.fs
@@ -548,11 +548,13 @@ let runFromCommandLineToImportingAssemblies(displayPSTypeProviderSecurityDialogB
 // Code from here on down is just used by fsc.exe
 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-let BuildInitialDisplayEnvForDocGeneration tcGlobals = 
+let BuildInitialDisplayEnvForSigFileGeneration tcGlobals = 
     let denv = DisplayEnv.Empty tcGlobals
     let denv = 
         { denv with 
            showImperativeTyparAnnotations=true;
+           showHiddenMembers=true;
+           showObsoleteMembers=true;
            showAttributes=true; }
     denv.SetOpenPaths 
         [ FSharpLib.RootPath 
@@ -577,7 +579,7 @@ module InterfaceFileWriter =
             fprintfn os "" 
 
         for (TImplFile(_,_,mexpr,_,_)) in declaredImpls do
-            let denv = BuildInitialDisplayEnvForDocGeneration tcGlobals
+            let denv = BuildInitialDisplayEnvForSigFileGeneration tcGlobals
             writeViaBufferWithEnvironmentNewLines os (fun os s -> Printf.bprintf os "%s\n\n" s)
               (NicePrint.layoutInferredSigOfModuleExpr true denv infoReader AccessibleFromSomewhere range0 mexpr |> Layout.squashTo 80 |> Layout.showL)
        
diff --git a/src/fsharp/infos.fs b/src/fsharp/infos.fs
@@ -2660,22 +2660,29 @@ module AttributeChecking =
         let (AttribInfo(tref,_)) = g.attrib_SystemObsolete
         isSome (TryDecodeILAttribute g tref (Some(tref.Scope)) cattrs)
 
+    /// Checks the attributes for CompilerMessageAttribute, which has an IsHidden argument that allows
+    /// items to be suppressed from intellisense.
+    let CheckFSharpAttributesForHidden g attribs = 
+        nonNil attribs &&         
+        (match TryFindFSharpAttribute g g.attrib_CompilerMessageAttribute attribs with
+         | Some(Attrib(_,_,[AttribStringArg _; AttribInt32Arg messageNumber],
+                     ExtractAttribNamedArg "IsHidden" (AttribBoolArg v),_,_,_)) -> 
+             // Message number 62 is for "ML Compatibility". Items labelled with this are visible in intellisense
+             // when mlCompatibility is set.
+             v && not (messageNumber = 62 && g.mlCompatibility)
+         | _ -> false)
+
+    /// Indicate if a list of F# attributes contains 'ObsoleteAttribute'. Used to suppress the item in intellisense.
+    let CheckFSharpAttributesForObsolete g attribs = 
+        nonNil attribs && (HasFSharpAttribute g g.attrib_SystemObsolete attribs)
+
     /// Indicate if a list of F# attributes contains 'ObsoleteAttribute'. Used to suppress the item in intellisense.
     /// Also check the attributes for CompilerMessageAttribute, which has an IsHidden argument that allows
     /// items to be suppressed from intellisense.
     let CheckFSharpAttributesForUnseen g attribs _m = 
-        nonNil attribs && 
-        (let isObsolete = isSome (TryFindFSharpAttribute g g.attrib_SystemObsolete attribs) 
-         let isHidden = 
-             (match TryFindFSharpAttribute g g.attrib_CompilerMessageAttribute attribs with
-              | Some(Attrib(_,_,[AttribStringArg _; AttribInt32Arg messageNumber],
-                            ExtractAttribNamedArg "IsHidden" (AttribBoolArg v),_,_,_)) -> 
-                  // Message number 62 is for "ML Compatibility". Items labelled with this are visible in intellisense
-                  // when mlCompatibility is set.
-                  v && not (messageNumber = 62 && g.mlCompatibility)
-              | _ -> false)
-         isObsolete || isHidden
-        )
+        nonNil attribs &&         
+        (CheckFSharpAttributesForObsolete g attribs ||
+         CheckFSharpAttributesForHidden g attribs)
       
 #if EXTENSIONTYPING
     /// Indicate if a list of provided attributes contains 'ObsoleteAttribute'. Used to suppress the item in intellisense.
diff --git a/src/fsharp/tastops.fs b/src/fsharp/tastops.fs
@@ -2344,6 +2344,7 @@ type DisplayEnv =
       suppressNestedTypes: bool;
       maxMembers : int option;
       showObsoleteMembers: bool; 
+      showHiddenMembers: bool; 
       showTyparBinding: bool; 
       showImperativeTyparAnnotations: bool;
       suppressInlineKeyword: bool;
@@ -2374,7 +2375,8 @@ type DisplayEnv =
         shortTypeNames=false;
         suppressNestedTypes=false;
         maxMembers=None;
-        showObsoleteMembers=true;
+        showObsoleteMembers=false;
+        showHiddenMembers=false;
         showTyparBinding = false;
         showImperativeTyparAnnotations=false;
         suppressInlineKeyword=false;
diff --git a/src/fsharp/tastops.fsi b/src/fsharp/tastops.fsi
@@ -587,6 +587,7 @@ type DisplayEnv =
       suppressNestedTypes: bool;
       maxMembers : int option;
       showObsoleteMembers: bool; 
+      showHiddenMembers: bool; 
       showTyparBinding: bool;
       showImperativeTyparAnnotations: bool;
       suppressInlineKeyword:bool;
diff --git a/vsintegration/src/unittests/Tests.LanguageService.QuickInfo.fs b/vsintegration/src/unittests/Tests.LanguageService.QuickInfo.fs
@@ -165,6 +165,46 @@ type QuickInfoTests() =
             f = (fun ((text, _), _) -> printfn "actual %s" text; Assert.IsTrue(text.Contains "tooltip for operator"))
             )
     
+    [<Test>]
+    member public this.``QuickInfo.HiddenMember``() =
+        // Tooltips showed hidden members - #50
+        let source = """
+            open System.ComponentModel
+
+            type TypeU = { Element : string }
+                with
+                  [<EditorBrowsableAttribute(EditorBrowsableState.Never)>] 
+                  [<CompilerMessageAttribute("This method is intended for use in generated code only.", 10001, IsHidden=true, IsError=false)>] 
+                  member x._Print = x.Element.ToString() 
+
+            let u = { Element = "abc" }
+            """
+        this.CheckTooltip(
+            code = source,
+            marker = "ypeU =",
+            atStart = true,
+            f = (fun ((text, _), _) -> printfn "actual %s" text; Assert.IsFalse(text.Contains "member _Print"))
+            )
+
+    [<Test>]
+    member public this.``QuickInfo.ObsoleteMember``() =
+        // Tooltips showed obsolete members - #50
+        let source = """
+            type TypeU = { Element : string }
+                with
+                    [<System.ObsoleteAttribute("This is replaced with Print2")>]
+                    member x.Print1 = x.Element.ToString() 
+                    member x.Print2 = x.Element.ToString() 
+
+            let u = { Element = "abc" }
+            """
+        this.CheckTooltip(
+            code = source,
+            marker = "ypeU =",
+            atStart = true,
+            f = (fun ((text, _), _) -> printfn "actual %s" text; Assert.IsFalse(text.Contains "member Print1"))
+            )
+    
     [<Test>]
     member public this.``QuickInfo.OverriddenMethods``() =
         let source = """
diff --git a/vsintegration/src/vs/FsPkgs/FSharp.LanguageService/XmlDocumentation.fs b/vsintegration/src/vs/FsPkgs/FSharp.LanguageService/XmlDocumentation.fs
@@ -26,7 +26,7 @@ module internal XmlDocumentation =
                     "<root>" + xml + "</root>"
             else xml
 
-    /// Provide Xml Documentatation             
+    /// Provide Xml Documentation             
     type Provider(xmlIndexService:IVsXMLMemberIndexService) = 
         /// Index of assembly name to xml member index.
         let mutable xmlCache = new AgedLookup<string,IVsXMLMemberIndex>(10,areSame=(fun (x,y) -> x = y))
