add comments, don't require inlined-at to be specified.
[oota-llvm.git] / include / llvm / Support / SourceMgr.h
index 0260d2d751821dfd71657fe4338cc7c5aed492c0..fd56b16639cbade317dfc25ecdb4b4d70e6a4305 100644 (file)
@@ -7,7 +7,7 @@
 //
 //===----------------------------------------------------------------------===//
 //
-// This file declares the SMLoc, SMDiagnostic and SourceMgr classes.  This
+// This file declares the SMDiagnostic and SourceMgr classes.  This
 // provides a simple substrate for diagnostics, #include handling, and other low
 // level things for simple parsers.
 //
@@ -16,6 +16,8 @@
 #ifndef SUPPORT_SOURCEMGR_H
 #define SUPPORT_SOURCEMGR_H
 
+#include "llvm/Support/SMLoc.h"
+
 #include <string>
 #include <vector>
 #include <cassert>
@@ -25,26 +27,6 @@ namespace llvm {
   class SourceMgr;
   class SMDiagnostic;
   class raw_ostream;
-  
-class SMLoc {
-  const char *Ptr;
-public:
-  SMLoc() : Ptr(0) {}
-  SMLoc(const SMLoc &RHS) : Ptr(RHS.Ptr) {}
-  
-  bool isValid() const { return Ptr != 0; }
-
-  bool operator==(const SMLoc &RHS) const { return RHS.Ptr == Ptr; }
-  bool operator!=(const SMLoc &RHS) const { return RHS.Ptr != Ptr; }
-
-  const char *getPointer() const { return Ptr; }
-  
-  static SMLoc getFromPointer(const char *Ptr) {
-    SMLoc L;
-    L.Ptr = Ptr;
-    return L;
-  }
-};
 
 /// SourceMgr - This owns the files read by a parser, handles include stacks,
 /// and handles diagnostic wrangling.
@@ -52,29 +34,33 @@ class SourceMgr {
   struct SrcBuffer {
     /// Buffer - The memory buffer for the file.
     MemoryBuffer *Buffer;
-    
+
     /// IncludeLoc - This is the location of the parent include, or null if at
     /// the top level.
     SMLoc IncludeLoc;
   };
-  
+
   /// Buffers - This is all of the buffers that we are reading from.
   std::vector<SrcBuffer> Buffers;
-  
+
   // IncludeDirectories - This is the list of directories we should search for
   // include files in.
   std::vector<std::string> IncludeDirectories;
-  
+
+  /// LineNoCache - This is a cache for line number queries, its implementation
+  /// is really private to SourceMgr.cpp.
+  mutable void *LineNoCache;
+
   SourceMgr(const SourceMgr&);    // DO NOT IMPLEMENT
   void operator=(const SourceMgr&); // DO NOT IMPLEMENT
 public:
-  SourceMgr() {}
+  SourceMgr() : LineNoCache(0) {}
   ~SourceMgr();
-  
+
   void setIncludeDirs(const std::vector<std::string> &Dirs) {
     IncludeDirectories = Dirs;
   }
-  
+
   const SrcBuffer &getBufferInfo(unsigned i) const {
     assert(i < Buffers.size() && "Invalid Buffer ID!");
     return Buffers[i];
@@ -84,12 +70,12 @@ public:
     assert(i < Buffers.size() && "Invalid Buffer ID!");
     return Buffers[i].Buffer;
   }
-  
+
   SMLoc getParentIncludeLoc(unsigned i) const {
     assert(i < Buffers.size() && "Invalid Buffer ID!");
     return Buffers[i].IncludeLoc;
   }
-  
+
   unsigned AddNewSourceBuffer(MemoryBuffer *F, SMLoc IncludeLoc) {
     SrcBuffer NB;
     NB.Buffer = F;
@@ -97,59 +83,65 @@ public:
     Buffers.push_back(NB);
     return Buffers.size()-1;
   }
-  
+
   /// AddIncludeFile - Search for a file with the specified name in the current
   /// directory or in one of the IncludeDirs.  If no file is found, this returns
   /// ~0, otherwise it returns the buffer ID of the stacked file.
   unsigned AddIncludeFile(const std::string &Filename, SMLoc IncludeLoc);
-  
+
   /// FindBufferContainingLoc - Return the ID of the buffer containing the
   /// specified location, returning -1 if not found.
   int FindBufferContainingLoc(SMLoc Loc) const;
-  
+
   /// FindLineNumber - Find the line number for the specified location in the
   /// specified file.  This is not a fast method.
   unsigned FindLineNumber(SMLoc Loc, int BufferID = -1) const;
-  
+
   /// PrintMessage - Emit a message about the specified location with the
   /// specified string.
   ///
   /// @param Type - If non-null, the kind of message (e.g., "error") which is
   /// prefixed to the message.
-  void PrintMessage(SMLoc Loc, const std::string &Msg, const char *Type) const;
-  
+  /// @param ShowLine - Should the diagnostic show the source line.
+  void PrintMessage(SMLoc Loc, const std::string &Msg, const char *Type,
+                    bool ShowLine = true) const;
+
+
+  /// GetMessage - Return an SMDiagnostic at the specified location with the
+  /// specified string.
+  ///
+  /// @param Type - If non-null, the kind of message (e.g., "error") which is
+  /// prefixed to the message.
+  /// @param ShowLine - Should the diagnostic show the source line.
+  SMDiagnostic GetMessage(SMLoc Loc,
+                          const std::string &Msg, const char *Type,
+                          bool ShowLine = true) const;
+
+
 private:
   void PrintIncludeStack(SMLoc IncludeLoc, raw_ostream &OS) const;
 };
 
-  
+
 /// SMDiagnostic - Instances of this class encapsulate one diagnostic report,
 /// allowing printing to a raw_ostream as a caret diagnostic.
 class SMDiagnostic {
   std::string Filename;
   int LineNo, ColumnNo;
   std::string Message, LineContents;
+  unsigned ShowLine : 1;
+
 public:
-  SMDiagnostic() : LineNo(0), ColumnNo(0) {}
+  SMDiagnostic() : LineNo(0), ColumnNo(0), ShowLine(0) {}
   SMDiagnostic(const std::string &FN, int Line, int Col,
-               const std::string &Msg, const std::string &LineStr)
+               const std::string &Msg, const std::string &LineStr,
+               bool showline = true)
     : Filename(FN), LineNo(Line), ColumnNo(Col), Message(Msg),
-      LineContents(LineStr) {}
-  SMDiagnostic(const SMDiagnostic &RHS) {
-    operator=(RHS);
-  }
+      LineContents(LineStr), ShowLine(showline) {}
 
-  void operator=(const SMDiagnostic &E) {
-    Filename = E.Filename;
-    LineNo = E.LineNo;
-    ColumnNo = E.ColumnNo;
-    Message = E.Message;
-    LineContents = E.LineContents;
-  }
-
-  void Print(const char *ProgName, raw_ostream &S);
+  void Print(const char *ProgName, raw_ostream &S) const;
 };
-  
+
 }  // end llvm namespace
 
 #endif