mirror of
https://github.com/c64scene-ar/llvm-6502.git
synced 2024-12-15 20:29:48 +00:00
dfc58e3bcf
This commit only changes comments and documentation in OCaml bindings. The official name of the language is OCaml, and the usage is now consistent. Patch by Peter Zotov git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@193836 91177308-0d34-0410-b5e6-96231b3b80d8
29 lines
1.2 KiB
OCaml
29 lines
1.2 KiB
OCaml
(*===-- 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
|
|
|
|
(** [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
|
|
|
|
|
|
(** [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
|