Skip to content

Commit

Permalink
Modernize doc comments for SourceMgr.
Browse files Browse the repository at this point in the history 
No functionality change.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@211086 91177308-0d34-0410-b5e6-96231b3b80d8
  • Loading branch information
@jrose-apple
jrose-apple committed Jun 17, 2014
1 parent dcc9291 commit ecb1c3a
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 51 deletions.
78 changes: 39 additions & 39 deletions include/llvm/Support/SourceMgr.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ namespace llvm {
class Twine;
class raw_ostream;

/// SourceMgr - This owns the files read by a parser, handles include stacks,
/// This owns the files read by a parser, handles include stacks,
/// and handles diagnostic wrangling.
class SourceMgr {
public:
Expand All @@ -40,29 +40,27 @@ class SourceMgr {
DK_Note
};

/// 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.
/// 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.
typedef void (*DiagHandlerTy)(const SMDiagnostic &, void *Context);
private:
struct SrcBuffer {
/// Buffer - The memory buffer for the file.
/// The memory buffer for the file.
MemoryBuffer *Buffer;

/// IncludeLoc - This is the location of the parent include, or null if at
/// the top level.
/// This is the location of the parent include, or null if at the top level.
SMLoc IncludeLoc;
};

/// Buffers - This is all of the buffers that we are reading from.
/// This is all of the buffers that we are reading from.
std::vector<SrcBuffer> Buffers;

// IncludeDirectories - This is the list of directories we should search for
// include files in.
// This is the list of directories we should search for include files in.
std::vector<std::string> IncludeDirectories;

/// LineNoCache - This is a cache for line number queries, its implementation
/// is really private to SourceMgr.cpp.
/// This is a cache for line number queries, its implementation is really
/// private to SourceMgr.cpp.
mutable void *LineNoCache;

DiagHandlerTy DiagHandler;
Expand All @@ -79,8 +77,8 @@ class SourceMgr {
IncludeDirectories = Dirs;
}

/// setDiagHandler - Specify a diagnostic handler to be invoked every time
/// PrintMessage is called. Ctx is passed into the handler when it is invoked.
/// Specify a diagnostic handler to be invoked every time PrintMessage is
/// called. \p Ctx is passed into the handler when it is invoked.
void setDiagHandler(DiagHandlerTy DH, void *Ctx = nullptr) {
DiagHandler = DH;
DiagContext = Ctx;
Expand Down Expand Up @@ -108,8 +106,8 @@ class SourceMgr {
return Buffers[i].IncludeLoc;
}

/// AddNewSourceBuffer - Add a new source buffer to this source manager. This
/// takes ownership of the memory buffer.
/// Add a new source buffer to this source manager. This takes ownership of
/// the memory buffer.
size_t AddNewSourceBuffer(MemoryBuffer *F, SMLoc IncludeLoc) {
SrcBuffer NB;
NB.Buffer = F;
Expand All @@ -118,32 +116,34 @@ class SourceMgr {
return Buffers.size() - 1;
}

/// AddIncludeFile - 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.
/// 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
/// \p IncludedFile.
size_t AddIncludeFile(const std::string &Filename, SMLoc IncludeLoc,
std::string &IncludedFile);

/// FindBufferContainingLoc - Return the ID of the buffer containing the
/// specified location, returning -1 if not found.
/// Return the ID of the buffer containing the specified location.
///
/// -1 is returned if the buffer is not found.
int FindBufferContainingLoc(SMLoc Loc) const;

/// FindLineNumber - Find the line number for the specified location in the
/// specified file. This is not a fast method.
/// Find the line number for the specified location in the specified file.
/// This is not a fast method.
unsigned FindLineNumber(SMLoc Loc, int BufferID = -1) const {
return getLineAndColumn(Loc, BufferID).first;
}

/// getLineAndColumn - Find the line and column number for the specified
/// location in the specified file. This is not a fast method.
/// Find the line and column number for the specified location in the
/// specified file. This is not a fast method.
std::pair<unsigned, unsigned>
getLineAndColumn(SMLoc Loc, int BufferID = -1) const;

/// PrintMessage - Emit a message about the specified location with the
/// specified string.
/// Emit a message about the specified location with the specified string.
///
/// @param ShowColors - Display colored messages if output is a terminal and
/// \param ShowColors Display colored messages if output is a terminal and
/// the default error handler is used.
void PrintMessage(raw_ostream &OS, SMLoc Loc, DiagKind Kind,
const Twine &Msg,
Expand All @@ -157,21 +157,21 @@ class SourceMgr {
ArrayRef<SMFixIt> FixIts = None,
bool ShowColors = true) const;

/// GetMessage - Return an SMDiagnostic at the specified location with the
/// specified string.
/// Return an SMDiagnostic at the specified location with the specified
/// string.
///
/// @param Msg If non-null, the kind of message (e.g., "error") which is
/// \param Msg If non-null, the kind of message (e.g., "error") which is
/// prefixed to the message.
SMDiagnostic GetMessage(SMLoc Loc, DiagKind Kind, const Twine &Msg,
ArrayRef<SMRange> Ranges = None,
ArrayRef<SMFixIt> FixIts = None) const;

/// PrintIncludeStack - 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.
/// 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.
///
/// @param IncludeLoc - The line of the include.
/// @param OS the raw_ostream to print on.
/// \param IncludeLoc The location of the include.
/// \param OS the raw_ostream to print on.
void PrintIncludeStack(SMLoc IncludeLoc, raw_ostream &OS) const;
};

Expand Down Expand Up @@ -208,8 +208,8 @@ class SMFixIt {
};


/// SMDiagnostic - Instances of this class encapsulate one diagnostic report,
/// allowing printing to a raw_ostream as a caret diagnostic.
/// Instances of this class encapsulate one diagnostic report, allowing
/// printing to a raw_ostream as a caret diagnostic.
class SMDiagnostic {
const SourceMgr *SM;
SMLoc Loc;
Expand Down
12 changes: 0 additions & 12 deletions lib/Support/SourceMgr.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,6 @@ SourceMgr::~SourceMgr() {
}
}

/// AddIncludeFile - 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.
size_t SourceMgr::AddIncludeFile(const std::string &Filename,
SMLoc IncludeLoc,
std::string &IncludedFile) {
Expand All @@ -71,8 +68,6 @@ size_t SourceMgr::AddIncludeFile(const std::string &Filename,
}


/// FindBufferContainingLoc - Return the ID of the buffer containing the
/// specified location, returning -1 if not found.
int SourceMgr::FindBufferContainingLoc(SMLoc Loc) const {
for (unsigned i = 0, e = Buffers.size(); i != e; ++i)
if (Loc.getPointer() >= Buffers[i].Buffer->getBufferStart() &&
Expand All @@ -83,8 +78,6 @@ int SourceMgr::FindBufferContainingLoc(SMLoc Loc) const {
return -1;
}

/// getLineAndColumn - Find the line and column number for the specified
/// location in the specified file. This is not a fast method.
std::pair<unsigned, unsigned>
SourceMgr::getLineAndColumn(SMLoc Loc, int BufferID) const {
if (BufferID == -1) BufferID = FindBufferContainingLoc(Loc);
Expand Down Expand Up @@ -143,11 +136,6 @@ void SourceMgr::PrintIncludeStack(SMLoc IncludeLoc, raw_ostream &OS) const {
}


/// GetMessage - Return an SMDiagnostic at the specified location with the
/// specified string.
///
/// @param Type - If non-null, the kind of message (e.g., "error") which is
/// prefixed to the message.
SMDiagnostic SourceMgr::GetMessage(SMLoc Loc, SourceMgr::DiagKind Kind,
const Twine &Msg,
ArrayRef<SMRange> Ranges,
Expand Down

0 comments on commit ecb1c3a

Please sign in to comment.