doc/guide/localhost/MLtonPointer

   1 <!DOCTYPE html>
   2 <html lang="en">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <meta name="generator" content="AsciiDoc 8.6.9">
   6 <title>MLtonPointer</title>
   7 <link rel="stylesheet" href="./asciidoc.css" type="text/css">
   8 <link rel="stylesheet" href="./pygments.css" type="text/css">
   9
  10
  11 <script type="text/javascript" src="./asciidoc.js"></script>
  12 <script type="text/javascript">
  13 /*<![CDATA[*/
  14 asciidoc.install();
  15 /*]]>*/
  16 </script>
  17 <link rel="stylesheet" href="./mlton.css" type="text/css">
  18 </head>
  19 <body class="article">
  20 <div id="banner">
  21 <div id="banner-home">
  22 <a href="./Home">MLton 20180207</a>
  23 </div>
  24 </div>
  25 <div id="header">
  26 <h1>MLtonPointer</h1>
  27 </div>
  28 <div id="content">
  29 <div id="preamble">
  30 <div class="sectionbody">
  31 <div class="listingblock">
  32 <div class="content"><div class="highlight"><pre><span class="k">signature</span><span class="w"> </span><span class="n">MLTON_POINTER</span><span class="w"> </span><span class="p">=</span><span class="w"></span>
  33 <span class="w">   </span><span class="k">sig</span><span class="w"></span>
  34 <span class="w">      </span><span class="k">eqtype</span><span class="w"> </span><span class="n">t</span><span class="w"></span>
  35
  36 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">add</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">word</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">t</span><span class="w"></span>
  37 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">compare</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">order</span><span class="w"></span>
  38 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">diff</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">word</span><span class="w"></span>
  39 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">getInt8</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">Int8</span><span class="p">.</span><span class="n">int</span><span class="w"></span>
  40 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">getInt16</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">Int16</span><span class="p">.</span><span class="n">int</span><span class="w"></span>
  41 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">getInt32</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">Int32</span><span class="p">.</span><span class="n">int</span><span class="w"></span>
  42 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">getInt64</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">Int64</span><span class="p">.</span><span class="n">int</span><span class="w"></span>
  43 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">getPointer</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">t</span><span class="w"></span>
  44 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">getReal32</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">Real32</span><span class="p">.</span><span class="n">real</span><span class="w"></span>
  45 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">getReal64</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">Real64</span><span class="p">.</span><span class="n">real</span><span class="w"></span>
  46 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">getWord8</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">Word8</span><span class="p">.</span><span class="n">word</span><span class="w"></span>
  47 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">getWord16</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">Word16</span><span class="p">.</span><span class="n">word</span><span class="w"></span>
  48 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">getWord32</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">Word32</span><span class="p">.</span><span class="n">word</span><span class="w"></span>
  49 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">getWord64</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">Word64</span><span class="p">.</span><span class="n">word</span><span class="w"></span>
  50 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">null</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"></span>
  51 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">setInt8</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">Int8</span><span class="p">.</span><span class="n">int</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">unit</span><span class="w"></span>
  52 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">setInt16</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">Int16</span><span class="p">.</span><span class="n">int</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">unit</span><span class="w"></span>
  53 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">setInt32</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">Int32</span><span class="p">.</span><span class="n">int</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">unit</span><span class="w"></span>
  54 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">setInt64</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">Int64</span><span class="p">.</span><span class="n">int</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">unit</span><span class="w"></span>
  55 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">setPointer</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">unit</span><span class="w"></span>
  56 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">setReal32</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">Real32</span><span class="p">.</span><span class="n">real</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">unit</span><span class="w"></span>
  57 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">setReal64</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">Real64</span><span class="p">.</span><span class="n">real</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">unit</span><span class="w"></span>
  58 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">setWord8</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">Word8</span><span class="p">.</span><span class="n">word</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">unit</span><span class="w"></span>
  59 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">setWord16</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">Word16</span><span class="p">.</span><span class="n">word</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">unit</span><span class="w"></span>
  60 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">setWord32</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">Word32</span><span class="p">.</span><span class="n">word</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">unit</span><span class="w"></span>
  61 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">setWord64</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">Word64</span><span class="p">.</span><span class="n">word</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">unit</span><span class="w"></span>
  62 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">sizeofPointer</span><span class="p">:</span><span class="w"> </span><span class="n">word</span><span class="w"></span>
  63 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">sub</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">word</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">t</span><span class="w"></span>
  64 <span class="w">   </span><span class="k">end</span><span class="w"></span>
  65 </pre></div></div></div>
  66 <div class="ulist"><ul>
  67 <li>
  68 <p>
  69 <span class="monospaced">eqtype t</span>
  70 </p>
  71 <div class="paragraph"><p>the type of pointers, i.e. machine addresses.</p></div>
  72 </li>
  73 <li>
  74 <p>
  75 <span class="monospaced">add (p, w)</span>
  76 </p>
  77 <div class="paragraph"><p>returns the pointer <span class="monospaced">w</span> bytes after than <span class="monospaced">p</span>.  Does not check for
  78 overflow.</p></div>
  79 </li>
  80 <li>
  81 <p>
  82 <span class="monospaced">compare (p1, p2)</span>
  83 </p>
  84 <div class="paragraph"><p>compares the pointer <span class="monospaced">p1</span> to the pointer <span class="monospaced">p2</span> (as addresses).</p></div>
  85 </li>
  86 <li>
  87 <p>
  88 <span class="monospaced">diff (p1, p2)</span>
  89 </p>
  90 <div class="paragraph"><p>returns the number of bytes <span class="monospaced">w</span> such that <span class="monospaced">add (p2, w) = p1</span>.  Does
  91 not check for overflow.</p></div>
  92 </li>
  93 <li>
  94 <p>
  95 <span class="monospaced">get<em>&lt;X&gt;</em> (p, i)</span>
  96 </p>
  97 <div class="paragraph"><p>returns the object stored at index i of the array of <em>X</em> objects
  98 pointed to by <span class="monospaced">p</span>.  For example, <span class="monospaced">getWord32 (p, 7)</span> returns the 32-bit
  99 word stored 28 bytes beyond <span class="monospaced">p</span>.</p></div>
 100 </li>
 101 <li>
 102 <p>
 103 <span class="monospaced">null</span>
 104 </p>
 105 <div class="paragraph"><p>the null pointer, i.e. 0.</p></div>
 106 </li>
 107 <li>
 108 <p>
 109 <span class="monospaced">set<em>&lt;X&gt;</em> (p, i, v)</span>
 110 </p>
 111 <div class="paragraph"><p>assigns <span class="monospaced">v</span> to the object stored at index i of the array of <em>X</em>
 112 objects pointed to by <span class="monospaced">p</span>.  For example, <span class="monospaced">setWord32 (p, 7, w)</span> stores
 113 the 32-bit word <span class="monospaced">w</span> at the address 28 bytes beyond <span class="monospaced">p</span>.</p></div>
 114 </li>
 115 <li>
 116 <p>
 117 <span class="monospaced">sizeofPointer</span>
 118 </p>
 119 <div class="paragraph"><p>size, in bytes, of a pointer.</p></div>
 120 </li>
 121 <li>
 122 <p>
 123 <span class="monospaced">sub (p, w)</span>
 124 </p>
 125 <div class="paragraph"><p>returns the pointer <span class="monospaced">w</span> bytes before <span class="monospaced">p</span>.  Does not check for
 126 overflow.</p></div>
 127 </li>
 128 </ul></div>
 129 </div>
 130 </div>
 131 </div>
 132 <div id="footnotes"><hr></div>
 133 <div id="footer">
 134 <div id="footer-text">
 135 </div>
 136 <div id="footer-badges">
 137 </div>
 138 </div>
 139 </body>
 140 </html>