clang API Documentation

Classes | Public Types | Public Member Functions | Static Public Member Functions
clang::LookupResult Class Reference

Represents the results of name lookup. More...

#include <Lookup.h>

List of all members.

Classes

class  Filter

Public Types

enum  LookupResultKind {
  NotFound = 0, NotFoundInCurrentInstantiation, Found, FoundOverloaded,
  FoundUnresolvedValue, Ambiguous
}
enum  AmbiguityKind { AmbiguousBaseSubobjectTypes, AmbiguousBaseSubobjects, AmbiguousReference, AmbiguousTagHiding }
enum  TemporaryToken { Temporary }
 A little identifier for flagging temporary lookup results. More...
typedef UnresolvedSetImpl::iterator iterator

Public Member Functions

 LookupResult (Sema &SemaRef, const DeclarationNameInfo &NameInfo, Sema::LookupNameKind LookupKind, Sema::RedeclarationKind Redecl=Sema::NotForRedeclaration)
 LookupResult (Sema &SemaRef, DeclarationName Name, SourceLocation NameLoc, Sema::LookupNameKind LookupKind, Sema::RedeclarationKind Redecl=Sema::NotForRedeclaration)
 LookupResult (TemporaryToken _, const LookupResult &Other)
 ~LookupResult ()
const DeclarationNameInfogetLookupNameInfo () const
 Gets the name info to look up.
void setLookupNameInfo (const DeclarationNameInfo &NameInfo)
 Sets the name info to look up.
DeclarationName getLookupName () const
 Gets the name to look up.
void setLookupName (DeclarationName Name)
 Sets the name to look up.
Sema::LookupNameKind getLookupKind () const
 Gets the kind of lookup to perform.
bool isForRedeclaration () const
 True if this lookup is just looking for an existing declaration.
bool isHiddenDeclarationVisible () const
 Determine whether this lookup is permitted to see hidden declarations, such as those in modules that have not yet been imported.
void setHideTags (bool Hide)
bool isAmbiguous () const
bool isSingleResult () const
bool isOverloadedResult () const
 Determines if the results are overloaded.
bool isUnresolvableResult () const
LookupResultKind getResultKind () const
AmbiguityKind getAmbiguityKind () const
const UnresolvedSetImplasUnresolvedSet () const
iterator begin () const
iterator end () const
bool empty () const
 Return true if no decls were found.
CXXBasePathsgetBasePaths () const
 Return the base paths structure that's associated with these results, or null if none is.
NamedDeclgetAcceptableDecl (NamedDecl *D) const
 Retrieve the accepted (re)declaration of the given declaration, if there is one.
unsigned getIdentifierNamespace () const
 Returns the identifier namespace mask for this lookup.
bool isClassLookup () const
 Returns whether these results arose from performing a lookup into a class.
CXXRecordDeclgetNamingClass () const
 Returns the 'naming class' for this lookup, i.e. the class which was looked into to find these results.
void setNamingClass (CXXRecordDecl *Record)
 Sets the 'naming class' for this lookup.
QualType getBaseObjectType () const
 Returns the base object type associated with this lookup; important for [class.protected]. Most lookups do not have an associated base object.
void setBaseObjectType (QualType T)
 Sets the base object type for this lookup.
void addDecl (NamedDecl *D)
 Add a declaration to these results with its natural access. Does not test the acceptance criteria.
void addDecl (NamedDecl *D, AccessSpecifier AS)
 Add a declaration to these results with the given access. Does not test the acceptance criteria.
void addAllDecls (const LookupResult &Other)
 Add all the declarations from another set of lookup results.
bool wasNotFoundInCurrentInstantiation () const
 Determine whether no result was found because we could not search into dependent base classes of the current instantiation.
void setNotFoundInCurrentInstantiation ()
 Note that while no result was found in the current instantiation, there were dependent base classes that could not be searched.
void resolveKind ()
 Resolves the result kind of the lookup, possibly hiding decls.
void resolveKindAfterFilter ()
 Re-resolves the result kind of the lookup after a set of removals has been performed.
template<class DeclClass >
DeclClass * getAsSingle () const
NamedDeclgetFoundDecl () const
 Fetch the unique decl found by this lookup. Asserts that one was found.
NamedDeclgetRepresentativeDecl () const
 Fetches a representative decl. Useful for lazy diagnostics.
bool isSingleTagDecl () const
 Asks if the result is a single tag decl.
void setAmbiguousBaseSubobjectTypes (CXXBasePaths &P)
 Make these results show that the name was found in base classes of different types.
