Merge pull request #251 from PowerShell/master

Merge changes to match PSReadline that ships in Win10

Author: lzybkr

CheckHelp.ps1

@@ -2,7 +2,7 @@ Import-Module -Name PSReadline
 
 $about_topic = Get-Help -Name about_PSReadline
 
-$methods = [PSConsoleUtilities.PSConsoleReadLine].GetMethods('public,static') |
+$methods = [Microsoft.PowerShell.PSConsoleReadLine].GetMethods('public,static') |
     Where-Object {
         $method = $_
         $parameters = $method.GetParameters()
@@ -59,4 +59,4 @@ Get-PSReadlineKeyHandler |
     Where-Object { $_.Function -eq $_.Description } |
     ForEach-Object {
         "Function missing description: $($_.Function)"
-    }
+    }

MakeRelease.ps1

@@ -25,7 +25,7 @@ $files = @('PSReadline\Changes.txt',
            'PSReadline\PSReadline.psd1',
            'PSReadline\PSReadline.psm1',
            'PSReadline\PSReadline.format.ps1xml',
-           'PSReadline\bin\Release\PSReadline.dll')
+           'PSReadline\bin\Release\Microsoft.PowerShell.PSReadline.dll')
 
 foreach ($file in $files)
 {
@@ -40,7 +40,7 @@ foreach ($file in $files)
     copy $PSScriptRoot\$file $targetDir\en-us
 }
 
-$version = (Get-ChildItem -Path $targetDir\PSReadline.dll).VersionInfo.FileVersion
+$version = (Get-ChildItem -Path $targetDir\Microsoft.PowerShell.PSReadline.dll).VersionInfo.FileVersion
 
 & $PSScriptRoot\Update-ModuleManifest.ps1 $targetDir\PSReadline.psd1 $version
 

PSReadLine/AssemblyInfo.cs

@@ -1,4 +1,8 @@
-using System.Reflection;
+/********************************************************************++
+Copyright (c) Microsoft Corporation.  All rights reserved.
+--********************************************************************/
+
+using System.Reflection;
 using System.Runtime.InteropServices;
 
 // General Information about an assembly is controlled through the following 

PSReadLine/BasicEditing.cs

@@ -1,15 +1,23 @@
-using System;
+/********************************************************************++
+Copyright (c) Microsoft Corporation.  All rights reserved.
+--********************************************************************/
+
+using System;
+using System.Diagnostics.CodeAnalysis;
+using System.Globalization;
 using System.Linq;
 using System.Management.Automation;
 using System.Management.Automation.Language;
+using System.Management.Automation.Runspaces;
 
