[hcoop/debian/mlton.git] / doc / guide / localhost / StandardMLGotchas

<!DOCTYPE html>\r
<html lang="en">\r
<head>\r
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">\r
<meta name="generator" content="AsciiDoc 8.6.9">\r
<title>StandardMLGotchas</title>\r
<link rel="stylesheet" href="./asciidoc.css" type="text/css">\r
<link rel="stylesheet" href="./pygments.css" type="text/css">\r
\r
\r
<script type="text/javascript" src="./asciidoc.js"></script>\r
<script type="text/javascript">\r
/*<![CDATA[*/\r
asciidoc.install(2);\r
/*]]>*/\r
</script>\r
<link rel="stylesheet" href="./mlton.css" type="text/css">\r
</head>\r
<body class="article">\r
<div id="banner">\r
<div id="banner-home">\r
<a href="./Home">MLton 20180207</a>\r
</div>\r
</div>\r
<div id="header">\r
<h1>StandardMLGotchas</h1>\r
<div id="toc">
  <div id="toctitle">Table of Contents</div>
  <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
</div>\r
</div>\r
<div id="content">\r
<div id="preamble">\r
<div class="sectionbody">\r
<div class="paragraph"><p>This page contains brief explanations of some recurring sources of\r
confusion and problems that SML newbies encounter.</p></div>\r
<div class="paragraph"><p>Many confusions about the syntax of SML seem to arise from the use of\r
an interactive REPL (Read-Eval Print Loop) while trying to learn the\r
basics of the language.  While writing your first SML programs, you\r
should keep the source code of your programs in a form that is\r
accepted by an SML compiler as a whole.</p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<h2 id="_the_span_class_monospaced_and_span_keyword">The <span class="monospaced">and</span> keyword</h2>\r
<div class="sectionbody">\r
<div class="paragraph"><p>It is a common mistake to misuse the <span class="monospaced">and</span> keyword or to not know how\r
to introduce mutually recursive definitions.  The purpose of the <span class="monospaced">and</span>\r
keyword is to introduce mutually recursive definitions of functions\r
and datatypes.  For example,</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">fun</span><span class="w"> </span><span class="n">isEven</span><span class="w"> </span><span class="mi">0w0</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">true</span><span class="w"></span>\r
<span class="w">  </span><span class="p">|</span><span class="w"> </span><span class="n">isEven</span><span class="w"> </span><span class="mi">0w1</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">false</span><span class="w"></span>\r
<span class="w">  </span><span class="p">|</span><span class="w"> </span><span class="n">isEven</span><span class="w"> </span><span class="n">n</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">isOdd</span><span class="w"> </span><span class="p">(</span><span class="n">n-</span><span class="mi">0w1</span><span class="p">)</span><span class="w"></span>\r
<span class="k">and</span><span class="w"> </span><span class="n">isOdd</span><span class="w"> </span><span class="mi">0w0</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">false</span><span class="w"></span>\r
<span class="w">  </span><span class="p">|</span><span class="w"> </span><span class="n">isOdd</span><span class="w"> </span><span class="mi">0w1</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">true</span><span class="w"></span>\r
<span class="w">  </span><span class="p">|</span><span class="w"> </span><span class="n">isOdd</span><span class="w"> </span><span class="n">n</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">isEven</span><span class="w"> </span><span class="p">(</span><span class="n">n-</span><span class="mi">0w1</span><span class="p">)</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p>and</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">datatype</span><span class="w"> </span><span class="n">decl</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">VAL</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">id</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">pat</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">expr</span><span class="w"></span>\r
<span class="w">           </span><span class="cm">(* | ... *)</span><span class="w"></span>\r
<span class="w">     </span><span class="k">and</span><span class="w"> </span><span class="n">expr</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">LET</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">decl</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">expr</span><span class="w"></span>\r
<span class="w">           </span><span class="cm">(* | ... *)</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p>You can also use <span class="monospaced">and</span> as a shorthand in a couple of other places, but\r
it is not necessary.</p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<h2 id="_constructed_patterns">Constructed patterns</h2>\r
<div class="sectionbody">\r
<div class="paragraph"><p>It is a common mistake to forget to parenthesize constructed patterns\r
in <span class="monospaced">fun</span> bindings.  Consider the following invalid definition:</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">fun</span><span class="w"> </span><span class="n">length</span><span class="w"> </span><span class="n">nil</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="mi">0</span><span class="w"></span>\r
<span class="w">  </span><span class="p">|</span><span class="w"> </span><span class="n">length</span><span class="w"> </span><span class="n">h</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">=</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="n">+</span><span class="w"> </span><span class="n">length</span><span class="w"> </span><span class="n">t</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
The pattern `h \r
</dt>\r
<dd>\r
<p>\r
t` needs to be parenthesized:\r
</p>\r
</dd>\r
</dl></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">fun</span><span class="w"> </span><span class="n">length</span><span class="w"> </span><span class="n">nil</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="mi">0</span><span class="w"></span>\r
<span class="w">  </span><span class="p">|</span><span class="w"> </span><span class="n">length</span><span class="w"> </span><span class="p">(</span><span class="n">h</span><span class="w"> </span><span class="n">::</span><span class="w"> </span><span class="n">t</span><span class="p">)</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="n">+</span><span class="w"> </span><span class="n">length</span><span class="w"> </span><span class="n">t</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p>The parentheses are needed, because a <span class="monospaced">fun</span> definition may have\r
multiple consecutive constructed patterns through currying.</p></div>\r
<div class="paragraph"><p>The same applies to nonfix constructors.  For example, the parentheses\r
in</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">fun</span><span class="w"> </span><span class="n">valOf</span><span class="w"> </span><span class="n">NONE</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="k">raise</span><span class="w"> </span><span class="n">Option</span><span class="w"></span>\r
<span class="w">  </span><span class="p">|</span><span class="w"> </span><span class="n">valOf</span><span class="w"> </span><span class="p">(</span><span class="n">SOME</span><span class="w"> </span><span class="n">x</span><span class="p">)</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">x</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p>are required.  However, the outermost constructed pattern in a <span class="monospaced">fn</span> or\r
<span class="monospaced">case</span> expression need not be parenthesized, because in those cases\r
there is always just one constructed pattern.  So, both</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">val</span><span class="w"> </span><span class="n">valOf</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="k">fn</span><span class="w"> </span><span class="n">NONE</span><span class="w"> </span><span class="p">=&gt;</span><span class="w"> </span><span class="k">raise</span><span class="w"> </span><span class="n">Option</span><span class="w"></span>\r
<span class="w">             </span><span class="p">|</span><span class="w"> </span><span class="n">SOME</span><span class="w"> </span><span class="n">x</span><span class="w"> </span><span class="p">=&gt;</span><span class="w"> </span><span class="n">x</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p>and</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">fun</span><span class="w"> </span><span class="n">valOf</span><span class="w"> </span><span class="n">x</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="k">case</span><span class="w"> </span><span class="n">x</span><span class="w"> </span><span class="k">of</span><span class="w"></span>\r
<span class="w">                 </span><span class="n">NONE</span><span class="w"> </span><span class="p">=&gt;</span><span class="w"> </span><span class="k">raise</span><span class="w"> </span><span class="n">Option</span><span class="w"></span>\r
<span class="w">               </span><span class="p">|</span><span class="w"> </span><span class="n">SOME</span><span class="w"> </span><span class="n">x</span><span class="w"> </span><span class="p">=&gt;</span><span class="w"> </span><span class="n">x</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p>are fine.</p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<h2 id="_declarations_and_expressions">Declarations and expressions</h2>\r
<div class="sectionbody">\r
<div class="paragraph"><p>It is a common mistake to confuse expressions and declarations.\r
Normally an SML source file should only contain declarations.  The\r
following are declarations:</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">datatype</span><span class="w"> </span><span class="n">dt</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="p">...</span><span class="w"></span>\r
<span class="k">fun</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="p">...</span><span class="w"></span>\r
<span class="k">functor</span><span class="w"> </span><span class="n">Fn</span><span class="w"> </span><span class="p">(...)</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="p">...</span><span class="w"></span>\r
<span class="k">infix</span><span class="w"> </span><span class="p">...</span><span class="w"></span>\r
<span class="k">infixr</span><span class="w"> </span><span class="p">...</span><span class="w"></span>\r
<span class="k">local</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="k">end</span><span class="w"></span>\r
<span class="k">nonfix</span><span class="w"> </span><span class="p">...</span><span class="w"></span>\r
<span class="k">open</span><span class="w"> </span><span class="p">...</span><span class="w"></span>\r
<span class="k">signature</span><span class="w"> </span><span class="n">SIG</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="p">...</span><span class="w"></span>\r
<span class="k">structure</span><span class="w"> </span><span class="n">Struct</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="p">...</span><span class="w"></span>\r
<span class="k">type</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="p">...</span><span class="w"></span>\r
<span class="k">val</span><span class="w"> </span><span class="n">v</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="p">...</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p>Note that</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">let</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="k">end</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p>isn&#8217;t a declaration.</p></div>\r
<div class="paragraph"><p>To specify a side-effecting computation in a source file, you can write:</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">val</span><span class="w"> </span><span class="p">()</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="p">...</span><span class="w"></span>\r
</pre></div></div></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<h2 id="_equality_types">Equality types</h2>\r
<div class="sectionbody">\r
<div class="paragraph"><p>SML has a fairly intricate built-in notion of equality.  See\r
<a href="EqualityType">EqualityType</a> and <a href="EqualityTypeVariable">EqualityTypeVariable</a> for a thorough\r
discussion.</p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<h2 id="_nested_cases">Nested cases</h2>\r
<div class="sectionbody">\r
<div class="paragraph"><p>It is a common mistake to write nested case expressions without the\r
necessary parentheses.  See <a href="UnresolvedBugs">UnresolvedBugs</a> for a discussion.</p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<h2 id="_op">(op *)</h2>\r
<div class="sectionbody">\r
<div class="paragraph"><p>It used to be a common mistake to parenthesize <span class="monospaced">op *</span> as <span class="monospaced">(op *)</span>.\r
Before SML&#8217;97, <span class="monospaced">*)</span> was considered a comment terminator in SML and\r
caused a syntax error.  At the time of writing, <a href="SMLNJ">SML/NJ</a> still\r
rejects the code.  An extra space may be used for portability:\r
<span class="monospaced">(op * )</span>. However, parenthesizing <span class="monospaced">op</span> is redundant, even though it\r
is a widely used convention.</p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<h2 id="_overloading">Overloading</h2>\r
<div class="sectionbody">\r
<div class="paragraph"><p>A number of standard operators (<span class="monospaced">+</span>, <span class="monospaced">-</span>, <span class="monospaced">~</span>, <span class="monospaced">*</span>, <span class="monospaced">&lt;</span>, <span class="monospaced">&gt;</span>, &#8230;) and\r
numeric constants are overloaded for some of the numeric types (<span class="monospaced">int</span>,\r
<span class="monospaced">real</span>, <span class="monospaced">word</span>).  It is a common surprise that definitions using\r
overloaded operators such as</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">fun</span><span class="w"> </span><span class="n">min</span><span class="w"> </span><span class="p">(</span><span class="n">x</span><span class="p">,</span><span class="w"> </span><span class="n">y</span><span class="p">)</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">y</span><span class="w"> </span><span class="n">&lt;</span><span class="w"> </span><span class="n">x</span><span class="w"> </span><span class="k">then</span><span class="w"> </span><span class="n">y</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="n">x</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p>are not overloaded themselves.  SML doesn&#8217;t really support\r
(user-defined) overloading or other forms of ad hoc polymorphism.  In\r
cases such as the above where the context doesn&#8217;t resolve the\r
overloading, expressions using overloaded operators or constants get\r
assigned a default type.  The above definition gets the type</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">val</span><span class="w"> </span><span class="n">min</span><span class="w"> </span><span class="p">:</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">int</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">int</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p>See <a href="Overloading">Overloading</a> and <a href="TypeIndexedValues">TypeIndexedValues</a> for further discussion.</p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<h2 id="_semicolons">Semicolons</h2>\r
<div class="sectionbody">\r
<div class="paragraph"><p>It is a common mistake to use redundant semicolons in SML code.  This\r
is probably caused by the fact that in an SML REPL, a semicolon (and\r
enter) is used to signal the REPL that it should evaluate the\r
preceding chunk of code as a unit.  In SML source files, semicolons\r
are really needed in only two places.  Namely, in expressions of the\r
form</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="p">(</span><span class="n">exp</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="n">exp</span><span class="p">)</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p>and</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">let</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="n">exp</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="n">exp</span><span class="w"> </span><span class="k">end</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p>Note that semicolons act as expression (or declaration) separators\r
rather than as terminators.</p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<h2 id="_stale_bindings">Stale bindings</h2>\r
<div class="sectionbody">\r
<div class="paragraph"><p></p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<h2 id="_unresolved_records">Unresolved records</h2>\r
<div class="sectionbody">\r
<div class="paragraph"><p></p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<h2 id="_value_restriction">Value restriction</h2>\r
<div class="sectionbody">\r
<div class="paragraph"><p>See <a href="ValueRestriction">ValueRestriction</a>.</p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<h2 id="_type_variable_scope">Type Variable Scope</h2>\r
<div class="sectionbody">\r
<div class="paragraph"><p>See <a href="TypeVariableScope">TypeVariableScope</a>.</p></div>\r
</div>\r
</div>\r
</div>\r
<div id="footnotes"><hr></div>\r
<div id="footer">\r
<div id="footer-text">\r
</div>\r
<div id="footer-badges">\r
</div>\r
</div>\r
</body>\r
</html>\r