summaryrefslogtreecommitdiff
path: root/bindings/ocaml/bitwriter/llvm_bitwriter.mli
blob: 2f782a1d9f6c8fb5c0f9de114f128502b8557093 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
(*===-- llvm_bitwriter.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 writer.

    This interface provides an ocaml API for the LLVM bitcode writer, the
    classes in the Bitwriter library. *)

(** [write_bitcode_file m path] writes the bitcode for module [m] to the file at
    [path]. Returns [true] if successful, [false] otherwise. *)
external write_bitcode_file : Llvm.llmodule -> string -> bool
                            = "llvm_write_bitcode_file"