SourceMgr.h revision 3f2d5f60b31fd057c10f77b2e607b23a8c94f6d3 
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&);    // DO NOT IMPLEMENT
69  void operator=(const SourceMgr&); // DO NOT IMPLEMENT
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  const SrcBuffer &getBufferInfo(unsigned i) const {
86    assert(i < Buffers.size() && "Invalid Buffer ID!");
87    return Buffers[i];
88  }
89
90  const MemoryBuffer *getMemoryBuffer(unsigned i) const {
91    assert(i < Buffers.size() && "Invalid Buffer ID!");
92    return Buffers[i].Buffer;
93  }
94
95  SMLoc getParentIncludeLoc(unsigned i) const {
96    assert(i < Buffers.size() && "Invalid Buffer ID!");
97    return Buffers[i].IncludeLoc;
98  }
99
100  /// AddNewSourceBuffer - Add a new source buffer to this source manager.  This
101  /// takes ownership of the memory buffer.
102  unsigned AddNewSourceBuffer(MemoryBuffer *F, SMLoc IncludeLoc) {
103    SrcBuffer NB;
104    NB.Buffer = F;
105    NB.IncludeLoc = IncludeLoc;
106    Buffers.push_back(NB);
107    return Buffers.size()-1;
108  }
109
110  /// AddIncludeFile - Search for a file with the specified name in the current
111  /// directory or in one of the IncludeDirs.  If no file is found, this returns
112  /// ~0, otherwise it returns the buffer ID of the stacked file.
113  /// The full path to the included file can be found in IncludedFile.
114  unsigned AddIncludeFile(const std::string &Filename, SMLoc IncludeLoc,
115                          std::string &IncludedFile);
116
117  /// FindBufferContainingLoc - Return the ID of the buffer containing the
118  /// specified location, returning -1 if not found.
119  int FindBufferContainingLoc(SMLoc Loc) const;
120
121  /// FindLineNumber - Find the line number for the specified location in the
122  /// specified file.  This is not a fast method.
123  unsigned FindLineNumber(SMLoc Loc, int BufferID = -1) const;
124
125  /// PrintMessage - Emit a message about the specified location with the
126  /// specified string.
127  ///
128  void PrintMessage(SMLoc Loc, DiagKind Kind, const Twine &Msg,
129                    ArrayRef<SMRange> Ranges = ArrayRef<SMRange>(),
130                    bool ShowLine = true) const;
131
132
133  /// GetMessage - Return an SMDiagnostic at the specified location with the
134  /// specified string.
135  ///
136  /// @param Type - If non-null, the kind of message (e.g., "error") which is
137  /// prefixed to the message.
138  /// @param ShowLine - Should the diagnostic show the source line.
139  SMDiagnostic GetMessage(SMLoc Loc, DiagKind Kind, const Twine &Msg,
140                          ArrayRef<SMRange> Ranges = ArrayRef<SMRange>(),
141                          bool ShowLine = true) const;
142
143  /// PrintIncludeStack - Prints the names of included files and the line of the
144  /// file they were included from.  A diagnostic handler can use this before
145  /// printing its custom formatted message.
146  ///
147  /// @param IncludeLoc - The line of the include.
148  /// @param OS the raw_ostream to print on.
149  void PrintIncludeStack(SMLoc IncludeLoc, raw_ostream &OS) const;
150};
151
152
153/// SMDiagnostic - Instances of this class encapsulate one diagnostic report,
154/// allowing printing to a raw_ostream as a caret diagnostic.
155class SMDiagnostic {
156  const SourceMgr *SM;
157  SMLoc Loc;
158  std::string Filename;
159  int LineNo, ColumnNo;
160  SourceMgr::DiagKind Kind;
161  std::string Message, LineContents;
162  unsigned ShowLine : 1;
163  std::vector<std::pair<unsigned, unsigned> > Ranges;
164
165public:
166  // Null diagnostic.
167  SMDiagnostic()
168    : SM(0), LineNo(0), ColumnNo(0), Kind(SourceMgr::DK_Error), ShowLine(0) {}
169  // Diagnostic with no location (e.g. file not found, command line arg error).
170  SMDiagnostic(const std::string &filename, SourceMgr::DiagKind Kind,
171               const std::string &Msg)
172    : SM(0), Filename(filename), LineNo(-1), ColumnNo(-1), Kind(Kind),
173      Message(Msg), ShowLine(false) {}
174
175  // Diagnostic with a location.
176  SMDiagnostic(const SourceMgr &sm, SMLoc L, const std::string &FN,
177               int Line, int Col, SourceMgr::DiagKind Kind,
178               const std::string &Msg, const std::string &LineStr,
179               ArrayRef<std::pair<unsigned,unsigned> > Ranges, bool showline);
180
181  const SourceMgr *getSourceMgr() const { return SM; }
182  SMLoc getLoc() const { return Loc; }
183  const std::string &getFilename() const { return Filename; }
184  int getLineNo() const { return LineNo; }
185  int getColumnNo() const { return ColumnNo; }
186  SourceMgr::DiagKind getKind() const { return Kind; }
187  const std::string &getMessage() const { return Message; }
188  const std::string &getLineContents() const { return LineContents; }
189  bool getShowLine() const { return ShowLine; }
190  const std::vector<std::pair<unsigned, unsigned> > &getRanges() const {
191    return Ranges;
192  }
193  void print(const char *ProgName, raw_ostream &S) const;
194};
195
196}  // end llvm namespace
197
198#endif
199