DeclObjC.h revision 99ba9e3bd70671f3441fb974895f226a83ce0e66 
1//===--- DeclObjC.h - Classes for representing declarations -----*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10//  This file defines the DeclObjC interface and subclasses.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_CLANG_AST_DECLOBJC_H
15#define LLVM_CLANG_AST_DECLOBJC_H
16
17#include "clang/AST/Decl.h"
18#include "clang/AST/SelectorLocationsKind.h"
19#include "llvm/ADT/STLExtras.h"
20
21namespace clang {
22class Expr;
23class Stmt;
24class FunctionDecl;
25class RecordDecl;
26class ObjCIvarDecl;
27class ObjCMethodDecl;
28class ObjCProtocolDecl;
29class ObjCCategoryDecl;
30class ObjCPropertyDecl;
31class ObjCPropertyImplDecl;
32class CXXCtorInitializer;
33
34class ObjCListBase {
35  void operator=(const ObjCListBase &);     // DO NOT IMPLEMENT
36  ObjCListBase(const ObjCListBase&);        // DO NOT IMPLEMENT
37protected:
38  /// List is an array of pointers to objects that are not owned by this object.
39  void **List;
40  unsigned NumElts;
41
42public:
43  ObjCListBase() : List(0), NumElts(0) {}
44  unsigned size() const { return NumElts; }
45  bool empty() const { return NumElts == 0; }
46
47protected:
48  void set(void *const* InList, unsigned Elts, ASTContext &Ctx);
49};
50
51
52/// ObjCList - This is a simple template class used to hold various lists of
53/// decls etc, which is heavily used by the ObjC front-end.  This only use case
54/// this supports is setting the list all at once and then reading elements out
55/// of it.
56template <typename T>
57class ObjCList : public ObjCListBase {
58public:
59  void set(T* const* InList, unsigned Elts, ASTContext &Ctx) {
60    ObjCListBase::set(reinterpret_cast<void*const*>(InList), Elts, Ctx);
61  }
62
63  typedef T* const * iterator;
64  iterator begin() const { return (iterator)List; }
65  iterator end() const { return (iterator)List+NumElts; }
66
67  T* operator[](unsigned Idx) const {
68    assert(Idx < NumElts && "Invalid access");
69    return (T*)List[Idx];
70  }
71};
72
73/// \brief A list of Objective-C protocols, along with the source
74/// locations at which they were referenced.
75class ObjCProtocolList : public ObjCList<ObjCProtocolDecl> {
76  SourceLocation *Locations;
77
78  using ObjCList<ObjCProtocolDecl>::set;
79
80public:
81  ObjCProtocolList() : ObjCList<ObjCProtocolDecl>(), Locations(0) { }
82
83  typedef const SourceLocation *loc_iterator;
84  loc_iterator loc_begin() const { return Locations; }
85  loc_iterator loc_end() const { return Locations + size(); }
86
87  void set(ObjCProtocolDecl* const* InList, unsigned Elts,
88           const SourceLocation *Locs, ASTContext &Ctx);
89};
90
91
92/// ObjCMethodDecl - Represents an instance or class method declaration.
93/// ObjC methods can be declared within 4 contexts: class interfaces,
94/// categories, protocols, and class implementations. While C++ member
95/// functions leverage C syntax, Objective-C method syntax is modeled after
96/// Smalltalk (using colons to specify argument types/expressions).
97/// Here are some brief examples:
98///
99/// Setter/getter instance methods:
100/// - (void)setMenu:(NSMenu *)menu;
101/// - (NSMenu *)menu;
102///
103/// Instance method that takes 2 NSView arguments:
104/// - (void)replaceSubview:(NSView *)oldView with:(NSView *)newView;
105///
106/// Getter class method:
107/// + (NSMenu *)defaultMenu;
108///
109/// A selector represents a unique name for a method. The selector names for
110/// the above methods are setMenu:, menu, replaceSubview:with:, and defaultMenu.
111///
112class ObjCMethodDecl : public NamedDecl, public DeclContext {
113public:
114  enum ImplementationControl { None, Required, Optional };
115private:
116  // The conventional meaning of this method; an ObjCMethodFamily.
117  // This is not serialized; instead, it is computed on demand and
118  // cached.
119  mutable unsigned Family : ObjCMethodFamilyBitWidth;
120
121  /// instance (true) or class (false) method.
122  unsigned IsInstance : 1;
123  unsigned IsVariadic : 1;
124
125  // Synthesized declaration method for a property setter/getter
126  unsigned IsSynthesized : 1;
127
128  // Method has a definition.
129  unsigned IsDefined : 1;
130
131  /// \brief Method redeclaration in the same interface.
132  unsigned IsRedeclaration : 1;
133
134  /// \brief Is redeclared in the same interface.
135  mutable unsigned HasRedeclaration : 1;
136
137  // NOTE: VC++ treats enums as signed, avoid using ImplementationControl enum
138  /// @required/@optional
139  unsigned DeclImplementation : 2;
140
141  // NOTE: VC++ treats enums as signed, avoid using the ObjCDeclQualifier enum
142  /// in, inout, etc.
143  unsigned objcDeclQualifier : 6;
144
145  /// \brief Indicates whether this method has a related result type.
146  unsigned RelatedResultType : 1;
147
148  /// \brief Whether the locations of the selector identifiers are in a
149  /// "standard" position, a enum SelectorLocationsKind.
150  unsigned SelLocsKind : 2;
151
152  // Result type of this method.
153  QualType MethodDeclType;
154
155  // Type source information for the result type.
156  TypeSourceInfo *ResultTInfo;
157
158  /// \brief Array of ParmVarDecls for the formal parameters of this method
159  /// and optionally followed by selector locations.
160  void *ParamsAndSelLocs;
161  unsigned NumParams;
162
163  /// List of attributes for this method declaration.
164  SourceLocation EndLoc; // the location of the ';' or '}'.
165
166  // The following are only used for method definitions, null otherwise.
167  // FIXME: space savings opportunity, consider a sub-class.
168  Stmt *Body;
169
170  /// SelfDecl - Decl for the implicit self parameter. This is lazily
171  /// constructed by createImplicitParams.
172  ImplicitParamDecl *SelfDecl;
173  /// CmdDecl - Decl for the implicit _cmd parameter. This is lazily
174  /// constructed by createImplicitParams.
175  ImplicitParamDecl *CmdDecl;
176
177  SelectorLocationsKind getSelLocsKind() const {
178    return (SelectorLocationsKind)SelLocsKind;
179  }
180  bool hasStandardSelLocs() const {
181    return getSelLocsKind() != SelLoc_NonStandard;
182  }
183
184  /// \brief Get a pointer to the stored selector identifiers locations array.
185  /// No locations will be stored if HasStandardSelLocs is true.
186  SourceLocation *getStoredSelLocs() {
187    return reinterpret_cast<SourceLocation*>(getParams() + NumParams);
188  }
189  const SourceLocation *getStoredSelLocs() const {
190    return reinterpret_cast<const SourceLocation*>(getParams() + NumParams);
191  }
192
193  /// \brief Get a pointer to the stored selector identifiers locations array.
194  /// No locations will be stored if HasStandardSelLocs is true.
195  ParmVarDecl **getParams() {
196    return reinterpret_cast<ParmVarDecl **>(ParamsAndSelLocs);
197  }
198  const ParmVarDecl *const *getParams() const {
199    return reinterpret_cast<const ParmVarDecl *const *>(ParamsAndSelLocs);
200  }
201
202  /// \brief Get the number of stored selector identifiers locations.
203  /// No locations will be stored if HasStandardSelLocs is true.
204  unsigned getNumStoredSelLocs() const {
205    if (hasStandardSelLocs())
206      return 0;
207    return getNumSelectorLocs();
208  }
209
210  void setParamsAndSelLocs(ASTContext &C,
211                           ArrayRef<ParmVarDecl*> Params,
212                           ArrayRef<SourceLocation> SelLocs);
213
214  ObjCMethodDecl(SourceLocation beginLoc, SourceLocation endLoc,
215                 Selector SelInfo, QualType T,
216                 TypeSourceInfo *ResultTInfo,
217                 DeclContext *contextDecl,
218                 bool isInstance = true,
219                 bool isVariadic = false,
220                 bool isSynthesized = false,
221                 bool isImplicitlyDeclared = false,
222                 bool isDefined = false,
223                 ImplementationControl impControl = None,
224                 bool HasRelatedResultType = false)
225  : NamedDecl(ObjCMethod, contextDecl, beginLoc, SelInfo),
226    DeclContext(ObjCMethod), Family(InvalidObjCMethodFamily),
227    IsInstance(isInstance), IsVariadic(isVariadic),
228    IsSynthesized(isSynthesized),
229    IsDefined(isDefined), IsRedeclaration(0), HasRedeclaration(0),
230    DeclImplementation(impControl), objcDeclQualifier(OBJC_TQ_None),
231    RelatedResultType(HasRelatedResultType),
232    SelLocsKind(SelLoc_StandardNoSpace),
233    MethodDeclType(T), ResultTInfo(ResultTInfo),
234    ParamsAndSelLocs(0), NumParams(0),
235    EndLoc(endLoc), Body(0), SelfDecl(0), CmdDecl(0) {
236    setImplicit(isImplicitlyDeclared);
237  }
238
239  /// \brief A definition will return its interface declaration.
240  /// An interface declaration will return its definition.
241  /// Otherwise it will return itself.
242  virtual ObjCMethodDecl *getNextRedeclaration();
243
244public:
245  static ObjCMethodDecl *Create(ASTContext &C,
246                                SourceLocation beginLoc,
247                                SourceLocation endLoc,
248                                Selector SelInfo,
249                                QualType T,
250                                TypeSourceInfo *ResultTInfo,
251                                DeclContext *contextDecl,
252                                bool isInstance = true,
253                                bool isVariadic = false,
254                                bool isSynthesized = false,
255                                bool isImplicitlyDeclared = false,
256                                bool isDefined = false,
257                                ImplementationControl impControl = None,
258                                bool HasRelatedResultType = false);
259
260  virtual ObjCMethodDecl *getCanonicalDecl();
261  const ObjCMethodDecl *getCanonicalDecl() const {
262    return const_cast<ObjCMethodDecl*>(this)->getCanonicalDecl();
263  }
264
265  ObjCDeclQualifier getObjCDeclQualifier() const {
266    return ObjCDeclQualifier(objcDeclQualifier);
267  }
268  void setObjCDeclQualifier(ObjCDeclQualifier QV) { objcDeclQualifier = QV; }
269
270  /// \brief Determine whether this method has a result type that is related
271  /// to the message receiver's type.
272  bool hasRelatedResultType() const { return RelatedResultType; }
273
274  /// \brief Note whether this method has a related result type.
275  void SetRelatedResultType(bool RRT = true) { RelatedResultType = RRT; }
276
277  /// \brief True if this is a method redeclaration in the same interface.
278  bool isRedeclaration() const { return IsRedeclaration; }
279  void setAsRedeclaration(const ObjCMethodDecl *PrevMethod);
280
281  // Location information, modeled after the Stmt API.
282  SourceLocation getLocStart() const { return getLocation(); }
283  SourceLocation getLocEnd() const { return EndLoc; }
284  void setEndLoc(SourceLocation Loc) { EndLoc = Loc; }
285  virtual SourceRange getSourceRange() const {
286    return SourceRange(getLocation(), EndLoc);
287  }
288
289  SourceLocation getSelectorStartLoc() const { return getSelectorLoc(0); }
290  SourceLocation getSelectorLoc(unsigned Index) const {
291    assert(Index < getNumSelectorLocs() && "Index out of range!");
292    if (hasStandardSelLocs())
293      return getStandardSelectorLoc(Index, getSelector(),
294                                   getSelLocsKind() == SelLoc_StandardWithSpace,
295                      llvm::makeArrayRef(const_cast<ParmVarDecl**>(getParams()),
296                                         NumParams),
297                                   EndLoc);
298    return getStoredSelLocs()[Index];
299  }
300
301  void getSelectorLocs(SmallVectorImpl<SourceLocation> &SelLocs) const;
302
303  unsigned getNumSelectorLocs() const {
304    if (isImplicit())
305      return 0;
306    Selector Sel = getSelector();
307    if (Sel.isUnarySelector())
308      return 1;
309    return Sel.getNumArgs();
310  }
311
312  ObjCInterfaceDecl *getClassInterface();
313  const ObjCInterfaceDecl *getClassInterface() const {
314    return const_cast<ObjCMethodDecl*>(this)->getClassInterface();
315  }
316
317  Selector getSelector() const { return getDeclName().getObjCSelector(); }
318
319  QualType getResultType() const { return MethodDeclType; }
320  void setResultType(QualType T) { MethodDeclType = T; }
321
322  /// \brief Determine the type of an expression that sends a message to this
323  /// function.
324  QualType getSendResultType() const {
325    return getResultType().getNonLValueExprType(getASTContext());
326  }
327
328  TypeSourceInfo *getResultTypeSourceInfo() const { return ResultTInfo; }
329  void setResultTypeSourceInfo(TypeSourceInfo *TInfo) { ResultTInfo = TInfo; }
330
331  // Iterator access to formal parameters.
332  unsigned param_size() const { return NumParams; }
333  typedef const ParmVarDecl *const *param_const_iterator;
334  typedef ParmVarDecl *const *param_iterator;
335  param_const_iterator param_begin() const { return getParams(); }
336  param_const_iterator param_end() const { return getParams() + NumParams; }
337  param_iterator param_begin() { return getParams(); }
338  param_iterator param_end() { return getParams() + NumParams; }
339  // This method returns and of the parameters which are part of the selector
340  // name mangling requirements.
341  param_const_iterator sel_param_end() const {
342    return param_begin() + getSelector().getNumArgs();
343  }
344
345  /// \brief Sets the method's parameters and selector source locations.
346  /// If the method is implicit (not coming from source) \arg SelLocs is
347  /// ignored.
348  void setMethodParams(ASTContext &C,
349                       ArrayRef<ParmVarDecl*> Params,
350                       ArrayRef<SourceLocation> SelLocs =
351                           ArrayRef<SourceLocation>());
352
353  // Iterator access to parameter types.
354  typedef std::const_mem_fun_t<QualType, ParmVarDecl> deref_fun;
355  typedef llvm::mapped_iterator<param_const_iterator, deref_fun>
356      arg_type_iterator;
357
358  arg_type_iterator arg_type_begin() const {
359    return llvm::map_iterator(param_begin(), deref_fun(&ParmVarDecl::getType));
360  }
361  arg_type_iterator arg_type_end() const {
362    return llvm::map_iterator(param_end(), deref_fun(&ParmVarDecl::getType));
363  }
364
365  /// createImplicitParams - Used to lazily create the self and cmd
366  /// implict parameters. This must be called prior to using getSelfDecl()
367  /// or getCmdDecl(). The call is ignored if the implicit paramters
368  /// have already been created.
369  void createImplicitParams(ASTContext &Context, const ObjCInterfaceDecl *ID);
370
371  ImplicitParamDecl * getSelfDecl() const { return SelfDecl; }
372  void setSelfDecl(ImplicitParamDecl *SD) { SelfDecl = SD; }
373  ImplicitParamDecl * getCmdDecl() const { return CmdDecl; }
374  void setCmdDecl(ImplicitParamDecl *CD) { CmdDecl = CD; }
375
376  /// Determines the family of this method.
377  ObjCMethodFamily getMethodFamily() const;
378
379  bool isInstanceMethod() const { return IsInstance; }
380  void setInstanceMethod(bool isInst) { IsInstance = isInst; }
381  bool isVariadic() const { return IsVariadic; }
382  void setVariadic(bool isVar) { IsVariadic = isVar; }
383
384  bool isClassMethod() const { return !IsInstance; }
385
386  bool isSynthesized() const { return IsSynthesized; }
387  void setSynthesized(bool isSynth) { IsSynthesized = isSynth; }
388
389  bool isDefined() const { return IsDefined; }
390  void setDefined(bool isDefined) { IsDefined = isDefined; }
391
392  // Related to protocols declared in  @protocol
393  void setDeclImplementation(ImplementationControl ic) {
394    DeclImplementation = ic;
395  }
396  ImplementationControl getImplementationControl() const {
397    return ImplementationControl(DeclImplementation);
398  }
399
400  virtual Stmt *getBody() const {
401    return (Stmt*) Body;
402  }
403  CompoundStmt *getCompoundBody() { return (CompoundStmt*)Body; }
404  void setBody(Stmt *B) { Body = B; }
405
406  /// \brief Returns whether this specific method is a definition.
407  bool isThisDeclarationADefinition() const { return Body; }
408
409  // Implement isa/cast/dyncast/etc.
410  static bool classof(const Decl *D) { return classofKind(D->getKind()); }
411  static bool classof(const ObjCMethodDecl *D) { return true; }
412  static bool classofKind(Kind K) { return K == ObjCMethod; }
413  static DeclContext *castToDeclContext(const ObjCMethodDecl *D) {
414    return static_cast<DeclContext *>(const_cast<ObjCMethodDecl*>(D));
415  }
416  static ObjCMethodDecl *castFromDeclContext(const DeclContext *DC) {
417    return static_cast<ObjCMethodDecl *>(const_cast<DeclContext*>(DC));
418  }
419
420  friend class ASTDeclReader;
421  friend class ASTDeclWriter;
422};
423
424/// ObjCContainerDecl - Represents a container for method declarations.
425/// Current sub-classes are ObjCInterfaceDecl, ObjCCategoryDecl,
426/// ObjCProtocolDecl, and ObjCImplDecl.
427///
428class ObjCContainerDecl : public NamedDecl, public DeclContext {
429  virtual void anchor();
430
431  SourceLocation AtStart;
432
433  // These two locations in the range mark the end of the method container.
434  // The first points to the '@' token, and the second to the 'end' token.
435  SourceRange AtEnd;
436public:
437
438  ObjCContainerDecl(Kind DK, DeclContext *DC,
439                    IdentifierInfo *Id, SourceLocation nameLoc,
440                    SourceLocation atStartLoc)
441    : NamedDecl(DK, DC, nameLoc, Id), DeclContext(DK), AtStart(atStartLoc) {}
442
443  // Iterator access to properties.
444  typedef specific_decl_iterator<ObjCPropertyDecl> prop_iterator;
445  prop_iterator prop_begin() const {
446    return prop_iterator(decls_begin());
447  }
448  prop_iterator prop_end() const {
449    return prop_iterator(decls_end());
450  }
451
452  // Iterator access to instance/class methods.
453  typedef specific_decl_iterator<ObjCMethodDecl> method_iterator;
454  method_iterator meth_begin() const {
455    return method_iterator(decls_begin());
456  }
457  method_iterator meth_end() const {
458    return method_iterator(decls_end());
459  }
460
461  typedef filtered_decl_iterator<ObjCMethodDecl,
462                                 &ObjCMethodDecl::isInstanceMethod>
463    instmeth_iterator;
464  instmeth_iterator instmeth_begin() const {
465    return instmeth_iterator(decls_begin());
466  }
467  instmeth_iterator instmeth_end() const {
468    return instmeth_iterator(decls_end());
469  }
470
471  typedef filtered_decl_iterator<ObjCMethodDecl,
472                                 &ObjCMethodDecl::isClassMethod>
473    classmeth_iterator;
474  classmeth_iterator classmeth_begin() const {
475    return classmeth_iterator(decls_begin());
476  }
477  classmeth_iterator classmeth_end() const {
478    return classmeth_iterator(decls_end());
479  }
480
481  // Get the local instance/class method declared in this interface.
482  ObjCMethodDecl *getMethod(Selector Sel, bool isInstance) const;
483  ObjCMethodDecl *getInstanceMethod(Selector Sel) const {
484    return getMethod(Sel, true/*isInstance*/);
485  }
486  ObjCMethodDecl *getClassMethod(Selector Sel) const {
487    return getMethod(Sel, false/*isInstance*/);
488  }
489  ObjCIvarDecl *getIvarDecl(IdentifierInfo *Id) const;
490
491  ObjCPropertyDecl *FindPropertyDeclaration(IdentifierInfo *PropertyId) const;
492
493  SourceLocation getAtStartLoc() const { return AtStart; }
494  void setAtStartLoc(SourceLocation Loc) { AtStart = Loc; }
495
496  // Marks the end of the container.
497  SourceRange getAtEndRange() const {
498    return AtEnd;
499  }
500  void setAtEndRange(SourceRange atEnd) {
501    AtEnd = atEnd;
502  }
503
504  virtual SourceRange getSourceRange() const {
505    return SourceRange(AtStart, getAtEndRange().getEnd());
506  }
507
508  // Implement isa/cast/dyncast/etc.
509  static bool classof(const Decl *D) { return classofKind(D->getKind()); }
510  static bool classof(const ObjCContainerDecl *D) { return true; }
511  static bool classofKind(Kind K) {
512    return K >= firstObjCContainer &&
513           K <= lastObjCContainer;
514  }
515
516  static DeclContext *castToDeclContext(const ObjCContainerDecl *D) {
517    return static_cast<DeclContext *>(const_cast<ObjCContainerDecl*>(D));
518  }
519  static ObjCContainerDecl *castFromDeclContext(const DeclContext *DC) {
520    return static_cast<ObjCContainerDecl *>(const_cast<DeclContext*>(DC));
521  }
522};
523
524/// ObjCInterfaceDecl - Represents an ObjC class declaration. For example:
525///
526///   // MostPrimitive declares no super class (not particularly useful).
527///   @interface MostPrimitive
528///     // no instance variables or methods.
529///   @end
530///
531///   // NSResponder inherits from NSObject & implements NSCoding (a protocol).
532///   @interface NSResponder : NSObject <NSCoding>
533///   { // instance variables are represented by ObjCIvarDecl.
534///     id nextResponder; // nextResponder instance variable.
535///   }
536///   - (NSResponder *)nextResponder; // return a pointer to NSResponder.
537///   - (void)mouseMoved:(NSEvent *)theEvent; // return void, takes a pointer
538///   @end                                    // to an NSEvent.
539///
540///   Unlike C/C++, forward class declarations are accomplished with @class.
541///   Unlike C/C++, @class allows for a list of classes to be forward declared.
542///   Unlike C++, ObjC is a single-rooted class model. In Cocoa, classes
543///   typically inherit from NSObject (an exception is NSProxy).
544///
545class ObjCInterfaceDecl : public ObjCContainerDecl
546                        , public Redeclarable<ObjCInterfaceDecl> {
547  virtual void anchor();
548
549  /// TypeForDecl - This indicates the Type object that represents this
550  /// TypeDecl.  It is a cache maintained by ASTContext::getObjCInterfaceType
551  mutable const Type *TypeForDecl;
552  friend class ASTContext;
553
554  struct DefinitionData {
555    /// \brief The definition of this class, for quick access from any
556    /// declaration.
557    ObjCInterfaceDecl *Definition;
558
559    /// Class's super class.
560    ObjCInterfaceDecl *SuperClass;
561
562    /// Protocols referenced in the @interface  declaration
563    ObjCProtocolList ReferencedProtocols;
564
565    /// Protocols reference in both the @interface and class extensions.
566    ObjCList<ObjCProtocolDecl> AllReferencedProtocols;
567
568    /// \brief List of categories and class extensions defined for this class.
569    ///
570    /// Categories are stored as a linked list in the AST, since the categories
571    /// and class extensions come long after the initial interface declaration,
572    /// and we avoid dynamically-resized arrays in the AST wherever possible.
573    ObjCCategoryDecl *CategoryList;
574
575    /// IvarList - List of all ivars defined by this class; including class
576    /// extensions and implementation. This list is built lazily.
577    ObjCIvarDecl *IvarList;
578
579    /// \brief Indicates that the contents of this Objective-C class will be
580    /// completed by the external AST source when required.
581    mutable bool ExternallyCompleted : 1;
582
583    /// \brief The location of the superclass, if any.
584    SourceLocation SuperClassLoc;
585
586    /// \brief The location of the last location in this declaration, before
587    /// the properties/methods. For example, this will be the '>', '}', or
588    /// identifier,
589    SourceLocation EndLoc;
590
591    DefinitionData() : Definition(), SuperClass(), CategoryList(), IvarList(),
592                       ExternallyCompleted() { }
593  };
594
595  ObjCInterfaceDecl(DeclContext *DC, SourceLocation atLoc, IdentifierInfo *Id,
596                    SourceLocation CLoc, ObjCInterfaceDecl *PrevDecl,
597                    bool isInternal);
598
599  void LoadExternalDefinition() const;
600
601  /// \brief Contains a pointer to the data associated with this class,
602  /// which will be NULL if this class has not yet been defined.
603  DefinitionData *Data;
604
605  DefinitionData &data() const {
606    assert(Data != 0 && "Declaration has no definition!");
607    return *Data;
608  }
609
610  /// \brief Allocate the definition data for this class.
611  void allocateDefinitionData();
612
613  typedef Redeclarable<ObjCInterfaceDecl> redeclarable_base;
614  virtual ObjCInterfaceDecl *getNextRedeclaration() {
615    return RedeclLink.getNext();
616  }
617
618public:
619  static ObjCInterfaceDecl *Create(ASTContext &C, DeclContext *DC,
620                                   SourceLocation atLoc,
621                                   IdentifierInfo *Id,
622                                   ObjCInterfaceDecl *PrevDecl,
623                                   SourceLocation ClassLoc = SourceLocation(),
624                                   bool isInternal = false);
625
626  static ObjCInterfaceDecl *CreateEmpty(ASTContext &C);
627
628  virtual SourceRange getSourceRange() const {
629    if (isThisDeclarationADefinition())
630      return ObjCContainerDecl::getSourceRange();
631
632    return SourceRange(getAtStartLoc(), getLocation());
633  }
634
635  /// \brief Indicate that this Objective-C class is complete, but that
636  /// the external AST source will be responsible for filling in its contents
637  /// when a complete class is required.
638  void setExternallyCompleted();
639
640  const ObjCProtocolList &getReferencedProtocols() const {
641    if (data().ExternallyCompleted)
642      LoadExternalDefinition();
643
644    return data().ReferencedProtocols;
645  }
646
647  ObjCImplementationDecl *getImplementation() const;
648  void setImplementation(ObjCImplementationDecl *ImplD);
649
650  ObjCCategoryDecl *FindCategoryDeclaration(IdentifierInfo *CategoryId) const;
651
652  // Get the local instance/class method declared in a category.
653  ObjCMethodDecl *getCategoryInstanceMethod(Selector Sel) const;
654  ObjCMethodDecl *getCategoryClassMethod(Selector Sel) const;
655  ObjCMethodDecl *getCategoryMethod(Selector Sel, bool isInstance) const {
656    return isInstance ? getInstanceMethod(Sel)
657                      : getClassMethod(Sel);
658  }
659
660  typedef ObjCProtocolList::iterator protocol_iterator;
661
662  protocol_iterator protocol_begin() const {
663    // FIXME: Should make sure no callers ever do this.
664    if (!hasDefinition())
665      return protocol_iterator();
666
667    if (data().ExternallyCompleted)
668      LoadExternalDefinition();
669
670    return data().ReferencedProtocols.begin();
671  }
672  protocol_iterator protocol_end() const {
673    // FIXME: Should make sure no callers ever do this.
674    if (!hasDefinition())
675      return protocol_iterator();
676
677    if (data().ExternallyCompleted)
678      LoadExternalDefinition();
679
680    return data().ReferencedProtocols.end();
681  }
682
683  typedef ObjCProtocolList::loc_iterator protocol_loc_iterator;
684
685  protocol_loc_iterator protocol_loc_begin() const {
686    // FIXME: Should make sure no callers ever do this.
687    if (!hasDefinition())
688      return protocol_loc_iterator();
689
690    if (data().ExternallyCompleted)
691      LoadExternalDefinition();
692
693    return data().ReferencedProtocols.loc_begin();
694  }
695
696  protocol_loc_iterator protocol_loc_end() const {
697    // FIXME: Should make sure no callers ever do this.
698    if (!hasDefinition())
699      return protocol_loc_iterator();
700
701    if (data().ExternallyCompleted)
702      LoadExternalDefinition();
703
704    return data().ReferencedProtocols.loc_end();
705  }
706
707  typedef ObjCList<ObjCProtocolDecl>::iterator all_protocol_iterator;
708
709  all_protocol_iterator all_referenced_protocol_begin() const {
710    // FIXME: Should make sure no callers ever do this.
711    if (!hasDefinition())
712      return all_protocol_iterator();
713
714    if (data().ExternallyCompleted)
715      LoadExternalDefinition();
716
717    return data().AllReferencedProtocols.empty()
718             ? protocol_begin()
719             : data().AllReferencedProtocols.begin();
720  }
721  all_protocol_iterator all_referenced_protocol_end() const {
722    // FIXME: Should make sure no callers ever do this.
723    if (!hasDefinition())
724      return all_protocol_iterator();
725
726    if (data().ExternallyCompleted)
727      LoadExternalDefinition();
728
729    return data().AllReferencedProtocols.empty()
730             ? protocol_end()
731             : data().AllReferencedProtocols.end();
732  }
733
734  typedef specific_decl_iterator<ObjCIvarDecl> ivar_iterator;
735
736  ivar_iterator ivar_begin() const {
737    if (const ObjCInterfaceDecl *Def = getDefinition())
738      return ivar_iterator(Def->decls_begin());
739
740    // FIXME: Should make sure no callers ever do this.
741    return ivar_iterator();
742  }
743  ivar_iterator ivar_end() const {
744    if (const ObjCInterfaceDecl *Def = getDefinition())
745      return ivar_iterator(Def->decls_end());
746
747    // FIXME: Should make sure no callers ever do this.
748    return ivar_iterator();
749  }
750
751  unsigned ivar_size() const {
752    return std::distance(ivar_begin(), ivar_end());
753  }
754
755  bool ivar_empty() const { return ivar_begin() == ivar_end(); }
756
757  ObjCIvarDecl *all_declared_ivar_begin();
758  const ObjCIvarDecl *all_declared_ivar_begin() const {
759    // Even though this modifies IvarList, it's conceptually const:
760    // the ivar chain is essentially a cached property of ObjCInterfaceDecl.
761    return const_cast<ObjCInterfaceDecl *>(this)->all_declared_ivar_begin();
762  }
763  void setIvarList(ObjCIvarDecl *ivar) { data().IvarList = ivar; }
764
765  /// setProtocolList - Set the list of protocols that this interface
766  /// implements.
767  void setProtocolList(ObjCProtocolDecl *const* List, unsigned Num,
768                       const SourceLocation *Locs, ASTContext &C) {
769    data().ReferencedProtocols.set(List, Num, Locs, C);
770  }
771
772  /// mergeClassExtensionProtocolList - Merge class extension's protocol list
773  /// into the protocol list for this class.
774  void mergeClassExtensionProtocolList(ObjCProtocolDecl *const* List,
775                                       unsigned Num,
776                                       ASTContext &C);
777
778  /// \brief Determine whether this particular declaration of this class is
779  /// actually also a definition.
780  bool isThisDeclarationADefinition() const {
781    return Data && Data->Definition == this;
782  }
783
784  /// \brief Determine whether this class has been defined.
785  bool hasDefinition() const { return Data; }
786
787  /// \brief Retrieve the definition of this class, or NULL if this class
788  /// has been forward-declared (with @class) but not yet defined (with
789  /// @interface).
790  ObjCInterfaceDecl *getDefinition() {
791    return hasDefinition()? Data->Definition : 0;
792  }
793
794  /// \brief Retrieve the definition of this class, or NULL if this class
795  /// has been forward-declared (with @class) but not yet defined (with
796  /// @interface).
797  const ObjCInterfaceDecl *getDefinition() const {
798    return hasDefinition()? Data->Definition : 0;
799  }
800
801  /// \brief Starts the definition of this Objective-C class, taking it from
802  /// a forward declaration (@class) to a definition (@interface).
803  void startDefinition();
804
805  ObjCInterfaceDecl *getSuperClass() const {
806    // FIXME: Should make sure no callers ever do this.
807    if (!hasDefinition())
808      return 0;
809
810    if (data().ExternallyCompleted)
811      LoadExternalDefinition();
812
813    return data().SuperClass;
814  }
815
816  void setSuperClass(ObjCInterfaceDecl * superCls) {
817    data().SuperClass = superCls;
818  }
819
820  ObjCCategoryDecl* getCategoryList() const {
821    // FIXME: Should make sure no callers ever do this.
822    if (!hasDefinition())
823      return 0;
824
825    if (data().ExternallyCompleted)
826      LoadExternalDefinition();
827
828    return data().CategoryList;
829  }
830
831  void setCategoryList(ObjCCategoryDecl *category) {
832    data().CategoryList = category;
833  }
834
835  ObjCCategoryDecl* getFirstClassExtension() const;
836
837  ObjCPropertyDecl
838    *FindPropertyVisibleInPrimaryClass(IdentifierInfo *PropertyId) const;
839
840  /// isSuperClassOf - Return true if this class is the specified class or is a
841  /// super class of the specified interface class.
842  bool isSuperClassOf(const ObjCInterfaceDecl *I) const {
843    // If RHS is derived from LHS it is OK; else it is not OK.
844    while (I != NULL) {
845      if (declaresSameEntity(this, I))
846        return true;
847
848      I = I->getSuperClass();
849    }
850    return false;
851  }
852
853  /// isArcWeakrefUnavailable - Checks for a class or one of its super classes
854  /// to be incompatible with __weak references. Returns true if it is.
855  bool isArcWeakrefUnavailable() const {
856    const ObjCInterfaceDecl *Class = this;
857    while (Class) {
858      if (Class->hasAttr<ArcWeakrefUnavailableAttr>())
859        return true;
860      Class = Class->getSuperClass();
861   }
862   return false;
863  }
864
865  ObjCIvarDecl *lookupInstanceVariable(IdentifierInfo *IVarName,
866                                       ObjCInterfaceDecl *&ClassDeclared);
867  ObjCIvarDecl *lookupInstanceVariable(IdentifierInfo *IVarName) {
868    ObjCInterfaceDecl *ClassDeclared;
869    return lookupInstanceVariable(IVarName, ClassDeclared);
870  }
871
872  // Lookup a method. First, we search locally. If a method isn't
873  // found, we search referenced protocols and class categories.
874  ObjCMethodDecl *lookupMethod(Selector Sel, bool isInstance) const;
875  ObjCMethodDecl *lookupInstanceMethod(Selector Sel) const {
876    return lookupMethod(Sel, true/*isInstance*/);
877  }
878  ObjCMethodDecl *lookupClassMethod(Selector Sel) const {
879    return lookupMethod(Sel, false/*isInstance*/);
880  }
881  ObjCInterfaceDecl *lookupInheritedClass(const IdentifierInfo *ICName);
882
883  // Lookup a method in the classes implementation hierarchy.
884  ObjCMethodDecl *lookupPrivateMethod(const Selector &Sel, bool Instance=true);
885
886  SourceLocation getEndOfDefinitionLoc() const {
887    if (!hasDefinition())
888      return getLocation();
889
890    return data().EndLoc;
891  }
892
893  void setEndOfDefinitionLoc(SourceLocation LE) { data().EndLoc = LE; }
894
895  void setSuperClassLoc(SourceLocation Loc) { data().SuperClassLoc = Loc; }
896  SourceLocation getSuperClassLoc() const { return data().SuperClassLoc; }
897
898  /// isImplicitInterfaceDecl - check that this is an implicitly declared
899  /// ObjCInterfaceDecl node. This is for legacy objective-c @implementation
900  /// declaration without an @interface declaration.
901  bool isImplicitInterfaceDecl() const { return isImplicit(); }
902  void setImplicitInterfaceDecl(bool val) { setImplicit(val); }
903
904  /// ClassImplementsProtocol - Checks that 'lProto' protocol
905  /// has been implemented in IDecl class, its super class or categories (if
906  /// lookupCategory is true).
907  bool ClassImplementsProtocol(ObjCProtocolDecl *lProto,
908                               bool lookupCategory,
909                               bool RHSIsQualifiedID = false);
910
911  typedef redeclarable_base::redecl_iterator redecl_iterator;
912  redecl_iterator redecls_begin() const {
913    return redeclarable_base::redecls_begin();
914  }
915  redecl_iterator redecls_end() const {
916    return redeclarable_base::redecls_end();
917  }
918
919  /// Retrieves the canonical declaration of this Objective-C class.
920  ObjCInterfaceDecl *getCanonicalDecl() {
921    return getFirstDeclaration();
922  }
923  const ObjCInterfaceDecl *getCanonicalDecl() const {
924    return getFirstDeclaration();
925  }
926
927  // Low-level accessor
928  const Type *getTypeForDecl() const { return TypeForDecl; }
929  void setTypeForDecl(const Type *TD) const { TypeForDecl = TD; }
930
931  static bool classof(const Decl *D) { return classofKind(D->getKind()); }
932  static bool classof(const ObjCInterfaceDecl *D) { return true; }
933  static bool classofKind(Kind K) { return K == ObjCInterface; }
934
935  friend class ASTReader;
936  friend class ASTDeclReader;
937  friend class ASTDeclWriter;
938};
939
940/// ObjCIvarDecl - Represents an ObjC instance variable. In general, ObjC
941/// instance variables are identical to C. The only exception is Objective-C
942/// supports C++ style access control. For example:
943///
944///   @interface IvarExample : NSObject
945///   {
946///     id defaultToProtected;
947///   @public:
948///     id canBePublic; // same as C++.
949///   @protected:
950///     id canBeProtected; // same as C++.
951///   @package:
952///     id canBePackage; // framework visibility (not available in C++).
953///   }
954///
955class ObjCIvarDecl : public FieldDecl {
956  virtual void anchor();
957
958public:
959  enum AccessControl {
960    None, Private, Protected, Public, Package
961  };
962
963private:
964  ObjCIvarDecl(ObjCContainerDecl *DC, SourceLocation StartLoc,
965               SourceLocation IdLoc, IdentifierInfo *Id,
966               QualType T, TypeSourceInfo *TInfo, AccessControl ac, Expr *BW,
967               bool synthesized)
968    : FieldDecl(ObjCIvar, DC, StartLoc, IdLoc, Id, T, TInfo, BW,
969                /*Mutable=*/false, /*HasInit=*/false),
970      NextIvar(0), DeclAccess(ac), Synthesized(synthesized) {}
971
972public:
973  static ObjCIvarDecl *Create(ASTContext &C, ObjCContainerDecl *DC,
974                              SourceLocation StartLoc, SourceLocation IdLoc,
975                              IdentifierInfo *Id, QualType T,
976                              TypeSourceInfo *TInfo,
977                              AccessControl ac, Expr *BW = NULL,
978                              bool synthesized=false);
979
980  /// \brief Return the class interface that this ivar is logically contained
981  /// in; this is either the interface where the ivar was declared, or the
982  /// interface the ivar is conceptually a part of in the case of synthesized
983  /// ivars.
984  const ObjCInterfaceDecl *getContainingInterface() const;
985
986  ObjCIvarDecl *getNextIvar() { return NextIvar; }
987  const ObjCIvarDecl *getNextIvar() const { return NextIvar; }
988  void setNextIvar(ObjCIvarDecl *ivar) { NextIvar = ivar; }
989
990  void setAccessControl(AccessControl ac) { DeclAccess = ac; }
991
992  AccessControl getAccessControl() const { return AccessControl(DeclAccess); }
993
994  AccessControl getCanonicalAccessControl() const {
995    return DeclAccess == None ? Protected : AccessControl(DeclAccess);
996  }
997
998  void setSynthesize(bool synth) { Synthesized = synth; }
999  bool getSynthesize() const { return Synthesized; }
1000
1001  // Implement isa/cast/dyncast/etc.
1002  static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1003  static bool classof(const ObjCIvarDecl *D) { return true; }
1004  static bool classofKind(Kind K) { return K == ObjCIvar; }
1005private:
1006  /// NextIvar - Next Ivar in the list of ivars declared in class; class's
1007  /// extensions and class's implementation
1008  ObjCIvarDecl *NextIvar;
1009
1010  // NOTE: VC++ treats enums as signed, avoid using the AccessControl enum
1011  unsigned DeclAccess : 3;
1012  unsigned Synthesized : 1;
1013};
1014
1015
1016/// ObjCAtDefsFieldDecl - Represents a field declaration created by an
1017///  @defs(...).
1018class ObjCAtDefsFieldDecl : public FieldDecl {
1019  virtual void anchor();
1020  ObjCAtDefsFieldDecl(DeclContext *DC, SourceLocation StartLoc,
1021                      SourceLocation IdLoc, IdentifierInfo *Id,
1022                      QualType T, Expr *BW)
1023    : FieldDecl(ObjCAtDefsField, DC, StartLoc, IdLoc, Id, T,
1024                /*TInfo=*/0, // FIXME: Do ObjCAtDefs have declarators ?
1025                BW, /*Mutable=*/false, /*HasInit=*/false) {}
1026
1027public:
1028  static ObjCAtDefsFieldDecl *Create(ASTContext &C, DeclContext *DC,
1029                                     SourceLocation StartLoc,
1030                                     SourceLocation IdLoc, IdentifierInfo *Id,
1031                                     QualType T, Expr *BW);
1032
1033  // Implement isa/cast/dyncast/etc.
1034  static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1035  static bool classof(const ObjCAtDefsFieldDecl *D) { return true; }
1036  static bool classofKind(Kind K) { return K == ObjCAtDefsField; }
1037};
1038
1039/// ObjCProtocolDecl - Represents a protocol declaration. ObjC protocols
1040/// declare a pure abstract type (i.e no instance variables are permitted).
1041/// Protocols originally drew inspiration from C++ pure virtual functions (a C++
1042/// feature with nice semantics and lousy syntax:-). Here is an example:
1043///
1044/// @protocol NSDraggingInfo <refproto1, refproto2>
1045/// - (NSWindow *)draggingDestinationWindow;
1046/// - (NSImage *)draggedImage;
1047/// @end
1048///
1049/// This says that NSDraggingInfo requires two methods and requires everything
1050/// that the two "referenced protocols" 'refproto1' and 'refproto2' require as
1051/// well.
1052///
1053/// @interface ImplementsNSDraggingInfo : NSObject <NSDraggingInfo>
1054/// @end
1055///
1056/// ObjC protocols inspired Java interfaces. Unlike Java, ObjC classes and
1057/// protocols are in distinct namespaces. For example, Cocoa defines both
1058/// an NSObject protocol and class (which isn't allowed in Java). As a result,
1059/// protocols are referenced using angle brackets as follows:
1060///
1061/// id <NSDraggingInfo> anyObjectThatImplementsNSDraggingInfo;
1062///
1063class ObjCProtocolDecl : public ObjCContainerDecl {
1064  virtual void anchor();
1065
1066  /// Referenced protocols
1067  ObjCProtocolList ReferencedProtocols;
1068
1069  bool InitiallyForwardDecl : 1;
1070  bool isForwardProtoDecl : 1; // declared with @protocol.
1071
1072  SourceLocation EndLoc; // marks the '>' or identifier.
1073
1074  ObjCProtocolDecl(DeclContext *DC, IdentifierInfo *Id,
1075                   SourceLocation nameLoc, SourceLocation atStartLoc,
1076                   bool isForwardDecl)
1077    : ObjCContainerDecl(ObjCProtocol, DC, Id, nameLoc, atStartLoc),
1078      InitiallyForwardDecl(isForwardDecl),
1079      isForwardProtoDecl(isForwardDecl) {
1080  }
1081
1082public:
1083  static ObjCProtocolDecl *Create(ASTContext &C, DeclContext *DC,
1084                                  IdentifierInfo *Id,
1085                                  SourceLocation nameLoc,
1086                                  SourceLocation atStartLoc,
1087                                  bool isForwardDecl);
1088
1089  const ObjCProtocolList &getReferencedProtocols() const {
1090    return ReferencedProtocols;
1091  }
1092  typedef ObjCProtocolList::iterator protocol_iterator;
1093  protocol_iterator protocol_begin() const {return ReferencedProtocols.begin();}
1094  protocol_iterator protocol_end() const { return ReferencedProtocols.end(); }
1095  typedef ObjCProtocolList::loc_iterator protocol_loc_iterator;
1096  protocol_loc_iterator protocol_loc_begin() const {
1097    return ReferencedProtocols.loc_begin();
1098  }
1099  protocol_loc_iterator protocol_loc_end() const {
1100    return ReferencedProtocols.loc_end();
1101  }
1102  unsigned protocol_size() const { return ReferencedProtocols.size(); }
1103
1104  /// setProtocolList - Set the list of protocols that this interface
1105  /// implements.
1106  void setProtocolList(ObjCProtocolDecl *const*List, unsigned Num,
1107                       const SourceLocation *Locs, ASTContext &C) {
1108    ReferencedProtocols.set(List, Num, Locs, C);
1109  }
1110
1111  ObjCProtocolDecl *lookupProtocolNamed(IdentifierInfo *PName);
1112
1113  // Lookup a method. First, we search locally. If a method isn't
1114  // found, we search referenced protocols and class categories.
1115  ObjCMethodDecl *lookupMethod(Selector Sel, bool isInstance) const;
1116  ObjCMethodDecl *lookupInstanceMethod(Selector Sel) const {
1117    return lookupMethod(Sel, true/*isInstance*/);
1118  }
1119  ObjCMethodDecl *lookupClassMethod(Selector Sel) const {
1120    return lookupMethod(Sel, false/*isInstance*/);
1121  }
1122
1123  /// \brief True if it was initially a forward reference.
1124  /// Differs with \see isForwardDecl in that \see isForwardDecl will change to
1125  /// false when we see the definition, but this will remain true.
1126  bool isInitiallyForwardDecl() const { return InitiallyForwardDecl; }
1127
1128  bool isForwardDecl() const { return isForwardProtoDecl; }
1129
1130  void completedForwardDecl();
1131
1132  // Location information, modeled after the Stmt API.
1133  SourceLocation getLocStart() const { return getAtStartLoc(); } // '@'protocol
1134  SourceLocation getLocEnd() const { return EndLoc; }
1135  void setLocEnd(SourceLocation LE) { EndLoc = LE; }
1136
1137  static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1138  static bool classof(const ObjCProtocolDecl *D) { return true; }
1139  static bool classofKind(Kind K) { return K == ObjCProtocol; }
1140
1141  friend class ASTDeclReader;
1142  friend class ASTDeclWriter;
1143};
1144
1145/// ObjCClassDecl - Specifies a list of forward class declarations. For example:
1146///
1147/// @class NSCursor, NSImage, NSPasteboard, NSWindow;
1148///
1149class ObjCClassDecl : public Decl {
1150  ObjCInterfaceDecl *Interface;
1151  SourceLocation InterfaceLoc;
1152
1153  ObjCClassDecl(DeclContext *DC, SourceLocation L,
1154                ObjCInterfaceDecl *Interface, SourceLocation InterfaceLoc);
1155
1156  friend class ASTDeclReader;
1157  friend class ASTDeclWriter;
1158
1159public:
1160  static ObjCClassDecl *Create(ASTContext &C, DeclContext *DC, SourceLocation L,
1161                               ObjCInterfaceDecl *Interface = 0,
1162                               SourceLocation InterfaceLoc = SourceLocation());
1163
1164  ObjCInterfaceDecl *getForwardInterfaceDecl() const {
1165    return Interface;
1166  }
1167
1168  /// \brief Retrieve the location of the class name.
1169  SourceLocation getNameLoc() const { return InterfaceLoc; }
1170
1171  virtual SourceRange getSourceRange() const;
1172
1173  static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1174  static bool classof(const ObjCClassDecl *D) { return true; }
1175  static bool classofKind(Kind K) { return K == ObjCClass; }
1176};
1177
1178/// ObjCForwardProtocolDecl - Specifies a list of forward protocol declarations.
1179/// For example:
1180///
1181/// @protocol NSTextInput, NSChangeSpelling, NSDraggingInfo;
1182///
1183class ObjCForwardProtocolDecl : public Decl {
1184  virtual void anchor();
1185
1186  ObjCProtocolList ReferencedProtocols;
1187
1188  ObjCForwardProtocolDecl(DeclContext *DC, SourceLocation L,
1189                          ObjCProtocolDecl *const *Elts, unsigned nElts,
1190                          const SourceLocation *Locs, ASTContext &C);
1191
1192public:
1193  static ObjCForwardProtocolDecl *Create(ASTContext &C, DeclContext *DC,
1194                                         SourceLocation L,
1195                                         ObjCProtocolDecl *const *Elts,
1196                                         unsigned Num,
1197                                         const SourceLocation *Locs);
1198
1199  static ObjCForwardProtocolDecl *Create(ASTContext &C, DeclContext *DC,
1200                                         SourceLocation L) {
1201    return Create(C, DC, L, 0, 0, 0);
1202  }
1203
1204  typedef ObjCProtocolList::iterator protocol_iterator;
1205  protocol_iterator protocol_begin() const {return ReferencedProtocols.begin();}
1206  protocol_iterator protocol_end() const { return ReferencedProtocols.end(); }
1207  typedef ObjCProtocolList::loc_iterator protocol_loc_iterator;
1208  protocol_loc_iterator protocol_loc_begin() const {
1209    return ReferencedProtocols.loc_begin();
1210  }
1211  protocol_loc_iterator protocol_loc_end() const {
1212    return ReferencedProtocols.loc_end();
1213  }
1214
1215  unsigned protocol_size() const { return ReferencedProtocols.size(); }
1216
1217  /// setProtocolList - Set the list of forward protocols.
1218  void setProtocolList(ObjCProtocolDecl *const*List, unsigned Num,
1219                       const SourceLocation *Locs, ASTContext &C) {
1220    ReferencedProtocols.set(List, Num, Locs, C);
1221  }
1222  static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1223  static bool classof(const ObjCForwardProtocolDecl *D) { return true; }
1224  static bool classofKind(Kind K) { return K == ObjCForwardProtocol; }
1225};
1226
1227/// ObjCCategoryDecl - Represents a category declaration. A category allows
1228/// you to add methods to an existing class (without subclassing or modifying
1229/// the original class interface or implementation:-). Categories don't allow
1230/// you to add instance data. The following example adds "myMethod" to all
1231/// NSView's within a process:
1232///
1233/// @interface NSView (MyViewMethods)
1234/// - myMethod;
1235/// @end
1236///
1237/// Categories also allow you to split the implementation of a class across
1238/// several files (a feature more naturally supported in C++).
1239///
1240/// Categories were originally inspired by dynamic languages such as Common
1241/// Lisp and Smalltalk.  More traditional class-based languages (C++, Java)
1242/// don't support this level of dynamism, which is both powerful and dangerous.
1243///
1244class ObjCCategoryDecl : public ObjCContainerDecl {
1245  virtual void anchor();
1246
1247  /// Interface belonging to this category
1248  ObjCInterfaceDecl *ClassInterface;
1249
1250  /// referenced protocols in this category.
1251  ObjCProtocolList ReferencedProtocols;
1252
1253  /// Next category belonging to this class.
1254  /// FIXME: this should not be a singly-linked list.  Move storage elsewhere.
1255  ObjCCategoryDecl *NextClassCategory;
1256
1257  /// true of class extension has at least one bitfield ivar.
1258  bool HasSynthBitfield : 1;
1259
1260  /// \brief The location of the category name in this declaration.
1261  SourceLocation CategoryNameLoc;
1262
1263  ObjCCategoryDecl(DeclContext *DC, SourceLocation AtLoc,
1264                   SourceLocation ClassNameLoc, SourceLocation CategoryNameLoc,
1265                   IdentifierInfo *Id, ObjCInterfaceDecl *IDecl)
1266    : ObjCContainerDecl(ObjCCategory, DC, Id, ClassNameLoc, AtLoc),
1267      ClassInterface(IDecl), NextClassCategory(0), HasSynthBitfield(false),
1268      CategoryNameLoc(CategoryNameLoc) {
1269  }
1270public:
1271
1272  static ObjCCategoryDecl *Create(ASTContext &C, DeclContext *DC,
1273                                  SourceLocation AtLoc,
1274                                  SourceLocation ClassNameLoc,
1275                                  SourceLocation CategoryNameLoc,
1276                                  IdentifierInfo *Id,
1277                                  ObjCInterfaceDecl *IDecl);
1278  static ObjCCategoryDecl *Create(ASTContext &C, EmptyShell Empty);
1279
1280  ObjCInterfaceDecl *getClassInterface() { return ClassInterface; }
1281  const ObjCInterfaceDecl *getClassInterface() const { return ClassInterface; }
1282
1283  ObjCCategoryImplDecl *getImplementation() const;
1284  void setImplementation(ObjCCategoryImplDecl *ImplD);
1285
1286  /// setProtocolList - Set the list of protocols that this interface
1287  /// implements.
1288  void setProtocolList(ObjCProtocolDecl *const*List, unsigned Num,
1289                       const SourceLocation *Locs, ASTContext &C) {
1290    ReferencedProtocols.set(List, Num, Locs, C);
1291  }
1292
1293  const ObjCProtocolList &getReferencedProtocols() const {
1294    return ReferencedProtocols;
1295  }
1296
1297  typedef ObjCProtocolList::iterator protocol_iterator;
1298  protocol_iterator protocol_begin() const {return ReferencedProtocols.begin();}
1299  protocol_iterator protocol_end() const { return ReferencedProtocols.end(); }
1300  unsigned protocol_size() const { return ReferencedProtocols.size(); }
1301  typedef ObjCProtocolList::loc_iterator protocol_loc_iterator;
1302  protocol_loc_iterator protocol_loc_begin() const {
1303    return ReferencedProtocols.loc_begin();
1304  }
1305  protocol_loc_iterator protocol_loc_end() const {
1306    return ReferencedProtocols.loc_end();
1307  }
1308
1309  ObjCCategoryDecl *getNextClassCategory() const { return NextClassCategory; }
1310
1311  bool IsClassExtension() const { return getIdentifier() == 0; }
1312  const ObjCCategoryDecl *getNextClassExtension() const;
1313
1314  bool hasSynthBitfield() const { return HasSynthBitfield; }
1315  void setHasSynthBitfield (bool val) { HasSynthBitfield = val; }
1316
1317  typedef specific_decl_iterator<ObjCIvarDecl> ivar_iterator;
1318  ivar_iterator ivar_begin() const {
1319    return ivar_iterator(decls_begin());
1320  }
1321  ivar_iterator ivar_end() const {
1322    return ivar_iterator(decls_end());
1323  }
1324  unsigned ivar_size() const {
1325    return std::distance(ivar_begin(), ivar_end());
1326  }
1327  bool ivar_empty() const {
1328    return ivar_begin() == ivar_end();
1329  }
1330
1331  SourceLocation getCategoryNameLoc() const { return CategoryNameLoc; }
1332  void setCategoryNameLoc(SourceLocation Loc) { CategoryNameLoc = Loc; }
1333
1334  static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1335  static bool classof(const ObjCCategoryDecl *D) { return true; }
1336  static bool classofKind(Kind K) { return K == ObjCCategory; }
1337
1338  friend class ASTDeclReader;
1339  friend class ASTDeclWriter;
1340};
1341
1342class ObjCImplDecl : public ObjCContainerDecl {
1343  virtual void anchor();
1344
1345  /// Class interface for this class/category implementation
1346  ObjCInterfaceDecl *ClassInterface;
1347
1348protected:
1349  ObjCImplDecl(Kind DK, DeclContext *DC,
1350               ObjCInterfaceDecl *classInterface,
1351               SourceLocation nameLoc, SourceLocation atStartLoc)
1352    : ObjCContainerDecl(DK, DC,
1353                        classInterface? classInterface->getIdentifier() : 0,
1354                        nameLoc, atStartLoc),
1355      ClassInterface(classInterface) {}
1356
1357public:
1358  const ObjCInterfaceDecl *getClassInterface() const { return ClassInterface; }
1359  ObjCInterfaceDecl *getClassInterface() { return ClassInterface; }
1360  void setClassInterface(ObjCInterfaceDecl *IFace);
1361
1362  void addInstanceMethod(ObjCMethodDecl *method) {
1363    // FIXME: Context should be set correctly before we get here.
1364    method->setLexicalDeclContext(this);
1365    addDecl(method);
1366  }
1367  void addClassMethod(ObjCMethodDecl *method) {
1368    // FIXME: Context should be set correctly before we get here.
1369    method->setLexicalDeclContext(this);
1370    addDecl(method);
1371  }
1372
1373  void addPropertyImplementation(ObjCPropertyImplDecl *property);
1374
1375  ObjCPropertyImplDecl *FindPropertyImplDecl(IdentifierInfo *propertyId) const;
1376  ObjCPropertyImplDecl *FindPropertyImplIvarDecl(IdentifierInfo *ivarId) const;
1377
1378  // Iterator access to properties.
1379  typedef specific_decl_iterator<ObjCPropertyImplDecl> propimpl_iterator;
1380  propimpl_iterator propimpl_begin() const {
1381    return propimpl_iterator(decls_begin());
1382  }
1383  propimpl_iterator propimpl_end() const {
1384    return propimpl_iterator(decls_end());
1385  }
1386
1387  static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1388  static bool classof(const ObjCImplDecl *D) { return true; }
1389  static bool classofKind(Kind K) {
1390    return K >= firstObjCImpl && K <= lastObjCImpl;
1391  }
1392};
1393
1394/// ObjCCategoryImplDecl - An object of this class encapsulates a category
1395/// @implementation declaration. If a category class has declaration of a
1396/// property, its implementation must be specified in the category's
1397/// @implementation declaration. Example:
1398/// @interface I @end
1399/// @interface I(CATEGORY)
1400///    @property int p1, d1;
1401/// @end
1402/// @implementation I(CATEGORY)
1403///  @dynamic p1,d1;
1404/// @end
1405///
1406/// ObjCCategoryImplDecl
1407class ObjCCategoryImplDecl : public ObjCImplDecl {
1408  virtual void anchor();
1409
1410  // Category name
1411  IdentifierInfo *Id;
1412
1413  // Category name location
1414  SourceLocation CategoryNameLoc;
1415
1416  ObjCCategoryImplDecl(DeclContext *DC, IdentifierInfo *Id,
1417                       ObjCInterfaceDecl *classInterface,
1418                       SourceLocation nameLoc, SourceLocation atStartLoc,
1419                       SourceLocation CategoryNameLoc)
1420    : ObjCImplDecl(ObjCCategoryImpl, DC, classInterface, nameLoc, atStartLoc),
1421      Id(Id), CategoryNameLoc(CategoryNameLoc) {}
1422public:
1423  static ObjCCategoryImplDecl *Create(ASTContext &C, DeclContext *DC,
1424                                      IdentifierInfo *Id,
1425                                      ObjCInterfaceDecl *classInterface,
1426                                      SourceLocation nameLoc,
1427                                      SourceLocation atStartLoc,
1428                                      SourceLocation CategoryNameLoc);
1429
1430  /// getIdentifier - Get the identifier that names the category
1431  /// interface associated with this implementation.
1432  /// FIXME: This is a bad API, we are overriding the NamedDecl::getIdentifier()
1433  /// to mean something different. For example:
1434  /// ((NamedDecl *)SomeCategoryImplDecl)->getIdentifier()
1435  /// returns the class interface name, whereas
1436  /// ((ObjCCategoryImplDecl *)SomeCategoryImplDecl)->getIdentifier()
1437  /// returns the category name.
1438  IdentifierInfo *getIdentifier() const {
1439    return Id;
1440  }
1441  void setIdentifier(IdentifierInfo *II) { Id = II; }
1442
1443  ObjCCategoryDecl *getCategoryDecl() const;
1444
1445  SourceLocation getCategoryNameLoc() const { return CategoryNameLoc; }
1446
1447  /// getName - Get the name of identifier for the class interface associated
1448  /// with this implementation as a StringRef.
1449  //
1450  // FIXME: This is a bad API, we are overriding the NamedDecl::getName, to mean
1451  // something different.
1452  StringRef getName() const {
1453    return Id ? Id->getNameStart() : "";
1454  }
1455
1456  /// getNameAsCString - Get the name of identifier for the class
1457  /// interface associated with this implementation as a C string
1458  /// (const char*).
1459  //
1460  // FIXME: Deprecated, move clients to getName().
1461  const char *getNameAsCString() const {
1462    return Id ? Id->getNameStart() : "";
1463  }
1464
1465  /// @brief Get the name of the class associated with this interface.
1466  //
1467  // FIXME: Deprecated, move clients to getName().
1468  std::string getNameAsString() const {
1469    return getName();
1470  }
1471
1472  static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1473  static bool classof(const ObjCCategoryImplDecl *D) { return true; }
1474  static bool classofKind(Kind K) { return K == ObjCCategoryImpl;}
1475
1476  friend class ASTDeclReader;
1477  friend class ASTDeclWriter;
1478};
1479
1480raw_ostream &operator<<(raw_ostream &OS,
1481                              const ObjCCategoryImplDecl *CID);
1482
1483/// ObjCImplementationDecl - Represents a class definition - this is where
1484/// method definitions are specified. For example:
1485///
1486/// @code
1487/// @implementation MyClass
1488/// - (void)myMethod { /* do something */ }
1489/// @end
1490/// @endcode
1491///
1492/// Typically, instance variables are specified in the class interface,
1493/// *not* in the implementation. Nevertheless (for legacy reasons), we
1494/// allow instance variables to be specified in the implementation.  When
1495/// specified, they need to be *identical* to the interface.
1496///
1497class ObjCImplementationDecl : public ObjCImplDecl {
1498  virtual void anchor();
1499  /// Implementation Class's super class.
1500  ObjCInterfaceDecl *SuperClass;
1501  /// Support for ivar initialization.
1502  /// IvarInitializers - The arguments used to initialize the ivars
1503  CXXCtorInitializer **IvarInitializers;
1504  unsigned NumIvarInitializers;
1505
1506  /// true if class has a .cxx_[construct,destruct] method.
1507  bool HasCXXStructors : 1;
1508
1509  /// true of class extension has at least one bitfield ivar.
1510  bool HasSynthBitfield : 1;
1511
1512  ObjCImplementationDecl(DeclContext *DC,
1513                         ObjCInterfaceDecl *classInterface,
1514                         ObjCInterfaceDecl *superDecl,
1515                         SourceLocation nameLoc, SourceLocation atStartLoc)
1516    : ObjCImplDecl(ObjCImplementation, DC, classInterface, nameLoc, atStartLoc),
1517       SuperClass(superDecl), IvarInitializers(0), NumIvarInitializers(0),
1518       HasCXXStructors(false), HasSynthBitfield(false) {}
1519public:
1520  static ObjCImplementationDecl *Create(ASTContext &C, DeclContext *DC,
1521                                        ObjCInterfaceDecl *classInterface,
1522                                        ObjCInterfaceDecl *superDecl,
1523                                        SourceLocation nameLoc,
1524                                        SourceLocation atStartLoc);
1525
1526  /// init_iterator - Iterates through the ivar initializer list.
1527  typedef CXXCtorInitializer **init_iterator;
1528
1529  /// init_const_iterator - Iterates through the ivar initializer list.
1530  typedef CXXCtorInitializer * const * init_const_iterator;
1531
1532  /// init_begin() - Retrieve an iterator to the first initializer.
1533  init_iterator       init_begin()       { return IvarInitializers; }
1534  /// begin() - Retrieve an iterator to the first initializer.
1535  init_const_iterator init_begin() const { return IvarInitializers; }
1536
1537  /// init_end() - Retrieve an iterator past the last initializer.
1538  init_iterator       init_end()       {
1539    return IvarInitializers + NumIvarInitializers;
1540  }
1541  /// end() - Retrieve an iterator past the last initializer.
1542  init_const_iterator init_end() const {
1543    return IvarInitializers + NumIvarInitializers;
1544  }
1545  /// getNumArgs - Number of ivars which must be initialized.
1546  unsigned getNumIvarInitializers() const {
1547    return NumIvarInitializers;
1548  }
1549
1550  void setNumIvarInitializers(unsigned numNumIvarInitializers) {
1551    NumIvarInitializers = numNumIvarInitializers;
1552  }
1553
1554  void setIvarInitializers(ASTContext &C,
1555                           CXXCtorInitializer ** initializers,
1556                           unsigned numInitializers);
1557
1558  bool hasCXXStructors() const { return HasCXXStructors; }
1559  void setHasCXXStructors(bool val) { HasCXXStructors = val; }
1560
1561  bool hasSynthBitfield() const { return HasSynthBitfield; }
1562  void setHasSynthBitfield (bool val) { HasSynthBitfield = val; }
1563
1564  /// getIdentifier - Get the identifier that names the class
1565  /// interface associated with this implementation.
1566  IdentifierInfo *getIdentifier() const {
1567    return getClassInterface()->getIdentifier();
1568  }
1569
1570  /// getName - Get the name of identifier for the class interface associated
1571  /// with this implementation as a StringRef.
1572  //
1573  // FIXME: This is a bad API, we are overriding the NamedDecl::getName, to mean
1574  // something different.
1575  StringRef getName() const {
1576    assert(getIdentifier() && "Name is not a simple identifier");
1577    return getIdentifier()->getName();
1578  }
1579
1580  /// getNameAsCString - Get the name of identifier for the class
1581  /// interface associated with this implementation as a C string
1582  /// (const char*).
1583  //
1584  // FIXME: Move to StringRef API.
1585  const char *getNameAsCString() const {
1586    return getName().data();
1587  }
1588
1589  /// @brief Get the name of the class associated with this interface.
1590  //
1591  // FIXME: Move to StringRef API.
1592  std::string getNameAsString() const {
1593    return getName();
1594  }
1595
1596  const ObjCInterfaceDecl *getSuperClass() const { return SuperClass; }
1597  ObjCInterfaceDecl *getSuperClass() { return SuperClass; }
1598
1599  void setSuperClass(ObjCInterfaceDecl * superCls) { SuperClass = superCls; }
1600
1601  typedef specific_decl_iterator<ObjCIvarDecl> ivar_iterator;
1602  ivar_iterator ivar_begin() const {
1603    return ivar_iterator(decls_begin());
1604  }
1605  ivar_iterator ivar_end() const {
1606    return ivar_iterator(decls_end());
1607  }
1608  unsigned ivar_size() const {
1609    return std::distance(ivar_begin(), ivar_end());
1610  }
1611  bool ivar_empty() const {
1612    return ivar_begin() == ivar_end();
1613  }
1614
1615  static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1616  static bool classof(const ObjCImplementationDecl *D) { return true; }
1617  static bool classofKind(Kind K) { return K == ObjCImplementation; }
1618
1619  friend class ASTDeclReader;
1620  friend class ASTDeclWriter;
1621};
1622
1623raw_ostream &operator<<(raw_ostream &OS,
1624                              const ObjCImplementationDecl *ID);
1625
1626/// ObjCCompatibleAliasDecl - Represents alias of a class. This alias is
1627/// declared as @compatibility_alias alias class.
1628class ObjCCompatibleAliasDecl : public NamedDecl {
1629  virtual void anchor();
1630  /// Class that this is an alias of.
1631  ObjCInterfaceDecl *AliasedClass;
1632
1633  ObjCCompatibleAliasDecl(DeclContext *DC, SourceLocation L, IdentifierInfo *Id,
1634                          ObjCInterfaceDecl* aliasedClass)
1635    : NamedDecl(ObjCCompatibleAlias, DC, L, Id), AliasedClass(aliasedClass) {}
1636public:
1637  static ObjCCompatibleAliasDecl *Create(ASTContext &C, DeclContext *DC,
1638                                         SourceLocation L, IdentifierInfo *Id,
1639                                         ObjCInterfaceDecl* aliasedClass);
1640
1641  const ObjCInterfaceDecl *getClassInterface() const { return AliasedClass; }
1642  ObjCInterfaceDecl *getClassInterface() { return AliasedClass; }
1643  void setClassInterface(ObjCInterfaceDecl *D) { AliasedClass = D; }
1644
1645  static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1646  static bool classof(const ObjCCompatibleAliasDecl *D) { return true; }
1647  static bool classofKind(Kind K) { return K == ObjCCompatibleAlias; }
1648
1649};
1650
1651/// ObjCPropertyDecl - Represents one property declaration in an interface.
1652/// For example:
1653/// @property (assign, readwrite) int MyProperty;
1654///
1655class ObjCPropertyDecl : public NamedDecl {
1656  virtual void anchor();
1657public:
1658  enum PropertyAttributeKind {
1659    OBJC_PR_noattr    = 0x00,
1660    OBJC_PR_readonly  = 0x01,
1661    OBJC_PR_getter    = 0x02,
1662    OBJC_PR_assign    = 0x04,
1663    OBJC_PR_readwrite = 0x08,
1664    OBJC_PR_retain    = 0x10,
1665    OBJC_PR_copy      = 0x20,
1666    OBJC_PR_nonatomic = 0x40,
1667    OBJC_PR_setter    = 0x80,
1668    OBJC_PR_atomic    = 0x100,
1669    OBJC_PR_weak      = 0x200,
1670    OBJC_PR_strong    = 0x400,
1671    OBJC_PR_unsafe_unretained = 0x800
1672    // Adding a property should change NumPropertyAttrsBits
1673  };
1674
1675  enum {
1676    /// \brief Number of bits fitting all the property attributes.
1677    NumPropertyAttrsBits = 12
1678  };
1679
1680  enum SetterKind { Assign, Retain, Copy, Weak };
1681  enum PropertyControl { None, Required, Optional };
1682private:
1683  SourceLocation AtLoc;   // location of @property
1684  TypeSourceInfo *DeclType;
1685  unsigned PropertyAttributes : NumPropertyAttrsBits;
1686  unsigned PropertyAttributesAsWritten : NumPropertyAttrsBits;
1687  // @required/@optional
1688  unsigned PropertyImplementation : 2;
1689
1690  Selector GetterName;    // getter name of NULL if no getter
1691  Selector SetterName;    // setter name of NULL if no setter
1692
1693  ObjCMethodDecl *GetterMethodDecl; // Declaration of getter instance method
1694  ObjCMethodDecl *SetterMethodDecl; // Declaration of setter instance method
1695  ObjCIvarDecl *PropertyIvarDecl;   // Synthesize ivar for this property
1696
1697  ObjCPropertyDecl(DeclContext *DC, SourceLocation L, IdentifierInfo *Id,
1698                   SourceLocation AtLocation, TypeSourceInfo *T)
1699    : NamedDecl(ObjCProperty, DC, L, Id), AtLoc(AtLocation), DeclType(T),
1700      PropertyAttributes(OBJC_PR_noattr),
1701      PropertyAttributesAsWritten(OBJC_PR_noattr),
1702      PropertyImplementation(None),
1703      GetterName(Selector()),
1704      SetterName(Selector()),
1705      GetterMethodDecl(0), SetterMethodDecl(0) , PropertyIvarDecl(0) {}
1706public:
1707  static ObjCPropertyDecl *Create(ASTContext &C, DeclContext *DC,
1708                                  SourceLocation L,
1709                                  IdentifierInfo *Id, SourceLocation AtLocation,
1710                                  TypeSourceInfo *T,
1711                                  PropertyControl propControl = None);
1712  SourceLocation getAtLoc() const { return AtLoc; }
1713  void setAtLoc(SourceLocation L) { AtLoc = L; }
1714
1715  TypeSourceInfo *getTypeSourceInfo() const { return DeclType; }
1716  QualType getType() const { return DeclType->getType(); }
1717  void setType(TypeSourceInfo *T) { DeclType = T; }
1718
1719  PropertyAttributeKind getPropertyAttributes() const {
1720    return PropertyAttributeKind(PropertyAttributes);
1721  }
1722  void setPropertyAttributes(PropertyAttributeKind PRVal) {
1723    PropertyAttributes |= PRVal;
1724  }
1725
1726  PropertyAttributeKind getPropertyAttributesAsWritten() const {
1727    return PropertyAttributeKind(PropertyAttributesAsWritten);
1728  }
1729
1730  bool hasWrittenStorageAttribute() const {
1731    return PropertyAttributesAsWritten & (OBJC_PR_assign | OBJC_PR_copy |
1732        OBJC_PR_unsafe_unretained | OBJC_PR_retain | OBJC_PR_strong |
1733        OBJC_PR_weak);
1734  }
1735
1736  void setPropertyAttributesAsWritten(PropertyAttributeKind PRVal) {
1737    PropertyAttributesAsWritten = PRVal;
1738  }
1739
1740 void makeitReadWriteAttribute(void) {
1741    PropertyAttributes &= ~OBJC_PR_readonly;
1742    PropertyAttributes |= OBJC_PR_readwrite;
1743 }
1744
1745  // Helper methods for accessing attributes.
1746
1747  /// isReadOnly - Return true iff the property has a setter.
1748  bool isReadOnly() const {
1749    return (PropertyAttributes & OBJC_PR_readonly);
1750  }
1751
1752  /// isAtomic - Return true if the property is atomic.
1753  bool isAtomic() const {
1754    return (PropertyAttributes & OBJC_PR_atomic);
1755  }
1756
1757  /// isRetaining - Return true if the property retains its value.
1758  bool isRetaining() const {
1759    return (PropertyAttributes &
1760            (OBJC_PR_retain | OBJC_PR_strong | OBJC_PR_copy));
1761  }
1762
1763  /// getSetterKind - Return the method used for doing assignment in
1764  /// the property setter. This is only valid if the property has been
1765  /// defined to have a setter.
1766  SetterKind getSetterKind() const {
1767    if (PropertyAttributes & OBJC_PR_strong)
1768      return getType()->isBlockPointerType() ? Copy : Retain;
1769    if (PropertyAttributes & OBJC_PR_retain)
1770      return Retain;
1771    if (PropertyAttributes & OBJC_PR_copy)
1772      return Copy;
1773    if (PropertyAttributes & OBJC_PR_weak)
1774      return Weak;
1775    return Assign;
1776  }
1777
1778  Selector getGetterName() const { return GetterName; }
1779  void setGetterName(Selector Sel) { GetterName = Sel; }
1780
1781  Selector getSetterName() const { return SetterName; }
1782  void setSetterName(Selector Sel) { SetterName = Sel; }
1783
1784  ObjCMethodDecl *getGetterMethodDecl() const { return GetterMethodDecl; }
1785  void setGetterMethodDecl(ObjCMethodDecl *gDecl) { GetterMethodDecl = gDecl; }
1786
1787  ObjCMethodDecl *getSetterMethodDecl() const { return SetterMethodDecl; }
1788  void setSetterMethodDecl(ObjCMethodDecl *gDecl) { SetterMethodDecl = gDecl; }
1789
1790  // Related to @optional/@required declared in @protocol
1791  void setPropertyImplementation(PropertyControl pc) {
1792    PropertyImplementation = pc;
1793  }
1794  PropertyControl getPropertyImplementation() const {
1795    return PropertyControl(PropertyImplementation);
1796  }
1797
1798  void setPropertyIvarDecl(ObjCIvarDecl *Ivar) {
1799    PropertyIvarDecl = Ivar;
1800  }
1801  ObjCIvarDecl *getPropertyIvarDecl() const {
1802    return PropertyIvarDecl;
1803  }
1804
1805  virtual SourceRange getSourceRange() const {
1806    return SourceRange(AtLoc, getLocation());
1807  }
1808
1809  /// Lookup a property by name in the specified DeclContext.
1810  static ObjCPropertyDecl *findPropertyDecl(const DeclContext *DC,
1811                                            IdentifierInfo *propertyID);
1812
1813  static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1814  static bool classof(const ObjCPropertyDecl *D) { return true; }
1815  static bool classofKind(Kind K) { return K == ObjCProperty; }
1816};
1817
1818/// ObjCPropertyImplDecl - Represents implementation declaration of a property
1819/// in a class or category implementation block. For example:
1820/// @synthesize prop1 = ivar1;
1821///
1822class ObjCPropertyImplDecl : public Decl {
1823public:
1824  enum Kind {
1825    Synthesize,
1826    Dynamic
1827  };
1828private:
1829  SourceLocation AtLoc;   // location of @synthesize or @dynamic
1830
1831  /// \brief For @synthesize, the location of the ivar, if it was written in
1832  /// the source code.
1833  ///
1834  /// \code
1835  /// @synthesize int a = b
1836  /// \endcode
1837  SourceLocation IvarLoc;
1838
1839  /// Property declaration being implemented
1840  ObjCPropertyDecl *PropertyDecl;
1841
1842  /// Null for @dynamic. Required for @synthesize.
1843  ObjCIvarDecl *PropertyIvarDecl;
1844
1845  /// Null for @dynamic. Non-null if property must be copy-constructed in getter
1846  Expr *GetterCXXConstructor;
1847
1848  /// Null for @dynamic. Non-null if property has assignment operator to call
1849  /// in Setter synthesis.
1850  Expr *SetterCXXAssignment;
1851
1852  ObjCPropertyImplDecl(DeclContext *DC, SourceLocation atLoc, SourceLocation L,
1853                       ObjCPropertyDecl *property,
1854                       Kind PK,
1855                       ObjCIvarDecl *ivarDecl,
1856                       SourceLocation ivarLoc)
1857    : Decl(ObjCPropertyImpl, DC, L), AtLoc(atLoc),
1858      IvarLoc(ivarLoc), PropertyDecl(property), PropertyIvarDecl(ivarDecl),
1859      GetterCXXConstructor(0), SetterCXXAssignment(0) {
1860    assert (PK == Dynamic || PropertyIvarDecl);
1861  }
1862
1863public:
1864  static ObjCPropertyImplDecl *Create(ASTContext &C, DeclContext *DC,
1865                                      SourceLocation atLoc, SourceLocation L,
1866                                      ObjCPropertyDecl *property,
1867                                      Kind PK,
1868                                      ObjCIvarDecl *ivarDecl,
1869                                      SourceLocation ivarLoc);
1870
1871  virtual SourceRange getSourceRange() const;
1872
1873  SourceLocation getLocStart() const { return AtLoc; }
1874  void setAtLoc(SourceLocation Loc) { AtLoc = Loc; }
1875
1876  ObjCPropertyDecl *getPropertyDecl() const {
1877    return PropertyDecl;
1878  }
1879  void setPropertyDecl(ObjCPropertyDecl *Prop) { PropertyDecl = Prop; }
1880
1881  Kind getPropertyImplementation() const {
1882    return PropertyIvarDecl ? Synthesize : Dynamic;
1883  }
1884
1885  ObjCIvarDecl *getPropertyIvarDecl() const {
1886    return PropertyIvarDecl;
1887  }
1888  SourceLocation getPropertyIvarDeclLoc() const { return IvarLoc; }
1889
1890  void setPropertyIvarDecl(ObjCIvarDecl *Ivar,
1891                           SourceLocation IvarLoc) {
1892    PropertyIvarDecl = Ivar;
1893    this->IvarLoc = IvarLoc;
1894  }
1895
1896  Expr *getGetterCXXConstructor() const {
1897    return GetterCXXConstructor;
1898  }
1899  void setGetterCXXConstructor(Expr *getterCXXConstructor) {
1900    GetterCXXConstructor = getterCXXConstructor;
1901  }
1902
1903  Expr *getSetterCXXAssignment() const {
1904    return SetterCXXAssignment;
1905  }
1906  void setSetterCXXAssignment(Expr *setterCXXAssignment) {
1907    SetterCXXAssignment = setterCXXAssignment;
1908  }
1909
1910  static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1911  static bool classof(const ObjCPropertyImplDecl *D) { return true; }
1912  static bool classofKind(Decl::Kind K) { return K == ObjCPropertyImpl; }
1913
1914  friend class ASTDeclReader;
1915};
1916
1917}  // end namespace clang
1918#endif
1919