llvm-mirror/bindings/ocaml/bitwriter/llvm_bitwriter.mli

(*===-- 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
Adding ocaml language bindings for the vmcore and bitwriter libraries. These are built atop the C language bindings, and user programs can link with them as such: # Bytecode ocamlc -cc g++ llvm.cma llvmbitwriter.cma -o example example.ml # Native ocamlopt -cc g++ llvm.cmxa llvmbitwriter.cmxa -o example.opt example.ml The vmcore.ml test exercises most/all of the APIs thus far bound. Unfortunately, they're not yet numerous enough to write hello world. But: $ cat example.ml (* example.ml ) open Llvm open Llvm_bitwriter let _ = let filename = Sys.argv.(1) in let m = create_module filename in let v = make_int_constant i32_type 42 false in let g = define_global "hello_world" v m in if not (write_bitcode_file m filename) then exit 1; dispose_module m; $ ocamlc -cc g++ llvm.cma llvm_bitwriter.cma -o example example.ml File "example.ml", line 11, characters 6-7: Warning Y: unused variable g. $ ./example example.bc $ llvm-dis < example.bc ; ModuleID = '<stdin>' @hello_world = global i32 42 ; <i32> [#uses=0] The ocaml test cases provide effective tests for the C interfaces. llvm-svn: 42093 2007-09-18 14:49:39 +02:00			`(===-- llvm_bitwriter.mli - LLVM Ocaml Interface ---------------- C++ --===`
			`*`
			`* The LLVM Compiler Infrastructure`
			`*`
remove attribution from a variety of miscellaneous files. llvm-svn: 45425 2007-12-29 23:59:10 +01:00			`* This file is distributed under the University of Illinois Open Source`
			`* License. See LICENSE.TXT for details.`
Adding ocaml language bindings for the vmcore and bitwriter libraries. These are built atop the C language bindings, and user programs can link with them as such: # Bytecode ocamlc -cc g++ llvm.cma llvmbitwriter.cma -o example example.ml # Native ocamlopt -cc g++ llvm.cmxa llvmbitwriter.cmxa -o example.opt example.ml The vmcore.ml test exercises most/all of the APIs thus far bound. Unfortunately, they're not yet numerous enough to write hello world. But: $ cat example.ml (* example.ml ) open Llvm open Llvm_bitwriter let _ = let filename = Sys.argv.(1) in let m = create_module filename in let v = make_int_constant i32_type 42 false in let g = define_global "hello_world" v m in if not (write_bitcode_file m filename) then exit 1; dispose_module m; $ ocamlc -cc g++ llvm.cma llvm_bitwriter.cma -o example example.ml File "example.ml", line 11, characters 6-7: Warning Y: unused variable g. $ ./example example.bc $ llvm-dis < example.bc ; ModuleID = '<stdin>' @hello_world = global i32 42 ; <i32> [#uses=0] The ocaml test cases provide effective tests for the C interfaces. llvm-svn: 42093 2007-09-18 14:49:39 +02:00			`*`
			`===----------------------------------------------------------------------===)`

This patch cleans up the OCaml bindings so that they format nicely with ocamldoc. It does not yet hook into the build system, though. Patch by Erick Tryzelaar! llvm-svn: 48095 2008-03-09 08:17:38 +01:00			`(** Bitcode writer.`

			`This interface provides an ocaml API for the LLVM bitcode writer, the`
			`classes in the Bitwriter library. *)`
Adding ocaml language bindings for the vmcore and bitwriter libraries. These are built atop the C language bindings, and user programs can link with them as such: # Bytecode ocamlc -cc g++ llvm.cma llvmbitwriter.cma -o example example.ml # Native ocamlopt -cc g++ llvm.cmxa llvmbitwriter.cmxa -o example.opt example.ml The vmcore.ml test exercises most/all of the APIs thus far bound. Unfortunately, they're not yet numerous enough to write hello world. But: $ cat example.ml (* example.ml ) open Llvm open Llvm_bitwriter let _ = let filename = Sys.argv.(1) in let m = create_module filename in let v = make_int_constant i32_type 42 false in let g = define_global "hello_world" v m in if not (write_bitcode_file m filename) then exit 1; dispose_module m; $ ocamlc -cc g++ llvm.cma llvm_bitwriter.cma -o example example.ml File "example.ml", line 11, characters 6-7: Warning Y: unused variable g. $ ./example example.bc $ llvm-dis < example.bc ; ModuleID = '<stdin>' @hello_world = global i32 42 ; <i32> [#uses=0] The ocaml test cases provide effective tests for the C interfaces. llvm-svn: 42093 2007-09-18 14:49:39 +02:00
Adding ocamldoc-style comments for the Ocaml bindings. llvm-svn: 44494 2007-12-01 22:01:15 +01:00			`(** [write_bitcode_file m path] writes the bitcode for module [m] to the file at`
This patch cleans up the OCaml bindings so that they format nicely with ocamldoc. It does not yet hook into the build system, though. Patch by Erick Tryzelaar! llvm-svn: 48095 2008-03-09 08:17:38 +01:00			`[path]. Returns [true] if successful, [false] otherwise. *)`
Adding ocaml language bindings for the vmcore and bitwriter libraries. These are built atop the C language bindings, and user programs can link with them as such: # Bytecode ocamlc -cc g++ llvm.cma llvmbitwriter.cma -o example example.ml # Native ocamlopt -cc g++ llvm.cmxa llvmbitwriter.cmxa -o example.opt example.ml The vmcore.ml test exercises most/all of the APIs thus far bound. Unfortunately, they're not yet numerous enough to write hello world. But: $ cat example.ml (* example.ml ) open Llvm open Llvm_bitwriter let _ = let filename = Sys.argv.(1) in let m = create_module filename in let v = make_int_constant i32_type 42 false in let g = define_global "hello_world" v m in if not (write_bitcode_file m filename) then exit 1; dispose_module m; $ ocamlc -cc g++ llvm.cma llvm_bitwriter.cma -o example example.ml File "example.ml", line 11, characters 6-7: Warning Y: unused variable g. $ ./example example.bc $ llvm-dis < example.bc ; ModuleID = '<stdin>' @hello_world = global i32 42 ; <i32> [#uses=0] The ocaml test cases provide effective tests for the C interfaces. llvm-svn: 42093 2007-09-18 14:49:39 +02:00			`external write_bitcode_file : Llvm.llmodule -> string -> bool`
			`= "llvm_write_bitcode_file"`
Add a LLVMWriteBitcodeToFD that exposes the raw_fd_ostream options. llvm-svn: 97858 2010-03-06 01:30:06 +01:00
			`(** [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`