Symbols.h 22.2 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2
3
4
**
** This file is part of Qt Creator
**
5
** Copyright (c) 2009 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
54
55
56
57
// 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_SYMBOLS_H
#define CPLUSPLUS_SYMBOLS_H

#include "CPlusPlusForwardDeclarations.h"
#include "Symbol.h"
#include "Type.h"
#include "FullySpecifiedType.h"
#include "Array.h"

Roberto Raggi's avatar
Roberto Raggi committed
58
59

namespace CPlusPlus {
con's avatar
con committed
60

61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
class TemplateParameters
{
public:
    TemplateParameters(Scope *scope);
    TemplateParameters(TemplateParameters *previous, Scope *scope);
    ~TemplateParameters();

    TemplateParameters *previous() const;
    Scope *scope() const;

private:
    TemplateParameters *_previous;
    Scope *_scope;
};

con's avatar
con committed
76
77
78
class CPLUSPLUS_EXPORT UsingNamespaceDirective: public Symbol
{
public:
Roberto Raggi's avatar
Roberto Raggi committed
79
    UsingNamespaceDirective(TranslationUnit *translationUnit, unsigned sourceLocation, const Name *name);
con's avatar
con committed
80
81
82
83
84
    virtual ~UsingNamespaceDirective();

    // Symbol's interface
    virtual FullySpecifiedType type() const;

85
86
87
88
89
90
    virtual const UsingNamespaceDirective *asUsingNamespaceDirective() const
    { return this; }

    virtual UsingNamespaceDirective *asUsingNamespaceDirective()
    { return this; }

con's avatar
con committed
91
92
93
94
95
96
97
protected:
    virtual void visitSymbol0(SymbolVisitor *visitor);
};

class CPLUSPLUS_EXPORT UsingDeclaration: public Symbol
{
public:
Roberto Raggi's avatar
Roberto Raggi committed
98
    UsingDeclaration(TranslationUnit *translationUnit, unsigned sourceLocation, const Name *name);
con's avatar
con committed
99
100
101
102
103
    virtual ~UsingDeclaration();

    // Symbol's interface
    virtual FullySpecifiedType type() const;

104
105
106
107
108
109
    virtual const UsingDeclaration *asUsingDeclaration() const
    { return this; }

    virtual UsingDeclaration *asUsingDeclaration()
    { return this; }

con's avatar
con committed
110
111
112
113
114
115
116
protected:
    virtual void visitSymbol0(SymbolVisitor *visitor);
};

class CPLUSPLUS_EXPORT Declaration: public Symbol
{
public:
Roberto Raggi's avatar
Roberto Raggi committed
117
    Declaration(TranslationUnit *translationUnit, unsigned sourceLocation, const Name *name);
con's avatar
con committed
118
119
    virtual ~Declaration();

120
121
    TemplateParameters *templateParameters() const;
    void setTemplateParameters(TemplateParameters *templateParameters);
con's avatar
con committed
122

123
    void setType(const FullySpecifiedType &type);
con's avatar
con committed
124
125
126
127

    // Symbol's interface
    virtual FullySpecifiedType type() const;

128
129
130
131
132
133
    virtual const Declaration *asDeclaration() const
    { return this; }

    virtual Declaration *asDeclaration()
    { return this; }

con's avatar
con committed
134
135
136
137
138
protected:
    virtual void visitSymbol0(SymbolVisitor *visitor);

private:
    FullySpecifiedType _type;
139
    TemplateParameters *_templateParameters;
con's avatar
con committed
140
141
142
143
144
};

class CPLUSPLUS_EXPORT Argument: public Symbol
{
public:
Roberto Raggi's avatar
Roberto Raggi committed
145
    Argument(TranslationUnit *translationUnit, unsigned sourceLocation, const Name *name);
con's avatar
con committed
146
147
    virtual ~Argument();

148
    void setType(const FullySpecifiedType &type);
con's avatar
con committed
149
150
151
152
153
154
155

    bool hasInitializer() const;
    void setInitializer(bool hasInitializer);

