Symbol.h 11.6 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2
3
4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
9
** Commercial Usage
10
**
11
12
13
14
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
15
**
16
** GNU Lesser General Public License Usage
17
**
18
19
20
21
22
23
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24
**
25
** If you are unsure which license is appropriate for your use, please
hjk's avatar
hjk committed
26
** contact the sales department at http://qt.nokia.com/contact.
con's avatar
con committed
27
**
28
**************************************************************************/
con's avatar
con committed
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
// Copyright (c) 2008 Roberto Raggi <roberto.raggi@gmail.com>
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// 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
// AUTHORS OR COPYRIGHT HOLDERS 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 CPLUSPLUS_SYMBOL_H
#define CPLUSPLUS_SYMBOL_H

#include "CPlusPlusForwardDeclarations.h"

Roberto Raggi's avatar
Roberto Raggi committed
54
55

namespace CPlusPlus {
con's avatar
con committed
56
57
58
59
60
61
62
63
64
65
66

class CPLUSPLUS_EXPORT Symbol
{
    Symbol(const Symbol &other);
    void operator =(const Symbol &other);

public:
    /// Storage class specifier
    enum Storage {
        NoStorage = 0,
        Friend,
67
        Auto,
con's avatar
con committed
68
69
70
71
72
73
74
75
76
77
78
        Register,
        Static,
        Extern,
        Mutable,
        Typedef
    };

    /// Access specifier.
    enum Visibility {
        Public,
        Protected,
79
80
        Private,
        Package
con's avatar
con committed
81
82
83
84
    };

public:
    /// Constructs a Symbol with the given source location, name and translation unit.
Roberto Raggi's avatar
Roberto Raggi committed
85
    Symbol(TranslationUnit *translationUnit, unsigned sourceLocation, const Name *name);
con's avatar
con committed
86
87
88
89
90
91
92
93
94
95
96
97
98
99

    /// Destroy this Symbol.
    virtual ~Symbol();

    /// Returns this Symbol's source location.
    unsigned sourceLocation() const;

    /// Returns this Symbol's line number.
    unsigned line() const;

    /// Returns this Symbol's column number.
    unsigned column() const;

    /// Returns this Symbol's file name.
Roberto Raggi's avatar
Roberto Raggi committed
100
    const StringLiteral *fileId() const;
con's avatar
con committed
101
102
103
104
105
106
107

    /// Returns this Symbol's file name.
    const char *fileName() const;

    /// Returns this Symbol's file name length.
    unsigned fileNameLength() const;

108
109
110
111
112
113
    unsigned startOffset() const;
    void setStartOffset(unsigned offset);

    unsigned endOffset() const;
    void setEndOffset(unsigned offset);

con's avatar
con committed
114
    /// Returns this Symbol's name.
Roberto Raggi's avatar
Roberto Raggi committed
115
    const Name *name() const;
con's avatar
con committed
116
117

    /// Sets this Symbol's name.
Roberto Raggi's avatar
Roberto Raggi committed
118
    void setName(const Name *name); // ### dangerous
con's avatar
con committed
119

Roberto Raggi's avatar
Roberto Raggi committed
120
    /// Returns this Symbol's (optional) identifier
Roberto Raggi's avatar
Roberto Raggi committed
121
    const Identifier *identifier() const;
Roberto Raggi's avatar
Roberto Raggi committed
122

con's avatar
con committed
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
    /// Returns this Symbol's storage class specifier.
    int storage() const;

    /// Sets this Symbol's storage class specifier.
    void setStorage(int storage);

    /// Returns this Symbol's visibility.
    int visibility() const;

    /// Sets this Symbol's visibility.
    void setVisibility(int visibility);

    /// Returns this Symbol's scope.
    Scope *scope() const;

    /// Returns the next chained Symbol.
    Symbol *next() const;

    /// Returns true if this Symbol has friend storage specifier.
    bool isFriend() const;

    /// Returns true if this Symbol has register storage specifier.
    bool isRegister() const;

    /// Returns true if this Symbol has static storage specifier.
    bool isStatic() const;

    /// Returns true if this Symbol has extern storage specifier.
    bool isExtern() const;

    /// Returns true if this Symbol has mutable storage specifier.
    bool isMutable() const;

    /// Returns true if this Symbol has typedef storage specifier.
    bool isTypedef() const;

