1 //===- SourceMgr.h - Manager for Source Buffers & Diagnostics ---*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares the SMDiagnostic and SourceMgr classes. This
11 // provides a simple substrate for diagnostics, #include handling, and other low
12 // level things for simple parsers.
14 //===----------------------------------------------------------------------===//
16 #ifndef SUPPORT_SOURCEMGR_H
17 #define SUPPORT_SOURCEMGR_H
19 #include "llvm/Support/SMLoc.h"
32 /// SourceMgr - This owns the files read by a parser, handles include stacks,
33 /// and handles diagnostic wrangling.
36 /// DiagHandlerTy - Clients that want to handle their own diagnostics in a
37 /// custom way can register a function pointer+context as a diagnostic
38 /// handler. It gets called each time PrintMessage is invoked.
39 typedef void (*DiagHandlerTy)(const SMDiagnostic&, void *Context);
42 /// Buffer - The memory buffer for the file.
45 /// IncludeLoc - This is the location of the parent include, or null if at
50 /// Buffers - This is all of the buffers that we are reading from.
51 std::vector<SrcBuffer> Buffers;
53 // IncludeDirectories - This is the list of directories we should search for
55 std::vector<std::string> IncludeDirectories;
57 /// LineNoCache - This is a cache for line number queries, its implementation
58 /// is really private to SourceMgr.cpp.
59 mutable void *LineNoCache;
61 DiagHandlerTy DiagHandler;
64 SourceMgr(const SourceMgr&); // DO NOT IMPLEMENT
65 void operator=(const SourceMgr&); // DO NOT IMPLEMENT
67 SourceMgr() : LineNoCache(0), DiagHandler(0), DiagContext(0) {}
70 void setIncludeDirs(const std::vector<std::string> &Dirs) {
71 IncludeDirectories = Dirs;
74 /// setDiagHandler - Specify a diagnostic handler to be invoked every time
75 /// PrintMessage is called. Ctx is passed into the handler when it is invoked.
76 void setDiagHandler(DiagHandlerTy DH, void *Ctx = 0) {
81 const SrcBuffer &getBufferInfo(unsigned i) const {
82 assert(i < Buffers.size() && "Invalid Buffer ID!");
86 const MemoryBuffer *getMemoryBuffer(unsigned i) const {
87 assert(i < Buffers.size() && "Invalid Buffer ID!");
88 return Buffers[i].Buffer;
91 SMLoc getParentIncludeLoc(unsigned i) const {
92 assert(i < Buffers.size() && "Invalid Buffer ID!");
93 return Buffers[i].IncludeLoc;
96 /// AddNewSourceBuffer - Add a new source buffer to this source manager. This
97 /// takes ownership of the memory buffer.
98 unsigned AddNewSourceBuffer(MemoryBuffer *F, SMLoc IncludeLoc) {
101 NB.IncludeLoc = IncludeLoc;
102 Buffers.push_back(NB);
103 return Buffers.size()-1;
106 /// AddIncludeFile - Search for a file with the specified name in the current
107 /// directory or in one of the IncludeDirs. If no file is found, this returns
108 /// ~0, otherwise it returns the buffer ID of the stacked file.
109 unsigned AddIncludeFile(const std::string &Filename, SMLoc IncludeLoc);
111 /// FindBufferContainingLoc - Return the ID of the buffer containing the
112 /// specified location, returning -1 if not found.
113 int FindBufferContainingLoc(SMLoc Loc) const;
115 /// FindLineNumber - Find the line number for the specified location in the
116 /// specified file. This is not a fast method.
117 unsigned FindLineNumber(SMLoc Loc, int BufferID = -1) const;
119 /// PrintMessage - Emit a message about the specified location with the
120 /// specified string.
122 /// @param Type - If non-null, the kind of message (e.g., "error") which is
123 /// prefixed to the message.
124 /// @param ShowLine - Should the diagnostic show the source line.
125 void PrintMessage(SMLoc Loc, const Twine &Msg, const char *Type,
126 bool ShowLine = true) const;
129 /// GetMessage - Return an SMDiagnostic at the specified location with the
130 /// specified string.
132 /// @param Type - If non-null, the kind of message (e.g., "error") which is
133 /// prefixed to the message.
134 /// @param ShowLine - Should the diagnostic show the source line.
135 SMDiagnostic GetMessage(SMLoc Loc,
136 const Twine &Msg, const char *Type,
137 bool ShowLine = true) const;
141 void PrintIncludeStack(SMLoc IncludeLoc, raw_ostream &OS) const;
145 /// SMDiagnostic - Instances of this class encapsulate one diagnostic report,
146 /// allowing printing to a raw_ostream as a caret diagnostic.
150 std::string Filename;
151 int LineNo, ColumnNo;
152 std::string Message, LineContents;
153 unsigned ShowLine : 1;
157 SMDiagnostic() : SM(0), LineNo(0), ColumnNo(0), ShowLine(0) {}
158 // Diagnostic with no location (e.g. file not found, command line arg error).
159 SMDiagnostic(const std::string &filename, const std::string &Msg,
160 bool showline = true)
161 : SM(0), Filename(filename), LineNo(-1), ColumnNo(-1),
162 Message(Msg), ShowLine(showline) {}
164 // Diagnostic with a location.
165 SMDiagnostic(const SourceMgr &sm, SMLoc L, const std::string &FN,
167 const std::string &Msg, const std::string &LineStr,
168 bool showline = true)
169 : SM(&sm), Loc(L), Filename(FN), LineNo(Line), ColumnNo(Col), Message(Msg),
170 LineContents(LineStr), ShowLine(showline) {}
172 const SourceMgr *getSourceMgr() const { return SM; }
173 SMLoc getLoc() const { return Loc; }
174 const std::string &getFilename() { return Filename; }
175 int getLineNo() const { return LineNo; }
176 int getColumnNo() const { return ColumnNo; }
177 const std::string &getMessage() const { return Message; }
178 const std::string &getLineContents() const { return LineContents; }
179 bool getShowLine() const { return ShowLine; }
181 void Print(const char *ProgName, raw_ostream &S) const;
184 } // end llvm namespace