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