metame / libc.ml

Raw bindings to platform APIs for OCaml

libc - raw definitions and bindings to platforms' system libraries

libc provides definitions (and in the future bindings) to easily interoperate with C code (or "C-like" code) on several platforms, and it does this with a target and architecture aware API.

Preliminary platform support includes:

• aarch64-macos-darwin
• aarch64-unknown-linux-gnu
• aarch64-unknown-linux-musl
• x86_64-unknown-linux-gnu
• x86_64-unknown-linux-musl
• PRs welcome -- see Contributing

None of these are complete, but they are being extended on a need basis.

Usage

Pin it in your OPAM:

opam pin add libc.0.0.1 git+https://github.com/leostera/libc.ml

Add it to your dune project:

(depends 
   (libc (>= "0.0.1"))
   ...)

Add it to your dune libraries:

(library
  (name my_lib)
  (libraries libc))

Use it in your code:

let flags = Libc.(ev_clear lor ev_receipt lor ev_add) in
(* ... *)

Contributing

Including new platforms, while tedious, is pretty straightforward. We are using Rust's libc as a template for what are interesting/useful definitions on each platform.

That way, the easiest way to get started is to find the right platform version of libc for Rust, and translate the definitions.

For example, for aarch64-apple-darwin the definitions are found here. If you use the 'platforms' drop-down you can find your platform, and we can start porting from there.

Common types are currently included in the types.ml module, so you can open Types at the top of your new module.

If you follow this path, here's some useful transformations you can apply with sed:

sed 's/<</lsl/g'
sed 's/|/lor/g'
sed 's/const /let /g'
sed 's/:://g'
sed 's/;;//g'