#!/usr/bin/env python # License: GPLv3 Copyright: 2024, Kovid Goyal from kitty.fast_data_types import TEXT_SIZE_CODE, wcswidth from . import BaseTest, parse_bytes from . import draw_multicell as multicell class TestMulticell(BaseTest): def test_multicell(self): test_multicell(self) def test_multicell(self: TestMulticell) -> None: from kitty.tab_bar import as_rgb from kitty.window import as_text def as_ansi(): return as_text(s, as_ansi=True) def ac(x_, y_, **assertions): # assert cell cell = s.cpu_cells(y_, x_) msg = f'Assertion failed for cell at ({x_}, {y_})\n{cell}\n' def ae(key): if key not in assertions: return if key in cell: val = cell[key] else: mcd = cell['mcd'] if mcd is None: raise AssertionError(f'{msg}Unexpectedly not a multicell') val = mcd[key] if assertions[key] != val: raise AssertionError(f'{msg}{assertions[key]!r} != {val!r}') ae('x') ae('y') ae('width') ae('scale') ae('subscale_n') ae('subscale_d') ae('vertical_align') ae('text') ae('natural_width') if 'cursor' in assertions: self.ae(assertions['cursor'], (s.cursor.x, s.cursor.y), msg) if 'is_multicell' in assertions: q = cell['mcd'] if assertions['is_multicell']: if q is None: raise AssertionError(f'{msg}Unexpectedly not a multicell') else: if q is not None: raise AssertionError(f'{msg}Unexpectedly is a multicell') def count_multicells(with_text=''): ans = 0 for y in range(s.lines): for x in range(s.columns): c = s.cpu_cells(y, x) if c['mcd'] is not None and (not with_text or c['text'] == with_text): ans += 1 return ans def line_text(y): def ct(c): if c['text']: return c['text'] if c['mcd']: return '_' return '\0' return ''.join(ct(c) for c in s.cpu_cells(y)) def assert_line(text, y=None): if y is None: y = s.cursor.y self.ae(text, line_text(y)) def assert_cursor_at(x, y): self.ae((s.cursor.x, s.cursor.y), (x, y)) s = self.create_screen(cols=6, lines=6) # Test basic multicell drawing s.reset() ac(0, 0, is_multicell=False) multicell(s, 'a') ac(0, 0, is_multicell=True, width=1, scale=1, subscale_n=0, x=0, y=0, text='a', natural_width=True, cursor=(1, 0)) ac(0, 1, is_multicell=False), ac(1, 0, is_multicell=False), ac(1, 1, is_multicell=False) s.draw('莊') ac(0, 0, is_multicell=True, width=1, scale=1, subscale_n=0, x=0, y=0, text='a', natural_width=True) ac(1, 0, is_multicell=True, width=2, scale=1, subscale_n=0, x=0, y=0, text='莊', natural_width=True, cursor=(3, 0)) ac(2, 0, is_multicell=True, width=2, scale=1, subscale_n=0, x=1, y=0, text='', natural_width=True) for x in range(s.columns): ac(x, 1, is_multicell=False) s.cursor.x = 0 multicell(s, 'a', width=2, scale=2, subscale_n=3) ac(0, 0, is_multicell=True, width=2, scale=2, subscale_n=3, x=0, y=0, text='a', natural_width=False, cursor=(4, 0)) for x in range(1, 4): ac(x, 0, is_multicell=True, width=2, scale=2, subscale_n=3, x=x, y=0, text='', natural_width=False) for x in range(0, 4): ac(x, 1, is_multicell=True, width=2, scale=2, subscale_n=3, x=x, y=1, text='', natural_width=False) # Test draw with cursor in a multicell s.reset() s.draw('莊') s.cursor.x -= 1 s.draw('a'), ac(0, 0, is_multicell=False), ac(1, 0, is_multicell=False) s.reset() s.draw('莊') s.cursor.x = 0 s.draw('a'), ac(0, 0, is_multicell=False), ac(1, 0, is_multicell=False) s.reset() multicell(s, 'a', width=2, scale=2, subscale_n=3, subscale_d=4) s.cursor.x, s.cursor.y = 1, 1 s.draw('b') self.ae(8, count_multicells()) assert_cursor_at(5, 1) self.assertIn('b', str(s.linebuf)) s.reset() s.cursor.x = 1 s.draw('莊') s.cursor.x = 0 s.draw('莊') ac(2, 0, is_multicell=False, text=' ') s.reset() multicell(s, 'a', scale=2) s.cursor.x += 1 multicell(s, 'b', scale=2) s.draw('莊') assert_cursor_at(2, 2) self.assertIn('莊', str(s.linebuf)) s.reset() multicell(s, 'a', scale=2) s.cursor.x += 1 multicell(s, 'b', scale=2) s.draw('\u2716\ufe0f') assert_cursor_at(2, 2) s.reset() s.draw('莊') s.cursor.x = 0 s.draw('b') self.ae(str(s.line(0)), 'b') s.reset() s.draw('莊') s.cursor.x = 1 s.draw('b') self.ae(str(s.line(0)), ' b') # Test multicell with cursor in a multicell def big_a(x, y=0, spaces=False, skip=False): s.reset() s.cursor.x, s.cursor.y = 1, 1 multicell(s, 'a', scale=4) ac(1, 1, x=0, y=0, text='a', scale=4, width=1) s.cursor.x, s.cursor.y = x, y multicell(s, 'b', scale=2) if skip: self.ae(20, count_multicells()) assert_cursor_at(2, 4) self.assertIn('a', str(s.linebuf)) else: ac(x, y, text='b') self.ae(4, count_multicells()) for x_ in range(1, 5): ac(x_, 4, text=' ' if spaces else '') for y in (0, 1): big_a(0, y), big_a(1, y), big_a(2, y, spaces=True) big_a(2, 2, skip=True), big_a(5, 1, skip=True) # Test multicell with combining and flag codepoints and default width def seq(text, *expected): s.reset() multicell(s, text) i = iter(expected) for x in range(s.cursor.x): cell = s.cpu_cells(0, x) if cell['x'] == 0: q = next(i) ac(x, 0, text=q, width=wcswidth(q)) seq('ab', 'a', 'b') flag = '\U0001f1ee\U0001f1f3' seq(flag + 'CD', flag, 'C', 'D') seq('àn̂X', 'à', 'n̂', 'X') seq('\U0001f1eea', '\U0001f1ee', 'a') del flag, seq # Test insert chars with multicell (aka right shift) s.reset() s.draw('a') s.cursor.x = 0 s.insert_characters(1) assert_line('\0a\0\0\0\0') s.reset() multicell(s, 'a', width=2) s.cursor.x = 0 s.insert_characters(1) assert_line('\0a_\0\0\0') s.reset() multicell(s, 'a', width=2) s.cursor.x = 0 s.insert_characters(2) assert_line('\0\0a_\0\0') s.reset() multicell(s, 'a', width=2) s.cursor.x = 1 s.insert_characters(1) assert_line('\0\0\0\0\0\0') s.reset() s.cursor.x = 3 multicell(s, 'a', width=2) s.cursor.x = 0 s.insert_characters(1) assert_line('\0\0\0\0a_') s.reset() s.cursor.x = s.columns - 2 multicell(s, 'a', width=2) s.cursor.x = 0 s.insert_characters(1) assert_line('\0\0\0\0\0\0') # multiline s.reset() s.draw('a') multicell(s, 'b', scale=2) assert_line('ab_\0\0\0') assert_line('\0__\0\0\0', 1) s.cursor.x, s.cursor.y = 0, 0 s.insert_characters(1) assert_line('\0a\0\0\0\0') assert_line('\0\0\0\0\0\0', 1) s.reset() multicell(s, 'a', scale=2) s.cursor.x = 3 s.insert_characters(1) assert_line('a_\0\0\0\0') assert_line('__\0\0\0\0', 1) # Test delete chars with multicell (aka left shift) s.reset() multicell(s, 'a', width=2) s.cursor.x = 0 s.delete_characters(1) assert_line('\0\0\0\0\0\0') s.reset() multicell(s, 'a', width=2) s.cursor.x = 1 s.delete_characters(1) assert_line('\0\0\0\0\0\0') s.reset() s.draw('ab') multicell(s, 'a', width=2) s.cursor.x = 0 s.delete_characters(2) assert_line('a_\0\0\0\0') s.reset() s.draw('a'), multicell(s, 'b', width=2), s.draw('c') s.cursor.x = 0 s.delete_characters(1) assert_line('b_c\0\0\0') s.reset() s.draw('a'), multicell(s, 'b', width=2), s.draw('c') s.cursor.x = 0 s.delete_characters(1) assert_line('b_c\0\0\0') s.reset(), s.draw('a'), multicell(s, 'b', width=2), s.draw('c') s.cursor.x = 0 s.delete_characters(2) assert_line('\0c\0\0\0\0') s.reset(), s.draw('a'), multicell(s, 'b', width=2), s.draw('c') s.cursor.x = 1 s.delete_characters(1) assert_line('a\0c\0\0\0') s.reset(), s.draw('a'), multicell(s, 'b', width=2), s.draw('c') s.cursor.x = 2 s.delete_characters(1) assert_line('a\0c\0\0\0') # multiline s.reset() s.draw('a'), multicell(s, 'b', scale=2), s.draw('c') assert_line('ab_c\0\0') assert_line('\0__\0\0\0', 1) s.cursor.x, s.cursor.y = 0, 0 s.delete_characters(1) assert_line('\0\0c\0\0\0') assert_line('\0\0\0\0\0\0', 1) s.reset() multicell(s, 'a', scale=2) s.cursor.x = 3 s.delete_characters(1) assert_line('a_\0\0\0\0') assert_line('__\0\0\0\0', 1) # Erase characters (aka replace with null) s.reset() s.cursor.x = 1 s.draw('a'), multicell(s, 'b', scale=2), s.draw('c') s.cursor.x = 0 s.erase_characters(1) assert_line('\0ab_c\0') s.erase_characters(2) assert_line('\0\0b_c\0') assert_line('\0\0__\0\0', 1) s.erase_characters(3) assert_line('\0\0\0\0c\0') assert_line('\0\0\0\0\0\0', 1) # Erase in line for x in (1, 2): s.reset() s.draw('a'), multicell(s, 'b', scale=2), s.draw('c') s.cursor.x = x s.erase_in_line(0) assert_line('a\0\0\0\0\0') s.reset() s.draw('a'), multicell(s, 'b', width=2), s.draw('c') s.cursor.x = x s.erase_in_line(1) assert_line('\0\0\0c\0\0') s.reset() s.draw('a'), multicell(s, 'b', scale=2), s.draw('c') s.erase_in_line(2) for y in (0, 1): assert_line('\0\0\0\0\0\0', y) s.reset() s.draw('a'), multicell(s, 'b', scale=2), s.draw('c') s.cursor.y = 1 s.erase_in_line(2) assert_line('a\0\0c\0\0', 0) assert_line('\0\0\0\0\0\0', 1) # Clear scrollback s.reset() s.draw('a'), multicell(s, 'b', scale=2), s.draw('c') for i in range(s.lines): s.index() s.cursor.y = 0 assert_line('\0__\0\0\0') s.clear_scrollback() assert_line('\0\0\0\0\0\0') # Erase in display for x in (1, 2): s.reset(), s.draw('a'), multicell(s, 'b', scale=2), s.draw('c') s.cursor.x = x s.erase_in_display(0) assert_line('a\0\0\0\0\0') s.reset(), s.draw('a'), multicell(s, 'b', scale=2), s.draw('c') s.cursor.x, s.cursor.y = 2, 1 s.erase_in_display(0) assert_line('a\0\0c\0\0', 0) assert_line('\0\0\0\0\0\0', 1) s.reset(), s.draw('a'), multicell(s, 'b', scale=2), s.draw('c') for i in range(s.lines): s.index() s.erase_in_display(22) assert_line('ab_c\0\0', -2) assert_line('\0__\0\0\0', -1) self.ae(s.historybuf.line(1).as_ansi(), f'a\x1b]{TEXT_SIZE_CODE};w=1:s=2;b\x07c') self.ae(s.historybuf.line(0).as_ansi(), ' ') # Insert lines s.reset() multicell(s, 'a', scale=2) s.cursor.x, s.cursor.y = 0, s.lines - 2 multicell(s, 'b', scale=2) s.cursor.x, s.cursor.y = 0, 1 s.insert_lines(1) for y in range(s.lines): assert_line('\0' * s.columns, y) s.reset() multicell(s, 'a', scale=2) s.insert_lines(2) assert_line('\0' * s.columns, 0) assert_line('a_\0\0\0\0', 2) # Delete lines s.reset() multicell(s, 'a', scale=2) s.cursor.y = 1 multicell(s, 'b', scale=2) s.delete_lines(1) for y in range(s.lines): assert_line('\0' * s.columns, y) # ansi output def ta(expected): actual = as_ansi().rstrip()[3:] self.ae(expected, actual) s.reset() parse_bytes(s, actual.encode()) actual2 = as_ansi().rstrip()[3:] self.ae(expected, actual2) s.reset() s.reset() multicell(s, 'a', width=2, scale=3, subscale_n=1, subscale_d=2, vertical_align=1) ta('\x1b]66;w=2:s=3:n=1:d=2;a\x07') s.draw('a') multicell(s, 'b', width=2) s.draw('c') ta('a\x1b]66;w=2;b\x07c') multicell(s, 'a') s.cursor.fg = as_rgb(0xffffff) multicell(s, 'b') ta('a\x1b[38:2:255:255:255mb') multicell(s, 'a', scale=2) multicell(s, 'b', scale=2) ta('\x1b]66;w=1:s=2;ab\x07') multicell(s, 'a', scale=2) s.cursor.fg = as_rgb(0xffffff) multicell(s, 'b', scale=2) ta('\x1b]66;w=1:s=2;a\x07\x1b[38:2:255:255:255m\x1b]66;w=1:s=2;b\x07\n\x1b[m\x1b[38:2:255:255:255m') multicell(s, 'a', scale=3) multicell(s, 'b', scale=2) ta('\x1b]66;w=1:s=3;a\x07\x1b]66;w=1:s=2;b\x07')