syntax.py

Go to the documentation of this file.

"""
SPDX-FileCopyrightText: 2017 Eliakin Costa <eliakim170@gmail.com>
 
SPDX-License-Identifier: GPL-2.0-or-later
"""
# syntax.py: taken from https://wiki.python.org/moin/PyQt/Python%20syntax%20highlighting
 
try:
    from PyQt6.QtCore import QRegularExpression
    from PyQt6.QtGui import QSyntaxHighlighter
except:
    from PyQt5.QtCore import QRegularExpression
    from PyQt5.QtGui import QSyntaxHighlighter
 
 
class PythonHighlighter (QSyntaxHighlighter):
 
    """Syntax highlighter for the Python language.
    """
    # Python keywords
    keywords = [
        'and', 'assert', 'break', 'class', 'continue', 'def',
        'del', 'elif', 'else', 'except', 'exec', 'finally',
        'for', 'from', 'global', 'if', 'import', 'in',
        'is', 'lambda', 'not', 'or', 'pass', 'print',
        'raise', 'return', 'try', 'while', 'yield',
        'None', 'True', 'False',
    ]
 
    # Python operators
    operators = [
        '=',
        # Comparison
        '==', '!=', '<', '<=', '>', '>=',
        # Arithmetic
        r'\+', '-', r'\*', '/', '//', r'\%', r'\*\*',
        # In-place
        r'\+=', '-=', r'\*=', '/=', r'\%=',
        # Bitwise
        r'\^', r'\|', r'\&', r'\~', '>>', '<<',
    ]
 
    # Python braces
    braces = [
        r'\{', r'\}', r'\‍(', r'\‍)', r'\[', r'\]',
    ]
 
    def __init__(self, document, syntaxStyle):
        QSyntaxHighlighter.__init__(self, document)
 
        self.syntaxStyle = syntaxStyle
        self.document = document
 
        # 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 = (QRegularExpression(r"""'''(?!")"""), 1, 'string2')
        self.tri_double = (QRegularExpression(r'''"""(?!')'''), 2, 'string2')
 
        rules = []
 
        # Keyword, operator, and brace rules
        rules += [(r'\b%s\b' % w, 0, 'keyword')
                  for w in PythonHighlighter.keywords]
        rules += [(r'%s' % o, 0, 'operator')
                  for o in PythonHighlighter.operators]
        rules += [(r'%s' % b, 0, 'brace')
                  for b in PythonHighlighter.braces]
 
        # All other rules
        rules += [
            # 'self'
            (r'\bself\b', 0, 'self'),
 
            # Double-quoted string, possibly containing escape sequences
            (r'"[^"\\]*(\\.[^"\\]*)*"', 0, 'string'),
            # Single-quoted string, possibly containing escape sequences
            (r"'[^'\\]*(\\.[^'\\]*)*'", 0, 'string'),
 
            # 'def' followed by an identifier
            (r'\bdef\b\s*(\w+)', 1, 'defclass'),
            # 'class' followed by an identifier
            (r'\bclass\b\s*(\w+)', 1, 'defclass'),
 
            # From '#' until a newline
            (r'#[^\n]*', 0, 'comment'),
 
            # Numeric literals
            (r'\b[+-]?[0-9]+[lL]?\b', 0, 'numbers'),
            (r'\b[+-]?0[xX][0-9A-Fa-f]+[lL]?\b', 0, 'numbers'),
            (r'\b[+-]?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?\b', 0, 'numbers'),
        ]
 
        # Build a QRegularExpression for each pattern
        self.rules = [(QRegularExpression(pat), index, identifier)
                      for (pat, index, identifier) in rules]
 
    def highlightBlock(self, text):
        """Apply syntax highlighting to the given block of text."""
        # Do other syntax formatting
        for expression, nth, identifier in self.rules:
            matchIter = expression.globalMatch(text)
            while matchIter.hasNext():
                match = matchIter.next()
                index = match.capturedStart(nth)
                length = match.capturedLength(nth)
                self.setFormat(index, length, self.syntaxStyle[identifier])
 
        self.setCurrentBlockState(0)
 
        # Do multi-line strings
        in_multiline = self.match_multiline(text, *self.tri_single)
        if not in_multiline:
            in_multiline = self.match_multiline(text, *self.tri_double)
 
    def match_multiline(self, text, delimiter, in_state, style):
        """Do highlighting of multi-line strings. ``delimiter`` should be a
        ``QRegularExpression`` 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.match(text).capturedStart()
            # Move past this match
            add = delimiter.match(text).capturedLength(delimiter.match(text).lastCapturedIndex())
 
        # As long as there's a delimiter match on this line...
        while start >= 0:
            # Look for the ending delimiter
            match = delimiter.match(text, start + add)
            end = match.capturedStart()
            # Ending delimiter on this line?
            if end >= add:
                length = end - start + add + match.capturedLength(match.lastCapturedIndex())
                self.setCurrentBlockState(0)
            # No; multi-line string
            else:
                self.setCurrentBlockState(in_state)
                length = len(text) - start + add
            # Apply formatting
            self.setFormat(start, length, self.syntaxStyle[style])
            # Look for the next match
            start = delimiter.match(text, start + length).capturedStart()
 
        # Return True if still inside a multi-line string, False otherwise
        if self.currentBlockState() == in_state:
            return True
        else:
            return False
 
    def getSyntaxStyle(self):
        return self.syntaxStyle
 
    def setSyntaxStyle(self, syntaxStyle):
        self.syntaxStyle = syntaxStyle