clang  7.0.0svn
Classes | Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
clang::ASTUnit Class Reference

Utility class for loading a ASTContext from an AST file. More...

#include "clang/Frontend/ASTUnit.h"

Classes

struct  ASTWriterData
 
struct  CachedCodeCompletionResult
 A cached code-completion result, which may be introduced in one of many different contexts. More...
 
class  ConcurrencyCheck
 
struct  StandaloneDiagnostic
 
struct  StandaloneFixIt
 

Public Types

enum  WhatToLoad { LoadPreprocessorOnly, LoadASTOnly, LoadEverything }
 
using top_level_iterator = std::vector< Decl * >::iterator
 
using stored_diag_iterator = StoredDiagnostic *
 
using stored_diag_const_iterator = const StoredDiagnostic *
 
using cached_completion_iterator = std::vector< CachedCodeCompletionResult >::iterator
 
using DeclVisitorFn = bool(*)(void *context, const Decl *D)
 Type for a function iterating over a number of declarations. More...
 
using RemappedFile = std::pair< std::string, llvm::MemoryBuffer * >
 A mapping from a file name to the memory buffer that stores the remapped contents of that file. More...
 

Public Member Functions

llvm::StringMap< unsigned > & getCachedCompletionTypes ()
 Retrieve the mapping from formatted type names to unique type identifiers. More...
 
std::shared_ptr< GlobalCodeCompletionAllocatorgetCachedCompletionAllocator ()
 Retrieve the allocator used to cache global code completions. More...
 
CodeCompletionTUInfogetCodeCompletionTUInfo ()
 
 ASTUnit (const ASTUnit &)=delete
 
ASTUnitoperator= (const ASTUnit &)=delete
 
 ~ASTUnit ()
 
bool isMainFileAST () const
 
bool isUnsafeToFree () const
 
void setUnsafeToFree (bool Value)
 
const DiagnosticsEnginegetDiagnostics () const
 
DiagnosticsEnginegetDiagnostics ()
 
const SourceManagergetSourceManager () const
 
SourceManagergetSourceManager ()
 
const PreprocessorgetPreprocessor () const
 
PreprocessorgetPreprocessor ()
 
std::shared_ptr< PreprocessorgetPreprocessorPtr () const
 
const ASTContextgetASTContext () const
 
ASTContextgetASTContext ()
 
void setASTContext (ASTContext *ctx)
 
void setPreprocessor (std::shared_ptr< Preprocessor > pp)
 
bool hasSema () const
 
SemagetSema () const
 
const LangOptionsgetLangOpts () const
 
const HeaderSearchOptionsgetHeaderSearchOpts () const
 
const PreprocessorOptionsgetPreprocessorOpts () const
 
const FileManagergetFileManager () const
 
FileManagergetFileManager ()
 
const FileSystemOptionsgetFileSystemOpts () const
 
IntrusiveRefCntPtr< ASTReadergetASTReader () const
 
StringRef getOriginalSourceFileName () const
 
ASTMutationListenergetASTMutationListener ()
 
ASTDeserializationListenergetDeserializationListener ()
 
bool getOnlyLocalDecls () const
 
bool getOwnsRemappedFileBuffers () const
 
void setOwnsRemappedFileBuffers (bool val)
 
StringRef getMainFileName () const
 
StringRef getASTFileName () const
 If this ASTUnit came from an AST file, returns the filename for it. More...
 
top_level_iterator top_level_begin ()
 
top_level_iterator top_level_end ()
 
std::size_t top_level_size () const
 
bool top_level_empty () const
 
void addTopLevelDecl (Decl *D)
 Add a new top-level declaration. More...
 
void addFileLevelDecl (Decl *D)
 Add a new local file-level declaration. More...
 
void findFileRegionDecls (FileID File, unsigned Offset, unsigned Length, SmallVectorImpl< Decl *> &Decls)
 Get the decls that are contained in a file in the Offset/Length range. More...
 
unsigned & getCurrentTopLevelHashValue ()
 Retrieve a reference to the current top-level name hash value. More...
 
SourceLocation getLocation (const FileEntry *File, unsigned Line, unsigned Col) const
 Get the source location for the given file:line:col triplet. More...
 
SourceLocation getLocation (const FileEntry *File, unsigned Offset) const
 Get the source location for the given file:offset pair. More...
 
SourceLocation mapLocationFromPreamble (SourceLocation Loc) const
 If Loc is a loaded location from the preamble, returns the corresponding local location of the main file, otherwise it returns Loc. More...
 
SourceLocation mapLocationToPreamble (SourceLocation Loc) const
 If Loc is a local location of the main file but inside the preamble chunk, returns the corresponding loaded location from the preamble, otherwise it returns Loc. More...
 
bool isInPreambleFileID (SourceLocation Loc) const
 
bool isInMainFileID (SourceLocation Loc) const
 
SourceLocation getStartOfMainFileID () const
 
SourceLocation getEndOfPreambleFileID () const
 
SourceRange mapRangeFromPreamble (SourceRange R) const
 
SourceRange mapRangeToPreamble (SourceRange R) const
 
stored_diag_const_iterator stored_diag_begin () const
 
stored_diag_iterator stored_diag_begin ()
 