void setAmbiguousBaseSubobjects (CXXBasePaths &P)
 Make these results show that the name was found in distinct base classes of the same type.
void setAmbiguousQualifiedTagHiding ()
 Make these results show that the name was found in different contexts and a tag decl was hidden by an ordinary decl in a different context.
void clear ()
 Clears out any current state.
void clear (Sema::LookupNameKind Kind)
 Clears out any current state and re-initializes for a different kind of lookup.
void setRedeclarationKind (Sema::RedeclarationKind RK)
 Change this lookup's redeclaration kind.
void print (raw_ostream &)
void suppressDiagnostics ()
bool isSuppressingDiagnostics () const
 Determines whether this lookup is suppressing diagnostics.
void setContextRange (SourceRange SR)
 Sets a 'context' source range.
SourceRange getContextRange () const
SourceLocation getNameLoc () const
SemagetSema () const
 Get the Sema object that this lookup result is searching with.
Filter makeFilter ()
 Create a filter for this result set.

Static Public Member Functions

static bool isVisible (NamedDecl *D)
 Determine whether the given declaration is visible to the program.

Detailed Description

Represents the results of name lookup.

An instance of the LookupResult class captures the results of a single name lookup, which can return no result (nothing found), a single declaration, a set of overloaded functions, or an ambiguity. Use the getKind() method to determine which of these results occurred for a given lookup.

Definition at line 30 of file Lookup.h.


Member Typedef Documentation

Definition at line 127 of file Lookup.h.


Member Enumeration Documentation

Enumerator:
AmbiguousBaseSubobjectTypes 

Name lookup results in an ambiguity because multiple entities that meet the lookup criteria were found in subobjects of different types. For example:

 struct A { void f(int); }
 struct B { void f(double); }
 struct C : A, B { };
 void test(C c) {
   c.f(0); // error: A::f and B::f come from subobjects of different
           // types. overload resolution is not performed.
 }
AmbiguousBaseSubobjects 

Name lookup results in an ambiguity because multiple nonstatic entities that meet the lookup criteria were found in different subobjects of the same type. For example:

 struct A { int x; };
 struct B : A { };
 struct C : A { };
 struct D : B, C { };
 int test(D d) {
   return d.x; // error: 'x' is found in two A subobjects (of B and C)
 }
AmbiguousReference 

Name lookup results in an ambiguity because multiple definitions of entity that meet the lookup criteria were found in different declaration contexts.

 namespace A {
   int i;
   namespace B { int i; }
   int test() {
     using namespace B;
     return i; // error 'i' is found in namespace A and A::B
    }
 }
AmbiguousTagHiding 

Name lookup results in an ambiguity because an entity with a tag name was hidden by an entity with an ordinary name from a different context.

 namespace A { struct Foo {}; }
 namespace B { void Foo(); }
 namespace C {
   using namespace A;
   using namespace B;
 }
 void test() {
   C::Foo(); // error: tag 'A::Foo' is hidden by an object in a
             // different namespace
 }

Definition at line 60 of file Lookup.h.

Enumerator:
NotFound 

No entity found met the criteria.

NotFoundInCurrentInstantiation 

No entity found met the criteria within the current instantiation,, but there were dependent base classes of the current instantiation that could not be searched.

Found 

Name lookup found a single declaration that met the criteria. getFoundDecl() will return this declaration.

FoundOverloaded 

Name lookup found a set of overloaded functions that met the criteria.

FoundUnresolvedValue 

Name lookup found an unresolvable value declaration and cannot yet complete. This only happens in C++ dependent contexts with dependent using declarations.

Ambiguous 

Name lookup results in an ambiguity; use getAmbiguityKind to figure out what kind of ambiguity we have.

Definition at line 32 of file Lookup.h.

A little identifier for flagging temporary lookup results.

Enumerator:
Temporary 

Definition at line 123 of file Lookup.h.


Constructor & Destructor Documentation

clang::LookupResult::LookupResult ( Sema SemaRef,
const DeclarationNameInfo NameInfo,
Sema::LookupNameKind  LookupKind,
Sema::RedeclarationKind  Redecl = Sema::NotForRedeclaration 
) [inline]

Definition at line 129 of file Lookup.h.

clang::LookupResult::LookupResult ( Sema SemaRef,
DeclarationName  Name,
SourceLocation  NameLoc,
Sema::LookupNameKind  LookupKind,
Sema::RedeclarationKind  Redecl = Sema::NotForRedeclaration 
) [inline]

