Merge pull request #105 from PowerShell/daviwil/repl-improvements

Improvements to REPL execution

Author: daviwil

src/PowerShellEditorServices.Channel.WebSocket/Properties/AssemblyInfo.cs

@@ -1,4 +1,9 @@
-using System.Reflection;
+//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+//
+
+using System.Reflection;
 using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
 
@@ -10,7 +15,7 @@
 [assembly: AssemblyConfiguration("")]
 [assembly: AssemblyCompany("")]
 [assembly: AssemblyProduct("PowerShellEditorServices.Channel.WebSocket")]
-[assembly: AssemblyCopyright("Copyright ©  2015")]
+[assembly: AssemblyCopyright("Copyright ©  2015")]
 [assembly: AssemblyTrademark("")]
 [assembly: AssemblyCulture("")]
 
@@ -34,3 +39,4 @@
 // [assembly: AssemblyVersion("1.0.*")]
 [assembly: AssemblyVersion("1.0.0.0")]
 [assembly: AssemblyFileVersion("1.0.0.0")]
+

src/PowerShellEditorServices.Channel.WebSocket/WebsocketClientChannel.cs

@@ -1,4 +1,9 @@
-using System;
+//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+//
+
+using System;
 using System.IO;
 using System.Linq;
 using System.Net.WebSockets;
@@ -150,3 +155,4 @@ public override async Task FlushAsync(CancellationToken cancellationToken)
         }
     }
 }
+

src/PowerShellEditorServices.Channel.WebSocket/WebsocketServerChannel.cs

@@ -1,4 +1,9 @@
-using System;
+//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+//
+
+using System;
 using System.IO;
 using System.Linq;
 using System.Net.WebSockets;
@@ -170,3 +175,4 @@ public async Task DispatchMessage()
         }
     }
 }
+

src/PowerShellEditorServices.Host/Program.cs

@@ -94,7 +94,15 @@ static void Main(string[] args)
             }
 #endif
 
-            Logger.Write(LogLevel.Normal, "PowerShell Editor Services Host starting...");
+            FileVersionInfo fileVersionInfo =
+                FileVersionInfo.GetVersionInfo(
+                    System.Reflection.Assembly.GetExecutingAssembly().Location);
+
+            Logger.Write(
+                LogLevel.Normal,
+                string.Format(
+                    "PowerShell Editor Services Host v{0} starting...",
+                    fileVersionInfo.FileVersion));
 
             // Start the server
             server.Start();

src/PowerShellEditorServices.Protocol/DebugAdapter/EvaluateRequest.cs

@@ -16,17 +16,37 @@ public static readonly
 
     public class EvaluateRequestArguments
     {
+        /// <summary>
+        /// The expression to evaluate.
+        /// </summary>
         public string Expression { get; set; }
 
-    //        /** Evaluate the expression in the context of this stack frame. If not specified, the top most frame is used. */
+        /// <summary>
+        /// The context in which the evaluate request is run. Possible
+        /// values are 'watch' if evaluate is run in a watch or 'repl'
+        /// if run from the REPL console.
+        /// </summary>
+        public string Context { get; set; }
+
+        /// <summary>
+        /// Evaluate the expression in the context of this stack frame.
+        /// If not specified, the top most frame is used.
+        /// </summary>
         public int FrameId { get; set; }
     }
 
     public class EvaluateResponseBody
     {
+        /// <summary>
+        /// The evaluation result.
+        /// </summary>
         public string Result { get; set; }
 
-//            /** If variablesReference is > 0, the evaluate result is structured and its children can be retrieved by passing variablesReference to the VariablesRequest */
+        /// <summary>
+        /// If variablesReference is > 0, the evaluate result is
+        /// structured and its children can be retrieved by passing
+        /// variablesReference to the VariablesRequest
+        /// </summary>
         public int VariablesReference { get; set; }
     }
 }

src/PowerShellEditorServices.Protocol/Server/DebugAdapter.cs

@@ -312,10 +312,17 @@ protected async Task HandleEvaluateRequest(
             EvaluateRequestArguments evaluateParams,
             RequestContext<EvaluateResponseBody> requestContext)
         {
+            bool isFromRepl =
+                string.Equals(
+                    evaluateParams.Context,
+                    "repl",
+                    StringComparison.InvariantCultureIgnoreCase);
+
             VariableDetails result =
                 await editorSession.DebugService.EvaluateExpression(
                     evaluateParams.Expression,
-                    evaluateParams.FrameId);
+                    evaluateParams.FrameId,
+                    isFromRepl);
 
             string valueString = null;
             int variableId = 0;

src/PowerShellEditorServices.Protocol/Server/LanguageServer.cs

