summaryrefslogtreecommitdiff
path: root/bindings/ocaml/irreader/llvm_irreader.mli
diff options
context:
space:
mode:
authorPeter Zotov <whitequark@whitequark.org>2013-11-06 09:21:25 +0000
committerPeter Zotov <whitequark@whitequark.org>2013-11-06 09:21:25 +0000
commitec7270c966b4a49840b1801bfbb11977d76cb333 (patch)
tree9cd0ec95ef489055aab4d3f8b3f8da56b6b690d7 /bindings/ocaml/irreader/llvm_irreader.mli
parentc6099db476ea863d0e897e3c311bfe490293e04f (diff)
downloadllvm-ec7270c966b4a49840b1801bfbb11977d76cb333.tar.gz
llvm-ec7270c966b4a49840b1801bfbb11977d76cb333.tar.bz2
llvm-ec7270c966b4a49840b1801bfbb11977d76cb333.tar.xz
[OCaml] Impement Llvm_irreader, bindings to LLVM assembly parser
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@194138 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'bindings/ocaml/irreader/llvm_irreader.mli')
-rw-r--r--bindings/ocaml/irreader/llvm_irreader.mli21
1 files changed, 21 insertions, 0 deletions
diff --git a/bindings/ocaml/irreader/llvm_irreader.mli b/bindings/ocaml/irreader/llvm_irreader.mli
new file mode 100644
index 0000000000..2b1147373b
--- /dev/null
+++ b/bindings/ocaml/irreader/llvm_irreader.mli
@@ -0,0 +1,21 @@
+(*===-- llvm_irreader.mli - LLVM OCaml Interface --------------*- OCaml -*-===*
+ *
+ * The LLVM Compiler Infrastructure
+ *
+ * This file is distributed under the University of Illinois Open Source
+ * License. See LICENSE.TXT for details.
+ *
+ *===----------------------------------------------------------------------===*)
+
+(** IR reader.
+
+ This interface provides an OCaml API for the LLVM assembly reader, the
+ classes in the IRReader library. *)
+
+exception Error of string
+
+(** [parse_ir context mb] parses the IR for a new module [m] from the
+ memory buffer [mb] in the context [context]. Returns [m] if successful, or
+ raises [Error msg] otherwise, where [msg] is a description of the error
+ encountered. See the function [llvm::ParseIR]. *)
+val parse_ir : Llvm.llcontext -> Llvm.llmemorybuffer -> Llvm.llmodule