clang 10.0.0git

Classes | Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
clang::ObjCProtocolDecl Class Reference

Represents an Objective-C protocol declaration. More...

`#include "clang/AST/DeclObjC.h"`

Inheritance diagram for clang::ObjCProtocolDecl:
[legend]
Collaboration diagram for clang::ObjCProtocolDecl:
[legend]

## Public Types
using | protocol_iterator = ObjCProtocolList::iterator
using | protocol_range = llvm::iterator_range< protocol_iterator >
using | protocol_loc_iterator = ObjCProtocolList::loc_iterator
using | protocol_loc_range = llvm::iterator_range< protocol_loc_iterator >
using | redecl_range = redeclarable_base::redecl_range
using | redecl_iterator = redeclarable_base::redecl_iterator
Public Types inherited from clang::ObjCContainerDecl
using | prop_iterator = specific_decl_iterator< ObjCPropertyDecl >
using | prop_range = llvm::iterator_range< specific_decl_iterator< ObjCPropertyDecl > >
using | instprop_iterator = filtered_decl_iterator< ObjCPropertyDecl, &ObjCPropertyDecl::isInstanceProperty >
using | instprop_range = llvm::iterator_range< instprop_iterator >
using | classprop_iterator = filtered_decl_iterator< ObjCPropertyDecl, &ObjCPropertyDecl::isClassProperty >
using | classprop_range = llvm::iterator_range< classprop_iterator >
using | method_iterator = specific_decl_iterator< ObjCMethodDecl >
using | method_range = llvm::iterator_range< specific_decl_iterator< ObjCMethodDecl > >
using | instmeth_iterator = filtered_decl_iterator< ObjCMethodDecl, &ObjCMethodDecl::isInstanceMethod >
using | instmeth_range = llvm::iterator_range< instmeth_iterator >
using | classmeth_iterator = filtered_decl_iterator< ObjCMethodDecl, &ObjCMethodDecl::isClassMethod >
using | classmeth_range = llvm::iterator_range< classmeth_iterator >
using | PropertyMap = llvm::DenseMap< std::pair< IdentifierInfo *, unsigned >, ObjCPropertyDecl * >
using | ProtocolPropertySet = llvm::SmallDenseSet< const ObjCProtocolDecl *, 8 >
using | PropertyDeclOrder = llvm::SmallVector< ObjCPropertyDecl *, 8 >
Public Types inherited from clang::NamedDecl
enum | ExplicitVisibilityKind { VisibilityForType, VisibilityForValue }
| Kinds of explicit visibility. More...
Public Types inherited from clang::Decl
enum | Kind
| Lists the kind of concrete classes of Decl. More...
enum | IdentifierNamespace { IDNS_Label = 0x0001, IDNS_Tag = 0x0002, IDNS_Type = 0x0004, IDNS_Member = 0x0008, IDNS_Namespace = 0x0010, IDNS_Ordinary = 0x0020, IDNS_ObjCProtocol = 0x0040, IDNS_OrdinaryFriend = 0x0080, IDNS_TagFriend = 0x0100, IDNS_Using = 0x0200, IDNS_NonMemberOperator = 0x0400, IDNS_LocalExtern = 0x0800, IDNS_OMPReduction = 0x1000, IDNS_OMPMapper = 0x2000 }
| IdentifierNamespace - The different namespaces in which declarations may appear. More...
enum | ObjCDeclQualifier { OBJC_TQ_None = 0x0, OBJC_TQ_In = 0x1, OBJC_TQ_Inout = 0x2, OBJC_TQ_Out = 0x4, OBJC_TQ_Bycopy = 0x8, OBJC_TQ_Byref = 0x10, OBJC_TQ_Oneway = 0x20, OBJC_TQ_CSNullability = 0x40 }
| ObjCDeclQualifier - 'Qualifiers' written next to the return and parameter types in method declarations. More...
enum | ModuleOwnershipKind : unsigned { ModuleOwnershipKind::Unowned, ModuleOwnershipKind::Visible, ModuleOwnershipKind::VisibleWhenImported, ModuleOwnershipKind::ModulePrivate }
| The kind of ownership a declaration has, for visibility purposes. More...
enum | FriendObjectKind { FOK_None, FOK_Declared, FOK_Undeclared }
using | attr_iterator = AttrVec::const_iterator
using | attr_range = llvm::iterator_range< attr_iterator >
using | redecl_range = llvm::iterator_range< redecl_iterator >
Public Types inherited from clang::DeclContext
using | decl_range = llvm::iterator_range< decl_iterator >
using | lookup_result = DeclContextLookupResult
using | lookup_iterator = lookup_result::iterator
using | lookups_range = llvm::iterator_range< all_lookups_iterator >
using | udir_iterator_base = llvm::iterator_adaptor_base< udir_iterator, lookup_iterator, std::random_access_iterator_tag, UsingDirectiveDecl * >
using | udir_range = llvm::iterator_range< udir_iterator >
using | ddiag_range = llvm::iterator_range< DeclContext::ddiag_iterator >
Public Types inherited from clang::Redeclarable< ObjCProtocolDecl >
using | redecl_range = llvm::iterator_range< redecl_iterator >

