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.

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.

Public Member Functions
llvm::StringMap< unsigned > &	getCachedCompletionTypes ()
	Retrieve the mapping from formatted type names to unique type identifiers.

std::shared_ptr< GlobalCodeCompletionAllocator >	getCachedCompletionAllocator ()
	Retrieve the allocator used to cache global code completions.

CodeCompletionTUInfo &	getCodeCompletionTUInfo ()

	ASTUnit (const ASTUnit &)=delete

ASTUnit &	operator= (const ASTUnit &)=delete

	~ASTUnit ()

bool	isMainFileAST () const

bool	isUnsafeToFree () const

void	setUnsafeToFree (bool Value)

const DiagnosticsEngine &	getDiagnostics () const

DiagnosticsEngine &	getDiagnostics ()

const SourceManager &	getSourceManager () const

SourceManager &	getSourceManager ()

const Preprocessor &	getPreprocessor () const

Preprocessor &	getPreprocessor ()

std::shared_ptr< Preprocessor >	getPreprocessorPtr () const

const ASTContext &	getASTContext () const

ASTContext &	getASTContext ()

void	setASTContext (ASTContext *ctx)

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

void	enableSourceFileDiagnostics ()
	Enable source-range based diagnostic messages.

bool	hasSema () const

Sema &	getSema () const

const LangOptions &	getLangOpts () const

const HeaderSearchOptions &	getHeaderSearchOpts () const

const PreprocessorOptions &	getPreprocessorOpts () const

const FileManager &	getFileManager () const

FileManager &	getFileManager ()

const FileSystemOptions &	getFileSystemOpts () const

IntrusiveRefCntPtr< ASTReader >	getASTReader () const

StringRef	getOriginalSourceFileName () const

ASTMutationListener *	getASTMutationListener ()

ASTDeserializationListener *	getDeserializationListener ()

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.

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.

void	addFileLevelDecl (Decl *D)
	Add a new local file-level declaration.

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.

unsigned &	getCurrentTopLevelHashValue ()
	Retrieve a reference to the current top-level name hash value.

SourceLocation	getLocation (const FileEntry *File, unsigned Line, unsigned Col) const
	Get the source location for the given file:line:col triplet.

SourceLocation	getLocation (const FileEntry *File, unsigned Offset) const
	Get the source location for the given file:offset pair.

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`.

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`.

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

unsigned	getPreambleCounterForTests () 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::iterator >	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.

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

OptionalFileEntryRef	getPCHFile ()
	Get the PCH file if one was included.

bool	isModuleFile () const
	Returns true if the ASTUnit was constructed from a serialized module file.

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

TranslationUnitKind	getTranslationUnitKind () const
	Determine what kind of translation unit this AST represents.

InputKind	getInputKind () const
	Determine the input kind this AST unit represents.

bool	Reparse (std::shared_ptr< PCHContainerOperations > PCHContainerOps, ArrayRef< RemappedFile > RemappedFiles={}, IntrusiveRefCntPtr< llvm::vfs::FileSystem > VFS=nullptr)
	Reparse the source files using the same command-line options that were originally used to produce this translation unit.

void	ResetForParse ()
	Free data that will be re-generated on the next parse.

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, std::unique_ptr< SyntaxOnlyAction > Act)
	Perform code completion at the given file, line, and column within this translation unit.

bool	Save (StringRef File)
	Save this translation unit to a file with the given name.

bool	serialize (raw_ostream &OS)
	Serialize this translation unit with the given output stream.

Static Public Member Functions
static std::unique_ptr< ASTUnit >	create (std::shared_ptr< CompilerInvocation > CI, IntrusiveRefCntPtr< DiagnosticsEngine > Diags, CaptureDiagsKind CaptureDiagnostics, bool UserFilesAreVolatile)
	Create a ASTUnit. Gets ownership of the passed CompilerInvocation.

