Information about a module that has been loaded by the ASTReader. More...

#include <Module.h>

Collaboration diagram for clang::serialization::ModuleFile:

Public Types
typedef llvm::DenseMap< const DeclContext *, DeclContextInfo >	DeclContextInfosMap
Public Member Functions
	ModuleFile (ModuleKind Kind, unsigned Generation)
	~ModuleFile ()
bool	isDirectlyImported () const
	Determine whether this module was directly imported at any point during translation.
void	dump ()
	Dump debugging output for this module.
Public Attributes
ModuleKind	Kind
	The type of this module.
std::string	FileName
	The file name of the module file.
bool	DirectlyImported
	Whether this module has been directly imported by the user.
unsigned	Generation
	The generation of which this module file is a part.
OwningPtr< llvm::MemoryBuffer >	Buffer
	The memory buffer that stores the data associated with this AST file.
uint64_t	SizeInBits
	The size of this file, in bits.
uint64_t	GlobalBitOffset
	The global bit offset (or base) of this module.
llvm::BitstreamReader	StreamFile
	The bitstream reader from which we'll read the AST file.
llvm::BitstreamCursor	Stream
	The main bitstream cursor for the main block.
SourceLocation	ImportLoc
	The source location where this module was first imported.
SourceLocation	FirstLoc
	The first source location in this module.
llvm::BitstreamCursor	SLocEntryCursor
	Cursor used to read source location entries.
unsigned	LocalNumSLocEntries
	The number of source location entries in this AST file.
int	SLocEntryBaseID
	The base ID in the source manager's view of this module.
unsigned	SLocEntryBaseOffset
	The base offset in the source manager's view of this module.
const uint32_t *	SLocEntryOffsets
	Offsets for all of the source location entries in the AST file.
SmallVector< uint64_t, 4 >	PreloadSLocEntries
	SLocEntries that we're going to preload.
unsigned	LocalNumSLocFileEntries
	The number of source location file entries in this AST file.
const uint32_t *	SLocFileOffsets
	Offsets for all of the source location file entries in the AST file.
ContinuousRangeMap< uint32_t, int, 2 >	SLocRemap
	Remapping table for source locations in this module.
unsigned	LocalNumIdentifiers
	The number of identifiers in this AST file.
const uint32_t *	IdentifierOffsets
	Offsets into the identifier table data.
serialization::IdentID	BaseIdentifierID
	Base identifier ID for identifiers local to this module.
ContinuousRangeMap< uint32_t, int, 2 >	IdentifierRemap
	Remapping table for identifier IDs in this module.
const char *	IdentifierTableData
	Actual data for the on-disk hash table of identifiers.
void *	IdentifierLookupTable
	A pointer to an on-disk hash table of opaque type IdentifierHashTable.
llvm::BitstreamCursor	MacroCursor
	The cursor to the start of the preprocessor block, which stores all of the macro definitions.
uint64_t	MacroStartOffset
	The offset of the start of the set of defined macros.
llvm::BitstreamCursor	PreprocessorDetailCursor
	The cursor to the start of the (optional) detailed preprocessing record block.
uint64_t	PreprocessorDetailStartOffset
	The offset of the start of the preprocessor detail cursor.
serialization::PreprocessedEntityID	BasePreprocessedEntityID
	Base preprocessed entity ID for preprocessed entities local to this module.
ContinuousRangeMap< uint32_t, int, 2 >	PreprocessedEntityRemap
	Remapping table for preprocessed entity IDs in this module.
const PPEntityOffset *	PreprocessedEntityOffsets
unsigned	NumPreprocessedEntities
unsigned	LocalNumHeaderFileInfos
	The number of local HeaderFileInfo structures.
const char *	HeaderFileInfoTableData
	Actual data for the on-disk hash table of header file information.
void *	HeaderFileInfoTable
	The on-disk hash table that contains information about each of the header files.
const char *	HeaderFileFrameworkStrings
	Actual data for the list of framework names used in the header search information.
unsigned	LocalNumSubmodules
	The number of submodules in this module.
serialization::SubmoduleID	BaseSubmoduleID
	Base submodule ID for submodules local to this module.
ContinuousRangeMap< uint32_t, int, 2 >	SubmoduleRemap
	Remapping table for submodule IDs in this module.
unsigned	LocalNumSelectors
	The number of selectors new to this file.
const uint32_t *	SelectorOffsets
	Offsets into the selector lookup table's data array where each selector resides.
serialization::SelectorID	BaseSelectorID
	Base selector ID for selectors local to this module.
ContinuousRangeMap< uint32_t, int, 2 >	SelectorRemap
	Remapping table for selector IDs in this module.
const unsigned char *	SelectorLookupTableData
	A pointer to the character data that comprises the selector table.
void *	SelectorLookupTable
	A pointer to an on-disk hash table of opaque type ASTSelectorLookupTable.