## Public Member Functions
const ObjCProtocolList & | getReferencedProtocols () const
protocol_range | protocols () const
protocol_iterator | protocol_begin () const
protocol_iterator | protocol_end () const
protocol_loc_range | protocol_locs () const
protocol_loc_iterator | protocol_loc_begin () const
protocol_loc_iterator | protocol_loc_end () const
unsigned | protocol_size () const
void | setProtocolList (ObjCProtocolDecl *const *List, unsigned Num, const SourceLocation *Locs, ASTContext &C)
| setProtocolList - Set the list of protocols that this interface implements. More...
ObjCProtocolDecl * | lookupProtocolNamed (IdentifierInfo *PName)
ObjCMethodDecl * | lookupMethod (Selector Sel, bool isInstance) const
ObjCMethodDecl * | lookupInstanceMethod (Selector Sel) const
ObjCMethodDecl * | lookupClassMethod (Selector Sel) const
bool | hasDefinition () const
| Determine whether this protocol has a definition. More...
ObjCProtocolDecl * | getDefinition ()
| Retrieve the definition of this protocol, if any. More...
const ObjCProtocolDecl * | getDefinition () const
| Retrieve the definition of this protocol, if any. More...
bool | isThisDeclarationADefinition () const
| Determine whether this particular declaration is also the definition. More...
void | startDefinition ()
| Starts the definition of this Objective-C protocol. More...
StringRef | getObjCRuntimeNameAsString () const
| Produce a name to be used for protocol's metadata. More...
SourceRange | getSourceRange () const override LLVM_READONLY
| Source range that this declaration covers. More...
ObjCProtocolDecl * | getCanonicalDecl () override
| Retrieves the canonical declaration of this Objective-C protocol. More...
const ObjCProtocolDecl * | getCanonicalDecl () const
void | collectPropertiesToImplement (PropertyMap &PM, PropertyDeclOrder &PO) const override
| This routine collects list of properties to be implemented in the class. More...
void | collectInheritedProtocolProperties (const ObjCPropertyDecl *Property, ProtocolPropertySet &PS, PropertyDeclOrder &PO) const
Public Member Functions inherited from clang::ObjCContainerDecl
| ObjCContainerDecl (Kind DK, DeclContext *DC, IdentifierInfo *Id, SourceLocation nameLoc, SourceLocation atStartLoc)
prop_range | properties () const
prop_iterator | prop_begin () const
prop_iterator | prop_end () const
instprop_range | instance_properties () const
instprop_iterator | instprop_begin () const
instprop_iterator | instprop_end () const
classprop_range | class_properties () const
classprop_iterator | classprop_begin () const
classprop_iterator | classprop_end () const
method_range | methods () const
method_iterator | meth_begin () const
method_iterator | meth_end () const
instmeth_range | instance_methods () const
instmeth_iterator | instmeth_begin () const
instmeth_iterator | instmeth_end () const
classmeth_range | class_methods () const
classmeth_iterator | classmeth_begin () const
classmeth_iterator | classmeth_end () const
ObjCMethodDecl * | getMethod (Selector Sel, bool isInstance, bool AllowHidden=false) const
ObjCMethodDecl * | getInstanceMethod (Selector Sel, bool AllowHidden=false) const
ObjCMethodDecl * | getClassMethod (Selector Sel, bool AllowHidden=false) const
bool | HasUserDeclaredSetterMethod (const ObjCPropertyDecl *P) const
| This routine returns 'true' if a user declared setter method was found in the class, its protocols, its super classes or categories. More...
ObjCIvarDecl * | getIvarDecl (IdentifierInfo *Id) const
| getIvarDecl - This method looks up an ivar in this ContextDecl. More...
ObjCPropertyDecl * | FindPropertyDeclaration (const IdentifierInfo *PropertyId, ObjCPropertyQueryKind QueryKind) const
| FindPropertyDeclaration - Finds declaration of the property given its name in 'PropertyId' and returns it. More...
SourceLocation | getAtStartLoc () const
void | setAtStartLoc (SourceLocation Loc)
SourceRange | getAtEndRange () const
void | setAtEndRange (SourceRange atEnd)
Public Member Functions inherited from clang::NamedDecl
IdentifierInfo * | getIdentifier () const
| Get the identifier that names this declaration, if there is one. More...
StringRef | getName () const
| Get the name of identifier for this declaration as a StringRef. More...
std::string | getNameAsString () const
| Get a human-readable name for the declaration, even if it is one of the special kinds of names (C++ constructor, Objective-C selector, etc). More...
virtual void | printName (raw_ostream &os) const
DeclarationName | getDeclName () const
| Get the actual, stored name of the declaration, which may be a special name. More...
void | setDeclName (DeclarationName N)
| Set the name of this declaration. More...
void | printQualifiedName (raw_ostream &OS) const
| Returns a human-readable qualified name for this declaration, like A::B::i, for i being member of namespace A::B. More...
void | printQualifiedName (raw_ostream &OS, const PrintingPolicy &Policy) const
void | printNestedNameSpecifier (raw_ostream &OS) const
| Print only the nested name specifier part of a fully-qualified name, including the '::' at the end. More...
void | printNestedNameSpecifier (raw_ostream &OS, const PrintingPolicy &Policy) const
std::string | getQualifiedNameAsString () const
virtual void | getNameForDiagnostic (raw_ostream &OS, const PrintingPolicy &Policy, bool Qualified) const
| Appends a human-readable name for this declaration into the given stream. More...
bool | declarationReplaces (NamedDecl *OldD, bool IsKnownNewer=true) const
| Determine whether this declaration, if known to be well-formed within its context, will replace the declaration OldD if introduced into scope. More...
bool | hasLinkage () const
| Determine whether this declaration has linkage. More...
bool | isCXXClassMember () const
| Determine whether this declaration is a C++ class member. More...
bool | isCXXInstanceMember () const
| Determine whether the given declaration is an instance member of a C++ class. More...
Linkage | getLinkageInternal () const
| Determine what kind of linkage this entity has. More...
Linkage | getFormalLinkage () const
| Get the linkage from a semantic point of view. More...
bool | hasExternalFormalLinkage () const
| True if this decl has external linkage. More...
bool | isExternallyVisible () const
bool | isExternallyDeclarable () const
| Determine whether this declaration can be redeclared in a different translation unit. More...
Visibility | getVisibility () const
| Determines the visibility of this entity. More...
LinkageInfo | getLinkageAndVisibility () const
| Determines the linkage and visibility of this entity. More...
Optional< Visibility > | getExplicitVisibility (ExplicitVisibilityKind kind) const
| If visibility was explicitly specified for this declaration, return that visibility. More...
bool | isLinkageValid () const
| True if the computed linkage is valid. More...
bool | hasLinkageBeenComputed () const
| True if something has required us to compute the linkage of this declaration. More...
NamedDecl * | getUnderlyingDecl ()
| Looks through UsingDecls and ObjCCompatibleAliasDecls for the underlying named decl. More...
const NamedDecl * | getUnderlyingDecl () const
NamedDecl * | getMostRecentDecl ()
const NamedDecl * | getMostRecentDecl () const
ObjCStringFormatFamily | getObjCFStringFormattingFamily () const
Public Member Functions inherited from clang::Decl
| Decl ()=delete
| Decl (const Decl &)=delete
| Decl (Decl &&)=delete
Decl & | operator= (const Decl &)=delete
Decl & | operator= (Decl &&)=delete
SourceLocation | getBeginLoc () const LLVM_READONLY
SourceLocation | getEndLoc () const LLVM_READONLY
SourceLocation | getLocation () const
void | setLocation (SourceLocation L)
Kind | getKind () const
const char * | getDeclKindName () const
Decl * | getNextDeclInContext ()
const Decl * | getNextDeclInContext () const
DeclContext * | getDeclContext ()
const DeclContext * | getDeclContext () const
Decl * | getNonClosureContext ()
| Find the innermost non-closure ancestor of this declaration, walking up through blocks, lambdas, etc. More...
const Decl * | getNonClosureContext () const
TranslationUnitDecl * | getTranslationUnitDecl ()
const TranslationUnitDecl * | getTranslationUnitDecl () const
bool | isInAnonymousNamespace () const
bool | isInStdNamespace () const
ASTContext & | getASTContext () const LLVM_READONLY
void | setAccess (AccessSpecifier AS)
AccessSpecifier | getAccess () const
AccessSpecifier | getAccessUnsafe () const
| Retrieve the access specifier for this declaration, even though it may not yet have been properly set. More...
bool | hasAttrs () const
void | setAttrs (const AttrVec &Attrs)
AttrVec & | getAttrs ()
const AttrVec & | getAttrs () const
void | dropAttrs ()
void | addAttr (Attr *A)
attr_range | attrs () const
attr_iterator | attr_begin () const
attr_iterator | attr_end () const
template<typename T >
void | dropAttr ()
template<typename T >
llvm::iterator_range< specific_attr_iterator< T > > | specific_attrs () const
template<typename T >
specific_attr_iterator< T > | specific_attr_begin () const
template<typename T >
specific_attr_iterator< T > | specific_attr_end () const
template<typename T >
T * | getAttr () const
template<typename T >
bool | hasAttr () const
unsigned | getMaxAlignment () const
| getMaxAlignment - return the maximum alignment specified by attributes on this decl, 0 if there are none. More...
void | setInvalidDecl (bool Invalid=true)
| setInvalidDecl - Indicates the Decl had a semantic error. More...
bool | isInvalidDecl () const
bool | isImplicit () const
| isImplicit - Indicates whether the declaration was implicitly generated by the implementation. More...
void | setImplicit (bool I=true)
bool | isUsed (bool CheckUsedAttr=true) const
| Whether any (re-)declaration of the entity was used, meaning that a definition is required. More...
void | setIsUsed ()
| Set whether the declaration is used, in the sense of odr-use. More...
void | markUsed (ASTContext &C)
| Mark the declaration used, in the sense of odr-use. More...
bool | isReferenced () const
| Whether any declaration of this entity was referenced. More...
bool | isThisDeclarationReferenced () const
| Whether this declaration was referenced. More...
void | setReferenced (bool R=true)
bool | isTopLevelDeclInObjCContainer () const
| Whether this declaration is a top-level declaration (function, global variable, etc.) that is lexically inside an objc container definition. More...
void | setTopLevelDeclInObjCContainer (bool V=true)
ExternalSourceSymbolAttr * | getExternalSourceSymbolAttr () const
| Looks on this and related declarations for an applicable external source symbol attribute. More...
bool | isModulePrivate () const
| Whether this declaration was marked as being private to the module in which it was defined. More...
bool | hasDefiningAttr () const
| Return true if this declaration has an attribute which acts as definition of the entity, such as 'alias' or 'ifunc'. More...
const Attr * | getDefiningAttr () const
| Return this declaration's defining attribute if it has one. More...
AvailabilityResult | getAvailability (std::string *Message=nullptr, VersionTuple EnclosingVersion=VersionTuple(), StringRef *RealizedPlatform=nullptr) const
| Determine the availability of the given declaration. More...
VersionTuple | getVersionIntroduced () const
| Retrieve the version of the target platform in which this declaration was introduced. More...
bool | isDeprecated (std::string *Message=nullptr) const
| Determine whether this declaration is marked 'deprecated'. More...
bool | isUnavailable (std::string *Message=nullptr) const
| Determine whether this declaration is marked 'unavailable'. More...
bool | isWeakImported () const
| Determine whether this is a weak-imported symbol. More...
bool | canBeWeakImported (bool &IsDefinition) const
| Determines whether this symbol can be weak-imported, e.g., whether it would be well-formed to add the weak_import attribute. More...
bool | isFromASTFile () const
| Determine whether this declaration came from an AST file (such as a precompiled header or module) rather than having been parsed. More...
unsigned | getGlobalID () const
| Retrieve the global declaration ID associated with this declaration, which specifies where this Decl was loaded from. More...
unsigned | getOwningModuleID () const
| Retrieve the global ID of the module that owns this particular declaration. More...
Module * | getImportedOwningModule () const
| Get the imported owning module, if this decl is from an imported (non-local) module. More...
Module * | getLocalOwningModule () const
| Get the local owning module, if known. More...
void | setLocalOwningModule (Module *M)
bool | hasOwningModule () const
| Is this declaration owned by some module? More...
Module * | getOwningModule () const
| Get the module that owns this declaration (for visibility purposes). More...
Module * | getOwningModuleForLinkage (bool IgnoreLinkage=false) const
| Get the module that owns this declaration for linkage purposes. More...
bool | isHidden () const
| Determine whether this declaration might be hidden from name lookup. More...
void | setVisibleDespiteOwningModule ()
| Set that this declaration is globally visible, even if it came from a module that is not visible. More...
ModuleOwnershipKind | getModuleOwnershipKind () const
| Get the kind of module ownership for this declaration. More...
void | setModuleOwnershipKind (ModuleOwnershipKind MOK)
| Set whether this declaration is hidden from name lookup. More...
unsigned | getIdentifierNamespace () const
bool | isInIdentifierNamespace (unsigned NS) const
bool | hasTagIdentifierNamespace () const
DeclContext * | getLexicalDeclContext ()
| getLexicalDeclContext - The declaration context where this Decl was lexically declared (LexicalDC). More...
const DeclContext * | getLexicalDeclContext () const
virtual bool | isOutOfLine () const
| Determine whether this declaration is declared out of line (outside its semantic context). More...
void | setDeclContext (DeclContext *DC)
| setDeclContext - Set both the semantic and lexical DeclContext to DC. More...
void | setLexicalDeclContext (DeclContext *DC)
bool | isTemplated () const
| Determine whether this declaration is a templated entity (whether it is. More...
bool | isDefinedOutsideFunctionOrMethod () const
| isDefinedOutsideFunctionOrMethod - This predicate returns true if this scoped decl is defined outside the current function or method. More...
bool | isLexicallyWithinFunctionOrMethod () const
| Returns true if this declaration lexically is inside a function. More...
const DeclContext * | getParentFunctionOrMethod () const
| If this decl is defined inside a function/method/block it returns the corresponding DeclContext, otherwise it returns null. More...
DeclContext * | getParentFunctionOrMethod ()
const Decl * | getCanonicalDecl () const
bool | isCanonicalDecl () const
| Whether this particular Decl is a canonical one. More...
redecl_range | redecls () const
| Returns an iterator range for all the redeclarations of the same decl. More...
redecl_iterator | redecls_begin () const
redecl_iterator | redecls_end () const
Decl * | getPreviousDecl ()
| Retrieve the previous declaration that declares the same entity as this declaration, or NULL if there is no previous declaration. More...
const Decl * | getPreviousDecl () const
| Retrieve the previous declaration that declares the same entity as this declaration, or NULL if there is no previous declaration. More...
bool | isFirstDecl () const
| True if this is the first declaration in its redeclaration chain. More...
Decl * | getMostRecentDecl ()
| Retrieve the most recent declaration that declares the same entity as this declaration (which may be this declaration). More...
const Decl * | getMostRecentDecl () const
| Retrieve the most recent declaration that declares the same entity as this declaration (which may be this declaration). More...
virtual Stmt * | getBody () const
| getBody - If this Decl represents a declaration for a body of code, such as a function or method definition, this method returns the top-level Stmt* of that body. More...
virtual bool | hasBody () const
| Returns true if this `Decl` represents a declaration for a body of code, such as a function or method definition. More...
SourceLocation | getBodyRBrace () const
| getBodyRBrace - Gets the right brace of the body, if a body exists. More...
bool | isTemplateParameter () const
| isTemplateParameter - Determines whether this declaration is a template parameter. More...
bool | isTemplateParameterPack () const
| isTemplateParameter - Determines whether this declaration is a template parameter pack. More...
bool | isParameterPack () const
| Whether this declaration is a parameter pack. More...
bool | isTemplateDecl () const
| returns true if this declaration is a template More...
bool | isFunctionOrFunctionTemplate () const
| Whether this declaration is a function or function template. More...
TemplateDecl * | getDescribedTemplate () const
| If this is a declaration that describes some template, this method returns that template declaration. More...
FunctionDecl * | getAsFunction () LLVM_READONLY
| Returns the function itself, or the templated function if this is a function template. More...
const FunctionDecl * | getAsFunction () const
void | setLocalExternDecl ()
| Changes the namespace of this declaration to reflect that it's a function-local extern declaration. More...
bool | isLocalExternDecl ()
| Determine whether this is a block-scope declaration with linkage. More...
void | setObjectOfFriendDecl (bool PerformFriendInjection=false)
| Changes the namespace of this declaration to reflect that it's the object of a friend declaration. More...
FriendObjectKind | getFriendObjectKind () const
| Determines whether this declaration is the object of a friend declaration and, if so, what kind. More...
void | setNonMemberOperator ()
| Specifies that this declaration is a C++ overloaded non-member. More...
void | print (raw_ostream &Out, unsigned Indentation=0, bool PrintInstantiation=false) const
void | print (raw_ostream &Out, const PrintingPolicy &Policy, unsigned Indentation=0, bool PrintInstantiation=false) const
void | dump () const
void | dumpColor () const
void | dump (raw_ostream &Out, bool Deserialize=false, ASTDumpOutputFormat OutputFormat=ADOF_Default) const
int64_t | getID () const
const FunctionType * | getFunctionType (bool BlocksToo=true) const
| Looks through the Decl's underlying type to extract a FunctionType when possible. More...
Public Member Functions inherited from clang::DeclContext
| ~DeclContext ()
Decl::Kind | getDeclKind () const
const char * | getDeclKindName () const
DeclContext * | getParent ()
| getParent - Returns the containing DeclContext. More...
const DeclContext * | getParent () const
DeclContext * | getLexicalParent ()
| getLexicalParent - Returns the containing lexical DeclContext. More...
const DeclContext * | getLexicalParent () const
DeclContext * | getLookupParent ()
| Find the parent context of this context that will be used for unqualified name lookup. More...
const DeclContext * | getLookupParent () const
ASTContext & | getParentASTContext () const
bool | isClosure () const
const BlockDecl * | getInnermostBlockDecl () const
| Return this DeclContext if it is a BlockDecl. More...
bool | isObjCContainer () const
bool | isFunctionOrMethod () const
bool | isLookupContext () const
| Test whether the context supports looking up names. More...
bool | isFileContext () const
bool | isTranslationUnit () const
bool | isRecord () const
bool | isNamespace () const
bool | isStdNamespace () const
bool | isInlineNamespace () const
bool | isDependentContext () const
| Determines whether this context is dependent on a template parameter. More...
bool | isTransparentContext () const
| isTransparentContext - Determines whether this context is a "transparent" context, meaning that the members declared in this context are semantically declared in the nearest enclosing non-transparent (opaque) context but are lexically declared in this context. More...
bool | isExternCContext () const
| Determines whether this context or some of its ancestors is a linkage specification context that specifies C linkage. More...
const LinkageSpecDecl * | getExternCContext () const
| Retrieve the nearest enclosing C linkage specification context. More...
bool | isExternCXXContext () const
| Determines whether this context or some of its ancestors is a linkage specification context that specifies C++ linkage. More...
bool | Equals (const DeclContext *DC) const
| Determine whether this declaration context is equivalent to the declaration context DC. More...
bool | Encloses (const DeclContext *DC) const
| Determine whether this declaration context encloses the declaration context DC. More...
Decl * | getNonClosureAncestor ()
| Find the nearest non-closure ancestor of this context, i.e. More...
const Decl * | getNonClosureAncestor () const
DeclContext * | getPrimaryContext ()
| getPrimaryContext - There may be many different declarations of the same entity (including forward declarations of classes, multiple definitions of namespaces, etc.), each with a different set of declarations. More...
const DeclContext * | getPrimaryContext () const
DeclContext * | getRedeclContext ()
| getRedeclContext - Retrieve the context in which an entity conflicts with other entities of the same name, or where it is a redeclaration if the two entities are compatible. More...
const DeclContext * | getRedeclContext () const
DeclContext * | getEnclosingNamespaceContext ()
| Retrieve the nearest enclosing namespace context. More...
const DeclContext * | getEnclosingNamespaceContext () const
RecordDecl * | getOuterLexicalRecordContext ()
| Retrieve the outermost lexically enclosing record context. More...
const RecordDecl * | getOuterLexicalRecordContext () const
bool | InEnclosingNamespaceSetOf (const DeclContext *NS) const
| Test if this context is part of the enclosing namespace set of the context NS, as defined in C++0x [namespace.def]p9. More...
void | collectAllContexts (SmallVectorImpl< DeclContext *> &Contexts)
| Collects all of the declaration contexts that are semantically connected to this declaration context. More...
decl_range | decls () const
| decls_begin/decls_end - Iterate over the declarations stored in this context. More...
decl_iterator | decls_begin () const
decl_iterator | decls_end () const
bool | decls_empty () const
decl_range | noload_decls () const
| noload_decls_begin/end - Iterate over the declarations stored in this context that are currently loaded; don't attempt to retrieve anything from an external source. More...
decl_iterator | noload_decls_begin () const
decl_iterator | noload_decls_end () const
void | addDecl (Decl *D)
| Add the declaration D into this context. More...
void | addDeclInternal (Decl *D)
| Add the declaration D into this context, but suppress searches for external declarations with the same name. More...
void | addHiddenDecl (Decl *D)
| Add the declaration D to this context without modifying any lookup tables. More...
void | removeDecl (Decl *D)
| Removes a declaration from this context. More...
bool | containsDecl (Decl *D) const
| Checks whether a declaration is in this context. More...
bool | containsDeclAndLoad (Decl *D) const
| Checks whether a declaration is in this context. More...
lookup_result | lookup (DeclarationName Name) const
| lookup - Find the declarations (if any) with the given Name in this context. More...
lookup_result | noload_lookup (DeclarationName Name)
| Find the declarations with the given name that are visible within this context; don't attempt to retrieve anything from an external source. More...
void | localUncachedLookup (DeclarationName Name, SmallVectorImpl< NamedDecl *> &Results)
| A simplistic name lookup mechanism that performs name lookup into this declaration context without consulting the external source. More...
void | makeDeclVisibleInContext (NamedDecl *D)
| Makes a declaration visible within this context. More...
lookups_range | lookups () const
lookups_range | noload_lookups (bool PreserveInternalState) const
all_lookups_iterator | lookups_begin () const
| Iterators over all possible lookups within this context. More...
all_lookups_iterator | lookups_end () const
all_lookups_iterator | noload_lookups_begin () const
| Iterators over all possible lookups within this context that are currently loaded; don't attempt to retrieve anything from an external source. More...
all_lookups_iterator | noload_lookups_end () const
udir_range | using_directives () const
| Returns iterator range [First, Last) of UsingDirectiveDecls stored within this context. More...
ddiag_range | ddiags () const
void | setMustBuildLookupTable ()
| Mark that there are external lexical declarations that we need to include in our lookup table (and that are not available as external visible lookups). More...
StoredDeclsMap * | getLookupPtr () const
| Retrieve the internal representation of the lookup structure. More...
StoredDeclsMap * | buildLookup ()
| Ensure the lookup structure is fully-built and return it. More...
bool | hasExternalLexicalStorage () const
| Whether this DeclContext has external storage containing additional declarations that are lexically in this context. More...
void | setHasExternalLexicalStorage (bool ES=true) const
| State whether this DeclContext has external storage for declarations lexically in this context. More...
bool | hasExternalVisibleStorage () const
| Whether this DeclContext has external storage containing additional declarations that are visible in this context. More...
void | setHasExternalVisibleStorage (bool ES=true) const
| State whether this DeclContext has external storage for declarations visible in this context. More...
bool | isDeclInLexicalTraversal (const Decl *D) const
| Determine whether the given declaration is stored in the list of declarations lexically within this context. More...
bool | setUseQualifiedLookup (bool use=true) const
bool | shouldUseQualifiedLookup () const
void | dumpDeclContext () const
void | dumpLookups () const
void | dumpLookups (llvm::raw_ostream &OS, bool DumpDecls=false, bool Deserialize=false) const
Public Member Functions inherited from clang::Redeclarable< ObjCProtocolDecl >
| Redeclarable (const ASTContext &Ctx)
ObjCProtocolDecl * | getPreviousDecl ()
| Return the previous declaration of this declaration or NULL if this is the first declaration. More...
const ObjCProtocolDecl * | getPreviousDecl () const
ObjCProtocolDecl * | getFirstDecl ()
| Return the first declaration of this declaration or itself if this is the only declaration. More...
const ObjCProtocolDecl * | getFirstDecl () const
| Return the first declaration of this declaration or itself if this is the only declaration. More...
bool | isFirstDecl () const
| True if this is the first declaration in its redeclaration chain. More...
ObjCProtocolDecl * | getMostRecentDecl ()
| Returns the most recent (re)declaration of this declaration. More...
const ObjCProtocolDecl * | getMostRecentDecl () const
| Returns the most recent (re)declaration of this declaration. More...
void | setPreviousDecl (ObjCProtocolDecl *PrevDecl)
| Set the previous declaration. More...
redecl_range | redecls () const
| Returns an iterator range for all the redeclarations of the same decl. More...
redecl_iterator | redecls_begin () const
redecl_iterator | redecls_end () const

## Static Public Member Functions
static ObjCProtocolDecl * | Create (ASTContext &C, DeclContext *DC, IdentifierInfo *Id, SourceLocation nameLoc, SourceLocation atStartLoc, ObjCProtocolDecl *PrevDecl)
static ObjCProtocolDecl * | CreateDeserialized (ASTContext &C, unsigned ID)
static bool | classof (const Decl *D)
static bool | classofKind (Kind K)
Static Public Member Functions inherited from clang::ObjCContainerDecl
static bool | classof (const Decl *D)
static bool | classofKind (Kind K)
static DeclContext * | castToDeclContext (const ObjCContainerDecl *D)
static ObjCContainerDecl * | castFromDeclContext (const DeclContext *DC)
Static Public Member Functions inherited from clang::NamedDecl
static bool | classof (const Decl *D)
static bool | classofKind (Kind K)
Static Public Member Functions inherited from clang::Decl
static unsigned | getIdentifierNamespaceForKind (Kind DK)
static bool | isTagIdentifierNamespace (unsigned NS)
static void | add (Kind k)
static void | EnableStatistics ()
static void | PrintStats ()
static bool | classofKind (Kind K)
static DeclContext * | castToDeclContext (const Decl *)
static Decl * | castFromDeclContext (const DeclContext *)
static void | printGroup (Decl **Begin, unsigned NumDecls, raw_ostream &Out, const PrintingPolicy &Policy, unsigned Indentation=0)
Static Public Member Functions inherited from clang::DeclContext
static bool | classof (const Decl *D)
static bool | classof (const DeclContext *D)

## Friends
class | ASTDeclReader
class | ASTDeclWriter
class | ASTReader

## Additional Inherited Members
Protected Member Functions inherited from clang::NamedDecl
| NamedDecl (Kind DK, DeclContext *DC, SourceLocation L, DeclarationName N)
Protected Member Functions inherited from clang::Decl
void * | operator new (std::size_t Size, const ASTContext &Ctx, unsigned ID, std::size_t Extra=0)
| Allocate memory for a deserialized declaration. More...
void * | operator new (std::size_t Size, const ASTContext &Ctx, DeclContext *Parent, std::size_t Extra=0)
| Allocate memory for a non-deserialized declaration. More...
| Decl (Kind DK, DeclContext *DC, SourceLocation L)
| Decl (Kind DK, EmptyShell Empty)
virtual | ~Decl ()
void | updateOutOfDate (IdentifierInfo &II) const
| Update a potentially out-of-date declaration. More...
Linkage | getCachedLinkage () const
void | setCachedLinkage (Linkage L) const
bool | hasCachedLinkage () const
void | setModulePrivate ()
| Specify that this declaration was marked as being private to the module in which it was defined. More...
void | setOwningModuleID (unsigned ID)
| Set the owning module ID. More...
bool | hasLocalOwningModuleStorage () const
ASTMutationListener * | getASTMutationListener () const
Protected Member Functions inherited from clang::DeclContext
| DeclContext (Decl::Kind K)
Protected Member Functions inherited from clang::Redeclarable< ObjCProtocolDecl >
ObjCProtocolDecl * | getNextRedeclaration () const
Static Protected Member Functions inherited from clang::DeclContext
static std::pair< Decl *, Decl * > | BuildDeclChain (ArrayRef< Decl *> Decls, bool FieldsAlreadyLoaded)
| Build up a chain of declarations. More...
Static Protected Member Functions inherited from clang::Redeclarable< ObjCProtocolDecl >
static DeclLink | PreviousDeclLink (ObjCProtocolDecl *D)
static DeclLink | LatestDeclLink (const ASTContext &Ctx)
Protected Attributes inherited from clang::Decl
llvm::PointerIntPair< Decl *, 2, ModuleOwnershipKind > | NextInContextAndBits
| The next declaration within the same lexical DeclContext. More...
unsigned | Access: 2
| Access - Used by C++ decls for the access specifier. More...
unsigned | FromASTFile: 1
| Whether this declaration was loaded from an AST file. More...
unsigned | IdentifierNamespace: 14
| IdentifierNamespace - This specifies what IDNS_* namespace this lives in. More...
unsigned | CacheValidAndLinkage: 3
| If 0, we have not computed the linkage of this declaration. More...
Protected Attributes inherited from clang::DeclContext
union {
DeclContextBitfields DeclContextBits
TagDeclBitfields TagDeclBits
EnumDeclBitfields EnumDeclBits
RecordDeclBitfields RecordDeclBits
OMPDeclareReductionDeclBitfields OMPDeclareReductionDeclBits
FunctionDeclBitfields FunctionDeclBits
CXXConstructorDeclBitfields CXXConstructorDeclBits
ObjCMethodDeclBitfields ObjCMethodDeclBits
ObjCContainerDeclBitfields ObjCContainerDeclBits
LinkageSpecDeclBitfields LinkageSpecDeclBits
BlockDeclBitfields BlockDeclBits
}; |
| This anonymous union stores the bits belonging to DeclContext and classes deriving from it. More...
Decl * | FirstDecl = nullptr
| FirstDecl - The first declaration stored within this declaration context. More...
Decl * | LastDecl = nullptr
| LastDecl - The last declaration stored within this declaration context. More...
Protected Attributes inherited from clang::Redeclarable< ObjCProtocolDecl >
DeclLink | RedeclLink
| Points to the next redeclaration in the chain. More...
ObjCProtocolDecl * | First

## Detailed Description

Represents an Objective-C protocol declaration.

Objective-C protocols declare a pure abstract type (i.e., no instance variables are permitted). Protocols originally drew inspiration from C++ pure virtual functions (a C++ feature with nice semantics and lousy syntax:-). Here is an example:

\@protocol NSDraggingInfo <refproto1, refproto2>
- (NSWindow *)draggingDestinationWindow;
- (NSImage *)draggedImage;
\@end

This says that NSDraggingInfo requires two methods and requires everything that the two "referenced protocols" 'refproto1' and 'refproto2' require as well.

\@interface ImplementsNSDraggingInfo : NSObject \<NSDraggingInfo>
\@end

ObjC protocols inspired Java interfaces. Unlike Java, ObjC classes and protocols are in distinct namespaces. For example, Cocoa defines both an NSObject protocol and class (which isn't allowed in Java). As a result, protocols are referenced using angle brackets as follows:

id <NSDraggingInfo> anyObjectThatImplementsNSDraggingInfo;

Definition at line 2078 of file DeclObjC.h.

## Member Typedef Documentation

## ◆ protocol_iterator

using clang::ObjCProtocolDecl::protocol_iterator = ObjCProtocolList::iterator

Definition at line 2140 of file DeclObjC.h.

## ◆ protocol_loc_iterator

using clang::ObjCProtocolDecl::protocol_loc_iterator = ObjCProtocolList::loc_iterator

Definition at line 2161 of file DeclObjC.h.

## ◆ protocol_loc_range

using clang::ObjCProtocolDecl::protocol_loc_range = llvm::iterator_range<protocol_loc_iterator>

Definition at line 2162 of file DeclObjC.h.

## ◆ protocol_range

using clang::ObjCProtocolDecl::protocol_range = llvm::iterator_range<protocol_iterator>

Definition at line 2141 of file DeclObjC.h.

## ◆ redecl_iterator

using clang::ObjCProtocolDecl::redecl_iterator = redeclarable_base::redecl_iterator

Definition at line 2254 of file DeclObjC.h.

## ◆ redecl_range

using clang::ObjCProtocolDecl::redecl_range = redeclarable_base::redecl_range

Definition at line 2253 of file DeclObjC.h.

## Member Function Documentation

## ◆ classof()

static bool clang::ObjCProtocolDecl::classof | ( | const Decl * | D | ) |
| inline static

Definition at line 2274 of file DeclObjC.h.

References clang::Decl::getKind().

## ◆ classofKind()

static bool clang::ObjCProtocolDecl::classofKind | ( | Kind | K | ) |
| inline static

Definition at line 2275 of file DeclObjC.h.

## ◆ collectInheritedProtocolProperties()

void ObjCProtocolDecl::collectInheritedProtocolProperties | ( | const ObjCPropertyDecl * | Property,
|  | ProtocolPropertySet & | PS,
|  | PropertyDeclOrder & | PO
| ) |  | const

Definition at line 1965 of file DeclObjC.cpp.

References getDefinition(), and clang::NamedDecl::getIdentifier().

## ◆ collectPropertiesToImplement()

void ObjCProtocolDecl::collectPropertiesToImplement | ( | PropertyMap & | PM,
|  | PropertyDeclOrder & | PO
| ) |  | const
| override virtual

This routine collects list of properties to be implemented in the class.

This includes, class's and its conforming protocols' properties. Note, the superclass's properties are not included in the list.

Reimplemented from clang::ObjCContainerDecl.

Definition at line 1949 of file DeclObjC.cpp.

References getDefinition().

## ◆ Create()

ObjCProtocolDecl * ObjCProtocolDecl::Create | ( | ASTContext & | C,
|  | DeclContext * | DC,
|  | IdentifierInfo * | Id,
|  | SourceLocation | nameLoc,
|  | SourceLocation | atStartLoc,
|  | ObjCProtocolDecl * | PrevDecl
| ) |  |
| static

Definition at line 1881 of file DeclObjC.cpp.

References clang::C, clang::ASTContext::getLangOpts(), and clang::Result.

Referenced by clang::Sema::ActOnForwardProtocolDeclaration(), and clang::Sema::ActOnStartProtocolInterface().

## ◆ CreateDeserialized()

ObjCProtocolDecl * ObjCProtocolDecl::CreateDeserialized | ( | ASTContext & | C,
|  | unsigned | ID
| ) |  |
| static

Definition at line 1892 of file DeclObjC.cpp.

References clang::C, clang::ASTContext::getLangOpts(), and clang::Result.

## ◆ getCanonicalDecl() [1/2]

ObjCProtocolDecl* clang::ObjCProtocolDecl::getCanonicalDecl | ( |  | ) |
| inline override virtual

Retrieves the canonical declaration of this Objective-C protocol.

Reimplemented from clang::Decl.

Definition at line 2264 of file DeclObjC.h.

Referenced by clang::ASTDeclReader::VisitObjCProtocolDecl(), and Write__ivar_list_t_initializer().

## ◆ getCanonicalDecl() [2/2]

const ObjCProtocolDecl* clang::ObjCProtocolDecl::getCanonicalDecl | ( |  | ) | const
| inline

Definition at line 2265 of file DeclObjC.h.

References clang::Property.

## ◆ getDefinition() [1/2]

ObjCProtocolDecl* clang::ObjCProtocolDecl::getDefinition | ( |  | ) |
| inline

Retrieve the definition of this protocol, if any.

Definition at line 2224 of file DeclObjC.h.

References hasDefinition().

Referenced by clang::Sema::ActOnStartProtocolInterface(), ClassImplementsAllMethodsAndProperties(), clang::ObjCPropertyDecl::findPropertyDecl(), clang::ObjCContainerDecl::FindPropertyDeclaration(), clang::Sema::FindProtocolDeclaration(), getBlockLayoutInfoString(), clang::serialization::getDefinitiveDeclContext(), clang::ObjCContainerDecl::getMethod(), clang::ASTImporter::ImportContext(), clang::ASTNodeImporter::ImportDefinition(), NestedProtocolHasNoDefinition(), clang::Sema::ParseObjCProtocolExpression(), clang::ASTNodeImporter::VisitObjCProtocolDecl(), and Write__ivar_list_t_initializer().

## ◆ getDefinition() [2/2]

const ObjCProtocolDecl* clang::ObjCProtocolDecl::getDefinition | ( |  | ) | const
| inline

Retrieve the definition of this protocol, if any.

Definition at line 2229 of file DeclObjC.h.

References hasDefinition().

## ◆ getObjCRuntimeNameAsString()

StringRef ObjCProtocolDecl::getObjCRuntimeNameAsString | ( |  | ) | const

Produce a name to be used for protocol's metadata.

It comes either via objc_runtime_name attribute or protocol name.

Definition at line 1986 of file DeclObjC.cpp.

References clang::NamedDecl::getName(), and clang::ObjCContainerDecl::ObjCContainerDecl().

Referenced by getBlockLayoutInfoString().

## ◆ getReferencedProtocols()

const ObjCProtocolList& clang::ObjCProtocolDecl::getReferencedProtocols | ( |  | ) | const
| inline

Definition at line 2135 of file DeclObjC.h.

References hasDefinition().

## ◆ getSourceRange()

SourceRange clang::ObjCProtocolDecl::getSourceRange | ( |  | ) | const
| inline override virtual

Source range that this declaration covers.

Reimplemented from clang::ObjCContainerDecl.

Definition at line 2246 of file DeclObjC.h.

References clang::ObjCContainerDecl::getSourceRange().

## ◆ hasDefinition()

bool clang::ObjCProtocolDecl::hasDefinition | ( |  | ) | const
| inline

Determine whether this protocol has a definition.

Definition at line 2212 of file DeclObjC.h.

Referenced by NestedProtocolHasNoDefinition(), and clang::Sema::ParseObjCProtocolExpression().

## ◆ isThisDeclarationADefinition()

bool clang::ObjCProtocolDecl::isThisDeclarationADefinition | ( |  | ) | const
| inline

Determine whether this particular declaration is also the definition.

Definition at line 2235 of file DeclObjC.h.

References getDefinition().

Referenced by clang::Sema::FindProtocolDeclaration(), RewriteOneForwardClassDecl(), and clang::ASTDeclWriter::VisitObjCProtocolDecl().

## ◆ lookupClassMethod()

ObjCMethodDecl* clang::ObjCProtocolDecl::lookupClassMethod | ( | Selector | Sel | ) | const
| inline

Definition at line 2207 of file DeclObjC.h.

## ◆ lookupInstanceMethod()

ObjCMethodDecl* clang::ObjCProtocolDecl::lookupInstanceMethod | ( | Selector | Sel | ) | const
| inline

Definition at line 2203 of file DeclObjC.h.

## ◆ lookupMethod()

ObjCMethodDecl * ObjCProtocolDecl::lookupMethod | ( | Selector | Sel,
|  | bool | isInstance
| ) |  | const

Definition at line 1916 of file DeclObjC.cpp.

References clang::Decl::getASTContext(), getDefinition(), clang::ObjCContainerDecl::getMethod(), and clang::Decl::isHidden().

## ◆ lookupProtocolNamed()

ObjCProtocolDecl * ObjCProtocolDecl::lookupProtocolNamed | ( | IdentifierInfo * | PName | ) |

Definition at line 1901 of file DeclObjC.cpp.

References clang::NamedDecl::getIdentifier(), and lookupProtocolNamed().

Referenced by lookupProtocolNamed(), and UseNSOptionsMacro().

## ◆ protocol_begin()

protocol_iterator clang::ObjCProtocolDecl::protocol_begin | ( |  | ) | const
| inline

Definition at line 2147 of file DeclObjC.h.

References hasDefinition().

Referenced by getBlockLayoutInfoString(), and clang::ASTNodeImporter::ImportDefinition().

## ◆ protocol_end()

protocol_iterator clang::ObjCProtocolDecl::protocol_end | ( |  | ) | const
| inline

Definition at line 2154 of file DeclObjC.h.

References hasDefinition().

Referenced by getBlockLayoutInfoString(), and clang::ASTNodeImporter::ImportDefinition().

## ◆ protocol_loc_begin()

protocol_loc_iterator clang::ObjCProtocolDecl::protocol_loc_begin | ( |  | ) | const
| inline

Definition at line 2168 of file DeclObjC.h.

References hasDefinition().

Referenced by clang::ASTNodeImporter::ImportDefinition().

## ◆ protocol_loc_end()

protocol_loc_iterator clang::ObjCProtocolDecl::protocol_loc_end | ( |  | ) | const
| inline

Definition at line 2175 of file DeclObjC.h.

References hasDefinition().

## ◆ protocol_locs()

protocol_loc_range clang::ObjCProtocolDecl::protocol_locs | ( |  | ) | const
| inline

Definition at line 2164 of file DeclObjC.h.

Referenced by clang::ASTDeclWriter::VisitObjCProtocolDecl().

## ◆ protocol_size()

unsigned clang::ObjCProtocolDecl::protocol_size | ( |  | ) | const
| inline

Definition at line 2182 of file DeclObjC.h.

References hasDefinition().

Referenced by clang::ASTDeclWriter::VisitObjCProtocolDecl().

## ◆ protocols()

protocol_range clang::ObjCProtocolDecl::protocols | ( |  | ) | const
| inline

Definition at line 2143 of file DeclObjC.h.

Referenced by findProtocolsWithExplicitImpls(), NestedProtocolHasNoDefinition(), clang::ASTContext::ProtocolCompatibleWithProtocol(), PushProtocolProperties(), clang::ASTDeclWriter::VisitObjCProtocolDecl(), clang::JSONNodeDumper::VisitObjCProtocolDecl(), clang::TextNodeDumper::VisitObjCProtocolDecl(), and Write__ivar_list_t_initializer().

## ◆ setProtocolList()

void clang::ObjCProtocolDecl::setProtocolList | ( | ObjCProtocolDecl *const * | List,
|  | unsigned | Num,
|  | const SourceLocation * | Locs,
|  | ASTContext & | C
| ) |  |
| inline

setProtocolList - Set the list of protocols that this interface implements.

Definition at line 2191 of file DeclObjC.h.

References hasDefinition().

Referenced by clang::Sema::ActOnStartProtocolInterface(), and clang::ASTNodeImporter::ImportDefinition().

## ◆ startDefinition()

void ObjCProtocolDecl::startDefinition | ( |  | ) |

Starts the definition of this Objective-C protocol.

Definition at line 1941 of file DeclObjC.cpp.

References clang::Decl::redecls().

Referenced by clang::ASTNodeImporter::ImportDefinition().

## Friends And Related Function Documentation

## ◆ ASTDeclReader

friend class ASTDeclReader
| friend

Definition at line 2123 of file DeclObjC.h.

## ◆ ASTDeclWriter

friend class ASTDeclWriter
| friend

Definition at line 2124 of file DeclObjC.h.

## ◆ ASTReader

friend class ASTReader
| friend

Definition at line 2125 of file DeclObjC.h.

The documentation for this class was generated from the following files:

- include/clang/AST/DeclObjC.h
- lib/AST/DeclObjC.cpp