@@ -676,27 +676,19 @@ protected async Task HandleEvaluateRequest(
             DebugAdapterMessages.EvaluateRequestArguments evaluateParams,
             RequestContext<DebugAdapterMessages.EvaluateResponseBody> requestContext)
         {
-            VariableDetails result =
-                await editorSession.DebugService.EvaluateExpression(
+            var results = 
+                await this.editorSession.PowerShellContext.ExecuteScriptString(
                     evaluateParams.Expression,
-                    evaluateParams.FrameId);
-
-            string valueString = null;
-            int variableId = 0;
-
-            if (result != null)
-            {
-                valueString = result.ValueString;
-                variableId =
-                    result.IsExpandable ?
-                        result.Id : 0;
-            }
+                    true,
+                    true);
 
+            // Return an empty result since the result value is irrelevant
+            // for this request in the LanguageServer
             await requestContext.SendResult(
                 new DebugAdapterMessages.EvaluateResponseBody
                 {
-                    Result = valueString,
-                    VariablesReference = variableId
+                    Result = "",
+                    VariablesReference = 0
                 });
         }
 

src/PowerShellEditorServices/Debugging/DebugService.cs

@@ -233,20 +233,38 @@ public VariableDetailsBase GetVariableFromExpression(string variableExpression,
         /// </summary>
         /// <param name="expressionString">The expression string to execute.</param>
         /// <param name="stackFrameId">The ID of the stack frame in which the expression should be executed.</param>
+        /// <param name="writeResultAsOutput">
+        /// If true, writes the expression result as host output rather than returning the results.
+        /// In this case, the return value of this function will be null.</param>
         /// <returns>A VariableDetails object containing the result.</returns>
-        public async Task<VariableDetails> EvaluateExpression(string expressionString, int stackFrameId)
+        public async Task<VariableDetails> EvaluateExpression(
+            string expressionString,
+            int stackFrameId,
+            bool writeResultAsOutput)
         {
             var results = 
                 await this.powerShellContext.ExecuteScriptString(
-                    expressionString);
+                    expressionString,
+                    false,
+                    writeResultAsOutput);
 
             // Since this method should only be getting invoked in the debugger,
             // we can assume that Out-String will be getting used to format results
-            // of command executions into string output.
-
-            return new VariableDetails(
-                expressionString, 
-                string.Join(Environment.NewLine, results));
+            // of command executions into string output.  However, if null is returned
+            // then return null so that no output gets displayed.
+            string outputString =
+                results != null ?
+                    string.Join(Environment.NewLine, results) :
+                    null;
+
+            // If we've written the result as output, don't return a
+            // VariableDetails instance.
+            return
+                writeResultAsOutput ?
+                    null :
+                    new VariableDetails(
+                        expressionString,
+                        outputString);
         }
 
         /// <summary>

src/PowerShellEditorServices/Language/AstOperations.cs

@@ -180,18 +180,24 @@ static public SymbolReference FindDefinitionOfSymbol(
         /// <returns>A collection of SymbolReference objects</returns>
         static public IEnumerable<SymbolReference> FindSymbolsInDocument(Ast scriptAst, Version powerShellVersion)
         {
+            IEnumerable<SymbolReference> symbolReferences = null;
+
             if (powerShellVersion >= new Version(5,0))
             {
+#if PowerShellv5
                 FindSymbolsVisitor2 findSymbolsVisitor = new FindSymbolsVisitor2();
                 scriptAst.Visit(findSymbolsVisitor);
-                return findSymbolsVisitor.SymbolReferences;
+                symbolReferences = findSymbolsVisitor.SymbolReferences;
+#endif
             }
             else
             {
                 FindSymbolsVisitor findSymbolsVisitor = new FindSymbolsVisitor();
                 scriptAst.Visit(findSymbolsVisitor);
-                return findSymbolsVisitor.SymbolReferences;
+                symbolReferences = findSymbolsVisitor.SymbolReferences;
             }
+
+            return symbolReferences;
         }
 
         /// <summary>

src/PowerShellEditorServices/Language/FindSymbolsVisitor2.cs

@@ -1,8 +1,14 @@
-using System.Collections.Generic;
+//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+//
+
+using System.Collections.Generic;
 using System.Management.Automation.Language;
 
 namespace Microsoft.PowerShell.EditorServices
 {
+#if PowerShellv5
     /// <summary>
     /// The visitor used to find all the symbols (function and class defs) in the AST. 
     /// </summary>
@@ -67,4 +73,6 @@ public override AstVisitAction VisitConfigurationDefinition(ConfigurationDefinit
             return AstVisitAction.Continue;
         }
     }
+#endif
 }
+