SQLiteView/src/sqliteviewer/sql_highlighter.py at c50241f516832e27dfc2ec254c36eb646775b037 · kwrkb/SQLiteView · GitHub

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
"""Simple SQL syntax highlighter for the query editor."""

from __future__ import annotations

from PyQt6.QtCore import QRegularExpression
from PyQt6.QtGui import QColor, QFont, QTextCharFormat, QSyntaxHighlighter


class SqlHighlighter(QSyntaxHighlighter):
    """Applies formatting rules to highlight SQL keywords and tokens."""

    KEYWORDS = {
        # Read / query
        "SELECT",
        "FROM",
        "WHERE",
        "GROUP",
        "BY",
        "ORDER",
        "LIMIT",
        "OFFSET",
        "JOIN",
        "LEFT",
        "RIGHT",
        "INNER",
        "OUTER",
        "ON",
        "AS",
        "AND",
        "OR",
        "NOT",
        "NULL",
        "IS",
        "IN",
        "CASE",
        "WHEN",
        "THEN",
        "END",
        "DISTINCT",
        "WITH",
        "UNION",
        "ALL",
        "HAVING",
        "LIKE",
        "EXISTS",
        "PRAGMA",
        "BETWEEN",
        "EXCEPT",
        "INTERSECT",
        "ELSE",
        "EXPLAIN",
        # DML
        "INSERT",
        "UPDATE",
        "DELETE",
        "SET",
        "VALUES",
        "INTO",
        "REPLACE",
        # DDL
        "CREATE",
        "ALTER",
        "DROP",
        "TABLE",
        "VIEW",
        "INDEX",
        "TRIGGER",
        "COLUMN",
        "ADD",
        "RENAME",
        "IF",
        "PRIMARY",
        "KEY",
        "UNIQUE",
        "CHECK",
        "DEFAULT",
        "FOREIGN",
        "REFERENCES",
        "CONSTRAINT",
        "AUTOINCREMENT",
        # TCL
        "BEGIN",
        "COMMIT",
        "ROLLBACK",
        "TRANSACTION",
        "SAVEPOINT",
        "RELEASE",
        # Maintenance
        "VACUUM",
        "REINDEX",
        "ATTACH",
        "DETACH",
        "CASCADE",
        "RESTRICT",
        "CONFLICT",
        "ABORT",
        "FAIL",
        "IGNORE",
        "TEMPORARY",
        "TEMP",
        # Type names
        "INTEGER",
        "TEXT",
        "REAL",
        "BLOB",
        "NUMERIC",
    }

    def __init__(self, document) -> None:
        super().__init__(document)
        self.keyword_format = QTextCharFormat()
        self.keyword_format.setForeground(QColor("#005cc5"))
        self.keyword_format.setFontWeight(QFont.Weight.Bold)

        self.comment_format = QTextCharFormat()
        self.comment_format.setForeground(QColor("#6a737d"))
        self.comment_format.setFontItalic(True)

        self.string_format = QTextCharFormat()
        self.string_format.setForeground(QColor("#22863a"))

        self.number_format = QTextCharFormat()
        self.number_format.setForeground(QColor("#b31d28"))

        self.comment_expression = QRegularExpression(r"--[^\n]*")
        self.string_expression = QRegularExpression(r"'([^']|'')*'")
        self.number_expression = QRegularExpression(r"\b\d+(\.\d+)?\b")

        pattern_str = r"\b(" + "|".join(self.KEYWORDS) + r")\b"
        self.keyword_pattern = QRegularExpression(pattern_str)
        self.keyword_pattern.setPatternOptions(QRegularExpression.PatternOption.CaseInsensitiveOption)

    def highlightBlock(self, text: str) -> None:  # noqa: N802 (Qt API signature)
        self._apply_regex(self.keyword_pattern, text, self.keyword_format)
        self._apply_regex(self.comment_expression, text, self.comment_format)
        self._apply_regex(self.string_expression, text, self.string_format)
        self._apply_regex(self.number_expression, text, self.number_format)

    def _apply_regex(self, expression: QRegularExpression, text: str, fmt: QTextCharFormat) -> None:
        iterator = expression.globalMatch(text)
        while iterator.hasNext():
            match = iterator.next()
            start = match.capturedStart()
            length = match.capturedLength()
            self.setFormat(start, length, fmt)