Use \e instead of \u001B or \x1B

dotnet · Mar 15, 2024 · e5724b3 · e5724b3
1 parent 5c40bb5
commit e5724b3
Show file tree

Hide file tree

Showing 15 changed files with 124 additions and 124 deletions.
diff --git a/eng/Version.Details.xml b/eng/Version.Details.xml
@@ -360,9 +360,9 @@
       <Uri>https://github.com/dotnet/runtime-assets</Uri>
       <Sha>fe7f6de587d1867b71a8e846ffee3b2035afbfe5</Sha>
     </Dependency>
-    <Dependency Name="Microsoft.Net.Compilers.Toolset" Version="4.10.0-2.24114.13">
+    <Dependency Name="Microsoft.Net.Compilers.Toolset" Version="4.10.0-3.24151.8">
       <Uri>https://github.com/dotnet/roslyn</Uri>
-      <Sha>77372c66fd54927312b5b0a2e399e192f74445c9</Sha>
+      <Sha>8537440d8c831b8533a18f6530945ee91c243e1b</Sha>
     </Dependency>
     <Dependency Name="Microsoft.CodeAnalysis" Version="4.10.0-2.24114.13">
       <Uri>https://github.com/dotnet/roslyn</Uri>

diff --git a/eng/Versions.props b/eng/Versions.props
@@ -44,7 +44,7 @@
     -->
     <MicrosoftCodeAnalysisCSharpVersion>4.10.0-2.24114.13</MicrosoftCodeAnalysisCSharpVersion>
     <MicrosoftCodeAnalysisVersion>4.10.0-2.24114.13</MicrosoftCodeAnalysisVersion>
-    <MicrosoftNetCompilersToolsetVersion>4.10.0-2.24114.13</MicrosoftNetCompilersToolsetVersion>
+    <MicrosoftNetCompilersToolsetVersion>4.10.0-3.24151.8</MicrosoftNetCompilersToolsetVersion>
   </PropertyGroup>
   <!--
     For source generator support we need to target multiple versions of Roslyn in order to be able to run on older versions of Roslyn.

diff --git a/src/installer/tests/TestUtils/AnsiColorExtensions.cs b/src/installer/tests/TestUtils/AnsiColorExtensions.cs
@@ -7,46 +7,46 @@ public static class AnsiColorExtensions
     {
         public static string Black(this string text)
         {
-            return "\x1B[30m" + text + "\x1B[39m";
+            return "\e[30m" + text + "\e[39m";
         }
 
         public static string Red(this string text)
         {
-            return "\x1B[31m" + text + "\x1B[39m";
+            return "\e[31m" + text + "\e[39m";
         }
         public static string Green(this string text)
         {
-            return "\x1B[32m" + text + "\x1B[39m";
+            return "\e[32m" + text + "\e[39m";
         }
 
         public static string Yellow(this string text)
         {
-            return "\x1B[33m" + text + "\x1B[39m";
+            return "\e[33m" + text + "\e[39m";
         }
 
         public static string Blue(this string text)
         {
-            return "\x1B[34m" + text + "\x1B[39m";
+            return "\e[34m" + text + "\e[39m";
         }
 
         public static string Magenta(this string text)
         {
-            return "\x1B[35m" + text + "\x1B[39m";
+            return "\e[35m" + text + "\e[39m";
         }
 
         public static string Cyan(this string text)
         {
-            return "\x1B[36m" + text + "\x1B[39m";
+            return "\e[36m" + text + "\e[39m";
         }
 
         public static string White(this string text)
         {
-            return "\x1B[37m" + text + "\x1B[39m";
+            return "\e[37m" + text + "\e[39m";
         }
 
         public static string Bold(this string text)
         {
-            return "\x1B[1m" + text + "\x1B[22m";
+            return "\e[1m" + text + "\e[22m";
         }
     }
 }