stored_diag_const_iterator stored_diag_end () const
 
stored_diag_iterator stored_diag_end ()
 
unsigned stored_diag_size () const
 
stored_diag_iterator stored_diag_afterDriver_begin ()
 
cached_completion_iterator cached_completion_begin ()
 
cached_completion_iterator cached_completion_end ()
 
unsigned cached_completion_size () const
 
llvm::iterator_range< PreprocessingRecord::iteratorgetLocalPreprocessingEntities () const
 Returns an iterator range for the local preprocessing entities of the local Preprocessor, if this is a parsed source file, or the loaded preprocessing entities of the primary module if this is an AST file. More...
 
bool visitLocalTopLevelDecls (void *context, DeclVisitorFn Fn)
 Iterate over local declarations (locally parsed if this is a parsed source file or the loaded declarations of the primary module if this is an AST file). More...
 
const FileEntrygetPCHFile ()
 Get the PCH file if one was included. More...
 
bool isModuleFile () const
 Returns true if the ASTUnit was constructed from a serialized module file. More...
 
std::unique_ptr< llvm::MemoryBuffer > getBufferForFile (StringRef Filename, std::string *ErrorStr=nullptr)
 
TranslationUnitKind getTranslationUnitKind () const
 Determine what kind of translation unit this AST represents. More...
 
InputKind getInputKind () const
 Determine the input kind this AST unit represents. More...
 
bool Reparse (std::shared_ptr< PCHContainerOperations > PCHContainerOps, ArrayRef< RemappedFile > RemappedFiles=None, IntrusiveRefCntPtr< vfs::FileSystem > VFS=nullptr)
 Reparse the source files using the same command-line options that were originally used to produce this translation unit. More...
 
void ResetForParse ()
 Free data that will be re-generated on the next parse. More...
 
void CodeComplete (StringRef File, unsigned Line, unsigned Column, ArrayRef< RemappedFile > RemappedFiles, bool IncludeMacros, bool IncludeCodePatterns, bool IncludeBriefComments, CodeCompleteConsumer &Consumer, std::shared_ptr< PCHContainerOperations > PCHContainerOps, DiagnosticsEngine &Diag, LangOptions &LangOpts, SourceManager &SourceMgr, FileManager &FileMgr, SmallVectorImpl< StoredDiagnostic > &StoredDiagnostics, SmallVectorImpl< const llvm::MemoryBuffer *> &OwnedBuffers)
 Perform code completion at the given file, line, and column within this translation unit. More...
 
bool Save (StringRef File)
 Save this translation unit to a file with the given name. More...
 
bool serialize (raw_ostream &OS)
 Serialize this translation unit with the given output stream. More...
 

Static Public Member Functions

static std::unique_ptr< ASTUnitcreate (std::shared_ptr< CompilerInvocation > CI, IntrusiveRefCntPtr< DiagnosticsEngine > Diags, bool CaptureDiagnostics, bool UserFilesAreVolatile)
 Create a ASTUnit. Gets ownership of the passed CompilerInvocation. More...
 
static std::unique_ptr< ASTUnitLoadFromASTFile (const std::string &Filename, const PCHContainerReader &PCHContainerRdr, WhatToLoad ToLoad, IntrusiveRefCntPtr< DiagnosticsEngine > Diags, const FileSystemOptions &FileSystemOpts, bool UseDebugInfo=false, bool OnlyLocalDecls=false, ArrayRef< RemappedFile > RemappedFiles=None, bool CaptureDiagnostics=false, bool AllowPCHWithCompilerErrors=false, bool UserFilesAreVolatile=false)
 Create a ASTUnit from an AST file. More...
 
static ASTUnitLoadFromCompilerInvocationAction (std::shared_ptr< CompilerInvocation > CI, std::shared_ptr< PCHContainerOperations > PCHContainerOps, IntrusiveRefCntPtr< DiagnosticsEngine > Diags, FrontendAction *Action=nullptr, ASTUnit *Unit=nullptr, bool Persistent=true, StringRef ResourceFilesPath=StringRef(), bool OnlyLocalDecls=false, bool CaptureDiagnostics=false, unsigned PrecompilePreambleAfterNParses=0, bool CacheCodeCompletionResults=false, bool IncludeBriefCommentsInCodeCompletion=false, bool UserFilesAreVolatile=false, std::unique_ptr< ASTUnit > *ErrAST=nullptr)
 Create an ASTUnit from a source file, via a CompilerInvocation object, by invoking the optionally provided ASTFrontendAction. More...
 
static std::unique_ptr< ASTUnitLoadFromCompilerInvocation (std::shared_ptr< CompilerInvocation > CI, std::shared_ptr< PCHContainerOperations > PCHContainerOps, IntrusiveRefCntPtr< DiagnosticsEngine > Diags, FileManager *FileMgr, bool OnlyLocalDecls=false, bool CaptureDiagnostics=false, unsigned PrecompilePreambleAfterNParses=0, TranslationUnitKind TUKind=TU_Complete, bool CacheCodeCompletionResults=false, bool IncludeBriefCommentsInCodeCompletion=false, bool UserFilesAreVolatile=false)
 LoadFromCompilerInvocation - Create an ASTUnit from a source file, via a CompilerInvocation object. More...
 
