summaryrefslogtreecommitdiff
path: root/include/llvm/AsmParser/Parser.h
diff options
context:
space:
mode:
authorChandler Carruth <chandlerc@gmail.com>2014-01-07 12:34:26 +0000
committerChandler Carruth <chandlerc@gmail.com>2014-01-07 12:34:26 +0000
commitbc65a8d518ebe0408deb15d9314fd2ff5cbd0686 (patch)
tree82bd288d014ea25cb1c5ec67387c1d2eb438e517 /include/llvm/AsmParser/Parser.h
parent974a445bd90795248274493eda5cdbf6721910f7 (diff)
downloadllvm-bc65a8d518ebe0408deb15d9314fd2ff5cbd0686.tar.gz
llvm-bc65a8d518ebe0408deb15d9314fd2ff5cbd0686.tar.bz2
llvm-bc65a8d518ebe0408deb15d9314fd2ff5cbd0686.tar.xz
Move the LLVM IR asm writer header files into the IR directory, as they
are part of the core IR library in order to support dumping and other basic functionality. Rename the 'Assembly' include directory to 'AsmParser' to match the library name and the only functionality left their -- printing has been in the core IR library for quite some time. Update all of the #includes to match. All of this started because I wanted to have the layering in good shape before I started adding support for printing LLVM IR using the new pass infrastructure, and commandline support for the new pass infrastructure. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@198688 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include/llvm/AsmParser/Parser.h')
-rw-r--r--include/llvm/AsmParser/Parser.h64
1 files changed, 64 insertions, 0 deletions
diff --git a/include/llvm/AsmParser/Parser.h b/include/llvm/AsmParser/Parser.h
new file mode 100644
index 0000000000..165c46d6f2
--- /dev/null
+++ b/include/llvm/AsmParser/Parser.h
@@ -0,0 +1,64 @@
+//===-- Parser.h - Parser for LLVM IR text assembly files -------*- C++ -*-===//
+//
+// 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.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_ASMPARSER_PARSER_H
+#define LLVM_ASMPARSER_PARSER_H
+
+#include <string>
+
+namespace llvm {
+
+class Module;
+class MemoryBuffer;
+class SMDiagnostic;
+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
+
+#endif