1 //===- SourceMgr.h - Manager for Source Buffers & Diagnostics ---*- C++ -*-===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 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. 13 // 14 //===----------------------------------------------------------------------===// 15 16 #ifndef SUPPORT_SOURCEMGR_H 17 #define SUPPORT_SOURCEMGR_H 18 19 #include "llvm/Support/SMLoc.h" 20 21 #include <string> 22 #include <vector> 23 #include <cassert> 24 25 namespace llvm { 26 class MemoryBuffer; 27 class SourceMgr; 28 class SMDiagnostic; 29 class Twine; 30 class raw_ostream; 31 32 /// SourceMgr - This owns the files read by a parser, handles include stacks, 33 /// and handles diagnostic wrangling. 34 class SourceMgr { 35 public: 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); 40 private: 41 struct SrcBuffer { 42 /// Buffer - The memory buffer for the file. 43 MemoryBuffer *Buffer; 44 45 /// IncludeLoc - This is the location of the parent include, or null if at 46 /// the top level. 47 SMLoc IncludeLoc; 48 }; 49 50 /// Buffers - This is all of the buffers that we are reading from. 51 std::vector<SrcBuffer> Buffers; 52 53 // IncludeDirectories - This is the list of directories we should search for 54 // include files in. 55 std::vector<std::string> IncludeDirectories; 56 57 /// LineNoCache - This is a cache for line number queries, its implementation 58 /// is really private to SourceMgr.cpp. 59 mutable void *LineNoCache; 60 61 DiagHandlerTy DiagHandler; 62 void *DiagContext; 63 64 SourceMgr(const SourceMgr&); // DO NOT IMPLEMENT 65 void operator=(const SourceMgr&); // DO NOT IMPLEMENT 66 public: 67 SourceMgr() : LineNoCache(0), DiagHandler(0), DiagContext(0) {} 68 ~SourceMgr(); 69 70 void setIncludeDirs(const std::vector<std::string> &Dirs) { 71 IncludeDirectories = Dirs; 72 } 73 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) { 77 DiagHandler = DH; 78 DiagContext = Ctx; 79 } 80 81 DiagHandlerTy getDiagHandler() const { return DiagHandler; } 82 void *getDiagContext() const { return DiagContext; } 83 84 const SrcBuffer &getBufferInfo(unsigned i) const { 85 assert(i < Buffers.size() && "Invalid Buffer ID!"); 86 return Buffers[i]; 87 } 88 89 const MemoryBuffer *getMemoryBuffer(unsigned i) const { 90 assert(i < Buffers.size() && "Invalid Buffer ID!"); 91 return Buffers[i].Buffer; 92 } 93 94 SMLoc getParentIncludeLoc(unsigned i) const { 95 assert(i < Buffers.size() && "Invalid Buffer ID!"); 96 return Buffers[i].IncludeLoc; 97 } 98 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) { 102 SrcBuffer NB; 103 NB.Buffer = F; 104 NB.IncludeLoc = IncludeLoc; 105 Buffers.push_back(NB); 106 return Buffers.size()-1; 107 } 108 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 /// The full path to the included file can be found in IncludedFile. 113 unsigned AddIncludeFile(const std::string &Filename, SMLoc IncludeLoc, 114 std::string &IncludedFile); 115 116 /// FindBufferContainingLoc - Return the ID of the buffer containing the 117 /// specified location, returning -1 if not found. 118 int FindBufferContainingLoc(SMLoc Loc) const; 119 120 /// FindLineNumber - Find the line number for the specified location in the 121 /// specified file. This is not a fast method. 122 unsigned FindLineNumber(SMLoc Loc, int BufferID = -1) const; 123 124 /// PrintMessage - Emit a message about the specified location with the 125 /// specified string. 126 /// 127 /// @param Type - If non-null, the kind of message (e.g., "error") which is 128 /// prefixed to the message. 129 /// @param ShowLine - Should the diagnostic show the source line. 130 void PrintMessage(SMLoc Loc, const Twine &Msg, const char *Type, 131 bool ShowLine = true) const; 132 133 134 /// GetMessage - Return an SMDiagnostic at the specified location with the 135 /// specified string. 136 /// 137 /// @param Type - If non-null, the kind of message (e.g., "error") which is 138 /// prefixed to the message. 139 /// @param ShowLine - Should the diagnostic show the source line. 140 SMDiagnostic GetMessage(SMLoc Loc, 141 const Twine &Msg, const char *Type, 142 bool ShowLine = true) const; 143 144 /// PrintIncludeStack - Prints the names of included files and the line of the 145 /// file they were included from. A diagnostic handler can use this before 146 /// printing its custom formatted message. 147 /// 148 /// @param IncludeLoc - The line of the include. 149 /// @param OS the raw_ostream to print on. 150 void PrintIncludeStack(SMLoc IncludeLoc, raw_ostream &OS) const; 151 }; 152 153 154 /// SMDiagnostic - Instances of this class encapsulate one diagnostic report, 155 /// allowing printing to a raw_ostream as a caret diagnostic. 156 class SMDiagnostic { 157 const SourceMgr *SM; 158 SMLoc Loc; 159 std::string Filename; 160 int LineNo, ColumnNo; 161 std::string Message, LineContents; 162 unsigned ShowLine : 1; 163 164 public: 165 // Null diagnostic. 166 SMDiagnostic() : SM(0), LineNo(0), ColumnNo(0), ShowLine(0) {} 167 // Diagnostic with no location (e.g. file not found, command line arg error). 168 SMDiagnostic(const std::string &filename, const std::string &Msg) 169 : SM(0), Filename(filename), LineNo(-1), ColumnNo(-1), 170 Message(Msg), ShowLine(false) {} 171 172 // Diagnostic with a location. 173 SMDiagnostic(const SourceMgr &sm, SMLoc L, const std::string &FN, 174 int Line, int Col, 175 const std::string &Msg, const std::string &LineStr, 176 bool showline = true) 177 : SM(&sm), Loc(L), Filename(FN), LineNo(Line), ColumnNo(Col), Message(Msg), 178 LineContents(LineStr), ShowLine(showline) {} 179 180 const SourceMgr *getSourceMgr() const { return SM; } 181 SMLoc getLoc() const { return Loc; } 182 const std::string &getFilename() const { return Filename; } 183 int getLineNo() const { return LineNo; } 184 int getColumnNo() const { return ColumnNo; } 185 const std::string &getMessage() const { return Message; } 186 const std::string &getLineContents() const { return LineContents; } 187 bool getShowLine() const { return ShowLine; } 188 189 void Print(const char *ProgName, raw_ostream &S) const; 190 }; 191 192 } // end llvm namespace 193 194 #endif 195
