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

<!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>SyntacticConventions</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>SyntacticConventions</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>Here are a number of syntactic conventions useful for programming in\r
SML.</p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<h2 id="_general">General</h2>\r
<div class="sectionbody">\r
<div class="ulist"><ul>\r
<li>\r
<p>\r
A line of code never exceeds 80 columns.\r
</p>\r
</li>\r
<li>\r
<p>\r
Only split a syntactic entity across multiple lines if it doesn&#8217;t fit on one line within 80 columns.\r
</p>\r
</li>\r
<li>\r
<p>\r
Use alphabetical order wherever possible.\r
</p>\r
</li>\r
<li>\r
<p>\r
Avoid redundant parentheses.\r
</p>\r
</li>\r
<li>\r
<p>\r
When using <span class="monospaced">:</span>, there is no space before the colon, and a single space after it.\r
</p>\r
</li>\r
</ul></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<h2 id="_identifiers">Identifiers</h2>\r
<div class="sectionbody">\r
<div class="ulist"><ul>\r
<li>\r
<p>\r
Variables, record labels and type constructors begin with and use\r
small letters, using capital letters to separate words.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="n">cost</span><span class="w"></span>\r
<span class="n">maxValue</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
Variables that represent collections of objects (lists, arrays,\r
vectors, &#8230;) are often suffixed with an <span class="monospaced">s</span>.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="n">xs</span><span class="w"></span>\r
<span class="n">employees</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
Constructors, structure identifiers, and functor identifiers begin\r
with a capital letter.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="n">Queue</span><span class="w"></span>\r
<span class="n">LinkedList</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
Signature identifiers are in all capitals, using <span class="monospaced">_</span> to separate\r
words.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="n">LIST</span><span class="w"></span>\r
<span class="n">BINARY_HEAP</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
</ul></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<h2 id="_types">Types</h2>\r
<div class="sectionbody">\r
<div class="ulist"><ul>\r
<li>\r
<p>\r
Alphabetize record labels.  In a record type, there are spaces after\r
colons and commas, but not before colons or commas, or at the\r
delimiters <span class="monospaced">{</span> and <span class="monospaced">}</span>.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="p">{</span><span class="n">bar</span><span class="p">:</span><span class="w"> </span><span class="n">int</span><span class="p">,</span><span class="w"> </span><span class="n">foo</span><span class="p">:</span><span class="w"> </span><span class="n">int</span><span class="p">}</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
Only split a record type across multiple lines if it doesn&#8217;t fit on\r
one line. If a record type must be split over multiple lines, put one\r
field per line.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="p">{</span><span class="n">bar</span><span class="p">:</span><span class="w"> </span><span class="n">int</span><span class="p">,</span><span class="w"></span>\r
<span class="w"> </span><span class="n">foo</span><span class="p">:</span><span class="w"> </span><span class="n">real</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">real</span><span class="p">,</span><span class="w"></span>\r
<span class="w"> </span><span class="n">zoo</span><span class="p">:</span><span class="w"> </span><span class="n">bool</span><span class="p">}</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
In a tuple type, there are spaces before and after each <span class="monospaced">*</span>.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">bool</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">real</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
Only split a tuple type across multiple lines if it doesn&#8217;t fit on\r
one line.  In a tuple type split over multiple lines, there is one\r
type per line, and the <span class="monospaced">*</span>-s go at the beginning of the lines.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="n">int</span><span class="w"></span>\r
<span class="n">*</span><span class="w"> </span><span class="n">bool</span><span class="w"></span>\r
<span class="n">*</span><span class="w"> </span><span class="n">real</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p>It may also be useful to parenthesize to make the grouping more\r
apparent.</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="p">(</span><span class="n">int</span><span class="w"></span>\r
<span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">bool</span><span class="w"></span>\r
<span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">real</span><span class="p">)</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
In an arrow type split over multiple lines, put the arrow at the\r
beginning of its line.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">real</span><span class="w"></span>\r
<span class="p">-&gt;</span><span class="w"> </span><span class="n">bool</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p>It may also be useful to parenthesize to make the grouping more\r
apparent.</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="p">(</span><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">real</span><span class="w"></span>\r
<span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">bool</span><span class="p">)</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
Avoid redundant parentheses.\r
</p>\r
</li>\r
<li>\r
<p>\r
Arrow types associate to the right, so write\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="n">a</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">b</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">c</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p>not</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="n">a</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="p">(</span><span class="n">b</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">c</span><span class="p">)</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
Type constructor application associates to the left, so write\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="n">int</span><span class="w"> </span><span class="n">ref</span><span class="w"> </span><span class="n">list</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p>not</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="p">(</span><span class="n">int</span><span class="w"> </span><span class="n">ref</span><span class="p">)</span><span class="w"> </span><span class="n">list</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
Type constructor application binds more tightly than a tuple type,\r
so write\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="n">int</span><span class="w"> </span><span class="n">list</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">bool</span><span class="w"> </span><span class="n">list</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p>not</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="p">(</span><span class="n">int</span><span class="w"> </span><span class="n">list</span><span class="p">)</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="p">(</span><span class="n">bool</span><span class="w"> </span><span class="n">list</span><span class="p">)</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
Tuple types bind more tightly than arrow types, so write\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">bool</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">real</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p>not</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="p">(</span><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">bool</span><span class="p">)</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">real</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
</ul></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<h2 id="_core">Core</h2>\r
<div class="sectionbody">\r
<div class="ulist"><ul>\r
<li>\r
<p>\r
A core expression or declaration split over multiple lines does not\r
contain any blank lines.\r
</p>\r
</li>\r
<li>\r
<p>\r
A record field selector has no space between the <span class="monospaced">#</span> and the record\r
label.  So, write\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="p">#</span><span class="n">foo</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p>not</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="p">#</span><span class="w"> </span><span class="n">foo</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
A tuple has a space after each comma, but not before, and not at the\r
delimiters <span class="monospaced">(</span> and <span class="monospaced">)</span>.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="p">(</span><span class="n">e1</span><span class="p">,</span><span class="w"> </span><span class="n">e2</span><span class="p">,</span><span class="w"> </span><span class="n">e3</span><span class="p">)</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
A tuple split over multiple lines has one element per line, and the\r
commas go at the end of the lines.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="p">(</span><span class="n">e1</span><span class="p">,</span><span class="w"></span>\r
<span class="w"> </span><span class="n">e2</span><span class="p">,</span><span class="w"></span>\r
<span class="w"> </span><span class="n">e3</span><span class="p">)</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
A list has a space after each comma, but not before, and not at the\r
delimiters <span class="monospaced">[</span> and <span class="monospaced">]</span>.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="p">[</span><span class="n">e1</span><span class="p">,</span><span class="w"> </span><span class="n">e2</span><span class="p">,</span><span class="w"> </span><span class="n">e3</span><span class="p">]</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
A list split over multiple lines has one element per line, and the\r
commas at the end of the lines.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="p">[</span><span class="n">e1</span><span class="p">,</span><span class="w"></span>\r
<span class="w"> </span><span class="n">e2</span><span class="p">,</span><span class="w"></span>\r
<span class="w"> </span><span class="n">e3</span><span class="p">]</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
A record has spaces before and after <span class="monospaced">=</span>, a space after each comma,\r
but not before, and not at the delimiters <span class="monospaced">{</span> and <span class="monospaced">}</span>.  Field names\r
appear in alphabetical order.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="p">{</span><span class="n">bar</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="mi">13</span><span class="p">,</span><span class="w"> </span><span class="n">foo</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">true</span><span class="p">}</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
A sequence expression has a space after each semicolon, but not before.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="p">(</span><span class="n">e1</span><span class="p">;</span><span class="w"> </span><span class="n">e2</span><span class="p">;</span><span class="w"> </span><span class="n">e3</span><span class="p">)</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
A sequence expression split over multiple lines has one expression\r
per line, and the semicolons at the beginning of lines.  Lisp and\r
Scheme programmers may find this hard to read at first.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="p">(</span><span class="n">e1</span><span class="w"></span>\r
<span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="n">e2</span><span class="w"></span>\r
<span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="n">e3</span><span class="p">)</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p><em>Rationale</em>: this makes it easy to visually spot the beginning of each\r
expression, which becomes more valuable as the expressions themselves\r
are split across multiple lines.</p></div>\r
</li>\r
<li>\r
<p>\r
An application expression has a space between the function and the\r
argument.  There are no parens unless the argument is a tuple (in\r
which case the parens are really part of the tuple, not the\r
application).\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="n">f</span><span class="w"> </span><span class="n">a</span><span class="w"></span>\r
<span class="n">f</span><span class="w"> </span><span class="p">(</span><span class="n">a1</span><span class="p">,</span><span class="w"> </span><span class="n">a2</span><span class="p">,</span><span class="w"> </span><span class="n">a3</span><span class="p">)</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
Avoid redundant parentheses.  Application associates to left, so\r
write\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="n">f</span><span class="w"> </span><span class="n">a1</span><span class="w"> </span><span class="n">a2</span><span class="w"> </span><span class="n">a3</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p>not</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="p">((</span><span class="n">f</span><span class="w"> </span><span class="n">a1</span><span class="p">)</span><span class="w"> </span><span class="n">a2</span><span class="p">)</span><span class="w"> </span><span class="n">a3</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
Infix operators have a space before and after the operator.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="n">x</span><span class="w"> </span><span class="n">+</span><span class="w"> </span><span class="n">y</span><span class="w"></span>\r
<span class="n">x</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">y</span><span class="w"> </span><span class="n">-</span><span class="w"> </span><span class="n">z</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
Avoid redundant parentheses.  Use <a href="OperatorPrecedence">OperatorPrecedence</a>.  So, write\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="n">x</span><span class="w"> </span><span class="n">+</span><span class="w"> </span><span class="n">y</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">z</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p>not</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="n">x</span><span class="w"> </span><span class="n">+</span><span class="w"> </span><span class="p">(</span><span class="n">y</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">z</span><span class="p">)</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
An <span class="monospaced">andalso</span> expression split over multiple lines has the <span class="monospaced">andalso</span>\r
at the beginning of subsequent lines.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="n">e1</span><span class="w"></span>\r
<span class="k">andalso</span><span class="w"> </span><span class="n">e2</span><span class="w"></span>\r
<span class="k">andalso</span><span class="w"> </span><span class="n">e3</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
A <span class="monospaced">case</span> expression is indented as follows\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">case</span><span class="w"> </span><span class="n">e1</span><span class="w"> </span><span class="k">of</span><span class="w"></span>\r
<span class="w">   </span><span class="n">p1</span><span class="w"> </span><span class="p">=&gt;</span><span class="w"> </span><span class="n">e1</span><span class="w"></span>\r
<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">p2</span><span class="w"> </span><span class="p">=&gt;</span><span class="w"> </span><span class="n">e2</span><span class="w"></span>\r
<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">p3</span><span class="w"> </span><span class="p">=&gt;</span><span class="w"> </span><span class="n">e3</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
A <span class="monospaced">datatype</span>'s constructors are alphabetized.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">datatype</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">A</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">B</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">C</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
A <span class="monospaced">datatype</span> declaration has a space before and after each <span class="monospaced">|</span>.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">datatype</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">A</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">B</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">C</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
A <span class="monospaced">datatype</span> split over multiple lines has one constructor per line,\r
with the <span class="monospaced">|</span> at the beginning of lines and the constructors beginning\r
3 columns to the right of the <span class="monospaced">datatype</span>.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">datatype</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="p">=</span><span class="w"></span>\r
<span class="w">   </span><span class="n">A</span><span class="w"></span>\r
<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">B</span><span class="w"></span>\r
<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">C</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
A <span class="monospaced">fun</span> declaration may start its body on the subsequent line,\r
indented 3 spaces.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">fun</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="n">x</span><span class="w"> </span><span class="n">y</span><span class="w"> </span><span class="p">=</span><span class="w"></span>\r
<span class="w">   </span><span class="k">let</span><span class="w"></span>\r
<span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">z</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">x</span><span class="w"> </span><span class="n">+</span><span class="w"> </span><span class="n">y</span><span class="w"> </span><span class="n">+</span><span class="w"> </span><span class="n">z</span><span class="w"></span>\r
<span class="w">   </span><span class="k">in</span><span class="w"></span>\r
<span class="w">      </span><span class="n">z</span><span class="w"></span>\r
<span class="w">   </span><span class="k">end</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
An <span class="monospaced">if</span> expression is indented as follows.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">if</span><span class="w"> </span><span class="n">e1</span><span class="w"></span>\r
<span class="w">   </span><span class="k">then</span><span class="w"> </span><span class="n">e2</span><span class="w"></span>\r
<span class="k">else</span><span class="w"> </span><span class="n">e3</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
A sequence of <span class="monospaced">if</span>-<span class="monospaced">then</span>-<span class="monospaced">else</span>-s is indented as follows.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">if</span><span class="w"> </span><span class="n">e1</span><span class="w"></span>\r
<span class="w">   </span><span class="k">then</span><span class="w"> </span><span class="n">e2</span><span class="w"></span>\r
<span class="k">else</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">e3</span><span class="w"></span>\r
<span class="w">   </span><span class="k">then</span><span class="w"> </span><span class="n">e4</span><span class="w"></span>\r
<span class="k">else</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">e5</span><span class="w"></span>\r
<span class="w">   </span><span class="k">then</span><span class="w"> </span><span class="n">e6</span><span class="w"></span>\r
<span class="k">else</span><span class="w"> </span><span class="n">e7</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
A <span class="monospaced">let</span> expression has the <span class="monospaced">let</span>, <span class="monospaced">in</span>, and <span class="monospaced">end</span> on their own\r
lines, starting in the same column.  Declarations and the body are\r
indented 3 spaces.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">let</span><span class="w"></span>\r
<span class="w">   </span><span class="k">val</span><span class="w"> </span><span class="n">x</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="mi">13</span><span class="w"></span>\r
<span class="w">   </span><span class="k">val</span><span class="w"> </span><span class="n">y</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="mi">14</span><span class="w"></span>\r
<span class="k">in</span><span class="w"></span>\r
<span class="w">   </span><span class="n">x</span><span class="w"> </span><span class="n">+</span><span class="w"> </span><span class="n">y</span><span class="w"></span>\r
<span class="k">end</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
A <span class="monospaced">local</span> declaration has the <span class="monospaced">local</span>, <span class="monospaced">in</span>, and <span class="monospaced">end</span> on their own\r
lines, starting in the same column.  Declarations are indented 3\r
spaces.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">local</span><span class="w"></span>\r
<span class="w">   </span><span class="k">val</span><span class="w"> </span><span class="n">x</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="mi">13</span><span class="w"></span>\r
<span class="k">in</span><span class="w"></span>\r
<span class="w">   </span><span class="k">val</span><span class="w"> </span><span class="n">y</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">x</span><span class="w"></span>\r
<span class="k">end</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
An <span class="monospaced">orelse</span> expression split over multiple lines has the <span class="monospaced">orelse</span> at\r
the beginning of subsequent lines.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="n">e1</span><span class="w"></span>\r
<span class="k">orelse</span><span class="w"> </span><span class="n">e2</span><span class="w"></span>\r
<span class="k">orelse</span><span class="w"> </span><span class="n">e3</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
A <span class="monospaced">val</span> declaration has a space before and after the <span class="monospaced">=</span>.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">val</span><span class="w"> </span><span class="n">p</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">e</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
A <span class="monospaced">val</span> declaration can start the expression on the subsequent line,\r
indented 3 spaces.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">val</span><span class="w"> </span><span class="n">p</span><span class="w"> </span><span class="p">=</span><span class="w"></span>\r
<span class="w">   </span><span class="k">if</span><span class="w"> </span><span class="n">e1</span><span class="w"> </span><span class="k">then</span><span class="w"> </span><span class="n">e2</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="n">e3</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
</ul></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<h2 id="_signatures">Signatures</h2>\r
<div class="sectionbody">\r
<div class="ulist"><ul>\r
<li>\r
<p>\r
A <span class="monospaced">signature</span> declaration is indented as follows.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">signature</span><span class="w"> </span><span class="n">FOO</span><span class="w"> </span><span class="p">=</span><span class="w"></span>\r
<span class="w">   </span><span class="k">sig</span><span class="w"></span>\r
<span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">x</span><span class="p">:</span><span class="w"> </span><span class="n">int</span><span class="w"></span>\r
<span class="w">   </span><span class="k">end</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p><em>Exception</em>: a signature declaration in a file to itself can omit the\r
indentation to save horizontal space.</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">signature</span><span class="w"> </span><span class="n">FOO</span><span class="w"> </span><span class="p">=</span><span class="w"></span>\r
<span class="k">sig</span><span class="w"></span>\r
\r
<span class="k">val</span><span class="w"> </span><span class="n">x</span><span class="p">:</span><span class="w"> </span><span class="n">int</span><span class="w"></span>\r
\r
<span class="k">end</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p>In this case, there should be a blank line after the <span class="monospaced">sig</span> and before\r
the <span class="monospaced">end</span>.</p></div>\r
</li>\r
<li>\r
<p>\r
A <span class="monospaced">val</span> specification has a space after the colon, but not before.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">val</span><span class="w"> </span><span class="n">x</span><span class="p">:</span><span class="w"> </span><span class="n">int</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p><em>Exception</em>: in the case of operators (like <span class="monospaced">+</span>), there is a space\r
before the colon to avoid lexing the colon as part of the operator.</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">+</span><span class="w"> </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">t</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
Alphabetize specifications in signatures.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">sig</span><span class="w"></span>\r
<span class="w">   </span><span class="k">val</span><span class="w"> </span><span class="n">x</span><span class="p">:</span><span class="w"> </span><span class="n">int</span><span class="w"></span>\r
<span class="w">   </span><span class="k">val</span><span class="w"> </span><span class="n">y</span><span class="p">:</span><span class="w"> </span><span class="n">bool</span><span class="w"></span>\r
<span class="k">end</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
</ul></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<h2 id="_structures">Structures</h2>\r
<div class="sectionbody">\r
<div class="ulist"><ul>\r
<li>\r
<p>\r
A <span class="monospaced">structure</span> declaration has a space on both sides of the <span class="monospaced">=</span>.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">structure</span><span class="w"> </span><span class="n">Foo</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">Bar</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
<li>\r
<p>\r
A <span class="monospaced">structure</span> declaration split over multiple lines is indented as\r
follows.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">structure</span><span class="w"> </span><span class="n">S</span><span class="w"> </span><span class="p">=</span><span class="w"></span>\r
<span class="w">   </span><span class="k">struct</span><span class="w"></span>\r
<span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">x</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="mi">13</span><span class="w"></span>\r
<span class="w">   </span><span class="k">end</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p><em>Exception</em>: a structure declaration in a file to itself can omit the\r
indentation to save horizontal space.</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">structure</span><span class="w"> </span><span class="n">S</span><span class="w"> </span><span class="p">=</span><span class="w"></span>\r
<span class="k">struct</span><span class="w"></span>\r
\r
<span class="k">val</span><span class="w"> </span><span class="n">x</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="mi">13</span><span class="w"></span>\r
\r
<span class="k">end</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p>In this case, there should be a blank line after the <span class="monospaced">struct</span> and\r
before the <span class="monospaced">end</span>.</p></div>\r
</li>\r
<li>\r
<p>\r
Declarations in a <span class="monospaced">struct</span> are separated by blank lines.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">struct</span><span class="w"></span>\r
<span class="w">   </span><span class="k">val</span><span class="w"> </span><span class="n">x</span><span class="w"> </span><span class="p">=</span><span class="w"></span>\r
<span class="w">      </span><span class="k">let</span><span class="w"></span>\r
<span class="w">         </span><span class="n">y</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="mi">13</span><span class="w"></span>\r
<span class="w">      </span><span class="k">in</span><span class="w"></span>\r
<span class="w">         </span><span class="n">y</span><span class="w"> </span><span class="n">+</span><span class="w"> </span><span class="mi">1</span><span class="w"></span>\r
<span class="w">      </span><span class="k">end</span><span class="w"></span>\r
\r
<span class="w">   </span><span class="k">val</span><span class="w"> </span><span class="n">z</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="mi">14</span><span class="w"></span>\r
<span class="k">end</span><span class="w"></span>\r
</pre></div></div></div>\r
</li>\r
</ul></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<h2 id="_functors">Functors</h2>\r
<div class="sectionbody">\r
<div class="ulist"><ul>\r
<li>\r
<p>\r
A <span class="monospaced">functor</span> declaration has spaces after each <span class="monospaced">:</span> (or <span class="monospaced">:&gt;</span>) but not\r
before, and a space before and after the <span class="monospaced">=</span>.  It is indented as\r
follows.\r
</p>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">functor</span><span class="w"> </span><span class="n">Foo</span><span class="w"> </span><span class="p">(</span><span class="n">S</span><span class="p">:</span><span class="w"> </span><span class="n">FOO_ARG</span><span class="p">):</span><span class="w"> </span><span class="n">FOO</span><span class="w"> </span><span class="p">=</span><span class="w"></span>\r
<span class="w">   </span><span class="k">struct</span><span class="w"></span>\r
<span class="w">       </span><span class="k">val</span><span class="w"> </span><span class="n">x</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">S</span><span class="p">.</span><span class="n">x</span><span class="w"></span>\r
<span class="w">   </span><span class="k">end</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p><em>Exception</em>: a functor declaration in a file to itself can omit the\r
indentation to save horizontal space.</p></div>\r
<div class="listingblock">\r
<div class="content"><div class="highlight"><pre><span class="k">functor</span><span class="w"> </span><span class="n">Foo</span><span class="w"> </span><span class="p">(</span><span class="n">S</span><span class="p">:</span><span class="w"> </span><span class="n">FOO_ARG</span><span class="p">):</span><span class="w"> </span><span class="n">FOO</span><span class="w"> </span><span class="p">=</span><span class="w"></span>\r
<span class="k">struct</span><span class="w"></span>\r
\r
<span class="k">val</span><span class="w"> </span><span class="n">x</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">S</span><span class="p">.</span><span class="n">x</span><span class="w"></span>\r
\r
<span class="k">end</span><span class="w"></span>\r
</pre></div></div></div>\r
<div class="paragraph"><p>In this case, there should be a blank line after the <span class="monospaced">struct</span>\r
and before the <span class="monospaced">end</span>.</p></div>\r
</li>\r
</ul></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