static ASTUnitLoadFromCommandLine (const char **ArgBegin, const char **ArgEnd, std::shared_ptr< PCHContainerOperations > PCHContainerOps, IntrusiveRefCntPtr< DiagnosticsEngine > Diags, StringRef ResourceFilesPath, bool OnlyLocalDecls=false, bool CaptureDiagnostics=false, ArrayRef< RemappedFile > RemappedFiles=None, bool RemappedFilesKeepOriginalName=true, unsigned PrecompilePreambleAfterNParses=0, TranslationUnitKind TUKind=TU_Complete, bool CacheCodeCompletionResults=false, bool IncludeBriefCommentsInCodeCompletion=false, bool AllowPCHWithCompilerErrors=false, bool SkipFunctionBodies=false, bool SingleFileParse=false, bool UserFilesAreVolatile=false, bool ForSerialization=false, llvm::Optional< StringRef > ModuleFormat=llvm::None, std::unique_ptr< ASTUnit > *ErrAST=nullptr, IntrusiveRefCntPtr< vfs::FileSystem > VFS=nullptr)
 LoadFromCommandLine - Create an ASTUnit from a vector of command line arguments, which must specify exactly one source file. More...
 

Friends

class ConcurrencyCheck
 

Detailed Description

Utility class for loading a ASTContext from an AST file.

Definition at line 85 of file ASTUnit.h.

Member Typedef Documentation

◆ cached_completion_iterator

Definition at line 593 of file ASTUnit.h.

◆ DeclVisitorFn

using clang::ASTUnit::DeclVisitorFn = bool (*)(void *context, const Decl *D)

Type for a function iterating over a number of declarations.

Returns
true to continue iteration and false to abort.

Definition at line 615 of file ASTUnit.h.

◆ RemappedFile

using clang::ASTUnit::RemappedFile = std::pair<std::string, llvm::MemoryBuffer *>

A mapping from a file name to the memory buffer that stores the remapped contents of that file.

Definition at line 641 of file ASTUnit.h.

◆ stored_diag_const_iterator

Definition at line 566 of file ASTUnit.h.

◆ stored_diag_iterator

Definition at line 565 of file ASTUnit.h.

◆ top_level_iterator

using clang::ASTUnit::top_level_iterator = std::vector<Decl *>::iterator

Definition at line 481 of file ASTUnit.h.

Member Enumeration Documentation

◆ WhatToLoad

Enumerator
LoadPreprocessorOnly 

Load options and the preprocessor state.

LoadASTOnly 

Load the AST, but do not restore Sema state.

LoadEverything 

Load everything, including Sema.

Definition at line 649 of file ASTUnit.h.

Constructor & Destructor Documentation

◆ ASTUnit()

clang::ASTUnit::ASTUnit ( const ASTUnit )
delete

◆ ~ASTUnit()

ASTUnit::~ASTUnit ( )

Member Function Documentation

◆ addFileLevelDecl()

void ASTUnit::addFileLevelDecl ( Decl D)

◆ addTopLevelDecl()

void clang::ASTUnit::addTopLevelDecl ( Decl D)
inline

Add a new top-level declaration.

Definition at line 508 of file ASTUnit.h.

◆ cached_completion_begin()

cached_completion_iterator clang::ASTUnit::cached_completion_begin ( )
inline

Definition at line 595 of file ASTUnit.h.

◆ cached_completion_end()

cached_completion_iterator clang::ASTUnit::cached_completion_end ( )
inline

Definition at line 599 of file ASTUnit.h.

◆ cached_completion_size()

unsigned clang::ASTUnit::cached_completion_size ( ) const
inline

Definition at line 603 of file ASTUnit.h.

◆ CodeComplete()

void ASTUnit::CodeComplete ( StringRef  File,
unsigned  Line,
unsigned  Column,
ArrayRef< RemappedFile RemappedFiles,
bool  IncludeMacros,
bool  IncludeCodePatterns,
bool  IncludeBriefComments,
CodeCompleteConsumer Consumer,
std::shared_ptr< PCHContainerOperations PCHContainerOps,
DiagnosticsEngine Diag,
LangOptions LangOpts,
SourceManager SourceMgr,
FileManager FileMgr,
SmallVectorImpl< StoredDiagnostic > &  StoredDiagnostics,
SmallVectorImpl< const llvm::MemoryBuffer *> &  OwnedBuffers 
)

Perform code completion at the given file, line, and column within this translation unit.

Parameters
FileThe file in which code completion will occur.
LineThe line at which code completion will occur.
ColumnThe column at which code completion will occur.
IncludeMacrosWhether to include macros in the code-completion results.
IncludeCodePatternsWhether to include code patterns (such as a for loop) in the code-completion results.
IncludeBriefCommentsWhether to include brief documentation within the set of code completions returned.

FIXME: The Diag, LangOpts, SourceMgr, FileMgr, StoredDiagnostics, and OwnedBuffers parameters are all disgusting hacks. They will go away.

Definition at line 2086 of file ASTUnit.cpp.

