Unbound functions in Get-PSReadlineKeyHandler

Get-PSReadlineKeyHandler will now return unbound functions by default.

A couple of parameters were added so you can get just the bound/unbound
parameters if so desired.

OutputType was also added to Get-PSReadlineKeyHandler.

The OutputType was cleaned up a bit - BriefDescription was renamed to Function
and LongDescription was renamed to ShortDescription.

Author: lzybkr

PSReadLine/Cmdlets.cs

@@ -439,9 +439,14 @@ public class SetKeyHandlerCommand : PSCmdlet
         public string BriefDescription { get; set; }
 
         [Parameter(ParameterSetName = "ScriptBlock")]
-        public string LongDescription { get; set; }
+        [Alias("LongDescription")]  // Alias to stay comptible with previous releases
+        public string Description { get; set; }
 
         // ValidateSet attribute is generated by the script GenerateBuiltinList
+        // It would be cleaner to use Function in the ScriptBlock parameter set (instead of BriefDescription)
+        // but then we couldn't use ValidateSet because ValidateSet only makes sense in the Function
+        // parameter set.  A custom Validate attribute would be better, but I don't know of a way
+        // for the attribute to determine the parameter set.
         [ValidateSet("Abort", "AcceptAndGetNext", "AcceptLine", "AddLine", "BackwardChar",
                      "BackwardDeleteChar", "BackwardDeleteLine", "BackwardKillLine", "BackwardKillWord", "BackwardWord",
                      "BeginningOfHistory", "BeginningOfLine", "CancelLine", "CharacterSearch", "CharacterSearchBackward",
@@ -471,17 +476,51 @@ protected override void EndProcessing()
             {
                 keyHandler = (key, arg) => ScriptBlock.Invoke(key, arg);
             }
-            PSConsoleReadLine.SetKeyHandler(Chord, keyHandler, BriefDescription, LongDescription);
+            PSConsoleReadLine.SetKeyHandler(Chord, keyHandler, BriefDescription, Description);
         }
     }
 
     [Cmdlet("Get", "PSReadlineKeyHandler")]
+    [OutputType(typeof(KeyHandler))]
     public class GetKeyHandlerCommand : PSCmdlet
     {
+        [Parameter]
+        public SwitchParameter Bound
+        {
+            get { return _bound.GetValueOrDefault(); }
+            set { _bound = value; }
+        }
+        private SwitchParameter? _bound;
+
+        [Parameter]
+        public SwitchParameter Unbound
+        {
+            get { return _unbound.GetValueOrDefault(); }
+            set { _unbound = value; }
+        }
+        private SwitchParameter? _unbound;
+
         [ExcludeFromCodeCoverage]
         protected override void EndProcessing()
         {
-            WriteObject(PSConsoleReadLine.GetKeyHandlers(), true);
+            bool bound = true;
+            bool unbound = true;
+            if (_bound.HasValue && _unbound.HasValue)
+            {
+                bound = _bound.Value.IsPresent;
+                unbound = _unbound.Value.IsPresent;
+            }
+            else if (_bound.HasValue)
+            {
+                bound = _bound.Value.IsPresent;
+                unbound = false;
+            }
+            else if (_unbound.HasValue)
+            {
+                bound = false;
+                unbound = _unbound.Value.IsPresent;
+            }
+            WriteObject(PSConsoleReadLine.GetKeyHandlers(bound, unbound), true);
         }
     }
 }

PSReadLine/PSReadLine.format.ps1xml

@@ -15,8 +15,8 @@
                         <Width>20</Width>
                     </TableColumnHeader>
                     <TableColumnHeader>
-                        <Label>BriefDescription</Label>
-                        <Width>22</Width>
+                        <Label>Function</Label>
+                        <Width>24</Width>
                     </TableColumnHeader>
                     <TableColumnHeader/>
                 </TableHeaders>
@@ -27,10 +27,10 @@
                                 <PropertyName>Key</PropertyName>
                             </TableColumnItem>
                             <TableColumnItem>
-                                <PropertyName>BriefDescription</PropertyName>
+                                <PropertyName>Function</PropertyName>
                             </TableColumnItem>
                             <TableColumnItem>
-                                <PropertyName>LongDescription</PropertyName>
+                                <PropertyName>Description</PropertyName>
                             </TableColumnItem>
                         </TableColumnItems>
                     </TableRowEntry>

