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"
31 /// SourceMgr - This owns the files read by a parser, handles include stacks,
32 /// and handles diagnostic wrangling.
35 /// DiagHandlerTy - Clients that want to handle their own diagnostics in a
36 /// custom way can register a function pointer+context as a diagnostic
37 /// handler. It gets called each time PrintMessage is invoked.
38 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;
63 unsigned DiagLocCookie;
65 SourceMgr(const SourceMgr&); // DO NOT IMPLEMENT
66 void operator=(const SourceMgr&); // DO NOT IMPLEMENT
68 SourceMgr() : LineNoCache(0), DiagHandler(0), DiagContext(0) {}
71 void setIncludeDirs(const std::vector<std::string> &Dirs) {
72 IncludeDirectories = Dirs;
75 /// setDiagHandler - Specify a diagnostic handler to be invoked every time
76 /// PrintMessage is called. Ctx and Cookie are passed into the handler when
78 void setDiagHandler(DiagHandlerTy DH, void *Ctx = 0, unsigned Cookie = 0) {
81 DiagLocCookie = Cookie;
84 const SrcBuffer &getBufferInfo(unsigned i) const {
85 assert(i < Buffers.size() && "Invalid Buffer ID!");
89 const MemoryBuffer *getMemoryBuffer(unsigned i) const {
90 assert(i < Buffers.size() && "Invalid Buffer ID!");
91 return Buffers[i].Buffer;
94 SMLoc getParentIncludeLoc(unsigned i) const {
95 assert(i < Buffers.size() && "Invalid Buffer ID!");
96 return Buffers[i].IncludeLoc;
99 /// AddNewSourceBuffer - Add a new source buffer to this source manager. This
100 /// takes ownership of the memory buffer.
101 unsigned AddNewSourceBuffer(MemoryBuffer *F, SMLoc IncludeLoc) {
104 NB.IncludeLoc = IncludeLoc;
105 Buffers.push_back(NB);
106 return Buffers.size()-1;
109 /// AddIncludeFile - Search for a file with the specified name in the current
110 /// directory or in one of the IncludeDirs. If no file is found, this returns
111 /// ~0, otherwise it returns the buffer ID of the stacked file.
112 unsigned AddIncludeFile(const std::string &Filename, SMLoc IncludeLoc);
114 /// FindBufferContainingLoc - Return the ID of the buffer containing the
115 /// specified location, returning -1 if not found.
116 int FindBufferContainingLoc(SMLoc Loc) const;
118 /// FindLineNumber - Find the line number for the specified location in the
119 /// specified file. This is not a fast method.
120 unsigned FindLineNumber(SMLoc Loc, int BufferID = -1) const;
122 /// PrintMessage - Emit a message about the specified location with the
123 /// specified string.
125 /// @param Type - If non-null, the kind of message (e.g., "error") which is
126 /// prefixed to the message.
127 /// @param ShowLine - Should the diagnostic show the source line.
128 void PrintMessage(SMLoc Loc, const std::string &Msg, const char *Type,
129 bool ShowLine = true) const;
132 /// GetMessage - Return an SMDiagnostic at the specified location with the
133 /// specified string.
135 /// @param Type - If non-null, the kind of message (e.g., "error") which is
136 /// prefixed to the message.
137 /// @param ShowLine - Should the diagnostic show the source line.
138 SMDiagnostic GetMessage(SMLoc Loc,
139 const std::string &Msg, const char *Type,
140 bool ShowLine = true) const;
144 void PrintIncludeStack(SMLoc IncludeLoc, raw_ostream &OS) const;
148 /// SMDiagnostic - Instances of this class encapsulate one diagnostic report,
149 /// allowing printing to a raw_ostream as a caret diagnostic.
153 std::string Filename;
154 int LineNo, ColumnNo;
155 std::string Message, LineContents;
156 unsigned ShowLine : 1;
160 SMDiagnostic() : SM(0), LineNo(0), ColumnNo(0), ShowLine(0) {}
161 // Diagnostic with no location (e.g. file not found, command line arg error).
162 SMDiagnostic(const std::string &filename, const std::string &Msg,
163 bool showline = true)
164 : SM(0), Loc(), Filename(filename), LineNo(-1), ColumnNo(-1),
165 Message(Msg), LineContents(""), ShowLine(showline) {}
167 // Diagnostic with a location.
168 SMDiagnostic(const SourceMgr &sm, SMLoc L, const std::string &FN,
170 const std::string &Msg, const std::string &LineStr,
171 bool showline = true)
172 : SM(&sm), Loc(L), Filename(FN), LineNo(Line), ColumnNo(Col), Message(Msg),
173 LineContents(LineStr), ShowLine(showline) {}
175 const SourceMgr *getSourceMgr() const { return SM; }
176 SMLoc getLoc() const { return Loc; }
177 const std::string &getFilename() { return Filename; }
178 int getLineNo() const { return LineNo; }
179 int getColumnNo() const { return ColumnNo; }
180 const std::string &getMessage() const { return Message; }
181 const std::string &getLineContents() const { return LineContents; }
182 bool getShowLine() const { return ShowLine; }
184 void Print(const char *ProgName, raw_ostream &S) const;
187 } // end llvm namespace