clang API Documentation

Public Member Functions
clang::CXXScopeSpec Class Reference

Represents a C++ nested-name-specifier or a global scope specifier. More...

#include <DeclSpec.h>

List of all members.

Public Member Functions

const SourceRangegetRange () const
void setRange (const SourceRange &R)
void setBeginLoc (SourceLocation Loc)
void setEndLoc (SourceLocation Loc)
SourceLocation getBeginLoc () const
SourceLocation getEndLoc () const
NestedNameSpecifiergetScopeRep () const
 Retrieve the representation of the nested-name-specifier.
void Extend (ASTContext &Context, SourceLocation TemplateKWLoc, TypeLoc TL, SourceLocation ColonColonLoc)
 Extend the current nested-name-specifier by another nested-name-specifier component of the form 'type::'.
void Extend (ASTContext &Context, IdentifierInfo *Identifier, SourceLocation IdentifierLoc, SourceLocation ColonColonLoc)
 Extend the current nested-name-specifier by another nested-name-specifier component of the form 'identifier::'.
void Extend (ASTContext &Context, NamespaceDecl *Namespace, SourceLocation NamespaceLoc, SourceLocation ColonColonLoc)
 Extend the current nested-name-specifier by another nested-name-specifier component of the form 'namespace::'.
void Extend (ASTContext &Context, NamespaceAliasDecl *Alias, SourceLocation AliasLoc, SourceLocation ColonColonLoc)
 Extend the current nested-name-specifier by another nested-name-specifier component of the form 'namespace-alias::'.
void MakeGlobal (ASTContext &Context, SourceLocation ColonColonLoc)
 Turn this (empty) nested-name-specifier into the global nested-name-specifier '::'.
void MakeSuper (ASTContext &Context, CXXRecordDecl *RD, SourceLocation SuperLoc, SourceLocation ColonColonLoc)
 Turns this (empty) nested-name-specifier into '__super' nested-name-specifier.
void MakeTrivial (ASTContext &Context, NestedNameSpecifier *Qualifier, SourceRange R)
 Make a new nested-name-specifier from incomplete source-location information.
void Adopt (NestedNameSpecifierLoc Other)
 Adopt an existing nested-name-specifier (with source-range information).
NestedNameSpecifierLoc getWithLocInContext (ASTContext &Context) const
 Retrieve a nested-name-specifier with location information, copied into the given AST context.
SourceLocation getLastQualifierNameLoc () const
 Retrieve the location of the name in the last qualifier in this nested name specifier.
bool isEmpty () const
 No scope specifier.
bool isNotEmpty () const
 A scope specifier is present, but may be valid or invalid.
bool isInvalid () const
 An error occurred during parsing of the scope specifier.
bool isValid () const
 A scope specifier is present, and it refers to a real scope.
void SetInvalid (SourceRange R)
 Indicate that this nested-name-specifier is invalid.
bool isSet () const
void clear ()
char * location_data () const
 Retrieve the data associated with the source-location information.
unsigned location_size () const
 Retrieve the size of the data associated with source-location information.

Detailed Description

Represents a C++ nested-name-specifier or a global scope specifier.

These can be in 3 states: 1) Not present, identified by isEmpty() 2) Present, identified by isNotEmpty() 2.a) Valid, idenified by isValid() 2.b) Invalid, identified by isInvalid().

isSet() is deprecated because it mostly corresponded to "valid" but was often used as if it meant "present".

The actual scope is described by getScopeRep().

Definition at line 67 of file DeclSpec.h.


Member Function Documentation

void clang::CXXScopeSpec::clear ( ) [inline]
void CXXScopeSpec::Extend ( ASTContext Context,
SourceLocation  TemplateKWLoc,
TypeLoc  TL,
SourceLocation  ColonColonLoc 
)

Extend the current nested-name-specifier by another nested-name-specifier component of the form 'type::'.

Parameters:
ContextThe AST context in which this nested-name-specifier resides.
TemplateKWLocThe location of the 'template' keyword, if present.
TLThe TypeLoc that describes the type preceding the '::'.
ColonColonLocThe location of the trailing '::'.

Definition at line 57 of file DeclSpec.cpp.