References clang::PreprocessorOptions::addRemappedFile(), clang::PreprocessorOptions::clearRemappedFiles(), clang::FrontendOptions::CodeCompleteOpts, clang::FrontendOptions::CodeCompletionAt, clang::ParsedSourceLocation::Column, clang::TargetInfo::CreateTargetInfo(), clang::PreprocessorOptions::DetailedRecord, clang::ParsedSourceLocation::FileName, clang::FileManager::getVirtualFileSystem(), clang::CodeCompleteOptions::IncludeBriefComments, clang::CodeCompleteOptions::IncludeCodePatterns, clang::CodeCompleteOptions::IncludeGlobals, clang::CodeCompleteOptions::IncludeMacros, clang::ParsedSourceLocation::Line, Line, clang::InputKind::LLVM_IR, clang::CodeCompleteOptions::LoadExternal, clang::CodeCompleteConsumer::loadExternal(), clang::PreprocessorOptions::PrecompiledPreambleBytes, clang::ProcessWarningOptions(), clang::PreprocessorOptions::RetainRemappedFileBuffers, and clang::InputKind::Source.

◆ create()

std::unique_ptr< ASTUnit > ASTUnit::create ( std::shared_ptr< CompilerInvocation CI,
IntrusiveRefCntPtr< DiagnosticsEngine Diags,
bool  CaptureDiagnostics,
bool  UserFilesAreVolatile 
)
static

Create a ASTUnit. Gets ownership of the passed CompilerInvocation.

Definition at line 1451 of file ASTUnit.cpp.

References clang::createVFSFromCompilerInvocation().

Referenced by LoadFromCompilerInvocationAction().

◆ findFileRegionDecls()

void ASTUnit::findFileRegionDecls ( FileID  File,
unsigned  Offset,
unsigned  Length,
SmallVectorImpl< Decl *> &  Decls 
)

Get the decls that are contained in a file in the Offset/Length range.

Length can be 0 to indicate a point at Offset instead of a range.

Definition at line 2405 of file ASTUnit.cpp.

References clang::FileID::isInvalid().

◆ getASTContext() [1/2]

const ASTContext& clang::ASTUnit::getASTContext ( ) const
inline

◆ getASTContext() [2/2]

ASTContext& clang::ASTUnit::getASTContext ( )
inline

Definition at line 430 of file ASTUnit.h.

◆ getASTFileName()

StringRef ASTUnit::getASTFileName ( ) const

If this ASTUnit came from an AST file, returns the filename for it.

Definition at line 1441 of file ASTUnit.cpp.

References clang::serialization::ModuleFile::FileName, and isMainFileAST().

◆ getASTMutationListener()

ASTMutationListener * ASTUnit::getASTMutationListener ( )

Definition at line 695 of file ASTUnit.cpp.

◆ getASTReader()

IntrusiveRefCntPtr< ASTReader > ASTUnit::getASTReader ( ) const

Definition at line 691 of file ASTUnit.cpp.

◆ getBufferForFile()

std::unique_ptr< llvm::MemoryBuffer > ASTUnit::getBufferForFile ( StringRef  Filename,
std::string *  ErrorStr = nullptr 
)

Definition at line 708 of file ASTUnit.cpp.

◆ getCachedCompletionAllocator()

std::shared_ptr<GlobalCodeCompletionAllocator> clang::ASTUnit::getCachedCompletionAllocator ( )
inline

Retrieve the allocator used to cache global code completions.

Definition at line 305 of file ASTUnit.h.

◆ getCachedCompletionTypes()

llvm::StringMap<unsigned>& clang::ASTUnit::getCachedCompletionTypes ( )
inline

Retrieve the mapping from formatted type names to unique type identifiers.

Definition at line 299 of file ASTUnit.h.

◆ getCodeCompletionTUInfo()

CodeCompletionTUInfo& clang::ASTUnit::getCodeCompletionTUInfo ( )
inline

Definition at line 309 of file ASTUnit.h.

◆ getCurrentTopLevelHashValue()

unsigned& clang::ASTUnit::getCurrentTopLevelHashValue ( )
inline

Retrieve a reference to the current top-level name hash value.

Note: This is used internally by the top-level tracking action

Definition at line 524 of file ASTUnit.h.

References Line.

Referenced by LoadFromCompilerInvocationAction().

◆ getDeserializationListener()

ASTDeserializationListener * ASTUnit::getDeserializationListener ( )

Definition at line 701 of file ASTUnit.cpp.

◆ getDiagnostics() [1/2]

const DiagnosticsEngine& clang::ASTUnit::getDiagnostics ( ) const
inline

◆ getDiagnostics() [2/2]

DiagnosticsEngine& clang::ASTUnit::getDiagnostics ( )
inline

Definition at line 420 of file ASTUnit.h.

◆ getEndOfPreambleFileID()

SourceLocation ASTUnit::getEndOfPreambleFileID ( ) const

Definition at line 2526 of file ASTUnit.cpp.

References clang::FileID::isInvalid().

◆ getFileManager() [1/2]

const FileManager& clang::ASTUnit::getFileManager ( ) const
inline

◆ getFileManager() [2/2]

FileManager& clang::ASTUnit::getFileManager ( )
inline

Definition at line 458 of file ASTUnit.h.

