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