References clang::NestedNameSpecifierLocBuilder::Extend(), clang::SourceRange::getBegin(), clang::TypeLoc::getBeginLoc(), clang::NestedNameSpecifierLocBuilder::getSourceRange(), clang::SourceLocation::isInvalid(), clang::SourceRange::setBegin(), and clang::SourceRange::setEnd().

Referenced by clang::Sema::ActOnCXXNestedNameSpecifier(), clang::Sema::ActOnCXXNestedNameSpecifierDecltype(), clang::Sema::BuildCXXNestedNameSpecifier(), and clang::TreeTransform< Derived >::RebuildCXXPseudoDestructorExpr().

void CXXScopeSpec::Extend ( ASTContext Context,
IdentifierInfo Identifier,
SourceLocation  IdentifierLoc,
SourceLocation  ColonColonLoc 
)

Extend the current nested-name-specifier by another nested-name-specifier component of the form 'identifier::'.

Parameters:
ContextThe AST context in which this nested-name-specifier resides.
IdentifierThe identifier.
IdentifierLocThe location of the identifier.
ColonColonLocThe location of the trailing '::'.

Definition at line 68 of file DeclSpec.cpp.

References clang::NestedNameSpecifierLocBuilder::Extend(), clang::SourceRange::getBegin(), clang::NestedNameSpecifierLocBuilder::getSourceRange(), clang::SourceLocation::isInvalid(), clang::SourceRange::setBegin(), and clang::SourceRange::setEnd().

void CXXScopeSpec::Extend ( ASTContext Context,
NamespaceDecl Namespace,
SourceLocation  NamespaceLoc,
SourceLocation  ColonColonLoc 
)

Extend the current nested-name-specifier by another nested-name-specifier component of the form 'namespace::'.

Parameters:
ContextThe AST context in which this nested-name-specifier resides.
NamespaceThe namespace.
NamespaceLocThe location of the namespace name.
ColonColonLocThe location of the trailing '::'.

Definition at line 81 of file DeclSpec.cpp.

References clang::NestedNameSpecifierLocBuilder::Extend(), clang::SourceRange::getBegin(), clang::NestedNameSpecifierLocBuilder::getSourceRange(), clang::SourceLocation::isInvalid(), clang::SourceRange::setBegin(), and clang::SourceRange::setEnd().

void CXXScopeSpec::Extend ( ASTContext Context,
NamespaceAliasDecl Alias,
SourceLocation  AliasLoc,
SourceLocation  ColonColonLoc 
)

Extend the current nested-name-specifier by another nested-name-specifier component of the form 'namespace-alias::'.

Parameters:
ContextThe AST context in which this nested-name-specifier resides.
AliasThe namespace alias.
AliasLocThe location of the namespace alias name.
ColonColonLocThe location of the trailing '::'.

Definition at line 94 of file DeclSpec.cpp.

References clang::NestedNameSpecifierLocBuilder::Extend(), clang::SourceRange::getBegin(), clang::NestedNameSpecifierLocBuilder::getSourceRange(), clang::SourceLocation::isInvalid(), clang::SourceRange::setBegin(), and clang::SourceRange::setEnd().

Definition at line 77 of file DeclSpec.h.

References clang::SourceRange::getEnd().

Retrieve the location of the name in the last qualifier in this nested name specifier.

For example, the location of bar in

  ///   \::foo::bar<0>::
  ///           ^~~
  /// 

Definition at line 146 of file DeclSpec.cpp.

References clang::NestedNameSpecifierLoc::getLocalBeginLoc(), clang::NestedNameSpecifierLocBuilder::getRepresentation(), and clang::NestedNameSpecifierLocBuilder::getTemporary().

Referenced by clang::Sema::RequireCompleteDeclContext().

const SourceRange& clang::CXXScopeSpec::getRange ( ) const [inline]

Definition at line 72 of file DeclSpec.h.

