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

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.

SourceLocation

getBodyRBrace () const

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

bool

isTemplateParameter () const

isTemplateParameter - Determines whether this declaration is a template parameter.

bool

isTemplateParameterPack () const

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

bool

isParameterPack () const

Whether this declaration is a parameter pack.

bool

isTemplateDecl () const

returns true if this declaration is a template

bool

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.

bool

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.

bool

isFunctionPointerType () const

Public Member Functions inherited from clang::DeclContext

~DeclContext ()

bool

hasValidDeclKind () const

Decl::Kind

getDeclKind () const

const char *

getDeclKindName () const

DeclContext *

getParent ()

getParent - Returns the containing DeclContext.

const DeclContext *

getParent () const

DeclContext *

getLexicalParent ()

getLexicalParent - Returns the containing lexical DeclContext.

const DeclContext *

getLexicalParent () const

DeclContext *

getLookupParent ()

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

const DeclContext *

getLookupParent () const

ASTContext &

getParentASTContext () const

bool

isClosure () const

const BlockDecl *

getInnermostBlockDecl () const

Return this DeclContext if it is a BlockDecl.

bool

isObjCContainer () const

bool

isFunctionOrMethod () const

bool

isLookupContext () const

Test whether the context supports looking up names.

bool

isFileContext () const

bool

isTranslationUnit () const

bool

isRecord () const

bool

isRequiresExprBody () const

bool

isNamespace () const

bool

isStdNamespace () const

bool

isInlineNamespace () const

bool

isDependentContext () const

Determines whether this context is dependent on a template parameter.

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.

bool

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.

bool

isExternCXXContext () const

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

bool

Equals (const DeclContext *DC) const

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

bool

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

DeclContext *

getNonTransparentContext ()

const DeclContext *

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

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.

const DeclContext *

getRedeclContext () const

DeclContext *

getEnclosingNamespaceContext ()

Retrieve the nearest enclosing namespace context.

const DeclContext *

getEnclosingNamespaceContext () const

RecordDecl *

getOuterLexicalRecordContext ()

Retrieve the outermost lexically enclosing record context.

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.

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.

bool

containsDecl (Decl *D) const

Checks whether a declaration is in this context.

bool

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

all_lookups_iterator

lookups_begin () const

Iterators over all possible lookups within this context.

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.

all_lookups_iterator

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.

bool

hasExternalLexicalStorage () const

Whether this DeclContext has external storage containing additional declarations that are lexically in this context.

void

setHasExternalLexicalStorage (bool ES=true) const

State whether this DeclContext has external storage for declarations lexically in this context.

bool

hasExternalVisibleStorage () const

Whether this DeclContext has external storage containing additional declarations that are visible in this context.

void

setHasExternalVisibleStorage (bool ES=true) const

State whether this DeclContext has external storage for declarations visible in this context.

bool

isDeclInLexicalTraversal (const Decl *D) const

Determine whether the given declaration is stored in the list of declarations lexically within this context.

void

setUseQualifiedLookup (bool use=true) const

bool

shouldUseQualifiedLookup () const

void

dumpAsDecl () const

void

dumpAsDecl (const ASTContext *Ctx) const

void

dumpDeclContext () const

void

dumpLookups () const

void

dumpLookups (llvm::raw_ostream &OS, bool DumpDecls=false, bool Deserialize=false) const

Static Public Member Functions

static ObjCMethodDecl *

Create (ASTContext &C, SourceLocation beginLoc, SourceLocation endLoc, Selector SelInfo, QualType T, TypeSourceInfo *ReturnTInfo, DeclContext *contextDecl, bool isInstance=true, bool isVariadic=false, bool isPropertyAccessor=false, bool isSynthesizedAccessorStub=false, bool isImplicitlyDeclared=false, bool isDefined=false, ObjCImplementationControl impControl=ObjCImplementationControl::None, bool HasRelatedResultType=false)

static ObjCMethodDecl *

CreateDeserialized (ASTContext &C, GlobalDeclID ID)

static bool

classof (const Decl *D)

static bool

classofKind (Kind K)

static DeclContext *

castToDeclContext (const ObjCMethodDecl *D)

static ObjCMethodDecl *

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 bool

isFlexibleArrayMemberLike (ASTContext &Context, const Decl *D, QualType Ty, LangOptions::StrictFlexArraysLevelKind StrictFlexArraysLevel, bool IgnoreTemplateOrMacroSubstitution)

Whether it resembles a flexible array member.

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)

Additional Inherited Members

Protected Types inherited from clang::DeclContext

enum

{ NumOdrHashBits = 25 }

enum

{ NumDeclContextBits = 13 }

