HCoop / hcoop / debian / mlton.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Import Debian changes 20180207-1
[hcoop/debian/mlton.git] / doc / guide / localhost / MLtonPointer
CommitLineData
7f918cf1
CE		 1<!DOCTYPE html>\r
2<html lang="en">\r
3<head>\r
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">\r
5<meta name="generator" content="AsciiDoc 8.6.9">\r
6<title>MLtonPointer</title>\r
7<link rel="stylesheet" href="./asciidoc.css" type="text/css">\r
8<link rel="stylesheet" href="./pygments.css" type="text/css">\r
9\r
10\r
11<script type="text/javascript" src="./asciidoc.js"></script>\r
12<script type="text/javascript">\r
13/*<![CDATA[*/\r
14asciidoc.install();\r
15/*]]>*/\r
16</script>\r
17<link rel="stylesheet" href="./mlton.css" type="text/css">\r
18</head>\r
19<body class="article">\r
20<div id="banner">\r
21<div id="banner-home">\r
22<a href="./Home">MLton 20180207</a>\r
23</div>\r
24</div>\r
25<div id="header">\r
26<h1>MLtonPointer</h1>\r
27</div>\r
28<div id="content">\r
29<div id="preamble">\r
30<div class="sectionbody">\r
31<div class="listingblock">\r
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>\r
33<span class="w"> </span><span class="k">sig</span><span class="w"></span>\r
34<span class="w"> </span><span class="k">eqtype</span><span class="w"> </span><span class="n">t</span><span class="w"></span>\r
35\r
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>\r
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>\r
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>\r
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>\r
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>\r
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>\r
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>\r
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>\r
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>\r
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>\r
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>\r
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>\r
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>\r
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>\r
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>\r
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>\r
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>\r
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>\r
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>\r
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>\r
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>\r
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>\r
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>\r
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>\r
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>\r
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>\r
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>\r
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>\r
64<span class="w"> </span><span class="k">end</span><span class="w"></span>\r
65</pre></div></div></div>\r
66<div class="ulist"><ul>\r
67<li>\r
68<p>\r
69<span class="monospaced">eqtype t</span>\r
70</p>\r
71<div class="paragraph"><p>the type of pointers, i.e. machine addresses.</p></div>\r
72</li>\r
73<li>\r
74<p>\r
75<span class="monospaced">add (p, w)</span>\r
76</p>\r
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\r
78overflow.</p></div>\r
79</li>\r
80<li>\r
81<p>\r
82<span class="monospaced">compare (p1, p2)</span>\r
83</p>\r
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>\r
85</li>\r
86<li>\r
87<p>\r
88<span class="monospaced">diff (p1, p2)</span>\r
89</p>\r
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\r
91not check for overflow.</p></div>\r
92</li>\r
93<li>\r
94<p>\r
95<span class="monospaced">get<em>&lt;X&gt;</em> (p, i)</span>\r
96</p>\r
97<div class="paragraph"><p>returns the object stored at index i of the array of <em>X</em> objects\r
98pointed to by <span class="monospaced">p</span>. For example, <span class="monospaced">getWord32 (p, 7)</span> returns the 32-bit\r
99word stored 28 bytes beyond <span class="monospaced">p</span>.</p></div>\r
100</li>\r
101<li>\r
102<p>\r
103<span class="monospaced">null</span>\r
104</p>\r
105<div class="paragraph"><p>the null pointer, i.e. 0.</p></div>\r
106</li>\r
107<li>\r
108<p>\r
109<span class="monospaced">set<em>&lt;X&gt;</em> (p, i, v)</span>\r
110</p>\r
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>\r
112objects pointed to by <span class="monospaced">p</span>. For example, <span class="monospaced">setWord32 (p, 7, w)</span> stores\r
113the 32-bit word <span class="monospaced">w</span> at the address 28 bytes beyond <span class="monospaced">p</span>.</p></div>\r
114</li>\r
115<li>\r
116<p>\r
117<span class="monospaced">sizeofPointer</span>\r
118</p>\r
119<div class="paragraph"><p>size, in bytes, of a pointer.</p></div>\r
120</li>\r
121<li>\r
122<p>\r
123<span class="monospaced">sub (p, w)</span>\r
124</p>\r
125<div class="paragraph"><p>returns the pointer <span class="monospaced">w</span> bytes before <span class="monospaced">p</span>. Does not check for\r
126overflow.</p></div>\r
127</li>\r
128</ul></div>\r
129</div>\r
130</div>\r
131</div>\r
132<div id="footnotes"><hr></div>\r
133<div id="footer">\r
134<div id="footer-text">\r
135</div>\r
136<div id="footer-badges">\r
137</div>\r
138</div>\r
139</body>\r
140</html>\r
mlton packaging