clang
3.9.0
|
Writes an AST file containing the contents of a translation unit. More...
#include <ASTWriter.h>
Public Types | |
typedef SmallVector< uint64_t, 64 > | RecordData |
typedef SmallVectorImpl< uint64_t > | RecordDataImpl |
typedef ArrayRef< uint64_t > | RecordDataRef |
Public Member Functions | |
ASTWriter (llvm::BitstreamWriter &Stream, ArrayRef< llvm::IntrusiveRefCntPtr< ModuleFileExtension >> Extensions, bool IncludeTimestamps=true) | |
Create a new precompiled header writer that outputs to the given bitstream. More... | |
~ASTWriter () override | |
const LangOptions & | getLangOpts () const |
time_t | getTimestampForOutput (const FileEntry *E) const |
Get a timestamp for output into the AST file. More... | |
uint64_t | WriteAST (Sema &SemaRef, const std::string &OutputFile, Module *WritingModule, StringRef isysroot, bool hasErrors=false) |
Write a precompiled header for the given semantic analysis. More... | |
void | AddToken (const Token &Tok, RecordDataImpl &Record) |
Emit a token. More... | |
void | AddSourceLocation (SourceLocation Loc, RecordDataImpl &Record) |
Emit a source location. More... | |
void | AddSourceRange (SourceRange Range, RecordDataImpl &Record) |
Emit a source range. More... | |
void | AddIdentifierRef (const IdentifierInfo *II, RecordDataImpl &Record) |
Emit a reference to an identifier. More... | |
serialization::SelectorID | getSelectorRef (Selector Sel) |
Get the unique number used to refer to the given selector. More... | |
serialization::IdentID | getIdentifierRef (const IdentifierInfo *II) |
Get the unique number used to refer to the given identifier. More... | |
serialization::MacroID | getMacroRef (MacroInfo *MI, const IdentifierInfo *Name) |
Get the unique number used to refer to the given macro. More... | |
serialization::MacroID | getMacroID (MacroInfo *MI) |
Determine the ID of an already-emitted macro. More... | |
uint64_t | getMacroDirectivesOffset (const IdentifierInfo *Name) |
void | AddTypeRef (QualType T, RecordDataImpl &Record) |
Emit a reference to a type. More... | |
serialization::TypeID | GetOrCreateTypeID (QualType T) |
Force a type to be emitted and get its ID. More... | |
serialization::TypeID | getTypeID (QualType T) const |
Determine the type ID of an already-emitted type. More... | |
const Decl * | getFirstLocalDecl (const Decl *D) |
Find the first local declaration of a given local redeclarable decl. More... | |
bool | IsLocalDecl (const Decl *D) |
Is this a local declaration (that is, one that will be written to our AST file)? This is the case for declarations that are neither imported from another AST file nor predefined. More... | |
void | AddDeclRef (const Decl *D, RecordDataImpl &Record) |
Emit a reference to a declaration. More... | |
serialization::DeclID | GetDeclRef (const Decl *D) |
Force a declaration to be emitted and get its ID. More... | |
serialization::DeclID | getDeclID (const Decl *D) |
Determine the declaration ID of an already-emitted declaration. More... | |
unsigned | getAnonymousDeclarationNumber (const NamedDecl *D) |
void | AddString (StringRef Str, RecordDataImpl &Record) |
Add a string to the given record. More... | |
bool | PreparePathForOutput (SmallVectorImpl< char > &Path) |
Convert a path from this build process into one that is appropriate for emission in the module file. More... | |
void | AddPath (StringRef Path, RecordDataImpl &Record) |
Add a path to the given record. More... | |
void | EmitRecordWithPath (unsigned Abbrev, RecordDataRef Record, StringRef Path) |
Emit the current record with the given path as a blob. More... | |
void | AddVersionTuple (const VersionTuple &Version, RecordDataImpl &Record) |
Add a version tuple to the given record. More... | |
serialization::SubmoduleID | inferSubmoduleIDFromLocation (SourceLocation Loc) |
Infer the submodule ID that contains an entity at the given source location. More... | |
unsigned | getLocalOrImportedSubmoduleID (Module *Mod) |
Retrieve or create a submodule ID for this module, or return 0 if the submodule is neither local (a submodle of the currently-written module) nor from an imported module. More... | |
void | SetIdentifierOffset (const IdentifierInfo *II, uint32_t Offset) |
Note that the identifier II occurs at the given offset within the identifier table. More... | |
void | SetSelectorOffset (Selector Sel, uint32_t Offset) |
Note that the selector Sel occurs at the given offset within the method pool/selector table. More... | |
unsigned | RecordSwitchCaseID (SwitchCase *S) |
Record an ID for the given switch-case statement. More... | |
unsigned | getSwitchCaseID (SwitchCase *S) |
Retrieve the ID for the given switch-case statement. More... | |
void | ClearSwitchCaseIDs () |
unsigned | getTypeExtQualAbbrev () const |
unsigned | getTypeFunctionProtoAbbrev () const |
unsigned | getDeclParmVarAbbrev () const |
unsigned | getDeclRecordAbbrev () const |
unsigned | getDeclTypedefAbbrev () const |
unsigned | getDeclVarAbbrev () const |
unsigned | getDeclFieldAbbrev () const |
unsigned | getDeclEnumAbbrev () const |
unsigned | getDeclObjCIvarAbbrev () const |
unsigned | getDeclCXXMethodAbbrev () const |
unsigned | getDeclRefExprAbbrev () const |
unsigned | getCharacterLiteralAbbrev () const |
unsigned | getIntegerLiteralAbbrev () const |
unsigned | getExprImplicitCastAbbrev () const |
bool | hasChain () const |
ASTReader * | getChain () const |
![]() | |
virtual | ~ASTDeserializationListener () |
virtual void | DeclRead (serialization::DeclID ID, const Decl *D) |
A decl was deserialized from the AST file. More... | |
![]() | |
virtual | ~ASTMutationListener () |
virtual void | AddedCXXTemplateSpecialization (const ClassTemplateDecl *TD, const ClassTemplateSpecializationDecl *D) |
A template specialization (or partial one) was added to the template declaration. More... | |
virtual void | AddedCXXTemplateSpecialization (const VarTemplateDecl *TD, const VarTemplateSpecializationDecl *D) |
A template specialization (or partial one) was added to the template declaration. More... | |
virtual void | AddedCXXTemplateSpecialization (const FunctionTemplateDecl *TD, const FunctionDecl *D) |
A template specialization (or partial one) was added to the template declaration. More... | |
Friends | |
class | ASTDeclWriter |
class | ASTStmtWriter |
class | ASTTypeWriter |
class | ASTRecordWriter |
Writes an AST file containing the contents of a translation unit.
The ASTWriter class produces a bitstream containing the serialized representation of a given abstract syntax tree and its supporting data structures. This bitstream can be de-serialized via an instance of the ASTReader class.
Definition at line 84 of file ASTWriter.h.
typedef SmallVector<uint64_t, 64> clang::ASTWriter::RecordData |
Definition at line 87 of file ASTWriter.h.
typedef SmallVectorImpl<uint64_t> clang::ASTWriter::RecordDataImpl |
Definition at line 88 of file ASTWriter.h.
typedef ArrayRef<uint64_t> clang::ASTWriter::RecordDataRef |
Definition at line 89 of file ASTWriter.h.
ASTWriter::ASTWriter | ( | llvm::BitstreamWriter & | Stream, |
ArrayRef< llvm::IntrusiveRefCntPtr< ModuleFileExtension >> | Extensions, | ||
bool | IncludeTimestamps = true |
||
) |
Create a new precompiled header writer that outputs to the given bitstream.
Definition at line 4071 of file ASTWriter.cpp.
|
override |
Definition at line 4100 of file ASTWriter.cpp.
void ASTWriter::AddDeclRef | ( | const Decl * | D, |
RecordDataImpl & | Record | ||
) |
Emit a reference to a declaration.
Definition at line 4977 of file ASTWriter.cpp.
References GetDeclRef().
Referenced by clang::ASTRecordWriter::AddCXXDefinitionData(), clang::ASTRecordWriter::AddCXXTemporary(), clang::ASTRecordWriter::AddDeclRef(), AddLazyVectorDecls(), clang::ASTRecordWriter::AddNestedNameSpecifier(), clang::ASTRecordWriter::AddNestedNameSpecifierLoc(), clang::ASTRecordWriter::AddTemplateArgument(), clang::ASTRecordWriter::AddTemplateName(), clang::ASTRecordWriter::AddTemplateParameterList(), and clang::ASTRecordWriter::AddUnresolvedSet().
void ASTWriter::AddIdentifierRef | ( | const IdentifierInfo * | II, |
RecordDataImpl & | Record | ||
) |
Emit a reference to an identifier.
Definition at line 4810 of file ASTWriter.cpp.
References getIdentifierRef().
Referenced by clang::ASTRecordWriter::AddDeclarationName(), clang::ASTRecordWriter::AddIdentifierRef(), clang::ASTRecordWriter::AddNestedNameSpecifier(), clang::ASTRecordWriter::AddNestedNameSpecifierLoc(), and clang::ASTRecordWriter::AddTemplateName().
void ASTWriter::AddPath | ( | StringRef | Path, |
RecordDataImpl & | Record | ||
) |
Add a path to the given record.
Definition at line 4023 of file ASTWriter.cpp.
References FilePath.
Referenced by clang::ASTRecordWriter::AddPath().
void ASTWriter::AddSourceLocation | ( | SourceLocation | Loc, |
RecordDataImpl & | Record | ||
) |
Emit a source location.
Definition at line 4785 of file ASTWriter.cpp.
References clang::SourceLocation::getRawEncoding().
Referenced by clang::ASTRecordWriter::AddASTTemplateArgumentListInfo(), clang::ASTRecordWriter::AddCXXBaseSpecifier(), clang::ASTRecordWriter::AddCXXDefinitionData(), clang::ASTRecordWriter::AddDeclarationNameInfo(), clang::ASTRecordWriter::AddDeclarationNameLoc(), clang::ASTRecordWriter::AddNestedNameSpecifierLoc(), clang::ASTRecordWriter::AddSourceLocation(), AddSourceRange(), clang::ASTRecordWriter::AddTemplateArgumentLocInfo(), and clang::ASTRecordWriter::AddTemplateParameterList().
void ASTWriter::AddSourceRange | ( | SourceRange | Range, |
RecordDataImpl & | Record | ||
) |
Emit a source range.
Definition at line 4790 of file ASTWriter.cpp.
References AddSourceLocation(), clang::SourceRange::getBegin(), and clang::SourceRange::getEnd().
Referenced by clang::ASTRecordWriter::AddCXXBaseSpecifier(), clang::ASTRecordWriter::AddNestedNameSpecifierLoc(), and clang::ASTRecordWriter::AddSourceRange().
void ASTWriter::AddString | ( | StringRef | Str, |
RecordDataImpl & | Record | ||
) |
Add a string to the given record.
Definition at line 4000 of file ASTWriter.cpp.
Referenced by clang::ASTRecordWriter::AddString().
void ASTWriter::AddToken | ( | const Token & | Tok, |
RecordDataImpl & | Record | ||
) |
Emit a token.
Definition at line 3987 of file ASTWriter.cpp.
References clang::Token::getFlags(), clang::Token::getIdentifierInfo(), clang::Token::getKind(), clang::Token::getLength(), and clang::Token::getLocation().
void ASTWriter::AddTypeRef | ( | QualType | T, |
RecordDataImpl & | Record | ||
) |
Emit a reference to a type.
Definition at line 4937 of file ASTWriter.cpp.
References GetOrCreateTypeID().
Referenced by clang::ASTRecordWriter::AddDeclarationName(), clang::ASTRecordWriter::AddNestedNameSpecifier(), clang::ASTRecordWriter::AddTemplateArgument(), clang::ASTRecordWriter::AddTypeLoc(), clang::ASTRecordWriter::AddTypeRef(), and clang::ASTRecordWriter::AddTypeSourceInfo().
void ASTWriter::AddVersionTuple | ( | const VersionTuple & | Version, |
RecordDataImpl & | Record | ||
) |
Add a version tuple to the given record.
Definition at line 4036 of file ASTWriter.cpp.
References clang::VersionTuple::getMajor(), clang::VersionTuple::getMinor(), and clang::VersionTuple::getSubminor().
Referenced by clang::ASTRecordWriter::AddVersionTuple().
void ASTWriter::ClearSwitchCaseIDs | ( | ) |
Definition at line 2500 of file ASTWriterStmt.cpp.
void ASTWriter::EmitRecordWithPath | ( | unsigned | Abbrev, |
RecordDataRef | Record, | ||
StringRef | Path | ||
) |
Emit the current record with the given path as a blob.
Definition at line 4029 of file ASTWriter.cpp.
References FilePath.
Definition at line 5101 of file ASTWriter.cpp.
References clang::serialization::needsAnonymousDeclarationNumber(), and clang::serialization::numberAnonymousDeclsWithin().
|
inline |
Definition at line 656 of file ASTWriter.h.
|
inline |
Definition at line 651 of file ASTWriter.h.
|
inline |
Definition at line 648 of file ASTWriter.h.
|
inline |
Definition at line 646 of file ASTWriter.h.
|
inline |
Definition at line 645 of file ASTWriter.h.
DeclID ASTWriter::getDeclID | ( | const Decl * | D | ) |
Determine the declaration ID of an already-emitted declaration.
Definition at line 5010 of file ASTWriter.cpp.
|
inline |
Definition at line 647 of file ASTWriter.h.
|
inline |
Definition at line 641 of file ASTWriter.h.
|
inline |
Definition at line 642 of file ASTWriter.h.
DeclID ASTWriter::GetDeclRef | ( | const Decl * | D | ) |
Force a declaration to be emitted and get its ID.
Definition at line 4981 of file ASTWriter.cpp.
References ID.
Referenced by AddDeclRef().
|
inline |
Definition at line 650 of file ASTWriter.h.
|
inline |
Definition at line 643 of file ASTWriter.h.
|
inline |
Definition at line 644 of file ASTWriter.h.
|
inline |
Definition at line 653 of file ASTWriter.h.
Find the first local declaration of a given local redeclarable decl.
Definition at line 1564 of file ASTWriterDecl.cpp.
IdentID ASTWriter::getIdentifierRef | ( | const IdentifierInfo * | II | ) |
Get the unique number used to refer to the given identifier.
Definition at line 4814 of file ASTWriter.cpp.
References ID.
Referenced by AddIdentifierRef().
|
inline |
Definition at line 652 of file ASTWriter.h.
const LangOptions & ASTWriter::getLangOpts | ( | ) | const |
Definition at line 4104 of file ASTWriter.cpp.
References clang::ASTContext::getLangOpts().
Retrieve or create a submodule ID for this module, or return 0 if the submodule is neither local (a submodle of the currently-written module) nor from an imported module.
Definition at line 2413 of file ASTWriter.cpp.
References clang::Module::getTopLevelModule(), and clang::if().
uint64_t ASTWriter::getMacroDirectivesOffset | ( | const IdentifierInfo * | Name | ) |
Definition at line 4848 of file ASTWriter.cpp.
Determine the ID of an already-emitted macro.
Definition at line 4840 of file ASTWriter.cpp.
References clang::MacroInfo::isBuiltinMacro().
MacroID ASTWriter::getMacroRef | ( | MacroInfo * | MI, |
const IdentifierInfo * | Name | ||
) |
Get the unique number used to refer to the given macro.
Definition at line 4824 of file ASTWriter.cpp.
References ID, clang::MacroInfo::isBuiltinMacro(), and clang::Name.
Force a type to be emitted and get its ID.
Definition at line 4941 of file ASTWriter.cpp.
References clang::QualType::getLocalFastQualifiers(), clang::QualType::isNull(), and clang::serialization::MakeTypeID().
Referenced by AddTypeRef().
SelectorID ASTWriter::getSelectorRef | ( | Selector | Sel | ) |
Get the unique number used to refer to the given selector.
Definition at line 4856 of file ASTWriter.cpp.
References clang::Selector::getAsOpaquePtr().
unsigned ASTWriter::getSwitchCaseID | ( | SwitchCase * | S | ) |
Retrieve the ID for the given switch-case statement.
Definition at line 2494 of file ASTWriterStmt.cpp.
References S.
time_t ASTWriter::getTimestampForOutput | ( | const FileEntry * | E | ) | const |
Get a timestamp for output into the AST file.
The actual timestamp of the specified file may be ignored if we have been instructed to not include timestamps in the output file.
Definition at line 4109 of file ASTWriter.cpp.
References clang::FileEntry::getModificationTime().
|
inline |
Definition at line 634 of file ASTWriter.h.
|
inline |
Definition at line 637 of file ASTWriter.h.
Determine the type ID of an already-emitted type.
Definition at line 4964 of file ASTWriter.cpp.
References clang::QualType::getLocalFastQualifiers(), I, clang::QualType::isNull(), and clang::serialization::MakeTypeID().
|
inline |
Definition at line 655 of file ASTWriter.h.
serialization::SubmoduleID ASTWriter::inferSubmoduleIDFromLocation | ( | SourceLocation | Loc | ) |
Infer the submodule ID that contains an entity at the given source location.
Definition at line 2667 of file ASTWriter.cpp.
References clang::Preprocessor::getHeaderSearchInfo(), clang::HeaderSearch::getModuleMap(), clang::Preprocessor::getSourceManager(), clang::ModuleMap::inferModuleFromLocation(), clang::SourceLocation::isInvalid(), and clang::Module::isSubModuleOf().
Is this a local declaration (that is, one that will be written to our AST file)? This is the case for declarations that are neither imported from another AST file nor predefined.
Definition at line 571 of file ASTWriter.h.
References I, and clang::serialization::NUM_PREDEF_DECL_IDS.
bool ASTWriter::PreparePathForOutput | ( | SmallVectorImpl< char > & | Path | ) |
Convert a path from this build process into one that is appropriate for emission in the module file.
Definition at line 4005 of file ASTWriter.cpp.
References adjustFilenameForRelocatableAST(), cleanPathForOutput(), clang::SourceManager::getFileManager(), and clang::ASTContext::getSourceManager().
unsigned ASTWriter::RecordSwitchCaseID | ( | SwitchCase * | S | ) |
Record an ID for the given switch-case statement.
Definition at line 2486 of file ASTWriterStmt.cpp.
References S.
void ASTWriter::SetIdentifierOffset | ( | const IdentifierInfo * | II, |
uint32_t | Offset | ||
) |
Note that the identifier II occurs at the given offset within the identifier table.
Definition at line 4051 of file ASTWriter.cpp.
void ASTWriter::SetSelectorOffset | ( | Selector | Sel, |
uint32_t | Offset | ||
) |
Note that the selector Sel occurs at the given offset within the method pool/selector table.
Definition at line 4061 of file ASTWriter.cpp.
uint64_t ASTWriter::WriteAST | ( | Sema & | SemaRef, |
const std::string & | OutputFile, | ||
Module * | WritingModule, | ||
StringRef | isysroot, | ||
bool | hasErrors = false |
||
) |
Write a precompiled header for the given semantic analysis.
SemaRef | a reference to the semantic analysis object that processed the AST to be written into the precompiled header. |
WritingModule | The module that we are writing. If null, we are writing a precompiled header. |
isysroot | if non-empty, write a relocatable file whose headers are relative to the given system root. If we're writing a module, its build directory will be used in preference to this if both are available. |
Definition at line 4113 of file ASTWriter.cpp.
References clang::Sema::Context, and clang::Sema::PP.
Referenced by clang::PCHGenerator::HandleTranslationUnit(), and serializeUnit().
|
friend |
Definition at line 91 of file ASTWriter.h.
|
friend |
Definition at line 94 of file ASTWriter.h.
|
friend |
Definition at line 92 of file ASTWriter.h.
|
friend |
Definition at line 93 of file ASTWriter.h.