    // Symbol's interface
    virtual FullySpecifiedType type() const;

156
157
158
159
160
161
    virtual const Argument *asArgument() const
    { return this; }

    virtual Argument *asArgument()
    { return this; }

con's avatar
con committed
162
163
164
165
166
167
168
169
170
171
172
protected:
    virtual void visitSymbol0(SymbolVisitor *visitor);

private:
    FullySpecifiedType _type;
    bool _initializer: 1;
};

class CPLUSPLUS_EXPORT ScopedSymbol: public Symbol
{
public:
Roberto Raggi's avatar
Roberto Raggi committed
173
    ScopedSymbol(TranslationUnit *translationUnit, unsigned sourceLocation, const Name *name);
con's avatar
con committed
174
175
176
177
178
179
180
    virtual ~ScopedSymbol();

    unsigned memberCount() const;
    Symbol *memberAt(unsigned index) const;
    Scope *members() const;
    void addMember(Symbol *member);

181
182
183
184
185
186
    virtual const ScopedSymbol *asScopedSymbol() const
    { return this; }

    virtual ScopedSymbol *asScopedSymbol()
    { return this; }

con's avatar
con committed
187
188
189
190
191
192
193
194
195
196
197
198
199
private:
    Scope *_members;
};

class CPLUSPLUS_EXPORT Block: public ScopedSymbol
{
public:
    Block(TranslationUnit *translationUnit, unsigned sourceLocation);
    virtual ~Block();

    // Symbol's interface
    virtual FullySpecifiedType type() const;

200
201
202
203
204
205
    virtual const Block *asBlock() const
    { return this; }

    virtual Block *asBlock()
    { return this; }

con's avatar
con committed
206
207
208
209
protected:
    virtual void visitSymbol0(SymbolVisitor *visitor);
};

210
211
212
class CPLUSPLUS_EXPORT ForwardClassDeclaration: public Symbol, public Type
{
public:
Roberto Raggi's avatar
Roberto Raggi committed
213
    ForwardClassDeclaration(TranslationUnit *translationUnit, unsigned sourceLocation, const Name *name);
214
215
    virtual ~ForwardClassDeclaration();

216
217
    TemplateParameters *templateParameters() const;
    void setTemplateParameters(TemplateParameters *templateParameters);
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237

    virtual FullySpecifiedType type() const;

    virtual bool isEqualTo(const Type *other) const;

    virtual const ForwardClassDeclaration *asForwardClassDeclaration() const
    { return this; }

    virtual ForwardClassDeclaration *asForwardClassDeclaration()
    { return this; }

    virtual const ForwardClassDeclaration *asForwardClassDeclarationType() const
    { return this; }

    virtual ForwardClassDeclaration *asForwardClassDeclarationType()
    { return this; }

protected:
    virtual void visitSymbol0(SymbolVisitor *visitor);
    virtual void accept0(TypeVisitor *visitor);
Roberto Raggi's avatar
Roberto Raggi committed
238
    virtual bool matchType0(const Type *otherType, TypeMatcher *matcher) const;
239
240

private:
241
    TemplateParameters *_templateParameters;
242
243
};

con's avatar
con committed
244
245
246
class CPLUSPLUS_EXPORT Enum: public ScopedSymbol, public Type
{
public:
Roberto Raggi's avatar
Roberto Raggi committed
247
    Enum(TranslationUnit *translationUnit, unsigned sourceLocation, const Name *name);
con's avatar
con committed
248
249
250
251
252
253
254
255
    virtual ~Enum();

    // Symbol's interface
    virtual FullySpecifiedType type() const;

    // Type's interface
    virtual bool isEqualTo(const Type *other) const;

256
257
258
259
260
261
    virtual const Enum *asEnum() const
    { return this; }

    virtual Enum *asEnum()
    { return this; }

262
263
264
265
266
267
    virtual const Enum *asEnumType() const
    { return this; }

