<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 2.0.23">
<title>MLNLFFI</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
<link rel="stylesheet" href="./asciidoctor.css">
<link rel="stylesheet" href="./mlton.css">

</head>
<body class="article">
<div id="mlton-header">
<div id="mlton-header-text">
<h2>
<a href="./Home">
MLton
20241230
</a>
</h2>
</div>
</div>
<div id="header">
<h1>MLNLFFI</h1>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p><a href="References#Blume01">ML-NLFFI</a> is the no-longer-foreign-function interface
library for SML.</p>
</div>
<div class="paragraph">
<p>As of 20050212, MLton has an initial port of ML-NLFFI from SML/NJ to
MLton.  All of the ML-NLFFI functionality is present.</p>
</div>
<div class="paragraph">
<p>Additionally, MLton has an initial port of the
<a href="MLNLFFIGen">mlnlffigen</a> tool from SML/NJ to MLton.  Due to low-level
details, the code generated by SML/NJ&#8217;s <code>ml-nlffigen</code> is not
compatible with MLton, and vice-versa.  However, the generated code
has the same interface, so portable client code can be written.
MLton&#8217;s <code>mlnlffigen</code> does not currently support C functions with
<code>struct</code> or <code>union</code> arguments.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_usage">Usage</h2>
<div class="sectionbody">
<div class="ulist">
<ul>
<li>
<p>You can import the ML-NLFFI Library into an MLB file with</p>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">MLB file</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>$(SML_LIB)/mlnlffi-lib/mlnlffi-lib.mlb</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>
</li>
<li>
<p>If you are porting a project from SML/NJ&#8217;s <a href="CompilationManager">CompilationManager</a> to
MLton&#8217;s <a href="MLBasis">ML Basis system</a> using <code>cm2mlb</code>, note that the
following maps are included by default:</p>
<div class="listingblock">
<div class="content">
<pre># MLNLFFI Library
$c                                      $(SML_LIB)/mlnlffi-lib
$c/c.cm                                 $(SML_LIB)/mlnlffi-lib/mlnlffi-lib.mlb</pre>
</div>
</div>
<div class="paragraph">
<p>This will automatically convert a <code>$/c.cm</code> import in an input <code>.cm</code>
file into a <code>$(SML_LIB)/mlnlffi-lib/mlnlffi-lib.mlb</code> import in the
output <code>.mlb</code> file.</p>
</div>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_also_see">Also see</h2>
<div class="sectionbody">
<div class="ulist">
<ul>
<li>
<p><a href="References#Blume01">Blume01</a></p>
</li>
<li>
<p><a href="MLNLFFIImplementation">MLNLFFIImplementation</a></p>
</li>
<li>
<p><a href="MLNLFFIGen">MLNLFFIGen</a></p>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="mlton-footer">
<div id="mlton-footer-text">
<div>
Last updated Thu Oct 21 15:53:06 2021 -0400 by Matthew Fluet.
<a href="https://github.com/MLton/mlton/commits/master/doc/guide/src/MLNLFFI.adoc">Log</a>
<a href="https://github.com/MLton/mlton/edit/master/doc/guide/src/MLNLFFI.adoc">Edit</a>
</div>
</div>
</body>
</html>