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
|
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the Qt3Support module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. 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.
**
** As a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "q3syntaxhighlighter.h"
#include "q3syntaxhighlighter_p.h"
#ifndef QT_NO_SYNTAXHIGHLIGHTER
#include "q3textedit.h"
#include "qtimer.h"
QT_BEGIN_NAMESPACE
/*!
\class Q3SyntaxHighlighter
\brief The Q3SyntaxHighlighter class is a base class for
implementing Q3TextEdit syntax highlighters.
\compat
A syntax highligher automatically highlights parts of the text in
a Q3TextEdit. Syntax highlighters are often used when the user is
entering text in a specific format (for example, source code) and
help the user to read the text and identify syntax errors.
To provide your own syntax highlighting for Q3TextEdit, you must
subclass Q3SyntaxHighlighter and reimplement highlightParagraph().
When you create an instance of your Q3SyntaxHighlighter subclass,
pass it the Q3TextEdit that you want the syntax highlighting to be
applied to. After this your highlightParagraph() function will be
called automatically whenever necessary. Use your
highlightParagraph() function to apply formatting (e.g. setting
the font and color) to the text that is passed to it.
*/
/*!
Constructs the Q3SyntaxHighlighter and installs it on \a textEdit.
Ownership of the Q3SyntaxHighlighter is transferred to the \a
textEdit
*/
Q3SyntaxHighlighter::Q3SyntaxHighlighter(Q3TextEdit *textEdit)
: para(0), edit(textEdit), d(new Q3SyntaxHighlighterPrivate)
{
textEdit->document()->setPreProcessor(new Q3SyntaxHighlighterInternal(this));
textEdit->document()->invalidate();
QTimer::singleShot(0, textEdit->viewport(), SLOT(update()));
}
/*!
Destructor. Uninstalls this syntax highlighter from the textEdit()
*/
Q3SyntaxHighlighter::~Q3SyntaxHighlighter()
{
delete d;
textEdit()->document()->setPreProcessor(0);
}
/*!
\fn int Q3SyntaxHighlighter::highlightParagraph(const QString &text, int endStateOfLastPara)
This function is called when necessary by the rich text engine,
i.e. on paragraphs which have changed.
In your reimplementation you should parse the paragraph's \a text
and call setFormat() as often as necessary to apply any font and
color changes that you require. Your function must return a value
which indicates the paragraph's end state: see below.
Some syntaxes can have constructs that span paragraphs. For
example, a C++ syntax highlighter should be able to cope with
\c{/}\c{*...*}\c{/} comments that span paragraphs. To deal
with these cases it is necessary to know the end state of the
previous paragraph (e.g. "in comment").
If your syntax does not have paragraph spanning constructs, simply
ignore the \a endStateOfLastPara parameter and always return 0.
Whenever highlightParagraph() is called it is passed a value for
\a endStateOfLastPara. For the very first paragraph this value is
always -2. For any other paragraph the value is the value returned
by the most recent highlightParagraph() call that applied to the
preceding paragraph.
The value you return is up to you. We recommend only returning 0
(to signify that this paragraph's syntax highlighting does not
affect the following paragraph), or a positive integer (to signify
that this paragraph has ended in the middle of a paragraph
spanning construct).
To find out which paragraph is highlighted, call
currentParagraph().
For example, if you're writing a simple C++ syntax highlighter,
you might designate 1 to signify "in comment". For a paragraph
that ended in the middle of a comment you'd return 1, and for
other paragraphs you'd return 0. In your parsing code if \a
endStateOfLastPara was 1, you would highlight the text as a C++
comment until you reached the closing \c{*}\c{/}.
*/
/*!
This function is applied to the syntax highlighter's current
paragraph (the text of which is passed to the highlightParagraph()
function).
The specified \a font and \a color are applied to the text from
position \a start for \a count characters. (If \a count is 0,
nothing is done.)
*/
void Q3SyntaxHighlighter::setFormat(int start, int count, const QFont &font, const QColor &color)
{
if (!para || count <= 0)
return;
Q3TextFormat *f = 0;
f = para->document()->formatCollection()->format(font, color);
para->setFormat(start, count, f);
f->removeRef();
}
/*! \overload */
void Q3SyntaxHighlighter::setFormat(int start, int count, const QColor &color)
{
if (!para || count <= 0)
return;
Q3TextFormat *f = 0;
QFont fnt = textEdit()->QWidget::font();
f = para->document()->formatCollection()->format(fnt, color);
para->setFormat(start, count, f);
f->removeRef();
}
/*! \overload */
void Q3SyntaxHighlighter::setFormat(int start, int count, const QFont &font)
{
if (!para || count <= 0)
return;
Q3TextFormat *f = 0;
QColor c = textEdit()->viewport()->palette().color(textEdit()->viewport()->foregroundRole());
f = para->document()->formatCollection()->format(font, c);
para->setFormat(start, count, f);
f->removeRef();
}
/*!
\fn Q3TextEdit *Q3SyntaxHighlighter::textEdit() const
Returns the Q3TextEdit on which this syntax highlighter is
installed
*/
/*! Redoes the highlighting of the whole document.
*/
void Q3SyntaxHighlighter::rehighlight()
{
Q3TextParagraph *s = edit->document()->firstParagraph();
while (s) {
s->invalidate(0);
s->state = -1;
s->needPreProcess = true;
s = s->next();
}
edit->repaintContents();
}
/*!
Returns the id of the paragraph which is highlighted, or -1 of no
paragraph is currently highlighted.
Usually this function is called from within highlightParagraph().
*/
int Q3SyntaxHighlighter::currentParagraph() const
{
return d->currentParagraph;
}
QT_END_NAMESPACE
#endif
|