static std::unique_ptr< ASTUnit >	LoadFromASTFile (StringRef Filename, const PCHContainerReader &PCHContainerRdr, WhatToLoad ToLoad, IntrusiveRefCntPtr< DiagnosticsEngine > Diags, const FileSystemOptions &FileSystemOpts, std::shared_ptr< HeaderSearchOptions > HSOpts, std::shared_ptr< LangOptions > LangOpts=nullptr, bool OnlyLocalDecls=false, CaptureDiagsKind CaptureDiagnostics=CaptureDiagsKind::None, bool AllowASTWithCompilerErrors=false, bool UserFilesAreVolatile=false, IntrusiveRefCntPtr< llvm::vfs::FileSystem > VFS=llvm::vfs::getRealFileSystem())
	Create a ASTUnit from an AST file.

static 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, CaptureDiagsKind CaptureDiagnostics=CaptureDiagsKind::None, unsigned PrecompilePreambleAfterNParses=0, bool CacheCodeCompletionResults=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.

static std::unique_ptr< ASTUnit >	LoadFromCompilerInvocation (std::shared_ptr< CompilerInvocation > CI, std::shared_ptr< PCHContainerOperations > PCHContainerOps, IntrusiveRefCntPtr< DiagnosticsEngine > Diags, FileManager *FileMgr, bool OnlyLocalDecls=false, CaptureDiagsKind CaptureDiagnostics=CaptureDiagsKind::None, 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.

static std::unique_ptr< ASTUnit >	LoadFromCommandLine (const char ArgBegin, const char ArgEnd, std::shared_ptr< PCHContainerOperations > PCHContainerOps, IntrusiveRefCntPtr< DiagnosticsEngine > Diags, StringRef ResourceFilesPath, bool StorePreamblesInMemory=false, StringRef PreambleStoragePath=StringRef(), bool OnlyLocalDecls=false, CaptureDiagsKind CaptureDiagnostics=CaptureDiagsKind::None, ArrayRef< RemappedFile > RemappedFiles={}, bool RemappedFilesKeepOriginalName=true, unsigned PrecompilePreambleAfterNParses=0, TranslationUnitKind TUKind=TU_Complete, bool CacheCodeCompletionResults=false, bool IncludeBriefCommentsInCodeCompletion=false, bool AllowPCHWithCompilerErrors=false, SkipFunctionBodiesScope SkipFunctionBodies=SkipFunctionBodiesScope::None, bool SingleFileParse=false, bool UserFilesAreVolatile=false, bool ForSerialization=false, bool RetainExcludedConditionalBlocks=false, std::optional< StringRef > ModuleFormat=std::nullopt, std::unique_ptr< ASTUnit > *ErrAST=nullptr, IntrusiveRefCntPtr< llvm::vfs::FileSystem > VFS=nullptr)
	LoadFromCommandLine - Create an ASTUnit from a vector of command line arguments, which must specify exactly one source file.

Friends
class	ConcurrencyCheck

Detailed Description

Utility class for loading a ASTContext from an AST file.

Definition at line 89 of file ASTUnit.h.

Member Typedef Documentation

◆ cached_completion_iterator

using clang::ASTUnit::cached_completion_iterator = std::vector<CachedCodeCompletionResult>::iterator

Definition at line 616 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 639 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 665 of file ASTUnit.h.

◆ stored_diag_const_iterator

using clang::ASTUnit::stored_diag_const_iterator = const StoredDiagnostic *

Definition at line 590 of file ASTUnit.h.

◆ stored_diag_iterator

using clang::ASTUnit::stored_diag_iterator = StoredDiagnostic *

Definition at line 589 of file ASTUnit.h.

◆ top_level_iterator

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

Definition at line 503 of file ASTUnit.h.

Member Enumeration Documentation

◆ WhatToLoad

enum clang::ASTUnit::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 673 of file ASTUnit.h.

Constructor & Destructor Documentation

◆ ASTUnit()

clang::ASTUnit::ASTUnit ( const ASTUnit & )

delete

◆ ~ASTUnit()

ASTUnit::~ASTUnit ( )

Definition at line 250 of file ASTUnit.cpp.

References ActiveASTUnitObjects, clang::DiagnosticConsumer::EndSourceFile(), clang::DiagnosticsEngine::getClient(), getDiagnostics(), and clang::PreprocessorOptions::RemappedFileBuffers.

Member Function Documentation

◆ addFileLevelDecl()

void ASTUnit::addFileLevelDecl ( Decl * D )

Add a new local file-level declaration.

Definition at line 2446 of file ASTUnit.cpp.

References D, clang::Decl::getLexicalDeclContext(), clang::Decl::getLocation(), clang::DeclContext::isFileContext(), clang::Decl::isFromASTFile(), clang::FileID::isInvalid(), clang::SourceLocation::isInvalid(), Loc, and SM.

◆ addTopLevelDecl()

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

inline

Add a new top-level declaration.

Definition at line 530 of file ASTUnit.h.

References D.

◆ cached_completion_begin()

cached_completion_iterator clang::ASTUnit::cached_completion_begin ( )

inline

Definition at line 619 of file ASTUnit.h.

◆ cached_completion_end()

cached_completion_iterator clang::ASTUnit::cached_completion_end ( )

inline

Definition at line 623 of file ASTUnit.h.

◆ cached_completion_size()

unsigned clang::ASTUnit::cached_completion_size ( ) const

inline

Definition at line 627 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,
		std::unique_ptr< SyntaxOnlyAction >	Act
	)

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

