Developer Documentation

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
highLighter.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4 * Copyright (c) 2001-2015, RWTH-Aachen University *
5 * Department of Computer Graphics and Multimedia *
6 * All rights reserved. *
7 * www.openflipper.org *
8 * *
9 *---------------------------------------------------------------------------*
10 * This file is part of OpenFlipper. *
11 *---------------------------------------------------------------------------*
12 * *
13 * Redistribution and use in source and binary forms, with or without *
14 * modification, are permitted provided that the following conditions *
15 * are met: *
16 * *
17 * 1. Redistributions of source code must retain the above copyright notice, *
18 * this list of conditions and the following disclaimer. *
19 * *
20 * 2. Redistributions in binary form must reproduce the above copyright *
21 * notice, this list of conditions and the following disclaimer in the *
22 * documentation and/or other materials provided with the distribution. *
23 * *
24 * 3. Neither the name of the copyright holder nor the names of its *
25 * contributors may be used to endorse or promote products derived from *
26 * this software without specific prior written permission. *
27 * *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41
42 /*===========================================================================*\
43 * *
44 * $Revision$ *
45 * $LastChangedBy$ *
46 * $Date$ *
47 * *
48 \*===========================================================================*/
49
50 #ifndef HIGHLIGHTER_H
51 #define HIGHLIGHTER_H
52
53 #include <QSyntaxHighlighter>
54
55 #include <QHash>
56 #include <QTextCharFormat>
57 #include <QTextDocument>
58 #include <QTextEdit>
59
60 class Highlighter : public QSyntaxHighlighter
61 {
62 Q_OBJECT
63
64 public:
65 Highlighter( QTextDocument* parent = 0);
66 Highlighter( QTextEdit* parent);
67
69 void update();
70
71 QStringList keywordPatterns_;
72 QStringList pluginPatterns_;
73 QStringList functionPatterns_;
74 QStringList typePatterns_;
75
76 protected:
77
78 void highlightBlock(const QString &text);
79
80 private:
82 void init();
83
84 struct HighlightingRule
85 {
86 QRegExp pattern;
87 QTextCharFormat format;
88 };
89
90 QVector<HighlightingRule> highlightingRules_;
91
92 QRegExp commentStartExpression_;
93 QRegExp commentEndExpression_;
94
95 QTextCharFormat keywordFormat_;
96 QTextCharFormat pluginFormat_;
97 QTextCharFormat functionFormat_;
98 QTextCharFormat typeFormat_;
99
100 // QTextCharFormat classFormat;
101 QTextCharFormat singleLineCommentFormat_;
102 QTextCharFormat multiLineCommentFormat_;
103 QTextCharFormat quotationFormat_;
104 QTextCharFormat listFormat_;
105 // QTextCharFormat functionFormat;
106 };
107
108 #endif
Highlighter::HighlightingRule
Definition: highLighter.hh:84
Highlighter
Definition: highLighter.hh:60
Highlighter::init
void init()
common initializer function called by the constructors
Definition: highLighter.cc:71
Highlighter::update
void update()
Updates the highlighter with the current rule set defined in the patterns.
Definition: highLighter.cc:120