microsoft
/
DbgShell
зеркало из https://github.com/microsoft/DbgShell.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

move ConsoleControl's AnsiColorWriter to separate file 

(for easier comparison with other copies of that code)
This commit is contained in:
Dan Thompson (SBS) 2019-04-16 08:07:02 -07:00 коммит произвёл Dan Thompson
Родитель a7cabf4355
Коммит fcf6689127
3 изменённых файлов: 297 добавлений и 285 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

294
DbgShell/ConsoleControl.AnsiColorWriter.cs Normal file
Просмотреть файл

@ -0,0 +1,294 @@
using System;
using System.Collections.Generic;
using ConsoleHandle = Microsoft.Win32.SafeHandles.SafeFileHandle;
namespace MS.DbgShell
{
// (unindented a level to simplify the diff with other similar copies of this code)
internal static partial class ConsoleControl
{
// This class interprets ANSI escape sequences to alter the color of console output. Only
// a limited set of control sequences are supported, namely a subset of SGR (Select
// Graphics Rendition) commands.
//
// See:
//
// http://bjh21.me.uk/all-escapes/all-escapes.txt
// http://en.wikipedia.org/wiki/ISO/IEC_6429
// http://en.wikipedia.org/wiki/ISO_6429
// http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
//
internal class AnsiColorWriter
{
private const char CSI = '\x9b'; // "Control Sequence Initiator"
private ConsoleColor DefaultForeground;
private ConsoleColor DefaultBackground;
private Dictionary< char, Action< List< int > > > m_commands;
private ControlSequenceParseState m_state;
// We support control sequences being broken across calls to Write methods. This
// struct keeps track of state in between calls.
private struct ControlSequenceParseState
{
private int m_accum;
private List< int > m_list;
// True if we are in the middle of parsing a sequence. Useful for when sequences
// are broken across multiple calls.
public bool Parsing { get; private set; }
// This can tolerate multiple Begin calls without destroying state.
public void Begin()
{
if( !Parsing )
{
Parsing = true;
m_list = new List< int >();
}
}
public void Accum( int digit )
{
m_accum *= 10;
m_accum += digit;
}
public void Enter()
{
m_list.Add( m_accum );
m_accum = 0;
}
public List< int > Finish()
{
Enter();
Parsing = false;
List< int > list = m_list;
m_list = null;
return list;
}
/// <summary>
/// To recover from bad input.
/// </summary>
public void Reset()
{
Parsing = false;
m_list = null;
m_accum = 0;
}
} // end class ControlSequenceParseState
public AnsiColorWriter()
{
DefaultForeground = ConsoleControl.ForegroundColor;
DefaultBackground = ConsoleControl.BackgroundColor;
m_commands = new Dictionary< char, Action< List< int > > >()
{
{ 'm', _SelectGraphicsRendition },
};
} // end constructor
public void Write( ConsoleHandle handle, string s )
{
int startIndex = 0;
if( m_state.Parsing )
{
// Need to continue.
startIndex = _HandleControlSequence( s, -1 );
}
int escIndex = s.IndexOf( CSI, startIndex );
while( escIndex >= 0 )
{
//Tool.WL( "escIndex: {0}, startIndex: {1}", escIndex, startIndex );
string chunk = s.Substring( startIndex, escIndex - startIndex );
//Console.Write( chunk );
ConsoleControl._RealWriteConsole( handle, chunk );
startIndex = _HandleControlSequence( s, escIndex );
escIndex = s.IndexOf( CSI, startIndex );
}
if( !(startIndex >= s.Length) )
{
//Console.Write( s.Substring( startIndex ) );
ConsoleControl._RealWriteConsole( handle, s.Substring( startIndex ) );
}
} // end Write()
/// <summary>
/// Returns the index of the next character after the escape sequence and code(s).
/// </summary>
private int _HandleControlSequence( string s, int escIndex )
{
m_state.Begin(); // we may actually be continuing...
char c;
int curIndex = escIndex;
while( ++curIndex < s.Length )
{
c = s[ curIndex ];
if( (c >= '0') && (c <= '9') )
{
m_state.Accum( ((int) c) - 0x30 );
continue;
}
else if( ';' == c )
{
m_state.Enter();
continue;
}
else if( (c >= '@') && (c <= '~') )
{
List< int > args = m_state.Finish();
_ProcessCommand( c, args );
return curIndex + 1;
}
else
{
// You're supposed to be able to have anonther character, like a space
// (0x20) before the command code character, but I'm not going to do that.
// TODO: Unfortunately, we can get into this scenario. Say somebody wrote a string to the
// output stream, and that string had control sequences. And say then somebody tried to process
// that string in a pipeline, for instance tried to find some property on it, that didn't
// exist, causing an error to be written, where the "target object" is the string... and stuff
// maybe gets truncated or ellipsis-ized... and then we're hosed. What should I do about this?
// Try to sanitize higher-level output? Seems daunting... Just reset state and ignore it? Hm.
m_state.Reset();
throw new ArgumentException( String.Format( "Invalid command sequence character at position {0} (0x{1:x}).", curIndex, (int) c ) );
}
}
// Finished parsing the whole string--the control sequence must be broken across
// strings.
return curIndex;
} // end _HandleControlSequence()
private void _ProcessCommand( char commandChar, List< int > args )
{
Action< List< int > > action;
if( !m_commands.TryGetValue( commandChar, out action ) )
{
// See big comment above the other throw above.
m_state.Reset();
throw new NotSupportedException( String.Format( "The command code '{0}' (0x{1:x}) is not supported.", commandChar, (int) commandChar ) );
}
action( args );
} // end _ProcessCommand()
// Info sources:
// http://bjh21.me.uk/all-escapes/all-escapes.txt
// http://en.wikipedia.org/wiki/ISO/IEC_6429
// http://en.wikipedia.org/wiki/ISO_6429
// http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
private static ConsoleColor[] AnsiNormalColorMap =
{
// Foreground Background
ConsoleColor.Black, // 30 40
ConsoleColor.DarkRed, // 31 41
ConsoleColor.DarkGreen, // 32 42
ConsoleColor.DarkYellow, // 33 43
ConsoleColor.DarkBlue, // 34 44
ConsoleColor.DarkMagenta, // 35 45
ConsoleColor.DarkCyan, // 36 46
ConsoleColor.Gray // 37 47
};
private static ConsoleColor[] AnsiBrightColorMap =
{ // Foreground Background
ConsoleColor.DarkGray, // 90 100
ConsoleColor.Red, // 91 101
ConsoleColor.Green, // 92 102
ConsoleColor.Yellow, // 93 103
ConsoleColor.Blue, // 94 104
ConsoleColor.Magenta, // 95 105
ConsoleColor.Cyan, // 96 106
ConsoleColor.White // 97 107
};
// In addition to the color codes, I've added support for two additional
// (non-standard) codes:
//
// 56: Push fg/bg color pair
// 57: Pop fg/bg color pair
//
private void _SelectGraphicsRendition( List< int > args )
{
if( 0 == args.Count )
args.Add( 0 ); // no args counts as a reset
foreach( int arg in args )
{
_ProcessSgrCode( arg );
}
} // end _SelectGraphicsRendition()
private class ColorPair
{
public ConsoleColor Foreground { get; private set; }
public ConsoleColor Background { get; private set; }
public ColorPair( ConsoleColor foreground, ConsoleColor background )
{
Foreground = foreground;
Background = background;
}
}
private Stack< ColorPair > m_colorStack = new Stack< ColorPair >();
private void _ProcessSgrCode( int code )
{
if( 0 == code )
{
ConsoleControl.ForegroundColor = DefaultForeground;
ConsoleControl.BackgroundColor = DefaultBackground;
}
else if( (code <= 37) && (code >= 30) )
{
ConsoleControl.ForegroundColor = AnsiNormalColorMap[ (code - 30) ];
}
else if( (code <= 47) && (code >= 40) )
{
ConsoleControl.BackgroundColor = AnsiNormalColorMap[ (code - 40) ];
}
else if( (code <= 97) && (code >= 90) )
{
ConsoleControl.ForegroundColor = AnsiBrightColorMap[ (code - 90) ];
}
else if( (code <= 107) && (code >= 100) )
{
ConsoleControl.BackgroundColor = AnsiBrightColorMap[ (code - 100) ];
}
else if( 56 == code ) // NON-STANDARD (I made this one up)
{
m_colorStack.Push( new ColorPair( ConsoleControl.ForegroundColor, ConsoleControl.BackgroundColor ) );
}
else if( 57 == code ) // NON-STANDARD (I made this one up)
{
ColorPair cp = m_colorStack.Pop();
ConsoleControl.ForegroundColor = cp.Foreground;
ConsoleControl.BackgroundColor = cp.Background;
}
else
{
throw new NotSupportedException( String.Format( "SGR code '{0}' not supported.", code ) );
}
} // end _ProcessSgrCode()
} // end class AnsiColorWriter
} // class ConsoleControl
} // namespace

