mirror of
https://github.com/justinethier/cyclone.git
synced 2025-05-31 07:55:06 +02:00
53 lines
1.4 KiB
Markdown
53 lines
1.4 KiB
Markdown
# Foreign Library
|
|
|
|
The `(cyclone foreign)` provides a convenient interface for integrating with C code. It is based in concept on the `(chicken foreign)` module from CHICKEN Scheme. Similarly to that module, this library manipulates the C code directly before it is compiled to a native binary. It is not possible to call these forms at runtime.
|
|
|
|
TODO: list of type specifiers
|
|
built-in types
|
|
Scheme | C
|
|
int | int
|
|
integer | int
|
|
bool | int
|
|
char | int
|
|
string | char *
|
|
symbol | const char *
|
|
bytevector | char *
|
|
float | double
|
|
double | double
|
|
bignum | mp_int
|
|
opaque | void *
|
|
|
|
- [`c-code`](#c-code)
|
|
- [`c-value`](#c-value)
|
|
- [`c-define`](#c-define)
|
|
|
|
# c-code
|
|
|
|
*Syntax*
|
|
|
|
(c-code CODE ...)
|
|
|
|
Insert C code directly into the compiled program. Each `CODE` parameter must be a string containing C code.
|
|
|
|
# c-value
|
|
|
|
*Syntax*
|
|
|
|
(c-value CODE TYPE)
|
|
|
|
Generate code that takes the C code specified by the string `CODE` and converts it to a Scheme object of type `TYPE`.
|
|
|
|
# c-define
|
|
|
|
*Syntax*
|
|
|
|
(c-define SCM-FUNC RETURN-TYPE C-FUNC TYPE ...)
|
|
|
|
Define a Scheme function `SCM-FUNC` returning an object of type `RETURN-TYPE`. The function will call C function specified by the string `C-FUNC` passed parameters of type specified by any `TYPE` arguments.
|
|
|
|
For example, to define a function that calls `strlen`:
|
|
|
|
(c-define scm-strlen int "strlen" string)
|
|
|
|
Note that these definitions are introduced at the top-level.
|
|
|