◆ getFileSystemOpts()

const FileSystemOptions& clang::ASTUnit::getFileSystemOpts ( ) const
inline

Definition at line 460 of file ASTUnit.h.

◆ getHeaderSearchOpts()

const HeaderSearchOptions& clang::ASTUnit::getHeaderSearchOpts ( ) const
inline

Definition at line 447 of file ASTUnit.h.

Referenced by LoadFromCompilerInvocationAction().

◆ getInputKind()

InputKind ASTUnit::getInputKind ( ) const

◆ getLangOpts()

const LangOptions& clang::ASTUnit::getLangOpts ( ) const
inline

Definition at line 442 of file ASTUnit.h.

Referenced by getInputKind(), and isModuleFile().

◆ getLocalPreprocessingEntities()

llvm::iterator_range< PreprocessingRecord::iterator > ASTUnit::getLocalPreprocessingEntities ( ) const

Returns an iterator range for the local preprocessing entities of the local Preprocessor, if this is a parsed source file, or the loaded preprocessing entities of the primary module if this is an AST file.

Definition at line 2549 of file ASTUnit.cpp.

References isMainFileAST().

◆ getLocation() [1/2]

SourceLocation ASTUnit::getLocation ( const FileEntry File,
unsigned  Line,
unsigned  Col 
) const

Get the source location for the given file:line:col triplet.

The difference with SourceManager::getLocation is that this method checks whether the requested location points inside the precompiled preamble in which case the returned source location will be a "loaded" one.

Definition at line 2448 of file ASTUnit.cpp.

References clang::SourceManager::getMacroArgExpandedLocation(), getSourceManager(), SM, and clang::SourceManager::translateFileLineCol().

◆ getLocation() [2/2]

SourceLocation ASTUnit::getLocation ( const FileEntry File,
unsigned  Offset 
) const

◆ getMainFileName()

StringRef ASTUnit::getMainFileName ( ) const

◆ getOnlyLocalDecls()

bool clang::ASTUnit::getOnlyLocalDecls ( ) const
inline

Definition at line 471 of file ASTUnit.h.

◆ getOriginalSourceFileName()

StringRef clang::ASTUnit::getOriginalSourceFileName ( ) const
inline

Definition at line 464 of file ASTUnit.h.

◆ getOwnsRemappedFileBuffers()

bool clang::ASTUnit::getOwnsRemappedFileBuffers ( ) const
inline

Definition at line 473 of file ASTUnit.h.

◆ getPCHFile()

const FileEntry * ASTUnit::getPCHFile ( )

Get the PCH file if one was included.

Definition at line 2585 of file ASTUnit.cpp.

References clang::serialization::ModuleFile::File, and clang::serialization::ModuleFile::Kind.

◆ getPreprocessor() [1/2]

const Preprocessor& clang::ASTUnit::getPreprocessor ( ) const
inline

Definition at line 425 of file ASTUnit.h.

◆ getPreprocessor() [2/2]

Preprocessor& clang::ASTUnit::getPreprocessor ( )
inline

Definition at line 426 of file ASTUnit.h.

◆ getPreprocessorOpts()

const PreprocessorOptions& clang::ASTUnit::getPreprocessorOpts ( ) const
inline

Definition at line 452 of file ASTUnit.h.

◆ getPreprocessorPtr()

std::shared_ptr<Preprocessor> clang::ASTUnit::getPreprocessorPtr ( ) const
inline

Definition at line 427 of file ASTUnit.h.

Referenced by clang::index::indexASTUnit().

◆ getSema()

Sema& clang::ASTUnit::getSema ( ) const
inline

Definition at line 437 of file ASTUnit.h.

Referenced by serialize().

◆ getSourceManager() [1/2]

const SourceManager& clang::ASTUnit::getSourceManager ( ) const
inline

Definition at line 422 of file ASTUnit.h.

Referenced by checkAndSanitizeDiags(), getLocation(), and LoadFromCompilerInvocationAction().

◆ getSourceManager() [2/2]

SourceManager& clang::ASTUnit::getSourceManager ( )
inline

Definition at line 423 of file ASTUnit.h.

◆ getStartOfMainFileID()

SourceLocation ASTUnit::getStartOfMainFileID ( ) const

Definition at line 2537 of file ASTUnit.cpp.

References clang::FileID::isInvalid().

◆ getTranslationUnitKind()

TranslationUnitKind clang::ASTUnit::getTranslationUnitKind ( ) const
inline

Determine what kind of translation unit this AST represents.

Definition at line 634 of file ASTUnit.h.

◆ hasSema()

bool clang::ASTUnit::hasSema ( ) const
inline

Definition at line 435 of file ASTUnit.h.

◆ isInMainFileID()

bool ASTUnit::isInMainFileID ( SourceLocation  Loc) const

Definition at line 2515 of file ASTUnit.cpp.

References clang::FileID::isInvalid(), and clang::SourceLocation::isInvalid().

◆ isInPreambleFileID()

bool ASTUnit::isInPreambleFileID ( SourceLocation  Loc) const

Definition at line 2504 of file ASTUnit.cpp.

References clang::FileID::isInvalid(), and clang::SourceLocation::isInvalid().

