Support tooltip rendering in the prediction list view (#3667)

Author: daxian-dbw

PSReadLine/Cmdlets.cs

@@ -101,6 +101,7 @@ public class PSConsoleReadLineOptions
         public const string DefaultInlinePredictionColor       = "\x1b[97;2;3m";
         public const string DefaultListPredictionColor         = "\x1b[33m";
         public const string DefaultListPredictionSelectedColor = "\x1b[48;5;238m";
+        public const string DefaultListPredictionTooltipColor  = "\x1b[97;2;3m";
 
         public static EditMode DefaultEditMode = RuntimeInformation.IsOSPlatform(OSPlatform.Windows)
             ? EditMode.Windows
@@ -495,6 +496,12 @@ public object ListPredictionSelectedColor
             set => _listPredictionSelectedColor = VTColorUtils.AsEscapeSequence(value);
         }
 
+        public object ListPredictionTooltipColor
+        {
+            get => _listPredictionTooltipColor;
+            set => _listPredictionTooltipColor = VTColorUtils.AsEscapeSequence(value);
+        }
+
         internal string _defaultTokenColor;
         internal string _commentColor;
         internal string _keywordColor;
@@ -512,6 +519,7 @@ public object ListPredictionSelectedColor
         internal string _inlinePredictionColor;
         internal string _listPredictionColor;
         internal string _listPredictionSelectedColor;
+        internal string _listPredictionTooltipColor;
 
         internal void ResetColors()
         {
@@ -532,6 +540,7 @@ internal void ResetColors()
             InlinePredictionColor       = DefaultInlinePredictionColor;
             ListPredictionColor         = DefaultListPredictionColor;
             ListPredictionSelectedColor = DefaultListPredictionSelectedColor;
+            ListPredictionTooltipColor  = DefaultListPredictionTooltipColor;
 
             var bg = Console.BackgroundColor;
             if (fg == VTColorUtils.UnknownColor || bg == VTColorUtils.UnknownColor)
@@ -571,6 +580,7 @@ internal void SetColor(string property, object value)
                         {"InlinePrediction", (o, v) => o.InlinePredictionColor = v},
                         {"ListPrediction", (o, v) => o.ListPredictionColor = v},
                         {"ListPredictionSelected", (o, v) => o.ListPredictionSelectedColor = v},
+                        {"ListPredictionTooltip", (o, v) => o.ListPredictionTooltipColor = v},
                     };
 
                 Interlocked.CompareExchange(ref ColorSetters, setters, null);

PSReadLine/DynamicHelp.cs

@@ -19,6 +19,7 @@ public partial class PSConsoleReadLine
         [ExcludeFromCodeCoverage]
         void IPSConsoleReadLineMockableMethods.RenderFullHelp(string content, string regexPatternToScrollTo)
         {
+            _pager ??= new Pager();
             _pager.Write(content, regexPatternToScrollTo);
         }
 
@@ -142,11 +143,6 @@ private void WriteDynamicHelpContent(string commandName, string parameterName, b
 
         private void DynamicHelpImpl(bool isFullHelp)
         {
-            if (isFullHelp)
-            {
-                _pager ??= new Pager();
-            }
-
             int cursor = _singleton._current;
             string commandName = null;
             string parameterName = null;

PSReadLine/KeyBindings.cs

@@ -235,6 +235,7 @@ void SetDefaultWindowsBindings()
                 { Keys.F2,                     MakeKeyHandler(SwitchPredictionView,      "SwitchPredictionView") },
                 { Keys.F3,                     MakeKeyHandler(CharacterSearch,           "CharacterSearch") },
                 { Keys.ShiftF3,                MakeKeyHandler(CharacterSearchBackward,   "CharacterSearchBackward") },
+                { Keys.F4,                     MakeKeyHandler(ShowFullPredictionTooltip, "ShowFullPredictionTooltip") },
                 { Keys.F8,                     MakeKeyHandler(HistorySearchBackward,     "HistorySearchBackward") },
                 { Keys.ShiftF8,                MakeKeyHandler(HistorySearchForward,      "HistorySearchForward") },
                 // Added for xtermjs-based terminals that send different key combinations.
@@ -339,6 +340,7 @@ void SetDefaultEmacsBindings()
                 { Keys.AltH,                   MakeKeyHandler(ShowParameterHelp,         "ShowParameterHelp") },
                 { Keys.F1,                     MakeKeyHandler(ShowCommandHelp,           "ShowCommandHelp") },
                 { Keys.F2,                     MakeKeyHandler(SwitchPredictionView,      "SwitchPredictionView") },
+                { Keys.F4,                     MakeKeyHandler(ShowFullPredictionTooltip, "ShowFullPredictionTooltip") },
                 { Keys.AltU,                   MakeKeyHandler(UpcaseWord,                "UpcaseWord") },
                 { Keys.AltL,                   MakeKeyHandler(DowncaseWord,              "DowncaseWord") },
                 { Keys.AltC,                   MakeKeyHandler(CapitalizeWord,            "CapitalizeWord") },
@@ -566,6 +568,7 @@ public static KeyHandlerGroup GetDisplayGrouping(string function)
             case nameof(NextSuggestion):
             case nameof(PreviousSuggestion):
             case nameof(SwitchPredictionView):
+            case nameof(ShowFullPredictionTooltip):
                 return KeyHandlerGroup.Prediction;
 
             case nameof(CaptureScreen):

PSReadLine/KeyBindings.vi.cs

@@ -91,6 +91,8 @@ private void SetDefaultViBindings()
                 { Keys.CtrlG,           MakeKeyHandler(Abort,                  "Abort") },
                 { Keys.AltH,            MakeKeyHandler(ShowParameterHelp,      "ShowParameterHelp") },
                 { Keys.F1,              MakeKeyHandler(ShowCommandHelp,        "ShowCommandHelp") },
+                { Keys.F2,              MakeKeyHandler(SwitchPredictionView,   "SwitchPredictionView") },
+                { Keys.F4,              MakeKeyHandler(ShowFullPredictionTooltip, "ShowFullPredictionTooltip") },
             };
 
             // Some bindings are not available on certain platforms

PSReadLine/PSReadLine.format.ps1xml

@@ -204,6 +204,10 @@ $d = [Microsoft.PowerShell.KeyHandler]::GetGroupingDescription($_.Group)
                 <Label>ListPredictionSelectedColor</Label>
                 <ScriptBlock>[Microsoft.PowerShell.VTColorUtils]::FormatColor($_.ListPredictionSelectedColor)</ScriptBlock>
               </ListItem>
+              <ListItem>
+                <Label>ListPredictionTooltipColor</Label>
+                <ScriptBlock>[Microsoft.PowerShell.VTColorUtils]::FormatColor($_.ListPredictionTooltipColor)</ScriptBlock>
+              </ListItem>
               <ListItem>
                 <Label>MemberColor</Label>
                 <ScriptBlock>[Microsoft.PowerShell.VTColorUtils]::FormatColor($_.MemberColor)</ScriptBlock>

PSReadLine/PSReadLineResources.Designer.cs

@@ -837,6 +837,9 @@ Or not saving history with:
   <data name="SwitchPredictionViewDescription" xml:space="preserve">
     <value>Switch between the inline and list prediction views.</value>
   </data>
+  <data name="ShowFullPredictionTooltipDescription" xml:space="preserve">
+    <value>Show the full tooltip of the selected list-view item in the terminal's alternate screen buffer.</value>
+  </data>
   <data name="WindowSizeTooSmallForListView" xml:space="preserve">
     <value>The prediction 'ListView' is temporarily disabled because the current window size of the console is too small. To use the 'ListView', please make sure the 'WindowWidth' is not less than '{0}' and the 'WindowHeight' is not less than '{1}'.</value>
   </data>

PSReadLine/PSReadLineResources.resx

@@ -47,23 +47,25 @@ private struct SuggestionEntry
             internal readonly Guid PredictorId;
             internal readonly uint? PredictorSession;
             internal readonly string Source;
+            internal readonly string ToolTip;
             internal readonly string SuggestionText;
             internal readonly int InputMatchIndex;
 
             private string _listItemTextRegular;
             private string _listItemTextSelected;
 
             internal SuggestionEntry(string suggestion, int matchIndex)
-                : this(source: HistorySource, predictorId: Guid.Empty, predictorSession: null, suggestion, matchIndex)
+                : this(source: HistorySource, predictorId: Guid.Empty, predictorSession: null, suggestion, tooltip: null, matchIndex)
             {
             }
 
-            internal SuggestionEntry(string source, Guid predictorId, uint? predictorSession, string suggestion, int matchIndex)
+            internal SuggestionEntry(string source, Guid predictorId, uint? predictorSession, string suggestion, string tooltip, int matchIndex)
             {
                 Source = source;
                 PredictorId = predictorId;
                 PredictorSession = predictorSession;
                 SuggestionText = suggestion;
+                ToolTip = tooltip;
                 InputMatchIndex = matchIndex;
 
                 _listItemTextRegular = _listItemTextSelected = null;