Definition at line 149 of file Lookup.h.

clang::LookupResult::LookupResult ( TemporaryToken  _,
const LookupResult Other 
) [inline]

Creates a temporary lookup result, initializing its core data using the information from another result. Diagnostics are always disabled.

Definition at line 169 of file Lookup.h.

clang::LookupResult::~LookupResult ( ) [inline]

Definition at line 182 of file Lookup.h.


Member Function Documentation

void clang::LookupResult::addAllDecls ( const LookupResult Other) [inline]

Add all the declarations from another set of lookup results.

Definition at line 367 of file Lookup.h.

References clang::UnresolvedSetImpl::append(), clang::UnresolvedSetImpl::begin(), clang::UnresolvedSetImpl::end(), and Found.

Referenced by LookupQualifiedNameInUsingDirectives().

void clang::LookupResult::addDecl ( NamedDecl D) [inline]
void clang::LookupResult::addDecl ( NamedDecl D,
AccessSpecifier  AS 
) [inline]

Add a declaration to these results with the given access. Does not test the acceptance criteria.

Definition at line 360 of file Lookup.h.

References clang::UnresolvedSetImpl::addDecl(), and Found.

const UnresolvedSetImpl& clang::LookupResult::asUnresolvedSet ( ) const [inline]

Definition at line 259 of file Lookup.h.

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

iterator clang::LookupResult::begin ( ) const [inline]
void clang::LookupResult::clear ( ) [inline]
void clang::LookupResult::clear ( Sema::LookupNameKind  Kind) [inline]

Clears out any current state and re-initializes for a different kind of lookup.

Definition at line 477 of file Lookup.h.

References clear().

bool clang::LookupResult::empty ( ) const [inline]

Return true if no decls were found.

Definition at line 267 of file Lookup.h.

References clang::UnresolvedSetImpl::empty().

Referenced by clang::Sema::ActOnAliasDeclaration(), clang::Sema::ActOnFriendFunctionDecl(), clang::Sema::ActOnIdExpression(), clang::Sema::ActOnNamespaceAliasDef(), clang::Sema::ActOnStartOfLambdaDefinition(), clang::Sema::ActOnTag(), clang::Sema::ActOnTypedefNameDecl(), clang::Sema::ActOnUsingDirective(), clang::Sema::ActOnVariableDeclarator(), clang::Sema::BuildCXXForRangeStmt(), clang::Sema::BuildCXXNestedNameSpecifier(), clang::Sema::BuildImplicitMemberExpr(), clang::Sema::BuildMemberReferenceExpr(), clang::Sema::BuildMemInitializer(), clang::Sema::BuildQualifiedDeclarationNameExpr(), clang::Sema::BuildQualifiedTemplateIdExpr(), clang::Sema::BuildTemplateIdExpr(), clang::Sema::BuildUsingDeclaration(), clang::Sema::CheckDependentFunctionTemplateSpecialization(), clang::Sema::CheckFunctionDeclaration(), clang::Sema::CheckMemberSpecialization(), clang::Sema::CheckUsingShadowDecl(), clang::Sema::CheckVariableDeclaration(), ClassifyImplicitMemberAccess(), clang::Sema::ClassifyName(), clang::Sema::DiagnoseEmptyLookup(), clang::DiagnoseTwoPhaseLookup(), doesUsualArrayDeleteWantSize(), clang::Sema::FindAllocationOverload(), clang::Sema::FindDeallocationFunction(), clang::Sema::getTypeName(), clang::Sema::LookupInObjCMethod(), LookupMemberExprInRecord(), clang::Sema::LookupOverloadedOperatorName(), LookupPotentialTypoResult(), LookupQualifiedNameInUsingDirectives(), clang::Sema::LookupTemplateName(), and clang::TemplateDeclInstantiator::VisitCXXMethodDecl().

iterator clang::LookupResult::end ( ) const [inline]
NamedDecl* clang::LookupResult::getAcceptableDecl ( NamedDecl D) const [inline]

Retrieve the accepted (re)declaration of the given declaration, if there is one.

Definition at line 290 of file Lookup.h.

References isHiddenDeclarationVisible(), clang::Decl::isInIdentifierNamespace(), and isVisible().

Referenced by LookupDirect(), and LookupVisibleDecls().

AmbiguityKind clang::LookupResult::getAmbiguityKind ( ) const [inline]

Definition at line 254 of file Lookup.h.

References isAmbiguous().