Number of bits in DeclContextBitfields. More...

enum

{ NumNamespaceDeclBits = NumDeclContextBits + 2 }

Number of inherited and non-inherited bits in NamespaceDeclBitfields. More...

enum

{ NumTagDeclBits = NumDeclContextBits + 10 }

Number of inherited and non-inherited bits in TagDeclBitfields. More...

enum

{ NumEnumDeclBits = NumTagDeclBits + 20 }

Number of inherited and non-inherited bits in EnumDeclBitfields. More...

enum

{ NumRecordDeclBits = NumTagDeclBits + 41 }

Number of inherited and non-inherited bits in RecordDeclBitfields. More...

enum

{ NumOMPDeclareReductionDeclBits = NumDeclContextBits + 2 }

Number of inherited and non-inherited bits in OMPDeclareReductionDeclBitfields. More...

enum

{ NumFunctionDeclBits = NumDeclContextBits + 31 }

Number of inherited and non-inherited bits in FunctionDeclBitfields. More...

enum

{ NumCXXConstructorDeclBits = NumFunctionDeclBits + 20 }

Number of inherited and non-inherited bits in CXXConstructorDeclBitfields. More...

enum

{ NumObjCMethodDeclBits = NumDeclContextBits + 24 }

Number of inherited and non-inherited bits in ObjCMethodDeclBitfields. More...

enum

{ NumObjCContainerDeclBits = 64 }

Number of inherited and non-inherited bits in ObjCContainerDeclBitfields. More...

enum

{ NumLinkageSpecDeclBits = NumDeclContextBits + 4 }

Number of inherited and non-inherited bits in LinkageSpecDeclBitfields. More...

enum

{ NumBlockDeclBits = NumDeclContextBits + 5 }

Number of inherited and non-inherited bits in BlockDeclBitfields. More...

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, GlobalDeclID ID, std::size_t Extra=0)

Allocate memory for a deserialized declaration.

void *

operator new (std::size_t Size, const ASTContext &Ctx, DeclContext *Parent, std::size_t Extra=0)

Allocate memory for a non-deserialized declaration.

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.

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.

bool

hasLocalOwningModuleStorage () const

virtual Decl *

getNextRedeclarationImpl ()

Returns the next redeclaration or itself if this is the only decl.

virtual Decl *

getPreviousDeclImpl ()

Implementation of getPreviousDecl(), to be overridden by any subclass that has a redeclaration chain.

virtual Decl *

getMostRecentDeclImpl ()

Implementation of getMostRecentDecl(), to be overridden by any subclass that has a redeclaration chain.

ASTMutationListener *

getASTMutationListener () const

Protected Member Functions inherited from clang::DeclContext

DeclContext (Decl::Kind K)

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.

Protected Attributes inherited from clang::Decl

llvm::PointerIntPair< Decl *, 3, ModuleOwnershipKind >

NextInContextAndBits

The next declaration within the same lexical DeclContext.

unsigned

Access: 2

Access - Used by C++ decls for the access specifier.

unsigned

FromASTFile: 1

Whether this declaration was loaded from an AST file.

unsigned

IdentifierNamespace: 14

IdentifierNamespace - This specifies what IDNS_* namespace this lives in.

unsigned

CacheValidAndLinkage: 3

If 0, we have not computed the linkage of this declaration.

Protected Attributes inherited from clang::DeclContext

StoredDeclsMap *

LookupPtr = nullptr

Pointer to the data structure used to lookup declarations within this context (or a DependentStoredDeclsMap if this is a dependent context).

union {

DeclContextBitfields DeclContextBits

NamespaceDeclBitfields NamespaceDeclBits

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.

Decl *

FirstDecl = nullptr

FirstDecl - The first declaration stored within this declaration context.

Decl *

LastDecl = nullptr

LastDecl - The last declaration stored within this declaration context.

ObjCMethodDecl - Represents an instance or class method declaration.

ObjC methods can be declared within 4 contexts: class interfaces, categories, protocols, and class implementations. While C++ member functions leverage C syntax, Objective-C method syntax is modeled after Smalltalk (using colons to specify argument types/expressions). Here are some brief examples:

Setter/getter instance methods:

(void)setMenu:(NSMenu *)menu;
(NSMenu *)menu;

Instance method that takes 2 NSView arguments:

(void)replaceSubview:(NSView *)oldView with:(NSView *)newView;

Getter class method:

(NSMenu *)defaultMenu;

A selector represents a unique name for a method. The selector names for the above methods are setMenu:, menu, replaceSubview:with:, and defaultMenu.

Definition at line 140 of file DeclObjC.h.