clang  6.0.0svn
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
clang::FriendDecl Class Referencefinal

FriendDecl - Represents the declaration of a friend entity, which can be a function, a type, or a templated function or type. More...

#include "clang/AST/DeclFriend.h"

Inheritance diagram for clang::FriendDecl:
Inheritance graph
[legend]
Collaboration diagram for clang::FriendDecl:
Collaboration graph
[legend]

Public Types

typedef llvm::PointerUnion< NamedDecl *, TypeSourceInfo * > FriendUnion
 
- 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
}
 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 }
 
typedef AttrVec::const_iterator attr_iterator
 
typedef llvm::iterator_range< attr_iteratorattr_range
 
typedef llvm::iterator_range< redecl_iteratorredecl_range
 

Public Member Functions

TypeSourceInfogetFriendType () const
 If this friend declaration names an (untemplated but possibly dependent) type, return the type; otherwise return null. More...
 
unsigned getFriendTypeNumTemplateParameterLists () const
 
TemplateParameterListgetFriendTypeTemplateParameterList (unsigned N) const
 
NamedDeclgetFriendDecl () const
 If this friend declaration doesn't name a type, return the inner declaration. More...
 
SourceLocation getFriendLoc () const
 Retrieves the location of the 'friend' keyword. More...
 
SourceRange getSourceRange () const override LLVM_READONLY
 Retrieves the source range for the friend declaration. More...
 
bool isUnsupportedFriend () const
 Determines if this friend kind is unsupported. More...
 
void setUnsupportedFriend (bool Unsupported)
 
- Public Member Functions inherited from clang::Decl
SourceLocation getLocStart () const LLVM_READONLY
 
SourceLocation getLocEnd () const LLVM_READONLY
 
SourceLocation getLocation () const
 
void setLocation (SourceLocation L)
 
Kind getKind () const
 
const char * getDeclKindName () const
 
DeclgetNextDeclInContext ()
 
const DeclgetNextDeclInContext () const
 
DeclContextgetDeclContext ()
 
const DeclContextgetDeclContext () const
 
DeclgetNonClosureContext ()
 Find the innermost non-closure ancestor of this declaration, walking up through blocks, lambdas, etc. More...
 
const DeclgetNonClosureContext () const
 
TranslationUnitDeclgetTranslationUnitDecl ()
 
const TranslationUnitDeclgetTranslationUnitDecl () const
 
bool isInAnonymousNamespace () const
 
bool isInStdNamespace () const
 
ASTContextgetASTContext () 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)
 
AttrVecgetAttrs ()
 
const AttrVecgetAttrs () 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 isExported () const
 Whether this declaration is exported (by virtue of being lexically within an ExportDecl or by being a NamespaceDecl). 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 AttrgetDefiningAttr () const
 Return this declaration's defining attribute if it has one. More...
 
AvailabilityResult getAvailability (std::string *Message=nullptr, VersionTuple EnclosingVersion=VersionTuple()) 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...
 
ModulegetImportedOwningModule () const
 Get the imported owning module, if this decl is from an imported (non-local) module. More...
 
ModulegetLocalOwningModule () const
 Get the local owning module, if known. More...
 
void setLocalOwningModule (Module *M)
 
bool hasOwningModule () const
 Is this declaration owned by some module? More...
 
ModulegetOwningModule () const
 Get the module that owns this declaration. 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
 
DeclContextgetLexicalDeclContext ()
 getLexicalDeclContext - The declaration context where this Decl was lexically declared (LexicalDC). More...
 
const DeclContextgetLexicalDeclContext () 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 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 DeclContextgetParentFunctionOrMethod () const
 If this decl is defined inside a function/method/block it returns the corresponding DeclContext, otherwise it returns null. More...
 
DeclContextgetParentFunctionOrMethod ()
 
virtual DeclgetCanonicalDecl ()
 Retrieves the "canonical" declaration of the given declaration. More...
 
const DeclgetCanonicalDecl () 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
 
DeclgetPreviousDecl ()
 Retrieve the previous declaration that declares the same entity as this declaration, or NULL if there is no previous declaration. More...
 
const DeclgetPreviousDecl () const
 Retrieve the most recent 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...
 
DeclgetMostRecentDecl ()
 Retrieve the most recent declaration that declares the same entity as this declaration (which may be this declaration). More...
 
const DeclgetMostRecentDecl () const
 Retrieve the most recent declaration that declares the same entity as this declaration (which may be this declaration). More...
 
virtual StmtgetBody () 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...
 
TemplateDeclgetDescribedTemplate () const
 If this is a declaration that describes some template, this method returns that template declaration. More...
 
FunctionDeclgetAsFunction () LLVM_READONLY
 Returns the function itself, or the templated function if this is a function template. More...
 
const FunctionDeclgetAsFunction () 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) const
 
const FunctionTypegetFunctionType (bool BlocksToo=true) const
 Looks through the Decl's underlying type to extract a FunctionType when possible. More...
 

Static Public Member Functions

static FriendDeclCreate (ASTContext &C, DeclContext *DC, SourceLocation L, FriendUnion Friend_, SourceLocation FriendL, ArrayRef< TemplateParameterList *> FriendTypeTPLists=None)
 
static FriendDeclCreateDeserialized (ASTContext &C, unsigned ID, unsigned FriendTypeNumTPLists)
 
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 DeclContextcastToDeclContext (const Decl *)
 
static DeclcastFromDeclContext (const DeclContext *)
 
static void printGroup (Decl **Begin, unsigned NumDecls, raw_ostream &Out, const PrintingPolicy &Policy, unsigned Indentation=0)
 

