clang  3.9.0
Classes | Public Types | Public Member Functions | Friends | List of all members
clang::ASTWriter Class Reference

Writes an AST file containing the contents of a translation unit. More...

#include <ASTWriter.h>

Inheritance diagram for clang::ASTWriter:
[legend]
Collaboration diagram for clang::ASTWriter:
[legend]

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 LangOptionsgetLangOpts () 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 DeclgetFirstLocalDecl (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
 
ASTReadergetChain () const
 
- Public Member Functions inherited from clang::ASTDeserializationListener
virtual ~ASTDeserializationListener ()
 
virtual void DeclRead (serialization::DeclID ID, const Decl *D)
 A decl was deserialized from the AST file. More...
 
- Public Member Functions inherited from clang::ASTMutationListener
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
 

Detailed Description

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.

Member Typedef Documentation

Definition at line 87 of file ASTWriter.h.

Definition at line 88 of file ASTWriter.h.

Definition at line 89 of file ASTWriter.h.

Constructor & Destructor Documentation

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.

ASTWriter::~ASTWriter ( )
override

Definition at line 4100 of file ASTWriter.cpp.

Member Function Documentation

void ASTWriter::AddDeclRef ( const Decl D,
RecordDataImpl Record 
)
void ASTWriter::AddIdentifierRef ( const IdentifierInfo II,
RecordDataImpl Record 
)
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 
)
void ASTWriter::AddSourceRange ( SourceRange  Range,
RecordDataImpl Record 
)
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 
)
void ASTWriter::AddTypeRef ( QualType  T,
RecordDataImpl Record 
)
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.

unsigned ASTWriter::getAnonymousDeclarationNumber ( const NamedDecl D)
ASTReader* clang::ASTWriter::getChain ( ) const
inline

Definition at line 656 of file ASTWriter.h.

unsigned clang::ASTWriter::getCharacterLiteralAbbrev ( ) const
inline

Definition at line 651 of file ASTWriter.h.

unsigned clang::ASTWriter::getDeclCXXMethodAbbrev ( ) const
inline

Definition at line 648 of file ASTWriter.h.

unsigned clang::ASTWriter::getDeclEnumAbbrev ( ) const
inline

Definition at line 646 of file ASTWriter.h.

unsigned clang::ASTWriter::getDeclFieldAbbrev ( ) const
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.

unsigned clang::ASTWriter::getDeclObjCIvarAbbrev ( ) const
inline

Definition at line 647 of file ASTWriter.h.

unsigned clang::ASTWriter::getDeclParmVarAbbrev ( ) const
inline

Definition at line 641 of file ASTWriter.h.

unsigned clang::ASTWriter::getDeclRecordAbbrev ( ) const
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().

unsigned clang::ASTWriter::getDeclRefExprAbbrev ( ) const
inline

Definition at line 650 of file ASTWriter.h.

unsigned clang::ASTWriter::getDeclTypedefAbbrev ( ) const
inline

Definition at line 643 of file ASTWriter.h.

unsigned clang::ASTWriter::getDeclVarAbbrev ( ) const
inline

Definition at line 644 of file ASTWriter.h.

unsigned clang::ASTWriter::getExprImplicitCastAbbrev ( ) const
inline

Definition at line 653 of file ASTWriter.h.

const Decl * ASTWriter::getFirstLocalDecl ( const Decl D)

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().

unsigned clang::ASTWriter::getIntegerLiteralAbbrev ( ) const
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().

unsigned ASTWriter::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.

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.

MacroID ASTWriter::getMacroID ( MacroInfo MI)

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.

TypeID ASTWriter::GetOrCreateTypeID ( QualType  T)

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().

unsigned clang::ASTWriter::getTypeExtQualAbbrev ( ) const
inline

Definition at line 634 of file ASTWriter.h.

unsigned clang::ASTWriter::getTypeFunctionProtoAbbrev ( ) const
inline

Definition at line 637 of file ASTWriter.h.

TypeID ASTWriter::getTypeID ( QualType  T) const

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().

bool clang::ASTWriter::hasChain ( ) const
inline

Definition at line 655 of file ASTWriter.h.

serialization::SubmoduleID ASTWriter::inferSubmoduleIDFromLocation ( SourceLocation  Loc)
bool clang::ASTWriter::IsLocalDecl ( const Decl D)
inline

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.

Parameters
SemaRefa reference to the semantic analysis object that processed the AST to be written into the precompiled header.
WritingModuleThe module that we are writing. If null, we are writing a precompiled header.
isysrootif 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.
Returns
the module signature, which eventually will be a hash of the module but currently is merely a random 32-bit number.

Definition at line 4113 of file ASTWriter.cpp.

References clang::Sema::Context, and clang::Sema::PP.

Referenced by clang::PCHGenerator::HandleTranslationUnit(), and serializeUnit().

Friends And Related Function Documentation

friend class ASTDeclWriter
friend

Definition at line 91 of file ASTWriter.h.

friend class ASTRecordWriter
friend

Definition at line 94 of file ASTWriter.h.

friend class ASTStmtWriter
friend

Definition at line 92 of file ASTWriter.h.

friend class ASTTypeWriter
friend

Definition at line 93 of file ASTWriter.h.


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