LLVM  16.0.0git
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 "llvm/Support/SourceMgr.h"

Public Types

enum  DiagKind { DK_Error, DK_Warning, DK_Remark, DK_Note }
 
using DiagHandlerTy = void(*)(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 ()=default
 
 SourceMgr (const SourceMgr &)=delete
 
SourceMgroperator= (const SourceMgr &)=delete
 
 SourceMgr (SourceMgr &&)=default
 
SourceMgroperator= (SourceMgr &&)=default
 
 ~SourceMgr ()=default
 
ArrayRef< std::string > getIncludeDirs () const
 Return the include directories of this source manager. More...
 
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...
 
void takeSourceBuffersFrom (SourceMgr &SrcMgr, SMLoc MainBufferIncludeLoc=SMLoc())
 Takes the source buffers from the given source manager and append them to the current 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...
 
ErrorOr< std::unique_ptr< MemoryBuffer > > OpenIncludeFile (const std::string &Filename, std::string &IncludedFile)
 Search for a file with the specified name in the current directory or in one of the IncludeDirs, and try to open it without adding to the SourceMgr. 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, unsigned > getLineAndColumn (SMLoc Loc, unsigned BufferID=0) const
 Find the line and column number for the specified location in the specified file. More...
 
std::string getFormattedLocationNoOffset (SMLoc Loc, bool IncludePath=false) const
 Get a string with the SMLoc filename and line number formatted in the standard style. More...
 
SMLoc FindLocForLineAndColumn (unsigned BufferID, unsigned LineNo, unsigned ColNo)
 Given a line and column number in a mapped buffer, turn it into an SMLoc. More...
 
void PrintMessage (raw_ostream &OS, SMLoc Loc, DiagKind Kind, const Twine &Msg, ArrayRef< SMRange > Ranges={}, ArrayRef< SMFixIt > FixIts={}, 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={}, ArrayRef< SMFixIt > FixIts={}, 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={}, ArrayRef< SMFixIt > FixIts={}) 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 31 of file SourceMgr.h.

Member Typedef Documentation

◆ DiagHandlerTy

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 43 of file SourceMgr.h.

Member Enumeration Documentation

◆ DiagKind

Enumerator
DK_Error 
DK_Warning 
DK_Remark 
DK_Note 

Definition at line 33 of file SourceMgr.h.

Constructor & Destructor Documentation

◆ SourceMgr() [1/3]

llvm::SourceMgr::SourceMgr ( )
default

◆ SourceMgr() [2/3]

llvm::SourceMgr::SourceMgr ( const SourceMgr )
delete

◆ SourceMgr() [3/3]

llvm::SourceMgr::SourceMgr ( SourceMgr &&  )
default

◆ ~SourceMgr()

llvm::SourceMgr::~SourceMgr ( )
default

Member Function Documentation

◆ AddIncludeFile()

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 40 of file SourceMgr.cpp.

References AddNewSourceBuffer(), move, and OpenIncludeFile().

◆ AddNewSourceBuffer()

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

Add a new source buffer to this source manager.

This takes ownership of the memory buffer.

Definition at line 144 of file SourceMgr.h.

References F, and move.

Referenced by AddIncludeFile(), llvm::MIRParserImpl::initializeMachineFunction(), and llvm::TableGenMain().

◆ FindBufferContainingLoc()

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 69 of file SourceMgr.cpp.

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

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

◆ FindLineNumber()

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 196 of file SourceMgr.h.

References getLineAndColumn().

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

◆ FindLocForLineAndColumn()

SMLoc SourceMgr::FindLocForLineAndColumn ( unsigned  BufferID,
unsigned  LineNo,
unsigned  ColNo 
)

Given a line and column number in a mapped buffer, turn it into an SMLoc.

This will return a null SMLoc if the line/column location is invalid.

Definition at line 230 of file SourceMgr.cpp.

References getBufferInfo(), llvm::SMLoc::getFromPointer(), llvm::StringRef::npos, and Ptr.

◆ getBufferInfo()

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

◆ getDiagContext()

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

Definition at line 118 of file SourceMgr.h.

Referenced by llvm::TableGenParseFile().

◆ getDiagHandler()

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

Definition at line 117 of file SourceMgr.h.

Referenced by llvm::TableGenParseFile().

◆ getFormattedLocationNoOffset()

std::string SourceMgr::getFormattedLocationNoOffset ( SMLoc  Loc,
bool  IncludePath = false 
) const

Get a string with the SMLoc filename and line number formatted in the standard style.

Get a string with the source location formatted in the standard style, but without the line offset.

If IncludePath is true, the path is included. If false, only the file name and extension are included.

Definition at line 212 of file SourceMgr.cpp.

References assert(), FindBufferContainingLoc(), FindLineNumber(), getBufferInfo(), I, and llvm::to_string().

◆ getIncludeDirs()

ArrayRef<std::string> llvm::SourceMgr::getIncludeDirs ( ) const
inline

Return the include directories of this source manager.

Definition at line 104 of file SourceMgr.h.

Referenced by llvm::TableGenParseFile().

◆ getLineAndColumn()

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 188 of file SourceMgr.cpp.

References assert(), llvm::StringRef::find_last_of(), FindBufferContainingLoc(), getBufferInfo(), llvm::SMLoc::getPointer(), llvm::StringRef::npos, and Ptr.

Referenced by FindLineNumber(), and GetMessage().

◆ getMainFileID()

unsigned llvm::SourceMgr::getMainFileID ( ) const
inline

◆ getMemoryBuffer()

const MemoryBuffer* llvm::SourceMgr::getMemoryBuffer ( unsigned  i) const
inline

◆ GetMessage()

SMDiagnostic SourceMgr::GetMessage ( SMLoc  Loc,
SourceMgr::DiagKind  Kind,
const Twine Msg,
ArrayRef< SMRange Ranges = {},
ArrayRef< SMFixIt FixIts = {} 
) const

◆ getNumBuffers()

unsigned llvm::SourceMgr::getNumBuffers ( ) const
inline

Definition at line 130 of file SourceMgr.h.

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

◆ getParentIncludeLoc()

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

Definition at line 137 of file SourceMgr.h.

References assert(), and i.

◆ OpenIncludeFile()

ErrorOr< std::unique_ptr< MemoryBuffer > > SourceMgr::OpenIncludeFile ( const std::string &  Filename,
std::string &  IncludedFile 
)

Search for a file with the specified name in the current directory or in one of the IncludeDirs, and try to open it without adding to the SourceMgr.

If the opened file is intended to be added to the source manager, prefer AddIncludeFile instead.

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

Definition at line 52 of file SourceMgr.cpp.

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

Referenced by AddIncludeFile().

◆ operator=() [1/2]

SourceMgr& llvm::SourceMgr::operator= ( const SourceMgr )
delete

◆ operator=() [2/2]

SourceMgr& llvm::SourceMgr::operator= ( SourceMgr &&  )
default

◆ PrintIncludeStack()

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 257 of file SourceMgr.cpp.

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

Referenced by PrintMessage().

◆ PrintMessage() [1/3]

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 331 of file SourceMgr.cpp.

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

◆ PrintMessage() [2/3]

void SourceMgr::PrintMessage ( raw_ostream OS,
SMLoc  Loc,
SourceMgr::DiagKind  Kind,
const Twine Msg,
ArrayRef< SMRange Ranges = {},
ArrayRef< SMFixIt FixIts = {},
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 348 of file SourceMgr.cpp.

References GetMessage(), and llvm::AMDGPU::SendMsg::Msg.

Referenced by llvm::vfs::RedirectingFileSystem::create(), llvm::MCObjectStreamer::emitFill(), llvm::Pattern::parsePattern(), llvm::PrintError(), llvm::yaml::Scanner::printError(), llvm::PrintMessage(), PrintMessage(), llvm::PrintWarning(), llvm::HexagonShuffler::reportError(), llvm::HexagonMCChecker::reportNote(), and llvm::LLLexer::Warning().

◆ PrintMessage() [3/3]

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

Emits a diagnostic to llvm::errs().

Definition at line 355 of file SourceMgr.cpp.

References llvm::errs(), llvm::AMDGPU::SendMsg::Msg, and PrintMessage().

◆ setDiagHandler()

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 112 of file SourceMgr.h.

Referenced by llvm::vfs::RedirectingFileSystem::create(), setupSM(), and llvm::TableGenParseFile().

◆ setIncludeDirs()

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

Definition at line 106 of file SourceMgr.h.

Referenced by llvm::TableGenMain(), and llvm::TableGenParseFile().

◆ takeSourceBuffersFrom()

void llvm::SourceMgr::takeSourceBuffersFrom ( SourceMgr SrcMgr,
SMLoc  MainBufferIncludeLoc = SMLoc() 
)
inline

Takes the source buffers from the given source manager and append them to the current manager.

MainBufferIncludeLoc is an optional include location to attach to the main buffer of SrcMgr after it gets moved to the current manager.

Definition at line 157 of file SourceMgr.h.

References getNumBuffers(), move, and llvm::SrcMgr.

Referenced by llvm::TableGenParseFile().


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