[patchew-devel] [PATCH 8/9] ansi2html: add support for 16-color palette

From: Paolo Bonzini <pbonzini@xxxxxxxxxx>
To: patchew-devel@xxxxxxxxxxxxx
Date: Mon, 26 Feb 2018 12:27:21 +0100

This includes inverted and dimmed text.

Signed-off-by: Paolo Bonzini <pbonzini@xxxxxxxxxx>
---
patchew/logviewer.py | 53 ++++++++++++++++
static/css/ansi2html.css | 22 ++++++-
tests/test_ansi2html.py | 159 +++++++++++++++++++++++++++++++++++++++++++++--
3 files changed, 228 insertions(+), 6 deletions(-)

diff --git a/patchew/logviewer.py b/patchew/logviewer.py
index 8114eb6..e035d54 100644
--- a/patchew/logviewer.py
+++ b/patchew/logviewer.py
@@ -22,6 +22,8 @@ class ANSI2HTMLConverter(object):
 RE_OSC = r'].*?(?:\x1B\\|\x07)'
 RE_CONTROL = '\x1B(?:%s|%s|[^][])|\r\n|[\b\t\n\f\r]' % (RE_CSI, RE_OSC)
 RE = re.compile('(%s)|(%s)' % (RE_STRING, RE_CONTROL))
