package ctypes-foreign

  1. Overview
  2. Docs
Dynamic access to foreign C libraries using Ctypes

Install

Dune Dependency

github.com Readme Changelog MIT License Edit opam file Versions (4)

Authors

  1. J
    Jeremy Yallop

Maintainers

  1. J
    Jeremy Yallop <yallop@gmail.com>

Sources

0.22.0.tar.gz
md5=8a301a3e3b79156448a6659859ad506c

Description

This installs the ctypes-foreign interface which uses libffi to provide dynamic access to foreign libraries.

Tags

org:mirage

Published: 19 Feb 2024

README

README.md

ctypes is a library for binding to C libraries using pure OCaml. The primary aim is to make writing C extensions as straightforward as possible.

The core of ctypes is a set of combinators for describing the structure of C types -- numeric types, arrays, pointers, structs, unions and functions. You can use these combinators to describe the types of the functions that you want to call, then bind directly to those functions -- all without writing or generating any C!

Usage

Suppose you want to bind to the following C functions:

   int sigemptyset(sigset_t *set);
   int sigfillset(sigset_t *set);
   int sigaddset(sigset_t *set, int signum);
   int sigdelset(sigset_t *set, int signum);
   int sigismember(const sigset_t *set, int signum);

Using ctypes you can describe the interfaces to these functions as follows:

   let sigemptyset = foreign "sigemptyset" (ptr sigset_t @-> returning int)
   let sigfillset = foreign "sigfillset" (ptr sigset_t @-> returning int)
   let sigaddset = foreign "sigaddset" (ptr sigset_t @-> int @-> returning int)
   let sigdelset = foreign "sigdelset" (ptr sigset_t @-> int @-> returning int)
   let sigismember = foreign "sigismember" (ptr sigset_t @-> int @-> returning int)

The names bound by this code have the types you might expect:

   val sigemptyset : sigset_t ptr -> int
   val sigfillset : sigset_t ptr -> int
   val sigaddset : sigset_t ptr -> int -> int
   val sigdelset : sigset_t ptr -> int -> int
   val sigismember : sigset_t ptr -> int -> int

That's all there is to it. Unlike the usual way of writing C extensions, there are no C "stub" functions to write, so there's much less opportunity for error.

The documentation and source distribution contain more complex examples, involving structs, unions, arrays, callback functions, and so on, and show how to create and use C values (like instances of sigset_t ptr) in OCaml.

Links

Dependencies (6)

  1. conf-libffi >= "2.0.0"
  2. conf-pkg-config
  3. dune-configurator
  4. ctypes = version
  5. ocaml >= "4.03.0"
  6. dune >= "2.9"

Dev Dependencies (7)

  1. odoc with-doc
  2. conf-fts with-test & os != "win32"
  3. stdlib-shims with-test
  4. conf-ncurses with-test
  5. ounit2 with-test
  6. lwt with-test & >= "2.4.7"
  7. integers with-test & >= "0.2.2"

Used by (92)

  1. arakoon >= "1.8.6" & < "1.8.12"
  2. argon2
  3. arrayjit
  4. async_ssl != "112.24.02" & < "113.33.05" | >= "v0.10.0"
  5. avroc
  6. bimage-unix
  7. bls12-381 = "0.3.15"
  8. bls12-381-legacy < "0.4.4"
  9. bls12-381-unix < "1.0.2"
  10. cf
  11. checked_oint
  12. cmark
  13. cmarker
  14. ctypes >= "0.7.0" & < "0.21.1"
  15. ctypes-zarith
  16. directories < "0.3"
  17. extism
  18. flock
  19. gccjit
  20. gdal >= "0.3.0"
  21. gobject-introspection
  22. gpiod
  23. gr
  24. gsasl
  25. guile
  26. hacl-star-raw < "0.4.4"
  27. hardcaml-llvmsim
  28. hardcaml-vpi
  29. hardcaml_c
  30. hardcaml_verilator
  31. hdr_histogram
  32. iocaml >= "0.4.3"
  33. iocaml-kernel >= "0.4.4"
  34. libdash
  35. libirmin
  36. libudev
  37. lilv
  38. llama-cpp-ocaml
  39. lmdb < "1.0"
  40. lp-glpk < "0.4.0"
  41. lp-gurobi
  42. mariadb < "1.1.4"
  43. memtrace_viewer < "v0.15.0"
  44. mmdb
  45. mpg123
  46. nanomsg
  47. nebula
  48. netlink >= "0.2.1"
  49. ocephes >= "0.8.1"
  50. octez-l2-libs
  51. opasswd >= "0.9.3"
  52. opencc < "transition"
  53. opencc0
  54. opencc1
  55. opencc1_1
  56. orocksdb
  57. osbx < "1.1.1"
  58. osx-cf
  59. osx-secure-transport
  60. pari
  61. pari-bindings
  62. pg_query
  63. pkcs11 < "0.9.0"
  64. pkcs11-driver
  65. pkcs11-rev
  66. portaudio_c_bindings
  67. portmidi
  68. posix-getopt < "2.0.0"
  69. py
  70. qcstm >= "0.1.1"
  71. reed-solomon-erasure
  72. sarek >= "20210823"
  73. sattools
  74. sodium >= "0.2.0" & < "0.3.0"
  75. spoc >= "20170724"
  76. srt >= "0.2.2"
  77. stk_iconv
  78. swipl
  79. tensorflow
  80. tezos-sapling >= "10.2" & < "13.0"
  81. tezos-wasmer
  82. tgls >= "0.8.3"
  83. torch
  84. tsdl >= "0.8.1"
  85. tsdl-image
  86. tsdl-mixer
  87. tsdl-ttf
  88. unix-type-representations < "0.1.1"
  89. wasmer
  90. wasmtime
  91. yara
  92. yices2_bindings

Conflicts

None