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