check type for property and function members

Author: fflaten

src/PowerShellEditorServices/Services/Symbols/SymbolsService.cs

@@ -333,7 +333,7 @@ public Task<SymbolDetails> FindSymbolDetailsAtLocationAsync(
                     scriptFile.ScriptAst,
                     lineNumber,
                     columnNumber,
-                    returnMemberSignature: true);
+                    returnFullSignature: true);
 
             if (symbolReference == null)
             {

src/PowerShellEditorServices/Services/Symbols/Vistors/AstOperations.cs

@@ -148,21 +148,21 @@ await executionService.ExecuteDelegateAsync(
         /// <param name="lineNumber">The line number of the cursor for the given script</param>
         /// <param name="columnNumber">The column number of the cursor for the given script</param>
         /// <param name="includeDefinitions">Includes full symbol definition ranges in the search.</param>
-        /// <param name="returnMemberSignature">Includes return type and class in symbol name.</param>
+        /// <param name="returnFullSignature">Includes return or property type in symbol name.</param>
         /// <returns>SymbolReference of found symbol</returns>
         public static SymbolReference FindSymbolAtPosition(
             Ast scriptAst,
             int lineNumber,
             int columnNumber,
             bool includeDefinitions = false,
-            bool returnMemberSignature = false)
+            bool returnFullSignature = false)
         {
             FindSymbolVisitor symbolVisitor =
                 new(
                     lineNumber,
                     columnNumber,
                     includeDefinitions,
-                    returnMemberSignature);
+                    returnFullSignature);
 
             scriptAst.Visit(symbolVisitor);
 

src/PowerShellEditorServices/Services/Symbols/Vistors/FindDeclarationVisitor.cs

@@ -110,10 +110,10 @@ public override AstVisitAction VisitFunctionMember(FunctionMemberAst functionMem
                     SymbolType.Constructor : SymbolType.Method;
 
             if (symbolRef.SymbolType.Equals(symbolType) &&
-                VisitorUtils.GetMemberOverloadName(functionMemberAst).Equals(symbolRef.SymbolName, StringComparison.CurrentCultureIgnoreCase))
+                VisitorUtils.GetMemberOverloadName(functionMemberAst, true, false).Equals(symbolRef.SymbolName, StringComparison.CurrentCultureIgnoreCase))
             {
                 // We only want the method/ctor name. Get start-location for name
-                IScriptExtent nameExtent = VisitorUtils.GetNameExtent(functionMemberAst);
+                IScriptExtent nameExtent = VisitorUtils.GetNameExtent(functionMemberAst, true, false);
 
                 FoundDeclaration =
                     new SymbolReference(
@@ -141,10 +141,10 @@ propertyMemberAst.Parent is TypeDefinitionAst typeAst && typeAst.IsEnum ?
                     SymbolType.EnumMember : SymbolType.Property;
 
             if (symbolRef.SymbolType.Equals(symbolType) &&
-                VisitorUtils.GetMemberOverloadName(propertyMemberAst).Equals(symbolRef.SymbolName, StringComparison.CurrentCultureIgnoreCase))
+                VisitorUtils.GetMemberOverloadName(propertyMemberAst, false).Equals(symbolRef.SymbolName, StringComparison.CurrentCultureIgnoreCase))
             {
                 // We only want the property name. Get start-location for name
-                IScriptExtent nameExtent = VisitorUtils.GetNameExtent(propertyMemberAst);
+                IScriptExtent nameExtent = VisitorUtils.GetNameExtent(propertyMemberAst, false);
 
                 FoundDeclaration =
                     new SymbolReference(

src/PowerShellEditorServices/Services/Symbols/Vistors/FindReferencesVisitor.cs

@@ -235,10 +235,10 @@ public override AstVisitAction VisitFunctionMember(FunctionMemberAst functionMem
                     SymbolType.Constructor : SymbolType.Method;
 
             if (_symbolRef.SymbolType.Equals(symbolType) &&
-                VisitorUtils.GetMemberOverloadName(functionMemberAst).Equals(_symbolRef.SymbolName, StringComparison.CurrentCultureIgnoreCase))
+                VisitorUtils.GetMemberOverloadName(functionMemberAst, true, false).Equals(_symbolRef.SymbolName, StringComparison.CurrentCultureIgnoreCase))
             {
                 // We only want the method/ctor name. Get start-location for name
-                IScriptExtent nameExtent = VisitorUtils.GetNameExtent(functionMemberAst);
+                IScriptExtent nameExtent = VisitorUtils.GetNameExtent(functionMemberAst, true, false);
                 FoundReferences.Add(new SymbolReference(symbolType, nameExtent));
             }
             return AstVisitAction.Continue;
@@ -258,10 +258,10 @@ propertyMemberAst.Parent is TypeDefinitionAst typeAst && typeAst.IsEnum ?
                     SymbolType.EnumMember : SymbolType.Property;
 
             if (_symbolRef.SymbolType.Equals(symbolType) &&
-                VisitorUtils.GetMemberOverloadName(propertyMemberAst).Equals(_symbolRef.SymbolName, StringComparison.CurrentCultureIgnoreCase))
+                VisitorUtils.GetMemberOverloadName(propertyMemberAst, false).Equals(_symbolRef.SymbolName, StringComparison.CurrentCultureIgnoreCase))
             {
                 // We only want the property name. Get start-location for name
-                IScriptExtent nameExtent = VisitorUtils.GetNameExtent(propertyMemberAst);
+                IScriptExtent nameExtent = VisitorUtils.GetNameExtent(propertyMemberAst, false);
                 FoundReferences.Add(new SymbolReference(SymbolType.Property, nameExtent));
             }
             return AstVisitAction.Continue;

src/PowerShellEditorServices/Services/Symbols/Vistors/FindSymbolVisitor.cs

@@ -14,20 +14,20 @@ internal class FindSymbolVisitor : AstVisitor2
         private readonly int lineNumber;
         private readonly int columnNumber;
         private readonly bool includeDefinitions;
-        private readonly bool returnMemberSignature;
+        private readonly bool returnFullSignature;
 
         public SymbolReference FoundSymbolReference { get; private set; }
 
         public FindSymbolVisitor(
             int lineNumber,
             int columnNumber,
             bool includeDefinitions,
-            bool returnMemberSignature)
+            bool returnFullSignature)
         {
             this.lineNumber = lineNumber;
             this.columnNumber = columnNumber;
             this.includeDefinitions = includeDefinitions;
-            this.returnMemberSignature = returnMemberSignature;
+            this.returnFullSignature = returnFullSignature;
         }
 
         /// <summary>
@@ -164,7 +164,7 @@ private bool IsPositionInExtent(IScriptExtent extent)
         public override AstVisitAction VisitFunctionMember(FunctionMemberAst functionMemberAst)
         {
             // We only want the method/ctor name. Get start-location for name
-            IScriptExtent nameExtent = VisitorUtils.GetNameExtent(functionMemberAst, returnMemberSignature);
+            IScriptExtent nameExtent = VisitorUtils.GetNameExtent(functionMemberAst, true, returnFullSignature);
 
             if (IsPositionInExtent(nameExtent))
             {
@@ -328,7 +328,7 @@ public override AstVisitAction VisitConfigurationDefinition(ConfigurationDefinit
         public override AstVisitAction VisitPropertyMember(PropertyMemberAst propertyMemberAst)
         {
             // We only want the property name. Get start-location for name
-            IScriptExtent nameExtent = VisitorUtils.GetNameExtent(propertyMemberAst, returnMemberSignature);
+            IScriptExtent nameExtent = VisitorUtils.GetNameExtent(propertyMemberAst, returnFullSignature);
 
             if (IsPositionInExtent(nameExtent))
             {

src/PowerShellEditorServices/Services/Symbols/Vistors/FindSymbolsVisitor.cs

@@ -107,7 +107,7 @@ public override AstVisitAction VisitTypeDefinition(TypeDefinitionAst typeDefinit
         public override AstVisitAction VisitFunctionMember(FunctionMemberAst functionMemberAst)
         {
             (int startColumn, int startLine) = VisitorUtils.GetNameStartColumnAndLineFromAst(functionMemberAst);
-            IScriptExtent nameExtent = GetNewExtent(functionMemberAst, VisitorUtils.GetMemberOverloadName(functionMemberAst), startLine, startColumn);
+            IScriptExtent nameExtent = GetNewExtent(functionMemberAst, VisitorUtils.GetMemberOverloadName(functionMemberAst, false, false), startLine, startColumn);
 
             SymbolType symbolType =
                 functionMemberAst.IsConstructor ?

src/PowerShellEditorServices/Utility/VisitorUtils.cs

@@ -152,15 +152,16 @@ internal static PSESSymbols.ScriptExtent GetNameExtent(TypeDefinitionAst typeDef
         /// Gets a new ScriptExtent for a given Ast for the symbol name only (variable)
         /// </summary>
         /// <param name="functionMemberAst">A FunctionMemberAst in the script's AST</param>
-        /// <param name="includeSignature">A bool indicating if return type and class should be included</param>
+        /// <param name="useQualifiedName">A bool indicating if class/enum name should be prepended</param>
+        /// <param name="includeReturnType">A bool indicating if return type should be included for methods</param>
         /// <returns>A ScriptExtent with for the symbol name only</returns>
-        internal static PSESSymbols.ScriptExtent GetNameExtent(FunctionMemberAst functionMemberAst, bool includeSignature = false)
+        internal static PSESSymbols.ScriptExtent GetNameExtent(FunctionMemberAst functionMemberAst, bool useQualifiedName = true, bool includeReturnType = false)
         {
             (int startColumn, int startLine) = GetNameStartColumnAndLineFromAst(functionMemberAst);
 
             return new PSESSymbols.ScriptExtent()
             {
-                Text = GetMemberOverloadName(functionMemberAst, includeSignature),
+                Text = GetMemberOverloadName(functionMemberAst, useQualifiedName, includeReturnType),
                 StartLineNumber = startLine,
                 EndLineNumber = startLine,
                 StartColumnNumber = startColumn,
@@ -173,9 +174,9 @@ internal static PSESSymbols.ScriptExtent GetNameExtent(FunctionMemberAst functio
         /// Gets a new ScriptExtent for a given Ast for the property name only
         /// </summary>
         /// <param name="propertyMemberAst">A PropertyMemberAst in the script's AST</param>
-        /// <param name="includeSignature">A bool indicating if property-type and name of class/enum should be included</param>
+        /// <param name="includePropertyType">A bool indicating if type should be included for class property</param>
         /// <returns>A ScriptExtent with for the symbol name only</returns>
-        internal static PSESSymbols.ScriptExtent GetNameExtent(PropertyMemberAst propertyMemberAst, bool includeSignature = false)
+        internal static PSESSymbols.ScriptExtent GetNameExtent(PropertyMemberAst propertyMemberAst, bool includePropertyType = false)
         {
             bool isEnumMember = propertyMemberAst.Parent is TypeDefinitionAst typeDef && typeDef.IsEnum;
             (int startColumn, int startLine) = GetNameStartColumnAndLineFromAst(propertyMemberAst, isEnumMember);
@@ -187,7 +188,7 @@ internal static PSESSymbols.ScriptExtent GetNameExtent(PropertyMemberAst propert
 
             return new PSESSymbols.ScriptExtent()
             {
-                Text = GetMemberOverloadName(propertyMemberAst, includeSignature),
+                Text = GetMemberOverloadName(propertyMemberAst, includePropertyType),
                 StartLineNumber = startLine,
                 EndLineNumber = startLine,
                 StartColumnNumber = startColumn,
@@ -221,24 +222,24 @@ internal static PSESSymbols.ScriptExtent GetNameExtent(ConfigurationDefinitionAs
         /// Gets the method or constructor name with parameters for current overload.
         /// </summary>
         /// <param name="functionMemberAst">A FunctionMemberAst object in the script's AST</param>
-        /// <param name="includeSignature">A bool indicating if return type and class should be included</param>
+        /// <param name="useQualifiedName">A bool indicating if class/enum name should be prepended</param>
+        /// <param name="includeReturnType">A bool indicating if return type should be included for methods</param>
         /// <returns>Function member name with return type (optional) and parameters</returns>
-        internal static string GetMemberOverloadName(FunctionMemberAst functionMemberAst, bool includeSignature = false)
+        internal static string GetMemberOverloadName(FunctionMemberAst functionMemberAst,
+            bool useQualifiedName = true,
+            bool includeReturnType = false)
         {
             StringBuilder sb = new();
 
             // Prepend return type and class. Used for symbol details (hover)
-            if (includeSignature)
+            if (includeReturnType && !functionMemberAst.IsConstructor)
             {
-                if (!functionMemberAst.IsConstructor)
-                {
-                    sb.Append(functionMemberAst.ReturnType?.TypeName.Name ?? "void").Append(' ');
-                }
+                sb.Append(functionMemberAst.ReturnType?.TypeName.Name ?? "void").Append(' ');
+            }
 
-                if (functionMemberAst.Parent is TypeDefinitionAst typeAst && typeAst.IsClass)
-                {
-                    sb.Append(typeAst.Name).Append('.');
-                }
+            if (useQualifiedName && functionMemberAst.Parent is TypeDefinitionAst typeAst && typeAst.IsClass)
+            {
+                sb.Append(typeAst.Name).Append('.');
             }
 
             sb.Append(functionMemberAst.Name);
@@ -264,16 +265,17 @@ internal static string GetMemberOverloadName(FunctionMemberAst functionMemberAst
         /// Gets the property name with type and class/enum.
         /// </summary>
         /// <param name="propertyMemberAst">A PropertyMemberAst object in the script's AST</param>
-        /// <param name="includeSignature">A bool indicating if property-type and name of class/enum should be included</param>
+        /// <param name="includePropertyType">A bool indicating if type should be included for class property</param>
         /// <returns>Property name with type (optional) and class/enum</returns>
-        internal static string GetMemberOverloadName(PropertyMemberAst propertyMemberAst, bool includeSignature = false)
+        internal static string GetMemberOverloadName(PropertyMemberAst propertyMemberAst,
+            bool includePropertyType = false)
         {
             StringBuilder sb = new();
 
             // Prepend return type and class. Used for symbol details (hover)
-            if (includeSignature && propertyMemberAst.Parent is TypeDefinitionAst typeAst)
+            if (propertyMemberAst.Parent is TypeDefinitionAst typeAst)
             {
-                if (!typeAst.IsEnum)
+                if (includePropertyType && !typeAst.IsEnum)
                 {
                     sb.Append(propertyMemberAst.PropertyType?.TypeName.Name ?? "object").Append(' ');
                 }