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#include "llvm/ADT/ArrayRef.h"
21#include <string>
22
23namespace llvm {
24  class MemoryBuffer;
25  class SourceMgr;
26  class SMDiagnostic;
27  class Twine;
28  class raw_ostream;
29
30/// SourceMgr - This owns the files read by a parser, handles include stacks,
31/// and handles diagnostic wrangling.
32class SourceMgr {
33public:
34  enum DiagKind {
35    DK_Error,
36    DK_Warning,
37    DK_Note
38  };
39
40  /// DiagHandlerTy - Clients that want to handle their own diagnostics in a
41  /// custom way can register a function pointer+context as a diagnostic
42  /// handler.  It gets called each time PrintMessage is invoked.
43  typedef void (*DiagHandlerTy)(const SMDiagnostic &, void *Context);
44private:
45  struct SrcBuffer {
46    /// Buffer - The memory buffer for the file.
47    MemoryBuffer *Buffer;
48
49    /// IncludeLoc - This is the location of the parent include, or null if at
50    /// the top level.
51    SMLoc IncludeLoc;
52  };
53
54  /// Buffers - This is all of the buffers that we are reading from.
55  std::vector<SrcBuffer> Buffers;
56
57  // IncludeDirectories - This is the list of directories we should search for
58  // include files in.
59  std::vector<std::string> IncludeDirectories;
60
61  /// LineNoCache - This is a cache for line number queries, its implementation
62  /// is really private to SourceMgr.cpp.
63  mutable void *LineNoCache;
64
65  DiagHandlerTy DiagHandler;
66  void *DiagContext;
67
68  SourceMgr(const SourceMgr&) LLVM_DELETED_FUNCTION;
69  void operator=(const SourceMgr&) LLVM_DELETED_FUNCTION;
70public:
71  SourceMgr() : LineNoCache(0), DiagHandler(0), DiagContext(0) {}
72  ~SourceMgr();
73
74  void setIncludeDirs(const std::vector<std::string> &Dirs) {
75    IncludeDirectories = Dirs;
76  }
77
78  /// setDiagHandler - Specify a diagnostic handler to be invoked every time
79  /// PrintMessage is called. Ctx is passed into the handler when it is invoked.
80  void setDiagHandler(DiagHandlerTy DH, void *Ctx = 0) {
81    DiagHandler = DH;
82    DiagContext = Ctx;
83  }
84
85  DiagHandlerTy getDiagHandler() const { return DiagHandler; }
86  void *getDiagContext() const { return DiagContext; }
87
88  const SrcBuffer &getBufferInfo(unsigned i) const {
89    assert(i < Buffers.size() && "Invalid Buffer ID!");
90    return Buffers[i];
91  }
92
93  const MemoryBuffer *getMemoryBuffer(unsigned i) const {
94    assert(i < Buffers.size() && "Invalid Buffer ID!");
95    return Buffers[i].Buffer;
96  }
97
98  SMLoc getParentIncludeLoc(unsigned i) const {
99    assert(i < Buffers.size() && "Invalid Buffer ID!");
100    return Buffers[i].IncludeLoc;
101  }
102
103  /// AddNewSourceBuffer - Add a new source buffer to this source manager.  This
104  /// takes ownership of the memory buffer.
105  unsigned AddNewSourceBuffer(MemoryBuffer *F, SMLoc IncludeLoc) {
106    SrcBuffer NB;
107    NB.Buffer = F;
108    NB.IncludeLoc = IncludeLoc;
109    Buffers.push_back(NB);
110    return Buffers.size()-1;
111  }
112
113  /// AddIncludeFile - Search for a file with the specified name in the current
114  /// directory or in one of the IncludeDirs.  If no file is found, this returns
115  /// ~0, otherwise it returns the buffer ID of the stacked file.
116  /// The full path to the included file can be found in IncludedFile.
117  unsigned AddIncludeFile(const std::string &Filename, SMLoc IncludeLoc,
118                          std::string &IncludedFile);
119
120  /// FindBufferContainingLoc - Return the ID of the buffer containing the
121  /// specified location, returning -1 if not found.
122  int FindBufferContainingLoc(SMLoc Loc) const;
123
124  /// FindLineNumber - Find the line number for the specified location in the
125  /// specified file.  This is not a fast method.
126  unsigned FindLineNumber(SMLoc Loc, int BufferID = -1) const {
127    return getLineAndColumn(Loc, BufferID).first;
128  }
129
130  /// getLineAndColumn - Find the line and column number for the specified
131  /// location in the specified file.  This is not a fast method.
132  std::pair<unsigned, unsigned>
133    getLineAndColumn(SMLoc Loc, int BufferID = -1) const;
134
135  /// PrintMessage - Emit a message about the specified location with the
136  /// specified string.
137  ///
138  /// @param ShowColors - Display colored messages if output is a terminal and
139  /// the default error handler is used.
140  void PrintMessage(SMLoc Loc, DiagKind Kind, const Twine &Msg,
141                    ArrayRef<SMRange> Ranges = ArrayRef<SMRange>(),
142                    bool ShowColors = true) const;
143
144
145  /// GetMessage - Return an SMDiagnostic at the specified location with the
146  /// specified string.
147  ///
148  /// @param Msg If non-null, the kind of message (e.g., "error") which is
149  /// prefixed to the message.
150  SMDiagnostic GetMessage(SMLoc Loc, DiagKind Kind, const Twine &Msg,
151                          ArrayRef<SMRange> Ranges = ArrayRef<SMRange>()) const;
152
153  /// PrintIncludeStack - Prints the names of included files and the line of the
154  /// file they were included from.  A diagnostic handler can use this before
155  /// printing its custom formatted message.
156  ///
157  /// @param IncludeLoc - The line of the include.
158  /// @param OS the raw_ostream to print on.
159  void PrintIncludeStack(SMLoc IncludeLoc, raw_ostream &OS) const;
160};
161
162
163/// SMDiagnostic - Instances of this class encapsulate one diagnostic report,
164/// allowing printing to a raw_ostream as a caret diagnostic.
165class SMDiagnostic {
166  const SourceMgr *SM;
167  SMLoc Loc;
168  std::string Filename;
169  int LineNo, ColumnNo;
170  SourceMgr::DiagKind Kind;
171  std::string Message, LineContents;
172  std::vector<std::pair<unsigned, unsigned> > Ranges;
173
174public:
175  // Null diagnostic.
176  SMDiagnostic()
177    : SM(0), LineNo(0), ColumnNo(0), Kind(SourceMgr::DK_Error) {}
178  // Diagnostic with no location (e.g. file not found, command line arg error).
179  SMDiagnostic(const std::string &filename, SourceMgr::DiagKind Knd,
180               const std::string &Msg)
181    : SM(0), Filename(filename), LineNo(-1), ColumnNo(-1), Kind(Knd),
182      Message(Msg) {}
183
184  // Diagnostic with a location.
185  SMDiagnostic(const SourceMgr &sm, SMLoc L, const std::string &FN,
186               int Line, int Col, SourceMgr::DiagKind Kind,
187               const std::string &Msg, const std::string &LineStr,
188               ArrayRef<std::pair<unsigned,unsigned> > Ranges);
189
190  const SourceMgr *getSourceMgr() const { return SM; }
191  SMLoc getLoc() const { return Loc; }
192  const std::string &getFilename() const { return Filename; }
193  int getLineNo() const { return LineNo; }
194  int getColumnNo() const { return ColumnNo; }
195  SourceMgr::DiagKind getKind() const { return Kind; }
196  const std::string &getMessage() const { return Message; }
197  const std::string &getLineContents() const { return LineContents; }
198  const std::vector<std::pair<unsigned, unsigned> > &getRanges() const {
199    return Ranges;
200  }
201  void print(const char *ProgName, raw_ostream &S, bool ShowColors = true) const;
202};
203
204}  // end llvm namespace
205
206#endif
207