Referenced by clang::Sema::DiagnoseAmbiguousLookup(), and clang::Sema::getTypeName().

template<class DeclClass >
DeclClass* clang::LookupResult::getAsSingle ( ) const [inline]
QualType clang::LookupResult::getBaseObjectType ( ) const [inline]

Returns the base object type associated with this lookup; important for [class.protected]. Most lookups do not have an associated base object.

Definition at line 343 of file Lookup.h.

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

CXXBasePaths* clang::LookupResult::getBasePaths ( ) const [inline]

Return the base paths structure that's associated with these results, or null if none is.

Definition at line 271 of file Lookup.h.

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

SourceRange clang::LookupResult::getContextRange ( ) const [inline]

Gets the source range of the context of this name; for C++ qualified lookups, this is the source range of the scope specifier.

Definition at line 510 of file Lookup.h.

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

NamedDecl* clang::LookupResult::getFoundDecl ( ) const [inline]
unsigned clang::LookupResult::getIdentifierNamespace ( ) const [inline]

Returns the identifier namespace mask for this lookup.

Definition at line 305 of file Lookup.h.

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

Sema::LookupNameKind clang::LookupResult::getLookupKind ( ) const [inline]
DeclarationName clang::LookupResult::getLookupName ( ) const [inline]
const DeclarationNameInfo& clang::LookupResult::getLookupNameInfo ( ) const [inline]
SourceLocation clang::LookupResult::getNameLoc ( ) const [inline]
CXXRecordDecl* clang::LookupResult::getNamingClass ( ) const [inline]

Returns the 'naming class' for this lookup, i.e. the class which was looked into to find these results.

C++0x [class.access.base]p5: The access to a member is affected by the class in which the member is named. This naming class is the class in which the member name was looked up and found. [Note: this class can be explicit, e.g., when a qualified-id is used, or implicit, e.g., when a class member access operator (5.2.5) is used (including cases where an implicit "this->" is added). If both a class member access operator and a qualified-id are used to name the member (as in p->T::m), the class naming the member is the class named by the nested-name-specifier of the qualified-id (that is, T). -- end note ]

This is set by the lookup routines when they find results in a class.

Definition at line 331 of file Lookup.h.

Referenced by clang::Sema::BuildDeclarationNameExpr(), clang::Sema::BuildTemplateIdExpr(), clang::Sema::CheckLookupAccess(), ClassifyImplicitMemberAccess(), clang::Sema::FindAllocationOverload(), and clang::Sema::FindDeallocationFunction().

NamedDecl* clang::LookupResult::getRepresentativeDecl ( ) const [inline]
LookupResultKind clang::LookupResult::getResultKind ( ) const [inline]
Sema& clang::LookupResult::getSema ( ) const [inline]

Get the Sema object that this lookup result is searching with.

Definition at line 522 of file Lookup.h.

Referenced by isResultTypeOrTemplate(), LookupDirect(), and LookupVisibleDecls().

bool clang::LookupResult::isAmbiguous ( ) const [inline]
bool clang::LookupResult::isClassLookup ( ) const [inline]

Returns whether these results arose from performing a lookup into a class.

Definition at line 311 of file Lookup.h.

bool clang::LookupResult::isForRedeclaration ( ) const [inline]

True if this lookup is just looking for an existing declaration.

Definition at line 213 of file Lookup.h.

Referenced by clang::Sema::ActOnTag(), LookupBuiltin(), LookupDirect(), clang::Sema::LookupInObjCMethod(), and clang::Sema::LookupQualifiedName().

bool clang::LookupResult::isHiddenDeclarationVisible ( ) const [inline]

Determine whether this lookup is permitted to see hidden declarations, such as those in modules that have not yet been imported.

Definition at line 219 of file Lookup.h.

References clang::Sema::LookupTagName.

Referenced by getAcceptableDecl(), and clang::Sema::LookupName().

bool clang::LookupResult::isOverloadedResult ( ) const [inline]

Determines if the results are overloaded.

Definition at line 241 of file Lookup.h.

References FoundOverloaded, and getResultKind().

Referenced by clang::Sema::ActOnIdExpression(), clang::Sema::BuildDeclarationNameExpr(), and clang::Sema::BuildMemberReferenceExpr().

bool clang::LookupResult::isSingleResult ( ) const [inline]
bool clang::LookupResult::isSingleTagDecl ( ) const [inline]

Asks if the result is a single tag decl.

Definition at line 443 of file Lookup.h.

References Found, getFoundDecl(), and getResultKind().

