Add a pointer to the owning LLVMContext to Module. This requires threading LLVMConte...

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

diff --git a/include/llvm/Assembly/Parser.h b/include/llvm/Assembly/Parser.h
index 5ac6ec20fa14b6d941d17a98cd0025b15f22a7d5..2a5bac7a704cca322b7c180e8bbe4291d4af9e06 100644 (file)
--- a/include/llvm/Assembly/Parser.h
+++ b/include/llvm/Assembly/Parser.h
@@ -1,6 +1,13 @@
-//===-- llvm/assembly/Parser.h - Parser for VM assembly files ----*- C++ -*--=//
+//===-- llvm/Assembly/Parser.h - Parser for VM assembly files ---*- C++ -*-===//
 //
-//  These classes are implemented by the lib/AssemblyParser library.
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+//  These classes are implemented by the lib/AsmParser library.
 //
 //===----------------------------------------------------------------------===//
 
@@ -9,58 +16,89 @@
 
 #include <string>
 
+namespace llvm {
+
 class Module;
-class ToolCommandLine;
-class ParseException;
+class ParseError;
+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
+  ParseError &Error,           ///< If not null, an object to return errors in.
+  LLVMContext* Context         ///< Context in which to allocate globals info.
+);
 
-// The useful interface defined by this file... Parse an ascii file, and return
-// the internal representation in a nice slice'n'dice'able representation.
-//
-Module *ParseAssemblyFile(const ToolCommandLine &Opts) throw (ParseException);
+/// 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.
+  ParseError &Error,     ///< If not null, an object to return errors in.
+  LLVMContext* Context
+);
 
 //===------------------------------------------------------------------------===
 //                              Helper Classes
 //===------------------------------------------------------------------------===
 
-// ParseException - For when an exceptional event is generated by the parser.
-// This class lets you print out the exception message
-//
-class ParseException {
+/// An instance of this class can be passed to ParseAssemblyFile or 
+/// ParseAssemblyString functions in order to capture error information from
+/// the parser.  It provides a standard way to print out the error message
+/// including the file name and line number where the error occurred.
+/// @brief An LLVM Assembly Parsing Error Object
+class ParseError {
 public:
-  ParseException(const ToolCommandLine &Opts, const string &message, 
-                int LineNo = -1, int ColNo = -1);
+  ParseError() : Filename("unknown"), Message("none"), LineNo(0), ColumnNo(0) {}
+  ParseError(const ParseError &E);
 
-  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 string getMessage() const;
-
-  inline const string getRawMessage() const {    // Just the raw message...
+  void setFilename(const std::string &F) { Filename = F; }
+  
+  inline const std::string &getRawMessage() const {   // Just the raw message.
     return Message;
   }
 
-  inline const ToolCommandLine &getOptions() const {
-    return Opts;                           // Get the options obj used to parse.
+  inline const std::string &getFilename() const {
+    return Filename;
+  }
+
+  void setError(const std::string &message, int lineNo = -1, int ColNo = -1,
+                const std::string &FileContents = "") {
+    Message = message;
+    LineNo = lineNo; ColumnNo = ColNo;
+    LineContents = FileContents;
   }
 
   // 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, 
+  // 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 {
+  inline void getErrorLocation(int &Line, int &Column) const {
     Line = LineNo; Column = ColumnNo;
   }
+  
+  void PrintError(const char *ProgName, raw_ostream &S);
 
 private :
-  const ToolCommandLine &Opts;
-  string Message;
+  std::string Filename;
+  std::string Message;
   int LineNo, ColumnNo;                               // -1 if not relevant
+  std::string LineContents;
 
-  ParseException &operator=(const ParseException &E); // objects by reference
+  void operator=(const ParseError &E); // DO NOT IMPLEMENT
 };
 
+} // End llvm namespace
+
 #endif