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

Public Types

enum

SetterKind { Assign, Retain, Copy, Weak }

enum

PropertyControl { None, Required, Optional }

Public Types inherited from clang::NamedDecl

enum

ExplicitVisibilityKind { VisibilityForType, VisibilityForValue }

Kinds of explicit visibility. More...

Public Types inherited from clang::Decl

enum

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 class

ModuleOwnershipKind : unsigned char {
Unowned, Visible, VisibleWhenImported, ReachableWhenImported,
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 Member Functions

getAtLoc () const

void

setAtLoc (SourceLocation L)

getLParenLoc () const

void

setLParenLoc (SourceLocation L)

TypeSourceInfo *

getTypeSourceInfo () const

getType () const

void

setType (QualType T, TypeSourceInfo *TSI)

getUsageType (QualType objectType) const

Retrieve the type when this property is used with a specific base object type.

ObjCPropertyAttribute::Kind

getPropertyAttributes () const

void

setPropertyAttributes (ObjCPropertyAttribute::Kind PRVal)

void

overwritePropertyAttributes (unsigned PRVal)

ObjCPropertyAttribute::Kind

getPropertyAttributesAsWritten () const

void

setPropertyAttributesAsWritten (ObjCPropertyAttribute::Kind PRVal)

isReadOnly () const

isReadOnly - Return true iff the property has a setter.

isAtomic () const

isAtomic - Return true if the property is atomic.

isRetaining () const

isRetaining - Return true if the property retains its value.

isInstanceProperty () const

isClassProperty () const

isDirectProperty () const

ObjCPropertyQueryKind

getQueryKind () const

getSetterKind () const

getSetterKind - Return the method used for doing assignment in the property setter.

getGetterName () const

getGetterNameLoc () const

void

setGetterName (Selector Sel, SourceLocation Loc=SourceLocation())

getSetterName () const

getSetterNameLoc () const

void

setSetterName (Selector Sel, SourceLocation Loc=SourceLocation())

ObjCMethodDecl *

getGetterMethodDecl () const

void

setGetterMethodDecl (ObjCMethodDecl *gDecl)

ObjCMethodDecl *

getSetterMethodDecl () const

void

setSetterMethodDecl (ObjCMethodDecl *gDecl)

void

setPropertyImplementation (PropertyControl pc)

PropertyControl

getPropertyImplementation () const

isOptional () const

void

setPropertyIvarDecl (ObjCIvarDecl *Ivar)

getPropertyIvarDecl () const

getSourceRange () const override LLVM_READONLY

Source range that this declaration covers.

IdentifierInfo *

getDefaultSynthIvarName (ASTContext &Ctx) const

Get the default name of the synthesized ivar.

Public Member Functions inherited from clang::NamedDecl

IdentifierInfo *

getIdentifier () const

Get the identifier that names this declaration, if there is one.

StringRef

getName () const

Get the name of identifier for this declaration as a StringRef.

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

virtual void

printName (raw_ostream &OS, const PrintingPolicy &Policy) const

Pretty-print the unqualified name of this declaration.

void

printName (raw_ostream &OS) const

Calls printName() with the ASTContext printing policy from the decl.

DeclarationName

getDeclName () const

Get the actual, stored name of the declaration, which may be a special name.

void

setDeclName (DeclarationName N)

Set the name of this declaration.

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.

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.

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.

declarationReplaces (const 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.

hasLinkage () const

Determine whether this declaration has linkage.

isCXXClassMember () const

Determine whether this declaration is a C++ class member.

isCXXInstanceMember () const

Determine whether the given declaration is an instance member of a C++ class.

ReservedIdentifierStatus

isReserved (const LangOptions &LangOpts) const

Determine if the declaration obeys the reserved identifier rules of the given language.

getLinkageInternal () const

Determine what kind of linkage this entity has.

getFormalLinkage () const

Get the linkage from a semantic point of view.

hasExternalFormalLinkage () const

True if this decl has external linkage.

isExternallyVisible () const

isExternallyDeclarable () const

Determine whether this declaration can be redeclared in a different translation unit.

getVisibility () const

Determines the visibility of this entity.

getLinkageAndVisibility () const

Determines the linkage and visibility of this entity.

std::optional< Visibility >

getExplicitVisibility (ExplicitVisibilityKind kind) const

If visibility was explicitly specified for this declaration, return that visibility.

isLinkageValid () const

True if the computed linkage is valid.

hasLinkageBeenComputed () const

True if something has required us to compute the linkage of this declaration.

isPlaceholderVar (const LangOptions &LangOpts) const

getUnderlyingDecl ()

Looks through UsingDecls and ObjCCompatibleAliasDecls for the underlying named decl.

const NamedDecl *

getUnderlyingDecl () const

getMostRecentDecl ()

const NamedDecl *

getMostRecentDecl () const

ObjCStringFormatFamily

getObjCFStringFormattingFamily () const

isModulePrivate () const

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

void

setModulePrivate ()

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

Public Member Functions inherited from clang::Decl

Decl ()=delete

Decl (const Decl &)=delete

Decl (Decl &&)=delete

operator= (const Decl &)=delete

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)

getKind () const

const char *

getDeclKindName () const

getNextDeclInContext ()

const Decl *

getNextDeclInContext () const

getDeclContext ()

const DeclContext *

getDeclContext () const

getNonTransparentDeclContext ()

Return the non transparent context.

const DeclContext *

getNonTransparentDeclContext () const

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

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)

const AttrVec &

getAttrs () const

void

void

addAttr (Attr *A)

attrs () const

attr_begin () const

attr_end () const

template<typename... Ts>

void

template<typename T >

void

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

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.

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.

isReachable () const

void

setVisibleDespiteOwningModule ()

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.

redecls () const

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

redecl_iterator

redecls_begin () const

redecl_iterator

redecls_end () const

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.

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.

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.

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

Static Public Member Functions

static ObjCPropertyDecl *

Create (ASTContext &C, DeclContext *DC, SourceLocation L, const IdentifierInfo *Id, SourceLocation AtLocation, SourceLocation LParenLocation, QualType T, TypeSourceInfo *TSI, PropertyControl propControl=None)

static ObjCPropertyDecl *

CreateDeserialized (ASTContext &C, GlobalDeclID ID)

static ObjCPropertyQueryKind

getQueryKind (bool isClassProperty)

static ObjCPropertyDecl *

findPropertyDecl (const DeclContext *DC, const IdentifierInfo *propertyID, ObjCPropertyQueryKind queryKind)

Lookup a property by name in the specified DeclContext.

static bool

classof (const Decl *D)

static bool

classofKind (Kind K)

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

static void

EnableStatistics ()

static void

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)

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, 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

void

updateOutOfDate (IdentifierInfo &II) const

Update a potentially out-of-date declaration.

getCachedLinkage () const

void

setCachedLinkage (Linkage L) const

hasCachedLinkage () const

void

setModulePrivate ()

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

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 Attributes inherited from clang::Decl

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

NextInContextAndBits

The next declaration within the same lexical DeclContext.

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

Whether this declaration was loaded from an AST file.

IdentifierNamespace: 14

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

CacheValidAndLinkage: 3

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

Represents one property declaration in an Objective-C interface.

For example:

\@property (assign, readwrite) int MyProperty;

Definition at line 730 of file DeclObjC.h.