◆ isMainFileAST()

bool clang::ASTUnit::isMainFileAST ( ) const
inline

◆ isModuleFile()

bool ASTUnit::isModuleFile ( ) const

Returns true if the ASTUnit was constructed from a serialized module file.

Definition at line 2613 of file ASTUnit.cpp.

References getLangOpts(), clang::LangOptions::isCompilingModule(), and isMainFileAST().

◆ isUnsafeToFree()

bool clang::ASTUnit::isUnsafeToFree ( ) const
inline

Definition at line 416 of file ASTUnit.h.

◆ LoadFromASTFile()

std::unique_ptr< ASTUnit > ASTUnit::LoadFromASTFile ( const std::string &  Filename,
const PCHContainerReader PCHContainerRdr,
WhatToLoad  ToLoad,
IntrusiveRefCntPtr< DiagnosticsEngine Diags,
const FileSystemOptions FileSystemOpts,
bool  UseDebugInfo = false,
bool  OnlyLocalDecls = false,
ArrayRef< RemappedFile RemappedFiles = None,
bool  CaptureDiagnostics = false,
bool  AllowPCHWithCompilerErrors = false,
bool  UserFilesAreVolatile = false 
)
static

Create a ASTUnit from an AST file.

Parameters
Filename- The AST file to load.
PCHContainerRdr- The PCHContainerOperations to use for loading and creating modules.
Diags- The diagnostics engine to use for reporting errors; its lifetime is expected to extend past that of the returned ASTUnit.
Returns
- The initialized ASTUnit or null if the AST failed to load.

Definition at line 726 of file ASTUnit.cpp.

References clang::ASTReader::ARR_None, clang::ASTReader::ConfigurationMismatch, clang::ASTReader::Failure, clang::PCHContainerReader::getFormat(), clang::vfs::getRealFileSystem(), clang::ASTReader::HadErrors, LoadASTOnly, LoadEverything, clang::ASTReader::Missing, clang::serialization::MK_MainFile, clang::ASTReader::OutOfDate, clang::ASTReader::setListener(), clang::ASTReader::Success, and clang::ASTReader::VersionMismatch.

Referenced by clang::FrontendAction::BeginSourceFile(), and clang::cross_tu::CrossTranslationUnitContext::loadExternalAST().

◆ LoadFromCommandLine()

ASTUnit * ASTUnit::LoadFromCommandLine ( const char **  ArgBegin,
const char **  ArgEnd,
std::shared_ptr< PCHContainerOperations PCHContainerOps,
IntrusiveRefCntPtr< DiagnosticsEngine Diags,
StringRef  ResourceFilesPath,
bool  OnlyLocalDecls = false,
bool  CaptureDiagnostics = false,
ArrayRef< RemappedFile RemappedFiles = None,
bool  RemappedFilesKeepOriginalName = true,
unsigned  PrecompilePreambleAfterNParses = 0,
TranslationUnitKind  TUKind = TU_Complete,
bool  CacheCodeCompletionResults = false,
bool  IncludeBriefCommentsInCodeCompletion = false,
bool  AllowPCHWithCompilerErrors = false,
bool  SkipFunctionBodies = false,
bool  SingleFileParse = false,
bool  UserFilesAreVolatile = false,
bool  ForSerialization = false,
llvm::Optional< StringRef >  ModuleFormat = llvm::None,
std::unique_ptr< ASTUnit > *  ErrAST = nullptr,
IntrusiveRefCntPtr< vfs::FileSystem VFS = nullptr 
)
static

LoadFromCommandLine - Create an ASTUnit from a vector of command line arguments, which must specify exactly one source file.

Parameters
ArgBegin- The beginning of the argument vector.
ArgEnd- The end of the argument vector.
PCHContainerOps- The PCHContainerOperations to use for loading and creating modules.
Diags- The diagnostics engine to use for reporting errors; its lifetime is expected to extend past that of the returned ASTUnit.
ResourceFilesPath- The path to the compiler resource files.
ModuleFormat- If provided, uses the specific module format.
ErrAST- If non-null and parsing failed without any AST to return (e.g. because the PCH could not be loaded), this accepts the ASTUnit mainly to allow the caller to see the diagnostics.
VFS- A vfs::FileSystem to be used for all file accesses. Note that preamble is saved to a temporary directory on a RealFileSystem, so in order for it to be loaded correctly, VFS should have access to it(i.e., be an overlay over RealFileSystem). RealFileSystem will be used if VFS is nullptr.

Definition at line 1686 of file ASTUnit.cpp.

References clang::PreprocessorOptions::AllowPCHWithCompilerErrors, clang::createInvocationFromCommandLine(), clang::createVFSFromCompilerInvocation(), clang::vfs::getRealFileSystem(), clang::PreprocessorOptions::RemappedFilesKeepOriginalName, and clang::PreprocessorOptions::SingleFileParseMode.

◆ LoadFromCompilerInvocation()

