Fix a FIXME about the format and add a test.

[oota-llvm.git] / bindings / ocaml / bitwriter / llvm_bitwriter.mli

diff --git a/bindings/ocaml/bitwriter/llvm_bitwriter.mli b/bindings/ocaml/bitwriter/llvm_bitwriter.mli
index 847eefc247e9a11451d637266b673434ad3dd06d..ea9a87600a7581d52fa484bfff4f56d599014b0e 100644 (file)
--- a/bindings/ocaml/bitwriter/llvm_bitwriter.mli
+++ b/bindings/ocaml/bitwriter/llvm_bitwriter.mli
@@ -5,15 +5,26 @@
  * This file is distributed under the University of Illinois Open Source
  * License. See LICENSE.TXT for details.
  *
- *===----------------------------------------------------------------------===
- *
- * This interface provides an ocaml API for the LLVM bitcode writer, the
- * classes in the Bitwriter library.
- *
  *===----------------------------------------------------------------------===*)
 
+(** 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. **)
+    [path]. Returns [true] if successful, [false] otherwise. *)
 external write_bitcode_file : Llvm.llmodule -> string -> bool
                             = "llvm_write_bitcode_file"
+
+(** [write_bitcode_to_fd ~unbuffered fd m] writes the bitcode for module
+    [m] to the channel [c]. If [unbuffered] is [true], after every write the fd
+    will be flushed. Returns [true] if successful, [false] otherwise. *)
+external write_bitcode_to_fd : ?unbuffered:bool -> Llvm.llmodule
+                               -> Unix.file_descr -> bool
+                             = "llvm_write_bitcode_to_fd"
+
+(** [output_bitcode ~unbuffered c m] writes the bitcode for module [m]
+    to the channel [c]. If [unbuffered] is [true], after every write the fd
+    will be flushed. Returns [true] if successful, [false] otherwise. *)
+val output_bitcode : ?unbuffered:bool -> out_channel -> Llvm.llmodule -> bool