    /// Returns true if this Symbol's visibility is public.
    bool isPublic() const;

    /// Returns true if this Symbol's visibility is protected.
    bool isProtected() const;

    /// Returns true if this Symbol's visibility is private.
    bool isPrivate() const;

    /// Returns true if this Symbol is a ScopedSymbol.
    bool isScopedSymbol() const;

    /// Returns true if this Symbol is an Enum.
    bool isEnum() const;

    /// Returns true if this Symbol is an Function.
    bool isFunction() const;

    /// Returns true if this Symbol is a Namespace.
    bool isNamespace() const;

    /// Returns true if this Symbol is a Class.
    bool isClass() const;

    /// Returns true if this Symbol is a Block.
    bool isBlock() const;

    /// Returns true if this Symbol is a UsingNamespaceDirective.
    bool isUsingNamespaceDirective() const;

    /// Returns true if this Symbol is a UsingDeclaration.
    bool isUsingDeclaration() const;

    /// Returns true if this Symbol is a Declaration.
    bool isDeclaration() const;

    /// Returns true if this Symbol is an Argument.
    bool isArgument() const;

Roberto Raggi's avatar
Roberto Raggi committed
198
199
200
    /// Returns true if this Symbol is a Typename argument.
    bool isTypenameArgument() const;

con's avatar
con committed
201
202
203
    /// Returns true if this Symbol is a BaseClass.
    bool isBaseClass() const;

204
205
206
    /// Returns true if this Symbol is a ForwardClassDeclaration.
    bool isForwardClassDeclaration() const;

207
208
209
    bool isObjCBaseClass() const;
    bool isObjCBaseProtocol() const;

210
    /// Returns true if this Symbol is an Objective-C Class declaration.
211
212
    bool isObjCClass() const;

213
    /// Returns true if this Symbol is an Objective-C Class forward declaration.
214
215
    bool isObjCForwardClassDeclaration() const;

216
    /// Returns true if this Symbol is an Objective-C Protocol declaration.
217
218
    bool isObjCProtocol() const;

219
    /// Returns true if this Symbol is an Objective-C Protocol forward declaration.
220
221
    bool isObjCForwardProtocolDeclaration() const;

222
223
224
    /// Returns true if this Symbol is an Objective-C method declaration.
    bool isObjCMethod() const;

225
226
227
    /// Returns true if this Symbol is an Objective-C @property declaration.
    bool isObjCPropertyDeclaration() const;

228
229
230
231
    virtual const ScopedSymbol *asScopedSymbol() const { return 0; }
    virtual const Enum *asEnum() const { return 0; }
    virtual const Function *asFunction() const { return 0; }
    virtual const Namespace *asNamespace() const { return 0; }
232
    virtual const NamespaceAlias *asNamespaceAlias() const { return 0; }
233
234
235
236
237
238
    virtual const Class *asClass() const { return 0; }
    virtual const Block *asBlock() const { return 0; }
    virtual const UsingNamespaceDirective *asUsingNamespaceDirective() const { return 0; }
    virtual const UsingDeclaration *asUsingDeclaration() const { return 0; }
    virtual const Declaration *asDeclaration() const { return 0; }
    virtual const Argument *asArgument() const { return 0; }
Roberto Raggi's avatar
Roberto Raggi committed
239
    virtual const TypenameArgument *asTypenameArgument() const { return 0; }
240
    virtual const BaseClass *asBaseClass() const { return 0; }
241
    virtual const ForwardClassDeclaration *asForwardClassDeclaration() const { return 0; }
242
243
    virtual const ObjCBaseClass *asObjCBaseClass() const { return 0; }
    virtual const ObjCBaseProtocol *asObjCBaseProtocol() const { return 0; }
244
245
246
247
    virtual const ObjCClass *asObjCClass() const { return 0; }
    virtual const ObjCForwardClassDeclaration *asObjCForwardClassDeclaration() const { return 0; }
    virtual const ObjCProtocol *asObjCProtocol() const { return 0; }
    virtual const ObjCForwardProtocolDeclaration *asObjCForwardProtocolDeclaration() const { return 0; }
248
    virtual const ObjCMethod *asObjCMethod() const { return 0; }
249
    virtual const ObjCPropertyDeclaration *asObjCPropertyDeclaration() const { return 0; }
250
251
252
253
254

