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 (91)

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

Conflicts

None