clang 20.0.0git
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
clang::DeclIDBase Class Reference

GlobalDeclID means DeclID in the current ASTContext and LocalDeclID means DeclID specific to a certain ModuleFile. More...

#include "clang/AST/DeclID.h"

Inheritance diagram for clang::DeclIDBase:
Inheritance graph
[legend]

Public Types

using DeclID = uint64_t
 An ID number that refers to a declaration in an AST file.
 

Public Member Functions

DeclID getRawValue () const
 
 operator DeclID () const
 
 operator PredefinedDeclIDs () const
 
bool isValid () const
 
bool isInvalid () const
 
unsigned getModuleFileIndex () const
 
unsigned getLocalDeclIndex () const
 

Protected Member Functions

 DeclIDBase ()
 
 DeclIDBase (DeclID ID)
 

Protected Attributes

DeclID ID
 

Friends

bool operator== (const DeclIDBase &LHS, const DeclID &RHS)
 
bool operator!= (const DeclIDBase &LHS, const DeclID &RHS)
 
bool operator< (const DeclIDBase &LHS, const DeclID &RHS)
 
bool operator<= (const DeclIDBase &LHS, const DeclID &RHS)
 
bool operator> (const DeclIDBase &LHS, const DeclID &RHS)
 
bool operator>= (const DeclIDBase &LHS, const DeclID &RHS)
 
bool operator== (const DeclIDBase &LHS, const DeclIDBase &RHS)
 
bool operator!= (const DeclIDBase &LHS, const DeclIDBase &RHS)
 
bool operator< (const DeclIDBase &LHS, const DeclIDBase &RHS)
 
bool operator> (const DeclIDBase &LHS, const DeclIDBase &RHS)
 
bool operator<= (const DeclIDBase &LHS, const DeclIDBase &RHS)
 
bool operator>= (const DeclIDBase &LHS, const DeclIDBase &RHS)
 

Detailed Description

GlobalDeclID means DeclID in the current ASTContext and LocalDeclID means DeclID specific to a certain ModuleFile.

Specially, in ASTWriter, the LocalDeclID to the ModuleFile been writting is equal to the GlobalDeclID. Outside the serializer, all the DeclID been used should be GlobalDeclID. We can translate a LocalDeclID to the GlobalDeclID by ASTReader::getGlobalDeclID().

Definition at line 102 of file DeclID.h.

Member Typedef Documentation

◆ DeclID

using clang::DeclIDBase::DeclID = uint64_t

An ID number that refers to a declaration in an AST file.

The ID numbers of declarations are consecutive (in order of discovery), with values below NUM_PREDEF_DECL_IDS being reserved. At the start of a chain of precompiled headers, declaration ID 1 is used for the translation unit declaration.

DeclID should only be used directly in serialization. All other users should use LocalDeclID or GlobalDeclID.

Definition at line 113 of file DeclID.h.

Constructor & Destructor Documentation

◆ DeclIDBase() [1/2]

clang::DeclIDBase::DeclIDBase ( )
inlineprotected

Definition at line 116 of file DeclID.h.

◆ DeclIDBase() [2/2]

clang::DeclIDBase::DeclIDBase ( DeclID  ID)
inlineexplicitprotected

Definition at line 117 of file DeclID.h.

Member Function Documentation

◆ getLocalDeclIndex()

unsigned DeclIDBase::getLocalDeclIndex ( ) const

Definition at line 2217 of file DeclBase.cpp.

Referenced by clang::ASTReader::getGlobalDeclID(), and clang::ASTReader::mapGlobalIDToModuleFileGlobalID().

◆ getModuleFileIndex()

unsigned clang::DeclIDBase::getModuleFileIndex ( ) const
inline

Definition at line 130 of file DeclID.h.

References ID.

Referenced by clang::ASTReader::getGlobalDeclID().

◆ getRawValue()

DeclID clang::DeclIDBase::getRawValue ( ) const
inline

Definition at line 120 of file DeclID.h.

References ID.

Referenced by clang::ASTReader::getGlobalDeclID(), llvm::DenseMapInfo< clang::GlobalDeclID >::getHashValue(), clang::ASTReader::mapGlobalIDToModuleFileGlobalID(), clang::ASTDeclReader::VisitCXXRecordDeclImpl(), clang::ASTDeclReader::VisitFriendDecl(), clang::ASTDeclReader::VisitOMPDeclareMapperDecl(), and clang::ASTDeclReader::VisitOMPDeclareReductionDecl().

◆ isInvalid()

bool clang::DeclIDBase::isInvalid ( ) const
inline

Definition at line 128 of file DeclID.h.

References ID, and clang::PREDEF_DECL_NULL_ID.

Referenced by clang::ASTDeclReader::VisitDecl(), and clang::ASTDeclReader::VisitRedeclarable().

◆ isValid()

bool clang::DeclIDBase::isValid ( ) const
inline

Definition at line 126 of file DeclID.h.

References ID, and clang::PREDEF_DECL_NULL_ID.

Referenced by clang::ASTDeclMerger::mergeRedeclarableImpl(), clang::ASTDeclReader::Visit(), clang::ASTDeclReader::VisitCXXRecordDeclImpl(), and clang::ASTDeclReader::VisitNamespaceDecl().

◆ operator DeclID()

clang::DeclIDBase::operator DeclID ( ) const
inlineexplicit

Definition at line 122 of file DeclID.h.

References ID.

◆ operator PredefinedDeclIDs()

clang::DeclIDBase::operator PredefinedDeclIDs ( ) const
inlineexplicit

Definition at line 124 of file DeclID.h.

References ID.

Friends And Related Function Documentation

◆ operator!= [1/2]

bool operator!= ( const DeclIDBase &  LHS,
const DeclID &  RHS 
)
friend

Definition at line 138 of file DeclID.h.

◆ operator!= [2/2]

bool operator!= ( const DeclIDBase &  LHS,
const DeclIDBase &  RHS 
)
friend

Definition at line 157 of file DeclID.h.

◆ operator< [1/2]

bool operator< ( const DeclIDBase &  LHS,
const DeclID &  RHS 
)
friend

Definition at line 141 of file DeclID.h.

◆ operator< [2/2]

bool operator< ( const DeclIDBase &  LHS,
const DeclIDBase &  RHS 
)
friend

Definition at line 162 of file DeclID.h.

◆ operator<= [1/2]

bool operator<= ( const DeclIDBase &  LHS,
const DeclID &  RHS 
)
friend

Definition at line 144 of file DeclID.h.

◆ operator<= [2/2]

bool operator<= ( const DeclIDBase &  LHS,
const DeclIDBase &  RHS 
)
friend

Definition at line 168 of file DeclID.h.

◆ operator== [1/2]

bool operator== ( const DeclIDBase &  LHS,
const DeclID &  RHS 
)
friend

Definition at line 135 of file DeclID.h.

◆ operator== [2/2]

bool operator== ( const DeclIDBase &  LHS,
const DeclIDBase &  RHS 
)
friend

Definition at line 154 of file DeclID.h.

◆ operator> [1/2]

bool operator> ( const DeclIDBase &  LHS,
const DeclID &  RHS 
)
friend

Definition at line 147 of file DeclID.h.

◆ operator> [2/2]

bool operator> ( const DeclIDBase &  LHS,
const DeclIDBase &  RHS 
)
friend

Definition at line 165 of file DeclID.h.

◆ operator>= [1/2]

bool operator>= ( const DeclIDBase &  LHS,
const DeclID &  RHS 
)
friend

Definition at line 150 of file DeclID.h.

◆ operator>= [2/2]

bool operator>= ( const DeclIDBase &  LHS,
const DeclIDBase &  RHS 
)
friend

Definition at line 171 of file DeclID.h.

Member Data Documentation

◆ ID

DeclID clang::DeclIDBase::ID
protected

Definition at line 176 of file DeclID.h.

Referenced by clang::LocalDeclID::get(), getModuleFileIndex(), getRawValue(), isInvalid(), isValid(), operator DeclID(), clang::GlobalDeclID::operator LocalDeclID(), operator PredefinedDeclIDs(), and clang::LocalDeclID::operator++().

The documentation for this class was generated from the following files:
Generated on Tue Nov 19 2024 23:06:49 for clang by doxygen 1.9.6