diff --git a/src/installer/tests/TestUtils/AnsiConsole.cs b/src/installer/tests/TestUtils/AnsiConsole.cs
@@ -66,7 +66,7 @@ public void Write(string message)
             var escapeScan = 0;
             for (;;)
             {
-                var escapeIndex = message.IndexOf("\x1b[", escapeScan, StringComparison.Ordinal);
+                var escapeIndex = message.IndexOf("\e[", escapeScan, StringComparison.Ordinal);
                 if (escapeIndex == -1)
                 {
                     var text = message.Substring(escapeScan);

diff --git a/src/libraries/Microsoft.Extensions.Logging.Console/src/AnsiParser.cs b/src/libraries/Microsoft.Extensions.Logging.Console/src/AnsiParser.cs
@@ -50,7 +50,7 @@ public void Parse(string message)
             ConsoleColor? foreground = null;
             ConsoleColor? background = null;
             var span = message.AsSpan();
-            const char EscapeChar = '\x1B';
+            const char EscapeChar = '\e';
             ConsoleColor? color = null;
             bool isBright = false;
             for (int i = 0; i < span.Length; i++)
@@ -59,7 +59,7 @@ public void Parse(string message)
                 {
                     if (span[i + 3] == 'm')
                     {
-                        // Example: \x1B[1m
+                        // Example: \e[1m
                         if (IsDigit(span[i + 2]))
                         {
                             escapeCode = (int)(span[i + 2] - '0');
@@ -77,7 +77,7 @@ public void Parse(string message)
                     }
                     else if (span.Length >= i + 5 && span[i + 4] == 'm')
                     {
-                        // Example: \x1B[40m
+                        // Example: \e[40m
                         if (IsDigit(span[i + 2]) && IsDigit(span[i + 3]))
                         {
                             escapeCode = (int)(span[i + 2] - '0') * 10 + (int)(span[i + 3] - '0');
@@ -127,28 +127,28 @@ public void Parse(string message)
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         private static bool IsDigit(char c) => (uint)(c - '0') <= ('9' - '0');
 
-        internal const string DefaultForegroundColor = "\x1B[39m\x1B[22m"; // reset to default foreground color
-        internal const string DefaultBackgroundColor = "\x1B[49m"; // reset to the background color
+        internal const string DefaultForegroundColor = "\e[39m\e[22m"; // reset to default foreground color
+        internal const string DefaultBackgroundColor = "\e[49m"; // reset to the background color
 
         internal static string GetForegroundColorEscapeCode(ConsoleColor color)
         {
             return color switch
             {
-                ConsoleColor.Black => "\x1B[30m",
-                ConsoleColor.DarkRed => "\x1B[31m",
-                ConsoleColor.DarkGreen => "\x1B[32m",
-                ConsoleColor.DarkYellow => "\x1B[33m",
-                ConsoleColor.DarkBlue => "\x1B[34m",
-                ConsoleColor.DarkMagenta => "\x1B[35m",
-                ConsoleColor.DarkCyan => "\x1B[36m",
-                ConsoleColor.Gray => "\x1B[37m",
-                ConsoleColor.Red => "\x1B[1m\x1B[31m",
-                ConsoleColor.Green => "\x1B[1m\x1B[32m",
-                ConsoleColor.Yellow => "\x1B[1m\x1B[33m",
-                ConsoleColor.Blue => "\x1B[1m\x1B[34m",
-                ConsoleColor.Magenta => "\x1B[1m\x1B[35m",
-                ConsoleColor.Cyan => "\x1B[1m\x1B[36m",
-                ConsoleColor.White => "\x1B[1m\x1B[37m",
+                ConsoleColor.Black => "\e[30m",
+                ConsoleColor.DarkRed => "\e[31m",
+                ConsoleColor.DarkGreen => "\e[32m",
+                ConsoleColor.DarkYellow => "\e[33m",
+                ConsoleColor.DarkBlue => "\e[34m",
+                ConsoleColor.DarkMagenta => "\e[35m",
+                ConsoleColor.DarkCyan => "\e[36m",
+                ConsoleColor.Gray => "\e[37m",
+                ConsoleColor.Red => "\e[1m\e[31m",
+                ConsoleColor.Green => "\e[1m\e[32m",
+                ConsoleColor.Yellow => "\e[1m\e[33m",
+                ConsoleColor.Blue => "\e[1m\e[34m",
+                ConsoleColor.Magenta => "\e[1m\e[35m",
+                ConsoleColor.Cyan => "\e[1m\e[36m",
+                ConsoleColor.White => "\e[1m\e[37m",
                 _ => DefaultForegroundColor // default foreground color
             };
         }
@@ -157,14 +157,14 @@ internal static string GetBackgroundColorEscapeCode(ConsoleColor color)
         {
             return color switch
             {
-                ConsoleColor.Black => "\x1B[40m",
-                ConsoleColor.DarkRed => "\x1B[41m",
-                ConsoleColor.DarkGreen => "\x1B[42m",
-                ConsoleColor.DarkYellow => "\x1B[43m",
-                ConsoleColor.DarkBlue => "\x1B[44m",
-                ConsoleColor.DarkMagenta => "\x1B[45m",
-                ConsoleColor.DarkCyan => "\x1B[46m",
-                ConsoleColor.Gray => "\x1B[47m",
+                ConsoleColor.Black => "\e[40m",
+                ConsoleColor.DarkRed => "\e[41m",
+                ConsoleColor.DarkGreen => "\e[42m",
+                ConsoleColor.DarkYellow => "\e[43m",
+                ConsoleColor.DarkBlue => "\e[44m",
+                ConsoleColor.DarkMagenta => "\e[45m",
+                ConsoleColor.DarkCyan => "\e[46m",
+                ConsoleColor.Gray => "\e[47m",
                 _ => DefaultBackgroundColor // Use default background color
             };
         }

diff --git a/...sions.Logging.Console/tests/Microsoft.Extensions.Logging.Console.Tests/AnsiParserTests.cs b/...sions.Logging.Console/tests/Microsoft.Extensions.Logging.Console.Tests/AnsiParserTests.cs
@@ -11,12 +11,12 @@ namespace Microsoft.Extensions.Logging.Console.Test
 {
     public class AnsiParserTests
     {
-        private const char EscapeChar = '\x1B';
+        private const char EscapeChar = '\e';
 
         [Theory]
         [InlineData(1, "No Color", "No Color")]
-        [InlineData(2, "\x1B[41mColored\x1B[49mNo Color", "No Color")]
-        [InlineData(2, "\x1B[41m\x1B[1m\x1B[31mmColored\x1B[39m\x1B[49mNo Color", "No Color")]
+        [InlineData(2, "\e[41mColored\e[49mNo Color", "No Color")]
+        [InlineData(2, "\e[41m\e[1m\e[31mmColored\e[39m\e[49mNo Color", "No Color")]
         public void Parse_CheckTimesWrittenToConsole(int numSegments, string message, string lastSegment)
         {
             // Arrange
@@ -151,33 +151,33 @@ public void Parse_RepeatedColorChange_PicksLastSet()
 
         [Theory]
         // supported
-        [InlineData("\x1B[77mInfo", "Info")]
-        [InlineData("\x1B[77m\x1B[1m\x1B[2m\x1B[0mInfo\x1B[1m", "Info")]
-        [InlineData("\x1B[7mInfo", "Info")]
-        [InlineData("\x1B[40m\x1B[1m\x1B[33mwarn\x1B[39m\x1B[22m\x1B[49m:", "warn", ":")]
+        [InlineData("\e[77mInfo", "Info")]
+        [InlineData("\e[77m\e[1m\e[2m\e[0mInfo\e[1m", "Info")]
+        [InlineData("\e[7mInfo", "Info")]
+        [InlineData("\e[40m\e[1m\e[33mwarn\e[39m\e[22m\e[49m:", "warn", ":")]
         // unsupported: skips
-        [InlineData("Info\x1B[77m:", "Info", ":")]
-        [InlineData("Info\x1B[7m:", "Info", ":")]
+        [InlineData("Info\e[77m:", "Info", ":")]
+        [InlineData("Info\e[7m:", "Info", ":")]
         // treats as content
-        [InlineData("\x1B", "\x1B")]
-        [InlineData("\x1B ", "\x1B ")]
-        [InlineData("\x1Bm", "\x1Bm")]
-        [InlineData("\x1B m", "\x1B m")]
-        [InlineData("\x1Bxym", "\x1Bxym")]
-        [InlineData("\x1B[", "\x1B[")]
-        [InlineData("\x1B[m", "\x1B[m")]
-        [InlineData("\x1B[ ", "\x1B[ ")]
-        [InlineData("\x1B[ m", "\x1B[ m")]
-        [InlineData("\x1B[xym", "\x1B[xym")]
-        [InlineData("\x1B[7777m", "\x1B[7777m")]
-        [InlineData("\x1B\x1B\x1B", "\x1B\x1B\x1B")]
-        [InlineData("Message\x1B\x1B\x1B", "Message\x1B\x1B\x1B")]
-        [InlineData("\x1B\x1BMessage\x1B", "\x1B\x1BMessage\x1B")]
-        [InlineData("\x1B\x1B\x1BMessage", "\x1B\x1B\x1BMessage")]
-        [InlineData("Message\x1B ", "Message\x1B ")]
-        [InlineData("\x1BmMessage", "\x1BmMessage")]
-        [InlineData("\x1B[77m\x1B m\x1B[40m", "\x1B m")]
-        [InlineData("\x1B mMessage\x1Bxym", "\x1B mMessage\x1Bxym")]
+        [InlineData("\e", "\e")]
+        [InlineData("\e ", "\e ")]
+        [InlineData("\em", "\em")]
+        [InlineData("\e m", "\e m")]
+        [InlineData("\exym", "\exym")]
+        [InlineData("\e[", "\e[")]
+        [InlineData("\e[m", "\e[m")]
+        [InlineData("\e[ ", "\e[ ")]
+        [InlineData("\e[ m", "\e[ m")]
+        [InlineData("\e[xym", "\e[xym")]
+        [InlineData("\e[7777m", "\e[7777m")]
+        [InlineData("\e\e\e", "\e\e\e")]
+        [InlineData("Message\e\e\e", "Message\e\e\e")]
+        [InlineData("\e\eMessage\e", "\e\eMessage\e")]
+        [InlineData("\e\e\eMessage", "\e\e\eMessage")]
+        [InlineData("Message\e ", "Message\e ")]
+        [InlineData("\emMessage", "\emMessage")]
+        [InlineData("\e[77m\e m\e[40m", "\e m")]
+        [InlineData("\e mMessage\exym", "\e mMessage\exym")]
         public void Parse_ValidSupportedOrUnsupportedCodesInMessage_MessageParsedSuccessfully(string messageWithUnsupportedCode, params string[] output)
         {
             // Arrange

diff --git a/...ing.Console/tests/Microsoft.Extensions.Logging.Console.Tests/TextWriterExtensionsTests.cs b/...ing.Console/tests/Microsoft.Extensions.Logging.Console.Tests/TextWriterExtensionsTests.cs
@@ -16,7 +16,7 @@ public void WriteColoredMessage_WithForegroundEscapeCode_AndNoBackgroundColorSpe
             var message = "Request received";
             var expectedMessage = AnsiParser.GetForegroundColorEscapeCode(ConsoleColor.DarkGreen)
                 + message
-                + "\x1B[39m\x1B[22m"; //resets foreground color
+                + "\e[39m\e[22m"; //resets foreground color
             var textWriter = new StringWriter();
 
             // Act
@@ -33,7 +33,7 @@ public void WriteColoredMessage_WithBackgroundEscapeCode_AndNoForegroundColorSpe
             var message = "Request received";
             var expectedMessage = AnsiParser.GetBackgroundColorEscapeCode(ConsoleColor.Red)
                 + message
-                + "\x1B[49m"; //resets background color
+                + "\e[49m"; //resets background color
             var textWriter = new StringWriter();
 
             // Act
@@ -51,8 +51,8 @@ public void WriteColoredMessage_InOrder_WhenBothForegroundOrBackgroundColorsSpec
             var expectedMessage = AnsiParser.GetBackgroundColorEscapeCode(ConsoleColor.Red)
                 + AnsiParser.GetForegroundColorEscapeCode(ConsoleColor.DarkGreen)
                 + "Request received"
-                + "\x1B[39m\x1B[22m" //resets foreground color
-                + "\x1B[49m"; //resets background color
+                + "\e[39m\e[22m" //resets foreground color
+                + "\e[49m"; //resets background color
             var textWriter = new StringWriter();
 
             // Act

diff --git a/src/libraries/System.Console/src/System/IO/KeyParser.cs b/src/libraries/System.Console/src/System/IO/KeyParser.cs
@@ -8,7 +8,7 @@ namespace System.IO;
 
 internal static class KeyParser
 {
-    private const char Escape = '\u001B';
+    private const char Escape = '\e';
     private const char Delete = '\u007F';
     private const char VtSequenceEndTag = '~';
     private const char ModifierSeparator = ';';

diff --git a/src/libraries/System.Console/src/System/TerminalFormatStrings.cs b/src/libraries/System.Console/src/System/TerminalFormatStrings.cs
@@ -46,7 +46,7 @@ internal sealed class TerminalFormatStrings
     /// doesn't contain it (as appears to be the case with e.g. screen and tmux on Ubuntu), at the risk
     /// of outputting the sequence on some terminal that's not compatible.
     /// </remarks>
-    public const string CursorPositionReport = "\x1B[6n";
+    public const string CursorPositionReport = "\e[6n";
     /// <summary>
     /// The dictionary of keystring to ConsoleKeyInfo.
     /// Only some members of the ConsoleKeyInfo are used; in particular, the actual char is ignored.
@@ -210,13 +210,13 @@ private static string GetTitle(TermInfo.Database db)
             case "linux":
             case "rxvt":
             case "xterm":
-                return "\x1B]0;%p1%s\x07";
+                return "\e]0;%p1%s\x07";
             case "cygwin":
-                return "\x1B];%p1%s\x07";
+                return "\e];%p1%s\x07";
             case "konsole":
-                return "\x1B]30;%p1%s\x07";
+                return "\e]30;%p1%s\x07";
             case "screen":
-                return "\x1Bk%p1%s\x1B\\";
+                return "\ek%p1%s\e\\";
             default:
                 return string.Empty;
         }