idris-lang/Idris2
1
1
Fork 0
mirror of https://github.com/idris-lang/Idris2.git synced 2024-12-20 10:02:03 +03:00
Code Issues Projects Releases Wiki Activity

[doc] add note regarding C header inclusion to FFI documentation

Browse Source
This commit is contained in:
Adam Brouwers-Harries 2023-12-12 21:59:02 +00:00 committed by Mathew Polzin
parent eddcbcdc75
commit 4cb45daba4
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/source/ffi/ffi.rst
View File

@ -29,6 +29,14 @@ the library. In this document, we will assume the default Chez Scheme code
generator (the examples also work with the Racket or Gambit code generator) and generator (the examples also work with the Racket or Gambit code generator) and
that the foreign language is C. that the foreign language is C.
FFI declarations for C functions can also, optionally, take a C header file to
be ``#include``'d in the C code generated by the Idris2 compiler. For instance:
.. code-block:: idris
%foreign "C:idris2_resetRawMode, libidris2_support, idris_support.h"
idris2_resetRawMode : (1 x : %World) -> IORes ()
Scheme Details Scheme Details
--------------- ---------------