    virtual Enum *asEnumType()
    { return this; }

con's avatar
con committed
268
269
270
protected:
    virtual void visitSymbol0(SymbolVisitor *visitor);
    virtual void accept0(TypeVisitor *visitor);
Roberto Raggi's avatar
Roberto Raggi committed
271
    virtual bool matchType0(const Type *otherType, TypeMatcher *matcher) const;
con's avatar
con committed
272
273
274
275
276
277
278
279
280
281
282
283
};

class CPLUSPLUS_EXPORT Function: public ScopedSymbol, public Type
{
public:
    enum MethodKey {
        NormalMethod,
        SlotMethod,
        SignalMethod
    };

public:
Roberto Raggi's avatar
Roberto Raggi committed
284
    Function(TranslationUnit *translationUnit, unsigned sourceLocation, const Name *name);
con's avatar
con committed
285
286
287
288
289
290
291
292
    virtual ~Function();

    bool isNormal() const;
    bool isSignal() const;
    bool isSlot() const;
    int methodKey() const;
    void setMethodKey(int key);

293
294
    unsigned templateParameterCount() const; // ### remove me
    Symbol *templateParameterAt(unsigned index) const; // ### remove me
con's avatar
con committed
295

296
297
    TemplateParameters *templateParameters() const;
    void setTemplateParameters(TemplateParameters *templateParameters);
con's avatar
con committed
298
299

    FullySpecifiedType returnType() const;
300
    void setReturnType(const FullySpecifiedType &returnType);
con's avatar
con committed
301

302
303
304
    /** Convenience function that returns whether the function returns something (including void). */
    bool hasReturnType() const;

con's avatar
con committed
305
306
307
308
    unsigned argumentCount() const;
    Symbol *argumentAt(unsigned index) const;
    Scope *arguments() const;

309
310
311
    /** Convenience function that returns whether the function receives any arguments. */
    bool hasArguments() const;

312
313
314
    bool isVirtual() const;
    void setVirtual(bool isVirtual);

con's avatar
con committed
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
    bool isVariadic() const;
    void setVariadic(bool isVariadic);

    bool isConst() const;
    void setConst(bool isConst);

    bool isVolatile() const;
    void setVolatile(bool isVolatile);

    bool isPureVirtual() const;
    void setPureVirtual(bool isPureVirtual);

    // Symbol's interface
    virtual FullySpecifiedType type() const;

    // Type's interface
    virtual bool isEqualTo(const Type *other) const;

333
334
335
336
337
338
    virtual const Function *asFunction() const
    { return this; }

    virtual Function *asFunction()
    { return this; }

339
340
341
342
343
344
    virtual const Function *asFunctionType() const
    { return this; }

    virtual Function *asFunctionType()
    { return this; }

345
346
347
    bool isAmbiguous() const; // internal
    void setAmbiguous(bool isAmbiguous); // internal

con's avatar
con committed
348
349
350
protected:
    virtual void visitSymbol0(SymbolVisitor *visitor);
    virtual void accept0(TypeVisitor *visitor);
Roberto Raggi's avatar
Roberto Raggi committed
351
    virtual bool matchType0(const Type *otherType, TypeMatcher *matcher) const;
con's avatar
con committed
352
353

private:
354
    TemplateParameters *_templateParameters;
con's avatar
con committed
355
    FullySpecifiedType _returnType;
356
    struct Flags {
357
        unsigned _isVirtual: 1;
358
359
360
361
362
363
364
        unsigned _isVariadic: 1;
        unsigned _isPureVirtual: 1;
        unsigned _isConst: 1;
        unsigned _isVolatile: 1;
        unsigned _isAmbiguous: 1;
        unsigned _methodKey: 3;
    };
con's avatar
con committed
365
366
    union {
        unsigned _flags;
367
        Flags f;
con's avatar
con committed
368
369
370
371
372
373
374
    };
    Scope *_arguments;
};

class CPLUSPLUS_EXPORT Namespace: public ScopedSymbol, public Type
{
public:
Roberto Raggi's avatar
Roberto Raggi committed
375
    Namespace(TranslationUnit *translationUnit, unsigned sourceLocation, const Name *name);
con's avatar
con committed
376
377
378
379
380
381
382
383
    virtual ~Namespace();

