LLVM  4.0.0
Classes | Public Types | Public Member Functions | List of all members
llvm::SourceMgr Class Reference

This owns the files read by a parser, handles include stacks, and handles diagnostic wrangling. More...

#include <SourceMgr.h>

Public Types

enum  DiagKind { DK_Error, DK_Warning, DK_Note }
 
typedef void(* DiagHandlerTy )(const SMDiagnostic &, void *Context)
 Clients that want to handle their own diagnostics in a custom way can register a function pointer+context as a diagnostic handler. More...
 

Public Member Functions

 SourceMgr ()
 
 ~SourceMgr ()
 
void setIncludeDirs (const std::vector< std::string > &Dirs)
 
void setDiagHandler (DiagHandlerTy DH, void *Ctx=nullptr)
 Specify a diagnostic handler to be invoked every time PrintMessage is called. More...
 
DiagHandlerTy getDiagHandler () const
 
void * getDiagContext () const
 
const SrcBuffer & getBufferInfo (unsigned i) const
 
const MemoryBuffergetMemoryBuffer (unsigned i) const
 
unsigned getNumBuffers () const
 
unsigned getMainFileID () const
 
SMLoc getParentIncludeLoc (unsigned i) const
 
unsigned AddNewSourceBuffer (std::unique_ptr< MemoryBuffer > F, SMLoc IncludeLoc)
 Add a new source buffer to this source manager. More...
 
unsigned AddIncludeFile (const std::string &Filename, SMLoc IncludeLoc, std::string &IncludedFile)
 Search for a file with the specified name in the current directory or in one of the IncludeDirs. More...
 
unsigned FindBufferContainingLoc (SMLoc Loc) const
 Return the ID of the buffer containing the specified location. More...
 
unsigned FindLineNumber (SMLoc Loc, unsigned BufferID=0) const
 Find the line number for the specified location in the specified file. More...
 
std::pair< unsigned, unsignedgetLineAndColumn (SMLoc Loc, unsigned BufferID=0) const
 Find the line and column number for the specified location in the specified file. More...
 
void PrintMessage (raw_ostream &OS, SMLoc Loc, DiagKind Kind, const Twine &Msg, ArrayRef< SMRange > Ranges=None, ArrayRef< SMFixIt > FixIts=None, bool ShowColors=true) const
 Emit a message about the specified location with the specified string. More...
 
void PrintMessage (SMLoc Loc, DiagKind Kind, const Twine &Msg, ArrayRef< SMRange > Ranges=None, ArrayRef< SMFixIt > FixIts=None, bool ShowColors=true) const
 Emits a diagnostic to llvm::errs(). More...
 
void PrintMessage (raw_ostream &OS, const SMDiagnostic &Diagnostic, bool ShowColors=true) const
 Emits a manually-constructed diagnostic to the given output stream. More...
 
SMDiagnostic GetMessage (SMLoc Loc, DiagKind Kind, const Twine &Msg, ArrayRef< SMRange > Ranges=None, ArrayRef< SMFixIt > FixIts=None) const
 Return an SMDiagnostic at the specified location with the specified string. More...
 
void PrintIncludeStack (SMLoc IncludeLoc, raw_ostream &OS) const
 Prints the names of included files and the line of the file they were included from. More...
 

Detailed Description

This owns the files read by a parser, handles include stacks, and handles diagnostic wrangling.

Definition at line 35 of file SourceMgr.h.

Member Typedef Documentation

typedef void(* llvm::SourceMgr::DiagHandlerTy)(const SMDiagnostic &, void *Context)

Clients that want to handle their own diagnostics in a custom way can register a function pointer+context as a diagnostic handler.

It gets called each time PrintMessage is invoked.

Definition at line 46 of file SourceMgr.h.

Member Enumeration Documentation

Enumerator
DK_Error 
DK_Warning 
DK_Note 

Definition at line 37 of file SourceMgr.h.

Constructor & Destructor Documentation

llvm::SourceMgr::SourceMgr ( )
inline

Definition at line 74 of file SourceMgr.h.

SourceMgr::~SourceMgr ( )

Definition at line 40 of file SourceMgr.cpp.

References getCache().

Member Function Documentation

unsigned SourceMgr::AddIncludeFile ( const std::string &  Filename,
SMLoc  IncludeLoc,
std::string &  IncludedFile 
)

Search for a file with the specified name in the current directory or in one of the IncludeDirs.

If no file is found, this returns 0, otherwise it returns the buffer ID of the stacked file. The full path to the included file can be found in IncludedFile.

Definition at line 46 of file SourceMgr.cpp.

References AddNewSourceBuffer(), llvm::StringRef::data(), llvm::sys::path::get_separator(), llvm::MemoryBuffer::getFile(), and i.

unsigned llvm::SourceMgr::AddNewSourceBuffer ( std::unique_ptr< MemoryBuffer F,
SMLoc  IncludeLoc 
)
inline
unsigned SourceMgr::FindBufferContainingLoc ( SMLoc  Loc) const

Return the ID of the buffer containing the specified location.

0 is returned if the buffer is not found.

Definition at line 67 of file SourceMgr.cpp.

References llvm::SMLoc::getPointer(), and i.

