1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
|
import unittest
from asciimatics.parsers import AsciimaticsParser, AnsiTerminalParser, ControlCodeParser, Parser
import asciimatics.constants as constants
class TestParsers(unittest.TestCase):
def test_controlcode_parser(self):
"""
Check ControlCodeParser works as expected
"""
parser = ControlCodeParser()
parser.reset("\0\b\ra[", colours=(1, 2, 3))
tokens = parser.parse()
self.assertEqual(next(tokens), (0, Parser.CHANGE_COLOURS, (1, 2, 3)))
self.assertEqual(next(tokens), (0, Parser.DISPLAY_TEXT, "^@"))
self.assertEqual(next(tokens), (1, Parser.DISPLAY_TEXT, "^H"))
self.assertEqual(next(tokens), (2, Parser.DISPLAY_TEXT, "^M"))
self.assertEqual(next(tokens), (3, Parser.DISPLAY_TEXT, "a"))
self.assertEqual(next(tokens), (4, Parser.DISPLAY_TEXT, "["))
def test_asciimatics_parser(self):
"""
Check AsciimaticsParser works as expected.
"""
parser = AsciimaticsParser()
parser.reset("a${1}b${2,1}c${3,2,4}de${7}", None)
tokens = parser.parse()
self.assertEqual(next(tokens), (0, Parser.DISPLAY_TEXT, "a"))
self.assertEqual(next(tokens), (1, Parser.CHANGE_COLOURS, (1, 0, None)))
self.assertEqual(next(tokens), (1, Parser.DISPLAY_TEXT, "b"))
self.assertEqual(next(tokens), (6, Parser.CHANGE_COLOURS, (2, 1, None)))
self.assertEqual(next(tokens), (6, Parser.DISPLAY_TEXT, "c"))
self.assertEqual(next(tokens), (13, Parser.CHANGE_COLOURS, (3, 2, 4)))
self.assertEqual(next(tokens), (13, Parser.DISPLAY_TEXT, "d"))
self.assertEqual(next(tokens), (22, Parser.DISPLAY_TEXT, "e"))
self.assertEqual(next(tokens), (23, Parser.CHANGE_COLOURS, (7, 0, None)))
with self.assertRaises(StopIteration):
next(tokens)
def test_ansi_terminal_parser_colours(self):
"""
Check AnsiTerminalParser basic colours work as expected.
"""
parser = AnsiTerminalParser()
parser.reset("a\x1B[23ab\x1B[0mc\x1B[1md\x1B[2me\x1B[7mf\x1B[27mg\x1B[31;42mh\x1B[m", None)
tokens = parser.parse()
# Normal text
self.assertEqual(next(tokens), (0, Parser.DISPLAY_TEXT, "a"))
# Unknown escape code
self.assertEqual(next(tokens), (1, Parser.DISPLAY_TEXT, "b"))
# Reset
self.assertEqual(next(tokens), (7, Parser.CHANGE_COLOURS, (7, constants.A_NORMAL, 0)))
self.assertEqual(next(tokens), (7, Parser.DISPLAY_TEXT, "c"))
# Bold
self.assertEqual(next(tokens), (12, Parser.CHANGE_COLOURS, (7, constants.A_BOLD, 0)))
self.assertEqual(next(tokens), (12, Parser.DISPLAY_TEXT, "d"))
# Normal
self.assertEqual(next(tokens), (17, Parser.CHANGE_COLOURS, (7, constants.A_NORMAL, 0)))
self.assertEqual(next(tokens), (17, Parser.DISPLAY_TEXT, "e"))
# Inverse
self.assertEqual(next(tokens), (22, Parser.CHANGE_COLOURS, (7, constants.A_REVERSE, 0)))
self.assertEqual(next(tokens), (22, Parser.DISPLAY_TEXT, "f"))
# Unset inverse
self.assertEqual(next(tokens), (27, Parser.CHANGE_COLOURS, (7, constants.A_NORMAL, 0)))
self.assertEqual(next(tokens), (27, Parser.DISPLAY_TEXT, "g"))
# Standard colours, using multiple parameters
self.assertEqual(next(tokens), (33, Parser.CHANGE_COLOURS, (constants.COLOUR_RED, constants.A_NORMAL, constants.COLOUR_GREEN)))
self.assertEqual(next(tokens), (33, Parser.DISPLAY_TEXT, "h"))
# Final escape sequence with no visible text is returned with no text.
self.assertEqual(next(tokens), (42, Parser.CHANGE_COLOURS, (constants.COLOUR_WHITE, constants.A_NORMAL, constants.COLOUR_BLACK)))
with self.assertRaises(StopIteration):
next(tokens)
def test_ansi_terminal_parser_def_colours(self):
"""
Check AnsiTerminalParser default colours work as expected.
"""
parser = AnsiTerminalParser()
parser.reset("a\x1B[39mb\x1B[49mc", None)
tokens = parser.parse()
# Normal text
self.assertEqual(next(tokens), (0, Parser.DISPLAY_TEXT, "a"))
# Default foreground colour
self.assertEqual(next(tokens), (1, Parser.CHANGE_COLOURS, (constants.COLOUR_DEFAULT, None, None)))
self.assertEqual(next(tokens), (1, Parser.DISPLAY_TEXT, "b"))
# Default background colour
self.assertEqual(next(tokens), (7, Parser.CHANGE_COLOURS, (constants.COLOUR_DEFAULT, None, constants.COLOUR_DEFAULT)))
self.assertEqual(next(tokens), (7, Parser.DISPLAY_TEXT, "c"))
def test_ansi_terminal_parser_palette(self):
"""
Check AnsiTerminalParser colour palettes work as expected.
"""
parser = AnsiTerminalParser()
parser.reset(
"\x1B[38;1ma\x1B[38;5;17mb\x1B[48;2;1;2;3mc\x1B[48;5;54md\x1B[999me\x1B[93m\x1B[104m", None)
tokens = parser.parse()
# Bad colour scheme - ignore
self.assertEqual(next(tokens), (0, Parser.DISPLAY_TEXT, "a"))
# Standard colour palette
self.assertEqual(next(tokens), (8, Parser.CHANGE_COLOURS, (17, None, None)))
self.assertEqual(next(tokens), (8, Parser.DISPLAY_TEXT, "b"))
# RGB colour scheme - ignore
self.assertEqual(next(tokens), (19, Parser.DISPLAY_TEXT, "c"))
# Standard colour palette
self.assertEqual(next(tokens), (33, Parser.CHANGE_COLOURS, (17, None, 54)))
self.assertEqual(next(tokens), (33, Parser.DISPLAY_TEXT, "d"))
# Unknown parameter
self.assertEqual(next(tokens), (44, Parser.DISPLAY_TEXT, "e"))
# Intense colour palette
self.assertEqual(next(tokens), (51, Parser.CHANGE_COLOURS, (11, None, 54)))
self.assertEqual(next(tokens), (51, Parser.CHANGE_COLOURS, (11, None, 12)))
def test_ansi_terminal_parser_cursor(self):
"""
Check AnsiTerminalParser cursor movement work as expected.
"""
parser = AnsiTerminalParser()
parser.reset("aa\x08b\rc\x1B[Cdd\x1B[De\x1B[A\x1B[B\x1B[1;2H\x1B[?25h\x1B[?25l\r", None)
tokens = parser.parse()
# Normal text...
self.assertEqual(next(tokens), (0, Parser.DISPLAY_TEXT, "a"))
self.assertEqual(next(tokens), (1, Parser.DISPLAY_TEXT, "a"))
# Backspace and overwrite.
self.assertEqual(next(tokens), (2, Parser.MOVE_RELATIVE, (-1, 0)))
self.assertEqual(next(tokens), (2, Parser.DISPLAY_TEXT, "b"))
# Carriage return and overwrite
self.assertEqual(next(tokens), (4, Parser.MOVE_ABSOLUTE, (0, None)))
self.assertEqual(next(tokens), (4, Parser.DISPLAY_TEXT, "c"))
# Move cursor forwards and append.
self.assertEqual(next(tokens), (6, Parser.MOVE_RELATIVE, (1, 0)))
self.assertEqual(next(tokens), (6, Parser.DISPLAY_TEXT, "d"))
self.assertEqual(next(tokens), (10, Parser.DISPLAY_TEXT, "d"))
# Move cursor backwards and overwrite.
self.assertEqual(next(tokens), (11, Parser.MOVE_RELATIVE, (-1, 0)))
self.assertEqual(next(tokens), (11, Parser.DISPLAY_TEXT, "e"))
# Move cursor up and down.
self.assertEqual(next(tokens), (15, Parser.MOVE_RELATIVE, (0, -1)))
self.assertEqual(next(tokens), (15, Parser.MOVE_RELATIVE, (0, 1)))
# Move cursor to location
self.assertEqual(next(tokens), (15, Parser.MOVE_ABSOLUTE, (1, 0)))
# Show/hide cursor
self.assertEqual(next(tokens), (15, Parser.SHOW_CURSOR, True))
self.assertEqual(next(tokens), (15, Parser.SHOW_CURSOR, False))
# Trailing Carriage return
self.assertEqual(next(tokens), (15, Parser.MOVE_ABSOLUTE, (0, None)))
def test_ansi_terminal_parser_delete(self):
"""
Check AnsiTerminalParser delete operations work as expected.
"""
parser = AnsiTerminalParser()
# Delete to end of line
parser.reset("abcde\x08\x08\x08\x1B[K", None)
tokens = parser.parse()
self.assertEqual(next(tokens), (0, Parser.DISPLAY_TEXT, "a"))
self.assertEqual(next(tokens), (1, Parser.DISPLAY_TEXT, "b"))
self.assertEqual(next(tokens), (2, Parser.DISPLAY_TEXT, "c"))
self.assertEqual(next(tokens), (3, Parser.DISPLAY_TEXT, "d"))
self.assertEqual(next(tokens), (4, Parser.DISPLAY_TEXT, "e"))
self.assertEqual(next(tokens), (5, Parser.MOVE_RELATIVE, (-1, 0)))
self.assertEqual(next(tokens), (5, Parser.MOVE_RELATIVE, (-1, 0)))
self.assertEqual(next(tokens), (5, Parser.MOVE_RELATIVE, (-1, 0)))
self.assertEqual(next(tokens), (5, Parser.DELETE_LINE, 0))
with self.assertRaises(StopIteration):
next(tokens)
# Delete to start of line
parser.reset("abcde\x1B[1K", None)
tokens = parser.parse()
self.assertEqual(next(tokens), (0, Parser.DISPLAY_TEXT, "a"))
self.assertEqual(next(tokens), (1, Parser.DISPLAY_TEXT, "b"))
self.assertEqual(next(tokens), (2, Parser.DISPLAY_TEXT, "c"))
self.assertEqual(next(tokens), (3, Parser.DISPLAY_TEXT, "d"))
self.assertEqual(next(tokens), (4, Parser.DISPLAY_TEXT, "e"))
self.assertEqual(next(tokens), (5, Parser.DELETE_LINE, 1))
with self.assertRaises(StopIteration):
next(tokens)
# Delete line
parser.reset("abcde\x1B[2K", None)
tokens = parser.parse()
self.assertEqual(next(tokens), (0, Parser.DISPLAY_TEXT, "a"))
self.assertEqual(next(tokens), (1, Parser.DISPLAY_TEXT, "b"))
self.assertEqual(next(tokens), (2, Parser.DISPLAY_TEXT, "c"))
self.assertEqual(next(tokens), (3, Parser.DISPLAY_TEXT, "d"))
self.assertEqual(next(tokens), (4, Parser.DISPLAY_TEXT, "e"))
self.assertEqual(next(tokens), (5, Parser.DELETE_LINE, 2))
with self.assertRaises(StopIteration):
next(tokens)
# Delete char
parser.reset("abcde\x08\x08\x08\x1B[P", None)
tokens = parser.parse()
self.assertEqual(next(tokens), (0, Parser.DISPLAY_TEXT, "a"))
self.assertEqual(next(tokens), (1, Parser.DISPLAY_TEXT, "b"))
self.assertEqual(next(tokens), (2, Parser.DISPLAY_TEXT, "c"))
self.assertEqual(next(tokens), (3, Parser.DISPLAY_TEXT, "d"))
self.assertEqual(next(tokens), (4, Parser.DISPLAY_TEXT, "e"))
self.assertEqual(next(tokens), (5, Parser.MOVE_RELATIVE, (-1, 0)))
self.assertEqual(next(tokens), (5, Parser.MOVE_RELATIVE, (-1, 0)))
self.assertEqual(next(tokens), (5, Parser.MOVE_RELATIVE, (-1, 0)))
self.assertEqual(next(tokens), (5, Parser.DELETE_CHARS, 1))
with self.assertRaises(StopIteration):
next(tokens)
def test_ansi_terminal_parser_errors(self):
"""
Check AnsiTerminalParser handles unsupported encodings gracefully.
"""
parser = AnsiTerminalParser()
parser.reset("a\x1BZb\x01c", None)
tokens = parser.parse()
# Ignore unknown escape and next letter
self.assertEqual(next(tokens), (0, Parser.DISPLAY_TEXT, "a"))
self.assertEqual(next(tokens), (1, Parser.DISPLAY_TEXT, "b"))
# ANSI art uses control codes for special characters - check we just blank them.
self.assertEqual(next(tokens), (4, Parser.DISPLAY_TEXT, " "))
# Back to normal.
self.assertEqual(next(tokens), (5, Parser.DISPLAY_TEXT, "c"))
def test_ansi_terminal_parser_tab(self):
"""
Check AnsiTerminalParser handles tabs.
"""
parser = AnsiTerminalParser()
parser.reset("\x09", None)
tokens = parser.parse()
self.assertEqual(next(tokens), (0, Parser.NEXT_TAB, None))
def test_ansi_terminal_parser_clear(self):
"""
Check AnsiTerminalParser clears screen.
"""
parser = AnsiTerminalParser()
parser.reset("\x1B[2J", None)
tokens = parser.parse()
self.assertEqual(next(tokens), (0, Parser.CLEAR_SCREEN, None))
def test_ansi_terminal_parser_os_cmd(self):
"""
Check AnsiTerminalParser removes OS commands.
"""
parser = AnsiTerminalParser()
parser.reset("a\x1B]do something;stuff:to^ignore\x07b", None)
tokens = parser.parse()
self.assertEqual(next(tokens), (0, Parser.DISPLAY_TEXT, "a"))
self.assertEqual(next(tokens), (1, Parser.DISPLAY_TEXT, "b"))
def test_ansi_terminal_parser_bell(self):
"""
Check AnsiTerminalParser handles bell.
"""
parser = AnsiTerminalParser()
parser.reset("\x07", None)
tokens = parser.parse()
with self.assertRaises(StopIteration):
next(tokens)
def test_ansi_terminal_parser_start_colour(self):
"""
Check AnsiTerminalParser uses the starting colours.
"""
parser = AnsiTerminalParser()
parser.reset("a", colours=(1,2,3))
tokens = parser.parse()
self.assertEqual(next(tokens), (0, Parser.CHANGE_COLOURS, (1, 2, 3)))
self.assertEqual(next(tokens), (0, Parser.DISPLAY_TEXT, "a"))
def test_ansi_terminal_parser_unknown(self):
"""
Check AnsiTerminalParser ignores unknown codes.
"""
parser = AnsiTerminalParser()
parser.reset("a\x1B[2345£", None)
tokens = parser.parse()
self.assertEqual(next(tokens), (0, Parser.DISPLAY_TEXT, "a"))
with self.assertRaises(StopIteration):
next(tokens)
parser.reset("a\x1B", None)
tokens = parser.parse()
self.assertEqual(next(tokens), (0, Parser.DISPLAY_TEXT, "a"))
with self.assertRaises(StopIteration):
next(tokens)
|
