Class FriendDecl::FriendDecl

A C++ friend declaration [N4140 11.3]. For example the two friend declarations in class A of the following code:

class A {
  friend void f(int);
  friend class X;
};

void f(int x) { ... }
class X { ... };

Direct supertypes

Indirect supertypes

Predicates

getADeclarationLocation

Gets the location of this friend declaration. The result is the location of the friend declaration itself, not the class or function that it refers to. Note: to get the target of the friend declaration, use getFriend.

getASpecifier

Friend declarations do not have specifiers. It makes no difference whether they are declared in a public, protected or private section of the class.

getCanonicalQLClass

Canonical QL class corresponding to this element.

getDeclaringClass

Gets the declaring class (also known as the befriending class). For example: A in class A { friend class X }.

getDefinitionLocation

Implements the abstract method Declaration.getDefinitionLocation. A friend declaration cannot be a definition because it is only a link to another class or function. But we have to provide an implementation of this method, so we use the location of the declaration as the location of the definition. Note: to get the target of the friend declaration, use getFriend.

getFriend

Gets the target of this friend declaration. For example: X in class A { friend class X }.

getLocation

Gets the location of this friend declaration.

getName

Gets a descriptive string for this friend declaration.

isTopLevel

Holds if this declaration is a top-level declaration.

Inherited predicates

findRootCause

Gets the source of this element: either itself or a macro that expanded to this element.

from Element
fromLibrary

Holds if this element may be from a library.

from Element
fromSource

Holds if this element may be from source.

from Element
getADeclarationEntry

Gets a declaration entry corresponding to this declaration. See the comment above this class for an explanation of the relationship between Declaration and DeclarationEntry.

from Declaration
getAFile

Gets a file where this element occurs.

from Declaration
getATemplateArgument

Gets a template argument used to instantiate this declaration from a template. When called on a template, this will return a template parameter.

from Declaration
getDeclaringType

Gets the class where this member is declared, if it is a member. For templates, both the template itself and all instantiations of the template are considered to have the same declaring class.

from Declaration
getDefinition

Gets the declaration entry corresponding to this declaration that is a definition, if any.

from Declaration
getEnclosingElement

Gets the closest Element enclosing this one.

from Element
getFile

Gets the primary file where this element occurs.

from Element
getNamespace

Gets the innermost namespace which contains this declaration.

from Declaration
getNumberOfTemplateArguments

Gets the number of template arguments for this declaration.

from Declaration
getParentScope

Gets the parent scope of this Element, if any. A scope is a Type (Class / Enum), a Namespace, a Block, a Function, or certain kinds of Statement.

from Element
getQualifiedName

Gets the name of the declaration, fully qualified with its namespace and declaring type.

from Declaration
getTemplateArgument

Gets the ith template argument used to instantiate this declaration from a template. When called on a template, this will return the ith template parameter.

from Declaration
hasDeclaringType

Holds if this declaration is a member of a class/struct/union.

from Declaration
hasDefinition

Holds if the declaration has a definition.

from Declaration
hasGlobalName

Holds if this declaration has the given name in the global namespace.

from Declaration
hasName

Holds if this declaration has the given name.

from Declaration
hasQualifiedName

DEPRECATED: Prefer hasGlobalName or the 2-argument or 3-argument hasQualifiedName predicates. To get the exact same results as this predicate in all edge cases, use getQualifiedName().

from Declaration
hasQualifiedName

Holds if this declaration has a fully-qualified name with a name-space component of namespaceQualifier, a declaring type of typeQualifier, and a base name of baseName. Template parameters and arguments are stripped from all components. Missing components are "".

from Declaration
hasQualifiedName

Holds if this declaration has a fully-qualified name with a name-space component of namespaceQualifier, no declaring type, and a base name of baseName.

from Declaration
hasSpecifier

Holds if this declaration has a specifier with the given name.

from Declaration
isAffectedByMacro

Holds if this element is affected in any way by a macro. All elements that are totally or partially generated by a macro are included, so this is a super-set of isInMacroExpansion.

from Element
isDefinedfrom Declaration
isFromTemplateInstantiation

Holds if this Element is a part of a template instantiation (but not the template itself).

from Element
isFromUninstantiatedTemplate

Holds if this Element is part of a template template (not if it is part of an instantiation of template). This means it is represented in the database purely as syntax and without guarantees on the presence or correctness of type-based operations such as implicit conversions.

from Element
isInMacroExpansion

Holds if this element comes from a macro expansion. Only elements that are entirely generated by a macro are included - for elements that partially come from a macro, see isAffectedByMacro.

from Element
isMember

Holds if this declaration is a member of a class/struct/union.

from Declaration
isStatic

Holds if this declaration is static.

from Declaration
toString

Gets a textual representation of this element.

from Declaration