-namespace PSConsoleUtilities
+namespace Microsoft.PowerShell
 {
     public partial class PSConsoleReadLine
     {
         /// <summary>
         /// Insert the key
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void SelfInsert(ConsoleKeyInfo? key = null, object arg = null)
         {
             if (!key.HasValue)
@@ -55,6 +63,7 @@ public static void SelfInsert(ConsoleKeyInfo? key = null, object arg = null)
         /// <summary>
         /// Reverts all of the input to the current input.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void RevertLine(ConsoleKeyInfo? key = null, object arg = null)
         {
             if (_singleton._statusIsErrorMessage)
@@ -75,6 +84,7 @@ public static void RevertLine(ConsoleKeyInfo? key = null, object arg = null)
         /// Cancel the current input, leaving the input on the screen,
         /// but returns back to the host so the prompt is evaluated again.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void CancelLine(ConsoleKeyInfo? key = null, object arg = null)
         {
             _singleton.ClearStatusMessage(false);
@@ -109,6 +119,7 @@ public static void CancelLine(ConsoleKeyInfo? key = null, object arg = null)
         /// Like ForwardKillLine - deletes text from the point to the end of the line,
         /// but does not put the deleted text in the kill ring.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void ForwardDeleteLine(ConsoleKeyInfo? key = null, object arg = null)
         {
             var current = _singleton._current;
@@ -127,6 +138,7 @@ public static void ForwardDeleteLine(ConsoleKeyInfo? key = null, object arg = nu
         /// Like BackwardKillLine - deletes text from the point to the start of the line,
         /// but does not put the deleted text in the kill ring.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void BackwardDeleteLine(ConsoleKeyInfo? key = null, object arg = null)
         {
             if (_singleton._current > 0)
@@ -142,6 +154,7 @@ public static void BackwardDeleteLine(ConsoleKeyInfo? key = null, object arg = n
         /// <summary>
         /// Delete the character before the cursor.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void BackwardDeleteChar(ConsoleKeyInfo? key = null, object arg = null)
         {
             if (_singleton._visualSelectionCommandCount > 0)
@@ -191,6 +204,7 @@ private void DeleteCharImpl(bool orExit)
         /// <summary>
         /// Delete the character under the cursor.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void DeleteChar(ConsoleKeyInfo? key = null, object arg = null)
         {
             _singleton.DeleteCharImpl(orExit: false);
@@ -199,6 +213,7 @@ public static void DeleteChar(ConsoleKeyInfo? key = null, object arg = null)
         /// <summary>
         /// Delete the character under the cursor, or if the line is empty, exit the process
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void DeleteCharOrExit(ConsoleKeyInfo? key = null, object arg = null)
         {
             _singleton.DeleteCharImpl(orExit: true);
@@ -223,6 +238,7 @@ private bool AcceptLineImpl(bool validate)
             _emphasisStart = -1;
             _emphasisLength = 0;
 
+            var insertionPoint = _current;
             // Make sure cursor is at the end before writing the line
             _current = _buffer.Length;
 
@@ -239,6 +255,17 @@ private bool AcceptLineImpl(bool validate)
                 var errorMessage = Validate(_ast);
                 if (!string.IsNullOrWhiteSpace(errorMessage))
                 {
+                    // If there are more keys, assume the user pasted with a right click and
+                    // we should insert a newline even though validation failed.
+                    if (_queuedKeys.Count > 0)
+                    {
+                        // Validation may have moved the cursor.  Because there are queued
+                        // keys, we need to move the cursor back to the correct place, and
+                        // ignore where validation put the cursor because the queued keys
+                        // will be inserted in the wrong place.
+                        SetCursorPosition(insertionPoint);
+                        Insert('\n');
+                    }
                     _statusLinePrompt = "";
                     _statusBuffer.Append(errorMessage);
                     _statusIsErrorMessage = true;
@@ -280,7 +307,7 @@ public override AstVisitAction VisitCommand(CommandAst commandAst)
                         if (commandInfo == null && !_singleton.UnresolvedCommandCouldSucceed(commandName, _rootAst))
                         {
                             _singleton._current = commandAst.CommandElements[0].Extent.EndOffset;
-                            detectedError = string.Format(PSReadLineResources.CommandNotFoundError, commandName);
+                            detectedError = string.Format(CultureInfo.CurrentCulture, PSReadLineResources.CommandNotFoundError, commandName);
                             return AstVisitAction.StopVisit;
                         }
                     }
@@ -415,6 +442,7 @@ static bool StaticParameterBindingSupported(CommandInfo commandInfo)
         /// continuation prompt is displayed on the next line and PSReadline waits for
         /// keys to edit the current input.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void AcceptLine(ConsoleKeyInfo? key = null, object arg = null)
         {
             _singleton.AcceptLineImpl(false);
@@ -426,6 +454,7 @@ public static void AcceptLine(ConsoleKeyInfo? key = null, object arg = null)
         /// continuation prompt is displayed on the next line and PSReadline waits for
         /// keys to edit the current input.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void ValidateAndAcceptLine(ConsoleKeyInfo? key = null, object arg = null)
         {
             _singleton.AcceptLineImpl(true);
@@ -435,6 +464,7 @@ public static void ValidateAndAcceptLine(ConsoleKeyInfo? key = null, object arg
         /// Attempt to execute the current input.  If it can be executed (like AcceptLine),
         /// then recall the next item from history the next time Readline is called.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void AcceptAndGetNext(ConsoleKeyInfo? key = null, object arg = null)
         {
             if (_singleton.AcceptLineImpl(false))
@@ -455,6 +485,7 @@ public static void AcceptAndGetNext(ConsoleKeyInfo? key = null, object arg = nul
         /// keys to edit the current input.  This is useful to enter multi-line input as
         /// a single command even when a single line is complete input by itself.
         /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
         public static void AddLine(ConsoleKeyInfo? key = null, object arg = null)
         {
             Insert('\n');

PSReadLine/Changes.txt

@@ -1,4 +1,7 @@
-### Version 1.0.0.14
+### Version 1.1.0
+
+Breaking change:
+* Namespace PSConsoleUtilities has been renamed to Microsoft.PowerShell
 
 ### Version 1.0.0.13
 

PSReadLine/Cmdlets.cs

@@ -1,4 +1,8 @@
-using System;
+/********************************************************************++
+Copyright (c) Microsoft Corporation.  All rights reserved.
+--********************************************************************/
+
+using System;
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
 using System.Diagnostics.CodeAnalysis;
@@ -7,8 +11,11 @@
 using System.Reflection;
 using System.Linq;
 
-namespace PSConsoleUtilities
+namespace Microsoft.PowerShell
 {
+
+#pragma warning disable 1591
+
     public enum TokenClassification
     {
         None,
@@ -64,7 +71,7 @@ public class PSConsoleReadlineOptions
 
         public const EditMode DefaultEditMode = EditMode.Windows;
 
-        public const string DefaultContinuationPrompt = ">>> ";
+        public const string DefaultContinuationPrompt = ">> ";
 
         /// <summary>
         /// The maximum number of commands to store in the history.
@@ -132,7 +139,7 @@ public PSConsoleReadlineOptions(string hostName)
             HistorySearchCaseSensitive = DefaultHistorySearchCaseSensitive;
             HistorySaveStyle = DefaultHistorySaveStyle;
             HistorySavePath = Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData)
-                + @"\PSReadline\" + hostName + "_history.txt";
+                + @"\Microsoft\Windows\PowerShell\PSReadline\" + hostName + "_history.txt";
             CommandValidationHandler = null;
             CommandsToValidateScriptBlockArguments = new HashSet<string>(StringComparer.OrdinalIgnoreCase)
             {
@@ -189,6 +196,7 @@ public PSConsoleReadlineOptions(string hostName)
         /// odd things with script blocks, we create a white-list of commands
         /// that do invoke the script block - this covers the most useful cases.
         /// </summary>
+        [SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")]
         public HashSet<string> CommandsToValidateScriptBlockArguments { get; set; }
 
         /// <summary>
@@ -317,7 +325,7 @@ internal void SetBackgroundColor(TokenClassification tokenKind, ConsoleColor col
         }
     }
 
-    [Cmdlet("Get", "PSReadlineOption")]
+    [Cmdlet("Get", "PSReadlineOption", HelpUri = "http://go.microsoft.com/fwlink/?LinkId=528808")]
     [OutputType(typeof(PSConsoleReadlineOptions))]
     public class GetPSReadlineOption : PSCmdlet
     {
@@ -328,7 +336,7 @@ protected override void EndProcessing()
         }
     }
 
-    [Cmdlet("Set", "PSReadlineOption")]
+    [Cmdlet("Set", "PSReadlineOption", HelpUri = "http://go.microsoft.com/fwlink/?LinkId=528811")]
     public class SetPSReadlineOption : PSCmdlet
     {
         [Parameter(ParameterSetName = "OptionsSet")]
@@ -561,12 +569,13 @@ protected override void EndProcessing()
         }
     }
 
-    [Cmdlet("Set", "PSReadlineKeyHandler")]
+    [Cmdlet("Set", "PSReadlineKeyHandler", HelpUri = "http://go.microsoft.com/fwlink/?LinkId=528810")]
     public class SetPSReadlineKeyHandlerCommand : PSCmdlet, IDynamicParameters
     {
         [Parameter(Position = 0, Mandatory = true)]
         [Alias("Key")]
         [ValidateNotNullOrEmpty]
+        [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
         public string[] Chord { get; set; }
 
         [Parameter(Position = 1, Mandatory = true, ParameterSetName = "ScriptBlock")]
@@ -638,7 +647,7 @@ public object GetDynamicParameters()
         }
     }
 
-    [Cmdlet("Get", "PSReadlineKeyHandler")]
+    [Cmdlet("Get", "PSReadlineKeyHandler", HelpUri = "http://go.microsoft.com/fwlink/?LinkId=528807")]
     [OutputType(typeof(KeyHandler))]
     public class GetKeyHandlerCommand : PSCmdlet
     {
@@ -682,12 +691,13 @@ protected override void EndProcessing()
         }
     }
 
-    [Cmdlet("Remove", "PSReadlineKeyHandler")]
+    [Cmdlet("Remove", "PSReadlineKeyHandler", HelpUri = "http://go.microsoft.com/fwlink/?LinkId=528809")]
     public class RemoveKeyHandlerCommand : PSCmdlet
     {
         [Parameter(Position = 0, Mandatory = true)]
         [Alias("Key")]
         [ValidateNotNullOrEmpty]
+        [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
         public string[] Chord { get; set; }
 
         [ExcludeFromCodeCoverage]
@@ -696,4 +706,7 @@ protected override void EndProcessing()
             PSConsoleReadLine.RemoveKeyHandler(Chord);
         }
     }
+
+#pragma warning restore 1591
+
 }