summaryrefslogtreecommitdiffstats
path: root/contrib/llvm/bindings/ocaml/bitwriter/llvm_bitwriter.mli
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/llvm/bindings/ocaml/bitwriter/llvm_bitwriter.mli')
-rw-r--r--contrib/llvm/bindings/ocaml/bitwriter/llvm_bitwriter.mli30
1 files changed, 30 insertions, 0 deletions
diff --git a/contrib/llvm/bindings/ocaml/bitwriter/llvm_bitwriter.mli b/contrib/llvm/bindings/ocaml/bitwriter/llvm_bitwriter.mli
new file mode 100644
index 0000000..ea9a876
--- /dev/null
+++ b/contrib/llvm/bindings/ocaml/bitwriter/llvm_bitwriter.mli
@@ -0,0 +1,30 @@
+(*===-- 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"
+
+(** [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
OpenPOWER on IntegriCloud