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