Import Upstream version 20180207
[hcoop/debian/mlton.git] / doc / guide / localhost / SMLofNJStructure
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>SMLofNJStructure</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>SMLofNJStructure</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">SML_OF_NJ</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">structure</span><span class="w"> </span><span class="n">Cont</span><span class="p">:</span><span class="w"></span>
35 <span class="w"> </span><span class="k">sig</span><span class="w"></span>
36 <span class="w"> </span><span class="k">type</span><span class="w"> </span><span class="n">&#39;a</span><span class="w"> </span><span class="n">cont</span><span class="w"></span>
37 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">callcc</span><span class="p">:</span><span class="w"> </span><span class="p">(</span><span class="n">&#39;a</span><span class="w"> </span><span class="n">cont</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">&#39;a</span><span class="p">)</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">&#39;a</span><span class="w"></span>
38 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">isolate</span><span class="p">:</span><span class="w"> </span><span class="p">(</span><span class="n">&#39;a</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">unit</span><span class="p">)</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">&#39;a</span><span class="w"> </span><span class="n">cont</span><span class="w"></span>
39 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">throw</span><span class="p">:</span><span class="w"> </span><span class="n">&#39;a</span><span class="w"> </span><span class="n">cont</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">&#39;a</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">&#39;b</span><span class="w"></span>
40 <span class="w"> </span><span class="k">end</span><span class="w"></span>
41 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">SysInfo</span><span class="p">:</span><span class="w"></span>
42 <span class="w"> </span><span class="k">sig</span><span class="w"></span>
43 <span class="w"> </span><span class="k">exception</span><span class="w"> </span><span class="n">UNKNOWN</span><span class="w"></span>
44 <span class="w"> </span><span class="k">datatype</span><span class="w"> </span><span class="n">os_kind</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">BEOS</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">MACOS</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">OS2</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">UNIX</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">WIN32</span><span class="w"></span>
45
46 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">getHostArch</span><span class="p">:</span><span class="w"> </span><span class="n">unit</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">string</span><span class="w"></span>
47 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">getOSKind</span><span class="p">:</span><span class="w"> </span><span class="n">unit</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">os_kind</span><span class="w"></span>
48 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">getOSName</span><span class="p">:</span><span class="w"> </span><span class="n">unit</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">string</span><span class="w"></span>
49 <span class="w"> </span><span class="k">end</span><span class="w"></span>
50
51 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">exnHistory</span><span class="p">:</span><span class="w"> </span><span class="n">exn</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">string</span><span class="w"> </span><span class="n">list</span><span class="w"></span>
52 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">exportFn</span><span class="p">:</span><span class="w"> </span><span class="n">string</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="p">(</span><span class="n">string</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">string</span><span class="w"> </span><span class="n">list</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">OS</span><span class="p">.</span><span class="n">Process</span><span class="p">.</span><span class="n">status</span><span class="p">)</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">exportML</span><span class="p">:</span><span class="w"> </span><span class="n">string</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">bool</span><span class="w"></span>
54 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">getAllArgs</span><span class="p">:</span><span class="w"> </span><span class="n">unit</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">string</span><span class="w"> </span><span class="n">list</span><span class="w"></span>
55 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">getArgs</span><span class="p">:</span><span class="w"> </span><span class="n">unit</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">string</span><span class="w"> </span><span class="n">list</span><span class="w"></span>
56 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">getCmdName</span><span class="p">:</span><span class="w"> </span><span class="n">unit</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">string</span><span class="w"></span>
57 <span class="w"> </span><span class="k">end</span><span class="w"></span>
58 </pre></div></div></div>
59 <div class="paragraph"><p><span class="monospaced">SMLofNJ</span> implements a subset of the structure of the same name
60 provided in <a href="SMLNJ">Standard ML of New Jersey</a>. It is included to
61 make it easier to port programs between the two systems. The
62 semantics of these functions may be different than in SML/NJ.</p></div>
63 <div class="ulist"><ul>
64 <li>
65 <p>
66 <span class="monospaced">structure Cont</span>
67 </p>
68 <div class="paragraph"><p>implements continuations.</p></div>
69 </li>
70 <li>
71 <p>
72 <span class="monospaced">SysInfo.getHostArch ()</span>
73 </p>
74 <div class="paragraph"><p>returns the string for the architecture.</p></div>
75 </li>
76 <li>
77 <p>
78 <span class="monospaced">SysInfo.getOSKind</span>
79 </p>
80 <div class="paragraph"><p>returns the OS kind.</p></div>
81 </li>
82 <li>
83 <p>
84 <span class="monospaced">SysInfo.getOSName ()</span>
85 </p>
86 <div class="paragraph"><p>returns the string for the host.</p></div>
87 </li>
88 <li>
89 <p>
90 <span class="monospaced">exnHistory</span>
91 </p>
92 <div class="paragraph"><p>the same as <span class="monospaced">MLton.Exn.history</span>.</p></div>
93 </li>
94 <li>
95 <p>
96 <span class="monospaced">getCmdName ()</span>
97 </p>
98 <div class="paragraph"><p>the same as <span class="monospaced">CommandLine.name ()</span>.</p></div>
99 </li>
100 <li>
101 <p>
102 <span class="monospaced">getArgs ()</span>
103 </p>
104 <div class="paragraph"><p>the same as <span class="monospaced">CommandLine.arguments ()</span>.</p></div>
105 </li>
106 <li>
107 <p>
108 <span class="monospaced">getAllArgs ()</span>
109 </p>
110 <div class="paragraph"><p>the same as <span class="monospaced">getCmdName()::getArgs()</span>.</p></div>
111 </li>
112 <li>
113 <p>
114 <span class="monospaced">exportFn f</span>
115 </p>
116 <div class="paragraph"><p>saves the state of the computation to a file that will apply <span class="monospaced">f</span> to
117 the command-line arguments upon restart.</p></div>
118 </li>
119 <li>
120 <p>
121 <span class="monospaced">exportML f</span>
122 </p>
123 <div class="paragraph"><p>saves the state of the computation to file <span class="monospaced">f</span> and continue. Returns
124 <span class="monospaced">true</span> in the restarted computation and <span class="monospaced">false</span> in the continuing
125 computation.</p></div>
126 </li>
127 </ul></div>
128 </div>
129 </div>
130 </div>
131 <div id="footnotes"><hr></div>
132 <div id="footer">
133 <div id="footer-text">
134 </div>
135 <div id="footer-badges">
136 </div>
137 </div>
138 </body>
139 </html>