Parameters

File	The file in which code completion will occur.
Line	The line at which code completion will occur.
Column	The column at which code completion will occur.
IncludeMacros	Whether to include macros in the code-completion results.
IncludeCodePatterns	Whether to include code patterns (such as a for loop) in the code-completion results.
IncludeBriefComments	Whether to include brief documentation within the set of code completions returned.
Act	If supplied, this argument is used to parse the input file, allowing customized parsing by overriding SyntaxOnlyAction lifecycle methods.

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

Definition at line 2187 of file ASTUnit.cpp.

References clang::PreprocessorOptions::addRemappedFile(), clang::All, clang::PreprocessorOptions::clearRemappedFiles(), clang::FrontendOptions::CodeCompleteOpts, clang::FrontendOptions::CodeCompletionAt, clang::Column, clang::ParsedSourceLocation::Column, clang::PreprocessorOptions::DetailedRecord, Diag(), clang::File, clang::ParsedSourceLocation::FileName, Filename, clang::FileManager::getVirtualFileSystem(), clang::CodeCompleteOptions::IncludeBriefComments, clang::CodeCompleteOptions::IncludeCodePatterns, clang::CodeCompleteConsumer::includeFixIts(), clang::CodeCompleteOptions::IncludeFixIts, clang::CodeCompleteOptions::IncludeGlobals, clang::CodeCompleteOptions::IncludeMacros, clang::Line, clang::ParsedSourceLocation::Line, clang::LLVM_IR, clang::CodeCompleteConsumer::loadExternal(), clang::CodeCompleteOptions::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,
		CaptureDiagsKind	CaptureDiagnostics,
		bool	UserFilesAreVolatile
	)

static

Create a ASTUnit. Gets ownership of the passed CompilerInvocation.

Definition at line 1534 of file ASTUnit.cpp.

References clang::createVFSFromCompilerInvocation().

Referenced by LoadFromCompilerInvocationAction().

◆ enableSourceFileDiagnostics()

void ASTUnit::enableSourceFileDiagnostics ( )

Enable source-range based diagnostic messages.

If diagnostic messages with source-range information are to be expected and AST comes not from file (e.g. after LoadFromCompilerInvocation) this function has to be called. The function is to be called only once and the AST should be associated with the same source file afterwards.

Definition at line 278 of file ASTUnit.cpp.

References clang::DiagnosticConsumer::BeginSourceFile(), clang::DiagnosticsEngine::getClient(), and getDiagnostics().

◆ 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 2487 of file ASTUnit.cpp.

References clang::File, and clang::SourceManager::isLoadedFileID().

◆ getASTContext() [1/2]

ASTContext & clang::ASTUnit::getASTContext ( )

inline

Definition at line 443 of file ASTUnit.h.

◆ getASTContext() [2/2]

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

inline

Definition at line 442 of file ASTUnit.h.

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

◆ getASTFileName()