+ COLORS = [ "BLK", "RED", "GRN", "YEL", "BLU", "MAG", "CYN", "WHI",
+ "HIK", "HIR", "HIG", "HIY", "HIB", "HIM", "HIC", "HIW" ]

 ENTITIES = {
 '\x00' : '␀', '\x01' : '␁', '\x02' : '␂',
@@ -41,12 +43,16 @@ class ANSI2HTMLConverter(object):
 def __init__(self, white_bg=False):
 self.class_to_id = {}
 self.id_to_class = []
+ self.default_fg = 0 if white_bg else 7
+ self.default_bg = 7 if white_bg else 0
 self.cur_class = self._class_to_id("")
 self.prefix = '<pre class="ansi">'
 self._reset()
 self._reset_attrs()

 def _reset_attrs(self):
+ self.fg = None
+ self.bg = None
 self.dim = 0
 self.bold = 0
 self.italic = 0
@@ -161,6 +167,22 @@ class ANSI2HTMLConverter(object):
 self.inverse = 0
 elif arg == 29:
 self.strike = 0
+ elif (arg >= 30 and arg <= 37) or (arg >= 91 and arg <= 96):
+ # we use light colors by default, so 31..36 and 91..96 are the same
+ self.fg = arg % 10
+ elif arg == 39:
+ self.fg = None
+ elif (arg >= 40 and arg <= 47) or (arg >= 101 and arg <= 106):
+ # we use light colors by default, so 31..36 and 91..96 are the same
+ self.bg = arg % 10
+ elif arg == 49:
+ self.bg = None
+ elif arg == 90 or arg == 97:
+ # the remaining light colors: dark grey and white
+ self.fg = arg - 82
+ elif arg == 100 or arg == 107:
+ # the remaining light colors: dark grey and white
+ self.bg = arg - 92

 def _class_to_id(self, html_class):
 class_id = self.class_to_id.get(html_class, None)
@@ -170,8 +192,39 @@ class ANSI2HTMLConverter(object):
 self.id_to_class.append(html_class)
 return class_id

+ def _map_color(self, color, default, dim):
+ # map a color assigned by _do_one_csi_m to an index in the COLORS array
+
+ color = color if color is not None else default
+ if dim:
+ # must be foreground color
+ # unlike vte which has a "very dark" grey, for simplicity
+ # dark grey remains dark grey
+ return 8 if color == default or color == 8 else color&~8
+ else:
+ # use light colors by default, except for black and light grey
+ # (but see bold case in _compute_class)
+ return color if color == 0 or color == 7 else color|8
+
 def _compute_class(self):
+ fg = self._map_color(self.fg, self.default_fg, self.dim)
+ bg = self._map_color(self.bg, self.default_bg, False)
+
+ # apply inverse now: "inverse dim" affects the *background* color!
+ if self.inverse:
+ fg, bg = bg, fg
+
+ # bold turns foreground light grey into white
+ if fg == 7 and not self.dim and self.bold:
+ fg = 15
+
+ # now compute CSS classes
 classes = []
+ if fg != self.default_fg:
+ classes.append(self.COLORS[fg])
+ if bg != self.default_bg:
+ classes.append('B' + self.COLORS[bg])
+
 if self.bold:
 classes.append('BOLD')
 if self.italic:
diff --git a/static/css/ansi2html.css b/static/css/ansi2html.css
index fa656a6..5435844 100644
--- a/static/css/ansi2html.css
+++ b/static/css/ansi2html.css
@@ -1,5 +1,5 @@
/* For black and white background respectively: */
-.ansi {color:#e8e2d2}
+.ansi {color:#eee8d5}
/* .ansi {color:#000} */

.ansi>.BOLD {font-weight: bold}
@@ -7,3 +7,23 @@
.ansi>.UND {text-decoration: underline}
.ansi>.STR {text-decoration: line-through}
.ansi>.UNDSTR {text-decoration: underline line-through}
+
+/* 16-color palette. Default-intensity colors are based on Solarized,
+ * dimmed colors are just 2/3 of the default intensity.
+ */
+.ansi>.BLK {color:#000000} .ansi>.BBLK {background-color:#000000}
+.ansi>.RED {color:#93211f} .ansi>.BRED {background-color:#93211f}
+.ansi>.GRN {color:#596600} .ansi>.BGRN {background-color:#596600}
+.ansi>.YEL {color:#795b00} .ansi>.BYEL {background-color:#795b00}
+.ansi>.BLU {color:#484b83} .ansi>.BBLU {background-color:#484b83}
+.ansi>.MAG {color:#8d2457} .ansi>.BMAG {background-color:#8d2457}
+.ansi>.CYN {color:#1c6b65} .ansi>.BCYN {background-color:#1c6b65}
+.ansi>.WHI {color:#eee8d5} .ansi>.BWHI {background-color:#eee8d5}
+.ansi>.HIK {color:#586e75} .ansi>.BHIK {background-color:#586e75}
+.ansi>.HIR {color:#dc322f} .ansi>.BHIR {background-color:#dc322f}
+.ansi>.HIG {color:#859900} .ansi>.BHIG {background-color:#859900}
+.ansi>.HIY {color:#b58900} .ansi>.BHIY {background-color:#b58900}
+.ansi>.HIB {color:#6c71c4} .ansi>.BHIB {background-color:#6c71c4}
+.ansi>.HIM {color:#d33682} .ansi>.BHIM {background-color:#d33682}
+.ansi>.HIC {color:#2aa198} .ansi>.BHIC {background-color:#2aa198}
+.ansi>.HIW {color:#fdf6e3} .ansi>.BHIW {background-color:#fdf6e3}
diff --git a/tests/test_ansi2html.py b/tests/test_ansi2html.py
index f0ee0ad..b264d85 100644
--- a/tests/test_ansi2html.py
+++ b/tests/test_ansi2html.py
@@ -94,37 +94,186 @@ class ANSI2HTMLTest(unittest.TestCase):
 self.assertWhiteBg('A\x1b[0mBC', 'ABC')
 self.assertBlackBg('\x1b[30;41m', '')
 self.assertWhiteBg('\x1b[30;41m', '')
- self.assertBlackBg('\x1b[1mABC', 'ABC')
+ self.assertBlackBg('\x1b[1mABC', 'ABC')
 self.assertWhiteBg('\x1b[1mABC', 'ABC')
- self.assertBlackBg('A\x1b[1mBC', 'ABC')
+ self.assertBlackBg('A\x1b[1mBC', 'ABC')
 self.assertWhiteBg('A\x1b[1mBC', 'ABC')
- self.assertBlackBg('\x1b[1mAB\x1b[0mC', 'ABC')
+ self.assertBlackBg('\x1b[1mAB\x1b[0mC', 'ABC')
 self.assertWhiteBg('\x1b[1mAB\x1b[0mC', 'ABC')
- self.assertBlackBg('A\x1b[1mB\x1b[0mC', 'ABC')
+ self.assertBlackBg('A\x1b[1mB\x1b[0mC', 'ABC')
 self.assertWhiteBg('A\x1b[1mB\x1b[0mC', 'ABC')
- self.assertBlackBg('A\x1b[1mB\x1b[0m\x1b[1mC', 'ABC')
+ self.assertBlackBg('A\x1b[1mB\x1b[0m\x1b[1mC', 'ABC')
 self.assertWhiteBg('A\x1b[1mB\x1b[0m\x1b[1mC', 'ABC')

+ # basic dim and dim+bold tests
+ def test_dim_bold(self):
+ self.assertBlackBg('\x1b[2mABC', 'ABC')
+ self.assertWhiteBg('\x1b[2mABC', 'ABC')
+ self.assertBlackBg('\x1b[2;1mABC', 'ABC')
+ self.assertWhiteBg('\x1b[2;1mABC', 'ABC')
+ self.assertBlackBg('\x1b[1;21mABC', 'ABC')
+ self.assertWhiteBg('\x1b[1;21mABC', 'ABC')
+ self.assertBlackBg('\x1b[2;21mABC', 'ABC')
+ self.assertWhiteBg('\x1b[2;21mABC', 'ABC')
+ self.assertBlackBg('\x1b[1;22mABC', 'ABC')
+ self.assertWhiteBg('\x1b[1;22mABC', 'ABC')
+ self.assertBlackBg('\x1b[2;22mABC', 'ABC')
+ self.assertWhiteBg('\x1b[2;22mABC', 'ABC')
+
+ # background and foreground colors
+ def test_colors(self):
+ self.assertBlackBg('\x1b[31mABC', 'ABC')
+ self.assertWhiteBg('\x1b[31mABC', 'ABC')
+ self.assertBlackBg('\x1b[31;1mABC', 'ABC')
+ self.assertWhiteBg('\x1b[31;1mABC', 'ABC')
+ self.assertBlackBg('\x1b[31;2mABC', 'ABC')
+ self.assertWhiteBg('\x1b[31;2mABC', 'ABC')
+ self.assertBlackBg('\x1b[31;2;1mABC', 'ABC')
+ self.assertWhiteBg('\x1b[31;2;1mABC', 'ABC')
+ self.assertBlackBg('\x1b[31mAB\x1b[39mC', 'ABC')
+ self.assertWhiteBg('\x1b[31mAB\x1b[39mC', 'ABC')
+ self.assertBlackBg('\x1b[30mABC', 'ABC')
+ self.assertWhiteBg('\x1b[30mABC', 'ABC')
+ self.assertBlackBg('\x1b[30;1mABC', 'ABC')
+ self.assertWhiteBg('\x1b[30;1mABC', 'ABC')
+ self.assertBlackBg('\x1b[30;2mABC', 'ABC')
+ self.assertWhiteBg('\x1b[30;2mABC', 'ABC')
+ self.assertBlackBg('\x1b[30;2;1mABC', 'ABC')
+ self.assertWhiteBg('\x1b[30;2;1mABC', 'ABC')
+ self.assertBlackBg('\x1b[37mABC', 'ABC')
+ self.assertWhiteBg('\x1b[37mABC', 'ABC')
+ self.assertBlackBg('\x1b[37;1mABC', 'ABC')
+ self.assertWhiteBg('\x1b[37;1mABC', 'ABC')
+ self.assertBlackBg('\x1b[37;2mABC', 'ABC')
+ self.assertWhiteBg('\x1b[37;2mABC', 'ABC')
+ self.assertBlackBg('\x1b[37;2;1mABC', 'ABC')
+ self.assertWhiteBg('\x1b[37;2;1mABC', 'ABC')
+ self.assertBlackBg('\x1b[46mABC', 'ABC')
+ self.assertWhiteBg('\x1b[46mABC', 'ABC')
+ self.assertBlackBg('\x1b[46mAB\x1b[49mC', 'ABC')
+ self.assertWhiteBg('\x1b[46mAB\x1b[49mC', 'ABC')
+ self.assertBlackBg('\x1b[46;31mABC', 'ABC')
+ self.assertWhiteBg('\x1b[46;31mABC', 'ABC')
+ self.assertBlackBg('\x1b[46;31;1mABC', 'ABC')
+ self.assertWhiteBg('\x1b[46;31;1mABC', 'ABC')
+ self.assertBlackBg('\x1b[46;31;2mABC', 'ABC')
+ self.assertWhiteBg('\x1b[46;31;2mABC', 'ABC')
+ self.assertBlackBg('\x1b[46;31;2;1mABC', 'ABC')
+ self.assertWhiteBg('\x1b[46;31;2;1mABC', 'ABC')
+ self.assertBlackBg('\x1b[46;37mABC', 'ABC')
+ self.assertWhiteBg('\x1b[46;37mABC', 'ABC')
+ self.assertBlackBg('\x1b[46;37;1mABC', 'ABC')
+ self.assertWhiteBg('\x1b[46;37;1mABC', 'ABC')
+ self.assertBlackBg('\x1b[46;37;2mABC', 'ABC')
+ self.assertWhiteBg('\x1b[46;37;2mABC', 'ABC')
+ self.assertBlackBg('\x1b[46;37;2;1mABC', 'ABC')
+ self.assertWhiteBg('\x1b[46;37;2;1mABC', 'ABC')
+
+ # more colors
+ def test_colors_extra(self):
+ self.assertBlackBg('\x1b[90mABC', 'ABC')
+ self.assertWhiteBg('\x1b[90mABC', 'ABC')
+ self.assertBlackBg('\x1b[90;1mABC', 'ABC')
+ self.assertWhiteBg('\x1b[90;1mABC', 'ABC')
+ self.assertBlackBg('\x1b[90;2mABC', 'ABC')
+ self.assertWhiteBg('\x1b[90;2mABC', 'ABC')
+ self.assertBlackBg('\x1b[90;2;1mABC', 'ABC')
+ self.assertWhiteBg('\x1b[90;2;1mABC', 'ABC')
+ self.assertBlackBg('\x1b[97;1mABC', 'ABC')
+ self.assertWhiteBg('\x1b[97;1mABC', 'ABC')
+ self.assertBlackBg('\x1b[97;2mABC', 'ABC')
+ self.assertWhiteBg('\x1b[97;2mABC', 'ABC')
+ self.assertBlackBg('\x1b[97;2;1mABC', 'ABC')
+ self.assertWhiteBg('\x1b[97;2;1mABC', 'ABC')
+ self.assertBlackBg('\x1b[100mABC', 'ABC')
+ self.assertWhiteBg('\x1b[100mABC', 'ABC')
+
 # italic, underline, strikethrough
 def test_text_variants(self):
 self.assertBlackBg('\x1b[3mABC', 'ABC')
 self.assertWhiteBg('\x1b[3mABC', 'ABC')
+ self.assertBlackBg('\x1b[3;31mABC', 'ABC')
+ self.assertWhiteBg('\x1b[3;31mABC', 'ABC')
 self.assertBlackBg('\x1b[3mAB\x1b[23mC', 'ABC')
 self.assertWhiteBg('\x1b[3mAB\x1b[23mC', 'ABC')
+ self.assertBlackBg('\x1b[3;31mAB\x1b[23mC', 'ABC')
+ self.assertWhiteBg('\x1b[3;31mAB\x1b[23mC', 'ABC')
 self.assertBlackBg('\x1b[4mABC', 'ABC')
 self.assertWhiteBg('\x1b[4mABC', 'ABC')
+ self.assertBlackBg('\x1b[4;31mABC', 'ABC')
+ self.assertWhiteBg('\x1b[4;31mABC', 'ABC')
 self.assertBlackBg('\x1b[4mAB\x1b[24mC', 'ABC')
 self.assertWhiteBg('\x1b[4mAB\x1b[24mC', 'ABC')
+ self.assertBlackBg('\x1b[4;31mAB\x1b[24mC', 'ABC')
+ self.assertWhiteBg('\x1b[4;31mAB\x1b[24mC', 'ABC')
 self.assertBlackBg('\x1b[9mABC', 'ABC')
 self.assertWhiteBg('\x1b[9mABC', 'ABC')
 self.assertBlackBg('\x1b[9mAB\x1b[29mC', 'ABC')
 self.assertWhiteBg('\x1b[9mAB\x1b[29mC', 'ABC')
+ self.assertBlackBg('\x1b[9;31mAB\x1b[29mC', 'ABC')
+ self.assertWhiteBg('\x1b[9;31mAB\x1b[29mC', 'ABC')
+ self.assertBlackBg('\x1b[9;31mABC', 'ABC')
+ self.assertWhiteBg('\x1b[9;31mABC', 'ABC')
 self.assertBlackBg('\x1b[4;9mABC', 'ABC')
 self.assertWhiteBg('\x1b[4;9mABC', 'ABC')
+ self.assertBlackBg('\x1b[4;9;31mABC', 'ABC')
+ self.assertWhiteBg('\x1b[4;9;31mABC', 'ABC')
 self.assertBlackBg('\x1b[4;9mAB\x1b[24mC', 'ABC')
 self.assertWhiteBg('\x1b[4;9mAB\x1b[24mC', 'ABC')
 self.assertBlackBg('\x1b[4;9mAB\x1b[29mC', 'ABC')
 self.assertWhiteBg('\x1b[4;9mAB\x1b[29mC', 'ABC')

+ # invert
+ def test_invert(self):
+ self.assertBlackBg('\x1b[7mABC', 'ABC')
+ self.assertWhiteBg('\x1b[7mABC', 'ABC')
+ self.assertBlackBg('\x1b[7mABC\r', 'ABC')
+ self.assertWhiteBg('\x1b[7mABC\r', 'ABC')
+ self.assertBlackBg('\x1b[30;7mABC', 'ABC')
+ self.assertWhiteBg('\x1b[30;7mABC', 'ABC')
+ self.assertBlackBg('\x1b[30;1;7mABC', 'ABC')
+ self.assertWhiteBg('\x1b[30;1;7mABC', 'ABC')
+ self.assertBlackBg('\x1b[37;7mABC', 'ABC')
+ self.assertWhiteBg('\x1b[37;7mABC', 'ABC')
+ self.assertBlackBg('\x1b[37;1;7mABC', 'ABC')
+ self.assertWhiteBg('\x1b[37;1;7mABC', 'ABC')
+ self.assertBlackBg('\x1b[46;7mABC', 'ABC')
+ self.assertWhiteBg('\x1b[46;7mABC', 'ABC')
+ self.assertBlackBg('\x1b[46;1;7mABC', 'ABC')
+ self.assertWhiteBg('\x1b[46;1;7mABC', 'ABC')
+ self.assertBlackBg('\x1b[46;31;7mABC', 'ABC')
+ self.assertWhiteBg('\x1b[46;31;7mABC', 'ABC')
+ self.assertBlackBg('\x1b[46;31;7mAB\x1b[27mC', 'ABC')
+ self.assertWhiteBg('\x1b[46;31;7mAB\x1b[27mC', 'ABC')
+ self.assertBlackBg('\x1b[36;47;1;7mABC', 'ABC')
+ self.assertWhiteBg('\x1b[36;47;1;7mABC', 'ABC')
+ self.assertBlackBg('\x1b[36;47;2;7mABC', 'ABC')
+ self.assertWhiteBg('\x1b[36;47;2;7mABC', 'ABC')
+ self.assertBlackBg('\x1b[36;47;2;1;7mABC', 'ABC')
+ self.assertWhiteBg('\x1b[36;47;2;1;7mABC', 'ABC')
+ self.assertBlackBg('\x1b[90;7mABC', 'ABC')
+ self.assertWhiteBg('\x1b[90;7mABC', 'ABC')
+ self.assertBlackBg('\x1b[90;1;7mABC', 'ABC')
+ self.assertWhiteBg('\x1b[90;1;7mABC', 'ABC')
+ self.assertBlackBg('\x1b[100;7mABC', 'ABC')
+ self.assertWhiteBg('\x1b[100;7mABC', 'ABC')
+ self.assertBlackBg('\x1b[100;1;7mABC', 'ABC')
+ self.assertWhiteBg('\x1b[100;1;7mABC', 'ABC')
+ # vte uses BHIK here??
+ self.assertBlackBg('\x1b[47;30;1;7mABC', 'ABC')
+ self.assertWhiteBg('\x1b[47;30;1;7mABC', 'ABC')
+
+ # combining cursor movement and formatting
+ def test_movement_and_formatting(self):
+ self.assertBlackBg('\x1b[42m\tabc', ' abc')
+ self.assertWhiteBg('\x1b[42m\tabc', ' abc')
+ self.assertBlackBg('abc\x1b[42m\x1b[1Kabc', ' abc')
+ self.assertWhiteBg('abc\x1b[42m\x1b[1Kabc', ' abc')
+ self.assertBlackBg('\x1b[7m\tabc', ' abc')
+ self.assertWhiteBg('\x1b[7m\tabc', ' abc')
+ self.assertBlackBg('abc\x1b[7m\x1b[1Kabc', ' abc')
+ self.assertWhiteBg('abc\x1b[7m\x1b[1Kabc', ' abc')
+
+
if __name__ == '__main__':
 unittest.main()
--
2.14.3

References:
- [patchew-devel] [PATCH 0/9] ANSI to HTML conversion for the log viewer
  - From: Paolo Bonzini

[patchew-devel] [PATCH 8/9] ansi2html: add support for 16-color palette

Other related posts: