Eliminate API leakage of some PowerShell types

This change introduces new types that wrap/replace the types
from System.Management.Automation which should not be exposed
outside of the core Editor Services library.  The reasoning is
that a consumer of our higher-level service types through an
EditorSession should not have to take a dependency on the
System.Management.Automation assembly (since this may become
more complicated in the future).  This also gives us a chance to
reshape the information that we return from API calls so that we
can provide extra value in some places and remove unneeded
information in others.

Going forward we will carefully monitor any new function
signatures to ensure that core PowerShell types aren't being
exposed through the abstraction unnecessarily.

Author: daviwil

src/PowerShellEditorServices.Transport.Stdio/Event/DiagnosticEvent.cs

@@ -63,13 +63,13 @@ public static DiagnosticEventBody Create(
                         Text = diagnosticMarker.Message,
                         Start = new Location
                         {
-                            Line = diagnosticMarker.Extent.StartLineNumber,
-                            Offset = diagnosticMarker.Extent.StartColumnNumber
+                            Line = diagnosticMarker.ScriptRegion.StartLineNumber,
+                            Offset = diagnosticMarker.ScriptRegion.StartColumnNumber
                         },
                         End = new Location
                         {
-                            Line = diagnosticMarker.Extent.EndLineNumber,
-                            Offset = diagnosticMarker.Extent.EndColumnNumber
+                            Line = diagnosticMarker.ScriptRegion.EndLineNumber,
+                            Offset = diagnosticMarker.ScriptRegion.EndColumnNumber
                         }
                     });
             }

src/PowerShellEditorServices.Transport.Stdio/Event/ReplPromptChoiceEvent.cs

@@ -3,8 +3,8 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 //
 
+using Microsoft.PowerShell.EditorServices.Console;
 using Microsoft.PowerShell.EditorServices.Transport.Stdio.Message;
-using System.Management.Automation.Host;
 
 namespace Microsoft.PowerShell.EditorServices.Transport.Stdio.Event
 {
@@ -33,12 +33,12 @@ public class ReplPromptChoiceDetails
         public string Label { get; set; }
 
         public static ReplPromptChoiceDetails FromChoiceDescription(
-            ChoiceDescription choiceDescription)
+            ChoiceDetails choiceDetails)
         {
             return new ReplPromptChoiceDetails
             {
-                Label = choiceDescription.Label,
-                HelpMessage = choiceDescription.HelpMessage
+                Label = choiceDetails.Label,
+                HelpMessage = choiceDetails.HelpMessage
             };
         }
     }

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

@@ -57,7 +57,6 @@
     <Reference Include="Microsoft.CSharp" />
     <Reference Include="System.Data" />
     <Reference Include="System.Xml" />
-    <Reference Include="System.Management.Automation" />
   </ItemGroup>
   <ItemGroup>
     <Compile Include="Constants.cs" />

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

@@ -3,10 +3,10 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 //
 
+using Microsoft.PowerShell.EditorServices.Language;
 using Microsoft.PowerShell.EditorServices.Session;
 using Microsoft.PowerShell.EditorServices.Transport.Stdio.Message;
 using Microsoft.PowerShell.EditorServices.Transport.Stdio.Response;
