Developer Documentation

renderObjectHighLighter.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 #pragma once
44
45 #include <QSyntaxHighlighter>
46
47 #include <QHash>
48 #include <QTextCharFormat>
49 #include <QTextEdit>
50 #include <QTextDocument>
51
52 class RenderObjectHighlighter : public QSyntaxHighlighter
53 {
54 Q_OBJECT
55
56 public:
57 explicit RenderObjectHighlighter( QTextDocument* parent = 0);
58 explicit RenderObjectHighlighter( QTextEdit* parent);
59
61 void update();
62
63 protected:
64
65 void highlightBlock(const QString &text);
66
67 private:
69 void init();
70
71 struct HighlightingRule
72 {
73 QRegExp pattern;
74 QTextCharFormat format;
75 };
76
77
78
79 // Single line rules
80 QStringList keywordPatterns_;
81 QStringList typePatterns_;
82
83 // All single line rules combined with their format
84 QVector<HighlightingRule> highlightingRules_;
85
86 // Multi line rules
87 QRegExp vertexShaderStartExpression_;
88 QRegExp vertexShaderEndExpression_;
89
90 QRegExp geometryShaderStartExpression_;
91 QRegExp geometryShaderEndExpression_;
92
93 QRegExp fragmentShaderStartExpression_;
94 QRegExp fragmentShaderEndExpression_;
95
96 // Single formats
97 QTextCharFormat keywordFormat_;
98 QTextCharFormat defineFormat_;
99 QTextCharFormat typeFormat_;
100
101 QTextCharFormat singleLineCommentFormat_;
102
103 // Multi Line formats
104 QTextCharFormat vertexShaderFormat_;
105 QTextCharFormat geometryShaderFormat_;
106 QTextCharFormat fragmentShaderFormat_;
107
108 };
109
RenderObjectHighlighter
Definition: renderObjectHighLighter.hh:52
RenderObjectHighlighter::init
void init()
common initializer function called by the constructors
Definition: renderObjectHighLighter.cc:59
RenderObjectHighlighter::HighlightingRule
Definition: renderObjectHighLighter.hh:71
RenderObjectHighlighter::update
void update()
Updates the highlighter with the current rule set defined in the patterns.
Definition: renderObjectHighLighter.cc:104