Referenced by clang::Sema::ActOnCXXMemberDeclarator(), clang::Sema::ActOnCXXNestedNameSpecifier(), clang::Sema::ActOnDependentTag(), clang::Sema::ActOnExceptionDeclarator(), clang::Sema::ActOnExplicitInstantiation(), clang::Sema::ActOnFriendFunctionDecl(), clang::Sema::ActOnFunctionDeclarator(), clang::Sema::ActOnNamespaceAliasDef(), clang::Sema::ActOnObjCExceptionDecl(), clang::Sema::ActOnParamDeclarator(), clang::Sema::ActOnTag(), clang::Sema::ActOnTemplatedFriendTag(), clang::Sema::ActOnTypedefDeclarator(), clang::Sema::ActOnUsingDeclaration(), clang::Sema::ActOnUsingDirective(), clang::Sema::ActOnVariableDeclarator(), clang::Sema::BuildCXXNestedNameSpecifier(), clang::Sema::BuildDeclarationNameExpr(), clang::Sema::BuildImplicitMemberExpr(), clang::Sema::BuildMemberReferenceExpr(), clang::Sema::BuildQualifiedDeclarationNameExpr(), clang::Sema::BuildQualifiedTemplateIdExpr(), clang::Sema::BuildUsingDeclaration(), clang::Sema::CheckClassTemplate(), clang::Sema::CheckUsingDeclQualifier(), clang::Sema::CheckUsingDeclRedeclaration(), diagnoseInstanceReference(), clang::Sema::diagnoseQualifiedDeclaration(), DiagnoseQualifiedMemberReference(), clang::Sema::DiagnoseUnexpandedParameterPack(), clang::Sema::DiagnoseUnknownTypeName(), GetFullTypeForDeclarator(), clang::Sema::HandleDeclarator(), clang::Sema::isNonTypeNestedNameSpecifier(), LookupMemberExpr(), LookupMemberExprInRecord(), clang::Sema::LookupParsedName(), clang::Sema::ParsedFreeStandingDeclSpec(), clang::Sema::RebuildNestedNameSpecifierInCurrentInstantiation(), clang::Sema::RequireCompleteDeclContext(), and clang::Parser::TryAnnotateTypeOrScopeToken().

Retrieve the representation of the nested-name-specifier.

Definition at line 80 of file DeclSpec.h.

References clang::NestedNameSpecifierLocBuilder::getRepresentation().

Referenced by clang::Sema::ActOnCXXNestedNameSpecifier(), clang::Sema::ActOnDependentTag(), clang::Sema::ActOnDependentTemplateName(), clang::Sema::ActOnFriendFunctionDecl(), clang::Sema::ActOnFunctionDeclarator(), clang::Sema::ActOnMemberAccessExpr(), clang::Sema::ActOnTagTemplateIdType(), clang::Sema::ActOnTemplatedFriendTag(), clang::Sema::ActOnTemplateIdType(), clang::Sema::ActOnTypenameType(), clang::Sema::ActOnUsingDirective(), BuildFieldReferenceExpr(), clang::Sema::BuildMemInitializer(), clang::Sema::BuildQualifiedDeclarationNameExpr(), clang::Sema::BuildQualifiedTemplateIdExpr(), clang::Sema::CheckClassTemplate(), clang::Sema::checkLiteralOperatorId(), clang::Sema::CheckTemplateTypeArgument(), clang::Sema::CheckTypenameType(), clang::Sema::CheckUsingDeclQualifier(), clang::Sema::CheckUsingDeclRedeclaration(), clang::Sema::ClassifyName(), clang::Sema::CodeCompleteQualifiedId(), clang::Sema::collectUnexpandedParameterPacks(), clang::Sema::computeDeclContext(), clang::Sema::containsUnexpandedParameterPacks(), clang::Sema::diagnoseQualifiedDeclaration(), clang::Sema::DiagnoseUnexpandedParameterPack(), clang::Sema::DiagnoseUnknownTemplateName(), clang::Sema::DiagnoseUnknownTypeName(), clang::Sema::getDestructorName(), clang::Sema::getElaboratedType(), GetFullTypeForDeclarator(), clang::Sema::getInheritingConstructorName(), getRangeOfTypeInNestedNameSpecifier(), clang::Sema::HandleDeclarator(), clang::Sema::isDependentScopeSpecifier(), isInvalid(), clang::Sema::isMicrosoftMissingTypename(), isSet(), clang::Sema::isTemplateName(), isValid(), LookupMemberExpr(), clang::Sema::LookupParsedName(), clang::Sema::MatchTemplateParametersToScopeSpecifier(), clang::TreeTransform< Derived >::RebuildTemplateName(), clang::Sema::SaveNestedNameSpecifierAnnotation(), ScopeSpecifierHasTemplateId(), clang::Sema::ShouldEnterDeclaratorScope(), clang::TreeTransform< Derived >::TransformNestedNameSpecifierLoc(), and clang::TreeTransform< Derived >::TransformTemplateName().