    // Symbol's interface
    virtual FullySpecifiedType type() const;

    // Type's interface
    virtual bool isEqualTo(const Type *other) const;

384
385
386
387
388
389
    virtual const Namespace *asNamespace() const
    { return this; }

    virtual Namespace *asNamespace()
    { return this; }

390
391
392
393
394
395
    virtual const Namespace *asNamespaceType() const
    { return this; }

    virtual Namespace *asNamespaceType()
    { return this; }

con's avatar
con committed
396
397
398
protected:
    virtual void visitSymbol0(SymbolVisitor *visitor);
    virtual void accept0(TypeVisitor *visitor);
Roberto Raggi's avatar
Roberto Raggi committed
399
    virtual bool matchType0(const Type *otherType, TypeMatcher *matcher) const;
con's avatar
con committed
400
401
402
403
404
};

class CPLUSPLUS_EXPORT BaseClass: public Symbol
{
public:
Roberto Raggi's avatar
Roberto Raggi committed
405
    BaseClass(TranslationUnit *translationUnit, unsigned sourceLocation, const Name *name);
con's avatar
con committed
406
407
408
409
410
411
412
413
    virtual ~BaseClass();

    bool isVirtual() const;
    void setVirtual(bool isVirtual);

    // Symbol's interface
    virtual FullySpecifiedType type() const;

414
415
416
417
418
419
    virtual const BaseClass *asBaseClass() const
    { return this; }

    virtual BaseClass *asBaseClass()
    { return this; }

con's avatar
con committed
420
421
422
423
424
425
426
427
428
429
protected:
    virtual void visitSymbol0(SymbolVisitor *visitor);

private:
    bool _isVirtual;
};

class CPLUSPLUS_EXPORT Class: public ScopedSymbol, public Type
{
public:
Roberto Raggi's avatar
Roberto Raggi committed
430
    Class(TranslationUnit *translationUnit, unsigned sourceLocation, const Name *name);
con's avatar
con committed
431
432
433
434
435
436
437
438
439
440
441
442
443
444
    virtual ~Class();

    enum Key {
        ClassKey,
        StructKey,
        UnionKey
    };

    bool isClass() const;
    bool isStruct() const;
    bool isUnion() const;
    Key classKey() const;
    void setClassKey(Key key);

445
446
    unsigned templateParameterCount() const; // ### remove me
    Symbol *templateParameterAt(unsigned index) const; // ### remove me
con's avatar
con committed
447

448
449
    TemplateParameters *templateParameters() const;
    void setTemplateParameters(TemplateParameters *templateParameters);
con's avatar
con committed
450
451
452
453
454
455
456
457
458
459
460

    unsigned baseClassCount() const;
    BaseClass *baseClassAt(unsigned index) const;
    void addBaseClass(BaseClass *baseClass);

    // Symbol's interface
    virtual FullySpecifiedType type() const;

    // Type's interface
    virtual bool isEqualTo(const Type *other) const;

461
462
463
464
465
466
    virtual const Class *asClass() const
    { return this; }

    virtual Class *asClass()
    { return this; }

467
468
469
470
471
472
    virtual const Class *asClassType() const
    { return this; }

    virtual Class *asClassType()
    { return this; }

con's avatar
con committed
473
474
475
protected:
    virtual void visitSymbol0(SymbolVisitor *visitor);
    virtual void accept0(TypeVisitor *visitor);
Roberto Raggi's avatar
Roberto Raggi committed
476
    virtual bool matchType0(const Type *otherType, TypeMatcher *matcher) const;
con's avatar
con committed
477
478
479

private:
    Key _key;
480
    TemplateParameters *_templateParameters;
con's avatar
con committed
481
482
483
    Array<BaseClass *> _baseClasses;
};

484
485
486
class CPLUSPLUS_EXPORT ObjCBaseClass: public Symbol
{
public:
Roberto Raggi's avatar
Roberto Raggi committed
487
    ObjCBaseClass(TranslationUnit *translationUnit, unsigned sourceLocation, const Name *name);
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
    virtual ~ObjCBaseClass();

