Add 'rec' to stmts in a 'do', and deprecate 'mdo'
[ghc-hetmet.git] / 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 are all enabled by options; by default GHC
7 understands only plain Haskell 98.
8 </para>
9
10 <para>
11 Some of the Glasgow extensions serve to give you access to the
12 underlying facilities with which we implement Haskell.  Thus, you can
13 get at the Raw Iron, if you are willing to write some non-portable
14 code at a more primitive level.  You need not be &ldquo;stuck&rdquo;
15 on performance because of the implementation costs of Haskell's
16 &ldquo;high-level&rdquo; features&mdash;you can always code
17 &ldquo;under&rdquo; them.  In an extreme case, you can write all your
18 time-critical code in C, and then just glue it together with Haskell!
19 </para>
20
21 <para>
22 Before you get too carried away working at the lowest level (e.g.,
23 sloshing <literal>MutableByteArray&num;</literal>s around your
24 program), you may wish to check if there are libraries that provide a
25 &ldquo;Haskellised veneer&rdquo; over the features you want.  The
26 separate <ulink url="../libraries/index.html">libraries
27 documentation</ulink> describes all the libraries that come with GHC.
28 </para>
29
30 <!-- LANGUAGE OPTIONS -->
31   <sect1 id="options-language">
32     <title>Language options</title>
33
34     <indexterm><primary>language</primary><secondary>option</secondary>
35     </indexterm>
36     <indexterm><primary>options</primary><secondary>language</secondary>
37     </indexterm>
38     <indexterm><primary>extensions</primary><secondary>options controlling</secondary>
39     </indexterm>
40
41     <para>The language option flags control what variation of the language are
42     permitted.  Leaving out all of them gives you standard Haskell
43     98.</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           <option>-XPrintExplicitForalls</option>,
60           <option>-XForeignFunctionInterface</option>,
61           <option>-XUnliftedFFITypes</option>,
62           <option>-XGADTs</option>,
63           <option>-XImplicitParams</option>,
64           <option>-XScopedTypeVariables</option>,
65           <option>-XUnboxedTuples</option>,
66           <option>-XTypeSynonymInstances</option>,
67           <option>-XStandaloneDeriving</option>,
68           <option>-XDeriveDataTypeable</option>,
69           <option>-XFlexibleContexts</option>,
70           <option>-XFlexibleInstances</option>,
71           <option>-XConstrainedClassMethods</option>,
72           <option>-XMultiParamTypeClasses</option>,
73           <option>-XFunctionalDependencies</option>,
74           <option>-XMagicHash</option>,
75           <option>-XPolymorphicComponents</option>,
76           <option>-XExistentialQuantification</option>,
77           <option>-XUnicodeSyntax</option>,
78           <option>-XPostfixOperators</option>,
79           <option>-XPatternGuards</option>,
80           <option>-XLiberalTypeSynonyms</option>,
81           <option>-XExplicitForAll</option>,
82           <option>-XRankNTypes</option>,
83           <option>-XImpredicativeTypes</option>,
84           <option>-XTypeOperators</option>,
85           <option>-XDoRec</option>,
86           <option>-XParallelListComp</option>,
87           <option>-XEmptyDataDecls</option>,
88           <option>-XKindSignatures</option>,
89           <option>-XGeneralizedNewtypeDeriving</option>,
90           <option>-XTypeFamilies</option>.
91             Enabling these options is the <emphasis>only</emphasis> 
92             effect of <option>-fglasgow-exts</option>.
93           We are trying to move away from this portmanteau flag, 
94           and towards enabling features individually.</para>
95
96   </sect1>
97
98 <!-- UNBOXED TYPES AND PRIMITIVE OPERATIONS -->
99 <sect1 id="primitives">
100   <title>Unboxed types and primitive operations</title>
101
102 <para>GHC is built on a raft of primitive data types and operations;
103 "primitive" in the sense that they cannot be defined in Haskell itself.
104 While you really can use this stuff to write fast code,
105   we generally find it a lot less painful, and more satisfying in the
106   long run, to use higher-level language features and libraries.  With
107   any luck, the code you write will be optimised to the efficient
108   unboxed version in any case.  And if it isn't, we'd like to know
109   about it.</para>
110
111 <para>All these primitive data types and operations are exported by the 
112 library <literal>GHC.Prim</literal>, for which there is 
113 <ulink url="../libraries/ghc-prim/GHC-Prim.html">detailed online documentation</ulink>.
114 (This documentation is generated from the file <filename>compiler/prelude/primops.txt.pp</filename>.)
115 </para>
116 <para>
117 If you want to mention any of the primitive data types or operations in your
118 program, you must first import <literal>GHC.Prim</literal> to bring them
119 into scope.  Many of them have names ending in "&num;", and to mention such
120 names you need the <option>-XMagicHash</option> extension (<xref linkend="magic-hash"/>).
121 </para>
122
123 <para>The primops make extensive use of <link linkend="glasgow-unboxed">unboxed types</link> 
124 and <link linkend="unboxed-tuples">unboxed tuples</link>, which
125 we briefly summarise here. </para>
126   
127 <sect2 id="glasgow-unboxed">
128 <title>Unboxed types
129 </title>
130
131 <para>
132 <indexterm><primary>Unboxed types (Glasgow extension)</primary></indexterm>
133 </para>
134
135 <para>Most types in GHC are <firstterm>boxed</firstterm>, which means
136 that values of that type are represented by a pointer to a heap
137 object.  The representation of a Haskell <literal>Int</literal>, for
138 example, is a two-word heap object.  An <firstterm>unboxed</firstterm>
139 type, however, is represented by the value itself, no pointers or heap
140 allocation are involved.
141 </para>
142
143 <para>
144 Unboxed types correspond to the &ldquo;raw machine&rdquo; types you
145 would use in C: <literal>Int&num;</literal> (long int),
146 <literal>Double&num;</literal> (double), <literal>Addr&num;</literal>
147 (void *), etc.  The <emphasis>primitive operations</emphasis>
148 (PrimOps) on these types are what you might expect; e.g.,
149 <literal>(+&num;)</literal> is addition on
150 <literal>Int&num;</literal>s, and is the machine-addition that we all
151 know and love&mdash;usually one instruction.
152 </para>
153
154 <para>
155 Primitive (unboxed) types cannot be defined in Haskell, and are
156 therefore built into the language and compiler.  Primitive types are
157 always unlifted; that is, a value of a primitive type cannot be
158 bottom.  We use the convention (but it is only a convention) 
159 that primitive types, values, and
160 operations have a <literal>&num;</literal> suffix (see <xref linkend="magic-hash"/>).
161 For some primitive types we have special syntax for literals, also
162 described in the <link linkend="magic-hash">same section</link>.
163 </para>
164
165 <para>
166 Primitive values are often represented by a simple bit-pattern, such
167 as <literal>Int&num;</literal>, <literal>Float&num;</literal>,
168 <literal>Double&num;</literal>.  But this is not necessarily the case:
169 a primitive value might be represented by a pointer to a
170 heap-allocated object.  Examples include
171 <literal>Array&num;</literal>, the type of primitive arrays.  A
172 primitive array is heap-allocated because it is too big a value to fit
173 in a register, and would be too expensive to copy around; in a sense,
174 it is accidental that it is represented by a pointer.  If a pointer
175 represents a primitive value, then it really does point to that value:
176 no unevaluated thunks, no indirections&hellip;nothing can be at the
177 other end of the pointer than the primitive value.
178 A numerically-intensive program using unboxed types can
179 go a <emphasis>lot</emphasis> faster than its &ldquo;standard&rdquo;
180 counterpart&mdash;we saw a threefold speedup on one example.
181 </para>
182
183 <para>
184 There are some restrictions on the use of primitive types:
185 <itemizedlist>
186 <listitem><para>The main restriction
187 is that you can't pass a primitive value to a polymorphic
188 function or store one in a polymorphic data type.  This rules out
189 things like <literal>[Int&num;]</literal> (i.e. lists of primitive
190 integers).  The reason for this restriction is that polymorphic
191 arguments and constructor fields are assumed to be pointers: if an
192 unboxed integer is stored in one of these, the garbage collector would
193 attempt to follow it, leading to unpredictable space leaks.  Or a
194 <function>seq</function> operation on the polymorphic component may
195 attempt to dereference the pointer, with disastrous results.  Even
196 worse, the unboxed value might be larger than a pointer
197 (<literal>Double&num;</literal> for instance).
198 </para>
199 </listitem>
200 <listitem><para> You cannot define a newtype whose representation type
201 (the argument type of the data constructor) is an unboxed type.  Thus,
202 this is illegal:
203 <programlisting>
204   newtype A = MkA Int#
205 </programlisting>
206 </para></listitem>
207 <listitem><para> You cannot bind a variable with an unboxed type
208 in a <emphasis>top-level</emphasis> binding.
209 </para></listitem>
210 <listitem><para> You cannot bind a variable with an unboxed type
211 in a <emphasis>recursive</emphasis> binding.
212 </para></listitem>
213 <listitem><para> You may bind unboxed variables in a (non-recursive,
214 non-top-level) pattern binding, but you must make any such pattern-match
215 strict.  For example, rather than:
216 <programlisting>
217   data Foo = Foo Int Int#
218
219   f x = let (Foo a b, w) = ..rhs.. in ..body..
220 </programlisting>
221 you must write:
222 <programlisting>
223   data Foo = Foo Int Int#
224
225   f x = let !(Foo a b, w) = ..rhs.. in ..body..
226 </programlisting>
227 since <literal>b</literal> has type <literal>Int#</literal>.
228 </para>
229 </listitem>
230 </itemizedlist>
231 </para>
232
233 </sect2>
234
235 <sect2 id="unboxed-tuples">
236 <title>Unboxed Tuples
237 </title>
238
239 <para>
240 Unboxed tuples aren't really exported by <literal>GHC.Exts</literal>,
241 they're available by default with <option>-fglasgow-exts</option>.  An
242 unboxed tuple looks like this:
243 </para>
244
245 <para>
246
247 <programlisting>
248 (# e_1, ..., e_n #)
249 </programlisting>
250
251 </para>
252
253 <para>
254 where <literal>e&lowbar;1..e&lowbar;n</literal> are expressions of any
255 type (primitive or non-primitive).  The type of an unboxed tuple looks
256 the same.
257 </para>
258
259 <para>
260 Unboxed tuples are used for functions that need to return multiple
261 values, but they avoid the heap allocation normally associated with
262 using fully-fledged tuples.  When an unboxed tuple is returned, the
263 components are put directly into registers or on the stack; the
264 unboxed tuple itself does not have a composite representation.  Many
265 of the primitive operations listed in <literal>primops.txt.pp</literal> return unboxed
266 tuples.
267 In particular, the <literal>IO</literal> and <literal>ST</literal> monads use unboxed
268 tuples to avoid unnecessary allocation during sequences of operations.
269 </para>
270
271 <para>
272 There are some pretty stringent restrictions on the use of unboxed tuples:
273 <itemizedlist>
274 <listitem>
275
276 <para>
277 Values of unboxed tuple types are subject to the same restrictions as
278 other unboxed types; i.e. they may not be stored in polymorphic data
279 structures or passed to polymorphic functions.
280
281 </para>
282 </listitem>
283 <listitem>
284
285 <para>
286 No variable can have an unboxed tuple type, nor may a constructor or function
287 argument have an unboxed tuple type.  The following are all illegal:
288
289
290 <programlisting>
291   data Foo = Foo (# Int, Int #)
292
293   f :: (# Int, Int #) -&#62; (# Int, Int #)
294   f x = x
295
296   g :: (# Int, Int #) -&#62; Int
297   g (# a,b #) = a
298
299   h x = let y = (# x,x #) in ...
300 </programlisting>
301 </para>
302 </listitem>
303 </itemizedlist>
304 </para>
305 <para>
306 The typical use of unboxed tuples is simply to return multiple values,
307 binding those multiple results with a <literal>case</literal> expression, thus:
308 <programlisting>
309   f x y = (# x+1, y-1 #)
310   g x = case f x x of { (# a, b #) -&#62; a + b }
311 </programlisting>
312 You can have an unboxed tuple in a pattern binding, thus
313 <programlisting>
314   f x = let (# p,q #) = h x in ..body..
315 </programlisting>
316 If the types of <literal>p</literal> and <literal>q</literal> are not unboxed,
317 the resulting binding is lazy like any other Haskell pattern binding.  The 
318 above example desugars like this:
319 <programlisting>
320   f x = let t = case h x o f{ (# p,q #) -> (p,q)
321             p = fst t
322             q = snd t
323         in ..body..
324 </programlisting>
325 Indeed, the bindings can even be recursive.
326 </para>
327
328 </sect2>
329 </sect1>
330
331
332 <!-- ====================== SYNTACTIC EXTENSIONS =======================  -->
333
334 <sect1 id="syntax-extns">
335 <title>Syntactic extensions</title>
336  
337     <sect2 id="unicode-syntax">
338       <title>Unicode syntax</title>
339       <para>The language
340       extension <option>-XUnicodeSyntax</option><indexterm><primary><option>-XUnicodeSyntax</option></primary></indexterm>
341       enables Unicode characters to be used to stand for certain ASCII
342       character sequences.  The following alternatives are provided:</para>
343
344       <informaltable>
345         <tgroup cols="2" align="left" colsep="1" rowsep="1">
346           <thead>
347             <row>
348               <entry>ASCII</entry>
349               <entry>Unicode alternative</entry>
350               <entry>Code point</entry>
351               <entry>Name</entry>
352             </row>
353           </thead>
354           <tbody>
355             <row>
356               <entry><literal>::</literal></entry>
357               <entry>::</entry> <!-- no special char, apparently -->
358               <entry>0x2237</entry>
359               <entry>PROPORTION</entry>
360             </row>
361           </tbody>
362           <tbody>
363             <row>
364               <entry><literal>=&gt;</literal></entry>
365               <entry>&rArr;</entry>
366               <entry>0x21D2</entry>
367               <entry>RIGHTWARDS DOUBLE ARROW</entry>
368             </row>
369           </tbody>
370           <tbody>
371             <row>
372               <entry><literal>forall</literal></entry>
373               <entry>&forall;</entry>
374               <entry>0x2200</entry>
375               <entry>FOR ALL</entry>
376             </row>
377           </tbody>
378           <tbody>
379             <row>
380               <entry><literal>-&gt;</literal></entry>
381               <entry>&rarr;</entry>
382               <entry>0x2192</entry>
383               <entry>RIGHTWARDS ARROW</entry>
384             </row>
385           </tbody>
386           <tbody>
387             <row>
388               <entry><literal>&lt;-</literal></entry>
389               <entry>&larr;</entry>
390               <entry>0x2190</entry>
391               <entry>LEFTWARDS ARROW</entry>
392             </row>
393           </tbody>
394           <tbody>
395             <row>
396               <entry>..</entry>
397               <entry>&hellip;</entry>
398               <entry>0x22EF</entry>
399               <entry>MIDLINE HORIZONTAL ELLIPSIS</entry>
400             </row>
401           </tbody>
402         </tgroup>
403       </informaltable>
404     </sect2>
405
406     <sect2 id="magic-hash">
407       <title>The magic hash</title>
408       <para>The language extension <option>-XMagicHash</option> allows "&num;" as a
409         postfix modifier to identifiers.  Thus, "x&num;" is a valid variable, and "T&num;" is
410         a valid type constructor or data constructor.</para>
411
412       <para>The hash sign does not change sematics at all.  We tend to use variable
413         names ending in "&num;" for unboxed values or types (e.g. <literal>Int&num;</literal>), 
414         but there is no requirement to do so; they are just plain ordinary variables.
415         Nor does the <option>-XMagicHash</option> extension bring anything into scope.
416         For example, to bring <literal>Int&num;</literal> into scope you must 
417         import <literal>GHC.Prim</literal> (see <xref linkend="primitives"/>); 
418         the <option>-XMagicHash</option> extension
419         then allows you to <emphasis>refer</emphasis> to the <literal>Int&num;</literal>
420         that is now in scope.</para>
421       <para> The <option>-XMagicHash</option> also enables some new forms of literals (see <xref linkend="glasgow-unboxed"/>):
422         <itemizedlist> 
423           <listitem><para> <literal>'x'&num;</literal> has type <literal>Char&num;</literal></para> </listitem>
424           <listitem><para> <literal>&quot;foo&quot;&num;</literal> has type <literal>Addr&num;</literal></para> </listitem>
425           <listitem><para> <literal>3&num;</literal> has type <literal>Int&num;</literal>. In general,
426           any Haskell 98 integer lexeme followed by a <literal>&num;</literal> is an <literal>Int&num;</literal> literal, e.g.
427             <literal>-0x3A&num;</literal> as well as <literal>32&num;</literal></para>.</listitem>
428           <listitem><para> <literal>3&num;&num;</literal> has type <literal>Word&num;</literal>. In general,
429           any non-negative Haskell 98 integer lexeme followed by <literal>&num;&num;</literal> 
430               is a <literal>Word&num;</literal>. </para> </listitem>
431           <listitem><para> <literal>3.2&num;</literal> has type <literal>Float&num;</literal>.</para> </listitem>
432           <listitem><para> <literal>3.2&num;&num;</literal> has type <literal>Double&num;</literal></para> </listitem>
433           </itemizedlist>
434       </para>
435    </sect2>
436
437     <sect2 id="new-qualified-operators">
438       <title>New qualified operator syntax</title>
439
440       <para>A new syntax for referencing qualified operators is
441         planned to be introduced by Haskell', and is enabled in GHC
442         with
443         the <option>-XNewQualifiedOperators</option><indexterm><primary><option>-XNewQualifiedOperators</option></primary></indexterm>
444         option.  In the new syntax, the prefix form of a qualified
445         operator is
446         written <literal><replaceable>module</replaceable>.(<replaceable>symbol</replaceable>)</literal>
447         (in Haskell 98 this would
448         be <literal>(<replaceable>module</replaceable>.<replaceable>symbol</replaceable>)</literal>),
449         and the infix form is
450         written <literal>`<replaceable>module</replaceable>.(<replaceable>symbol</replaceable>)`</literal>
451         (in Haskell 98 this would
452         be <literal>`<replaceable>module</replaceable>.<replaceable>symbol</replaceable>`</literal>.
453         For example:
454 <programlisting>
455   add x y = Prelude.(+) x y
456   subtract y = (`Prelude.(-)` y)
457 </programlisting>
458         The new form of qualified operators is intended to regularise
459         the syntax by eliminating odd cases
460         like <literal>Prelude..</literal>.  For example,
461         when <literal>NewQualifiedOperators</literal> is on, it is possible to
462         write the enumerated sequence <literal>[Monday..]</literal>
463         without spaces, whereas in Haskell 98 this would be a
464         reference to the operator &lsquo;<literal>.</literal>&lsquo;
465         from module <literal>Monday</literal>.</para>
466
467       <para>When <option>-XNewQualifiedOperators</option> is on, the old Haskell
468         98 syntax for qualified operators is not accepted, so this
469         option may cause existing Haskell 98 code to break.</para>
470
471     </sect2>
472         
473
474     <!-- ====================== HIERARCHICAL MODULES =======================  -->
475
476
477     <sect2 id="hierarchical-modules">
478       <title>Hierarchical Modules</title>
479
480       <para>GHC supports a small extension to the syntax of module
481       names: a module name is allowed to contain a dot
482       <literal>&lsquo;.&rsquo;</literal>.  This is also known as the
483       &ldquo;hierarchical module namespace&rdquo; extension, because
484       it extends the normally flat Haskell module namespace into a
485       more flexible hierarchy of modules.</para>
486
487       <para>This extension has very little impact on the language
488       itself; modules names are <emphasis>always</emphasis> fully
489       qualified, so you can just think of the fully qualified module
490       name as <quote>the module name</quote>.  In particular, this
491       means that the full module name must be given after the
492       <literal>module</literal> keyword at the beginning of the
493       module; for example, the module <literal>A.B.C</literal> must
494       begin</para>
495
496 <programlisting>module A.B.C</programlisting>
497
498
499       <para>It is a common strategy to use the <literal>as</literal>
500       keyword to save some typing when using qualified names with
501       hierarchical modules.  For example:</para>
502
503 <programlisting>
504 import qualified Control.Monad.ST.Strict as ST
505 </programlisting>
506
507       <para>For details on how GHC searches for source and interface
508       files in the presence of hierarchical modules, see <xref
509       linkend="search-path"/>.</para>
510
511       <para>GHC comes with a large collection of libraries arranged
512       hierarchically; see the accompanying <ulink
513       url="../libraries/index.html">library
514       documentation</ulink>.  More libraries to install are available
515       from <ulink
516       url="http://hackage.haskell.org/packages/hackage.html">HackageDB</ulink>.</para>
517     </sect2>
518
519     <!-- ====================== PATTERN GUARDS =======================  -->
520
521 <sect2 id="pattern-guards">
522 <title>Pattern guards</title>
523
524 <para>
525 <indexterm><primary>Pattern guards (Glasgow extension)</primary></indexterm>
526 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.)
527 </para>
528
529 <para>
530 Suppose we have an abstract data type of finite maps, with a
531 lookup operation:
532
533 <programlisting>
534 lookup :: FiniteMap -> Int -> Maybe Int
535 </programlisting>
536
537 The lookup returns <function>Nothing</function> if the supplied key is not in the domain of the mapping, and <function>(Just v)</function> otherwise,
538 where <varname>v</varname> is the value that the key maps to.  Now consider the following definition:
539 </para>
540
541 <programlisting>
542 clunky env var1 var2 | ok1 &amp;&amp; ok2 = val1 + val2
543 | otherwise  = var1 + var2
544 where
545   m1 = lookup env var1
546   m2 = lookup env var2
547   ok1 = maybeToBool m1
548   ok2 = maybeToBool m2
549   val1 = expectJust m1
550   val2 = expectJust m2
551 </programlisting>
552
553 <para>
554 The auxiliary functions are 
555 </para>
556
557 <programlisting>
558 maybeToBool :: Maybe a -&gt; Bool
559 maybeToBool (Just x) = True
560 maybeToBool Nothing  = False
561
562 expectJust :: Maybe a -&gt; a
563 expectJust (Just x) = x
564 expectJust Nothing  = error "Unexpected Nothing"
565 </programlisting>
566
567 <para>
568 What is <function>clunky</function> doing? The guard <literal>ok1 &amp;&amp;
569 ok2</literal> checks that both lookups succeed, using
570 <function>maybeToBool</function> to convert the <function>Maybe</function>
571 types to booleans. The (lazily evaluated) <function>expectJust</function>
572 calls extract the values from the results of the lookups, and binds the
573 returned values to <varname>val1</varname> and <varname>val2</varname>
574 respectively.  If either lookup fails, then clunky takes the
575 <literal>otherwise</literal> case and returns the sum of its arguments.
576 </para>
577
578 <para>
579 This is certainly legal Haskell, but it is a tremendously verbose and
580 un-obvious way to achieve the desired effect.  Arguably, a more direct way
581 to write clunky would be to use case expressions:
582 </para>
583
584 <programlisting>
585 clunky env var1 var2 = case lookup env var1 of
586   Nothing -&gt; fail
587   Just val1 -&gt; case lookup env var2 of
588     Nothing -&gt; fail
589     Just val2 -&gt; val1 + val2
590 where
591   fail = var1 + var2
592 </programlisting>
593
594 <para>
595 This is a bit shorter, but hardly better.  Of course, we can rewrite any set
596 of pattern-matching, guarded equations as case expressions; that is
597 precisely what the compiler does when compiling equations! The reason that
598 Haskell provides guarded equations is because they allow us to write down
599 the cases we want to consider, one at a time, independently of each other. 
600 This structure is hidden in the case version.  Two of the right-hand sides
601 are really the same (<function>fail</function>), and the whole expression
602 tends to become more and more indented. 
603 </para>
604
605 <para>
606 Here is how I would write clunky:
607 </para>
608
609 <programlisting>
610 clunky env var1 var2
611   | Just val1 &lt;- lookup env var1
612   , Just val2 &lt;- lookup env var2
613   = val1 + val2
614 ...other equations for clunky...
615 </programlisting>
616
617 <para>
618 The semantics should be clear enough.  The qualifiers are matched in order. 
619 For a <literal>&lt;-</literal> qualifier, which I call a pattern guard, the
620 right hand side is evaluated and matched against the pattern on the left. 
621 If the match fails then the whole guard fails and the next equation is
622 tried.  If it succeeds, then the appropriate binding takes place, and the
623 next qualifier is matched, in the augmented environment.  Unlike list
624 comprehensions, however, the type of the expression to the right of the
625 <literal>&lt;-</literal> is the same as the type of the pattern to its
626 left.  The bindings introduced by pattern guards scope over all the
627 remaining guard qualifiers, and over the right hand side of the equation.
628 </para>
629
630 <para>
631 Just as with list comprehensions, boolean expressions can be freely mixed
632 with among the pattern guards.  For example:
633 </para>
634
635 <programlisting>
636 f x | [y] &lt;- x
637     , y > 3
638     , Just z &lt;- h y
639     = ...
640 </programlisting>
641
642 <para>
643 Haskell's current guards therefore emerge as a special case, in which the
644 qualifier list has just one element, a boolean expression.
645 </para>
646 </sect2>
647
648     <!-- ===================== View patterns ===================  -->
649
650 <sect2 id="view-patterns">
651 <title>View patterns
652 </title>
653
654 <para>
655 View patterns are enabled by the flag <literal>-XViewPatterns</literal>.
656 More information and examples of view patterns can be found on the
657 <ulink url="http://hackage.haskell.org/trac/ghc/wiki/ViewPatterns">Wiki
658 page</ulink>.
659 </para>
660
661 <para>
662 View patterns are somewhat like pattern guards that can be nested inside
663 of other patterns.  They are a convenient way of pattern-matching
664 against values of abstract types. For example, in a programming language
665 implementation, we might represent the syntax of the types of the
666 language as follows:
667
668 <programlisting>
669 type Typ
670  
671 data TypView = Unit
672              | Arrow Typ Typ
673
674 view :: Type -> TypeView
675
676 -- additional operations for constructing Typ's ...
677 </programlisting>
678
679 The representation of Typ is held abstract, permitting implementations
680 to use a fancy representation (e.g., hash-consing to manage sharing).
681
682 Without view patterns, using this signature a little inconvenient: 
683 <programlisting>
684 size :: Typ -> Integer
685 size t = case view t of
686   Unit -> 1
687   Arrow t1 t2 -> size t1 + size t2
688 </programlisting>
689
690 It is necessary to iterate the case, rather than using an equational
691 function definition. And the situation is even worse when the matching
692 against <literal>t</literal> is buried deep inside another pattern.
693 </para>
694
695 <para>
696 View patterns permit calling the view function inside the pattern and
697 matching against the result: 
698 <programlisting>
699 size (view -> Unit) = 1
700 size (view -> Arrow t1 t2) = size t1 + size t2
701 </programlisting>
702
703 That is, we add a new form of pattern, written
704 <replaceable>expression</replaceable> <literal>-></literal>
705 <replaceable>pattern</replaceable> that means "apply the expression to
706 whatever we're trying to match against, and then match the result of
707 that application against the pattern". The expression can be any Haskell
708 expression of function type, and view patterns can be used wherever
709 patterns are used.
710 </para>
711
712 <para>
713 The semantics of a pattern <literal>(</literal>
714 <replaceable>exp</replaceable> <literal>-></literal>
715 <replaceable>pat</replaceable> <literal>)</literal> are as follows:
716
717 <itemizedlist>
718
719 <listitem> Scoping:
720
721 <para>The variables bound by the view pattern are the variables bound by
722 <replaceable>pat</replaceable>.
723 </para>
724
725 <para>
726 Any variables in <replaceable>exp</replaceable> are bound occurrences,
727 but variables bound "to the left" in a pattern are in scope.  This
728 feature permits, for example, one argument to a function to be used in
729 the view of another argument.  For example, the function
730 <literal>clunky</literal> from <xref linkend="pattern-guards" /> can be
731 written using view patterns as follows:
732
733 <programlisting>
734 clunky env (lookup env -> Just val1) (lookup env -> Just val2) = val1 + val2
735 ...other equations for clunky...
736 </programlisting>
737 </para>
738
739 <para>
740 More precisely, the scoping rules are: 
741 <itemizedlist>
742 <listitem>
743 <para>
744 In a single pattern, variables bound by patterns to the left of a view
745 pattern expression are in scope. For example:
746 <programlisting>
747 example :: Maybe ((String -> Integer,Integer), String) -> Bool
748 example Just ((f,_), f -> 4) = True
749 </programlisting>
750
751 Additionally, in function definitions, variables bound by matching earlier curried
752 arguments may be used in view pattern expressions in later arguments:
753 <programlisting>
754 example :: (String -> Integer) -> String -> Bool
755 example f (f -> 4) = True
756 </programlisting>
757 That is, the scoping is the same as it would be if the curried arguments
758 were collected into a tuple.  
759 </para>
760 </listitem>
761
762 <listitem>
763 <para>
764 In mutually recursive bindings, such as <literal>let</literal>,
765 <literal>where</literal>, or the top level, view patterns in one
766 declaration may not mention variables bound by other declarations.  That
767 is, each declaration must be self-contained.  For example, the following
768 program is not allowed:
769 <programlisting>
770 let {(x -> y) = e1 ;
771      (y -> x) = e2 } in x
772 </programlisting>
773
774 (We may lift this
775 restriction in the future; the only cost is that type checking patterns
776 would get a little more complicated.)  
777
778
779 </para>
780 </listitem>
781 </itemizedlist>
782
783 </para>
784 </listitem>
785
786 <listitem><para> Typing: If <replaceable>exp</replaceable> has type
787 <replaceable>T1</replaceable> <literal>-></literal>
788 <replaceable>T2</replaceable> and <replaceable>pat</replaceable> matches
789 a <replaceable>T2</replaceable>, then the whole view pattern matches a
790 <replaceable>T1</replaceable>.
791 </para></listitem>
792
793 <listitem><para> Matching: To the equations in Section 3.17.3 of the
794 <ulink url="http://www.haskell.org/onlinereport/">Haskell 98
795 Report</ulink>, add the following:
796 <programlisting>
797 case v of { (e -> p) -> e1 ; _ -> e2 } 
798  = 
799 case (e v) of { p -> e1 ; _ -> e2 }
800 </programlisting>
801 That is, to match a variable <replaceable>v</replaceable> against a pattern
802 <literal>(</literal> <replaceable>exp</replaceable>
803 <literal>-></literal> <replaceable>pat</replaceable>
804 <literal>)</literal>, evaluate <literal>(</literal>
805 <replaceable>exp</replaceable> <replaceable> v</replaceable>
806 <literal>)</literal> and match the result against
807 <replaceable>pat</replaceable>.  
808 </para></listitem>
809
810 <listitem><para> Efficiency: When the same view function is applied in
811 multiple branches of a function definition or a case expression (e.g.,
812 in <literal>size</literal> above), GHC makes an attempt to collect these
813 applications into a single nested case expression, so that the view
814 function is only applied once.  Pattern compilation in GHC follows the
815 matrix algorithm described in Chapter 4 of <ulink
816 url="http://research.microsoft.com/~simonpj/Papers/slpj-book-1987/">The
817 Implementation of Functional Programming Languages</ulink>.  When the
818 top rows of the first column of a matrix are all view patterns with the
819 "same" expression, these patterns are transformed into a single nested
820 case.  This includes, for example, adjacent view patterns that line up
821 in a tuple, as in
822 <programlisting>
823 f ((view -> A, p1), p2) = e1
824 f ((view -> B, p3), p4) = e2
825 </programlisting>
826 </para>
827
828 <para> The current notion of when two view pattern expressions are "the
829 same" is very restricted: it is not even full syntactic equality.
830 However, it does include variables, literals, applications, and tuples;
831 e.g., two instances of <literal>view ("hi", "there")</literal> will be
832 collected.  However, the current implementation does not compare up to
833 alpha-equivalence, so two instances of <literal>(x, view x ->
834 y)</literal> will not be coalesced.
835 </para>
836
837 </listitem>
838
839 </itemizedlist>
840 </para>
841
842 </sect2>
843
844     <!-- ===================== n+k patterns ===================  -->
845
846 <sect2 id="n-k-patterns">
847 <title>n+k patterns</title>
848 <indexterm><primary><option>-XNoNPlusKPatterns</option></primary></indexterm>
849
850 <para>
851 <literal>n+k</literal> pattern support is enabled by default. To disable
852 it, you can use the <option>-XNoNPlusKPatterns</option> flag.
853 </para>
854
855 </sect2>
856
857     <!-- ===================== Recursive do-notation ===================  -->
858
859 <sect2 id="mdo-notation">
860 <title>The recursive do-notation
861 </title>
862
863 <para>
864 The do-notation of Haskell 98 does not allow <emphasis>recursive bindings</emphasis>,
865 that is, the variables bound in a do-expression are visible only in the textually following 
866 code block. Compare this to a let-expression, where bound variables are visible in the entire binding
867 group. It turns out that several applications can benefit from recursive bindings in
868 the do-notation.  The <option>-XDoRec</option> flag provides the necessary syntactic support.
869 </para>
870 <para>
871 Here is a simple (albeit contrived) example:
872 <programlisting>
873 {-# LANGUAGE DoRec #-}
874 import Control.Monad.Fix
875
876 justOnes = do { rec { xs &lt;- Just (1:xs) }
877               ; return (map negate xs) }
878 </programlisting>
879 The <literal>rec</literal>
880 As you can guess <literal>justOnes</literal> will evaluate to <literal>Just [-1,-1,-1,...</literal>.
881 </para>
882 <para>
883 The background and motivation for recusrive do-notation is described in
884 <ulink url="http://citeseer.ist.psu.edu/erk02recursive.html">A recursive do for Haskell</ulink>,
885 by Levent Erkok, John Launchbury,
886 Haskell Workshop 2002, pages: 29-37. Pittsburgh, Pennsylvania. 
887 This paper is essential reading for anyone making non-trivial use of mdo-notation,
888 and we do not repeat it here.  However, note that GHC uses a different syntax than the one
889 in the paper.
890 </para>
891
892 <sect3>
893 <title>Details of recursive do-notation</title>
894 <para>
895 The recursive do-notation is enabled with the flag <option>-XDoRec</option> or, equivalently,
896 the LANGUAGE pragma <option>DoRec</option>.  It introduces the single new keyword "<literal>rec</literal>",
897 which wraps a mutually-recusrive group of monadic statements,
898 producing a single statement.  Similar to a <literal>let</literal>
899 statement, the variables bound in the <literal>rec</literal> are 
900 visible throughout the <literal>rec</literal> group, and below it.
901 </para>
902 <para>
903 The Control.Monad.Fix library introduces the <literal>MonadFix</literal> class.  Its definition is:
904 </para>
905 <programlisting>
906 class Monad m => MonadFix m where
907    mfix :: (a -> m a) -> m a
908 </programlisting>
909 <para>
910 The function <literal>mfix</literal>
911 dictates how the required recursion operation should be performed.  For example, 
912 <literal>justOnes</literal> desugars as follows:
913 <programlisting>
914 justOnes = do { xs &lt;- mfix (\xs' -&gt; do { xs &lt;- Just (1:xs'); return xs })
915               ; return (map negate xs) }
916 </programlisting>
917 In general, a <literal>rec</literal> 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>
921                                                                    ; return <replaceable>vs</replaceable> })
922 </programlisting>
923 where <replaceable>vs</replaceable> is a tuple of the varaibles bound by <replaceable>ss</replaceable>.
924 Moreover, 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 Here are some other important points in using the recursive-do notation:
931 <itemizedlist>
932 <listitem><para>
933 It is enabled with the flag <literal>-XDoRec</literal>, which is in turn implied by
934 <literal>-fglasgow-exts</literal>.
935 </para></listitem>
936
937 <listitem><para>
938 If recursive bindings are required for a monad,
939 then that monad must be declared an instance of the <literal>MonadFix</literal> class.
940 The following instances of <literal>MonadFix</literal> are automatically provided: List, Maybe, IO. 
941 Furthermore, the Control.Monad.ST and Control.Monad.ST.Lazy modules provide the instances of the MonadFix class 
942 for Haskell's internal state monad (strict and lazy, respectively).
943 </para></listitem>
944
945 <listitem><para>
946 Unlike ordinary do-notation, but like <literal>let</literal> and <literal>where</literal> bindings,
947 name shadowing is not allowed; that is, all the names bound in a single <literal>mdo</literal> must
948 be distinct (Section 3.3 of the paper).
949 </para></listitem>
950
951 <listitem><para>
952 Similar to let-bindings, GHC implements the segmentation technique described in Section 3.2 of
953 <ulink url="http://citeseer.ist.psu.edu/erk02recursive.html">A recursive do for Haskell</ulink>,
954 to break up a single <literal>rec</literal> statement into a sequenc e of statements with
955 <literal>rec</literal> groups of minimal size.  This 
956 improves polymorphism, and reduces the size of the recursive "knot".
957 </para></listitem>
958 </itemizedlist>
959 </para>
960 </sect3>
961
962 <sect3> <title Mdo-notation (deprecated) </title>
963
964 <para> GHC used to support the flag <option>-XREecursiveDo</option>,
965 which enabled the keyword <literal>mdo</literal>, precisely as described in
966 <ulink url="http://citeseer.ist.psu.edu/erk02recursive.html">A recursive do for Haskell</ulink>,
967 but this is now deprecated.  Instead of <literal>mdo { Q; e }</literal>, write
968 <literal>do { rec Q; e }</literal>.
969 </para>
970 <para>
971 Historical note: The old implementation of the mdo-notation (and most
972 of the existing documents) used the name
973 <literal>MonadRec</literal> for the class and the corresponding library.
974 This name is not supported by GHC.
975 </para>
976 </sect3>
977
978 </sect2>
979
980
981    <!-- ===================== PARALLEL LIST COMPREHENSIONS ===================  -->
982
983   <sect2 id="parallel-list-comprehensions">
984     <title>Parallel List Comprehensions</title>
985     <indexterm><primary>list comprehensions</primary><secondary>parallel</secondary>
986     </indexterm>
987     <indexterm><primary>parallel list comprehensions</primary>
988     </indexterm>
989
990     <para>Parallel list comprehensions are a natural extension to list
991     comprehensions.  List comprehensions can be thought of as a nice
992     syntax for writing maps and filters.  Parallel comprehensions
993     extend this to include the zipWith family.</para>
994
995     <para>A parallel list comprehension has multiple independent
996     branches of qualifier lists, each separated by a `|' symbol.  For
997     example, the following zips together two lists:</para>
998
999 <programlisting>
1000    [ (x, y) | x &lt;- xs | y &lt;- ys ] 
1001 </programlisting>
1002
1003     <para>The behavior of parallel list comprehensions follows that of
1004     zip, in that the resulting list will have the same length as the
1005     shortest branch.</para>
1006
1007     <para>We can define parallel list comprehensions by translation to
1008     regular comprehensions.  Here's the basic idea:</para>
1009
1010     <para>Given a parallel comprehension of the form: </para>
1011
1012 <programlisting>
1013    [ e | p1 &lt;- e11, p2 &lt;- e12, ... 
1014        | q1 &lt;- e21, q2 &lt;- e22, ... 
1015        ... 
1016    ] 
1017 </programlisting>
1018
1019     <para>This will be translated to: </para>
1020
1021 <programlisting>
1022    [ e | ((p1,p2), (q1,q2), ...) &lt;- zipN [(p1,p2) | p1 &lt;- e11, p2 &lt;- e12, ...] 
1023                                          [(q1,q2) | q1 &lt;- e21, q2 &lt;- e22, ...] 
1024                                          ... 
1025    ] 
1026 </programlisting>
1027
1028     <para>where `zipN' is the appropriate zip for the given number of
1029     branches.</para>
1030
1031   </sect2>
1032   
1033   <!-- ===================== TRANSFORM LIST COMPREHENSIONS ===================  -->
1034
1035   <sect2 id="generalised-list-comprehensions">
1036     <title>Generalised (SQL-Like) List Comprehensions</title>
1037     <indexterm><primary>list comprehensions</primary><secondary>generalised</secondary>
1038     </indexterm>
1039     <indexterm><primary>extended list comprehensions</primary>
1040     </indexterm>
1041     <indexterm><primary>group</primary></indexterm>
1042     <indexterm><primary>sql</primary></indexterm>
1043
1044
1045     <para>Generalised list comprehensions are a further enhancement to the
1046     list comprehension syntactic sugar to allow operations such as sorting
1047     and grouping which are familiar from SQL.   They are fully described in the
1048         paper <ulink url="http://research.microsoft.com/~simonpj/papers/list-comp">
1049           Comprehensive comprehensions: comprehensions with "order by" and "group by"</ulink>,
1050     except that the syntax we use differs slightly from the paper.</para>
1051 <para>The extension is enabled with the flag <option>-XTransformListComp</option>.</para>
1052 <para>Here is an example: 
1053 <programlisting>
1054 employees = [ ("Simon", "MS", 80)
1055 , ("Erik", "MS", 100)
1056 , ("Phil", "Ed", 40)
1057 , ("Gordon", "Ed", 45)
1058 , ("Paul", "Yale", 60)]
1059
1060 output = [ (the dept, sum salary)
1061 | (name, dept, salary) &lt;- employees
1062 , then group by dept
1063 , then sortWith by (sum salary)
1064 , then take 5 ]
1065 </programlisting>
1066 In this example, the list <literal>output</literal> would take on 
1067     the value:
1068     
1069 <programlisting>
1070 [("Yale", 60), ("Ed", 85), ("MS", 180)]
1071 </programlisting>
1072 </para>
1073 <para>There are three new keywords: <literal>group</literal>, <literal>by</literal>, and <literal>using</literal>.
1074 (The function <literal>sortWith</literal> is not a keyword; it is an ordinary
1075 function that is exported by <literal>GHC.Exts</literal>.)</para>
1076
1077 <para>There are five new forms of comprehension qualifier,
1078 all introduced by the (existing) keyword <literal>then</literal>:
1079     <itemizedlist>
1080     <listitem>
1081     
1082 <programlisting>
1083 then f
1084 </programlisting>
1085
1086     This statement requires that <literal>f</literal> have the type <literal>
1087     forall a. [a] -> [a]</literal>. You can see an example of its use in the
1088     motivating example, as this form is used to apply <literal>take 5</literal>.
1089     
1090     </listitem>
1091     
1092     
1093     <listitem>
1094 <para>
1095 <programlisting>
1096 then f by e
1097 </programlisting>
1098
1099     This form is similar to the previous one, but allows you to create a function
1100     which will be passed as the first argument to f. As a consequence f must have 
1101     the type <literal>forall a. (a -> t) -> [a] -> [a]</literal>. As you can see
1102     from the type, this function lets f &quot;project out&quot; some information 
1103     from the elements of the list it is transforming.</para>
1104
1105     <para>An example is shown in the opening example, where <literal>sortWith</literal> 
1106     is supplied with a function that lets it find out the <literal>sum salary</literal> 
1107     for any item in the list comprehension it transforms.</para>
1108
1109     </listitem>
1110
1111
1112     <listitem>
1113
1114 <programlisting>
1115 then group by e using f
1116 </programlisting>
1117
1118     <para>This is the most general of the grouping-type statements. In this form,
1119     f is required to have type <literal>forall a. (a -> t) -> [a] -> [[a]]</literal>.
1120     As with the <literal>then f by e</literal> case above, the first argument
1121     is a function supplied to f by the compiler which lets it compute e on every
1122     element of the list being transformed. However, unlike the non-grouping case,
1123     f additionally partitions the list into a number of sublists: this means that
1124     at every point after this statement, binders occurring before it in the comprehension
1125     refer to <emphasis>lists</emphasis> of possible values, not single values. To help understand
1126     this, let's look at an example:</para>
1127     
1128 <programlisting>
1129 -- This works similarly to groupWith in GHC.Exts, but doesn't sort its input first
1130 groupRuns :: Eq b => (a -> b) -> [a] -> [[a]]
1131 groupRuns f = groupBy (\x y -> f x == f y)
1132
1133 output = [ (the x, y)
1134 | x &lt;- ([1..3] ++ [1..2])
1135 , y &lt;- [4..6]
1136 , then group by x using groupRuns ]
1137 </programlisting>
1138
1139     <para>This results in the variable <literal>output</literal> taking on the value below:</para>
1140
1141 <programlisting>
1142 [(1, [4, 5, 6]), (2, [4, 5, 6]), (3, [4, 5, 6]), (1, [4, 5, 6]), (2, [4, 5, 6])]
1143 </programlisting>
1144
1145     <para>Note that we have used the <literal>the</literal> function to change the type 
1146     of x from a list to its original numeric type. The variable y, in contrast, is left 
1147     unchanged from the list form introduced by the grouping.</para>
1148
1149     </listitem>
1150
1151     <listitem>
1152
1153 <programlisting>
1154 then group by e
1155 </programlisting>
1156
1157     <para>This form of grouping is essentially the same as the one described above. However,
1158     since no function to use for the grouping has been supplied it will fall back on the
1159     <literal>groupWith</literal> function defined in 
1160     <ulink url="../libraries/base/GHC-Exts.html"><literal>GHC.Exts</literal></ulink>. This
1161     is the form of the group statement that we made use of in the opening example.</para>
1162
1163     </listitem>
1164     
1165     
1166     <listitem>
1167
1168 <programlisting>
1169 then group using f
1170 </programlisting>
1171
1172     <para>With this form of the group statement, f is required to simply have the type
1173     <literal>forall a. [a] -> [[a]]</literal>, which will be used to group up the
1174     comprehension so far directly. An example of this form is as follows:</para>
1175     
1176 <programlisting>
1177 output = [ x
1178 | y &lt;- [1..5]
1179 , x &lt;- "hello"
1180 , then group using inits]
1181 </programlisting>
1182
1183     <para>This will yield a list containing every prefix of the word "hello" written out 5 times:</para>
1184
1185 <programlisting>
1186 ["","h","he","hel","hell","hello","helloh","hellohe","hellohel","hellohell","hellohello","hellohelloh",...]
1187 </programlisting>
1188
1189     </listitem>
1190 </itemizedlist>
1191 </para>
1192   </sect2>
1193
1194    <!-- ===================== REBINDABLE SYNTAX ===================  -->
1195
1196 <sect2 id="rebindable-syntax">
1197 <title>Rebindable syntax and the implicit Prelude import</title>
1198
1199  <para><indexterm><primary>-XNoImplicitPrelude
1200  option</primary></indexterm> GHC normally imports
1201  <filename>Prelude.hi</filename> files for you.  If you'd
1202  rather it didn't, then give it a
1203  <option>-XNoImplicitPrelude</option> option.  The idea is
1204  that you can then import a Prelude of your own.  (But don't
1205  call it <literal>Prelude</literal>; the Haskell module
1206  namespace is flat, and you must not conflict with any
1207  Prelude module.)</para>
1208
1209             <para>Suppose you are importing a Prelude of your own
1210               in order to define your own numeric class
1211             hierarchy.  It completely defeats that purpose if the
1212             literal "1" means "<literal>Prelude.fromInteger
1213             1</literal>", which is what the Haskell Report specifies.
1214             So the <option>-XNoImplicitPrelude</option> 
1215               flag <emphasis>also</emphasis> causes
1216             the following pieces of built-in syntax to refer to
1217             <emphasis>whatever is in scope</emphasis>, not the Prelude
1218             versions:
1219             <itemizedlist>
1220               <listitem>
1221                 <para>An integer literal <literal>368</literal> means
1222                 "<literal>fromInteger (368::Integer)</literal>", rather than
1223                 "<literal>Prelude.fromInteger (368::Integer)</literal>".
1224 </para> </listitem>         
1225
1226       <listitem><para>Fractional literals are handed in just the same way,
1227           except that the translation is 
1228               <literal>fromRational (3.68::Rational)</literal>.
1229 </para> </listitem>         
1230
1231           <listitem><para>The equality test in an overloaded numeric pattern
1232               uses whatever <literal>(==)</literal> is in scope.
1233 </para> </listitem>         
1234
1235           <listitem><para>The subtraction operation, and the
1236           greater-than-or-equal test, in <literal>n+k</literal> patterns
1237               use whatever <literal>(-)</literal> and <literal>(>=)</literal> are in scope.
1238               </para></listitem>
1239
1240               <listitem>
1241                 <para>Negation (e.g. "<literal>- (f x)</literal>")
1242                 means "<literal>negate (f x)</literal>", both in numeric
1243                 patterns, and expressions.
1244               </para></listitem>
1245
1246               <listitem>
1247           <para>"Do" notation is translated using whatever
1248               functions <literal>(>>=)</literal>,
1249               <literal>(>>)</literal>, and <literal>fail</literal>,
1250               are in scope (not the Prelude
1251               versions).  List comprehensions, mdo (<xref linkend="mdo-notation"/>), and parallel array
1252               comprehensions, are unaffected.  </para></listitem>
1253
1254               <listitem>
1255                 <para>Arrow
1256                 notation (see <xref linkend="arrow-notation"/>)
1257                 uses whatever <literal>arr</literal>,
1258                 <literal>(>>>)</literal>, <literal>first</literal>,
1259                 <literal>app</literal>, <literal>(|||)</literal> and
1260                 <literal>loop</literal> functions are in scope. But unlike the
1261                 other constructs, the types of these functions must match the
1262                 Prelude types very closely.  Details are in flux; if you want
1263                 to use this, ask!
1264               </para></listitem>
1265             </itemizedlist>
1266 In all cases (apart from arrow notation), the static semantics should be that of the desugared form,
1267 even if that is a little unexpected. For example, the 
1268 static semantics of the literal <literal>368</literal>
1269 is exactly that of <literal>fromInteger (368::Integer)</literal>; it's fine for
1270 <literal>fromInteger</literal> to have any of the types:
1271 <programlisting>
1272 fromInteger :: Integer -> Integer
1273 fromInteger :: forall a. Foo a => Integer -> a
1274 fromInteger :: Num a => a -> Integer
1275 fromInteger :: Integer -> Bool -> Bool
1276 </programlisting>
1277 </para>
1278                 
1279              <para>Be warned: this is an experimental facility, with
1280              fewer checks than usual.  Use <literal>-dcore-lint</literal>
1281              to typecheck the desugared program.  If Core Lint is happy
1282              you should be all right.</para>
1283
1284 </sect2>
1285
1286 <sect2 id="postfix-operators">
1287 <title>Postfix operators</title>
1288
1289 <para>
1290   The <option>-XPostfixOperators</option> flag enables a small
1291 extension to the syntax of left operator sections, which allows you to
1292 define postfix operators.  The extension is this: the left section
1293 <programlisting>
1294   (e !)
1295 </programlisting>
1296 is equivalent (from the point of view of both type checking and execution) to the expression
1297 <programlisting>
1298   ((!) e)
1299 </programlisting>
1300 (for any expression <literal>e</literal> and operator <literal>(!)</literal>.
1301 The strict Haskell 98 interpretation is that the section is equivalent to
1302 <programlisting>
1303   (\y -> (!) e y)
1304 </programlisting>
1305 That is, the operator must be a function of two arguments.  GHC allows it to
1306 take only one argument, and that in turn allows you to write the function
1307 postfix.
1308 </para>
1309 <para>The extension does not extend to the left-hand side of function
1310 definitions; you must define such a function in prefix form.</para>
1311
1312 </sect2>
1313
1314 <sect2 id="tuple-sections">
1315 <title>Tuple sections</title>
1316
1317 <para>
1318   The <option>-XTupleSections</option> flag enables Python-style partially applied
1319   tuple constructors. For example, the following program
1320 <programlisting>
1321   (, True)
1322 </programlisting>
1323   is considered to be an alternative notation for the more unwieldy alternative
1324 <programlisting>
1325   \x -> (x, True)
1326 </programlisting>
1327 You can omit any combination of arguments to the tuple, as in the following
1328 <programlisting>
1329   (, "I", , , "Love", , 1337)
1330 </programlisting>
1331 which translates to
1332 <programlisting>
1333   \a b c d -> (a, "I", b, c, "Love", d, 1337)
1334 </programlisting>
1335 </para>
1336
1337 <para>
1338   If you have <link linkend="unboxed-tuples">unboxed tuples</link> enabled, tuple sections
1339   will also be available for them, like so
1340 <programlisting>
1341   (# , True #)
1342 </programlisting>
1343 Because there is no unboxed unit tuple, the following expression
1344 <programlisting>
1345   (# #)
1346 </programlisting>
1347 continues to stand for the unboxed singleton tuple data constructor.
1348 </para>
1349
1350 </sect2>
1351
1352 <sect2 id="disambiguate-fields">
1353 <title>Record field disambiguation</title>
1354 <para>
1355 In record construction and record pattern matching
1356 it is entirely unambiguous which field is referred to, even if there are two different
1357 data types in scope with a common field name.  For example:
1358 <programlisting>
1359 module M where
1360   data S = MkS { x :: Int, y :: Bool }
1361
1362 module Foo where
1363   import M
1364
1365   data T = MkT { x :: Int }
1366   
1367   ok1 (MkS { x = n }) = n+1   -- Unambiguous
1368   ok2 n = MkT { x = n+1 }     -- Unambiguous
1369
1370   bad1 k = k { x = 3 }  -- Ambiguous
1371   bad2 k = x k          -- Ambiguous
1372 </programlisting>
1373 Even though there are two <literal>x</literal>'s in scope,
1374 it is clear that the <literal>x</literal> in the pattern in the
1375 definition of <literal>ok1</literal> can only mean the field
1376 <literal>x</literal> from type <literal>S</literal>. Similarly for
1377 the function <literal>ok2</literal>.  However, in the record update
1378 in <literal>bad1</literal> and the record selection in <literal>bad2</literal>
1379 it is not clear which of the two types is intended.
1380 </para>
1381 <para>
1382 Haskell 98 regards all four as ambiguous, but with the
1383 <option>-XDisambiguateRecordFields</option> flag, GHC will accept
1384 the former two.  The rules are precisely the same as those for instance
1385 declarations in Haskell 98, where the method names on the left-hand side 
1386 of the method bindings in an instance declaration refer unambiguously
1387 to the method of that class (provided they are in scope at all), even
1388 if there are other variables in scope with the same name.
1389 This reduces the clutter of qualified names when you import two
1390 records from different modules that use the same field name.
1391 </para>
1392 <para>
1393 Some details:
1394 <itemizedlist>
1395 <listitem><para>
1396 Field disambiguation can be combined with punning (see <xref linkend="record-puns"/>). For exampe:
1397 <programlisting>
1398 module Foo where
1399   import M
1400   x=True
1401   ok3 (MkS { x }) = x+1   -- Uses both disambiguation and punning
1402 </programlisting>
1403 </para></listitem>
1404
1405 <listitem><para>
1406 With <option>-XDisambiguateRecordFields</option> you can use <emphasis>unqualifed</emphasis>
1407 field names even if the correponding selector is only in scope <emphasis>qualified</emphasis>
1408 For example, assuming the same module <literal>M</literal> as in our earlier example, this is legal:
1409 <programlisting>
1410 module Foo where
1411   import qualified M    -- Note qualified
1412
1413   ok4 (M.MkS { x = n }) = n+1   -- Unambiguous
1414 </programlisting>
1415 Since the constructore <literal>MkS</literal> is only in scope qualified, you must
1416 name it <literal>M.MkS</literal>, but the field <literal>x</literal> does not need
1417 to be qualified even though <literal>M.x</literal> is in scope but <literal>x</literal>
1418 is not.  (In effect, it is qualified by the constructor.)
1419 </para></listitem>
1420 </itemizedlist>
1421 </para>
1422
1423 </sect2>
1424
1425     <!-- ===================== Record puns ===================  -->
1426
1427 <sect2 id="record-puns">
1428 <title>Record puns
1429 </title>
1430
1431 <para>
1432 Record puns are enabled by the flag <literal>-XNamedFieldPuns</literal>.
1433 </para>
1434
1435 <para>
1436 When using records, it is common to write a pattern that binds a
1437 variable with the same name as a record field, such as:
1438
1439 <programlisting>
1440 data C = C {a :: Int}
1441 f (C {a = a}) = a
1442 </programlisting>
1443 </para>
1444
1445 <para>
1446 Record punning permits the variable name to be elided, so one can simply
1447 write
1448
1449 <programlisting>
1450 f (C {a}) = a
1451 </programlisting>
1452
1453 to mean the same pattern as above.  That is, in a record pattern, the
1454 pattern <literal>a</literal> expands into the pattern <literal>a =
1455 a</literal> for the same name <literal>a</literal>.  
1456 </para>
1457
1458 <para>
1459 Note that:
1460 <itemizedlist>
1461 <listitem><para>
1462 Record punning can also be used in an expression, writing, for example,
1463 <programlisting>
1464 let a = 1 in C {a}
1465 </programlisting>
1466 instead of 
1467 <programlisting>
1468 let a = 1 in C {a = a}
1469 </programlisting>
1470 The expansion is purely syntactic, so the expanded right-hand side
1471 expression refers to the nearest enclosing variable that is spelled the
1472 same as the field name.
1473 </para></listitem>
1474
1475 <listitem><para>
1476 Puns and other patterns can be mixed in the same record:
1477 <programlisting>
1478 data C = C {a :: Int, b :: Int}
1479 f (C {a, b = 4}) = a
1480 </programlisting>
1481 </para></listitem>
1482
1483 <listitem><para>
1484 Puns can be used wherever record patterns occur (e.g. in
1485 <literal>let</literal> bindings or at the top-level).  
1486 </para></listitem>
1487
1488 <listitem><para>
1489 A pun on a qualified field name is expanded by stripping off the module qualifier.
1490 For example:
1491 <programlisting>
1492 f (C {M.a}) = a
1493 </programlisting>
1494 means
1495 <programlisting>
1496 f (M.C {M.a = a}) = a
1497 </programlisting>
1498 (This is useful if the field selector <literal>a</literal> for constructor <literal>M.C</literal>
1499 is only in scope in qualified form.)
1500 </para></listitem>
1501 </itemizedlist>
1502 </para>
1503
1504
1505 </sect2>
1506
1507     <!-- ===================== Record wildcards ===================  -->
1508
1509 <sect2 id="record-wildcards">
1510 <title>Record wildcards
1511 </title>
1512
1513 <para>
1514 Record wildcards are enabled by the flag <literal>-XRecordWildCards</literal>.
1515 This flag implies <literal>-XDisambiguateRecordFields</literal>.
1516 </para>
1517
1518 <para>
1519 For records with many fields, it can be tiresome to write out each field
1520 individually in a record pattern, as in
1521 <programlisting>
1522 data C = C {a :: Int, b :: Int, c :: Int, d :: Int}
1523 f (C {a = 1, b = b, c = c, d = d}) = b + c + d
1524 </programlisting>
1525 </para>
1526
1527 <para>
1528 Record wildcard syntax permits a "<literal>..</literal>" in a record
1529 pattern, where each elided field <literal>f</literal> is replaced by the
1530 pattern <literal>f = f</literal>.  For example, the above pattern can be
1531 written as
1532 <programlisting>
1533 f (C {a = 1, ..}) = b + c + d
1534 </programlisting>
1535 </para>
1536
1537 <para>
1538 More details:
1539 <itemizedlist>
1540 <listitem><para>
1541 Wildcards can be mixed with other patterns, including puns
1542 (<xref linkend="record-puns"/>); for example, in a pattern <literal>C {a
1543 = 1, b, ..})</literal>.  Additionally, record wildcards can be used
1544 wherever record patterns occur, including in <literal>let</literal>
1545 bindings and at the top-level.  For example, the top-level binding
1546 <programlisting>
1547 C {a = 1, ..} = e
1548 </programlisting>
1549 defines <literal>b</literal>, <literal>c</literal>, and
1550 <literal>d</literal>.
1551 </para></listitem>
1552
1553 <listitem><para>
1554 Record wildcards can also be used in expressions, writing, for example,
1555 <programlisting>
1556 let {a = 1; b = 2; c = 3; d = 4} in C {..}
1557 </programlisting>
1558 in place of
1559 <programlisting>
1560 let {a = 1; b = 2; c = 3; d = 4} in C {a=a, b=b, c=c, d=d}
1561 </programlisting>
1562 The expansion is purely syntactic, so the record wildcard
1563 expression refers to the nearest enclosing variables that are spelled
1564 the same as the omitted field names.
1565 </para></listitem>
1566
1567 <listitem><para>
1568 The "<literal>..</literal>" expands to the missing 
1569 <emphasis>in-scope</emphasis> record fields, where "in scope"
1570 includes both unqualified and qualified-only.  
1571 Any fields that are not in scope are not filled in.  For example
1572 <programlisting>
1573 module M where
1574   data R = R { a,b,c :: Int }
1575 module X where
1576   import qualified M( R(a,b) )
1577   f a b = R { .. }
1578 </programlisting>
1579 The <literal>{..}</literal> expands to <literal>{M.a=a,M.b=b}</literal>,
1580 omitting <literal>c</literal> since it is not in scope at all.
1581 </para></listitem>
1582 </itemizedlist>
1583 </para>
1584
1585 </sect2>
1586
1587     <!-- ===================== Local fixity declarations ===================  -->
1588
1589 <sect2 id="local-fixity-declarations">
1590 <title>Local Fixity Declarations
1591 </title>
1592
1593 <para>A careful reading of the Haskell 98 Report reveals that fixity
1594 declarations (<literal>infix</literal>, <literal>infixl</literal>, and
1595 <literal>infixr</literal>) are permitted to appear inside local bindings
1596 such those introduced by <literal>let</literal> and
1597 <literal>where</literal>.  However, the Haskell Report does not specify
1598 the semantics of such bindings very precisely.
1599 </para>
1600
1601 <para>In GHC, a fixity declaration may accompany a local binding:
1602 <programlisting>
1603 let f = ...
1604     infixr 3 `f`
1605 in 
1606     ...
1607 </programlisting>
1608 and the fixity declaration applies wherever the binding is in scope.
1609 For example, in a <literal>let</literal>, it applies in the right-hand
1610 sides of other <literal>let</literal>-bindings and the body of the
1611 <literal>let</literal>C. Or, in recursive <literal>do</literal>
1612 expressions (<xref linkend="mdo-notation"/>), the local fixity
1613 declarations of a <literal>let</literal> statement scope over other
1614 statements in the group, just as the bound name does.
1615 </para>
1616
1617 <para>
1618 Moreover, a local fixity declaration *must* accompany a local binding of
1619 that name: it is not possible to revise the fixity of name bound
1620 elsewhere, as in
1621 <programlisting>
1622 let infixr 9 $ in ...
1623 </programlisting>
1624
1625 Because local fixity declarations are technically Haskell 98, no flag is
1626 necessary to enable them.
1627 </para>
1628 </sect2>
1629
1630 <sect2 id="package-imports">
1631   <title>Package-qualified imports</title>
1632
1633   <para>With the <option>-XPackageImports</option> flag, GHC allows
1634   import declarations to be qualified by the package name that the
1635     module is intended to be imported from.  For example:</para>
1636
1637 <programlisting>
1638 import "network" Network.Socket
1639 </programlisting>
1640   
1641   <para>would import the module <literal>Network.Socket</literal> from
1642     the package <literal>network</literal> (any version).  This may
1643     be used to disambiguate an import when the same module is
1644     available from multiple packages, or is present in both the
1645     current package being built and an external package.</para>
1646
1647   <para>Note: you probably don't need to use this feature, it was
1648     added mainly so that we can build backwards-compatible versions of
1649     packages when APIs change.  It can lead to fragile dependencies in
1650     the common case: modules occasionally move from one package to
1651     another, rendering any package-qualified imports broken.</para>
1652 </sect2>
1653
1654 <sect2 id="syntax-stolen">
1655 <title>Summary of stolen syntax</title>
1656
1657     <para>Turning on an option that enables special syntax
1658     <emphasis>might</emphasis> cause working Haskell 98 code to fail
1659     to compile, perhaps because it uses a variable name which has
1660     become a reserved word.  This section lists the syntax that is
1661     "stolen" by language extensions.
1662      We use
1663     notation and nonterminal names from the Haskell 98 lexical syntax
1664     (see the Haskell 98 Report).  
1665     We only list syntax changes here that might affect
1666     existing working programs (i.e. "stolen" syntax).  Many of these
1667     extensions will also enable new context-free syntax, but in all
1668     cases programs written to use the new syntax would not be
1669     compilable without the option enabled.</para>
1670
1671 <para>There are two classes of special
1672     syntax:
1673
1674     <itemizedlist>
1675       <listitem>
1676         <para>New reserved words and symbols: character sequences
1677         which are no longer available for use as identifiers in the
1678         program.</para>
1679       </listitem>
1680       <listitem>
1681         <para>Other special syntax: sequences of characters that have
1682         a different meaning when this particular option is turned
1683         on.</para>
1684       </listitem>
1685     </itemizedlist>
1686     
1687 The following syntax is stolen:
1688
1689     <variablelist>
1690       <varlistentry>
1691         <term>
1692           <literal>forall</literal>
1693           <indexterm><primary><literal>forall</literal></primary></indexterm>
1694         </term>
1695         <listitem><para>
1696         Stolen (in types) by: <option>-XExplicitForAll</option>, and hence by
1697             <option>-XScopedTypeVariables</option>,
1698             <option>-XLiberalTypeSynonyms</option>,
1699             <option>-XRank2Types</option>,
1700             <option>-XRankNTypes</option>,
1701             <option>-XPolymorphicComponents</option>,
1702             <option>-XExistentialQuantification</option>
1703           </para></listitem>
1704       </varlistentry>
1705
1706       <varlistentry>
1707         <term>
1708           <literal>mdo</literal>
1709           <indexterm><primary><literal>mdo</literal></primary></indexterm>
1710         </term>
1711         <listitem><para>
1712         Stolen by: <option>-XRecursiveDo</option>,
1713           </para></listitem>
1714       </varlistentry>
1715
1716       <varlistentry>
1717         <term>
1718           <literal>foreign</literal>
1719           <indexterm><primary><literal>foreign</literal></primary></indexterm>
1720         </term>
1721         <listitem><para>
1722         Stolen by: <option>-XForeignFunctionInterface</option>,
1723           </para></listitem>
1724       </varlistentry>
1725
1726       <varlistentry>
1727         <term>
1728           <literal>rec</literal>,
1729           <literal>proc</literal>, <literal>-&lt;</literal>,
1730           <literal>&gt;-</literal>, <literal>-&lt;&lt;</literal>,
1731           <literal>&gt;&gt;-</literal>, and <literal>(|</literal>,
1732           <literal>|)</literal> brackets
1733           <indexterm><primary><literal>proc</literal></primary></indexterm>
1734         </term>
1735         <listitem><para>
1736         Stolen by: <option>-XArrows</option>,
1737           </para></listitem>
1738       </varlistentry>
1739
1740       <varlistentry>
1741         <term>
1742           <literal>?<replaceable>varid</replaceable></literal>,
1743           <literal>%<replaceable>varid</replaceable></literal>
1744           <indexterm><primary>implicit parameters</primary></indexterm>
1745         </term>
1746         <listitem><para>
1747         Stolen by: <option>-XImplicitParams</option>,
1748           </para></listitem>
1749       </varlistentry>
1750
1751       <varlistentry>
1752         <term>
1753           <literal>[|</literal>,
1754           <literal>[e|</literal>, <literal>[p|</literal>,
1755           <literal>[d|</literal>, <literal>[t|</literal>,
1756           <literal>$(</literal>,
1757           <literal>$<replaceable>varid</replaceable></literal>
1758           <indexterm><primary>Template Haskell</primary></indexterm>
1759         </term>
1760         <listitem><para>
1761         Stolen by: <option>-XTemplateHaskell</option>,
1762           </para></listitem>
1763       </varlistentry>
1764
1765       <varlistentry>
1766         <term>
1767           <literal>[:<replaceable>varid</replaceable>|</literal>
1768           <indexterm><primary>quasi-quotation</primary></indexterm>
1769         </term>
1770         <listitem><para>
1771         Stolen by: <option>-XQuasiQuotes</option>,
1772           </para></listitem>
1773       </varlistentry>
1774
1775       <varlistentry>
1776         <term>
1777               <replaceable>varid</replaceable>{<literal>&num;</literal>},
1778               <replaceable>char</replaceable><literal>&num;</literal>,      
1779               <replaceable>string</replaceable><literal>&num;</literal>,    
1780               <replaceable>integer</replaceable><literal>&num;</literal>,    
1781               <replaceable>float</replaceable><literal>&num;</literal>,    
1782               <replaceable>float</replaceable><literal>&num;&num;</literal>,    
1783               <literal>(&num;</literal>, <literal>&num;)</literal>,         
1784         </term>
1785         <listitem><para>
1786         Stolen by: <option>-XMagicHash</option>,
1787           </para></listitem>
1788       </varlistentry>
1789     </variablelist>
1790 </para>
1791 </sect2>
1792 </sect1>
1793
1794
1795 <!-- TYPE SYSTEM EXTENSIONS -->
1796 <sect1 id="data-type-extensions">
1797 <title>Extensions to data types and type synonyms</title>
1798
1799 <sect2 id="nullary-types">
1800 <title>Data types with no constructors</title>
1801
1802 <para>With the <option>-fglasgow-exts</option> flag, GHC lets you declare
1803 a data type with no constructors.  For example:</para>
1804
1805 <programlisting>
1806   data S      -- S :: *
1807   data T a    -- T :: * -> *
1808 </programlisting>
1809
1810 <para>Syntactically, the declaration lacks the "= constrs" part.  The 
1811 type can be parameterised over types of any kind, but if the kind is
1812 not <literal>*</literal> then an explicit kind annotation must be used
1813 (see <xref linkend="kinding"/>).</para>
1814
1815 <para>Such data types have only one value, namely bottom.
1816 Nevertheless, they can be useful when defining "phantom types".</para>
1817 </sect2>
1818
1819 <sect2 id="infix-tycons">
1820 <title>Infix type constructors, classes, and type variables</title>
1821
1822 <para>
1823 GHC allows type constructors, classes, and type variables to be operators, and
1824 to be written infix, very much like expressions.  More specifically:
1825 <itemizedlist>
1826 <listitem><para>
1827   A type constructor or class can be an operator, beginning with a colon; e.g. <literal>:*:</literal>.
1828   The lexical syntax is the same as that for data constructors.
1829   </para></listitem>
1830 <listitem><para>
1831   Data type and type-synonym declarations can be written infix, parenthesised
1832   if you want further arguments.  E.g.
1833 <screen>
1834   data a :*: b = Foo a b
1835   type a :+: b = Either a b
1836   class a :=: b where ...
1837
1838   data (a :**: b) x = Baz a b x
1839   type (a :++: b) y = Either (a,b) y
1840 </screen>
1841   </para></listitem>
1842 <listitem><para>
1843   Types, and class constraints, can be written infix.  For example
1844   <screen>
1845         x :: Int :*: Bool
1846         f :: (a :=: b) => a -> b
1847   </screen>
1848   </para></listitem>
1849 <listitem><para>
1850   A type variable can be an (unqualified) operator e.g. <literal>+</literal>.
1851   The lexical syntax is the same as that for variable operators, excluding "(.)",
1852   "(!)", and "(*)".  In a binding position, the operator must be
1853   parenthesised.  For example:
1854 <programlisting>
1855    type T (+) = Int + Int
1856    f :: T Either
1857    f = Left 3
1858  
1859    liftA2 :: Arrow (~>)
1860           => (a -> b -> c) -> (e ~> a) -> (e ~> b) -> (e ~> c)
1861    liftA2 = ...
1862 </programlisting>
1863   </para></listitem>
1864 <listitem><para>
1865   Back-quotes work
1866   as for expressions, both for type constructors and type variables;  e.g. <literal>Int `Either` Bool</literal>, or
1867   <literal>Int `a` Bool</literal>.  Similarly, parentheses work the same; e.g.  <literal>(:*:) Int Bool</literal>.
1868   </para></listitem>
1869 <listitem><para>
1870   Fixities may be declared for type constructors, or classes, just as for data constructors.  However,
1871   one cannot distinguish between the two in a fixity declaration; a fixity declaration
1872   sets the fixity for a data constructor and the corresponding type constructor.  For example:
1873 <screen>
1874   infixl 7 T, :*:
1875 </screen>
1876   sets the fixity for both type constructor <literal>T</literal> and data constructor <literal>T</literal>,
1877   and similarly for <literal>:*:</literal>.
1878   <literal>Int `a` Bool</literal>.
1879   </para></listitem>
1880 <listitem><para>
1881   Function arrow is <literal>infixr</literal> with fixity 0.  (This might change; I'm not sure what it should be.)
1882   </para></listitem>
1883
1884 </itemizedlist>
1885 </para>
1886 </sect2>
1887
1888 <sect2 id="type-synonyms">
1889 <title>Liberalised type synonyms</title>
1890
1891 <para>
1892 Type synonyms are like macros at the type level, but Haskell 98 imposes many rules
1893 on individual synonym declarations.
1894 With the <option>-XLiberalTypeSynonyms</option> extension,
1895 GHC does validity checking on types <emphasis>only after expanding type synonyms</emphasis>.
1896 That means that GHC can be very much more liberal about type synonyms than Haskell 98. 
1897
1898 <itemizedlist>
1899 <listitem> <para>You can write a <literal>forall</literal> (including overloading)
1900 in a type synonym, thus:
1901 <programlisting>
1902   type Discard a = forall b. Show b => a -> b -> (a, String)
1903
1904   f :: Discard a
1905   f x y = (x, show y)
1906
1907   g :: Discard Int -> (Int,String)    -- A rank-2 type
1908   g f = f 3 True
1909 </programlisting>
1910 </para>
1911 </listitem>
1912
1913 <listitem><para>
1914 If you also use <option>-XUnboxedTuples</option>, 
1915 you can write an unboxed tuple in a type synonym:
1916 <programlisting>
1917   type Pr = (# Int, Int #)
1918
1919   h :: Int -> Pr
1920   h x = (# x, x #)
1921 </programlisting>
1922 </para></listitem>
1923
1924 <listitem><para>
1925 You can apply a type synonym to a forall type:
1926 <programlisting>
1927   type Foo a = a -> a -> Bool
1928  
1929   f :: Foo (forall b. b->b)
1930 </programlisting>
1931 After expanding the synonym, <literal>f</literal> has the legal (in GHC) type:
1932 <programlisting>
1933   f :: (forall b. b->b) -> (forall b. b->b) -> Bool
1934 </programlisting>
1935 </para></listitem>
1936
1937 <listitem><para>
1938 You can apply a type synonym to a partially applied type synonym:
1939 <programlisting>
1940   type Generic i o = forall x. i x -> o x
1941   type Id x = x
1942   
1943   foo :: Generic Id []
1944 </programlisting>
1945 After expanding the synonym, <literal>foo</literal> has the legal (in GHC) type:
1946 <programlisting>
1947   foo :: forall x. x -> [x]
1948 </programlisting>
1949 </para></listitem>
1950
1951 </itemizedlist>
1952 </para>
1953
1954 <para>
1955 GHC currently does kind checking before expanding synonyms (though even that
1956 could be changed.)
1957 </para>
1958 <para>
1959 After expanding type synonyms, GHC does validity checking on types, looking for
1960 the following mal-formedness which isn't detected simply by kind checking:
1961 <itemizedlist>
1962 <listitem><para>
1963 Type constructor applied to a type involving for-alls.
1964 </para></listitem>
1965 <listitem><para>
1966 Unboxed tuple on left of an arrow.
1967 </para></listitem>
1968 <listitem><para>
1969 Partially-applied type synonym.
1970 </para></listitem>
1971 </itemizedlist>
1972 So, for example,
1973 this will be rejected:
1974 <programlisting>
1975   type Pr = (# Int, Int #)
1976
1977   h :: Pr -> Int
1978   h x = ...
1979 </programlisting>
1980 because GHC does not allow  unboxed tuples on the left of a function arrow.
1981 </para>
1982 </sect2>
1983
1984
1985 <sect2 id="existential-quantification">
1986 <title>Existentially quantified data constructors
1987 </title>
1988
1989 <para>
1990 The idea of using existential quantification in data type declarations
1991 was suggested by Perry, and implemented in Hope+ (Nigel Perry, <emphasis>The Implementation
1992 of Practical Functional Programming Languages</emphasis>, PhD Thesis, University of
1993 London, 1991). It was later formalised by Laufer and Odersky
1994 (<emphasis>Polymorphic type inference and abstract data types</emphasis>,
1995 TOPLAS, 16(5), pp1411-1430, 1994).
1996 It's been in Lennart
1997 Augustsson's <command>hbc</command> Haskell compiler for several years, and
1998 proved very useful.  Here's the idea.  Consider the declaration:
1999 </para>
2000
2001 <para>
2002
2003 <programlisting>
2004   data Foo = forall a. MkFoo a (a -> Bool)
2005            | Nil
2006 </programlisting>
2007
2008 </para>
2009
2010 <para>
2011 The data type <literal>Foo</literal> has two constructors with types:
2012 </para>
2013
2014 <para>
2015
2016 <programlisting>
2017   MkFoo :: forall a. a -> (a -> Bool) -> Foo
2018   Nil   :: Foo
2019 </programlisting>
2020
2021 </para>
2022
2023 <para>
2024 Notice that the type variable <literal>a</literal> in the type of <function>MkFoo</function>
2025 does not appear in the data type itself, which is plain <literal>Foo</literal>.
2026 For example, the following expression is fine:
2027 </para>
2028
2029 <para>
2030
2031 <programlisting>
2032   [MkFoo 3 even, MkFoo 'c' isUpper] :: [Foo]
2033 </programlisting>
2034
2035 </para>
2036
2037 <para>
2038 Here, <literal>(MkFoo 3 even)</literal> packages an integer with a function
2039 <function>even</function> that maps an integer to <literal>Bool</literal>; and <function>MkFoo 'c'
2040 isUpper</function> packages a character with a compatible function.  These
2041 two things are each of type <literal>Foo</literal> and can be put in a list.
2042 </para>
2043
2044 <para>
2045 What can we do with a value of type <literal>Foo</literal>?.  In particular,
2046 what happens when we pattern-match on <function>MkFoo</function>?
2047 </para>
2048
2049 <para>
2050
2051 <programlisting>
2052   f (MkFoo val fn) = ???
2053 </programlisting>
2054
2055 </para>
2056
2057 <para>
2058 Since all we know about <literal>val</literal> and <function>fn</function> is that they
2059 are compatible, the only (useful) thing we can do with them is to
2060 apply <function>fn</function> to <literal>val</literal> to get a boolean.  For example:
2061 </para>
2062
2063 <para>
2064
2065 <programlisting>
2066   f :: Foo -> Bool
2067   f (MkFoo val fn) = fn val
2068 </programlisting>
2069
2070 </para>
2071
2072 <para>
2073 What this allows us to do is to package heterogeneous values
2074 together with a bunch of functions that manipulate them, and then treat
2075 that collection of packages in a uniform manner.  You can express
2076 quite a bit of object-oriented-like programming this way.
2077 </para>
2078
2079 <sect3 id="existential">
2080 <title>Why existential?
2081 </title>
2082
2083 <para>
2084 What has this to do with <emphasis>existential</emphasis> quantification?
2085 Simply that <function>MkFoo</function> has the (nearly) isomorphic type
2086 </para>
2087
2088 <para>
2089
2090 <programlisting>
2091   MkFoo :: (exists a . (a, a -> Bool)) -> Foo
2092 </programlisting>
2093
2094 </para>
2095
2096 <para>
2097 But Haskell programmers can safely think of the ordinary
2098 <emphasis>universally</emphasis> quantified type given above, thereby avoiding
2099 adding a new existential quantification construct.
2100 </para>
2101
2102 </sect3>
2103
2104 <sect3 id="existential-with-context">
2105 <title>Existentials and type classes</title>
2106
2107 <para>
2108 An easy extension is to allow
2109 arbitrary contexts before the constructor.  For example:
2110 </para>
2111
2112 <para>
2113
2114 <programlisting>
2115 data Baz = forall a. Eq a => Baz1 a a
2116          | forall b. Show b => Baz2 b (b -> b)
2117 </programlisting>
2118
2119 </para>
2120
2121 <para>
2122 The two constructors have the types you'd expect:
2123 </para>
2124
2125 <para>
2126
2127 <programlisting>
2128 Baz1 :: forall a. Eq a => a -> a -> Baz
2129 Baz2 :: forall b. Show b => b -> (b -> b) -> Baz
2130 </programlisting>
2131
2132 </para>
2133
2134 <para>
2135 But when pattern matching on <function>Baz1</function> the matched values can be compared
2136 for equality, and when pattern matching on <function>Baz2</function> the first matched
2137 value can be converted to a string (as well as applying the function to it).
2138 So this program is legal:
2139 </para>
2140
2141 <para>
2142
2143 <programlisting>
2144   f :: Baz -> String
2145   f (Baz1 p q) | p == q    = "Yes"
2146                | otherwise = "No"
2147   f (Baz2 v fn)            = show (fn v)
2148 </programlisting>
2149
2150 </para>
2151
2152 <para>
2153 Operationally, in a dictionary-passing implementation, the
2154 constructors <function>Baz1</function> and <function>Baz2</function> must store the
2155 dictionaries for <literal>Eq</literal> and <literal>Show</literal> respectively, and
2156 extract it on pattern matching.
2157 </para>
2158
2159 </sect3>
2160
2161 <sect3 id="existential-records">
2162 <title>Record Constructors</title>
2163
2164 <para>
2165 GHC allows existentials to be used with records syntax as well.  For example:
2166
2167 <programlisting>
2168 data Counter a = forall self. NewCounter
2169     { _this    :: self
2170     , _inc     :: self -> self
2171     , _display :: self -> IO ()
2172     , tag      :: a
2173     }
2174 </programlisting>
2175 Here <literal>tag</literal> is a public field, with a well-typed selector
2176 function <literal>tag :: Counter a -> a</literal>.  The <literal>self</literal>
2177 type is hidden from the outside; any attempt to apply <literal>_this</literal>,
2178 <literal>_inc</literal> or <literal>_display</literal> as functions will raise a
2179 compile-time error.  In other words, <emphasis>GHC defines a record selector function
2180 only for fields whose type does not mention the existentially-quantified variables</emphasis>.
2181 (This example used an underscore in the fields for which record selectors
2182 will not be defined, but that is only programming style; GHC ignores them.)
2183 </para>
2184
2185 <para>
2186 To make use of these hidden fields, we need to create some helper functions:
2187
2188 <programlisting>
2189 inc :: Counter a -> Counter a
2190 inc (NewCounter x i d t) = NewCounter
2191     { _this = i x, _inc = i, _display = d, tag = t } 
2192
2193 display :: Counter a -> IO ()
2194 display NewCounter{ _this = x, _display = d } = d x
2195 </programlisting>
2196
2197 Now we can define counters with different underlying implementations:
2198
2199 <programlisting>
2200 counterA :: Counter String 
2201 counterA = NewCounter
2202     { _this = 0, _inc = (1+), _display = print, tag = "A" }
2203
2204 counterB :: Counter String 
2205 counterB = NewCounter
2206     { _this = "", _inc = ('#':), _display = putStrLn, tag = "B" }
2207
2208 main = do
2209     display (inc counterA)         -- prints "1"
2210     display (inc (inc counterB))   -- prints "##"
2211 </programlisting>
2212
2213 Record update syntax is supported for existentials (and GADTs):
2214 <programlisting>
2215 setTag :: Counter a -> a -> Counter a
2216 setTag obj t = obj{ tag = t }
2217 </programlisting>
2218 The rule for record update is this: <emphasis>
2219 the types of the updated fields may
2220 mention only the universally-quantified type variables
2221 of the data constructor.  For GADTs, the field may mention only types
2222 that appear as a simple type-variable argument in the constructor's result
2223 type</emphasis>.  For example:
2224 <programlisting>
2225 data T a b where { T1 { f1::a, f2::b, f3::(b,c) } :: T a b } -- c is existential
2226 upd1 t x = t { f1=x }   -- OK:   upd1 :: T a b -> a' -> T a' b
2227 upd2 t x = t { f3=x }   -- BAD   (f3's type mentions c, which is
2228                         --        existentially quantified)
2229
2230 data G a b where { G1 { g1::a, g2::c } :: G a [c] }
2231 upd3 g x = g { g1=x }   -- OK:   upd3 :: G a b -> c -> G c b
2232 upd4 g x = g { g2=x }   -- BAD (f2's type mentions c, which is not a simple
2233                         --      type-variable argument in G1's result type)
2234 </programlisting>
2235 </para>
2236
2237 </sect3>
2238
2239
2240 <sect3>
2241 <title>Restrictions</title>
2242
2243 <para>
2244 There are several restrictions on the ways in which existentially-quantified
2245 constructors can be use.
2246 </para>
2247
2248 <para>
2249
2250 <itemizedlist>
2251 <listitem>
2252
2253 <para>
2254  When pattern matching, each pattern match introduces a new,
2255 distinct, type for each existential type variable.  These types cannot
2256 be unified with any other type, nor can they escape from the scope of
2257 the pattern match.  For example, these fragments are incorrect:
2258
2259
2260 <programlisting>
2261 f1 (MkFoo a f) = a
2262 </programlisting>
2263
2264
2265 Here, the type bound by <function>MkFoo</function> "escapes", because <literal>a</literal>
2266 is the result of <function>f1</function>.  One way to see why this is wrong is to
2267 ask what type <function>f1</function> has:
2268
2269
2270 <programlisting>
2271   f1 :: Foo -> a             -- Weird!
2272 </programlisting>
2273
2274
2275 What is this "<literal>a</literal>" in the result type? Clearly we don't mean
2276 this:
2277
2278
2279 <programlisting>
2280   f1 :: forall a. Foo -> a   -- Wrong!
2281 </programlisting>
2282
2283
2284 The original program is just plain wrong.  Here's another sort of error
2285
2286
2287 <programlisting>
2288   f2 (Baz1 a b) (Baz1 p q) = a==q
2289 </programlisting>
2290
2291
2292 It's ok to say <literal>a==b</literal> or <literal>p==q</literal>, but
2293 <literal>a==q</literal> is wrong because it equates the two distinct types arising
2294 from the two <function>Baz1</function> constructors.
2295
2296
2297 </para>
2298 </listitem>
2299 <listitem>
2300
2301 <para>
2302 You can't pattern-match on an existentially quantified
2303 constructor in a <literal>let</literal> or <literal>where</literal> group of
2304 bindings. So this is illegal:
2305
2306
2307 <programlisting>
2308   f3 x = a==b where { Baz1 a b = x }
2309 </programlisting>
2310
2311 Instead, use a <literal>case</literal> expression:
2312
2313 <programlisting>
2314   f3 x = case x of Baz1 a b -> a==b
2315 </programlisting>
2316
2317 In general, you can only pattern-match
2318 on an existentially-quantified constructor in a <literal>case</literal> expression or
2319 in the patterns of a function definition.
2320
2321 The reason for this restriction is really an implementation one.
2322 Type-checking binding groups is already a nightmare without
2323 existentials complicating the picture.  Also an existential pattern
2324 binding at the top level of a module doesn't make sense, because it's
2325 not clear how to prevent the existentially-quantified type "escaping".
2326 So for now, there's a simple-to-state restriction.  We'll see how
2327 annoying it is.
2328
2329 </para>
2330 </listitem>
2331 <listitem>
2332
2333 <para>
2334 You can't use existential quantification for <literal>newtype</literal>
2335 declarations.  So this is illegal:
2336
2337
2338 <programlisting>
2339   newtype T = forall a. Ord a => MkT a
2340 </programlisting>
2341
2342
2343 Reason: a value of type <literal>T</literal> must be represented as a
2344 pair of a dictionary for <literal>Ord t</literal> and a value of type
2345 <literal>t</literal>.  That contradicts the idea that
2346 <literal>newtype</literal> should have no concrete representation.
2347 You can get just the same efficiency and effect by using
2348 <literal>data</literal> instead of <literal>newtype</literal>.  If
2349 there is no overloading involved, then there is more of a case for
2350 allowing an existentially-quantified <literal>newtype</literal>,
2351 because the <literal>data</literal> version does carry an
2352 implementation cost, but single-field existentially quantified
2353 constructors aren't much use.  So the simple restriction (no
2354 existential stuff on <literal>newtype</literal>) stands, unless there
2355 are convincing reasons to change it.
2356
2357
2358 </para>
2359 </listitem>
2360 <listitem>
2361
2362 <para>
2363  You can't use <literal>deriving</literal> to define instances of a
2364 data type with existentially quantified data constructors.
2365
2366 Reason: in most cases it would not make sense. For example:;
2367
2368 <programlisting>
2369 data T = forall a. MkT [a] deriving( Eq )
2370 </programlisting>
2371
2372 To derive <literal>Eq</literal> in the standard way we would need to have equality
2373 between the single component of two <function>MkT</function> constructors:
2374
2375 <programlisting>
2376 instance Eq T where
2377   (MkT a) == (MkT b) = ???
2378 </programlisting>
2379
2380 But <varname>a</varname> and <varname>b</varname> have distinct types, and so can't be compared.
2381 It's just about possible to imagine examples in which the derived instance
2382 would make sense, but it seems altogether simpler simply to prohibit such
2383 declarations.  Define your own instances!
2384 </para>
2385 </listitem>
2386
2387 </itemizedlist>
2388
2389 </para>
2390
2391 </sect3>
2392 </sect2>
2393
2394 <!-- ====================== Generalised algebraic data types =======================  -->
2395
2396 <sect2 id="gadt-style">
2397 <title>Declaring data types with explicit constructor signatures</title>
2398
2399 <para>GHC allows you to declare an algebraic data type by 
2400 giving the type signatures of constructors explicitly.  For example:
2401 <programlisting>
2402   data Maybe a where
2403       Nothing :: Maybe a
2404       Just    :: a -> Maybe a
2405 </programlisting>
2406 The form is called a "GADT-style declaration"
2407 because Generalised Algebraic Data Types, described in <xref linkend="gadt"/>, 
2408 can only be declared using this form.</para>
2409 <para>Notice that GADT-style syntax generalises existential types (<xref linkend="existential-quantification"/>).  
2410 For example, these two declarations are equivalent:
2411 <programlisting>
2412   data Foo = forall a. MkFoo a (a -> Bool)
2413   data Foo' where { MKFoo :: a -> (a->Bool) -> Foo' }
2414 </programlisting>
2415 </para>
2416 <para>Any data type that can be declared in standard Haskell-98 syntax 
2417 can also be declared using GADT-style syntax.
2418 The choice is largely stylistic, but GADT-style declarations differ in one important respect:
2419 they treat class constraints on the data constructors differently.
2420 Specifically, if the constructor is given a type-class context, that
2421 context is made available by pattern matching.  For example:
2422 <programlisting>
2423   data Set a where
2424     MkSet :: Eq a => [a] -> Set a
2425
2426   makeSet :: Eq a => [a] -> Set a
2427   makeSet xs = MkSet (nub xs)
2428
2429   insert :: a -> Set a -> Set a
2430   insert a (MkSet as) | a `elem` as = MkSet as
2431                       | otherwise   = MkSet (a:as)
2432 </programlisting>
2433 A use of <literal>MkSet</literal> as a constructor (e.g. in the definition of <literal>makeSet</literal>) 
2434 gives rise to a <literal>(Eq a)</literal>
2435 constraint, as you would expect.  The new feature is that pattern-matching on <literal>MkSet</literal>
2436 (as in the definition of <literal>insert</literal>) makes <emphasis>available</emphasis> an <literal>(Eq a)</literal>
2437 context.  In implementation terms, the <literal>MkSet</literal> constructor has a hidden field that stores
2438 the <literal>(Eq a)</literal> dictionary that is passed to <literal>MkSet</literal>; so
2439 when pattern-matching that dictionary becomes available for the right-hand side of the match.
2440 In the example, the equality dictionary is used to satisfy the equality constraint 
2441 generated by the call to <literal>elem</literal>, so that the type of
2442 <literal>insert</literal> itself has no <literal>Eq</literal> constraint.
2443 </para>
2444 <para>
2445 For example, one possible application is to reify dictionaries:
2446 <programlisting>
2447    data NumInst a where
2448      MkNumInst :: Num a => NumInst a
2449
2450    intInst :: NumInst Int
2451    intInst = MkNumInst
2452
2453    plus :: NumInst a -> a -> a -> a
2454    plus MkNumInst p q = p + q
2455 </programlisting>
2456 Here, a value of type <literal>NumInst a</literal> is equivalent 
2457 to an explicit <literal>(Num a)</literal> dictionary.
2458 </para>
2459 <para>
2460 All this applies to constructors declared using the syntax of <xref linkend="existential-with-context"/>.
2461 For example, the <literal>NumInst</literal> data type above could equivalently be declared 
2462 like this:
2463 <programlisting>
2464    data NumInst a 
2465       = Num a => MkNumInst (NumInst a)
2466 </programlisting>
2467 Notice that, unlike the situation when declaring an existential, there is 
2468 no <literal>forall</literal>, because the <literal>Num</literal> constrains the
2469 data type's universally quantified type variable <literal>a</literal>.  
2470 A constructor may have both universal and existential type variables: for example,
2471 the following two declarations are equivalent:
2472 <programlisting>
2473    data T1 a 
2474         = forall b. (Num a, Eq b) => MkT1 a b
2475    data T2 a where
2476         MkT2 :: (Num a, Eq b) => a -> b -> T2 a
2477 </programlisting>
2478 </para>
2479 <para>All this behaviour contrasts with Haskell 98's peculiar treatment of 
2480 contexts on a data type declaration (Section 4.2.1 of the Haskell 98 Report).
2481 In Haskell 98 the definition
2482 <programlisting>
2483   data Eq a => Set' a = MkSet' [a]
2484 </programlisting>
2485 gives <literal>MkSet'</literal> the same type as <literal>MkSet</literal> above.  But instead of 
2486 <emphasis>making available</emphasis> an <literal>(Eq a)</literal> constraint, pattern-matching
2487 on <literal>MkSet'</literal> <emphasis>requires</emphasis> an <literal>(Eq a)</literal> constraint!
2488 GHC faithfully implements this behaviour, odd though it is.  But for GADT-style declarations,
2489 GHC's behaviour is much more useful, as well as much more intuitive.
2490 </para>
2491
2492 <para>
2493 The rest of this section gives further details about GADT-style data
2494 type declarations.
2495
2496 <itemizedlist>
2497 <listitem><para>
2498 The result type of each data constructor must begin with the type constructor being defined.
2499 If the result type of all constructors 
2500 has the form <literal>T a1 ... an</literal>, where <literal>a1 ... an</literal>
2501 are distinct type variables, then the data type is <emphasis>ordinary</emphasis>;
2502 otherwise is a <emphasis>generalised</emphasis> data type (<xref linkend="gadt"/>).
2503 </para></listitem>
2504
2505 <listitem><para>
2506 As with other type signatures, you can give a single signature for several data constructors.
2507 In this example we give a single signature for <literal>T1</literal> and <literal>T2</literal>:
2508 <programlisting>
2509   data T a where
2510     T1,T2 :: a -> T a
2511     T3 :: T a
2512 </programlisting>
2513 </para></listitem>
2514
2515 <listitem><para>
2516 The type signature of
2517 each constructor is independent, and is implicitly universally quantified as usual. 
2518 In particular, the type variable(s) in the "<literal>data T a where</literal>" header 
2519 have no scope, and different constructors may have different universally-quantified type variables:
2520 <programlisting>
2521   data T a where        -- The 'a' has no scope
2522     T1,T2 :: b -> T b   -- Means forall b. b -> T b
2523     T3 :: T a           -- Means forall a. T a
2524 </programlisting>
2525 </para></listitem>
2526
2527 <listitem><para>
2528 A constructor signature may mention type class constraints, which can differ for
2529 different constructors.  For example, this is fine:
2530 <programlisting>
2531   data T a where
2532     T1 :: Eq b => b -> b -> T b
2533     T2 :: (Show c, Ix c) => c -> [c] -> T c
2534 </programlisting>
2535 When patten matching, these constraints are made available to discharge constraints
2536 in the body of the match. For example:
2537 <programlisting>
2538   f :: T a -> String
2539   f (T1 x y) | x==y      = "yes"
2540              | otherwise = "no"
2541   f (T2 a b)             = show a
2542 </programlisting>
2543 Note that <literal>f</literal> is not overloaded; the <literal>Eq</literal> constraint arising
2544 from the use of <literal>==</literal> is discharged by the pattern match on <literal>T1</literal>
2545 and similarly the <literal>Show</literal> constraint arising from the use of <literal>show</literal>.
2546 </para></listitem>
2547
2548 <listitem><para>
2549 Unlike a Haskell-98-style 
2550 data type declaration, the type variable(s) in the "<literal>data Set a where</literal>" header 
2551 have no scope.  Indeed, one can write a kind signature instead:
2552 <programlisting>
2553   data Set :: * -> * where ...
2554 </programlisting>
2555 or even a mixture of the two:
2556 <programlisting>
2557   data Bar a :: (* -> *) -> * where ...
2558 </programlisting>
2559 The type variables (if given) may be explicitly kinded, so we could also write the header for <literal>Foo</literal>
2560 like this:
2561 <programlisting>
2562   data Bar a (b :: * -> *) where ...
2563 </programlisting>
2564 </para></listitem>
2565
2566
2567 <listitem><para>
2568 You can use strictness annotations, in the obvious places
2569 in the constructor type:
2570 <programlisting>
2571   data Term a where
2572       Lit    :: !Int -> Term Int
2573       If     :: Term Bool -> !(Term a) -> !(Term a) -> Term a
2574       Pair   :: Term a -> Term b -> Term (a,b)
2575 </programlisting>
2576 </para></listitem>
2577
2578 <listitem><para>
2579 You can use a <literal>deriving</literal> clause on a GADT-style data type
2580 declaration.   For example, these two declarations are equivalent
2581 <programlisting>
2582   data Maybe1 a where {
2583       Nothing1 :: Maybe1 a ;
2584       Just1    :: a -> Maybe1 a
2585     } deriving( Eq, Ord )
2586
2587   data Maybe2 a = Nothing2 | Just2 a 
2588        deriving( Eq, Ord )
2589 </programlisting>
2590 </para></listitem>
2591
2592 <listitem><para>
2593 The type signature may have quantified type variables that do not appear
2594 in the result type:
2595 <programlisting>
2596   data Foo where
2597      MkFoo :: a -> (a->Bool) -> Foo
2598      Nil   :: Foo
2599 </programlisting>
2600 Here the type variable <literal>a</literal> does not appear in the result type
2601 of either constructor.  
2602 Although it is universally quantified in the type of the constructor, such
2603 a type variable is often called "existential".  
2604 Indeed, the above declaration declares precisely the same type as 
2605 the <literal>data Foo</literal> in <xref linkend="existential-quantification"/>.
2606 </para><para>
2607 The type may contain a class context too, of course:
2608 <programlisting>
2609   data Showable where
2610     MkShowable :: Show a => a -> Showable
2611 </programlisting>
2612 </para></listitem>
2613
2614 <listitem><para>
2615 You can use record syntax on a GADT-style data type declaration:
2616
2617 <programlisting>
2618   data Person where
2619       Adult :: { name :: String, children :: [Person] } -> Person
2620       Child :: Show a => { name :: !String, funny :: a } -> Person
2621 </programlisting>
2622 As usual, for every constructor that has a field <literal>f</literal>, the type of
2623 field <literal>f</literal> must be the same (modulo alpha conversion).
2624 The <literal>Child</literal> constructor above shows that the signature
2625 may have a context, existentially-quantified variables, and strictness annotations, 
2626 just as in the non-record case.  (NB: the "type" that follows the double-colon
2627 is not really a type, because of the record syntax and strictness annotations.
2628 A "type" of this form can appear only in a constructor signature.)
2629 </para></listitem>
2630
2631 <listitem><para> 
2632 Record updates are allowed with GADT-style declarations, 
2633 only fields that have the following property: the type of the field
2634 mentions no existential type variables.
2635 </para></listitem>
2636
2637 <listitem><para> 
2638 As in the case of existentials declared using the Haskell-98-like record syntax 
2639 (<xref linkend="existential-records"/>),
2640 record-selector functions are generated only for those fields that have well-typed
2641 selectors.  
2642 Here is the example of that section, in GADT-style syntax:
2643 <programlisting>
2644 data Counter a where
2645     NewCounter { _this    :: self
2646                , _inc     :: self -> self
2647                , _display :: self -> IO ()
2648                , tag      :: a
2649                }
2650         :: Counter a
2651 </programlisting>
2652 As before, only one selector function is generated here, that for <literal>tag</literal>.
2653 Nevertheless, you can still use all the field names in pattern matching and record construction.
2654 </para></listitem>
2655 </itemizedlist></para>
2656 </sect2>
2657
2658 <sect2 id="gadt">
2659 <title>Generalised Algebraic Data Types (GADTs)</title>
2660
2661 <para>Generalised Algebraic Data Types generalise ordinary algebraic data types 
2662 by allowing constructors to have richer return types.  Here is an example:
2663 <programlisting>
2664   data Term a where
2665       Lit    :: Int -> Term Int
2666       Succ   :: Term Int -> Term Int
2667       IsZero :: Term Int -> Term Bool   
2668       If     :: Term Bool -> Term a -> Term a -> Term a
2669       Pair   :: Term a -> Term b -> Term (a,b)
2670 </programlisting>
2671 Notice that the return type of the constructors is not always <literal>Term a</literal>, as is the
2672 case with ordinary data types.  This generality allows us to 
2673 write a well-typed <literal>eval</literal> function
2674 for these <literal>Terms</literal>:
2675 <programlisting>
2676   eval :: Term a -> a
2677   eval (Lit i)      = i
2678   eval (Succ t)     = 1 + eval t
2679   eval (IsZero t)   = eval t == 0
2680   eval (If b e1 e2) = if eval b then eval e1 else eval e2
2681   eval (Pair e1 e2) = (eval e1, eval e2)
2682 </programlisting>
2683 The key point about GADTs is that <emphasis>pattern matching causes type refinement</emphasis>.  
2684 For example, in the right hand side of the equation
2685 <programlisting>
2686   eval :: Term a -> a
2687   eval (Lit i) =  ...
2688 </programlisting>
2689 the type <literal>a</literal> is refined to <literal>Int</literal>.  That's the whole point!
2690 A precise specification of the type rules is beyond what this user manual aspires to, 
2691 but the design closely follows that described in
2692 the paper <ulink
2693 url="http://research.microsoft.com/%7Esimonpj/papers/gadt/">Simple
2694 unification-based type inference for GADTs</ulink>,
2695 (ICFP 2006).
2696 The general principle is this: <emphasis>type refinement is only carried out 
2697 based on user-supplied type annotations</emphasis>.
2698 So if no type signature is supplied for <literal>eval</literal>, no type refinement happens, 
2699 and lots of obscure error messages will
2700 occur.  However, the refinement is quite general.  For example, if we had:
2701 <programlisting>
2702   eval :: Term a -> a -> a
2703   eval (Lit i) j =  i+j
2704 </programlisting>
2705 the pattern match causes the type <literal>a</literal> to be refined to <literal>Int</literal> (because of the type
2706 of the constructor <literal>Lit</literal>), and that refinement also applies to the type of <literal>j</literal>, and
2707 the result type of the <literal>case</literal> expression.  Hence the addition <literal>i+j</literal> is legal.
2708 </para>
2709 <para>
2710 These and many other examples are given in papers by Hongwei Xi, and
2711 Tim Sheard. There is a longer introduction
2712 <ulink url="http://www.haskell.org/haskellwiki/GADT">on the wiki</ulink>,
2713 and Ralf Hinze's
2714 <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
2715 may use different notation to that implemented in GHC.
2716 </para>
2717 <para>
2718 The rest of this section outlines the extensions to GHC that support GADTs.   The extension is enabled with 
2719 <option>-XGADTs</option>.  The <option>-XGADTs</option> flag also sets <option>-XRelaxedPolyRec</option>.
2720 <itemizedlist>
2721 <listitem><para>
2722 A GADT can only be declared using GADT-style syntax (<xref linkend="gadt-style"/>); 
2723 the old Haskell-98 syntax for data declarations always declares an ordinary data type.
2724 The result type of each constructor must begin with the type constructor being defined,
2725 but for a GADT the arguments to the type constructor can be arbitrary monotypes.  
2726 For example, in the <literal>Term</literal> data
2727 type above, the type of each constructor must end with <literal>Term ty</literal>, but
2728 the <literal>ty</literal> need not be a type variable (e.g. the <literal>Lit</literal>
2729 constructor).
2730 </para></listitem>
2731
2732 <listitem><para>
2733 It is permitted to declare an ordinary algebraic data type using GADT-style syntax.
2734 What makes a GADT into a GADT is not the syntax, but rather the presence of data constructors
2735 whose result type is not just <literal>T a b</literal>.
2736 </para></listitem>
2737
2738 <listitem><para>
2739 You cannot use a <literal>deriving</literal> clause for a GADT; only for
2740 an ordinary data type.
2741 </para></listitem>
2742
2743 <listitem><para>
2744 As mentioned in <xref linkend="gadt-style"/>, record syntax is supported.
2745 For example:
2746 <programlisting>
2747   data Term a where
2748       Lit    { val  :: Int }      :: Term Int
2749       Succ   { num  :: Term Int } :: Term Int
2750       Pred   { num  :: Term Int } :: Term Int
2751       IsZero { arg  :: Term Int } :: Term Bool  
2752       Pair   { arg1 :: Term a
2753              , arg2 :: Term b
2754              }                    :: Term (a,b)
2755       If     { cnd  :: Term Bool
2756              , tru  :: Term a
2757              , fls  :: Term a
2758              }                    :: Term a
2759 </programlisting>
2760 However, for GADTs there is the following additional constraint: 
2761 every constructor that has a field <literal>f</literal> must have
2762 the same result type (modulo alpha conversion)
2763 Hence, in the above example, we cannot merge the <literal>num</literal> 
2764 and <literal>arg</literal> fields above into a 
2765 single name.  Although their field types are both <literal>Term Int</literal>,
2766 their selector functions actually have different types:
2767
2768 <programlisting>
2769   num :: Term Int -> Term Int
2770   arg :: Term Bool -> Term Int
2771 </programlisting>
2772 </para></listitem>
2773
2774 <listitem><para>
2775 When pattern-matching against data constructors drawn from a GADT, 
2776 for example in a <literal>case</literal> expression, the following rules apply:
2777 <itemizedlist>
2778 <listitem><para>The type of the scrutinee must be rigid.</para></listitem>
2779 <listitem><para>The type of the entire <literal>case</literal> expression must be rigid.</para></listitem>
2780 <listitem><para>The type of any free variable mentioned in any of
2781 the <literal>case</literal> alternatives must be rigid.</para></listitem>
2782 </itemizedlist>
2783 A type is "rigid" if it is completely known to the compiler at its binding site.  The easiest
2784 way to ensure that a variable a rigid type is to give it a type signature.
2785 For more precise details see <ulink url="http://research.microsoft.com/%7Esimonpj/papers/gadt">
2786 Simple unification-based type inference for GADTs
2787 </ulink>. The criteria implemented by GHC are given in the Appendix.
2788
2789 </para></listitem>
2790
2791 </itemizedlist>
2792 </para>
2793
2794 </sect2>
2795 </sect1>
2796
2797 <!-- ====================== End of Generalised algebraic data types =======================  -->
2798
2799 <sect1 id="deriving">
2800 <title>Extensions to the "deriving" mechanism</title>
2801
2802 <sect2 id="deriving-inferred">
2803 <title>Inferred context for deriving clauses</title>
2804
2805 <para>
2806 The Haskell Report is vague about exactly when a <literal>deriving</literal> clause is
2807 legal.  For example:
2808 <programlisting>
2809   data T0 f a = MkT0 a         deriving( Eq )
2810   data T1 f a = MkT1 (f a)     deriving( Eq )
2811   data T2 f a = MkT2 (f (f a)) deriving( Eq )
2812 </programlisting>
2813 The natural generated <literal>Eq</literal> code would result in these instance declarations:
2814 <programlisting>
2815   instance Eq a         => Eq (T0 f a) where ...
2816   instance Eq (f a)     => Eq (T1 f a) where ...
2817   instance Eq (f (f a)) => Eq (T2 f a) where ...
2818 </programlisting>
2819 The first of these is obviously fine. The second is still fine, although less obviously. 
2820 The third is not Haskell 98, and risks losing termination of instances.
2821 </para>
2822 <para>
2823 GHC takes a conservative position: it accepts the first two, but not the third.  The  rule is this:
2824 each constraint in the inferred instance context must consist only of type variables, 
2825 with no repetitions.
2826 </para>
2827 <para>
2828 This rule is applied regardless of flags.  If you want a more exotic context, you can write
2829 it yourself, using the <link linkend="stand-alone-deriving">standalone deriving mechanism</link>.
2830 </para>
2831 </sect2>
2832
2833 <sect2 id="stand-alone-deriving">
2834 <title>Stand-alone deriving declarations</title>
2835
2836 <para>
2837 GHC now allows stand-alone <literal>deriving</literal> declarations, enabled by <literal>-XStandaloneDeriving</literal>:
2838 <programlisting>
2839   data Foo a = Bar a | Baz String
2840
2841   deriving instance Eq a => Eq (Foo a)
2842 </programlisting>
2843 The syntax is identical to that of an ordinary instance declaration apart from (a) the keyword
2844 <literal>deriving</literal>, and (b) the absence of the <literal>where</literal> part.
2845 Note the following points:
2846 <itemizedlist>
2847 <listitem><para>
2848 You must supply an explicit context (in the example the context is <literal>(Eq a)</literal>), 
2849 exactly as you would in an ordinary instance declaration.
2850 (In contrast, in a <literal>deriving</literal> clause 
2851 attached to a data type declaration, the context is inferred.) 
2852 </para></listitem>
2853
2854 <listitem><para>
2855 A <literal>deriving instance</literal> declaration
2856 must obey the same rules concerning form and termination as ordinary instance declarations,
2857 controlled by the same flags; see <xref linkend="instance-decls"/>.
2858 </para></listitem>
2859
2860 <listitem><para>
2861 Unlike a <literal>deriving</literal>
2862 declaration attached to a <literal>data</literal> declaration, the instance can be more specific
2863 than the data type (assuming you also use 
2864 <literal>-XFlexibleInstances</literal>, <xref linkend="instance-rules"/>).  Consider
2865 for example
2866 <programlisting>
2867   data Foo a = Bar a | Baz String
2868
2869   deriving instance Eq a => Eq (Foo [a])
2870   deriving instance Eq a => Eq (Foo (Maybe a))
2871 </programlisting>
2872 This will generate a derived instance for <literal>(Foo [a])</literal> and <literal>(Foo (Maybe a))</literal>,
2873 but other types such as <literal>(Foo (Int,Bool))</literal> will not be an instance of <literal>Eq</literal>.
2874 </para></listitem>
2875
2876 <listitem><para>
2877 Unlike a <literal>deriving</literal>
2878 declaration attached to a <literal>data</literal> declaration, 
2879 GHC does not restrict the form of the data type.  Instead, GHC simply generates the appropriate
2880 boilerplate code for the specified class, and typechecks it. If there is a type error, it is
2881 your problem. (GHC will show you the offending code if it has a type error.) 
2882 The merit of this is that you can derive instances for GADTs and other exotic
2883 data types, providing only that the boilerplate code does indeed typecheck.  For example:
2884 <programlisting>
2885   data T a where
2886      T1 :: T Int
2887      T2 :: T Bool
2888
2889   deriving instance Show (T a)
2890 </programlisting>
2891 In this example, you cannot say <literal>... deriving( Show )</literal> on the 
2892 data type declaration for <literal>T</literal>, 
2893 because <literal>T</literal> is a GADT, but you <emphasis>can</emphasis> generate
2894 the instance declaration using stand-alone deriving.
2895 </para>
2896 </listitem>
2897
2898 <listitem>
2899 <para>The stand-alone syntax is generalised for newtypes in exactly the same
2900 way that ordinary <literal>deriving</literal> clauses are generalised (<xref linkend="newtype-deriving"/>).
2901 For example:
2902 <programlisting>
2903   newtype Foo a = MkFoo (State Int a)
2904
2905   deriving instance MonadState Int Foo
2906 </programlisting>
2907 GHC always treats the <emphasis>last</emphasis> parameter of the instance
2908 (<literal>Foo</literal> in this example) as the type whose instance is being derived.
2909 </para></listitem>
2910 </itemizedlist></para>
2911
2912 </sect2>
2913
2914
2915 <sect2 id="deriving-typeable">
2916 <title>Deriving clause for extra classes (<literal>Typeable</literal>, <literal>Data</literal>, etc)</title>
2917
2918 <para>
2919 Haskell 98 allows the programmer to add "<literal>deriving( Eq, Ord )</literal>" to a data type 
2920 declaration, to generate a standard instance declaration for classes specified in the <literal>deriving</literal> clause.  
2921 In Haskell 98, the only classes that may appear in the <literal>deriving</literal> clause are the standard
2922 classes <literal>Eq</literal>, <literal>Ord</literal>, 
2923 <literal>Enum</literal>, <literal>Ix</literal>, <literal>Bounded</literal>, <literal>Read</literal>, and <literal>Show</literal>.
2924 </para>
2925 <para>
2926 GHC extends this list with several more classes that may be automatically derived:
2927 <itemizedlist>
2928 <listitem><para> With <option>-XDeriveDataTypeable</option>, you can derive instances of the classes
2929 <literal>Typeable</literal>, and <literal>Data</literal>, defined in the library
2930 modules <literal>Data.Typeable</literal> and <literal>Data.Generics</literal> respectively.
2931 </para>
2932 <para>An instance of <literal>Typeable</literal> can only be derived if the
2933 data type has seven or fewer type parameters, all of kind <literal>*</literal>.
2934 The reason for this is that the <literal>Typeable</literal> class is derived using the scheme
2935 described in
2936 <ulink url="http://research.microsoft.com/%7Esimonpj/papers/hmap/gmap2.ps">
2937 Scrap More Boilerplate: Reflection, Zips, and Generalised Casts
2938 </ulink>.
2939 (Section 7.4 of the paper describes the multiple <literal>Typeable</literal> classes that
2940 are used, and only <literal>Typeable1</literal> up to
2941 <literal>Typeable7</literal> are provided in the library.)
2942 In other cases, there is nothing to stop the programmer writing a <literal>TypableX</literal>
2943 class, whose kind suits that of the data type constructor, and
2944 then writing the data type instance by hand.
2945 </para>
2946 </listitem>
2947
2948 <listitem><para> With <option>-XDeriveFunctor</option>, you can derive instances of 
2949 the class <literal>Functor</literal>,
2950 defined in <literal>GHC.Base</literal>.
2951 </para></listitem>
2952
2953 <listitem><para> With <option>-XDeriveFoldable</option>, you can derive instances of 
2954 the class <literal>Foldable</literal>,
2955 defined in <literal>Data.Foldable</literal>.
2956 </para></listitem>
2957
2958 <listitem><para> With <option>-XDeriveTraversable</option>, you can derive instances of 
2959 the class <literal>Traversable</literal>,
2960 defined in <literal>Data.Traversable</literal>.
2961 </para></listitem>
2962 </itemizedlist>
2963 In each case the appropriate class must be in scope before it 
2964 can be mentioned in the <literal>deriving</literal> clause.
2965 </para>
2966 </sect2>
2967
2968 <sect2 id="newtype-deriving">
2969 <title>Generalised derived instances for newtypes</title>
2970
2971 <para>
2972 When you define an abstract type using <literal>newtype</literal>, you may want
2973 the new type to inherit some instances from its representation. In
2974 Haskell 98, you can inherit instances of <literal>Eq</literal>, <literal>Ord</literal>,
2975 <literal>Enum</literal> and <literal>Bounded</literal> by deriving them, but for any
2976 other classes you have to write an explicit instance declaration. For
2977 example, if you define
2978
2979 <programlisting>
2980   newtype Dollars = Dollars Int 
2981 </programlisting>
2982
2983 and you want to use arithmetic on <literal>Dollars</literal>, you have to
2984 explicitly define an instance of <literal>Num</literal>:
2985
2986 <programlisting>
2987   instance Num Dollars where
2988     Dollars a + Dollars b = Dollars (a+b)
2989     ...
2990 </programlisting>
2991 All the instance does is apply and remove the <literal>newtype</literal>
2992 constructor. It is particularly galling that, since the constructor
2993 doesn't appear at run-time, this instance declaration defines a
2994 dictionary which is <emphasis>wholly equivalent</emphasis> to the <literal>Int</literal>
2995 dictionary, only slower!
2996 </para>
2997
2998
2999 <sect3> <title> Generalising the deriving clause </title>
3000 <para>
3001 GHC now permits such instances to be derived instead, 
3002 using the flag <option>-XGeneralizedNewtypeDeriving</option>,
3003 so one can write 
3004 <programlisting>
3005   newtype Dollars = Dollars Int deriving (Eq,Show,Num)
3006 </programlisting>
3007
3008 and the implementation uses the <emphasis>same</emphasis> <literal>Num</literal> dictionary
3009 for <literal>Dollars</literal> as for <literal>Int</literal>. Notionally, the compiler
3010 derives an instance declaration of the form
3011
3012 <programlisting>
3013   instance Num Int => Num Dollars
3014 </programlisting>
3015
3016 which just adds or removes the <literal>newtype</literal> constructor according to the type.
3017 </para>
3018 <para>
3019
3020 We can also derive instances of constructor classes in a similar
3021 way. For example, suppose we have implemented state and failure monad
3022 transformers, such that
3023
3024 <programlisting>
3025   instance Monad m => Monad (State s m) 
3026   instance Monad m => Monad (Failure m)
3027 </programlisting>
3028 In Haskell 98, we can define a parsing monad by 
3029 <programlisting>
3030   type Parser tok m a = State [tok] (Failure m) a
3031 </programlisting>
3032
3033 which is automatically a monad thanks to the instance declarations
3034 above. With the extension, we can make the parser type abstract,
3035 without needing to write an instance of class <literal>Monad</literal>, via
3036
3037 <programlisting>
3038   newtype Parser tok m a = Parser (State [tok] (Failure m) a)
3039                          deriving Monad
3040 </programlisting>
3041 In this case the derived instance declaration is of the form 
3042 <programlisting>
3043   instance Monad (State [tok] (Failure m)) => Monad (Parser tok m) 
3044 </programlisting>
3045
3046 Notice that, since <literal>Monad</literal> is a constructor class, the
3047 instance is a <emphasis>partial application</emphasis> of the new type, not the
3048 entire left hand side. We can imagine that the type declaration is
3049 "eta-converted" to generate the context of the instance
3050 declaration.
3051 </para>
3052 <para>
3053
3054 We can even derive instances of multi-parameter classes, provided the
3055 newtype is the last class parameter. In this case, a ``partial
3056 application'' of the class appears in the <literal>deriving</literal>
3057 clause. For example, given the class
3058
3059 <programlisting>
3060   class StateMonad s m | m -> s where ... 
3061   instance Monad m => StateMonad s (State s m) where ... 
3062 </programlisting>
3063 then we can derive an instance of <literal>StateMonad</literal> for <literal>Parser</literal>s by 
3064 <programlisting>
3065   newtype Parser tok m a = Parser (State [tok] (Failure m) a)
3066                          deriving (Monad, StateMonad [tok])
3067 </programlisting>
3068
3069 The derived instance is obtained by completing the application of the
3070 class to the new type:
3071
3072 <programlisting>
3073   instance StateMonad [tok] (State [tok] (Failure m)) =>
3074            StateMonad [tok] (Parser tok m)
3075 </programlisting>
3076 </para>
3077 <para>
3078
3079 As a result of this extension, all derived instances in newtype
3080  declarations are treated uniformly (and implemented just by reusing
3081 the dictionary for the representation type), <emphasis>except</emphasis>
3082 <literal>Show</literal> and <literal>Read</literal>, which really behave differently for
3083 the newtype and its representation.
3084 </para>
3085 </sect3>
3086
3087 <sect3> <title> A more precise specification </title>
3088 <para>
3089 Derived instance declarations are constructed as follows. Consider the
3090 declaration (after expansion of any type synonyms)
3091
3092 <programlisting>
3093   newtype T v1...vn = T' (t vk+1...vn) deriving (c1...cm) 
3094 </programlisting>
3095
3096 where 
3097  <itemizedlist>
3098 <listitem><para>
3099   The <literal>ci</literal> are partial applications of
3100   classes of the form <literal>C t1'...tj'</literal>, where the arity of <literal>C</literal>
3101   is exactly <literal>j+1</literal>.  That is, <literal>C</literal> lacks exactly one type argument.
3102 </para></listitem>
3103 <listitem><para>
3104   The <literal>k</literal> is chosen so that <literal>ci (T v1...vk)</literal> is well-kinded.
3105 </para></listitem>
3106 <listitem><para>
3107   The type <literal>t</literal> is an arbitrary type.
3108 </para></listitem>
3109 <listitem><para>
3110   The type variables <literal>vk+1...vn</literal> do not occur in <literal>t</literal>, 
3111   nor in the <literal>ci</literal>, and
3112 </para></listitem>
3113 <listitem><para>
3114   None of the <literal>ci</literal> is <literal>Read</literal>, <literal>Show</literal>, 
3115                 <literal>Typeable</literal>, or <literal>Data</literal>.  These classes
3116                 should not "look through" the type or its constructor.  You can still
3117                 derive these classes for a newtype, but it happens in the usual way, not 
3118                 via this new mechanism.  
3119 </para></listitem>
3120 </itemizedlist>
3121 Then, for each <literal>ci</literal>, the derived instance
3122 declaration is:
3123 <programlisting>
3124   instance ci t => ci (T v1...vk)
3125 </programlisting>
3126 As an example which does <emphasis>not</emphasis> work, consider 
3127 <programlisting>
3128   newtype NonMonad m s = NonMonad (State s m s) deriving Monad 
3129 </programlisting>
3130 Here we cannot derive the instance 
3131 <programlisting>
3132   instance Monad (State s m) => Monad (NonMonad m) 
3133 </programlisting>
3134
3135 because the type variable <literal>s</literal> occurs in <literal>State s m</literal>,
3136 and so cannot be "eta-converted" away. It is a good thing that this
3137 <literal>deriving</literal> clause is rejected, because <literal>NonMonad m</literal> is
3138 not, in fact, a monad --- for the same reason. Try defining
3139 <literal>>>=</literal> with the correct type: you won't be able to.
3140 </para>
3141 <para>
3142
3143 Notice also that the <emphasis>order</emphasis> of class parameters becomes
3144 important, since we can only derive instances for the last one. If the
3145 <literal>StateMonad</literal> class above were instead defined as
3146
3147 <programlisting>
3148   class StateMonad m s | m -> s where ... 
3149 </programlisting>
3150
3151 then we would not have been able to derive an instance for the
3152 <literal>Parser</literal> type above. We hypothesise that multi-parameter
3153 classes usually have one "main" parameter for which deriving new
3154 instances is most interesting.
3155 </para>
3156 <para>Lastly, all of this applies only for classes other than
3157 <literal>Read</literal>, <literal>Show</literal>, <literal>Typeable</literal>, 
3158 and <literal>Data</literal>, for which the built-in derivation applies (section
3159 4.3.3. of the Haskell Report).
3160 (For the standard classes <literal>Eq</literal>, <literal>Ord</literal>,
3161 <literal>Ix</literal>, and <literal>Bounded</literal> it is immaterial whether
3162 the standard method is used or the one described here.)
3163 </para>
3164 </sect3>
3165 </sect2>
3166 </sect1>
3167
3168
3169 <!-- TYPE SYSTEM EXTENSIONS -->
3170 <sect1 id="type-class-extensions">
3171 <title>Class and instances declarations</title>
3172
3173 <sect2 id="multi-param-type-classes">
3174 <title>Class declarations</title>
3175
3176 <para>
3177 This section, and the next one, documents GHC's type-class extensions.
3178 There's lots of background in the paper <ulink
3179 url="http://research.microsoft.com/~simonpj/Papers/type-class-design-space/">Type
3180 classes: exploring the design space</ulink> (Simon Peyton Jones, Mark
3181 Jones, Erik Meijer).
3182 </para>
3183 <para>
3184 All the extensions are enabled by the <option>-fglasgow-exts</option> flag.
3185 </para>
3186
3187 <sect3>
3188 <title>Multi-parameter type classes</title>
3189 <para>
3190 Multi-parameter type classes are permitted, with flag <option>-XMultiParamTypeClasses</option>. 
3191 For example:
3192
3193
3194 <programlisting>
3195   class Collection c a where
3196     union :: c a -> c a -> c a
3197     ...etc.
3198 </programlisting>
3199
3200 </para>
3201 </sect3>
3202
3203 <sect3 id="superclass-rules">
3204 <title>The superclasses of a class declaration</title>
3205
3206 <para>
3207 In Haskell 98 the context of a class declaration (which introduces superclasses)
3208 must be simple; that is, each predicate must consist of a class applied to 
3209 type variables.  The flag <option>-XFlexibleContexts</option> 
3210 (<xref linkend="flexible-contexts"/>)
3211 lifts this restriction,
3212 so that the only restriction on the context in a class declaration is 
3213 that the class hierarchy must be acyclic.  So these class declarations are OK:
3214
3215
3216 <programlisting>
3217   class Functor (m k) => FiniteMap m k where
3218     ...
3219
3220   class (Monad m, Monad (t m)) => Transform t m where
3221     lift :: m a -> (t m) a
3222 </programlisting>
3223
3224
3225 </para>
3226 <para>
3227 As in Haskell 98, The class hierarchy must be acyclic.  However, the definition
3228 of "acyclic" involves only the superclass relationships.  For example,
3229 this is OK:
3230
3231
3232 <programlisting>
3233   class C a where {
3234     op :: D b => a -> b -> b
3235   }
3236
3237   class C a => D a where { ... }
3238 </programlisting>
3239
3240
3241 Here, <literal>C</literal> is a superclass of <literal>D</literal>, but it's OK for a
3242 class operation <literal>op</literal> of <literal>C</literal> to mention <literal>D</literal>.  (It
3243 would not be OK for <literal>D</literal> to be a superclass of <literal>C</literal>.)
3244 </para>
3245 </sect3>
3246
3247
3248
3249
3250 <sect3 id="class-method-types">
3251 <title>Class method types</title>
3252
3253 <para>
3254 Haskell 98 prohibits class method types to mention constraints on the
3255 class type variable, thus:
3256 <programlisting>
3257   class Seq s a where
3258     fromList :: [a] -> s a
3259     elem     :: Eq a => a -> s a -> Bool
3260 </programlisting>
3261 The type of <literal>elem</literal> is illegal in Haskell 98, because it
3262 contains the constraint <literal>Eq a</literal>, constrains only the 
3263 class type variable (in this case <literal>a</literal>).
3264 GHC lifts this restriction (flag <option>-XConstrainedClassMethods</option>).
3265 </para>
3266
3267
3268 </sect3>
3269 </sect2>
3270
3271 <sect2 id="functional-dependencies">
3272 <title>Functional dependencies
3273 </title>
3274
3275 <para> Functional dependencies are implemented as described by Mark Jones
3276 in &ldquo;<ulink url="http://citeseer.ist.psu.edu/jones00type.html">Type Classes with Functional Dependencies</ulink>&rdquo;, Mark P. Jones, 
3277 In Proceedings of the 9th European Symposium on Programming, 
3278 ESOP 2000, Berlin, Germany, March 2000, Springer-Verlag LNCS 1782,
3279 .
3280 </para>
3281 <para>
3282 Functional dependencies are introduced by a vertical bar in the syntax of a 
3283 class declaration;  e.g. 
3284 <programlisting>
3285   class (Monad m) => MonadState s m | m -> s where ...
3286
3287   class Foo a b c | a b -> c where ...
3288 </programlisting>
3289 There should be more documentation, but there isn't (yet).  Yell if you need it.
3290 </para>
3291
3292 <sect3><title>Rules for functional dependencies </title>
3293 <para>
3294 In a class declaration, all of the class type variables must be reachable (in the sense 
3295 mentioned in <xref linkend="flexible-contexts"/>)
3296 from the free variables of each method type.
3297 For example:
3298
3299 <programlisting>
3300   class Coll s a where
3301     empty  :: s
3302     insert :: s -> a -> s
3303 </programlisting>
3304
3305 is not OK, because the type of <literal>empty</literal> doesn't mention
3306 <literal>a</literal>.  Functional dependencies can make the type variable
3307 reachable:
3308 <programlisting>
3309   class Coll s a | s -> a where
3310     empty  :: s
3311     insert :: s -> a -> s
3312 </programlisting>
3313
3314 Alternatively <literal>Coll</literal> might be rewritten
3315
3316 <programlisting>
3317   class Coll s a where
3318     empty  :: s a
3319     insert :: s a -> a -> s a
3320 </programlisting>
3321
3322
3323 which makes the connection between the type of a collection of
3324 <literal>a</literal>'s (namely <literal>(s a)</literal>) and the element type <literal>a</literal>.
3325 Occasionally this really doesn't work, in which case you can split the
3326 class like this:
3327
3328
3329 <programlisting>
3330   class CollE s where
3331     empty  :: s
3332
3333   class CollE s => Coll s a where
3334     insert :: s -> a -> s
3335 </programlisting>
3336 </para>
3337 </sect3>
3338
3339
3340 <sect3>
3341 <title>Background on functional dependencies</title>
3342
3343 <para>The following description of the motivation and use of functional dependencies is taken
3344 from the Hugs user manual, reproduced here (with minor changes) by kind
3345 permission of Mark Jones.
3346 </para>
3347 <para> 
3348 Consider the following class, intended as part of a
3349 library for collection types:
3350 <programlisting>
3351    class Collects e ce where
3352        empty  :: ce
3353        insert :: e -> ce -> ce
3354        member :: e -> ce -> Bool
3355 </programlisting>
3356 The type variable e used here represents the element type, while ce is the type
3357 of the container itself. Within this framework, we might want to define
3358 instances of this class for lists or characteristic functions (both of which
3359 can be used to represent collections of any equality type), bit sets (which can
3360 be used to represent collections of characters), or hash tables (which can be
3361 used to represent any collection whose elements have a hash function). Omitting
3362 standard implementation details, this would lead to the following declarations: 
3363 <programlisting>
3364    instance Eq e => Collects e [e] where ...
3365    instance Eq e => Collects e (e -> Bool) where ...
3366    instance Collects Char BitSet where ...
3367    instance (Hashable e, Collects a ce)
3368               => Collects e (Array Int ce) where ...
3369 </programlisting>
3370 All this looks quite promising; we have a class and a range of interesting
3371 implementations. Unfortunately, there are some serious problems with the class
3372 declaration. First, the empty function has an ambiguous type: 
3373 <programlisting>
3374    empty :: Collects e ce => ce
3375 </programlisting>
3376 By "ambiguous" we mean that there is a type variable e that appears on the left
3377 of the <literal>=&gt;</literal> symbol, but not on the right. The problem with
3378 this is that, according to the theoretical foundations of Haskell overloading,
3379 we cannot guarantee a well-defined semantics for any term with an ambiguous
3380 type.
3381 </para>
3382 <para>
3383 We can sidestep this specific problem by removing the empty member from the
3384 class declaration. However, although the remaining members, insert and member,
3385 do not have ambiguous types, we still run into problems when we try to use
3386 them. For example, consider the following two functions: 
3387 <programlisting>
3388    f x y = insert x . insert y
3389    g     = f True 'a'
3390 </programlisting>
3391 for which GHC infers the following types: 
3392 <programlisting>
3393    f :: (Collects a c, Collects b c) => a -> b -> c -> c
3394    g :: (Collects Bool c, Collects Char c) => c -> c
3395 </programlisting>
3396 Notice that the type for f allows the two parameters x and y to be assigned
3397 different types, even though it attempts to insert each of the two values, one
3398 after the other, into the same collection. If we're trying to model collections
3399 that contain only one type of value, then this is clearly an inaccurate
3400 type. Worse still, the definition for g is accepted, without causing a type
3401 error. As a result, the error in this code will not be flagged at the point
3402 where it appears. Instead, it will show up only when we try to use g, which
3403 might even be in a different module.
3404 </para>
3405
3406 <sect4><title>An attempt to use constructor classes</title>
3407
3408 <para>
3409 Faced with the problems described above, some Haskell programmers might be
3410 tempted to use something like the following version of the class declaration: 
3411 <programlisting>
3412    class Collects e c where
3413       empty  :: c e
3414       insert :: e -> c e -> c e
3415       member :: e -> c e -> Bool
3416 </programlisting>
3417 The key difference here is that we abstract over the type constructor c that is
3418 used to form the collection type c e, and not over that collection type itself,
3419 represented by ce in the original class declaration. This avoids the immediate
3420 problems that we mentioned above: empty has type <literal>Collects e c => c
3421 e</literal>, which is not ambiguous. 
3422 </para>
3423 <para>
3424 The function f from the previous section has a more accurate type: 
3425 <programlisting>
3426    f :: (Collects e c) => e -> e -> c e -> c e
3427 </programlisting>
3428 The function g from the previous section is now rejected with a type error as
3429 we would hope because the type of f does not allow the two arguments to have
3430 different types. 
3431 This, then, is an example of a multiple parameter class that does actually work
3432 quite well in practice, without ambiguity problems.
3433 There is, however, a catch. This version of the Collects class is nowhere near
3434 as general as the original class seemed to be: only one of the four instances
3435 for <literal>Collects</literal>
3436 given above can be used with this version of Collects because only one of
3437 them---the instance for lists---has a collection type that can be written in
3438 the form c e, for some type constructor c, and element type e.
3439 </para>
3440 </sect4>
3441
3442 <sect4><title>Adding functional dependencies</title>
3443
3444 <para>
3445 To get a more useful version of the Collects class, Hugs provides a mechanism
3446 that allows programmers to specify dependencies between the parameters of a
3447 multiple parameter class (For readers with an interest in theoretical
3448 foundations and previous work: The use of dependency information can be seen
3449 both as a generalization of the proposal for `parametric type classes' that was
3450 put forward by Chen, Hudak, and Odersky, or as a special case of Mark Jones's
3451 later framework for "improvement" of qualified types. The
3452 underlying ideas are also discussed in a more theoretical and abstract setting
3453 in a manuscript [implparam], where they are identified as one point in a
3454 general design space for systems of implicit parameterization.).
3455
3456 To start with an abstract example, consider a declaration such as: 
3457 <programlisting>
3458    class C a b where ...
3459 </programlisting>
3460 which tells us simply that C can be thought of as a binary relation on types
3461 (or type constructors, depending on the kinds of a and b). Extra clauses can be
3462 included in the definition of classes to add information about dependencies
3463 between parameters, as in the following examples: 
3464 <programlisting>
3465    class D a b | a -> b where ...
3466    class E a b | a -> b, b -> a where ...
3467 </programlisting>
3468 The notation <literal>a -&gt; b</literal> used here between the | and where
3469 symbols --- not to be
3470 confused with a function type --- indicates that the a parameter uniquely
3471 determines the b parameter, and might be read as "a determines b." Thus D is
3472 not just a relation, but actually a (partial) function. Similarly, from the two
3473 dependencies that are included in the definition of E, we can see that E
3474 represents a (partial) one-one mapping between types.
3475 </para>
3476 <para>
3477 More generally, dependencies take the form <literal>x1 ... xn -&gt; y1 ... ym</literal>,
3478 where x1, ..., xn, and y1, ..., yn are type variables with n&gt;0 and
3479 m&gt;=0, meaning that the y parameters are uniquely determined by the x
3480 parameters. Spaces can be used as separators if more than one variable appears
3481 on any single side of a dependency, as in <literal>t -&gt; a b</literal>. Note that a class may be
3482 annotated with multiple dependencies using commas as separators, as in the
3483 definition of E above. Some dependencies that we can write in this notation are
3484 redundant, and will be rejected because they don't serve any useful
3485 purpose, and may instead indicate an error in the program. Examples of
3486 dependencies like this include  <literal>a -&gt; a </literal>,  
3487 <literal>a -&gt; a a </literal>,  
3488 <literal>a -&gt; </literal>, etc. There can also be
3489 some redundancy if multiple dependencies are given, as in  
3490 <literal>a-&gt;b</literal>, 
3491  <literal>b-&gt;c </literal>,  <literal>a-&gt;c </literal>, and
3492 in which some subset implies the remaining dependencies. Examples like this are
3493 not treated as errors. Note that dependencies appear only in class
3494 declarations, and not in any other part of the language. In particular, the
3495 syntax for instance declarations, class constraints, and types is completely
3496 unchanged.
3497 </para>
3498 <para>
3499 By including dependencies in a class declaration, we provide a mechanism for
3500 the programmer to specify each multiple parameter class more precisely. The
3501 compiler, on the other hand, is responsible for ensuring that the set of
3502 instances that are in scope at any given point in the program is consistent
3503 with any declared dependencies. For example, the following pair of instance
3504 declarations cannot appear together in the same scope because they violate the
3505 dependency for D, even though either one on its own would be acceptable: 
3506 <programlisting>
3507    instance D Bool Int where ...
3508    instance D Bool Char where ...
3509 </programlisting>
3510 Note also that the following declaration is not allowed, even by itself: 
3511 <programlisting>
3512    instance D [a] b where ...
3513 </programlisting>
3514 The problem here is that this instance would allow one particular choice of [a]
3515 to be associated with more than one choice for b, which contradicts the
3516 dependency specified in the definition of D. More generally, this means that,
3517 in any instance of the form: 
3518 <programlisting>
3519    instance D t s where ...
3520 </programlisting>
3521 for some particular types t and s, the only variables that can appear in s are
3522 the ones that appear in t, and hence, if the type t is known, then s will be
3523 uniquely determined.
3524 </para>
3525 <para>
3526 The benefit of including dependency information is that it allows us to define
3527 more general multiple parameter classes, without ambiguity problems, and with
3528 the benefit of more accurate types. To illustrate this, we return to the
3529 collection class example, and annotate the original definition of <literal>Collects</literal>
3530 with a simple dependency: 
3531 <programlisting>
3532    class Collects e ce | ce -> e where
3533       empty  :: ce
3534       insert :: e -> ce -> ce
3535       member :: e -> ce -> Bool
3536 </programlisting>
3537 The dependency <literal>ce -&gt; e</literal> here specifies that the type e of elements is uniquely
3538 determined by the type of the collection ce. Note that both parameters of
3539 Collects are of kind *; there are no constructor classes here. Note too that
3540 all of the instances of Collects that we gave earlier can be used
3541 together with this new definition.
3542 </para>
3543 <para>
3544 What about the ambiguity problems that we encountered with the original
3545 definition? The empty function still has type Collects e ce => ce, but it is no
3546 longer necessary to regard that as an ambiguous type: Although the variable e
3547 does not appear on the right of the => symbol, the dependency for class
3548 Collects tells us that it is uniquely determined by ce, which does appear on
3549 the right of the => symbol. Hence the context in which empty is used can still
3550 give enough information to determine types for both ce and e, without