Retrieve a nested-name-specifier with location information, copied into the given AST context.

Parameters:
ContextThe context into which this nested-name-specifier will be copied.

Definition at line 153 of file DeclSpec.cpp.

References clang::NestedNameSpecifierLocBuilder::getRepresentation(), and clang::NestedNameSpecifierLocBuilder::getWithLocInContext().

Referenced by clang::Sema::ActOnCXXNestedNameSpecifier(), clang::Sema::ActOnDependentIdExpression(), clang::Sema::ActOnDependentMemberExpr(), clang::Sema::ActOnDependentTag(), clang::Sema::ActOnMSDependentExistsStmt(), clang::Sema::ActOnNamespaceAliasDef(), clang::Sema::ActOnOpenMPReductionClause(), clang::Sema::ActOnTag(), clang::Sema::ActOnTagTemplateIdType(), clang::Sema::ActOnTemplatedFriendTag(), clang::Sema::ActOnTemplateIdType(), clang::Sema::ActOnTypenameType(), clang::Sema::ActOnUsingDirective(), clang::Sema::BuildDeclarationNameExpr(), clang::Sema::BuildDeclRefExpr(), clang::Sema::BuildDependentDeclRefExpr(), BuildMemberExpr(), clang::Sema::BuildMemberReferenceExpr(), clang::Sema::BuildMemInitializer(), BuildMSPropertyRefExpr(), buildNestedType(), clang::Sema::BuildPseudoDestructorExpr(), clang::Sema::BuildQualifiedDeclarationNameExpr(), clang::Sema::BuildTemplateIdExpr(), clang::Sema::BuildUsingDeclaration(), clang::Sema::CheckTemplateTypeArgument(), clang::Sema::DiagnoseEmptyLookup(), clang::Sema::getDestructorName(), clang::Sema::getTypeName(), clang::Sema::RebuildNestedNameSpecifierInCurrentInstantiation(), recoverFromMSUnqualifiedLookup(), recoverFromTypeInKnownDependentBase(), SetNestedNameSpecifier(), clang::TreeTransform< Derived >::TransformDependentTemplateSpecializationType(), clang::TreeTransform< Derived >::TransformNestedNameSpecifierLoc(), and translateTemplateArgument().

bool clang::CXXScopeSpec::isEmpty ( ) const [inline]
bool clang::CXXScopeSpec::isSet ( ) const [inline]

Deprecated. Some call sites intend isNotEmpty() while others intend isValid().

Definition at line 213 of file DeclSpec.h.

References getScopeRep().

