forked from ninja-ide/ninja-ide
-
Notifications
You must be signed in to change notification settings - Fork 0
/
highlighter.py
605 lines (514 loc) · 23.2 KB
/
highlighter.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
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
# -*- coding: utf-8 -*-
#
# This file is part of NINJA-IDE (http://ninja-ide.org).
#
# NINJA-IDE is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# any later version.
#
# NINJA-IDE is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with NINJA-IDE; If not, see <http://www.gnu.org/licenses/>.
# based on Python Syntax highlighting from:
# http://diotavelli.net/PyQtWiki/Python%20syntax%20highlighting
from __future__ import absolute_import
from PyQt4.QtGui import QColor
from PyQt4.QtGui import QTextCharFormat
from PyQt4.QtGui import QFont
from PyQt4.QtGui import QSyntaxHighlighter
from PyQt4.QtGui import QTextBlockUserData
from PyQt4.QtCore import QThread
from PyQt4.QtCore import QRegExp
from PyQt4.QtCore import SIGNAL
from ninja_ide import resources
from ninja_ide.core import settings
def format(color, style=''):
"""Return a QTextCharFormat with the given attributes."""
_color = QColor()
_color.setNamedColor(color)
_format = QTextCharFormat()
_format.setFontFamily(settings.FONT_FAMILY)
_format.setForeground(_color)
if 'bold' in style:
_format.setFontWeight(QFont.Bold)
if 'italic' in style:
_format.setFontItalic(True)
return _format
# Syntax styles that can be shared by all languages
STYLES = {}
def restyle(scheme):
"""Reset the style for each highlighting item when the scheme change."""
STYLES['keyword'] = format(scheme.get('keyword',
resources.COLOR_SCHEME['keyword']), 'bold')
STYLES['operator'] = format(scheme.get('operator',
resources.COLOR_SCHEME['operator']))
STYLES['brace'] = format(scheme.get('brace',
resources.COLOR_SCHEME['brace']))
STYLES['definition'] = format(scheme.get('definition',
resources.COLOR_SCHEME['definition']), 'bold')
STYLES['string'] = format(scheme.get('string',
resources.COLOR_SCHEME['string']))
STYLES['string2'] = format(scheme.get('string2',
resources.COLOR_SCHEME['string2']))
STYLES['comment'] = format(scheme.get('comment',
resources.COLOR_SCHEME['comment']), 'italic')
STYLES['properObject'] = format(scheme.get('properObject',
resources.COLOR_SCHEME['properObject']), 'italic')
STYLES['numbers'] = format(scheme.get('numbers',
resources.COLOR_SCHEME['numbers']))
STYLES['spaces'] = format(scheme.get('spaces',
resources.COLOR_SCHEME['spaces']))
STYLES['extras'] = format(scheme.get('extras',
resources.COLOR_SCHEME['extras']), 'bold')
STYLES['selectedWord'] = scheme.get('selected-word',
resources.COLOR_SCHEME['selected-word'])
class SyntaxUserData(QTextBlockUserData):
"""Store the information of the errors, str and comments for each block."""
def __init__(self, error=False):
super(SyntaxUserData, self).__init__()
self.error = error
self.str_groups = []
self.comment_start = -1
def clear_data(self):
"""Clear the data stored for the current block."""
self.error = False
self.str_groups = []
self.comment_start = -1
def add_str_group(self, start, end):
"""Add a pair of values setting the beggining and end of a string."""
self.str_groups.append((start + 1, end))
def comment_start_at(self, pos):
"""Set the position in the line where the comment starts."""
self.comment_start = pos
class Highlighter(QSyntaxHighlighter):
"""Syntax Highlighter for NINJA-IDE."""
# braces
braces = ['\\(', '\\)', '\\{', '\\}', '\\[', '\\]']
def __init__(self, document, lang=None, scheme=None,
errors=None, pep8=None):
QSyntaxHighlighter.__init__(self, document)
self.highlight_function = self.realtime_highlight
self.errors = errors
self.pep8 = pep8
self.selected_word_lines = []
self.visible_limits = (0, 50)
self._styles = {}
if lang is not None:
self.apply_highlight(lang, scheme)
def sanitize(self, word):
"""Sanitize the string to avoid problems with the regex."""
return word.replace('\\', '\\\\')
def apply_highlight(self, lang, scheme=None, syntax=None):
"""Set the rules that will decide what to highlight and how."""
if syntax is None:
langSyntax = settings.SYNTAX.get(lang, {})
else:
langSyntax = syntax
if scheme is not None:
restyle(scheme)
keywords = langSyntax.get('keywords', [])
operators = langSyntax.get('operators', [])
extras = langSyntax.get('extras', [])
rules = []
# Keyword, operator, brace and extras rules
keyword_pattern = '(^|[^\w\.]{1})(%s)([^\w]{1}|$)'
rules += [(keyword_pattern % w, 2, STYLES['keyword'])
for w in keywords]
rules += [(r'%s' % o, 0, STYLES['operator'])
for o in operators]
rules += [(r'%s' % b, 0, STYLES['brace'])
for b in Highlighter.braces]
rules += [(keyword_pattern % e, 2, STYLES['extras'])
for e in extras]
# All other rules
proper = langSyntax.get('properObject', None)
if proper is not None:
proper = r'\b%s\b' % str(proper[0])
rules += [(proper, 0, STYLES['properObject'])]
rules.append((r'__\w+__', 0, STYLES['properObject']))
# Classes and functions
definition = langSyntax.get('definition', [])
for de in definition:
expr = r'\b%s\b\s*(\w+)' % de
rules.append((expr, 1, STYLES['definition']))
# Numeric literals
rules += [
(r'\b[+-]?[0-9]+[lL]?\b', 0, STYLES['numbers']),
(r'\b[+-]?0[xX][0-9A-Fa-f]+[lL]?\b', 0, STYLES['numbers']),
(r'\b[+-]?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?\b', 0,
STYLES['numbers']),
]
# Regular expressions
regex = langSyntax.get('regex', [])
for reg in regex:
expr = reg[0]
color = resources.COLOR_SCHEME['extras']
style = ''
if len(reg) > 1:
if reg[1] in resources.CUSTOM_SCHEME:
color = resources.CUSTOM_SCHEME[reg[1]]
elif reg[1] in resources.COLOR_SCHEME:
color = resources.COLOR_SCHEME[reg[1]]
if len(reg) > 2:
style = reg[2]
rules.append((expr, 0, format(color, style)))
# Strings
stringChar = langSyntax.get('string', [])
for sc in stringChar:
expr = r'"[^"\\]*(\\.[^"\\]*)*"' if sc == '"' \
else r"'[^'\\]*(\\.[^'\\]*)*'"
rules.append((expr, 0, STYLES['string']))
# Comments
comments = langSyntax.get('comment', [])
for co in comments:
expr = co + '[^\\n]*'
rules.append((expr, 0, STYLES['comment']))
# Multi-line strings (expression, flag, style)
# FIXME: The triple-quotes in these two lines will mess up the
# syntax highlighting from this point onward
self.tri_single = (QRegExp("'''"), 1, STYLES["string2"])
self.tri_double = (QRegExp('"""'), 2, STYLES['string2'])
multi = langSyntax.get('multiline_comment', [])
if multi:
self.multi_start = (QRegExp(multi['open']), STYLES['comment'])
self.multi_end = (QRegExp(multi['close']), STYLES['comment'])
else:
self.multi_start = None
# Build a QRegExp for each pattern
self.rules = [(QRegExp(pat), index, fmt)
for (pat, index, fmt) in rules]
self.selected_word_pattern = None
#Apply Highlight to the document... (when colors change)
self.rehighlight()
def set_selected_word(self, word):
"""Set the word to highlight."""
if len(word) > 2:
self.selected_word_pattern = QRegExp(
r'\b%s\b' % self.sanitize(word))
else:
self.selected_word_pattern = None
def __highlight_pep8(self, char_format, user_data):
"""Highlight the lines with pep8 errors."""
user_data.error = True
char_format = char_format.toCharFormat()
char_format.setUnderlineColor(QColor(
resources.CUSTOM_SCHEME.get('pep8-underline',
resources.COLOR_SCHEME['pep8-underline'])))
char_format.setUnderlineStyle(
QTextCharFormat.WaveUnderline)
return char_format
def __highlight_lint(self, char_format, user_data):
"""Highlight the lines with lint errors."""
user_data.error = True
char_format = char_format.toCharFormat()
char_format.setUnderlineColor(QColor(
resources.CUSTOM_SCHEME.get('error-underline',
resources.COLOR_SCHEME['error-underline'])))
char_format.setUnderlineStyle(
QTextCharFormat.WaveUnderline)
return char_format
def highlightBlock(self, text):
"""Apply syntax highlighting to the given block of text."""
self.highlight_function(text)
def set_open_visible_area(self, is_line, position):
"""Set the range of lines that should be highlighted on open."""
if is_line:
self.visible_limits = (position - 50, position + 50)
def open_highlight(self, text):
"""Only highlight the lines inside the accepted range."""
if self.visible_limits[0] <= self.currentBlock().blockNumber() <= \
self.visible_limits[1]:
self.realtime_highlight(text)
else:
self.setCurrentBlockState(0)
def async_highlight(self):
"""Execute a thread to collect the info of the things to highlight.
The thread will collect the data from where to where to highlight,
and which kind of highlight to use for those sections, and return
that info to the main thread after it process all the file."""
self.thread_highlight = HighlightParserThread(self)
self.connect(self.thread_highlight,
SIGNAL("highlightingDetected(PyQt_PyObject)"),
self._execute_threaded_highlight)
self.thread_highlight.start()
def _execute_threaded_highlight(self, styles=None):
"""Function called with the info collected when the thread ends."""
self.highlight_function = self.threaded_highlight
if styles:
self._styles = styles
lines = list(set(styles.keys()) -
set(range(self.visible_limits[0], self.visible_limits[1])))
# Highlight the rest of the lines that weren't highlighted on open
self.rehighlight_lines(lines, False)
else:
self._styles = {}
self.highlight_function = self.realtime_highlight
def threaded_highlight(self, text):
"""Highlight each line using the info collected by the thread.
This function doesn't need to execute the regular expressions to see
where the highlighting starts and end for each rule, it just take
the start and end point, and the proper highlighting style from the
info returned from the thread and applied that to the document."""
hls = []
block = self.currentBlock()
user_data = block.userData()
if user_data is None:
user_data = SyntaxUserData(False)
user_data.clear_data()
block_number = block.blockNumber()
highlight_errors = lambda cf, ud: cf
if self.errors and (block_number in self.errors.errorsSummary):
highlight_errors = self.__highlight_lint
elif self.pep8 and (block_number in self.pep8.pep8checks):
highlight_errors = self.__highlight_pep8
char_format = block.charFormat()
char_format = highlight_errors(char_format, user_data)
self.setFormat(0, len(block.text()), char_format)
block_styles = self._styles.get(block.blockNumber(), ())
for index, length, char_format in block_styles:
char_format = highlight_errors(char_format, user_data)
if (self.format(index) != STYLES['string']):
self.setFormat(index, length, char_format)
if char_format == STYLES['string']:
hls.append((index, index + length))
user_data.add_str_group(index, index + length)
elif char_format == STYLES['comment']:
user_data.comment_start_at(index)
self.setCurrentBlockState(0)
if not self.multi_start:
# Do multi-line strings
in_multiline = self.match_multiline(text, *self.tri_single,
hls=hls, highlight_errors=highlight_errors,
user_data=user_data)
if not in_multiline:
in_multiline = self.match_multiline(text, *self.tri_double,
hls=hls, highlight_errors=highlight_errors,
user_data=user_data)
else:
# Do multi-line comment
self.comment_multiline(text, self.multi_end[0], *self.multi_start)
block.setUserData(user_data)
def realtime_highlight(self, text):
"""Highlight each line while it is being edited.
This function apply the proper highlight to the line being edited
by the user, this is a really fast process for each line once you
already have the document highlighted, but slow to do it the first
time to highlight all the lines together."""
hls = []
block = self.currentBlock()
user_data = block.userData()
if user_data is None:
user_data = SyntaxUserData(False)
user_data.clear_data()
block_number = block.blockNumber()
highlight_errors = lambda cf, ud: cf
if self.errors and (block_number in self.errors.errorsSummary):
highlight_errors = self.__highlight_lint
elif self.pep8 and (block_number in self.pep8.pep8checks):
highlight_errors = self.__highlight_pep8
char_format = block.charFormat()
char_format = highlight_errors(char_format, user_data)
self.setFormat(0, len(block.text()), char_format)
for expression, nth, char_format in self.rules:
index = expression.indexIn(text, 0)
while index >= 0:
# We actually want the index of the nth match
index = expression.pos(nth)
length = len(expression.cap(nth))
char_format = highlight_errors(char_format, user_data)
if (self.format(index) != STYLES['string']):
self.setFormat(index, length, char_format)
if char_format == STYLES['string']:
hls.append((index, index + length))
user_data.add_str_group(index, index + length)
elif char_format == STYLES['comment']:
user_data.comment_start_at(index)
index = expression.indexIn(text, index + length)
self.setCurrentBlockState(0)
if not self.multi_start:
# Do multi-line strings
in_multiline = self.match_multiline(text, *self.tri_single,
hls=hls, highlight_errors=highlight_errors,
user_data=user_data)
if not in_multiline:
in_multiline = self.match_multiline(text, *self.tri_double,
hls=hls, highlight_errors=highlight_errors,
user_data=user_data)
else:
# Do multi-line comment
self.comment_multiline(text, self.multi_end[0], *self.multi_start)
#Highlight selected word
if self.selected_word_pattern is not None:
index = self.selected_word_pattern.indexIn(text, 0)
while index >= 0:
index = self.selected_word_pattern.pos(0)
length = len(self.selected_word_pattern.cap(0))
char_format = self.format(index)
color = QColor()
color.setNamedColor(STYLES['selectedWord'])
color.setAlpha(100)
char_format.setBackground(color)
self.setFormat(index, length, char_format)
index = self.selected_word_pattern.indexIn(
text, index + length)
#Spaces
expression = QRegExp('\s+')
index = expression.indexIn(text, 0)
while index >= 0:
index = expression.pos(0)
length = len(expression.cap(0))
char_format = STYLES['spaces']
if settings.HIGHLIGHT_WHOLE_LINE:
char_format = highlight_errors(char_format, user_data)
self.setFormat(index, length, char_format)
index = expression.indexIn(text, index + length)
block.setUserData(user_data)
def _rehighlight_lines(self, lines):
"""If the document is valid, highlight the list of lines received."""
if self.document() is None:
return
for line in lines:
block = self.document().findBlockByNumber(line)
self.rehighlightBlock(block)
def _get_errors_lines(self):
"""Return the number of lines that contains errors to highlight."""
errors_lines = []
block = self.document().begin()
while block.isValid():
user_data = block.userData()
if (user_data is not None) and (user_data.error):
errors_lines.append(block.blockNumber())
block = block.next()
return errors_lines
def rehighlight_lines(self, lines, errors=True):
"""Rehighlight the lines for errors or selected words."""
if errors:
errors_lines = self._get_errors_lines()
refresh_lines = set(lines + errors_lines)
else:
refresh_lines = set(lines + self.selected_word_lines)
self.selected_word_lines = lines
self._rehighlight_lines(refresh_lines)
def match_multiline(self, text, delimiter, in_state, style,
hls=[], highlight_errors=lambda x: x, user_data=None):
"""Do highlighting of multi-line strings. ``delimiter`` should be a
``QRegExp`` for triple-single-quotes or triple-double-quotes, and
``in_state`` should be a unique integer to represent the corresponding
state changes when inside those strings. Returns True if we're still
inside a multi-line string when this function is finished.
"""
# If inside triple-single quotes, start at 0
if self.previousBlockState() == in_state:
start = 0
add = 0
# Otherwise, look for the delimiter on this line
else:
start = delimiter.indexIn(text)
# Move past this match
add = delimiter.matchedLength()
# As long as there's a delimiter match on this line...
while start >= 0:
# Look for the ending delimiter
end = delimiter.indexIn(text, start + add)
# Ending delimiter on this line?
if end >= add:
length = end - start + add + delimiter.matchedLength()
self.setCurrentBlockState(0)
# No; multi-line string
else:
self.setCurrentBlockState(in_state)
length = len(text) - start + add
st_fmt = self.format(start)
start_collides = [pos for pos in hls if pos[0] < start < pos[1]]
# Apply formatting
if ((st_fmt != STYLES['comment']) or
((st_fmt == STYLES['comment']) and
(self.previousBlockState() != 0))) and \
(len(start_collides) == 0):
if user_data is not None:
style = highlight_errors(style, user_data)
self.setFormat(start, length, style)
else:
self.setCurrentBlockState(0)
# Look for the next match
start = delimiter.indexIn(text, start + length)
# Return True if still inside a multi-line string, False otherwise
if self.currentBlockState() == in_state:
return True
else:
return False
def comment_multiline(self, text, delimiter_end, delimiter_start, style):
"""Process the beggining and end of a multiline comment."""
startIndex = 0
if self.previousBlockState() != 1:
startIndex = delimiter_start.indexIn(text)
while startIndex >= 0:
endIndex = delimiter_end.indexIn(text, startIndex)
commentLength = 0
if endIndex == -1:
self.setCurrentBlockState(1)
commentLength = len(text) - startIndex
else:
commentLength = endIndex - startIndex + \
delimiter_end.matchedLength()
self.setFormat(startIndex, commentLength, style)
startIndex = delimiter_start.indexIn(text,
startIndex + commentLength)
class HighlightParserThread(QThread):
"""Thread that collect the highlighting info to the current file."""
def __init__(self, highlighter):
super(HighlightParserThread, self).__init__()
self._highlighter = highlighter
def run(self):
"""Execute this rules in another thread to avoid blocking the ui."""
styles = {}
self.msleep(300)
block = self._highlighter.document().begin()
while block.blockNumber() != -1:
text = block.text()
formats = []
for expression, nth, char_format in self._highlighter.rules:
index = expression.indexIn(text, 0)
while index >= 0:
# We actually want the index of the nth match
index = expression.pos(nth)
length = len(expression.cap(nth))
formats.append((index, length, char_format))
index = expression.indexIn(text, index + length)
#Spaces
expression = QRegExp('\s+')
index = expression.indexIn(text, 0)
while index >= 0:
index = expression.pos(0)
length = len(expression.cap(0))
formats.append((index, length, STYLES['spaces']))
index = expression.indexIn(text, index + length)
styles[block.blockNumber()] = formats
block = block.next()
self.emit(SIGNAL("highlightingDetected(PyQt_PyObject)"), styles)
class EmpyHighlighter(QSyntaxHighlighter):
"""Dummy highlighter to be used when the current file is not recognized."""
def __init__(self, document):
super(EmpyHighlighter, self).__init__(document)
self.highlight_function = lambda x: None
def apply_highlight(self, *args, **kwargs):
pass
def set_selected_word(self, *args, **kwargs):
pass
def realtime_highlight(self, *args, **kwargs):
pass
def set_open_visible_area(self, *args, **kwargs):
pass
def open_highlight(self, *args, **kwargs):
pass
def async_highlight(self, *args, **kwargs):
pass
def highlightBlock(self, text):
pass
def rehighlight_lines(self, lines, errors=True):
pass