Home | History | Annotate | Download | only in bitwriter
      1 (*===-- llvm_bitwriter.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 writer.
     11 
     12     This interface provides an ocaml API for the LLVM bitcode writer, the
     13     classes in the Bitwriter library. *)
     14 
     15 (** [write_bitcode_file m path] writes the bitcode for module [m] to the file at
     16     [path]. Returns [true] if successful, [false] otherwise. *)
     17 external write_bitcode_file : Llvm.llmodule -> string -> bool
     18                             = "llvm_write_bitcode_file"
     19 
     20 (** [write_bitcode_to_fd ~unbuffered fd m] writes the bitcode for module
     21     [m] to the channel [c]. If [unbuffered] is [true], after every write the fd
     22     will be flushed. Returns [true] if successful, [false] otherwise. *)
     23 external write_bitcode_to_fd : ?unbuffered:bool -> Llvm.llmodule
     24                                -> Unix.file_descr -> bool
     25                              = "llvm_write_bitcode_to_fd"
     26 
     27 (** [output_bitcode ~unbuffered c m] writes the bitcode for module [m]
     28     to the channel [c]. If [unbuffered] is [true], after every write the fd
     29     will be flushed. Returns [true] if successful, [false] otherwise. *)
     30 val output_bitcode : ?unbuffered:bool -> out_channel -> Llvm.llmodule -> bool
     31