    // Symbol's interface
    virtual FullySpecifiedType type() const;

    virtual const ObjCBaseClass *asObjCBaseClass() const
    { return this; }

    virtual ObjCBaseClass *asObjCBaseClass()
    { return this; }

protected:
    virtual void visitSymbol0(SymbolVisitor *visitor);

private:
};

class CPLUSPLUS_EXPORT ObjCBaseProtocol: public Symbol
{
public:
Roberto Raggi's avatar
Roberto Raggi committed
508
    ObjCBaseProtocol(TranslationUnit *translationUnit, unsigned sourceLocation, const Name *name);
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
    virtual ~ObjCBaseProtocol();

    // Symbol's interface
    virtual FullySpecifiedType type() const;

    virtual const ObjCBaseProtocol *asObjCBaseProtocol() const
    { return this; }

    virtual ObjCBaseProtocol *asObjCBaseProtocol()
    { return this; }

protected:
    virtual void visitSymbol0(SymbolVisitor *visitor);

private:
};

526
class CPLUSPLUS_EXPORT ObjCForwardProtocolDeclaration: public Symbol, public Type
527
528
{
public:
Roberto Raggi's avatar
Roberto Raggi committed
529
    ObjCForwardProtocolDeclaration(TranslationUnit *translationUnit, unsigned sourceLocation, const Name *name);
530
531
532
533
    virtual ~ObjCForwardProtocolDeclaration();

    virtual FullySpecifiedType type() const;

534
535
    virtual bool isEqualTo(const Type *other) const;

536
537
538
539
540
541
    virtual const ObjCForwardProtocolDeclaration *asObjCForwardProtocolDeclaration() const
    { return this; }

    virtual ObjCForwardProtocolDeclaration *asObjCForwardProtocolDeclaration()
    { return this; }

542
543
544
545
546
547
    virtual const ObjCForwardProtocolDeclaration *asObjCForwardProtocolDeclarationType() const
    { return this; }

    virtual ObjCForwardProtocolDeclaration *asObjCForwardProtocolDeclarationType()
    { return this; }

548
549
protected:
    virtual void visitSymbol0(SymbolVisitor *visitor);
550
    virtual void accept0(TypeVisitor *visitor);
Roberto Raggi's avatar
Roberto Raggi committed
551
    virtual bool matchType0(const Type *otherType, TypeMatcher *matcher) const;
552
553
554
555
556
557
558

private:
};

class CPLUSPLUS_EXPORT ObjCProtocol: public ScopedSymbol, public Type
{
public:
Roberto Raggi's avatar
Roberto Raggi committed
559
    ObjCProtocol(TranslationUnit *translationUnit, unsigned sourceLocation, const Name *name);
560
561
    virtual ~ObjCProtocol();

562
563
564
565
566
567
568
569
570
    unsigned protocolCount() const
    { return _protocols.count(); }

    ObjCBaseProtocol *protocolAt(unsigned index) const
    { return _protocols.at(index); }

    void addProtocol(ObjCBaseProtocol *protocol)
    { _protocols.push_back(protocol); }

571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
    // Symbol's interface
    virtual FullySpecifiedType type() const;

    // Type's interface
    virtual bool isEqualTo(const Type *other) const;

    virtual const ObjCProtocol *asObjCProtocol() const
    { return this; }

    virtual ObjCProtocol *asObjCProtocol()
    { return this; }

    virtual const ObjCProtocol *asObjCProtocolType() const
    { return this; }

