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 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
|
import GPS
from modules import Module
try:
# While building the doc, we might not have gi.repository
from gi.repository import Gtk, GLib, Gdk, Pango
from pygps import get_gtk_buffer, is_editor_visible
except ImportError:
pass
import re
class HighlighterModule(Module):
highlighters = {}
preferences = {}
def init_highlighting(self, f):
highlighter = self.highlighters.get(f.language(), None)
if isinstance(highlighter, Highlighter):
ed = GPS.EditorBuffer.get(f, open=False)
if ed:
gtk_ed = get_gtk_buffer(ed)
if not gtk_ed.highlighting_initialized:
highlighter.init_highlighting(ed)
highlighter.gtk_highlight(gtk_ed)
def setup(self):
for ed in GPS.EditorBuffer.list():
if is_editor_visible(ed):
self.init_highlighting(ed.file())
def preferences_changed(self):
for pref in self.preferences.values():
if pref.tag:
propagate_change(pref)
def context_changed(self, ctx):
if ctx is not None:
if ctx.file() is not None:
ed = GPS.EditorBuffer.get(open=False)
if ed:
self.init_highlighting(ed.file())
def file_edited(self, f):
"""
This hook is called when a new file editor is being opened
"""
self.init_highlighting(f)
#############
# Utilities #
#############
null_span = (-1, -1)
def to_tuple(gtk_iter):
"""
Transform the gtk_iter passed as parameter into a tuple representation
:type gtk_iter: Gtk.TextIter
:rtype (int, int)
"""
return (
gtk_iter.get_line(),
gtk_iter.get_line_offset()
)
def iter_from_tuple(gtk_ed, tuple_instance):
"""
Recreate a Gtk.TextIter from a tuple
:type gtk_ed: Gtk.TextBuffer
:type tuple_instance: (int, int)
:rtype Gtk.TextIter
"""
return gtk_ed.get_iter_at_line_index(*tuple_instance)
def iter_to_str(gtk_iter):
"""
Return a better string representation of a text iter
:type gtk_iter: Gtk.TextIter
"""
return "<TextIter {0} {1}>".format(*to_tuple(gtk_iter))
def iter_eq(iter_1, iter_2):
"""
Structural comparison for Gtk.TextIter
:type iter_1: Gtk.TextIter
:type iter_2: Gtk.TextIter
:rtype: bool
"""
return iter_1.to_tuple() == iter_2.to_tuple()
def tag_to_str(gtk_tag):
return "<TextTag {0}>".format(gtk_tag.props.name)
def make_wrapper(method_name):
fn = getattr(Gtk.TextIter, method_name)
def wrapper(gtk_iter, *args, **kwargs):
new_iter = gtk_iter.copy()
fn(new_iter, *args, **kwargs)
return new_iter
return wrapper
def to_line_end(textiter):
"""
:type textiter: Gtk.TextIter
:return: Gtk.TextIter
"""
if textiter.get_char() == "\n":
return textiter
return textiter.forward_to_line_end_n()
try:
# Might fail while building the doc
import re as r
for name in dir(Gtk.TextIter):
if r.match("(forward|set|backward).*$", name):
setattr(Gtk.TextIter, name + "_n", make_wrapper(name))
Gtk.TextIter.__str__ = iter_to_str
Gtk.TextIter.__repr__ = iter_to_str
Gtk.TextIter.__eq__ = iter_eq
Gtk.TextIter.to_line_end = to_line_end
Gtk.TextTag.__str__ = tag_to_str
Gtk.TextTag.__repr__ = tag_to_str
Gtk.TextIter.to_tuple = to_tuple
Gtk.TextBuffer.iter_from_tuple = iter_from_tuple
Gtk.TextBuffer.highlighting_initialized = False
except NameError:
pass
def propagate_change(pref):
fg_color = Gdk.RGBA()
style_string = pref.get()
font_style, fg_style, bg_style = style_string.split("@")
has_bg = bg_style != "rgba(0,0,0,0)"
fg_color.parse(fg_style)
pref.tag.set_property("foreground_rgba", fg_color)
if has_bg:
bg_color = Gdk.RGBA()
bg_color.parse(bg_style)
is_white = bg_color.red == bg_color.blue == bg_color.green == 1
if not is_white:
pref.tag.set_property("background_rgba", bg_color)
if font_style in ["BOLD", "BOLD_ITALIC"]:
pref.tag.set_property("weight", Pango.Weight.BOLD)
if font_style in ["ITALIC", "BOLD_ITALIC"]:
pref.tag.set_property("style", Pango.Style.ITALIC)
if font_style in ["DEFAULT", "NORMAL"]:
pref.tag.set_property("style", Pango.Style.NORMAL)
pref.tag.set_property("weight", Pango.Weight.NORMAL)
# Data classes for highlighters
class Style(object):
def __init__(self, style_id, prio, pref):
"""
:type style_id: string
:type prio: int
:type pref: GPS.Preference
"""
self.pref = pref
self.prio = prio
self.style_id = style_id
def __repr__(self):
return "<Style : {0}>".format(self.style_id)
class BaseMatcher(object):
def resolve(self):
"""
:rtype: Matcher
"""
raise NotImplemented
class Matcher(BaseMatcher):
def resolve(self):
return self
@property
def pattern(self):
raise NotImplemented
def __init__(self, tag, name=""):
"""
:type tag: Style
:type name: string
"""
self.name = name
self.tag = tag
self.gtk_tag = None
def init_tag(self, gtk_ed):
self.gtk_tag = gtk_ed.get_tag_table().lookup(self.tag.style_id)
if not self.gtk_tag:
self.gtk_tag = gtk_ed.create_tag(self.tag.style_id)
if self.tag.prio != -1:
self.gtk_tag.set_priority(self.tag.prio)
self.tag.pref.tag = self.gtk_tag
propagate_change(self.tag.pref)
return self.gtk_tag
class SimpleMatcher(Matcher):
def __init__(self, tag, pattern, name=""):
"""
:type tag: Style
:type pattern: string
"""
super(SimpleMatcher, self).__init__(tag, name)
self._pattern = pattern
@property
def pattern(self):
return self._pattern
class RegionMatcher(Matcher):
":type: dict[string, RegionMatcher]"
region_matchers = {}
def __init__(self, tag, start_pattern, end_pattern, hl_spec, matchall,
name="", igncase=False):
"""
:type tag: Style
:type start_pattern: string
:type end_pattern: string
:type hl_spec: Iterable[BaseMatcher]
:type matchall: boolean
:type name: string
"""
Matcher.__init__(self, tag, name)
self.matchall = matchall
self.hl_spec = hl_spec
self.end_pattern = end_pattern
self.start_pattern = start_pattern
if self.name:
RegionMatcher.region_matchers[self.name] = self
self.subhighlighter = SubHighlighter(hl_spec, end_pattern,
matchall, igncase=igncase)
self.subhighlighter.parent_cat = self
@property
def pattern(self):
return self.start_pattern
def init_tag(self, gtk_ed):
Matcher.init_tag(self, gtk_ed)
self.subhighlighter.gtk_tag = self.gtk_tag
return self.gtk_tag
class RegionRef(BaseMatcher):
def __init__(self, region_name):
self.region_name = region_name
def resolve(self):
return RegionMatcher.region_matchers[self.region_name]
########################
# Highlighter creation #
########################
class HighlighterStacks(object):
def __init__(self):
# The stack of highlighter at (0, 0) is necessarily the empty stack,
# so the stack list comes prepopulated with one empty stack
self.stacks_list = [()]
def set(self, index, stack):
"""
Set the stack of highlighters for line index. Returns true if the
previous stack is the same as the stack argument.
:type index: int
:type stack: tuple[Struct]
@rtype: bool
"""
assert 0 <= index <= len(self.stacks_list)
tpstack = tuple(stack)
if index == len(self.stacks_list):
self.stacks_list.append(tpstack)
return False
else:
current_stack = self.stacks_list[index]
self.stacks_list[index] = tpstack
return tpstack == current_stack
def get(self, start_line):
"""
:type start_line: int
@rtype: tuple[Struct]|None
"""
if start_line < len(self.stacks_list):
return self.stacks_list[start_line][:]
else:
return None
def insert_newlines(self, nb_lines, after_line):
"""
:type after_line: int
:type nb_lines: int
"""
for _ in range(nb_lines):
self.stacks_list.insert(after_line + 1, ())
def delete_lines(self, nb_deleted_lines, at_line):
"""
:param nb_deleted_lines: int
:param at_line: int
"""
del self.stacks_list[at_line + 1:at_line + nb_deleted_lines + 1]
def __str__(self):
return "{0}".format(
"\n".join(["{0}\t{1}".format(num, [c for c in stack])
for num, stack in enumerate(self.stacks_list)])
)
class SubHighlighter(object):
def __init__(self, highlighter_spec, stop_pattern=None,
matchall=True, igncase=False):
"""
:type highlighter_spec: Iterable[BaseMatcher]
"""
self.matchers = [m.resolve() for m in highlighter_spec]
patterns = [m.pattern for m in self.matchers]
if stop_pattern:
patterns.append(stop_pattern)
self.matchers.append(None)
self.pattern = re.compile(
"|".join("({0})".format(pat) for pat in patterns),
flags=re.M + (re.S if matchall else 0) +
(re.I if igncase else 0)
)
self.gtk_tag = None
self.region_start = None
self.parent_cat = None
def get_tags_list(self, gtk_ed):
"""
:type gtk_ed: Gtk.TextBuffer
"""
return [m.init_tag(gtk_ed) if m else None for m in self.matchers]
def __str__(self):
return "<{0}>".format((self.parent_cat.name if self.parent_cat.name
else "") if self.parent_cat else "Root")
def __repr__(self):
return self.__str__()
class Highlighter(object):
def __init__(self, spec=(), igncase=False):
"""
:type spec: Iterable[BaseMatcher]
:return:
"""
self.root_highlighter = SubHighlighter(spec, igncase=igncase)
self.sync_stop = False
def highlight_info_gen(self, gtk_ed, start_line, end_line=0):
"""
Returns a generator that will highlight the buffer, one token at a
time, every time the generator is consumed.
:type gtk_ed: Gtk.TextBuffer
:type start_line: int
"""
self.sync_stop = False
start = gtk_ed.get_iter_at_line(start_line)
":type: Gtk.TextIter"
end = (gtk_ed.get_end_iter()
if (end_line == 0 or end_line > gtk_ed.get_line_count())
else gtk_ed.get_iter_at_line(end_line))
":type: Gtk.TextIter"
strn = gtk_ed.get_text(start, end, True).decode('utf-8')
":type: unicode"
current_line = start_line
if start_line == 0:
subhl_stack = [self.root_highlighter]
gtk_ed.stacks.set(0, subhl_stack)
else:
subhl_stack = list(gtk_ed.stacks.get(start_line))
match_offset = 0
last_start_offset = 0
results = []
hl_tags = {}
rstarts = []
start_offset = start.get_offset()
end_offset = end.get_offset()
while subhl_stack:
hl = subhl_stack[-1]
matches = hl.pattern.finditer(strn, match_offset)
# Cache tags
tags = hl_tags.get(hl, None)
if not tags:
tags = hl.get_tags_list(gtk_ed)
hl_tags[hl] = tags
pop_stack = True
met_stop_pattern = False
for m in matches:
# Get the index of the first matching category
i = [j for j in range(1, len(hl.matchers) + 1)
if m.span(j) != null_span][0]
matcher, tag = hl.matchers[i - 1], tags[i - 1]
start_line += strn.count("\n",
last_start_offset, m.start(i))
last_start_offset = m.start(i)
tk_start_offset = start_offset + m.start(i)
tk_end_offset = start_offset + m.end(i)
if start_line > current_line:
for l in range(current_line + 1, start_line):
gtk_ed.stacks.set(l, subhl_stack)
current_line = start_line
# We exit because the stack we're setting is == to the
# existing one, so the buffer is synced
if gtk_ed.stacks.set(current_line, subhl_stack):
endi = gtk_ed.get_iter_at_line(current_line)
endi.backward_char()
endo = endi.get_offset()
rstart = rstarts.pop() if rstarts else start_offset
results.append((subhl_stack[-1].gtk_tag, rstart,
endo))
self.sync_stop = True
return results
# Stop pattern, this is the end of the region, we want to
# return to the parent highlighter after having yielded the
# location of the region stop-pattern.
if not matcher:
assert isinstance(hl.gtk_tag, Gtk.TextTag)
# If the region has no region start, we are
# rehighlighting a region that was previously created,
# and has no stored region start.
rstart = rstarts.pop() if rstarts else start_offset
results.append((hl.gtk_tag, rstart, tk_end_offset))
match_offset = m.end(i)
met_stop_pattern = True
break
if isinstance(matcher, RegionMatcher):
subhl_stack.append(matcher.subhighlighter)
rstarts.append(tk_start_offset)
match_offset = m.end(i)
pop_stack = False
break
if tag:
results.append((tag, tk_start_offset, tk_end_offset))
else:
assert False
# If a region highlighter is stacked, we haven't met it's stop
# pattern, but yet exhausted the matcher, and we didn't just put
# it on the stack, then it means this is an unfinished region,
# so we can highlight to the end of the buffer with this region's
# tag
if len(subhl_stack) > 1 and not met_stop_pattern and pop_stack:
rstart = rstarts.pop() if rstarts else start_offset
results.append((hl.gtk_tag, rstart, end_offset))
# We break out of the while loop to keep the stack intact
break
if len(subhl_stack) == 1:
break
if pop_stack:
subhl_stack.pop()
# If we are here, it means this highlighter went on through the end
# of the buffer (didn't meet a stop pattern, or is the top level hl).
# In this case, we want to set the stack correctly for the remaining
# lines
for l in range(current_line + 1, end.get_line() + 1):
gtk_ed.stacks.set(l, subhl_stack)
results.append((None, end_offset, end_offset))
return results
def highlight_gen(self, gtk_ed, start_line=-1):
"""
:type gtk_ed: Gtk.TextBuffer
:type start_line: int
"""
# t = time()
start_it = gtk_ed.get_start_iter()
end_it = gtk_ed.get_start_iter()
if start_line == -1:
for tag, start, end in self.highlight_info_gen(gtk_ed, 0):
if tag:
start_it.set_offset(start)
end_it.set_offset(end)
gtk_ed.apply_tag(tag, start_it, end_it)
else:
st_iter = gtk_ed.get_iter_at_line(start_line)
actions_list = self.highlight_info_gen(gtk_ed, start_line,
start_line + 1000)
# if not self.sync_stop:
# actions_list = self.highlight_info_gen(gtk_ed, start_line)
end_it.set_offset(actions_list[-1][2])
gtk_ed.remove_all_tags(st_iter, end_it)
for tag, start, end in actions_list:
start_it.set_offset(start)
end_it.set_offset(end)
if tag:
gtk_ed.apply_tag(tag, start_it, end_it)
# print (time() - t)
def gtk_highlight(self, gtk_ed):
self.highlight_gen(gtk_ed, -1)
def gtk_highlight_region(self, gtk_ed, start_line):
self.highlight_gen(gtk_ed, start_line)
def init_highlighting(self, ed):
gtk_ed = get_gtk_buffer(ed)
gtk_ed.highlighting_initialized = True
gtk_ed.stacks = HighlighterStacks()
if not hasattr(gtk_ed, "idle_highlight_id"):
gtk_ed.idle_highlight_id = None
def action_handler(loc):
""":type loc: Gtk.TextIter"""
if gtk_ed.idle_highlight_id:
GLib.source_remove(gtk_ed.idle_highlight_id)
# Highlight all the rest of the buffer
# TODO: Highlight N lines synchronously, and if there are any
# TODO: remaining, the rest in async
self.gtk_highlight_region(gtk_ed, loc.get_line())
# noinspection PyUnusedLocal
def highlighting_insert_text_before(buf, loc, text, length):
buf.insert_loc = loc.to_tuple()
# noinspection PyUnusedLocal
def highlighting_insert_text(buf, loc, text, length):
nb_new_lines = len(text.split("\n")) - 1
itr = buf.iter_from_tuple(buf.insert_loc)
buf.stacks.insert_newlines(nb_new_lines, itr.get_line())
action_handler(itr)
def highlighting_delete_range_before(buf, loc, end):
buf.nb_deleted_lines = len(
buf.get_text(loc, end, True).split("\n")
) - 1
# noinspection PyUnusedLocal
def highlighting_delete_range(buf, loc, end):
buf.stacks.delete_lines(buf.nb_deleted_lines, loc.get_line())
action_handler(loc)
gtk_ed.connect_after("insert-text", highlighting_insert_text)
gtk_ed.connect_after("delete-range", highlighting_delete_range)
gtk_ed.connect("delete-range", highlighting_delete_range_before)
gtk_ed.connect("insert-text", highlighting_insert_text_before)
def gps_fun(fun):
def __gps_to_gtk_fun(start, end, *args, **kwargs):
gtk_ed = get_gtk_buffer(start.buffer())
gtk_start = gtk_ed.get_iter_at_offset(start.offset())
gtk_end = gtk_ed.get_iter_at_offset(end.offset())
fun(gtk_ed, gtk_start, gtk_end, *args, **kwargs)
return __gps_to_gtk_fun
|