mirror of
https://github.com/justinethier/cyclone.git
synced 2025-07-11 23:07:36 +02:00
Add c-define-type and refine layout
This commit is contained in:
parent
d62166d5d7
commit
1d57b73861
1 changed files with 51 additions and 34 deletions
|
@ -2,6 +2,57 @@
|
|||
|
||||
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.
|
||||
|
||||
# Overview
|
||||
|
||||
- [`c-define-type`(#c-define-type)
|
||||
- [`c-code`](#c-code)
|
||||
- [`c-value`](#c-value)
|
||||
- [`c-define`](#c-define)
|
||||
|
||||
## c-define-type
|
||||
|
||||
*Syntax*
|
||||
|
||||
(c-define-type NAME TYPE (ARG-CONVERT (RET-CONVERT)))
|
||||
|
||||
Define a custom type with symbol `NAME` that is an alias of type `TYPE`. It is also possible to specify conversion functions `ARG-CONVERT` and `RET-CONVERT` to convert to/from this custom type.
|
||||
|
||||
EG, to define a type that consists of integers in Scheme and strings in C:
|
||||
|
||||
(c-define-type string-as-integer string number->string string->number)
|
||||
|
||||
## 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.
|
||||
|
||||
# Type Specifiers
|
||||
|
||||
TODO: list of type specifiers
|
||||
built-in types
|
||||
Scheme | C
|
||||
|
@ -17,37 +68,3 @@ 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.
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue