clang: clang::BlockDecl Class Reference (original) (raw)

hasCaptures () const

True if this block (or its nested blocks) captures anything of local storage from its enclosing scopes.

getNumCaptures () const

Returns the number of captured variables.

ArrayRef< Capture >

captures () const

capture_const_iterator

capture_begin () const

capture_const_iterator

capture_end () const

capturesCXXThis () const

void

setCapturesCXXThis (bool B=true)

blockMissingReturnType () const

void

setBlockMissingReturnType (bool val=true)

isConversionFromLambda () const

void

setIsConversionFromLambda (bool val=true)

doesNotEscape () const

void

setDoesNotEscape (bool B=true)

canAvoidCopyToHeap () const

void

setCanAvoidCopyToHeap (bool B=true)

capturesVariable (const VarDecl *var) const

void

setCaptures (ASTContext &Context, ArrayRef< Capture > Captures, bool CapturesCXXThis)

getBlockManglingNumber () const

Decl *

getBlockManglingContextDecl () const

void

setBlockMangling (unsigned Number, Decl *Ctx)

SourceRange

getSourceRange () const override LLVM_READONLY

Source range that this declaration covers.

FunctionEffectsRef

getFunctionEffects () 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

virtual SourceRange

getSourceRange () const LLVM_READONLY

Source range that this declaration covers.

getBeginLoc () const LLVM_READONLY

getEndLoc () const LLVM_READONLY

getLocation () const

void

setLocation (SourceLocation L)

Kind

getKind () const

const char *

getDeclKindName () const

Decl *

getNextDeclInContext ()

const Decl *

getNextDeclInContext () const

getDeclContext ()

const DeclContext *

getDeclContext () const

getNonTransparentDeclContext ()

Return the non transparent context.

const DeclContext *

getNonTransparentDeclContext () const

Decl *

getNonClosureContext ()

Find the innermost non-closure ancestor of this declaration, walking up through blocks, lambdas, etc.

const Decl *

getNonClosureContext () const

TranslationUnitDecl *

getTranslationUnitDecl ()

const TranslationUnitDecl *

getTranslationUnitDecl () const

isInAnonymousNamespace () const

isInStdNamespace () const

isFileContextDecl () const

ASTContext &

getASTContext () const LLVM_READONLY

const LangOptions &

getLangOpts () const LLVM_READONLY

Helper to get the language options from the ASTContext.

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.

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... Ts>

void

dropAttrs ()

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 >

hasAttr () const

getMaxAlignment () const

getMaxAlignment - return the maximum alignment specified by attributes on this decl, 0 if there are none.

void

setInvalidDecl (bool Invalid=true)

setInvalidDecl - Indicates the Decl had a semantic error.

isInvalidDecl () const

isImplicit () const

isImplicit - Indicates whether the declaration was implicitly generated by the implementation.

void

setImplicit (bool I=true)

isUsed (bool CheckUsedAttr=true) const

Whether any (re-)declaration of the entity was used, meaning that a definition is required.

void

setIsUsed ()

Set whether the declaration is used, in the sense of odr-use.

void

markUsed (ASTContext &C)

Mark the declaration used, in the sense of odr-use.

isReferenced () const

Whether any declaration of this entity was referenced.

isThisDeclarationReferenced () const

Whether this declaration was referenced.

void

setReferenced (bool R=true)

isTopLevelDeclInObjCContainer () const

Whether this declaration is a top-level declaration (function, global variable, etc.) that is lexically inside an objc container definition.

void

setTopLevelDeclInObjCContainer (bool V=true)

ExternalSourceSymbolAttr *

getExternalSourceSymbolAttr () const

Looks on this and related declarations for an applicable external source symbol attribute.

isModulePrivate () const

Whether this declaration was marked as being private to the module in which it was defined.

isInExportDeclContext () const

Whether this declaration was exported in a lexical context.

isInvisibleOutsideTheOwningModule () const

isInAnotherModuleUnit () const

Whether this declaration comes from another module unit.

isInCurrentModuleUnit () const

Whether this declaration comes from the same module unit being compiled.

shouldEmitInExternalSource () const

Whether the definition of the declaration should be emitted in external sources.

isFromExplicitGlobalModule () const

Whether this declaration comes from explicit global module.

isFromGlobalModule () const

Whether this declaration comes from global module.

isInNamedModule () const

Whether this declaration comes from a named module.

isFromHeaderUnit () const

Whether this declaration comes from a header unit.

hasDefiningAttr () const

Return true if this declaration has an attribute which acts as definition of the entity, such as 'alias' or 'ifunc'.

const Attr *

getDefiningAttr () const

Return this declaration's defining attribute if it has one.

void

setFromASTFile ()

Set the FromASTFile flag.

void

setOwningModuleID (unsigned ID)

Set the owning module ID.

AvailabilityResult

