forked from aziz/SublimeANSI
-
Notifications
You must be signed in to change notification settings - Fork 1
/
ansi.py
428 lines (352 loc) · 16.4 KB
/
ansi.py
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
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
# -*- coding: utf-8 -*-
import sublime
import sublime_plugin
import inspect
import os
import Default
import re
from collections import namedtuple
from functools import partial
AnsiDefinition = namedtuple("AnsiDefinition", "scope regex")
DEBUG = False
def debug(view, msg):
if DEBUG:
info = inspect.getframeinfo(inspect.stack()[1][0])
filepath = os.path.abspath(info.filename)
if view.name():
name = view.name()
elif view.file_name():
name = os.path.basename(view.file_name())
else:
name = "not named"
msg = re.sub(r'\n', "\n\t", msg)
print("File: \"{0}\", line {1}, window: {2}, view: {3}, file: {4}\n\t{5}".format(
filepath, # 0
info.lineno, # 1
view.window().id(), # 2
view.id(), # 3
name, # 4
msg # 5
))
def ansi_definitions(content=None):
settings = sublime.load_settings("ansi.sublime-settings")
if content is not None:
# collect colors from file content and make them a string
color_str = "{0}{1}{0}".format(
'\x1b',
'\x1b'.join(set(re.findall(
r'(\[[\d;]*m)', # find all possible colors
content
)))
)
# filter out unnecessary colors in user settings
bgs = [v for v in settings.get("ANSI_BG", []) if re.search(v['code'], color_str) is not None]
fgs = [v for v in settings.get("ANSI_FG", []) if re.search(v['code'], color_str) is not None]
else:
bgs = [v for v in settings.get("ANSI_BG", [])]
fgs = [v for v in settings.get("ANSI_FG", [])]
for bg in bgs:
for fg in fgs:
regex = r'(?:(?:{0}{1})|(?:{1}{0}))[^\x1b]*'.format(fg['code'], bg['code'])
scope = "{0}{1}".format(fg['scope'], bg['scope'])
yield AnsiDefinition(scope, regex)
class AnsiRegion(object):
def __init__(self, scope):
super(AnsiRegion, self).__init__()
self.scope = scope
self.regions = []
def add(self, a, b):
self.regions.append([a, b])
def cut_area(self, a, b):
begin = min(a, b)
end = max(a, b)
for n, (a, b) in enumerate(self.regions):
a = self.subtract_region(a, begin, end)
b = self.subtract_region(b, begin, end)
self.regions[n] = (a, b)
def shift(self, val):
for n, (a, b) in enumerate(self.regions):
self.regions[n] = (a + val, b + val)
def jsonable(self):
return {self.scope: self.regions}
@staticmethod
def subtract_region(p, begin, end):
if p < begin:
return p
elif p < end:
return begin
else:
return p - (end - begin)
class AnsiCommand(sublime_plugin.TextCommand):
def run(self, edit, regions=None, clear_before=False):
view = self.view
if view.settings().get("ansi_in_progres", False):
debug(view, "oops ... the ansi command is already in progress")
return
view.settings().set("ansi_in_progres", True)
# if the syntax has not already been changed to ansi this means the command has
# been run via the sublime console therefore the syntax must be changed manually
if view.settings().get("syntax") != "Packages/ANSIescape/ANSI.tmLanguage":
view.settings().set("syntax", "Packages/ANSIescape/ANSI.tmLanguage")
view.settings().set("ansi_enabled", True)
view.settings().set("color_scheme", "Packages/User/ANSIescape/ansi.tmTheme")
view.settings().set("draw_white_space", "none")
# save the view's original scratch and read only settings
if not view.settings().has("ansi_scratch"):
view.settings().set("ansi_scratch", view.is_scratch())
view.set_scratch(True)
if not view.settings().has("ansi_read_only"):
view.settings().set("ansi_read_only", view.is_read_only())
view.set_read_only(False)
if clear_before:
self._remove_ansi_regions()
if regions is None:
self._colorize_ansi_codes(edit)
else:
self._colorize_regions(regions)
view.settings().set("ansi_in_progres", False)
view.settings().set("ansi_size", view.size())
view.set_read_only(True)
def _colorize_regions(self, regions):
view = self.view
for scope, regions_points in regions.items():
regions = []
for a, b in regions_points:
regions.append(sublime.Region(a, b))
sum_regions = view.get_regions(scope) + regions
view.add_regions(scope, sum_regions, scope, '', sublime.DRAW_NO_OUTLINE | sublime.PERSISTENT)
def _colorize_ansi_codes(self, edit):
view = self.view
# removing unsupported ansi escape codes before going forward: 2m 4m 5m 7m 8m
ansi_unsupported_codes = view.find_all(r'(\x1b\[(0;)?(2|4|5|7|8)m)')
ansi_unsupported_codes.reverse()
for r in ansi_unsupported_codes:
view.replace(edit, r, "\x1b[1m")
content = view.substr(sublime.Region(0, view.size()))
for ansi in ansi_definitions(content):
ansi_regions = view.find_all(ansi.regex)
debug(view, "scope: {}\nregex: {}\nregions: {}\n----------\n".format(ansi.scope, ansi.regex, ansi_regions))
if ansi_regions:
sum_regions = view.get_regions(ansi.scope) + ansi_regions
view.add_regions(ansi.scope, sum_regions, ansi.scope, '', sublime.DRAW_NO_OUTLINE | sublime.PERSISTENT)
# removing the rest of ansi escape codes
ansi_codes = view.find_all(r'(\x1b\[[\d;]*m){1,}')
ansi_codes.reverse()
for r in ansi_codes:
view.erase(edit, r)
def _remove_ansi_regions(self):
view = self.view
for ansi in ansi_definitions():
view.erase_regions(ansi.scope)
class UndoAnsiCommand(sublime_plugin.WindowCommand):
def run(self):
view = self.window.active_view()
# if ansi is in progress or don't have ansi_in_progress setting
# don't run the command
if view.settings().get("ansi_in_progres", True):
debug(view, "oops ... the ansi command is already executing")
return
view.settings().set("ansi_in_progres", True)
# if the syntax has not already been changed from ansi this means the command has
# been run via the sublime console therefore the syntax must be changed manually
if view.settings().get("syntax") == "Packages/ANSIescape/ANSI.tmLanguage":
view.settings().set("syntax", "Packages/Text/Plain text.tmLanguage")
view.settings().erase("ansi_enabled")
view.settings().erase("color_scheme")
view.settings().erase("draw_white_space")
view.set_read_only(False)
settings = sublime.load_settings("ansi.sublime-settings")
view.run_command("undo")
for ansi in ansi_definitions():
view.erase_regions(ansi.scope)
# restore the view's original scratch and read only settings
view.set_scratch(view.settings().get("ansi_scratch", False))
view.settings().erase("ansi_scratch")
view.set_read_only(view.settings().get("ansi_read_only", False))
view.settings().erase("ansi_read_only")
view.settings().erase("ansi_in_progres")
view.settings().erase("ansi_size")
class AnsiEventListener(sublime_plugin.EventListener):
def on_new_async(self, view):
self.process_view_open(view)
def on_load_async(self, view):
self.process_view_open(view)
def on_pre_close(self, view):
self.process_view_close(view)
def process_view_open(self, view):
self._del_event_listeners(view)
self._add_event_listeners(view)
if view.settings().get("syntax") == "Packages/ANSIescape/ANSI.tmLanguage":
view.run_command("ansi")
def process_view_close(self, view):
self._del_event_listeners(view)
#if view.settings().get("syntax") == "Packages/ANSIescape/ANSI.tmLanguage":
# view.window().run_command("undo_ansi") ** this needs to be tested **
def detect_left_ansi(self, view):
sublime.set_timeout_async(partial(self.check_left_ansi, view), 50)
def check_left_ansi(self, view):
if not self._is_view_valid(view):
self._del_event_listeners(view)
return
if view.settings().get("syntax") != "Packages/ANSIescape/ANSI.tmLanguage":
return
if view.settings().get("ansi_in_progres", False):
debug(view, "ansi in progres")
sublime.set_timeout_async(partial(self.check_left_ansi, view), 50)
return
if view.settings().get("ansi_size", view.size()) != view.size():
debug(view, "ANSI view size changed. Running ansi command")
view.run_command("ansi", args={"clear_before": True})
debug(view, "ANSI cmd done and no codes left")
def detect_syntax_change(self, view):
if not self._is_view_valid(view):
self._del_event_listeners(view)
return
if view.settings().get("ansi_in_progres", False):
return
if view.settings().get("syntax") == "Packages/ANSIescape/ANSI.tmLanguage":
if not view.settings().has("ansi_enabled"):
debug(view, "Syntax change detected (running ansi command).")
view.run_command("ansi", args={"clear_before": True})
else:
if view.settings().has("ansi_enabled"):
debug(view, "Syntax change detected (running undo command).")
view.window().run_command("undo_ansi")
def _is_view_valid(self, view):
if view.window() is None:
return False
if view.window() not in sublime.windows():
return False
if view not in view.window().views():
return False
return True
def _add_event_listeners(self, view):
view.settings().add_on_change("CHECK_FOR_ANSI_SYNTAX", lambda: self.detect_syntax_change(view))
view.settings().add_on_change("CHECK_FOR_LEFT_ANSI", lambda: self.detect_left_ansi(view))
debug(view, "ANSIescape event listeners assigned to view.")
def _del_event_listeners(self, view):
view.settings().clear_on_change("CHECK_FOR_ANSI_SYNTAX")
view.settings().clear_on_change("CHECK_FOR_LEFT_ANSI")
debug(view, "ANSIescape event listener removed from view.")
class AnsiColorBuildCommand(Default.exec.ExecCommand):
process_trigger = "on_finish"
@classmethod
def update_build_settings(self, settings):
val = settings.get("ANSI_process_trigger", "on_finish")
if val in ["on_finish", "on_data"]:
self.process_trigger = val
else:
self.process_trigger = None
sublime.error_message("ANSIescape settings warning:\n\nThe setting ANSI_process_trigger has been set to an invalid value; must be one of 'on_finish' or 'on_data'.")
@classmethod
def clear_build_settings(self, settings):
self.process_trigger = None
def on_data_process(self, proc, data):
view = self.output_view
if not view.settings().get("syntax") == "Packages/ANSIescape/ANSI.tmLanguage":
super(AnsiColorBuildCommand, self).on_data(proc, data)
return
str_data = data.decode(self.encoding)
# replace unsupported ansi escape codes before going forward: 2m 4m 5m 7m 8m
unsupported_pattern = r'(\x1b\[(0;)?(2|4|5|7|8)m)'
str_data = re.sub(unsupported_pattern, "\x1b[1m", str_data)
# find all regions
ansi_regions = []
for ansi in ansi_definitions(str_data):
if re.search(ansi.regex, str_data):
reg = re.finditer(ansi.regex, str_data)
new_region = AnsiRegion(ansi.scope)
for m in reg:
new_region.add(*m.span())
ansi_regions.append(new_region)
# remove codes
remove_pattern = r'(\x1b\[[\d;]*m){1,}'
ansi_codes = re.finditer(remove_pattern, str_data)
ansi_codes = list(ansi_codes)
ansi_codes.reverse()
for c in ansi_codes:
to_remove = c.span()
for r in ansi_regions:
r.cut_area(*to_remove)
out_data = re.sub(remove_pattern, "", str_data)
# create json serialable region representation
json_ansi_regions = {}
shift_val = view.size()
for region in ansi_regions:
region.shift(shift_val)
json_ansi_regions.update(region.jsonable())
# send on_data without ansi codes
super(AnsiColorBuildCommand, self).on_data(proc, out_data.encode(self.encoding))
# send ansi command
view.run_command('ansi', args={"regions": json_ansi_regions})
def on_data(self, proc, data):
if self.process_trigger == "on_data":
self.on_data_process(proc, data)
else:
super(AnsiColorBuildCommand, self).on_data(proc, data)
def on_finished(self, proc):
super(AnsiColorBuildCommand, self).on_finished(proc)
if self.process_trigger == "on_finish":
view = self.output_view
if view.settings().get("syntax") == "Packages/ANSIescape/ANSI.tmLanguage":
view.run_command("ansi", args={"clear_before": True})
CS_TEMPLATE = """<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0"><dict><key>name</key><string>Ansi</string>
<key>settings</key><array><dict><key>settings</key><dict>
<key>background</key><string>%s</string>
<key>caret</key><string>%s</string>
<key>foreground</key><string>%s</string>
<key>gutter</key><string>%s</string>
<key>gutterForeground</key><string>%s</string>
<key>invisibles</key><string>%s</string>
<key>lineHighlight</key><string>%s</string>
<key>selection</key><string>%s</string>
</dict></dict>
%s</array></dict></plist>
"""
ANSI_SCOPE = "<dict><key>scope</key><string>{0}{1}</string><key>settings</key><dict><key>background</key><string>{2}</string><key>foreground</key><string>{3}</string>{4}</dict></dict>\n"
def generate_color_scheme(cs_file, settings):
print("Regenerating ANSI color scheme...")
cs_scopes = ""
for bg in settings.get("ANSI_BG", []):
for fg in settings.get("ANSI_FG", []):
if (bg.get('font_style') and bg['font_style'] == 'bold') or (fg.get('font_style') and fg['font_style'] == 'bold'):
font_style = "<key>fontStyle</key><string>bold</string>"
else:
font_style = ''
cs_scopes += ANSI_SCOPE.format(fg['scope'], bg['scope'], bg['color'], fg['color'], font_style)
g = settings.get("GENERAL")
vals = [g['background'], g['caret'], g['foreground'], g['gutter'], g['gutterForeground'], g['invisibles'], g['lineHighlight'], g['selection'], cs_scopes]
theme = CS_TEMPLATE % tuple(vals)
with open(cs_file, 'w') as color_scheme:
color_scheme.write(theme)
def plugin_loaded():
# load pluggin settings
settings = sublime.load_settings("ansi.sublime-settings")
# create ansi color scheme directory
ansi_cs_dir = os.path.join(sublime.packages_path(), "User", "ANSIescape")
if not os.path.exists(ansi_cs_dir):
os.makedirs(ansi_cs_dir)
# create ansi color scheme file
cs_file = os.path.join(ansi_cs_dir, "ansi.tmTheme")
if not os.path.isfile(cs_file):
generate_color_scheme(cs_file, settings)
# update the settings for the plugin
AnsiColorBuildCommand.update_build_settings(settings)
settings.add_on_change("ANSI_COLORS_CHANGE", lambda: generate_color_scheme(cs_file, settings))
settings.add_on_change("ANSI_TRIGGER_CHANGE", lambda: AnsiColorBuildCommand.update_build_settings(settings))
# update the setting for each view
for window in sublime.windows():
for view in window.views():
AnsiEventListener().process_view_open(view)
def plugin_unloaded():
# update the settings for the plugin
settings = sublime.load_settings("ansi.sublime-settings")
AnsiColorBuildCommand.clear_build_settings(settings)
settings.clear_on_change("ANSI_COLORS_CHANGE")
settings.clear_on_change("ANSI_TRIGGER_CHANGE")
# update the setting for each view
for window in sublime.windows():
for view in window.views():
AnsiEventListener().process_view_close(view)