/usr/share/doc/mlton/guide/MLtonPointer is in mlton-doc 20100608-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta name="robots" content="index,nofollow">
<title>MLtonPointer - MLton Standard ML Compiler (SML Compiler)</title>
<link rel="stylesheet" type="text/css" charset="iso-8859-1" media="all" href="common.css">
<link rel="stylesheet" type="text/css" charset="iso-8859-1" media="screen" href="screen.css">
<link rel="stylesheet" type="text/css" charset="iso-8859-1" media="print" href="print.css">
<link rel="Start" href="Home">
</head>
<body lang="en" dir="ltr">
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
</script>
<script type="text/javascript">
_uacct = "UA-833377-1";
urchinTracker();
</script>
<table bgcolor = lightblue cellspacing = 0 style = "border: 0px;" width = 100%>
<tr>
<td style = "
border: 0px;
color: darkblue;
font-size: 150%;
text-align: left;">
<a class = mltona href="Home">MLton MLTONWIKIVERSION</a>
<td style = "
border: 0px;
font-size: 150%;
text-align: center;
width: 50%;">
MLtonPointer
<td style = "
border: 0px;
text-align: right;">
<table cellspacing = 0 style = "border: 0px">
<tr style = "vertical-align: middle;">
</table>
<tr style = "background-color: white;">
<td colspan = 3
style = "
border: 0px;
font-size:70%;
text-align: right;">
<a href = "Home">Home</a>
<a href = "TitleIndex">Index</a>
</table>
<div id="content" lang="en" dir="ltr">
<pre class=code>
<B><FONT COLOR="#0000FF">signature</FONT></B> MLTON_POINTER =
<B><FONT COLOR="#0000FF">sig</FONT></B>
<B><FONT COLOR="#A020F0">eqtype</FONT></B><B><FONT COLOR="#228B22"> t
</FONT></B><B><FONT COLOR="#A020F0">val</FONT></B> add: t * word -> t
<B><FONT COLOR="#A020F0">val</FONT></B> compare: t * t -> order
<B><FONT COLOR="#A020F0">val</FONT></B> diff: t * t -> word
<B><FONT COLOR="#A020F0">val</FONT></B> getInt8: t * int -> Int8.int
<B><FONT COLOR="#A020F0">val</FONT></B> getInt16: t * int -> Int16.int
<B><FONT COLOR="#A020F0">val</FONT></B> getInt32: t * int -> Int32.int
<B><FONT COLOR="#A020F0">val</FONT></B> getInt64: t * int -> Int64.int
<B><FONT COLOR="#A020F0">val</FONT></B> getPointer: t * int -> t
<B><FONT COLOR="#A020F0">val</FONT></B> getReal32: t * int -> Real32.real
<B><FONT COLOR="#A020F0">val</FONT></B> getReal64: t * int -> Real64.real
<B><FONT COLOR="#A020F0">val</FONT></B> getWord8: t * int -> Word8.word
<B><FONT COLOR="#A020F0">val</FONT></B> getWord16: t * int -> Word16.word
<B><FONT COLOR="#A020F0">val</FONT></B> getWord32: t * int -> Word32.word
<B><FONT COLOR="#A020F0">val</FONT></B> getWord64: t * int -> Word64.word
<B><FONT COLOR="#A020F0">val</FONT></B> null: t
<B><FONT COLOR="#A020F0">val</FONT></B> setInt8: t * int * Int8.int -> unit
<B><FONT COLOR="#A020F0">val</FONT></B> setInt16: t * int * Int16.int -> unit
<B><FONT COLOR="#A020F0">val</FONT></B> setInt32: t * int * Int32.int -> unit
<B><FONT COLOR="#A020F0">val</FONT></B> setInt64: t * int * Int64.int -> unit
<B><FONT COLOR="#A020F0">val</FONT></B> setPointer: t * int * t -> unit
<B><FONT COLOR="#A020F0">val</FONT></B> setReal32: t * int * Real32.real -> unit
<B><FONT COLOR="#A020F0">val</FONT></B> setReal64: t * int * Real64.real -> unit
<B><FONT COLOR="#A020F0">val</FONT></B> setWord8: t * int * Word8.word -> unit
<B><FONT COLOR="#A020F0">val</FONT></B> setWord16: t * int * Word16.word -> unit
<B><FONT COLOR="#A020F0">val</FONT></B> setWord32: t * int * Word32.word -> unit
<B><FONT COLOR="#A020F0">val</FONT></B> setWord64: t * int * Word64.word -> unit
<B><FONT COLOR="#A020F0">val</FONT></B> sizeofPointer: word
<B><FONT COLOR="#A020F0">val</FONT></B> sub: t * word -> t
<B><FONT COLOR="#0000FF">end</FONT></B>
</PRE>
<p>
</p>
<ul>
<li>
<p>
<tt>eqtype t</tt> <br>
the type of pointers, i.e. machine addresses.
</p>
</li>
<li class="gap">
<p>
<tt>add (p, w)</tt> <br>
returns the pointer <tt>w</tt> bytes after than <tt>p</tt>. Does not check for overflow.
</p>
</li>
<li class="gap">
<p>
<tt>compare (p1, p2)</tt> <br>
compares the pointer <tt>p1</tt> to the pointer <tt>p2</tt> (as addresses).
</p>
</li>
<li class="gap">
<p>
<tt>diff (p1, p2)</tt> <br>
returns the number of bytes <tt>w</tt> such that <tt>add (p2, w) = p1</tt>. Does not check for overflow.
</p>
</li>
<li class="gap">
<p>
<tt>get</tt><em>X</em><tt> (p, i)</tt> <br>
returns the object stored at index i of the array of <em>X</em> objects pointed to by <tt>p</tt>. For example, <tt>getWord32 (p, 7)</tt> returns the 32-bit word stored 28 bytes beyond <tt>p</tt>.
</p>
</li>
<li class="gap">
<p>
<tt>null</tt> <br>
the null pointer, i.e. 0.
</p>
</li>
<li class="gap">
<p>
<tt>set</tt><em>X</em><tt> (p, i, v)</tt> <br>
assigns <tt>v</tt> to the object stored at index i of the array of <em>X</em> objects pointed to by <tt>p</tt>. For example, <tt>setWord32 (p, 7, w)</tt> stores the 32-bit word <tt>w</tt> at the address 28 bytes beyond <tt>p</tt>.
</p>
</li>
<li class="gap">
<p>
<tt>sizeofPointer</tt> <br>
size, in bytes, of a pointer.
</p>
</li>
<li class="gap">
<p>
<tt>sub (p, w)</tt> <br>
returns the pointer <tt>w</tt> bytes before <tt>p</tt>. Does not check for overflow.
</p>
</li>
</ul>
</div>
<p>
<hr>
Last edited on 2009-06-05 23:27:00 by <span title="fenrir.uchicago.edu"><a href="MatthewFluet">MatthewFluet</a></span>.
</body></html>
|