Use const strings for some often used ANSI control sequences (#1809)

daxian-dbw · web-flow · commit a6b0e762b658 · 2020-09-14T12:40:25.000-07:00
diff --git a/PSReadLine/Cmdlets.cs b/PSReadLine/Cmdlets.cs
@@ -358,9 +358,9 @@ public string[] PromptText
                 for (int i = 0; i < minLength; i ++)
                 {
                     var text = _promptText[i];
-                    if (text.Contains('\x1b') && !text.EndsWith("\x1b[0m", StringComparison.Ordinal))
+                    if (text.Contains('\x1b') && !text.EndsWith(VTColorUtils.AnsiReset, StringComparison.Ordinal))
                     {
-                        _promptText[i] = string.Concat(text, "\x1b[0m");
+                        _promptText[i] = string.Concat(text, VTColorUtils.AnsiReset);
                     }
                 }
             }
@@ -946,6 +946,11 @@ protected override void EndProcessing()
 
     public static class VTColorUtils
     {
+        internal const string AnsiReset = "\x1b[0m";
+        internal const string DefaultForeground = "\x1b[39m";
+        internal const string DefaultBackground = "\x1b[49m";
+        internal const string DefaultColor = "\x1b[39;49m";
+
         public const ConsoleColor UnknownColor = (ConsoleColor) (-1);
         private static readonly Dictionary<string, ConsoleColor> ConsoleColors =
             new Dictionary<string, ConsoleColor>(StringComparer.OrdinalIgnoreCase)
@@ -1138,7 +1143,7 @@ public static string FormatColor(object seq)
             var result = seq.ToString();
             if (seq is ConsoleColor) return result;
 
-            result = result + "\"" + FormatEscape(result) + "\"" + "\x1b[0m";
+            result = result + "\"" + FormatEscape(result) + "\"" + AnsiReset;
             return result;
         }
     }