    virtual ObjCProtocol *asObjCProtocolType()
    { return this; }

protected:
    virtual void visitSymbol0(SymbolVisitor *visitor);
    virtual void accept0(TypeVisitor *visitor);
Roberto Raggi's avatar
Roberto Raggi committed
592
    virtual bool matchType0(const Type *otherType, TypeMatcher *matcher) const;
593
594

private:
595
    Array<ObjCBaseProtocol *> _protocols;
596
597
};

598
class CPLUSPLUS_EXPORT ObjCForwardClassDeclaration: public Symbol, public Type
599
600
{
public:
Roberto Raggi's avatar
Roberto Raggi committed
601
    ObjCForwardClassDeclaration(TranslationUnit *translationUnit, unsigned sourceLocation, const Name *name);
602
603
604
605
    virtual ~ObjCForwardClassDeclaration();

    virtual FullySpecifiedType type() const;

606
607
    virtual bool isEqualTo(const Type *other) const;

608
609
610
611
612
613
    virtual const ObjCForwardClassDeclaration *asObjCForwardClassDeclaration() const
    { return this; }

    virtual ObjCForwardClassDeclaration *asObjCForwardClassDeclaration()
    { return this; }

614
615
616
617
618
619
    virtual const ObjCForwardClassDeclaration *asObjCForwardClassDeclarationType() const
    { return this; }

    virtual ObjCForwardClassDeclaration *asObjCForwardClassDeclarationType()
    { return this; }

620
621
protected:
    virtual void visitSymbol0(SymbolVisitor *visitor);
622
    virtual void accept0(TypeVisitor *visitor);
Roberto Raggi's avatar
Roberto Raggi committed
623
    virtual bool matchType0(const Type *otherType, TypeMatcher *matcher) const;
624
625
626
627
628
629
630

private:
};

class CPLUSPLUS_EXPORT ObjCClass: public ScopedSymbol, public Type
{
public:
Roberto Raggi's avatar
Roberto Raggi committed
631
    ObjCClass(TranslationUnit *translationUnit, unsigned sourceLocation, const Name *name);
632
633
    virtual ~ObjCClass();

634
635
636
637
    bool isInterface() const { return _isInterface; }
    void setInterface(bool isInterface) { _isInterface = isInterface; }

    bool isCategory() const { return _categoryName != 0; }
Roberto Raggi's avatar
Roberto Raggi committed
638
639
    const Name *categoryName() const { return _categoryName; }
    void setCategoryName(const Name *categoryName) { _categoryName = categoryName; }
640

641
    ObjCBaseClass *baseClass() const
642
    { return _baseClass; }
643
    void setBaseClass(ObjCBaseClass *baseClass)
644
645
646
647
648
    { _baseClass = baseClass; }

    unsigned protocolCount() const
    { return _protocols.count(); }

649
    ObjCBaseProtocol *protocolAt(unsigned index) const
650
651
    { return _protocols.at(index); }

652
    void addProtocol(ObjCBaseProtocol *protocol)
653
654
    { _protocols.push_back(protocol); }

655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
    // Symbol's interface
    virtual FullySpecifiedType type() const;

    // Type's interface
    virtual bool isEqualTo(const Type *other) const;

    virtual const ObjCClass *asObjCClass() const
    { return this; }

    virtual ObjCClass *asObjCClass()
    { return this; }

    virtual const ObjCClass *asObjCClassType() const
    { return this; }

    virtual ObjCClass *asObjCClassType()
    { return this; }

protected:
    virtual void visitSymbol0(SymbolVisitor *visitor);
    virtual void accept0(TypeVisitor *visitor);
Roberto Raggi's avatar
Roberto Raggi committed
676
    virtual bool matchType0(const Type *otherType, TypeMatcher *matcher) const;
677
678

private:
679
    bool _isInterface;
Roberto Raggi's avatar
Roberto Raggi committed
680
    const Name *_categoryName;
681
682
    ObjCBaseClass * _baseClass;
    Array<ObjCBaseProtocol *> _protocols;
683
684
};

685
686
687
class CPLUSPLUS_EXPORT ObjCMethod: public ScopedSymbol, public Type
{
public:
Roberto Raggi's avatar
Roberto Raggi committed
688
    ObjCMethod(TranslationUnit *translationUnit, unsigned sourceLocation, const Name *name);
689
690
691
    virtual ~ObjCMethod();

    FullySpecifiedType returnType() const;
692
    void setReturnType(const FullySpecifiedType &returnType);
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727

