clang  3.7.0
Classes | Public Member Functions | Friends | List of all members
clang::PreprocessingRecord Class Reference

A record of the steps taken while preprocessing a source file, including the various preprocessing directives processed, macros expanded, etc. More...

#include <PreprocessingRecord.h>

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

Classes

class  iterator
 

Public Member Functions

 PreprocessingRecord (SourceManager &SM)
 Construct a new preprocessing record. More...
 
void * Allocate (unsigned Size, unsigned Align=8)
 Allocate memory in the preprocessing record. More...
 
void Deallocate (void *Ptr)
 Deallocate memory in the preprocessing record. More...
 
size_t getTotalMemory () const
 
SourceManagergetSourceManager () const
 
iterator begin ()
 Begin iterator for all preprocessed entities. More...
 
iterator end ()
 End iterator for all preprocessed entities. More...
 
iterator local_begin ()
 Begin iterator for local, non-loaded, preprocessed entities. More...
 
iterator local_end ()
 End iterator for local, non-loaded, preprocessed entities. More...
 
llvm::iterator_range< iteratorgetIteratorsForLoadedRange (unsigned start, unsigned count)
 iterator range for the given range of loaded preprocessed entities. More...
 
llvm::iterator_range< iteratorgetPreprocessedEntitiesInRange (SourceRange R)
 Returns a range of preprocessed entities that source range R encompasses. More...
 
bool isEntityInFileID (iterator PPEI, FileID FID)
 Returns true if the preprocessed entity that PPEI iterator points to is coming from the file FID. More...
 
PPEntityID addPreprocessedEntity (PreprocessedEntity *Entity)
 Add a new preprocessed entity to this record. More...
 
void SetExternalSource (ExternalPreprocessingRecordSource &Source)
 Set the external source for preprocessed entities. More...
 
ExternalPreprocessingRecordSourcegetExternalSource () const
 Retrieve the external source for preprocessed entities. More...
 
MacroDefinitionRecordfindMacroDefinition (const MacroInfo *MI)
 Retrieve the macro definition that corresponds to the given MacroInfo. More...
 
const std::vector< SourceRange > & getSkippedRanges () const
 Retrieve all ranges that got skipped while preprocessing. More...
 
- Public Member Functions inherited from clang::PPCallbacks
virtual ~PPCallbacks ()
 
virtual void FileChanged (SourceLocation Loc, FileChangeReason Reason, SrcMgr::CharacteristicKind FileType, FileID PrevFID=FileID())
 Callback invoked whenever a source file is entered or exited. More...
 
virtual void FileSkipped (const FileEntry &SkippedFile, const Token &FilenameTok, SrcMgr::CharacteristicKind FileType)
 Callback invoked whenever a source file is skipped as the result of header guard optimization. More...
 
virtual bool FileNotFound (StringRef FileName, SmallVectorImpl< char > &RecoveryPath)
 Callback invoked whenever an inclusion directive results in a file-not-found error. More...
 
virtual void moduleImport (SourceLocation ImportLoc, ModuleIdPath Path, const Module *Imported)
 Callback invoked whenever there was an explicit module-import syntax. More...
 
virtual void EndOfMainFile ()
 Callback invoked when the end of the main file is reached. More...
 
virtual void Ident (SourceLocation Loc, StringRef str)
 Callback invoked when a #ident or #sccs directive is read. More...
 
virtual void PragmaDirective (SourceLocation Loc, PragmaIntroducerKind Introducer)
 Callback invoked when start reading any pragma directive. More...
 
virtual void PragmaComment (SourceLocation Loc, const IdentifierInfo *Kind, StringRef Str)
 Callback invoked when a #pragma comment directive is read. More...
 
virtual void PragmaDetectMismatch (SourceLocation Loc, StringRef Name, StringRef Value)
 Callback invoked when a #pragma detect_mismatch directive is read. More...
 
virtual void PragmaDebug (SourceLocation Loc, StringRef DebugType)
 Callback invoked when a #pragma clang __debug directive is read. More...
 
virtual void PragmaMessage (SourceLocation Loc, StringRef Namespace, PragmaMessageKind Kind, StringRef Str)
 Callback invoked when a #pragma message directive is read. More...
 
virtual void PragmaDiagnosticPush (SourceLocation Loc, StringRef Namespace)
 Callback invoked when a #pragma gcc dianostic push directive is read. More...
 
virtual void PragmaDiagnosticPop (SourceLocation Loc, StringRef Namespace)
 Callback invoked when a #pragma gcc dianostic pop directive is read. More...
 
virtual void PragmaDiagnostic (SourceLocation Loc, StringRef Namespace, diag::Severity mapping, StringRef Str)
 Callback invoked when a #pragma gcc dianostic directive is read. More...
 
virtual void PragmaOpenCLExtension (SourceLocation NameLoc, const IdentifierInfo *Name, SourceLocation StateLoc, unsigned State)
 Called when an OpenCL extension is either disabled or enabled with a pragma. More...
 
virtual void PragmaWarning (SourceLocation Loc, StringRef WarningSpec, ArrayRef< int > Ids)
 Callback invoked when a #pragma warning directive is read. More...
 
virtual void PragmaWarningPush (SourceLocation Loc, int Level)
 Callback invoked when a #pragma warning(push) directive is read. More...
 
virtual void PragmaWarningPop (SourceLocation Loc)
 Callback invoked when a #pragma warning(pop) directive is read. More...
 
virtual void If (SourceLocation Loc, SourceRange ConditionRange, ConditionValueKind ConditionValue)
 Hook called whenever an #if is seen. More...
 
virtual void Elif (SourceLocation Loc, SourceRange ConditionRange, ConditionValueKind ConditionValue, SourceLocation IfLoc)
 Hook called whenever an #elif is seen. More...
 
