bindings/ocaml/bitreader/llvm_bitreader.mli

   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 (** Bitcode reader.
  11
  12     This interface provides an ocaml API for the LLVM bitcode reader, the
  13     classes in the Bitreader library. *)
  14
  15 exception Error of string
  16
  17 (** [get_module_provider context mb] reads the bitcode for a new
  18     module provider [m] from the memory buffer [mb] in the context [context].
  19     Returns [m] if successful, or raises [Error msg] otherwise, where [msg] is a
  20     description of the error encountered. See the function
  21     [llvm::getBitcodeModuleProvider]. *)
  22 external get_module_provider : Llvm.llcontext -> Llvm.llmemorybuffer ->
  23                                Llvm.llmoduleprovider
  24                              = "llvm_get_module_provider"
  25
  26 (** [parse_bitcode context mb] parses the bitcode for a new module [m] from the
  27     memory buffer [mb] in the context [context]. Returns [m] if successful, or
  28                 raises [Error msg] otherwise, where [msg] is a description of the error
  29                 encountered. See the function [llvm::ParseBitcodeFile]. *)
  30 external parse_bitcode : Llvm.llcontext -> Llvm.llmemorybuffer -> Llvm.llmodule
  31                        = "llvm_parse_bitcode"