Improve debugger variable support

This changes improves debugger variable support by allowing the
enumeration of the children of "expandable" variables (objects and
collections) and the requesting of variable scopes.  The variable scope
feature will be completed in a future commit.

Author: daviwil

src/PowerShellEditorServices.Host/MessageLoop.cs

@@ -182,22 +182,22 @@ void PowerShellSession_BreakpointUpdated(object sender, BreakpointUpdatedEventAr
         {
         }
 
-        async void PowerShellSession_OutputWritten(object sender, OutputWrittenEventArgs e)
+        void PowerShellSession_OutputWritten(object sender, OutputWrittenEventArgs e)
         {
             // TODO: change this to use the OutputEvent!
 
-            await this.messageWriter.WriteMessage(
-                new ReplWriteOutputEvent
-                {
-                    Body = new ReplWriteOutputEventBody
-                    {
-                        LineContents = e.OutputText,
-                        LineType = e.OutputType,
-                        IncludeNewLine = e.IncludeNewLine,
-                        ForegroundColor = e.ForegroundColor,
-                        BackgroundColor = e.BackgroundColor
-                    }
-                });
+            //await this.messageWriter.WriteMessage(
+            //    new ReplWriteOutputEvent
+            //    {
+            //        Body = new ReplWriteOutputEventBody
+            //        {
+            //            LineContents = e.OutputText,
+            //            LineType = e.OutputType,
+            //            IncludeNewLine = e.IncludeNewLine,
+            //            ForegroundColor = e.ForegroundColor,
+            //            BackgroundColor = e.BackgroundColor
+            //        }
+            //    });
         }
 
         #endregion

src/PowerShellEditorServices.Host/Program.cs

@@ -27,8 +27,6 @@ static void Main(string[] args)
                             "/waitForDebugger",
                             StringComparison.InvariantCultureIgnoreCase));
 
-            waitForDebugger = true;
-
             // Should we wait for the debugger before starting?
             if (waitForDebugger)
             {

src/PowerShellEditorServices.Transport.Stdio/Model/Scope.cs

@@ -1,4 +1,5 @@
-using System;
+using Microsoft.PowerShell.EditorServices.Console;
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
@@ -19,5 +20,14 @@ public class Scope
 //        /** If true, the number of variables in this scope is large or expensive to retrieve. */
 //        expensive: boolean;
         public bool Expensive { get; set; }
+
+        public static Scope Create(VariableScope scope)
+        {
+            return new Scope
+            {
+                Name = scope.Name,
+                VariablesReference = scope.Id
+            };
+        }
     }
 }

src/PowerShellEditorServices.Transport.Stdio/Model/StackFrame.cs

@@ -1,5 +1,6 @@
 
 using Microsoft.PowerShell.EditorServices.Console;
+
 namespace Microsoft.PowerShell.EditorServices.Transport.Stdio.Model
 {
     public class StackFrame
@@ -14,8 +15,6 @@ public class StackFrame
 
         public int Column { get; set; }
 
-        public Scope[] Scopes { get; set; }
-
         //        /** An identifier for the stack frame. */
         //id: number;
         ///** The name of the stack frame, typically a method name */
@@ -30,25 +29,18 @@ public class StackFrame
         //scopes: Scope[];
 
         public static StackFrame Create(
-            StackFrameDetails stackFrame)
+            StackFrameDetails stackFrame,
+            int id)
         {
             return new StackFrame
             {
-                Id = stackFrame.FunctionName.GetHashCode(),
+                Id = id,
                 Name = stackFrame.FunctionName,
                 Line = stackFrame.LineNumber,
                 Column = stackFrame.ColumnNumber,
                 Source = new Source
                 {
                     Path = stackFrame.ScriptPath
-                },
-                Scopes = new Scope[]
-                {
-                    new Scope
-                    {
-                        Name = "locals",
-                        VariablesReference = 1 // TODO: Use a contextual number
-                    }
                 }
             };
         }

src/PowerShellEditorServices.Transport.Stdio/Model/Variable.cs

@@ -19,7 +19,7 @@ public static Variable Create(VariableDetails variable)
                 Name = variable.Name,
                 Value = variable.ValueString ?? string.Empty,
                 VariablesReference = 
-                    variable.HasChildren ?
+                    variable.IsExpandable ?
                         variable.Id : 0
             };
         }

src/PowerShellEditorServices.Transport.Stdio/PowerShellEditorServices.Transport.Stdio.csproj

@@ -107,6 +107,7 @@
     <Compile Include="Request\ReferencesRequest.cs" />
     <Compile Include="Request\ReplExecuteRequest.cs" />
     <Compile Include="Request\RequestBase.cs" />
+    <Compile Include="Request\ScopesRequest.cs" />
     <Compile Include="Request\SetBreakpointsRequest.cs" />
     <Compile Include="Request\SetExceptionBreakpointsRequest.cs" />
     <Compile Include="Request\SourceRequest.cs" />
@@ -129,6 +130,7 @@
     <Compile Include="Response\OccurrencesResponse.cs" />
     <Compile Include="Response\QuickInfoResponse.cs" />
     <Compile Include="Response\ReferencesResponse.cs" />
+    <Compile Include="Response\ScopesResponse.cs" />
     <Compile Include="Response\SetBreakpointsResponse.cs" />
     <Compile Include="Response\SetExceptionBreakpointsResponse.cs" />
     <Compile Include="Response\SignatureHelpResponse.cs" />