std::unique_ptr< ASTUnit > ASTUnit::LoadFromCompilerInvocation ( std::shared_ptr< CompilerInvocation CI,
std::shared_ptr< PCHContainerOperations PCHContainerOps,
IntrusiveRefCntPtr< DiagnosticsEngine Diags,
FileManager FileMgr,
bool  OnlyLocalDecls = false,
bool  CaptureDiagnostics = false,
unsigned  PrecompilePreambleAfterNParses = 0,
TranslationUnitKind  TUKind = TU_Complete,
bool  CacheCodeCompletionResults = false,
bool  IncludeBriefCommentsInCodeCompletion = false,
bool  UserFilesAreVolatile = false 
)
static

LoadFromCompilerInvocation - Create an ASTUnit from a source file, via a CompilerInvocation object.

Parameters
CI- The compiler invocation to use; it must have exactly one input source file. The ASTUnit takes ownership of the CompilerInvocation object.
PCHContainerOps- The PCHContainerOperations to use for loading and creating modules.
Diags- The diagnostics engine to use for reporting errors; its lifetime is expected to extend past that of the returned ASTUnit.

Definition at line 1649 of file ASTUnit.cpp.

References clang::FileManager::getFileSystemOpts().

◆ LoadFromCompilerInvocationAction()

ASTUnit * ASTUnit::LoadFromCompilerInvocationAction ( std::shared_ptr< CompilerInvocation CI,
std::shared_ptr< PCHContainerOperations PCHContainerOps,
IntrusiveRefCntPtr< DiagnosticsEngine Diags,
FrontendAction Action = nullptr,
ASTUnit Unit = nullptr,
bool  Persistent = true,
StringRef  ResourceFilesPath = StringRef(),
bool  OnlyLocalDecls = false,
bool  CaptureDiagnostics = false,
unsigned  PrecompilePreambleAfterNParses = 0,
bool  CacheCodeCompletionResults = false,
bool  IncludeBriefCommentsInCodeCompletion = false,
bool  UserFilesAreVolatile = false,
std::unique_ptr< ASTUnit > *  ErrAST = nullptr 
)
static

Create an ASTUnit from a source file, via a CompilerInvocation object, by invoking the optionally provided ASTFrontendAction.

Parameters
CI- The compiler invocation to use; it must have exactly one input source file. The ASTUnit takes ownership of the CompilerInvocation object.
PCHContainerOps- The PCHContainerOperations to use for loading and creating modules.
Diags- The diagnostics engine to use for reporting errors; its lifetime is expected to extend past that of the returned ASTUnit.
Action- The ASTFrontendAction to invoke. Its ownership is not transferred.
Unit- optionally an already created ASTUnit. Its ownership is not transferred.
Persistent- if true the returned ASTUnit will be complete. false means the caller is only interested in getting info through the provided
See also
Action.
Parameters
ErrAST- If non-null and parsing failed without any AST to return (e.g. because the PCH could not be loaded), this accepts the ASTUnit mainly to allow the caller to see the diagnostics. This will only receive an ASTUnit if a new one was created. If an already created ASTUnit was passed in Unit then the caller can check that.

Definition at line 1470 of file ASTUnit.cpp.

References clang::FrontendAction::BeginSourceFile(), create(), clang::TargetInfo::CreateTargetInfo(), clang::FrontendAction::EndSourceFile(), clang::FrontendAction::Execute(), getCurrentTopLevelHashValue(), getDiagnostics(), getFileManager(), getHeaderSearchOpts(), getMainFileName(), getSourceManager(), clang::FrontendAction::getTranslationUnitKind(), clang::InputKind::LLVM_IR, clang::ProcessWarningOptions(), clang::DiagnosticsEngine::Reset(), clang::HeaderSearchOptions::ResourceDir, clang::InputKind::Source, and clang::TU_Complete.

Referenced by clang::arcmt::MigrationProcess::applyTransform(), and clang::arcmt::checkForManualIssues().

◆ mapLocationFromPreamble()

SourceLocation ASTUnit::mapLocationFromPreamble ( SourceLocation  Loc) const

If Loc is a loaded location from the preamble, returns the corresponding local location of the main file, otherwise it returns Loc.

If.

  • Loc is a loaded location from the preamble, returns the corresponding local location of the main file, otherwise it returns
  • Loc.

Definition at line 2465 of file ASTUnit.cpp.

References clang::SourceLocation::getLocWithOffset(), clang::FileID::isInvalid(), and clang::SourceLocation::isInvalid().

◆ mapLocationToPreamble()

SourceLocation ASTUnit::mapLocationToPreamble ( SourceLocation  Loc) const

If Loc is a local location of the main file but inside the preamble chunk, returns the corresponding loaded location from the preamble, otherwise it returns Loc.

If.

  • Loc is a local location of the main file but inside the preamble chunk, returns the corresponding loaded location from the preamble, otherwise it returns
  • Loc.

Definition at line 2486 of file ASTUnit.cpp.

References clang::SourceLocation::getLocWithOffset(), clang::FileID::isInvalid(), and clang::SourceLocation::isInvalid().

◆ mapRangeFromPreamble()

SourceRange clang::ASTUnit::mapRangeFromPreamble ( SourceRange  R) const
inline

◆ mapRangeToPreamble()

SourceRange clang::ASTUnit::mapRangeToPreamble ( SourceRange  R) const
inline

◆ operator=()

ASTUnit& clang::ASTUnit::operator= ( const ASTUnit )
delete

