[hcoop/debian/mlton.git] / lib / mlnlffi-lib / README

This is the ML-NLFFI Library, the core of a new foreign-function
interface for SML/NJ.

Library $c/c.cm provides:

  - an encoding of the C type system in ML
  - dynamic linking (an interface to dlopen/dlsym)
  - ML/C string conversion routines

  This is the (only) library to be used by user code.

Library $c/c-int.cm (subdirectory "internals"):

  - implements all of $c/c.cm
  - implements low-level hooks to be used by ml-nlffigen-generated code

Library $c/memory.cm (subdirectory "memory"):

  - encapsulates low-level details related to raw memory access

  User code should NOT directly refer to this library.
Commit	Line	Data
7f918cf1 CE	1	This is the ML-NLFFI Library, the core of a new foreign-function
	2	interface for SML/NJ.
	3
	4	Library $c/c.cm provides:
	5
	6	- an encoding of the C type system in ML
	7	- dynamic linking (an interface to dlopen/dlsym)
	8	- ML/C string conversion routines
	9
	10	This is the (only) library to be used by user code.
	11
	12	Library $c/c-int.cm (subdirectory "internals"):
	13
	14	- implements all of $c/c.cm
	15	- implements low-level hooks to be used by ml-nlffigen-generated code
	16
	17	Library $c/memory.cm (subdirectory "memory"):
	18
	19	- encapsulates low-level details related to raw memory access
	20
	21	User code should NOT directly refer to this library.