getAvailability (std::string *Message=nullptr, VersionTuple EnclosingVersion=VersionTuple(), StringRef *RealizedPlatform=nullptr) const

Determine the availability of the given declaration.

VersionTuple

getVersionIntroduced () const

Retrieve the version of the target platform in which this declaration was introduced.

isDeprecated (std::string *Message=nullptr) const

Determine whether this declaration is marked 'deprecated'.

isUnavailable (std::string *Message=nullptr) const

Determine whether this declaration is marked 'unavailable'.

isWeakImported () const

Determine whether this is a weak-imported symbol.

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.

isFromASTFile () const

Determine whether this declaration came from an AST file (such as a precompiled header or module) rather than having been parsed.

GlobalDeclID

getGlobalID () const

Retrieve the global declaration ID associated with this declaration, which specifies where this Decl was loaded from.

getOwningModuleID () const

Retrieve the global ID of the module that owns this particular declaration.

getImportedOwningModule () const

Get the imported owning module, if this decl is from an imported (non-local) module.

getLocalOwningModule () const

Get the local owning module, if known.

void

setLocalOwningModule (Module *M)

hasOwningModule () const

Is this declaration owned by some module?

getOwningModule () const

Get the module that owns this declaration (for visibility purposes).

getTopLevelOwningNamedModule () const

Get the top level owning named module that owns this declaration if any.

getOwningModuleForLinkage () const

Get the module that owns this declaration for linkage purposes.

isUnconditionallyVisible () const

Determine whether this declaration is definitely visible to name lookup, independent of whether the owning module is visible.

setVisibleDespiteOwningModule ()

isReachable () const

void

Set that this declaration is globally visible, even if it came from a module that is not visible.

ModuleOwnershipKind

getModuleOwnershipKind () const

Get the kind of module ownership for this declaration.

void

setModuleOwnershipKind (ModuleOwnershipKind MOK)

Set whether this declaration is hidden from name lookup.

getIdentifierNamespace () const

isInIdentifierNamespace (unsigned NS) const

hasTagIdentifierNamespace () const

getLexicalDeclContext ()

getLexicalDeclContext - The declaration context where this Decl was lexically declared (LexicalDC).

const DeclContext *

getLexicalDeclContext () const

virtual bool

isOutOfLine () const

Determine whether this declaration is declared out of line (outside its semantic context).

void

setDeclContext (DeclContext *DC)

setDeclContext - Set both the semantic and lexical DeclContext to DC.

void

setLexicalDeclContext (DeclContext *DC)

isTemplated () const

