-(*===-- llvm_bitreader.mli - LLVM Ocaml Interface ---------------*- C++ -*-===*
+(*===-- llvm_bitreader.mli - LLVM OCaml Interface ---------------*- C++ -*-===*
*
* The LLVM Compiler Infrastructure
*
- * This file was developed by Gordon Henriksen and is distributed under the
- * University of Illinois Open Source License. See LICENSE.TXT for details.
- *
- *===----------------------------------------------------------------------===
- *
- * This interface provides an ocaml API for the LLVM bitcode reader, the
- * classes in the Bitreader library.
+ * This file is distributed under the University of Illinois Open Source
+ * License. See LICENSE.TXT for details.
*
*===----------------------------------------------------------------------===*)
+(** Bitcode reader.
+
+ This interface provides an OCaml API for the LLVM bitcode reader, the
+ classes in the Bitreader library. *)
+
+exception Error of string
-type bitreader_result =
-| Bitreader_success of Llvm.llmodule
-| Bitreader_failure of string
+(** [get_module context mb] reads the bitcode 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::getBitcodeModule]. *)
+val get_module : Llvm.llcontext -> Llvm.llmemorybuffer -> Llvm.llmodule
-(** [read_bitcode_file path] reads the bitcode for module [m] from the file at
- [path]. Returns [Reader_success m] if successful, and [Reader_failure msg]
- otherwise, where [msg] is a description of the error encountered. **)
-external read_bitcode_file : string -> bitreader_result
- = "llvm_read_bitcode_file"
+(** [parse_bitcode context mb] parses the bitcode 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::ParseBitcodeFile]. *)
+val parse_bitcode : Llvm.llcontext -> Llvm.llmemorybuffer -> Llvm.llmodule