StringRef ASTUnit::getASTFileName ( ) const

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

Definition at line 1524 of file ASTUnit.cpp.

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

◆ getASTMutationListener()

ASTMutationListener * ASTUnit::getASTMutationListener ( )

Definition at line 770 of file ASTUnit.cpp.

◆ getASTReader()

IntrusiveRefCntPtr< ASTReader > ASTUnit::getASTReader ( ) const

Definition at line 766 of file ASTUnit.cpp.

Referenced by clang::DumpModuleInfoAction::ExecuteAction().

◆ getBufferForFile()

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

Definition at line 783 of file ASTUnit.cpp.

References Filename.

◆ getCachedCompletionAllocator()

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

inline

Retrieve the allocator used to cache global code completions.

Definition at line 314 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 308 of file ASTUnit.h.

◆ getCodeCompletionTUInfo()

CodeCompletionTUInfo & clang::ASTUnit::getCodeCompletionTUInfo ( )

inline

Definition at line 318 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 546 of file ASTUnit.h.

Referenced by LoadFromCompilerInvocationAction().

◆ getDeserializationListener()

ASTDeserializationListener * ASTUnit::getDeserializationListener ( )

Definition at line 776 of file ASTUnit.cpp.

◆ getDiagnostics() [1/2]

DiagnosticsEngine & clang::ASTUnit::getDiagnostics ( )

inline

Definition at line 433 of file ASTUnit.h.

◆ getDiagnostics() [2/2]

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

inline

Definition at line 432 of file ASTUnit.h.

Referenced by enableSourceFileDiagnostics(), LoadFromCompilerInvocationAction(), Reparse(), and ~ASTUnit().

◆ getEndOfPreambleFileID()

SourceLocation ASTUnit::getEndOfPreambleFileID ( ) const

Definition at line 2608 of file ASTUnit.cpp.

References clang::SourceManager::getLocForEndOfFile(), clang::SourceManager::getPreambleFileID(), and clang::FileID::isInvalid().

◆ getFileManager() [1/2]

FileManager & clang::ASTUnit::getFileManager ( )

inline

Definition at line 480 of file ASTUnit.h.

◆ getFileManager() [2/2]

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

inline

Definition at line 479 of file ASTUnit.h.

Referenced by LoadFromCompilerInvocationAction().

◆ getFileSystemOpts()

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

inline

Definition at line 482 of file ASTUnit.h.

◆ getHeaderSearchOpts()

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

inline

Definition at line 469 of file ASTUnit.h.

Referenced by LoadFromCompilerInvocationAction().

◆ getInputKind()

InputKind ASTUnit::getInputKind ( ) const

Determine the input kind this AST unit represents.

Definition at line 2699 of file ASTUnit.cpp.

References clang::C, clang::LangOptionsBase::CMK_ModuleMap, clang::CUDA, clang::CXX, getLangOpts(), clang::InputKind::ModuleMap, clang::ObjC, clang::ObjCXX, clang::OpenCL, and clang::InputKind::Source.

◆ getLangOpts()

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

inline

Definition at line 464 of file ASTUnit.h.

Referenced by clang::DumpModuleInfoAction::ExecuteAction(), 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 2631 of file ASTUnit.cpp.

References clang::Preprocessor::getPreprocessingRecord(), and 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 2530 of file ASTUnit.cpp.

References clang::File, getSourceManager(), clang::Line, Loc, and SM.

◆ getLocation() [2/2]

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

Get the source location for the given file:offset pair.

Definition at line 2537 of file ASTUnit.cpp.

References clang::File, clang::SourceLocation::getLocWithOffset(), getSourceManager(), and SM.

◆ getMainFileName()

StringRef ASTUnit::getMainFileName ( ) const

Definition at line 1506 of file ASTUnit.cpp.

References clang::FrontendInputFile::getBuffer(), clang::FrontendInputFile::getFile(), clang::SourceManager::getFileEntryRefForID(), clang::SourceManager::getMainFileID(), and clang::FrontendInputFile::isFile().

Referenced by Reparse().

◆ getOnlyLocalDecls()

