-//===-- 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.
//
//===----------------------------------------------------------------------===//
#include <string>
-class Module;
-class ToolCommandLine;
-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.
-//
-Module *ParseAssemblyFile(const ToolCommandLine &Opts) 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 ToolCommandLine &Opts, const string &message,
- int LineNo = -1, int ColNo = -1);
+namespace llvm {
- 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...
- return Message;
- }
+class Module;
+class MemoryBuffer;
+class SMDiagnostic;
+class LLVMContext;
- inline const ToolCommandLine &getOptions() const {
- return Opts; // Get the options obj used to parse.
- }
+/// 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.
+);
- // 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;
- }
+/// 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
+);
-private :
- const ToolCommandLine &Opts;
- string Message;
- int LineNo, ColumnNo; // -1 if not relevant
+/// 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
+);
- ParseException &operator=(const ParseException &E); // objects by reference
-};
+} // End llvm namespace
#endif