    virtual ScopedSymbol *asScopedSymbol() { return 0; }
    virtual Enum *asEnum() { return 0; }
    virtual Function *asFunction() { return 0; }
    virtual Namespace *asNamespace() { return 0; }
255
    virtual NamespaceAlias *asNamespaceAlias() { return 0; }
256
257
258
259
260
261
    virtual Class *asClass() { return 0; }
    virtual Block *asBlock() { return 0; }
    virtual UsingNamespaceDirective *asUsingNamespaceDirective() { return 0; }
    virtual UsingDeclaration *asUsingDeclaration() { return 0; }
    virtual Declaration *asDeclaration() { return 0; }
    virtual Argument *asArgument() { return 0; }
Roberto Raggi's avatar
Roberto Raggi committed
262
    virtual TypenameArgument *asTypenameArgument() { return 0; }
263
    virtual BaseClass *asBaseClass() { return 0; }
264
    virtual ForwardClassDeclaration *asForwardClassDeclaration() { return 0; }
265
266
    virtual ObjCBaseClass *asObjCBaseClass() { return 0; }
    virtual ObjCBaseProtocol *asObjCBaseProtocol() { return 0; }
267
268
269
270
    virtual ObjCClass *asObjCClass() { return 0; }
    virtual ObjCForwardClassDeclaration *asObjCForwardClassDeclaration() { return 0; }
    virtual ObjCProtocol *asObjCProtocol() { return 0; }
    virtual ObjCForwardProtocolDeclaration *asObjCForwardProtocolDeclaration() { return 0; }
271
    virtual ObjCMethod *asObjCMethod() { return 0; }
272
    virtual ObjCPropertyDeclaration *asObjCPropertyDeclaration() { return 0; }
con's avatar
con committed
273
274
275
276
277
278
279
280
281
282

    /// Returns this Symbol's type.
    virtual FullySpecifiedType type() const = 0;

    /// Returns this Symbol's hash value.
    unsigned hashCode() const;

    /// Returns this Symbol's index.
    unsigned index() const;

Roberto Raggi's avatar
Roberto Raggi committed
283
    const Name *identity() const;
con's avatar
con committed
284

285
286
    bool isGenerated() const;

287
288
289
    bool isDeprecated() const;
    void setDeprecated(bool isDeprecated);

290
291
    Symbol *enclosingSymbol() const;

292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
    /// Returns the eclosing namespace scope.
    Scope *enclosingNamespaceScope() const;

    /// Returns the enclosing class scope.
    Scope *enclosingClassScope() const;

    /// Returns the enclosing enum scope.
    Scope *enclosingEnumScope() const;

    /// Returns the enclosing function scope.
    Scope *enclosingFunctionScope() const;

    /// Returns the enclosing Block scope.
    Scope *enclosingBlockScope() const;

con's avatar
con committed
307
    void setScope(Scope *scope); // ### make me private
308
    void setSourceLocation(unsigned sourceLocation, TranslationUnit *translationUnit); // ### make me private
con's avatar
con committed
309
310
311
312

    void visitSymbol(SymbolVisitor *visitor);
    static void visitSymbol(Symbol *symbol, SymbolVisitor *visitor);

313
314
    virtual void copy(Symbol *other);

con's avatar
con committed
315
316
317
318
319
protected:
    virtual void visitSymbol0(SymbolVisitor *visitor) = 0;

private:
    unsigned _sourceLocation;
320
321
    unsigned _startOffset;
    unsigned _endOffset;
Roberto Raggi's avatar
Roberto Raggi committed
322
    const Name *_name;
con's avatar
con committed
323
324
325
326
327
328
    unsigned _hashCode;
    int _storage;
    int _visibility;
    Scope *_scope;
    unsigned _index;
    Symbol *_next;
329
330
331
    const StringLiteral *_fileId;
    unsigned _line;
    unsigned _column;
con's avatar
con committed
332

333
    bool _isGenerated: 1;
334
    bool _isDeprecated: 1;
335

con's avatar
con committed
336
337
338
339
340
341
    class IdentityForName;
    class HashCode;

    friend class Scope;
};

Roberto Raggi's avatar
Roberto Raggi committed
342
343
} // end of namespace CPlusPlus

con's avatar
con committed
344
345

#endif // CPLUSPLUS_SYMBOL_H