virtual void Else (SourceLocation Loc, SourceLocation IfLoc)
 Hook called whenever an #else is seen. More...
 
virtual void Endif (SourceLocation Loc, SourceLocation IfLoc)
 Hook called whenever an #endif is seen. More...
 

Friends

class ASTReader
 
class ASTWriter
 

Additional Inherited Members

- Public Types inherited from clang::PPCallbacks
enum  FileChangeReason { EnterFile, ExitFile, SystemHeaderPragma, RenameFile }
 
enum  PragmaMessageKind { PMK_Message, PMK_Warning, PMK_Error }
 Determines the kind of #pragma invoking a call to PragmaMessage. More...
 
enum  ConditionValueKind { CVK_NotEvaluated, CVK_False, CVK_True }
 

Detailed Description

A record of the steps taken while preprocessing a source file, including the various preprocessing directives processed, macros expanded, etc.

Definition at line 292 of file PreprocessingRecord.h.

Constructor & Destructor Documentation

PreprocessingRecord::PreprocessingRecord ( SourceManager SM)
explicit

Construct a new preprocessing record.

Definition at line 41 of file PreprocessingRecord.cpp.

Member Function Documentation

PreprocessingRecord::PPEntityID PreprocessingRecord::addPreprocessedEntity ( PreprocessedEntity Entity)
void* clang::PreprocessingRecord::Allocate ( unsigned  Size,
unsigned  Align = 8 
)
inline

Allocate memory in the preprocessing record.

Definition at line 372 of file PreprocessingRecord.h.

Referenced by clang::InclusionDirective::InclusionDirective().

iterator clang::PreprocessingRecord::begin ( )
inline

Begin iterator for all preprocessed entities.

Definition at line 423 of file PreprocessingRecord.h.

void clang::PreprocessingRecord::Deallocate ( void *  Ptr)
inline

Deallocate memory in the preprocessing record.

Definition at line 377 of file PreprocessingRecord.h.

iterator clang::PreprocessingRecord::end ( )
inline

End iterator for all preprocessed entities.

Definition at line 428 of file PreprocessingRecord.h.

Referenced by getIteratorsForLoadedRange().

MacroDefinitionRecord * PreprocessingRecord::findMacroDefinition ( const MacroInfo MI)

Retrieve the macro definition that corresponds to the given MacroInfo.

Definition at line 360 of file PreprocessingRecord.cpp.

ExternalPreprocessingRecordSource* clang::PreprocessingRecord::getExternalSource ( ) const
inline

Retrieve the external source for preprocessed entities.

Definition at line 477 of file PreprocessingRecord.h.

llvm::iterator_range<iterator> clang::PreprocessingRecord::getIteratorsForLoadedRange ( unsigned  start,
unsigned  count 
)
inline

iterator range for the given range of loaded preprocessed entities.

Definition at line 444 of file PreprocessingRecord.h.

References end().

llvm::iterator_range< PreprocessingRecord::iterator > PreprocessingRecord::getPreprocessedEntitiesInRange ( SourceRange  R)

Returns a range of preprocessed entities that source range R encompasses.

Returns a pair of [Begin, End) iterators of preprocessed entities that source range Range encompasses.

Parameters
Rthe range to look for preprocessed entities.

Definition at line 49 of file PreprocessingRecord.cpp.

References clang::SourceRange::isInvalid(), and Range.

const std::vector<SourceRange>& clang::PreprocessingRecord::getSkippedRanges ( ) const
inline

Retrieve all ranges that got skipped while preprocessing.

Definition at line 486 of file PreprocessingRecord.h.

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

Definition at line 381 of file PreprocessingRecord.h.

References SourceMgr.

size_t PreprocessingRecord::getTotalMemory ( ) const

Definition at line 483 of file PreprocessingRecord.cpp.

bool PreprocessingRecord::isEntityInFileID ( iterator  PPEI,
FileID  FID 
)

Returns true if the preprocessed entity that PPEI iterator points to is coming from the file FID.

Returns true if the preprocessed entity that.

Can be used to avoid implicit deserializations of preallocated preprocessed entities if we only care about entities of a specific file and not from files #included in the range given at

See Also
getPreprocessedEntitiesInRange.
  • PPEI iterator points to is coming from the file
  • FID.

Can be used to avoid implicit deserializations of preallocated preprocessed entities if we only care about entities of a specific file and not from files #included in the range given at

See Also
getPreprocessedEntitiesInRange.

Definition at line 87 of file PreprocessingRecord.cpp.

References clang::FileID::isInvalid(), isPreprocessedEntityIfInFileID(), and clang::ExternalPreprocessingRecordSource::isPreprocessedEntityInFileID().

iterator clang::PreprocessingRecord::local_begin ( )
inline

Begin iterator for local, non-loaded, preprocessed entities.

Definition at line 433 of file PreprocessingRecord.h.

iterator clang::PreprocessingRecord::local_end ( )
inline

End iterator for local, non-loaded, preprocessed entities.

Definition at line 438 of file PreprocessingRecord.h.

void PreprocessingRecord::SetExternalSource ( ExternalPreprocessingRecordSource Source)

Set the external source for preprocessed entities.

Definition at line 307 of file PreprocessingRecord.cpp.

Friends And Related Function Documentation

friend class ASTReader
friend

Definition at line 523 of file PreprocessingRecord.h.

friend class ASTWriter
friend

Definition at line 524 of file PreprocessingRecord.h.

Member Data Documentation

SourceRange clang::PreprocessingRecord::Range

Definition at line 517 of file PreprocessingRecord.h.

Referenced by getPreprocessedEntitiesInRange().

std::pair<int, int> clang::PreprocessingRecord::Result

Definition at line 518 of file PreprocessingRecord.h.


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