llvm_bitreader.mli revision 234d529e582963ad4b5d83b911cd057fe99d1435 
1(*===-- llvm_bitreader.mli - LLVM Ocaml Interface ---------------*- C++ -*-===*
2 *
3 *                     The LLVM Compiler Infrastructure
4 *
5 * This file is distributed under the University of Illinois Open Source
6 * License. See LICENSE.TXT for details.
7 *
8 *===----------------------------------------------------------------------===
9 *
10 * This interface provides an ocaml API for the LLVM bitcode reader, the
11 * classes in the Bitreader library.
12 *
13 *===----------------------------------------------------------------------===*)
14
15
16exception Error of string
17
18(** [read_bitcode_file path] reads the bitcode for a new module [m] from the
19    file at [path]. Returns [Success m] if successful, and [Failure msg]
20    otherwise, where [msg] is a description of the error encountered.
21    See the function [llvm::getBitcodeModuleProvider]. **)
22external get_module_provider : Llvm.llmemorybuffer -> Llvm.llmoduleprovider
23                             = "llvm_get_module_provider"
24
25(** [parse_bitcode mb] parses the bitcode for a new module [m] from the memory
26    buffer [mb]. Returns [Success m] if successful, and [Failure msg] otherwise,
27    where [msg] is a description of the error encountered.
28    See the function [llvm::ParseBitcodeFile]. **)
29external parse_bitcode : Llvm.llmemorybuffer -> Llvm.llmodule
30                       = "llvm_parse_bitcode"
31