Referenced by clang::Sema::HandleDeclarator(), LookupQualifiedNameInUsingDirectives(), and clang::TemplateDeclInstantiator::VisitCXXMethodDecl().

bool clang::LookupResult::isSuppressingDiagnostics ( ) const [inline]

Determines whether this lookup is suppressing diagnostics.

Definition at line 498 of file Lookup.h.

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

bool clang::LookupResult::isUnresolvableResult ( ) const [inline]
static bool clang::LookupResult::isVisible ( NamedDecl D) [inline, static]

Determine whether the given declaration is visible to the program.

Definition at line 277 of file Lookup.h.

References clang::NamedDecl::isHidden().

Referenced by getAcceptableDecl(), getVisibleDecl(), and clang::Sema::RequireCompleteType().

Filter clang::LookupResult::makeFilter ( ) [inline]
void LookupResult::print ( raw_ostream &  Out)

Definition at line 471 of file SemaLookup.cpp.

void LookupResult::resolveKind ( )
void clang::LookupResult::resolveKindAfterFilter ( ) [inline]

Re-resolves the result kind of the lookup after a set of removals has been performed.

Definition at line 394 of file Lookup.h.

References Ambiguous, clang::UnresolvedSetImpl::empty(), Found, NotFound, NotFoundInCurrentInstantiation, and resolveKind().

Referenced by clang::LookupResult::Filter::done().

void LookupResult::setAmbiguousBaseSubobjects ( CXXBasePaths P)

Make these results show that the name was found in distinct base classes of the same type.

The given paths object is copied and invalidated.

Definition at line 455 of file SemaLookup.cpp.

References clang::CXXBasePaths::swap().

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

void LookupResult::setAmbiguousBaseSubobjectTypes ( CXXBasePaths P)

Make these results show that the name was found in base classes of different types.

The given paths object is copied and invalidated.

Definition at line 463 of file SemaLookup.cpp.

References clang::CXXBasePaths::swap().

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

void clang::LookupResult::setAmbiguousQualifiedTagHiding ( ) [inline]

Make these results show that the name was found in different contexts and a tag decl was hidden by an ordinary decl in a different context.

Definition at line 462 of file Lookup.h.

References AmbiguousTagHiding.

Referenced by LookupQualifiedNameInUsingDirectives().

void clang::LookupResult::setBaseObjectType ( QualType  T) [inline]

Sets the base object type for this lookup.

Definition at line 348 of file Lookup.h.

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

void clang::LookupResult::setContextRange ( SourceRange  SR) [inline]

Sets a 'context' source range.

Definition at line 503 of file Lookup.h.

Referenced by clang::Sema::BuildCXXNestedNameSpecifier(), clang::Sema::isNonTypeNestedNameSpecifier(), and clang::Sema::LookupParsedName().

void clang::LookupResult::setHideTags ( bool  Hide) [inline]

Sets whether tag declarations should be hidden by non-tag declarations during resolution. The default is true.

Definition at line 225 of file Lookup.h.

Referenced by clang::Sema::BuildUsingDeclaration(), and clang::TemplateDeclInstantiator::VisitUsingDecl().

void clang::LookupResult::setLookupName ( DeclarationName  Name) [inline]
void clang::LookupResult::setLookupNameInfo ( const DeclarationNameInfo NameInfo) [inline]

Sets the name info to look up.

Definition at line 193 of file Lookup.h.

void clang::LookupResult::setNamingClass ( CXXRecordDecl Record) [inline]

Sets the 'naming class' for this lookup.

Definition at line 336 of file Lookup.h.

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

void clang::LookupResult::setNotFoundInCurrentInstantiation ( ) [inline]

Note that while no result was found in the current instantiation, there were dependent base classes that could not be searched.

Definition at line 380 of file Lookup.h.

References clang::UnresolvedSetImpl::empty(), NotFound, and NotFoundInCurrentInstantiation.

Referenced by clang::Sema::LookupParsedName(), and clang::Sema::LookupQualifiedName().

void clang::LookupResult::setRedeclarationKind ( Sema::RedeclarationKind  RK) [inline]

Change this lookup's redeclaration kind.

Definition at line 484 of file Lookup.h.

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

void clang::LookupResult::suppressDiagnostics ( ) [inline]
bool clang::LookupResult::wasNotFoundInCurrentInstantiation ( ) const [inline]

Determine whether no result was found because we could not search into dependent base classes of the current instantiation.

Definition at line 374 of file Lookup.h.

References NotFoundInCurrentInstantiation.

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


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