llvm::BitstreamCursor	DeclsCursor
unsigned	LocalNumDecls
	The number of declarations in this AST file.
const DeclOffset *	DeclOffsets
	Offset of each declaration within the bitstream, indexed by the declaration ID (-1).
serialization::DeclID	BaseDeclID
	Base declaration ID for declarations local to this module.
ContinuousRangeMap< uint32_t, int, 2 >	DeclRemap
	Remapping table for declaration IDs in this module.
llvm::DenseMap< ModuleFile *, serialization::DeclID >	GlobalToLocalDeclIDs
	Mapping from the module files that this module file depends on to the base declaration ID for that module as it is understood within this module.
unsigned	LocalNumCXXBaseSpecifiers
	The number of C++ base specifier sets in this AST file.
const uint32_t *	CXXBaseSpecifiersOffsets
	Offset of each C++ base specifier set within the bitstream, indexed by the C++ base specifier set ID (-1).
DeclContextInfosMap	DeclContextInfos
	Information about the lexical and visible declarations for each DeclContext.
const serialization::DeclID *	FileSortedDecls
	Array of file-level DeclIDs sorted by file.
const serialization::LocalRedeclarationsInfo *	RedeclarationsMap
	Array of redeclaration chain location information within this module file, sorted by the first declaration ID.
unsigned	LocalNumRedeclarationsInMap
	The number of redeclaration info entries in RedeclarationsMap.
SmallVector< uint64_t, 1 >	RedeclarationChains
	The redeclaration chains for declarations local to this module file.
const serialization::ObjCCategoriesInfo *	ObjCCategoriesMap
	Array of category list location information within this module file, sorted by the definition ID.
unsigned	LocalNumObjCCategoriesInMap
	The number of redeclaration info entries in ObjCCategoriesMap.
SmallVector< uint64_t, 1 >	ObjCCategories
	The Objective-C category lists for categories known to this module.
unsigned	LocalNumTypes
	The number of types in this AST file.
const uint32_t *	TypeOffsets
	Offset of each type within the bitstream, indexed by the type ID, or the representation of a Type*.
serialization::TypeID	BaseTypeIndex
	Base type ID for types local to this module as represented in the global type ID space.
ContinuousRangeMap< uint32_t, int, 2 >	TypeRemap
	Remapping table for type IDs in this module.
SmallVector< uint64_t, 8 >	PragmaDiagMappings
	Diagnostic IDs and their mappings that the user changed.
void *	StatCache
	The AST stat cache installed for this file, if any.
llvm::SetVector< ModuleFile * >	ImportedBy
	List of modules which depend on this module.
llvm::SetVector< ModuleFile * >	Imports
	List of modules which this module depends on.

Detailed Description

Information about a module that has been loaded by the ASTReader.

Each instance of the Module class corresponds to a single AST file, which may be a precompiled header, precompiled preamble, a module, or an AST file of some sort loaded as the main file, all of which are specific formulations of the general notion of a "module". A module may depend on any number of other modules.

Definition at line 64 of file Serialization/Module.h.

Member Typedef Documentation

typedef llvm::DenseMap<const DeclContext *, DeclContextInfo> clang::serialization::ModuleFile::DeclContextInfosMap

Definition at line 289 of file Serialization/Module.h.

Constructor & Destructor Documentation

ModuleFile::ModuleFile	(	ModuleKind	Kind,
		unsigned	Generation
	)

Definition at line 23 of file Serialization/Module.cpp.

ModuleFile::~ModuleFile ( )

Definition at line 43 of file Serialization/Module.cpp.

References DeclContextInfos, HeaderFileInfoTable, IdentifierLookupTable, and SelectorLookupTable.

Member Function Documentation

void ModuleFile::dump ( )

Dump debugging output for this module.

Definition at line 71 of file Serialization/Module.cpp.

References BaseDeclID, BaseIdentifierID, BasePreprocessedEntityID, BaseSelectorID, BaseSubmoduleID, BaseTypeIndex, DeclRemap, dumpLocalRemap(), FileName, IdentifierRemap, Imports, LocalNumDecls, LocalNumIdentifiers, LocalNumSelectors, LocalNumSubmodules, LocalNumTypes, NumPreprocessedEntities, PreprocessedEntityRemap, SelectorRemap, SLocEntryBaseOffset, SubmoduleRemap, and TypeRemap.

bool clang::serialization::ModuleFile::isDirectlyImported ( ) const [inline]

Determine whether this module was directly imported at any point during translation.

Definition at line 354 of file Serialization/Module.h.

References DirectlyImported.

Member Data Documentation

serialization::DeclID clang::serialization::ModuleFile::BaseDeclID

Base declaration ID for declarations local to this module.

Definition at line 267 of file Serialization/Module.h.

Referenced by dump().