Referenced by clang::Sema::ActOnClassTemplateSpecialization(), clang::Sema::ActOnCXXEnterDeclaratorScope(), clang::Sema::ActOnCXXExitDeclaratorScope(), clang::Sema::ActOnCXXMemberDeclarator(), clang::Sema::ActOnDependentTemplateName(), clang::Sema::ActOnExceptionDeclarator(), clang::Sema::ActOnExplicitInstantiation(), clang::Sema::ActOnFriendFunctionDecl(), clang::Sema::ActOnFunctionDeclarator(), clang::Sema::ActOnIdExpression(), clang::Sema::ActOnMemberAccessExpr(), clang::Sema::ActOnObjCExceptionDecl(), clang::Sema::ActOnParamDeclarator(), clang::Sema::ActOnPseudoDestructorExpr(), clang::Sema::ActOnTag(), clang::Sema::ActOnTypedefDeclarator(), clang::Sema::ActOnUsingDirective(), clang::Sema::ActOnVariableDeclarator(), clang::Sema::BuildCXXNestedNameSpecifier(), clang::Sema::BuildMemberReferenceExpr(), clang::Sema::BuildMemInitializer(), clang::Sema::CheckClassTemplate(), clang::Sema::ClassifyName(), clang::Sema::computeDeclContext(), diagnoseInstanceReference(), clang::Sema::DiagnoseUnknownTemplateName(), clang::Sema::DiagnoseUnknownTypeName(), clang::Sema::getDestructorName(), GetFullTypeForDeclarator(), clang::Sema::HandleDeclarator(), clang::Sema::isCurrentClassName(), clang::Sema::isCurrentClassNameTypo(), clang::Sema::isDependentScopeSpecifier(), clang::Sema::isNonTypeNestedNameSpecifier(), clang::Sema::isTemplateName(), LookupMemberExprInRecord(), clang::Sema::LookupParsedName(), clang::Sema::LookupTemplateName(), clang::Parser::ParseUnqualifiedId(), ScopeSpecifierHasTemplateId(), SetNestedNameSpecifier(), clang::Sema::ShouldEnterDeclaratorScope(), clang::Parser::TryAnnotateTypeOrScopeToken(), and clang::Sema::UseArgumentDependentLookup().

bool clang::CXXScopeSpec::isValid ( ) const [inline]
char* clang::CXXScopeSpec::location_data ( ) const [inline]

Retrieve the size of the data associated with source-location information.

Definition at line 225 of file DeclSpec.h.

References clang::NestedNameSpecifierLocBuilder::getBuffer().

Referenced by clang::Sema::SaveNestedNameSpecifierAnnotation(), and clang::TreeTransform< Derived >::TransformNestedNameSpecifierLoc().

void CXXScopeSpec::MakeGlobal ( ASTContext Context,
SourceLocation  ColonColonLoc 
)

Turn this (empty) nested-name-specifier into the global nested-name-specifier '::'.

Definition at line 107 of file DeclSpec.cpp.

References clang::NestedNameSpecifierLocBuilder::getSourceRange(), and clang::NestedNameSpecifierLocBuilder::MakeGlobal().

Referenced by clang::Sema::ActOnCXXGlobalScopeSpecifier().

void CXXScopeSpec::MakeSuper ( ASTContext Context,
CXXRecordDecl RD,
SourceLocation  SuperLoc,
SourceLocation  ColonColonLoc 
)

Turns this (empty) nested-name-specifier into '__super' nested-name-specifier.

Parameters:
ContextThe AST context in which this nested-name-specifier resides.
RDThe declaration of the class in which nested-name-specifier appeared.
SuperLocThe location of the '__super' keyword. name.
ColonColonLocThe location of the trailing '::'.

Definition at line 117 of file DeclSpec.cpp.

References clang::NestedNameSpecifierLocBuilder::getSourceRange(), clang::NestedNameSpecifierLocBuilder::MakeSuper(), clang::SourceRange::setBegin(), and clang::SourceRange::setEnd().

Referenced by clang::Sema::ActOnSuperScopeSpecifier().

void CXXScopeSpec::MakeTrivial ( ASTContext Context,
NestedNameSpecifier Qualifier,
SourceRange  R 
)

Make a new nested-name-specifier from incomplete source-location information.

FIXME: This routine should be used very, very rarely, in cases where we need to synthesize a nested-name-specifier. Most code should instead use Adopt() with a proper NestedNameSpecifierLoc.

Definition at line 129 of file DeclSpec.cpp.

References clang::NestedNameSpecifierLocBuilder::MakeTrivial().

Referenced by clang::Sema::BuildExpressionFromDeclTemplateArgument(), buildSingleCopyAssignRecursively(), clang::Sema::DiagnoseUnknownTypeName(), clang::Sema::getTypeName(), recoverFromMSUnqualifiedLookup(), and recoverFromTypeInKnownDependentBase().

Definition at line 74 of file DeclSpec.h.

References clang::SourceRange::setBegin().

Definition at line 75 of file DeclSpec.h.

References clang::SourceRange::setEnd().

void clang::CXXScopeSpec::setRange ( const SourceRange R) [inline]

Definition at line 73 of file DeclSpec.h.


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