Merge pull request #103 from adamdriscoll/v3v4

daviwil · daviwil · commit 3a3d984e2785 · 2016-01-04T13:51:28.000-08:00
PowerShell v3/v4 Support
diff --git a/src/PowerShellEditorServices.Protocol/MessageProtocol/MessageDispatcher.cs b/src/PowerShellEditorServices.Protocol/MessageProtocol/MessageDispatcher.cs
@@ -79,7 +79,8 @@ public void Stop()
         {
             // By disposing the thread we cancel all existing work
             // and cause the thread to be destroyed.
-            this.messageLoopThread.Dispose();
+            if (this.messageLoopThread != null)
+                this.messageLoopThread.Dispose();
         }
 
         public void SetRequestHandler<TParams, TResult>(
diff --git a/src/PowerShellEditorServices.Protocol/Server/ProtocolServer.cs b/src/PowerShellEditorServices.Protocol/Server/ProtocolServer.cs
@@ -70,7 +70,8 @@ public void Stop()
                 this.OnStop();
 
                 this.serverChannel.Stop();
-                this.serverExitedTask.SetResult(true);
+                if (this.serverExitedTask != null)
+                    this.serverExitedTask.SetResult(true);
             }
         }
 
diff --git a/src/PowerShellEditorServices/Language/AstOperations.cs b/src/PowerShellEditorServices/Language/AstOperations.cs
@@ -176,13 +176,22 @@ static public SymbolReference FindDefinitionOfSymbol(
         /// Finds all symbols in a script
         /// </summary>
         /// <param name="scriptAst">The abstract syntax tree of the given script</param>
+        /// <param name="powerShellVersion">The PowerShell version the Ast was generated from</param>
         /// <returns>A collection of SymbolReference objects</returns>
-        static public IEnumerable<SymbolReference> FindSymbolsInDocument(Ast scriptAst)
+        static public IEnumerable<SymbolReference> FindSymbolsInDocument(Ast scriptAst, Version powerShellVersion)
         {
-            FindSymbolsVisitor findSymbolsVisitor = new FindSymbolsVisitor();
-            scriptAst.Visit(findSymbolsVisitor);
-
-            return findSymbolsVisitor.SymbolReferences;
+            if (powerShellVersion >= new Version(5,0))
+            {
+                FindSymbolsVisitor2 findSymbolsVisitor = new FindSymbolsVisitor2();
+                scriptAst.Visit(findSymbolsVisitor);
+                return findSymbolsVisitor.SymbolReferences;
+            }
+            else
+            {
+                FindSymbolsVisitor findSymbolsVisitor = new FindSymbolsVisitor();
+                scriptAst.Visit(findSymbolsVisitor);
+                return findSymbolsVisitor.SymbolReferences;
+            }
         }
 
         /// <summary>
diff --git a/src/PowerShellEditorServices/Language/CompletionResults.cs b/src/PowerShellEditorServices/Language/CompletionResults.cs
@@ -275,8 +275,10 @@ private static CompletionType ConvertCompletionResultType(
                 case CompletionResultType.Type:
                     return CompletionType.Type;
 
+#if !PowerShellv3
                 case CompletionResultType.Keyword:
                     return CompletionType.Keyword;
+#endif
 
                 case CompletionResultType.ProviderContainer:
                 case CompletionResultType.ProviderItem:
diff --git a/src/PowerShellEditorServices/Language/FindSymbolVisitor.cs b/src/PowerShellEditorServices/Language/FindSymbolVisitor.cs
@@ -10,7 +10,7 @@ namespace Microsoft.PowerShell.EditorServices
     /// <summary>
     /// The visitor used to find the the symbol at a specfic location in the AST
     /// </summary>
-    internal class FindSymbolVisitor : AstVisitor2
+    internal class FindSymbolVisitor : AstVisitor
     {
         private int lineNumber;
         private int columnNumber;
diff --git a/src/PowerShellEditorServices/Language/FindSymbolsVisitor.cs b/src/PowerShellEditorServices/Language/FindSymbolsVisitor.cs
@@ -11,7 +11,10 @@ namespace Microsoft.PowerShell.EditorServices
     /// <summary>
     /// The visitor used to find all the symbols (function and class defs) in the AST.
     /// </summary>
-    internal class FindSymbolsVisitor : AstVisitor2
+    /// <remarks>
+    /// Requires PowerShell v3 or higher
+    /// </remarks>
+    internal class FindSymbolsVisitor : AstVisitor
     {
         public List<SymbolReference> SymbolReferences { get; private set; }
 
@@ -68,25 +71,7 @@ public override AstVisitAction VisitVariableExpression(VariableExpressionAst var
 
             return AstVisitAction.Continue;
         }
-
-        public override AstVisitAction VisitConfigurationDefinition(ConfigurationDefinitionAst configurationDefinitionAst)
-        {
-            IScriptExtent nameExtent = new ScriptExtent() {
-                Text = configurationDefinitionAst.InstanceName.Extent.Text,
-                StartLineNumber = configurationDefinitionAst.Extent.StartLineNumber,
-                EndLineNumber = configurationDefinitionAst.Extent.EndLineNumber,
-                StartColumnNumber = configurationDefinitionAst.Extent.StartColumnNumber,
-                EndColumnNumber = configurationDefinitionAst.Extent.EndColumnNumber
-            };
-
-            this.SymbolReferences.Add(
-                new SymbolReference(
-                    SymbolType.Configuration,
-                    nameExtent));
-
-            return AstVisitAction.Continue;
-        }
-
+        
         private bool IsAssignedAtScriptScope(VariableExpressionAst variableExpressionAst)
         {
             Ast parent = variableExpressionAst.Parent;
diff --git a/src/PowerShellEditorServices/Language/FindSymbolsVisitor2.cs b/src/PowerShellEditorServices/Language/FindSymbolsVisitor2.cs
@@ -0,0 +1,70 @@
+﻿using System.Collections.Generic;
+using System.Management.Automation.Language;
+
+namespace Microsoft.PowerShell.EditorServices
+{
+    /// <summary>
+    /// The visitor used to find all the symbols (function and class defs) in the AST. 
+    /// </summary>
+    /// <remarks>
+    /// Requires PowerShell v5 or higher
+    /// </remarks>
+    internal class FindSymbolsVisitor2 : AstVisitor2
+    {
+        private FindSymbolsVisitor findSymbolsVisitor;
+
+        public List<SymbolReference> SymbolReferences
+        {
+            get
+            {
+                return this.findSymbolsVisitor.SymbolReferences;
+            }
+        }
+
+        public FindSymbolsVisitor2()
+        {
+            this.findSymbolsVisitor = new FindSymbolsVisitor();
+        }
+
+        /// <summary>
+        /// Adds each function defintion as a 
+        /// </summary>
+        /// <param name="functionDefinitionAst">A functionDefinitionAst object in the script's AST</param>
+        /// <returns>A decision to stop searching if the right symbol was found, 
+        /// or a decision to continue if it wasn't found</returns>
+        public override AstVisitAction VisitFunctionDefinition(FunctionDefinitionAst functionDefinitionAst)
+        {
+            return this.findSymbolsVisitor.VisitFunctionDefinition(functionDefinitionAst);
+        }
+
+        /// <summary>
+        ///  Checks to see if this variable expression is the symbol we are looking for.
+        /// </summary>
+        /// <param name="variableExpressionAst">A VariableExpressionAst object in the script's AST</param>
+        /// <returns>A descion to stop searching if the right symbol was found, 
+        /// or a decision to continue if it wasn't found</returns>
+        public override AstVisitAction VisitVariableExpression(VariableExpressionAst variableExpressionAst)
+        {
+            return this.findSymbolsVisitor.VisitVariableExpression(variableExpressionAst);
+        }
+
+        public override AstVisitAction VisitConfigurationDefinition(ConfigurationDefinitionAst configurationDefinitionAst)
+        {
+            IScriptExtent nameExtent = new ScriptExtent()
+            {
+                Text = configurationDefinitionAst.InstanceName.Extent.Text,
+                StartLineNumber = configurationDefinitionAst.Extent.StartLineNumber,
+                EndLineNumber = configurationDefinitionAst.Extent.EndLineNumber,
+                StartColumnNumber = configurationDefinitionAst.Extent.StartColumnNumber,
+                EndColumnNumber = configurationDefinitionAst.Extent.EndColumnNumber
+            };
+
+            this.findSymbolsVisitor.SymbolReferences.Add(
+                new SymbolReference(
+                    SymbolType.Configuration,
+                    nameExtent));
+
+            return AstVisitAction.Continue;
+        }
+    }
+}
diff --git a/src/PowerShellEditorServices/Language/LanguageService.cs b/src/PowerShellEditorServices/Language/LanguageService.cs
@@ -221,7 +221,7 @@ public FindOccurrencesResult FindSymbolsInFile(ScriptFile scriptFile)
 
             IEnumerable<SymbolReference> symbolReferencesinFile =
                 AstOperations
-                    .FindSymbolsInDocument(scriptFile.ScriptAst)
+                    .FindSymbolsInDocument(scriptFile.ScriptAst, this.powerShellContext.PowerShellVersion)
                     .Select(
                         reference => {
                             reference.SourceLine =
diff --git a/src/PowerShellEditorServices/PowerShellEditorServices.csproj b/src/PowerShellEditorServices/PowerShellEditorServices.csproj
@@ -13,13 +13,16 @@
     <FileAlignment>512</FileAlignment>
     <SolutionDir Condition="$(SolutionDir) == '' Or $(SolutionDir) == '*Undefined*'">..\..\</SolutionDir>
     <RestorePackages>true</RestorePackages>
+    <DefineConstants Condition=" '$(PowerShellVersion)' == 'v3'">PowerShellv3</DefineConstants>
+    <DefineConstants Condition=" '$(PowerShellVersion)' == 'v4'">PowerShellv4</DefineConstants>
+    <DefineConstants Condition=" '$(PowerShellVersion)' == '' Or '$(PowerShellVersion)' == 'v5'">PowerShellv5</DefineConstants>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <DebugSymbols>true</DebugSymbols>
     <DebugType>full</DebugType>
     <Optimize>false</Optimize>
     <OutputPath>bin\Debug\</OutputPath>
-    <DefineConstants>DEBUG;TRACE</DefineConstants>
+    <DefineConstants>TRACE;DEBUG;$(DefineConstants)</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
     <DocumentationFile>bin\Debug\Microsoft.PowerShell.EditorServices.XML</DocumentationFile>
@@ -28,7 +31,7 @@
     <DebugType>pdbonly</DebugType>
     <Optimize>true</Optimize>
     <OutputPath>bin\Release\</OutputPath>
-    <DefineConstants>TRACE</DefineConstants>
+    <DefineConstants>TRACE;$(DefineConstants)</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
     <WarningsAsErrors>1591,1573,1572</WarningsAsErrors>
@@ -49,12 +52,12 @@
     </Reference>
     <Reference Include="System" />
     <Reference Include="System.Core" />
+    <Reference Include="System.Management.Automation" />
     <Reference Include="System.Xml.Linq" />
     <Reference Include="System.Data.DataSetExtensions" />
     <Reference Include="Microsoft.CSharp" />
     <Reference Include="System.Data" />
     <Reference Include="System.Xml" />
-    <Reference Include="System.Management.Automation" />
   </ItemGroup>
   <ItemGroup>
     <Compile Include="Analysis\AnalysisOutputWriter.cs" />
@@ -76,6 +79,7 @@
     <Compile Include="Language\FindReferencesResult.cs" />
     <Compile Include="Language\FindReferencesVisitor.cs" />
     <Compile Include="Language\FindSymbolsVisitor.cs" />
+    <Compile Include="Language\FindSymbolsVisitor2.cs" />
     <Compile Include="Language\FindSymbolVisitor.cs" />
     <Compile Include="Language\GetDefinitionResult.cs" />
     <Compile Include="Language\LanguageService.cs" />
diff --git a/src/PowerShellEditorServices/Session/PowerShellContext.cs b/src/PowerShellEditorServices/Session/PowerShellContext.cs
@@ -15,6 +15,7 @@
 
 namespace Microsoft.PowerShell.EditorServices
 {
+    using System.Collections;
     using System.Management.Automation;
     using System.Management.Automation.Host;
     using System.Management.Automation.Runspaces;
@@ -68,6 +69,14 @@ public PowerShellContextState SessionState
             private set;
         }
 
+        /// <summary>
+        /// PowerShell Version of the current runspace.
+        /// </summary>
+        public Version PowerShellVersion
+        {
+            get; private set;
+        }
+
         #endregion
 
         #region Constructors
@@ -109,7 +118,7 @@ private void Initialize(Runspace initialRunspace)
 
             this.initialRunspace = initialRunspace;
             this.currentRunspace = initialRunspace;
-            this.currentRunspace.Debugger.SetDebugMode(DebugModes.LocalScript | DebugModes.RemoteScript);
+
             this.currentRunspace.Debugger.BreakpointUpdated += OnBreakpointUpdated;
             this.currentRunspace.Debugger.DebuggerStop += OnDebuggerStop;
 
@@ -120,9 +129,38 @@ private void Initialize(Runspace initialRunspace)
             // TODO: Should this be configurable?
             this.SetExecutionPolicy(ExecutionPolicy.RemoteSigned);
 
+            PowerShellVersion = GetPowerShellVersion();
+
+#if !PowerShellv3
+            if (PowerShellVersion > new Version(3,0))
+            {
+                this.currentRunspace.Debugger.SetDebugMode(DebugModes.LocalScript | DebugModes.RemoteScript);
+            }
+#endif
+
             this.SessionState = PowerShellContextState.Ready;
         }
 
+        private Version GetPowerShellVersion()
+        {
+            try
+            {
+                var psVersionTable = this.currentRunspace.SessionStateProxy.GetVariable("PSVersionTable") as Hashtable;
+                if (psVersionTable != null)
+                {
+                    var version = psVersionTable["PSVersion"] as Version;
+                    if (version == null) return new Version(5, 0);
+                    return version;
+                }
+            }
+            catch (Exception ex)
+            {
+                Logger.Write(LogLevel.Warning, "Failed to look up PowerShell version. Defaulting to version 5. " + ex.Message);
+            }
+
+            return new Version(5, 0);
+        }
+
         #endregion
 
         #region Public Methods
@@ -370,7 +408,12 @@ internal void BreakExecution()
         {
             Logger.Write(LogLevel.Verbose, "Debugger break requested...");
 
-            this.currentRunspace.Debugger.SetDebuggerStepMode(true);
+#if PowerShellv5
+            if (PowerShellVersion >= new Version(5, 0))
+            {
+                this.currentRunspace.Debugger.SetDebuggerStepMode(true);
+            }
+#endif
         }
 
         internal void ResumeDebugger(DebuggerResumeAction resumeAction)
@@ -568,7 +611,7 @@ private static string GetStringForPSCommand(PSCommand psCommand)
 
             return stringBuilder.ToString();
         }
-
+        
         private void SetExecutionPolicy(ExecutionPolicy desiredExecutionPolicy)
         {
             var currentPolicy = ExecutionPolicy.Undefined;
diff --git a/test/PowerShellEditorServices.Test/Language/LanguageServiceTests.cs b/test/PowerShellEditorServices.Test/Language/LanguageServiceTests.cs
@@ -10,12 +10,15 @@
 using Microsoft.PowerShell.EditorServices.Test.Shared.References;
 using Microsoft.PowerShell.EditorServices.Test.Shared.SymbolDetails;
 using Microsoft.PowerShell.EditorServices.Test.Shared.Symbols;
+using Microsoft.Win32;
 using System;
+using System.Diagnostics;
 using System.IO;
 using System.Linq;
 using System.Management.Automation.Runspaces;
 using System.Threading;
 using System.Threading.Tasks;
+using System.Xml.Linq;
 using Xunit;
 
 namespace Microsoft.PowerShell.EditorServices.Test.Language
@@ -25,6 +28,7 @@ public class LanguageServiceTests : IDisposable
         private Workspace workspace;
         private LanguageService languageService;
         private PowerShellContext powerShellContext;
+       
 
         public LanguageServiceTests()
         {
@@ -262,6 +266,7 @@ public void LanguageServiceFindsSymbolsInFile()
             Assert.Equal(4, symbolsResult.FoundOccurrences.Where(r => r.SymbolType == SymbolType.Function).Count());
             Assert.Equal(3, symbolsResult.FoundOccurrences.Where(r => r.SymbolType == SymbolType.Variable).Count());
             Assert.Equal(1, symbolsResult.FoundOccurrences.Where(r => r.SymbolType == SymbolType.Workflow).Count());
+            Assert.Equal(1, symbolsResult.FoundOccurrences.Where(r => r.SymbolType == SymbolType.Configuration).Count());
 
             SymbolReference firstFunctionSymbol = symbolsResult.FoundOccurrences.Where(r => r.SymbolType == SymbolType.Function).First();
             Assert.Equal("AFunction", firstFunctionSymbol.SymbolName);
@@ -277,6 +282,11 @@ public void LanguageServiceFindsSymbolsInFile()
             Assert.Equal("AWorkflow", firstWorkflowSymbol.SymbolName);
             Assert.Equal(23, firstWorkflowSymbol.ScriptRegion.StartLineNumber);
             Assert.Equal(1, firstWorkflowSymbol.ScriptRegion.StartColumnNumber);
+
+            SymbolReference firstConfigurationSymbol = symbolsResult.FoundOccurrences.Where(r => r.SymbolType == SymbolType.Configuration).First();
+            Assert.Equal("AConfiguration", firstConfigurationSymbol.SymbolName);
+            Assert.Equal(25, firstConfigurationSymbol.ScriptRegion.StartLineNumber);
+            Assert.Equal(1, firstConfigurationSymbol.ScriptRegion.StartColumnNumber);
         }
 
         [Fact]
@@ -289,6 +299,7 @@ public void LanguageServiceFindsSymbolsInNoSymbolsFile()
             Assert.Equal(0, symbolsResult.FoundOccurrences.Count());
         }
 
+
         private ScriptFile GetScriptFile(ScriptRegion scriptRegion)
         {
             const string baseSharedScriptPath = 
diff --git a/test/PowerShellEditorServices.Test/Language/PowerShellVersionTests.cs b/test/PowerShellEditorServices.Test/Language/PowerShellVersionTests.cs
diff --git a/test/PowerShellEditorServices.Test/PowerShellEditorServices.Test.csproj b/test/PowerShellEditorServices.Test/PowerShellEditorServices.Test.csproj
diff --git a/test/PowerShellEditorServices.Test/packages.config b/test/PowerShellEditorServices.Test/packages.config

Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,8 @@ public void Stop()`
`79`	`79`	`{`
`80`	`80`	`// By disposing the thread we cancel all existing work`
`81`	`81`	`// and cause the thread to be destroyed.`
`82`		`- this.messageLoopThread.Dispose();`
	`82`	`+ if (this.messageLoopThread != null)`
	`83`	`+ this.messageLoopThread.Dispose();`
`83`	`84`	`}`
`84`	`85`
`85`	`86`	`public void SetRequestHandler<TParams, TResult>(`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,8 @@ public void Stop()`
`70`	`70`	`this.OnStop();`
`71`	`71`
`72`	`72`	`this.serverChannel.Stop();`
`73`		`- this.serverExitedTask.SetResult(true);`
	`73`	`+ if (this.serverExitedTask != null)`
	`74`	`+ this.serverExitedTask.SetResult(true);`
`74`	`75`	`}`
`75`	`76`	`}`
`76`	`77`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ namespace Microsoft.PowerShell.EditorServices`
`10`	`10`	`/// <summary>`
`11`	`11`	`/// The visitor used to find the the symbol at a specfic location in the AST`
`12`	`12`	`/// </summary>`
`13`		`- internal class FindSymbolVisitor : AstVisitor2`
	`13`	`+ internal class FindSymbolVisitor : AstVisitor`
`14`	`14`	`{`
`15`	`15`	`private int lineNumber;`
`16`	`16`	`private int columnNumber;`