serialization::IdentID clang::serialization::ModuleFile::BaseIdentifierID

Base identifier ID for identifiers local to this module.

Definition at line 150 of file Serialization/Module.h.

Referenced by clang::ASTReader::DecodeIdentifierInfo(), and dump().

serialization::PreprocessedEntityID clang::serialization::ModuleFile::BasePreprocessedEntityID

Base preprocessed entity ID for preprocessed entities local to this module.

Definition at line 185 of file Serialization/Module.h.

Referenced by dump().

serialization::SelectorID clang::serialization::ModuleFile::BaseSelectorID

Base selector ID for selectors local to this module.

Definition at line 235 of file Serialization/Module.h.

Referenced by dump().

serialization::SubmoduleID clang::serialization::ModuleFile::BaseSubmoduleID

Base submodule ID for submodules local to this module.

Definition at line 218 of file Serialization/Module.h.

Referenced by dump().

serialization::TypeID clang::serialization::ModuleFile::BaseTypeIndex

Base type ID for types local to this module as represented in the global type ID space.

Definition at line 331 of file Serialization/Module.h.

Referenced by dump().

OwningPtr<llvm::MemoryBuffer> clang::serialization::ModuleFile::Buffer

The memory buffer that stores the data associated with this AST file.

Definition at line 86 of file Serialization/Module.h.

Referenced by clang::serialization::ModuleManager::addModule().

const uint32_t* clang::serialization::ModuleFile::CXXBaseSpecifiersOffsets

Offset of each C++ base specifier set within the bitstream, indexed by the C++ base specifier set ID (-1).

Definition at line 286 of file Serialization/Module.h.

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

DeclContextInfosMap clang::serialization::ModuleFile::DeclContextInfos

Information about the lexical and visible declarations for each DeclContext.

Definition at line 293 of file Serialization/Module.h.

Referenced by ~ModuleFile().

const DeclOffset* clang::serialization::ModuleFile::DeclOffsets

Offset of each declaration within the bitstream, indexed by the declaration ID (-1).

Definition at line 264 of file Serialization/Module.h.

ContinuousRangeMap<uint32_t, int, 2> clang::serialization::ModuleFile::DeclRemap

Remapping table for declaration IDs in this module.

Definition at line 270 of file Serialization/Module.h.

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

llvm::BitstreamCursor clang::serialization::ModuleFile::DeclsCursor

DeclsCursor - This is a cursor to the start of the DECLS_BLOCK block. It has read all the abbreviations at the start of the block and is ready to jump around with these in context.

Definition at line 257 of file Serialization/Module.h.

bool clang::serialization::ModuleFile::DirectlyImported

Whether this module has been directly imported by the user.

Definition at line 79 of file Serialization/Module.h.

Referenced by clang::serialization::ModuleManager::addModule(), and isDirectlyImported().

std::string clang::serialization::ModuleFile::FileName

The file name of the module file.

Definition at line 75 of file Serialization/Module.h.

Referenced by clang::serialization::ModuleManager::addModule(), dump(), and llvm::DOTGraphTraits< ModuleManager >::getNodeLabel().

const serialization::DeclID* clang::serialization::ModuleFile::FileSortedDecls

Array of file-level DeclIDs sorted by file.

Definition at line 296 of file Serialization/Module.h.

SourceLocation clang::serialization::ModuleFile::FirstLoc

The first source location in this module.

Definition at line 104 of file Serialization/Module.h.

unsigned clang::serialization::ModuleFile::Generation

The generation of which this module file is a part.

Definition at line 82 of file Serialization/Module.h.

Referenced by clang::serialization::ReadMethodPoolVisitor::visit().

uint64_t clang::serialization::ModuleFile::GlobalBitOffset

The global bit offset (or base) of this module.

Definition at line 92 of file Serialization/Module.h.

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

llvm::DenseMap<ModuleFile *, serialization::DeclID> clang::serialization::ModuleFile::GlobalToLocalDeclIDs

Mapping from the module files that this module file depends on to the base declaration ID for that module as it is understood within this module.

This is effectively a reverse global-to-local mapping for declaration IDs, so that we can interpret a true global ID (for this translation unit) as a local ID (for this module file).

Definition at line 279 of file Serialization/Module.h.

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

const char* clang::serialization::ModuleFile::HeaderFileFrameworkStrings

Actual data for the list of framework names used in the header search information.

Definition at line 211 of file Serialization/Module.h.

void* clang::serialization::ModuleFile::HeaderFileInfoTable

The on-disk hash table that contains information about each of the header files.

Definition at line 207 of file Serialization/Module.h.

Referenced by ~ModuleFile().

const char* clang::serialization::ModuleFile::HeaderFileInfoTableData

Actual data for the on-disk hash table of header file information.

This pointer points into a memory buffer, where the on-disk hash table for header file information actually lives.