DeclObjC.h revision 3fc73ee0c613715ebce78e30b4d050ea715a007d
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 = 818 (superCls && superCls->hasDefinition()) ? superCls->getDefinition() 819 : superCls; 820 } 821 822 ObjCCategoryDecl* getCategoryList() const { 823 // FIXME: Should make sure no callers ever do this. 824 if (!hasDefinition()) 825 return 0; 826 827 if (data().ExternallyCompleted) 828 LoadExternalDefinition(); 829 830 return data().CategoryList; 831 } 832 833 void setCategoryList(ObjCCategoryDecl *category) { 834 data().CategoryList = category; 835 } 836 837 ObjCCategoryDecl* getFirstClassExtension() const; 838 839 ObjCPropertyDecl 840 *FindPropertyVisibleInPrimaryClass(IdentifierInfo *PropertyId) const; 841 842 /// isSuperClassOf - Return true if this class is the specified class or is a 843 /// super class of the specified interface class. 844 bool isSuperClassOf(const ObjCInterfaceDecl *I) const { 845 // If RHS is derived from LHS it is OK; else it is not OK. 846 while (I != NULL) { 847 if (declaresSameEntity(this, I)) 848 return true; 849 850 I = I->getSuperClass(); 851 } 852 return false; 853 } 854 855 /// isArcWeakrefUnavailable - Checks for a class or one of its super classes 856 /// to be incompatible with __weak references. Returns true if it is. 857 bool isArcWeakrefUnavailable() const { 858 const ObjCInterfaceDecl *Class = this; 859 while (Class) { 860 if (Class->hasAttr<ArcWeakrefUnavailableAttr>()) 861 return true; 862 Class = Class->getSuperClass(); 863 } 864 return false; 865 } 866 867 ObjCIvarDecl *lookupInstanceVariable(IdentifierInfo *IVarName, 868 ObjCInterfaceDecl *&ClassDeclared); 869 ObjCIvarDecl *lookupInstanceVariable(IdentifierInfo *IVarName) { 870 ObjCInterfaceDecl *ClassDeclared; 871 return lookupInstanceVariable(IVarName, ClassDeclared); 872 } 873 874 // Lookup a method. First, we search locally. If a method isn't 875 // found, we search referenced protocols and class categories. 876 ObjCMethodDecl *lookupMethod(Selector Sel, bool isInstance) const; 877 ObjCMethodDecl *lookupInstanceMethod(Selector Sel) const { 878 return lookupMethod(Sel, true/*isInstance*/); 879 } 880 ObjCMethodDecl *lookupClassMethod(Selector Sel) const { 881 return lookupMethod(Sel, false/*isInstance*/); 882 } 883 ObjCInterfaceDecl *lookupInheritedClass(const IdentifierInfo *ICName); 884 885 // Lookup a method in the classes implementation hierarchy. 886 ObjCMethodDecl *lookupPrivateMethod(const Selector &Sel, bool Instance=true); 887 888 SourceLocation getEndOfDefinitionLoc() const { 889 if (!hasDefinition()) 890 return getLocation(); 891 892 return data().EndLoc; 893 } 894 895 void setEndOfDefinitionLoc(SourceLocation LE) { data().EndLoc = LE; } 896 897 void setSuperClassLoc(SourceLocation Loc) { data().SuperClassLoc = Loc; } 898 SourceLocation getSuperClassLoc() const { return data().SuperClassLoc; } 899 900 /// isImplicitInterfaceDecl - check that this is an implicitly declared 901 /// ObjCInterfaceDecl node. This is for legacy objective-c @implementation 902 /// declaration without an @interface declaration. 903 bool isImplicitInterfaceDecl() const { 904 return hasDefinition() ? Data->Definition->isImplicit() : isImplicit(); 905 } 906 907 /// ClassImplementsProtocol - Checks that 'lProto' protocol 908 /// has been implemented in IDecl class, its super class or categories (if 909 /// lookupCategory is true). 910 bool ClassImplementsProtocol(ObjCProtocolDecl *lProto, 911 bool lookupCategory, 912 bool RHSIsQualifiedID = false); 913 914 typedef redeclarable_base::redecl_iterator redecl_iterator; 915 redecl_iterator redecls_begin() const { 916 return redeclarable_base::redecls_begin(); 917 } 918 redecl_iterator redecls_end() const { 919 return redeclarable_base::redecls_end(); 920 } 921 922 /// Retrieves the canonical declaration of this Objective-C class. 923 ObjCInterfaceDecl *getCanonicalDecl() { 924 return getFirstDeclaration(); 925 } 926 const ObjCInterfaceDecl *getCanonicalDecl() const { 927 return getFirstDeclaration(); 928 } 929 930 // Low-level accessor 931 const Type *getTypeForDecl() const { return TypeForDecl; } 932 void setTypeForDecl(const Type *TD) const { TypeForDecl = TD; } 933 934 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 935 static bool classof(const ObjCInterfaceDecl *D) { return true; } 936 static bool classofKind(Kind K) { return K == ObjCInterface; } 937 938 friend class ASTReader; 939 friend class ASTDeclReader; 940 friend class ASTDeclWriter; 941}; 942 943/// ObjCIvarDecl - Represents an ObjC instance variable. In general, ObjC 944/// instance variables are identical to C. The only exception is Objective-C 945/// supports C++ style access control. For example: 946/// 947/// @interface IvarExample : NSObject 948/// { 949/// id defaultToProtected; 950/// @public: 951/// id canBePublic; // same as C++. 952/// @protected: 953/// id canBeProtected; // same as C++. 954/// @package: 955/// id canBePackage; // framework visibility (not available in C++). 956/// } 957/// 958class ObjCIvarDecl : public FieldDecl { 959 virtual void anchor(); 960 961public: 962 enum AccessControl { 963 None, Private, Protected, Public, Package 964 }; 965 966private: 967 ObjCIvarDecl(ObjCContainerDecl *DC, SourceLocation StartLoc, 968 SourceLocation IdLoc, IdentifierInfo *Id, 969 QualType T, TypeSourceInfo *TInfo, AccessControl ac, Expr *BW, 970 bool synthesized) 971 : FieldDecl(ObjCIvar, DC, StartLoc, IdLoc, Id, T, TInfo, BW, 972 /*Mutable=*/false, /*HasInit=*/false), 973 NextIvar(0), DeclAccess(ac), Synthesized(synthesized) {} 974 975public: 976 static ObjCIvarDecl *Create(ASTContext &C, ObjCContainerDecl *DC, 977 SourceLocation StartLoc, SourceLocation IdLoc, 978 IdentifierInfo *Id, QualType T, 979 TypeSourceInfo *TInfo, 980 AccessControl ac, Expr *BW = NULL, 981 bool synthesized=false); 982 983 /// \brief Return the class interface that this ivar is logically contained 984 /// in; this is either the interface where the ivar was declared, or the 985 /// interface the ivar is conceptually a part of in the case of synthesized 986 /// ivars. 987 const ObjCInterfaceDecl *getContainingInterface() const; 988 989 ObjCIvarDecl *getNextIvar() { return NextIvar; } 990 const ObjCIvarDecl *getNextIvar() const { return NextIvar; } 991 void setNextIvar(ObjCIvarDecl *ivar) { NextIvar = ivar; } 992 993 void setAccessControl(AccessControl ac) { DeclAccess = ac; } 994 995 AccessControl getAccessControl() const { return AccessControl(DeclAccess); } 996 997 AccessControl getCanonicalAccessControl() const { 998 return DeclAccess == None ? Protected : AccessControl(DeclAccess); 999 } 1000 1001 void setSynthesize(bool synth) { Synthesized = synth; } 1002 bool getSynthesize() const { return Synthesized; } 1003 1004 // Implement isa/cast/dyncast/etc. 1005 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 1006 static bool classof(const ObjCIvarDecl *D) { return true; } 1007 static bool classofKind(Kind K) { return K == ObjCIvar; } 1008private: 1009 /// NextIvar - Next Ivar in the list of ivars declared in class; class's 1010 /// extensions and class's implementation 1011 ObjCIvarDecl *NextIvar; 1012 1013 // NOTE: VC++ treats enums as signed, avoid using the AccessControl enum 1014 unsigned DeclAccess : 3; 1015 unsigned Synthesized : 1; 1016}; 1017 1018 1019/// ObjCAtDefsFieldDecl - Represents a field declaration created by an 1020/// @defs(...). 1021class ObjCAtDefsFieldDecl : public FieldDecl { 1022 virtual void anchor(); 1023 ObjCAtDefsFieldDecl(DeclContext *DC, SourceLocation StartLoc, 1024 SourceLocation IdLoc, IdentifierInfo *Id, 1025 QualType T, Expr *BW) 1026 : FieldDecl(ObjCAtDefsField, DC, StartLoc, IdLoc, Id, T, 1027 /*TInfo=*/0, // FIXME: Do ObjCAtDefs have declarators ? 1028 BW, /*Mutable=*/false, /*HasInit=*/false) {} 1029 1030public: 1031 static ObjCAtDefsFieldDecl *Create(ASTContext &C, DeclContext *DC, 1032 SourceLocation StartLoc, 1033 SourceLocation IdLoc, IdentifierInfo *Id, 1034 QualType T, Expr *BW); 1035 1036 // Implement isa/cast/dyncast/etc. 1037 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 1038 static bool classof(const ObjCAtDefsFieldDecl *D) { return true; } 1039 static bool classofKind(Kind K) { return K == ObjCAtDefsField; } 1040}; 1041 1042/// ObjCProtocolDecl - Represents a protocol declaration. ObjC protocols 1043/// declare a pure abstract type (i.e no instance variables are permitted). 1044/// Protocols originally drew inspiration from C++ pure virtual functions (a C++ 1045/// feature with nice semantics and lousy syntax:-). Here is an example: 1046/// 1047/// @protocol NSDraggingInfo <refproto1, refproto2> 1048/// - (NSWindow *)draggingDestinationWindow; 1049/// - (NSImage *)draggedImage; 1050/// @end 1051/// 1052/// This says that NSDraggingInfo requires two methods and requires everything 1053/// that the two "referenced protocols" 'refproto1' and 'refproto2' require as 1054/// well. 1055/// 1056/// @interface ImplementsNSDraggingInfo : NSObject <NSDraggingInfo> 1057/// @end 1058/// 1059/// ObjC protocols inspired Java interfaces. Unlike Java, ObjC classes and 1060/// protocols are in distinct namespaces. For example, Cocoa defines both 1061/// an NSObject protocol and class (which isn't allowed in Java). As a result, 1062/// protocols are referenced using angle brackets as follows: 1063/// 1064/// id <NSDraggingInfo> anyObjectThatImplementsNSDraggingInfo; 1065/// 1066class ObjCProtocolDecl : public ObjCContainerDecl { 1067 virtual void anchor(); 1068 1069 /// Referenced protocols 1070 ObjCProtocolList ReferencedProtocols; 1071 1072 bool InitiallyForwardDecl : 1; 1073 bool isForwardProtoDecl : 1; // declared with @protocol. 1074 1075 SourceLocation EndLoc; // marks the '>' or identifier. 1076 1077 ObjCProtocolDecl(DeclContext *DC, IdentifierInfo *Id, 1078 SourceLocation nameLoc, SourceLocation atStartLoc, 1079 bool isForwardDecl) 1080 : ObjCContainerDecl(ObjCProtocol, DC, Id, nameLoc, atStartLoc), 1081 InitiallyForwardDecl(isForwardDecl), 1082 isForwardProtoDecl(isForwardDecl) { 1083 } 1084 1085public: 1086 static ObjCProtocolDecl *Create(ASTContext &C, DeclContext *DC, 1087 IdentifierInfo *Id, 1088 SourceLocation nameLoc, 1089 SourceLocation atStartLoc, 1090 bool isForwardDecl); 1091 1092 const ObjCProtocolList &getReferencedProtocols() const { 1093 return ReferencedProtocols; 1094 } 1095 typedef ObjCProtocolList::iterator protocol_iterator; 1096 protocol_iterator protocol_begin() const {return ReferencedProtocols.begin();} 1097 protocol_iterator protocol_end() const { return ReferencedProtocols.end(); } 1098 typedef ObjCProtocolList::loc_iterator protocol_loc_iterator; 1099 protocol_loc_iterator protocol_loc_begin() const { 1100 return ReferencedProtocols.loc_begin(); 1101 } 1102 protocol_loc_iterator protocol_loc_end() const { 1103 return ReferencedProtocols.loc_end(); 1104 } 1105 unsigned protocol_size() const { return ReferencedProtocols.size(); } 1106 1107 /// setProtocolList - Set the list of protocols that this interface 1108 /// implements. 1109 void setProtocolList(ObjCProtocolDecl *const*List, unsigned Num, 1110 const SourceLocation *Locs, ASTContext &C) { 1111 ReferencedProtocols.set(List, Num, Locs, C); 1112 } 1113 1114 ObjCProtocolDecl *lookupProtocolNamed(IdentifierInfo *PName); 1115 1116 // Lookup a method. First, we search locally. If a method isn't 1117 // found, we search referenced protocols and class categories. 1118 ObjCMethodDecl *lookupMethod(Selector Sel, bool isInstance) const; 1119 ObjCMethodDecl *lookupInstanceMethod(Selector Sel) const { 1120 return lookupMethod(Sel, true/*isInstance*/); 1121 } 1122 ObjCMethodDecl *lookupClassMethod(Selector Sel) const { 1123 return lookupMethod(Sel, false/*isInstance*/); 1124 } 1125 1126 /// \brief True if it was initially a forward reference. 1127 /// Differs with \see isForwardDecl in that \see isForwardDecl will change to 1128 /// false when we see the definition, but this will remain true. 1129 bool isInitiallyForwardDecl() const { return InitiallyForwardDecl; } 1130 1131 bool isForwardDecl() const { return isForwardProtoDecl; } 1132 1133 void completedForwardDecl(); 1134 1135 // Location information, modeled after the Stmt API. 1136 SourceLocation getLocStart() const { return getAtStartLoc(); } // '@'protocol 1137 SourceLocation getLocEnd() const { return EndLoc; } 1138 void setLocEnd(SourceLocation LE) { EndLoc = LE; } 1139 1140 /// Retrieves the canonical declaration of this Objective-C protocol. 1141 ObjCProtocolDecl *getCanonicalDecl() { 1142 return this; 1143 } 1144 const ObjCProtocolDecl *getCanonicalDecl() const { 1145 return this; 1146 } 1147 1148 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 1149 static bool classof(const ObjCProtocolDecl *D) { return true; } 1150 static bool classofKind(Kind K) { return K == ObjCProtocol; } 1151 1152 friend class ASTDeclReader; 1153 friend class ASTDeclWriter; 1154}; 1155 1156/// ObjCForwardProtocolDecl - Specifies a list of forward protocol declarations. 1157/// For example: 1158/// 1159/// @protocol NSTextInput, NSChangeSpelling, NSDraggingInfo; 1160/// 1161class ObjCForwardProtocolDecl : public Decl { 1162 virtual void anchor(); 1163 1164 ObjCProtocolList ReferencedProtocols; 1165 1166 ObjCForwardProtocolDecl(DeclContext *DC, SourceLocation L, 1167 ObjCProtocolDecl *const *Elts, unsigned nElts, 1168 const SourceLocation *Locs, ASTContext &C); 1169 1170public: 1171 static ObjCForwardProtocolDecl *Create(ASTContext &C, DeclContext *DC, 1172 SourceLocation L, 1173 ObjCProtocolDecl *const *Elts, 1174 unsigned Num, 1175 const SourceLocation *Locs); 1176 1177 static ObjCForwardProtocolDecl *Create(ASTContext &C, DeclContext *DC, 1178 SourceLocation L) { 1179 return Create(C, DC, L, 0, 0, 0); 1180 } 1181 1182 typedef ObjCProtocolList::iterator protocol_iterator; 1183 protocol_iterator protocol_begin() const {return ReferencedProtocols.begin();} 1184 protocol_iterator protocol_end() const { return ReferencedProtocols.end(); } 1185 typedef ObjCProtocolList::loc_iterator protocol_loc_iterator; 1186 protocol_loc_iterator protocol_loc_begin() const { 1187 return ReferencedProtocols.loc_begin(); 1188 } 1189 protocol_loc_iterator protocol_loc_end() const { 1190 return ReferencedProtocols.loc_end(); 1191 } 1192 1193 unsigned protocol_size() const { return ReferencedProtocols.size(); } 1194 1195 /// setProtocolList - Set the list of forward protocols. 1196 void setProtocolList(ObjCProtocolDecl *const*List, unsigned Num, 1197 const SourceLocation *Locs, ASTContext &C) { 1198 ReferencedProtocols.set(List, Num, Locs, C); 1199 } 1200 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 1201 static bool classof(const ObjCForwardProtocolDecl *D) { return true; } 1202 static bool classofKind(Kind K) { return K == ObjCForwardProtocol; } 1203}; 1204 1205/// ObjCCategoryDecl - Represents a category declaration. A category allows 1206/// you to add methods to an existing class (without subclassing or modifying 1207/// the original class interface or implementation:-). Categories don't allow 1208/// you to add instance data. The following example adds "myMethod" to all 1209/// NSView's within a process: 1210/// 1211/// @interface NSView (MyViewMethods) 1212/// - myMethod; 1213/// @end 1214/// 1215/// Categories also allow you to split the implementation of a class across 1216/// several files (a feature more naturally supported in C++). 1217/// 1218/// Categories were originally inspired by dynamic languages such as Common 1219/// Lisp and Smalltalk. More traditional class-based languages (C++, Java) 1220/// don't support this level of dynamism, which is both powerful and dangerous. 1221/// 1222class ObjCCategoryDecl : public ObjCContainerDecl { 1223 virtual void anchor(); 1224 1225 /// Interface belonging to this category 1226 ObjCInterfaceDecl *ClassInterface; 1227 1228 /// referenced protocols in this category. 1229 ObjCProtocolList ReferencedProtocols; 1230 1231 /// Next category belonging to this class. 1232 /// FIXME: this should not be a singly-linked list. Move storage elsewhere. 1233 ObjCCategoryDecl *NextClassCategory; 1234 1235 /// true of class extension has at least one bitfield ivar. 1236 bool HasSynthBitfield : 1; 1237 1238 /// \brief The location of the category name in this declaration. 1239 SourceLocation CategoryNameLoc; 1240 1241 ObjCCategoryDecl(DeclContext *DC, SourceLocation AtLoc, 1242 SourceLocation ClassNameLoc, SourceLocation CategoryNameLoc, 1243 IdentifierInfo *Id, ObjCInterfaceDecl *IDecl) 1244 : ObjCContainerDecl(ObjCCategory, DC, Id, ClassNameLoc, AtLoc), 1245 ClassInterface(IDecl), NextClassCategory(0), HasSynthBitfield(false), 1246 CategoryNameLoc(CategoryNameLoc) { 1247 } 1248public: 1249 1250 static ObjCCategoryDecl *Create(ASTContext &C, DeclContext *DC, 1251 SourceLocation AtLoc, 1252 SourceLocation ClassNameLoc, 1253 SourceLocation CategoryNameLoc, 1254 IdentifierInfo *Id, 1255 ObjCInterfaceDecl *IDecl); 1256 static ObjCCategoryDecl *Create(ASTContext &C, EmptyShell Empty); 1257 1258 ObjCInterfaceDecl *getClassInterface() { return ClassInterface; } 1259 const ObjCInterfaceDecl *getClassInterface() const { return ClassInterface; } 1260 1261 ObjCCategoryImplDecl *getImplementation() const; 1262 void setImplementation(ObjCCategoryImplDecl *ImplD); 1263 1264 /// setProtocolList - Set the list of protocols that this interface 1265 /// implements. 1266 void setProtocolList(ObjCProtocolDecl *const*List, unsigned Num, 1267 const SourceLocation *Locs, ASTContext &C) { 1268 ReferencedProtocols.set(List, Num, Locs, C); 1269 } 1270 1271 const ObjCProtocolList &getReferencedProtocols() const { 1272 return ReferencedProtocols; 1273 } 1274 1275 typedef ObjCProtocolList::iterator protocol_iterator; 1276 protocol_iterator protocol_begin() const {return ReferencedProtocols.begin();} 1277 protocol_iterator protocol_end() const { return ReferencedProtocols.end(); } 1278 unsigned protocol_size() const { return ReferencedProtocols.size(); } 1279 typedef ObjCProtocolList::loc_iterator protocol_loc_iterator; 1280 protocol_loc_iterator protocol_loc_begin() const { 1281 return ReferencedProtocols.loc_begin(); 1282 } 1283 protocol_loc_iterator protocol_loc_end() const { 1284 return ReferencedProtocols.loc_end(); 1285 } 1286 1287 ObjCCategoryDecl *getNextClassCategory() const { return NextClassCategory; } 1288 1289 bool IsClassExtension() const { return getIdentifier() == 0; } 1290 const ObjCCategoryDecl *getNextClassExtension() const; 1291 1292 bool hasSynthBitfield() const { return HasSynthBitfield; } 1293 void setHasSynthBitfield (bool val) { HasSynthBitfield = val; } 1294 1295 typedef specific_decl_iterator<ObjCIvarDecl> ivar_iterator; 1296 ivar_iterator ivar_begin() const { 1297 return ivar_iterator(decls_begin()); 1298 } 1299 ivar_iterator ivar_end() const { 1300 return ivar_iterator(decls_end()); 1301 } 1302 unsigned ivar_size() const { 1303 return std::distance(ivar_begin(), ivar_end()); 1304 } 1305 bool ivar_empty() const { 1306 return ivar_begin() == ivar_end(); 1307 } 1308 1309 SourceLocation getCategoryNameLoc() const { return CategoryNameLoc; } 1310 void setCategoryNameLoc(SourceLocation Loc) { CategoryNameLoc = Loc; } 1311 1312 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 1313 static bool classof(const ObjCCategoryDecl *D) { return true; } 1314 static bool classofKind(Kind K) { return K == ObjCCategory; } 1315 1316 friend class ASTDeclReader; 1317 friend class ASTDeclWriter; 1318}; 1319 1320class ObjCImplDecl : public ObjCContainerDecl { 1321 virtual void anchor(); 1322 1323 /// Class interface for this class/category implementation 1324 ObjCInterfaceDecl *ClassInterface; 1325 1326protected: 1327 ObjCImplDecl(Kind DK, DeclContext *DC, 1328 ObjCInterfaceDecl *classInterface, 1329 SourceLocation nameLoc, SourceLocation atStartLoc) 1330 : ObjCContainerDecl(DK, DC, 1331 classInterface? classInterface->getIdentifier() : 0, 1332 nameLoc, atStartLoc), 1333 ClassInterface(classInterface) {} 1334 1335public: 1336 const ObjCInterfaceDecl *getClassInterface() const { return ClassInterface; } 1337 ObjCInterfaceDecl *getClassInterface() { return ClassInterface; } 1338 void setClassInterface(ObjCInterfaceDecl *IFace); 1339 1340 void addInstanceMethod(ObjCMethodDecl *method) { 1341 // FIXME: Context should be set correctly before we get here. 1342 method->setLexicalDeclContext(this); 1343 addDecl(method); 1344 } 1345 void addClassMethod(ObjCMethodDecl *method) { 1346 // FIXME: Context should be set correctly before we get here. 1347 method->setLexicalDeclContext(this); 1348 addDecl(method); 1349 } 1350 1351 void addPropertyImplementation(ObjCPropertyImplDecl *property); 1352 1353 ObjCPropertyImplDecl *FindPropertyImplDecl(IdentifierInfo *propertyId) const; 1354 ObjCPropertyImplDecl *FindPropertyImplIvarDecl(IdentifierInfo *ivarId) const; 1355 1356 // Iterator access to properties. 1357 typedef specific_decl_iterator<ObjCPropertyImplDecl> propimpl_iterator; 1358 propimpl_iterator propimpl_begin() const { 1359 return propimpl_iterator(decls_begin()); 1360 } 1361 propimpl_iterator propimpl_end() const { 1362 return propimpl_iterator(decls_end()); 1363 } 1364 1365 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 1366 static bool classof(const ObjCImplDecl *D) { return true; } 1367 static bool classofKind(Kind K) { 1368 return K >= firstObjCImpl && K <= lastObjCImpl; 1369 } 1370}; 1371 1372/// ObjCCategoryImplDecl - An object of this class encapsulates a category 1373/// @implementation declaration. If a category class has declaration of a 1374/// property, its implementation must be specified in the category's 1375/// @implementation declaration. Example: 1376/// @interface I @end 1377/// @interface I(CATEGORY) 1378/// @property int p1, d1; 1379/// @end 1380/// @implementation I(CATEGORY) 1381/// @dynamic p1,d1; 1382/// @end 1383/// 1384/// ObjCCategoryImplDecl 1385class ObjCCategoryImplDecl : public ObjCImplDecl { 1386 virtual void anchor(); 1387 1388 // Category name 1389 IdentifierInfo *Id; 1390 1391 // Category name location 1392 SourceLocation CategoryNameLoc; 1393 1394 ObjCCategoryImplDecl(DeclContext *DC, IdentifierInfo *Id, 1395 ObjCInterfaceDecl *classInterface, 1396 SourceLocation nameLoc, SourceLocation atStartLoc, 1397 SourceLocation CategoryNameLoc) 1398 : ObjCImplDecl(ObjCCategoryImpl, DC, classInterface, nameLoc, atStartLoc), 1399 Id(Id), CategoryNameLoc(CategoryNameLoc) {} 1400public: 1401 static ObjCCategoryImplDecl *Create(ASTContext &C, DeclContext *DC, 1402 IdentifierInfo *Id, 1403 ObjCInterfaceDecl *classInterface, 1404 SourceLocation nameLoc, 1405 SourceLocation atStartLoc, 1406 SourceLocation CategoryNameLoc); 1407 1408 /// getIdentifier - Get the identifier that names the category 1409 /// interface associated with this implementation. 1410 /// FIXME: This is a bad API, we are overriding the NamedDecl::getIdentifier() 1411 /// to mean something different. For example: 1412 /// ((NamedDecl *)SomeCategoryImplDecl)->getIdentifier() 1413 /// returns the class interface name, whereas 1414 /// ((ObjCCategoryImplDecl *)SomeCategoryImplDecl)->getIdentifier() 1415 /// returns the category name. 1416 IdentifierInfo *getIdentifier() const { 1417 return Id; 1418 } 1419 void setIdentifier(IdentifierInfo *II) { Id = II; } 1420 1421 ObjCCategoryDecl *getCategoryDecl() const; 1422 1423 SourceLocation getCategoryNameLoc() const { return CategoryNameLoc; } 1424 1425 /// getName - Get the name of identifier for the class interface associated 1426 /// with this implementation as a StringRef. 1427 // 1428 // FIXME: This is a bad API, we are overriding the NamedDecl::getName, to mean 1429 // something different. 1430 StringRef getName() const { 1431 return Id ? Id->getNameStart() : ""; 1432 } 1433 1434 /// getNameAsCString - Get the name of identifier for the class 1435 /// interface associated with this implementation as a C string 1436 /// (const char*). 1437 // 1438 // FIXME: Deprecated, move clients to getName(). 1439 const char *getNameAsCString() const { 1440 return Id ? Id->getNameStart() : ""; 1441 } 1442 1443 /// @brief Get the name of the class associated with this interface. 1444 // 1445 // FIXME: Deprecated, move clients to getName(). 1446 std::string getNameAsString() const { 1447 return getName(); 1448 } 1449 1450 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 1451 static bool classof(const ObjCCategoryImplDecl *D) { return true; } 1452 static bool classofKind(Kind K) { return K == ObjCCategoryImpl;} 1453 1454 friend class ASTDeclReader; 1455 friend class ASTDeclWriter; 1456}; 1457 1458raw_ostream &operator<<(raw_ostream &OS, 1459 const ObjCCategoryImplDecl *CID); 1460 1461/// ObjCImplementationDecl - Represents a class definition - this is where 1462/// method definitions are specified. For example: 1463/// 1464/// @code 1465/// @implementation MyClass 1466/// - (void)myMethod { /* do something */ } 1467/// @end 1468/// @endcode 1469/// 1470/// Typically, instance variables are specified in the class interface, 1471/// *not* in the implementation. Nevertheless (for legacy reasons), we 1472/// allow instance variables to be specified in the implementation. When 1473/// specified, they need to be *identical* to the interface. 1474/// 1475class ObjCImplementationDecl : public ObjCImplDecl { 1476 virtual void anchor(); 1477 /// Implementation Class's super class. 1478 ObjCInterfaceDecl *SuperClass; 1479 /// Support for ivar initialization. 1480 /// IvarInitializers - The arguments used to initialize the ivars 1481 CXXCtorInitializer **IvarInitializers; 1482 unsigned NumIvarInitializers; 1483 1484 /// true if class has a .cxx_[construct,destruct] method. 1485 bool HasCXXStructors : 1; 1486 1487 /// true of class extension has at least one bitfield ivar. 1488 bool HasSynthBitfield : 1; 1489 1490 ObjCImplementationDecl(DeclContext *DC, 1491 ObjCInterfaceDecl *classInterface, 1492 ObjCInterfaceDecl *superDecl, 1493 SourceLocation nameLoc, SourceLocation atStartLoc) 1494 : ObjCImplDecl(ObjCImplementation, DC, classInterface, nameLoc, atStartLoc), 1495 SuperClass(superDecl), IvarInitializers(0), NumIvarInitializers(0), 1496 HasCXXStructors(false), HasSynthBitfield(false) {} 1497public: 1498 static ObjCImplementationDecl *Create(ASTContext &C, DeclContext *DC, 1499 ObjCInterfaceDecl *classInterface, 1500 ObjCInterfaceDecl *superDecl, 1501 SourceLocation nameLoc, 1502 SourceLocation atStartLoc); 1503 1504 /// init_iterator - Iterates through the ivar initializer list. 1505 typedef CXXCtorInitializer **init_iterator; 1506 1507 /// init_const_iterator - Iterates through the ivar initializer list. 1508 typedef CXXCtorInitializer * const * init_const_iterator; 1509 1510 /// init_begin() - Retrieve an iterator to the first initializer. 1511 init_iterator init_begin() { return IvarInitializers; } 1512 /// begin() - Retrieve an iterator to the first initializer. 1513 init_const_iterator init_begin() const { return IvarInitializers; } 1514 1515 /// init_end() - Retrieve an iterator past the last initializer. 1516 init_iterator init_end() { 1517 return IvarInitializers + NumIvarInitializers; 1518 } 1519 /// end() - Retrieve an iterator past the last initializer. 1520 init_const_iterator init_end() const { 1521 return IvarInitializers + NumIvarInitializers; 1522 } 1523 /// getNumArgs - Number of ivars which must be initialized. 1524 unsigned getNumIvarInitializers() const { 1525 return NumIvarInitializers; 1526 } 1527 1528 void setNumIvarInitializers(unsigned numNumIvarInitializers) { 1529 NumIvarInitializers = numNumIvarInitializers; 1530 } 1531 1532 void setIvarInitializers(ASTContext &C, 1533 CXXCtorInitializer ** initializers, 1534 unsigned numInitializers); 1535 1536 bool hasCXXStructors() const { return HasCXXStructors; } 1537 void setHasCXXStructors(bool val) { HasCXXStructors = val; } 1538 1539 bool hasSynthBitfield() const { return HasSynthBitfield; } 1540 void setHasSynthBitfield (bool val) { HasSynthBitfield = val; } 1541 1542 /// getIdentifier - Get the identifier that names the class 1543 /// interface associated with this implementation. 1544 IdentifierInfo *getIdentifier() const { 1545 return getClassInterface()->getIdentifier(); 1546 } 1547 1548 /// getName - Get the name of identifier for the class interface associated 1549 /// with this implementation as a StringRef. 1550 // 1551 // FIXME: This is a bad API, we are overriding the NamedDecl::getName, to mean 1552 // something different. 1553 StringRef getName() const { 1554 assert(getIdentifier() && "Name is not a simple identifier"); 1555 return getIdentifier()->getName(); 1556 } 1557 1558 /// getNameAsCString - Get the name of identifier for the class 1559 /// interface associated with this implementation as a C string 1560 /// (const char*). 1561 // 1562 // FIXME: Move to StringRef API. 1563 const char *getNameAsCString() const { 1564 return getName().data(); 1565 } 1566 1567 /// @brief Get the name of the class associated with this interface. 1568 // 1569 // FIXME: Move to StringRef API. 1570 std::string getNameAsString() const { 1571 return getName(); 1572 } 1573 1574 const ObjCInterfaceDecl *getSuperClass() const { return SuperClass; } 1575 ObjCInterfaceDecl *getSuperClass() { return SuperClass; } 1576 1577 void setSuperClass(ObjCInterfaceDecl * superCls) { SuperClass = superCls; } 1578 1579 typedef specific_decl_iterator<ObjCIvarDecl> ivar_iterator; 1580 ivar_iterator ivar_begin() const { 1581 return ivar_iterator(decls_begin()); 1582 } 1583 ivar_iterator ivar_end() const { 1584 return ivar_iterator(decls_end()); 1585 } 1586 unsigned ivar_size() const { 1587 return std::distance(ivar_begin(), ivar_end()); 1588 } 1589 bool ivar_empty() const { 1590 return ivar_begin() == ivar_end(); 1591 } 1592 1593 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 1594 static bool classof(const ObjCImplementationDecl *D) { return true; } 1595 static bool classofKind(Kind K) { return K == ObjCImplementation; } 1596 1597 friend class ASTDeclReader; 1598 friend class ASTDeclWriter; 1599}; 1600 1601raw_ostream &operator<<(raw_ostream &OS, 1602 const ObjCImplementationDecl *ID); 1603 1604/// ObjCCompatibleAliasDecl - Represents alias of a class. This alias is 1605/// declared as @compatibility_alias alias class. 1606class ObjCCompatibleAliasDecl : public NamedDecl { 1607 virtual void anchor(); 1608 /// Class that this is an alias of. 1609 ObjCInterfaceDecl *AliasedClass; 1610 1611 ObjCCompatibleAliasDecl(DeclContext *DC, SourceLocation L, IdentifierInfo *Id, 1612 ObjCInterfaceDecl* aliasedClass) 1613 : NamedDecl(ObjCCompatibleAlias, DC, L, Id), AliasedClass(aliasedClass) {} 1614public: 1615 static ObjCCompatibleAliasDecl *Create(ASTContext &C, DeclContext *DC, 1616 SourceLocation L, IdentifierInfo *Id, 1617 ObjCInterfaceDecl* aliasedClass); 1618 1619 const ObjCInterfaceDecl *getClassInterface() const { return AliasedClass; } 1620 ObjCInterfaceDecl *getClassInterface() { return AliasedClass; } 1621 void setClassInterface(ObjCInterfaceDecl *D) { AliasedClass = D; } 1622 1623 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 1624 static bool classof(const ObjCCompatibleAliasDecl *D) { return true; } 1625 static bool classofKind(Kind K) { return K == ObjCCompatibleAlias; } 1626 1627}; 1628 1629/// ObjCPropertyDecl - Represents one property declaration in an interface. 1630/// For example: 1631/// @property (assign, readwrite) int MyProperty; 1632/// 1633class ObjCPropertyDecl : public NamedDecl { 1634 virtual void anchor(); 1635public: 1636 enum PropertyAttributeKind { 1637 OBJC_PR_noattr = 0x00, 1638 OBJC_PR_readonly = 0x01, 1639 OBJC_PR_getter = 0x02, 1640 OBJC_PR_assign = 0x04, 1641 OBJC_PR_readwrite = 0x08, 1642 OBJC_PR_retain = 0x10, 1643 OBJC_PR_copy = 0x20, 1644 OBJC_PR_nonatomic = 0x40, 1645 OBJC_PR_setter = 0x80, 1646 OBJC_PR_atomic = 0x100, 1647 OBJC_PR_weak = 0x200, 1648 OBJC_PR_strong = 0x400, 1649 OBJC_PR_unsafe_unretained = 0x800 1650 // Adding a property should change NumPropertyAttrsBits 1651 }; 1652 1653 enum { 1654 /// \brief Number of bits fitting all the property attributes. 1655 NumPropertyAttrsBits = 12 1656 }; 1657 1658 enum SetterKind { Assign, Retain, Copy, Weak }; 1659 enum PropertyControl { None, Required, Optional }; 1660private: 1661 SourceLocation AtLoc; // location of @property 1662 TypeSourceInfo *DeclType; 1663 unsigned PropertyAttributes : NumPropertyAttrsBits; 1664 unsigned PropertyAttributesAsWritten : NumPropertyAttrsBits; 1665 // @required/@optional 1666 unsigned PropertyImplementation : 2; 1667 1668 Selector GetterName; // getter name of NULL if no getter 1669 Selector SetterName; // setter name of NULL if no setter 1670 1671 ObjCMethodDecl *GetterMethodDecl; // Declaration of getter instance method 1672 ObjCMethodDecl *SetterMethodDecl; // Declaration of setter instance method 1673 ObjCIvarDecl *PropertyIvarDecl; // Synthesize ivar for this property 1674 1675 ObjCPropertyDecl(DeclContext *DC, SourceLocation L, IdentifierInfo *Id, 1676 SourceLocation AtLocation, TypeSourceInfo *T) 1677 : NamedDecl(ObjCProperty, DC, L, Id), AtLoc(AtLocation), DeclType(T), 1678 PropertyAttributes(OBJC_PR_noattr), 1679 PropertyAttributesAsWritten(OBJC_PR_noattr), 1680 PropertyImplementation(None), 1681 GetterName(Selector()), 1682 SetterName(Selector()), 1683 GetterMethodDecl(0), SetterMethodDecl(0) , PropertyIvarDecl(0) {} 1684public: 1685 static ObjCPropertyDecl *Create(ASTContext &C, DeclContext *DC, 1686 SourceLocation L, 1687 IdentifierInfo *Id, SourceLocation AtLocation, 1688 TypeSourceInfo *T, 1689 PropertyControl propControl = None); 1690 SourceLocation getAtLoc() const { return AtLoc; } 1691 void setAtLoc(SourceLocation L) { AtLoc = L; } 1692 1693 TypeSourceInfo *getTypeSourceInfo() const { return DeclType; } 1694 QualType getType() const { return DeclType->getType(); } 1695 void setType(TypeSourceInfo *T) { DeclType = T; } 1696 1697 PropertyAttributeKind getPropertyAttributes() const { 1698 return PropertyAttributeKind(PropertyAttributes); 1699 } 1700 void setPropertyAttributes(PropertyAttributeKind PRVal) { 1701 PropertyAttributes |= PRVal; 1702 } 1703 1704 PropertyAttributeKind getPropertyAttributesAsWritten() const { 1705 return PropertyAttributeKind(PropertyAttributesAsWritten); 1706 } 1707 1708 bool hasWrittenStorageAttribute() const { 1709 return PropertyAttributesAsWritten & (OBJC_PR_assign | OBJC_PR_copy | 1710 OBJC_PR_unsafe_unretained | OBJC_PR_retain | OBJC_PR_strong | 1711 OBJC_PR_weak); 1712 } 1713 1714 void setPropertyAttributesAsWritten(PropertyAttributeKind PRVal) { 1715 PropertyAttributesAsWritten = PRVal; 1716 } 1717 1718 void makeitReadWriteAttribute(void) { 1719 PropertyAttributes &= ~OBJC_PR_readonly; 1720 PropertyAttributes |= OBJC_PR_readwrite; 1721 } 1722 1723 // Helper methods for accessing attributes. 1724 1725 /// isReadOnly - Return true iff the property has a setter. 1726 bool isReadOnly() const { 1727 return (PropertyAttributes & OBJC_PR_readonly); 1728 } 1729 1730 /// isAtomic - Return true if the property is atomic. 1731 bool isAtomic() const { 1732 return (PropertyAttributes & OBJC_PR_atomic); 1733 } 1734 1735 /// isRetaining - Return true if the property retains its value. 1736 bool isRetaining() const { 1737 return (PropertyAttributes & 1738 (OBJC_PR_retain | OBJC_PR_strong | OBJC_PR_copy)); 1739 } 1740 1741 /// getSetterKind - Return the method used for doing assignment in 1742 /// the property setter. This is only valid if the property has been 1743 /// defined to have a setter. 1744 SetterKind getSetterKind() const { 1745 if (PropertyAttributes & OBJC_PR_strong) 1746 return getType()->isBlockPointerType() ? Copy : Retain; 1747 if (PropertyAttributes & OBJC_PR_retain) 1748 return Retain; 1749 if (PropertyAttributes & OBJC_PR_copy) 1750 return Copy; 1751 if (PropertyAttributes & OBJC_PR_weak) 1752 return Weak; 1753 return Assign; 1754 } 1755 1756 Selector getGetterName() const { return GetterName; } 1757 void setGetterName(Selector Sel) { GetterName = Sel; } 1758 1759 Selector getSetterName() const { return SetterName; } 1760 void setSetterName(Selector Sel) { SetterName = Sel; } 1761 1762 ObjCMethodDecl *getGetterMethodDecl() const { return GetterMethodDecl; } 1763 void setGetterMethodDecl(ObjCMethodDecl *gDecl) { GetterMethodDecl = gDecl; } 1764 1765 ObjCMethodDecl *getSetterMethodDecl() const { return SetterMethodDecl; } 1766 void setSetterMethodDecl(ObjCMethodDecl *gDecl) { SetterMethodDecl = gDecl; } 1767 1768 // Related to @optional/@required declared in @protocol 1769 void setPropertyImplementation(PropertyControl pc) { 1770 PropertyImplementation = pc; 1771 } 1772 PropertyControl getPropertyImplementation() const { 1773 return PropertyControl(PropertyImplementation); 1774 } 1775 1776 void setPropertyIvarDecl(ObjCIvarDecl *Ivar) { 1777 PropertyIvarDecl = Ivar; 1778 } 1779 ObjCIvarDecl *getPropertyIvarDecl() const { 1780 return PropertyIvarDecl; 1781 } 1782 1783 virtual SourceRange getSourceRange() const { 1784 return SourceRange(AtLoc, getLocation()); 1785 } 1786 1787 /// Lookup a property by name in the specified DeclContext. 1788 static ObjCPropertyDecl *findPropertyDecl(const DeclContext *DC, 1789 IdentifierInfo *propertyID); 1790 1791 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 1792 static bool classof(const ObjCPropertyDecl *D) { return true; } 1793 static bool classofKind(Kind K) { return K == ObjCProperty; } 1794}; 1795 1796/// ObjCPropertyImplDecl - Represents implementation declaration of a property 1797/// in a class or category implementation block. For example: 1798/// @synthesize prop1 = ivar1; 1799/// 1800class ObjCPropertyImplDecl : public Decl { 1801public: 1802 enum Kind { 1803 Synthesize, 1804 Dynamic 1805 }; 1806private: 1807 SourceLocation AtLoc; // location of @synthesize or @dynamic 1808 1809 /// \brief For @synthesize, the location of the ivar, if it was written in 1810 /// the source code. 1811 /// 1812 /// \code 1813 /// @synthesize int a = b 1814 /// \endcode 1815 SourceLocation IvarLoc; 1816 1817 /// Property declaration being implemented 1818 ObjCPropertyDecl *PropertyDecl; 1819 1820 /// Null for @dynamic. Required for @synthesize. 1821 ObjCIvarDecl *PropertyIvarDecl; 1822 1823 /// Null for @dynamic. Non-null if property must be copy-constructed in getter 1824 Expr *GetterCXXConstructor; 1825 1826 /// Null for @dynamic. Non-null if property has assignment operator to call 1827 /// in Setter synthesis. 1828 Expr *SetterCXXAssignment; 1829 1830 ObjCPropertyImplDecl(DeclContext *DC, SourceLocation atLoc, SourceLocation L, 1831 ObjCPropertyDecl *property, 1832 Kind PK, 1833 ObjCIvarDecl *ivarDecl, 1834 SourceLocation ivarLoc) 1835 : Decl(ObjCPropertyImpl, DC, L), AtLoc(atLoc), 1836 IvarLoc(ivarLoc), PropertyDecl(property), PropertyIvarDecl(ivarDecl), 1837 GetterCXXConstructor(0), SetterCXXAssignment(0) { 1838 assert (PK == Dynamic || PropertyIvarDecl); 1839 } 1840 1841public: 1842 static ObjCPropertyImplDecl *Create(ASTContext &C, DeclContext *DC, 1843 SourceLocation atLoc, SourceLocation L, 1844 ObjCPropertyDecl *property, 1845 Kind PK, 1846 ObjCIvarDecl *ivarDecl, 1847 SourceLocation ivarLoc); 1848 1849 virtual SourceRange getSourceRange() const; 1850 1851 SourceLocation getLocStart() const { return AtLoc; } 1852 void setAtLoc(SourceLocation Loc) { AtLoc = Loc; } 1853 1854 ObjCPropertyDecl *getPropertyDecl() const { 1855 return PropertyDecl; 1856 } 1857 void setPropertyDecl(ObjCPropertyDecl *Prop) { PropertyDecl = Prop; } 1858 1859 Kind getPropertyImplementation() const { 1860 return PropertyIvarDecl ? Synthesize : Dynamic; 1861 } 1862 1863 ObjCIvarDecl *getPropertyIvarDecl() const { 1864 return PropertyIvarDecl; 1865 } 1866 SourceLocation getPropertyIvarDeclLoc() const { return IvarLoc; } 1867 1868 void setPropertyIvarDecl(ObjCIvarDecl *Ivar, 1869 SourceLocation IvarLoc) { 1870 PropertyIvarDecl = Ivar; 1871 this->IvarLoc = IvarLoc; 1872 } 1873 1874 Expr *getGetterCXXConstructor() const { 1875 return GetterCXXConstructor; 1876 } 1877 void setGetterCXXConstructor(Expr *getterCXXConstructor) { 1878 GetterCXXConstructor = getterCXXConstructor; 1879 } 1880 1881 Expr *getSetterCXXAssignment() const { 1882 return SetterCXXAssignment; 1883 } 1884 void setSetterCXXAssignment(Expr *setterCXXAssignment) { 1885 SetterCXXAssignment = setterCXXAssignment; 1886 } 1887 1888 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 1889 static bool classof(const ObjCPropertyImplDecl *D) { return true; } 1890 static bool classofKind(Decl::Kind K) { return K == ObjCPropertyImpl; } 1891 1892 friend class ASTDeclReader; 1893}; 1894 1895} // end namespace clang 1896#endif 1897