-using System.Management.Automation;
 
 namespace Microsoft.PowerShell.EditorServices.Transport.Stdio.Request
 {
@@ -19,7 +19,7 @@ public override void ProcessMessage(
         {
             ScriptFile scriptFile = this.GetScriptFile(editorSession);
 
-            CommandCompletion completions =
+            CompletionResults completions =
                 editorSession.LanguageService.GetCompletionsInFile(
                     scriptFile,
                     this.Arguments.Line,

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

@@ -3,26 +3,26 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 //
 
+using Microsoft.PowerShell.EditorServices.Language;
 using Microsoft.PowerShell.EditorServices.Transport.Stdio.Message;
 using System.Collections.Generic;
-using System.Management.Automation;
 
 namespace Microsoft.PowerShell.EditorServices.Transport.Stdio.Response
 {
     [MessageTypeName("completions")]
     public class CompletionsResponse : ResponseBase<CompletionEntry[]>
     {
-        public static CompletionsResponse Create(CommandCompletion commandCompletion)
+        public static CompletionsResponse Create(CompletionResults completionResults)
         {
             List<CompletionEntry> completionResult = new List<CompletionEntry>();
 
-            foreach (var completion in commandCompletion.CompletionMatches)
+            foreach (var completion in completionResults.Completions)
             {
                 completionResult.Add(
                     new CompletionEntry
                     {
                         Name = completion.CompletionText,
-                        Kind = GetCompletionKind(completion.ResultType),
+                        Kind = GetCompletionKind(completion.CompletionType),
                     });
             }
 
@@ -32,12 +32,12 @@ public static CompletionsResponse Create(CommandCompletion commandCompletion)
             };
         }
 
-        private static string GetCompletionKind(CompletionResultType resultType)
+        private static string GetCompletionKind(CompletionType completionType)
         {
-            switch (resultType)
+            switch (completionType)
             {
-                case CompletionResultType.Command:
-                case CompletionResultType.Method:
+                case CompletionType.Command:
+                case CompletionType.Method:
                     return "method";
                 default:
                     // TODO: Better default

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

@@ -3,9 +3,9 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 //
 
+using Microsoft.PowerShell.EditorServices.Language;
 using Microsoft.PowerShell.EditorServices.Transport.Stdio.Message;
 using Newtonsoft.Json;
-using System.Management.Automation;
 using System.Text.RegularExpressions;
 
 namespace Microsoft.PowerShell.EditorServices.Transport.Stdio.Response
@@ -48,35 +48,34 @@ public class CompletionEntry
 
     public class CompletionEntryDetails
     {
-        public CompletionEntryDetails(CompletionResult completionResult, string entryName)
+        public CompletionEntryDetails(CompletionDetails completionDetails, string entryName)
         {
-
             Kind = null;
             KindModifiers = null;
             DisplayParts = null;
             Documentation = null;
             DocString = null;
 
             // if the  result type is a command return null 
-            if (!(completionResult.ResultType.Equals(CompletionResultType.Command)))
+            if (!(completionDetails.CompletionType.Equals(CompletionType.Command)))
             {
                 //find matches on square brackets in the the tool tip
-                var matches = Regex.Matches(completionResult.ToolTip, @"^\[(.+)\]");
+                var matches = Regex.Matches(completionDetails.ToolTipText, @"^\[(.+)\]");
                 string strippedEntryName = Regex.Replace(entryName, @"^[$_-]","").Replace("{","").Replace("}","");
 
                 if (matches.Count > 0 && matches[0].Groups.Count > 1)
                 {                        
                     Name = matches[0].Groups[1].Value;
                 }
                 // if there are nobracets and the only content is the completion name
-                else if (completionResult.ToolTip.Equals(strippedEntryName))
+                else if (completionDetails.ToolTipText.Equals(strippedEntryName))
                 {
                     Name = null;
                 }
                 else
                 {
                     Name = null;
-                    DocString = completionResult.ToolTip;
+                    DocString = completionDetails.ToolTipText;
                 }
             }
 

src/PowerShellEditorServices.Transport.Stdio/StdioConsoleHost.cs

@@ -10,7 +10,6 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using System.Management.Automation.Host;
 using System.Text;
 using System.Threading.Tasks;
 
@@ -63,7 +62,7 @@ void IConsoleHost.WriteOutput(
         Task<int> IConsoleHost.PromptForChoice(
             string caption, 
             string message, 
-            IEnumerable<ChoiceDescription> choices, 
+            IEnumerable<ChoiceDetails> choices,
             int defaultChoice)
         {
             // Create and store a TaskCompletionSource that will be
@@ -103,7 +102,7 @@ void IConsoleHost.PromptForChoiceResult(
 
         void IConsoleHost.UpdateProgress(
             long sourceId, 
-            System.Management.Automation.ProgressRecord progressRecord)
+            ProgressDetails progressDetails)
         {
             // TODO: Implement message for this
         }

src/PowerShellEditorServices/Console/ChoiceDetails.cs

@@ -0,0 +1,52 @@
+//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+//
+
+using System.Management.Automation.Host;
+
+namespace Microsoft.PowerShell.EditorServices.Console
+{
+    /// <summary>
+    /// Contains the details about a choice that should be displayed
+    /// to the user.  This class is meant to be serializable to the 
+    /// user's UI.
+    /// </summary>
+    public class ChoiceDetails
+    {
+        #region Properties
+
+        /// <summary>
+        /// Gets or sets the label for the choice.
+        /// </summary>
+        public string Label { get; set; }
+
+        /// <summary>
+        /// Gets or sets the help string that describes the choice.
+        /// </summary>
+        public string HelpMessage { get; set; }
+
+        #endregion
+
+        #region Constructors
+
+        /// <summary>
+        /// Creates a new instance of the ChoicePromptDetails class
+        /// based on a ChoiceDescription from the PowerShell layer.
+        /// </summary>
+        /// <param name="choiceDescription">
+        /// A ChoiceDescription on which this instance will be based.
+        /// </param>
+        /// <returns>A new ChoicePromptDetails instance.</returns>
+        public static ChoiceDetails Create(ChoiceDescription choiceDescription)
+        {
+            return new ChoiceDetails
+            {
+                Label = choiceDescription.Label,
+                HelpMessage = choiceDescription.HelpMessage
+            };
+        }
+
+        #endregion
+    }
+}

src/PowerShellEditorServices/Console/ConsoleServicePSHostUserInterface.cs

@@ -8,6 +8,7 @@
 using System.Collections.ObjectModel;
 using System.Management.Automation;
 using System.Management.Automation.Host;
+using System.Linq;
 using System.Security;
 using System.Threading.Tasks;
 
@@ -65,7 +66,7 @@ public override int PromptForChoice(
                     .PromptForChoice(
                         promptCaption,
                         promptMessage,
-                        choiceDescriptions,
+                        choiceDescriptions.Select(ChoiceDetails.Create),
                         defaultChoice);
 
             // This will synchronously block on the async PromptForChoice
@@ -193,7 +194,7 @@ public override void WriteProgress(
         {
             this.consoleHost.UpdateProgress(
                 sourceId,
-                record);
+                ProgressDetails.Create(record));
         }
 
         #endregion

src/PowerShellEditorServices/Console/IConsoleHost.cs

@@ -53,7 +53,7 @@ void WriteOutput(
         /// <param name="promptMessage">
         /// The descriptive message which will be displayed to the user.
         /// </param>
-        /// <param name="choiceDescriptions">
+        /// <param name="choices">
         /// The list of choices from which the user will select.
         /// </param>
         /// <param name="defaultChoice">
@@ -66,7 +66,7 @@ void WriteOutput(
         Task<int> PromptForChoice(
             string promptCaption,
             string promptMessage,
-            IEnumerable<ChoiceDescription> choiceDescriptions,
+            IEnumerable<ChoiceDetails> choices,
             int defaultChoice);
 
         // TODO: Get rid of this method!  Leaky abstraction.
@@ -88,10 +88,10 @@ void PromptForChoiceResult(
         /// Sends a progress update event to the user.
         /// </summary>
         /// <param name="sourceId">The source ID of the progress event.</param>
-        /// <param name="progressRecord">The </param>
+        /// <param name="progressDetails">The details of the activity's current progress.</param>
         void UpdateProgress(
             long sourceId, 
-            ProgressRecord progressRecord);
+            ProgressDetails progressDetails);
 
         /// <summary>
         /// Notifies the IConsoleHost implementation that the PowerShell