diff --git a/PSReadLine/Completion.cs b/PSReadLine/Completion.cs
@@ -603,7 +603,7 @@ public void UpdateMenuSelection(int selectedItem, bool select, bool showTooltips
 
                 if (select) console.Write(Singleton.Options._selectionColor);
                 console.Write(GetMenuItem(listItem, ColumnWidth));
-                if (select) console.Write("\x1b[0m");
+                if (select) console.Write(VTColorUtils.AnsiReset);
 
                 ToolTipLines = 0;
                 if (showTooltips)
@@ -617,7 +617,7 @@ public void UpdateMenuSelection(int selectedItem, bool select, bool showTooltips
                     console.Write(toolTip);
                     ToolTipLines = toolTipLines;
 
-                    console.Write("\x1b[0m");
+                    console.Write(VTColorUtils.AnsiReset);
                 }
 
                 RestoreCursor();
diff --git a/PSReadLine/Render.cs b/PSReadLine/Render.cs
@@ -122,7 +122,7 @@ private void Render()
 
         private void ForceRender()
         {
-            var defaultColor = "\x1b[39;49m";
+            var defaultColor = VTColorUtils.DefaultColor;
 
             // Geneate a sequence of logical lines with escape sequences for coloring.
             int logicalLineCount = GenerateRender(defaultColor);
@@ -179,7 +179,7 @@ void RenderOneChar(char charToRender, bool toEmphasize)
                     if (inSelectedRegion)
                     {
                         // Turn off inverse before end of line, turn on after continuation prompt
-                        _consoleBufferLines[currentLogicalLine].Append("\x1b[0m");
+                        _consoleBufferLines[currentLogicalLine].Append(VTColorUtils.AnsiReset);
                     }
 
                     currentLogicalLine += 1;
@@ -254,7 +254,7 @@ void RenderOneChar(char charToRender, bool toEmphasize)
                 }
                 else if (i == selectionEnd)
                 {
-                    _consoleBufferLines[currentLogicalLine].Append("\x1b[0m");
+                    _consoleBufferLines[currentLogicalLine].Append(VTColorUtils.AnsiReset);
                     _consoleBufferLines[currentLogicalLine].Append(activeColor);
                     inSelectedRegion = false;
                 }
@@ -334,7 +334,7 @@ void RenderOneChar(char charToRender, bool toEmphasize)
 
             if (inSelectedRegion)
             {
-                _consoleBufferLines[currentLogicalLine].Append("\x1b[0m");
+                _consoleBufferLines[currentLogicalLine].Append(VTColorUtils.AnsiReset);
                 inSelectedRegion = false;
             }
 
@@ -444,7 +444,7 @@ private bool RenderErrorPrompt(RenderData renderData, string defaultColor)
                     string color = renderData.errorPrompt ? _options._errorColor : defaultColor;
                     _console.Write(color);
                     _console.Write(promptText);
-                    _console.Write("\x1b[0m");
+                    _console.Write(VTColorUtils.AnsiReset);
                 }
                 else
                 {
@@ -772,7 +772,7 @@ void UpdateColorsIfNecessary(string newColor)
             physicalLine -= pseudoPhysicalLineOffset;
 
             // Reset the colors after we've finished all our rendering.
-            _console.Write("\x1b[0m");
+            _console.Write(VTColorUtils.AnsiReset);
 
             if (_initialY + physicalLine > bufferHeight)
             {

Original file line number	Diff line number	Diff line change
`@@ -358,9 +358,9 @@ public string[] PromptText`
`358`	`358`	`for (int i = 0; i < minLength; i ++)`
`359`	`359`	`{`
`360`	`360`	`var text = _promptText[i];`
`361`		`- if (text.Contains('\x1b') && !text.EndsWith("\x1b[0m", StringComparison.Ordinal))`
	`361`	`+ if (text.Contains('\x1b') && !text.EndsWith(VTColorUtils.AnsiReset, StringComparison.Ordinal))`
`362`	`362`	`{`
`363`		`- _promptText[i] = string.Concat(text, "\x1b[0m");`
	`363`	`+ _promptText[i] = string.Concat(text, VTColorUtils.AnsiReset);`
`364`	`364`	`}`
`365`	`365`	`}`
`366`	`366`	`}`
`@@ -946,6 +946,11 @@ protected override void EndProcessing()`
`946`	`946`
`947`	`947`	`public static class VTColorUtils`
`948`	`948`	`{`
	`949`	`+ internal const string AnsiReset = "\x1b[0m";`
	`950`	`+ internal const string DefaultForeground = "\x1b[39m";`
	`951`	`+ internal const string DefaultBackground = "\x1b[49m";`
	`952`	`+ internal const string DefaultColor = "\x1b[39;49m";`
	`953`	`+`
`949`	`954`	`public const ConsoleColor UnknownColor = (ConsoleColor) (-1);`
`950`	`955`	`private static readonly Dictionary<string, ConsoleColor> ConsoleColors =`
`951`	`956`	`new Dictionary<string, ConsoleColor>(StringComparer.OrdinalIgnoreCase)`
`@@ -1138,7 +1143,7 @@ public static string FormatColor(object seq)`
`1138`	`1143`	`var result = seq.ToString();`
`1139`	`1144`	`if (seq is ConsoleColor) return result;`
`1140`	`1145`
`1141`		`- result = result + "\"" + FormatEscape(result) + "\"" + "\x1b[0m";`
	`1146`	`+ result = result + "\"" + FormatEscape(result) + "\"" + AnsiReset;`
`1142`	`1147`	`return result;`
`1143`	`1148`	`}`
`1144`	`1149`	`}`
Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,7 @@ private void Render()`
`122`	`122`
`123`	`123`	`private void ForceRender()`
`124`	`124`	`{`
`125`		`- var defaultColor = "\x1b[39;49m";`
	`125`	`+ var defaultColor = VTColorUtils.DefaultColor;`
`126`	`126`
`127`	`127`	`// Geneate a sequence of logical lines with escape sequences for coloring.`
`128`	`128`	`int logicalLineCount = GenerateRender(defaultColor);`
`@@ -179,7 +179,7 @@ void RenderOneChar(char charToRender, bool toEmphasize)`
`179`	`179`	`if (inSelectedRegion)`
`180`	`180`	`{`
`181`	`181`	`// Turn off inverse before end of line, turn on after continuation prompt`
`182`		`- _consoleBufferLines[currentLogicalLine].Append("\x1b[0m");`
	`182`	`+ _consoleBufferLines[currentLogicalLine].Append(VTColorUtils.AnsiReset);`
`183`	`183`	`}`
`184`	`184`
`185`	`185`	`currentLogicalLine += 1;`
`@@ -254,7 +254,7 @@ void RenderOneChar(char charToRender, bool toEmphasize)`
`254`	`254`	`}`
`255`	`255`	`else if (i == selectionEnd)`
`256`	`256`	`{`
`257`		`- _consoleBufferLines[currentLogicalLine].Append("\x1b[0m");`
	`257`	`+ _consoleBufferLines[currentLogicalLine].Append(VTColorUtils.AnsiReset);`
`258`	`258`	`_consoleBufferLines[currentLogicalLine].Append(activeColor);`
`259`	`259`	`inSelectedRegion = false;`
`260`	`260`	`}`
`@@ -334,7 +334,7 @@ void RenderOneChar(char charToRender, bool toEmphasize)`
`334`	`334`
`335`	`335`	`if (inSelectedRegion)`
`336`	`336`	`{`
`337`		`- _consoleBufferLines[currentLogicalLine].Append("\x1b[0m");`
	`337`	`+ _consoleBufferLines[currentLogicalLine].Append(VTColorUtils.AnsiReset);`
`338`	`338`	`inSelectedRegion = false;`
`339`	`339`	`}`
`340`	`340`
`@@ -444,7 +444,7 @@ private bool RenderErrorPrompt(RenderData renderData, string defaultColor)`
`444`	`444`	`string color = renderData.errorPrompt ? _options._errorColor : defaultColor;`
`445`	`445`	`_console.Write(color);`
`446`	`446`	`_console.Write(promptText);`
`447`		`- _console.Write("\x1b[0m");`
	`447`	`+ _console.Write(VTColorUtils.AnsiReset);`
`448`	`448`	`}`
`449`	`449`	`else`
`450`	`450`	`{`
`@@ -772,7 +772,7 @@ void UpdateColorsIfNecessary(string newColor)`
`772`	`772`	`physicalLine -= pseudoPhysicalLineOffset;`
`773`	`773`
`774`	`774`	`// Reset the colors after we've finished all our rendering.`
`775`		`- _console.Write("\x1b[0m");`
	`775`	`+ _console.Write(VTColorUtils.AnsiReset);`
`776`	`776`
`777`	`777`	`if (_initialY + physicalLine > bufferHeight)`
`778`	`778`	`{`