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
|
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia. For licensing terms and
** conditions see http://www.qt.io/licensing. For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
/**
* @brief The Highlighter class pre-highlights Python source using simple scanner.
*
* Highlighter doesn't highlight user types (classes and enumerations), syntax
* and semantic errors, unnecessary code, etc. It's implements only
* basic highlight mechanism.
*
* Main highlight procedure is highlightBlock().
*/
#include "pythonhighlighter.h"
#include "lexical/pythonscanner.h"
#include <texteditor/basetextdocument.h>
#include <texteditor/texteditorconstants.h>
namespace PythonEditor {
using namespace PythonEditor::Internal;
/**
* @class PyEditor::Highlighter
* @brief Handles incremental lexical highlighting, but not semantic
*
* Incremental lexical highlighting works every time when any character typed
* or some text inserted (i.e. copied & pasted).
* Each line keeps associated scanner state - integer number. This state is the
* scanner context for next line. For example, 3 quotes begin a multiline
* string, and each line up to next 3 quotes has state 'MultiLineString'.
*
* @code
* def __init__: # Normal
* self.__doc__ = """ # MultiLineString (next line is inside)
* banana # MultiLineString
* """ # Normal
* @endcode
*/
PythonHighlighter::PythonHighlighter(QTextDocument *parent) :
TextEditor::SyntaxHighlighter(parent)
{
init();
}
/// New instance created when opening any document in editor
PythonHighlighter::PythonHighlighter(TextEditor::BaseTextDocument *parent) :
TextEditor::SyntaxHighlighter(parent)
{
init();
}
void PythonHighlighter::init()
{
static QVector<TextEditor::TextStyle> categories;
if (categories.isEmpty()) {
categories << TextEditor::C_NUMBER
<< TextEditor::C_STRING
<< TextEditor::C_KEYWORD
<< TextEditor::C_TYPE
<< TextEditor::C_FIELD
<< TextEditor::C_JS_SCOPE_VAR
<< TextEditor::C_OPERATOR
<< TextEditor::C_COMMENT
<< TextEditor::C_DOXYGEN_COMMENT
<< TextEditor::C_TEXT
<< TextEditor::C_VISUAL_WHITESPACE
<< TextEditor::C_STRING;
}
setTextFormatCategories(categories);
}
/// Instance destroyed when one of documents closed from editor
PythonHighlighter::~PythonHighlighter()
{
}
/**
* @brief Highlighter::highlightBlock highlights single line of Python code
* @param text is single line without EOLN symbol. Access to all block data
* can be obtained through inherited currentBlock() function.
*
* This function receives state (int number) from previously highlighted block,
* scans block using received state and sets initial highlighting for current
* block. At the end, it saves internal state in current block.
*/
void PythonHighlighter::highlightBlock(const QString &text)
{
int initialState = previousBlockState();
if (initialState == -1)
initialState = 0;
setCurrentBlockState(highlightLine(text, initialState));
}
/**
* @return True if this keyword is acceptable at start of import line
*/
static inline
bool isImportKeyword(const QString &keyword)
{
return (keyword == QLatin1String("import")
|| keyword == QLatin1String("from"));
}
/**
* @brief Highlight line of code, returns new block state
* @param text Source code to highlight
* @param initialState Initial state of scanner, retrieved from previous block
* @return Final state of scanner, should be saved with current block
*/
int PythonHighlighter::highlightLine(const QString &text, int initialState)
{
Scanner scanner(text.constData(), text.size());
scanner.setState(initialState);
FormatToken tk;
bool hasOnlyWhitespace = true;
while ((tk = scanner.read()).format() != Format_EndOfBlock) {
Format format = tk.format();
if (format == Format_Keyword) {
QString value = scanner.value(tk);
if (isImportKeyword(value) && hasOnlyWhitespace) {
setFormat(tk.begin(), tk.length(), formatForCategory(format));
highlightImport(scanner);
break;
}
}
setFormat(tk.begin(), tk.length(), formatForCategory(format));
if (format != Format_Whitespace)
hasOnlyWhitespace = false;
}
return scanner.state();
}
/**
* @brief Highlights rest of line as import directive
*/
void PythonHighlighter::highlightImport(Scanner &scanner)
{
FormatToken tk;
while ((tk = scanner.read()).format() != Format_EndOfBlock) {
Format format = tk.format();
if (tk.format() == Format_Identifier)
format = Format_ImportedModule;
setFormat(tk.begin(), tk.length(), formatForCategory(format));
}
}
} // namespace PythonEditor
|