Determine whether this declaration is a templated entity (whether it is.

getTemplateDepth () const

Determine the number of levels of template parameter surrounding this declaration.

isDefinedOutsideFunctionOrMethod () const

isDefinedOutsideFunctionOrMethod - This predicate returns true if this scoped decl is defined outside the current function or method.

isInLocalScopeForInstantiation () const

Determine whether a substitution into this declaration would occur as part of a substitution into a dependent local scope.

const DeclContext *

getParentFunctionOrMethod (bool LexicalParent=false) const

If this decl is defined inside a function/method/block it returns the corresponding DeclContext, otherwise it returns null.

getParentFunctionOrMethod (bool LexicalParent=false)

virtual Decl *

getCanonicalDecl ()

Retrieves the "canonical" declaration of the given declaration.

const Decl *

getCanonicalDecl () const

isCanonicalDecl () const

Whether this particular Decl is a canonical one.

redecl_range

redecls () const

Returns an iterator range for all the redeclarations of the same decl.

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.

const Decl *

getPreviousDecl () const

Retrieve the previous declaration that declares the same entity as this declaration, or NULL if there is no previous declaration.

isFirstDecl () const

True if this is the first declaration in its redeclaration chain.

Decl *

getMostRecentDecl ()

Retrieve the most recent declaration that declares the same entity as this declaration (which may be this declaration).

const Decl *

getMostRecentDecl () const

Retrieve the most recent declaration that declares the same entity as this declaration (which may be this declaration).

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.

virtual bool

hasBody () const

Returns true if this [Decl](classclang%5F1%5F1Decl.html "Decl - This represents one declaration (or definition), e.g.") represents a declaration for a body of code, such as a function or method definition.

getBodyRBrace () const

getBodyRBrace - Gets the right brace of the body, if a body exists.

isTemplateParameter () const

isTemplateParameter - Determines whether this declaration is a template parameter.

isTemplateParameterPack () const

isTemplateParameter - Determines whether this declaration is a template parameter pack.

isParameterPack () const

Whether this declaration is a parameter pack.

isTemplateDecl () const

returns true if this declaration is a template

isFunctionOrFunctionTemplate () const

Whether this declaration is a function or function template.

TemplateDecl *

getDescribedTemplate () const

If this is a declaration that describes some template, this method returns that template declaration.

const TemplateParameterList *

getDescribedTemplateParams () const

If this is a declaration that describes some template or partial specialization, this returns the corresponding template parameter list.

FunctionDecl *

getAsFunction () LLVM_READONLY

Returns the function itself, or the templated function if this is a function template.

const FunctionDecl *

getAsFunction () const

void

setLocalExternDecl ()

Changes the namespace of this declaration to reflect that it's a function-local extern declaration.

isLocalExternDecl () const

Determine whether this is a block-scope declaration with linkage.

void

setObjectOfFriendDecl (bool PerformFriendInjection=false)

Changes the namespace of this declaration to reflect that it's the object of a friend declaration.

void

clearIdentifierNamespace ()

Clears the namespace of this declaration.

FriendObjectKind

getFriendObjectKind () const

Determines whether this declaration is the object of a friend declaration and, if so, what kind.

void

setNonMemberOperator ()

Specifies that this declaration is a C++ overloaded non-member.

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.

isFunctionPointerType () const

Public Member Functions inherited from clang::DeclContext

~DeclContext ()

hasValidDeclKind () const

Decl::Kind

getDeclKind () const

const char *

getDeclKindName () const

getParent ()

getParent - Returns the containing DeclContext.

const DeclContext *

getParent () const

getLexicalParent ()

getLexicalParent - Returns the containing lexical DeclContext.

const DeclContext *

getLexicalParent () const

getLookupParent ()

Find the parent context of this context that will be used for unqualified name lookup.

const DeclContext *

getLookupParent () const

ASTContext &

getParentASTContext () const

isClosure () const

const BlockDecl *

getInnermostBlockDecl () const

Return this DeclContext if it is a BlockDecl.

isObjCContainer () const

isFunctionOrMethod () const

isLookupContext () const

Test whether the context supports looking up names.

isFileContext () const

isTranslationUnit () const

isRecord () const

isRequiresExprBody () const

isNamespace () const

isStdNamespace () const

isInlineNamespace () const

isDependentContext () const

Determines whether this context is dependent on a template parameter.

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.

isExternCContext () const

Determines whether this context or some of its ancestors is a linkage specification context that specifies C linkage.

const LinkageSpecDecl *

getExternCContext () const

Retrieve the nearest enclosing C linkage specification context.

isExternCXXContext () const

Determines whether this context or some of its ancestors is a linkage specification context that specifies C++ linkage.

Equals (const DeclContext *DC) const

Determine whether this declaration context is equivalent to the declaration context DC.

Encloses (const DeclContext *DC) const

Determine whether this declaration context encloses the declaration context DC.

Decl *

getNonClosureAncestor ()

Find the nearest non-closure ancestor of this context, i.e.

const Decl *

getNonClosureAncestor () const

getNonTransparentContext ()

const DeclContext *

getNonTransparentContext () const

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.

const DeclContext *

getPrimaryContext () const

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.

const DeclContext *

getRedeclContext () const

getEnclosingNamespaceContext ()

Retrieve the nearest enclosing namespace context.

const DeclContext *

getEnclosingNamespaceContext () const

RecordDecl *

getOuterLexicalRecordContext ()

Retrieve the outermost lexically enclosing record context.

const RecordDecl *

getOuterLexicalRecordContext () const

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.

void

collectAllContexts (SmallVectorImpl< DeclContext * > &Contexts)

Collects all of the declaration contexts that are semantically connected to this declaration context.

decl_range

decls () const

decls_begin/decls_end - Iterate over the declarations stored in this context.

decls_begin () const

decls_end () const

decls_empty () const

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.

decl_iterator

noload_decls_begin () const

decl_iterator

noload_decls_end () const

void

addDecl (Decl *D)

Add the declaration D into this context.

void

addDeclInternal (Decl *D)

Add the declaration D into this context, but suppress searches for external declarations with the same name.

void

addHiddenDecl (Decl *D)

Add the declaration D to this context without modifying any lookup tables.

void

removeDecl (Decl *D)

Removes a declaration from this context.

containsDecl (Decl *D) const

Checks whether a declaration is in this context.

containsDeclAndLoad (Decl *D) const

Checks whether a declaration is in this context.

lookup_result

lookup (DeclarationName Name) const

lookup - Find the declarations (if any) with the given Name in this context.

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.

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.

void

makeDeclVisibleInContext (NamedDecl *D)

Makes a declaration visible within this context.

lookups_range

lookups () const

lookups_range

noload_lookups (bool PreserveInternalState) const

lookups_begin () const

Iterators over all possible lookups within this context.

lookups_end () const

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.

noload_lookups_end () const

udir_range

using_directives () const

Returns iterator range [First, Last) of UsingDirectiveDecls stored within this context.

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).

StoredDeclsMap *

getLookupPtr () const

Retrieve the internal representation of the lookup structure.

StoredDeclsMap *

buildLookup ()

Ensure the lookup structure is fully-built and return it.