    /** Convenience function that returns whether the function returns something (including void). */
    bool hasReturnType() const;

    unsigned argumentCount() const;
    Symbol *argumentAt(unsigned index) const;
    Scope *arguments() const;

    /** Convenience function that returns whether the function receives any arguments. */
    bool hasArguments() const;

    bool isVariadic() const;
    void setVariadic(bool isVariadic);

    // Symbol's interface
    virtual FullySpecifiedType type() const;

    // Type's interface
    virtual bool isEqualTo(const Type *other) const;

    virtual const ObjCMethod *asObjCMethod() const
    { return this; }

    virtual ObjCMethod *asObjCMethod()
    { return this; }

    virtual const ObjCMethod *asObjCMethodType() const
    { return this; }

    virtual ObjCMethod *asObjCMethodType()
    { return this; }

protected:
    virtual void visitSymbol0(SymbolVisitor *visitor);
    virtual void accept0(TypeVisitor *visitor);
Roberto Raggi's avatar
Roberto Raggi committed
728
    virtual bool matchType0(const Type *otherType, TypeMatcher *matcher) const;
729
730
731
732
733
734
735
736
737
738
739
740
741

private:
    FullySpecifiedType _returnType;
    struct Flags {
        unsigned _isVariadic: 1;
    };
    union {
        unsigned _flags;
        Flags f;
    };
    Scope *_arguments;
};

742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
class CPLUSPLUS_EXPORT ObjCPropertyDeclaration: public Symbol
{
public:
    enum PropertyAttributes {
        None = 0,
        Assign = 1 << 0,
        Retain = 1 << 1,
        Copy = 1 << 2,
        ReadOnly = 1 << 3,
        ReadWrite = 1 << 4,
        Getter = 1 << 5,
        Setter = 1 << 6,
        NonAtomic = 1 << 7,

        WritabilityMask = ReadOnly | ReadWrite,
        SetterSemanticsMask = Assign | Retain | Copy,
    };

public:
    ObjCPropertyDeclaration(TranslationUnit *translationUnit,
                            unsigned sourceLocation,
Roberto Raggi's avatar
Roberto Raggi committed
763
                            const Name *name);
764
765
766
767
768
769
770
771
772
773
774
775
776
777
    virtual ~ObjCPropertyDeclaration();

    bool hasAttribute(int attribute) const
    { return _propertyAttributes & attribute; }

    void setAttributes(int attributes)
    { _propertyAttributes = attributes; }

    bool hasGetter() const
    { return hasAttribute(Getter); }

    bool hasSetter() const
    { return hasAttribute(Setter); }

Roberto Raggi's avatar
Roberto Raggi committed
778
    const Name *getterName() const
779
780
    { return _getterName; }

Roberto Raggi's avatar
Roberto Raggi committed
781
    void setGetterName(const Name *getterName)
782
783
    { _getterName = getterName; }

Roberto Raggi's avatar
Roberto Raggi committed
784
    const Name *setterName() const
785
786
    { return _setterName; }

Roberto Raggi's avatar
Roberto Raggi committed
787
    void setSetterName(const Name *setterName)
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
    { _setterName = setterName; }

    void setType(const FullySpecifiedType &type)
    { _type = type; }

    // Symbol's interface
    virtual FullySpecifiedType type() const;

    virtual const ObjCPropertyDeclaration *asOObjCPropertyDeclaration() const
    { return this; }

    virtual ObjCPropertyDeclaration *asObjCPropertyDeclaration()
    { return this; }

protected:
    virtual void visitSymbol0(SymbolVisitor *visitor);

private:
    FullySpecifiedType _type;
    int _propertyAttributes;
Roberto Raggi's avatar
Roberto Raggi committed
808
809
    const Name *_getterName;
    const Name *_setterName;
810
811
};

Roberto Raggi's avatar
Roberto Raggi committed
812
813
} // end of namespace CPlusPlus

con's avatar
con committed
814
815

#endif // CPLUSPLUS_SYMBOLS_H