285
DbgShell/ConsoleControl.cs
Просмотреть файл

@ -45,7 +45,7 @@ namespace MS.DbgShell
/// ///
/// </summary> /// </summary>
internal static class ConsoleControl internal static partial class ConsoleControl
{ {
#region structs #region structs
@ -3755,289 +3755,6 @@ namespace MS.DbgShell
} }
} }
} // end property BackgroundColor } // end property BackgroundColor
// This class interprets ANSI escape sequences to alter the color of console output. Only
// a limited set of control sequences are supported, namely a subset of SGR (Select
// Graphics Rendition) commands.
//
// See:
//
// http://bjh21.me.uk/all-escapes/all-escapes.txt
// http://en.wikipedia.org/wiki/ISO/IEC_6429
// http://en.wikipedia.org/wiki/ISO_6429
// http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
//
internal class AnsiColorWriter
{
private const char CSI = '\x9b'; // "Control Sequence Initiator"
private ConsoleColor DefaultForeground;
private ConsoleColor DefaultBackground;
private Dictionary< char, Action< List< int > > > m_commands;
private ControlSequenceParseState m_state;
// We support control sequences being broken across calls to Write methods. This
// struct keeps track of state in between calls.
private struct ControlSequenceParseState
{
private int m_accum;
private List< int > m_list;
// True if we are in the middle of parsing a sequence. Useful for when sequences
// are broken across multiple calls.
public bool Parsing { get; private set; }
// This can tolerate multiple Begin calls without destroying state.
public void Begin()
{
if( !Parsing )
{
Parsing = true;
m_list = new List< int >();
}
}
public void Accum( int digit )
{
m_accum *= 10;
m_accum += digit;
}
public void Enter()
{
m_list.Add( m_accum );
m_accum = 0;
}
public List< int > Finish()
{
Enter();
Parsing = false;
List< int > list = m_list;
m_list = null;
return list;
}
/// <summary>
/// To recover from bad input.
/// </summary>
public void Reset()
{
Parsing = false;
m_list = null;
m_accum = 0;
}
} // end class ControlSequenceParseState
public AnsiColorWriter()
{
DefaultForeground = ConsoleControl.ForegroundColor;
DefaultBackground = ConsoleControl.BackgroundColor;
m_commands = new Dictionary< char, Action< List< int > > >()
{
{ 'm', _SelectGraphicsRendition },
};
} // end constructor
public void Write( ConsoleHandle handle, string s )
{
int startIndex = 0;
if( m_state.Parsing )
{
// Need to continue.
startIndex = _HandleControlSequence( s, -1 );
}
int escIndex = s.IndexOf( CSI, startIndex );
while( escIndex >= 0 )
{
//Tool.WL( "escIndex: {0}, startIndex: {1}", escIndex, startIndex );
string chunk = s.Substring( startIndex, escIndex - startIndex );
//Console.Write( chunk );
ConsoleControl._RealWriteConsole( handle, chunk );
startIndex = _HandleControlSequence( s, escIndex );
escIndex = s.IndexOf( CSI, startIndex );
}
if( !(startIndex >= s.Length) )
{
//Console.Write( s.Substring( startIndex ) );
ConsoleControl._RealWriteConsole( handle, s.Substring( startIndex ) );
}
} // end Write()
/// <summary>
/// Returns the index of the next character after the escape sequence and code(s).
/// </summary>
private int _HandleControlSequence( string s, int escIndex )
{
m_state.Begin(); // we may actually be continuing...
char c;
int curIndex = escIndex;
while( ++curIndex < s.Length )
{
c = s[ curIndex ];
if( (c >= '0') && (c <= '9') )
{
m_state.Accum( ((int) c) - 0x30 );
continue;
}
else if( ';' == c )
{
m_state.Enter();
continue;
}
else if( (c >= '@') && (c <= '~') )
{
List< int > args = m_state.Finish();
_ProcessCommand( c, args );
return curIndex + 1;
}
else
{
// You're supposed to be able to have anonther character, like a space
// (0x20) before the command code character, but I'm not going to do that.
// TODO: Unfortunately, we can get into this scenario. Say somebody wrote a string to the
// output stream, and that string had control sequences. And say then somebody tried to process
// that string in a pipeline, for instance tried to find some property on it, that didn't
// exist, causing an error to be written, where the "target object" is the string... and stuff
// maybe gets truncated or ellipsis-ized... and then we're hosed. What should I do about this?
// Try to sanitize higher-level output? Seems daunting... Just reset state and ignore it? Hm.
m_state.Reset();
throw new ArgumentException( String.Format( "Invalid command sequence character at position {0} (0x{1:x}).", curIndex, (int) c ) );
}
}
// Finished parsing the whole string--the control sequence must be broken across
// strings.
return curIndex;
} // end _HandleControlSequence()
private void _ProcessCommand( char commandChar, List< int > args )
{
Action< List< int > > action;
if( !m_commands.TryGetValue( commandChar, out action ) )
{
// See big comment above the other throw above.
m_state.Reset();
throw new NotSupportedException( String.Format( "The command code '{0}' (0x{1:x}) is not supported.", commandChar, (int) commandChar ) );
}
action( args );
} // end _ProcessCommand()
// Info sources:
// http://bjh21.me.uk/all-escapes/all-escapes.txt
// http://en.wikipedia.org/wiki/ISO/IEC_6429
// http://en.wikipedia.org/wiki/ISO_6429
// http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
private static ConsoleColor[] AnsiNormalColorMap =
{
// Foreground Background
ConsoleColor.Black, // 30 40
ConsoleColor.DarkRed, // 31 41
ConsoleColor.DarkGreen, // 32 42
ConsoleColor.DarkYellow, // 33 43
ConsoleColor.DarkBlue, // 34 44
ConsoleColor.DarkMagenta, // 35 45
ConsoleColor.DarkCyan, // 36 46
ConsoleColor.Gray // 37 47
};
private static ConsoleColor[] AnsiBrightColorMap =
{ // Foreground Background
ConsoleColor.DarkGray, // 90 100
ConsoleColor.Red, // 91 101
ConsoleColor.Green, // 92 102
ConsoleColor.Yellow, // 93 103
ConsoleColor.Blue, // 94 104
ConsoleColor.Magenta, // 95 105
ConsoleColor.Cyan, // 96 106
ConsoleColor.White // 97 107
};
// In addition to the color codes, I've added support for two additional
// (non-standard) codes:
//
// 56: Push fg/bg color pair
// 57: Pop fg/bg color pair
//
private void _SelectGraphicsRendition( List< int > args )
{
if( 0 == args.Count )
args.Add( 0 ); // no args counts as a reset
foreach( int arg in args )
{
_ProcessSgrCode( arg );
}
} // end _SelectGraphicsRendition()
private class ColorPair
{
public ConsoleColor Foreground { get; private set; }
public ConsoleColor Background { get; private set; }
public ColorPair( ConsoleColor foreground, ConsoleColor background )
{
Foreground = foreground;
Background = background;
}
}
private Stack< ColorPair > m_colorStack = new Stack< ColorPair >();
private void _ProcessSgrCode( int code )
{
if( 0 == code )
{
ConsoleControl.ForegroundColor = DefaultForeground;
ConsoleControl.BackgroundColor = DefaultBackground;
}
else if( (code <= 37) && (code >= 30) )
{
ConsoleControl.ForegroundColor = AnsiNormalColorMap[ (code - 30) ];
}
else if( (code <= 47) && (code >= 40) )
{
ConsoleControl.BackgroundColor = AnsiNormalColorMap[ (code - 40) ];
}
else if( (code <= 97) && (code >= 90) )
{
ConsoleControl.ForegroundColor = AnsiBrightColorMap[ (code - 90) ];
}
else if( (code <= 107) && (code >= 100) )
{
ConsoleControl.BackgroundColor = AnsiBrightColorMap[ (code - 100) ];
}
else if( 56 == code ) // NON-STANDARD (I made this one up)
{
m_colorStack.Push( new ColorPair( ConsoleControl.ForegroundColor, ConsoleControl.BackgroundColor ) );
}
else if( 57 == code ) // NON-STANDARD (I made this one up)
{
ColorPair cp = m_colorStack.Pop();
ConsoleControl.ForegroundColor = cp.Foreground;
ConsoleControl.BackgroundColor = cp.Background;
}
else
{
throw new NotSupportedException( String.Format( "SGR code '{0}' not supported.", code ) );
}
} // end _ProcessSgrCode()
} // end class AnsiColorWriter
} }
} // namespace } // namespace

1
DbgShell/DbgShell.csproj
Просмотреть файл

@ -86,6 +86,7 @@
<Compile Include="ColorHostUserInterfaceSecurity.cs" /> <Compile Include="ColorHostUserInterfaceSecurity.cs" />
<Compile Include="ColorUserInterfacePromptForChoice.cs" /> <Compile Include="ColorUserInterfacePromptForChoice.cs" />
<Compile Include="CommandLineParameterParser.cs" /> <Compile Include="CommandLineParameterParser.cs" />
<Compile Include="ConsoleControl.AnsiColorWriter.cs" />
<Compile Include="ConsoleControl.cs" /> <Compile Include="ConsoleControl.cs" />
<Compile Include="ConsoleTextWriter.cs" /> <Compile Include="ConsoleTextWriter.cs" />
<Compile Include="HostUtilities.cs" /> <Compile Include="HostUtilities.cs" />