Merge pull request #327 from PowerShell/kapilmb/provide-psd1-symbols

Provide symbol outline for psd1 files

Author: daviwil

src/PowerShellEditorServices/Language/AstOperations.cs

@@ -209,14 +209,74 @@ static public IEnumerable<SymbolReference> FindSymbolsInDocument(Ast scriptAst,
 //            }
 //            else
             {
-                FindSymbolsVisitor findSymbolsVisitor = new FindSymbolsVisitor();
-                scriptAst.Visit(findSymbolsVisitor);
-                symbolReferences = findSymbolsVisitor.SymbolReferences;
+                if (IsPowerShellDataFileAst(scriptAst))
+                {
+                    var findHashtableSymbolsVisitor = new FindHashtableSymbolsVisitor();
+                    scriptAst.Visit(findHashtableSymbolsVisitor);
+                    symbolReferences = findHashtableSymbolsVisitor.SymbolReferences;
+                }
+                else
+                {
+                    FindSymbolsVisitor findSymbolsVisitor = new FindSymbolsVisitor();
+                    scriptAst.Visit(findSymbolsVisitor);
+                    symbolReferences = findSymbolsVisitor.SymbolReferences;
+                }
             }
 
             return symbolReferences;
         }
 
+        static private bool IsPowerShellDataFileAst(Ast ast)
+        {
+            // sometimes we don't have reliable access to the filename
+            // so we employ heuristics to check if the contents are
+            // part of a psd1 file.
+            return (ast.Extent.File != null
+                        && ast.Extent.File.EndsWith(".psd1", StringComparison.OrdinalIgnoreCase))
+                    || IsPowerShellDataFileAstNode(
+                        new { Item = ast, Children = new List<dynamic>() },
+                        new Type[] {
+                            typeof(ScriptBlockAst),
+                            typeof(NamedBlockAst),
+                            typeof(PipelineAst),
+                            typeof(CommandExpressionAst),
+                            typeof(HashtableAst) },
+                        0);
+        }
+
+        static private bool IsPowerShellDataFileAstNode(dynamic node, Type[] levelAstMap, int level)
+        {
+            var levelAstTypeMatch = node.Item.GetType().Equals(levelAstMap[level]);
+            if (!levelAstTypeMatch)
+            {
+                return false;
+            }
+
+            if (level == levelAstMap.Length - 1)
+            {
+                return levelAstTypeMatch;
+            }
+
+            var astsFound = (node.Item as Ast).FindAll(a => a is Ast, false);
+            if (astsFound != null)
+            {
+                foreach (var astFound in astsFound)
+                {
+                    if (!astFound.Equals(node.Item)
+                        && node.Item.Equals(astFound.Parent)
+                        && IsPowerShellDataFileAstNode(
+                            new { Item = astFound, Children = new List<dynamic>() },
+                            levelAstMap,
+                            level + 1))
+                    {
+                        return true;
+                    }
+                }
+            }
+
+            return false;
+        }
+
         /// <summary>
         /// Finds all files dot sourced in a script
         /// </summary>

src/PowerShellEditorServices/Language/FindSymbolsVisitor.cs

@@ -89,4 +89,60 @@ private bool IsAssignedAtScriptScope(VariableExpressionAst variableExpressionAst
             return false;
         }
     }
+
+    /// <summary>
+    /// Visitor to find all the keys in Hashtable AST
+    /// </summary>
+    internal class FindHashtableSymbolsVisitor : AstVisitor
+    {
+        /// <summary>
+        /// List of symbols (keys) found in the hashtable
+        /// </summary>
+        public List<SymbolReference> SymbolReferences { get; private set; }
+
+        /// <summary>
+        /// Initializes a new instance of FindHashtableSymbolsVisitor class
+        /// </summary>
+        public FindHashtableSymbolsVisitor()
+        {
+            SymbolReferences = new List<SymbolReference>();
+        }
+
+        /// <summary>
+        /// Adds keys in the input hashtable to the symbol reference
+        /// </summary>
+        public override AstVisitAction VisitHashtable(HashtableAst hashtableAst)
+        {
+            if (hashtableAst.KeyValuePairs == null)
+            {
+                return AstVisitAction.Continue;
+            }
+
+            foreach (var kvp in hashtableAst.KeyValuePairs)
+            {
+                var keyStrConstExprAst = kvp.Item1 as StringConstantExpressionAst;
+                if (keyStrConstExprAst != null)
+                {
+                    IScriptExtent nameExtent = new ScriptExtent()
+                    {
+                        Text = keyStrConstExprAst.Value,
+                        StartLineNumber = kvp.Item1.Extent.StartLineNumber,
+                        EndLineNumber = kvp.Item2.Extent.EndLineNumber,
+                        StartColumnNumber = kvp.Item1.Extent.StartColumnNumber,
+                        EndColumnNumber = kvp.Item2.Extent.EndColumnNumber
+                    };
+
+                    SymbolType symbolType = SymbolType.HashtableKey;
+
+                    this.SymbolReferences.Add(
+                        new SymbolReference(
+                            symbolType,
+                            nameExtent));
+
+                }
+            }
+
+            return AstVisitAction.Continue;
+        }
+    }
 }

src/PowerShellEditorServices/Language/SymbolType.cs

@@ -14,17 +14,17 @@ public enum SymbolType
         /// The symbol type is unknown
         /// </summary>
         Unknown = 0,
-        
+
         /// <summary>
         /// The symbol is a vairable
         /// </summary>
         Variable,
-        
+
         /// <summary>
         /// The symbol is a function
         /// </summary>
         Function,
-        
+
         /// <summary>
         /// The symbol is a parameter
         /// </summary>
@@ -39,6 +39,10 @@ public enum SymbolType
         /// The symbol is a workflow
         /// </summary>
         Workflow,
+
+        /// <summary>
+        /// The symbol is a hashtable key
+        /// </summary>
+        HashtableKey
     }
 }
-