llvm/bindings/ocaml/irreader/llvm_irreader.mli

(*===-- llvm_irreader.mli - LLVM OCaml Interface --------------*- OCaml -*-===*
 *
 * Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 * See https://llvm.org/LICENSE.txt for license information.
 * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 *
 *===----------------------------------------------------------------------===*)

(** IR reader.

    This interface provides an OCaml API for the LLVM assembly reader, the
    classes in the IRReader library. *)

exception Error of string

(** [parse_ir_bitcode_or_assembly context mb] parses the IR 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.

    This function does not take ownership of [mb]; the caller should dispose it
    (see {!Llvm.MemoryBuffer.dispose}) when it is no longer needed.

    See the function [llvm::ParseIR]. *)
val parse_ir_bitcode_or_assembly
  : Llvm.llcontext -> Llvm.llmemorybuffer -> Llvm.llmodule