PSReadLine/ReadLine.cs

@@ -5,6 +5,7 @@
 using System.Linq;
 using System.Management.Automation;
 using System.Management.Automation.Language;
+using System.Reflection;
 using System.Runtime.InteropServices;
 using System.Text;
 using System.Text.RegularExpressions;
@@ -46,21 +47,21 @@ public enum TokenClassification
     public class KeyHandler
     {
         public string Key { get; set; }
-        public string BriefDescription { get; set; }
-        public string LongDescription
+        public string Function { get; set; }
+        public string Description
         {
             get
             {
-                var result = _longDescription;
+                var result = _description;
                 if (string.IsNullOrWhiteSpace(result))
-                    result = PSReadLineResources.ResourceManager.GetString(BriefDescription + "Description");
+                    result = PSReadLineResources.ResourceManager.GetString(Function + "Description");
                 if (string.IsNullOrWhiteSpace(result))
-                    result = BriefDescription;
+                    result = Function;
                 return result;
             }
-            set { _longDescription = value; }
+            set { _description = value; }
         }
-        private string _longDescription;
+        private string _description;
     }
 
     public class PSConsoleReadLine
@@ -3462,33 +3463,71 @@ public static void SetKeyHandler(string[] key, Action<ConsoleKeyInfo?, object> h
         /// Helper function for the Get-PSReadlineKeyHandler cmdlet.
         /// </summary>
         /// <returns></returns>
-        public static IEnumerable<PSConsoleUtilities.KeyHandler> GetKeyHandlers()
+        public static IEnumerable<PSConsoleUtilities.KeyHandler> GetKeyHandlers(bool includeBound = true, bool includeUnbound = false)
         {
+            var boundFunctions = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
+
             foreach (var entry in _singleton._dispatchTable)
             {
-                if (entry.Value.BriefDescription == "Ignore" 
+                if (entry.Value.BriefDescription == "Ignore"
                     || entry.Value.BriefDescription == "ChordFirstKey")
                 {
                     continue;
                 }
-                yield return new PSConsoleUtilities.KeyHandler
+                boundFunctions.Add(entry.Value.BriefDescription);
+                if (includeBound)
                 {
-                    Key = entry.Key.ToGestureString(),
-                    BriefDescription = entry.Value.BriefDescription,
-                    LongDescription = entry.Value.LongDescription,
-                };
+                    yield return new PSConsoleUtilities.KeyHandler
+                    {
+                        Key = entry.Key.ToGestureString(),
+                        Function = entry.Value.BriefDescription,
+                        Description = entry.Value.LongDescription,
+                    };
+                }
             }
 
             foreach (var entry in _singleton._chordDispatchTable)
             {
                 foreach (var secondEntry in entry.Value)
                 {
-                    yield return new PSConsoleUtilities.KeyHandler
+                    boundFunctions.Add(secondEntry.Value.BriefDescription);
+                    if (includeBound)
                     {
-                        Key = entry.Key.ToGestureString() + "," + secondEntry.Key.ToGestureString(),
-                        BriefDescription = secondEntry.Value.BriefDescription,
-                        LongDescription = secondEntry.Value.LongDescription,
-                    };
+                        yield return new PSConsoleUtilities.KeyHandler
+                        {
+                            Key = entry.Key.ToGestureString() + "," + secondEntry.Key.ToGestureString(),
+                            Function = secondEntry.Value.BriefDescription,
+                            Description = secondEntry.Value.LongDescription,
+                        };
+                    }
+                }
+            }
+
+            if (includeUnbound)
+            {
+                // SelfInsert isn't really unbound, but we don't want UI to show it that way
+                boundFunctions.Add("SelfInsert");
+
+                var methods = typeof (PSConsoleReadLine).GetMethods(BindingFlags.Public | BindingFlags.Static);
+                foreach (var method in methods)
+                {
+                    var parameters = method.GetParameters();
+                    if (parameters.Length != 2 ||
+                        parameters[0].ParameterType != typeof (ConsoleKeyInfo?) ||
+                        parameters[1].ParameterType != typeof (object))
+                    {
+                        continue;
+                    }
+
+                    if (!boundFunctions.Contains(method.Name))
+                    {
+                        yield return new PSConsoleUtilities.KeyHandler
+                        {
+                            Key = "Unbound",
+                            Function = method.Name,
+                            Description = null,
+                        };
+                    }
                 }
             }
         }