975 lines
41 KiB
HTML
975 lines
41 KiB
HTML
<!doctype html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<title>Portable Foreign Function Interface for R7RS
|
||
Documentation - 0.6.0</title>
|
||
<style>
|
||
table { width: 250%; }
|
||
nav { float: left; width: 20%;}
|
||
main { float: right; width: 80%; }
|
||
pre { background-color: lightgrey; }
|
||
</style>
|
||
</head>
|
||
<body>
|
||
<h1
|
||
id="portable-foreign-function-interface-for-r7rs---version">Portable
|
||
Foreign Function Interface for R7RS - ${version}</h1>
|
||
<p>Portable foreign function interface for R7RS. It is portable
|
||
in the sense that it supports multiple implementations, as
|
||
opposed to being portable by conforming to some
|
||
specification.</p>
|
||
<p><a
|
||
href="https://todo.sr.ht/~retropikzel/r7rs-pffi">Project</a></p>
|
||
<p><a href="https://sr.ht/~retropikzel/r7rs-pffi/trackers">Issue
|
||
trackers</a></p>
|
||
<p><a href="https://sr.ht/~retropikzel/r7rs-pffi/lists">Maling
|
||
lists</a></p>
|
||
<p><a
|
||
href="https://jenkins.scheme.org/job/r7rs_pffi/job/r7rs-pffi/">Jenkins</a></p>
|
||
<h2 id="table-of-contents">Table of contents</h2>
|
||
<nav>
|
||
<ul>
|
||
<li><a href="#goals">Goals</a></li>
|
||
<li><a href="#non-goals">Non Goals</a></li>
|
||
<li><a href="#status">Status</a>
|
||
<ul>
|
||
<li><a href="#current-caveats">Current caveats</a></li>
|
||
</ul></li>
|
||
<li><a href="#implementation-table">Implementation table</a>
|
||
<ul>
|
||
<li><a href="#beta">Beta</a></li>
|
||
<li><a href="#alpha">Alpha</a></li>
|
||
<li><a href="#not-started">Not started</a></li>
|
||
<li><a href="#other">Other</a></li>
|
||
</ul></li>
|
||
<li><a href="#documentation">Documentation</a>
|
||
<ul>
|
||
<li><a href="#usage">Usage</a>
|
||
<ul>
|
||
<li><a href="#usage-chibi">Chibi</a></li>
|
||
<li><a href="#usage-chicken">Chicken</a></li>
|
||
<li><a href="#usage-racket">Racket</a></li>
|
||
<li><a href="#usage-kawa">Kawa</a></li>
|
||
</ul></li>
|
||
</ul></li>
|
||
<li><a href="#reference">Reference</a>
|
||
<ul>
|
||
<li><a href="#types">Types</a></li>
|
||
<li><a href="#procedures-and-macros">Procedures and macros</a>
|
||
<ul>
|
||
<li><a href="#pffi-init">pffi-init</a></li>
|
||
<li><a href="#pffi-size-of">pffi-size-of</a></li>
|
||
<li><a href="#pffi-align-of">pffi-align-of</a></li>
|
||
<li><a
|
||
href="#pffi-shared-object-auto-load">pffi-shared-object-auto-load</a></li>
|
||
<li><a
|
||
href="#pffi-shared-object-load">pffi-shared-object-load</a></li>
|
||
<li><a href="#pffi-pointer-null">pffi-pointer-null</a></li>
|
||
<li><a href="#pffi-pointer-null?">pffi-pointer-null?</a></li>
|
||
<li><a
|
||
href="#pffi-pointer-allocate">pffi-pointer-allocate</a></li>
|
||
<li><a
|
||
href="#pffi-pointer-address">pffi-pointer-address</a></li>
|
||
<li><a href="#pffi-pointer?">pffi-pointer?</a></li>
|
||
<li><a href="#pffi-pointer-free">pffi-pointer-free</a></li>
|
||
<li><a href="#pffi-pointer-set!">pffi-pointer-set!</a></li>
|
||
<li><a href="#pffi-pointer-get">pffi-pointer-get</a></li>
|
||
<li><a
|
||
href="#pffi-string-to-pointer">pffi-string->pointer</a></li>
|
||
<li><a
|
||
href="#pffi-pointer-to-string">pffi-pointer->string</a></li>
|
||
<li><a href="#pffi-struct-make">pffi-struct-make</a></li>
|
||
<li><a href="#pffi-struct-pointer">pffi-struct-pointer</a></li>
|
||
<li><a
|
||
href="#pffi-struct-offset-get">pffi-struct-offset-get</a></li>
|
||
<li><a href="#pffi-struct-get">pffi-struct-get</a></li>
|
||
<li><a href="#pffi-struct-set!">pffi-struct-set!</a></li>
|
||
<li><a href="#pffi-define">pffi-define</a></li>
|
||
<li><a
|
||
href="#pffi-define-callback">pffi-define-callback</a></li>
|
||
</ul></li>
|
||
</ul></li>
|
||
</ul>
|
||
</nav>
|
||
<main>
|
||
<h2 id="goals">Goals</h2>
|
||
<p><a name="goals"></a></p>
|
||
<ul>
|
||
<li>Support only R7RS implementations</li>
|
||
<li>Same interface on all implementations
|
||
<ul>
|
||
<li>Some things that are procedures on one implementation are
|
||
macros on other, but they must behave the same</li>
|
||
</ul></li>
|
||
<li>Stability and being boring after 1.0.0 is reached</li>
|
||
</ul>
|
||
<h2 id="non-goals">Non goals</h2>
|
||
<p><a name="non-goals"></a></p>
|
||
<ul>
|
||
<li>To have every possible FFI feature</li>
|
||
<li>Compiling of used library C code at any point
|
||
<ul>
|
||
<li>That is no stubs, no C code generated by the library and so
|
||
on</li>
|
||
<li>The pffi library itself may require compilation on
|
||
installation</li>
|
||
</ul></li>
|
||
</ul>
|
||
<h2 id="status">Status</h2>
|
||
<p><a name="status"></a></p>
|
||
<p>Currently the interface of the library is in okay shape. It
|
||
propably will not change much but no guarantees are being made
|
||
just yet.</p>
|
||
<p>Due to supporting many different Scheme implementations,
|
||
different parts of this software are in different stage. As a
|
||
whole it is still in <strong>alpha</strong> stage. That said the
|
||
interface should not be changing anymore and some
|
||
implementations are in <strong>beta</strong>.</p>
|
||
<h3 id="current-caveats">Current caveats</h3>
|
||
<p><a name="current-caveats"></a></p>
|
||
<ul>
|
||
<li>No way to pass structs by value</li>
|
||
<li>Most implementations are missing callback support</li>
|
||
</ul>
|
||
<h2 id="implementation-table">Implementation table</h2>
|
||
<p><a name="implementation-table"></a></p>
|
||
<h3 id="beta">Beta</h3>
|
||
<p><a name="beta"></a></p>
|
||
<table>
|
||
<colgroup>
|
||
<col style="width: 3%" />
|
||
<col style="width: 2%" />
|
||
<col style="width: 3%" />
|
||
<col style="width: 7%" />
|
||
<col style="width: 5%" />
|
||
<col style="width: 4%" />
|
||
<col style="width: 4%" />
|
||
<col style="width: 5%" />
|
||
<col style="width: 5%" />
|
||
<col style="width: 3%" />
|
||
<col style="width: 4%" />
|
||
<col style="width: 4%" />
|
||
<col style="width: 4%" />
|
||
<col style="width: 5%" />
|
||
<col style="width: 5%" />
|
||
<col style="width: 4%" />
|
||
<col style="width: 4%" />
|
||
<col style="width: 5%" />
|
||
<col style="width: 3%" />
|
||
<col style="width: 4%" />
|
||
<col style="width: 3%" />
|
||
<col style="width: 5%" />
|
||
</colgroup>
|
||
<thead>
|
||
<tr class="header">
|
||
<th></th>
|
||
<th style="text-align: center;">pffi-init</th>
|
||
<th style="text-align: center;">pffi-size-of</th>
|
||
<th
|
||
style="text-align: center;">pffi-shared-object-auto-load</th>
|
||
<th style="text-align: center;">pffi-shared-object-load</th>
|
||
<th style="text-align: center;">pffi-pointer-null</th>
|
||
<th style="text-align: center;">pffi-pointer-null?</th>
|
||
<th style="text-align: center;">pffi-pointer-allocate</th>
|
||
<th style="text-align: center;">pffi-pointer-address</th>
|
||
<th style="text-align: center;">pffi-pointer?</th>
|
||
<th style="text-align: center;">pffi-pointer-free</th>
|
||
<th style="text-align: center;">pffi-pointer-set!</th>
|
||
<th style="text-align: center;">pffi-pointer-get</th>
|
||
<th style="text-align: center;">pffi-string->pointer</th>
|
||
<th style="text-align: center;">pffi-pointer->string</th>
|
||
<th style="text-align: center;">pffi-struct-make</th>
|
||
<th style="text-align: center;">pffi-struct-pointer</th>
|
||
<th style="text-align: center;">pffi-struct-offset-get</th>
|
||
<th style="text-align: center;">pffi-struct-get</th>
|
||
<th style="text-align: center;">pffi-struct-set!</th>
|
||
<th style="text-align: center;">pffi-define</th>
|
||
<th style="text-align: center;">pffi-define-callback</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="odd">
|
||
<td>Chibi</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
</tr>
|
||
<tr class="even">
|
||
<td>Gauche</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
</tr>
|
||
<tr class="odd">
|
||
<td>Guile</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
</tr>
|
||
<tr class="even">
|
||
<td>Kawa</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
</tr>
|
||
<tr class="odd">
|
||
<td>Racket</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
</tr>
|
||
<tr class="even">
|
||
<td>Saggittarius</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="alpha">Alpha</h3>
|
||
<p><a name="alpha"></a></p>
|
||
<table>
|
||
<colgroup>
|
||
<col style="width: 3%" />
|
||
<col style="width: 2%" />
|
||
<col style="width: 3%" />
|
||
<col style="width: 7%" />
|
||
<col style="width: 5%" />
|
||
<col style="width: 4%" />
|
||
<col style="width: 4%" />
|
||
<col style="width: 5%" />
|
||
<col style="width: 5%" />
|
||
<col style="width: 3%" />
|
||
<col style="width: 4%" />
|
||
<col style="width: 4%" />
|
||
<col style="width: 4%" />
|
||
<col style="width: 5%" />
|
||
<col style="width: 5%" />
|
||
<col style="width: 4%" />
|
||
<col style="width: 4%" />
|
||
<col style="width: 5%" />
|
||
<col style="width: 3%" />
|
||
<col style="width: 4%" />
|
||
<col style="width: 3%" />
|
||
<col style="width: 5%" />
|
||
</colgroup>
|
||
<thead>
|
||
<tr class="header">
|
||
<th></th>
|
||
<th style="text-align: center;">pffi-init</th>
|
||
<th style="text-align: center;">pffi-size-of</th>
|
||
<th
|
||
style="text-align: center;">pffi-shared-object-auto-load</th>
|
||
<th style="text-align: center;">pffi-shared-object-load</th>
|
||
<th style="text-align: center;">pffi-pointer-null</th>
|
||
<th style="text-align: center;">pffi-pointer-null?</th>
|
||
<th style="text-align: center;">pffi-pointer-allocate</th>
|
||
<th style="text-align: center;">pffi-pointer-address</th>
|
||
<th style="text-align: center;">pffi-pointer?</th>
|
||
<th style="text-align: center;">pffi-pointer-free</th>
|
||
<th style="text-align: center;">pffi-pointer-set!</th>
|
||
<th style="text-align: center;">pffi-pointer-get</th>
|
||
<th style="text-align: center;">pffi-string->pointer</th>
|
||
<th style="text-align: center;">pffi-pointer->string</th>
|
||
<th style="text-align: center;">pffi-struct-make</th>
|
||
<th style="text-align: center;">pffi-struct-pointer</th>
|
||
<th style="text-align: center;">pffi-struct-offset-get</th>
|
||
<th style="text-align: center;">pffi-struct-get</th>
|
||
<th style="text-align: center;">pffi-struct-set!</th>
|
||
<th style="text-align: center;">pffi-define</th>
|
||
<th style="text-align: center;">pffi-define-callback</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="odd">
|
||
<td>Chicken-5</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
</tr>
|
||
<tr class="even">
|
||
<td>Cyclone</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
</tr>
|
||
<tr class="odd">
|
||
<td>Gambit</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
</tr>
|
||
<tr class="even">
|
||
<td>Gerbil</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
</tr>
|
||
<tr class="odd">
|
||
<td>Larceny</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
</tr>
|
||
<tr class="even">
|
||
<td>Mosh</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
</tr>
|
||
<tr class="odd">
|
||
<td>Skint</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
</tr>
|
||
<tr class="even">
|
||
<td>Stklos</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
</tr>
|
||
<tr class="odd">
|
||
<td>tr7</td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
</tr>
|
||
<tr class="even">
|
||
<td>Ypsilon</td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;">X</td>
|
||
<td style="text-align: center;"></td>
|
||
<td style="text-align: center;"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="not-started">Not started</h3>
|
||
<p><a name="not-started"></a></p>
|
||
<ul>
|
||
<li><a href="https://lips.js.org/">LIPS</a>
|
||
<ul>
|
||
<li>Will work on nodejs by using some C FFI library from
|
||
npm</li>
|
||
<li>Javascript side needs design</li>
|
||
</ul></li>
|
||
<li><a href="https://www.biwascheme.org/">Biwascheme</a>
|
||
<ul>
|
||
<li>Will work on nodejs by using some C FFI library from
|
||
npm</li>
|
||
<li>Javascript side needs design</li>
|
||
</ul></li>
|
||
<li><a
|
||
href="https://www.gnu.org/software/mit-scheme/">MIT-Scheme</a>
|
||
<ul>
|
||
<li>Need to study the implementation more</li>
|
||
</ul></li>
|
||
<li><a
|
||
href="https://gitlab.com/mbabich/airship-scheme">Airship</a>
|
||
<ul>
|
||
<li>Need to study the implementation more</li>
|
||
</ul></li>
|
||
<li><a href="https://gambitscheme.org/">Other gambit targets</a>
|
||
<ul>
|
||
<li>Gambit compiles to different targets other than C too, for
|
||
example Javascript. It would be cool and interesting to see if
|
||
this FFI could also support some of those</li>
|
||
<li>When LIPS and Biwascheme Javascript side is done then Gambit
|
||
should be done too</li>
|
||
</ul></li>
|
||
<li><a
|
||
href="https://codeberg.org/prescheme/s48-r7rs">s48-r7rs</a>
|
||
<ul>
|
||
<li>Need to study the implementation more</li>
|
||
</ul></li>
|
||
<li><a
|
||
href="https://codeberg.org/prescheme/prescheme">prescheme</a>
|
||
<ul>
|
||
<li>Need to study the implementation more</li>
|
||
</ul></li>
|
||
</ul>
|
||
<h3 id="other">Other</h3>
|
||
<p><a name="other"></a></p>
|
||
<ul>
|
||
<li><a
|
||
href="https://scheme.fail://ccrma.stanford.edu/software/snd/snd/s7.html">s7</a>
|
||
<ul>
|
||
<li>Propably does not need FFI as it is embeddable only</li>
|
||
</ul></li>
|
||
<li><a href="https://scheme.fail/">Loko</a>
|
||
<ul>
|
||
<li>Desires no C interop, I can respect that</li>
|
||
</ul></li>
|
||
</ul>
|
||
<h2 id="documentation">Documentation</h2>
|
||
<p><a name="documentation"></a></p>
|
||
<h3 id="usage">Usage</h3>
|
||
<p><a name="usage"></a></p>
|
||
<h4 id="chibi">Chibi</h4>
|
||
<p><a name="usage-chibi"></a></p>
|
||
<p>Needs libffi-dev, on Debina/Ubuntu/Mint install with:</p>
|
||
<pre><code>apt install libffi-dev</code></pre>
|
||
<p>Build with:</p>
|
||
<pre><code>make chibi</code></pre>
|
||
<h4 id="chicken">Chicken</h4>
|
||
<p><a name="usage-chicken"></a></p>
|
||
<p>Needs <a href="https://wiki.call-cc.org/eggref/5/r7rs">r7rs
|
||
egg</a>, install with:</p>
|
||
<pre><code>chicken-install r7rs</code></pre>
|
||
<h4 id="racket">Racket</h4>
|
||
<p><a name="usage-racket"></a></p>
|
||
<p>Needs <a
|
||
href="https://github.com/lexi-lambda/racket-r7rs">racket-r7rs</a>,
|
||
install with:</p>
|
||
<pre><code>raco pkg install --auto r7rs</code></pre>
|
||
<h4 id="kawa">Kawa</h4>
|
||
<p><a name="usage-kawa"></a></p>
|
||
<p>Kawa Needs at least Java version 22</p>
|
||
<p>Needs jvm flags:</p>
|
||
<ul>
|
||
<li>--add-exports
|
||
java.base/jdk.internal.foreign.abi=ALL-UNNAMED</li>
|
||
<li>--add-exports
|
||
java.base/jdk.internal.foreign.layout=ALL-UNNAMED</li>
|
||
<li>--add-exports
|
||
java.base/jdk.internal.foreign=ALL-UNNAMED</li>
|
||
<li>--enable-native-access=ALL-UNNAMED</li>
|
||
</ul>
|
||
<h2 id="reference">Reference</h2>
|
||
<p><a name="reference"></a></p>
|
||
<h3 id="types">Types</h3>
|
||
<p><a name="types"></a></p>
|
||
<p>Types are given as symbols, for example ’int8 or
|
||
’pointer.</p>
|
||
<ul>
|
||
<li>int8</li>
|
||
<li>uint8</li>
|
||
<li>int16</li>
|
||
<li>uint16</li>
|
||
<li>int32</li>
|
||
<li>uint32</li>
|
||
<li>int64</li>
|
||
<li>uint64</li>
|
||
<li>char</li>
|
||
<li>unsigned-char</li>
|
||
<li>short</li>
|
||
<li>unsigned-short</li>
|
||
<li>int</li>
|
||
<li>unsigned-int</li>
|
||
<li>long</li>
|
||
<li>unsigned-long</li>
|
||
<li>float</li>
|
||
<li>double</li>
|
||
<li>pointer</li>
|
||
<li>callback
|
||
<ul>
|
||
<li>Callback function</li>
|
||
</ul></li>
|
||
</ul>
|
||
<h3 id="procedures-and-macros">Procedures and macros</h3>
|
||
<p><a name="procedures-and-macros"></a></p>
|
||
<p>Some of these are procedures and some macros, it might also
|
||
change implementation to implementation.</p>
|
||
<h4 id="pffi-init">pffi-init <a name="pffi-init"></a></h4>
|
||
<p><strong>pffi-init</strong></p>
|
||
<p>Always call this first, on most implementation it does
|
||
nothing but some implementations might need initialisation
|
||
run.</p>
|
||
<h4 id="pffi-size-of">pffi-size-of
|
||
<a name="pffi-size-of"></a></h4>
|
||
<p><strong>pffi-size-of</strong> object -> number</p>
|
||
<p>Returns the size of the pffi-struct, pffi-enum or
|
||
pffi-type.</p>
|
||
<h4 id="pffi-align-of">pffi-align-of
|
||
<a name="pffi-align-of"></a></h4>
|
||
<p><strong>pffi-align-of</strong> type -> number</p>
|
||
<p>Returns the align of the type.</p>
|
||
<h4
|
||
id="pffi-shared-object-auto-load">pffi-shared-object-auto-load
|
||
<a name="pffi-shared-object-auto-load"></a></h4>
|
||
<p><strong>pffi-shared-object-auto-load</strong> headers
|
||
shared-object-name [options] -> object</p>
|
||
<p>Load given shared object automatically searching many
|
||
predefined paths.</p>
|
||
<p>Takes as argument a list of C headers, these are for the
|
||
compiler ones. And an shared-object name, used by the dynamic
|
||
FFI’s. The name of the shared object should not contain suffix
|
||
like .so or .dll. Nor should it contain any prefix like
|
||
“lib”.</p>
|
||
<p>Additional options argument can be provided, theys should be
|
||
a pair with a keyword. The options are:</p>
|
||
<ul>
|
||
<li>additional-versions
|
||
<ul>
|
||
<li>Search for additional versions of shared object, given
|
||
shared object “c” and additional versions “6” “7” on linux the
|
||
files “libc”, “libc.6”, “libc.7” are searched for.</li>
|
||
<li>Can be either numbers or strings</li>
|
||
</ul></li>
|
||
<li>additional-paths
|
||
<ul>
|
||
<li>Give additional paths to search shared objects for</li>
|
||
</ul></li>
|
||
</ul>
|
||
<p>Example:</p>
|
||
<pre><code>(define libc-stdlib
|
||
(cond-expand
|
||
(windows (pffi-shared-object-auto-load (list "stdlib.h") "ucrtbase"))
|
||
(else (pffi-shared-object-auto-load (list "stdlib.h")
|
||
"c"
|
||
'(additional-versions . ("6"))
|
||
'(additional-search-paths . ("."))))))</code></pre>
|
||
<h4 id="pffi-shared-object-load">pffi-shared-object-load
|
||
<a name="pffi-shared-object-load"></a></h4>
|
||
<p><strong>pffi-shared-object-load</strong> headers path
|
||
[options]</p>
|
||
<p>It is recommended to use the pffi-shared-object-auto-load
|
||
instead of this directly.</p>
|
||
<p>Headers is a list of strings needed to be included, for
|
||
example</p>
|
||
<pre><code>(list "curl/curl.h")</code></pre>
|
||
<p>Path is the full path of the shared object without any “lib”
|
||
prefix or “.so/.dll” suffix. For example:</p>
|
||
<pre><code>"curl"</code></pre>
|
||
<p>Options:</p>
|
||
<ul>
|
||
<li>additional-versions
|
||
<ul>
|
||
<li>List of different versions of library to try, for example
|
||
(list “.0” “.1”)</li>
|
||
</ul></li>
|
||
</ul>
|
||
<h4 id="pffi-pointer-null">pffi-pointer-null
|
||
<a name="pffi-pointer-null"></a></h4>
|
||
<p><strong>pffi-pointer-null</strong> -> pointer</p>
|
||
<p>Returns a new NULL pointer.</p>
|
||
<h4 id="pffi-pointer-null-1">pffi-pointer-null?
|
||
<a name="pffi-pointer-null?"></a></h4>
|
||
<p><strong>pffi-pointer-null?</strong> pointer -> boolean</p>
|
||
<p>Returns #t if given pointer is null pointer, #f
|
||
otherwise.</p>
|
||
<h4 id="pffi-pointer-allocate">pffi-pointer-allocate
|
||
<a name="pffi-pointer-allocate"></a></h4>
|
||
<p><strong>pffi-pointer-allocate</strong> size -> pointer</p>
|
||
<p>Returns newly allocated pointer of given size.</p>
|
||
<h4 id="pffi-pointer-address">pffi-pointer-address
|
||
<a name="pffi-pointer-address"></a></h4>
|
||
<p><strong>pffi-pointer-address</strong> pointer ->
|
||
number</p>
|
||
<p>Returns the address of given pointer as number.</p>
|
||
<h4 id="pffi-pointer">pffi-pointer?
|
||
<a name="pffi-pointer?"></a></h4>
|
||
<p><strong>pffi-pointer?</strong> object -> boolean</p>
|
||
<p>Returns #t if given object is pointer, #f otherwise.</p>
|
||
<h4 id="pffi-pointer-free">pffi-pointer-free
|
||
<a name="pffi-pointer-free"></a></h4>
|
||
<p><strong>pffi-pointer-free</strong> pointer</p>
|
||
<p>Frees given pointer.</p>
|
||
<h4 id="pffi-pointer-set">pffi-pointer-set!
|
||
<a name="pffi-pointer-set!"></a></h4>
|
||
<p><strong>pffi-pointer-set!</strong> pointer type offset
|
||
value</p>
|
||
<p>Sets the value on a pointer on given offset. For example:</p>
|
||
<pre><code>(define p (pffi-pointer-allocate 128))
|
||
(pffi-pointer-set! p 'int 64 100)</code></pre>
|
||
<p>Would set the offset of 64, on pointer p to value 100.</p>
|
||
<h4 id="pffi-pointer-get">pffi-pointer-get
|
||
<a name="pffi-pointer-get"></a></h4>
|
||
<p><strong>pffi-pointer-get</strong> pointer type offset ->
|
||
object</p>
|
||
<p>Gets the value from a pointer on given offset. For
|
||
example:</p>
|
||
<pre><code>(define p (pffi-pointer-allocate 128))
|
||
(pffi-pointer-set! p 'int 64 100)
|
||
(pffi-pointer-get p 'int 64)
|
||
> 100</code></pre>
|
||
<h4 id="pffi-string-pointer">pffi-string->pointer
|
||
<a name="pffi-string-to-pointer"></a></h4>
|
||
<p><strong>pffi-string->pointer</strong> string ->
|
||
pointer</p>
|
||
<p>Makes pointer out of a given string.</p>
|
||
<h4 id="pffi-pointer-string">pffi-pointer->string
|
||
<a name="pffi-pointer-to-string"></a></h4>
|
||
<p><strong>pffi-pointer->string</strong> pointer ->
|
||
string</p>
|
||
<p>Makes string out of a given pointer.</p>
|
||
<h4 id="pffi-struct-make">pffi-struct-make
|
||
<a name="pffi-struct-make"></a></h4>
|
||
<p><strong>pffi-struct-make</strong> c-type members . pointer
|
||
-> pffi-struct</p>
|
||
<p>Creates a new pffi-struct and allocates pointer for it. The
|
||
members argument is a list of member names and types. For
|
||
example:</p>
|
||
<pre><code>(define color (pffi-struct-make 'color '((int8 . r) (int8 . g) (int8 . b) (int8 .a ))))
|
||
(define test (pffi-struct-make "struct test" '((int8 . r) (int8 . g) (int8 . b) (int8 .a ))))</code></pre>
|
||
<p>C-type argument can be symbol or a string.</p>
|
||
<h4 id="pffi-struct-pointer">pffi-struct-pointer
|
||
<a name="pffi-struct-pointer"></a></h4>
|
||
<p><strong>pffi-struct-pointer</strong> pffi-struct ->
|
||
pointer</p>
|
||
<p>Returns the pointer that holds the struct content. You need
|
||
to use this when passing a struct as a pointer to foreign
|
||
functions.</p>
|
||
<pre><code>(define s (pffi-struct-make 'test '((int . r) (int . g) (int . b))))
|
||
(pffi-struct-pointer s)</code></pre>
|
||
<h4 id="pffi-struct-offset-get">pffi-struct-offset-get
|
||
<a name="pffi-struct-offset-get"></a></h4>
|
||
<p><strong>pffi-struct-offset-get</strong> member-name ->
|
||
number</p>
|
||
<p>Returns the offset of a struct member with given name.</p>
|
||
<h4 id="pffi-struct-get">pffi-struct-get
|
||
<a name="pffi-struct-get"></a></h4>
|
||
<p><strong>pffi-struct-get</strong> pffi-struct member-name
|
||
-> object</p>
|
||
<p>Returns the value of the givens struct member.</p>
|
||
<h4 id="pffi-struct-set">pffi-struct-set!
|
||
<a name="pffi-struct-set!"></a></h4>
|
||
<p><strong>pffi-struct-set!</strong> pffi-struct member-name
|
||
value</p>
|
||
<p>Sets the value of the givens struct member. It is up to you
|
||
to make sure that the type of value is correct.</p>
|
||
<h4 id="pffi-define">pffi-define <a name="pffi-define"></a></h4>
|
||
<p><strong>pffi-define</strong> scheme-name shared-object c-name
|
||
return-type argument-types</p>
|
||
<p>Defines a new foreign function to be used from Scheme code.
|
||
For example:</p>
|
||
<pre><code>(define libc-stdlib
|
||
(cond-expand
|
||
(windows (pffi-shared-object-auto-load (list "stdlib.h") (list) "ucrtbase" (list "")))
|
||
(else (pffi-shared-object-auto-load (list "stdlib.h") (list) "c" (list "" "6")))))
|
||
(pffi-define c-puts libc-stdlib 'puts 'int (list 'pointer))
|
||
(c-puts "Message brought to you by FFI!")</code></pre>
|
||
<h4 id="pffi-define-callback">pffi-define-callback
|
||
<a name="pffi-define-callback"></a></h4>
|
||
<p><strong>pffi-define-callback</strong> scheme-name return-type
|
||
argument-types procedure</p>
|
||
<p>Defines a new Sceme function to be used as callback to C
|
||
code. For example:</p>
|
||
<pre><code>; Load the shared library
|
||
(define libc-stdlib
|
||
(cond-expand
|
||
(windows (pffi-shared-object-auto-load (list "stdlib.h") (list) "ucrtbase" (list "")))
|
||
(else (pffi-shared-object-auto-load (list "stdlib.h") (list) "c" (list "" "6")))))
|
||
|
||
; Define C function that takes a callback
|
||
(pffi-define qsort libc-stdlib 'qsort 'void (list 'pointer 'int 'int 'callback))
|
||
|
||
; Define our callback
|
||
(pffi-define-callback compare
|
||
'int
|
||
(list 'pointer 'pointer)
|
||
(lambda (pointer-a pointer-b)
|
||
(let ((a (pffi-pointer-get pointer-a 'int 0))
|
||
(b (pffi-pointer-get pointer-b 'int 0)))
|
||
(cond ((> a b) 1)
|
||
((= a b) 0)
|
||
((< a b) -1)))))
|
||
|
||
; Create new array of ints to be sorted
|
||
(define array (pffi-pointer-allocate (* (pffi-size-of 'int) 3)))
|
||
(pffi-pointer-set! array 'int (* (pffi-size-of 'int) 0) 3)
|
||
(pffi-pointer-set! array 'int (* (pffi-size-of 'int) 1) 2)
|
||
(pffi-pointer-set! array 'int (* (pffi-size-of 'int) 2) 1)
|
||
|
||
(display array)
|
||
(newline)
|
||
;> (3 2 1)
|
||
|
||
; Sort the array
|
||
(qsort array 3 (pffi-size-of 'int) compare)
|
||
|
||
(display array)
|
||
(newline)
|
||
;> (1 2 3)</code></pre>
|
||
</main>
|
||
</body>
|
||
</html>
|