Make SMDiagnostic a little more sane. Instead of passing around note/warning/error...

[oota-llvm.git] / include / llvm / Assembly / Parser.h

diff --git a/include/llvm/Assembly/Parser.h b/include/llvm/Assembly/Parser.h
index 1950b431cf6e3f7c53e6fb3206317dbff8786f6a..82ec6d81367bfb123696d6cf76ce4c6306325e47 100644 (file)
--- a/include/llvm/Assembly/Parser.h
+++ b/include/llvm/Assembly/Parser.h
@@ -2,8 +2,8 @@
 //
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by the LLVM research group and is distributed under
-// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
@@ -19,59 +19,46 @@
 namespace llvm {
 
 class Module;
-class ParseException;
-
-
-// The useful interface defined by this file... Parse an ascii file, and return
-// the internal representation in a nice slice'n'dice'able representation.  Note
-// that this does not verify that the generated LLVM is valid, so you should run
-// the verifier after parsing the file to check that it's ok.
-//
-Module *ParseAssemblyFile(const std::string &Filename);// throw (ParseException)
-
-//===------------------------------------------------------------------------===
-//                              Helper Classes
-//===------------------------------------------------------------------------===
-
-// ParseException - For when an exceptional event is generated by the parser.
-// This class lets you print out the exception message
-//
-class ParseException {
-public:
-  ParseException(const std::string &filename, const std::string &message,
-                int LineNo = -1, int ColNo = -1);
-
-  ParseException(const ParseException &E);
-
-  // getMessage - Return the message passed in at construction time plus extra
-  // information extracted from the options used to parse with...
-  //
-  const std::string getMessage() const;
-
-  inline const std::string &getRawMessage() const {   // Just the raw message...
-    return Message;
-  }
-
-  inline const std::string &getFilename() const {
-    return Filename;
-  }
-
-  // getErrorLocation - Return the line and column number of the error in the
-  // input source file.  The source filename can be derived from the
-  // ParserOptions in effect.  If positional information is not applicable,
-  // these will return a value of -1.
-  //
-  inline const void getErrorLocation(int &Line, int &Column) const {
-    Line = LineNo; Column = ColumnNo;
-  }
-
-private :
-  std::string Filename;
-  std::string Message;
-  int LineNo, ColumnNo;                               // -1 if not relevant
-
-  ParseException &operator=(const ParseException &E); // objects by reference
-};
+class MemoryBuffer;
+class SMDiagnostic;
+class raw_ostream;
+class LLVMContext;
+
+/// This function is the main interface to the LLVM Assembly Parser. It parses
+/// an ASCII file that (presumably) contains LLVM Assembly code. It returns a
+/// Module (intermediate representation) with the corresponding features. Note
+/// that this does not verify that the generated Module is valid, so you should
+/// run the verifier after parsing the file to check that it is okay.
+/// @brief Parse LLVM Assembly from a file
+Module *ParseAssemblyFile(
+  const std::string &Filename, ///< The name of the file to parse
+  SMDiagnostic &Error,         ///< Error result info.
+  LLVMContext &Context         ///< Context in which to allocate globals info.
+);
+
+/// The function is a secondary interface to the LLVM Assembly Parser. It parses
+/// an ASCII string that (presumably) contains LLVM Assembly code. It returns a
+/// Module (intermediate representation) with the corresponding features. Note
+/// that this does not verify that the generated Module is valid, so you should
+/// run the verifier after parsing the file to check that it is okay.
+/// @brief Parse LLVM Assembly from a string
+Module *ParseAssemblyString(
+  const char *AsmString, ///< The string containing assembly
+  Module *M,             ///< A module to add the assembly too.
+  SMDiagnostic &Error,   ///< Error result info.
+  LLVMContext &Context
+);
+
+/// This function is the low-level interface to the LLVM Assembly Parser.
+/// ParseAssemblyFile and ParseAssemblyString are wrappers around this function.
+/// @brief Parse LLVM Assembly from a MemoryBuffer. This function *always*
+/// takes ownership of the MemoryBuffer.
+Module *ParseAssembly(
+    MemoryBuffer *F,     ///< The MemoryBuffer containing assembly
+    Module *M,           ///< A module to add the assembly too.
+    SMDiagnostic &Err,   ///< Error result info.
+    LLVMContext &Context
+);
 
 } // End llvm namespace