Public Attributes

friend TrailingObjects
 

Friends

class CXXRecordDecl::friend_iterator
 
class CXXRecordDecl
 
class ASTDeclReader
 
class ASTDeclWriter
 
class ASTNodeImporter
 

Additional Inherited Members

- 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
 
virtual DeclgetNextRedeclarationImpl ()
 Returns the next redeclaration or itself if this is the only decl. More...
 
virtual DeclgetPreviousDeclImpl ()
 Implementation of getPreviousDecl(), to be overridden by any subclass that has a redeclaration chain. More...
 
virtual DeclgetMostRecentDeclImpl ()
 Implementation of getMostRecentDecl(), to be overridden by any subclass that has a redeclaration chain. More...
 
ASTMutationListenergetASTMutationListener () const
 
- Protected Attributes inherited from clang::Decl
llvm::PointerIntPair< Decl *, 2, ModuleOwnershipKindNextInContextAndBits
 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: 13
 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...
 

Detailed Description

FriendDecl - Represents the declaration of a friend entity, which can be a function, a type, or a templated function or type.

template <typename T> class A {
friend int foo(T);
friend class B;
friend T; // only in C++0x
template <typename U> friend class C;
template <typename U> friend A& operator+=(A&, const U&) { ... }
};

The semantic context of a friend decl is its declaring class.

Definition at line 40 of file DeclFriend.h.

Member Typedef Documentation

◆ FriendUnion

Definition at line 45 of file DeclFriend.h.

Member Function Documentation

◆ classof()

static bool clang::FriendDecl::classof ( const Decl D)
inlinestatic

Definition at line 165 of file DeclFriend.h.

References classofKind(), and clang::Decl::getKind().

◆ classofKind()

static bool clang::FriendDecl::classofKind ( Kind  K)
inlinestatic

Definition at line 166 of file DeclFriend.h.

Referenced by classof().

◆ Create()

FriendDecl * FriendDecl::Create ( ASTContext C,
DeclContext DC,
SourceLocation  L,
FriendUnion  Friend_,
SourceLocation  FriendL,
ArrayRef< TemplateParameterList *>  FriendTypeTPLists = None 
)
static

◆ CreateDeserialized()

FriendDecl * FriendDecl::CreateDeserialized ( ASTContext C,
unsigned  ID,
unsigned  FriendTypeNumTPLists 
)
static

Definition at line 58 of file DeclFriend.cpp.

References AttributeLangSupport::C.

◆ getFriendDecl()

NamedDecl* clang::FriendDecl::getFriendDecl ( ) const
inline

If this friend declaration doesn't name a type, return the inner declaration.

Definition at line 121 of file DeclFriend.h.

Referenced by getSourceRange(), clang::ASTDeclWriter::VisitFriendDecl(), and ODRDeclVisitor::VisitFriendDecl().

◆ getFriendLoc()

SourceLocation clang::FriendDecl::getFriendLoc ( ) const
inline

Retrieves the location of the 'friend' keyword.

Definition at line 126 of file DeclFriend.h.

Referenced by getSourceRange().

◆ getFriendType()

TypeSourceInfo* clang::FriendDecl::getFriendType ( ) const
inline

If this friend declaration names an (untemplated but possibly dependent) type, return the type; otherwise return null.

This is used for elaborated-type-specifiers and, in C++0x, for arbitrary friend type declarations.

Definition at line 108 of file DeclFriend.h.

Referenced by getSourceRange(), clang::ASTDeclWriter::VisitFriendDecl(), and ODRDeclVisitor::VisitFriendDecl().

◆ getFriendTypeNumTemplateParameterLists()

unsigned clang::FriendDecl::getFriendTypeNumTemplateParameterLists ( ) const
inline

Definition at line 111 of file DeclFriend.h.

◆ getFriendTypeTemplateParameterList()

TemplateParameterList* clang::FriendDecl::getFriendTypeTemplateParameterList ( unsigned  N) const
inline

Definition at line 114 of file DeclFriend.h.

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

◆ getSourceRange()

SourceRange clang::FriendDecl::getSourceRange ( ) const
inlineoverridevirtual

Retrieves the source range for the friend declaration.

Reimplemented from clang::Decl.

Definition at line 131 of file DeclFriend.h.

References getFriendDecl(), getFriendLoc(), getFriendType(), and clang::Decl::getLocation().

◆ isUnsupportedFriend()

bool clang::FriendDecl::isUnsupportedFriend ( ) const
inline

Determines if this friend kind is unsupported.

Definition at line 157 of file DeclFriend.h.

◆ setUnsupportedFriend()

void clang::FriendDecl::setUnsupportedFriend ( bool  Unsupported)
inline

Definition at line 160 of file DeclFriend.h.

References clang::driver::options::Unsupported.

Friends And Related Function Documentation

◆ ASTDeclReader

friend class ASTDeclReader
friend

Definition at line 168 of file DeclFriend.h.

◆ ASTDeclWriter

friend class ASTDeclWriter
friend

Definition at line 169 of file DeclFriend.h.

◆ ASTNodeImporter

friend class ASTNodeImporter
friend

Definition at line 170 of file DeclFriend.h.

◆ CXXRecordDecl

friend class CXXRecordDecl
friend

Definition at line 68 of file DeclFriend.h.

◆ CXXRecordDecl::friend_iterator

friend class CXXRecordDecl::friend_iterator
friend

Definition at line 67 of file DeclFriend.h.

Member Data Documentation

◆ TrailingObjects

friend clang::FriendDecl::TrailingObjects

Definition at line 171 of file DeclFriend.h.


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