bool clang::ASTUnit::getOnlyLocalDecls ( ) const

inline

Definition at line 493 of file ASTUnit.h.

◆ getOriginalSourceFileName()

StringRef clang::ASTUnit::getOriginalSourceFileName ( ) const

inline

Definition at line 486 of file ASTUnit.h.

◆ getOwnsRemappedFileBuffers()

bool clang::ASTUnit::getOwnsRemappedFileBuffers ( ) const

inline

Definition at line 495 of file ASTUnit.h.

◆ getPCHFile()

OptionalFileEntryRef ASTUnit::getPCHFile ( )

Get the PCH file if one was included.

Definition at line 2667 of file ASTUnit.cpp.

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

◆ getPreambleCounterForTests()

unsigned clang::ASTUnit::getPreambleCounterForTests ( ) const

inline

Definition at line 586 of file ASTUnit.h.

◆ getPreprocessor() [1/2]

Preprocessor & clang::ASTUnit::getPreprocessor ( )

inline

Definition at line 439 of file ASTUnit.h.

◆ getPreprocessor() [2/2]

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

inline

Definition at line 438 of file ASTUnit.h.

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

◆ getPreprocessorOpts()

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

inline

Definition at line 474 of file ASTUnit.h.

◆ getPreprocessorPtr()

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

inline

Definition at line 440 of file ASTUnit.h.

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

◆ getSema()

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

inline

Definition at line 459 of file ASTUnit.h.

Referenced by serialize().

◆ getSourceManager() [1/2]

SourceManager & clang::ASTUnit::getSourceManager ( )

inline

Definition at line 436 of file ASTUnit.h.

◆ getSourceManager() [2/2]

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

inline

Definition at line 435 of file ASTUnit.h.

Referenced by getLocation(), and LoadFromCompilerInvocationAction().

◆ getStartOfMainFileID()

SourceLocation ASTUnit::getStartOfMainFileID ( ) const

Definition at line 2619 of file ASTUnit.cpp.

References clang::SourceManager::getLocForStartOfFile(), clang::SourceManager::getMainFileID(), and clang::FileID::isInvalid().

◆ getTranslationUnitKind()

TranslationUnitKind clang::ASTUnit::getTranslationUnitKind ( ) const

inline

Determine what kind of translation unit this AST represents.

Definition at line 658 of file ASTUnit.h.

◆ hasSema()

bool clang::ASTUnit::hasSema ( ) const

inline

Definition at line 457 of file ASTUnit.h.

◆ isInMainFileID()

bool ASTUnit::isInMainFileID ( SourceLocation Loc ) const

Definition at line 2597 of file ASTUnit.cpp.

References clang::SourceManager::getMainFileID(), clang::SourceManager::isInFileID(), clang::FileID::isInvalid(), clang::SourceLocation::isInvalid(), and Loc.

◆ isInPreambleFileID()

bool ASTUnit::isInPreambleFileID ( SourceLocation Loc ) const

Definition at line 2586 of file ASTUnit.cpp.

References clang::SourceManager::getPreambleFileID(), clang::SourceManager::isInFileID(), clang::FileID::isInvalid(), clang::SourceLocation::isInvalid(), and Loc.

◆ isMainFileAST()

bool clang::ASTUnit::isMainFileAST ( ) const

inline

Definition at line 427 of file ASTUnit.h.

Referenced by getASTFileName(), getLocalPreprocessingEntities(), isModuleFile(), top_level_begin(), top_level_empty(), top_level_end(), top_level_size(), and visitLocalTopLevelDecls().

◆ isModuleFile()

bool ASTUnit::isModuleFile ( ) const

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

Definition at line 2695 of file ASTUnit.cpp.

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

◆ isUnsafeToFree()

bool clang::ASTUnit::isUnsafeToFree ( ) const

inline

Definition at line 429 of file ASTUnit.h.

◆ LoadFromASTFile()