◆ Reparse()

bool ASTUnit::Reparse ( std::shared_ptr< PCHContainerOperations PCHContainerOps,
ArrayRef< RemappedFile RemappedFiles = None,
IntrusiveRefCntPtr< vfs::FileSystem VFS = nullptr 
)

Reparse the source files using the same command-line options that were originally used to produce this translation unit.

Parameters
VFS- A vfs::FileSystem to be used for all file accesses. Note that preamble is saved to a temporary directory on a RealFileSystem, so in order for it to be loaded correctly, VFS should give an access to this(i.e. be an overlay over RealFileSystem). FileMgr->getVirtualFileSystem() will be used if VFS is nullptr.
Returns
True if a failure occurred that causes the ASTUnit not to contain any translation-unit information, false otherwise.

Definition at line 1778 of file ASTUnit.cpp.

References clang::PreprocessorOptions::clearRemappedFiles(), getDiagnostics(), getMainFileName(), clang::ProcessWarningOptions(), clang::PreprocessorOptions::RemappedFileBuffers, clang::DiagnosticsEngine::Reset(), clang::Result, and clang::DiagnosticsEngine::setNumWarnings().

◆ ResetForParse()

void ASTUnit::ResetForParse ( )

Free data that will be re-generated on the next parse.

Preamble-related data is not affected.

Definition at line 1836 of file ASTUnit.cpp.

Referenced by checkAndSanitizeDiags().

◆ Save()

bool ASTUnit::Save ( StringRef  File)

Save this translation unit to a file with the given name.

Returns
true if there was a file error or false if the save was successful.

Definition at line 2242 of file ASTUnit.cpp.

References serialize().

◆ serialize()

bool ASTUnit::serialize ( raw_ostream &  OS)

Serialize this translation unit with the given output stream.

Returns
True if an error occurred, false otherwise.

Definition at line 2288 of file ASTUnit.cpp.

References getDiagnostics(), getSema(), clang::DiagnosticsEngine::hasUncompilableErrorOccurred(), and serializeUnit().

Referenced by Save().

◆ setASTContext()

void clang::ASTUnit::setASTContext ( ASTContext ctx)
inline

Definition at line 432 of file ASTUnit.h.

◆ setOwnsRemappedFileBuffers()

void clang::ASTUnit::setOwnsRemappedFileBuffers ( bool  val)
inline

Definition at line 474 of file ASTUnit.h.

◆ setPreprocessor()

void ASTUnit::setPreprocessor ( std::shared_ptr< Preprocessor pp)

Definition at line 273 of file ASTUnit.cpp.

◆ setUnsafeToFree()

void clang::ASTUnit::setUnsafeToFree ( bool  Value)
inline

Definition at line 417 of file ASTUnit.h.

◆ stored_diag_afterDriver_begin()

stored_diag_iterator clang::ASTUnit::stored_diag_afterDriver_begin ( )
inline

Definition at line 586 of file ASTUnit.h.

◆ stored_diag_begin() [1/2]

stored_diag_const_iterator clang::ASTUnit::stored_diag_begin ( ) const
inline

Definition at line 568 of file ASTUnit.h.

◆ stored_diag_begin() [2/2]

stored_diag_iterator clang::ASTUnit::stored_diag_begin ( )
inline

Definition at line 572 of file ASTUnit.h.

◆ stored_diag_end() [1/2]

stored_diag_const_iterator clang::ASTUnit::stored_diag_end ( ) const
inline

Definition at line 576 of file ASTUnit.h.

◆ stored_diag_end() [2/2]

stored_diag_iterator clang::ASTUnit::stored_diag_end ( )
inline

Definition at line 580 of file ASTUnit.h.

◆ stored_diag_size()

unsigned clang::ASTUnit::stored_diag_size ( ) const
inline

Definition at line 584 of file ASTUnit.h.

◆ top_level_begin()

top_level_iterator clang::ASTUnit::top_level_begin ( )
inline

Definition at line 483 of file ASTUnit.h.

Referenced by visitLocalTopLevelDecls().

◆ top_level_empty()

bool clang::ASTUnit::top_level_empty ( ) const
inline

Definition at line 502 of file ASTUnit.h.

◆ top_level_end()

top_level_iterator clang::ASTUnit::top_level_end ( )
inline

Definition at line 490 of file ASTUnit.h.

Referenced by visitLocalTopLevelDecls().

◆ top_level_size()

std::size_t clang::ASTUnit::top_level_size ( ) const
inline

Definition at line 497 of file ASTUnit.h.

◆ visitLocalTopLevelDecls()

bool ASTUnit::visitLocalTopLevelDecls ( void *  context,
DeclVisitorFn  Fn 
)

Iterate over local declarations (locally parsed if this is a parsed source file or the loaded declarations of the primary module if this is an AST file).

Returns
true if the iteration was complete or false if it was aborted.

Definition at line 2563 of file ASTUnit.cpp.

References isMainFileAST(), top_level_begin(), and top_level_end().

Referenced by indexTranslationUnit().

Friends And Related Function Documentation

◆ ConcurrencyCheck

friend class ConcurrencyCheck
friend

Definition at line 395 of file ASTUnit.h.


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