pp-engine.h 7.03 KB
Newer Older
con's avatar
con committed
1
2
3
4
5
6
7
8
/***************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact:  Qt Software Information (qt-info@nokia.com)
**
9
10
11
**
** Non-Open Source Usage
**
con's avatar
con committed
12
13
14
** Licensees may use this file in accordance with the Qt Beta Version
** License Agreement, Agreement version 2.2 provided with the Software or,
** alternatively, in accordance with the terms contained in a written
15
16
17
18
** agreement between you and Nokia.
**
** GNU General Public License Usage
**
con's avatar
con committed
19
20
21
22
23
24
25
26
27
28
** Alternatively, this file may be used under the terms of the GNU General
** Public License versions 2.0 or 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 GNU
** General Public Licensing requirements will be met:
**
** http://www.fsf.org/licensing/licenses/info/GPLv2.html and
** http://www.gnu.org/copyleft/gpl.html.
**
** In addition, as a special exception, Nokia gives you certain additional
29
** rights. These rights are described in the Nokia Qt GPL Exception
30
** version 1.3, included in the file GPL_EXCEPTION.txt in this package.
31
32
**
***************************************************************************/
con's avatar
con committed
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
/*
  Copyright 2005 Roberto Raggi <roberto@kdevelop.org>

  Permission to use, copy, modify, distribute, and sell this software and its
  documentation for any purpose is hereby granted without fee, provided that
  the above copyright notice appear in all copies and that both that
  copyright notice and this permission notice appear in supporting
  documentation.

  The above copyright notice and this permission notice shall be included in
  all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
  KDEVELOP TEAM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

#ifndef PP_ENGINE_H
#define PP_ENGINE_H

#include "pp-client.h"
hjk's avatar
hjk committed
57

con's avatar
con committed
58
59
60
61
62
63
64
#include <Token.h>
#include <QVector>

namespace CPlusPlus {
    class Token;
}

65
namespace CPlusPlus {
con's avatar
con committed
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

    struct Value
    {
        enum Kind {
            Kind_Long,
            Kind_ULong,
        };

        Kind kind;

        union {
            long l;
            unsigned long ul;
        };


        Value()
            : kind(Kind_Long), l(0)
        { }

        inline bool is_ulong () const
        { return kind == Kind_ULong; }

        inline void set_ulong (unsigned long v)
        {
            ul = v;
            kind = Kind_ULong;
        }

        inline void set_long (long v)
        {
            l = v;
            kind = Kind_Long;
        }

        inline bool is_zero () const
        { return l == 0; }

#define PP_DEFINE_BIN_OP(name, op) \
        inline Value operator op(const Value &other) const \
        { \
            Value v = *this; \
            if (v.is_ulong () || other.is_ulong ()) \
                v.set_ulong (v.ul op other.ul); \
            else \
                v.set_long (v.l op other.l); \
            return v; \
        }

        PP_DEFINE_BIN_OP(op_add, +)
        PP_DEFINE_BIN_OP(op_sub, -)
        PP_DEFINE_BIN_OP(op_mult, *)
        PP_DEFINE_BIN_OP(op_div, /)
        PP_DEFINE_BIN_OP(op_mod, %)
        PP_DEFINE_BIN_OP(op_lhs, <<)
        PP_DEFINE_BIN_OP(op_rhs, >>)
        PP_DEFINE_BIN_OP(op_lt, <)
        PP_DEFINE_BIN_OP(op_gt, >)
        PP_DEFINE_BIN_OP(op_le, <=)
        PP_DEFINE_BIN_OP(op_ge, >=)
        PP_DEFINE_BIN_OP(op_eq, ==)
        PP_DEFINE_BIN_OP(op_ne, !=)
        PP_DEFINE_BIN_OP(op_bit_and, &)
        PP_DEFINE_BIN_OP(op_bit_or, |)
        PP_DEFINE_BIN_OP(op_bit_xor, ^)
        PP_DEFINE_BIN_OP(op_and, &&)
        PP_DEFINE_BIN_OP(op_or, ||)

#undef PP_DEFINE_BIN_OP
    };

Roberto Raggi's avatar
Roberto Raggi committed
137
    class CPLUSPLUS_EXPORT pp
con's avatar
con committed
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
    {
        Client *client;
        Environment &env;
        MacroExpander expand;

        enum { MAX_LEVEL = 512 };

        bool _skipping[MAX_LEVEL]; // ### move in state
        bool _true_test[MAX_LEVEL]; // ### move in state
        int iflevel; // ### move in state

        enum PP_DIRECTIVE_TYPE
        {
            PP_UNKNOWN_DIRECTIVE,
            PP_DEFINE,
            PP_INCLUDE,
            PP_INCLUDE_NEXT,
            PP_ELIF,
            PP_ELSE,
            PP_ENDIF,
            PP_IF,
            PP_IFDEF,
            PP_IFNDEF,
            PP_UNDEF
        };

        typedef const CPlusPlus::Token *TokenIterator;

        struct State {
            QByteArray source;
            QVector<CPlusPlus::Token> tokens;
            TokenIterator dot;
        };

        QList<State> _savedStates;

        State state() const;
        void pushState(const State &state);
        void popState();

        QByteArray _source;
        QVector<CPlusPlus::Token> _tokens;
        TokenIterator _dot;

        State createStateFromSource(const QByteArray &source) const;

    public:
        pp(Client *client, Environment &env);

        void operator()(const QByteArray &filename,
                        const QByteArray &source,
                        QByteArray *result);

        void operator()(const QByteArray &source,
                        QByteArray *result);

    private:
        void resetIfLevel();
        bool testIfLevel();
        int skipping() const;

        PP_DIRECTIVE_TYPE classifyDirective(const QByteArray &directive) const;

        Value evalExpression(TokenIterator firstToken,
                             TokenIterator lastToken,
203
                             const QByteArray &source) const;
con's avatar
con committed
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228

        QVector<CPlusPlus::Token> tokenize(const QByteArray &text) const;

        const char *startOfToken(const CPlusPlus::Token &token) const;
        const char *endOfToken(const CPlusPlus::Token &token) const;

        QByteArray tokenSpell(const CPlusPlus::Token &token) const;
        QByteArray tokenText(const CPlusPlus::Token &token) const; // does a deep copy

        void processDirective(TokenIterator dot, TokenIterator lastToken);
        void processInclude(bool skipCurrentPath,
                            TokenIterator dot, TokenIterator lastToken,
                            bool acceptMacros = true);
        void processDefine(TokenIterator dot, TokenIterator lastToken);
        void processIf(TokenIterator dot, TokenIterator lastToken);
        void processElse(TokenIterator dot, TokenIterator lastToken);
        void processElif(TokenIterator dot, TokenIterator lastToken);
        void processEndif(TokenIterator dot, TokenIterator lastToken);
        void processIfdef(bool checkUndefined,
                          TokenIterator dot, TokenIterator lastToken);
        void processUndef(TokenIterator dot, TokenIterator lastToken);

        bool isQtReservedWord(const QByteArray &name) const;
    };

229
} // namespace CPlusPlus
con's avatar
con committed
230
231

#endif // PP_ENGINE_H