summaryrefslogtreecommitdiff
path: root/bindings/ocaml/bitreader/llvm_bitreader.mli
blob: 15b389bb83c753f6399238720d8a24dc55f3dc46 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
(*===-- llvm_bitreader.mli - LLVM Ocaml Interface ---------------*- C++ -*-===*
 *
 *                     The LLVM Compiler Infrastructure
 *
 * 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

(** [read_bitcode_file path] reads the bitcode for a new module [m] from the
    file at [path]. Returns [Success m] if successful, and [Failure msg]
    otherwise, where [msg] is a description of the error encountered.
    See the function [llvm::getBitcodeModuleProvider]. *)
external get_module_provider : Llvm.llmemorybuffer -> Llvm.llmoduleprovider
                             = "llvm_get_module_provider"

(** [parse_bitcode mb] parses the bitcode for a new module [m] from the memory
    buffer [mb]. Returns [Success m] if successful, and [Failure msg] otherwise,
    where [msg] is a description of the error encountered.
    See the function [llvm::ParseBitcodeFile]. *)
external parse_bitcode : Llvm.llmemorybuffer -> Llvm.llmodule
                       = "llvm_parse_bitcode"