<!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.26">
<title>MLtonPointer</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+git20251029+dfsg-5
</a>
</h2>
</div>
</div>
<div id="header">
<h1>MLtonPointer</h1>
</div>
<div id="content">
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="sml">signature MLTON_POINTER =
   sig
      eqtype t

      val add: t * word -&gt; t
      val compare: t * t -&gt; order
      val diff: t * t -&gt; word
      val getInt8: t * int -&gt; Int8.int
      val getInt16: t * int -&gt; Int16.int
      val getInt32: t * int -&gt; Int32.int
      val getInt64: t * int -&gt; Int64.int
      val getPointer: t * int -&gt; t
      val getReal32: t * int -&gt; Real32.real
      val getReal64: t * int -&gt; Real64.real
      val getWord8: t * int -&gt; Word8.word
      val getWord16: t * int -&gt; Word16.word
      val getWord32: t * int -&gt; Word32.word
      val getWord64: t * int -&gt; Word64.word
      val null: t
      val setInt8: t * int * Int8.int -&gt; unit
      val setInt16: t * int * Int16.int -&gt; unit
      val setInt32: t * int * Int32.int -&gt; unit
      val setInt64: t * int * Int64.int -&gt; unit
      val setPointer: t * int * t -&gt; unit
      val setReal32: t * int * Real32.real -&gt; unit
      val setReal64: t * int * Real64.real -&gt; unit
      val setWord8: t * int * Word8.word -&gt; unit
      val setWord16: t * int * Word16.word -&gt; unit
      val setWord32: t * int * Word32.word -&gt; unit
      val setWord64: t * int * Word64.word -&gt; unit
      val sizeofPointer: word
      val sub: t * word -&gt; t
   end</code></pre>
</div>
</div>
<div class="ulist">
<ul>
<li>
<p><code>eqtype t</code></p>
<div class="paragraph">
<p>the type of pointers, i.e. machine addresses.</p>
</div>
</li>
<li>
<p><code>add (p, w)</code></p>
<div class="paragraph">
<p>returns the pointer <code>w</code> bytes after than <code>p</code>.  Does not check for
overflow.</p>
</div>
</li>
<li>
<p><code>compare (p1, p2)</code></p>
<div class="paragraph">
<p>compares the pointer <code>p1</code> to the pointer <code>p2</code> (as addresses).</p>
</div>
</li>
<li>
<p><code>diff (p1, p2)</code></p>
<div class="paragraph">
<p>returns the number of bytes <code>w</code> such that <code>add (p2, w) = p1</code>.  Does
not check for overflow.</p>
</div>
</li>
<li>
<p><code>get<em>&lt;X&gt;</em> (p, i)</code></p>
<div class="paragraph">
<p>returns the object stored at index i of the array of <em>X</em> objects
pointed to by <code>p</code>.  For example, <code>getWord32 (p, 7)</code> returns the 32-bit
word stored 28 bytes beyond <code>p</code>.</p>
</div>
</li>
<li>
<p><code>null</code></p>
<div class="paragraph">
<p>the null pointer, i.e. 0.</p>
</div>
</li>
<li>
<p><code>set<em>&lt;X&gt;</em> (p, i, v)</code></p>
<div class="paragraph">
<p>assigns <code>v</code> to the object stored at index i of the array of <em>X</em>
objects pointed to by <code>p</code>.  For example, <code>setWord32 (p, 7, w)</code> stores
the 32-bit word <code>w</code> at the address 28 bytes beyond <code>p</code>.</p>
</div>
</li>
<li>
<p><code>sizeofPointer</code></p>
<div class="paragraph">
<p>size, in bytes, of a pointer.</p>
</div>
</li>
<li>
<p><code>sub (p, w)</code></p>
<div class="paragraph">
<p>returns the pointer <code>w</code> bytes before <code>p</code>.  Does not check for
overflow.</p>
</div>
</li>
</ul>
</div>
</div>
</body>
</html>