std::unique_ptr< ASTUnit > ASTUnit::LoadFromASTFile	(	StringRef	Filename,
		const PCHContainerReader &	PCHContainerRdr,
		WhatToLoad	ToLoad,
		IntrusiveRefCntPtr< DiagnosticsEngine >	Diags,
		const FileSystemOptions &	FileSystemOpts,
		std::shared_ptr< HeaderSearchOptions >	HSOpts,
		std::shared_ptr< LangOptions >	LangOpts = `nullptr`,
		bool	OnlyLocalDecls = `false`,
		CaptureDiagsKind	CaptureDiagnostics = `CaptureDiagsKind::None`,
		bool	AllowASTWithCompilerErrors = `false`,
		bool	UserFilesAreVolatile = `false`,
		IntrusiveRefCntPtr< llvm::vfs::FileSystem >	VFS = `llvm::vfs::getRealFileSystem()`
	)

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 804 of file ASTUnit.cpp.

References clang::All, clang::ASTReader::ARR_None, clang::ASTReader::ConfigurationMismatch, clang::ASTReader::Failure, Filename, clang::Preprocessor::getBuiltinInfo(), clang::PCHContainerReader::getFormats(), clang::Preprocessor::getIdentifierTable(), clang::Preprocessor::getLangOpts(), clang::Preprocessor::getSelectorTable(), clang::ASTReader::HadErrors, clang::Module::isNamedModule(), LoadASTOnly, LoadEverything, clang::HeaderSearch::lookupModule(), clang::ASTReader::Missing, clang::serialization::MK_MainFile, clang::None, clang::ASTReader::OutOfDate, clang::Preprocessor::setCounterValue(), clang::ASTReader::Success, and clang::ASTReader::VersionMismatch.

Referenced by clang::FrontendAction::BeginSourceFile(), and clang::ASTMergeAction::ExecuteAction().

◆ LoadFromCommandLine()