Referenced by getLineAndColumn(), GetMessage(), llvm::MCGenDwarfLabelEntry::Make(), PrintIncludeStack(), and PrintMessage().

unsigned llvm::SourceMgr::FindLineNumber ( SMLoc  Loc,
unsigned  BufferID = 0 
) const
inline

Find the line number for the specified location in the specified file.

This is not a fast method.

Definition at line 143 of file SourceMgr.h.

References getLineAndColumn().

Referenced by llvm::MCGenDwarfLabelEntry::Make(), and PrintIncludeStack().

const SrcBuffer& llvm::SourceMgr::getBufferInfo ( unsigned  i) const
inline

Definition at line 92 of file SourceMgr.h.

References assert().

Referenced by PrintIncludeStack(), and PrintMessage().

void* llvm::SourceMgr::getDiagContext ( ) const
inline

Definition at line 90 of file SourceMgr.h.

DiagHandlerTy llvm::SourceMgr::getDiagHandler ( ) const
inline

Definition at line 89 of file SourceMgr.h.

std::pair< unsigned, unsigned > SourceMgr::getLineAndColumn ( SMLoc  Loc,
unsigned  BufferID = 0 
) const

Find the line and column number for the specified location in the specified file.

This is not a fast method.

Definition at line 78 of file SourceMgr.cpp.

References assert(), llvm::StringRef::find_last_of(), FindBufferContainingLoc(), llvm::MemoryBuffer::getBufferStart(), getCache(), llvm::SMLoc::getFromPointer(), getMemoryBuffer(), llvm::SMLoc::getPointer(), llvm::StringRef::npos, and Ptr.

Referenced by FindLineNumber(), and GetMessage().

unsigned llvm::SourceMgr::getMainFileID ( ) const
inline
const MemoryBuffer* llvm::SourceMgr::getMemoryBuffer ( unsigned  i) const
inline
SMDiagnostic SourceMgr::GetMessage ( SMLoc  Loc,
SourceMgr::DiagKind  Kind,
const Twine Msg,
ArrayRef< SMRange Ranges = None,
ArrayRef< SMFixIt FixIts = None 
) const
unsigned llvm::SourceMgr::getNumBuffers ( ) const
inline

Definition at line 102 of file SourceMgr.h.

Referenced by getMainFileID(), and llvm::MCContext::MCContext().

SMLoc llvm::SourceMgr::getParentIncludeLoc ( unsigned  i) const
inline

Definition at line 111 of file SourceMgr.h.

References assert().

void SourceMgr::PrintIncludeStack ( SMLoc  IncludeLoc,
raw_ostream OS 
) const

Prints the names of included files and the line of the file they were included from.

A diagnostic handler can use this before printing its custom formatted message.

Parameters
IncludeLocThe location of the include.
OSthe raw_ostream to print on.

Definition at line 122 of file SourceMgr.cpp.

References assert(), FindBufferContainingLoc(), FindLineNumber(), and getBufferInfo().

Referenced by PrintMessage().

void SourceMgr::PrintMessage ( raw_ostream OS,
SMLoc  Loc,
SourceMgr::DiagKind  Kind,
const Twine Msg,
ArrayRef< SMRange Ranges = None,
ArrayRef< SMFixIt FixIts = None,
bool  ShowColors = true 
) const

Emit a message about the specified location with the specified string.

Parameters
ShowColorsDisplay colored messages if output is a terminal and the default error handler is used.

Definition at line 216 of file SourceMgr.cpp.

References GetMessage().

Referenced by llvm::MCObjectStreamer::emitFill(), llvm::PrintError(), llvm::yaml::Scanner::printError(), llvm::PrintMessage(), PrintMessage(), llvm::PrintWarning(), llvm::MCContext::reportError(), and llvm::LLLexer::Warning().

void SourceMgr::PrintMessage ( SMLoc  Loc,
SourceMgr::DiagKind  Kind,
const Twine Msg,
ArrayRef< SMRange Ranges = None,
ArrayRef< SMFixIt FixIts = None,
bool  ShowColors = true 
) const

Emits a diagnostic to llvm::errs().

Definition at line 223 of file SourceMgr.cpp.

References llvm::errs(), and PrintMessage().

void SourceMgr::PrintMessage ( raw_ostream OS,
const SMDiagnostic Diagnostic,
bool  ShowColors = true 
) const

Emits a manually-constructed diagnostic to the given output stream.

Parameters
ShowColorsDisplay colored messages if output is a terminal and the default error handler is used.

Definition at line 199 of file SourceMgr.cpp.

References assert(), FindBufferContainingLoc(), getBufferInfo(), llvm::SMDiagnostic::getLoc(), llvm::SMLoc::isValid(), llvm::SMDiagnostic::print(), and PrintIncludeStack().

void llvm::SourceMgr::setDiagHandler ( DiagHandlerTy  DH,
void *  Ctx = nullptr 
)
inline

Specify a diagnostic handler to be invoked every time PrintMessage is called.

Ctx is passed into the handler when it is invoked.

Definition at line 84 of file SourceMgr.h.

Referenced by llvm::yaml::Input::Input().

void llvm::SourceMgr::setIncludeDirs ( const std::vector< std::string > &  Dirs)
inline

Definition at line 78 of file SourceMgr.h.

Referenced by llvm::TableGenMain().


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