docs/users_guide/glasgow_exts.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <para>
   3 <indexterm><primary>language, GHC</primary></indexterm>
   4 <indexterm><primary>extensions, GHC</primary></indexterm>
   5 As with all known Haskell systems, GHC implements some extensions to
   6 the language.  They can all be enabled or disabled by commandline flags
   7 or language pragmas. By default GHC understands the most recent Haskell
   8 version it supports, plus a handful of extensions.
   9 </para>
  10
  11 <para>
  12 Some of the Glasgow extensions serve to give you access to the
  13 underlying facilities with which we implement Haskell.  Thus, you can
  14 get at the Raw Iron, if you are willing to write some non-portable
  15 code at a more primitive level.  You need not be &ldquo;stuck&rdquo;
  16 on performance because of the implementation costs of Haskell's
  17 &ldquo;high-level&rdquo; features&mdash;you can always code
  18 &ldquo;under&rdquo; them.  In an extreme case, you can write all your
  19 time-critical code in C, and then just glue it together with Haskell!
  20 </para>
  21
  22 <para>
  23 Before you get too carried away working at the lowest level (e.g.,
  24 sloshing <literal>MutableByteArray&num;</literal>s around your
  25 program), you may wish to check if there are libraries that provide a
  26 &ldquo;Haskellised veneer&rdquo; over the features you want.  The
  27 separate <ulink url="../libraries/index.html">libraries
  28 documentation</ulink> describes all the libraries that come with GHC.
  29 </para>
  30
  31 <!-- LANGUAGE OPTIONS -->
  32   <sect1 id="options-language">
  33     <title>Language options</title>
  34
  35     <indexterm><primary>language</primary><secondary>option</secondary>
  36     </indexterm>
  37     <indexterm><primary>options</primary><secondary>language</secondary>
  38     </indexterm>
  39     <indexterm><primary>extensions</primary><secondary>options controlling</secondary>
  40     </indexterm>
  41
  42     <para>The language option flags control what variation of the language are
  43     permitted.</para>
  44
  45     <para>Language options can be controlled in two ways:
  46     <itemizedlist>
  47       <listitem><para>Every language option can switched on by a command-line flag "<option>-X...</option>"
  48         (e.g. <option>-XTemplateHaskell</option>), and switched off by the flag "<option>-XNo...</option>";
  49         (e.g. <option>-XNoTemplateHaskell</option>).</para></listitem>
  50       <listitem><para>
  51           Language options recognised by Cabal can also be enabled using the <literal>LANGUAGE</literal> pragma,
  52           thus <literal>{-# LANGUAGE TemplateHaskell #-}</literal> (see <xref linkend="language-pragma"/>). </para>
  53           </listitem>
  54       </itemizedlist></para>
  55
  56     <para>The flag <option>-fglasgow-exts</option>
  57           <indexterm><primary><option>-fglasgow-exts</option></primary></indexterm>
  58           is equivalent to enabling the following extensions:
  59           &what_glasgow_exts_does;
  60             Enabling these options is the <emphasis>only</emphasis>
  61             effect of <option>-fglasgow-exts</option>.
  62           We are trying to move away from this portmanteau flag,
  63           and towards enabling features individually.</para>
  64
  65   </sect1>
  66
  67 <!-- UNBOXED TYPES AND PRIMITIVE OPERATIONS -->
  68 <sect1 id="primitives">
  69   <title>Unboxed types and primitive operations</title>
  70
  71 <para>GHC is built on a raft of primitive data types and operations;
  72 "primitive" in the sense that they cannot be defined in Haskell itself.
  73 While you really can use this stuff to write fast code,
  74   we generally find it a lot less painful, and more satisfying in the
  75   long run, to use higher-level language features and libraries.  With
  76   any luck, the code you write will be optimised to the efficient
  77   unboxed version in any case.  And if it isn't, we'd like to know
  78   about it.</para>
  79
  80 <para>All these primitive data types and operations are exported by the
  81 library <literal>GHC.Prim</literal>, for which there is
  82 <ulink url="&libraryGhcPrimLocation;/GHC-Prim.html">detailed online documentation</ulink>.
  83 (This documentation is generated from the file <filename>compiler/prelude/primops.txt.pp</filename>.)
  84 </para>
  85 <para>
  86 If you want to mention any of the primitive data types or operations in your
  87 program, you must first import <literal>GHC.Prim</literal> to bring them
  88 into scope.  Many of them have names ending in "&num;", and to mention such
  89 names you need the <option>-XMagicHash</option> extension (<xref linkend="magic-hash"/>).
  90 </para>
  91
  92 <para>The primops make extensive use of <link linkend="glasgow-unboxed">unboxed types</link>
  93 and <link linkend="unboxed-tuples">unboxed tuples</link>, which
  94 we briefly summarise here. </para>
  95
  96 <sect2 id="glasgow-unboxed">
  97 <title>Unboxed types
  98 </title>
  99
 100 <para>
 101 <indexterm><primary>Unboxed types (Glasgow extension)</primary></indexterm>
 102 </para>
 103
 104 <para>Most types in GHC are <firstterm>boxed</firstterm>, which means
 105 that values of that type are represented by a pointer to a heap
 106 object.  The representation of a Haskell <literal>Int</literal>, for
 107 example, is a two-word heap object.  An <firstterm>unboxed</firstterm>
 108 type, however, is represented by the value itself, no pointers or heap
 109 allocation are involved.
 110 </para>
 111
 112 <para>
 113 Unboxed types correspond to the &ldquo;raw machine&rdquo; types you
 114 would use in C: <literal>Int&num;</literal> (long int),
 115 <literal>Double&num;</literal> (double), <literal>Addr&num;</literal>
 116 (void *), etc.  The <emphasis>primitive operations</emphasis>
 117 (PrimOps) on these types are what you might expect; e.g.,
 118 <literal>(+&num;)</literal> is addition on
 119 <literal>Int&num;</literal>s, and is the machine-addition that we all
 120 know and love&mdash;usually one instruction.
 121 </para>
 122
 123 <para>
 124 Primitive (unboxed) types cannot be defined in Haskell, and are
 125 therefore built into the language and compiler.  Primitive types are
 126 always unlifted; that is, a value of a primitive type cannot be
 127 bottom.  We use the convention (but it is only a convention)
 128 that primitive types, values, and
 129 operations have a <literal>&num;</literal> suffix (see <xref linkend="magic-hash"/>).
 130 For some primitive types we have special syntax for literals, also
 131 described in the <link linkend="magic-hash">same section</link>.
 132 </para>
 133
 134 <para>
 135 Primitive values are often represented by a simple bit-pattern, such
 136 as <literal>Int&num;</literal>, <literal>Float&num;</literal>,
 137 <literal>Double&num;</literal>.  But this is not necessarily the case:
 138 a primitive value might be represented by a pointer to a
 139 heap-allocated object.  Examples include
 140 <literal>Array&num;</literal>, the type of primitive arrays.  A
 141 primitive array is heap-allocated because it is too big a value to fit
 142 in a register, and would be too expensive to copy around; in a sense,
 143 it is accidental that it is represented by a pointer.  If a pointer
 144 represents a primitive value, then it really does point to that value:
 145 no unevaluated thunks, no indirections&hellip;nothing can be at the
 146 other end of the pointer than the primitive value.
 147 A numerically-intensive program using unboxed types can
 148 go a <emphasis>lot</emphasis> faster than its &ldquo;standard&rdquo;
 149 counterpart&mdash;we saw a threefold speedup on one example.
 150 </para>
 151
 152 <para>
 153 There are some restrictions on the use of primitive types:
 154 <itemizedlist>
 155 <listitem><para>The main restriction
 156 is that you can't pass a primitive value to a polymorphic
 157 function or store one in a polymorphic data type.  This rules out
 158 things like <literal>[Int&num;]</literal> (i.e. lists of primitive
 159 integers).  The reason for this restriction is that polymorphic
 160 arguments and constructor fields are assumed to be pointers: if an
 161 unboxed integer is stored in one of these, the garbage collector would
 162 attempt to follow it, leading to unpredictable space leaks.  Or a
 163 <function>seq</function> operation on the polymorphic component may
 164 attempt to dereference the pointer, with disastrous results.  Even
 165 worse, the unboxed value might be larger than a pointer
 166 (<literal>Double&num;</literal> for instance).
 167 </para>
 168 </listitem>
 169 <listitem><para> You cannot define a newtype whose representation type
 170 (the argument type of the data constructor) is an unboxed type.  Thus,
 171 this is illegal:
 172 <programlisting>
 173   newtype A = MkA Int#
 174 </programlisting>
 175 </para></listitem>
 176 <listitem><para> You cannot bind a variable with an unboxed type
 177 in a <emphasis>top-level</emphasis> binding.
 178 </para></listitem>
 179 <listitem><para> You cannot bind a variable with an unboxed type
 180 in a <emphasis>recursive</emphasis> binding.
 181 </para></listitem>
 182 <listitem><para> You may bind unboxed variables in a (non-recursive,
 183 non-top-level) pattern binding, but you must make any such pattern-match
 184 strict.  For example, rather than:
 185 <programlisting>
 186   data Foo = Foo Int Int#
 187
 188   f x = let (Foo a b, w) = ..rhs.. in ..body..
 189 </programlisting>
 190 you must write:
 191 <programlisting>
 192   data Foo = Foo Int Int#
 193
 194   f x = let !(Foo a b, w) = ..rhs.. in ..body..
 195 </programlisting>
 196 since <literal>b</literal> has type <literal>Int#</literal>.
 197 </para>
 198 </listitem>
 199 </itemizedlist>
 200 </para>
 201
 202 </sect2>
 203
 204 <sect2 id="unboxed-tuples">
 205 <title>Unboxed Tuples
 206 </title>
 207
 208 <para>
 209 Unboxed tuples aren't really exported by <literal>GHC.Exts</literal>,
 210 they're available by default with <option>-fglasgow-exts</option>.  An
 211 unboxed tuple looks like this:
 212 </para>
 213
 214 <para>
 215
 216 <programlisting>
 217 (# e_1, ..., e_n #)
 218 </programlisting>
 219
 220 </para>
 221
 222 <para>
 223 where <literal>e&lowbar;1..e&lowbar;n</literal> are expressions of any
 224 type (primitive or non-primitive).  The type of an unboxed tuple looks
 225 the same.
 226 </para>
 227
 228 <para>
 229 Unboxed tuples are used for functions that need to return multiple
 230 values, but they avoid the heap allocation normally associated with
 231 using fully-fledged tuples.  When an unboxed tuple is returned, the
 232 components are put directly into registers or on the stack; the
 233 unboxed tuple itself does not have a composite representation.  Many
 234 of the primitive operations listed in <literal>primops.txt.pp</literal> return unboxed
 235 tuples.
 236 In particular, the <literal>IO</literal> and <literal>ST</literal> monads use unboxed
 237 tuples to avoid unnecessary allocation during sequences of operations.
 238 </para>
 239
 240 <para>
 241 There are some pretty stringent restrictions on the use of unboxed tuples:
 242 <itemizedlist>
 243 <listitem>
 244
 245 <para>
 246 Values of unboxed tuple types are subject to the same restrictions as
 247 other unboxed types; i.e. they may not be stored in polymorphic data
 248 structures or passed to polymorphic functions.
 249
 250 </para>
 251 </listitem>
 252 <listitem>
 253
 254 <para>
 255 No variable can have an unboxed tuple type, nor may a constructor or function
 256 argument have an unboxed tuple type.  The following are all illegal:
 257
 258
 259 <programlisting>
 260   data Foo = Foo (# Int, Int #)
 261
 262   f :: (# Int, Int #) -&#62; (# Int, Int #)
 263   f x = x
 264
 265   g :: (# Int, Int #) -&#62; Int
 266   g (# a,b #) = a
 267
 268   h x = let y = (# x,x #) in ...
 269 </programlisting>
 270 </para>
 271 </listitem>
 272 </itemizedlist>
 273 </para>
 274 <para>
 275 The typical use of unboxed tuples is simply to return multiple values,
 276 binding those multiple results with a <literal>case</literal> expression, thus:
 277 <programlisting>
 278   f x y = (# x+1, y-1 #)
 279   g x = case f x x of { (# a, b #) -&#62; a + b }
 280 </programlisting>
 281 You can have an unboxed tuple in a pattern binding, thus
 282 <programlisting>
 283   f x = let (# p,q #) = h x in ..body..
 284 </programlisting>
 285 If the types of <literal>p</literal> and <literal>q</literal> are not unboxed,
 286 the resulting binding is lazy like any other Haskell pattern binding.  The
 287 above example desugars like this:
 288 <programlisting>
 289   f x = let t = case h x o f{ (# p,q #) -> (p,q)
 290             p = fst t
 291             q = snd t
 292         in ..body..
 293 </programlisting>
 294 Indeed, the bindings can even be recursive.
 295 </para>
 296
 297 </sect2>
 298 </sect1>
 299
 300
 301 <!-- ====================== SYNTACTIC EXTENSIONS =======================  -->
 302
 303 <sect1 id="syntax-extns">
 304 <title>Syntactic extensions</title>
 305
 306     <sect2 id="unicode-syntax">
 307       <title>Unicode syntax</title>
 308       <para>The language
 309       extension <option>-XUnicodeSyntax</option><indexterm><primary><option>-XUnicodeSyntax</option></primary></indexterm>
 310       enables Unicode characters to be used to stand for certain ASCII
 311       character sequences.  The following alternatives are provided:</para>
 312
 313       <informaltable>
 314         <tgroup cols="2" align="left" colsep="1" rowsep="1">
 315           <thead>
 316             <row>
 317               <entry>ASCII</entry>
 318               <entry>Unicode alternative</entry>
 319               <entry>Code point</entry>
 320               <entry>Name</entry>
 321             </row>
 322           </thead>
 323
 324 <!--
 325                to find the DocBook entities for these characters, find
 326                the Unicode code point (e.g. 0x2237), and grep for it in
 327                /usr/share/sgml/docbook/xml-dtd-*/ent/* (or equivalent on
 328                your system.  Some of these Unicode code points don't have
 329                equivalent DocBook entities.
 330             -->
 331
 332           <tbody>
 333             <row>
 334               <entry><literal>::</literal></entry>
 335               <entry>::</entry> <!-- no special char, apparently -->
 336               <entry>0x2237</entry>
 337               <entry>PROPORTION</entry>
 338             </row>
 339           </tbody>
 340           <tbody>
 341             <row>
 342               <entry><literal>=&gt;</literal></entry>
 343               <entry>&rArr;</entry>
 344               <entry>0x21D2</entry>
 345               <entry>RIGHTWARDS DOUBLE ARROW</entry>
 346             </row>
 347           </tbody>
 348           <tbody>
 349             <row>
 350               <entry><literal>forall</literal></entry>
 351               <entry>&forall;</entry>
 352               <entry>0x2200</entry>
 353               <entry>FOR ALL</entry>
 354             </row>
 355           </tbody>
 356           <tbody>
 357             <row>
 358               <entry><literal>-&gt;</literal></entry>
 359               <entry>&rarr;</entry>
 360               <entry>0x2192</entry>
 361               <entry>RIGHTWARDS ARROW</entry>
 362             </row>
 363           </tbody>
 364           <tbody>
 365             <row>
 366               <entry><literal>&lt;-</literal></entry>
 367               <entry>&larr;</entry>
 368               <entry>0x2190</entry>
 369               <entry>LEFTWARDS ARROW</entry>
 370             </row>
 371           </tbody>
 372
 373           <tbody>
 374             <row>
 375               <entry>-&lt;</entry>
 376               <entry>&larrtl;</entry>
 377               <entry>0x2919</entry>
 378               <entry>LEFTWARDS ARROW-TAIL</entry>
 379             </row>
 380           </tbody>
 381
 382           <tbody>
 383             <row>
 384               <entry>&gt;-</entry>
 385               <entry>&rarrtl;</entry>
 386               <entry>0x291A</entry>
 387               <entry>RIGHTWARDS ARROW-TAIL</entry>
 388             </row>
 389           </tbody>
 390
 391           <tbody>
 392             <row>
 393               <entry>-&lt;&lt;</entry>
 394               <entry></entry>
 395               <entry>0x291B</entry>
 396               <entry>LEFTWARDS DOUBLE ARROW-TAIL</entry>
 397             </row>
 398           </tbody>
 399
 400           <tbody>
 401             <row>
 402               <entry>&gt;&gt;-</entry>
 403               <entry></entry>
 404               <entry>0x291C</entry>
 405               <entry>RIGHTWARDS DOUBLE ARROW-TAIL</entry>
 406             </row>
 407           </tbody>
 408
 409           <tbody>
 410             <row>
 411               <entry>*</entry>
 412               <entry>&starf;</entry>
 413               <entry>0x2605</entry>
 414               <entry>BLACK STAR</entry>
 415             </row>
 416           </tbody>
 417
 418         </tgroup>
 419       </informaltable>
 420     </sect2>
 421
 422     <sect2 id="magic-hash">
 423       <title>The magic hash</title>
 424       <para>The language extension <option>-XMagicHash</option> allows "&num;" as a
 425         postfix modifier to identifiers.  Thus, "x&num;" is a valid variable, and "T&num;" is
 426         a valid type constructor or data constructor.</para>
 427
 428       <para>The hash sign does not change semantics at all.  We tend to use variable
 429         names ending in "&num;" for unboxed values or types (e.g. <literal>Int&num;</literal>),
 430         but there is no requirement to do so; they are just plain ordinary variables.
 431         Nor does the <option>-XMagicHash</option> extension bring anything into scope.
 432         For example, to bring <literal>Int&num;</literal> into scope you must
 433         import <literal>GHC.Prim</literal> (see <xref linkend="primitives"/>);
 434         the <option>-XMagicHash</option> extension
 435         then allows you to <emphasis>refer</emphasis> to the <literal>Int&num;</literal>
 436         that is now in scope.</para>
 437       <para> The <option>-XMagicHash</option> also enables some new forms of literals (see <xref linkend="glasgow-unboxed"/>):
 438         <itemizedlist>
 439           <listitem><para> <literal>'x'&num;</literal> has type <literal>Char&num;</literal></para> </listitem>
 440           <listitem><para> <literal>&quot;foo&quot;&num;</literal> has type <literal>Addr&num;</literal></para> </listitem>
 441           <listitem><para> <literal>3&num;</literal> has type <literal>Int&num;</literal>. In general,
 442           any Haskell integer lexeme followed by a <literal>&num;</literal> is an <literal>Int&num;</literal> literal, e.g.
 443             <literal>-0x3A&num;</literal> as well as <literal>32&num;</literal></para>.</listitem>
 444           <listitem><para> <literal>3&num;&num;</literal> has type <literal>Word&num;</literal>. In general,
 445           any non-negative Haskell integer lexeme followed by <literal>&num;&num;</literal>
 446               is a <literal>Word&num;</literal>. </para> </listitem>
 447           <listitem><para> <literal>3.2&num;</literal> has type <literal>Float&num;</literal>.</para> </listitem>
 448           <listitem><para> <literal>3.2&num;&num;</literal> has type <literal>Double&num;</literal></para> </listitem>
 449           </itemizedlist>
 450       </para>
 451    </sect2>
 452
 453     <!-- ====================== HIERARCHICAL MODULES =======================  -->
 454
 455
 456     <sect2 id="hierarchical-modules">
 457       <title>Hierarchical Modules</title>
 458
 459       <para>GHC supports a small extension to the syntax of module
 460       names: a module name is allowed to contain a dot
 461       <literal>&lsquo;.&rsquo;</literal>.  This is also known as the
 462       &ldquo;hierarchical module namespace&rdquo; extension, because
 463       it extends the normally flat Haskell module namespace into a
 464       more flexible hierarchy of modules.</para>
 465
 466       <para>This extension has very little impact on the language
 467       itself; modules names are <emphasis>always</emphasis> fully
 468       qualified, so you can just think of the fully qualified module
 469       name as <quote>the module name</quote>.  In particular, this
 470       means that the full module name must be given after the
 471       <literal>module</literal> keyword at the beginning of the
 472       module; for example, the module <literal>A.B.C</literal> must
 473       begin</para>
 474
 475 <programlisting>module A.B.C</programlisting>
 476
 477
 478       <para>It is a common strategy to use the <literal>as</literal>
 479       keyword to save some typing when using qualified names with
 480       hierarchical modules.  For example:</para>
 481
 482 <programlisting>
 483 import qualified Control.Monad.ST.Strict as ST
 484 </programlisting>
 485
 486       <para>For details on how GHC searches for source and interface
 487       files in the presence of hierarchical modules, see <xref
 488       linkend="search-path"/>.</para>
 489
 490       <para>GHC comes with a large collection of libraries arranged
 491       hierarchically; see the accompanying <ulink
 492       url="../libraries/index.html">library
 493       documentation</ulink>.  More libraries to install are available
 494       from <ulink
 495       url="http://hackage.haskell.org/packages/hackage.html">HackageDB</ulink>.</para>
 496     </sect2>
 497
 498     <!-- ====================== PATTERN GUARDS =======================  -->
 499
 500 <sect2 id="pattern-guards">
 501 <title>Pattern guards</title>
 502
 503 <para>
 504 <indexterm><primary>Pattern guards (Glasgow extension)</primary></indexterm>
 505 The discussion that follows is an abbreviated version of Simon Peyton Jones's original <ulink url="http://research.microsoft.com/~simonpj/Haskell/guards.html">proposal</ulink>. (Note that the proposal was written before pattern guards were implemented, so refers to them as unimplemented.)
 506 </para>
 507
 508 <para>
 509 Suppose we have an abstract data type of finite maps, with a
 510 lookup operation:
 511
 512 <programlisting>
 513 lookup :: FiniteMap -> Int -> Maybe Int
 514 </programlisting>
 515
 516 The lookup returns <function>Nothing</function> if the supplied key is not in the domain of the mapping, and <function>(Just v)</function> otherwise,
 517 where <varname>v</varname> is the value that the key maps to.  Now consider the following definition:
 518 </para>
 519
 520 <programlisting>
 521 clunky env var1 var2 | ok1 &amp;&amp; ok2 = val1 + val2
 522 | otherwise  = var1 + var2
 523 where
 524   m1 = lookup env var1
 525   m2 = lookup env var2
 526   ok1 = maybeToBool m1
 527   ok2 = maybeToBool m2
 528   val1 = expectJust m1
 529   val2 = expectJust m2
 530 </programlisting>
 531
 532 <para>
 533 The auxiliary functions are
 534 </para>
 535
 536 <programlisting>
 537 maybeToBool :: Maybe a -&gt; Bool
 538 maybeToBool (Just x) = True
 539 maybeToBool Nothing  = False
 540
 541 expectJust :: Maybe a -&gt; a
 542 expectJust (Just x) = x
 543 expectJust Nothing  = error "Unexpected Nothing"
 544 </programlisting>
 545
 546 <para>
 547 What is <function>clunky</function> doing? The guard <literal>ok1 &amp;&amp;
 548 ok2</literal> checks that both lookups succeed, using
 549 <function>maybeToBool</function> to convert the <function>Maybe</function>
 550 types to booleans. The (lazily evaluated) <function>expectJust</function>
 551 calls extract the values from the results of the lookups, and binds the
 552 returned values to <varname>val1</varname> and <varname>val2</varname>
 553 respectively.  If either lookup fails, then clunky takes the
 554 <literal>otherwise</literal> case and returns the sum of its arguments.
 555 </para>
 556
 557 <para>
 558 This is certainly legal Haskell, but it is a tremendously verbose and
 559 un-obvious way to achieve the desired effect.  Arguably, a more direct way
 560 to write clunky would be to use case expressions:
 561 </para>
 562
 563 <programlisting>
 564 clunky env var1 var2 = case lookup env var1 of
 565   Nothing -&gt; fail
 566   Just val1 -&gt; case lookup env var2 of
 567     Nothing -&gt; fail
 568     Just val2 -&gt; val1 + val2
 569 where
 570   fail = var1 + var2
 571 </programlisting>
 572
 573 <para>
 574 This is a bit shorter, but hardly better.  Of course, we can rewrite any set
 575 of pattern-matching, guarded equations as case expressions; that is
 576 precisely what the compiler does when compiling equations! The reason that
 577 Haskell provides guarded equations is because they allow us to write down
 578 the cases we want to consider, one at a time, independently of each other.
 579 This structure is hidden in the case version.  Two of the right-hand sides
 580 are really the same (<function>fail</function>), and the whole expression
 581 tends to become more and more indented.
 582 </para>
 583
 584 <para>
 585 Here is how I would write clunky:
 586 </para>
 587
 588 <programlisting>
 589 clunky env var1 var2
 590   | Just val1 &lt;- lookup env var1
 591   , Just val2 &lt;- lookup env var2
 592   = val1 + val2
 593 ...other equations for clunky...
 594 </programlisting>
 595
 596 <para>
 597 The semantics should be clear enough.  The qualifiers are matched in order.
 598 For a <literal>&lt;-</literal> qualifier, which I call a pattern guard, the
 599 right hand side is evaluated and matched against the pattern on the left.
 600 If the match fails then the whole guard fails and the next equation is
 601 tried.  If it succeeds, then the appropriate binding takes place, and the
 602 next qualifier is matched, in the augmented environment.  Unlike list
 603 comprehensions, however, the type of the expression to the right of the
 604 <literal>&lt;-</literal> is the same as the type of the pattern to its
 605 left.  The bindings introduced by pattern guards scope over all the
 606 remaining guard qualifiers, and over the right hand side of the equation.
 607 </para>
 608
 609 <para>
 610 Just as with list comprehensions, boolean expressions can be freely mixed
 611 with among the pattern guards.  For example:
 612 </para>
 613
 614 <programlisting>
 615 f x | [y] &lt;- x
 616     , y > 3
 617     , Just z &lt;- h y
 618     = ...
 619 </programlisting>
 620
 621 <para>
 622 Haskell's current guards therefore emerge as a special case, in which the
 623 qualifier list has just one element, a boolean expression.
 624 </para>
 625 </sect2>
 626
 627     <!-- ===================== View patterns ===================  -->
 628
 629 <sect2 id="view-patterns">
 630 <title>View patterns
 631 </title>
 632
 633 <para>
 634 View patterns are enabled by the flag <literal>-XViewPatterns</literal>.
 635 More information and examples of view patterns can be found on the
 636 <ulink url="http://hackage.haskell.org/trac/ghc/wiki/ViewPatterns">Wiki
 637 page</ulink>.
 638 </para>
 639
 640 <para>
 641 View patterns are somewhat like pattern guards that can be nested inside
 642 of other patterns.  They are a convenient way of pattern-matching
 643 against values of abstract types. For example, in a programming language
 644 implementation, we might represent the syntax of the types of the
 645 language as follows:
 646
 647 <programlisting>
 648 type Typ
 649
 650 data TypView = Unit
 651              | Arrow Typ Typ
 652
 653 view :: Type -> TypeView
 654
 655 -- additional operations for constructing Typ's ...
 656 </programlisting>
 657
 658 The representation of Typ is held abstract, permitting implementations
 659 to use a fancy representation (e.g., hash-consing to manage sharing).
 660
 661 Without view patterns, using this signature a little inconvenient:
 662 <programlisting>
 663 size :: Typ -> Integer
 664 size t = case view t of
 665   Unit -> 1
 666   Arrow t1 t2 -> size t1 + size t2
 667 </programlisting>
 668
 669 It is necessary to iterate the case, rather than using an equational
 670 function definition. And the situation is even worse when the matching
 671 against <literal>t</literal> is buried deep inside another pattern.
 672 </para>
 673
 674 <para>
 675 View patterns permit calling the view function inside the pattern and
 676 matching against the result:
 677 <programlisting>
 678 size (view -> Unit) = 1
 679 size (view -> Arrow t1 t2) = size t1 + size t2
 680 </programlisting>
 681
 682 That is, we add a new form of pattern, written
 683 <replaceable>expression</replaceable> <literal>-></literal>
 684 <replaceable>pattern</replaceable> that means "apply the expression to
 685 whatever we're trying to match against, and then match the result of
 686 that application against the pattern". The expression can be any Haskell
 687 expression of function type, and view patterns can be used wherever
 688 patterns are used.
 689 </para>
 690
 691 <para>
 692 The semantics of a pattern <literal>(</literal>
 693 <replaceable>exp</replaceable> <literal>-></literal>
 694 <replaceable>pat</replaceable> <literal>)</literal> are as follows:
 695
 696 <itemizedlist>
 697
 698 <listitem> Scoping:
 699
 700 <para>The variables bound by the view pattern are the variables bound by
 701 <replaceable>pat</replaceable>.
 702 </para>
 703
 704 <para>
 705 Any variables in <replaceable>exp</replaceable> are bound occurrences,
 706 but variables bound "to the left" in a pattern are in scope.  This
 707 feature permits, for example, one argument to a function to be used in
 708 the view of another argument.  For example, the function
 709 <literal>clunky</literal> from <xref linkend="pattern-guards" /> can be
 710 written using view patterns as follows:
 711
 712 <programlisting>
 713 clunky env (lookup env -> Just val1) (lookup env -> Just val2) = val1 + val2
 714 ...other equations for clunky...
 715 </programlisting>
 716 </para>
 717
 718 <para>
 719 More precisely, the scoping rules are:
 720 <itemizedlist>
 721 <listitem>
 722 <para>
 723 In a single pattern, variables bound by patterns to the left of a view
 724 pattern expression are in scope. For example:
 725 <programlisting>
 726 example :: Maybe ((String -> Integer,Integer), String) -> Bool
 727 example Just ((f,_), f -> 4) = True
 728 </programlisting>
 729
 730 Additionally, in function definitions, variables bound by matching earlier curried
 731 arguments may be used in view pattern expressions in later arguments:
 732 <programlisting>
 733 example :: (String -> Integer) -> String -> Bool
 734 example f (f -> 4) = True
 735 </programlisting>
 736 That is, the scoping is the same as it would be if the curried arguments
 737 were collected into a tuple.
 738 </para>
 739 </listitem>
 740
 741 <listitem>
 742 <para>
 743 In mutually recursive bindings, such as <literal>let</literal>,
 744 <literal>where</literal>, or the top level, view patterns in one
 745 declaration may not mention variables bound by other declarations.  That
 746 is, each declaration must be self-contained.  For example, the following
 747 program is not allowed:
 748 <programlisting>
 749 let {(x -> y) = e1 ;
 750      (y -> x) = e2 } in x
 751 </programlisting>
 752
 753 (For some amplification on this design choice see
 754 <ulink url="http://hackage.haskell.org/trac/ghc/ticket/4061">Trac #4061</ulink>.)
 755
 756 </para>
 757 </listitem>
 758 </itemizedlist>
 759
 760 </para>
 761 </listitem>
 762
 763 <listitem><para> Typing: If <replaceable>exp</replaceable> has type
 764 <replaceable>T1</replaceable> <literal>-></literal>
 765 <replaceable>T2</replaceable> and <replaceable>pat</replaceable> matches
 766 a <replaceable>T2</replaceable>, then the whole view pattern matches a
 767 <replaceable>T1</replaceable>.
 768 </para></listitem>
 769
 770 <listitem><para> Matching: To the equations in Section 3.17.3 of the
 771 <ulink url="http://www.haskell.org/onlinereport/">Haskell 98
 772 Report</ulink>, add the following:
 773 <programlisting>
 774 case v of { (e -> p) -> e1 ; _ -> e2 }
 775  =
 776 case (e v) of { p -> e1 ; _ -> e2 }
 777 </programlisting>
 778 That is, to match a variable <replaceable>v</replaceable> against a pattern
 779 <literal>(</literal> <replaceable>exp</replaceable>
 780 <literal>-></literal> <replaceable>pat</replaceable>
 781 <literal>)</literal>, evaluate <literal>(</literal>
 782 <replaceable>exp</replaceable> <replaceable> v</replaceable>
 783 <literal>)</literal> and match the result against
 784 <replaceable>pat</replaceable>.
 785 </para></listitem>
 786
 787 <listitem><para> Efficiency: When the same view function is applied in
 788 multiple branches of a function definition or a case expression (e.g.,
 789 in <literal>size</literal> above), GHC makes an attempt to collect these
 790 applications into a single nested case expression, so that the view
 791 function is only applied once.  Pattern compilation in GHC follows the
 792 matrix algorithm described in Chapter 4 of <ulink
 793 url="http://research.microsoft.com/~simonpj/Papers/slpj-book-1987/">The
 794 Implementation of Functional Programming Languages</ulink>.  When the
 795 top rows of the first column of a matrix are all view patterns with the
 796 "same" expression, these patterns are transformed into a single nested
 797 case.  This includes, for example, adjacent view patterns that line up
 798 in a tuple, as in
 799 <programlisting>
 800 f ((view -> A, p1), p2) = e1
 801 f ((view -> B, p3), p4) = e2
 802 </programlisting>
 803 </para>
 804
 805 <para> The current notion of when two view pattern expressions are "the
 806 same" is very restricted: it is not even full syntactic equality.
 807 However, it does include variables, literals, applications, and tuples;
 808 e.g., two instances of <literal>view ("hi", "there")</literal> will be
 809 collected.  However, the current implementation does not compare up to
 810 alpha-equivalence, so two instances of <literal>(x, view x ->
 811 y)</literal> will not be coalesced.
 812 </para>
 813
 814 </listitem>
 815
 816 </itemizedlist>
 817 </para>
 818
 819 </sect2>
 820
 821     <!-- ===================== n+k patterns ===================  -->
 822
 823 <sect2 id="n-k-patterns">
 824 <title>n+k patterns</title>
 825 <indexterm><primary><option>-XNoNPlusKPatterns</option></primary></indexterm>
 826
 827 <para>
 828 <literal>n+k</literal> pattern support is enabled by default. To disable
 829 it, you can use the <option>-XNoNPlusKPatterns</option> flag.
 830 </para>
 831
 832 </sect2>
 833
 834     <!-- ===================== Recursive do-notation ===================  -->
 835
 836 <sect2 id="recursive-do-notation">
 837 <title>The recursive do-notation
 838 </title>
 839
 840 <para>
 841 The do-notation of Haskell 98 does not allow <emphasis>recursive bindings</emphasis>,
 842 that is, the variables bound in a do-expression are visible only in the textually following
 843 code block. Compare this to a let-expression, where bound variables are visible in the entire binding
 844 group. It turns out that several applications can benefit from recursive bindings in
 845 the do-notation.  The <option>-XDoRec</option> flag provides the necessary syntactic support.
 846 </para>
 847 <para>
 848 Here is a simple (albeit contrived) example:
 849 <programlisting>
 850 {-# LANGUAGE DoRec #-}
 851 justOnes = do { rec { xs &lt;- Just (1:xs) }
 852               ; return (map negate xs) }
 853 </programlisting>
 854 As you can guess <literal>justOnes</literal> will evaluate to <literal>Just [-1,-1,-1,...</literal>.
 855 </para>
 856 <para>
 857 The background and motivation for recursive do-notation is described in
 858 <ulink url="http://sites.google.com/site/leventerkok/">A recursive do for Haskell</ulink>,
 859 by Levent Erkok, John Launchbury,
 860 Haskell Workshop 2002, pages: 29-37. Pittsburgh, Pennsylvania.
 861 The theory behind monadic value recursion is explained further in Erkok's thesis
 862 <ulink url="http://sites.google.com/site/leventerkok/erkok-thesis.pdf">Value Recursion in Monadic Computations</ulink>.
 863 However, note that GHC uses a different syntax than the one described in these documents.
 864 </para>
 865
 866 <sect3>
 867 <title>Details of recursive do-notation</title>
 868 <para>
 869 The recursive do-notation is enabled with the flag <option>-XDoRec</option> or, equivalently,
 870 the LANGUAGE pragma <option>DoRec</option>.  It introduces the single new keyword "<literal>rec</literal>",
 871 which wraps a mutually-recursive group of monadic statements,
 872 producing a single statement.
 873 </para>
 874 <para>Similar to a <literal>let</literal>
 875 statement, the variables bound in the <literal>rec</literal> are
 876 visible throughout the <literal>rec</literal> group, and below it.
 877 For example, compare
 878 <programlisting>
 879 do { a &lt;- getChar              do { a &lt;- getChar
 880    ; let { r1 = f a r2             ; rec { r1 &lt;- f a r2
 881          ; r2 = g r1 }                   ; r2 &lt;- g r1 }
 882    ; return (r1 ++ r2) }          ; return (r1 ++ r2) }
 883 </programlisting>
 884 In both cases, <literal>r1</literal> and <literal>r2</literal> are
 885 available both throughout the <literal>let</literal> or <literal>rec</literal> block, and
 886 in the statements that follow it.  The difference is that <literal>let</literal> is non-monadic,
 887 while <literal>rec</literal> is monadic.  (In Haskell <literal>let</literal> is
 888 really <literal>letrec</literal>, of course.)
 889 </para>
 890 <para>
 891 The static and dynamic semantics of <literal>rec</literal> can be described as follows:
 892 <itemizedlist>
 893 <listitem><para>
 894 First,
 895 similar to let-bindings, the <literal>rec</literal> is broken into
 896 minimal recursive groups, a process known as <emphasis>segmentation</emphasis>.
 897 For example:
 898 <programlisting>
 899 rec { a &lt;- getChar      ===>     a &lt;- getChar
 900     ; b &lt;- f a c                 rec { b &lt;- f a c
 901     ; c &lt;- f b a                     ; c &lt;- f b a }
 902     ; putChar c }                putChar c
 903 </programlisting>
 904 The details of segmentation are described in Section 3.2 of
 905 <ulink url="http://sites.google.com/site/leventerkok/">A recursive do for Haskell</ulink>.
 906 Segmentation improves polymorphism, reduces the size of the recursive "knot", and, as the paper
 907 describes, also has a semantic effect (unless the monad satisfies the right-shrinking law).
 908 </para></listitem>
 909 <listitem><para>
 910 Then each resulting <literal>rec</literal> is desugared, using a call to <literal>Control.Monad.Fix.mfix</literal>.
 911 For example, the <literal>rec</literal> group in the preceding example is desugared like this:
 912 <programlisting>
 913 rec { b &lt;- f a c     ===>    (b,c) &lt;- mfix (\~(b,c) -> do { b &lt;- f a c
 914     ; c &lt;- f b a }                                        ; c &lt;- f b a
 915                                                           ; return (b,c) })
 916 </programlisting>
 917 In general, the statment <literal>rec <replaceable>ss</replaceable></literal>
 918 is desugared to the statement
 919 <programlisting>
 920 <replaceable>vs</replaceable> &lt;- mfix (\~<replaceable>vs</replaceable> -&gt; do { <replaceable>ss</replaceable>; return <replaceable>vs</replaceable> })
 921 </programlisting>
 922 where <replaceable>vs</replaceable> is a tuple of the variables bound by <replaceable>ss</replaceable>.
 923 </para><para>
 924 The original <literal>rec</literal> typechecks exactly
 925 when the above desugared version would do so.  For example, this means that
 926 the variables <replaceable>vs</replaceable> are all monomorphic in the statements
 927 following the <literal>rec</literal>, because they are bound by a lambda.
 928 </para>
 929 <para>
 930 The <literal>mfix</literal> function is defined in the <literal>MonadFix</literal>
 931 class, in <literal>Control.Monad.Fix</literal>, thus:
 932 <programlisting>
 933 class Monad m => MonadFix m where
 934    mfix :: (a -> m a) -> m a
 935 </programlisting>
 936 </para>
 937 </listitem>
 938 </itemizedlist>
 939 </para>
 940 <para>
 941 Here are some other important points in using the recursive-do notation:
 942 <itemizedlist>
 943 <listitem><para>
 944 It is enabled with the flag <literal>-XDoRec</literal>, which is in turn implied by
 945 <literal>-fglasgow-exts</literal>.
 946 </para></listitem>
 947
 948 <listitem><para>
 949 If recursive bindings are required for a monad,
 950 then that monad must be declared an instance of the <literal>MonadFix</literal> class.
 951 </para></listitem>
 952
 953 <listitem><para>
 954 The following instances of <literal>MonadFix</literal> are automatically provided: List, Maybe, IO.
 955 Furthermore, the Control.Monad.ST and Control.Monad.ST.Lazy modules provide the instances of the MonadFix class
 956 for Haskell's internal state monad (strict and lazy, respectively).
 957 </para></listitem>
 958
 959 <listitem><para>
 960 Like <literal>let</literal> and <literal>where</literal> bindings,
 961 name shadowing is not allowed within a <literal>rec</literal>;
 962 that is, all the names bound in a single <literal>rec</literal> must
 963 be distinct (Section 3.3 of the paper).
 964 </para></listitem>
 965 <listitem><para>
 966 It supports rebindable syntax (see <xref linkend="rebindable-syntax"/>).
 967 </para></listitem>
 968 </itemizedlist>
 969 </para>
 970 </sect3>
 971
 972 <sect3 id="mdo-notation"> <title> Mdo-notation (deprecated) </title>
 973
 974 <para> GHC used to support the flag <option>-XRecursiveDo</option>,
 975 which enabled the keyword <literal>mdo</literal>, precisely as described in
 976 <ulink url="http://sites.google.com/site/leventerkok/">A recursive do for Haskell</ulink>,
 977 but this is now deprecated.  Instead of <literal>mdo { Q; e }</literal>, write
 978 <literal>do { rec Q; e }</literal>.
 979 </para>
 980 <para>
 981 Historical note: The old implementation of the mdo-notation (and most
 982 of the existing documents) used the name
 983 <literal>MonadRec</literal> for the class and the corresponding library.
 984 This name is not supported by GHC.
 985 </para>
 986 </sect3>
 987
 988 </sect2>
 989
 990
 991    <!-- ===================== PARALLEL LIST COMPREHENSIONS ===================  -->
 992
 993   <sect2 id="parallel-list-comprehensions">
 994     <title>Parallel List Comprehensions</title>
 995     <indexterm><primary>list comprehensions</primary><secondary>parallel</secondary>
 996     </indexterm>
 997     <indexterm><primary>parallel list comprehensions</primary>
 998     </indexterm>
 999
1000     <para>Parallel list comprehensions are a natural extension to list
1001     comprehensions.  List comprehensions can be thought of as a nice
1002     syntax for writing maps and filters.  Parallel comprehensions
1003     extend this to include the zipWith family.</para>
1004
1005     <para>A parallel list comprehension has multiple independent
1006     branches of qualifier lists, each separated by a `|' symbol.  For
1007     example, the following zips together two lists:</para>
1008
1009 <programlisting>
1010    [ (x, y) | x &lt;- xs | y &lt;- ys ]
1011 </programlisting>
1012
1013     <para>The behavior of parallel list comprehensions follows that of
1014     zip, in that the resulting list will have the same length as the
1015     shortest branch.</para>
1016
1017     <para>We can define parallel list comprehensions by translation to
1018     regular comprehensions.  Here's the basic idea:</para>
1019
1020     <para>Given a parallel comprehension of the form: </para>
1021
1022 <programlisting>
1023    [ e | p1 &lt;- e11, p2 &lt;- e12, ...
1024        | q1 &lt;- e21, q2 &lt;- e22, ...
1025        ...
1026    ]
1027 </programlisting>
1028
1029     <para>This will be translated to: </para>
1030
1031 <programlisting>
1032    [ e | ((p1,p2), (q1,q2), ...) &lt;- zipN [(p1,p2) | p1 &lt;- e11, p2 &lt;- e12, ...]
1033                                          [(q1,q2) | q1 &lt;- e21, q2 &lt;- e22, ...]
1034                                          ...
1035    ]
1036 </programlisting>
1037
1038     <para>where `zipN' is the appropriate zip for the given number of
1039     branches.</para>
1040
1041   </sect2>
1042
1043   <!-- ===================== TRANSFORM LIST COMPREHENSIONS ===================  -->
1044
1045   <sect2 id="generalised-list-comprehensions">
1046     <title>Generalised (SQL-Like) List Comprehensions</title>
1047     <indexterm><primary>list comprehensions</primary><secondary>generalised</secondary>
1048     </indexterm>
1049     <indexterm><primary>extended list comprehensions</primary>
1050     </indexterm>
1051     <indexterm><primary>group</primary></indexterm>
1052     <indexterm><primary>sql</primary></indexterm>
1053
1054
1055     <para>Generalised list comprehensions are a further enhancement to the
1056     list comprehension syntactic sugar to allow operations such as sorting
1057     and grouping which are familiar from SQL.   They are fully described in the
1058         paper <ulink url="http://research.microsoft.com/~simonpj/papers/list-comp">
1059           Comprehensive comprehensions: comprehensions with "order by" and "group by"</ulink>,
1060     except that the syntax we use differs slightly from the paper.</para>
1061 <para>The extension is enabled with the flag <option>-XTransformListComp</option>.</para>
1062 <para>Here is an example:
1063 <programlisting>
1064 employees = [ ("Simon", "MS", 80)
1065 , ("Erik", "MS", 100)
1066 , ("Phil", "Ed", 40)
1067 , ("Gordon", "Ed", 45)
1068 , ("Paul", "Yale", 60)]
1069
1070 output = [ (the dept, sum salary)
1071 | (name, dept, salary) &lt;- employees
1072 , then group by dept
1073 , then sortWith by (sum salary)
1074 , then take 5 ]
1075 </programlisting>
1076 In this example, the list <literal>output</literal> would take on
1077     the value:
1078
1079 <programlisting>
1080 [("Yale", 60), ("Ed", 85), ("MS", 180)]
1081 </programlisting>
1082 </para>
1083 <para>There are three new keywords: <literal>group</literal>, <literal>by</literal>, and <literal>using</literal>.
1084 (The function <literal>sortWith</literal> is not a keyword; it is an ordinary
1085 function that is exported by <literal>GHC.Exts</literal>.)</para>
1086
1087 <para>There are five new forms of comprehension qualifier,
1088 all introduced by the (existing) keyword <literal>then</literal>:
1089     <itemizedlist>
1090     <listitem>
1091
1092 <programlisting>
1093 then f
1094 </programlisting>
1095
1096     This statement requires that <literal>f</literal> have the type <literal>
1097     forall a. [a] -> [a]</literal>. You can see an example of its use in the
1098     motivating example, as this form is used to apply <literal>take 5</literal>.
1099
1100     </listitem>
1101
1102
1103     <listitem>
1104 <para>
1105 <programlisting>
1106 then f by e
1107 </programlisting>
1108
1109     This form is similar to the previous one, but allows you to create a function
1110     which will be passed as the first argument to f. As a consequence f must have
1111     the type <literal>forall a. (a -> t) -> [a] -> [a]</literal>. As you can see
1112     from the type, this function lets f &quot;project out&quot; some information
1113     from the elements of the list it is transforming.</para>
1114
1115     <para>An example is shown in the opening example, where <literal>sortWith</literal>
1116     is supplied with a function that lets it find out the <literal>sum salary</literal>
1117     for any item in the list comprehension it transforms.</para>
1118
1119     </listitem>
1120
1121
1122     <listitem>
1123
1124 <programlisting>
1125 then group by e using f
1126 </programlisting>
1127
1128     <para>This is the most general of the grouping-type statements. In this form,
1129     f is required to have type <literal>forall a. (a -> t) -> [a] -> [[a]]</literal>.
1130     As with the <literal>then f by e</literal> case above, the first argument
1131     is a function supplied to f by the compiler which lets it compute e on every
1132     element of the list being transformed. However, unlike the non-grouping case,
1133     f additionally partitions the list into a number of sublists: this means that
1134     at every point after this statement, binders occurring before it in the comprehension
1135     refer to <emphasis>lists</emphasis> of possible values, not single values. To help understand
1136     this, let's look at an example:</para>
1137
1138 <programlisting>
1139 -- This works similarly to groupWith in GHC.Exts, but doesn't sort its input first
1140 groupRuns :: Eq b => (a -> b) -> [a] -> [[a]]
1141 groupRuns f = groupBy (\x y -> f x == f y)
1142
1143 output = [ (the x, y)
1144 | x &lt;- ([1..3] ++ [1..2])
1145 , y &lt;- [4..6]
1146 , then group by x using groupRuns ]
1147 </programlisting>
1148
1149     <para>This results in the variable <literal>output</literal> taking on the value below:</para>
1150
1151 <programlisting>
1152 [(1, [4, 5, 6]), (2, [4, 5, 6]), (3, [4, 5, 6]), (1, [4, 5, 6]), (2, [4, 5, 6])]
1153 </programlisting>
1154
1155     <para>Note that we have used the <literal>the</literal> function to change the type
1156     of x from a list to its original numeric type. The variable y, in contrast, is left
1157     unchanged from the list form introduced by the grouping.</para>
1158
1159     </listitem>
1160
1161     <listitem>
1162
1163 <programlisting>
1164 then group by e
1165 </programlisting>
1166
1167     <para>This form of grouping is essentially the same as the one described above. However,
1168     since no function to use for the grouping has been supplied it will fall back on the
1169     <literal>groupWith</literal> function defined in
1170     <ulink url="&libraryBaseLocation;/GHC-Exts.html"><literal>GHC.Exts</literal></ulink>. This
1171     is the form of the group statement that we made use of in the opening example.</para>
1172
1173     </listitem>
1174
1175
1176     <listitem>
1177
1178 <programlisting>
1179 then group using f
1180 </programlisting>
1181
1182     <para>With this form of the group statement, f is required to simply have the type
1183     <literal>forall a. [a] -> [[a]]</literal>, which will be used to group up the
1184     comprehension so far directly. An example of this form is as follows:</para>
1185
1186 <programlisting>
1187 output = [ x
1188 | y &lt;- [1..5]
1189 , x &lt;- "hello"
1190 , then group using inits]
1191 </programlisting>
1192
1193     <para>This will yield a list containing every prefix of the word "hello" written out 5 times:</para>
1194
1195 <programlisting>
1196 ["","h","he","hel","hell","hello","helloh","hellohe","hellohel","hellohell","hellohello","hellohelloh",...]
1197 </programlisting>
1198
1199     </listitem>
1200 </itemizedlist>
1201 </para>
1202   </sect2>
1203
1204    <!-- ===================== MONAD COMPREHENSIONS ===================== -->
1205
1206 <sect2 id="monad-comprehensions">
1207     <title>Monad comprehensions</title>
1208     <indexterm><primary>monad comprehensions</primary></indexterm>
1209
1210     <para>
1211         Monad comprehensions generalise the list comprehension notation,
1212         including parallel comprehensions
1213         (<xref linkend="parallel-list-comprehensions"/>) and
1214         transform comprehensions (<xref linkend="generalised-list-comprehensions"/>)
1215         to work for any monad.
1216     </para>
1217
1218     <para>Monad comprehensions support:</para>
1219
1220     <itemizedlist>
1221         <listitem>
1222             <para>
1223                 Bindings:
1224             </para>
1225
1226 <programlisting>
1227 [ x + y | x &lt;- Just 1, y &lt;- Just 2 ]
1228 </programlisting>
1229
1230             <para>
1231                 Bindings are translated with the <literal>(&gt;&gt;=)</literal> and
1232                 <literal>return</literal> functions to the usual do-notation:
1233             </para>
1234
1235 <programlisting>
1236 do x &lt;- Just 1
1237    y &lt;- Just 2
1238    return (x+y)
1239 </programlisting>
1240
1241         </listitem>
1242         <listitem>
1243             <para>
1244                 Guards:
1245             </para>
1246
1247 <programlisting>
1248 [ x | x &lt;- [1..10], x &lt;= 5 ]
1249 </programlisting>
1250
1251             <para>
1252                 Guards are translated with the <literal>guard</literal> function,
1253                 which requires a <literal>MonadPlus</literal> instance:
1254             </para>
1255
1256 <programlisting>
1257 do x &lt;- [1..10]
1258    guard (x &lt;= 5)
1259    return x
1260 </programlisting>
1261
1262         </listitem>
1263         <listitem>
1264             <para>
1265                 Transform statements (as with <literal>-XTransformListComp</literal>):
1266             </para>
1267
1268 <programlisting>
1269 [ x+y | x &lt;- [1..10], y &lt;- [1..x], then take 2 ]
1270 </programlisting>
1271
1272             <para>
1273                 This translates to:
1274             </para>
1275
1276 <programlisting>
1277 do (x,y) &lt;- take 2 (do x &lt;- [1..10]
1278                        y &lt;- [1..x]
1279                        return (x,y))
1280    return (x+y)
1281 </programlisting>
1282
1283         </listitem>
1284         <listitem>
1285             <para>
1286                 Group statements (as with <literal>-XTransformListComp</literal>):
1287             </para>
1288
1289 <programlisting>
1290 [ x | x &lt;- [1,1,2,2,3], then group by x ]
1291 [ x | x &lt;- [1,1,2,2,3], then group by x using GHC.Exts.groupWith ]
1292 [ x | x &lt;- [1,1,2,2,3], then group using myGroup ]
1293 </programlisting>
1294
1295             <para>
1296                 The basic <literal>then group by e</literal> statement is
1297                 translated using the <literal>mgroupWith</literal> function, which
1298                 requires a <literal>MonadGroup</literal> instance, defined in
1299                 <ulink url="&libraryBaseLocation;/Control-Monad-Group.html"><literal>Control.Monad.Group</literal></ulink>:
1300             </para>
1301
1302 <programlisting>
1303 do x &lt;- mgroupWith (do x &lt;- [1,1,2,2,3]
1304                        return x)
1305    return x
1306 </programlisting>
1307
1308             <para>
1309                 Note that the type of <literal>x</literal> is changed by the
1310                 grouping statement.
1311             </para>
1312
1313             <para>
1314                 The grouping function can also be defined with the
1315                 <literal>using</literal> keyword.
1316             </para>
1317
1318         </listitem>
1319         <listitem>
1320             <para>
1321                 Parallel statements (as with <literal>-XParallelListComp</literal>):
1322             </para>
1323
1324 <programlisting>
1325 [ (x+y) | x &lt;- [1..10]
1326         | y &lt;- [11..20]
1327         ]
1328 </programlisting>
1329
1330             <para>
1331                 Parallel statements are translated using the
1332                 <literal>mzip</literal> function, which requires a
1333                 <literal>MonadZip</literal> instance defined in
1334                 <ulink url="&libraryBaseLocation;/Control-Monad-Zip.html"><literal>Control.Monad.Zip</literal></ulink>:
1335             </para>
1336
1337 <programlisting>
1338 do (x,y) &lt;- mzip (do x &lt;- [1..10]
1339                      return x)
1340                  (do y &lt;- [11..20]
1341                      return y)
1342    return (x+y)
1343 </programlisting>
1344
1345         </listitem>
1346     </itemizedlist>
1347
1348     <para>
1349         All these features are enabled by default if the
1350         <literal>MonadComprehensions</literal> extension is enabled. The types
1351         and more detailed examples on how to use comprehensions are explained
1352         in the previous chapters <xref
1353             linkend="generalised-list-comprehensions"/> and <xref
1354             linkend="parallel-list-comprehensions"/>. In general you just have
1355         to replace the type <literal>[a]</literal> with the type
1356         <literal>Monad m => m a</literal> for monad comprehensions.
1357     </para>
1358
1359     <para>
1360         Note: Even though most of these examples are using the list monad,
1361         monad comprehensions work for any monad.
1362         The <literal>base</literal> package offers all necessary instances for
1363         lists, which make <literal>MonadComprehensions</literal> backward
1364         compatible to built-in, transform and parallel list comprehensions.
1365     </para>
1366 <para> More formally, the desugaring is as follows.  We write <literal>D[ e | Q]</literal>
1367 to mean the desugaring of the monad comprehension <literal>[ e | Q]</literal>:
1368 <programlisting>
1369 Expressions: e
1370 Declarations: d
1371 Lists of qualifiers: Q,R,S
1372
1373 -- Basic forms
1374 D[ e | ]               = return e
1375 D[ e | p &lt;- e, Q ]     = e &gt;&gt;= \p -&gt; D[ e | Q ]
1376 D[ e | e, Q ]          = guard e &gt;&gt; \p -&gt; D[ e | Q ]
1377 D[ e | let d, Q ]      = let d in D[ e | Q ]
1378
1379 -- Parallel comprehensions (iterate for multiple parallel branches)
1380 D[ e | (Q | R), S ]    = mzip D[ Qv | Q ] D[ Rv | R ] &gt;&gt;= \(Qv,Rv) -&gt; D[ e | S ]
1381
1382 -- Transform comprehensions
1383 D[ e | Q then f, R ]                  = f D[ Qv | Q ] &gt;&gt;= \Qv -&gt; D[ e | R ]
1384
1385 D[ e | Q then f by b, R ]             = f b D[ Qv | Q ] &gt;&gt;= \Qv -&gt; D[ e | R ]
1386
1387 D[ e | Q then group using f, R ]      = f D[ Qv | Q ] &gt;&gt;= \ys -&gt;
1388                                         case (fmap selQv1 ys, ..., fmap selQvn ys) of
1389                                              Qv -&gt; D[ e | R ]
1390
1391 D[ e | Q then group by b using f, R ] = f b D[ Qv | Q ] &gt;&gt;= \ys -&gt;
1392                                         case (fmap selQv1 ys, ..., fmap selQvn ys) of
1393                                            Qv -&gt; D[ e | R ]
1394
1395 where  Qv is the tuple of variables bound by Q (and used subsequently)
1396        selQvi is a selector mapping Qv to the ith component of Qv
1397
1398 Operator     Standard binding       Expected type
1399 --------------------------------------------------------------------
1400 return       GHC.Base               t1 -&gt; m t2
1401 (&gt;&gt;=)        GHC.Base               m1 t1 -&gt; (t2 -&gt; m2 t3) -&gt; m3 t3
1402 (&gt;&gt;)         GHC.Base               m1 t1 -&gt; m2 t2         -&gt; m3 t3
1403 guard        Control.Monad          t1 -&gt; m t2
1404 fmap         GHC.Base               forall a b. (a-&gt;b) -&gt; n a -&gt; n b
1405 mgroupWith   Control.Monad.Group    forall a. (a -&gt; t) -&gt; m1 a -&gt; m2 (n a)
1406 mzip         Control.Monad.Zip      forall a b. m a -&gt; m b -&gt; m (a,b)
1407 </programlisting>
1408 The comprehension should typecheck when its desugaring would typecheck.
1409 </para>
1410 <para>
1411 Monad comprehensions support rebindable syntax (<xref linkend="rebindable-syntax"/>).
1412 Without rebindable
1413 syntax, the operators from the "standard binding" module are used; with
1414 rebindable syntax, the operators are looked up in the current lexical scope.
1415 For example, parallel comprehensions will be typechecked and desugared
1416 using whatever "<literal>mzip</literal>" is in scope.
1417 </para>
1418 <para>
1419 The rebindable operators must have the "Expected type" given in the
1420 table above.  These types are surprisingly general.  For example, you can
1421 use a bind operator with the type
1422 <programlisting>
1423 (>>=) :: T x y a -> (a -> T y z b) -> T x z b
1424 </programlisting>
1425 In the case of transform comprehensions, notice that the groups are
1426 parameterised over some arbitrary type <literal>n</literal> (provided it
1427 has an <literal>fmap</literal>, as well as
1428 the comprehension being over an arbitrary monad.
1429 </para>
1430 </sect2>
1431
1432    <!-- ===================== REBINDABLE SYNTAX ===================  -->
1433
1434 <sect2 id="rebindable-syntax">
1435 <title>Rebindable syntax and the implicit Prelude import</title>
1436
1437  <para><indexterm><primary>-XNoImplicitPrelude
1438  option</primary></indexterm> GHC normally imports
1439  <filename>Prelude.hi</filename> files for you.  If you'd
1440  rather it didn't, then give it a
1441  <option>-XNoImplicitPrelude</option> option.  The idea is
1442  that you can then import a Prelude of your own.  (But don't
1443  call it <literal>Prelude</literal>; the Haskell module
1444  namespace is flat, and you must not conflict with any
1445  Prelude module.)</para>
1446
1447             <para>Suppose you are importing a Prelude of your own
1448               in order to define your own numeric class
1449             hierarchy.  It completely defeats that purpose if the
1450             literal "1" means "<literal>Prelude.fromInteger
1451             1</literal>", which is what the Haskell Report specifies.
1452             So the <option>-XRebindableSyntax</option>
1453               flag causes
1454             the following pieces of built-in syntax to refer to
1455             <emphasis>whatever is in scope</emphasis>, not the Prelude
1456             versions:
1457             <itemizedlist>
1458               <listitem>
1459                 <para>An integer literal <literal>368</literal> means
1460                 "<literal>fromInteger (368::Integer)</literal>", rather than
1461                 "<literal>Prelude.fromInteger (368::Integer)</literal>".
1462 </para> </listitem>
1463
1464       <listitem><para>Fractional literals are handed in just the same way,
1465           except that the translation is
1466               <literal>fromRational (3.68::Rational)</literal>.
1467 </para> </listitem>
1468
1469           <listitem><para>The equality test in an overloaded numeric pattern
1470               uses whatever <literal>(==)</literal> is in scope.
1471 </para> </listitem>
1472
1473           <listitem><para>The subtraction operation, and the
1474           greater-than-or-equal test, in <literal>n+k</literal> patterns
1475               use whatever <literal>(-)</literal> and <literal>(>=)</literal> are in scope.
1476               </para></listitem>
1477
1478               <listitem>
1479                 <para>Negation (e.g. "<literal>- (f x)</literal>")
1480                 means "<literal>negate (f x)</literal>", both in numeric
1481                 patterns, and expressions.
1482               </para></listitem>
1483
1484               <listitem>
1485                 <para>Conditionals (e.g. "<literal>if</literal> e1 <literal>then</literal> e2 <literal>else</literal> e3")
1486                 means "<literal>ifThenElse</literal> e1 e2 e3".  However <literal>case</literal> expressions are unaffected.
1487               </para></listitem>
1488
1489               <listitem>
1490           <para>"Do" notation is translated using whatever
1491               functions <literal>(>>=)</literal>,
1492               <literal>(>>)</literal>, and <literal>fail</literal>,
1493               are in scope (not the Prelude
1494               versions).  List comprehensions, mdo (<xref linkend="mdo-notation"/>), and parallel array
1495               comprehensions, are unaffected.  </para></listitem>
1496
1497               <listitem>
1498                 <para>Arrow
1499                 notation (see <xref linkend="arrow-notation"/>)
1500                 uses whatever <literal>arr</literal>,
1501                 <literal>(>>>)</literal>, <literal>first</literal>,
1502                 <literal>app</literal>, <literal>(|||)</literal> and
1503                 <literal>loop</literal> functions are in scope. But unlike the
1504                 other constructs, the types of these functions must match the
1505                 Prelude types very closely.  Details are in flux; if you want
1506                 to use this, ask!
1507               </para></listitem>
1508             </itemizedlist>
1509 <option>-XRebindableSyntax</option> implies <option>-XNoImplicitPrelude</option>.
1510 </para>
1511 <para>
1512 In all cases (apart from arrow notation), the static semantics should be that of the desugared form,
1513 even if that is a little unexpected. For example, the
1514 static semantics of the literal <literal>368</literal>
1515 is exactly that of <literal>fromInteger (368::Integer)</literal>; it's fine for
1516 <literal>fromInteger</literal> to have any of the types:
1517 <programlisting>
1518 fromInteger :: Integer -> Integer
1519 fromInteger :: forall a. Foo a => Integer -> a
1520 fromInteger :: Num a => a -> Integer
1521 fromInteger :: Integer -> Bool -> Bool
1522 </programlisting>
1523 </para>
1524
1525              <para>Be warned: this is an experimental facility, with
1526              fewer checks than usual.  Use <literal>-dcore-lint</literal>
1527              to typecheck the desugared program.  If Core Lint is happy
1528              you should be all right.</para>
1529
1530 </sect2>
1531
1532 <sect2 id="postfix-operators">
1533 <title>Postfix operators</title>
1534
1535 <para>
1536   The <option>-XPostfixOperators</option> flag enables a small
1537 extension to the syntax of left operator sections, which allows you to
1538 define postfix operators.  The extension is this: the left section
1539 <programlisting>
1540   (e !)
1541 </programlisting>
1542 is equivalent (from the point of view of both type checking and execution) to the expression
1543 <programlisting>
1544   ((!) e)
1545 </programlisting>
1546 (for any expression <literal>e</literal> and operator <literal>(!)</literal>.
1547 The strict Haskell 98 interpretation is that the section is equivalent to
1548 <programlisting>
1549   (\y -> (!) e y)
1550 </programlisting>
1551 That is, the operator must be a function of two arguments.  GHC allows it to
1552 take only one argument, and that in turn allows you to write the function
1553 postfix.
1554 </para>
1555 <para>The extension does not extend to the left-hand side of function
1556 definitions; you must define such a function in prefix form.</para>
1557
1558 </sect2>
1559
1560 <sect2 id="tuple-sections">
1561 <title>Tuple sections</title>
1562
1563 <para>
1564   The <option>-XTupleSections</option> flag enables Python-style partially applied
1565   tuple constructors. For example, the following program
1566 <programlisting>
1567   (, True)
1568 </programlisting>
1569   is considered to be an alternative notation for the more unwieldy alternative
1570 <programlisting>
1571   \x -> (x, True)
1572 </programlisting>
1573 You can omit any combination of arguments to the tuple, as in the following
1574 <programlisting>
1575   (, "I", , , "Love", , 1337)
1576 </programlisting>
1577 which translates to
1578 <programlisting>
1579   \a b c d -> (a, "I", b, c, "Love", d, 1337)
1580 </programlisting>
1581 </para>
1582
1583 <para>
1584   If you have <link linkend="unboxed-tuples">unboxed tuples</link> enabled, tuple sections
1585   will also be available for them, like so
1586 <programlisting>
1587   (# , True #)
1588 </programlisting>
1589 Because there is no unboxed unit tuple, the following expression
1590 <programlisting>
1591   (# #)
1592 </programlisting>
1593 continues to stand for the unboxed singleton tuple data constructor.
1594 </para>
1595
1596 </sect2>
1597
1598 <sect2 id="disambiguate-fields">
1599 <title>Record field disambiguation</title>
1600 <para>
1601 In record construction and record pattern matching
1602 it is entirely unambiguous which field is referred to, even if there are two different
1603 data types in scope with a common field name.  For example:
1604 <programlisting>
1605 module M where
1606   data S = MkS { x :: Int, y :: Bool }
1607
1608 module Foo where
1609   import M
1610
1611   data T = MkT { x :: Int }
1612
1613   ok1 (MkS { x = n }) = n+1   -- Unambiguous
1614   ok2 n = MkT { x = n+1 }     -- Unambiguous
1615
1616   bad1 k = k { x = 3 }  -- Ambiguous
1617   bad2 k = x k          -- Ambiguous
1618 </programlisting>
1619 Even though there are two <literal>x</literal>'s in scope,
1620 it is clear that the <literal>x</literal> in the pattern in the
1621 definition of <literal>ok1</literal> can only mean the field
1622 <literal>x</literal> from type <literal>S</literal>. Similarly for
1623 the function <literal>ok2</literal>.  However, in the record update
1624 in <literal>bad1</literal> and the record selection in <literal>bad2</literal>
1625 it is not clear which of the two types is intended.
1626 </para>
1627 <para>
1628 Haskell 98 regards all four as ambiguous, but with the
1629 <option>-XDisambiguateRecordFields</option> flag, GHC will accept
1630 the former two.  The rules are precisely the same as those for instance
1631 declarations in Haskell 98, where the method names on the left-hand side
1632 of the method bindings in an instance declaration refer unambiguously
1633 to the method of that class (provided they are in scope at all), even
1634 if there are other variables in scope with the same name.
1635 This reduces the clutter of qualified names when you import two
1636 records from different modules that use the same field name.
1637 </para>
1638 <para>
1639 Some details:
1640 <itemizedlist>
1641 <listitem><para>
1642 Field disambiguation can be combined with punning (see <xref linkend="record-puns"/>). For example:
1643 <programlisting>
1644 module Foo where
1645   import M
1646   x=True
1647   ok3 (MkS { x }) = x+1   -- Uses both disambiguation and punning
1648 </programlisting>
1649 </para></listitem>
1650
1651 <listitem><para>
1652 With <option>-XDisambiguateRecordFields</option> you can use <emphasis>unqualified</emphasis>
1653 field names even if the corresponding selector is only in scope <emphasis>qualified</emphasis>
1654 For example, assuming the same module <literal>M</literal> as in our earlier example, this is legal:
1655 <programlisting>
1656 module Foo where
1657   import qualified M    -- Note qualified
1658
1659   ok4 (M.MkS { x = n }) = n+1   -- Unambiguous
1660 </programlisting>
1661 Since the constructor <literal>MkS</literal> is only in scope qualified, you must
1662 name it <literal>M.MkS</literal>, but the field <literal>x</literal> does not need
1663 to be qualified even though <literal>M.x</literal> is in scope but <literal>x</literal>
1664 is not.  (In effect, it is qualified by the constructor.)
1665 </para></listitem>
1666 </itemizedlist>
1667 </para>
1668
1669 </sect2>
1670
1671     <!-- ===================== Record puns ===================  -->
1672
1673 <sect2 id="record-puns">
1674 <title>Record puns
1675 </title>
1676
1677 <para>
1678 Record puns are enabled by the flag <literal>-XNamedFieldPuns</literal>.
1679 </para>
1680
1681 <para>
1682 When using records, it is common to write a pattern that binds a
1683 variable with the same name as a record field, such as:
1684
1685 <programlisting>
1686 data C = C {a :: Int}
1687 f (C {a = a}) = a
1688 </programlisting>
1689 </para>
1690
1691 <para>
1692 Record punning permits the variable name to be elided, so one can simply
1693 write
1694
1695 <programlisting>
1696 f (C {a}) = a
1697 </programlisting>
1698
1699 to mean the same pattern as above.  That is, in a record pattern, the
1700 pattern <literal>a</literal> expands into the pattern <literal>a =
1701 a</literal> for the same name <literal>a</literal>.
1702 </para>
1703
1704 <para>
1705 Note that:
1706 <itemizedlist>
1707 <listitem><para>
1708 Record punning can also be used in an expression, writing, for example,
1709 <programlisting>
1710 let a = 1 in C {a}
1711 </programlisting>
1712 instead of
1713 <programlisting>
1714 let a = 1 in C {a = a}
1715 </programlisting>
1716 The expansion is purely syntactic, so the expanded right-hand side
1717 expression refers to the nearest enclosing variable that is spelled the
1718 same as the field name.
1719 </para></listitem>
1720
1721 <listitem><para>
1722 Puns and other patterns can be mixed in the same record:
1723 <programlisting>
1724 data C = C {a :: Int, b :: Int}
1725 f (C {a, b = 4}) = a
1726 </programlisting>
1727 </para></listitem>
1728
1729 <listitem><para>
1730 Puns can be used wherever record patterns occur (e.g. in
1731 <literal>let</literal> bindings or at the top-level).
1732 </para></listitem>
1733
1734 <listitem><para>
1735 A pun on a qualified field name is expanded by stripping off the module qualifier.
1736 For example:
1737 <programlisting>
1738 f (C {M.a}) = a
1739 </programlisting>
1740 means
1741 <programlisting>
1742 f (M.C {M.a = a}) = a
1743 </programlisting>
1744 (This is useful if the field selector <literal>a</literal> for constructor <literal>M.C</literal>
1745 is only in scope in qualified form.)
1746 </para></listitem>
1747 </itemizedlist>
1748 </para>
1749
1750
1751 </sect2>
1752
1753     <!-- ===================== Record wildcards ===================  -->
1754
1755 <sect2 id="record-wildcards">
1756 <title>Record wildcards
1757 </title>
1758
1759 <para>
1760 Record wildcards are enabled by the flag <literal>-XRecordWildCards</literal>.
1761 This flag implies <literal>-XDisambiguateRecordFields</literal>.
1762 </para>
1763
1764 <para>
1765 For records with many fields, it can be tiresome to write out each field
1766 individually in a record pattern, as in
1767 <programlisting>
1768 data C = C {a :: Int, b :: Int, c :: Int, d :: Int}
1769 f (C {a = 1, b = b, c = c, d = d}) = b + c + d
1770 </programlisting>
1771 </para>
1772
1773 <para>
1774 Record wildcard syntax permits a "<literal>..</literal>" in a record
1775 pattern, where each elided field <literal>f</literal> is replaced by the
1776 pattern <literal>f = f</literal>.  For example, the above pattern can be
1777 written as
1778 <programlisting>
1779 f (C {a = 1, ..}) = b + c + d
1780 </programlisting>
1781 </para>
1782
1783 <para>
1784 More details:
1785 <itemizedlist>
1786 <listitem><para>
1787 Wildcards can be mixed with other patterns, including puns
1788 (<xref linkend="record-puns"/>); for example, in a pattern <literal>C {a
1789 = 1, b, ..})</literal>.  Additionally, record wildcards can be used
1790 wherever record patterns occur, including in <literal>let</literal>
1791 bindings and at the top-level.  For example, the top-level binding
1792 <programlisting>
1793 C {a = 1, ..} = e
1794 </programlisting>
1795 defines <literal>b</literal>, <literal>c</literal>, and
1796 <literal>d</literal>.
1797 </para></listitem>
1798
1799 <listitem><para>
1800 Record wildcards can also be used in expressions, writing, for example,
1801 <programlisting>
1802 let {a = 1; b = 2; c = 3; d = 4} in C {..}
1803 </programlisting>
1804 in place of
1805 <programlisting>
1806 let {a = 1; b = 2; c = 3; d = 4} in C {a=a, b=b, c=c, d=d}
1807 </programlisting>
1808 The expansion is purely syntactic, so the record wildcard
1809 expression refers to the nearest enclosing variables that are spelled
1810 the same as the omitted field names.
1811 </para></listitem>
1812
1813 <listitem><para>
1814 The "<literal>..</literal>" expands to the missing
1815 <emphasis>in-scope</emphasis> record fields, where "in scope"
1816 includes both unqualified and qualified-only.
1817 Any fields that are not in scope are not filled in.  For example
1818 <programlisting>
1819 module M where
1820   data R = R { a,b,c :: Int }
1821 module X where
1822   import qualified M( R(a,b) )
1823   f a b = R { .. }
1824 </programlisting>
1825 The <literal>{..}</literal> expands to <literal>{M.a=a,M.b=b}</literal>,
1826 omitting <literal>c</literal> since it is not in scope at all.
1827 </para></listitem>
1828 </itemizedlist>
1829 </para>
1830
1831 </sect2>
1832
1833     <!-- ===================== Local fixity declarations ===================  -->
1834
1835 <sect2 id="local-fixity-declarations">
1836 <title>Local Fixity Declarations
1837 </title>
1838
1839 <para>A careful reading of the Haskell 98 Report reveals that fixity
1840 declarations (<literal>infix</literal>, <literal>infixl</literal>, and
1841 <literal>infixr</literal>) are permitted to appear inside local bindings
1842 such those introduced by <literal>let</literal> and
1843 <literal>where</literal>.  However, the Haskell Report does not specify
1844 the semantics of such bindings very precisely.
1845 </para>
1846
1847 <para>In GHC, a fixity declaration may accompany a local binding:
1848 <programlisting>
1849 let f = ...
1850     infixr 3 `f`
1851 in
1852     ...
1853 </programlisting>
1854 and the fixity declaration applies wherever the binding is in scope.
1855 For example, in a <literal>let</literal>, it applies in the right-hand
1856 sides of other <literal>let</literal>-bindings and the body of the
1857 <literal>let</literal>C. Or, in recursive <literal>do</literal>
1858 expressions (<xref linkend="recursive-do-notation"/>), the local fixity
1859 declarations of a <literal>let</literal> statement scope over other
1860 statements in the group, just as the bound name does.
1861 </para>
1862
1863 <para>
1864 Moreover, a local fixity declaration *must* accompany a local binding of
1865 that name: it is not possible to revise the fixity of name bound
1866 elsewhere, as in
1867 <programlisting>
1868 let infixr 9 $ in ...
1869 </programlisting>
1870
1871 Because local fixity declarations are technically Haskell 98, no flag is
1872 necessary to enable them.
1873 </para>
1874 </sect2>
1875
1876 <sect2 id="package-imports">
1877   <title>Package-qualified imports</title>
1878
1879   <para>With the <option>-XPackageImports</option> flag, GHC allows
1880   import declarations to be qualified by the package name that the
1881     module is intended to be imported from.  For example:</para>
1882
1883 <programlisting>
1884 import "network" Network.Socket
1885 </programlisting>
1886
1887   <para>would import the module <literal>Network.Socket</literal> from
1888     the package <literal>network</literal> (any version).  This may
1889     be used to disambiguate an import when the same module is
1890     available from multiple packages, or is present in both the
1891     current package being built and an external package.</para>
1892
1893   <para>Note: you probably don't need to use this feature, it was
1894     added mainly so that we can build backwards-compatible versions of
1895     packages when APIs change.  It can lead to fragile dependencies in
1896     the common case: modules occasionally move from one package to
1897     another, rendering any package-qualified imports broken.</para>
1898 </sect2>
1899
1900 <sect2 id="syntax-stolen">
1901 <title>Summary of stolen syntax</title>
1902
1903     <para>Turning on an option that enables special syntax
1904     <emphasis>might</emphasis> cause working Haskell 98 code to fail
1905     to compile, perhaps because it uses a variable name which has
1906     become a reserved word.  This section lists the syntax that is
1907     "stolen" by language extensions.
1908      We use
1909     notation and nonterminal names from the Haskell 98 lexical syntax
1910     (see the Haskell 98 Report).
1911     We only list syntax changes here that might affect
1912     existing working programs (i.e. "stolen" syntax).  Many of these
1913     extensions will also enable new context-free syntax, but in all
1914     cases programs written to use the new syntax would not be
1915     compilable without the option enabled.</para>
1916
1917 <para>There are two classes of special
1918     syntax:
1919
1920     <itemizedlist>
1921       <listitem>
1922         <para>New reserved words and symbols: character sequences
1923         which are no longer available for use as identifiers in the
1924         program.</para>
1925       </listitem>
1926       <listitem>
1927         <para>Other special syntax: sequences of characters that have
1928         a different meaning when this particular option is turned
1929         on.</para>
1930       </listitem>
1931     </itemizedlist>
1932
1933 The following syntax is stolen:
1934
1935     <variablelist>
1936       <varlistentry>
1937         <term>
1938           <literal>forall</literal>
1939           <indexterm><primary><literal>forall</literal></primary></indexterm>
1940         </term>
1941         <listitem><para>
1942         Stolen (in types) by: <option>-XExplicitForAll</option>, and hence by
1943             <option>-XScopedTypeVariables</option>,
1944             <option>-XLiberalTypeSynonyms</option>,
1945             <option>-XRank2Types</option>,
1946             <option>-XRankNTypes</option>,
1947             <option>-XPolymorphicComponents</option>,
1948             <option>-XExistentialQuantification</option>
1949           </para></listitem>
1950       </varlistentry>
1951
1952       <varlistentry>
1953         <term>
1954           <literal>mdo</literal>
1955           <indexterm><primary><literal>mdo</literal></primary></indexterm>
1956         </term>
1957         <listitem><para>
1958         Stolen by: <option>-XRecursiveDo</option>,
1959           </para></listitem>
1960       </varlistentry>
1961
1962       <varlistentry>
1963         <term>
1964           <literal>foreign</literal>
1965           <indexterm><primary><literal>foreign</literal></primary></indexterm>
1966         </term>
1967         <listitem><para>
1968         Stolen by: <option>-XForeignFunctionInterface</option>,
1969           </para></listitem>
1970       </varlistentry>
1971
1972       <varlistentry>
1973         <term>
1974           <literal>rec</literal>,
1975           <literal>proc</literal>, <literal>-&lt;</literal>,
1976           <literal>&gt;-</literal>, <literal>-&lt;&lt;</literal>,
1977           <literal>&gt;&gt;-</literal>, and <literal>(|</literal>,
1978           <literal>|)</literal> brackets
1979           <indexterm><primary><literal>proc</literal></primary></indexterm>
1980         </term>
1981         <listitem><para>
1982         Stolen by: <option>-XArrows</option>,
1983           </para></listitem>
1984       </varlistentry>
1985
1986       <varlistentry>
1987         <term>
1988           <literal>?<replaceable>varid</replaceable></literal>,
1989           <literal>%<replaceable>varid</replaceable></literal>
1990           <indexterm><primary>implicit parameters</primary></indexterm>
1991         </term>
1992         <listitem><para>
1993         Stolen by: <option>-XImplicitParams</option>,
1994           </para></listitem>
1995       </varlistentry>
1996
1997       <varlistentry>
1998         <term>
1999           <literal>[|</literal>,
2000           <literal>[e|</literal>, <literal>[p|</literal>,
2001           <literal>[d|</literal>, <literal>[t|</literal>,
2002           <literal>$(</literal>,
2003           <literal>$<replaceable>varid</replaceable></literal>
2004           <indexterm><primary>Template Haskell</primary></indexterm>
2005         </term>
2006         <listitem><para>
2007         Stolen by: <option>-XTemplateHaskell</option>,
2008           </para></listitem>
2009       </varlistentry>
2010
2011       <varlistentry>
2012         <term>
2013           <literal>[:<replaceable>varid</replaceable>|</literal>
2014           <indexterm><primary>quasi-quotation</primary></indexterm>
2015         </term>
2016         <listitem><para>
2017         Stolen by: <option>-XQuasiQuotes</option>,
2018           </para></listitem>
2019       </varlistentry>
2020
2021       <varlistentry>
2022         <term>
2023               <replaceable>varid</replaceable>{<literal>&num;</literal>},
2024               <replaceable>char</replaceable><literal>&num;</literal>,
2025               <replaceable>string</replaceable><literal>&num;</literal>,
2026               <replaceable>integer</replaceable><literal>&num;</literal>,
2027               <replaceable>float</replaceable><literal>&num;</literal>,
2028               <replaceable>float</replaceable><literal>&num;&num;</literal>,
2029               <literal>(&num;</literal>, <literal>&num;)</literal>,
2030         </term>
2031         <listitem><para>
2032         Stolen by: <option>-XMagicHash</option>,
2033           </para></listitem>
2034       </varlistentry>
2035     </variablelist>
2036 </para>
2037 </sect2>
2038 </sect1>
2039
2040
2041 <!-- TYPE SYSTEM EXTENSIONS -->
2042 <sect1 id="data-type-extensions">
2043 <title>Extensions to data types and type synonyms</title>
2044
2045 <sect2 id="nullary-types">
2046 <title>Data types with no constructors</title>
2047
2048 <para>With the <option>-fglasgow-exts</option> flag, GHC lets you declare
2049 a data type with no constructors.  For example:</para>
2050
2051 <programlisting>
2052   data S      -- S :: *
2053   data T a    -- T :: * -> *
2054 </programlisting>
2055
2056 <para>Syntactically, the declaration lacks the "= constrs" part.  The
2057 type can be parameterised over types of any kind, but if the kind is
2058 not <literal>*</literal> then an explicit kind annotation must be used
2059 (see <xref linkend="kinding"/>).</para>
2060
2061 <para>Such data types have only one value, namely bottom.
2062 Nevertheless, they can be useful when defining "phantom types".</para>
2063 </sect2>
2064
2065 <sect2 id="datatype-contexts">
2066 <title>Data type contexts</title>
2067
2068 <para>Haskell allows datatypes to be given contexts, e.g.</para>
2069
2070 <programlisting>
2071 data Eq a => Set a = NilSet | ConsSet a (Set a)
2072 </programlisting>
2073
2074 <para>give constructors with types:</para>
2075
2076 <programlisting>
2077 NilSet :: Set a
2078 ConsSet :: Eq a => a -> Set a -> Set a
2079 </programlisting>
2080
2081 <para>In GHC this feature is an extension called
2082 <literal>DatatypeContexts</literal>, and on by default.</para>
2083 </sect2>
2084
2085 <sect2 id="infix-tycons">
2086 <title>Infix type constructors, classes, and type variables</title>
2087
2088 <para>
2089 GHC allows type constructors, classes, and type variables to be operators, and
2090 to be written infix, very much like expressions.  More specifically:
2091 <itemizedlist>
2092 <listitem><para>
2093   A type constructor or class can be an operator, beginning with a colon; e.g. <literal>:*:</literal>.
2094   The lexical syntax is the same as that for data constructors.
2095   </para></listitem>
2096 <listitem><para>
2097   Data type and type-synonym declarations can be written infix, parenthesised
2098   if you want further arguments.  E.g.
2099 <screen>
2100   data a :*: b = Foo a b
2101   type a :+: b = Either a b
2102   class a :=: b where ...
2103
2104   data (a :**: b) x = Baz a b x
2105   type (a :++: b) y = Either (a,b) y
2106 </screen>
2107   </para></listitem>
2108 <listitem><para>
2109   Types, and class constraints, can be written infix.  For example
2110   <screen>
2111         x :: Int :*: Bool
2112         f :: (a :=: b) => a -> b
2113   </screen>
2114   </para></listitem>
2115 <listitem><para>
2116   A type variable can be an (unqualified) operator e.g. <literal>+</literal>.
2117   The lexical syntax is the same as that for variable operators, excluding "(.)",
2118   "(!)", and "(*)".  In a binding position, the operator must be
2119   parenthesised.  For example:
2120 <programlisting>
2121    type T (+) = Int + Int
2122    f :: T Either
2123    f = Left 3
2124
2125    liftA2 :: Arrow (~>)
2126           => (a -> b -> c) -> (e ~> a) -> (e ~> b) -> (e ~> c)
2127    liftA2 = ...
2128 </programlisting>
2129   </para></listitem>
2130 <listitem><para>
2131   Back-quotes work
2132   as for expressions, both for type constructors and type variables;  e.g. <literal>Int `Either` Bool</literal>, or
2133   <literal>Int `a` Bool</literal>.  Similarly, parentheses work the same; e.g.  <literal>(:*:) Int Bool</literal>.
2134   </para></listitem>
2135 <listitem><para>
2136   Fixities may be declared for type constructors, or classes, just as for data constructors.  However,
2137   one cannot distinguish between the two in a fixity declaration; a fixity declaration
2138   sets the fixity for a data constructor and the corresponding type constructor.  For example:
2139 <screen>
2140   infixl 7 T, :*:
2141 </screen>
2142   sets the fixity for both type constructor <literal>T</literal> and data constructor <literal>T</literal>,
2143   and similarly for <literal>:*:</literal>.
2144   <literal>Int `a` Bool</literal>.
2145   </para></listitem>
2146 <listitem><para>
2147   Function arrow is <literal>infixr</literal> with fixity 0.  (This might change; I'm not sure what it should be.)
2148   </para></listitem>
2149
2150 </itemizedlist>
2151 </para>
2152 </sect2>
2153
2154 <sect2 id="type-synonyms">
2155 <title>Liberalised type synonyms</title>
2156
2157 <para>
2158 Type synonyms are like macros at the type level, but Haskell 98 imposes many rules
2159 on individual synonym declarations.
2160 With the <option>-XLiberalTypeSynonyms</option> extension,
2161 GHC does validity checking on types <emphasis>only after expanding type synonyms</emphasis>.
2162 That means that GHC can be very much more liberal about type synonyms than Haskell 98.
2163
2164 <itemizedlist>
2165 <listitem> <para>You can write a <literal>forall</literal> (including overloading)
2166 in a type synonym, thus:
2167 <programlisting>
2168   type Discard a = forall b. Show b => a -> b -> (a, String)
2169
2170   f :: Discard a
2171   f x y = (x, show y)
2172
2173   g :: Discard Int -> (Int,String)    -- A rank-2 type
2174   g f = f 3 True
2175 </programlisting>
2176 </para>
2177 </listitem>
2178
2179 <listitem><para>
2180 If you also use <option>-XUnboxedTuples</option>,
2181 you can write an unboxed tuple in a type synonym:
2182 <programlisting>
2183   type Pr = (# Int, Int #)
2184
2185   h :: Int -> Pr
2186   h x = (# x, x #)
2187 </programlisting>
2188 </para></listitem>
2189
2190 <listitem><para>
2191 You can apply a type synonym to a forall type:
2192 <programlisting>
2193   type Foo a = a -> a -> Bool
2194
2195   f :: Foo (forall b. b->b)
2196 </programlisting>
2197 After expanding the synonym, <literal>f</literal> has the legal (in GHC) type:
2198 <programlisting>
2199   f :: (forall b. b->b) -> (forall b. b->b) -> Bool
2200 </programlisting>
2201 </para></listitem>
2202
2203 <listitem><para>
2204 You can apply a type synonym to a partially applied type synonym:
2205 <programlisting>
2206   type Generic i o = forall x. i x -> o x
2207   type Id x = x
2208
2209   foo :: Generic Id []
2210 </programlisting>
2211 After expanding the synonym, <literal>foo</literal> has the legal (in GHC) type:
2212 <programlisting>
2213   foo :: forall x. x -> [x]
2214 </programlisting>
2215 </para></listitem>
2216
2217 </itemizedlist>
2218 </para>
2219
2220 <para>
2221 GHC currently does kind checking before expanding synonyms (though even that
2222 could be changed.)
2223 </para>
2224 <para>
2225 After expanding type synonyms, GHC does validity checking on types, looking for
2226 the following mal-formedness which isn't detected simply by kind checking:
2227 <itemizedlist>
2228 <listitem><para>
2229 Type constructor applied to a type involving for-alls.
2230 </para></listitem>
2231 <listitem><para>
2232 Unboxed tuple on left of an arrow.
2233 </para></listitem>
2234 <listitem><para>
2235 Partially-applied type synonym.
2236 </para></listitem>
2237 </itemizedlist>
2238 So, for example,
2239 this will be rejected:
2240 <programlisting>
2241   type Pr = (# Int, Int #)
2242
2243   h :: Pr -> Int
2244   h x = ...
2245 </programlisting>
2246 because GHC does not allow  unboxed tuples on the left of a function arrow.
2247 </para>
2248 </sect2>
2249
2250
2251 <sect2 id="existential-quantification">
2252 <title>Existentially quantified data constructors
2253 </title>
2254
2255 <para>
2256 The idea of using existential quantification in data type declarations
2257 was suggested by Perry, and implemented in Hope+ (Nigel Perry, <emphasis>The Implementation
2258 of Practical Functional Programming Languages</emphasis>, PhD Thesis, University of
2259 London, 1991). It was later formalised by Laufer and Odersky
2260 (<emphasis>Polymorphic type inference and abstract data types</emphasis>,
2261 TOPLAS, 16(5), pp1411-1430, 1994).
2262 It's been in Lennart
2263 Augustsson's <command>hbc</command> Haskell compiler for several years, and
2264 proved very useful.  Here's the idea.  Consider the declaration:
2265 </para>
2266
2267 <para>
2268
2269 <programlisting>
2270   data Foo = forall a. MkFoo a (a -> Bool)
2271            | Nil
2272 </programlisting>
2273
2274 </para>
2275
2276 <para>
2277 The data type <literal>Foo</literal> has two constructors with types:
2278 </para>
2279
2280 <para>
2281
2282 <programlisting>
2283   MkFoo :: forall a. a -> (a -> Bool) -> Foo
2284   Nil   :: Foo
2285 </programlisting>
2286
2287 </para>
2288
2289 <para>
2290 Notice that the type variable <literal>a</literal> in the type of <function>MkFoo</function>
2291 does not appear in the data type itself, which is plain <literal>Foo</literal>.
2292 For example, the following expression is fine:
2293 </para>
2294
2295 <para>
2296
2297 <programlisting>
2298   [MkFoo 3 even, MkFoo 'c' isUpper] :: [Foo]
2299 </programlisting>
2300
2301 </para>
2302
2303 <para>
2304 Here, <literal>(MkFoo 3 even)</literal> packages an integer with a function
2305 <function>even</function> that maps an integer to <literal>Bool</literal>; and <function>MkFoo 'c'
2306 isUpper</function> packages a character with a compatible function.  These
2307 two things are each of type <literal>Foo</literal> and can be put in a list.
2308 </para>
2309
2310 <para>
2311 What can we do with a value of type <literal>Foo</literal>?.  In particular,
2312 what happens when we pattern-match on <function>MkFoo</function>?
2313 </para>
2314
2315 <para>
2316
2317 <programlisting>
2318   f (MkFoo val fn) = ???
2319 </programlisting>
2320
2321 </para>
2322
2323 <para>
2324 Since all we know about <literal>val</literal> and <function>fn</function> is that they
2325 are compatible, the only (useful) thing we can do with them is to
2326 apply <function>fn</function> to <literal>val</literal> to get a boolean.  For example:
2327 </para>
2328
2329 <para>
2330
2331 <programlisting>
2332   f :: Foo -> Bool
2333   f (MkFoo val fn) = fn val
2334 </programlisting>
2335
2336 </para>
2337
2338 <para>
2339 What this allows us to do is to package heterogeneous values
2340 together with a bunch of functions that manipulate them, and then treat
2341 that collection of packages in a uniform manner.  You can express
2342 quite a bit of object-oriented-like programming this way.
2343 </para>
2344
2345 <sect3 id="existential">
2346 <title>Why existential?
2347 </title>
2348
2349 <para>
2350 What has this to do with <emphasis>existential</emphasis> quantification?
2351 Simply that <function>MkFoo</function> has the (nearly) isomorphic type
2352 </para>
2353
2354 <para>
2355
2356 <programlisting>
2357   MkFoo :: (exists a . (a, a -> Bool)) -> Foo
2358 </programlisting>
2359
2360 </para>
2361
2362 <para>
2363 But Haskell programmers can safely think of the ordinary
2364 <emphasis>universally</emphasis> quantified type given above, thereby avoiding
2365 adding a new existential quantification construct.
2366 </para>
2367
2368 </sect3>
2369
2370 <sect3 id="existential-with-context">
2371 <title>Existentials and type classes</title>
2372
2373 <para>
2374 An easy extension is to allow
2375 arbitrary contexts before the constructor.  For example:
2376 </para>
2377
2378 <para>
2379
2380 <programlisting>
2381 data Baz = forall a. Eq a => Baz1 a a
2382          | forall b. Show b => Baz2 b (b -> b)
2383 </programlisting>
2384
2385 </para>
2386
2387 <para>
2388 The two constructors have the types you'd expect:
2389 </para>
2390
2391 <para>
2392
2393 <programlisting>
2394 Baz1 :: forall a. Eq a => a -> a -> Baz
2395 Baz2 :: forall b. Show b => b -> (b -> b) -> Baz
2396 </programlisting>
2397
2398 </para>
2399
2400 <para>
2401 But when pattern matching on <function>Baz1</function> the matched values can be compared
2402 for equality, and when pattern matching on <function>Baz2</function> the first matched
2403 value can be converted to a string (as well as applying the function to it).
2404 So this program is legal:
2405 </para>
2406
2407 <para>
2408
2409 <programlisting>
2410   f :: Baz -> String
2411   f (Baz1 p q) | p == q    = "Yes"
2412                | otherwise = "No"
2413   f (Baz2 v fn)            = show (fn v)
2414 </programlisting>
2415
2416 </para>
2417
2418 <para>
2419 Operationally, in a dictionary-passing implementation, the
2420 constructors <function>Baz1</function> and <function>Baz2</function> must store the
2421 dictionaries for <literal>Eq</literal> and <literal>Show</literal> respectively, and
2422 extract it on pattern matching.
2423 </para>
2424
2425 </sect3>
2426
2427 <sect3 id="existential-records">
2428 <title>Record Constructors</title>
2429
2430 <para>
2431 GHC allows existentials to be used with records syntax as well.  For example:
2432
2433 <programlisting>
2434 data Counter a = forall self. NewCounter
2435     { _this    :: self
2436     , _inc     :: self -> self
2437     , _display :: self -> IO ()
2438     , tag      :: a
2439     }
2440 </programlisting>
2441 Here <literal>tag</literal> is a public field, with a well-typed selector
2442 function <literal>tag :: Counter a -> a</literal>.  The <literal>self</literal>
2443 type is hidden from the outside; any attempt to apply <literal>_this</literal>,
2444 <literal>_inc</literal> or <literal>_display</literal> as functions will raise a
2445 compile-time error.  In other words, <emphasis>GHC defines a record selector function
2446 only for fields whose type does not mention the existentially-quantified variables</emphasis>.
2447 (This example used an underscore in the fields for which record selectors
2448 will not be defined, but that is only programming style; GHC ignores them.)
2449 </para>
2450
2451 <para>
2452 To make use of these hidden fields, we need to create some helper functions:
2453
2454 <programlisting>
2455 inc :: Counter a -> Counter a
2456 inc (NewCounter x i d t) = NewCounter
2457     { _this = i x, _inc = i, _display = d, tag = t }
2458
2459 display :: Counter a -> IO ()
2460 display NewCounter{ _this = x, _display = d } = d x
2461 </programlisting>
2462
2463 Now we can define counters with different underlying implementations:
2464
2465 <programlisting>
2466 counterA :: Counter String
2467 counterA = NewCounter
2468     { _this = 0, _inc = (1+), _display = print, tag = "A" }
2469
2470 counterB :: Counter String
2471 counterB = NewCounter
2472     { _this = "", _inc = ('#':), _display = putStrLn, tag = "B" }
2473
2474 main = do
2475     display (inc counterA)         -- prints "1"
2476     display (inc (inc counterB))   -- prints "##"
2477 </programlisting>
2478
2479 Record update syntax is supported for existentials (and GADTs):
2480 <programlisting>
2481 setTag :: Counter a -> a -> Counter a
2482 setTag obj t = obj{ tag = t }
2483 </programlisting>
2484 The rule for record update is this: <emphasis>
2485 the types of the updated fields may
2486 mention only the universally-quantified type variables
2487 of the data constructor.  For GADTs, the field may mention only types
2488 that appear as a simple type-variable argument in the constructor's result
2489 type</emphasis>.  For example:
2490 <programlisting>
2491 data T a b where { T1 { f1::a, f2::b, f3::(b,c) } :: T a b } -- c is existential
2492 upd1 t x = t { f1=x }   -- OK:   upd1 :: T a b -> a' -> T a' b
2493 upd2 t x = t { f3=x }   -- BAD   (f3's type mentions c, which is
2494                         --        existentially quantified)
2495
2496 data G a b where { G1 { g1::a, g2::c } :: G a [c] }
2497 upd3 g x = g { g1=x }   -- OK:   upd3 :: G a b -> c -> G c b
2498 upd4 g x = g { g2=x }   -- BAD (f2's type mentions c, which is not a simple
2499                         --      type-variable argument in G1's result type)
2500 </programlisting>
2501 </para>
2502
2503 </sect3>
2504
2505
2506 <sect3>
2507 <title>Restrictions</title>
2508
2509 <para>
2510 There are several restrictions on the ways in which existentially-quantified
2511 constructors can be use.
2512 </para>
2513
2514 <para>
2515
2516 <itemizedlist>
2517 <listitem>
2518
2519 <para>
2520  When pattern matching, each pattern match introduces a new,
2521 distinct, type for each existential type variable.  These types cannot
2522 be unified with any other type, nor can they escape from the scope of
2523 the pattern match.  For example, these fragments are incorrect:
2524
2525
2526 <programlisting>
2527 f1 (MkFoo a f) = a
2528 </programlisting>
2529
2530
2531 Here, the type bound by <function>MkFoo</function> "escapes", because <literal>a</literal>
2532 is the result of <function>f1</function>.  One way to see why this is wrong is to
2533 ask what type <function>f1</function> has:
2534
2535
2536 <programlisting>
2537   f1 :: Foo -> a             -- Weird!
2538 </programlisting>
2539
2540
2541 What is this "<literal>a</literal>" in the result type? Clearly we don't mean
2542 this:
2543
2544
2545 <programlisting>
2546   f1 :: forall a. Foo -> a   -- Wrong!
2547 </programlisting>
2548
2549
2550 The original program is just plain wrong.  Here's another sort of error
2551
2552
2553 <programlisting>
2554   f2 (Baz1 a b) (Baz1 p q) = a==q
2555 </programlisting>
2556
2557
2558 It's ok to say <literal>a==b</literal> or <literal>p==q</literal>, but
2559 <literal>a==q</literal> is wrong because it equates the two distinct types arising
2560 from the two <function>Baz1</function> constructors.
2561
2562
2563 </para>
2564 </listitem>
2565 <listitem>
2566
2567 <para>
2568 You can't pattern-match on an existentially quantified
2569 constructor in a <literal>let</literal> or <literal>where</literal> group of
2570 bindings. So this is illegal:
2571
2572
2573 <programlisting>
2574   f3 x = a==b where { Baz1 a b = x }
2575 </programlisting>
2576
2577 Instead, use a <literal>case</literal> expression:
2578
2579 <programlisting>
2580   f3 x = case x of Baz1 a b -> a==b
2581 </programlisting>
2582
2583 In general, you can only pattern-match
2584 on an existentially-quantified constructor in a <literal>case</literal> expression or
2585 in the patterns of a function definition.
2586
2587 The reason for this restriction is really an implementation one.
2588 Type-checking binding groups is already a nightmare without
2589 existentials complicating the picture.  Also an existential pattern
2590 binding at the top level of a module doesn't make sense, because it's
2591 not clear how to prevent the existentially-quantified type "escaping".
2592 So for now, there's a simple-to-state restriction.  We'll see how
2593 annoying it is.
2594
2595 </para>
2596 </listitem>
2597 <listitem>
2598
2599 <para>
2600 You can't use existential quantification for <literal>newtype</literal>
2601 declarations.  So this is illegal:
2602
2603
2604 <programlisting>
2605   newtype T = forall a. Ord a => MkT a
2606 </programlisting>
2607
2608
2609 Reason: a value of type <literal>T</literal> must be represented as a
2610 pair of a dictionary for <literal>Ord t</literal> and a value of type
2611 <literal>t</literal>.  That contradicts the idea that
2612 <literal>newtype</literal> should have no concrete representation.
2613 You can get just the same efficiency and effect by using
2614 <literal>data</literal> instead of <literal>newtype</literal>.  If
2615 there is no overloading involved, then there is more of a case for
2616 allowing an existentially-quantified <literal>newtype</literal>,
2617 because the <literal>data</literal> version does carry an
2618 implementation cost, but single-field existentially quantified
2619 constructors aren't much use.  So the simple restriction (no
2620 existential stuff on <literal>newtype</literal>) stands, unless there
2621 are convincing reasons to change it.
2622
2623
2624 </para>
2625 </listitem>
2626 <listitem>
2627
2628 <para>
2629  You can't use <literal>deriving</literal> to define instances of a
2630 data type with existentially quantified data constructors.
2631
2632 Reason: in most cases it would not make sense. For example:;
2633
2634 <programlisting>
2635 data T = forall a. MkT [a] deriving( Eq )
2636 </programlisting>
2637
2638 To derive <literal>Eq</literal> in the standard way we would need to have equality
2639 between the single component of two <function>MkT</function> constructors:
2640
2641 <programlisting>
2642 instance Eq T where
2643   (MkT a) == (MkT b) = ???
2644 </programlisting>
2645
2646 But <varname>a</varname> and <varname>b</varname> have distinct types, and so can't be compared.
2647 It's just about possible to imagine examples in which the derived instance
2648 would make sense, but it seems altogether simpler simply to prohibit such
2649 declarations.  Define your own instances!
2650 </para>
2651 </listitem>
2652
2653 </itemizedlist>
2654
2655 </para>
2656
2657 </sect3>
2658 </sect2>
2659
2660 <!-- ====================== Generalised algebraic data types =======================  -->
2661
2662 <sect2 id="gadt-style">
2663 <title>Declaring data types with explicit constructor signatures</title>
2664
2665 <para>When the <literal>GADTSyntax</literal> extension is enabled,
2666 GHC allows you to declare an algebraic data type by
2667 giving the type signatures of constructors explicitly.  For example:
2668 <programlisting>
2669   data Maybe a where
2670       Nothing :: Maybe a
2671       Just    :: a -> Maybe a
2672 </programlisting>
2673 The form is called a "GADT-style declaration"
2674 because Generalised Algebraic Data Types, described in <xref linkend="gadt"/>,
2675 can only be declared using this form.</para>
2676 <para>Notice that GADT-style syntax generalises existential types (<xref linkend="existential-quantification"/>).
2677 For example, these two declarations are equivalent:
2678 <programlisting>
2679   data Foo = forall a. MkFoo a (a -> Bool)
2680   data Foo' where { MKFoo :: a -> (a->Bool) -> Foo' }
2681 </programlisting>
2682 </para>
2683 <para>Any data type that can be declared in standard Haskell-98 syntax
2684 can also be declared using GADT-style syntax.
2685 The choice is largely stylistic, but GADT-style declarations differ in one important respect:
2686 they treat class constraints on the data constructors differently.
2687 Specifically, if the constructor is given a type-class context, that
2688 context is made available by pattern matching.  For example:
2689 <programlisting>
2690   data Set a where
2691     MkSet :: Eq a => [a] -> Set a
2692
2693   makeSet :: Eq a => [a] -> Set a
2694   makeSet xs = MkSet (nub xs)
2695
2696   insert :: a -> Set a -> Set a
2697   insert a (MkSet as) | a `elem` as = MkSet as
2698                       | otherwise   = MkSet (a:as)
2699 </programlisting>
2700 A use of <literal>MkSet</literal> as a constructor (e.g. in the definition of <literal>makeSet</literal>)
2701 gives rise to a <literal>(Eq a)</literal>
2702 constraint, as you would expect.  The new feature is that pattern-matching on <literal>MkSet</literal>
2703 (as in the definition of <literal>insert</literal>) makes <emphasis>available</emphasis> an <literal>(Eq a)</literal>
2704 context.  In implementation terms, the <literal>MkSet</literal> constructor has a hidden field that stores
2705 the <literal>(Eq a)</literal> dictionary that is passed to <literal>MkSet</literal>; so
2706 when pattern-matching that dictionary becomes available for the right-hand side of the match.
2707 In the example, the equality dictionary is used to satisfy the equality constraint
2708 generated by the call to <literal>elem</literal>, so that the type of
2709 <literal>insert</literal> itself has no <literal>Eq</literal> constraint.
2710 </para>
2711 <para>
2712 For example, one possible application is to reify dictionaries:
2713 <programlisting>
2714    data NumInst a where
2715      MkNumInst :: Num a => NumInst a
2716
2717    intInst :: NumInst Int
2718    intInst = MkNumInst
2719
2720    plus :: NumInst a -> a -> a -> a
2721    plus MkNumInst p q = p + q
2722 </programlisting>
2723 Here, a value of type <literal>NumInst a</literal> is equivalent
2724 to an explicit <literal>(Num a)</literal> dictionary.
2725 </para>
2726 <para>
2727 All this applies to constructors declared using the syntax of <xref linkend="existential-with-context"/>.
2728 For example, the <literal>NumInst</literal> data type above could equivalently be declared
2729 like this:
2730 <programlisting>
2731    data NumInst a
2732       = Num a => MkNumInst (NumInst a)
2733 </programlisting>
2734 Notice that, unlike the situation when declaring an existential, there is
2735 no <literal>forall</literal>, because the <literal>Num</literal> constrains the
2736 data type's universally quantified type variable <literal>a</literal>.
2737 A constructor may have both universal and existential type variables: for example,
2738 the following two declarations are equivalent:
2739 <programlisting>
2740    data T1 a
2741         = forall b. (Num a, Eq b) => MkT1 a b
2742    data T2 a where
2743         MkT2 :: (Num a, Eq b) => a -> b -> T2 a
2744 </programlisting>
2745 </para>
2746 <para>All this behaviour contrasts with Haskell 98's peculiar treatment of
2747 contexts on a data type declaration (Section 4.2.1 of the Haskell 98 Report).
2748 In Haskell 98 the definition
2749 <programlisting>
2750   data Eq a => Set' a = MkSet' [a]
2751 </programlisting>
2752 gives <literal>MkSet'</literal> the same type as <literal>MkSet</literal> above.  But instead of
2753 <emphasis>making available</emphasis> an <literal>(Eq a)</literal> constraint, pattern-matching
2754 on <literal>MkSet'</literal> <emphasis>requires</emphasis> an <literal>(Eq a)</literal> constraint!
2755 GHC faithfully implements this behaviour, odd though it is.  But for GADT-style declarations,
2756 GHC's behaviour is much more useful, as well as much more intuitive.
2757 </para>
2758
2759 <para>
2760 The rest of this section gives further details about GADT-style data
2761 type declarations.
2762
2763 <itemizedlist>
2764 <listitem><para>
2765 The result type of each data constructor must begin with the type constructor being defined.
2766 If the result type of all constructors
2767 has the form <literal>T a1 ... an</literal>, where <literal>a1 ... an</literal>
2768 are distinct type variables, then the data type is <emphasis>ordinary</emphasis>;
2769 otherwise is a <emphasis>generalised</emphasis> data type (<xref linkend="gadt"/>).
2770 </para></listitem>
2771
2772 <listitem><para>
2773 As with other type signatures, you can give a single signature for several data constructors.
2774 In this example we give a single signature for <literal>T1</literal> and <literal>T2</literal>:
2775 <programlisting>
2776   data T a where
2777     T1,T2 :: a -> T a
2778     T3 :: T a
2779 </programlisting>
2780 </para></listitem>
2781
2782 <listitem><para>
2783 The type signature of
2784 each constructor is independent, and is implicitly universally quantified as usual.
2785 In particular, the type variable(s) in the "<literal>data T a where</literal>" header
2786 have no scope, and different constructors may have different universally-quantified type variables:
2787 <programlisting>
2788   data T a where        -- The 'a' has no scope
2789     T1,T2 :: b -> T b   -- Means forall b. b -> T b
2790     T3 :: T a           -- Means forall a. T a
2791 </programlisting>
2792 </para></listitem>
2793
2794 <listitem><para>
2795 A constructor signature may mention type class constraints, which can differ for
2796 different constructors.  For example, this is fine:
2797 <programlisting>
2798   data T a where
2799     T1 :: Eq b => b -> b -> T b
2800     T2 :: (Show c, Ix c) => c -> [c] -> T c
2801 </programlisting>
2802 When pattern matching, these constraints are made available to discharge constraints
2803 in the body of the match. For example:
2804 <programlisting>
2805   f :: T a -> String
2806   f (T1 x y) | x==y      = "yes"
2807              | otherwise = "no"
2808   f (T2 a b)             = show a
2809 </programlisting>
2810 Note that <literal>f</literal> is not overloaded; the <literal>Eq</literal> constraint arising
2811 from the use of <literal>==</literal> is discharged by the pattern match on <literal>T1</literal>
2812 and similarly the <literal>Show</literal> constraint arising from the use of <literal>show</literal>.
2813 </para></listitem>
2814
2815 <listitem><para>
2816 Unlike a Haskell-98-style
2817 data type declaration, the type variable(s) in the "<literal>data Set a where</literal>" header
2818 have no scope.  Indeed, one can write a kind signature instead:
2819 <programlisting>
2820   data Set :: * -> * where ...
2821 </programlisting>
2822 or even a mixture of the two:
2823 <programlisting>
2824   data Bar a :: (* -> *) -> * where ...
2825 </programlisting>
2826 The type variables (if given) may be explicitly kinded, so we could also write the header for <literal>Foo</literal>
2827 like this:
2828 <programlisting>
2829   data Bar a (b :: * -> *) where ...
2830 </programlisting>
2831 </para></listitem>
2832
2833
2834 <listitem><para>
2835 You can use strictness annotations, in the obvious places
2836 in the constructor type:
2837 <programlisting>
2838   data Term a where
2839       Lit    :: !Int -> Term Int
2840       If     :: Term Bool -> !(Term a) -> !(Term a) -> Term a
2841       Pair   :: Term a -> Term b -> Term (a,b)
2842 </programlisting>
2843 </para></listitem>
2844
2845 <listitem><para>
2846 You can use a <literal>deriving</literal> clause on a GADT-style data type
2847 declaration.   For example, these two declarations are equivalent
2848 <programlisting>
2849   data Maybe1 a where {
2850       Nothing1 :: Maybe1 a ;
2851       Just1    :: a -> Maybe1 a
2852     } deriving( Eq, Ord )
2853
2854   data Maybe2 a = Nothing2 | Just2 a
2855        deriving( Eq, Ord )
2856 </programlisting>
2857 </para></listitem>
2858
2859 <listitem><para>
2860 The type signature may have quantified type variables that do not appear
2861 in the result type:
2862 <programlisting>
2863   data Foo where
2864      MkFoo :: a -> (a->Bool) -> Foo
2865      Nil   :: Foo
2866 </programlisting>
2867 Here the type variable <literal>a</literal> does not appear in the result type
2868 of either constructor.
2869 Although it is universally quantified in the type of the constructor, such
2870 a type variable is often called "existential".
2871 Indeed, the above declaration declares precisely the same type as
2872 the <literal>data Foo</literal> in <xref linkend="existential-quantification"/>.
2873 </para><para>
2874 The type may contain a class context too, of course:
2875 <programlisting>
2876   data Showable where
2877     MkShowable :: Show a => a -> Showable
2878 </programlisting>
2879 </para></listitem>
2880
2881 <listitem><para>
2882 You can use record syntax on a GADT-style data type declaration:
2883
2884 <programlisting>
2885   data Person where
2886       Adult :: { name :: String, children :: [Person] } -> Person
2887       Child :: Show a => { name :: !String, funny :: a } -> Person
2888 </programlisting>
2889 As usual, for every constructor that has a field <literal>f</literal>, the type of
2890 field <literal>f</literal> must be the same (modulo alpha conversion).
2891 The <literal>Child</literal> constructor above shows that the signature
2892 may have a context, existentially-quantified variables, and strictness annotations,
2893 just as in the non-record case.  (NB: the "type" that follows the double-colon
2894 is not really a type, because of the record syntax and strictness annotations.
2895 A "type" of this form can appear only in a constructor signature.)
2896 </para></listitem>
2897
2898 <listitem><para>
2899 Record updates are allowed with GADT-style declarations,
2900 only fields that have the following property: the type of the field
2901 mentions no existential type variables.
2902 </para></listitem>
2903
2904 <listitem><para>
2905 As in the case of existentials declared using the Haskell-98-like record syntax
2906 (<xref linkend="existential-records"/>),
2907 record-selector functions are generated only for those fields that have well-typed
2908 selectors.
2909 Here is the example of that section, in GADT-style syntax:
2910 <programlisting>
2911 data Counter a where
2912     NewCounter { _this    :: self
2913                , _inc     :: self -> self
2914                , _display :: self -> IO ()
2915                , tag      :: a
2916                }
2917         :: Counter a
2918 </programlisting>
2919 As before, only one selector function is generated here, that for <literal>tag</literal>.
2920 Nevertheless, you can still use all the field names in pattern matching and record construction.
2921 </para></listitem>
2922 </itemizedlist></para>
2923 </sect2>
2924
2925 <sect2 id="gadt">
2926 <title>Generalised Algebraic Data Types (GADTs)</title>
2927
2928 <para>Generalised Algebraic Data Types generalise ordinary algebraic data types
2929 by allowing constructors to have richer return types.  Here is an example:
2930 <programlisting>
2931   data Term a where
2932       Lit    :: Int -> Term Int
2933       Succ   :: Term Int -> Term Int
2934       IsZero :: Term Int -> Term Bool
2935       If     :: Term Bool -> Term a -> Term a -> Term a
2936       Pair   :: Term a -> Term b -> Term (a,b)
2937 </programlisting>
2938 Notice that the return type of the constructors is not always <literal>Term a</literal>, as is the
2939 case with ordinary data types.  This generality allows us to
2940 write a well-typed <literal>eval</literal> function
2941 for these <literal>Terms</literal>:
2942 <programlisting>
2943   eval :: Term a -> a
2944   eval (Lit i)      = i
2945   eval (Succ t)     = 1 + eval t
2946   eval (IsZero t)   = eval t == 0
2947   eval (If b e1 e2) = if eval b then eval e1 else eval e2
2948   eval (Pair e1 e2) = (eval e1, eval e2)
2949 </programlisting>
2950 The key point about GADTs is that <emphasis>pattern matching causes type refinement</emphasis>.
2951 For example, in the right hand side of the equation
2952 <programlisting>
2953   eval :: Term a -> a
2954   eval (Lit i) =  ...
2955 </programlisting>
2956 the type <literal>a</literal> is refined to <literal>Int</literal>.  That's the whole point!
2957 A precise specification of the type rules is beyond what this user manual aspires to,
2958 but the design closely follows that described in
2959 the paper <ulink
2960 url="http://research.microsoft.com/%7Esimonpj/papers/gadt/">Simple
2961 unification-based type inference for GADTs</ulink>,
2962 (ICFP 2006).
2963 The general principle is this: <emphasis>type refinement is only carried out
2964 based on user-supplied type annotations</emphasis>.
2965 So if no type signature is supplied for <literal>eval</literal>, no type refinement happens,
2966 and lots of obscure error messages will
2967 occur.  However, the refinement is quite general.  For example, if we had:
2968 <programlisting>
2969   eval :: Term a -> a -> a
2970   eval (Lit i) j =  i+j
2971 </programlisting>
2972 the pattern match causes the type <literal>a</literal> to be refined to <literal>Int</literal> (because of the type
2973 of the constructor <literal>Lit</literal>), and that refinement also applies to the type of <literal>j</literal>, and
2974 the result type of the <literal>case</literal> expression.  Hence the addition <literal>i+j</literal> is legal.
2975 </para>
2976 <para>
2977 These and many other examples are given in papers by Hongwei Xi, and
2978 Tim Sheard. There is a longer introduction
2979 <ulink url="http://www.haskell.org/haskellwiki/GADT">on the wiki</ulink>,
2980 and Ralf Hinze's
2981 <ulink url="http://www.informatik.uni-bonn.de/~ralf/publications/With.pdf">Fun with phantom types</ulink> also has a number of examples. Note that papers
2982 may use different notation to that implemented in GHC.
2983 </para>
2984 <para>
2985 The rest of this section outlines the extensions to GHC that support GADTs.   The extension is enabled with
2986 <option>-XGADTs</option>.  The <option>-XGADTs</option> flag also sets <option>-XRelaxedPolyRec</option>.
2987 <itemizedlist>
2988 <listitem><para>
2989 A GADT can only be declared using GADT-style syntax (<xref linkend="gadt-style"/>);
2990 the old Haskell-98 syntax for data declarations always declares an ordinary data type.
2991 The result type of each constructor must begin with the type constructor being defined,
2992 but for a GADT the arguments to the type constructor can be arbitrary monotypes.
2993 For example, in the <literal>Term</literal> data
2994 type above, the type of each constructor must end with <literal>Term ty</literal>, but
2995 the <literal>ty</literal> need not be a type variable (e.g. the <literal>Lit</literal>
2996 constructor).
2997 </para></listitem>
2998
2999 <listitem><para>
3000 It is permitted to declare an ordinary algebraic data type using GADT-style syntax.
3001 What makes a GADT into a GADT is not the syntax, but rather the presence of data constructors
3002 whose result type is not just <literal>T a b</literal>.
3003 </para></listitem>
3004
3005 <listitem><para>
3006 You cannot use a <literal>deriving</literal> clause for a GADT; only for
3007 an ordinary data type.
3008 </para></listitem>
3009
3010 <listitem><para>
3011 As mentioned in <xref linkend="gadt-style"/>, record syntax is supported.
3012 For example:
3013 <programlisting>
3014   data Term a where
3015       Lit    { val  :: Int }      :: Term Int
3016       Succ   { num  :: Term Int } :: Term Int
3017       Pred   { num  :: Term Int } :: Term Int
3018       IsZero { arg  :: Term Int } :: Term Bool
3019       Pair   { arg1 :: Term a
3020              , arg2 :: Term b
3021              }                    :: Term (a,b)
3022       If     { cnd  :: Term Bool
3023              , tru  :: Term a
3024              , fls  :: Term a
3025              }                    :: Term a
3026 </programlisting>
3027 However, for GADTs there is the following additional constraint:
3028 every constructor that has a field <literal>f</literal> must have
3029 the same result type (modulo alpha conversion)
3030 Hence, in the above example, we cannot merge the <literal>num</literal>
3031 and <literal>arg</literal> fields above into a
3032 single name.  Although their field types are both <literal>Term Int</literal>,
3033 their selector functions actually have different types:
3034
3035 <programlisting>
3036   num :: Term Int -> Term Int
3037   arg :: Term Bool -> Term Int
3038 </programlisting>
3039 </para></listitem>
3040
3041 <listitem><para>
3042 When pattern-matching against data constructors drawn from a GADT,
3043 for example in a <literal>case</literal> expression, the following rules apply:
3044 <itemizedlist>
3045 <listitem><para>The type of the scrutinee must be rigid.</para></listitem>
3046 <listitem><para>The type of the entire <literal>case</literal> expression must be rigid.</para></listitem>
3047 <listitem><para>The type of any free variable mentioned in any of
3048 the <literal>case</literal> alternatives must be rigid.</para></listitem>
3049 </itemizedlist>
3050 A type is "rigid" if it is completely known to the compiler at its binding site.  The easiest
3051 way to ensure that a variable a rigid type is to give it a type signature.
3052 For more precise details see <ulink url="http://research.microsoft.com/%7Esimonpj/papers/gadt">
3053 Simple unification-based type inference for GADTs
3054 </ulink>. The criteria implemented by GHC are given in the Appendix.
3055
3056 </para></listitem>
3057
3058 </itemizedlist>
3059 </para>
3060
3061 </sect2>
3062 </sect1>
3063
3064 <!-- ====================== End of Generalised algebraic data types =======================  -->
3065
3066 <sect1 id="deriving">
3067 <title>Extensions to the "deriving" mechanism</title>
3068
3069 <sect2 id="deriving-inferred">
3070 <title>Inferred context for deriving clauses</title>
3071
3072 <para>
3073 The Haskell Report is vague about exactly when a <literal>deriving</literal> clause is
3074 legal.  For example:
3075 <programlisting>
3076   data T0 f a = MkT0 a         deriving( Eq )
3077   data T1 f a = MkT1 (f a)     deriving( Eq )
3078   data T2 f a = MkT2 (f (f a)) deriving( Eq )
3079 </programlisting>
3080 The natural generated <literal>Eq</literal> code would result in these instance declarations:
3081 <programlisting>
3082   instance Eq a         => Eq (T0 f a) where ...
3083   instance Eq (f a)     => Eq (T1 f a) where ...
3084   instance Eq (f (f a)) => Eq (T2 f a) where ...
3085 </programlisting>
3086 The first of these is obviously fine. The second is still fine, although less obviously.
3087 The third is not Haskell 98, and risks losing termination of instances.
3088 </para>
3089 <para>
3090 GHC takes a conservative position: it accepts the first two, but not the third.  The  rule is this:
3091 each constraint in the inferred instance context must consist only of type variables,
3092 with no repetitions.
3093 </para>
3094 <para>
3095 This rule is applied regardless of flags.  If you want a more exotic context, you can write
3096 it yourself, using the <link linkend="stand-alone-deriving">standalone deriving mechanism</link>.
3097 </para>
3098 </sect2>
3099
3100 <sect2 id="stand-alone-deriving">
3101 <title>Stand-alone deriving declarations</title>
3102
3103 <para>
3104 GHC now allows stand-alone <literal>deriving</literal> declarations, enabled by <literal>-XStandaloneDeriving</literal>:
3105 <programlisting>
3106   data Foo a = Bar a | Baz String
3107
3108   deriving instance Eq a => Eq (Foo a)
3109 </programlisting>
3110 The syntax is identical to that of an ordinary instance declaration apart from (a) the keyword
3111 <literal>deriving</literal>, and (b) the absence of the <literal>where</literal> part.
3112 Note the following points:
3113 <itemizedlist>
3114 <listitem><para>
3115 You must supply an explicit context (in the example the context is <literal>(Eq a)</literal>),
3116 exactly as you would in an ordinary instance declaration.
3117 (In contrast, in a <literal>deriving</literal> clause
3118 attached to a data type declaration, the context is inferred.)
3119 </para></listitem>
3120
3121 <listitem><para>
3122 A <literal>deriving instance</literal> declaration
3123 must obey the same rules concerning form and termination as ordinary instance declarations,
3124 controlled by the same flags; see <xref linkend="instance-decls"/>.
3125 </para></listitem>
3126
3127 <listitem><para>
3128 Unlike a <literal>deriving</literal>
3129 declaration attached to a <literal>data</literal> declaration, the instance can be more specific
3130 than the data type (assuming you also use
3131 <literal>-XFlexibleInstances</literal>, <xref linkend="instance-rules"/>).  Consider
3132 for example
3133 <programlisting>
3134   data Foo a = Bar a | Baz String
3135
3136   deriving instance Eq a => Eq (Foo [a])
3137   deriving instance Eq a => Eq (Foo (Maybe a))
3138 </programlisting>
3139 This will generate a derived instance for <literal>(Foo [a])</literal> and <literal>(Foo (Maybe a))</literal>,
3140 but other types such as <literal>(Foo (Int,Bool))</literal> will not be an instance of <literal>Eq</literal>.
3141 </para></listitem>
3142
3143 <listitem><para>
3144 Unlike a <literal>deriving</literal>
3145 declaration attached to a <literal>data</literal> declaration,
3146 GHC does not restrict the form of the data type.  Instead, GHC simply generates the appropriate
3147 boilerplate code for the specified class, and typechecks it. If there is a type error, it is
3148 your problem. (GHC will show you the offending code if it has a type error.)
3149 The merit of this is that you can derive instances for GADTs and other exotic
3150 data types, providing only that the boilerplate code does indeed typecheck.  For example:
3151 <programlisting>
3152   data T a where
3153      T1 :: T Int
3154      T2 :: T Bool
3155
3156   deriving instance Show (T a)
3157 </programlisting>
3158 In this example, you cannot say <literal>... deriving( Show )</literal> on the
3159 data type declaration for <literal>T</literal>,
3160 because <literal>T</literal> is a GADT, but you <emphasis>can</emphasis> generate
3161 the instance declaration using stand-alone deriving.
3162 </para>
3163 </listitem>
3164
3165 <listitem>
3166 <para>The stand-alone syntax is generalised for newtypes in exactly the same
3167 way that ordinary <literal>deriving</literal> clauses are generalised (<xref linkend="newtype-deriving"/>).
3168 For example:
3169 <programlisting>
3170   newtype Foo a = MkFoo (State Int a)
3171
3172   deriving instance MonadState Int Foo
3173 </programlisting>
3174 GHC always treats the <emphasis>last</emphasis> parameter of the instance
3175 (<literal>Foo</literal> in this example) as the type whose instance is being derived.
3176 </para></listitem>
3177 </itemizedlist></para>
3178
3179 </sect2>
3180
3181
3182 <sect2 id="deriving-typeable">
3183 <title>Deriving clause for extra classes (<literal>Typeable</literal>, <literal>Data</literal>, etc)</title>
3184
3185 <para>
3186 Haskell 98 allows the programmer to add "<literal>deriving( Eq, Ord )</literal>" to a data type
3187 declaration, to generate a standard instance declaration for classes specified in the <literal>deriving</literal> clause.
3188 In Haskell 98, the only classes that may appear in the <literal>deriving</literal> clause are the standard
3189 classes <literal>Eq</literal>, <literal>Ord</literal>,
3190 <literal>Enum</literal>, <literal>Ix</literal>, <literal>Bounded</literal>, <literal>Read</literal>, and <literal>Show</literal>.
3191 </para>
3192 <para>
3193 GHC extends this list with several more classes that may be automatically derived:
3194 <itemizedlist>
3195 <listitem><para> With <option>-XDeriveDataTypeable</option>, you can derive instances of the classes
3196 <literal>Typeable</literal>, and <literal>Data</literal>, defined in the library
3197 modules <literal>Data.Typeable</literal> and <literal>Data.Generics</literal> respectively.
3198 </para>
3199 <para>An instance of <literal>Typeable</literal> can only be derived if the
3200 data type has seven or fewer type parameters, all of kind <literal>*</literal>.
3201 The reason for this is that the <literal>Typeable</literal> class is derived using the scheme
3202 described in
3203 <ulink url="http://research.microsoft.com/%7Esimonpj/papers/hmap/gmap2.ps">
3204 Scrap More Boilerplate: Reflection, Zips, and Generalised Casts
3205 </ulink>.
3206 (Section 7.4 of the paper describes the multiple <literal>Typeable</literal> classes that
3207 are used, and only <literal>Typeable1</literal> up to
3208 <literal>Typeable7</literal> are provided in the library.)
3209 In other cases, there is nothing to stop the programmer writing a <literal>TypeableX</literal>
3210 class, whose kind suits that of the data type constructor, and
3211 then writing the data type instance by hand.
3212 </para>
3213 </listitem>
3214
3215 <listitem><para> With <option>-XDeriveGeneric</option>, you can derive
3216 instances of  the class <literal>Generic</literal>, defined in
3217 <literal>GHC.Generics</literal>. You can use these to define generic functions,
3218 as described in <xref linkend="generic-programming"/>.
3219 </para></listitem>
3220
3221 <listitem><para> With <option>-XDeriveFunctor</option>, you can derive instances of
3222 the class <literal>Functor</literal>,
3223 defined in <literal>GHC.Base</literal>.
3224 </para></listitem>
3225
3226 <listitem><para> With <option>-XDeriveFoldable</option>, you can derive instances of
3227 the class <literal>Foldable</literal>,
3228 defined in <literal>Data.Foldable</literal>.
3229 </para></listitem>
3230
3231 <listitem><para> With <option>-XDeriveTraversable</option>, you can derive instances of
3232 the class <literal>Traversable</literal>,
3233 defined in <literal>Data.Traversable</literal>.
3234 </para></listitem>
3235 </itemizedlist>
3236 In each case the appropriate class must be in scope before it
3237 can be mentioned in the <literal>deriving</literal> clause.
3238 </para>
3239 </sect2>
3240
3241 <sect2 id="newtype-deriving">
3242 <title>Generalised derived instances for newtypes</title>
3243
3244 <para>
3245 When you define an abstract type using <literal>newtype</literal>, you may want
3246 the new type to inherit some instances from its representation. In
3247 Haskell 98, you can inherit instances of <literal>Eq</literal>, <literal>Ord</literal>,
3248 <literal>Enum</literal> and <literal>Bounded</literal> by deriving them, but for any
3249 other classes you have to write an explicit instance declaration. For
3250 example, if you define
3251
3252 <programlisting>
3253   newtype Dollars = Dollars Int
3254 </programlisting>
3255
3256 and you want to use arithmetic on <literal>Dollars</literal>, you have to
3257 explicitly define an instance of <literal>Num</literal>:
3258
3259 <programlisting>
3260   instance Num Dollars where
3261     Dollars a + Dollars b = Dollars (a+b)
3262     ...
3263 </programlisting>
3264 All the instance does is apply and remove the <literal>newtype</literal>
3265 constructor. It is particularly galling that, since the constructor
3266 doesn't appear at run-time, this instance declaration defines a
3267 dictionary which is <emphasis>wholly equivalent</emphasis> to the <literal>Int</literal>
3268 dictionary, only slower!
3269 </para>
3270
3271
3272 <sect3> <title> Generalising the deriving clause </title>
3273 <para>
3274 GHC now permits such instances to be derived instead,
3275 using the flag <option>-XGeneralizedNewtypeDeriving</option>,
3276 so one can write
3277 <programlisting>
3278   newtype Dollars = Dollars Int deriving (Eq,Show,Num)
3279 </programlisting>
3280
3281 and the implementation uses the <emphasis>same</emphasis> <literal>Num</literal> dictionary
3282 for <literal>Dollars</literal> as for <literal>Int</literal>. Notionally, the compiler
3283 derives an instance declaration of the form
3284
3285 <programlisting>
3286   instance Num Int => Num Dollars
3287 </programlisting>
3288
3289 which just adds or removes the <literal>newtype</literal> constructor according to the type.
3290 </para>
3291 <para>
3292
3293 We can also derive instances of constructor classes in a similar
3294 way. For example, suppose we have implemented state and failure monad
3295 transformers, such that
3296
3297 <programlisting>
3298   instance Monad m => Monad (State s m)
3299   instance Monad m => Monad (Failure m)
3300 </programlisting>
3301 In Haskell 98, we can define a parsing monad by
3302 <programlisting>
3303   type Parser tok m a = State [tok] (Failure m) a
3304 </programlisting>
3305
3306 which is automatically a monad thanks to the instance declarations
3307 above. With the extension, we can make the parser type abstract,
3308 without needing to write an instance of class <literal>Monad</literal>, via
3309
3310 <programlisting>
3311   newtype Parser tok m a = Parser (State [tok] (Failure m) a)
3312                          deriving Monad
3313 </programlisting>
3314 In this case the derived instance declaration is of the form
3315 <programlisting>
3316   instance Monad (State [tok] (Failure m)) => Monad (Parser tok m)
3317 </programlisting>
3318
3319 Notice that, since <literal>Monad</literal> is a constructor class, the
3320 instance is a <emphasis>partial application</emphasis> of the new type, not the
3321 entire left hand side. We can imagine that the type declaration is
3322 "eta-converted" to generate the context of the instance
3323 declaration.
3324 </para>
3325 <para>
3326
3327 We can even derive instances of multi-parameter classes, provided the
3328 newtype is the last class parameter. In this case, a ``partial
3329 application'' of the class appears in the <literal>deriving</literal>
3330 clause. For example, given the class
3331
3332 <programlisting>
3333   class StateMonad s m | m -> s where ...
3334   instance Monad m => StateMonad s (State s m) where ...
3335 </programlisting>
3336 then we can derive an instance of <literal>StateMonad</literal> for <literal>Parser</literal>s by
3337 <programlisting>
3338   newtype Parser tok m a = Parser (State [tok] (Failure m) a)
3339                          deriving (Monad, StateMonad [tok])
3340 </programlisting>
3341
3342 The derived instance is obtained by completing the application of the
3343 class to the new type:
3344
3345 <programlisting>
3346   instance StateMonad [tok] (State [tok] (Failure m)) =>
3347            StateMonad [tok] (Parser tok m)
3348 </programlisting>
3349 </para>
3350 <para>
3351
3352 As a result of this extension, all derived instances in newtype
3353  declarations are treated uniformly (and implemented just by reusing
3354 the dictionary for the representation type), <emphasis>except</emphasis>
3355 <literal>Show</literal> and <literal>Read</literal>, which really behave differently for
3356 the newtype and its representation.
3357 </para>
3358 </sect3>
3359
3360 <sect3> <title> A more precise specification </title>
3361 <para>
3362 Derived instance declarations are constructed as follows. Consider the
3363 declaration (after expansion of any type synonyms)
3364
3365 <programlisting>
3366   newtype T v1...vn = T' (t vk+1...vn) deriving (c1...cm)
3367 </programlisting>
3368
3369 where
3370  <itemizedlist>
3371 <listitem><para>
3372   The <literal>ci</literal> are partial applications of
3373   classes of the form <literal>C t1'...tj'</literal>, where the arity of <literal>C</literal>
3374   is exactly <literal>j+1</literal>.  That is, <literal>C</literal> lacks exactly one type argument.
3375 </para></listitem>
3376 <listitem><para>
3377   The <literal>k</literal> is chosen so that <literal>ci (T v1...vk)</literal> is well-kinded.
3378 </para></listitem>
3379 <listitem><para>
3380   The type <literal>t</literal> is an arbitrary type.
3381 </para></listitem>
3382 <listitem><para>
3383   The type variables <literal>vk+1...vn</literal> do not occur in <literal>t</literal>,
3384   nor in the <literal>ci</literal>, and
3385 </para></listitem>
3386 <listitem><para>
3387   None of the <literal>ci</literal> is <literal>Read</literal>, <literal>Show</literal>,
3388                 <literal>Typeable</literal>, or <literal>Data</literal>.  These classes
3389                 should not "look through" the type or its constructor.  You can still
3390                 derive these classes for a newtype, but it happens in the usual way, not
3391                 via this new mechanism.
3392 </para></listitem>
3393 </itemizedlist>
3394 Then, for each <literal>ci</literal>, the derived instance
3395 declaration is:
3396 <programlisting>
3397   instance ci t => ci (T v1...vk)
3398 </programlisting>
3399 As an example which does <emphasis>not</emphasis> work, consider
3400 <programlisting>
3401   newtype NonMonad m s = NonMonad (State s m s) deriving Monad
3402 </programlisting>
3403 Here we cannot derive the instance
3404 <programlisting>
3405   instance Monad (State s m) => Monad (NonMonad m)
3406 </programlisting>
3407
3408 because the type variable <literal>s</literal> occurs in <literal>State s m</literal>,
3409 and so cannot be "eta-converted" away. It is a good thing that this
3410 <literal>deriving</literal> clause is rejected, because <literal>NonMonad m</literal> is
3411 not, in fact, a monad --- for the same reason. Try defining
3412 <literal>>>=</literal> with the correct type: you won't be able to.
3413 </para>
3414 <para>
3415
3416 Notice also that the <emphasis>order</emphasis> of class parameters becomes
3417 important, since we can only derive instances for the last one. If the
3418 <literal>StateMonad</literal> class above were instead defined as
3419
3420 <programlisting>
3421   class StateMonad m s | m -> s where ...
3422 </programlisting>
3423
3424 then we would not have been able to derive an instance for the
3425 <literal>Parser</literal> type above. We hypothesise that multi-parameter
3426 classes usually have one "main" parameter for which deriving new
3427 instances is most interesting.
3428 </para>
3429 <para>Lastly, all of this applies only for classes other than
3430 <literal>Read</literal>, <literal>Show</literal>, <literal>Typeable</literal>,
3431 and <literal>Data</literal>, for which the built-in derivation applies (section
3432 4.3.3. of the Haskell Report).
3433 (For the standard classes <literal>Eq</literal>, <literal>Ord</literal>,
3434 <literal>Ix</literal>, and <literal>Bounded</literal> it is immaterial whether
3435 the standard method is used or the one described here.)
3436 </para>
3437 </sect3>
3438 </sect2>
3439 </sect1>
3440
3441
3442 <!-- TYPE SYSTEM EXTENSIONS -->
3443 <sect1 id="type-class-extensions">
3444 <title>Class and instances declarations</title>
3445
3446 <sect2 id="multi-param-type-classes">
3447 <title>Class declarations</title>
3448
3449 <para>
3450 This section, and the next one, documents GHC's type-class extensions.
3451 There's lots of background in the paper <ulink
3452 url="http://research.microsoft.com/~simonpj/Papers/type-class-design-space/">Type
3453 classes: exploring the design space</ulink> (Simon Peyton Jones, Mark
3454 Jones, Erik Meijer).
3455 </para>
3456 <para>
3457 All the extensions are enabled by the <option>-fglasgow-exts</option> flag.
3458 </para>
3459
3460 <sect3>
3461 <title>Multi-parameter type classes</title>
3462 <para>
3463 Multi-parameter type classes are permitted, with flag <option>-XMultiParamTypeClasses</option>.
3464 For example:
3465
3466
3467 <programlisting>
3468   class Collection c a where
3469     union :: c a -> c a -> c a
3470     ...etc.
3471 </programlisting>
3472
3473 </para>
3474 </sect3>
3475
3476 <sect3 id="superclass-rules">
3477 <title>The superclasses of a class declaration</title>
3478
3479 <para>
3480 In Haskell 98 the context of a class declaration (which introduces superclasses)
3481 must be simple; that is, each predicate must consist of a class applied to
3482 type variables.  The flag <option>-XFlexibleContexts</option>
3483 (<xref linkend="flexible-contexts"/>)
3484 lifts this restriction,
3485 so that the only restriction on the context in a class declaration is
3486 that the class hierarchy must be acyclic.  So these class declarations are OK:
3487
3488
3489 <programlisting>
3490   class Functor (m k) => FiniteMap m k where
3491     ...
3492
3493   class (Monad m, Monad (t m)) => Transform t m where
3494     lift :: m a -> (t m) a
3495 </programlisting>
3496
3497
3498 </para>
3499 <para>
3500 As in Haskell 98, The class hierarchy must be acyclic.  However, the definition
3501 of "acyclic" involves only the superclass relationships.  For example,
3502 this is OK:
3503
3504
3505 <programlisting>
3506   class C a where {
3507     op :: D b => a -> b -> b
3508   }
3509
3510   class C a => D a where { ... }
3511 </programlisting>
3512
3513
3514 Here, <literal>C</literal> is a superclass of <literal>D</literal>, but it's OK for a
3515 class operation <literal>op</literal> of <literal>C</literal> to mention <literal>D</literal>.  (It
3516 would not be OK for <literal>D</literal> to be a superclass of <literal>C</literal>.)
3517 </para>
3518 </sect3>
3519
3520
3521
3522
3523 <sect3 id="class-method-types">
3524 <title>Class method types</title>
3525
3526 <para>
3527 Haskell 98 prohibits class method types to mention constraints on the
3528 class type variable, thus:
3529 <programlisting>
3530   class Seq s a where
3531     fromList :: [a] -> s a
3532     elem     :: Eq a => a -> s a -> Bool
3533 </programlisting>
3534 The type of <literal>elem</literal> is illegal in Haskell 98, because it
3535 contains the constraint <literal>Eq a</literal>, constrains only the
3536 class type variable (in this case <literal>a</literal>).
3537 GHC lifts this restriction (flag <option>-XConstrainedClassMethods</option>).
3538 </para>
3539
3540
3541 </sect3>
3542
3543
3544 <sect3 id="class-default-signatures">
3545 <title>Default signatures</title>
3546
3547 <para>
3548 Haskell 98 allows you to define a default implementation when declaring a class:
3549 <programlisting>
3550   class Enum a where
3551     enum :: [a]
3552     enum = []
3553 </programlisting>
3554 The type of the <literal>enum</literal> method is <literal>[a]</literal>, and
3555 this is also the type of the default method. You can lift this restriction
3556 and give another type to the default method using the flag
3557 <option>-XDefaultSignatures</option>. For instance, if you have written a
3558 generic implementation of enumeration in a class <literal>GEnum</literal>
3559 with method <literal>genum</literal> in terms of <literal>GHC.Generics</literal>,
3560 you can specify a default method that uses that generic implementation:
3561 <programlisting>
3562   class Enum a where
3563     enum :: [a]
3564     default enum :: (Generic a, GEnum (Rep a)) => [a]
3565     enum = map to genum
3566 </programlisting>
3567 We reuse the keyword <literal>default</literal> to signal that a signature
3568 applies to the default method only; when defining instances of the
3569 <literal>Enum</literal> class, the original type <literal>[a]</literal> of
3570 <literal>enum</literal> still applies. When giving an empty instance, however,
3571 the default implementation <literal>map to0 genum</literal> is filled-in,
3572 and type-checked with the type
3573 <literal>(Generic a, GEnum (Rep a)) => [a]</literal>.
3574 </para>
3575
3576 <para>
3577 We use default signatures to simplify generic programming in GHC
3578 (<xref linkend="generic-programming"/>).
3579 </para>
3580
3581
3582 </sect3>
3583 </sect2>
3584
3585 <sect2 id="functional-dependencies">
3586 <title>Functional dependencies
3587 </title>
3588
3589 <para> Functional dependencies are implemented as described by Mark Jones
3590 in &ldquo;<ulink url="http://citeseer.ist.psu.edu/jones00type.html">Type Classes with Functional Dependencies</ulink>&rdquo;, Mark P. Jones,
3591 In Proceedings of the 9th European Symposium on Programming,
3592 ESOP 2000, Berlin, Germany, March 2000, Springer-Verlag LNCS 1782,
3593 .
3594 </para>
3595 <para>
3596 Functional dependencies are introduced by a vertical bar in the syntax of a
3597 class declaration;  e.g.
3598 <programlisting>
3599   class (Monad m) => MonadState s m | m -> s where ...
3600
3601   class Foo a b c | a b -> c where ...
3602 </programlisting>
3603 There should be more documentation, but there isn't (yet).  Yell if you need it.
3604 </para>
3605
3606 <sect3><title>Rules for functional dependencies </title>
3607 <para>
3608 In a class declaration, all of the class type variables must be reachable (in the sense
3609 mentioned in <xref linkend="flexible-contexts"/>)
3610 from the free variables of each method type.
3611 For example:
3612
3613 <programlisting>
3614   class Coll s a where
3615     empty  :: s
3616     insert :: s -> a -> s
3617 </programlisting>
3618
3619 is not OK, because the type of <literal>empty</literal> doesn't mention
3620 <literal>a</literal>.  Functional dependencies can make the type variable
3621 reachable:
3622 <programlisting>
3623   class Coll s a | s -> a where
3624     empty  :: s
3625     insert :: s -> a -> s
3626 </programlisting>
3627
3628 Alternatively <literal>Coll</literal> might be rewritten
3629
3630 <programlisting>
3631   class Coll s a where
3632     empty  :: s a
3633     insert :: s a -> a -> s a
3634 </programlisting>
3635
3636
3637 which makes the connection between the type of a collection of
3638 <literal>a</literal>'s (namely <literal>(s a)</literal>) and the element type <literal>a</literal>.
3639 Occasionally this really doesn't work, in which case you can split the
3640 class like this:
3641
3642
3643 <programlisting>
3644   class CollE s where
3645     empty  :: s
3646
3647   class CollE s => Coll s a where
3648     insert :: s -> a -> s
3649 </programlisting>
3650 </para>
3651 </sect3>
3652
3653
3654 <sect3>
3655 <title>Background on functional dependencies</title>
3656
3657 <para>The following description of the motivation and use of functional dependencies is taken
3658 from the Hugs user manual, reproduced here (with minor changes) by kind
3659 permission of Mark Jones.
3660 </para>
3661 <para>
3662 Consider the following class, intended as part of a
3663 library for collection types:
3664 <programlisting>
3665    class Collects e ce where
3666        empty  :: ce
3667        insert :: e -> ce -> ce
3668        member :: e -> ce -> Bool
3669 </programlisting>
3670 The type variable e used here represents the element type, while ce is the type
3671 of the container itself. Within this framework, we might want to define
3672 instances of this class for lists or characteristic functions (both of which
3673 can be used to represent collections of any equality type), bit sets (which can
3674 be used to represent collections of characters), or hash tables (which can be
3675 used to represent any collection whose elements have a hash function). Omitting
3676 standard implementation details, this would lead to the following declarations:
3677 <programlisting>
3678    instance Eq e => Collects e [e] where ...
3679    instance Eq e => Collects e (e -> Bool) where ...
3680    instance Collects Char BitSet where ...
3681    instance (Hashable e, Collects a ce)
3682               => Collects e (Array Int ce) where ...
3683 </programlisting>
3684 All this looks quite promising; we have a class and a range of interesting
3685 implementations. Unfortunately, there are some serious problems with the class
3686 declaration. First, the empty function has an ambiguous type:
3687 <programlisting>
3688    empty :: Collects e ce => ce
3689 </programlisting>
3690 By "ambiguous" we mean that there is a type variable e that appears on the left
3691 of the <literal>=&gt;</literal> symbol, but not on the right. The problem with
3692 this is that, according to the theoretical foundations of Haskell overloading,
3693 we cannot guarantee a well-defined semantics for any term with an ambiguous
3694 type.
3695 </para>
3696 <para>
3697 We can sidestep this specific problem by removing the empty member from the
3698 class declaration. However, although the remaining members, insert and member,
3699 do not have ambiguous types, we still run into problems when we try to use
3700 them. For example, consider the following two functions:
3701 <programlisting>
3702    f x y = insert x . insert y
3703    g     = f True 'a'
3704 </programlisting>
3705 for which GHC infers the following types:
3706 <programlisting>
3707    f :: (Collects a c, Collects b c) => a -> b -> c -> c
3708    g :: (Collects Bool c, Collects Char c) => c -> c
3709 </programlisting>
3710 Notice that the type for f allows the two parameters x and y to be assigned
3711 different types, even though it attempts to insert each of the two values, one
3712 after the other, into the same collection. If we're trying to model collections
3713 that contain only one type of value, then this is clearly an inaccurate
3714 type. Worse still, the definition for g is accepted, without causing a type
3715 error. As a result, the error in this code will not be flagged at the point
3716 where it appears. Instead, it will show up only when we try to use g, which
3717 might even be in a different module.
3718 </para>
3719
3720 <sect4><title>An attempt to use constructor classes</title>
3721
3722 <para>
3723 Faced with the problems described above, some Haskell programmers might be
3724 tempted to use something like the following version of the class declaration:
3725 <programlisting>
3726    class Collects e c where
3727       empty  :: c e
3728       insert :: e -> c e -> c e
3729       member :: e -> c e -> Bool
3730 </programlisting>
3731 The key difference here is that we abstract over the type constructor c that is
3732 used to form the collection type c e, and not over that collection type itself,
3733 represented by ce in the original class declaration. This avoids the immediate
3734 problems that we mentioned above: empty has type <literal>Collects e c => c
3735 e</literal>, which is not ambiguous.
3736 </para>
3737 <para>
3738 The function f from the previous section has a more accurate type:
3739 <programlisting>
3740    f :: (Collects e c) => e -> e -> c e -> c e
3741 </programlisting>
3742 The function g from the previous section is now rejected with a type error as
3743 we would hope because the type of f does not allow the two arguments to have
3744 different types.
3745 This, then, is an example of a multiple parameter class that does actually work
3746 quite well in practice, without ambiguity problems.
3747 There is, however, a catch. This version of the Collects class is nowhere near
3748 as general as the original class seemed to be: only one of the four instances
3749 for <literal>Collects</literal>
3750 given above can be used with this version of Collects because only one of
3751 them---the instance for lists---has a collection type that can be written in
3752 the form c e, for some type constructor c, and element type e.
3753 </para>
3754 </sect4>
3755
3756 <sect4><title>Adding functional dependencies</title>
3757
3758 <para>
3759 To get a more useful version of the Collects class, Hugs provides a mechanism
3760 that allows programmers to specify dependencies between the parameters of a
3761 multiple parameter class (For readers with an interest in theoretical
3762 foundations and previous work: The use of dependency information can be seen
3763 both as a generalization of the proposal for `parametric type classes' that was
3764 put forward by Chen, Hudak, and Odersky, or as a special case of Mark Jones's
3765 later framework for "improvement" of qualified types. The
3766 underlying ideas are also discussed in a more theoretical and abstract setting
3767 in a manuscript [implparam], where they are identified as one point in a
3768 general design space for systems of implicit parameterization.).
3769
3770 To start with an abstract example, consider a declaration such as:
3771 <programlisting>
3772    class C a b where ...
3773 </programlisting>
3774 which tells us simply that C can be thought of as a binary relation on types
3775 (or type constructors, depending on the kinds of a and b). Extra clauses can be
3776 included in the definition of classes to add information about dependencies
3777 between parameters, as in the following examples:
3778 <programlisting>
3779    class D a b | a -> b where ...
3780    class E a b | a -> b, b -> a where ...
3781 </programlisting>
3782 The notation <literal>a -&gt; b</literal> used here between the | and where
3783 symbols --- not to be
3784 confused with a function type --- indicates that the a parameter uniquely
3785 determines the b parameter, and might be read as "a determines b." Thus D is
3786 not just a relation, but actually a (partial) function. Similarly, from the two
3787 dependencies that are included in the definition of E, we can see that E
3788 represents a (partial) one-one mapping between types.
3789 </para>
3790 <para>
3791 More generally, dependencies take the form <literal>x1 ... xn -&gt; y1 ... ym</literal>,
3792 where x1, ..., xn, and y1, ..., yn are type variables with n&gt;0 and
3793 m&gt;=0, meaning that the y parameters are uniquely determined by the x
3794 parameters. Spaces can be used as separators if more than one variable appears
3795 on any single side of a dependency, as in <literal>t -&gt; a b</literal>. Note that a class may be
3796 annotated with multiple dependencies using commas as separators, as in the
3797 definition of E above. Some dependencies that we can write in this notation are
3798 redundant, and will be rejected because they don't serve any useful
3799 purpose, and may instead indicate an error in the program. Examples of
3800 dependencies like this include  <literal>a -&gt; a </literal>,
3801 <literal>a -&gt; a a </literal>,
3802 <literal>a -&gt; </literal>, etc. There can also be
3803 some redundancy if multiple dependencies are given, as in
3804 <literal>a-&gt;b</literal>,
3805  <literal>b-&gt;c </literal>,  <literal>a-&gt;c </literal>, and
3806 in which some subset implies the remaining dependencies. Examples like this are
3807 not treated as errors. Note that dependencies appear only in class
3808 declarations, and not in any other part of the language. In particular, the
3809 syntax for instance declarations, class constraints, and types is completely
3810 unchanged.
3811 </para>
3812 <para>
3813 By including dependencies in a class declaration, we provide a mechanism for
3814 the programmer to specify each multiple parameter class more precisely. The
3815 compiler, on the other hand, is responsible for ensuring that the set of
3816 instances that are in scope at any given point in the program is consistent
3817 with any declared dependencies. For example, the following pair of instance
3818 declarations cannot appear together in the same scope because they violate the
3819 dependency for D, even though either one on its own would be acceptable:
3820 <programlisting>
3821    instance D Bool Int where ...
3822    instance D Bool Char where ...
3823 </programlisting>
3824 Note also that the following declaration is not allowed, even by itself:
3825 <programlisting>
3826    instance D [a] b where ...
3827 </programlisting>
3828 The problem here is that this instance would allow one particular choice of [a]
3829 to be associated with more than one choice for b, which contradicts the
3830 dependency specified in the definition of D. More generally, this means that,
3831 in any instance of the form:
3832 <programlisting>
3833    instance D t s where ...
3834 </programlisting>
3835 for some particular types t and s, the only variables that can appear in s are
3836 the ones that appear in t, and hence, if the type t is known, then s will be
3837 uniquely determined.
3838 </para>
3839 <para>
3840 The benefit of including dependency information is that it allows us to define
3841 more general multiple parameter classes, without ambiguity problems, and with
3842 the benefit of more accurate types. To illustrate this, we return to the
3843 collection class example, and annotate the original definition of <literal>Collects</literal>
3844 with a simple dependency:
3845 <programlisting>
3846    class Collects e ce | ce -> e where
3847       empty  :: ce
3848       insert :: e -> ce -> ce
3849       member :: e -> ce -> Bool
3850 </programlisting>
3851 The dependency <literal>ce -&gt; e</literal> here specifies that the type e of elements is uniquely
3852 determined by the type of the collection ce. Note that both parameters of
3853 Collects are of kind *; there are no constructor classes here. Note too that
3854 all of the instances of Collects that we gave earlier can be used
3855 together with this new definition.
3856 </para>
3857 <para>
3858 What about the ambiguity problems that we encountered with the original
3859 definition? The empty function still has type Collects e ce => ce, but it is no
3860 longer necessary to regard that as an ambiguous type: Although the variable e
3861 does not appear on the right of the => symbol, the dependency for class
3862 Collects tells us that it is uniquely determined by ce, which does appear on
3863 the right of the => symbol. Hence the context in which empty is used can still
3864 give enough information to determine types for both ce and e, without
3865 ambiguity. More generally, we need only regard a type as ambiguous if it
3866 contains a variable on the left of the => that is not uniquely determined
3867 (either directly or indirectly) by the variables on the right.
3868 </para>
3869 <para>
3870 Dependencies also help to produce more accurate types for user defined
3871 functions, and hence to provide earlier detection of errors, and less cluttered
3872 types for programmers to work with. Recall the previous definition for a
3873 function f:
3874 <programlisting>
3875    f x y = insert x y = insert x . insert y
3876 </programlisting>
3877 for which we originally obtained a type:
3878 <programlisting>
3879    f :: (Collects a c, Collects b c) => a -> b -> c -> c
3880 </programlisting>
3881 Given the dependency information that we have for Collects, however, we can
3882 deduce that a and b must be equal because they both appear as the second
3883 parameter in a Collects constraint with the same first parameter c. Hence we
3884 can infer a shorter and more accurate type for f:
3885 <programlisting>
3886    f :: (Collects a c) => a -> a -> c -> c
3887 </programlisting>
3888 In a similar way, the earlier definition of g will now be flagged as a type error.
3889 </para>
3890 <para>
3891 Although we have given only a few examples here, it should be clear that the
3892 addition of dependency information can help to make multiple parameter classes
3893 more useful in practice, avoiding ambiguity problems, and allowing more general
3894 sets of instance declarations.
3895 </para>
3896 </sect4>
3897 </sect3>
3898 </sect2>
3899
3900 <sect2 id="instance-decls">
3901 <title>Instance declarations</title>
3902
3903 <para>An instance declaration has the form
3904 <screen>
3905   instance ( <replaceable>assertion</replaceable><subscript>1</subscript>, ..., <replaceable>assertion</replaceable><subscript>n</subscript>) =&gt; <replaceable>class</replaceable> <replaceable>type</replaceable><subscript>1</subscript> ... <replaceable>type</replaceable><subscript>m</subscript> where ...
3906 </screen>
3907 The part before the "<literal>=&gt;</literal>" is the
3908 <emphasis>context</emphasis>, while the part after the
3909 "<literal>=&gt;</literal>" is the <emphasis>head</emphasis> of the instance declaration.
3910 </para>
3911
3912 <sect3 id="flexible-instance-head">
3913 <title>Relaxed rules for the instance head</title>
3914
3915 <para>
3916 In Haskell 98 the head of an instance declaration
3917 must be of the form <literal>C (T a1 ... an)</literal>, where
3918 <literal>C</literal> is the class, <literal>T</literal> is a data type constructor,
3919 and the <literal>a1 ... an</literal> are distinct type variables.
3920 GHC relaxes these rules in two ways.
3921 <itemizedlist>
3922 <listitem>
3923 <para>
3924 The <option>-XFlexibleInstances</option> flag allows the head of the instance
3925 declaration to mention arbitrary nested types.
3926 For example, this becomes a legal instance declaration
3927 <programlisting>
3928   instance C (Maybe Int) where ...
3929 </programlisting>
3930 See also the <link linkend="instance-overlap">rules on overlap</link>.
3931 </para></listitem>
3932 <listitem><para>
3933 With the <option>-XTypeSynonymInstances</option> flag, instance heads may use type
3934 synonyms. As always, using a type synonym is just shorthand for
3935 writing the RHS of the type synonym definition.  For example:
3936
3937
3938 <programlisting>
3939   type Point = (Int,Int)
3940   instance C Point   where ...
3941   instance C [Point] where ...
3942 </programlisting>
3943
3944
3945 is legal.  However, if you added
3946
3947
3948 <programlisting>
3949   instance C (Int,Int) where ...
3950 </programlisting>
3951
3952
3953 as well, then the compiler will complain about the overlapping
3954 (actually, identical) instance declarations.  As always, type synonyms
3955 must be fully applied.  You cannot, for example, write:
3956
3957 <programlisting>
3958   type P a = [[a]]
3959   instance Monad P where ...
3960 </programlisting>
3961
3962 </para></listitem>
3963 </itemizedlist>
3964 </para>
3965 </sect3>
3966
3967 <sect3 id="instance-rules">
3968 <title>Relaxed rules for instance contexts</title>
3969
3970 <para>In Haskell 98, the assertions in the context of the instance declaration
3971 must be of the form <literal>C a</literal> where <literal>a</literal>
3972 is a type variable that occurs in the head.
3973 </para>
3974
3975 <para>
3976 The <option>-XFlexibleContexts</option> flag relaxes this rule, as well
3977 as the corresponding rule for type signatures (see <xref linkend="flexible-contexts"/>).
3978 With this flag the context of the instance declaration can each consist of arbitrary
3979 (well-kinded) assertions <literal>(C t1 ... tn)</literal> subject only to the
3980 following rules:
3981 <orderedlist>
3982 <listitem><para>
3983 The Paterson Conditions: for each assertion in the context
3984 <orderedlist>
3985 <listitem><para>No type variable has more occurrences in the assertion than in the head</para></listitem>
3986 <listitem><para>The assertion has fewer constructors and variables (taken together
3987       and counting repetitions) than the head</para></listitem>
3988 </orderedlist>
3989 </para></listitem>
3990
3991 <listitem><para>The Coverage Condition.  For each functional dependency,
3992 <replaceable>tvs</replaceable><subscript>left</subscript> <literal>-&gt;</literal>
3993 <replaceable>tvs</replaceable><subscript>right</subscript>,  of the class,
3994 every type variable in
3995 S(<replaceable>tvs</replaceable><subscript>right</subscript>) must appear in
3996 S(<replaceable>tvs</replaceable><subscript>left</subscript>), where S is the
3997 substitution mapping each type variable in the class declaration to the
3998 corresponding type in the instance declaration.
3999 </para></listitem>
4000 </orderedlist>
4001 These restrictions ensure that context reduction terminates: each reduction
4002 step makes the problem smaller by at least one
4003 constructor.  Both the Paterson Conditions and the Coverage Condition are lifted
4004 if you give the <option>-XUndecidableInstances</option>
4005 flag (<xref linkend="undecidable-instances"/>).
4006 You can find lots of background material about the reason for these
4007 restrictions in the paper <ulink
4008 url="http://research.microsoft.com/%7Esimonpj/papers/fd%2Dchr/">
4009 Understanding functional dependencies via Constraint Handling Rules</ulink>.
4010 </para>
4011 <para>
4012 For example, these are OK:
4013 <programlisting>
4014   instance C Int [a]          -- Multiple parameters
4015   instance Eq (S [a])         -- Structured type in head
4016
4017       -- Repeated type variable in head
4018   instance C4 a a => C4 [a] [a]
4019   instance Stateful (ST s) (MutVar s)
4020
4021       -- Head can consist of type variables only
4022   instance C a
4023   instance (Eq a, Show b) => C2 a b
4024
4025       -- Non-type variables in context
4026   instance Show (s a) => Show (Sized s a)
4027   instance C2 Int a => C3 Bool [a]
4028   instance C2 Int a => C3 [a] b
4029 </programlisting>
4030 But these are not:
4031 <programlisting>
4032       -- Context assertion no smaller than head
4033   instance C a => C a where ...
4034       -- (C b b) has more occurrences of b than the head
4035   instance C b b => Foo [b] where ...
4036 </programlisting>
4037 </para>
4038
4039 <para>
4040 The same restrictions apply to instances generated by
4041 <literal>deriving</literal> clauses.  Thus the following is accepted:
4042 <programlisting>
4043   data MinHeap h a = H a (h a)
4044     deriving (Show)
4045 </programlisting>
4046 because the derived instance
4047 <programlisting>
4048   instance (Show a, Show (h a)) => Show (MinHeap h a)
4049 </programlisting>
4050 conforms to the above rules.
4051 </para>
4052
4053 <para>
4054 A useful idiom permitted by the above rules is as follows.
4055 If one allows overlapping instance declarations then it's quite
4056 convenient to have a "default instance" declaration that applies if
4057 something more specific does not:
4058 <programlisting>
4059   instance C a where
4060     op = ... -- Default
4061 </programlisting>
4062 </para>
4063 </sect3>
4064
4065 <sect3 id="undecidable-instances">
4066 <title>Undecidable instances</title>
4067
4068 <para>
4069 Sometimes even the rules of <xref linkend="instance-rules"/> are too onerous.
4070 For example, sometimes you might want to use the following to get the
4071 effect of a "class synonym":
4072 <programlisting>
4073   class (C1 a, C2 a, C3 a) => C a where { }
4074
4075   instance (C1 a, C2 a, C3 a) => C a where { }
4076 </programlisting>
4077 This allows you to write shorter signatures:
4078 <programlisting>
4079   f :: C a => ...
4080 </programlisting>
4081 instead of
4082 <programlisting>
4083   f :: (C1 a, C2 a, C3 a) => ...
4084 </programlisting>
4085 The restrictions on functional dependencies (<xref
4086 linkend="functional-dependencies"/>) are particularly troublesome.
4087 It is tempting to introduce type variables in the context that do not appear in
4088 the head, something that is excluded by the normal rules. For example:
4089 <programlisting>
4090   class HasConverter a b | a -> b where
4091      convert :: a -> b
4092
4093   data Foo a = MkFoo a
4094
4095   instance (HasConverter a b,Show b) => Show (Foo a) where
4096      show (MkFoo value) = show (convert value)
4097 </programlisting>
4098 This is dangerous territory, however. Here, for example, is a program that would make the
4099 typechecker loop:
4100 <programlisting>
4101   class D a
4102   class F a b | a->b
4103   instance F [a] [[a]]
4104   instance (D c, F a c) => D [a]   -- 'c' is not mentioned in the head
4105 </programlisting>
4106 Similarly, it can be tempting to lift the coverage condition:
4107 <programlisting>
4108   class Mul a b c | a b -> c where
4109         (.*.) :: a -> b -> c
4110
4111   instance Mul Int Int Int where (.*.) = (*)
4112   instance Mul Int Float Float where x .*. y = fromIntegral x * y
4113   instance Mul a b c => Mul a [b] [c] where x .*. v = map (x.*.) v
4114 </programlisting>
4115 The third instance declaration does not obey the coverage condition;
4116 and indeed the (somewhat strange) definition:
4117 <programlisting>
4118   f = \ b x y -> if b then x .*. [y] else y
4119 </programlisting>
4120 makes instance inference go into a loop, because it requires the constraint
4121 <literal>(Mul a [b] b)</literal>.
4122 </para>
4123 <para>
4124 Nevertheless, GHC allows you to experiment with more liberal rules.  If you use
4125 the experimental flag <option>-XUndecidableInstances</option>
4126 <indexterm><primary>-XUndecidableInstances</primary></indexterm>,
4127 both the Paterson Conditions and the Coverage Condition
4128 (described in <xref linkend="instance-rules"/>) are lifted.  Termination is ensured by having a
4129 fixed-depth recursion stack.  If you exceed the stack depth you get a
4130 sort of backtrace, and the opportunity to increase the stack depth
4131 with <option>-fcontext-stack=</option><emphasis>N</emphasis>.
4132 </para>
4133
4134 </sect3>
4135
4136
4137 <sect3 id="instance-overlap">
4138 <title>Overlapping instances</title>
4139 <para>
4140 In general, <emphasis>GHC requires that that it be unambiguous which instance
4141 declaration
4142 should be used to resolve a type-class constraint</emphasis>. This behaviour
4143 can be modified by two flags: <option>-XOverlappingInstances</option>
4144 <indexterm><primary>-XOverlappingInstances
4145 </primary></indexterm>
4146 and <option>-XIncoherentInstances</option>
4147 <indexterm><primary>-XIncoherentInstances
4148 </primary></indexterm>, as this section discusses.  Both these
4149 flags are dynamic flags, and can be set on a per-module basis, using
4150 an <literal>OPTIONS_GHC</literal> pragma if desired (<xref linkend="source-file-options"/>).</para>
4151 <para>
4152 When GHC tries to resolve, say, the constraint <literal>C Int Bool</literal>,
4153 it tries to match every instance declaration against the
4154 constraint,
4155 by instantiating the head of the instance declaration.  For example, consider
4156 these declarations:
4157 <programlisting>
4158   instance context1 => C Int a     where ...  -- (A)
4159   instance context2 => C a   Bool  where ...  -- (B)
4160   instance context3 => C Int [a]   where ...  -- (C)
4161   instance context4 => C Int [Int] where ...  -- (D)
4162 </programlisting>
4163 The instances (A) and (B) match the constraint <literal>C Int Bool</literal>,
4164 but (C) and (D) do not.  When matching, GHC takes
4165 no account of the context of the instance declaration
4166 (<literal>context1</literal> etc).
4167 GHC's default behaviour is that <emphasis>exactly one instance must match the
4168 constraint it is trying to resolve</emphasis>.
4169 It is fine for there to be a <emphasis>potential</emphasis> of overlap (by
4170 including both declarations (A) and (B), say); an error is only reported if a
4171 particular constraint matches more than one.
4172 </para>
4173
4174 <para>
4175 The <option>-XOverlappingInstances</option> flag instructs GHC to allow
4176 more than one instance to match, provided there is a most specific one.  For
4177 example, the constraint <literal>C Int [Int]</literal> matches instances (A),
4178 (C) and (D), but the last is more specific, and hence is chosen.  If there is no
4179 most-specific match, the program is rejected.
4180 </para>
4181 <para>
4182 However, GHC is conservative about committing to an overlapping instance.  For example:
4183 <programlisting>
4184   f :: [b] -> [b]
4185   f x = ...
4186 </programlisting>
4187 Suppose that from the RHS of <literal>f</literal> we get the constraint
4188 <literal>C Int [b]</literal>.  But
4189 GHC does not commit to instance (C), because in a particular
4190 call of <literal>f</literal>, <literal>b</literal> might be instantiate
4191 to <literal>Int</literal>, in which case instance (D) would be more specific still.
4192 So GHC rejects the program.
4193 (If you add the flag <option>-XIncoherentInstances</option>,
4194 GHC will instead pick (C), without complaining about
4195 the problem of subsequent instantiations.)
4196 </para>
4197 <para>
4198 Notice that we gave a type signature to <literal>f</literal>, so GHC had to
4199 <emphasis>check</emphasis> that <literal>f</literal> has the specified type.
4200 Suppose instead we do not give a type signature, asking GHC to <emphasis>infer</emphasis>
4201 it instead.  In this case, GHC will refrain from
4202 simplifying the constraint <literal>C Int [b]</literal> (for the same reason
4203 as before) but, rather than rejecting the program, it will infer the type
4204 <programlisting>
4205   f :: C Int [b] => [b] -> [b]
4206 </programlisting>
4207 That postpones the question of which instance to pick to the
4208 call site for <literal>f</literal>
4209 by which time more is known about the type <literal>b</literal>.
4210 You can write this type signature yourself if you use the
4211 <link linkend="flexible-contexts"><option>-XFlexibleContexts</option></link>
4212 flag.
4213 </para>
4214 <para>
4215 Exactly the same situation can arise in instance declarations themselves.  Suppose we have
4216 <programlisting>
4217   class Foo a where
4218      f :: a -> a
4219   instance Foo [b] where
4220      f x = ...
4221 </programlisting>
4222 and, as before, the constraint <literal>C Int [b]</literal> arises from <literal>f</literal>'s
4223 right hand side.  GHC will reject the instance, complaining as before that it does not know how to resolve
4224 the constraint <literal>C Int [b]</literal>, because it matches more than one instance
4225 declaration.  The solution is to postpone the choice by adding the constraint to the context
4226 of the instance declaration, thus:
4227 <programlisting>
4228   instance C Int [b] => Foo [b] where
4229      f x = ...
4230 </programlisting>
4231 (You need <link linkend="instance-rules"><option>-XFlexibleInstances</option></link> to do this.)
4232 </para>
4233 <para>
4234 Warning: overlapping instances must be used with care.  They
4235 can give rise to incoherence (ie different instance choices are made
4236 in different parts of the program) even without <option>-XIncoherentInstances</option>. Consider:
4237 <programlisting>
4238 {-# LANGUAGE OverlappingInstances #-}
4239 module Help where
4240
4241     class MyShow a where
4242       myshow :: a -> String
4243
4244     instance MyShow a => MyShow [a] where
4245       myshow xs = concatMap myshow xs
4246
4247     showHelp :: MyShow a => [a] -> String
4248     showHelp xs = myshow xs
4249
4250 {-# LANGUAGE FlexibleInstances, OverlappingInstances #-}
4251 module Main where
4252     import Help
4253
4254     data T = MkT
4255
4256     instance MyShow T where
4257       myshow x = "Used generic instance"
4258
4259     instance MyShow [T] where
4260       myshow xs = "Used more specific instance"
4261
4262     main = do { print (myshow [MkT]); print (showHelp [MkT]) }
4263 </programlisting>
4264 In function <literal>showHelp</literal> GHC sees no overlapping
4265 instances, and so uses the <literal>MyShow [a]</literal> instance
4266 without complaint.  In the call to <literal>myshow</literal> in <literal>main</literal>,
4267 GHC resolves the <literal>MyShow [T]</literal> constraint using the overlapping
4268 instance declaration in module <literal>Main</literal>. As a result,
4269 the program prints
4270 <programlisting>
4271   "Used more specific instance"
4272   "Used generic instance"
4273 </programlisting>
4274 (An alternative possible behaviour, not currently implemented,
4275 would be to reject module <literal>Help</literal>
4276 on the grounds that a later instance declaration might overlap the local one.)
4277 </para>
4278 <para>
4279 The willingness to be overlapped or incoherent is a property of
4280 the <emphasis>instance declaration</emphasis> itself, controlled by the
4281 presence or otherwise of the <option>-XOverlappingInstances</option>
4282 and <option>-XIncoherentInstances</option> flags when that module is
4283 being defined.  Specifically, during the lookup process:
4284 <itemizedlist>
4285 <listitem><para>
4286 If the constraint being looked up matches two instance declarations IA and IB,
4287 and
4288 <itemizedlist>
4289 <listitem><para>IB is a substitution instance of IA (but not vice versa);
4290 that is, IB is strictly more specific than IA</para></listitem>
4291 <listitem><para>either IA or IB was compiled with <option>-XOverlappingInstances</option></para></listitem>
4292 </itemizedlist>
4293 then the less-specific instance IA is ignored.
4294 </para></listitem>
4295 <listitem><para>
4296 Suppose an instance declaration does not match the constraint being looked up, but
4297 does <emphasis>unify</emphasis> with it, so that it might match when the constraint is further
4298 instantiated.  Usually GHC will regard this as a reason for not committing to
4299 some other constraint.  But if the instance declaration was compiled with
4300 <option>-XIncoherentInstances</option>, GHC will skip the "does-it-unify?"
4301 check for that declaration.
4302 </para></listitem>
4303 </itemizedlist>
4304 These rules make it possible for a library author to design a library that relies on
4305 overlapping instances without the library client having to know.
4306 </para>
4307 <para>The <option>-XIncoherentInstances</option> flag implies the
4308 <option>-XOverlappingInstances</option> flag, but not vice versa.
4309 </para>
4310 </sect3>
4311
4312
4313
4314 </sect2>
4315
4316 <sect2 id="overloaded-strings">
4317 <title>Overloaded string literals
4318 </title>
4319
4320 <para>
4321 GHC supports <emphasis>overloaded string literals</emphasis>.  Normally a
4322 string literal has type <literal>String</literal>, but with overloaded string
4323 literals enabled (with <literal>-XOverloadedStrings</literal>)
4324  a string literal has type <literal>(IsString a) => a</literal>.
4325 </para>
4326 <para>
4327 This means that the usual string syntax can be used, e.g., for packed strings
4328 and other variations of string like types.  String literals behave very much
4329 like integer literals, i.e., they can be used in both expressions and patterns.
4330 If used in a pattern the literal with be replaced by an equality test, in the same
4331 way as an integer literal is.
4332 </para>
4333 <para>
4334 The class <literal>IsString</literal> is defined as:
4335 <programlisting>
4336 class IsString a where
4337     fromString :: String -> a
4338 </programlisting>
4339 The only predefined instance is the obvious one to make strings work as usual:
4340 <programlisting>
4341 instance IsString [Char] where
4342     fromString cs = cs
4343 </programlisting>
4344 The class <literal>IsString</literal> is not in scope by default.  If you want to mention
4345 it explicitly (for example, to give an instance declaration for it), you can import it
4346 from module <literal>GHC.Exts</literal>.
4347 </para>
4348 <para>
4349 Haskell's defaulting mechanism is extended to cover string literals, when <option>-XOverloadedStrings</option> is specified.
4350 Specifically:
4351 <itemizedlist>
4352 <listitem><para>
4353 Each type in a default declaration must be an
4354 instance of <literal>Num</literal> <emphasis>or</emphasis> of <literal>IsString</literal>.
4355 </para></listitem>
4356
4357 <listitem><para>
4358 The standard defaulting rule (<ulink url="http://www.haskell.org/onlinereport/decls.html#sect4.3.4">Haskell Report, Section 4.3.4</ulink>)
4359 is extended thus: defaulting applies when all the unresolved constraints involve standard classes
4360 <emphasis>or</emphasis> <literal>IsString</literal>; and at least one is a numeric class
4361 <emphasis>or</emphasis> <literal>IsString</literal>.
4362 </para></listitem>
4363 </itemizedlist>
4364 </para>
4365 <para>
4366 A small example:
4367 <programlisting>
4368 module Main where
4369
4370 import GHC.Exts( IsString(..) )
4371
4372 newtype MyString = MyString String deriving (Eq, Show)
4373 instance IsString MyString where
4374     fromString = MyString
4375
4376 greet :: MyString -> MyString
4377 greet "hello" = "world"
4378 greet other = other
4379
4380 main = do
4381     print $ greet "hello"
4382     print $ greet "fool"
4383 </programlisting>
4384 </para>
4385 <para>
4386 Note that deriving <literal>Eq</literal> is necessary for the pattern matching
4387 to work since it gets translated into an equality comparison.
4388 </para>
4389 </sect2>
4390
4391 </sect1>
4392
4393 <sect1 id="type-families">
4394 <title>Type families</title>
4395
4396 <para>
4397   <firstterm>Indexed type families</firstterm> are a new GHC extension to
4398   facilitate type-level
4399   programming. Type families are a generalisation of <firstterm>associated
4400   data types</firstterm>
4401   (&ldquo;<ulink url="http://www.cse.unsw.edu.au/~chak/papers/CKPM05.html">Associated
4402   Types with Class</ulink>&rdquo;, M. Chakravarty, G. Keller, S. Peyton Jones,
4403   and S. Marlow. In Proceedings of &ldquo;The 32nd Annual ACM SIGPLAN-SIGACT
4404      Symposium on Principles of Programming Languages (POPL'05)&rdquo;, pages
4405   1-13, ACM Press, 2005) and <firstterm>associated type synonyms</firstterm>
4406   (&ldquo;<ulink url="http://www.cse.unsw.edu.au/~chak/papers/CKP05.html">Type
4407   Associated Type Synonyms</ulink>&rdquo;. M. Chakravarty, G. Keller, and
4408   S. Peyton Jones.
4409   In Proceedings of &ldquo;The Tenth ACM SIGPLAN International Conference on
4410   Functional Programming&rdquo;, ACM Press, pages 241-253, 2005).  Type families
4411   themselves are described in the paper &ldquo;<ulink
4412   url="http://www.cse.unsw.edu.au/~chak/papers/SPCS08.html">Type
4413   Checking with Open Type Functions</ulink>&rdquo;, T. Schrijvers,
4414   S. Peyton-Jones,
4415   M. Chakravarty, and M. Sulzmann, in Proceedings of &ldquo;ICFP 2008: The
4416   13th ACM SIGPLAN International Conference on Functional
4417   Programming&rdquo;, ACM Press, pages 51-62, 2008. Type families
4418   essentially provide type-indexed data types and named functions on types,
4419   which are useful for generic programming and highly parameterised library
4420   interfaces as well as interfaces with enhanced static information, much like
4421   dependent types. They might also be regarded as an alternative to functional
4422   dependencies, but provide a more functional style of type-level programming
4423   than the relational style of functional dependencies.
4424 </para>
4425 <para>
4426   Indexed type families, or type families for short, are type constructors that
4427   represent sets of types. Set members are denoted by supplying the type family
4428   constructor with type parameters, which are called <firstterm>type
4429   indices</firstterm>. The
4430   difference between vanilla parametrised type constructors and family
4431   constructors is much like between parametrically polymorphic functions and
4432   (ad-hoc polymorphic) methods of type classes. Parametric polymorphic functions
4433   behave the same at all type instances, whereas class methods can change their
4434   behaviour in dependence on the class type parameters. Similarly, vanilla type
4435   constructors imply the same data representation for all type instances, but
4436   family constructors can have varying representation types for varying type
4437   indices.
4438 </para>
4439 <para>
4440   Indexed type families come in two flavours: <firstterm>data
4441     families</firstterm> and <firstterm>type synonym
4442     families</firstterm>. They are the indexed family variants of algebraic
4443   data types and type synonyms, respectively. The instances of data families
4444   can be data types and newtypes.
4445 </para>
4446 <para>
4447   Type families are enabled by the flag <option>-XTypeFamilies</option>.
4448   Additional information on the use of type families in GHC is available on
4449   <ulink url="http://www.haskell.org/haskellwiki/GHC/Indexed_types">the
4450   Haskell wiki page on type families</ulink>.
4451 </para>
4452
4453 <sect2 id="data-families">
4454   <title>Data families</title>
4455
4456   <para>
4457     Data families appear in two flavours: (1) they can be defined on the
4458     toplevel
4459     or (2) they can appear inside type classes (in which case they are known as
4460     associated types). The former is the more general variant, as it lacks the
4461     requirement for the type-indexes to coincide with the class
4462     parameters. However, the latter can lead to more clearly structured code and
4463     compiler warnings if some type instances were - possibly accidentally -
4464     omitted. In the following, we always discuss the general toplevel form first
4465     and then cover the additional constraints placed on associated types.
4466   </para>
4467
4468   <sect3 id="data-family-declarations">
4469     <title>Data family declarations</title>
4470
4471     <para>
4472       Indexed data families are introduced by a signature, such as
4473 <programlisting>
4474 data family GMap k :: * -> *
4475 </programlisting>
4476       The special <literal>family</literal> distinguishes family from standard
4477       data declarations.  The result kind annotation is optional and, as
4478       usual, defaults to <literal>*</literal> if omitted.  An example is
4479 <programlisting>
4480 data family Array e
4481 </programlisting>
4482       Named arguments can also be given explicit kind signatures if needed.
4483       Just as with
4484       [http://www.haskell.org/ghc/docs/latest/html/users_guide/gadt.html GADT
4485       declarations] named arguments are entirely optional, so that we can
4486       declare <literal>Array</literal> alternatively with
4487 <programlisting>
4488 data family Array :: * -> *
4489 </programlisting>
4490     </para>
4491
4492     <sect4 id="assoc-data-family-decl">
4493       <title>Associated data family declarations</title>
4494       <para>
4495         When a data family is declared as part of a type class, we drop
4496         the <literal>family</literal> special.  The <literal>GMap</literal>
4497         declaration takes the following form
4498 <programlisting>
4499 class GMapKey k where
4500   data GMap k :: * -> *
4501   ...
4502 </programlisting>
4503         In contrast to toplevel declarations, named arguments must be used for
4504         all type parameters that are to be used as type-indexes.  Moreover,
4505         the argument names must be class parameters.  Each class parameter may
4506         only be used at most once per associated type, but some may be omitted
4507         and they may be in an order other than in the class head.  Hence, the
4508         following contrived example is admissible:
4509 <programlisting>
4510   class C a b c where
4511   data T c a :: *
4512 </programlisting>
4513       </para>
4514     </sect4>
4515   </sect3>
4516
4517   <sect3 id="data-instance-declarations">
4518     <title>Data instance declarations</title>
4519
4520     <para>
4521       Instance declarations of data and newtype families are very similar to
4522       standard data and newtype declarations.  The only two differences are
4523       that the keyword <literal>data</literal> or <literal>newtype</literal>
4524       is followed by <literal>instance</literal> and that some or all of the
4525       type arguments can be non-variable types, but may not contain forall
4526       types or type synonym families.  However, data families are generally
4527       allowed in type parameters, and type synonyms are allowed as long as
4528       they are fully applied and expand to a type that is itself admissible -
4529       exactly as this is required for occurrences of type synonyms in class
4530       instance parameters.  For example, the <literal>Either</literal>
4531       instance for <literal>GMap</literal> is
4532 <programlisting>
4533 data instance GMap (Either a b) v = GMapEither (GMap a v) (GMap b v)
4534 </programlisting>
4535       In this example, the declaration has only one variant.  In general, it
4536       can be any number.
4537     </para>
4538     <para>
4539       Data and newtype instance declarations are only permitted when an
4540       appropriate family declaration is in scope - just as a class instance declaration
4541       requires the class declaration to be visible.  Moreover, each instance
4542       declaration has to conform to the kind determined by its family
4543       declaration.  This implies that the number of parameters of an instance
4544       declaration matches the arity determined by the kind of the family.
4545     </para>
4546     <para>
4547       A data family instance declaration can use the full expressiveness of
4548       ordinary <literal>data</literal> or <literal>newtype</literal> declarations:
4549       <itemizedlist>
4550       <listitem><para> Although, a data family is <emphasis>introduced</emphasis> with
4551       the keyword "<literal>data</literal>", a data family <emphasis>instance</emphasis> can
4552       use either <literal>data</literal> or <literal>newtype</literal>. For example:
4553 <programlisting>
4554 data family T a
4555 data    instance T Int  = T1 Int | T2 Bool
4556 newtype instance T Char = TC Bool
4557 </programlisting>
4558       </para></listitem>
4559       <listitem><para> A <literal>data instance</literal> can use GADT syntax for the data constructors,
4560       and indeed can define a GADT.  For example:
4561 <programlisting>
4562 data family G a b
4563 data instance G [a] b where
4564    G1 :: c -> G [Int] b
4565    G2 :: G [a] Bool
4566 </programlisting>
4567       </para></listitem>
4568       <listitem><para> You can use a <literal>deriving</literal> clause on a
4569       <literal>data instance</literal> or <literal>newtype instance</literal>
4570       declaration.
4571       </para></listitem>
4572       </itemizedlist>
4573     </para>
4574
4575     <para>
4576       Even if type families are defined as toplevel declarations, functions
4577       that perform different computations for different family instances may still
4578       need to be defined as methods of type classes.  In particular, the
4579       following is not possible:
4580 <programlisting>
4581 data family T a
4582 data instance T Int  = A
4583 data instance T Char = B
4584 foo :: T a -> Int
4585 foo A = 1             -- WRONG: These two equations together...
4586 foo B = 2             -- ...will produce a type error.
4587 </programlisting>
4588 Instead, you would have to write <literal>foo</literal> as a class operation, thus:
4589 <programlisting>
4590 class C a where
4591   foo :: T a -> Int
4592 instance Foo Int where
4593   foo A = 1
4594 instance Foo Char where
4595   foo B = 2
4596 </programlisting>
4597       (Given the functionality provided by GADTs (Generalised Algebraic Data
4598       Types), it might seem as if a definition, such as the above, should be
4599       feasible.  However, type families are - in contrast to GADTs - are
4600       <emphasis>open;</emphasis> i.e., new instances can always be added,
4601       possibly in other
4602       modules.  Supporting pattern matching across different data instances
4603       would require a form of extensible case construct.)
4604     </para>
4605
4606     <sect4 id="assoc-data-inst">
4607       <title>Associated data instances</title>
4608       <para>
4609         When an associated data family instance is declared within a type
4610         class instance, we drop the <literal>instance</literal> keyword in the
4611         family instance.  So, the <literal>Either</literal> instance
4612         for <literal>GMap</literal> becomes:
4613 <programlisting>
4614 instance (GMapKey a, GMapKey b) => GMapKey (Either a b) where
4615   data GMap (Either a b) v = GMapEither (GMap a v) (GMap b v)
4616   ...
4617 </programlisting>
4618         The most important point about associated family instances is that the
4619         type indexes corresponding to class parameters must be identical to
4620         the type given in the instance head; here this is the first argument
4621         of <literal>GMap</literal>, namely <literal>Either a b</literal>,
4622         which coincides with the only class parameter.  Any parameters to the
4623         family constructor that do not correspond to class parameters, need to
4624         be variables in every instance; here this is the
4625         variable <literal>v</literal>.
4626       </para>
4627       <para>
4628         Instances for an associated family can only appear as part of
4629         instances declarations of the class in which the family was declared -
4630         just as with the equations of the methods of a class.  Also in
4631         correspondence to how methods are handled, declarations of associated
4632         types can be omitted in class instances.  If an associated family
4633         instance is omitted, the corresponding instance type is not inhabited;
4634         i.e., only diverging expressions, such
4635         as <literal>undefined</literal>, can assume the type.
4636       </para>
4637     </sect4>
4638
4639     <sect4 id="scoping-class-params">
4640       <title>Scoping of class parameters</title>
4641       <para>
4642         In the case of multi-parameter type classes, the visibility of class
4643         parameters in the right-hand side of associated family instances
4644         depends <emphasis>solely</emphasis> on the parameters of the data
4645         family.  As an example, consider the simple class declaration
4646 <programlisting>
4647 class C a b where
4648   data T a
4649 </programlisting>
4650         Only one of the two class parameters is a parameter to the data
4651         family.  Hence, the following instance declaration is invalid:
4652 <programlisting>
4653 instance C [c] d where
4654   data T [c] = MkT (c, d)    -- WRONG!!  'd' is not in scope
4655 </programlisting>
4656         Here, the right-hand side of the data instance mentions the type
4657         variable <literal>d</literal> that does not occur in its left-hand
4658         side.  We cannot admit such data instances as they would compromise
4659         type safety.
4660       </para>
4661     </sect4>
4662
4663     <sect4 id="family-class-inst">
4664       <title>Type class instances of family instances</title>
4665       <para>
4666         Type class instances of instances of data families can be defined as
4667         usual, and in particular data instance declarations can
4668         have <literal>deriving</literal> clauses.  For example, we can write
4669 <programlisting>
4670 data GMap () v = GMapUnit (Maybe v)
4671                deriving Show
4672 </programlisting>
4673         which implicitly defines an instance of the form
4674 <programlisting>
4675 instance Show v => Show (GMap () v) where ...
4676 </programlisting>
4677       </para>
4678       <para>
4679         Note that class instances are always for
4680         particular <emphasis>instances</emphasis> of a data family and never
4681         for an entire family as a whole.  This is for essentially the same
4682         reasons that we cannot define a toplevel function that performs
4683         pattern matching on the data constructors
4684         of <emphasis>different</emphasis> instances of a single type family.
4685         It would require a form of extensible case construct.
4686       </para>
4687     </sect4>
4688
4689     <sect4 id="data-family-overlap">
4690       <title>Overlap of data instances</title>
4691       <para>
4692         The instance declarations of a data family used in a single program
4693         may not overlap at all, independent of whether they are associated or
4694         not.  In contrast to type class instances, this is not only a matter
4695         of consistency, but one of type safety.
4696       </para>
4697     </sect4>
4698
4699   </sect3>
4700
4701   <sect3 id="data-family-import-export">
4702     <title>Import and export</title>
4703
4704     <para>
4705       The association of data constructors with type families is more dynamic
4706       than that is the case with standard data and newtype declarations.  In
4707       the standard case, the notation <literal>T(..)</literal> in an import or
4708       export list denotes the type constructor and all the data constructors
4709       introduced in its declaration.  However, a family declaration never
4710       introduces any data constructors; instead, data constructors are
4711       introduced by family instances.  As a result, which data constructors
4712       are associated with a type family depends on the currently visible
4713       instance declarations for that family.  Consequently, an import or
4714       export item of the form <literal>T(..)</literal> denotes the family
4715       constructor and all currently visible data constructors - in the case of
4716       an export item, these may be either imported or defined in the current
4717       module.  The treatment of import and export items that explicitly list
4718       data constructors, such as <literal>GMap(GMapEither)</literal>, is
4719       analogous.
4720     </para>
4721
4722     <sect4 id="data-family-impexp-assoc">
4723       <title>Associated families</title>
4724       <para>
4725         As expected, an import or export item of the
4726         form <literal>C(..)</literal> denotes all of the class' methods and
4727         associated types.  However, when associated types are explicitly
4728         listed as subitems of a class, we need some new syntax, as uppercase
4729         identifiers as subitems are usually data constructors, not type
4730         constructors.  To clarify that we denote types here, each associated
4731         type name needs to be prefixed by the keyword <literal>type</literal>.
4732         So for example, when explicitly listing the components of
4733         the <literal>GMapKey</literal> class, we write <literal>GMapKey(type
4734         GMap, empty, lookup, insert)</literal>.
4735       </para>
4736     </sect4>
4737
4738     <sect4 id="data-family-impexp-examples">
4739       <title>Examples</title>
4740       <para>
4741         Assuming our running <literal>GMapKey</literal> class example, let us
4742         look at some export lists and their meaning:
4743         <itemizedlist>
4744           <listitem>
4745             <para><literal>module GMap (GMapKey) where...</literal>: Exports
4746               just the class name.</para>
4747           </listitem>
4748           <listitem>
4749             <para><literal>module GMap (GMapKey(..)) where...</literal>:
4750               Exports the class, the associated type <literal>GMap</literal>
4751               and the member
4752               functions <literal>empty</literal>, <literal>lookup</literal>,
4753               and <literal>insert</literal>.  None of the data constructors is
4754               exported.</para>
4755           </listitem>
4756           <listitem>
4757             <para><literal>module GMap (GMapKey(..), GMap(..))
4758                 where...</literal>: As before, but also exports all the data
4759               constructors <literal>GMapInt</literal>,
4760               <literal>GMapChar</literal>,
4761               <literal>GMapUnit</literal>, <literal>GMapPair</literal>,
4762               and <literal>GMapUnit</literal>.</para>
4763           </listitem>
4764           <listitem>
4765             <para><literal>module GMap (GMapKey(empty, lookup, insert),
4766             GMap(..)) where...</literal>: As before.</para>
4767           </listitem>
4768           <listitem>
4769             <para><literal>module GMap (GMapKey, empty, lookup, insert, GMap(..))
4770                 where...</literal>: As before.</para>
4771           </listitem>
4772         </itemizedlist>
4773       </para>
4774       <para>
4775         Finally, you can write <literal>GMapKey(type GMap)</literal> to denote
4776         both the class <literal>GMapKey</literal> as well as its associated
4777         type <literal>GMap</literal>.  However, you cannot
4778         write <literal>GMapKey(type GMap(..))</literal> &mdash; i.e.,
4779         sub-component specifications cannot be nested.  To
4780         specify <literal>GMap</literal>'s data constructors, you have to list
4781         it separately.
4782       </para>
4783     </sect4>
4784
4785     <sect4 id="data-family-impexp-instances">
4786       <title>Instances</title>
4787       <para>
4788         Family instances are implicitly exported, just like class instances.
4789         However, this applies only to the heads of instances, not to the data
4790         constructors an instance defines.
4791       </para>
4792     </sect4>
4793
4794   </sect3>
4795
4796 </sect2>
4797
4798 <sect2 id="synonym-families">
4799   <title>Synonym families</title>
4800
4801   <para>
4802     Type families appear in two flavours: (1) they can be defined on the
4803     toplevel or (2) they can appear inside type classes (in which case they
4804     are known as associated type synonyms).  The former is the more general
4805     variant, as it lacks the requirement for the type-indexes to coincide with
4806     the class parameters.  However, the latter can lead to more clearly
4807     structured code and compiler warnings if some type instances were -
4808     possibly accidentally - omitted.  In the following, we always discuss the
4809     general toplevel form first and then cover the additional constraints
4810     placed on associated types.
4811   </para>
4812
4813   <sect3 id="type-family-declarations">
4814     <title>Type family declarations</title>
4815
4816     <para>
4817       Indexed type families are introduced by a signature, such as
4818 <programlisting>
4819 type family Elem c :: *
4820 </programlisting>
4821       The special <literal>family</literal> distinguishes family from standard
4822       type declarations.  The result kind annotation is optional and, as
4823       usual, defaults to <literal>*</literal> if omitted.  An example is
4824 <programlisting>
4825 type family Elem c
4826 </programlisting>
4827       Parameters can also be given explicit kind signatures if needed.  We
4828       call the number of parameters in a type family declaration, the family's
4829       arity, and all applications of a type family must be fully saturated
4830       w.r.t. to that arity.  This requirement is unlike ordinary type synonyms
4831       and it implies that the kind of a type family is not sufficient to
4832       determine a family's arity, and hence in general, also insufficient to
4833       determine whether a type family application is well formed.  As an
4834       example, consider the following declaration:
4835 <programlisting>
4836 type family F a b :: * -> *   -- F's arity is 2,
4837                               -- although its overall kind is * -> * -> * -> *
4838 </programlisting>
4839       Given this declaration the following are examples of well-formed and
4840       malformed types:
4841 <programlisting>
4842 F Char [Int]       -- OK!  Kind: * -> *
4843 F Char [Int] Bool  -- OK!  Kind: *
4844 F IO Bool          -- WRONG: kind mismatch in the first argument
4845 F Bool             -- WRONG: unsaturated application
4846 </programlisting>
4847       </para>
4848
4849     <sect4 id="assoc-type-family-decl">
4850       <title>Associated type family declarations</title>
4851       <para>
4852         When a type family is declared as part of a type class, we drop
4853         the <literal>family</literal> special.  The <literal>Elem</literal>
4854         declaration takes the following form
4855 <programlisting>
4856 class Collects ce where
4857   type Elem ce :: *
4858   ...
4859 </programlisting>
4860         The argument names of the type family must be class parameters.  Each
4861         class parameter may only be used at most once per associated type, but
4862         some may be omitted and they may be in an order other than in the
4863         class head.  Hence, the following contrived example is admissible:
4864 <programlisting>
4865 class C a b c where
4866   type T c a :: *
4867 </programlisting>
4868         These rules are exactly as for associated data families.
4869       </para>
4870     </sect4>
4871   </sect3>
4872
4873   <sect3 id="type-instance-declarations">
4874     <title>Type instance declarations</title>
4875     <para>
4876       Instance declarations of type families are very similar to standard type
4877       synonym declarations.  The only two differences are that the
4878       keyword <literal>type</literal> is followed
4879       by <literal>instance</literal> and that some or all of the type
4880       arguments can be non-variable types, but may not contain forall types or
4881       type synonym families. However, data families are generally allowed, and
4882       type synonyms are allowed as long as they are fully applied and expand
4883       to a type that is admissible - these are the exact same requirements as
4884       for data instances.  For example, the <literal>[e]</literal> instance
4885       for <literal>Elem</literal> is
4886 <programlisting>
4887 type instance Elem [e] = e
4888 </programlisting>
4889     </para>
4890     <para>
4891       Type family instance declarations are only legitimate when an
4892       appropriate family declaration is in scope - just like class instances
4893       require the class declaration to be visible.  Moreover, each instance
4894       declaration has to conform to the kind determined by its family
4895       declaration, and the number of type parameters in an instance
4896       declaration must match the number of type parameters in the family
4897       declaration.   Finally, the right-hand side of a type instance must be a
4898       monotype (i.e., it may not include foralls) and after the expansion of
4899       all saturated vanilla type synonyms, no synonyms, except family synonyms
4900       may remain.  Here are some examples of admissible and illegal type
4901       instances:
4902 <programlisting>
4903 type family F a :: *
4904 type instance F [Int]              = Int         -- OK!
4905 type instance F String             = Char        -- OK!
4906 type instance F (F a)              = a           -- WRONG: type parameter mentions a type family
4907 type instance F (forall a. (a, b)) = b           -- WRONG: a forall type appears in a type parameter
4908 type instance F Float              = forall a.a  -- WRONG: right-hand side may not be a forall type
4909
4910 type family G a b :: * -> *
4911 type instance G Int            = (,)     -- WRONG: must be two type parameters
4912 type instance G Int Char Float = Double  -- WRONG: must be two type parameters
4913 </programlisting>
4914     </para>
4915
4916     <sect4 id="assoc-type-instance">
4917       <title>Associated type instance declarations</title>
4918       <para>
4919         When an associated family instance is declared within a type class
4920         instance, we drop the <literal>instance</literal> keyword in the family
4921         instance.  So, the <literal>[e]</literal> instance
4922         for <literal>Elem</literal> becomes:
4923 <programlisting>
4924 instance (Eq (Elem [e])) => Collects ([e]) where
4925   type Elem [e] = e
4926   ...
4927 </programlisting>
4928         The most important point about associated family instances is that the
4929         type indexes corresponding to class parameters must be identical to the
4930         type given in the instance head; here this is <literal>[e]</literal>,
4931         which coincides with the only class parameter.
4932       </para>
4933       <para>
4934         Instances for an associated family can only appear as part of  instances
4935         declarations of the class in which the family was declared - just as
4936         with the equations of the methods of a class.  Also in correspondence to
4937         how methods are handled, declarations of associated types can be omitted
4938         in class instances.  If an associated family instance is omitted, the
4939         corresponding instance type is not inhabited; i.e., only diverging
4940         expressions, such as <literal>undefined</literal>, can assume the type.
4941       </para>
4942     </sect4>
4943
4944     <sect4 id="type-family-overlap">
4945       <title>Overlap of type synonym instances</title>
4946       <para>
4947         The instance declarations of a type family used in a single program
4948         may only overlap if the right-hand sides of the overlapping instances
4949         coincide for the overlapping types.  More formally, two instance
4950         declarations overlap if there is a substitution that makes the
4951         left-hand sides of the instances syntactically the same.  Whenever
4952         that is the case, the right-hand sides of the instances must also be
4953         syntactically equal under the same substitution.  This condition is
4954         independent of whether the type family is associated or not, and it is
4955         not only a matter of consistency, but one of type safety.
4956       </para>
4957       <para>
4958         Here are two example to illustrate the condition under which overlap
4959         is permitted.
4960 <programlisting>
4961 type instance F (a, Int) = [a]
4962 type instance F (Int, b) = [b]   -- overlap permitted
4963
4964 type instance G (a, Int)  = [a]
4965 type instance G (Char, a) = [a]  -- ILLEGAL overlap, as [Char] /= [Int]
4966 </programlisting>
4967       </para>
4968     </sect4>
4969
4970     <sect4 id="type-family-decidability">
4971       <title>Decidability of type synonym instances</title>
4972       <para>
4973         In order to guarantee that type inference in the presence of type
4974         families decidable, we need to place a number of additional
4975         restrictions on the formation of type instance declarations (c.f.,
4976         Definition 5 (Relaxed Conditions) of &ldquo;<ulink
4977         url="http://www.cse.unsw.edu.au/~chak/papers/SPCS08.html">Type
4978           Checking with Open Type Functions</ulink>&rdquo;).  Instance
4979           declarations have the general form
4980 <programlisting>
4981 type instance F t1 .. tn = t
4982 </programlisting>
4983         where we require that for every type family application <literal>(G s1
4984         .. sm)</literal> in <literal>t</literal>,
4985         <orderedlist>
4986           <listitem>
4987             <para><literal>s1 .. sm</literal> do not contain any type family
4988             constructors,</para>
4989           </listitem>
4990           <listitem>
4991             <para>the total number of symbols (data type constructors and type
4992             variables) in <literal>s1 .. sm</literal> is strictly smaller than
4993             in <literal>t1 .. tn</literal>, and</para>
4994           </listitem>
4995           <listitem>
4996             <para>for every type
4997             variable <literal>a</literal>, <literal>a</literal> occurs
4998             in <literal>s1 .. sm</literal> at most as often as in <literal>t1
4999             .. tn</literal>.</para>
5000           </listitem>
5001         </orderedlist>
5002         These restrictions are easily verified and ensure termination of type
5003         inference.  However, they are not sufficient to guarantee completeness
5004         of type inference in the presence of, so called, ''loopy equalities'',
5005         such as <literal>a ~ [F a]</literal>, where a recursive occurrence of
5006         a type variable is underneath a family application and data
5007         constructor application - see the above mentioned paper for details.
5008       </para>
5009       <para>
5010         If the option <option>-XUndecidableInstances</option> is passed to the
5011         compiler, the above restrictions are not enforced and it is on the
5012         programmer to ensure termination of the normalisation of type families
5013         during type inference.
5014       </para>
5015     </sect4>
5016   </sect3>
5017
5018   <sect3 id-="equality-constraints">
5019     <title>Equality constraints</title>
5020     <para>
5021       Type context can include equality constraints of the form <literal>t1 ~
5022       t2</literal>, which denote that the types <literal>t1</literal>
5023       and <literal>t2</literal> need to be the same.  In the presence of type
5024       families, whether two types are equal cannot generally be decided
5025       locally.  Hence, the contexts of function signatures may include
5026       equality constraints, as in the following example:
5027 <programlisting>
5028 sumCollects :: (Collects c1, Collects c2, Elem c1 ~ Elem c2) => c1 -> c2 -> c2
5029 </programlisting>
5030       where we require that the element type of <literal>c1</literal>
5031       and <literal>c2</literal> are the same.  In general, the
5032       types <literal>t1</literal> and <literal>t2</literal> of an equality
5033       constraint may be arbitrary monotypes; i.e., they may not contain any
5034       quantifiers, independent of whether higher-rank types are otherwise
5035       enabled.
5036     </para>
5037     <para>
5038       Equality constraints can also appear in class and instance contexts.
5039       The former enable a simple translation of programs using functional
5040       dependencies into programs using family synonyms instead.  The general
5041       idea is to rewrite a class declaration of the form
5042 <programlisting>
5043 class C a b | a -> b
5044 </programlisting>
5045       to
5046 <programlisting>
5047 class (F a ~ b) => C a b where
5048   type F a
5049 </programlisting>
5050       That is, we represent every functional dependency (FD) <literal>a1 .. an
5051       -> b</literal> by an FD type family <literal>F a1 .. an</literal> and a
5052       superclass context equality <literal>F a1 .. an ~ b</literal>,
5053       essentially giving a name to the functional dependency.  In class
5054       instances, we define the type instances of FD families in accordance
5055       with the class head.  Method signatures are not affected by that
5056       process.
5057     </para>
5058     <para>
5059       NB: Equalities in superclass contexts are not fully implemented in
5060       GHC 6.10.
5061     </para>
5062   </sect3>
5063
5064   <sect3 id-="ty-fams-in-instances">
5065     <title>Type families and instance declarations</title>
5066     <para>Type families require us to extend the rules for
5067       the form of instance heads, which are given
5068       in <xref linkend="flexible-instance-head"/>.
5069       Specifically:
5070 <itemizedlist>
5071  <listitem><para>Data type families may appear in an instance head</para></listitem>
5072  <listitem><para>Type synonym families may not appear (at all) in an instance head</para></listitem>
5073 </itemizedlist>
5074 The reason for the latter restriction is that there is no way to check for. Consider
5075 <programlisting>
5076    type family F a
5077    type instance F Bool = Int
5078
5079    class C a
5080
5081    instance C Int
5082    instance C (F a)
5083 </programlisting>
5084 Now a constraint <literal>(C (F Bool))</literal> would match both instances.
5085 The situation is especially bad because the type instance for <literal>F Bool</literal>
5086 might be in another module, or even in a module that is not yet written.
5087 </para>
5088 </sect3>
5089 </sect2>
5090
5091 </sect1>
5092
5093 <sect1 id="other-type-extensions">
5094 <title>Other type system extensions</title>
5095
5096 <sect2 id="explicit-foralls"><title>Explicit universal quantification (forall)</title>
5097 <para>
5098 Haskell type signatures are implicitly quantified.  When the language option <option>-XExplicitForAll</option>
5099 is used, the keyword <literal>forall</literal>
5100 allows us to say exactly what this means.  For example:
5101 </para>
5102 <para>
5103 <programlisting>
5104         g :: b -> b
5105 </programlisting>
5106 means this:
5107 <programlisting>
5108         g :: forall b. (b -> b)
5109 </programlisting>
5110 The two are treated identically.
5111 </para>
5112 <para>
5113 Of course <literal>forall</literal> becomes a keyword; you can't use <literal>forall</literal> as
5114 a type variable any more!
5115 </para>
5116 </sect2>
5117
5118
5119 <sect2 id="flexible-contexts"><title>The context of a type signature</title>
5120 <para>
5121 The <option>-XFlexibleContexts</option> flag lifts the Haskell 98 restriction
5122 that the type-class constraints in a type signature must have the
5123 form <emphasis>(class type-variable)</emphasis> or
5124 <emphasis>(class (type-variable type-variable ...))</emphasis>.
5125 With <option>-XFlexibleContexts</option>
5126 these type signatures are perfectly OK
5127 <programlisting>
5128   g :: Eq [a] => ...
5129   g :: Ord (T a ()) => ...
5130 </programlisting>
5131 The flag <option>-XFlexibleContexts</option> also lifts the corresponding
5132 restriction on class declarations (<xref linkend="superclass-rules"/>) and instance declarations
5133 (<xref linkend="instance-rules"/>).
5134 </para>
5135
5136 <para>
5137 GHC imposes the following restrictions on the constraints in a type signature.
5138 Consider the type:
5139
5140 <programlisting>
5141   forall tv1..tvn (c1, ...,cn) => type
5142 </programlisting>
5143
5144 (Here, we write the "foralls" explicitly, although the Haskell source
5145 language omits them; in Haskell 98, all the free type variables of an
5146 explicit source-language type signature are universally quantified,
5147 except for the class type variables in a class declaration.  However,
5148 in GHC, you can give the foralls if you want.  See <xref linkend="explicit-foralls"/>).
5149 </para>
5150
5151 <para>
5152
5153 <orderedlist>
5154 <listitem>
5155
5156 <para>
5157  <emphasis>Each universally quantified type variable
5158 <literal>tvi</literal> must be reachable from <literal>type</literal></emphasis>.
5159
5160 A type variable <literal>a</literal> is "reachable" if it appears
5161 in the same constraint as either a type variable free in
5162 <literal>type</literal>, or another reachable type variable.
5163 A value with a type that does not obey
5164 this reachability restriction cannot be used without introducing
5165 ambiguity; that is why the type is rejected.
5166 Here, for example, is an illegal type:
5167
5168
5169 <programlisting>
5170   forall a. Eq a => Int
5171 </programlisting>
5172
5173
5174 When a value with this type was used, the constraint <literal>Eq tv</literal>
5175 would be introduced where <literal>tv</literal> is a fresh type variable, and
5176 (in the dictionary-translation implementation) the value would be
5177 applied to a dictionary for <literal>Eq tv</literal>.  The difficulty is that we
5178 can never know which instance of <literal>Eq</literal> to use because we never
5179 get any more information about <literal>tv</literal>.
5180 </para>
5181 <para>
5182 Note
5183 that the reachability condition is weaker than saying that <literal>a</literal> is
5184 functionally dependent on a type variable free in
5185 <literal>type</literal> (see <xref
5186 linkend="functional-dependencies"/>).  The reason for this is there
5187 might be a "hidden" dependency, in a superclass perhaps.  So
5188 "reachable" is a conservative approximation to "functionally dependent".
5189 For example, consider:
5190 <programlisting>
5191   class C a b | a -> b where ...
5192   class C a b => D a b where ...
5193   f :: forall a b. D a b => a -> a
5194 </programlisting>
5195 This is fine, because in fact <literal>a</literal> does functionally determine <literal>b</literal>
5196 but that is not immediately apparent from <literal>f</literal>'s type.
5197 </para>
5198 </listitem>
5199 <listitem>
5200
5201 <para>
5202  <emphasis>Every constraint <literal>ci</literal> must mention at least one of the
5203 universally quantified type variables <literal>tvi</literal></emphasis>.
5204
5205 For example, this type is OK because <literal>C a b</literal> mentions the
5206 universally quantified type variable <literal>b</literal>:
5207
5208
5209 <programlisting>
5210   forall a. C a b => burble
5211 </programlisting>
5212
5213
5214 The next type is illegal because the constraint <literal>Eq b</literal> does not
5215 mention <literal>a</literal>:
5216
5217
5218 <programlisting>
5219   forall a. Eq b => burble
5220 </programlisting>
5221
5222
5223 The reason for this restriction is milder than the other one.  The
5224 excluded types are never useful or necessary (because the offending
5225 context doesn't need to be witnessed at this point; it can be floated
5226 out).  Furthermore, floating them out increases sharing. Lastly,
5227 excluding them is a conservative choice; it leaves a patch of
5228 territory free in case we need it later.
5229
5230 </para>
5231 </listitem>
5232
5233 </orderedlist>
5234
5235 </para>
5236
5237 </sect2>
5238
5239 <sect2 id="implicit-parameters">
5240 <title>Implicit parameters</title>
5241
5242 <para> Implicit parameters are implemented as described in
5243 "Implicit parameters: dynamic scoping with static types",
5244 J Lewis, MB Shields, E Meijer, J Launchbury,
5245 27th ACM Symposium on Principles of Programming Languages (POPL'00),
5246 Boston, Jan 2000.
5247 </para>
5248
5249 <para>(Most of the following, still rather incomplete, documentation is
5250 due to Jeff Lewis.)</para>
5251
5252 <para>Implicit parameter support is enabled with the option
5253 <option>-XImplicitParams</option>.</para>
5254
5255 <para>
5256 A variable is called <emphasis>dynamically bound</emphasis> when it is bound by the calling
5257 context of a function and <emphasis>statically bound</emphasis> when bound by the callee's
5258 context. In Haskell, all variables are statically bound. Dynamic
5259 binding of variables is a notion that goes back to Lisp, but was later
5260 discarded in more modern incarnations, such as Scheme. Dynamic binding
5261 can be very confusing in an untyped language, and unfortunately, typed
5262 languages, in particular Hindley-Milner typed languages like Haskell,
5263 only support static scoping of variables.
5264 </para>
5265 <para>
5266 However, by a simple extension to the type class system of Haskell, we
5267 can support dynamic binding. Basically, we express the use of a
5268 dynamically bound variable as a constraint on the type. These
5269 constraints lead to types of the form <literal>(?x::t') => t</literal>, which says "this
5270 function uses a dynamically-bound variable <literal>?x</literal>
5271 of type <literal>t'</literal>". For
5272 example, the following expresses the type of a sort function,
5273 implicitly parameterized by a comparison function named <literal>cmp</literal>.
5274 <programlisting>
5275   sort :: (?cmp :: a -> a -> Bool) => [a] -> [a]
5276 </programlisting>
5277 The dynamic binding constraints are just a new form of predicate in the type class system.
5278 </para>
5279 <para>
5280 An implicit parameter occurs in an expression using the special form <literal>?x</literal>,
5281 where <literal>x</literal> is
5282 any valid identifier (e.g. <literal>ord ?x</literal> is a valid expression).
5283 Use of this construct also introduces a new
5284 dynamic-binding constraint in the type of the expression.
5285 For example, the following definition
5286 shows how we can define an implicitly parameterized sort function in
5287 terms of an explicitly parameterized <literal>sortBy</literal> function:
5288 <programlisting>
5289   sortBy :: (a -> a -> Bool) -> [a] -> [a]
5290
5291   sort   :: (?cmp :: a -> a -> Bool) => [a] -> [a]
5292   sort    = sortBy ?cmp
5293 </programlisting>
5294 </para>
5295
5296 <sect3>
5297 <title>Implicit-parameter type constraints</title>
5298 <para>
5299 Dynamic binding constraints behave just like other type class
5300 constraints in that they are automatically propagated. Thus, when a
5301 function is used, its implicit parameters are inherited by the
5302 function that called it. For example, our <literal>sort</literal> function might be used
5303 to pick out the least value in a list:
5304 <programlisting>
5305   least   :: (?cmp :: a -> a -> Bool) => [a] -> a
5306   least xs = head (sort xs)
5307 </programlisting>
5308 Without lifting a finger, the <literal>?cmp</literal> parameter is
5309 propagated to become a parameter of <literal>least</literal> as well. With explicit
5310 parameters, the default is that parameters must always be explicit
5311 propagated. With implicit parameters, the default is to always
5312 propagate them.
5313 </para>
5314 <para>
5315 An implicit-parameter type constraint differs from other type class constraints in the
5316 following way: All uses of a particular implicit parameter must have
5317 the same type. This means that the type of <literal>(?x, ?x)</literal>
5318 is <literal>(?x::a) => (a,a)</literal>, and not
5319 <literal>(?x::a, ?x::b) => (a, b)</literal>, as would be the case for type
5320 class constraints.
5321 </para>
5322
5323 <para> You can't have an implicit parameter in the context of a class or instance
5324 declaration.  For example, both these declarations are illegal:
5325 <programlisting>
5326   class (?x::Int) => C a where ...
5327   instance (?x::a) => Foo [a] where ...
5328 </programlisting>
5329 Reason: exactly which implicit parameter you pick up depends on exactly where
5330 you invoke a function. But the ``invocation'' of instance declarations is done
5331 behind the scenes by the compiler, so it's hard to figure out exactly where it is done.
5332 Easiest thing is to outlaw the offending types.</para>
5333 <para>
5334 Implicit-parameter constraints do not cause ambiguity.  For example, consider:
5335 <programlisting>
5336    f :: (?x :: [a]) => Int -> Int
5337    f n = n + length ?x
5338
5339    g :: (Read a, Show a) => String -> String
5340    g s = show (read s)
5341 </programlisting>
5342 Here, <literal>g</literal> has an ambiguous type, and is rejected, but <literal>f</literal>
5343 is fine.  The binding for <literal>?x</literal> at <literal>f</literal>'s call site is
5344 quite unambiguous, and fixes the type <literal>a</literal>.
5345 </para>
5346 </sect3>
5347
5348 <sect3>
5349 <title>Implicit-parameter bindings</title>
5350
5351 <para>
5352 An implicit parameter is <emphasis>bound</emphasis> using the standard
5353 <literal>let</literal> or <literal>where</literal> binding forms.
5354 For example, we define the <literal>min</literal> function by binding
5355 <literal>cmp</literal>.
5356 <programlisting>
5357   min :: [a] -> a
5358   min  = let ?cmp = (&lt;=) in least
5359 </programlisting>
5360 </para>
5361 <para>
5362 A group of implicit-parameter bindings may occur anywhere a normal group of Haskell
5363 bindings can occur, except at top level.  That is, they can occur in a <literal>let</literal>
5364 (including in a list comprehension, or do-notation, or pattern guards),
5365 or a <literal>where</literal> clause.
5366 Note the following points:
5367 <itemizedlist>
5368 <listitem><para>
5369 An implicit-parameter binding group must be a
5370 collection of simple bindings to implicit-style variables (no
5371 function-style bindings, and no type signatures); these bindings are
5372 neither polymorphic or recursive.
5373 </para></listitem>
5374 <listitem><para>
5375 You may not mix implicit-parameter bindings with ordinary bindings in a
5376 single <literal>let</literal>
5377 expression; use two nested <literal>let</literal>s instead.
5378 (In the case of <literal>where</literal> you are stuck, since you can't nest <literal>where</literal> clauses.)
5379 </para></listitem>
5380
5381 <listitem><para>
5382 You may put multiple implicit-parameter bindings in a
5383 single binding group; but they are <emphasis>not</emphasis> treated
5384 as a mutually recursive group (as ordinary <literal>let</literal> bindings are).
5385 Instead they are treated as a non-recursive group, simultaneously binding all the implicit
5386 parameter.  The bindings are not nested, and may be re-ordered without changing
5387 the meaning of the program.
5388 For example, consider:
5389 <programlisting>
5390   f t = let { ?x = t; ?y = ?x+(1::Int) } in ?x + ?y
5391 </programlisting>
5392 The use of <literal>?x</literal> in the binding for <literal>?y</literal> does not "see"
5393 the binding for <literal>?x</literal>, so the type of <literal>f</literal> is
5394 <programlisting>
5395   f :: (?x::Int) => Int -> Int
5396 </programlisting>
5397 </para></listitem>
5398 </itemizedlist>
5399 </para>
5400
5401 </sect3>
5402
5403 <sect3><title>Implicit parameters and polymorphic recursion</title>
5404
5405 <para>
5406 Consider these two definitions:
5407 <programlisting>
5408   len1 :: [a] -> Int
5409   len1 xs = let ?acc = 0 in len_acc1 xs
5410
5411   len_acc1 [] = ?acc
5412   len_acc1 (x:xs) = let ?acc = ?acc + (1::Int) in len_acc1 xs
5413
5414   ------------
5415
5416   len2 :: [a] -> Int
5417   len2 xs = let ?acc = 0 in len_acc2 xs
5418
5419   len_acc2 :: (?acc :: Int) => [a] -> Int
5420   len_acc2 [] = ?acc
5421   len_acc2 (x:xs) = let ?acc = ?acc + (1::Int) in len_acc2 xs
5422 </programlisting>
5423 The only difference between the two groups is that in the second group
5424 <literal>len_acc</literal> is given a type signature.
5425 In the former case, <literal>len_acc1</literal> is monomorphic in its own
5426 right-hand side, so the implicit parameter <literal>?acc</literal> is not
5427 passed to the recursive call.  In the latter case, because <literal>len_acc2</literal>
5428 has a type signature, the recursive call is made to the
5429 <emphasis>polymorphic</emphasis> version, which takes <literal>?acc</literal>
5430 as an implicit parameter.  So we get the following results in GHCi:
5431 <programlisting>
5432   Prog> len1 "hello"
5433   0
5434   Prog> len2 "hello"
5435   5
5436 </programlisting>
5437 Adding a type signature dramatically changes the result!  This is a rather
5438 counter-intuitive phenomenon, worth watching out for.
5439 </para>
5440 </sect3>
5441
5442 <sect3><title>Implicit parameters and monomorphism</title>
5443
5444 <para>GHC applies the dreaded Monomorphism Restriction (section 4.5.5 of the
5445 Haskell Report) to implicit parameters.  For example, consider:
5446 <programlisting>
5447  f :: Int -> Int
5448   f v = let ?x = 0     in
5449         let y = ?x + v in
5450         let ?x = 5     in
5451         y
5452 </programlisting>
5453 Since the binding for <literal>y</literal> falls under the Monomorphism
5454 Restriction it is not generalised, so the type of <literal>y</literal> is
5455 simply <literal>Int</literal>, not <literal>(?x::Int) => Int</literal>.
5456 Hence, <literal>(f 9)</literal> returns result <literal>9</literal>.
5457 If you add a type signature for <literal>y</literal>, then <literal>y</literal>
5458 will get type <literal>(?x::Int) => Int</literal>, so the occurrence of
5459 <literal>y</literal> in the body of the <literal>let</literal> will see the
5460 inner binding of <literal>?x</literal>, so <literal>(f 9)</literal> will return
5461 <literal>14</literal>.
5462 </para>
5463 </sect3>
5464 </sect2>
5465
5466     <!--   ======================= COMMENTED OUT ========================
5467
5468     We intend to remove linear implicit parameters, so I'm at least removing
5469     them from the 6.6 user manual
5470
5471 <sect2 id="linear-implicit-parameters">
5472 <title>Linear implicit parameters</title>
5473 <para>
5474 Linear implicit parameters are an idea developed by Koen Claessen,
5475 Mark Shields, and Simon PJ.  They address the long-standing
5476 problem that monads seem over-kill for certain sorts of problem, notably:
5477 </para>
5478 <itemizedlist>
5479 <listitem> <para> distributing a supply of unique names </para> </listitem>
5480 <listitem> <para> distributing a supply of random numbers </para> </listitem>
5481 <listitem> <para> distributing an oracle (as in QuickCheck) </para> </listitem>
5482 </itemizedlist>
5483
5484 <para>
5485 Linear implicit parameters are just like ordinary implicit parameters,
5486 except that they are "linear"; that is, they cannot be copied, and
5487 must be explicitly "split" instead.  Linear implicit parameters are
5488 written '<literal>%x</literal>' instead of '<literal>?x</literal>'.
5489 (The '/' in the '%' suggests the split!)
5490 </para>
5491 <para>
5492 For example:
5493 <programlisting>
5494     import GHC.Exts( Splittable )
5495
5496     data NameSupply = ...
5497
5498     splitNS :: NameSupply -> (NameSupply, NameSupply)
5499     newName :: NameSupply -> Name
5500
5501     instance Splittable NameSupply where
5502         split = splitNS
5503
5504
5505     f :: (%ns :: NameSupply) => Env -> Expr -> Expr
5506     f env (Lam x e) = Lam x' (f env e)
5507                     where
5508                       x'   = newName %ns
5509                       env' = extend env x x'
5510     ...more equations for f...
5511 </programlisting>
5512 Notice that the implicit parameter %ns is consumed
5513 <itemizedlist>
5514 <listitem> <para> once by the call to <literal>newName</literal> </para> </listitem>
5515 <listitem> <para> once by the recursive call to <literal>f</literal> </para></listitem>
5516 </itemizedlist>
5517 </para>
5518 <para>
5519 So the translation done by the type checker makes
5520 the parameter explicit:
5521 <programlisting>
5522     f :: NameSupply -> Env -> Expr -> Expr
5523     f ns env (Lam x e) = Lam x' (f ns1 env e)
5524                        where
5525                          (ns1,ns2) = splitNS ns
5526                          x' = newName ns2
5527                          env = extend env x x'
5528 </programlisting>
5529 Notice the call to 'split' introduced by the type checker.
5530 How did it know to use 'splitNS'?  Because what it really did
5531 was to introduce a call to the overloaded function 'split',
5532 defined by the class <literal>Splittable</literal>:
5533 <programlisting>
5534         class Splittable a where
5535           split :: a -> (a,a)
5536 </programlisting>
5537 The instance for <literal>Splittable NameSupply</literal> tells GHC how to implement
5538 split for name supplies.  But we can simply write
5539 <programlisting>
5540         g x = (x, %ns, %ns)
5541 </programlisting>
5542 and GHC will infer
5543 <programlisting>
5544         g :: (Splittable a, %ns :: a) => b -> (b,a,a)
5545 </programlisting>
5546 The <literal>Splittable</literal> class is built into GHC.  It's exported by module
5547 <literal>GHC.Exts</literal>.
5548 </para>
5549 <para>
5550 Other points:
5551 <itemizedlist>
5552 <listitem> <para> '<literal>?x</literal>' and '<literal>%x</literal>'
5553 are entirely distinct implicit parameters: you
5554   can use them together and they won't interfere with each other. </para>
5555 </listitem>
5556
5557 <listitem> <para> You can bind linear implicit parameters in 'with' clauses. </para> </listitem>
5558
5559 <listitem> <para>You cannot have implicit parameters (whether linear or not)
5560   in the context of a class or instance declaration. </para></listitem>
5561 </itemizedlist>
5562 </para>
5563
5564 <sect3><title>Warnings</title>
5565
5566 <para>
5567 The monomorphism restriction is even more important than usual.
5568 Consider the example above:
5569 <programlisting>
5570     f :: (%ns :: NameSupply) => Env -> Expr -> Expr
5571     f env (Lam x e) = Lam x' (f env e)
5572                     where
5573                       x'   = newName %ns
5574                       env' = extend env x x'
5575 </programlisting>
5576 If we replaced the two occurrences of x' by (newName %ns), which is
5577 usually a harmless thing to do, we get:
5578 <programlisting>
5579     f :: (%ns :: NameSupply) => Env -> Expr -> Expr
5580     f env (Lam x e) = Lam (newName %ns) (f env e)
5581                     where
5582                       env' = extend env x (newName %ns)
5583 </programlisting>
5584 But now the name supply is consumed in <emphasis>three</emphasis> places
5585 (the two calls to newName,and the recursive call to f), so
5586 the result is utterly different.  Urk!  We don't even have
5587 the beta rule.
5588 </para>
5589 <para>
5590 Well, this is an experimental change.  With implicit
5591 parameters we have already lost beta reduction anyway, and
5592 (as John Launchbury puts it) we can't sensibly reason about
5593 Haskell programs without knowing their typing.
5594 </para>
5595
5596 </sect3>
5597
5598 <sect3><title>Recursive functions</title>
5599 <para>Linear implicit parameters can be particularly tricky when you have a recursive function
5600 Consider
5601 <programlisting>
5602         foo :: %x::T => Int -> [Int]
5603         foo 0 = []
5604         foo n = %x : foo (n-1)
5605 </programlisting>
5606 where T is some type in class Splittable.</para>
5607 <para>
5608 Do you get a list of all the same T's or all different T's
5609 (assuming that split gives two distinct T's back)?
5610 </para><para>
5611 If you supply the type signature, taking advantage of polymorphic
5612 recursion, you get what you'd probably expect.  Here's the
5613 translated term, where the implicit param is made explicit:
5614 <programlisting>
5615         foo x 0 = []
5616         foo x n = let (x1,x2) = split x
5617                   in x1 : foo x2 (n-1)
5618 </programlisting>
5619 But if you don't supply a type signature, GHC uses the Hindley
5620 Milner trick of using a single monomorphic instance of the function
5621 for the recursive calls. That is what makes Hindley Milner type inference
5622 work.  So the translation becomes
5623 <programlisting>
5624         foo x = let
5625                   foom 0 = []
5626                   foom n = x : foom (n-1)
5627                 in
5628                 foom
5629 </programlisting>
5630 Result: 'x' is not split, and you get a list of identical T's.  So the
5631 semantics of the program depends on whether or not foo has a type signature.
5632 Yikes!
5633 </para><para>
5634 You may say that this is a good reason to dislike linear implicit parameters
5635 and you'd be right.  That is why they are an experimental feature.
5636 </para>
5637 </sect3>
5638
5639 </sect2>
5640
5641 ================ END OF Linear Implicit Parameters commented out -->
5642
5643 <sect2 id="kinding">
5644 <title>Explicitly-kinded quantification</title>
5645
5646 <para>
5647 Haskell infers the kind of each type variable.  Sometimes it is nice to be able
5648 to give the kind explicitly as (machine-checked) documentation,
5649 just as it is nice to give a type signature for a function.  On some occasions,
5650 it is essential to do so.  For example, in his paper "Restricted Data Types in Haskell" (Haskell Workshop 1999)
5651 John Hughes had to define the data type:
5652 <screen>
5653      data Set cxt a = Set [a]
5654                     | Unused (cxt a -> ())
5655 </screen>
5656 The only use for the <literal>Unused</literal> constructor was to force the correct
5657 kind for the type variable <literal>cxt</literal>.
5658 </para>
5659 <para>
5660 GHC now instead allows you to specify the kind of a type variable directly, wherever
5661 a type variable is explicitly bound, with the flag <option>-XKindSignatures</option>.
5662 </para>
5663 <para>
5664 This flag enables kind signatures in the following places:
5665 <itemizedlist>
5666 <listitem><para><literal>data</literal> declarations:
5667 <screen>
5668   data Set (cxt :: * -> *) a = Set [a]
5669 </screen></para></listitem>
5670 <listitem><para><literal>type</literal> declarations:
5671 <screen>
5672   type T (f :: * -> *) = f Int
5673 </screen></para></listitem>
5674 <listitem><para><literal>class</literal> declarations:
5675 <screen>
5676   class (Eq a) => C (f :: * -> *) a where ...
5677 </screen></para></listitem>
5678 <listitem><para><literal>forall</literal>'s in type signatures:
5679 <screen>
5680   f :: forall (cxt :: * -> *). Set cxt Int
5681 </screen></para></listitem>
5682 </itemizedlist>
5683 </para>
5684
5685 <para>
5686 The parentheses are required.  Some of the spaces are required too, to
5687 separate the lexemes.  If you write <literal>(f::*->*)</literal> you
5688 will get a parse error, because "<literal>::*->*</literal>" is a
5689 single lexeme in Haskell.
5690 </para>
5691
5692 <para>
5693 As part of the same extension, you can put kind annotations in types
5694 as well.  Thus:
5695 <screen>
5696    f :: (Int :: *) -> Int
5697    g :: forall a. a -> (a :: *)
5698 </screen>
5699 The syntax is
5700 <screen>
5701    atype ::= '(' ctype '::' kind ')
5702 </screen>
5703 The parentheses are required.
5704 </para>
5705 </sect2>
5706
5707
5708 <sect2 id="universal-quantification">
5709 <title>Arbitrary-rank polymorphism
5710 </title>
5711
5712 <para>
5713 GHC's type system supports <emphasis>arbitrary-rank</emphasis>
5714 explicit universal quantification in
5715 types.
5716 For example, all the following types are legal:
5717 <programlisting>
5718     f1 :: forall a b. a -> b -> a
5719     g1 :: forall a b. (Ord a, Eq  b) => a -> b -> a
5720
5721     f2 :: (forall a. a->a) -> Int -> Int
5722     g2 :: (forall a. Eq a => [a] -> a -> Bool) -> Int -> Int
5723
5724     f3 :: ((forall a. a->a) -> Int) -> Bool -> Bool
5725
5726     f4 :: Int -> (forall a. a -> a)
5727 </programlisting>
5728 Here, <literal>f1</literal> and <literal>g1</literal> are rank-1 types, and
5729 can be written in standard Haskell (e.g. <literal>f1 :: a->b->a</literal>).
5730 The <literal>forall</literal> makes explicit the universal quantification that
5731 is implicitly added by Haskell.
5732 </para>
5733 <para>
5734 The functions <literal>f2</literal> and <literal>g2</literal> have rank-2 types;
5735 the <literal>forall</literal> is on the left of a function arrow.  As <literal>g2</literal>
5736 shows, the polymorphic type on the left of the function arrow can be overloaded.
5737 </para>
5738 <para>
5739 The function <literal>f3</literal> has a rank-3 type;
5740 it has rank-2 types on the left of a function arrow.
5741 </para>
5742 <para>
5743 GHC has three flags to control higher-rank types:
5744 <itemizedlist>
5745 <listitem><para>
5746  <option>-XPolymorphicComponents</option>: data constructors (only) can have polymorphic argument types.
5747 </para></listitem>
5748 <listitem><para>
5749  <option>-XRank2Types</option>: any function (including data constructors) can have a rank-2 type.
5750 </para></listitem>
5751 <listitem><para>
5752  <option>-XRankNTypes</option>: any function (including data constructors) can have an arbitrary-rank type.
5753 That is,  you can nest <literal>forall</literal>s
5754 arbitrarily deep in function arrows.
5755 In particular, a forall-type (also called a "type scheme"),
5756 including an operational type class context, is legal:
5757 <itemizedlist>
5758 <listitem> <para> On the left or right (see <literal>f4</literal>, for example)
5759 of a function arrow </para> </listitem>
5760 <listitem> <para> As the argument of a constructor, or type of a field, in a data type declaration. For
5761 example, any of the <literal>f1,f2,f3,g1,g2</literal> above would be valid
5762 field type signatures.</para> </listitem>
5763 <listitem> <para> As the type of an implicit parameter </para> </listitem>
5764 <listitem> <para> In a pattern type signature (see <xref linkend="scoped-type-variables"/>) </para> </listitem>
5765 </itemizedlist>
5766 </para></listitem>
5767 </itemizedlist>
5768 </para>
5769
5770
5771 <sect3 id="univ">
5772 <title>Examples
5773 </title>
5774
5775 <para>
5776 In a <literal>data</literal> or <literal>newtype</literal> declaration one can quantify
5777 the types of the constructor arguments.  Here are several examples:
5778 </para>
5779
5780 <para>
5781
5782 <programlisting>
5783 data T a = T1 (forall b. b -> b -> b) a
5784
5785 data MonadT m = MkMonad { return :: forall a. a -> m a,
5786                           bind   :: forall a b. m a -> (a -> m b) -> m b
5787                         }
5788
5789 newtype Swizzle = MkSwizzle (Ord a => [a] -> [a])
5790 </programlisting>
5791
5792 </para>
5793
5794 <para>
5795 The constructors have rank-2 types:
5796 </para>
5797
5798 <para>
5799
5800 <programlisting>
5801 T1 :: forall a. (forall b. b -> b -> b) -> a -> T a
5802 MkMonad :: forall m. (forall a. a -> m a)
5803                   -> (forall a b. m a -> (a -> m b) -> m b)
5804                   -> MonadT m
5805 MkSwizzle :: (Ord a => [a] -> [a]) -> Swizzle
5806 </programlisting>
5807
5808 </para>
5809
5810 <para>
5811 Notice that you don't need to use a <literal>forall</literal> if there's an
5812 explicit context.  For example in the first argument of the
5813 constructor <function>MkSwizzle</function>, an implicit "<literal>forall a.</literal>" is
5814 prefixed to the argument type.  The implicit <literal>forall</literal>
5815 quantifies all type variables that are not already in scope, and are
5816 mentioned in the type quantified over.
5817 </para>
5818
5819 <para>
5820 As for type signatures, implicit quantification happens for non-overloaded
5821 types too.  So if you write this:
5822
5823 <programlisting>
5824   data T a = MkT (Either a b) (b -> b)
5825 </programlisting>
5826
5827 it's just as if you had written this:
5828
5829 <programlisting>
5830   data T a = MkT (forall b. Either a b) (forall b. b -> b)
5831 </programlisting>
5832
5833 That is, since the type variable <literal>b</literal> isn't in scope, it's
5834 implicitly universally quantified.  (Arguably, it would be better
5835 to <emphasis>require</emphasis> explicit quantification on constructor arguments
5836 where that is what is wanted.  Feedback welcomed.)
5837 </para>
5838
5839 <para>
5840 You construct values of types <literal>T1, MonadT, Swizzle</literal> by applying
5841 the constructor to suitable values, just as usual.  For example,
5842 </para>
5843
5844 <para>
5845
5846 <programlisting>
5847     a1 :: T Int
5848     a1 = T1 (\xy->x) 3
5849
5850     a2, a3 :: Swizzle
5851     a2 = MkSwizzle sort
5852     a3 = MkSwizzle reverse
5853
5854     a4 :: MonadT Maybe
5855     a4 = let r x = Just x
5856              b m k = case m of
5857                        Just y -> k y
5858                        Nothing -> Nothing
5859          in
5860          MkMonad r b
5861
5862     mkTs :: (forall b. b -> b -> b) -> a -> [T a]
5863     mkTs f x y = [T1 f x, T1 f y]
5864 </programlisting>
5865
5866 </para>
5867
5868 <para>
5869 The type of the argument can, as usual, be more general than the type
5870 required, as <literal>(MkSwizzle reverse)</literal> shows.  (<function>reverse</function>
5871 does not need the <literal>Ord</literal> constraint.)
5872 </para>
5873
5874 <para>
5875 When you use pattern matching, the bound variables may now have
5876 polymorphic types.  For example:
5877 </para>
5878
5879 <para>
5880
5881 <programlisting>
5882     f :: T a -> a -> (a, Char)
5883     f (T1 w k) x = (w k x, w 'c' 'd')
5884
5885     g :: (Ord a, Ord b) => Swizzle -> [a] -> (a -> b) -> [b]
5886     g (MkSwizzle s) xs f = s (map f (s xs))
5887
5888     h :: MonadT m -> [m a] -> m [a]
5889     h m [] = return m []
5890     h m (x:xs) = bind m x          $ \y ->
5891                  bind m (h m xs)   $ \ys ->
5892                  return m (y:ys)
5893 </programlisting>
5894
5895 </para>
5896
5897 <para>
5898 In the function <function>h</function> we use the record selectors <literal>return</literal>
5899 and <literal>bind</literal> to extract the polymorphic bind and return functions
5900 from the <literal>MonadT</literal> data structure, rather than using pattern
5901 matching.
5902 </para>
5903 </sect3>
5904
5905 <sect3>
5906 <title>Type inference</title>
5907
5908 <para>
5909 In general, type inference for arbitrary-rank types is undecidable.
5910 GHC uses an algorithm proposed by Odersky and Laufer ("Putting type annotations to work", POPL'96)
5911 to get a decidable algorithm by requiring some help from the programmer.
5912 We do not yet have a formal specification of "some help" but the rule is this:
5913 </para>
5914 <para>
5915 <emphasis>For a lambda-bound or case-bound variable, x, either the programmer
5916 provides an explicit polymorphic type for x, or GHC's type inference will assume
5917 that x's type has no foralls in it</emphasis>.
5918 </para>
5919 <para>
5920 What does it mean to "provide" an explicit type for x?  You can do that by
5921 giving a type signature for x directly, using a pattern type signature
5922 (<xref linkend="scoped-type-variables"/>), thus:
5923 <programlisting>
5924      \ f :: (forall a. a->a) -> (f True, f 'c')
5925 </programlisting>
5926 Alternatively, you can give a type signature to the enclosing
5927 context, which GHC can "push down" to find the type for the variable:
5928 <programlisting>
5929      (\ f -> (f True, f 'c')) :: (forall a. a->a) -> (Bool,Char)
5930 </programlisting>
5931 Here the type signature on the expression can be pushed inwards
5932 to give a type signature for f.  Similarly, and more commonly,
5933 one can give a type signature for the function itself:
5934 <programlisting>
5935      h :: (forall a. a->a) -> (Bool,Char)
5936      h f = (f True, f 'c')
5937 </programlisting>
5938 You don't need to give a type signature if the lambda bound variable
5939 is a constructor argument.  Here is an example we saw earlier:
5940 <programlisting>
5941     f :: T a -> a -> (a, Char)
5942     f (T1 w k) x = (w k x, w 'c' 'd')
5943 </programlisting>
5944 Here we do not need to give a type signature to <literal>w</literal>, because
5945 it is an argument of constructor <literal>T1</literal> and that tells GHC all
5946 it needs to know.
5947 </para>
5948
5949 </sect3>
5950
5951
5952 <sect3 id="implicit-quant">
5953 <title>Implicit quantification</title>
5954
5955 <para>
5956 GHC performs implicit quantification as follows.  <emphasis>At the top level (only) of
5957 user-written types, if and only if there is no explicit <literal>forall</literal>,
5958 GHC finds all the type variables mentioned in the type that are not already
5959 in scope, and universally quantifies them.</emphasis>  For example, the following pairs are
5960 equivalent:
5961 <programlisting>
5962   f :: a -> a
5963   f :: forall a. a -> a
5964
5965   g (x::a) = let
5966                 h :: a -> b -> b
5967                 h x y = y
5968              in ...
5969   g (x::a) = let
5970                 h :: forall b. a -> b -> b
5971                 h x y = y
5972              in ...
5973 </programlisting>
5974 </para>
5975 <para>
5976 Notice that GHC does <emphasis>not</emphasis> find the innermost possible quantification
5977 point.  For example:
5978 <programlisting>
5979   f :: (a -> a) -> Int
5980            -- MEANS
5981   f :: forall a. (a -> a) -> Int
5982            -- NOT
5983   f :: (forall a. a -> a) -> Int
5984
5985
5986   g :: (Ord a => a -> a) -> Int
5987            -- MEANS the illegal type
5988   g :: forall a. (Ord a => a -> a) -> Int
5989            -- NOT
5990   g :: (forall a. Ord a => a -> a) -> Int
5991 </programlisting>
5992 The latter produces an illegal type, which you might think is silly,
5993 but at least the rule is simple.  If you want the latter type, you
5994 can write your for-alls explicitly.  Indeed, doing so is strongly advised
5995 for rank-2 types.
5996 </para>
5997 </sect3>
5998 </sect2>
5999
6000
6001 <sect2 id="impredicative-polymorphism">
6002 <title>Impredicative polymorphism
6003 </title>
6004 <para>GHC supports <emphasis>impredicative polymorphism</emphasis>,
6005 enabled with <option>-XImpredicativeTypes</option>.
6006 This means
6007 that you can call a polymorphic function at a polymorphic type, and
6008 parameterise data structures over polymorphic types.  For example:
6009 <programlisting>
6010   f :: Maybe (forall a. [a] -> [a]) -> Maybe ([Int], [Char])
6011   f (Just g) = Just (g [3], g "hello")
6012   f Nothing  = Nothing
6013 </programlisting>
6014 Notice here that the <literal>Maybe</literal> type is parameterised by the
6015 <emphasis>polymorphic</emphasis> type <literal>(forall a. [a] ->
6016 [a])</literal>.
6017 </para>
6018 <para>The technical details of this extension are described in the paper
6019 <ulink url="http://research.microsoft.com/%7Esimonpj/papers/boxy/">Boxy types:
6020 type inference for higher-rank types and impredicativity</ulink>,
6021 which appeared at ICFP 2006.
6022 </para>
6023 </sect2>
6024
6025 <sect2 id="scoped-type-variables">
6026 <title>Lexically scoped type variables
6027 </title>
6028
6029 <para>
6030 GHC supports <emphasis>lexically scoped type variables</emphasis>, without
6031 which some type signatures are simply impossible to write. For example:
6032 <programlisting>
6033 f :: forall a. [a] -> [a]
6034 f xs = ys ++ ys
6035      where
6036        ys :: [a]
6037        ys = reverse xs
6038 </programlisting>
6039 The type signature for <literal>f</literal> brings the type variable <literal>a</literal> into scope,
6040 because of the explicit <literal>forall</literal> (<xref linkend="decl-type-sigs"/>).
6041 The type variables bound by a <literal>forall</literal> scope over
6042 the entire definition of the accompanying value declaration.
6043 In this example, the type variable <literal>a</literal> scopes over the whole
6044 definition of <literal>f</literal>, including over
6045 the type signature for <varname>ys</varname>.
6046 In Haskell 98 it is not possible to declare
6047 a type for <varname>ys</varname>; a major benefit of scoped type variables is that
6048 it becomes possible to do so.
6049 </para>
6050 <para>Lexically-scoped type variables are enabled by
6051 <option>-XScopedTypeVariables</option>.  This flag implies <option>-XRelaxedPolyRec</option>.
6052 </para>
6053 <para>Note: GHC 6.6 contains substantial changes to the way that scoped type
6054 variables work, compared to earlier releases.  Read this section
6055 carefully!</para>
6056
6057 <sect3>
6058 <title>Overview</title>
6059
6060 <para>The design follows the following principles
6061 <itemizedlist>
6062 <listitem><para>A scoped type variable stands for a type <emphasis>variable</emphasis>, and not for
6063 a <emphasis>type</emphasis>. (This is a change from GHC's earlier
6064 design.)</para></listitem>
6065 <listitem><para>Furthermore, distinct lexical type variables stand for distinct
6066 type variables.  This means that every programmer-written type signature
6067 (including one that contains free scoped type variables) denotes a
6068 <emphasis>rigid</emphasis> type; that is, the type is fully known to the type
6069 checker, and no inference is involved.</para></listitem>
6070 <listitem><para>Lexical type variables may be alpha-renamed freely, without
6071 changing the program.</para></listitem>
6072 </itemizedlist>
6073 </para>
6074 <para>
6075 A <emphasis>lexically scoped type variable</emphasis> can be bound by:
6076 <itemizedlist>
6077 <listitem><para>A declaration type signature (<xref linkend="decl-type-sigs"/>)</para></listitem>
6078 <listitem><para>An expression type signature (<xref linkend="exp-type-sigs"/>)</para></listitem>
6079 <listitem><para>A pattern type signature (<xref linkend="pattern-type-sigs"/>)</para></listitem>
6080 <listitem><para>Class and instance declarations (<xref linkend="cls-inst-scoped-tyvars"/>)</para></listitem>
6081 </itemizedlist>
6082 </para>
6083 <para>
6084 In Haskell, a programmer-written type signature is implicitly quantified over
6085 its free type variables (<ulink
6086 url="http://www.haskell.org/onlinereport/decls.html#sect4.1.2">Section
6087 4.1.2</ulink>
6088 of the Haskell Report).
6089 Lexically scoped type variables affect this implicit quantification rules
6090 as follows: any type variable that is in scope is <emphasis>not</emphasis> universally
6091 quantified. For example, if type variable <literal>a</literal> is in scope,
6092 then
6093 <programlisting>
6094   (e :: a -> a)     means     (e :: a -> a)
6095   (e :: b -> b)     means     (e :: forall b. b->b)
6096   (e :: a -> b)     means     (e :: forall b. a->b)
6097 </programlisting>
6098 </para>
6099
6100
6101 </sect3>
6102
6103
6104 <sect3 id="decl-type-sigs">
6105 <title>Declaration type signatures</title>
6106 <para>A declaration type signature that has <emphasis>explicit</emphasis>
6107 quantification (using <literal>forall</literal>) brings into scope the
6108 explicitly-quantified
6109 type variables, in the definition of the named function.  For example:
6110 <programlisting>
6111   f :: forall a. [a] -> [a]
6112   f (x:xs) = xs ++ [ x :: a ]
6113 </programlisting>
6114 The "<literal>forall a</literal>" brings "<literal>a</literal>" into scope in
6115 the definition of "<literal>f</literal>".
6116 </para>
6117 <para>This only happens if:
6118 <itemizedlist>
6119 <listitem><para> The quantification in <literal>f</literal>'s type
6120 signature is explicit.  For example:
6121 <programlisting>
6122   g :: [a] -> [a]
6123   g (x:xs) = xs ++ [ x :: a ]
6124 </programlisting>
6125 This program will be rejected, because "<literal>a</literal>" does not scope
6126 over the definition of "<literal>g</literal>", so "<literal>x::a</literal>"
6127 means "<literal>x::forall a. a</literal>" by Haskell's usual implicit
6128 quantification rules.
6129 </para></listitem>
6130 <listitem><para> The signature gives a type for a function binding or a bare variable binding,
6131 not a pattern binding.
6132 For example:
6133 <programlisting>
6134   f1 :: forall a. [a] -> [a]
6135   f1 (x:xs) = xs ++ [ x :: a ]   -- OK
6136
6137   f2 :: forall a. [a] -> [a]
6138   f2 = \(x:xs) -> xs ++ [ x :: a ]   -- OK
6139
6140   f3 :: forall a. [a] -> [a]
6141   Just f3 = Just (\(x:xs) -> xs ++ [ x :: a ])   -- Not OK!
6142 </programlisting>
6143 The binding for <literal>f3</literal> is a pattern binding, and so its type signature
6144 does not bring <literal>a</literal> into scope.   However <literal>f1</literal> is a
6145 function binding, and <literal>f2</literal> binds a bare variable; in both cases
6146 the type signature brings <literal>a</literal> into scope.
6147 </para></listitem>
6148 </itemizedlist>
6149 </para>
6150 </sect3>
6151
6152 <sect3 id="exp-type-sigs">
6153 <title>Expression type signatures</title>
6154
6155 <para>An expression type signature that has <emphasis>explicit</emphasis>
6156 quantification (using <literal>forall</literal>) brings into scope the
6157 explicitly-quantified
6158 type variables, in the annotated expression.  For example:
6159 <programlisting>
6160   f = runST ( (op >>= \(x :: STRef s Int) -> g x) :: forall s. ST s Bool )
6161 </programlisting>
6162 Here, the type signature <literal>forall s. ST s Bool</literal> brings the
6163 type variable <literal>s</literal> into scope, in the annotated expression
6164 <literal>(op >>= \(x :: STRef s Int) -> g x)</literal>.
6165 </para>
6166
6167 </sect3>
6168
6169 <sect3 id="pattern-type-sigs">
6170 <title>Pattern type signatures</title>
6171 <para>
6172 A type signature may occur in any pattern; this is a <emphasis>pattern type
6173 signature</emphasis>.
6174 For example:
6175 <programlisting>
6176   -- f and g assume that 'a' is already in scope
6177   f = \(x::Int, y::a) -> x
6178   g (x::a) = x
6179   h ((x,y) :: (Int,Bool)) = (y,x)
6180 </programlisting>
6181 In the case where all the type variables in the pattern type signature are
6182 already in scope (i.e. bound by the enclosing context), matters are simple: the
6183 signature simply constrains the type of the pattern in the obvious way.
6184 </para>
6185 <para>
6186 Unlike expression and declaration type signatures, pattern type signatures are not implicitly generalised.
6187 The pattern in a <emphasis>pattern binding</emphasis> may only mention type variables
6188 that are already in scope.  For example:
6189 <programlisting>
6190   f :: forall a. [a] -> (Int, [a])
6191   f xs = (n, zs)
6192     where
6193       (ys::[a], n) = (reverse xs, length xs) -- OK
6194       zs::[a] = xs ++ ys                     -- OK
6195
6196       Just (v::b) = ...  -- Not OK; b is not in scope
6197 </programlisting>
6198 Here, the pattern signatures for <literal>ys</literal> and <literal>zs</literal>
6199 are fine, but the one for <literal>v</literal> is not because <literal>b</literal> is
6200 not in scope.
6201 </para>
6202 <para>
6203 However, in all patterns <emphasis>other</emphasis> than pattern bindings, a pattern
6204 type signature may mention a type variable that is not in scope; in this case,
6205 <emphasis>the signature brings that type variable into scope</emphasis>.
6206 This is particularly important for existential data constructors.  For example:
6207 <programlisting>
6208   data T = forall a. MkT [a]
6209
6210   k :: T -> T
6211   k (MkT [t::a]) = MkT t3
6212                  where
6213                    t3::[a] = [t,t,t]
6214 </programlisting>
6215 Here, the pattern type signature <literal>(t::a)</literal> mentions a lexical type
6216 variable that is not already in scope.  Indeed, it <emphasis>cannot</emphasis> already be in scope,
6217 because it is bound by the pattern match.  GHC's rule is that in this situation
6218 (and only then), a pattern type signature can mention a type variable that is
6219 not already in scope; the effect is to bring it into scope, standing for the
6220 existentially-bound type variable.
6221 </para>
6222 <para>
6223 When a pattern type signature binds a type variable in this way, GHC insists that the
6224 type variable is bound to a <emphasis>rigid</emphasis>, or fully-known, type variable.
6225 This means that any user-written type signature always stands for a completely known type.
6226 </para>
6227 <para>
6228 If all this seems a little odd, we think so too.  But we must have
6229 <emphasis>some</emphasis> way to bring such type variables into scope, else we
6230 could not name existentially-bound type variables in subsequent type signatures.
6231 </para>
6232 <para>
6233 This is (now) the <emphasis>only</emphasis> situation in which a pattern type
6234 signature is allowed to mention a lexical variable that is not already in
6235 scope.
6236 For example, both <literal>f</literal> and <literal>g</literal> would be
6237 illegal if <literal>a</literal> was not already in scope.
6238 </para>
6239
6240
6241 </sect3>
6242
6243 <!-- ==================== Commented out part about result type signatures
6244
6245 <sect3 id="result-type-sigs">
6246 <title>Result type signatures</title>
6247
6248 <para>
6249 The result type of a function, lambda, or case expression alternative can be given a signature, thus:
6250
6251 <programlisting>
6252   {- f assumes that 'a' is already in scope -}
6253   f x y :: [a] = [x,y,x]
6254
6255   g = \ x :: [Int] -> [3,4]
6256
6257   h :: forall a. [a] -> a
6258   h xs = case xs of
6259             (y:ys) :: a -> y
6260 </programlisting>
6261 The final <literal>:: [a]</literal> after the patterns of <literal>f</literal> gives the type of
6262 the result of the function.  Similarly, the body of the lambda in the RHS of
6263 <literal>g</literal> is <literal>[Int]</literal>, and the RHS of the case
6264 alternative in <literal>h</literal> is <literal>a</literal>.
6265 </para>
6266 <para> A result type signature never brings new type variables into scope.</para>
6267 <para>
6268 There are a couple of syntactic wrinkles.  First, notice that all three
6269 examples would parse quite differently with parentheses:
6270 <programlisting>
6271   {- f assumes that 'a' is already in scope -}
6272   f x (y :: [a]) = [x,y,x]
6273
6274   g = \ (x :: [Int]) -> [3,4]
6275
6276   h :: forall a. [a] -> a
6277   h xs = case xs of
6278             ((y:ys) :: a) -> y
6279 </programlisting>
6280 Now the signature is on the <emphasis>pattern</emphasis>; and
6281 <literal>h</literal> would certainly be ill-typed (since the pattern
6282 <literal>(y:ys)</literal> cannot have the type <literal>a</literal>.
6283
6284 Second, to avoid ambiguity, the type after the &ldquo;<literal>::</literal>&rdquo; in a result
6285 pattern signature on a lambda or <literal>case</literal> must be atomic (i.e. a single
6286 token or a parenthesised type of some sort).  To see why,
6287 consider how one would parse this:
6288 <programlisting>
6289   \ x :: a -> b -> x
6290 </programlisting>
6291 </para>
6292 </sect3>
6293
6294  -->
6295
6296 <sect3 id="cls-inst-scoped-tyvars">
6297 <title>Class and instance declarations</title>
6298 <para>
6299
6300 The type variables in the head of a <literal>class</literal> or <literal>instance</literal> declaration
6301 scope over the methods defined in the <literal>where</literal> part.  For example:
6302
6303
6304 <programlisting>
6305   class C a where
6306     op :: [a] -> a
6307
6308     op xs = let ys::[a]
6309                 ys = reverse xs
6310             in
6311             head ys
6312 </programlisting>
6313 </para>
6314 </sect3>
6315
6316 </sect2>
6317
6318
6319 <sect2 id="typing-binds">
6320 <title>Generalised typing of mutually recursive bindings</title>
6321
6322 <para>
6323 The Haskell Report specifies that a group of bindings (at top level, or in a
6324 <literal>let</literal> or <literal>where</literal>) should be sorted into
6325 strongly-connected components, and then type-checked in dependency order
6326 (<ulink url="http://www.haskell.org/onlinereport/decls.html#sect4.5.1">Haskell
6327 Report, Section 4.5.1</ulink>).
6328 As each group is type-checked, any binders of the group that
6329 have
6330 an explicit type signature are put in the type environment with the specified
6331 polymorphic type,
6332 and all others are monomorphic until the group is generalised
6333 (<ulink url="http://www.haskell.org/onlinereport/decls.html#sect4.5.2">Haskell Report, Section 4.5.2</ulink>).
6334 </para>
6335
6336 <para>Following a suggestion of Mark Jones, in his paper
6337 <ulink url="http://citeseer.ist.psu.edu/424440.html">Typing Haskell in
6338 Haskell</ulink>,
6339 GHC implements a more general scheme.  If <option>-XRelaxedPolyRec</option> is
6340 specified:
6341 <emphasis>the dependency analysis ignores references to variables that have an explicit
6342 type signature</emphasis>.
6343 As a result of this refined dependency analysis, the dependency groups are smaller, and more bindings will
6344 typecheck.  For example, consider:
6345 <programlisting>
6346   f :: Eq a =&gt; a -> Bool
6347   f x = (x == x) || g True || g "Yes"
6348
6349   g y = (y &lt;= y) || f True
6350 </programlisting>
6351 This is rejected by Haskell 98, but under Jones's scheme the definition for
6352 <literal>g</literal> is typechecked first, separately from that for
6353 <literal>f</literal>,
6354 because the reference to <literal>f</literal> in <literal>g</literal>'s right
6355 hand side is ignored by the dependency analysis.  Then <literal>g</literal>'s
6356 type is generalised, to get
6357 <programlisting>
6358   g :: Ord a =&gt; a -> Bool
6359 </programlisting>
6360 Now, the definition for <literal>f</literal> is typechecked, with this type for
6361 <literal>g</literal> in the type environment.
6362 </para>
6363
6364 <para>
6365 The same refined dependency analysis also allows the type signatures of
6366 mutually-recursive functions to have different contexts, something that is illegal in
6367 Haskell 98 (Section 4.5.2, last sentence).  With
6368 <option>-XRelaxedPolyRec</option>
6369 GHC only insists that the type signatures of a <emphasis>refined</emphasis> group have identical
6370 type signatures; in practice this means that only variables bound by the same
6371 pattern binding must have the same context.  For example, this is fine:
6372 <programlisting>
6373   f :: Eq a =&gt; a -> Bool
6374   f x = (x == x) || g True
6375
6376   g :: Ord a =&gt; a -> Bool
6377   g y = (y &lt;= y) || f True
6378 </programlisting>
6379 </para>
6380 </sect2>
6381
6382 <sect2 id="mono-local-binds">
6383 <title>Monomorphic local bindings</title>
6384 <para>
6385 We are actively thinking of simplifying GHC's type system, by <emphasis>not generalising local bindings</emphasis>.
6386 The rationale is described in the paper
6387 <ulink url="http://research.microsoft.com/~simonpj/papers/constraints/index.htm">Let should not be generalised</ulink>.
6388 </para>
6389 <para>
6390 The experimental new behaviour is enabled by the flag <option>-XMonoLocalBinds</option>.  The effect is
6391 that local (that is, non-top-level) bindings without a type signature are not generalised at all.  You can
6392 think of it as an extreme (but much more predictable) version of the Monomorphism Restriction.
6393 If you supply a type signature, then the flag has no effect.
6394 </para>
6395 </sect2>
6396
6397 </sect1>
6398 <!-- ==================== End of type system extensions =================  -->
6399
6400 <!-- ====================== TEMPLATE HASKELL =======================  -->
6401
6402 <sect1 id="template-haskell">
6403 <title>Template Haskell</title>
6404
6405 <para>Template Haskell allows you to do compile-time meta-programming in
6406 Haskell.
6407 The background to
6408 the main technical innovations is discussed in "<ulink
6409 url="http://research.microsoft.com/~simonpj/papers/meta-haskell/">
6410 Template Meta-programming for Haskell</ulink>" (Proc Haskell Workshop 2002).
6411 </para>
6412 <para>
6413 There is a Wiki page about
6414 Template Haskell at <ulink url="http://www.haskell.org/haskellwiki/Template_Haskell">
6415 http://www.haskell.org/haskellwiki/Template_Haskell</ulink>, and that is the best place to look for
6416 further details.
6417 You may also
6418 consult the <ulink
6419 url="http://www.haskell.org/ghc/docs/latest/html/libraries/index.html">online
6420 Haskell library reference material</ulink>
6421 (look for module <literal>Language.Haskell.TH</literal>).
6422 Many changes to the original design are described in
6423       <ulink url="http://research.microsoft.com/~simonpj/papers/meta-haskell/notes2.ps">
6424 Notes on Template Haskell version 2</ulink>.
6425 Not all of these changes are in GHC, however.
6426 </para>
6427
6428 <para> The first example from that paper is set out below (<xref linkend="th-example"/>)
6429 as a worked example to help get you started.
6430 </para>
6431
6432 <para>
6433 The documentation here describes the realisation of Template Haskell in GHC.  It is not detailed enough to
6434 understand Template Haskell; see the <ulink url="http://haskell.org/haskellwiki/Template_Haskell">
6435 Wiki page</ulink>.
6436 </para>
6437
6438     <sect2>
6439       <title>Syntax</title>
6440
6441       <para> Template Haskell has the following new syntactic
6442       constructions.  You need to use the flag
6443       <option>-XTemplateHaskell</option>
6444         <indexterm><primary><option>-XTemplateHaskell</option></primary>
6445       </indexterm>to switch these syntactic extensions on
6446       (<option>-XTemplateHaskell</option> is no longer implied by
6447       <option>-fglasgow-exts</option>).</para>
6448
6449         <itemizedlist>
6450               <listitem><para>
6451                   A splice is written <literal>$x</literal>, where <literal>x</literal> is an
6452                   identifier, or <literal>$(...)</literal>, where the "..." is an arbitrary expression.
6453                   There must be no space between the "$" and the identifier or parenthesis.  This use
6454                   of "$" overrides its meaning as an infix operator, just as "M.x" overrides the meaning
6455                   of "." as an infix operator.  If you want the infix operator, put spaces around it.
6456                   </para>
6457               <para> A splice can occur in place of
6458                   <itemizedlist>
6459                     <listitem><para> an expression; the spliced expression must
6460                     have type <literal>Q Exp</literal></para></listitem>
6461                     <listitem><para> an type; the spliced expression must
6462                     have type <literal>Q Typ</literal></para></listitem>
6463                     <listitem><para> a list of top-level declarations; the spliced expression
6464                     must have type <literal>Q [Dec]</literal></para></listitem>
6465                     </itemizedlist>
6466             Note that pattern splices are not supported.
6467             Inside a splice you can only call functions defined in imported modules,
6468             not functions defined elsewhere in the same module.</para></listitem>
6469
6470               <listitem><para>
6471                   A expression quotation is written in Oxford brackets, thus:
6472                   <itemizedlist>
6473                     <listitem><para> <literal>[| ... |]</literal>, or <literal>[e| ... |]</literal>,
6474                              where the "..." is an expression;
6475                              the quotation has type <literal>Q Exp</literal>.</para></listitem>
6476                     <listitem><para> <literal>[d| ... |]</literal>, where the "..." is a list of top-level declarations;
6477                              the quotation has type <literal>Q [Dec]</literal>.</para></listitem>
6478                     <listitem><para> <literal>[t| ... |]</literal>, where the "..." is a type;
6479                              the quotation has type <literal>Q Type</literal>.</para></listitem>
6480                     <listitem><para> <literal>[p| ... |]</literal>, where the "..." is a pattern;
6481                              the quotation has type <literal>Q Pat</literal>.</para></listitem>
6482                   </itemizedlist></para></listitem>
6483
6484               <listitem><para>
6485                   A quasi-quotation can appear in either a pattern context or an
6486                   expression context and is also written in Oxford brackets:
6487                   <itemizedlist>
6488                     <listitem><para> <literal>[<replaceable>varid</replaceable>| ... |]</literal>,
6489                         where the "..." is an arbitrary string; a full description of the
6490                         quasi-quotation facility is given in <xref linkend="th-quasiquotation"/>.</para></listitem>
6491                   </itemizedlist></para></listitem>
6492
6493               <listitem><para>
6494                   A name can be quoted with either one or two prefix single quotes:
6495                   <itemizedlist>
6496                     <listitem><para> <literal>'f</literal> has type <literal>Name</literal>, and names the function <literal>f</literal>.
6497                   Similarly <literal>'C</literal> has type <literal>Name</literal> and names the data constructor <literal>C</literal>.
6498                   In general <literal>'</literal><replaceable>thing</replaceable> interprets <replaceable>thing</replaceable> in an expression context.
6499                      </para></listitem>
6500                     <listitem><para> <literal>''T</literal> has type <literal>Name</literal>, and names the type constructor  <literal>T</literal>.
6501                   That is, <literal>''</literal><replaceable>thing</replaceable> interprets <replaceable>thing</replaceable> in a type context.
6502                      </para></listitem>
6503                   </itemizedlist>
6504                   These <literal>Names</literal> can be used to construct Template Haskell expressions, patterns, declarations etc.  They
6505                   may also be given as an argument to the <literal>reify</literal> function.
6506                  </para>
6507                 </listitem>
6508
6509               <listitem><para> You may omit the <literal>$(...)</literal> in a top-level declaration splice.
6510               Simply writing an expression (rather than a declaration) implies a splice.  For example, you can write
6511 <programlisting>
6512 module Foo where
6513 import Bar
6514
6515 f x = x
6516
6517 $(deriveStuff 'f)   -- Uses the $(...) notation
6518
6519 g y = y+1
6520
6521 deriveStuff 'g      -- Omits the $(...)
6522
6523 h z = z-1
6524 </programlisting>
6525             This abbreviation makes top-level declaration slices quieter and less intimidating.
6526             </para></listitem>
6527
6528
6529         </itemizedlist>
6530 (Compared to the original paper, there are many differences of detail.
6531 The syntax for a declaration splice uses "<literal>$</literal>" not "<literal>splice</literal>".
6532 The type of the enclosed expression must be  <literal>Q [Dec]</literal>, not  <literal>[Q Dec]</literal>.
6533 Pattern splices and quotations are not implemented.)
6534
6535 </sect2>
6536
6537 <sect2>  <title> Using Template Haskell </title>
6538 <para>
6539 <itemizedlist>
6540     <listitem><para>
6541     The data types and monadic constructor functions for Template Haskell are in the library
6542     <literal>Language.Haskell.THSyntax</literal>.
6543     </para></listitem>
6544
6545     <listitem><para>
6546     You can only run a function at compile time if it is imported from another module.  That is,
6547             you can't define a function in a module, and call it from within a splice in the same module.
6548             (It would make sense to do so, but it's hard to implement.)
6549    </para></listitem>
6550
6551    <listitem><para>
6552    You can only run a function at compile time if it is imported
6553    from another module <emphasis>that is not part of a mutually-recursive group of modules
6554    that includes the module currently being compiled</emphasis>.  Furthermore, all of the modules of
6555    the mutually-recursive group must be reachable by non-SOURCE imports from the module where the
6556    splice is to be run.</para>
6557    <para>
6558    For example, when compiling module A,
6559    you can only run Template Haskell functions imported from B if B does not import A (directly or indirectly).
6560    The reason should be clear: to run B we must compile and run A, but we are currently type-checking A.
6561    </para></listitem>
6562
6563     <listitem><para>
6564             The flag <literal>-ddump-splices</literal> shows the expansion of all top-level splices as they happen.
6565    </para></listitem>
6566     <listitem><para>
6567             If you are building GHC from source, you need at least a stage-2 bootstrap compiler to
6568               run Template Haskell.  A stage-1 compiler will reject the TH constructs.  Reason: TH
6569               compiles and runs a program, and then looks at the result.  So it's important that
6570               the program it compiles produces results whose representations are identical to
6571               those of the compiler itself.
6572    </para></listitem>
6573 </itemizedlist>
6574 </para>
6575 <para> Template Haskell works in any mode (<literal>--make</literal>, <literal>--interactive</literal>,
6576         or file-at-a-time).  There used to be a restriction to the former two, but that restriction
6577         has been lifted.
6578 </para>
6579 </sect2>
6580
6581 <sect2 id="th-example">  <title> A Template Haskell Worked Example </title>
6582 <para>To help you get over the confidence barrier, try out this skeletal worked example.
6583   First cut and paste the two modules below into "Main.hs" and "Printf.hs":</para>
6584
6585 <programlisting>
6586
6587 {- Main.hs -}
6588 module Main where
6589
6590 -- Import our template "pr"
6591 import Printf ( pr )
6592
6593 -- The splice operator $ takes the Haskell source code
6594 -- generated at compile time by "pr" and splices it into
6595 -- the argument of "putStrLn".
6596 main = putStrLn ( $(pr "Hello") )
6597
6598
6599 {- Printf.hs -}
6600 module Printf where
6601
6602 -- Skeletal printf from the paper.
6603 -- It needs to be in a separate module to the one where
6604 -- you intend to use it.
6605
6606 -- Import some Template Haskell syntax
6607 import Language.Haskell.TH
6608
6609 -- Describe a format string
6610 data Format = D | S | L String
6611
6612 -- Parse a format string.  This is left largely to you
6613 -- as we are here interested in building our first ever
6614 -- Template Haskell program and not in building printf.
6615 parse :: String -> [Format]
6616 parse s   = [ L s ]
6617
6618 -- Generate Haskell source code from a parsed representation
6619 -- of the format string.  This code will be spliced into
6620 -- the module which calls "pr", at compile time.
6621 gen :: [Format] -> Q Exp
6622 gen [D]   = [| \n -> show n |]
6623 gen [S]   = [| \s -> s |]
6624 gen [L s] = stringE s
6625
6626 -- Here we generate the Haskell code for the splice
6627 -- from an input format string.
6628 pr :: String -> Q Exp
6629 pr s = gen (parse s)
6630 </programlisting>
6631
6632 <para>Now run the compiler (here we are a Cygwin prompt on Windows):
6633 </para>
6634 <programlisting>
6635 $ ghc --make -XTemplateHaskell main.hs -o main.exe
6636 </programlisting>
6637
6638 <para>Run "main.exe" and here is your output:</para>
6639
6640 <programlisting>
6641 $ ./main
6642 Hello
6643 </programlisting>
6644
6645 </sect2>
6646
6647 <sect2>
6648 <title>Using Template Haskell with Profiling</title>
6649 <indexterm><primary>profiling</primary><secondary>with Template Haskell</secondary></indexterm>
6650
6651 <para>Template Haskell relies on GHC's built-in bytecode compiler and
6652 interpreter to run the splice expressions.  The bytecode interpreter
6653 runs the compiled expression on top of the same runtime on which GHC
6654 itself is running; this means that the compiled code referred to by
6655 the interpreted expression must be compatible with this runtime, and
6656 in particular this means that object code that is compiled for
6657 profiling <emphasis>cannot</emphasis> be loaded and used by a splice
6658 expression, because profiled object code is only compatible with the
6659 profiling version of the runtime.</para>
6660
6661 <para>This causes difficulties if you have a multi-module program
6662 containing Template Haskell code and you need to compile it for
6663 profiling, because GHC cannot load the profiled object code and use it
6664 when executing the splices.  Fortunately GHC provides a workaround.
6665 The basic idea is to compile the program twice:</para>
6666
6667 <orderedlist>
6668 <listitem>
6669   <para>Compile the program or library first the normal way, without
6670   <option>-prof</option><indexterm><primary><option>-prof</option></primary></indexterm>.</para>
6671 </listitem>
6672 <listitem>
6673   <para>Then compile it again with <option>-prof</option>, and
6674   additionally use <option>-osuf
6675   p_o</option><indexterm><primary><option>-osuf</option></primary></indexterm>
6676   to name the object files differently (you can choose any suffix
6677   that isn't the normal object suffix here).  GHC will automatically
6678   load the object files built in the first step when executing splice
6679   expressions.  If you omit the <option>-osuf</option> flag when
6680   building with <option>-prof</option> and Template Haskell is used,
6681   GHC will emit an error message. </para>
6682 </listitem>
6683 </orderedlist>
6684 </sect2>
6685
6686 <sect2 id="th-quasiquotation">  <title> Template Haskell Quasi-quotation </title>
6687 <para>Quasi-quotation allows patterns and expressions to be written using
6688 programmer-defined concrete syntax; the motivation behind the extension and
6689 several examples are documented in
6690 "<ulink url="http://www.eecs.harvard.edu/~mainland/ghc-quasiquoting/">Why It's
6691 Nice to be Quoted: Quasiquoting for Haskell</ulink>" (Proc Haskell Workshop
6692 2007). The example below shows how to write a quasiquoter for a simple
6693 expression language.</para>
6694 <para>
6695 Here are the salient features
6696 <itemizedlist>
6697 <listitem><para>
6698 A quasi-quote has the form
6699 <literal>[<replaceable>quoter</replaceable>| <replaceable>string</replaceable> |]</literal>.
6700 <itemizedlist>
6701 <listitem><para>
6702 The <replaceable>quoter</replaceable> must be the (unqualified) name of an imported
6703 quoter; it cannot be an arbitrary expression.
6704 </para></listitem>
6705 <listitem><para>
6706 The <replaceable>quoter</replaceable> cannot be "<literal>e</literal>",
6707 "<literal>t</literal>", "<literal>d</literal>", or "<literal>p</literal>", since
6708 those overlap with Template Haskell quotations.
6709 </para></listitem>
6710 <listitem><para>
6711 There must be no spaces in the token
6712 <literal>[<replaceable>quoter</replaceable>|</literal>.
6713 </para></listitem>
6714 <listitem><para>
6715 The quoted <replaceable>string</replaceable>
6716 can be arbitrary, and may contain newlines.
6717 </para></listitem>
6718 </itemizedlist>
6719 </para></listitem>
6720
6721 <listitem><para>
6722 A quasiquote may appear in place of
6723 <itemizedlist>
6724 <listitem><para>An expression</para></listitem>
6725 <listitem><para>A pattern</para></listitem>
6726 <listitem><para>A type</para></listitem>
6727 <listitem><para>A top-level declaration</para></listitem>
6728 </itemizedlist>
6729 (Only the first two are described in the paper.)
6730 </para></listitem>
6731
6732 <listitem><para>
6733 A quoter is a value of type <literal>Language.Haskell.TH.Quote.QuasiQuoter</literal>,
6734 which is defined thus:
6735 <programlisting>
6736 data QuasiQuoter = QuasiQuoter { quoteExp  :: String -> Q Exp,
6737                                  quotePat  :: String -> Q Pat,
6738                                  quoteType :: String -> Q Type,
6739                                  quoteDec  :: String -> Q [Dec] }
6740 </programlisting>
6741 That is, a quoter is a tuple of four parsers, one for each of the contexts
6742 in which a quasi-quote can occur.
6743 </para></listitem>
6744 <listitem><para>
6745 A quasi-quote is expanded by applying the appropriate parser to the string
6746 enclosed by the Oxford brackets.  The context of the quasi-quote (expression, pattern,
6747 type, declaration) determines which of the parsers is called.
6748 </para></listitem>
6749 </itemizedlist>
6750 </para>
6751 <para>
6752 The example below shows quasi-quotation in action.  The quoter <literal>expr</literal>
6753 is bound to a value of type <literal>QuasiQuoter</literal> defined in module <literal>Expr</literal>.
6754 The example makes use of an antiquoted
6755 variable <literal>n</literal>, indicated by the syntax <literal>'int:n</literal>
6756 (this syntax for anti-quotation was defined by the parser's
6757 author, <emphasis>not</emphasis> by GHC). This binds <literal>n</literal> to the
6758 integer value argument of the constructor <literal>IntExpr</literal> when
6759 pattern matching. Please see the referenced paper for further details regarding
6760 anti-quotation as well as the description of a technique that uses SYB to
6761 leverage a single parser of type <literal>String -> a</literal> to generate both
6762 an expression parser that returns a value of type <literal>Q Exp</literal> and a
6763 pattern parser that returns a value of type <literal>Q Pat</literal>.
6764 </para>
6765
6766 <para>
6767 Quasiquoters must obey the same stage restrictions as Template Haskell, e.g., in
6768 the example, <literal>expr</literal> cannot be defined
6769 in <literal>Main.hs</literal> where it is used, but must be imported.
6770 </para>
6771
6772 <programlisting>
6773 {- ------------- file Main.hs --------------- -}
6774 module Main where
6775
6776 import Expr
6777
6778 main :: IO ()
6779 main = do { print $ eval [expr|1 + 2|]
6780           ; case IntExpr 1 of
6781               { [expr|'int:n|] -> print n
6782               ;  _              -> return ()
6783               }
6784           }
6785
6786
6787 {- ------------- file Expr.hs --------------- -}
6788 module Expr where
6789
6790 import qualified Language.Haskell.TH as TH
6791 import Language.Haskell.TH.Quote
6792
6793 data Expr  =  IntExpr Integer
6794            |  AntiIntExpr String
6795            |  BinopExpr BinOp Expr Expr
6796            |  AntiExpr String
6797     deriving(Show, Typeable, Data)
6798
6799 data BinOp  =  AddOp
6800             |  SubOp
6801             |  MulOp
6802             |  DivOp
6803     deriving(Show, Typeable, Data)
6804
6805 eval :: Expr -> Integer
6806 eval (IntExpr n)        = n
6807 eval (BinopExpr op x y) = (opToFun op) (eval x) (eval y)
6808   where
6809     opToFun AddOp = (+)
6810     opToFun SubOp = (-)
6811     opToFun MulOp = (*)
6812     opToFun DivOp = div
6813
6814 expr = QuasiQuoter { quoteExp = parseExprExp, quotePat =  parseExprPat }
6815
6816 -- Parse an Expr, returning its representation as
6817 -- either a Q Exp or a Q Pat. See the referenced paper
6818 -- for how to use SYB to do this by writing a single
6819 -- parser of type String -> Expr instead of two
6820 -- separate parsers.
6821
6822 parseExprExp :: String -> Q Exp
6823 parseExprExp ...
6824
6825 parseExprPat :: String -> Q Pat
6826 parseExprPat ...
6827 </programlisting>
6828
6829 <para>Now run the compiler:
6830 <programlisting>
6831 $ ghc --make -XQuasiQuotes Main.hs -o main
6832 </programlisting>
6833 </para>
6834
6835 <para>Run "main" and here is your output:
6836 <programlisting>
6837 $ ./main
6838 3
6839 1
6840 </programlisting>
6841 </para>
6842 </sect2>
6843
6844 </sect1>
6845
6846 <!-- ===================== Arrow notation ===================  -->
6847
6848 <sect1 id="arrow-notation">
6849 <title>Arrow notation
6850 </title>
6851
6852 <para>Arrows are a generalization of monads introduced by John Hughes.
6853 For more details, see
6854 <itemizedlist>
6855
6856 <listitem>
6857 <para>
6858 &ldquo;Generalising Monads to Arrows&rdquo;,
6859 John Hughes, in <citetitle>Science of Computer Programming</citetitle> 37,
6860 pp67&ndash;111, May 2000.
6861 The paper that introduced arrows: a friendly introduction, motivated with
6862 programming examples.
6863 </para>
6864 </listitem>
6865
6866 <listitem>
6867 <para>
6868 &ldquo;<ulink url="http://www.soi.city.ac.uk/~ross/papers/notation.html">A New Notation for Arrows</ulink>&rdquo;,
6869 Ross Paterson, in <citetitle>ICFP</citetitle>, Sep 2001.
6870 Introduced the notation described here.
6871 </para>
6872 </listitem>
6873
6874 <listitem>
6875 <para>
6876 &ldquo;<ulink url="http://www.soi.city.ac.uk/~ross/papers/fop.html">Arrows and Computation</ulink>&rdquo;,
6877 Ross Paterson, in <citetitle>The Fun of Programming</citetitle>,
6878 Palgrave, 2003.
6879 </para>
6880 </listitem>
6881
6882 <listitem>
6883 <para>
6884 &ldquo;<ulink url="http://www.cs.chalmers.se/~rjmh/afp-arrows.pdf">Programming with Arrows</ulink>&rdquo;,
6885 John Hughes, in <citetitle>5th International Summer School on
6886 Advanced Functional Programming</citetitle>,
6887 <citetitle>Lecture Notes in Computer Science</citetitle> vol. 3622,
6888 Springer, 2004.
6889 This paper includes another introduction to the notation,
6890 with practical examples.
6891 </para>
6892 </listitem>
6893
6894 <listitem>
6895 <para>
6896 &ldquo;<ulink url="http://www.haskell.org/ghc/docs/papers/arrow-rules.pdf">Type and Translation Rules for Arrow Notation in GHC</ulink>&rdquo;,
6897 Ross Paterson and Simon Peyton Jones, September 16, 2004.
6898 A terse enumeration of the formal rules used
6899 (extracted from comments in the source code).
6900 </para>
6901 </listitem>
6902
6903 <listitem>
6904 <para>
6905 The arrows web page at
6906 <ulink url="http://www.haskell.org/arrows/"><literal>http://www.haskell.org/arrows/</literal></ulink>.
6907 </para>
6908 </listitem>
6909
6910 </itemizedlist>
6911 With the <option>-XArrows</option> flag, GHC supports the arrow
6912 notation described in the second of these papers,
6913 translating it using combinators from the
6914 <ulink url="&libraryBaseLocation;/Control-Arrow.html"><literal>Control.Arrow</literal></ulink>
6915 module.
6916 What follows is a brief introduction to the notation;
6917 it won't make much sense unless you've read Hughes's paper.
6918 </para>
6919
6920 <para>The extension adds a new kind of expression for defining arrows:
6921 <screen>
6922 <replaceable>exp</replaceable><superscript>10</superscript> ::= ...
6923        |  proc <replaceable>apat</replaceable> -> <replaceable>cmd</replaceable>
6924 </screen>
6925 where <literal>proc</literal> is a new keyword.
6926 The variables of the pattern are bound in the body of the
6927 <literal>proc</literal>-expression,
6928 which is a new sort of thing called a <firstterm>command</firstterm>.
6929 The syntax of commands is as follows:
6930 <screen>
6931 <replaceable>cmd</replaceable>   ::= <replaceable>exp</replaceable><superscript>10</superscript> -&lt;  <replaceable>exp</replaceable>
6932        |  <replaceable>exp</replaceable><superscript>10</superscript> -&lt;&lt; <replaceable>exp</replaceable>
6933        |  <replaceable>cmd</replaceable><superscript>0</superscript>
6934 </screen>
6935 with <replaceable>cmd</replaceable><superscript>0</superscript> up to
6936 <replaceable>cmd</replaceable><superscript>9</superscript> defined using
6937 infix operators as for expressions, and
6938 <screen>
6939 <replaceable>cmd</replaceable><superscript>10</superscript> ::= \ <replaceable>apat</replaceable> ... <replaceable>apat</replaceable> -> <replaceable>cmd</replaceable>
6940        |  let <replaceable>decls</replaceable> in <replaceable>cmd</replaceable>
6941        |  if <replaceable>exp</replaceable> then <replaceable>cmd</replaceable> else <replaceable>cmd</replaceable>
6942        |  case <replaceable>exp</replaceable> of { <replaceable>calts</replaceable> }
6943        |  do { <replaceable>cstmt</replaceable> ; ... <replaceable>cstmt</replaceable> ; <replaceable>cmd</replaceable> }
6944        |  <replaceable>fcmd</replaceable>
6945
6946 <replaceable>fcmd</replaceable>  ::= <replaceable>fcmd</replaceable> <replaceable>aexp</replaceable>
6947        |  ( <replaceable>cmd</replaceable> )
6948        |  (| <replaceable>aexp</replaceable> <replaceable>cmd</replaceable> ... <replaceable>cmd</replaceable> |)
6949
6950 <replaceable>cstmt</replaceable> ::= let <replaceable>decls</replaceable>
6951        |  <replaceable>pat</replaceable> &lt;- <replaceable>cmd</replaceable>
6952        |  rec { <replaceable>cstmt</replaceable> ; ... <replaceable>cstmt</replaceable> [;] }
6953        |  <replaceable>cmd</replaceable>
6954 </screen>
6955 where <replaceable>calts</replaceable> are like <replaceable>alts</replaceable>
6956 except that the bodies are commands instead of expressions.
6957 </para>
6958
6959 <para>
6960 Commands produce values, but (like monadic computations)
6961 may yield more than one value,
6962 or none, and may do other things as well.
6963 For the most part, familiarity with monadic notation is a good guide to
6964 using commands.
6965 However the values of expressions, even monadic ones,
6966 are determined by the values of the variables they contain;
6967 this is not necessarily the case for commands.
6968 </para>
6969
6970 <para>
6971 A simple example of the new notation is the expression
6972 <screen>
6973 proc x -> f -&lt; x+1
6974 </screen>
6975 We call this a <firstterm>procedure</firstterm> or
6976 <firstterm>arrow abstraction</firstterm>.
6977 As with a lambda expression, the variable <literal>x</literal>
6978 is a new variable bound within the <literal>proc</literal>-expression.
6979 It refers to the input to the arrow.
6980 In the above example, <literal>-&lt;</literal> is not an identifier but an
6981 new reserved symbol used for building commands from an expression of arrow
6982 type and an expression to be fed as input to that arrow.
6983 (The weird look will make more sense later.)
6984 It may be read as analogue of application for arrows.
6985 The above example is equivalent to the Haskell expression
6986 <screen>
6987 arr (\ x -> x+1) >>> f
6988 </screen>
6989 That would make no sense if the expression to the left of
6990 <literal>-&lt;</literal> involves the bound variable <literal>x</literal>.
6991 More generally, the expression to the left of <literal>-&lt;</literal>
6992 may not involve any <firstterm>local variable</firstterm>,
6993 i.e. a variable bound in the current arrow abstraction.
6994 For such a situation there is a variant <literal>-&lt;&lt;</literal>, as in
6995 <screen>
6996 proc x -> f x -&lt;&lt; x+1
6997 </screen>
6998 which is equivalent to
6999 <screen>
7000 arr (\ x -> (f x, x+1)) >>> app
7001 </screen>
7002 so in this case the arrow must belong to the <literal>ArrowApply</literal>
7003 class.
7004 Such an arrow is equivalent to a monad, so if you're using this form
7005 you may find a monadic formulation more convenient.
7006 </para>
7007
7008 <sect2>
7009 <title>do-notation for commands</title>
7010
7011 <para>
7012 Another form of command is a form of <literal>do</literal>-notation.
7013 For example, you can write
7014 <screen>
7015 proc x -> do
7016         y &lt;- f -&lt; x+1
7017         g -&lt; 2*y
7018         let z = x+y
7019         t &lt;- h -&lt; x*z
7020         returnA -&lt; t+z
7021 </screen>
7022 You can read this much like ordinary <literal>do</literal>-notation,
7023 but with commands in place of monadic expressions.
7024 The first line sends the value of <literal>x+1</literal> as an input to
7025 the arrow <literal>f</literal>, and matches its output against
7026 <literal>y</literal>.
7027 In the next line, the output is discarded.
7028 The arrow <function>returnA</function> is defined in the
7029 <ulink url="&libraryBaseLocation;/Control-Arrow.html"><literal>Control.Arrow</literal></ulink>
7030 module as <literal>arr id</literal>.
7031 The above example is treated as an abbreviation for
7032 <screen>
7033 arr (\ x -> (x, x)) >>>
7034         first (arr (\ x -> x+1) >>> f) >>>
7035         arr (\ (y, x) -> (y, (x, y))) >>>
7036         first (arr (\ y -> 2*y) >>> g) >>>
7037         arr snd >>>
7038         arr (\ (x, y) -> let z = x+y in ((x, z), z)) >>>
7039         first (arr (\ (x, z) -> x*z) >>> h) >>>
7040         arr (\ (t, z) -> t+z) >>>
7041         returnA
7042 </screen>
7043 Note that variables not used later in the composition are projected out.
7044 After simplification using rewrite rules (see <xref linkend="rewrite-rules"/>)
7045 defined in the
7046 <ulink url="&libraryBaseLocation;/Control-Arrow.html"><literal>Control.Arrow</literal></ulink>
7047 module, this reduces to
7048 <screen>
7049 arr (\ x -> (x+1, x)) >>>
7050         first f >>>
7051         arr (\ (y, x) -> (2*y, (x, y))) >>>
7052         first g >>>
7053         arr (\ (_, (x, y)) -> let z = x+y in (x*z, z)) >>>
7054         first h >>>
7055         arr (\ (t, z) -> t+z)
7056 </screen>
7057 which is what you might have written by hand.
7058 With arrow notation, GHC keeps track of all those tuples of variables for you.
7059 </para>
7060
7061 <para>
7062 Note that although the above translation suggests that
7063 <literal>let</literal>-bound variables like <literal>z</literal> must be
7064 monomorphic, the actual translation produces Core,
7065 so polymorphic variables are allowed.
7066 </para>
7067
7068 <para>
7069 It's also possible to have mutually recursive bindings,
7070 using the new <literal>rec</literal> keyword, as in the following example:
7071 <programlisting>
7072 counter :: ArrowCircuit a => a Bool Int
7073 counter = proc reset -> do
7074         rec     output &lt;- returnA -&lt; if reset then 0 else next
7075                 next &lt;- delay 0 -&lt; output+1
7076         returnA -&lt; output
7077 </programlisting>
7078 The translation of such forms uses the <function>loop</function> combinator,
7079 so the arrow concerned must belong to the <literal>ArrowLoop</literal> class.
7080 </para>
7081
7082 </sect2>
7083
7084 <sect2>
7085 <title>Conditional commands</title>
7086
7087 <para>
7088 In the previous example, we used a conditional expression to construct the
7089 input for an arrow.
7090 Sometimes we want to conditionally execute different commands, as in
7091 <screen>
7092 proc (x,y) ->
7093         if f x y
7094         then g -&lt; x+1
7095         else h -&lt; y+2
7096 </screen>
7097 which is translated to
7098 <screen>
7099 arr (\ (x,y) -> if f x y then Left x else Right y) >>>
7100         (arr (\x -> x+1) >>> f) ||| (arr (\y -> y+2) >>> g)
7101 </screen>
7102 Since the translation uses <function>|||</function>,
7103 the arrow concerned must belong to the <literal>ArrowChoice</literal> class.
7104 </para>
7105
7106 <para>
7107 There are also <literal>case</literal> commands, like
7108 <screen>
7109 case input of
7110     [] -> f -&lt; ()
7111     [x] -> g -&lt; x+1
7112     x1:x2:xs -> do
7113         y &lt;- h -&lt; (x1, x2)
7114         ys &lt;- k -&lt; xs
7115         returnA -&lt; y:ys
7116 </screen>
7117 The syntax is the same as for <literal>case</literal> expressions,
7118 except that the bodies of the alternatives are commands rather than expressions.
7119 The translation is similar to that of <literal>if</literal> commands.
7120 </para>
7121
7122 </sect2>
7123
7124 <sect2>
7125 <title>Defining your own control structures</title>
7126
7127 <para>
7128 As we're seen, arrow notation provides constructs,
7129 modelled on those for expressions,
7130 for sequencing, value recursion and conditionals.
7131 But suitable combinators,
7132 which you can define in ordinary Haskell,
7133 may also be used to build new commands out of existing ones.
7134 The basic idea is that a command defines an arrow from environments to values.
7135 These environments assign values to the free local variables of the command.
7136 Thus combinators that produce arrows from arrows
7137 may also be used to build commands from commands.
7138 For example, the <literal>ArrowChoice</literal> class includes a combinator
7139 <programlisting>
7140 ArrowChoice a => (&lt;+>) :: a e c -> a e c -> a e c
7141 </programlisting>
7142 so we can use it to build commands:
7143 <programlisting>
7144 expr' = proc x -> do
7145                 returnA -&lt; x
7146         &lt;+> do
7147                 symbol Plus -&lt; ()
7148                 y &lt;- term -&lt; ()
7149                 expr' -&lt; x + y
7150         &lt;+> do
7151                 symbol Minus -&lt; ()
7152                 y &lt;- term -&lt; ()
7153                 expr' -&lt; x - y
7154 </programlisting>
7155 (The <literal>do</literal> on the first line is needed to prevent the first
7156 <literal>&lt;+> ...</literal> from being interpreted as part of the
7157 expression on the previous line.)
7158 This is equivalent to
7159 <programlisting>
7160 expr' = (proc x -> returnA -&lt; x)
7161         &lt;+> (proc x -> do
7162                 symbol Plus -&lt; ()
7163                 y &lt;- term -&lt; ()
7164                 expr' -&lt; x + y)
7165         &lt;+> (proc x -> do
7166                 symbol Minus -&lt; ()
7167                 y &lt;- term -&lt; ()
7168                 expr' -&lt; x - y)
7169 </programlisting>
7170 It is essential that this operator be polymorphic in <literal>e</literal>
7171 (representing the environment input to the command
7172 and thence to its subcommands)
7173 and satisfy the corresponding naturality property
7174 <screen>
7175 arr k >>> (f &lt;+> g) = (arr k >>> f) &lt;+> (arr k >>> g)
7176 </screen>
7177 at least for strict <literal>k</literal>.
7178 (This should be automatic if you're not using <function>seq</function>.)
7179 This ensures that environments seen by the subcommands are environments
7180 of the whole command,
7181 and also allows the translation to safely trim these environments.
7182 The operator must also not use any variable defined within the current
7183 arrow abstraction.
7184 </para>
7185
7186 <para>
7187 We could define our own operator
7188 <programlisting>
7189 untilA :: ArrowChoice a => a e () -> a e Bool -> a e ()
7190 untilA body cond = proc x ->
7191         b &lt;- cond -&lt; x
7192         if b then returnA -&lt; ()
7193         else do
7194                 body -&lt; x
7195                 untilA body cond -&lt; x
7196 </programlisting>
7197 and use it in the same way.
7198 Of course this infix syntax only makes sense for binary operators;
7199 there is also a more general syntax involving special brackets:
7200 <screen>
7201 proc x -> do
7202         y &lt;- f -&lt; x+1
7203         (|untilA (increment -&lt; x+y) (within 0.5 -&lt; x)|)
7204 </screen>
7205 </para>
7206
7207 </sect2>
7208
7209 <sect2>
7210 <title>Primitive constructs</title>
7211
7212 <para>
7213 Some operators will need to pass additional inputs to their subcommands.
7214 For example, in an arrow type supporting exceptions,
7215 the operator that attaches an exception handler will wish to pass the
7216 exception that occurred to the handler.
7217 Such an operator might have a type
7218 <screen>
7219 handleA :: ... => a e c -> a (e,Ex) c -> a e c
7220 </screen>
7221 where <literal>Ex</literal> is the type of exceptions handled.
7222 You could then use this with arrow notation by writing a command
7223 <screen>
7224 body `handleA` \ ex -> handler
7225 </screen>
7226 so that if an exception is raised in the command <literal>body</literal>,
7227 the variable <literal>ex</literal> is bound to the value of the exception
7228 and the command <literal>handler</literal>,
7229 which typically refers to <literal>ex</literal>, is entered.
7230 Though the syntax here looks like a functional lambda,
7231 we are talking about commands, and something different is going on.
7232 The input to the arrow represented by a command consists of values for
7233 the free local variables in the command, plus a stack of anonymous values.
7234 In all the prior examples, this stack was empty.
7235 In the second argument to <function>handleA</function>,
7236 this stack consists of one value, the value of the exception.
7237 The command form of lambda merely gives this value a name.
7238 </para>
7239
7240 <para>
7241 More concretely,
7242 the values on the stack are paired to the right of the environment.
7243 So operators like <function>handleA</function> that pass
7244 extra inputs to their subcommands can be designed for use with the notation
7245 by pairing the values with the environment in this way.
7246 More precisely, the type of each argument of the operator (and its result)
7247 should have the form
7248 <screen>
7249 a (...(e,t1), ... tn) t
7250 </screen>
7251 where <replaceable>e</replaceable> is a polymorphic variable
7252 (representing the environment)
7253 and <replaceable>ti</replaceable> are the types of the values on the stack,
7254 with <replaceable>t1</replaceable> being the <quote>top</quote>.
7255 The polymorphic variable <replaceable>e</replaceable> must not occur in
7256 <replaceable>a</replaceable>, <replaceable>ti</replaceable> or
7257 <replaceable>t</replaceable>.
7258 However the arrows involved need not be the same.
7259 Here are some more examples of suitable operators:
7260 <screen>
7261 bracketA :: ... => a e b -> a (e,b) c -> a (e,c) d -> a e d
7262 runReader :: ... => a e c -> a' (e,State) c
7263 runState :: ... => a e c -> a' (e,State) (c,State)
7264 </screen>
7265 We can supply the extra input required by commands built with the last two
7266 by applying them to ordinary expressions, as in
7267 <screen>
7268 proc x -> do
7269         s &lt;- ...
7270         (|runReader (do { ... })|) s
7271 </screen>
7272 which adds <literal>s</literal> to the stack of inputs to the command
7273 built using <function>runReader</function>.
7274 </para>
7275
7276 <para>
7277 The command versions of lambda abstraction and application are analogous to
7278 the expression versions.
7279 In particular, the beta and eta rules describe equivalences of commands.
7280 These three features (operators, lambda abstraction and application)
7281 are the core of the notation; everything else can be built using them,
7282 though the results would be somewhat clumsy.
7283 For example, we could simulate <literal>do</literal>-notation by defining
7284 <programlisting>
7285 bind :: Arrow a => a e b -> a (e,b) c -> a e c
7286 u `bind` f = returnA &amp;&amp;&amp; u >>> f
7287
7288 bind_ :: Arrow a => a e b -> a e c -> a e c
7289 u `bind_` f = u `bind` (arr fst >>> f)
7290 </programlisting>
7291 We could simulate <literal>if</literal> by defining
7292 <programlisting>
7293 cond :: ArrowChoice a => a e b -> a e b -> a (e,Bool) b
7294 cond f g = arr (\ (e,b) -> if b then Left e else Right e) >>> f ||| g
7295 </programlisting>
7296 </para>
7297
7298 </sect2>
7299
7300 <sect2>
7301 <title>Differences with the paper</title>
7302
7303 <itemizedlist>
7304
7305 <listitem>
7306 <para>Instead of a single form of arrow application (arrow tail) with two
7307 translations, the implementation provides two forms
7308 <quote><literal>-&lt;</literal></quote> (first-order)
7309 and <quote><literal>-&lt;&lt;</literal></quote> (higher-order).
7310 </para>
7311 </listitem>
7312
7313 <listitem>
7314 <para>User-defined operators are flagged with banana brackets instead of
7315 a new <literal>form</literal> keyword.
7316 </para>
7317 </listitem>
7318
7319 </itemizedlist>
7320
7321 </sect2>
7322
7323 <sect2>
7324 <title>Portability</title>
7325
7326 <para>
7327 Although only GHC implements arrow notation directly,
7328 there is also a preprocessor
7329 (available from the
7330 <ulink url="http://www.haskell.org/arrows/">arrows web page</ulink>)
7331 that translates arrow notation into Haskell 98
7332 for use with other Haskell systems.
7333 You would still want to check arrow programs with GHC;
7334 tracing type errors in the preprocessor output is not easy.
7335 Modules intended for both GHC and the preprocessor must observe some
7336 additional restrictions:
7337 <itemizedlist>
7338
7339 <listitem>
7340 <para>
7341 The module must import
7342 <ulink url="&libraryBaseLocation;/Control-Arrow.html"><literal>Control.Arrow</literal></ulink>.
7343 </para>
7344 </listitem>
7345
7346 <listitem>
7347 <para>
7348 The preprocessor cannot cope with other Haskell extensions.
7349 These would have to go in separate modules.
7350 </para>
7351 </listitem>
7352
7353 <listitem>
7354 <para>
7355 Because the preprocessor targets Haskell (rather than Core),
7356 <literal>let</literal>-bound variables are monomorphic.
7357 </para>
7358 </listitem>
7359
7360 </itemizedlist>
7361 </para>
7362
7363 </sect2>
7364
7365 </sect1>
7366
7367 <!-- ==================== BANG PATTERNS =================  -->
7368
7369 <sect1 id="bang-patterns">
7370 <title>Bang patterns
7371 <indexterm><primary>Bang patterns</primary></indexterm>
7372 </title>
7373 <para>GHC supports an extension of pattern matching called <emphasis>bang
7374 patterns</emphasis>, written <literal>!<replaceable>pat</replaceable></literal>.
7375 Bang patterns are under consideration for Haskell Prime.
7376 The <ulink
7377 url="http://hackage.haskell.org/trac/haskell-prime/wiki/BangPatterns">Haskell
7378 prime feature description</ulink> contains more discussion and examples
7379 than the material below.
7380 </para>
7381 <para>
7382 The key change is the addition of a new rule to the
7383 <ulink url="http://haskell.org/onlinereport/exps.html#sect3.17.2">semantics of pattern matching in the Haskell 98 report</ulink>.
7384 Add new bullet 10, saying: Matching the pattern <literal>!</literal><replaceable>pat</replaceable>
7385 against a value <replaceable>v</replaceable> behaves as follows:
7386 <itemizedlist>
7387 <listitem><para>if <replaceable>v</replaceable> is bottom, the match diverges</para></listitem>
7388 <listitem><para>otherwise, <replaceable>pat</replaceable> is matched against <replaceable>v</replaceable>  </para></listitem>
7389 </itemizedlist>
7390 </para>
7391 <para>
7392 Bang patterns are enabled by the flag <option>-XBangPatterns</option>.
7393 </para>
7394
7395 <sect2 id="bang-patterns-informal">
7396 <title>Informal description of bang patterns
7397 </title>
7398 <para>
7399 The main idea is to add a single new production to the syntax of patterns:
7400 <programlisting>
7401   pat ::= !pat
7402 </programlisting>
7403 Matching an expression <literal>e</literal> against a pattern <literal>!p</literal> is done by first
7404 evaluating <literal>e</literal> (to WHNF) and then matching the result against <literal>p</literal>.
7405 Example:
7406 <programlisting>
7407 f1 !x = True
7408 </programlisting>
7409 This definition makes <literal>f1</literal> is strict in <literal>x</literal>,
7410 whereas without the bang it would be lazy.
7411 Bang patterns can be nested of course:
7412 <programlisting>
7413 f2 (!x, y) = [x,y]
7414 </programlisting>
7415 Here, <literal>f2</literal> is strict in <literal>x</literal> but not in
7416 <literal>y</literal>.
7417 A bang only really has an effect if it precedes a variable or wild-card pattern:
7418 <programlisting>
7419 f3 !(x,y) = [x,y]
7420 f4 (x,y)  = [x,y]
7421 </programlisting>
7422 Here, <literal>f3</literal> and <literal>f4</literal> are identical;
7423 putting a bang before a pattern that
7424 forces evaluation anyway does nothing.
7425 </para>
7426 <para>
7427 There is one (apparent) exception to this general rule that a bang only
7428 makes a difference when it precedes a variable or wild-card: a bang at the
7429 top level of a <literal>let</literal> or <literal>where</literal>
7430 binding makes the binding strict, regardless of the pattern.
7431 (We say "apparent" exception because the Right Way to think of it is that the bang
7432 at the top of a binding is not part of the <emphasis>pattern</emphasis>; rather it
7433 is part of the syntax of the <emphasis>binding</emphasis>,
7434 creating a "bang-pattern binding".)
7435 For example:
7436 <programlisting>
7437 let ![x,y] = e in b
7438 </programlisting>
7439 is a bang-pattern binding. Operationally, it behaves just like a case expression:
7440 <programlisting>
7441 case e of [x,y] -> b
7442 </programlisting>
7443 Like a case expression, a bang-pattern binding must be non-recursive, and
7444 is monomorphic.
7445
7446 However, <emphasis>nested</emphasis> bangs in a pattern binding behave uniformly with all other forms of
7447 pattern matching.  For example
7448 <programlisting>
7449 let (!x,[y]) = e in b
7450 </programlisting>
7451 is equivalent to this:
7452 <programlisting>
7453 let { t = case e of (x,[y]) -> x `seq` (x,y)
7454       x = fst t
7455       y = snd t }
7456 in b
7457 </programlisting>
7458 The binding is lazy, but when either <literal>x</literal> or <literal>y</literal> is
7459 evaluated by <literal>b</literal> the entire pattern is matched, including forcing the
7460 evaluation of <literal>x</literal>.
7461 </para>
7462 <para>
7463 Bang patterns work in <literal>case</literal> expressions too, of course:
7464 <programlisting>
7465 g5 x = let y = f x in body
7466 g6 x = case f x of { y -&gt; body }
7467 g7 x = case f x of { !y -&gt; body }
7468 </programlisting>
7469 The functions <literal>g5</literal> and <literal>g6</literal> mean exactly the same thing.
7470 But <literal>g7</literal> evaluates <literal>(f x)</literal>, binds <literal>y</literal> to the
7471 result, and then evaluates <literal>body</literal>.
7472 </para>
7473 </sect2>
7474
7475
7476 <sect2 id="bang-patterns-sem">
7477 <title>Syntax and semantics
7478 </title>
7479 <para>
7480
7481 We add a single new production to the syntax of patterns:
7482 <programlisting>
7483   pat ::= !pat
7484 </programlisting>
7485 There is one problem with syntactic ambiguity.  Consider:
7486 <programlisting>
7487 f !x = 3
7488 </programlisting>
7489 Is this a definition of the infix function "<literal>(!)</literal>",
7490 or of the "<literal>f</literal>" with a bang pattern? GHC resolves this
7491 ambiguity in favour of the latter.  If you want to define
7492 <literal>(!)</literal> with bang-patterns enabled, you have to do so using
7493 prefix notation:
7494 <programlisting>
7495 (!) f x = 3
7496 </programlisting>
7497 The semantics of Haskell pattern matching is described in <ulink
7498 url="http://www.haskell.org/onlinereport/exps.html#sect3.17.2">
7499 Section 3.17.2</ulink> of the Haskell Report.  To this description add
7500 one extra item 10, saying:
7501 <itemizedlist><listitem><para>Matching
7502 the pattern <literal>!pat</literal> against a value <literal>v</literal> behaves as follows:
7503 <itemizedlist><listitem><para>if <literal>v</literal> is bottom, the match diverges</para></listitem>
7504                 <listitem><para>otherwise, <literal>pat</literal> is matched against
7505                 <literal>v</literal></para></listitem>
7506 </itemizedlist>
7507 </para></listitem></itemizedlist>
7508 Similarly, in Figure 4 of  <ulink url="http://www.haskell.org/onlinereport/exps.html#sect3.17.3">
7509 Section 3.17.3</ulink>, add a new case (t):
7510 <programlisting>
7511 case v of { !pat -> e; _ -> e' }
7512    = v `seq` case v of { pat -> e; _ -> e' }
7513 </programlisting>
7514 </para><para>
7515 That leaves let expressions, whose translation is given in
7516 <ulink url="http://www.haskell.org/onlinereport/exps.html#sect3.12">Section
7517 3.12</ulink>
7518 of the Haskell Report.
7519 In the translation box, first apply
7520 the following transformation:  for each pattern <literal>pi</literal> that is of
7521 form <literal>!qi = ei</literal>, transform it to <literal>(xi,!qi) = ((),ei)</literal>, and replace <literal>e0</literal>
7522 by <literal>(xi `seq` e0)</literal>.  Then, when none of the left-hand-side patterns
7523 have a bang at the top, apply the rules in the existing box.
7524 </para>
7525 <para>The effect of the let rule is to force complete matching of the pattern
7526 <literal>qi</literal> before evaluation of the body is begun.  The bang is
7527 retained in the translated form in case <literal>qi</literal> is a variable,
7528 thus:
7529 <programlisting>
7530   let !y = f x in b
7531 </programlisting>
7532
7533 </para>
7534 <para>
7535 The let-binding can be recursive.  However, it is much more common for
7536 the let-binding to be non-recursive, in which case the following law holds:
7537 <literal>(let !p = rhs in body)</literal>
7538      is equivalent to
7539 <literal>(case rhs of !p -> body)</literal>
7540 </para>
7541 <para>
7542 A pattern with a bang at the outermost level is not allowed at the top level of
7543 a module.
7544 </para>
7545 </sect2>
7546 </sect1>
7547
7548 <!-- ==================== ASSERTIONS =================  -->
7549
7550 <sect1 id="assertions">
7551 <title>Assertions
7552 <indexterm><primary>Assertions</primary></indexterm>
7553 </title>
7554
7555 <para>
7556 If you want to make use of assertions in your standard Haskell code, you
7557 could define a function like the following:
7558 </para>
7559
7560 <para>
7561
7562 <programlisting>
7563 assert :: Bool -> a -> a
7564 assert False x = error "assertion failed!"
7565 assert _     x = x
7566 </programlisting>
7567
7568 </para>
7569
7570 <para>
7571 which works, but gives you back a less than useful error message --
7572 an assertion failed, but which and where?
7573 </para>
7574
7575 <para>
7576 One way out is to define an extended <function>assert</function> function which also
7577 takes a descriptive string to include in the error message and
7578 perhaps combine this with the use of a pre-processor which inserts
7579 the source location where <function>assert</function> was used.
7580 </para>
7581
7582 <para>
7583 Ghc offers a helping hand here, doing all of this for you. For every
7584 use of <function>assert</function> in the user's source:
7585 </para>
7586
7587 <para>
7588
7589 <programlisting>
7590 kelvinToC :: Double -> Double
7591 kelvinToC k = assert (k &gt;= 0.0) (k+273.15)
7592 </programlisting>
7593
7594 </para>
7595
7596 <para>
7597 Ghc will rewrite this to also include the source location where the
7598 assertion was made,
7599 </para>
7600
7601 <para>
7602
7603 <programlisting>
7604 assert pred val ==> assertError "Main.hs|15" pred val
7605 </programlisting>
7606
7607 </para>
7608
7609 <para>
7610 The rewrite is only performed by the compiler when it spots
7611 applications of <function>Control.Exception.assert</function>, so you
7612 can still define and use your own versions of
7613 <function>assert</function>, should you so wish. If not, import
7614 <literal>Control.Exception</literal> to make use
7615 <function>assert</function> in your code.
7616 </para>
7617
7618 <para>
7619 GHC ignores assertions when optimisation is turned on with the
7620       <option>-O</option><indexterm><primary><option>-O</option></primary></indexterm> flag.  That is, expressions of the form
7621 <literal>assert pred e</literal> will be rewritten to
7622 <literal>e</literal>.  You can also disable assertions using the
7623       <option>-fignore-asserts</option>
7624       option<indexterm><primary><option>-fignore-asserts</option></primary>
7625       </indexterm>.</para>
7626
7627 <para>
7628 Assertion failures can be caught, see the documentation for the
7629 <literal>Control.Exception</literal> library for the details.
7630 </para>
7631
7632 </sect1>
7633
7634
7635 <!-- =============================== PRAGMAS ===========================  -->
7636
7637   <sect1 id="pragmas">
7638     <title>Pragmas</title>
7639
7640     <indexterm><primary>pragma</primary></indexterm>
7641
7642     <para>GHC supports several pragmas, or instructions to the
7643     compiler placed in the source code.  Pragmas don't normally affect
7644     the meaning of the program, but they might affect the efficiency
7645     of the generated code.</para>
7646
7647     <para>Pragmas all take the form
7648
7649 <literal>{-# <replaceable>word</replaceable> ... #-}</literal>
7650
7651     where <replaceable>word</replaceable> indicates the type of
7652     pragma, and is followed optionally by information specific to that
7653     type of pragma.  Case is ignored in
7654     <replaceable>word</replaceable>.  The various values for
7655     <replaceable>word</replaceable> that GHC understands are described
7656     in the following sections; any pragma encountered with an
7657     unrecognised <replaceable>word</replaceable> is
7658     ignored. The layout rule applies in pragmas, so the closing <literal>#-}</literal>
7659     should start in a column to the right of the opening <literal>{-#</literal>. </para>
7660
7661     <para>Certain pragmas are <emphasis>file-header pragmas</emphasis>:
7662       <itemizedlist>
7663       <listitem><para>
7664           A file-header
7665           pragma must precede the <literal>module</literal> keyword in the file.
7666           </para></listitem>
7667       <listitem><para>
7668       There can be as many file-header pragmas as you please, and they can be
7669       preceded or followed by comments.
7670           </para></listitem>
7671       <listitem><para>
7672       File-header pragmas are read once only, before
7673       pre-processing the file (e.g. with cpp).
7674           </para></listitem>
7675       <listitem><para>
7676          The file-header pragmas are: <literal>{-# LANGUAGE #-}</literal>,
7677         <literal>{-# OPTIONS_GHC #-}</literal>, and
7678         <literal>{-# INCLUDE #-}</literal>.
7679           </para></listitem>
7680       </itemizedlist>
7681       </para>
7682
7683     <sect2 id="language-pragma">
7684       <title>LANGUAGE pragma</title>
7685
7686       <indexterm><primary>LANGUAGE</primary><secondary>pragma</secondary></indexterm>
7687       <indexterm><primary>pragma</primary><secondary>LANGUAGE</secondary></indexterm>
7688
7689       <para>The <literal>LANGUAGE</literal> pragma allows language extensions to be enabled
7690         in a portable way.
7691         It is the intention that all Haskell compilers support the
7692         <literal>LANGUAGE</literal> pragma with the same syntax, although not
7693         all extensions are supported by all compilers, of
7694         course.  The <literal>LANGUAGE</literal> pragma should be used instead
7695         of <literal>OPTIONS_GHC</literal>, if possible.</para>
7696
7697       <para>For example, to enable the FFI and preprocessing with CPP:</para>
7698
7699 <programlisting>{-# LANGUAGE ForeignFunctionInterface, CPP #-}</programlisting>
7700
7701         <para><literal>LANGUAGE</literal> is a file-header pragma (see <xref linkend="pragmas"/>).</para>
7702
7703       <para>Every language extension can also be turned into a command-line flag
7704         by prefixing it with "<literal>-X</literal>"; for example <option>-XForeignFunctionInterface</option>.
7705         (Similarly, all "<literal>-X</literal>" flags can be written as <literal>LANGUAGE</literal> pragmas.
7706       </para>
7707
7708       <para>A list of all supported language extensions can be obtained by invoking
7709         <literal>ghc --supported-extensions</literal> (see <xref linkend="modes"/>).</para>
7710
7711       <para>Any extension from the <literal>Extension</literal> type defined in
7712         <ulink
7713           url="&libraryCabalLocation;/Language-Haskell-Extension.html"><literal>Language.Haskell.Extension</literal></ulink>
7714         may be used.  GHC will report an error if any of the requested extensions are not supported.</para>
7715     </sect2>
7716
7717
7718     <sect2 id="options-pragma">
7719       <title>OPTIONS_GHC pragma</title>
7720       <indexterm><primary>OPTIONS_GHC</primary>
7721       </indexterm>
7722       <indexterm><primary>pragma</primary><secondary>OPTIONS_GHC</secondary>
7723       </indexterm>
7724
7725       <para>The <literal>OPTIONS_GHC</literal> pragma is used to specify
7726       additional options that are given to the compiler when compiling
7727       this source file.  See <xref linkend="source-file-options"/> for
7728       details.</para>
7729
7730       <para>Previous versions of GHC accepted <literal>OPTIONS</literal> rather
7731         than <literal>OPTIONS_GHC</literal>, but that is now deprecated.</para>
7732     </sect2>
7733
7734         <para><literal>OPTIONS_GHC</literal> is a file-header pragma (see <xref linkend="pragmas"/>).</para>
7735
7736     <sect2 id="include-pragma">
7737       <title>INCLUDE pragma</title>
7738
7739       <para>The <literal>INCLUDE</literal> used to be necessary for
7740         specifying header files to be included when using the FFI and
7741         compiling via C.  It is no longer required for GHC, but is
7742         accepted (and ignored) for compatibility with other
7743         compilers.</para>
7744     </sect2>
7745
7746     <sect2 id="warning-deprecated-pragma">
7747       <title>WARNING and DEPRECATED pragmas</title>
7748       <indexterm><primary>WARNING</primary></indexterm>
7749       <indexterm><primary>DEPRECATED</primary></indexterm>
7750
7751       <para>The WARNING pragma allows you to attach an arbitrary warning
7752       to a particular function, class, or type.
7753       A DEPRECATED pragma lets you specify that
7754       a particular function, class, or type is deprecated.
7755       There are two ways of using these pragmas.
7756
7757       <itemizedlist>
7758         <listitem>
7759           <para>You can work on an entire module thus:</para>
7760 <programlisting>
7761    module Wibble {-# DEPRECATED "Use Wobble instead" #-} where
7762      ...
7763 </programlisting>
7764       <para>Or:</para>
7765 <programlisting>
7766    module Wibble {-# WARNING "This is an unstable interface." #-} where
7767      ...
7768 </programlisting>
7769           <para>When you compile any module that import
7770           <literal>Wibble</literal>, GHC will print the specified
7771           message.</para>
7772         </listitem>
7773
7774         <listitem>
7775           <para>You can attach a warning to a function, class, type, or data constructor, with the
7776           following top-level declarations:</para>
7777 <programlisting>
7778    {-# DEPRECATED f, C, T "Don't use these" #-}
7779    {-# WARNING unsafePerformIO "This is unsafe; I hope you know what you're doing" #-}
7780 </programlisting>
7781           <para>When you compile any module that imports and uses any
7782           of the specified entities, GHC will print the specified
7783           message.</para>
7784           <para> You can only attach to entities declared at top level in the module
7785           being compiled, and you can only use unqualified names in the list of
7786           entities. A capitalised name, such as <literal>T</literal>
7787           refers to <emphasis>either</emphasis> the type constructor <literal>T</literal>
7788           <emphasis>or</emphasis> the data constructor <literal>T</literal>, or both if
7789           both are in scope.  If both are in scope, there is currently no way to
7790       specify one without the other (c.f. fixities
7791       <xref linkend="infix-tycons"/>).</para>
7792         </listitem>
7793       </itemizedlist>
7794       Warnings and deprecations are not reported for
7795       (a) uses within the defining module, and
7796       (b) uses in an export list.
7797       The latter reduces spurious complaints within a library
7798       in which one module gathers together and re-exports
7799       the exports of several others.
7800       </para>
7801       <para>You can suppress the warnings with the flag
7802       <option>-fno-warn-warnings-deprecations</option>.</para>
7803     </sect2>
7804
7805     <sect2 id="inline-noinline-pragma">
7806       <title>INLINE and NOINLINE pragmas</title>
7807
7808       <para>These pragmas control the inlining of function
7809       definitions.</para>
7810
7811       <sect3 id="inline-pragma">
7812         <title>INLINE pragma</title>
7813         <indexterm><primary>INLINE</primary></indexterm>
7814
7815         <para>GHC (with <option>-O</option>, as always) tries to
7816         inline (or &ldquo;unfold&rdquo;) functions/values that are
7817         &ldquo;small enough,&rdquo; thus avoiding the call overhead
7818         and possibly exposing other more-wonderful optimisations.
7819         Normally, if GHC decides a function is &ldquo;too
7820         expensive&rdquo; to inline, it will not do so, nor will it
7821         export that unfolding for other modules to use.</para>
7822
7823         <para>The sledgehammer you can bring to bear is the
7824         <literal>INLINE</literal><indexterm><primary>INLINE
7825         pragma</primary></indexterm> pragma, used thusly:</para>
7826
7827 <programlisting>
7828 key_function :: Int -> String -> (Bool, Double)
7829 {-# INLINE key_function #-}
7830 </programlisting>
7831
7832         <para>The major effect of an <literal>INLINE</literal> pragma
7833         is to declare a function's &ldquo;cost&rdquo; to be very low.
7834         The normal unfolding machinery will then be very keen to
7835         inline it.  However, an <literal>INLINE</literal> pragma for a
7836         function "<literal>f</literal>" has a number of other effects:
7837 <itemizedlist>
7838 <listitem><para>
7839 While GHC is keen to inline the function, it does not do so
7840 blindly.  For example, if you write
7841 <programlisting>
7842 map key_function xs
7843 </programlisting>
7844 there really isn't any point in inlining <literal>key_function</literal> to get
7845 <programlisting>
7846 map (\x -> <replaceable>body</replaceable>) xs
7847 </programlisting>
7848 In general, GHC only inlines the function if there is some reason (no matter
7849 how slight) to suppose that it is useful to do so.
7850 </para></listitem>
7851
7852 <listitem><para>
7853 Moreover, GHC will only inline the function if it is <emphasis>fully applied</emphasis>,
7854 where "fully applied"
7855 means applied to as many arguments as appear (syntactically)
7856 on the LHS of the function
7857 definition.  For example:
7858 <programlisting>
7859 comp1 :: (b -> c) -> (a -> b) -> a -> c
7860 {-# INLINE comp1 #-}
7861 comp1 f g = \x -> f (g x)
7862
7863 comp2 :: (b -> c) -> (a -> b) -> a -> c
7864 {-# INLINE comp2 #-}
7865 comp2 f g x = f (g x)
7866 </programlisting>
7867 The two functions <literal>comp1</literal> and <literal>comp2</literal> have the
7868 same semantics, but <literal>comp1</literal> will be inlined when applied
7869 to <emphasis>two</emphasis> arguments, while <literal>comp2</literal> requires
7870 <emphasis>three</emphasis>.  This might make a big difference if you say
7871 <programlisting>
7872 map (not `comp1` not) xs
7873 </programlisting>
7874 which will optimise better than the corresponding use of `comp2`.
7875 </para></listitem>
7876
7877 <listitem><para>
7878 It is useful for GHC to optimise the definition of an
7879 INLINE function <literal>f</literal> just like any other non-INLINE function,
7880 in case the non-inlined version of <literal>f</literal> is
7881 ultimately called.  But we don't want to inline
7882 the <emphasis>optimised</emphasis> version
7883 of <literal>f</literal>;
7884 a major reason for INLINE pragmas is to expose functions
7885 in <literal>f</literal>'s RHS that have
7886 rewrite rules, and it's no good if those functions have been optimised
7887 away.
7888 </para>
7889 <para>
7890 So <emphasis>GHC guarantees to inline precisely the code that you wrote</emphasis>, no more
7891 and no less.  It does this by capturing a copy of the definition of the function to use
7892 for inlining (we call this the "inline-RHS"), which it leaves untouched,
7893 while optimising the ordinarily RHS as usual.  For externally-visible functions
7894 the inline-RHS (not the optimised RHS) is recorded in the interface file.
7895 </para></listitem>
7896 <listitem><para>
7897 An INLINE function is not worker/wrappered by strictness analysis.
7898 It's going to be inlined wholesale instead.
7899 </para></listitem>
7900 </itemizedlist>
7901 </para>
7902 <para>GHC ensures that inlining cannot go on forever: every mutually-recursive
7903 group is cut by one or more <emphasis>loop breakers</emphasis> that is never inlined
7904 (see <ulink url="http://research.microsoft.com/%7Esimonpj/Papers/inlining/index.htm">
7905 Secrets of the GHC inliner, JFP 12(4) July 2002</ulink>).
7906 GHC tries not to select a function with an INLINE pragma as a loop breaker, but
7907 when there is no choice even an INLINE function can be selected, in which case
7908 the INLINE pragma is ignored.
7909 For example, for a self-recursive function, the loop breaker can only be the function
7910 itself, so an INLINE pragma is always ignored.</para>
7911
7912         <para>Syntactically, an <literal>INLINE</literal> pragma for a
7913         function can be put anywhere its type signature could be
7914         put.</para>
7915
7916         <para><literal>INLINE</literal> pragmas are a particularly
7917         good idea for the
7918         <literal>then</literal>/<literal>return</literal> (or
7919         <literal>bind</literal>/<literal>unit</literal>) functions in
7920         a monad.  For example, in GHC's own
7921         <literal>UniqueSupply</literal> monad code, we have:</para>
7922
7923 <programlisting>
7924 {-# INLINE thenUs #-}
7925 {-# INLINE returnUs #-}
7926 </programlisting>
7927
7928         <para>See also the <literal>NOINLINE</literal> (<xref linkend="inlinable-pragma"/>)
7929         and <literal>INLINABLE</literal> (<xref linkend="noinline-pragma"/>)
7930         pragmas.</para>
7931
7932         <para>Note: the HBC compiler doesn't like <literal>INLINE</literal> pragmas,
7933           so if you want your code to be HBC-compatible you'll have to surround
7934           the pragma with C pre-processor directives
7935           <literal>#ifdef __GLASGOW_HASKELL__</literal>...<literal>#endif</literal>.</para>
7936
7937       </sect3>
7938
7939       <sect3 id="inlinable-pragma">
7940         <title>INLINABLE pragma</title>
7941
7942 <para>An <literal>{-# INLINABLE f #-}</literal> pragma on a
7943 function <literal>f</literal> has the following behaviour:
7944 <itemizedlist>
7945 <listitem><para>
7946 While <literal>INLINE</literal> says "please inline me", the <literal>INLINABLE</literal>
7947 says "feel free to inline me; use your
7948 discretion".  In other words the choice is left to GHC, which uses the same
7949 rules as for pragma-free functions.  Unlike <literal>INLINE</literal>, that decision is made at
7950 the <emphasis>call site</emphasis>, and
7951 will therefore be affected by the inlining threshold, optimisation level etc.
7952 </para></listitem>
7953 <listitem><para>
7954 Like <literal>INLINE</literal>, the <literal>INLINABLE</literal> pragma retains a
7955 copy of the original RHS for
7956 inlining purposes, and persists it in the interface file, regardless of
7957 the size of the RHS.
7958 </para></listitem>
7959
7960 <listitem><para>
7961 One way to use <literal>INLINABLE</literal> is in conjunction with
7962 the special function <literal>inline</literal> (<xref linkend="special-ids"/>).
7963 The call <literal>inline f</literal> tries very hard to inline <literal>f</literal>.
7964 To make sure that <literal>f</literal> can be inlined,
7965 it is a good idea to mark the definition
7966 of <literal>f</literal> as <literal>INLINABLE</literal>,
7967 so that GHC guarantees to expose an unfolding regardless of how big it is.
7968 Moreover, by annotating <literal>f</literal> as <literal>INLINABLE</literal>,
7969 you ensure that <literal>f</literal>'s original RHS is inlined, rather than
7970 whatever random optimised version of <literal>f</literal> GHC's optimiser
7971 has produced.
7972 </para></listitem>
7973
7974 <listitem><para>
7975 The <literal>INLINABLE</literal> pragma also works with <literal>SPECIALISE</literal>:
7976 if you mark function <literal>f</literal> as <literal>INLINABLE</literal>, then
7977 you can subsequently <literal>SPECIALISE</literal> in another module
7978 (see <xref linkend="specialize-pragma"/>).</para></listitem>
7979
7980 <listitem><para>
7981 Unlike <literal>INLINE</literal>, it is OK to use
7982 an <literal>INLINABLE</literal> pragma on a recursive function.
7983 The principal reason do to so to allow later use of <literal>SPECIALISE</literal>
7984 </para></listitem>
7985 </itemizedlist>
7986 </para>
7987
7988       </sect3>
7989
7990       <sect3 id="noinline-pragma">
7991         <title>NOINLINE pragma</title>
7992
7993         <indexterm><primary>NOINLINE</primary></indexterm>
7994         <indexterm><primary>NOTINLINE</primary></indexterm>
7995
7996         <para>The <literal>NOINLINE</literal> pragma does exactly what
7997         you'd expect: it stops the named function from being inlined
7998         by the compiler.  You shouldn't ever need to do this, unless
7999         you're very cautious about code size.</para>
8000
8001         <para><literal>NOTINLINE</literal> is a synonym for
8002         <literal>NOINLINE</literal> (<literal>NOINLINE</literal> is
8003         specified by Haskell 98 as the standard way to disable
8004         inlining, so it should be used if you want your code to be
8005         portable).</para>
8006       </sect3>
8007
8008       <sect3 id="conlike-pragma">
8009         <title>CONLIKE modifier</title>
8010         <indexterm><primary>CONLIKE</primary></indexterm>
8011         <para>An INLINE or NOINLINE pragma may have a CONLIKE modifier,
8012         which affects matching in RULEs (only).  See <xref linkend="conlike"/>.
8013         </para>
8014       </sect3>
8015
8016       <sect3 id="phase-control">
8017         <title>Phase control</title>
8018
8019         <para> Sometimes you want to control exactly when in GHC's
8020         pipeline the INLINE pragma is switched on.  Inlining happens
8021         only during runs of the <emphasis>simplifier</emphasis>.  Each
8022         run of the simplifier has a different <emphasis>phase
8023         number</emphasis>; the phase number decreases towards zero.
8024         If you use <option>-dverbose-core2core</option> you'll see the
8025         sequence of phase numbers for successive runs of the
8026         simplifier.  In an INLINE pragma you can optionally specify a
8027         phase number, thus:
8028         <itemizedlist>
8029           <listitem>
8030             <para>"<literal>INLINE[k] f</literal>" means: do not inline
8031             <literal>f</literal>
8032               until phase <literal>k</literal>, but from phase
8033               <literal>k</literal> onwards be very keen to inline it.
8034             </para></listitem>
8035           <listitem>
8036             <para>"<literal>INLINE[~k] f</literal>" means: be very keen to inline
8037             <literal>f</literal>
8038               until phase <literal>k</literal>, but from phase
8039               <literal>k</literal> onwards do not inline it.
8040             </para></listitem>
8041           <listitem>
8042             <para>"<literal>NOINLINE[k] f</literal>" means: do not inline
8043             <literal>f</literal>
8044               until phase <literal>k</literal>, but from phase
8045               <literal>k</literal> onwards be willing to inline it (as if
8046               there was no pragma).
8047             </para></listitem>
8048             <listitem>
8049             <para>"<literal>NOINLINE[~k] f</literal>" means: be willing to inline
8050             <literal>f</literal>
8051               until phase <literal>k</literal>, but from phase
8052               <literal>k</literal> onwards do not inline it.
8053             </para></listitem>
8054         </itemizedlist>
8055 The same information is summarised here:
8056 <programlisting>
8057                            -- Before phase 2     Phase 2 and later
8058   {-# INLINE   [2]  f #-}  --      No                 Yes
8059   {-# INLINE   [~2] f #-}  --      Yes                No
8060   {-# NOINLINE [2]  f #-}  --      No                 Maybe
8061   {-# NOINLINE [~2] f #-}  --      Maybe              No
8062
8063   {-# INLINE   f #-}       --      Yes                Yes
8064   {-# NOINLINE f #-}       --      No                 No
8065 </programlisting>
8066 By "Maybe" we mean that the usual heuristic inlining rules apply (if the
8067 function body is small, or it is applied to interesting-looking arguments etc).
8068 Another way to understand the semantics is this:
8069 <itemizedlist>
8070 <listitem><para>For both INLINE and NOINLINE, the phase number says
8071 when inlining is allowed at all.</para></listitem>
8072 <listitem><para>The INLINE pragma has the additional effect of making the
8073 function body look small, so that when inlining is allowed it is very likely to
8074 happen.
8075 </para></listitem>
8076 </itemizedlist>
8077 </para>
8078 <para>The same phase-numbering control is available for RULES
8079         (<xref linkend="rewrite-rules"/>).</para>
8080       </sect3>
8081     </sect2>
8082
8083     <sect2 id="annotation-pragmas">
8084       <title>ANN pragmas</title>
8085
8086       <para>GHC offers the ability to annotate various code constructs with additional
8087       data by using three pragmas.  This data can then be inspected at a later date by
8088       using GHC-as-a-library.</para>
8089
8090       <sect3 id="ann-pragma">
8091         <title>Annotating values</title>
8092
8093         <indexterm><primary>ANN</primary></indexterm>
8094
8095         <para>Any expression that has both <literal>Typeable</literal> and <literal>Data</literal> instances may be attached to a top-level value
8096         binding using an <literal>ANN</literal> pragma. In particular, this means you can use <literal>ANN</literal>
8097         to annotate data constructors (e.g. <literal>Just</literal>) as well as normal values (e.g. <literal>take</literal>).
8098         By way of example, to annotate the function <literal>foo</literal> with the annotation <literal>Just "Hello"</literal>
8099         you would do this:</para>
8100
8101 <programlisting>
8102 {-# ANN foo (Just "Hello") #-}
8103 foo = ...
8104 </programlisting>
8105
8106         <para>
8107           A number of restrictions apply to use of annotations:
8108           <itemizedlist>
8109             <listitem><para>The binder being annotated must be at the top level (i.e. no nested binders)</para></listitem>
8110             <listitem><para>The binder being annotated must be declared in the current module</para></listitem>
8111             <listitem><para>The expression you are annotating with must have a type with <literal>Typeable</literal> and <literal>Data</literal> instances</para></listitem>
8112             <listitem><para>The <ulink linkend="using-template-haskell">Template Haskell staging restrictions</ulink> apply to the
8113             expression being annotated with, so for example you cannot run a function from the module being compiled.</para>
8114
8115             <para>To be precise, the annotation <literal>{-# ANN x e #-}</literal> is well staged if and only if <literal>$(e)</literal> would be
8116             (disregarding the usual type restrictions of the splice syntax, and the usual restriction on splicing inside a splice - <literal>$([|1|])</literal> is fine as an annotation, albeit redundant).</para></listitem>
8117           </itemizedlist>
8118
8119           If you feel strongly that any of these restrictions are too onerous, <ulink url="http://hackage.haskell.org/trac/ghc/wiki/MailingListsAndIRC">
8120           please give the GHC team a shout</ulink>.
8121         </para>
8122
8123         <para>However, apart from these restrictions, many things are allowed, including expressions which are not fully evaluated!
8124         Annotation expressions will be evaluated by the compiler just like Template Haskell splices are. So, this annotation is fine:</para>
8125
8126 <programlisting>
8127 {-# ANN f SillyAnnotation { foo = (id 10) + $([| 20 |]), bar = 'f } #-}
8128 f = ...
8129 </programlisting>
8130       </sect3>
8131
8132       <sect3 id="typeann-pragma">
8133         <title>Annotating types</title>
8134
8135         <indexterm><primary>ANN type</primary></indexterm>
8136         <indexterm><primary>ANN</primary></indexterm>
8137
8138         <para>You can annotate types with the <literal>ANN</literal> pragma by using the <literal>type</literal> keyword. For example:</para>
8139
8140 <programlisting>
8141 {-# ANN type Foo (Just "A `Maybe String' annotation") #-}
8142 data Foo = ...
8143 </programlisting>
8144       </sect3>
8145
8146       <sect3 id="modann-pragma">
8147         <title>Annotating modules</title>
8148
8149         <indexterm><primary>ANN module</primary></indexterm>
8150         <indexterm><primary>ANN</primary></indexterm>
8151
8152         <para>You can annotate modules with the <literal>ANN</literal> pragma by using the <literal>module</literal> keyword. For example:</para>
8153
8154 <programlisting>
8155 {-# ANN module (Just "A `Maybe String' annotation") #-}
8156 </programlisting>
8157       </sect3>
8158     </sect2>
8159
8160     <sect2 id="line-pragma">
8161       <title>LINE pragma</title>
8162
8163       <indexterm><primary>LINE</primary><secondary>pragma</secondary></indexterm>
8164       <indexterm><primary>pragma</primary><secondary>LINE</secondary></indexterm>
8165       <para>This pragma is similar to C's <literal>&num;line</literal>
8166       pragma, and is mainly for use in automatically generated Haskell
8167       code.  It lets you specify the line number and filename of the
8168       original code; for example</para>
8169
8170 <programlisting>{-# LINE 42 "Foo.vhs" #-}</programlisting>
8171
8172       <para>if you'd generated the current file from something called
8173       <filename>Foo.vhs</filename> and this line corresponds to line
8174       42 in the original.  GHC will adjust its error messages to refer
8175       to the line/file named in the <literal>LINE</literal>
8176       pragma.</para>
8177     </sect2>
8178
8179     <sect2 id="rules">
8180       <title>RULES pragma</title>
8181
8182       <para>The RULES pragma lets you specify rewrite rules.  It is
8183       described in <xref linkend="rewrite-rules"/>.</para>
8184     </sect2>
8185
8186     <sect2 id="specialize-pragma">
8187       <title>SPECIALIZE pragma</title>
8188
8189       <indexterm><primary>SPECIALIZE pragma</primary></indexterm>
8190       <indexterm><primary>pragma, SPECIALIZE</primary></indexterm>
8191       <indexterm><primary>overloading, death to</primary></indexterm>
8192
8193       <para>(UK spelling also accepted.)  For key overloaded
8194       functions, you can create extra versions (NB: more code space)
8195       specialised to particular types.  Thus, if you have an
8196       overloaded function:</para>
8197
8198 <programlisting>
8199   hammeredLookup :: Ord key => [(key, value)] -> key -> value
8200 </programlisting>
8201
8202       <para>If it is heavily used on lists with
8203       <literal>Widget</literal> keys, you could specialise it as
8204       follows:</para>
8205
8206 <programlisting>
8207   {-# SPECIALIZE hammeredLookup :: [(Widget, value)] -> Widget -> value #-}
8208 </programlisting>
8209
8210       <para>A <literal>SPECIALIZE</literal> pragma for a function can
8211       be put anywhere its type signature could be put.</para>
8212
8213       <para>A <literal>SPECIALIZE</literal> has the effect of generating
8214       (a) a specialised version of the function and (b) a rewrite rule
8215       (see <xref linkend="rewrite-rules"/>) that rewrites a call to the
8216       un-specialised function into a call to the specialised one.</para>
8217
8218       <para>The type in a SPECIALIZE pragma can be any type that is less
8219         polymorphic than the type of the original function.  In concrete terms,
8220         if the original function is <literal>f</literal> then the pragma
8221 <programlisting>
8222   {-# SPECIALIZE f :: &lt;type&gt; #-}
8223 </programlisting>
8224       is valid if and only if the definition
8225 <programlisting>
8226   f_spec :: &lt;type&gt;
8227   f_spec = f
8228 </programlisting>
8229       is valid.  Here are some examples (where we only give the type signature
8230       for the original function, not its code):
8231 <programlisting>
8232   f :: Eq a => a -> b -> b
8233   {-# SPECIALISE f :: Int -> b -> b #-}
8234
8235   g :: (Eq a, Ix b) => a -> b -> b
8236   {-# SPECIALISE g :: (Eq a) => a -> Int -> Int #-}
8237
8238   h :: Eq a => a -> a -> a
8239   {-# SPECIALISE h :: (Eq a) => [a] -> [a] -> [a] #-}
8240 </programlisting>
8241 The last of these examples will generate a
8242 RULE with a somewhat-complex left-hand side (try it yourself), so it might not fire very
8243 well.  If you use this kind of specialisation, let us know how well it works.
8244 </para>
8245
8246     <sect3 id="specialize-inline">
8247       <title>SPECIALIZE INLINE</title>
8248
8249 <para>A <literal>SPECIALIZE</literal> pragma can optionally be followed with a
8250 <literal>INLINE</literal> or <literal>NOINLINE</literal> pragma, optionally
8251 followed by a phase, as described in <xref linkend="inline-noinline-pragma"/>.
8252 The <literal>INLINE</literal> pragma affects the specialised version of the
8253 function (only), and applies even if the function is recursive.  The motivating
8254 example is this:
8255 <programlisting>
8256 -- A GADT for arrays with type-indexed representation
8257 data Arr e where
8258   ArrInt :: !Int -> ByteArray# -> Arr Int
8259   ArrPair :: !Int -> Arr e1 -> Arr e2 -> Arr (e1, e2)
8260
8261 (!:) :: Arr e -> Int -> e
8262 {-# SPECIALISE INLINE (!:) :: Arr Int -> Int -> Int #-}
8263 {-# SPECIALISE INLINE (!:) :: Arr (a, b) -> Int -> (a, b) #-}
8264 (ArrInt _ ba)     !: (I# i) = I# (indexIntArray# ba i)
8265 (ArrPair _ a1 a2) !: i      = (a1 !: i, a2 !: i)
8266 </programlisting>
8267 Here, <literal>(!:)</literal> is a recursive function that indexes arrays
8268 of type <literal>Arr e</literal>.  Consider a call to  <literal>(!:)</literal>
8269 at type <literal>(Int,Int)</literal>.  The second specialisation will fire, and
8270 the specialised function will be inlined.  It has two calls to
8271 <literal>(!:)</literal>,
8272 both at type <literal>Int</literal>.  Both these calls fire the first
8273 specialisation, whose body is also inlined.  The result is a type-based
8274 unrolling of the indexing function.</para>
8275 <para>Warning: you can make GHC diverge by using <literal>SPECIALISE INLINE</literal>
8276 on an ordinarily-recursive function.</para>
8277 </sect3>
8278
8279 <sect3><title>SPECIALIZE for imported functions</title>
8280
8281 <para>
8282 Generally, you can only give a <literal>SPECIALIZE</literal> pragma
8283 for a function defined in the same module.
8284 However if a function <literal>f</literal> is given an <literal>INLINABLE</literal>
8285 pragma at its definition site, then it can subsequently be specialised by
8286 importing modules (see <xref linkend="inlinable-pragma"/>).
8287 For example
8288 <programlisting>
8289 module Map( lookup, blah blah ) where
8290   lookup :: Ord key => [(key,a)] -> key -> Maybe a
8291   lookup = ...
8292   {-# INLINABLE lookup #-}
8293
8294 module Client where
8295   import Map( lookup )
8296
8297   data T = T1 | T2 deriving( Eq, Ord )
8298   {-# SPECIALISE lookup :: [(T,a)] -> T -> Maybe a
8299 </programlisting>
8300 Here, <literal>lookup</literal> is declared <literal>INLINABLE</literal>, but
8301 it cannot be specialised for type <literal>T</literal> at its definition site,
8302 because that type does not exist yet.  Instead a client module can define <literal>T</literal>
8303 and then specialise <literal>lookup</literal> at that type.
8304 </para>
8305 <para>
8306 Moreover, every module that imports <literal>Client</literal> (or imports a module
8307 that imports <literal>Client</literal>, transitively) will "see", and make use of,
8308 the specialised version of <literal>lookup</literal>.  You don't need to put
8309 a <literal>SPECIALIZE</literal> pragma in every module.
8310 </para>
8311 <para>
8312 Moreover you often don't even need the <literal>SPECIALIZE</literal> pragma in the
8313 first place. When compiling a module M,
8314 GHC's optimiser (with -O) automatically considers each top-level
8315 overloaded function declared in M, and specialises it
8316 for the different types at which it is called in M.  The optimiser
8317 <emphasis>also</emphasis> considers each <emphasis>imported</emphasis>
8318 <literal>INLINABLE</literal> overloaded function, and specialises it
8319 for the different types at which it is called in M.
8320 So in our example, it would be enough for <literal>lookup</literal> to
8321 be called at type <literal>T</literal>:
8322 <programlisting>
8323 module Client where
8324   import Map( lookup )
8325
8326   data T = T1 | T2 deriving( Eq, Ord )
8327
8328   findT1 :: [(T,a)] -> Maybe a
8329   findT1 m = lookup m T1   -- A call of lookup at type T
8330 </programlisting>
8331 However, sometimes there are no such calls, in which case the
8332 pragma can be useful.
8333 </para>
8334 </sect3>
8335
8336 <sect3><title>Obsolete SPECIALIZE syntax</title>
8337
8338       <para>Note: In earlier versions of GHC, it was possible to provide your own
8339       specialised function for a given type:
8340
8341 <programlisting>
8342 {-# SPECIALIZE hammeredLookup :: [(Int, value)] -> Int -> value = intLookup #-}
8343 </programlisting>
8344
8345       This feature has been removed, as it is now subsumed by the
8346       <literal>RULES</literal> pragma (see <xref linkend="rule-spec"/>).</para>
8347 </sect3>
8348
8349     </sect2>
8350
8351 <sect2 id="specialize-instance-pragma">
8352 <title>SPECIALIZE instance pragma
8353 </title>
8354
8355 <para>
8356 <indexterm><primary>SPECIALIZE pragma</primary></indexterm>
8357 <indexterm><primary>overloading, death to</primary></indexterm>
8358 Same idea, except for instance declarations.  For example:
8359
8360 <programlisting>
8361 instance (Eq a) => Eq (Foo a) where {
8362    {-# SPECIALIZE instance Eq (Foo [(Int, Bar)]) #-}
8363    ... usual stuff ...
8364  }
8365 </programlisting>
8366 The pragma must occur inside the <literal>where</literal> part
8367 of the instance declaration.
8368 </para>
8369 <para>
8370 Compatible with HBC, by the way, except perhaps in the placement
8371 of the pragma.
8372 </para>
8373
8374 </sect2>
8375
8376     <sect2 id="unpack-pragma">
8377       <title>UNPACK pragma</title>
8378
8379       <indexterm><primary>UNPACK</primary></indexterm>
8380
8381       <para>The <literal>UNPACK</literal> indicates to the compiler
8382       that it should unpack the contents of a constructor field into
8383       the constructor itself, removing a level of indirection.  For
8384       example:</para>
8385
8386 <programlisting>
8387 data T = T {-# UNPACK #-} !Float
8388            {-# UNPACK #-} !Float
8389 </programlisting>
8390
8391       <para>will create a constructor <literal>T</literal> containing
8392       two unboxed floats.  This may not always be an optimisation: if
8393       the <function>T</function> constructor is scrutinised and the
8394       floats passed to a non-strict function for example, they will
8395       have to be reboxed (this is done automatically by the
8396       compiler).</para>
8397
8398       <para>Unpacking constructor fields should only be used in
8399       conjunction with <option>-O</option>, in order to expose
8400       unfoldings to the compiler so the reboxing can be removed as
8401       often as possible.  For example:</para>
8402
8403 <programlisting>
8404 f :: T -&#62; Float
8405 f (T f1 f2) = f1 + f2
8406 </programlisting>
8407
8408       <para>The compiler will avoid reboxing <function>f1</function>
8409       and <function>f2</function> by inlining <function>+</function>
8410       on floats, but only when <option>-O</option> is on.</para>
8411
8412       <para>Any single-constructor data is eligible for unpacking; for
8413       example</para>
8414
8415 <programlisting>
8416 data T = T {-# UNPACK #-} !(Int,Int)
8417 </programlisting>
8418
8419       <para>will store the two <literal>Int</literal>s directly in the
8420       <function>T</function> constructor, by flattening the pair.
8421       Multi-level unpacking is also supported:
8422
8423 <programlisting>
8424 data T = T {-# UNPACK #-} !S
8425 data S = S {-# UNPACK #-} !Int {-# UNPACK #-} !Int
8426 </programlisting>
8427
8428       will store two unboxed <literal>Int&num;</literal>s
8429       directly in the <function>T</function> constructor.  The
8430       unpacker can see through newtypes, too.</para>
8431
8432       <para>See also the <option>-funbox-strict-fields</option> flag,
8433       which essentially has the effect of adding
8434       <literal>{-#&nbsp;UNPACK&nbsp;#-}</literal> to every strict
8435       constructor field.</para>
8436     </sect2>
8437
8438     <sect2 id="source-pragma">
8439       <title>SOURCE pragma</title>
8440
8441       <indexterm><primary>SOURCE</primary></indexterm>
8442      <para>The <literal>{-# SOURCE #-}</literal> pragma is used only in <literal>import</literal> declarations,
8443      to break a module loop.  It is described in detail in <xref linkend="mutual-recursion"/>.
8444      </para>
8445 </sect2>
8446
8447 </sect1>
8448
8449 <!--  ======================= REWRITE RULES ======================== -->
8450
8451 <sect1 id="rewrite-rules">
8452 <title>Rewrite rules
8453
8454 <indexterm><primary>RULES pragma</primary></indexterm>
8455 <indexterm><primary>pragma, RULES</primary></indexterm>
8456 <indexterm><primary>rewrite rules</primary></indexterm></title>
8457
8458 <para>
8459 The programmer can specify rewrite rules as part of the source program
8460 (in a pragma).
8461 Here is an example:
8462
8463 <programlisting>
8464   {-# RULES
8465   "map/map"    forall f g xs.  map f (map g xs) = map (f.g) xs
8466     #-}
8467 </programlisting>
8468 </para>
8469 <para>
8470 Use the debug flag <option>-ddump-simpl-stats</option> to see what rules fired.
8471 If you need more information, then <option>-ddump-rule-firings</option> shows you
8472 each individual rule firing and <option>-ddump-rule-rewrites</option> also shows what the code looks like before and after the rewrite.
8473 </para>
8474
8475 <sect2>
8476 <title>Syntax</title>
8477
8478 <para>
8479 From a syntactic point of view:
8480
8481 <itemizedlist>
8482
8483 <listitem>
8484 <para>
8485  There may be zero or more rules in a <literal>RULES</literal> pragma, separated by semicolons (which
8486  may be generated by the layout rule).
8487 </para>
8488 </listitem>
8489
8490 <listitem>
8491 <para>
8492 The layout rule applies in a pragma.
8493 Currently no new indentation level
8494 is set, so if you put several rules in single RULES pragma and wish to use layout to separate them,
8495 you must lay out the starting in the same column as the enclosing definitions.
8496 <programlisting>
8497   {-# RULES
8498   "map/map"    forall f g xs.  map f (map g xs) = map (f.g) xs
8499   "map/append" forall f xs ys. map f (xs ++ ys) = map f xs ++ map f ys
8500     #-}
8501 </programlisting>
8502 Furthermore, the closing <literal>#-}</literal>
8503 should start in a column to the right of the opening <literal>{-#</literal>.
8504 </para>
8505 </listitem>
8506
8507 <listitem>
8508 <para>
8509  Each rule has a name, enclosed in double quotes.  The name itself has
8510 no significance at all.  It is only used when reporting how many times the rule fired.
8511 </para>
8512 </listitem>
8513
8514 <listitem>
8515 <para>
8516 A rule may optionally have a phase-control number (see <xref linkend="phase-control"/>),
8517 immediately after the name of the rule.  Thus:
8518 <programlisting>
8519   {-# RULES
8520         "map/map" [2]  forall f g xs. map f (map g xs) = map (f.g) xs
8521     #-}
8522 </programlisting>
8523 The "[2]" means that the rule is active in Phase 2 and subsequent phases.  The inverse
8524 notation "[~2]" is also accepted, meaning that the rule is active up to, but not including,
8525 Phase 2.
8526 </para>
8527 </listitem>
8528
8529
8530
8531 <listitem>
8532 <para>
8533  Each variable mentioned in a rule must either be in scope (e.g. <function>map</function>),
8534 or bound by the <literal>forall</literal> (e.g. <function>f</function>, <function>g</function>, <function>xs</function>).  The variables bound by
8535 the <literal>forall</literal> are called the <emphasis>pattern</emphasis> variables.  They are separated
8536 by spaces, just like in a type <literal>forall</literal>.
8537 </para>
8538 </listitem>
8539 <listitem>
8540
8541 <para>
8542  A pattern variable may optionally have a type signature.
8543 If the type of the pattern variable is polymorphic, it <emphasis>must</emphasis> have a type signature.
8544 For example, here is the <literal>foldr/build</literal> rule:
8545
8546 <programlisting>
8547 "fold/build"  forall k z (g::forall b. (a->b->b) -> b -> b) .
8548               foldr k z (build g) = g k z
8549 </programlisting>
8550
8551 Since <function>g</function> has a polymorphic type, it must have a type signature.
8552
8553 </para>
8554 </listitem>
8555 <listitem>
8556
8557 <para>
8558 The left hand side of a rule must consist of a top-level variable applied
8559 to arbitrary expressions.  For example, this is <emphasis>not</emphasis> OK:
8560
8561 <programlisting>
8562 "wrong1"   forall e1 e2.  case True of { True -> e1; False -> e2 } = e1
8563 "wrong2"   forall f.      f True = True
8564 </programlisting>
8565
8566 In <literal>"wrong1"</literal>, the LHS is not an application; in <literal>"wrong2"</literal>, the LHS has a pattern variable
8567 in the head.
8568 </para>
8569 </listitem>
8570 <listitem>
8571
8572 <para>
8573  A rule does not need to be in the same module as (any of) the
8574 variables it mentions, though of course they need to be in scope.
8575 </para>
8576 </listitem>
8577 <listitem>
8578
8579 <para>
8580  All rules are implicitly exported from the module, and are therefore
8581 in force in any module that imports the module that defined the rule, directly
8582 or indirectly.  (That is, if A imports B, which imports C, then C's rules are
8583 in force when compiling A.)  The situation is very similar to that for instance
8584 declarations.
8585 </para>
8586 </listitem>
8587
8588 <listitem>
8589
8590 <para>
8591 Inside a RULE "<literal>forall</literal>" is treated as a keyword, regardless of
8592 any other flag settings.  Furthermore, inside a RULE, the language extension
8593 <option>-XScopedTypeVariables</option> is automatically enabled; see
8594 <xref linkend="scoped-type-variables"/>.
8595 </para>
8596 </listitem>
8597 <listitem>
8598
8599 <para>
8600 Like other pragmas, RULE pragmas are always checked for scope errors, and
8601 are typechecked. Typechecking means that the LHS and RHS of a rule are typechecked,
8602 and must have the same type.  However, rules are only <emphasis>enabled</emphasis>
8603 if the <option>-fenable-rewrite-rules</option> flag is
8604 on (see <xref linkend="rule-semantics"/>).
8605 </para>
8606 </listitem>
8607 </itemizedlist>
8608
8609 </para>
8610
8611 </sect2>
8612
8613 <sect2 id="rule-semantics">
8614 <title>Semantics</title>
8615
8616 <para>
8617 From a semantic point of view:
8618
8619 <itemizedlist>
8620 <listitem>
8621 <para>
8622 Rules are enabled (that is, used during optimisation)
8623 by the <option>-fenable-rewrite-rules</option> flag.
8624 This flag is implied by <option>-O</option>, and may be switched
8625 off (as usual) by <option>-fno-enable-rewrite-rules</option>.
8626 (NB: enabling <option>-fenable-rewrite-rules</option> without <option>-O</option>
8627 may not do what you expect, though, because without <option>-O</option> GHC
8628 ignores all optimisation information in interface files;
8629 see <option>-fignore-interface-pragmas</option>, <xref linkend="options-f"/>.)
8630 Note that <option>-fenable-rewrite-rules</option> is an <emphasis>optimisation</emphasis> flag, and
8631 has no effect on parsing or typechecking.
8632 </para>
8633 </listitem>
8634
8635 <listitem>
8636 <para>
8637  Rules are regarded as left-to-right rewrite rules.
8638 When GHC finds an expression that is a substitution instance of the LHS
8639 of a rule, it replaces the expression by the (appropriately-substituted) RHS.
8640 By "a substitution instance" we mean that the LHS can be made equal to the
8641 expression by substituting for the pattern variables.
8642
8643 </para>
8644 </listitem>
8645 <listitem>
8646
8647 <para>
8648  GHC makes absolutely no attempt to verify that the LHS and RHS
8649 of a rule have the same meaning.  That is undecidable in general, and
8650 infeasible in most interesting cases.  The responsibility is entirely the programmer's!
8651
8652 </para>
8653 </listitem>
8654 <listitem>
8655
8656 <para>
8657  GHC makes no attempt to make sure that the rules are confluent or
8658 terminating.  For example:
8659
8660 <programlisting>
8661   "loop"        forall x y.  f x y = f y x
8662 </programlisting>
8663
8664 This rule will cause the compiler to go into an infinite loop.
8665
8666 </para>
8667 </listitem>
8668 <listitem>
8669
8670 <para>
8671  If more than one rule matches a call, GHC will choose one arbitrarily to apply.
8672
8673 </para>
8674 </listitem>
8675 <listitem>
8676 <para>
8677  GHC currently uses a very simple, syntactic, matching algorithm
8678 for matching a rule LHS with an expression.  It seeks a substitution
8679 which makes the LHS and expression syntactically equal modulo alpha
8680 conversion.  The pattern (rule), but not the expression, is eta-expanded if
8681 necessary.  (Eta-expanding the expression can lead to laziness bugs.)
8682 But not beta conversion (that's called higher-order matching).
8683 </para>
8684
8685 <para>
8686 Matching is carried out on GHC's intermediate language, which includes
8687 type abstractions and applications.  So a rule only matches if the
8688 types match too.  See <xref linkend="rule-spec"/> below.
8689 </para>
8690 </listitem>
8691 <listitem>
8692
8693 <para>
8694  GHC keeps trying to apply the rules as it optimises the program.
8695 For example, consider:
8696
8697 <programlisting>
8698   let s = map f
8699       t = map g
8700   in
8701   s (t xs)
8702 </programlisting>
8703
8704 The expression <literal>s (t xs)</literal> does not match the rule <literal>"map/map"</literal>, but GHC
8705 will substitute for <varname>s</varname> and <varname>t</varname>, giving an expression which does match.
8706 If <varname>s</varname> or <varname>t</varname> was (a) used more than once, and (b) large or a redex, then it would
8707 not be substituted, and the rule would not fire.
8708
8709 </para>
8710 </listitem>
8711 </itemizedlist>
8712
8713 </para>
8714
8715 </sect2>
8716
8717 <sect2 id="conlike">
8718 <title>How rules interact with INLINE/NOINLINE and CONLIKE pragmas</title>
8719
8720 <para>
8721 Ordinary inlining happens at the same time as rule rewriting, which may lead to unexpected
8722 results.  Consider this (artificial) example
8723 <programlisting>
8724 f x = x
8725 g y = f y
8726 h z = g True
8727
8728 {-# RULES "f" f True = False #-}
8729 </programlisting>
8730 Since <literal>f</literal>'s right-hand side is small, it is inlined into <literal>g</literal>,
8731 to give
8732 <programlisting>
8733 g y = y
8734 </programlisting>
8735 Now <literal>g</literal> is inlined into <literal>h</literal>, but <literal>f</literal>'s RULE has
8736 no chance to fire.
8737 If instead GHC had first inlined <literal>g</literal> into <literal>h</literal> then there
8738 would have been a better chance that <literal>f</literal>'s RULE might fire.
8739 </para>
8740 <para>
8741 The way to get predictable behaviour is to use a NOINLINE
8742 pragma, or an INLINE[<replaceable>phase</replaceable>] pragma, on <literal>f</literal>, to ensure
8743 that it is not inlined until its RULEs have had a chance to fire.
8744 </para>
8745 <para>
8746 GHC is very cautious about duplicating work.  For example, consider
8747 <programlisting>
8748 f k z xs = let xs = build g
8749            in ...(foldr k z xs)...sum xs...
8750 {-# RULES "foldr/build" forall k z g. foldr k z (build g) = g k z #-}
8751 </programlisting>
8752 Since <literal>xs</literal> is used twice, GHC does not fire the foldr/build rule.  Rightly
8753 so, because it might take a lot of work to compute <literal>xs</literal>, which would be
8754 duplicated if the rule fired.
8755 </para>
8756 <para>
8757 Sometimes, however, this approach is over-cautious, and we <emphasis>do</emphasis> want the
8758 rule to fire, even though doing so would duplicate redex.  There is no way that GHC can work out
8759 when this is a good idea, so we provide the CONLIKE pragma to declare it, thus:
8760 <programlisting>
8761 {-# INLINE[1] CONLIKE f #-}
8762 f x = <replaceable>blah</replaceable>
8763 </programlisting>
8764 CONLIKE is a modifier to an INLINE or NOINLINE pragma.  It specifies that an application
8765 of f to one argument (in general, the number of arguments to the left of the '=' sign)
8766 should be considered cheap enough to duplicate, if such a duplication would make rule
8767 fire.  (The name "CONLIKE" is short for "constructor-like", because constructors certainly
8768 have such a property.)
8769 The CONLIKE pragma is a modifier to INLINE/NOINLINE because it really only makes sense to match
8770 <literal>f</literal> on the LHS of a rule if you are sure that <literal>f</literal> is
8771 not going to be inlined before the rule has a chance to fire.
8772 </para>
8773 </sect2>
8774
8775 <sect2>
8776 <title>List fusion</title>
8777
8778 <para>
8779 The RULES mechanism is used to implement fusion (deforestation) of common list functions.
8780 If a "good consumer" consumes an intermediate list constructed by a "good producer", the
8781 intermediate list should be eliminated entirely.
8782 </para>
8783
8784 <para>
8785 The following are good producers:
8786
8787 <itemizedlist>
8788 <listitem>
8789
8790 <para>
8791  List comprehensions
8792 </para>
8793 </listitem>
8794 <listitem>
8795
8796 <para>
8797  Enumerations of <literal>Int</literal> and <literal>Char</literal> (e.g. <literal>['a'..'z']</literal>).
8798 </para>
8799 </listitem>
8800 <listitem>
8801
8802 <para>
8803  Explicit lists (e.g. <literal>[True, False]</literal>)
8804 </para>
8805 </listitem>
8806 <listitem>
8807
8808 <para>
8809  The cons constructor (e.g <literal>3:4:[]</literal>)
8810 </para>
8811 </listitem>
8812 <listitem>
8813
8814 <para>
8815  <function>++</function>
8816 </para>
8817 </listitem>
8818
8819 <listitem>
8820 <para>
8821  <function>map</function>
8822 </para>
8823 </listitem>
8824
8825 <listitem>
8826 <para>
8827 <function>take</function>, <function>filter</function>
8828 </para>
8829 </listitem>
8830 <listitem>
8831
8832 <para>
8833  <function>iterate</function>, <function>repeat</function>
8834 </para>
8835 </listitem>
8836 <listitem>
8837
8838 <para>
8839  <function>zip</function>, <function>zipWith</function>
8840 </para>
8841 </listitem>
8842
8843 </itemizedlist>
8844
8845 </para>
8846
8847 <para>
8848 The following are good consumers:
8849
8850 <itemizedlist>
8851 <listitem>
8852
8853 <para>
8854  List comprehensions
8855 </para>
8856 </listitem>
8857 <listitem>
8858
8859 <para>
8860  <function>array</function> (on its second argument)
8861 </para>
8862 </listitem>
8863 <listitem>
8864
8865 <para>
8866  <function>++</function> (on its first argument)
8867 </para>
8868 </listitem>
8869
8870 <listitem>
8871 <para>
8872  <function>foldr</function>
8873 </para>
8874 </listitem>
8875
8876 <listitem>
8877 <para>
8878  <function>map</function>
8879 </para>
8880 </listitem>
8881 <listitem>
8882
8883 <para>
8884 <function>take</function>, <function>filter</function>
8885 </para>
8886 </listitem>
8887 <listitem>
8888
8889 <para>
8890  <function>concat</function>
8891 </para>
8892 </listitem>
8893 <listitem>
8894
8895 <para>
8896  <function>unzip</function>, <function>unzip2</function>, <function>unzip3</function>, <function>unzip4</function>
8897 </para>
8898 </listitem>
8899 <listitem>
8900
8901 <para>
8902  <function>zip</function>, <function>zipWith</function> (but on one argument only; if both are good producers, <function>zip</function>
8903 will fuse with one but not the other)
8904 </para>
8905 </listitem>
8906 <listitem>
8907
8908 <para>
8909  <function>partition</function>
8910 </para>
8911 </listitem>
8912 <listitem>
8913
8914 <para>
8915  <function>head</function>
8916 </para>
8917 </listitem>
8918 <listitem>
8919
8920 <para>
8921  <function>and</function>, <function>or</function>, <function>any</function>, <function>all</function>
8922 </para>
8923 </listitem>
8924 <listitem>
8925
8926 <para>
8927  <function>sequence&lowbar;</function>
8928 </para>
8929 </listitem>
8930 <listitem>
8931
8932 <para>
8933  <function>msum</function>
8934 </para>
8935 </listitem>
8936 <listitem>
8937
8938 <para>
8939  <function>sortBy</function>
8940 </para>
8941 </listitem>
8942
8943 </itemizedlist>
8944
8945 </para>
8946
8947  <para>
8948 So, for example, the following should generate no intermediate lists:
8949
8950 <programlisting>
8951 array (1,10) [(i,i*i) | i &#60;- map (+ 1) [0..9]]
8952 </programlisting>
8953
8954 </para>
8955
8956 <para>
8957 This list could readily be extended; if there are Prelude functions that you use
8958 a lot which are not included, please tell us.
8959 </para>
8960
8961 <para>
8962 If you want to write your own good consumers or producers, look at the
8963 Prelude definitions of the above functions to see how to do so.
8964 </para>
8965
8966 </sect2>
8967
8968 <sect2 id="rule-spec">
8969 <title>Specialisation
8970 </title>
8971
8972 <para>
8973 Rewrite rules can be used to get the same effect as a feature
8974 present in earlier versions of GHC.
8975 For example, suppose that:
8976
8977 <programlisting>
8978 genericLookup :: Ord a => Table a b   -> a   -> b
8979 intLookup     ::          Table Int b -> Int -> b
8980 </programlisting>
8981
8982 where <function>intLookup</function> is an implementation of
8983 <function>genericLookup</function> that works very fast for
8984 keys of type <literal>Int</literal>.  You might wish
8985 to tell GHC to use <function>intLookup</function> instead of
8986 <function>genericLookup</function> whenever the latter was called with
8987 type <literal>Table Int b -&gt; Int -&gt; b</literal>.
8988 It used to be possible to write
8989
8990 <programlisting>
8991 {-# SPECIALIZE genericLookup :: Table Int b -> Int -> b = intLookup #-}
8992 </programlisting>
8993
8994 This feature is no longer in GHC, but rewrite rules let you do the same thing:
8995
8996 <programlisting>
8997 {-# RULES "genericLookup/Int" genericLookup = intLookup #-}
8998 </programlisting>
8999
9000 This slightly odd-looking rule instructs GHC to replace
9001 <function>genericLookup</function> by <function>intLookup</function>
9002 <emphasis>whenever the types match</emphasis>.
9003 What is more, this rule does not need to be in the same
9004 file as <function>genericLookup</function>, unlike the
9005 <literal>SPECIALIZE</literal> pragmas which currently do (so that they
9006 have an original definition available to specialise).
9007 </para>
9008
9009 <para>It is <emphasis>Your Responsibility</emphasis> to make sure that
9010 <function>intLookup</function> really behaves as a specialised version
9011 of <function>genericLookup</function>!!!</para>
9012
9013 <para>An example in which using <literal>RULES</literal> for
9014 specialisation will Win Big:
9015
9016 <programlisting>
9017 toDouble :: Real a => a -> Double
9018 toDouble = fromRational . toRational
9019
9020 {-# RULES "toDouble/Int" toDouble = i2d #-}
9021 i2d (I# i) = D# (int2Double# i) -- uses Glasgow prim-op directly
9022 </programlisting>
9023
9024 The <function>i2d</function> function is virtually one machine
9025 instruction; the default conversion&mdash;via an intermediate
9026 <literal>Rational</literal>&mdash;is obscenely expensive by
9027 comparison.
9028 </para>
9029
9030 </sect2>
9031
9032 <sect2 id="controlling-rules">
9033 <title>Controlling what's going on in rewrite rules</title>
9034
9035 <para>
9036
9037 <itemizedlist>
9038 <listitem>
9039
9040 <para>
9041 Use <option>-ddump-rules</option> to see the rules that are defined
9042 <emphasis>in this module</emphasis>.
9043 This includes rules generated by the specialisation pass, but excludes
9044 rules imported from other modules.
9045 </para>
9046 </listitem>
9047
9048 <listitem>
9049 <para>
9050  Use <option>-ddump-simpl-stats</option> to see what rules are being fired.
9051 If you add <option>-dppr-debug</option> you get a more detailed listing.
9052 </para>
9053 </listitem>
9054
9055 <listitem>
9056 <para>
9057  Use <option>-ddump-rule-firings</option> or <option>-ddump-rule-rewrites</option>
9058 to see in great detail what rules are being fired.
9059 If you add <option>-dppr-debug</option> you get a still more detailed listing.
9060 </para>
9061 </listitem>
9062
9063 <listitem>
9064 <para>
9065  The definition of (say) <function>build</function> in <filename>GHC/Base.lhs</filename> looks like this:
9066
9067 <programlisting>
9068         build   :: forall a. (forall b. (a -> b -> b) -> b -> b) -> [a]
9069         {-# INLINE build #-}
9070         build g = g (:) []
9071 </programlisting>
9072
9073 Notice the <literal>INLINE</literal>!  That prevents <literal>(:)</literal> from being inlined when compiling
9074 <literal>PrelBase</literal>, so that an importing module will &ldquo;see&rdquo; the <literal>(:)</literal>, and can
9075 match it on the LHS of a rule.  <literal>INLINE</literal> prevents any inlining happening
9076 in the RHS of the <literal>INLINE</literal> thing.  I regret the delicacy of this.
9077
9078 </para>
9079 </listitem>
9080 <listitem>
9081
9082 <para>
9083  In <filename>libraries/base/GHC/Base.lhs</filename> look at the rules for <function>map</function> to
9084 see how to write rules that will do fusion and yet give an efficient
9085 program even if fusion doesn't happen.  More rules in <filename>GHC/List.lhs</filename>.
9086 </para>
9087 </listitem>
9088
9089 </itemizedlist>
9090
9091 </para>
9092
9093 </sect2>
9094
9095 <sect2 id="core-pragma">
9096   <title>CORE pragma</title>
9097
9098   <indexterm><primary>CORE pragma</primary></indexterm>
9099   <indexterm><primary>pragma, CORE</primary></indexterm>
9100   <indexterm><primary>core, annotation</primary></indexterm>
9101
9102 <para>
9103   The external core format supports <quote>Note</quote> annotations;
9104   the <literal>CORE</literal> pragma gives a way to specify what these
9105   should be in your Haskell source code.  Syntactically, core
9106   annotations are attached to expressions and take a Haskell string
9107   literal as an argument.  The following function definition shows an
9108   example:
9109
9110 <programlisting>
9111 f x = ({-# CORE "foo" #-} show) ({-# CORE "bar" #-} x)
9112 </programlisting>
9113
9114   Semantically, this is equivalent to:
9115
9116 <programlisting>
9117 g x = show x
9118 </programlisting>
9119 </para>
9120
9121 <para>
9122   However, when external core is generated (via
9123   <option>-fext-core</option>), there will be Notes attached to the
9124   expressions <function>show</function> and <varname>x</varname>.
9125   The core function declaration for <function>f</function> is:
9126 </para>
9127
9128 <programlisting>
9129   f :: %forall a . GHCziShow.ZCTShow a ->
9130                    a -> GHCziBase.ZMZN GHCziBase.Char =
9131     \ @ a (zddShow::GHCziShow.ZCTShow a) (eta::a) ->
9132         (%note "foo"
9133          %case zddShow %of (tpl::GHCziShow.ZCTShow a)
9134            {GHCziShow.ZCDShow
9135             (tpl1::GHCziBase.Int ->
9136                    a ->
9137                    GHCziBase.ZMZN GHCziBase.Char -> GHCziBase.ZMZN GHCziBase.Cha
9138 r)
9139             (tpl2::a -> GHCziBase.ZMZN GHCziBase.Char)
9140             (tpl3::GHCziBase.ZMZN a ->
9141                    GHCziBase.ZMZN GHCziBase.Char -> GHCziBase.ZMZN GHCziBase.Cha
9142 r) ->
9143               tpl2})
9144         (%note "bar"
9145          eta);
9146 </programlisting>
9147
9148 <para>
9149   Here, we can see that the function <function>show</function> (which
9150   has been expanded out to a case expression over the Show dictionary)
9151   has a <literal>%note</literal> attached to it, as does the
9152   expression <varname>eta</varname> (which used to be called
9153   <varname>x</varname>).
9154 </para>
9155
9156 </sect2>
9157
9158 </sect1>
9159
9160 <sect1 id="special-ids">
9161 <title>Special built-in functions</title>
9162 <para>GHC has a few built-in functions with special behaviour.  These
9163 are now described in the module <ulink
9164 url="&libraryGhcPrimLocation;/GHC-Prim.html"><literal>GHC.Prim</literal></ulink>
9165 in the library documentation.
9166 In particular:
9167 <itemizedlist>
9168 <listitem><para>
9169 <ulink url="&libraryGhcPrimLocation;/GHC-Prim.html#v%3Ainline"><literal>inline</literal></ulink>
9170 allows control over inlining on a per-call-site basis.
9171 </para></listitem>
9172 <listitem><para>
9173 <ulink url="&libraryGhcPrimLocation;/GHC-Prim.html#v%3Alazy"><literal>lazy</literal></ulink>
9174 restrains the strictness analyser.
9175 </para></listitem>
9176 <listitem><para>
9177 <ulink url="&libraryGhcPrimLocation;/GHC-Prim.html#v%3AunsafeCoerce%23"><literal>unsafeCoerce#</literal></ulink>
9178 allows you to fool the type checker.
9179 </para></listitem>
9180 </itemizedlist>
9181 </para>
9182 </sect1>
9183
9184
9185 <sect1 id="generic-classes">
9186 <title>Generic classes</title>
9187
9188 <para>
9189 GHC used to have an implementation of generic classes as defined in the paper
9190 "Derivable type classes", Ralf Hinze and Simon Peyton Jones, Haskell Workshop,
9191 Montreal Sept 2000, pp94-105. These have been removed and replaced by the more
9192 general <link linkend="generic-programming">support for generic programming</link>.
9193 </para>
9194
9195 </sect1>
9196
9197
9198 <sect1 id="generic-programming">
9199 <title>Generic programming</title>
9200
9201 <para>
9202 Using a combination of <option>-XDeriveGeneric</option>
9203 (<xref linkend="deriving-typeable"/>) and
9204 <option>-XDefaultSignatures</option> (<xref linkend="class-default-signatures"/>),
9205 you can easily do datatype-generic
9206 programming using the <literal>GHC.Generics</literal> framework. This section
9207 gives a very brief overview of how to do it. For more detail please refer to the
9208 <ulink url="http://www.haskell.org/haskellwiki/Generics">HaskellWiki page</ulink>
9209 or the original paper:
9210 </para>
9211
9212 <itemizedlist>
9213 <listitem>
9214 <para>
9215 Jos� Pedro Magalh�es, Atze Dijkstra, Johan Jeuring, and Andres L�h.
9216 <ulink url="http://dreixel.net/research/pdf/gdmh.pdf">
9217   A generic deriving mechanism for Haskell</ulink>.
9218 <citetitle>Proceedings of the third ACM Haskell symposium on Haskell</citetitle>
9219 (Haskell'2010), pp. 37-48, ACM, 2010.
9220 </para>
9221 </listitem>
9222 </itemizedlist>
9223
9224 <emphasis>Note</emphasis>: the current support for generic programming in GHC
9225 is preliminary. In particular, we only allow deriving instances for the
9226 <literal>Generic</literal> class. Support for deriving
9227 <literal>Generic1</literal> (and thus enabling generic functions of kind
9228 <literal>* -> *</literal> such as <literal>fmap</literal>) will come at a
9229 later stage.
9230
9231
9232 <sect2>
9233 <title>Deriving representations</title>
9234
9235 <para>
9236 The first thing we need is generic representations. The
9237 <literal>GHC.Generics</literal> module defines a couple of primitive types
9238 that can be used to represent most Haskell datatypes:
9239
9240 <programlisting>
9241 -- | Unit: used for constructors without arguments
9242 data U1 p = U1
9243
9244 -- | Constants, additional parameters and recursion of kind *
9245 newtype K1 i c p = K1 { unK1 :: c }
9246
9247 -- | Meta-information (constructor names, etc.)
9248 newtype M1 i c f p = M1 { unM1 :: f p }
9249
9250 -- | Sums: encode choice between constructors
9251 infixr 5 :+:
9252 data (:+:) f g p = L1 (f p) | R1 (g p)
9253
9254 -- | Products: encode multiple arguments to constructors
9255 infixr 6 :*:
9256 data (:*:) f g p = f p :*: g p
9257 </programlisting>
9258
9259 For example, a user-defined datatype of trees <literal>data UserTree a = Node a
9260 (UserTree a) (UserTree a) | Leaf</literal> gets the following representation:
9261
9262 <programlisting>
9263 instance Generic (UserTree a) where
9264   -- Representation type
9265   type Rep (UserTree a) =
9266     M1 D D1UserTree (
9267           M1 C C1_0UserTree (
9268                 M1 S NoSelector (K1 P a)
9269             :*: M1 S NoSelector (K1 R (UserTree a))
9270             :*: M1 S NoSelector (K1 R (UserTree a)))
9271       :+: M1 C C1_1UserTree U1)
9272
9273   -- Conversion functions
9274   from (Node x l r) = M1 (L1 (M1 (M1 (K1 x) :*: M1 (K1 l) :*: M1 (K1 r))))
9275   from Leaf         = M1 (R1 (M1 U1))
9276   to (M1 (L1 (M1 (M1 (K1 x) :*: M1 (K1 l) :*: M1 (K1 r))))) = Node x l r
9277   to (M1 (R1 (M1 U1)))                                      = Leaf
9278
9279 -- Meta-information
9280 data D1UserTree
9281 data C1_0UserTree
9282 data C1_1UserTree
9283
9284 instance Datatype D1UserTree where
9285   datatypeName _ = "UserTree"
9286   moduleName _   = "Main"
9287
9288 instance Constructor C1_0UserTree where
9289   conName _ = "Node"
9290
9291 instance Constructor C1_1UserTree where
9292   conName _ = "Leaf"
9293 </programlisting>
9294
9295 This representation is generated automatically if a
9296 <literal>deriving Generic</literal> clause is attached to the datatype.
9297 <link linkend="stand-alone-deriving">Standalone deriving</link> can also be
9298 used.
9299 </para>
9300 </sect2>
9301
9302 <sect2>
9303 <title>Writing generic functions</title>
9304
9305 <para>
9306 A generic function is defined by creating a class and giving instances for
9307 each of the representation types of <literal>GHC.Generics</literal>. As an
9308 example we show generic serialization:
9309 <programlisting>
9310 data Bin = O | I
9311
9312 class GSerialize f where
9313   gput :: f a -> [Bin]
9314
9315 instance GSerialize U1 where
9316   gput U1 = []
9317
9318 instance (GSerialize a, GSerialize b) => GSerialize (a :*: b) where
9319   gput (a :*: b) = gput a ++ gput b
9320
9321 instance (GSerialize a, GSerialize b) => GSerialize (a :+: b) where
9322   gput (L1 x) = O : gput x
9323   gput (R1 x) = I : gput x
9324
9325 instance (GSerialize a) => GSerialize (M1 i c a) where
9326   gput (M1 x) = gput x
9327
9328 instance (Serialize a) => GSerialize (K1 i c a) where
9329   gput (K1 x) = put x
9330 </programlisting>
9331
9332 Typically this class will not be exported, as it only makes sense to have
9333 instances for the representation types.
9334 </para>
9335 </sect2>
9336
9337 <sect2>
9338 <title>Generic defaults</title>
9339
9340 <para>
9341 The only thing left to do now is to define a "front-end" class, which is
9342 exposed to the user:
9343 <programlisting>
9344 class Serialize a where
9345   put :: a -> [Bin]
9346
9347   default put :: (Generic a, GSerialize (Rep a)) => a -> [Bit]
9348   put = gput . from
9349 </programlisting>
9350 Here we use a <link linkend="class-default-signatures">default signature</link>
9351 to specify that the user does not have to provide an implementation for
9352 <literal>put</literal>, as long as there is a <literal>Generic</literal>
9353 instance for the type to instantiate. For the <literal>UserTree</literal> type,
9354 for instance, the user can just write:
9355
9356 <programlisting>
9357 instance (Serialize a) => Serialize (UserTree a)
9358 </programlisting>
9359
9360 The default method for <literal>put</literal> is then used, corresponding to the
9361 generic implementation of serialization.
9362 </para>
9363 </sect2>
9364
9365 </sect1>
9366
9367
9368 <sect1 id="monomorphism">
9369 <title>Control over monomorphism</title>
9370
9371 <para>GHC supports two flags that control the way in which generalisation is
9372 carried out at let and where bindings.
9373 </para>
9374
9375 <sect2>
9376 <title>Switching off the dreaded Monomorphism Restriction</title>
9377           <indexterm><primary><option>-XNoMonomorphismRestriction</option></primary></indexterm>
9378
9379 <para>Haskell's monomorphism restriction (see
9380 <ulink url="http://www.haskell.org/onlinereport/decls.html#sect4.5.5">Section
9381 4.5.5</ulink>
9382 of the Haskell Report)
9383 can be completely switched off by
9384 <option>-XNoMonomorphismRestriction</option>.
9385 </para>
9386 </sect2>
9387
9388 <sect2>
9389 <title>Monomorphic pattern bindings</title>
9390           <indexterm><primary><option>-XNoMonoPatBinds</option></primary></indexterm>
9391           <indexterm><primary><option>-XMonoPatBinds</option></primary></indexterm>
9392
9393           <para> As an experimental change, we are exploring the possibility of
9394           making pattern bindings monomorphic; that is, not generalised at all.
9395             A pattern binding is a binding whose LHS has no function arguments,
9396             and is not a simple variable.  For example:
9397 <programlisting>
9398   f x = x                    -- Not a pattern binding
9399   f = \x -> x                -- Not a pattern binding
9400   f :: Int -> Int = \x -> x  -- Not a pattern binding
9401
9402   (g,h) = e                  -- A pattern binding
9403   (f) = e                    -- A pattern binding
9404   [x] = e                    -- A pattern binding
9405 </programlisting>
9406 Experimentally, GHC now makes pattern bindings monomorphic <emphasis>by
9407 default</emphasis>.  Use <option>-XNoMonoPatBinds</option> to recover the
9408 standard behaviour.
9409 </para>
9410 </sect2>
9411 </sect1>
9412
9413
9414
9415 <!-- Emacs stuff:
9416      ;;; Local Variables: ***
9417      ;;; sgml-parent-document: ("users_guide.xml" "book" "chapter" "sect1") ***
9418      ;;; ispell-local-dictionary: "british" ***
9419      ;;; End: ***
9420  -->
9421