std::unique_ptr< ASTUnit > ASTUnit::LoadFromCommandLine	(	const char **	ArgBegin,
		const char **	ArgEnd,
		std::shared_ptr< PCHContainerOperations >	PCHContainerOps,
		IntrusiveRefCntPtr< DiagnosticsEngine >	Diags,
		StringRef	ResourceFilesPath,
		bool	StorePreamblesInMemory = `false`,
		StringRef	PreambleStoragePath = `StringRef()`,
		bool	OnlyLocalDecls = `false`,
		CaptureDiagsKind	CaptureDiagnostics = `CaptureDiagsKind::None`,
		ArrayRef< RemappedFile >	RemappedFiles = `{}`,
		bool	RemappedFilesKeepOriginalName = `true`,
		unsigned	PrecompilePreambleAfterNParses = `0`,
		TranslationUnitKind	TUKind = `TU_Complete`,
		bool	CacheCodeCompletionResults = `false`,
		bool	IncludeBriefCommentsInCodeCompletion = `false`,
		bool	AllowPCHWithCompilerErrors = `false`,
		SkipFunctionBodiesScope	SkipFunctionBodies = `SkipFunctionBodiesScope::None`,
		bool	SingleFileParse = `false`,
		bool	UserFilesAreVolatile = `false`,
		bool	ForSerialization = `false`,
		bool	RetainExcludedConditionalBlocks = `false`,
		std::optional< StringRef >	ModuleFormat = `std::nullopt`,
		std::unique_ptr< ASTUnit > *	ErrAST = `nullptr`,
		IntrusiveRefCntPtr< llvm::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.
StorePreamblesInMemory	- Whether to store PCH in memory. If false, PCH are stored in temporary files.
PreambleStoragePath	- The path to a directory, in which to create temporary PCH files. If empty, the default system temporary directory is used. This parameter is ignored if `StorePreamblesInMemory` is true.
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 llvm::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 1765 of file ASTUnit.cpp.

References clang::PreprocessorOptions::AllowPCHWithCompilerErrors, clang::createInvocation(), clang::createVFSFromCompilerInvocation(), clang::CreateInvocationOptions::Diags, clang::PreambleAndMainFile, clang::CreateInvocationOptions::ProbePrecompiled, clang::PreprocessorOptions::RemappedFilesKeepOriginalName, clang::PreprocessorOptions::RetainExcludedConditionalBlocks, clang::PreprocessorOptions::SingleFileParseMode, and clang::CreateInvocationOptions::VFS.

◆ 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`,
		CaptureDiagsKind	CaptureDiagnostics = `CaptureDiagsKind::None`,
		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 1728 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`,
		CaptureDiagsKind	CaptureDiagnostics = `CaptureDiagsKind::None`,
		unsigned	PrecompilePreambleAfterNParses = `0`,
		bool	CacheCodeCompletionResults = `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 1554 of file ASTUnit.cpp.

References clang::FrontendAction::BeginSourceFile(), create(), clang::FrontendAction::EndSourceFile(), clang::FrontendAction::Execute(), getCurrentTopLevelHashValue(), getDiagnostics(), getFileManager(), getHeaderSearchOpts(), getSourceManager(), clang::FrontendAction::getTranslationUnitKind(), clang::FileManager::getVirtualFileSystem(), clang::LLVM_IR, clang::ProcessWarningOptions(), clang::HeaderSearchOptions::ResourceDir, clang::InputKind::Source, and clang::TU_Complete.

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

◆ 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 2547 of file ASTUnit.cpp.

References clang::SourceManager::getLocForStartOfFile(), clang::SourceLocation::getLocWithOffset(), clang::SourceManager::getMainFileID(), clang::SourceManager::getPreambleFileID(), clang::SourceManager::isInFileID(), clang::FileID::isInvalid(), clang::SourceLocation::isInvalid(), and Loc.

Referenced by mapRangeFromPreamble().

◆ 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 2568 of file ASTUnit.cpp.

References clang::SourceManager::getLocForStartOfFile(), clang::SourceLocation::getLocWithOffset(), clang::SourceManager::getMainFileID(), clang::SourceManager::getPreambleFileID(), clang::SourceManager::isInFileID(), clang::FileID::isInvalid(), clang::SourceLocation::isInvalid(), and Loc.

Referenced by mapRangeToPreamble().

◆ mapRangeFromPreamble()

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

inline

See also: mapLocationFromPreamble.

Definition at line 575 of file ASTUnit.h.

References clang::SourceRange::getBegin(), clang::SourceRange::getEnd(), and mapLocationFromPreamble().

◆ mapRangeToPreamble()

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

inline

See also: mapLocationToPreamble.

Definition at line 581 of file ASTUnit.h.

References clang::SourceRange::getBegin(), clang::SourceRange::getEnd(), and mapLocationToPreamble().

◆ operator=()

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

delete

◆ Reparse()

bool ASTUnit::Reparse	(	std::shared_ptr< PCHContainerOperations >	PCHContainerOps,
		ArrayRef< RemappedFile >	RemappedFiles = `{}`,
		IntrusiveRefCntPtr< llvm::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 llvm::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 1871 of file ASTUnit.cpp.

References 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 1930 of file ASTUnit.cpp.

◆ 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 2345 of file ASTUnit.cpp.

References clang::File, and 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 2376 of file ASTUnit.cpp.

References getSema(), and serializeUnit().

Referenced by Save().

◆ setASTContext()

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

inline

Definition at line 445 of file ASTUnit.h.

◆ setOwnsRemappedFileBuffers()

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

inline

Definition at line 496 of file ASTUnit.h.

◆ setPreprocessor()

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

Definition at line 274 of file ASTUnit.cpp.

◆ setUnsafeToFree()

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

inline

Definition at line 430 of file ASTUnit.h.

◆ stored_diag_afterDriver_begin()

stored_diag_iterator clang::ASTUnit::stored_diag_afterDriver_begin ( )

inline

Definition at line 610 of file ASTUnit.h.

◆ stored_diag_begin() [1/2]

stored_diag_iterator clang::ASTUnit::stored_diag_begin ( )

inline

Definition at line 596 of file ASTUnit.h.

◆ stored_diag_begin() [2/2]

stored_diag_const_iterator clang::ASTUnit::stored_diag_begin ( ) const

inline

Definition at line 592 of file ASTUnit.h.

◆ stored_diag_end() [1/2]

stored_diag_iterator clang::ASTUnit::stored_diag_end ( )

inline

Definition at line 604 of file ASTUnit.h.

◆ stored_diag_end() [2/2]

stored_diag_const_iterator clang::ASTUnit::stored_diag_end ( ) const

inline

Definition at line 600 of file ASTUnit.h.

◆ stored_diag_size()

unsigned clang::ASTUnit::stored_diag_size ( ) const

inline

Definition at line 608 of file ASTUnit.h.

◆ top_level_begin()

top_level_iterator clang::ASTUnit::top_level_begin ( )

inline

Definition at line 505 of file ASTUnit.h.

References isMainFileAST().

Referenced by visitLocalTopLevelDecls().

◆ top_level_empty()

bool clang::ASTUnit::top_level_empty ( ) const

inline

Definition at line 524 of file ASTUnit.h.

References isMainFileAST().

◆ top_level_end()

top_level_iterator clang::ASTUnit::top_level_end ( )

inline

Definition at line 512 of file ASTUnit.h.

References isMainFileAST().

Referenced by visitLocalTopLevelDecls().

◆ top_level_size()

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

inline

Definition at line 519 of file ASTUnit.h.

References isMainFileAST().

◆ 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 2645 of file ASTUnit.cpp.

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

Referenced by indexTranslationUnit().

Friends And Related Function Documentation

◆ ConcurrencyCheck

friend class ConcurrencyCheck

friend

Definition at line 408 of file ASTUnit.h.

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

include/clang/Frontend/ASTUnit.h
lib/Frontend/ASTUnit.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ cached_completion_iterator

◆ DeclVisitorFn

◆ RemappedFile

◆ stored_diag_const_iterator

◆ stored_diag_iterator

◆ top_level_iterator

Member Enumeration Documentation

◆ WhatToLoad

Constructor & Destructor Documentation

◆ ASTUnit()

◆ ~ASTUnit()

Member Function Documentation

◆ addFileLevelDecl()

◆ addTopLevelDecl()

◆ cached_completion_begin()

◆ cached_completion_end()

◆ cached_completion_size()

◆ CodeComplete()

◆ create()

◆ enableSourceFileDiagnostics()

◆ findFileRegionDecls()

◆ getASTContext() [1/2]

◆ getASTContext() [2/2]

◆ getASTFileName()

◆ getASTMutationListener()

◆ getASTReader()

◆ getBufferForFile()

◆ getCachedCompletionAllocator()

◆ getCachedCompletionTypes()

◆ getCodeCompletionTUInfo()

◆ getCurrentTopLevelHashValue()

◆ getDeserializationListener()

◆ getDiagnostics() [1/2]

◆ getDiagnostics() [2/2]

◆ getEndOfPreambleFileID()

◆ getFileManager() [1/2]

◆ getFileManager() [2/2]

◆ getFileSystemOpts()

◆ getHeaderSearchOpts()

◆ getInputKind()

◆ getLangOpts()

◆ getLocalPreprocessingEntities()

◆ getLocation() [1/2]

◆ getLocation() [2/2]

◆ getMainFileName()

◆ getOnlyLocalDecls()

◆ getOriginalSourceFileName()

◆ getOwnsRemappedFileBuffers()

◆ getPCHFile()

◆ getPreambleCounterForTests()

◆ getPreprocessor() [1/2]

◆ getPreprocessor() [2/2]

◆ getPreprocessorOpts()

◆ getPreprocessorPtr()

◆ getSema()

◆ getSourceManager() [1/2]

◆ getSourceManager() [2/2]

◆ getStartOfMainFileID()

◆ getTranslationUnitKind()

◆ hasSema()

◆ isInMainFileID()

◆ isInPreambleFileID()

◆ isMainFileAST()

◆ isModuleFile()

◆ isUnsafeToFree()

◆ LoadFromASTFile()

◆ LoadFromCommandLine()

◆ LoadFromCompilerInvocation()

◆ LoadFromCompilerInvocationAction()

◆ mapLocationFromPreamble()

◆ mapLocationToPreamble()

◆ mapRangeFromPreamble()

◆ mapRangeToPreamble()