src/PowerShellEditorServices.Transport.Stdio/Request/DisconnectRequest.cs

@@ -1,6 +1,9 @@
-using Microsoft.PowerShell.EditorServices.Session;
+using Microsoft.PowerShell.EditorServices.Console;
+using Microsoft.PowerShell.EditorServices.Session;
 using Microsoft.PowerShell.EditorServices.Transport.Stdio.Message;
+using Microsoft.PowerShell.EditorServices.Transport.Stdio.Response;
 using Nito.AsyncEx;
+using System;
 using System.Threading.Tasks;
 
 namespace Microsoft.PowerShell.EditorServices.Transport.Stdio.Request
@@ -12,7 +15,23 @@ public override Task ProcessMessage(
             EditorSession editorSession, 
             MessageWriter messageWriter)
         {
-            // TODO: Do something with this!
+            EventHandler<SessionStateChangedEventArgs> handler = null;
+
+            handler =
+                async (o, e) =>
+                    {
+                        if (e.NewSessionState == Console.PowerShellSessionState.Ready)
+                        {
+                            await messageWriter.WriteMessage(new DisconnectResponse {});
+                            editorSession.PowerShellSession.SessionStateChanged -= handler;
+
+                            // TODO: Find a way to exit more gracefully!
+                            Environment.Exit(0);
+                        }
+                    };
+
+            editorSession.PowerShellSession.SessionStateChanged += handler;
+            editorSession.PowerShellSession.AbortExecution();
 
             return TaskConstants.Completed;
         }

src/PowerShellEditorServices.Transport.Stdio/Request/EvaluateRequest.cs

@@ -14,43 +14,30 @@ public override async Task ProcessMessage(
             EditorSession editorSession, 
             MessageWriter messageWriter)
         {
-            // TODO TODO TODO FIX THIS
-
-            //VariableDetails foundHeaders =
-            //    editorSession.ConsoleService.EvaluateExpression(
-            //        this.Arguments.Expression,
-            //        this.Arguments.FrameId);
-
-            //string valueString = null;
-            //int variableId = 0;
-
-            //if (foundHeaders != null)
-            //{
-            //    valueString = foundHeaders.ValueString;
-            //    variableId =
-            //        foundHeaders.HasChildren ?
-            //            foundHeaders.Id : 0;
-            //}
-
-            //messageWriter.WriteMessage(
-            //    this.PrepareResponse(
-            //        new EvaluateResponse
-            //        {
-            //            Body = new EvaluateResponseBody
-            //            {
-            //                Result = valueString,
-            //                VariablesReference = variableId
-            //            }
-            //        }));
+            VariableDetails result =
+                editorSession.DebugService.EvaluateExpression(
+                    this.Arguments.Expression,
+                    this.Arguments.FrameId);
+
+            string valueString = null;
+            int variableId = 0;
+
+            if (result != null)
+            {
+                valueString = result.ValueString;
+                variableId =
+                    result.IsExpandable ?
+                        result.Id : 0;
+            }
 
             await messageWriter.WriteMessage(
                 this.PrepareResponse(
                     new EvaluateResponse
                     {
                         Body = new EvaluateResponseBody
                         {
-                            Result = "",
-                            VariablesReference = 0
+                            Result = valueString,
+                            VariablesReference = variableId
                         }
                     }));
         }

src/PowerShellEditorServices.Transport.Stdio/Request/ScopesRequest.cs

@@ -0,0 +1,41 @@
+using Microsoft.PowerShell.EditorServices.Console;
+using Microsoft.PowerShell.EditorServices.Session;
+using Microsoft.PowerShell.EditorServices.Transport.Stdio.Message;
+using Microsoft.PowerShell.EditorServices.Transport.Stdio.Model;
+using Microsoft.PowerShell.EditorServices.Transport.Stdio.Response;
+using System.Linq;
+using System.Threading.Tasks;
+
+namespace Microsoft.PowerShell.EditorServices.Transport.Stdio.Request
+{
+    [MessageTypeName("scopes")]
+    public class ScopesRequest : RequestBase<ScopesRequestArgs>
+    {
+        public override async Task ProcessMessage(
+            EditorSession editorSession, 
+            MessageWriter messageWriter)
+        {
+            VariableScope[] variableScopes = 
+                editorSession.DebugService.GetVariableScopes(
+                    this.Arguments.FrameId);
+
+            await messageWriter.WriteMessage(
+                this.PrepareResponse(
+                    new ScopesResponse
+                    {
+                        Body = new ScopesResponseBody
+                        {
+                            Scopes = 
+                                variableScopes
+                                    .Select(Scope.Create)
+                                    .ToArray()
+                        }
+                    }));
+        }
+    }
+
+    public class ScopesRequestArgs
+    {
+        public int FrameId { get; set; }
+    }
+}

src/PowerShellEditorServices.Transport.Stdio/Response/ScopesResponse.cs

@@ -0,0 +1,15 @@
+using Microsoft.PowerShell.EditorServices.Transport.Stdio.Message;
+using Microsoft.PowerShell.EditorServices.Transport.Stdio.Model;
+
+namespace Microsoft.PowerShell.EditorServices.Transport.Stdio.Response
+{
+    [MessageTypeName("scopes")]
+    public class ScopesResponse : ResponseBase<ScopesResponseBody>
+    {
+    }
+
+    public class ScopesResponseBody
+    {
+        public Scope[] Scopes { get; set; }
+    }
+}