/usr/share/doc/mlton/guide/MLBasisAnnotations 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 | <!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>MLBasisAnnotations - 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%;">
MLBasisAnnotations
<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">
<a href="MLBasis">ML Basis</a> annotations control options that affect the elaboration of SML source files. Conceptually, a basis file is elaborated in a default annotation environment (just as it is elaborated in an empty basis). The declaration <tt>ann </tt><tt>"</tt><em>ann</em><tt>"</tt><tt> in </tt><em>basdec</em><tt> end</tt> merges the annotation <em>ann</em> with the "current" annotation environment for the elaboration of <em>basdec</em>. To allow for future expansion, <tt>"</tt><em>ann</em><tt>"</tt> is lexed as a single SML string constant. To conveniently specify multiple annotations, the following derived form is provided:
<div>
<table>
<tr>
<td>
<tt>ann </tt><tt>"</tt><em>ann</em><tt>"</tt><tt> </tt>(<tt>"</tt><em>ann</em><tt>"</tt>)+<tt> in </tt><em>basdec</em><tt> end</tt><tt> ==> </tt> <tt>ann </tt><tt>"</tt><em>ann</em><tt>"</tt><tt> in ann </tt>(<tt>"</tt><em>ann</em><tt>"</tt>)+<tt> in </tt><em>basdec</em><tt> end</tt><tt> end</tt></td>
</tr>
</table>
</div>
<p>
Here are the available annotations. In the explanation below, for annotations that take an argument, the first value listed is the default.
</p>
<ul>
<li>
<p>
<tt>allowFFI {false|true} </tt> <br>
If <tt>true</tt>, allow <tt>_address</tt>, <tt>_export</tt>, <tt>_import</tt>, and <tt>_symbol</tt> expressions to appear in source files. See <a href="ForeignFunctionInterface">ForeignFunctionInterface</a>.
</p>
</li>
<li class="gap">
<p>
<tt>forceUsed </tt> <br>
Force all identifiers in the basis denoted by the body of the <tt>ann</tt> to be considered used; use in conjunction with <tt>warnUnused true</tt>.
</p>
</li>
<li class="gap">
<p>
<tt>nonexhaustiveExnMatch {default|ignore} </tt> <br>
If <tt>ignore</tt>, suppress errors and warnings about nonexhaustive matches that arise solely from unmatched exceptions. If <tt>default</tt>, follow the behavior of <tt>nonexhaustiveMatch</tt>.
</p>
</li>
<li class="gap">
<p>
<tt>nonexhaustiveMatch {warn|error|ignore} </tt> <br>
If <tt>error</tt> or <tt>warn</tt>, report nonexhaustive matches. An error will abort a compile, while a warning will not.
</p>
</li>
<li class="gap">
<p>
<tt>redundantMatch {warn|error|ignore} </tt> <br>
If <tt>error</tt> or <tt>warn</tt>, report redundant matches. An error will abort a compile, while a warning will not.
</p>
</li>
<li class="gap">
<p>
<tt>sequenceNonUnit {ignore|error|warn} </tt> <br>
If <tt>error</tt> or <tt>warn</tt>, report when <tt>e1</tt> is not of type <tt>unit</tt> in the sequence expression <tt>(e1; e2)</tt>. This can be helpful in detecting curried applications that are mistakenly not fully applied. To silence spurious messages, you can use <tt>ignore e1</tt>.
</p>
</li>
<li class="gap">
<p>
<tt>warnUnused {false|true} </tt> <br>
Report unused identifiers.
</p>
</li>
</ul>
<h2 id="head-3f170caead65df254d786032a409a6f6d204bca6">Next Steps</h2>
<ul>
<li>
<p>
<a href="MLBasisAnnotationExamples">MLBasisAnnotationExamples</a>
</p>
</li>
<li>
<p>
<a href="WarnUnusedAnomalies">WarnUnusedAnomalies</a>
</p>
</li>
</ul>
</div>
<p>
<hr>
Last edited on 2010-06-01 20:12:20 by <span title="fenrir.cs.rit.edu"><a href="MatthewFluet">MatthewFluet</a></span>.
</body></html>
|