1 //===--- DeclObjC.h - Classes for representing declarations -----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the DeclObjC interface and subclasses.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CLANG_AST_DECLOBJC_H
15 #define LLVM_CLANG_AST_DECLOBJC_H
17 #include "clang/AST/Decl.h"
18 #include "clang/AST/SelectorLocationsKind.h"
19 #include "llvm/ADT/STLExtras.h"
20 #include "llvm/Support/Compiler.h"
29 class ObjCProtocolDecl;
30 class ObjCCategoryDecl;
31 class ObjCPropertyDecl;
32 class ObjCPropertyImplDecl;
33 class CXXCtorInitializer;
36 ObjCListBase(const ObjCListBase &) = delete;
37 void operator=(const ObjCListBase &) = delete;
39 /// List is an array of pointers to objects that are not owned by this object.
44 ObjCListBase() : List(nullptr), NumElts(0) {}
45 unsigned size() const { return NumElts; }
46 bool empty() const { return NumElts == 0; }
49 void set(void *const* InList, unsigned Elts, ASTContext &Ctx);
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
58 class ObjCList : public ObjCListBase {
60 void set(T* const* InList, unsigned Elts, ASTContext &Ctx) {
61 ObjCListBase::set(reinterpret_cast<void*const*>(InList), Elts, Ctx);
64 typedef T* const * iterator;
65 iterator begin() const { return (iterator)List; }
66 iterator end() const { return (iterator)List+NumElts; }
68 T* operator[](unsigned Idx) const {
69 assert(Idx < NumElts && "Invalid access");
74 /// \brief A list of Objective-C protocols, along with the source
75 /// locations at which they were referenced.
76 class ObjCProtocolList : public ObjCList<ObjCProtocolDecl> {
77 SourceLocation *Locations;
79 using ObjCList<ObjCProtocolDecl>::set;
82 ObjCProtocolList() : ObjCList<ObjCProtocolDecl>(), Locations(nullptr) { }
84 typedef const SourceLocation *loc_iterator;
85 loc_iterator loc_begin() const { return Locations; }
86 loc_iterator loc_end() const { return Locations + size(); }
88 void set(ObjCProtocolDecl* const* InList, unsigned Elts,
89 const SourceLocation *Locs, ASTContext &Ctx);
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:
100 /// Setter/getter instance methods:
101 /// - (void)setMenu:(NSMenu *)menu;
102 /// - (NSMenu *)menu;
104 /// Instance method that takes 2 NSView arguments:
105 /// - (void)replaceSubview:(NSView *)oldView with:(NSView *)newView;
107 /// Getter class method:
108 /// + (NSMenu *)defaultMenu;
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.
113 class ObjCMethodDecl : public NamedDecl, public DeclContext {
115 enum ImplementationControl { None, Required, Optional };
117 // The conventional meaning of this method; an ObjCMethodFamily.
118 // This is not serialized; instead, it is computed on demand and
120 mutable unsigned Family : ObjCMethodFamilyBitWidth;
122 /// instance (true) or class (false) method.
123 unsigned IsInstance : 1;
124 unsigned IsVariadic : 1;
126 /// True if this method is the getter or setter for an explicit property.
127 unsigned IsPropertyAccessor : 1;
129 // Method has a definition.
130 unsigned IsDefined : 1;
132 /// \brief Method redeclaration in the same interface.
133 unsigned IsRedeclaration : 1;
135 /// \brief Is redeclared in the same interface.
136 mutable unsigned HasRedeclaration : 1;
138 // NOTE: VC++ treats enums as signed, avoid using ImplementationControl enum
139 /// \@required/\@optional
140 unsigned DeclImplementation : 2;
142 // NOTE: VC++ treats enums as signed, avoid using the ObjCDeclQualifier enum
144 unsigned objcDeclQualifier : 7;
146 /// \brief Indicates whether this method has a related result type.
147 unsigned RelatedResultType : 1;
149 /// \brief Whether the locations of the selector identifiers are in a
150 /// "standard" position, a enum SelectorLocationsKind.
151 unsigned SelLocsKind : 2;
153 /// \brief Whether this method overrides any other in the class hierarchy.
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;
162 /// \brief Indicates if the method was a definition but its body was skipped.
163 unsigned HasSkippedBody : 1;
165 // Return type of this method.
166 QualType MethodDeclType;
168 // Type source information for the return type.
169 TypeSourceInfo *ReturnTInfo;
171 /// \brief Array of ParmVarDecls for the formal parameters of this method
172 /// and optionally followed by selector locations.
173 void *ParamsAndSelLocs;
176 /// List of attributes for this method declaration.
177 SourceLocation DeclEndLoc; // the location of the ';' or '{'.
179 // The following are only used for method definitions, null otherwise.
180 LazyDeclStmtPtr Body;
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;
189 SelectorLocationsKind getSelLocsKind() const {
190 return (SelectorLocationsKind)SelLocsKind;
192 bool hasStandardSelLocs() const {
193 return getSelLocsKind() != SelLoc_NonStandard;
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);
201 const SourceLocation *getStoredSelLocs() const {
202 return reinterpret_cast<const SourceLocation*>(getParams() + NumParams);
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);
210 const ParmVarDecl *const *getParams() const {
211 return reinterpret_cast<const ParmVarDecl *const *>(ParamsAndSelLocs);
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())
219 return getNumSelectorLocs();
222 void setParamsAndSelLocs(ASTContext &C,
223 ArrayRef<ParmVarDecl*> Params,
224 ArrayRef<SourceLocation> SelLocs);
226 ObjCMethodDecl(SourceLocation beginLoc, SourceLocation endLoc,
227 Selector SelInfo, QualType T, TypeSourceInfo *ReturnTInfo,
228 DeclContext *contextDecl, bool isInstance = true,
229 bool isVariadic = false, bool isPropertyAccessor = false,
230 bool isImplicitlyDeclared = false, bool isDefined = false,
231 ImplementationControl impControl = None,
232 bool HasRelatedResultType = false)
233 : NamedDecl(ObjCMethod, contextDecl, beginLoc, SelInfo),
234 DeclContext(ObjCMethod), Family(InvalidObjCMethodFamily),
235 IsInstance(isInstance), IsVariadic(isVariadic),
236 IsPropertyAccessor(isPropertyAccessor), IsDefined(isDefined),
237 IsRedeclaration(0), HasRedeclaration(0), DeclImplementation(impControl),
238 objcDeclQualifier(OBJC_TQ_None),
239 RelatedResultType(HasRelatedResultType),
240 SelLocsKind(SelLoc_StandardNoSpace), IsOverriding(0), HasSkippedBody(0),
241 MethodDeclType(T), ReturnTInfo(ReturnTInfo), ParamsAndSelLocs(nullptr),
242 NumParams(0), DeclEndLoc(endLoc), Body(), SelfDecl(nullptr),
244 setImplicit(isImplicitlyDeclared);
247 /// \brief A definition will return its interface declaration.
248 /// An interface declaration will return its definition.
249 /// Otherwise it will return itself.
250 ObjCMethodDecl *getNextRedeclarationImpl() override;
253 static ObjCMethodDecl *
254 Create(ASTContext &C, SourceLocation beginLoc, SourceLocation endLoc,
255 Selector SelInfo, QualType T, TypeSourceInfo *ReturnTInfo,
256 DeclContext *contextDecl, bool isInstance = true,
257 bool isVariadic = false, bool isPropertyAccessor = false,
258 bool isImplicitlyDeclared = false, bool isDefined = false,
259 ImplementationControl impControl = None,
260 bool HasRelatedResultType = false);
262 static ObjCMethodDecl *CreateDeserialized(ASTContext &C, unsigned ID);
264 ObjCMethodDecl *getCanonicalDecl() override;
265 const ObjCMethodDecl *getCanonicalDecl() const {
266 return const_cast<ObjCMethodDecl*>(this)->getCanonicalDecl();
269 ObjCDeclQualifier getObjCDeclQualifier() const {
270 return ObjCDeclQualifier(objcDeclQualifier);
272 void setObjCDeclQualifier(ObjCDeclQualifier QV) { objcDeclQualifier = QV; }
274 /// \brief Determine whether this method has a result type that is related
275 /// to the message receiver's type.
276 bool hasRelatedResultType() const { return RelatedResultType; }
278 /// \brief Note whether this method has a related result type.
279 void SetRelatedResultType(bool RRT = true) { RelatedResultType = RRT; }
281 /// \brief True if this is a method redeclaration in the same interface.
282 bool isRedeclaration() const { return IsRedeclaration; }
283 void setAsRedeclaration(const ObjCMethodDecl *PrevMethod);
285 /// \brief Returns the location where the declarator ends. It will be
286 /// the location of ';' for a method declaration and the location of '{'
287 /// for a method definition.
288 SourceLocation getDeclaratorEndLoc() const { return DeclEndLoc; }
290 // Location information, modeled after the Stmt API.
291 SourceLocation getLocStart() const LLVM_READONLY { return getLocation(); }
292 SourceLocation getLocEnd() const LLVM_READONLY;
293 SourceRange getSourceRange() const override LLVM_READONLY {
294 return SourceRange(getLocation(), getLocEnd());
297 SourceLocation getSelectorStartLoc() const {
299 return getLocStart();
300 return getSelectorLoc(0);
302 SourceLocation getSelectorLoc(unsigned Index) const {
303 assert(Index < getNumSelectorLocs() && "Index out of range!");
304 if (hasStandardSelLocs())
305 return getStandardSelectorLoc(Index, getSelector(),
306 getSelLocsKind() == SelLoc_StandardWithSpace,
309 return getStoredSelLocs()[Index];
312 void getSelectorLocs(SmallVectorImpl<SourceLocation> &SelLocs) const;
314 unsigned getNumSelectorLocs() const {
317 Selector Sel = getSelector();
318 if (Sel.isUnarySelector())
320 return Sel.getNumArgs();
323 ObjCInterfaceDecl *getClassInterface();
324 const ObjCInterfaceDecl *getClassInterface() const {
325 return const_cast<ObjCMethodDecl*>(this)->getClassInterface();
328 Selector getSelector() const { return getDeclName().getObjCSelector(); }
330 QualType getReturnType() const { return MethodDeclType; }
331 void setReturnType(QualType T) { MethodDeclType = T; }
332 SourceRange getReturnTypeSourceRange() const;
334 /// \brief Determine the type of an expression that sends a message to this
335 /// function. This replaces the type parameters with the types they would
336 /// get if the receiver was parameterless (e.g. it may replace the type
337 /// parameter with 'id').
338 QualType getSendResultType() const;
340 /// Determine the type of an expression that sends a message to this
341 /// function with the given receiver type.
342 QualType getSendResultType(QualType receiverType) const;
344 TypeSourceInfo *getReturnTypeSourceInfo() const { return ReturnTInfo; }
345 void setReturnTypeSourceInfo(TypeSourceInfo *TInfo) { ReturnTInfo = TInfo; }
347 // Iterator access to formal parameters.
348 unsigned param_size() const { return NumParams; }
349 typedef const ParmVarDecl *const *param_const_iterator;
350 typedef ParmVarDecl *const *param_iterator;
351 typedef llvm::iterator_range<param_iterator> param_range;
352 typedef llvm::iterator_range<param_const_iterator> param_const_range;
354 param_range params() { return param_range(param_begin(), param_end()); }
355 param_const_range params() const {
356 return param_const_range(param_begin(), param_end());
359 param_const_iterator param_begin() const {
360 return param_const_iterator(getParams());
362 param_const_iterator param_end() const {
363 return param_const_iterator(getParams() + NumParams);
365 param_iterator param_begin() { return param_iterator(getParams()); }
366 param_iterator param_end() { return param_iterator(getParams() + NumParams); }
368 // This method returns and of the parameters which are part of the selector
369 // name mangling requirements.
370 param_const_iterator sel_param_end() const {
371 return param_begin() + getSelector().getNumArgs();
374 // ArrayRef access to formal parameters. This should eventually
375 // replace the iterator interface above.
376 ArrayRef<ParmVarDecl*> parameters() const {
377 return llvm::makeArrayRef(const_cast<ParmVarDecl**>(getParams()),
381 /// \brief Sets the method's parameters and selector source locations.
382 /// If the method is implicit (not coming from source) \p SelLocs is
384 void setMethodParams(ASTContext &C,
385 ArrayRef<ParmVarDecl*> Params,
386 ArrayRef<SourceLocation> SelLocs = llvm::None);
388 // Iterator access to parameter types.
389 typedef std::const_mem_fun_t<QualType, ParmVarDecl> deref_fun;
390 typedef llvm::mapped_iterator<param_const_iterator, deref_fun>
393 param_type_iterator param_type_begin() const {
394 return llvm::map_iterator(param_begin(), deref_fun(&ParmVarDecl::getType));
396 param_type_iterator param_type_end() const {
397 return llvm::map_iterator(param_end(), deref_fun(&ParmVarDecl::getType));
400 /// createImplicitParams - Used to lazily create the self and cmd
401 /// implict parameters. This must be called prior to using getSelfDecl()
402 /// or getCmdDecl(). The call is ignored if the implicit paramters
403 /// have already been created.
404 void createImplicitParams(ASTContext &Context, const ObjCInterfaceDecl *ID);
406 /// \return the type for \c self and set \arg selfIsPseudoStrong and
407 /// \arg selfIsConsumed accordingly.
408 QualType getSelfType(ASTContext &Context, const ObjCInterfaceDecl *OID,
409 bool &selfIsPseudoStrong, bool &selfIsConsumed);
411 ImplicitParamDecl * getSelfDecl() const { return SelfDecl; }
412 void setSelfDecl(ImplicitParamDecl *SD) { SelfDecl = SD; }
413 ImplicitParamDecl * getCmdDecl() const { return CmdDecl; }
414 void setCmdDecl(ImplicitParamDecl *CD) { CmdDecl = CD; }
416 /// Determines the family of this method.
417 ObjCMethodFamily getMethodFamily() const;
419 bool isInstanceMethod() const { return IsInstance; }
420 void setInstanceMethod(bool isInst) { IsInstance = isInst; }
421 bool isVariadic() const { return IsVariadic; }
422 void setVariadic(bool isVar) { IsVariadic = isVar; }
424 bool isClassMethod() const { return !IsInstance; }
426 bool isPropertyAccessor() const { return IsPropertyAccessor; }
427 void setPropertyAccessor(bool isAccessor) { IsPropertyAccessor = isAccessor; }
429 bool isDefined() const { return IsDefined; }
430 void setDefined(bool isDefined) { IsDefined = isDefined; }
432 /// \brief Whether this method overrides any other in the class hierarchy.
434 /// A method is said to override any method in the class's
435 /// base classes, its protocols, or its categories' protocols, that has
436 /// the same selector and is of the same kind (class or instance).
437 /// A method in an implementation is not considered as overriding the same
438 /// method in the interface or its categories.
439 bool isOverriding() const { return IsOverriding; }
440 void setOverriding(bool isOverriding) { IsOverriding = isOverriding; }
442 /// \brief Return overridden methods for the given \p Method.
444 /// An ObjC method is considered to override any method in the class's
445 /// base classes (and base's categories), its protocols, or its categories'
446 /// protocols, that has
447 /// the same selector and is of the same kind (class or instance).
448 /// A method in an implementation is not considered as overriding the same
449 /// method in the interface or its categories.
450 void getOverriddenMethods(
451 SmallVectorImpl<const ObjCMethodDecl *> &Overridden) const;
453 /// \brief True if the method was a definition but its body was skipped.
454 bool hasSkippedBody() const { return HasSkippedBody; }
455 void setHasSkippedBody(bool Skipped = true) { HasSkippedBody = Skipped; }
457 /// \brief Returns the property associated with this method's selector.
459 /// Note that even if this particular method is not marked as a property
460 /// accessor, it is still possible for it to match a property declared in a
461 /// superclass. Pass \c false if you only want to check the current class.
462 const ObjCPropertyDecl *findPropertyDecl(bool CheckOverrides = true) const;
464 // Related to protocols declared in \@protocol
465 void setDeclImplementation(ImplementationControl ic) {
466 DeclImplementation = ic;
468 ImplementationControl getImplementationControl() const {
469 return ImplementationControl(DeclImplementation);
472 /// Returns true if this specific method declaration is marked with the
473 /// designated initializer attribute.
474 bool isThisDeclarationADesignatedInitializer() const;
476 /// Returns true if the method selector resolves to a designated initializer
477 /// in the class's interface.
479 /// \param InitMethod if non-null and the function returns true, it receives
480 /// the method declaration that was marked with the designated initializer
482 bool isDesignatedInitializerForTheInterface(
483 const ObjCMethodDecl **InitMethod = nullptr) const;
485 /// \brief Determine whether this method has a body.
486 bool hasBody() const override { return Body.isValid(); }
488 /// \brief Retrieve the body of this method, if it has one.
489 Stmt *getBody() const override;
491 void setLazyBody(uint64_t Offset) { Body = Offset; }
493 CompoundStmt *getCompoundBody() { return (CompoundStmt*)getBody(); }
494 void setBody(Stmt *B) { Body = B; }
496 /// \brief Returns whether this specific method is a definition.
497 bool isThisDeclarationADefinition() const { return hasBody(); }
499 // Implement isa/cast/dyncast/etc.
500 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
501 static bool classofKind(Kind K) { return K == ObjCMethod; }
502 static DeclContext *castToDeclContext(const ObjCMethodDecl *D) {
503 return static_cast<DeclContext *>(const_cast<ObjCMethodDecl*>(D));
505 static ObjCMethodDecl *castFromDeclContext(const DeclContext *DC) {
506 return static_cast<ObjCMethodDecl *>(const_cast<DeclContext*>(DC));
509 friend class ASTDeclReader;
510 friend class ASTDeclWriter;
513 /// Describes the variance of a given generic parameter.
514 enum class ObjCTypeParamVariance : uint8_t {
515 /// The parameter is invariant: must match exactly.
517 /// The parameter is covariant, e.g., X<T> is a subtype of X<U> when
518 /// the type parameter is covariant and T is a subtype of U.
520 /// The parameter is contravariant, e.g., X<T> is a subtype of X<U>
521 /// when the type parameter is covariant and U is a subtype of T.
525 /// Represents the declaration of an Objective-C type parameter.
528 /// @interface NSDictionary<Key : id<NSCopying>, Value>
532 /// In the example above, both \c Key and \c Value are represented by
533 /// \c ObjCTypeParamDecl. \c Key has an explicit bound of \c id<NSCopying>,
534 /// while \c Value gets an implicit bound of \c id.
536 /// Objective-C type parameters are typedef-names in the grammar,
537 class ObjCTypeParamDecl : public TypedefNameDecl {
538 void anchor() override;
540 /// Index of this type parameter in the type parameter list.
543 /// The variance of the type parameter.
544 unsigned Variance : 2;
546 /// The location of the variance, if any.
547 SourceLocation VarianceLoc;
549 /// The location of the ':', which will be valid when the bound was
550 /// explicitly specified.
551 SourceLocation ColonLoc;
553 ObjCTypeParamDecl(ASTContext &ctx, DeclContext *dc,
554 ObjCTypeParamVariance variance, SourceLocation varianceLoc,
556 SourceLocation nameLoc, IdentifierInfo *name,
557 SourceLocation colonLoc, TypeSourceInfo *boundInfo)
558 : TypedefNameDecl(ObjCTypeParam, ctx, dc, nameLoc, nameLoc, name,
560 Index(index), Variance(static_cast<unsigned>(variance)),
561 VarianceLoc(varianceLoc), ColonLoc(colonLoc) { }
564 static ObjCTypeParamDecl *Create(ASTContext &ctx, DeclContext *dc,
565 ObjCTypeParamVariance variance,
566 SourceLocation varianceLoc,
568 SourceLocation nameLoc,
569 IdentifierInfo *name,
570 SourceLocation colonLoc,
571 TypeSourceInfo *boundInfo);
572 static ObjCTypeParamDecl *CreateDeserialized(ASTContext &ctx, unsigned ID);
574 SourceRange getSourceRange() const override LLVM_READONLY;
576 /// Determine the variance of this type parameter.
577 ObjCTypeParamVariance getVariance() const {
578 return static_cast<ObjCTypeParamVariance>(Variance);
581 /// Set the variance of this type parameter.
582 void setVariance(ObjCTypeParamVariance variance) {
583 Variance = static_cast<unsigned>(variance);
586 /// Retrieve the location of the variance keyword.
587 SourceLocation getVarianceLoc() const { return VarianceLoc; }
589 /// Retrieve the index into its type parameter list.
590 unsigned getIndex() const { return Index; }
592 /// Whether this type parameter has an explicitly-written type bound, e.g.,
594 bool hasExplicitBound() const { return ColonLoc.isValid(); }
596 /// Retrieve the location of the ':' separating the type parameter name
597 /// from the explicitly-specified bound.
598 SourceLocation getColonLoc() const { return ColonLoc; }
600 // Implement isa/cast/dyncast/etc.
601 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
602 static bool classofKind(Kind K) { return K == ObjCTypeParam; }
604 friend class ASTDeclReader;
605 friend class ASTDeclWriter;
608 /// Stores a list of Objective-C type parameters for a parameterized class
609 /// or a category/extension thereof.
612 /// @interface NSArray<T> // stores the <T>
615 class ObjCTypeParamList final
616 : private llvm::TrailingObjects<ObjCTypeParamList, ObjCTypeParamDecl *> {
617 /// Stores the components of a SourceRange as a POD.
618 struct PODSourceRange {
624 /// Location of the left and right angle brackets.
625 PODSourceRange Brackets;
627 // Used only for alignment.
628 ObjCTypeParamDecl *AlignmentHack;
631 /// The number of parameters in the list, which are tail-allocated.
634 ObjCTypeParamList(SourceLocation lAngleLoc,
635 ArrayRef<ObjCTypeParamDecl *> typeParams,
636 SourceLocation rAngleLoc);
639 /// Create a new Objective-C type parameter list.
640 static ObjCTypeParamList *create(ASTContext &ctx,
641 SourceLocation lAngleLoc,
642 ArrayRef<ObjCTypeParamDecl *> typeParams,
643 SourceLocation rAngleLoc);
645 /// Iterate through the type parameters in the list.
646 typedef ObjCTypeParamDecl **iterator;
648 iterator begin() { return getTrailingObjects<ObjCTypeParamDecl *>(); }
650 iterator end() { return begin() + size(); }
652 /// Determine the number of type parameters in this list.
653 unsigned size() const { return NumParams; }
655 // Iterate through the type parameters in the list.
656 typedef ObjCTypeParamDecl * const *const_iterator;
658 const_iterator begin() const {
659 return getTrailingObjects<ObjCTypeParamDecl *>();
662 const_iterator end() const {
663 return begin() + size();
666 ObjCTypeParamDecl *front() const {
667 assert(size() > 0 && "empty Objective-C type parameter list");
671 ObjCTypeParamDecl *back() const {
672 assert(size() > 0 && "empty Objective-C type parameter list");
676 SourceLocation getLAngleLoc() const {
677 return SourceLocation::getFromRawEncoding(Brackets.Begin);
679 SourceLocation getRAngleLoc() const {
680 return SourceLocation::getFromRawEncoding(Brackets.End);
682 SourceRange getSourceRange() const {
683 return SourceRange(getLAngleLoc(), getRAngleLoc());
686 /// Gather the default set of type arguments to be substituted for
687 /// these type parameters when dealing with an unspecialized type.
688 void gatherDefaultTypeArgs(SmallVectorImpl<QualType> &typeArgs) const;
689 friend TrailingObjects;
692 /// ObjCContainerDecl - Represents a container for method declarations.
693 /// Current sub-classes are ObjCInterfaceDecl, ObjCCategoryDecl,
694 /// ObjCProtocolDecl, and ObjCImplDecl.
696 class ObjCContainerDecl : public NamedDecl, public DeclContext {
697 void anchor() override;
699 SourceLocation AtStart;
701 // These two locations in the range mark the end of the method container.
702 // The first points to the '@' token, and the second to the 'end' token.
706 ObjCContainerDecl(Kind DK, DeclContext *DC,
707 IdentifierInfo *Id, SourceLocation nameLoc,
708 SourceLocation atStartLoc)
709 : NamedDecl(DK, DC, nameLoc, Id), DeclContext(DK), AtStart(atStartLoc) {}
711 // Iterator access to properties.
712 typedef specific_decl_iterator<ObjCPropertyDecl> prop_iterator;
713 typedef llvm::iterator_range<specific_decl_iterator<ObjCPropertyDecl>>
716 prop_range properties() const { return prop_range(prop_begin(), prop_end()); }
717 prop_iterator prop_begin() const {
718 return prop_iterator(decls_begin());
720 prop_iterator prop_end() const {
721 return prop_iterator(decls_end());
724 // Iterator access to instance/class methods.
725 typedef specific_decl_iterator<ObjCMethodDecl> method_iterator;
726 typedef llvm::iterator_range<specific_decl_iterator<ObjCMethodDecl>>
729 method_range methods() const {
730 return method_range(meth_begin(), meth_end());
732 method_iterator meth_begin() const {
733 return method_iterator(decls_begin());
735 method_iterator meth_end() const {
736 return method_iterator(decls_end());
739 typedef filtered_decl_iterator<ObjCMethodDecl,
740 &ObjCMethodDecl::isInstanceMethod>
742 typedef llvm::iterator_range<instmeth_iterator> instmeth_range;
744 instmeth_range instance_methods() const {
745 return instmeth_range(instmeth_begin(), instmeth_end());
747 instmeth_iterator instmeth_begin() const {
748 return instmeth_iterator(decls_begin());
750 instmeth_iterator instmeth_end() const {
751 return instmeth_iterator(decls_end());
754 typedef filtered_decl_iterator<ObjCMethodDecl,
755 &ObjCMethodDecl::isClassMethod>
757 typedef llvm::iterator_range<classmeth_iterator> classmeth_range;
759 classmeth_range class_methods() const {
760 return classmeth_range(classmeth_begin(), classmeth_end());
762 classmeth_iterator classmeth_begin() const {
763 return classmeth_iterator(decls_begin());
765 classmeth_iterator classmeth_end() const {
766 return classmeth_iterator(decls_end());
769 // Get the local instance/class method declared in this interface.
770 ObjCMethodDecl *getMethod(Selector Sel, bool isInstance,
771 bool AllowHidden = false) const;
772 ObjCMethodDecl *getInstanceMethod(Selector Sel,
773 bool AllowHidden = false) const {
774 return getMethod(Sel, true/*isInstance*/, AllowHidden);
776 ObjCMethodDecl *getClassMethod(Selector Sel, bool AllowHidden = false) const {
777 return getMethod(Sel, false/*isInstance*/, AllowHidden);
779 bool HasUserDeclaredSetterMethod(const ObjCPropertyDecl *P) const;
780 ObjCIvarDecl *getIvarDecl(IdentifierInfo *Id) const;
783 FindPropertyDeclaration(const IdentifierInfo *PropertyId) const;
785 typedef llvm::DenseMap<IdentifierInfo*, ObjCPropertyDecl*> PropertyMap;
787 typedef llvm::DenseMap<const ObjCProtocolDecl *, ObjCPropertyDecl*>
790 typedef llvm::SmallVector<ObjCPropertyDecl*, 8> PropertyDeclOrder;
792 /// This routine collects list of properties to be implemented in the class.
793 /// This includes, class's and its conforming protocols' properties.
794 /// Note, the superclass's properties are not included in the list.
795 virtual void collectPropertiesToImplement(PropertyMap &PM,
796 PropertyDeclOrder &PO) const {}
798 SourceLocation getAtStartLoc() const { return AtStart; }
799 void setAtStartLoc(SourceLocation Loc) { AtStart = Loc; }
801 // Marks the end of the container.
802 SourceRange getAtEndRange() const {
805 void setAtEndRange(SourceRange atEnd) {
809 SourceRange getSourceRange() const override LLVM_READONLY {
810 return SourceRange(AtStart, getAtEndRange().getEnd());
813 // Implement isa/cast/dyncast/etc.
814 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
815 static bool classofKind(Kind K) {
816 return K >= firstObjCContainer &&
817 K <= lastObjCContainer;
820 static DeclContext *castToDeclContext(const ObjCContainerDecl *D) {
821 return static_cast<DeclContext *>(const_cast<ObjCContainerDecl*>(D));
823 static ObjCContainerDecl *castFromDeclContext(const DeclContext *DC) {
824 return static_cast<ObjCContainerDecl *>(const_cast<DeclContext*>(DC));
828 /// \brief Represents an ObjC class declaration.
833 /// // MostPrimitive declares no super class (not particularly useful).
834 /// \@interface MostPrimitive
835 /// // no instance variables or methods.
838 /// // NSResponder inherits from NSObject & implements NSCoding (a protocol).
839 /// \@interface NSResponder : NSObject \<NSCoding>
840 /// { // instance variables are represented by ObjCIvarDecl.
841 /// id nextResponder; // nextResponder instance variable.
843 /// - (NSResponder *)nextResponder; // return a pointer to NSResponder.
844 /// - (void)mouseMoved:(NSEvent *)theEvent; // return void, takes a pointer
845 /// \@end // to an NSEvent.
848 /// Unlike C/C++, forward class declarations are accomplished with \@class.
849 /// Unlike C/C++, \@class allows for a list of classes to be forward declared.
850 /// Unlike C++, ObjC is a single-rooted class model. In Cocoa, classes
851 /// typically inherit from NSObject (an exception is NSProxy).
853 class ObjCInterfaceDecl : public ObjCContainerDecl
854 , public Redeclarable<ObjCInterfaceDecl> {
855 void anchor() override;
857 /// TypeForDecl - This indicates the Type object that represents this
858 /// TypeDecl. It is a cache maintained by ASTContext::getObjCInterfaceType
859 mutable const Type *TypeForDecl;
860 friend class ASTContext;
862 struct DefinitionData {
863 /// \brief The definition of this class, for quick access from any
865 ObjCInterfaceDecl *Definition;
867 /// When non-null, this is always an ObjCObjectType.
868 TypeSourceInfo *SuperClassTInfo;
870 /// Protocols referenced in the \@interface declaration
871 ObjCProtocolList ReferencedProtocols;
873 /// Protocols reference in both the \@interface and class extensions.
874 ObjCList<ObjCProtocolDecl> AllReferencedProtocols;
876 /// \brief List of categories and class extensions defined for this class.
878 /// Categories are stored as a linked list in the AST, since the categories
879 /// and class extensions come long after the initial interface declaration,
880 /// and we avoid dynamically-resized arrays in the AST wherever possible.
881 ObjCCategoryDecl *CategoryList;
883 /// IvarList - List of all ivars defined by this class; including class
884 /// extensions and implementation. This list is built lazily.
885 ObjCIvarDecl *IvarList;
887 /// \brief Indicates that the contents of this Objective-C class will be
888 /// completed by the external AST source when required.
889 mutable bool ExternallyCompleted : 1;
891 /// \brief Indicates that the ivar cache does not yet include ivars
892 /// declared in the implementation.
893 mutable bool IvarListMissingImplementation : 1;
895 /// Indicates that this interface decl contains at least one initializer
896 /// marked with the 'objc_designated_initializer' attribute.
897 bool HasDesignatedInitializers : 1;
899 enum InheritedDesignatedInitializersState {
900 /// We didn't calculate whether the designated initializers should be
901 /// inherited or not.
903 /// Designated initializers are inherited for the super class.
905 /// The class does not inherit designated initializers.
908 /// One of the \c InheritedDesignatedInitializersState enumeratos.
909 mutable unsigned InheritedDesignatedInitializers : 2;
911 /// \brief The location of the last location in this declaration, before
912 /// the properties/methods. For example, this will be the '>', '}', or
914 SourceLocation EndLoc;
916 DefinitionData() : Definition(), SuperClassTInfo(), CategoryList(), IvarList(),
917 ExternallyCompleted(),
918 IvarListMissingImplementation(true),
919 HasDesignatedInitializers(),
920 InheritedDesignatedInitializers(IDI_Unknown) { }
923 ObjCInterfaceDecl(const ASTContext &C, DeclContext *DC, SourceLocation AtLoc,
924 IdentifierInfo *Id, ObjCTypeParamList *typeParamList,
925 SourceLocation CLoc, ObjCInterfaceDecl *PrevDecl,
928 void LoadExternalDefinition() const;
930 /// The type parameters associated with this class, if any.
931 ObjCTypeParamList *TypeParamList;
933 /// \brief Contains a pointer to the data associated with this class,
934 /// which will be NULL if this class has not yet been defined.
936 /// The bit indicates when we don't need to check for out-of-date
937 /// declarations. It will be set unless modules are enabled.
938 llvm::PointerIntPair<DefinitionData *, 1, bool> Data;
940 DefinitionData &data() const {
941 assert(Data.getPointer() && "Declaration has no definition!");
942 return *Data.getPointer();
945 /// \brief Allocate the definition data for this class.
946 void allocateDefinitionData();
948 typedef Redeclarable<ObjCInterfaceDecl> redeclarable_base;
949 ObjCInterfaceDecl *getNextRedeclarationImpl() override {
950 return getNextRedeclaration();
952 ObjCInterfaceDecl *getPreviousDeclImpl() override {
953 return getPreviousDecl();
955 ObjCInterfaceDecl *getMostRecentDeclImpl() override {
956 return getMostRecentDecl();
960 static ObjCInterfaceDecl *Create(const ASTContext &C, DeclContext *DC,
961 SourceLocation atLoc,
963 ObjCTypeParamList *typeParamList,
964 ObjCInterfaceDecl *PrevDecl,
965 SourceLocation ClassLoc = SourceLocation(),
966 bool isInternal = false);
968 static ObjCInterfaceDecl *CreateDeserialized(const ASTContext &C, unsigned ID);
970 /// Retrieve the type parameters of this class.
972 /// This function looks for a type parameter list for the given
973 /// class; if the class has been declared (with \c \@class) but not
974 /// defined (with \c \@interface), it will search for a declaration that
975 /// has type parameters, skipping any declarations that do not.
976 ObjCTypeParamList *getTypeParamList() const;
978 /// Set the type parameters of this class.
980 /// This function is used by the AST importer, which must import the type
981 /// parameters after creating their DeclContext to avoid loops.
982 void setTypeParamList(ObjCTypeParamList *TPL);
984 /// Retrieve the type parameters written on this particular declaration of
986 ObjCTypeParamList *getTypeParamListAsWritten() const {
987 return TypeParamList;
990 SourceRange getSourceRange() const override LLVM_READONLY {
991 if (isThisDeclarationADefinition())
992 return ObjCContainerDecl::getSourceRange();
994 return SourceRange(getAtStartLoc(), getLocation());
997 /// \brief Indicate that this Objective-C class is complete, but that
998 /// the external AST source will be responsible for filling in its contents
999 /// when a complete class is required.
1000 void setExternallyCompleted();
1002 /// Indicate that this interface decl contains at least one initializer
1003 /// marked with the 'objc_designated_initializer' attribute.
1004 void setHasDesignatedInitializers();
1006 /// Returns true if this interface decl contains at least one initializer
1007 /// marked with the 'objc_designated_initializer' attribute.
1008 bool hasDesignatedInitializers() const;
1010 /// Returns true if this interface decl declares a designated initializer
1011 /// or it inherites one from its super class.
1012 bool declaresOrInheritsDesignatedInitializers() const {
1013 return hasDesignatedInitializers() || inheritsDesignatedInitializers();
1016 const ObjCProtocolList &getReferencedProtocols() const {
1017 assert(hasDefinition() && "Caller did not check for forward reference!");
1018 if (data().ExternallyCompleted)
1019 LoadExternalDefinition();
1021 return data().ReferencedProtocols;
1024 ObjCImplementationDecl *getImplementation() const;
1025 void setImplementation(ObjCImplementationDecl *ImplD);
1027 ObjCCategoryDecl *FindCategoryDeclaration(IdentifierInfo *CategoryId) const;
1029 // Get the local instance/class method declared in a category.
1030 ObjCMethodDecl *getCategoryInstanceMethod(Selector Sel) const;
1031 ObjCMethodDecl *getCategoryClassMethod(Selector Sel) const;
1032 ObjCMethodDecl *getCategoryMethod(Selector Sel, bool isInstance) const {
1033 return isInstance ? getCategoryInstanceMethod(Sel)
1034 : getCategoryClassMethod(Sel);
1037 typedef ObjCProtocolList::iterator protocol_iterator;
1038 typedef llvm::iterator_range<protocol_iterator> protocol_range;
1040 protocol_range protocols() const {
1041 return protocol_range(protocol_begin(), protocol_end());
1043 protocol_iterator protocol_begin() const {
1044 // FIXME: Should make sure no callers ever do this.
1045 if (!hasDefinition())
1046 return protocol_iterator();
1048 if (data().ExternallyCompleted)
1049 LoadExternalDefinition();
1051 return data().ReferencedProtocols.begin();
1053 protocol_iterator protocol_end() const {
1054 // FIXME: Should make sure no callers ever do this.
1055 if (!hasDefinition())
1056 return protocol_iterator();
1058 if (data().ExternallyCompleted)
1059 LoadExternalDefinition();
1061 return data().ReferencedProtocols.end();
1064 typedef ObjCProtocolList::loc_iterator protocol_loc_iterator;
1065 typedef llvm::iterator_range<protocol_loc_iterator> protocol_loc_range;
1067 protocol_loc_range protocol_locs() const {
1068 return protocol_loc_range(protocol_loc_begin(), protocol_loc_end());
1070 protocol_loc_iterator protocol_loc_begin() const {
1071 // FIXME: Should make sure no callers ever do this.
1072 if (!hasDefinition())
1073 return protocol_loc_iterator();
1075 if (data().ExternallyCompleted)
1076 LoadExternalDefinition();
1078 return data().ReferencedProtocols.loc_begin();
1081 protocol_loc_iterator protocol_loc_end() const {
1082 // FIXME: Should make sure no callers ever do this.
1083 if (!hasDefinition())
1084 return protocol_loc_iterator();
1086 if (data().ExternallyCompleted)
1087 LoadExternalDefinition();
1089 return data().ReferencedProtocols.loc_end();
1092 typedef ObjCList<ObjCProtocolDecl>::iterator all_protocol_iterator;
1093 typedef llvm::iterator_range<all_protocol_iterator> all_protocol_range;
1095 all_protocol_range all_referenced_protocols() const {
1096 return all_protocol_range(all_referenced_protocol_begin(),
1097 all_referenced_protocol_end());
1099 all_protocol_iterator all_referenced_protocol_begin() const {
1100 // FIXME: Should make sure no callers ever do this.
1101 if (!hasDefinition())
1102 return all_protocol_iterator();
1104 if (data().ExternallyCompleted)
1105 LoadExternalDefinition();
1107 return data().AllReferencedProtocols.empty()
1109 : data().AllReferencedProtocols.begin();
1111 all_protocol_iterator all_referenced_protocol_end() const {
1112 // FIXME: Should make sure no callers ever do this.
1113 if (!hasDefinition())
1114 return all_protocol_iterator();
1116 if (data().ExternallyCompleted)
1117 LoadExternalDefinition();
1119 return data().AllReferencedProtocols.empty()
1121 : data().AllReferencedProtocols.end();
1124 typedef specific_decl_iterator<ObjCIvarDecl> ivar_iterator;
1125 typedef llvm::iterator_range<specific_decl_iterator<ObjCIvarDecl>> ivar_range;
1127 ivar_range ivars() const { return ivar_range(ivar_begin(), ivar_end()); }
1128 ivar_iterator ivar_begin() const {
1129 if (const ObjCInterfaceDecl *Def = getDefinition())
1130 return ivar_iterator(Def->decls_begin());
1132 // FIXME: Should make sure no callers ever do this.
1133 return ivar_iterator();
1135 ivar_iterator ivar_end() const {
1136 if (const ObjCInterfaceDecl *Def = getDefinition())
1137 return ivar_iterator(Def->decls_end());
1139 // FIXME: Should make sure no callers ever do this.
1140 return ivar_iterator();
1143 unsigned ivar_size() const {
1144 return std::distance(ivar_begin(), ivar_end());
1147 bool ivar_empty() const { return ivar_begin() == ivar_end(); }
1149 ObjCIvarDecl *all_declared_ivar_begin();
1150 const ObjCIvarDecl *all_declared_ivar_begin() const {
1151 // Even though this modifies IvarList, it's conceptually const:
1152 // the ivar chain is essentially a cached property of ObjCInterfaceDecl.
1153 return const_cast<ObjCInterfaceDecl *>(this)->all_declared_ivar_begin();
1155 void setIvarList(ObjCIvarDecl *ivar) { data().IvarList = ivar; }
1157 /// setProtocolList - Set the list of protocols that this interface
1159 void setProtocolList(ObjCProtocolDecl *const* List, unsigned Num,
1160 const SourceLocation *Locs, ASTContext &C) {
1161 data().ReferencedProtocols.set(List, Num, Locs, C);
1164 /// mergeClassExtensionProtocolList - Merge class extension's protocol list
1165 /// into the protocol list for this class.
1166 void mergeClassExtensionProtocolList(ObjCProtocolDecl *const* List,
1170 /// Produce a name to be used for class's metadata. It comes either via
1171 /// objc_runtime_name attribute or class name.
1172 StringRef getObjCRuntimeNameAsString() const;
1174 /// Returns the designated initializers for the interface.
1176 /// If this declaration does not have methods marked as designated
1177 /// initializers then the interface inherits the designated initializers of
1178 /// its super class.
1179 void getDesignatedInitializers(
1180 llvm::SmallVectorImpl<const ObjCMethodDecl *> &Methods) const;
1182 /// Returns true if the given selector is a designated initializer for the
1185 /// If this declaration does not have methods marked as designated
1186 /// initializers then the interface inherits the designated initializers of
1187 /// its super class.
1189 /// \param InitMethod if non-null and the function returns true, it receives
1190 /// the method that was marked as a designated initializer.
1192 isDesignatedInitializer(Selector Sel,
1193 const ObjCMethodDecl **InitMethod = nullptr) const;
1195 /// \brief Determine whether this particular declaration of this class is
1196 /// actually also a definition.
1197 bool isThisDeclarationADefinition() const {
1198 return getDefinition() == this;
1201 /// \brief Determine whether this class has been defined.
1202 bool hasDefinition() const {
1203 // If the name of this class is out-of-date, bring it up-to-date, which
1204 // might bring in a definition.
1205 // Note: a null value indicates that we don't have a definition and that
1206 // modules are enabled.
1207 if (!Data.getOpaqueValue())
1208 getMostRecentDecl();
1210 return Data.getPointer();
1213 /// \brief Retrieve the definition of this class, or NULL if this class
1214 /// has been forward-declared (with \@class) but not yet defined (with
1216 ObjCInterfaceDecl *getDefinition() {
1217 return hasDefinition()? Data.getPointer()->Definition : nullptr;
1220 /// \brief Retrieve the definition of this class, or NULL if this class
1221 /// has been forward-declared (with \@class) but not yet defined (with
1223 const ObjCInterfaceDecl *getDefinition() const {
1224 return hasDefinition()? Data.getPointer()->Definition : nullptr;
1227 /// \brief Starts the definition of this Objective-C class, taking it from
1228 /// a forward declaration (\@class) to a definition (\@interface).
1229 void startDefinition();
1231 /// Retrieve the superclass type.
1232 const ObjCObjectType *getSuperClassType() const {
1233 if (TypeSourceInfo *TInfo = getSuperClassTInfo())
1234 return TInfo->getType()->castAs<ObjCObjectType>();
1239 // Retrieve the type source information for the superclass.
1240 TypeSourceInfo *getSuperClassTInfo() const {
1241 // FIXME: Should make sure no callers ever do this.
1242 if (!hasDefinition())
1245 if (data().ExternallyCompleted)
1246 LoadExternalDefinition();
1248 return data().SuperClassTInfo;
1251 // Retrieve the declaration for the superclass of this class, which
1252 // does not include any type arguments that apply to the superclass.
1253 ObjCInterfaceDecl *getSuperClass() const;
1255 void setSuperClass(TypeSourceInfo *superClass) {
1256 data().SuperClassTInfo = superClass;
1259 /// \brief Iterator that walks over the list of categories, filtering out
1260 /// those that do not meet specific criteria.
1262 /// This class template is used for the various permutations of category
1263 /// and extension iterators.
1264 template<bool (*Filter)(ObjCCategoryDecl *)>
1265 class filtered_category_iterator {
1266 ObjCCategoryDecl *Current;
1268 void findAcceptableCategory();
1271 typedef ObjCCategoryDecl * value_type;
1272 typedef value_type reference;
1273 typedef value_type pointer;
1274 typedef std::ptrdiff_t difference_type;
1275 typedef std::input_iterator_tag iterator_category;
1277 filtered_category_iterator() : Current(nullptr) { }
1278 explicit filtered_category_iterator(ObjCCategoryDecl *Current)
1281 findAcceptableCategory();
1284 reference operator*() const { return Current; }
1285 pointer operator->() const { return Current; }
1287 filtered_category_iterator &operator++();
1289 filtered_category_iterator operator++(int) {
1290 filtered_category_iterator Tmp = *this;
1295 friend bool operator==(filtered_category_iterator X,
1296 filtered_category_iterator Y) {
1297 return X.Current == Y.Current;
1300 friend bool operator!=(filtered_category_iterator X,
1301 filtered_category_iterator Y) {
1302 return X.Current != Y.Current;
1307 /// \brief Test whether the given category is visible.
1309 /// Used in the \c visible_categories_iterator.
1310 static bool isVisibleCategory(ObjCCategoryDecl *Cat);
1313 /// \brief Iterator that walks over the list of categories and extensions
1314 /// that are visible, i.e., not hidden in a non-imported submodule.
1315 typedef filtered_category_iterator<isVisibleCategory>
1316 visible_categories_iterator;
1318 typedef llvm::iterator_range<visible_categories_iterator>
1319 visible_categories_range;
1321 visible_categories_range visible_categories() const {
1322 return visible_categories_range(visible_categories_begin(),
1323 visible_categories_end());
1326 /// \brief Retrieve an iterator to the beginning of the visible-categories
1328 visible_categories_iterator visible_categories_begin() const {
1329 return visible_categories_iterator(getCategoryListRaw());
1332 /// \brief Retrieve an iterator to the end of the visible-categories list.
1333 visible_categories_iterator visible_categories_end() const {
1334 return visible_categories_iterator();
1337 /// \brief Determine whether the visible-categories list is empty.
1338 bool visible_categories_empty() const {
1339 return visible_categories_begin() == visible_categories_end();
1343 /// \brief Test whether the given category... is a category.
1345 /// Used in the \c known_categories_iterator.
1346 static bool isKnownCategory(ObjCCategoryDecl *) { return true; }
1349 /// \brief Iterator that walks over all of the known categories and
1350 /// extensions, including those that are hidden.
1351 typedef filtered_category_iterator<isKnownCategory> known_categories_iterator;
1352 typedef llvm::iterator_range<known_categories_iterator>
1353 known_categories_range;
1355 known_categories_range known_categories() const {
1356 return known_categories_range(known_categories_begin(),
1357 known_categories_end());
1360 /// \brief Retrieve an iterator to the beginning of the known-categories
1362 known_categories_iterator known_categories_begin() const {
1363 return known_categories_iterator(getCategoryListRaw());
1366 /// \brief Retrieve an iterator to the end of the known-categories list.
1367 known_categories_iterator known_categories_end() const {
1368 return known_categories_iterator();
1371 /// \brief Determine whether the known-categories list is empty.
1372 bool known_categories_empty() const {
1373 return known_categories_begin() == known_categories_end();
1377 /// \brief Test whether the given category is a visible extension.
1379 /// Used in the \c visible_extensions_iterator.
1380 static bool isVisibleExtension(ObjCCategoryDecl *Cat);
1383 /// \brief Iterator that walks over all of the visible extensions, skipping
1384 /// any that are known but hidden.
1385 typedef filtered_category_iterator<isVisibleExtension>
1386 visible_extensions_iterator;
1388 typedef llvm::iterator_range<visible_extensions_iterator>
1389 visible_extensions_range;
1391 visible_extensions_range visible_extensions() const {
1392 return visible_extensions_range(visible_extensions_begin(),
1393 visible_extensions_end());
1396 /// \brief Retrieve an iterator to the beginning of the visible-extensions
1398 visible_extensions_iterator visible_extensions_begin() const {
1399 return visible_extensions_iterator(getCategoryListRaw());
1402 /// \brief Retrieve an iterator to the end of the visible-extensions list.
1403 visible_extensions_iterator visible_extensions_end() const {
1404 return visible_extensions_iterator();
1407 /// \brief Determine whether the visible-extensions list is empty.
1408 bool visible_extensions_empty() const {
1409 return visible_extensions_begin() == visible_extensions_end();
1413 /// \brief Test whether the given category is an extension.
1415 /// Used in the \c known_extensions_iterator.
1416 static bool isKnownExtension(ObjCCategoryDecl *Cat);
1419 /// \brief Iterator that walks over all of the known extensions.
1420 typedef filtered_category_iterator<isKnownExtension>
1421 known_extensions_iterator;
1422 typedef llvm::iterator_range<known_extensions_iterator>
1423 known_extensions_range;
1425 known_extensions_range known_extensions() const {
1426 return known_extensions_range(known_extensions_begin(),
1427 known_extensions_end());
1430 /// \brief Retrieve an iterator to the beginning of the known-extensions
1432 known_extensions_iterator known_extensions_begin() const {
1433 return known_extensions_iterator(getCategoryListRaw());
1436 /// \brief Retrieve an iterator to the end of the known-extensions list.
1437 known_extensions_iterator known_extensions_end() const {
1438 return known_extensions_iterator();
1441 /// \brief Determine whether the known-extensions list is empty.
1442 bool known_extensions_empty() const {
1443 return known_extensions_begin() == known_extensions_end();
1446 /// \brief Retrieve the raw pointer to the start of the category/extension
1448 ObjCCategoryDecl* getCategoryListRaw() const {
1449 // FIXME: Should make sure no callers ever do this.
1450 if (!hasDefinition())
1453 if (data().ExternallyCompleted)
1454 LoadExternalDefinition();
1456 return data().CategoryList;
1459 /// \brief Set the raw pointer to the start of the category/extension
1461 void setCategoryListRaw(ObjCCategoryDecl *category) {
1462 data().CategoryList = category;
1466 *FindPropertyVisibleInPrimaryClass(IdentifierInfo *PropertyId) const;
1468 void collectPropertiesToImplement(PropertyMap &PM,
1469 PropertyDeclOrder &PO) const override;
1471 /// isSuperClassOf - Return true if this class is the specified class or is a
1472 /// super class of the specified interface class.
1473 bool isSuperClassOf(const ObjCInterfaceDecl *I) const {
1474 // If RHS is derived from LHS it is OK; else it is not OK.
1475 while (I != nullptr) {
1476 if (declaresSameEntity(this, I))
1479 I = I->getSuperClass();
1484 /// isArcWeakrefUnavailable - Checks for a class or one of its super classes
1485 /// to be incompatible with __weak references. Returns true if it is.
1486 bool isArcWeakrefUnavailable() const;
1488 /// isObjCRequiresPropertyDefs - Checks that a class or one of its super
1489 /// classes must not be auto-synthesized. Returns class decl. if it must not
1490 /// be; 0, otherwise.
1491 const ObjCInterfaceDecl *isObjCRequiresPropertyDefs() const;
1493 ObjCIvarDecl *lookupInstanceVariable(IdentifierInfo *IVarName,
1494 ObjCInterfaceDecl *&ClassDeclared);
1495 ObjCIvarDecl *lookupInstanceVariable(IdentifierInfo *IVarName) {
1496 ObjCInterfaceDecl *ClassDeclared;
1497 return lookupInstanceVariable(IVarName, ClassDeclared);
1500 ObjCProtocolDecl *lookupNestedProtocol(IdentifierInfo *Name);
1502 // Lookup a method. First, we search locally. If a method isn't
1503 // found, we search referenced protocols and class categories.
1504 ObjCMethodDecl *lookupMethod(Selector Sel, bool isInstance,
1505 bool shallowCategoryLookup = false,
1506 bool followSuper = true,
1507 const ObjCCategoryDecl *C = nullptr) const;
1509 /// Lookup an instance method for a given selector.
1510 ObjCMethodDecl *lookupInstanceMethod(Selector Sel) const {
1511 return lookupMethod(Sel, true/*isInstance*/);
1514 /// Lookup a class method for a given selector.
1515 ObjCMethodDecl *lookupClassMethod(Selector Sel) const {
1516 return lookupMethod(Sel, false/*isInstance*/);
1518 ObjCInterfaceDecl *lookupInheritedClass(const IdentifierInfo *ICName);
1520 /// \brief Lookup a method in the classes implementation hierarchy.
1521 ObjCMethodDecl *lookupPrivateMethod(const Selector &Sel,
1522 bool Instance=true) const;
1524 ObjCMethodDecl *lookupPrivateClassMethod(const Selector &Sel) {
1525 return lookupPrivateMethod(Sel, false);
1528 /// \brief Lookup a setter or getter in the class hierarchy,
1529 /// including in all categories except for category passed
1531 ObjCMethodDecl *lookupPropertyAccessor(const Selector Sel,
1532 const ObjCCategoryDecl *Cat) const {
1533 return lookupMethod(Sel, true/*isInstance*/,
1534 false/*shallowCategoryLookup*/,
1535 true /* followsSuper */,
1539 SourceLocation getEndOfDefinitionLoc() const {
1540 if (!hasDefinition())
1541 return getLocation();
1543 return data().EndLoc;
1546 void setEndOfDefinitionLoc(SourceLocation LE) { data().EndLoc = LE; }
1548 /// Retrieve the starting location of the superclass.
1549 SourceLocation getSuperClassLoc() const;
1551 /// isImplicitInterfaceDecl - check that this is an implicitly declared
1552 /// ObjCInterfaceDecl node. This is for legacy objective-c \@implementation
1553 /// declaration without an \@interface declaration.
1554 bool isImplicitInterfaceDecl() const {
1555 return hasDefinition() ? data().Definition->isImplicit() : isImplicit();
1558 /// ClassImplementsProtocol - Checks that 'lProto' protocol
1559 /// has been implemented in IDecl class, its super class or categories (if
1560 /// lookupCategory is true).
1561 bool ClassImplementsProtocol(ObjCProtocolDecl *lProto,
1562 bool lookupCategory,
1563 bool RHSIsQualifiedID = false);
1565 typedef redeclarable_base::redecl_range redecl_range;
1566 typedef redeclarable_base::redecl_iterator redecl_iterator;
1567 using redeclarable_base::redecls_begin;
1568 using redeclarable_base::redecls_end;
1569 using redeclarable_base::redecls;
1570 using redeclarable_base::getPreviousDecl;
1571 using redeclarable_base::getMostRecentDecl;
1572 using redeclarable_base::isFirstDecl;
1574 /// Retrieves the canonical declaration of this Objective-C class.
1575 ObjCInterfaceDecl *getCanonicalDecl() override { return getFirstDecl(); }
1576 const ObjCInterfaceDecl *getCanonicalDecl() const { return getFirstDecl(); }
1578 // Low-level accessor
1579 const Type *getTypeForDecl() const { return TypeForDecl; }
1580 void setTypeForDecl(const Type *TD) const { TypeForDecl = TD; }
1582 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1583 static bool classofKind(Kind K) { return K == ObjCInterface; }
1585 friend class ASTReader;
1586 friend class ASTDeclReader;
1587 friend class ASTDeclWriter;
1590 const ObjCInterfaceDecl *findInterfaceWithDesignatedInitializers() const;
1591 bool inheritsDesignatedInitializers() const;
1594 /// ObjCIvarDecl - Represents an ObjC instance variable. In general, ObjC
1595 /// instance variables are identical to C. The only exception is Objective-C
1596 /// supports C++ style access control. For example:
1598 /// \@interface IvarExample : NSObject
1600 /// id defaultToProtected;
1602 /// id canBePublic; // same as C++.
1604 /// id canBeProtected; // same as C++.
1606 /// id canBePackage; // framework visibility (not available in C++).
1609 class ObjCIvarDecl : public FieldDecl {
1610 void anchor() override;
1613 enum AccessControl {
1614 None, Private, Protected, Public, Package
1618 ObjCIvarDecl(ObjCContainerDecl *DC, SourceLocation StartLoc,
1619 SourceLocation IdLoc, IdentifierInfo *Id,
1620 QualType T, TypeSourceInfo *TInfo, AccessControl ac, Expr *BW,
1622 : FieldDecl(ObjCIvar, DC, StartLoc, IdLoc, Id, T, TInfo, BW,
1623 /*Mutable=*/false, /*HasInit=*/ICIS_NoInit),
1624 NextIvar(nullptr), DeclAccess(ac), Synthesized(synthesized) {}
1627 static ObjCIvarDecl *Create(ASTContext &C, ObjCContainerDecl *DC,
1628 SourceLocation StartLoc, SourceLocation IdLoc,
1629 IdentifierInfo *Id, QualType T,
1630 TypeSourceInfo *TInfo,
1631 AccessControl ac, Expr *BW = nullptr,
1632 bool synthesized=false);
1634 static ObjCIvarDecl *CreateDeserialized(ASTContext &C, unsigned ID);
1636 /// \brief Return the class interface that this ivar is logically contained
1637 /// in; this is either the interface where the ivar was declared, or the
1638 /// interface the ivar is conceptually a part of in the case of synthesized
1640 const ObjCInterfaceDecl *getContainingInterface() const;
1642 ObjCIvarDecl *getNextIvar() { return NextIvar; }
1643 const ObjCIvarDecl *getNextIvar() const { return NextIvar; }
1644 void setNextIvar(ObjCIvarDecl *ivar) { NextIvar = ivar; }
1646 void setAccessControl(AccessControl ac) { DeclAccess = ac; }
1648 AccessControl getAccessControl() const { return AccessControl(DeclAccess); }
1650 AccessControl getCanonicalAccessControl() const {
1651 return DeclAccess == None ? Protected : AccessControl(DeclAccess);
1654 void setSynthesize(bool synth) { Synthesized = synth; }
1655 bool getSynthesize() const { return Synthesized; }
1657 /// Retrieve the type of this instance variable when viewed as a member of a
1658 /// specific object type.
1659 QualType getUsageType(QualType objectType) const;
1661 // Implement isa/cast/dyncast/etc.
1662 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1663 static bool classofKind(Kind K) { return K == ObjCIvar; }
1665 /// NextIvar - Next Ivar in the list of ivars declared in class; class's
1666 /// extensions and class's implementation
1667 ObjCIvarDecl *NextIvar;
1669 // NOTE: VC++ treats enums as signed, avoid using the AccessControl enum
1670 unsigned DeclAccess : 3;
1671 unsigned Synthesized : 1;
1675 /// \brief Represents a field declaration created by an \@defs(...).
1676 class ObjCAtDefsFieldDecl : public FieldDecl {
1677 void anchor() override;
1678 ObjCAtDefsFieldDecl(DeclContext *DC, SourceLocation StartLoc,
1679 SourceLocation IdLoc, IdentifierInfo *Id,
1680 QualType T, Expr *BW)
1681 : FieldDecl(ObjCAtDefsField, DC, StartLoc, IdLoc, Id, T,
1682 /*TInfo=*/nullptr, // FIXME: Do ObjCAtDefs have declarators ?
1683 BW, /*Mutable=*/false, /*HasInit=*/ICIS_NoInit) {}
1686 static ObjCAtDefsFieldDecl *Create(ASTContext &C, DeclContext *DC,
1687 SourceLocation StartLoc,
1688 SourceLocation IdLoc, IdentifierInfo *Id,
1689 QualType T, Expr *BW);
1691 static ObjCAtDefsFieldDecl *CreateDeserialized(ASTContext &C, unsigned ID);
1693 // Implement isa/cast/dyncast/etc.
1694 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1695 static bool classofKind(Kind K) { return K == ObjCAtDefsField; }
1698 /// \brief Represents an Objective-C protocol declaration.
1700 /// Objective-C protocols declare a pure abstract type (i.e., no instance
1701 /// variables are permitted). Protocols originally drew inspiration from
1702 /// C++ pure virtual functions (a C++ feature with nice semantics and lousy
1703 /// syntax:-). Here is an example:
1706 /// \@protocol NSDraggingInfo <refproto1, refproto2>
1707 /// - (NSWindow *)draggingDestinationWindow;
1708 /// - (NSImage *)draggedImage;
1712 /// This says that NSDraggingInfo requires two methods and requires everything
1713 /// that the two "referenced protocols" 'refproto1' and 'refproto2' require as
1717 /// \@interface ImplementsNSDraggingInfo : NSObject \<NSDraggingInfo>
1721 /// ObjC protocols inspired Java interfaces. Unlike Java, ObjC classes and
1722 /// protocols are in distinct namespaces. For example, Cocoa defines both
1723 /// an NSObject protocol and class (which isn't allowed in Java). As a result,
1724 /// protocols are referenced using angle brackets as follows:
1726 /// id \<NSDraggingInfo> anyObjectThatImplementsNSDraggingInfo;
1728 class ObjCProtocolDecl : public ObjCContainerDecl,
1729 public Redeclarable<ObjCProtocolDecl> {
1730 void anchor() override;
1732 struct DefinitionData {
1733 // \brief The declaration that defines this protocol.
1734 ObjCProtocolDecl *Definition;
1736 /// \brief Referenced protocols
1737 ObjCProtocolList ReferencedProtocols;
1740 /// \brief Contains a pointer to the data associated with this class,
1741 /// which will be NULL if this class has not yet been defined.
1743 /// The bit indicates when we don't need to check for out-of-date
1744 /// declarations. It will be set unless modules are enabled.
1745 llvm::PointerIntPair<DefinitionData *, 1, bool> Data;
1747 DefinitionData &data() const {
1748 assert(Data.getPointer() && "Objective-C protocol has no definition!");
1749 return *Data.getPointer();
1752 ObjCProtocolDecl(ASTContext &C, DeclContext *DC, IdentifierInfo *Id,
1753 SourceLocation nameLoc, SourceLocation atStartLoc,
1754 ObjCProtocolDecl *PrevDecl);
1756 void allocateDefinitionData();
1758 typedef Redeclarable<ObjCProtocolDecl> redeclarable_base;
1759 ObjCProtocolDecl *getNextRedeclarationImpl() override {
1760 return getNextRedeclaration();
1762 ObjCProtocolDecl *getPreviousDeclImpl() override {
1763 return getPreviousDecl();
1765 ObjCProtocolDecl *getMostRecentDeclImpl() override {
1766 return getMostRecentDecl();
1770 static ObjCProtocolDecl *Create(ASTContext &C, DeclContext *DC,
1772 SourceLocation nameLoc,
1773 SourceLocation atStartLoc,
1774 ObjCProtocolDecl *PrevDecl);
1776 static ObjCProtocolDecl *CreateDeserialized(ASTContext &C, unsigned ID);
1778 const ObjCProtocolList &getReferencedProtocols() const {
1779 assert(hasDefinition() && "No definition available!");
1780 return data().ReferencedProtocols;
1782 typedef ObjCProtocolList::iterator protocol_iterator;
1783 typedef llvm::iterator_range<protocol_iterator> protocol_range;
1785 protocol_range protocols() const {
1786 return protocol_range(protocol_begin(), protocol_end());
1788 protocol_iterator protocol_begin() const {
1789 if (!hasDefinition())
1790 return protocol_iterator();
1792 return data().ReferencedProtocols.begin();
1794 protocol_iterator protocol_end() const {
1795 if (!hasDefinition())
1796 return protocol_iterator();
1798 return data().ReferencedProtocols.end();
1800 typedef ObjCProtocolList::loc_iterator protocol_loc_iterator;
1801 typedef llvm::iterator_range<protocol_loc_iterator> protocol_loc_range;
1803 protocol_loc_range protocol_locs() const {
1804 return protocol_loc_range(protocol_loc_begin(), protocol_loc_end());
1806 protocol_loc_iterator protocol_loc_begin() const {
1807 if (!hasDefinition())
1808 return protocol_loc_iterator();
1810 return data().ReferencedProtocols.loc_begin();
1812 protocol_loc_iterator protocol_loc_end() const {
1813 if (!hasDefinition())
1814 return protocol_loc_iterator();
1816 return data().ReferencedProtocols.loc_end();
1818 unsigned protocol_size() const {
1819 if (!hasDefinition())
1822 return data().ReferencedProtocols.size();
1825 /// setProtocolList - Set the list of protocols that this interface
1827 void setProtocolList(ObjCProtocolDecl *const*List, unsigned Num,
1828 const SourceLocation *Locs, ASTContext &C) {
1829 assert(hasDefinition() && "Protocol is not defined");
1830 data().ReferencedProtocols.set(List, Num, Locs, C);
1833 ObjCProtocolDecl *lookupProtocolNamed(IdentifierInfo *PName);
1835 // Lookup a method. First, we search locally. If a method isn't
1836 // found, we search referenced protocols and class categories.
1837 ObjCMethodDecl *lookupMethod(Selector Sel, bool isInstance) const;
1838 ObjCMethodDecl *lookupInstanceMethod(Selector Sel) const {
1839 return lookupMethod(Sel, true/*isInstance*/);
1841 ObjCMethodDecl *lookupClassMethod(Selector Sel) const {
1842 return lookupMethod(Sel, false/*isInstance*/);
1845 /// \brief Determine whether this protocol has a definition.
1846 bool hasDefinition() const {
1847 // If the name of this protocol is out-of-date, bring it up-to-date, which
1848 // might bring in a definition.
1849 // Note: a null value indicates that we don't have a definition and that
1850 // modules are enabled.
1851 if (!Data.getOpaqueValue())
1852 getMostRecentDecl();
1854 return Data.getPointer();
1857 /// \brief Retrieve the definition of this protocol, if any.
1858 ObjCProtocolDecl *getDefinition() {
1859 return hasDefinition()? Data.getPointer()->Definition : nullptr;
1862 /// \brief Retrieve the definition of this protocol, if any.
1863 const ObjCProtocolDecl *getDefinition() const {
1864 return hasDefinition()? Data.getPointer()->Definition : nullptr;
1867 /// \brief Determine whether this particular declaration is also the
1869 bool isThisDeclarationADefinition() const {
1870 return getDefinition() == this;
1873 /// \brief Starts the definition of this Objective-C protocol.
1874 void startDefinition();
1876 /// Produce a name to be used for protocol's metadata. It comes either via
1877 /// objc_runtime_name attribute or protocol name.
1878 StringRef getObjCRuntimeNameAsString() const;
1880 SourceRange getSourceRange() const override LLVM_READONLY {
1881 if (isThisDeclarationADefinition())
1882 return ObjCContainerDecl::getSourceRange();
1884 return SourceRange(getAtStartLoc(), getLocation());
1887 typedef redeclarable_base::redecl_range redecl_range;
1888 typedef redeclarable_base::redecl_iterator redecl_iterator;
1889 using redeclarable_base::redecls_begin;
1890 using redeclarable_base::redecls_end;
1891 using redeclarable_base::redecls;
1892 using redeclarable_base::getPreviousDecl;
1893 using redeclarable_base::getMostRecentDecl;
1894 using redeclarable_base::isFirstDecl;
1896 /// Retrieves the canonical declaration of this Objective-C protocol.
1897 ObjCProtocolDecl *getCanonicalDecl() override { return getFirstDecl(); }
1898 const ObjCProtocolDecl *getCanonicalDecl() const { return getFirstDecl(); }
1900 void collectPropertiesToImplement(PropertyMap &PM,
1901 PropertyDeclOrder &PO) const override;
1903 void collectInheritedProtocolProperties(const ObjCPropertyDecl *Property,
1904 ProtocolPropertyMap &PM) const;
1906 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1907 static bool classofKind(Kind K) { return K == ObjCProtocol; }
1909 friend class ASTReader;
1910 friend class ASTDeclReader;
1911 friend class ASTDeclWriter;
1914 /// ObjCCategoryDecl - Represents a category declaration. A category allows
1915 /// you to add methods to an existing class (without subclassing or modifying
1916 /// the original class interface or implementation:-). Categories don't allow
1917 /// you to add instance data. The following example adds "myMethod" to all
1918 /// NSView's within a process:
1920 /// \@interface NSView (MyViewMethods)
1924 /// Categories also allow you to split the implementation of a class across
1925 /// several files (a feature more naturally supported in C++).
1927 /// Categories were originally inspired by dynamic languages such as Common
1928 /// Lisp and Smalltalk. More traditional class-based languages (C++, Java)
1929 /// don't support this level of dynamism, which is both powerful and dangerous.
1931 class ObjCCategoryDecl : public ObjCContainerDecl {
1932 void anchor() override;
1934 /// Interface belonging to this category
1935 ObjCInterfaceDecl *ClassInterface;
1937 /// The type parameters associated with this category, if any.
1938 ObjCTypeParamList *TypeParamList;
1940 /// referenced protocols in this category.
1941 ObjCProtocolList ReferencedProtocols;
1943 /// Next category belonging to this class.
1944 /// FIXME: this should not be a singly-linked list. Move storage elsewhere.
1945 ObjCCategoryDecl *NextClassCategory;
1947 /// \brief The location of the category name in this declaration.
1948 SourceLocation CategoryNameLoc;
1950 /// class extension may have private ivars.
1951 SourceLocation IvarLBraceLoc;
1952 SourceLocation IvarRBraceLoc;
1954 ObjCCategoryDecl(DeclContext *DC, SourceLocation AtLoc,
1955 SourceLocation ClassNameLoc, SourceLocation CategoryNameLoc,
1956 IdentifierInfo *Id, ObjCInterfaceDecl *IDecl,
1957 ObjCTypeParamList *typeParamList,
1958 SourceLocation IvarLBraceLoc=SourceLocation(),
1959 SourceLocation IvarRBraceLoc=SourceLocation());
1963 static ObjCCategoryDecl *Create(ASTContext &C, DeclContext *DC,
1964 SourceLocation AtLoc,
1965 SourceLocation ClassNameLoc,
1966 SourceLocation CategoryNameLoc,
1968 ObjCInterfaceDecl *IDecl,
1969 ObjCTypeParamList *typeParamList,
1970 SourceLocation IvarLBraceLoc=SourceLocation(),
1971 SourceLocation IvarRBraceLoc=SourceLocation());
1972 static ObjCCategoryDecl *CreateDeserialized(ASTContext &C, unsigned ID);
1974 ObjCInterfaceDecl *getClassInterface() { return ClassInterface; }
1975 const ObjCInterfaceDecl *getClassInterface() const { return ClassInterface; }
1977 /// Retrieve the type parameter list associated with this category or
1979 ObjCTypeParamList *getTypeParamList() const { return TypeParamList; }
1981 /// Set the type parameters of this category.
1983 /// This function is used by the AST importer, which must import the type
1984 /// parameters after creating their DeclContext to avoid loops.
1985 void setTypeParamList(ObjCTypeParamList *TPL);
1988 ObjCCategoryImplDecl *getImplementation() const;
1989 void setImplementation(ObjCCategoryImplDecl *ImplD);
1991 /// setProtocolList - Set the list of protocols that this interface
1993 void setProtocolList(ObjCProtocolDecl *const*List, unsigned Num,
1994 const SourceLocation *Locs, ASTContext &C) {
1995 ReferencedProtocols.set(List, Num, Locs, C);
1998 const ObjCProtocolList &getReferencedProtocols() const {
1999 return ReferencedProtocols;
2002 typedef ObjCProtocolList::iterator protocol_iterator;
2003 typedef llvm::iterator_range<protocol_iterator> protocol_range;
2005 protocol_range protocols() const {
2006 return protocol_range(protocol_begin(), protocol_end());
2008 protocol_iterator protocol_begin() const {
2009 return ReferencedProtocols.begin();
2011 protocol_iterator protocol_end() const { return ReferencedProtocols.end(); }
2012 unsigned protocol_size() const { return ReferencedProtocols.size(); }
2013 typedef ObjCProtocolList::loc_iterator protocol_loc_iterator;
2014 typedef llvm::iterator_range<protocol_loc_iterator> protocol_loc_range;
2016 protocol_loc_range protocol_locs() const {
2017 return protocol_loc_range(protocol_loc_begin(), protocol_loc_end());
2019 protocol_loc_iterator protocol_loc_begin() const {
2020 return ReferencedProtocols.loc_begin();
2022 protocol_loc_iterator protocol_loc_end() const {
2023 return ReferencedProtocols.loc_end();
2026 ObjCCategoryDecl *getNextClassCategory() const { return NextClassCategory; }
2028 /// \brief Retrieve the pointer to the next stored category (or extension),
2029 /// which may be hidden.
2030 ObjCCategoryDecl *getNextClassCategoryRaw() const {
2031 return NextClassCategory;
2034 bool IsClassExtension() const { return getIdentifier() == nullptr; }
2036 typedef specific_decl_iterator<ObjCIvarDecl> ivar_iterator;
2037 typedef llvm::iterator_range<specific_decl_iterator<ObjCIvarDecl>> ivar_range;
2039 ivar_range ivars() const { return ivar_range(ivar_begin(), ivar_end()); }
2040 ivar_iterator ivar_begin() const {
2041 return ivar_iterator(decls_begin());
2043 ivar_iterator ivar_end() const {
2044 return ivar_iterator(decls_end());
2046 unsigned ivar_size() const {
2047 return std::distance(ivar_begin(), ivar_end());
2049 bool ivar_empty() const {
2050 return ivar_begin() == ivar_end();
2053 SourceLocation getCategoryNameLoc() const { return CategoryNameLoc; }
2054 void setCategoryNameLoc(SourceLocation Loc) { CategoryNameLoc = Loc; }
2056 void setIvarLBraceLoc(SourceLocation Loc) { IvarLBraceLoc = Loc; }
2057 SourceLocation getIvarLBraceLoc() const { return IvarLBraceLoc; }
2058 void setIvarRBraceLoc(SourceLocation Loc) { IvarRBraceLoc = Loc; }
2059 SourceLocation getIvarRBraceLoc() const { return IvarRBraceLoc; }
2061 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2062 static bool classofKind(Kind K) { return K == ObjCCategory; }
2064 friend class ASTDeclReader;
2065 friend class ASTDeclWriter;
2068 class ObjCImplDecl : public ObjCContainerDecl {
2069 void anchor() override;
2071 /// Class interface for this class/category implementation
2072 ObjCInterfaceDecl *ClassInterface;
2075 ObjCImplDecl(Kind DK, DeclContext *DC,
2076 ObjCInterfaceDecl *classInterface,
2077 SourceLocation nameLoc, SourceLocation atStartLoc)
2078 : ObjCContainerDecl(DK, DC,
2079 classInterface? classInterface->getIdentifier()
2081 nameLoc, atStartLoc),
2082 ClassInterface(classInterface) {}
2085 const ObjCInterfaceDecl *getClassInterface() const { return ClassInterface; }
2086 ObjCInterfaceDecl *getClassInterface() { return ClassInterface; }
2087 void setClassInterface(ObjCInterfaceDecl *IFace);
2089 void addInstanceMethod(ObjCMethodDecl *method) {
2090 // FIXME: Context should be set correctly before we get here.
2091 method->setLexicalDeclContext(this);
2094 void addClassMethod(ObjCMethodDecl *method) {
2095 // FIXME: Context should be set correctly before we get here.
2096 method->setLexicalDeclContext(this);
2100 void addPropertyImplementation(ObjCPropertyImplDecl *property);
2102 ObjCPropertyImplDecl *FindPropertyImplDecl(IdentifierInfo *propertyId) const;
2103 ObjCPropertyImplDecl *FindPropertyImplIvarDecl(IdentifierInfo *ivarId) const;
2105 // Iterator access to properties.
2106 typedef specific_decl_iterator<ObjCPropertyImplDecl> propimpl_iterator;
2107 typedef llvm::iterator_range<specific_decl_iterator<ObjCPropertyImplDecl>>
2110 propimpl_range property_impls() const {
2111 return propimpl_range(propimpl_begin(), propimpl_end());
2113 propimpl_iterator propimpl_begin() const {
2114 return propimpl_iterator(decls_begin());
2116 propimpl_iterator propimpl_end() const {
2117 return propimpl_iterator(decls_end());
2120 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2121 static bool classofKind(Kind K) {
2122 return K >= firstObjCImpl && K <= lastObjCImpl;
2126 /// ObjCCategoryImplDecl - An object of this class encapsulates a category
2127 /// \@implementation declaration. If a category class has declaration of a
2128 /// property, its implementation must be specified in the category's
2129 /// \@implementation declaration. Example:
2130 /// \@interface I \@end
2131 /// \@interface I(CATEGORY)
2132 /// \@property int p1, d1;
2134 /// \@implementation I(CATEGORY)
2135 /// \@dynamic p1,d1;
2138 /// ObjCCategoryImplDecl
2139 class ObjCCategoryImplDecl : public ObjCImplDecl {
2140 void anchor() override;
2145 // Category name location
2146 SourceLocation CategoryNameLoc;
2148 ObjCCategoryImplDecl(DeclContext *DC, IdentifierInfo *Id,
2149 ObjCInterfaceDecl *classInterface,
2150 SourceLocation nameLoc, SourceLocation atStartLoc,
2151 SourceLocation CategoryNameLoc)
2152 : ObjCImplDecl(ObjCCategoryImpl, DC, classInterface, nameLoc, atStartLoc),
2153 Id(Id), CategoryNameLoc(CategoryNameLoc) {}
2155 static ObjCCategoryImplDecl *Create(ASTContext &C, DeclContext *DC,
2157 ObjCInterfaceDecl *classInterface,
2158 SourceLocation nameLoc,
2159 SourceLocation atStartLoc,
2160 SourceLocation CategoryNameLoc);
2161 static ObjCCategoryImplDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2163 /// getIdentifier - Get the identifier that names the category
2164 /// interface associated with this implementation.
2165 /// FIXME: This is a bad API, we are hiding NamedDecl::getIdentifier()
2166 /// with a different meaning. For example:
2167 /// ((NamedDecl *)SomeCategoryImplDecl)->getIdentifier()
2168 /// returns the class interface name, whereas
2169 /// ((ObjCCategoryImplDecl *)SomeCategoryImplDecl)->getIdentifier()
2170 /// returns the category name.
2171 IdentifierInfo *getIdentifier() const {
2174 void setIdentifier(IdentifierInfo *II) { Id = II; }
2176 ObjCCategoryDecl *getCategoryDecl() const;
2178 SourceLocation getCategoryNameLoc() const { return CategoryNameLoc; }
2180 /// getName - Get the name of identifier for the class interface associated
2181 /// with this implementation as a StringRef.
2183 // FIXME: This is a bad API, we are hiding NamedDecl::getName with a different
2185 StringRef getName() const { return Id ? Id->getName() : StringRef(); }
2187 /// @brief Get the name of the class associated with this interface.
2189 // FIXME: Deprecated, move clients to getName().
2190 std::string getNameAsString() const {
2194 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2195 static bool classofKind(Kind K) { return K == ObjCCategoryImpl;}
2197 friend class ASTDeclReader;
2198 friend class ASTDeclWriter;
2201 raw_ostream &operator<<(raw_ostream &OS, const ObjCCategoryImplDecl &CID);
2203 /// ObjCImplementationDecl - Represents a class definition - this is where
2204 /// method definitions are specified. For example:
2207 /// \@implementation MyClass
2208 /// - (void)myMethod { /* do something */ }
2212 /// In a non-fragile runtime, instance variables can appear in the class
2213 /// interface, class extensions (nameless categories), and in the implementation
2214 /// itself, as well as being synthesized as backing storage for properties.
2216 /// In a fragile runtime, instance variables are specified in the class
2217 /// interface, \em not in the implementation. Nevertheless (for legacy reasons),
2218 /// we allow instance variables to be specified in the implementation. When
2219 /// specified, they need to be \em identical to the interface.
2220 class ObjCImplementationDecl : public ObjCImplDecl {
2221 void anchor() override;
2222 /// Implementation Class's super class.
2223 ObjCInterfaceDecl *SuperClass;
2224 SourceLocation SuperLoc;
2226 /// \@implementation may have private ivars.
2227 SourceLocation IvarLBraceLoc;
2228 SourceLocation IvarRBraceLoc;
2230 /// Support for ivar initialization.
2231 /// \brief The arguments used to initialize the ivars
2232 LazyCXXCtorInitializersPtr IvarInitializers;
2233 unsigned NumIvarInitializers;
2235 /// Do the ivars of this class require initialization other than
2236 /// zero-initialization?
2237 bool HasNonZeroConstructors : 1;
2239 /// Do the ivars of this class require non-trivial destruction?
2240 bool HasDestructors : 1;
2242 ObjCImplementationDecl(DeclContext *DC,
2243 ObjCInterfaceDecl *classInterface,
2244 ObjCInterfaceDecl *superDecl,
2245 SourceLocation nameLoc, SourceLocation atStartLoc,
2246 SourceLocation superLoc = SourceLocation(),
2247 SourceLocation IvarLBraceLoc=SourceLocation(),
2248 SourceLocation IvarRBraceLoc=SourceLocation())
2249 : ObjCImplDecl(ObjCImplementation, DC, classInterface, nameLoc, atStartLoc),
2250 SuperClass(superDecl), SuperLoc(superLoc), IvarLBraceLoc(IvarLBraceLoc),
2251 IvarRBraceLoc(IvarRBraceLoc),
2252 IvarInitializers(nullptr), NumIvarInitializers(0),
2253 HasNonZeroConstructors(false), HasDestructors(false) {}
2255 static ObjCImplementationDecl *Create(ASTContext &C, DeclContext *DC,
2256 ObjCInterfaceDecl *classInterface,
2257 ObjCInterfaceDecl *superDecl,
2258 SourceLocation nameLoc,
2259 SourceLocation atStartLoc,
2260 SourceLocation superLoc = SourceLocation(),
2261 SourceLocation IvarLBraceLoc=SourceLocation(),
2262 SourceLocation IvarRBraceLoc=SourceLocation());
2264 static ObjCImplementationDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2266 /// init_iterator - Iterates through the ivar initializer list.
2267 typedef CXXCtorInitializer **init_iterator;
2269 /// init_const_iterator - Iterates through the ivar initializer list.
2270 typedef CXXCtorInitializer * const * init_const_iterator;
2272 typedef llvm::iterator_range<init_iterator> init_range;
2273 typedef llvm::iterator_range<init_const_iterator> init_const_range;
2275 init_range inits() { return init_range(init_begin(), init_end()); }
2276 init_const_range inits() const {
2277 return init_const_range(init_begin(), init_end());
2280 /// init_begin() - Retrieve an iterator to the first initializer.
2281 init_iterator init_begin() {
2282 const auto *ConstThis = this;
2283 return const_cast<init_iterator>(ConstThis->init_begin());
2285 /// begin() - Retrieve an iterator to the first initializer.
2286 init_const_iterator init_begin() const;
2288 /// init_end() - Retrieve an iterator past the last initializer.
2289 init_iterator init_end() {
2290 return init_begin() + NumIvarInitializers;
2292 /// end() - Retrieve an iterator past the last initializer.
2293 init_const_iterator init_end() const {
2294 return init_begin() + NumIvarInitializers;
2296 /// getNumArgs - Number of ivars which must be initialized.
2297 unsigned getNumIvarInitializers() const {
2298 return NumIvarInitializers;
2301 void setNumIvarInitializers(unsigned numNumIvarInitializers) {
2302 NumIvarInitializers = numNumIvarInitializers;
2305 void setIvarInitializers(ASTContext &C,
2306 CXXCtorInitializer ** initializers,
2307 unsigned numInitializers);
2309 /// Do any of the ivars of this class (not counting its base classes)
2310 /// require construction other than zero-initialization?
2311 bool hasNonZeroConstructors() const { return HasNonZeroConstructors; }
2312 void setHasNonZeroConstructors(bool val) { HasNonZeroConstructors = val; }
2314 /// Do any of the ivars of this class (not counting its base classes)
2315 /// require non-trivial destruction?
2316 bool hasDestructors() const { return HasDestructors; }
2317 void setHasDestructors(bool val) { HasDestructors = val; }
2319 /// getIdentifier - Get the identifier that names the class
2320 /// interface associated with this implementation.
2321 IdentifierInfo *getIdentifier() const {
2322 return getClassInterface()->getIdentifier();
2325 /// getName - Get the name of identifier for the class interface associated
2326 /// with this implementation as a StringRef.
2328 // FIXME: This is a bad API, we are hiding NamedDecl::getName with a different
2330 StringRef getName() const {
2331 assert(getIdentifier() && "Name is not a simple identifier");
2332 return getIdentifier()->getName();
2335 /// @brief Get the name of the class associated with this interface.
2337 // FIXME: Move to StringRef API.
2338 std::string getNameAsString() const {
2342 /// Produce a name to be used for class's metadata. It comes either via
2343 /// class's objc_runtime_name attribute or class name.
2344 StringRef getObjCRuntimeNameAsString() const;
2346 const ObjCInterfaceDecl *getSuperClass() const { return SuperClass; }
2347 ObjCInterfaceDecl *getSuperClass() { return SuperClass; }
2348 SourceLocation getSuperClassLoc() const { return SuperLoc; }
2350 void setSuperClass(ObjCInterfaceDecl * superCls) { SuperClass = superCls; }
2352 void setIvarLBraceLoc(SourceLocation Loc) { IvarLBraceLoc = Loc; }
2353 SourceLocation getIvarLBraceLoc() const { return IvarLBraceLoc; }
2354 void setIvarRBraceLoc(SourceLocation Loc) { IvarRBraceLoc = Loc; }
2355 SourceLocation getIvarRBraceLoc() const { return IvarRBraceLoc; }
2357 typedef specific_decl_iterator<ObjCIvarDecl> ivar_iterator;
2358 typedef llvm::iterator_range<specific_decl_iterator<ObjCIvarDecl>> ivar_range;
2360 ivar_range ivars() const { return ivar_range(ivar_begin(), ivar_end()); }
2361 ivar_iterator ivar_begin() const {
2362 return ivar_iterator(decls_begin());
2364 ivar_iterator ivar_end() const {
2365 return ivar_iterator(decls_end());
2367 unsigned ivar_size() const {
2368 return std::distance(ivar_begin(), ivar_end());
2370 bool ivar_empty() const {
2371 return ivar_begin() == ivar_end();
2374 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2375 static bool classofKind(Kind K) { return K == ObjCImplementation; }
2377 friend class ASTDeclReader;
2378 friend class ASTDeclWriter;
2381 raw_ostream &operator<<(raw_ostream &OS, const ObjCImplementationDecl &ID);
2383 /// ObjCCompatibleAliasDecl - Represents alias of a class. This alias is
2384 /// declared as \@compatibility_alias alias class.
2385 class ObjCCompatibleAliasDecl : public NamedDecl {
2386 void anchor() override;
2387 /// Class that this is an alias of.
2388 ObjCInterfaceDecl *AliasedClass;
2390 ObjCCompatibleAliasDecl(DeclContext *DC, SourceLocation L, IdentifierInfo *Id,
2391 ObjCInterfaceDecl* aliasedClass)
2392 : NamedDecl(ObjCCompatibleAlias, DC, L, Id), AliasedClass(aliasedClass) {}
2394 static ObjCCompatibleAliasDecl *Create(ASTContext &C, DeclContext *DC,
2395 SourceLocation L, IdentifierInfo *Id,
2396 ObjCInterfaceDecl* aliasedClass);
2398 static ObjCCompatibleAliasDecl *CreateDeserialized(ASTContext &C,
2401 const ObjCInterfaceDecl *getClassInterface() const { return AliasedClass; }
2402 ObjCInterfaceDecl *getClassInterface() { return AliasedClass; }
2403 void setClassInterface(ObjCInterfaceDecl *D) { AliasedClass = D; }
2405 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2406 static bool classofKind(Kind K) { return K == ObjCCompatibleAlias; }
2410 /// \brief Represents one property declaration in an Objective-C interface.
2414 /// \@property (assign, readwrite) int MyProperty;
2416 class ObjCPropertyDecl : public NamedDecl {
2417 void anchor() override;
2419 enum PropertyAttributeKind {
2420 OBJC_PR_noattr = 0x00,
2421 OBJC_PR_readonly = 0x01,
2422 OBJC_PR_getter = 0x02,
2423 OBJC_PR_assign = 0x04,
2424 OBJC_PR_readwrite = 0x08,
2425 OBJC_PR_retain = 0x10,
2426 OBJC_PR_copy = 0x20,
2427 OBJC_PR_nonatomic = 0x40,
2428 OBJC_PR_setter = 0x80,
2429 OBJC_PR_atomic = 0x100,
2430 OBJC_PR_weak = 0x200,
2431 OBJC_PR_strong = 0x400,
2432 OBJC_PR_unsafe_unretained = 0x800,
2433 /// Indicates that the nullability of the type was spelled with a
2434 /// property attribute rather than a type qualifier.
2435 OBJC_PR_nullability = 0x1000,
2436 OBJC_PR_null_resettable = 0x2000
2437 // Adding a property should change NumPropertyAttrsBits
2441 /// \brief Number of bits fitting all the property attributes.
2442 NumPropertyAttrsBits = 14
2445 enum SetterKind { Assign, Retain, Copy, Weak };
2446 enum PropertyControl { None, Required, Optional };
2448 SourceLocation AtLoc; // location of \@property
2449 SourceLocation LParenLoc; // location of '(' starting attribute list or null.
2451 TypeSourceInfo *DeclTypeSourceInfo;
2452 unsigned PropertyAttributes : NumPropertyAttrsBits;
2453 unsigned PropertyAttributesAsWritten : NumPropertyAttrsBits;
2454 // \@required/\@optional
2455 unsigned PropertyImplementation : 2;
2457 Selector GetterName; // getter name of NULL if no getter
2458 Selector SetterName; // setter name of NULL if no setter
2460 ObjCMethodDecl *GetterMethodDecl; // Declaration of getter instance method
2461 ObjCMethodDecl *SetterMethodDecl; // Declaration of setter instance method
2462 ObjCIvarDecl *PropertyIvarDecl; // Synthesize ivar for this property
2464 ObjCPropertyDecl(DeclContext *DC, SourceLocation L, IdentifierInfo *Id,
2465 SourceLocation AtLocation, SourceLocation LParenLocation,
2466 QualType T, TypeSourceInfo *TSI,
2467 PropertyControl propControl)
2468 : NamedDecl(ObjCProperty, DC, L, Id), AtLoc(AtLocation),
2469 LParenLoc(LParenLocation), DeclType(T), DeclTypeSourceInfo(TSI),
2470 PropertyAttributes(OBJC_PR_noattr),
2471 PropertyAttributesAsWritten(OBJC_PR_noattr),
2472 PropertyImplementation(propControl),
2473 GetterName(Selector()),
2474 SetterName(Selector()),
2475 GetterMethodDecl(nullptr), SetterMethodDecl(nullptr),
2476 PropertyIvarDecl(nullptr) {}
2479 static ObjCPropertyDecl *Create(ASTContext &C, DeclContext *DC,
2481 IdentifierInfo *Id, SourceLocation AtLocation,
2482 SourceLocation LParenLocation,
2484 TypeSourceInfo *TSI,
2485 PropertyControl propControl = None);
2487 static ObjCPropertyDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2489 SourceLocation getAtLoc() const { return AtLoc; }
2490 void setAtLoc(SourceLocation L) { AtLoc = L; }
2492 SourceLocation getLParenLoc() const { return LParenLoc; }
2493 void setLParenLoc(SourceLocation L) { LParenLoc = L; }
2495 TypeSourceInfo *getTypeSourceInfo() const { return DeclTypeSourceInfo; }
2497 QualType getType() const { return DeclType; }
2499 void setType(QualType T, TypeSourceInfo *TSI) {
2501 DeclTypeSourceInfo = TSI;
2504 /// Retrieve the type when this property is used with a specific base object
2506 QualType getUsageType(QualType objectType) const;
2508 PropertyAttributeKind getPropertyAttributes() const {
2509 return PropertyAttributeKind(PropertyAttributes);
2511 void setPropertyAttributes(PropertyAttributeKind PRVal) {
2512 PropertyAttributes |= PRVal;
2514 void overwritePropertyAttributes(unsigned PRVal) {
2515 PropertyAttributes = PRVal;
2518 PropertyAttributeKind getPropertyAttributesAsWritten() const {
2519 return PropertyAttributeKind(PropertyAttributesAsWritten);
2522 void setPropertyAttributesAsWritten(PropertyAttributeKind PRVal) {
2523 PropertyAttributesAsWritten = PRVal;
2526 // Helper methods for accessing attributes.
2528 /// isReadOnly - Return true iff the property has a setter.
2529 bool isReadOnly() const {
2530 return (PropertyAttributes & OBJC_PR_readonly);
2533 /// isAtomic - Return true if the property is atomic.
2534 bool isAtomic() const {
2535 return (PropertyAttributes & OBJC_PR_atomic);
2538 /// isRetaining - Return true if the property retains its value.
2539 bool isRetaining() const {
2540 return (PropertyAttributes &
2541 (OBJC_PR_retain | OBJC_PR_strong | OBJC_PR_copy));
2544 /// getSetterKind - Return the method used for doing assignment in
2545 /// the property setter. This is only valid if the property has been
2546 /// defined to have a setter.
2547 SetterKind getSetterKind() const {
2548 if (PropertyAttributes & OBJC_PR_strong)
2549 return getType()->isBlockPointerType() ? Copy : Retain;
2550 if (PropertyAttributes & OBJC_PR_retain)
2552 if (PropertyAttributes & OBJC_PR_copy)
2554 if (PropertyAttributes & OBJC_PR_weak)
2559 Selector getGetterName() const { return GetterName; }
2560 void setGetterName(Selector Sel) { GetterName = Sel; }
2562 Selector getSetterName() const { return SetterName; }
2563 void setSetterName(Selector Sel) { SetterName = Sel; }
2565 ObjCMethodDecl *getGetterMethodDecl() const { return GetterMethodDecl; }
2566 void setGetterMethodDecl(ObjCMethodDecl *gDecl) { GetterMethodDecl = gDecl; }
2568 ObjCMethodDecl *getSetterMethodDecl() const { return SetterMethodDecl; }
2569 void setSetterMethodDecl(ObjCMethodDecl *gDecl) { SetterMethodDecl = gDecl; }
2571 // Related to \@optional/\@required declared in \@protocol
2572 void setPropertyImplementation(PropertyControl pc) {
2573 PropertyImplementation = pc;
2575 PropertyControl getPropertyImplementation() const {
2576 return PropertyControl(PropertyImplementation);
2579 void setPropertyIvarDecl(ObjCIvarDecl *Ivar) {
2580 PropertyIvarDecl = Ivar;
2582 ObjCIvarDecl *getPropertyIvarDecl() const {
2583 return PropertyIvarDecl;
2586 SourceRange getSourceRange() const override LLVM_READONLY {
2587 return SourceRange(AtLoc, getLocation());
2590 /// Get the default name of the synthesized ivar.
2591 IdentifierInfo *getDefaultSynthIvarName(ASTContext &Ctx) const;
2593 /// Lookup a property by name in the specified DeclContext.
2594 static ObjCPropertyDecl *findPropertyDecl(const DeclContext *DC,
2595 const IdentifierInfo *propertyID);
2597 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2598 static bool classofKind(Kind K) { return K == ObjCProperty; }
2601 /// ObjCPropertyImplDecl - Represents implementation declaration of a property
2602 /// in a class or category implementation block. For example:
2603 /// \@synthesize prop1 = ivar1;
2605 class ObjCPropertyImplDecl : public Decl {
2612 SourceLocation AtLoc; // location of \@synthesize or \@dynamic
2614 /// \brief For \@synthesize, the location of the ivar, if it was written in
2615 /// the source code.
2618 /// \@synthesize int a = b
2620 SourceLocation IvarLoc;
2622 /// Property declaration being implemented
2623 ObjCPropertyDecl *PropertyDecl;
2625 /// Null for \@dynamic. Required for \@synthesize.
2626 ObjCIvarDecl *PropertyIvarDecl;
2628 /// Null for \@dynamic. Non-null if property must be copy-constructed in
2630 Expr *GetterCXXConstructor;
2632 /// Null for \@dynamic. Non-null if property has assignment operator to call
2633 /// in Setter synthesis.
2634 Expr *SetterCXXAssignment;
2636 ObjCPropertyImplDecl(DeclContext *DC, SourceLocation atLoc, SourceLocation L,
2637 ObjCPropertyDecl *property,
2639 ObjCIvarDecl *ivarDecl,
2640 SourceLocation ivarLoc)
2641 : Decl(ObjCPropertyImpl, DC, L), AtLoc(atLoc),
2642 IvarLoc(ivarLoc), PropertyDecl(property), PropertyIvarDecl(ivarDecl),
2643 GetterCXXConstructor(nullptr), SetterCXXAssignment(nullptr) {
2644 assert (PK == Dynamic || PropertyIvarDecl);
2648 static ObjCPropertyImplDecl *Create(ASTContext &C, DeclContext *DC,
2649 SourceLocation atLoc, SourceLocation L,
2650 ObjCPropertyDecl *property,
2652 ObjCIvarDecl *ivarDecl,
2653 SourceLocation ivarLoc);
2655 static ObjCPropertyImplDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2657 SourceRange getSourceRange() const override LLVM_READONLY;
2659 SourceLocation getLocStart() const LLVM_READONLY { return AtLoc; }
2660 void setAtLoc(SourceLocation Loc) { AtLoc = Loc; }
2662 ObjCPropertyDecl *getPropertyDecl() const {
2663 return PropertyDecl;
2665 void setPropertyDecl(ObjCPropertyDecl *Prop) { PropertyDecl = Prop; }
2667 Kind getPropertyImplementation() const {
2668 return PropertyIvarDecl ? Synthesize : Dynamic;
2671 ObjCIvarDecl *getPropertyIvarDecl() const {
2672 return PropertyIvarDecl;
2674 SourceLocation getPropertyIvarDeclLoc() const { return IvarLoc; }
2676 void setPropertyIvarDecl(ObjCIvarDecl *Ivar,
2677 SourceLocation IvarLoc) {
2678 PropertyIvarDecl = Ivar;
2679 this->IvarLoc = IvarLoc;
2682 /// \brief For \@synthesize, returns true if an ivar name was explicitly
2686 /// \@synthesize int a = b; // true
2687 /// \@synthesize int a; // false
2689 bool isIvarNameSpecified() const {
2690 return IvarLoc.isValid() && IvarLoc != getLocation();
2693 Expr *getGetterCXXConstructor() const {
2694 return GetterCXXConstructor;
2696 void setGetterCXXConstructor(Expr *getterCXXConstructor) {
2697 GetterCXXConstructor = getterCXXConstructor;
2700 Expr *getSetterCXXAssignment() const {
2701 return SetterCXXAssignment;
2703 void setSetterCXXAssignment(Expr *setterCXXAssignment) {
2704 SetterCXXAssignment = setterCXXAssignment;
2707 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2708 static bool classofKind(Decl::Kind K) { return K == ObjCPropertyImpl; }
2710 friend class ASTDeclReader;
2713 template<bool (*Filter)(ObjCCategoryDecl *)>
2715 ObjCInterfaceDecl::filtered_category_iterator<Filter>::
2716 findAcceptableCategory() {
2717 while (Current && !Filter(Current))
2718 Current = Current->getNextClassCategoryRaw();
2721 template<bool (*Filter)(ObjCCategoryDecl *)>
2722 inline ObjCInterfaceDecl::filtered_category_iterator<Filter> &
2723 ObjCInterfaceDecl::filtered_category_iterator<Filter>::operator++() {
2724 Current = Current->getNextClassCategoryRaw();
2725 findAcceptableCategory();
2729 inline bool ObjCInterfaceDecl::isVisibleCategory(ObjCCategoryDecl *Cat) {
2730 return !Cat->isHidden();
2733 inline bool ObjCInterfaceDecl::isVisibleExtension(ObjCCategoryDecl *Cat) {
2734 return Cat->IsClassExtension() && !Cat->isHidden();
2737 inline bool ObjCInterfaceDecl::isKnownExtension(ObjCCategoryDecl *Cat) {
2738 return Cat->IsClassExtension();
2741 } // end namespace clang