bcc7d1ea8e6eea0f09a5be4c35aba1030b775dc4
[ghc-hetmet.git] / ghc / docs / users_guide / glasgow_exts.sgml
1 <para>
2 <indexterm><primary>language, GHC</primary></indexterm>
3 <indexterm><primary>extensions, GHC</primary></indexterm>
4 As with all known Haskell systems, GHC implements some extensions to
5 the language.  To use them, you'll need to give a <option>-fglasgow-exts</option>
6 <indexterm><primary>-fglasgow-exts option</primary></indexterm> option.
7 </para>
8
9 <para>
10 Virtually all of the Glasgow extensions serve to give you access to
11 the underlying facilities with which we implement Haskell.  Thus, you
12 can get at the Raw Iron, if you are willing to write some non-standard
13 code at a more primitive level.  You need not be &ldquo;stuck&rdquo; on
14 performance because of the implementation costs of Haskell's
15 &ldquo;high-level&rdquo; features&mdash;you can always code &ldquo;under&rdquo; them.  In an extreme case, you can write all your time-critical code in C, and then just glue it together with Haskell!
16 </para>
17
18 <para>
19 Before you get too carried away working at the lowest level (e.g.,
20 sloshing <literal>MutableByteArray&num;</literal>s around your
21 program), you may wish to check if there are libraries that provide a
22 &ldquo;Haskellised veneer&rdquo; over the features you want.  The
23 separate libraries documentation describes all the libraries that come
24 with GHC.
25 </para>
26
27 <!-- LANGUAGE OPTIONS -->
28   <sect1 id="options-language">
29     <title>Language options</title>
30
31     <indexterm><primary>language</primary><secondary>option</secondary>
32     </indexterm>
33     <indexterm><primary>options</primary><secondary>language</secondary>
34     </indexterm>
35     <indexterm><primary>extensions</primary><secondary>options controlling</secondary>
36     </indexterm>
37
38     <para> These flags control what variation of the language are
39     permitted.  Leaving out all of them gives you standard Haskell
40     98.</para>
41
42     <variablelist>
43
44       <varlistentry>
45         <term><option>-fglasgow-exts</option>:</term>
46         <indexterm><primary><option>-fglasgow-exts</option></primary></indexterm>
47         <listitem>
48           <para>This simultaneously enables all of the extensions to
49           Haskell 98 described in <xref
50           linkend="ghc-language-features">, except where otherwise
51           noted. </para>
52         </listitem>
53       </varlistentry>
54
55       <varlistentry>
56         <term><option>-ffi</option> and <option>-fffi</option>:</term>
57         <indexterm><primary><option>-ffi</option></primary></indexterm>
58         <indexterm><primary><option>-fffi</option></primary></indexterm>
59         <listitem>
60           <para>This option enables the language extension defined in the
61           Haskell 98 Foreign Function Interface Addendum plus deprecated
62           syntax of previous versions of the FFI for backwards
63           compatibility.</para> 
64         </listitem>
65       </varlistentry>
66
67       <varlistentry>
68         <term><option>-fwith</option>:</term>
69         <indexterm><primary><option>-fwith</option></primary></indexterm>
70         <listitem>
71           <para>This option enables the deprecated <literal>with</literal>
72           keyword for implicit parameters; it is merely provided for backwards
73           compatibility.
74           It is independent of the <option>-fglasgow-exts</option>
75           flag. </para>
76         </listitem>
77       </varlistentry>
78
79       <varlistentry>
80         <term><option>-fno-monomorphism-restriction</option>:</term>
81         <indexterm><primary><option>-fno-monomorphism-restriction</option></primary></indexterm>
82         <listitem>
83           <para> Switch off the Haskell 98 monomorphism restriction.
84           Independent of the <option>-fglasgow-exts</option>
85           flag. </para>
86         </listitem>
87       </varlistentry>
88
89       <varlistentry>
90         <term><option>-fallow-overlapping-instances</option></term>
91         <term><option>-fallow-undecidable-instances</option></term>
92         <term><option>-fallow-incoherent-instances</option></term>
93         <term><option>-fcontext-stack</option></term>
94         <indexterm><primary><option>-fallow-overlapping-instances</option></primary></indexterm>
95         <indexterm><primary><option>-fallow-undecidable-instances</option></primary></indexterm>
96         <indexterm><primary><option>-fcontext-stack</option></primary></indexterm>
97         <listitem>
98           <para> See <xref LinkEnd="instance-decls">.  Only relevant
99           if you also use <option>-fglasgow-exts</option>.</para>
100         </listitem>
101       </varlistentry>
102
103       <varlistentry>
104         <term><option>-finline-phase</option></term>
105         <indexterm><primary><option>-finline-phase</option></primary></indexterm>
106         <listitem>
107           <para>See <xref LinkEnd="rewrite-rules">.  Only relevant if
108           you also use <option>-fglasgow-exts</option>.</para>
109         </listitem>
110       </varlistentry>
111
112       <varlistentry>
113         <term><option>-fgenerics</option></term>
114         <indexterm><primary><option>-fgenerics</option></primary></indexterm>
115         <listitem>
116           <para>See <xref LinkEnd="generic-classes">.  Independent of
117           <option>-fglasgow-exts</option>.</para>
118         </listitem>
119       </varlistentry>
120
121         <varlistentry>
122           <term><option>-fno-implicit-prelude</option></term>
123           <listitem>
124             <para><indexterm><primary>-fno-implicit-prelude
125             option</primary></indexterm> GHC normally imports
126             <filename>Prelude.hi</filename> files for you.  If you'd
127             rather it didn't, then give it a
128             <option>-fno-implicit-prelude</option> option.  The idea
129             is that you can then import a Prelude of your own.  (But
130             don't call it <literal>Prelude</literal>; the Haskell
131             module namespace is flat, and you must not conflict with
132             any Prelude module.)</para>
133
134             <para>Even though you have not imported the Prelude, most of
135             the built-in syntax still refers to the built-in Haskell
136             Prelude types and values, as specified by the Haskell
137             Report.  For example, the type <literal>[Int]</literal>
138             still means <literal>Prelude.[] Int</literal>; tuples
139             continue to refer to the standard Prelude tuples; the
140             translation for list comprehensions continues to use
141             <literal>Prelude.map</literal> etc.</para>
142
143             <para>However, <option>-fno-implicit-prelude</option> does
144             change the handling of certain built-in syntax: see
145             <xref LinkEnd="rebindable-syntax">.</para>
146
147           </listitem>
148         </varlistentry>
149
150     </variablelist>
151   </sect1>
152
153 <!-- UNBOXED TYPES AND PRIMITIVE OPERATIONS -->
154 <!--    included from primitives.sgml  -->
155 &primitives;
156
157
158 <!-- TYPE SYSTEM EXTENSIONS -->
159 <sect1 id="type-extensions">
160 <title>Type system extensions</title>
161
162 <sect2 id="nullary-types">
163 <title>Data types with no constructors</title>
164
165 <para>With the <option>-fglasgow-exts</option> flag, GHC lets you declare
166 a data type with no constructors.  For example:</para>
167
168 <programlisting>
169   data S      -- S :: *
170   data T a    -- T :: * -> *
171 </programlisting>
172
173 <para>Syntactically, the declaration lacks the "= constrs" part.  The 
174 type can be parameterised over types of any kind, but if the kind is
175 not <literal>*</literal> then an explicit kind annotation must be used
176 (see <xref linkend="sec-kinding">).</para>
177
178 <para>Such data types have only one value, namely bottom.
179 Nevertheless, they can be useful when defining "phantom types".</para>
180 </sect2>
181
182 <sect2 id="infix-tycons">
183 <title>Infix type constructors</title>
184
185 <para>
186 GHC allows type constructors to be operators, and to be written infix, very much 
187 like expressions.  More specifically:
188 <itemizedlist>
189 <listitem><para>
190   A type constructor can be an operator, beginning with a colon; e.g. <literal>:*:</literal>.
191   The lexical syntax is the same as that for data constructors.
192   </para></listitem>
193 <listitem><para>
194   Types can be written infix.  For example <literal>Int :*: Bool</literal>.  
195   </para></listitem>
196 <listitem><para>
197   Back-quotes work
198   as for expressions, both for type constructors and type variables;  e.g. <literal>Int `Either` Bool</literal>, or
199   <literal>Int `a` Bool</literal>.  Similarly, parentheses work the same; e.g.  <literal>(:*:) Int Bool</literal>.
200   </para></listitem>
201 <listitem><para>
202   Fixities may be declared for type constructors just as for data constructors.  However,
203   one cannot distinguish between the two in a fixity declaration; a fixity declaration
204   sets the fixity for a data constructor and the corresponding type constructor.  For example:
205 <screen>
206   infixl 7 T, :*:
207 </screen>
208   sets the fixity for both type constructor <literal>T</literal> and data constructor <literal>T</literal>,
209   and similarly for <literal>:*:</literal>.
210   <literal>Int `a` Bool</literal>.
211   </para></listitem>
212 <listitem><para>
213   Function arrow is <literal>infixr</literal> with fixity 0.  (This might change; I'm not sure what it should be.)
214   </para></listitem>
215 <listitem><para>
216   Data type and type-synonym declarations can be written infix.  E.g.
217 <screen>
218   data a :*: b = Foo a b
219   type a :+: b = Either a b
220 </screen>
221   </para></listitem>
222 <listitem><para>
223   The only thing that differs between operators in types and operators in expressions is that
224   ordinary non-constructor operators, such as <literal>+</literal> and <literal>*</literal>
225   are not allowed in types. Reason: the uniform thing to do would be to make them type
226   variables, but that's not very useful.  A less uniform but more useful thing would be to
227   allow them to be type <emphasis>constructors</emphasis>.  But that gives trouble in export
228   lists.  So for now we just exclude them.
229   </para></listitem>
230
231 </itemizedlist>
232 </para>
233 </sect2>
234
235 <sect2 id="sec-kinding">
236 <title>Explicitly-kinded quantification</title>
237
238 <para>
239 Haskell infers the kind of each type variable.  Sometimes it is nice to be able
240 to give the kind explicitly as (machine-checked) documentation, 
241 just as it is nice to give a type signature for a function.  On some occasions,
242 it is essential to do so.  For example, in his paper "Restricted Data Types in Haskell" (Haskell Workshop 1999)
243 John Hughes had to define the data type:
244 <Screen>
245      data Set cxt a = Set [a]
246                     | Unused (cxt a -> ())
247 </Screen>
248 The only use for the <literal>Unused</literal> constructor was to force the correct
249 kind for the type variable <literal>cxt</literal>.
250 </para>
251 <para>
252 GHC now instead allows you to specify the kind of a type variable directly, wherever
253 a type variable is explicitly bound.  Namely:
254 <itemizedlist>
255 <listitem><para><literal>data</literal> declarations:
256 <Screen>
257   data Set (cxt :: * -> *) a = Set [a]
258 </Screen></para></listitem>
259 <listitem><para><literal>type</literal> declarations:
260 <Screen>
261   type T (f :: * -> *) = f Int
262 </Screen></para></listitem>
263 <listitem><para><literal>class</literal> declarations:
264 <Screen>
265   class (Eq a) => C (f :: * -> *) a where ...
266 </Screen></para></listitem>
267 <listitem><para><literal>forall</literal>'s in type signatures:
268 <Screen>
269   f :: forall (cxt :: * -> *). Set cxt Int
270 </Screen></para></listitem>
271 </itemizedlist>
272 </para>
273
274 <para>
275 The parentheses are required.  Some of the spaces are required too, to
276 separate the lexemes.  If you write <literal>(f::*->*)</literal> you
277 will get a parse error, because "<literal>::*->*</literal>" is a
278 single lexeme in Haskell.
279 </para>
280
281 <para>
282 As part of the same extension, you can put kind annotations in types
283 as well.  Thus:
284 <Screen>
285    f :: (Int :: *) -> Int
286    g :: forall a. a -> (a :: *)
287 </Screen>
288 The syntax is
289 <Screen>
290    atype ::= '(' ctype '::' kind ')
291 </Screen>
292 The parentheses are required.
293 </para>
294 </sect2>
295
296
297 <sect2 id="class-method-types">
298 <title>Class method types
299 </title>
300 <para>
301 Haskell 98 prohibits class method types to mention constraints on the
302 class type variable, thus:
303 <programlisting>
304   class Seq s a where
305     fromList :: [a] -> s a
306     elem     :: Eq a => a -> s a -> Bool
307 </programlisting>
308 The type of <literal>elem</literal> is illegal in Haskell 98, because it
309 contains the constraint <literal>Eq a</literal>, constrains only the 
310 class type variable (in this case <literal>a</literal>).
311 </para>
312 <para>
313 With the <option>-fglasgow-exts</option> GHC lifts this restriction.
314 </para>
315
316 </sect2>
317
318 <sect2 id="multi-param-type-classes">
319 <title>Multi-parameter type classes
320 </title>
321
322 <para>
323 This section documents GHC's implementation of multi-parameter type
324 classes.  There's lots of background in the paper <ULink
325 URL="http://research.microsoft.com/~simonpj/multi.ps.gz" >Type
326 classes: exploring the design space</ULink > (Simon Peyton Jones, Mark
327 Jones, Erik Meijer).
328 </para>
329
330 <para>
331 I'd like to thank people who reported shorcomings in the GHC 3.02
332 implementation.  Our default decisions were all conservative ones, and
333 the experience of these heroic pioneers has given useful concrete
334 examples to support several generalisations.  (These appear below as
335 design choices not implemented in 3.02.)
336 </para>
337
338 <para>
339 I've discussed these notes with Mark Jones, and I believe that Hugs
340 will migrate towards the same design choices as I outline here.
341 Thanks to him, and to many others who have offered very useful
342 feedback.
343 </para>
344
345 <sect3>
346 <title>Types</title>
347
348 <para>
349 There are the following restrictions on the form of a qualified
350 type:
351 </para>
352
353 <para>
354
355 <programlisting>
356   forall tv1..tvn (c1, ...,cn) => type
357 </programlisting>
358
359 </para>
360
361 <para>
362 (Here, I write the "foralls" explicitly, although the Haskell source
363 language omits them; in Haskell 1.4, all the free type variables of an
364 explicit source-language type signature are universally quantified,
365 except for the class type variables in a class declaration.  However,
366 in GHC, you can give the foralls if you want.  See <xref LinkEnd="universal-quantification">).
367 </para>
368
369 <para>
370
371 <OrderedList>
372 <listitem>
373
374 <para>
375  <emphasis>Each universally quantified type variable
376 <literal>tvi</literal> must be mentioned (i.e. appear free) in <literal>type</literal></emphasis>.
377
378 The reason for this is that a value with a type that does not obey
379 this restriction could not be used without introducing
380 ambiguity. Here, for example, is an illegal type:
381
382
383 <programlisting>
384   forall a. Eq a => Int
385 </programlisting>
386
387
388 When a value with this type was used, the constraint <literal>Eq tv</literal>
389 would be introduced where <literal>tv</literal> is a fresh type variable, and
390 (in the dictionary-translation implementation) the value would be
391 applied to a dictionary for <literal>Eq tv</literal>.  The difficulty is that we
392 can never know which instance of <literal>Eq</literal> to use because we never
393 get any more information about <literal>tv</literal>.
394
395 </para>
396 </listitem>
397 <listitem>
398
399 <para>
400  <emphasis>Every constraint <literal>ci</literal> must mention at least one of the
401 universally quantified type variables <literal>tvi</literal></emphasis>.
402
403 For example, this type is OK because <literal>C a b</literal> mentions the
404 universally quantified type variable <literal>b</literal>:
405
406
407 <programlisting>
408   forall a. C a b => burble
409 </programlisting>
410
411
412 The next type is illegal because the constraint <literal>Eq b</literal> does not
413 mention <literal>a</literal>:
414
415
416 <programlisting>
417   forall a. Eq b => burble
418 </programlisting>
419
420
421 The reason for this restriction is milder than the other one.  The
422 excluded types are never useful or necessary (because the offending
423 context doesn't need to be witnessed at this point; it can be floated
424 out).  Furthermore, floating them out increases sharing. Lastly,
425 excluding them is a conservative choice; it leaves a patch of
426 territory free in case we need it later.
427
428 </para>
429 </listitem>
430
431 </OrderedList>
432
433 </para>
434
435 <para>
436 These restrictions apply to all types, whether declared in a type signature
437 or inferred.
438 </para>
439
440 <para>
441 Unlike Haskell 1.4, constraints in types do <emphasis>not</emphasis> have to be of
442 the form <emphasis>(class type-variables)</emphasis>.  Thus, these type signatures
443 are perfectly OK
444 </para>
445
446 <para>
447
448 <programlisting>
449   f :: Eq (m a) => [m a] -> [m a]
450   g :: Eq [a] => ...
451 </programlisting>
452
453 </para>
454
455 <para>
456 This choice recovers principal types, a property that Haskell 1.4 does not have.
457 </para>
458
459 </sect3>
460
461 <sect3>
462 <title>Class declarations</title>
463
464 <para>
465
466 <OrderedList>
467 <listitem>
468
469 <para>
470  <emphasis>Multi-parameter type classes are permitted</emphasis>. For example:
471
472
473 <programlisting>
474   class Collection c a where
475     union :: c a -> c a -> c a
476     ...etc.
477 </programlisting>
478
479
480
481 </para>
482 </listitem>
483 <listitem>
484
485 <para>
486  <emphasis>The class hierarchy must be acyclic</emphasis>.  However, the definition
487 of "acyclic" involves only the superclass relationships.  For example,
488 this is OK:
489
490
491 <programlisting>
492   class C a where {
493     op :: D b => a -> b -> b
494   }
495
496   class C a => D a where { ... }
497 </programlisting>
498
499
500 Here, <literal>C</literal> is a superclass of <literal>D</literal>, but it's OK for a
501 class operation <literal>op</literal> of <literal>C</literal> to mention <literal>D</literal>.  (It
502 would not be OK for <literal>D</literal> to be a superclass of <literal>C</literal>.)
503
504 </para>
505 </listitem>
506 <listitem>
507
508 <para>
509  <emphasis>There are no restrictions on the context in a class declaration
510 (which introduces superclasses), except that the class hierarchy must
511 be acyclic</emphasis>.  So these class declarations are OK:
512
513
514 <programlisting>
515   class Functor (m k) => FiniteMap m k where
516     ...
517
518   class (Monad m, Monad (t m)) => Transform t m where
519     lift :: m a -> (t m) a
520 </programlisting>
521
522
523 </para>
524 </listitem>
525 <listitem>
526
527 <para>
528  <emphasis>In the signature of a class operation, every constraint
529 must mention at least one type variable that is not a class type
530 variable</emphasis>.
531
532 Thus:
533
534
535 <programlisting>
536   class Collection c a where
537     mapC :: Collection c b => (a->b) -> c a -> c b
538 </programlisting>
539
540
541 is OK because the constraint <literal>(Collection a b)</literal> mentions
542 <literal>b</literal>, even though it also mentions the class variable
543 <literal>a</literal>.  On the other hand:
544
545
546 <programlisting>
547   class C a where
548     op :: Eq a => (a,b) -> (a,b)
549 </programlisting>
550
551
552 is not OK because the constraint <literal>(Eq a)</literal> mentions on the class
553 type variable <literal>a</literal>, but not <literal>b</literal>.  However, any such
554 example is easily fixed by moving the offending context up to the
555 superclass context:
556
557
558 <programlisting>
559   class Eq a => C a where
560     op ::(a,b) -> (a,b)
561 </programlisting>
562
563
564 A yet more relaxed rule would allow the context of a class-op signature
565 to mention only class type variables.  However, that conflicts with
566 Rule 1(b) for types above.
567
568 </para>
569 </listitem>
570 <listitem>
571
572 <para>
573  <emphasis>The type of each class operation must mention <emphasis>all</emphasis> of
574 the class type variables</emphasis>.  For example:
575
576
577 <programlisting>
578   class Coll s a where
579     empty  :: s
580     insert :: s -> a -> s
581 </programlisting>
582
583
584 is not OK, because the type of <literal>empty</literal> doesn't mention
585 <literal>a</literal>.  This rule is a consequence of Rule 1(a), above, for
586 types, and has the same motivation.
587
588 Sometimes, offending class declarations exhibit misunderstandings.  For
589 example, <literal>Coll</literal> might be rewritten
590
591
592 <programlisting>
593   class Coll s a where
594     empty  :: s a
595     insert :: s a -> a -> s a
596 </programlisting>
597
598
599 which makes the connection between the type of a collection of
600 <literal>a</literal>'s (namely <literal>(s a)</literal>) and the element type <literal>a</literal>.
601 Occasionally this really doesn't work, in which case you can split the
602 class like this:
603
604
605 <programlisting>
606   class CollE s where
607     empty  :: s
608
609   class CollE s => Coll s a where
610     insert :: s -> a -> s
611 </programlisting>
612
613
614 </para>
615 </listitem>
616
617 </OrderedList>
618
619 </para>
620
621 </sect3>
622
623 <sect3 id="instance-decls">
624 <title>Instance declarations</title>
625
626 <para>
627
628 <OrderedList>
629 <listitem>
630
631 <para>
632  <emphasis>Instance declarations may not overlap</emphasis>.  The two instance
633 declarations
634
635
636 <programlisting>
637   instance context1 => C type1 where ...
638   instance context2 => C type2 where ...
639 </programlisting>
640
641
642 "overlap" if <literal>type1</literal> and <literal>type2</literal> unify
643
644 However, if you give the command line option
645 <option>-fallow-overlapping-instances</option><indexterm><primary>-fallow-overlapping-instances
646 option</primary></indexterm> then overlapping instance declarations are permitted.
647 However, GHC arranges never to commit to using an instance declaration
648 if another instance declaration also applies, either now or later.
649
650 <itemizedlist>
651 <listitem>
652
653 <para>
654  EITHER <literal>type1</literal> and <literal>type2</literal> do not unify
655 </para>
656 </listitem>
657 <listitem>
658
659 <para>
660  OR <literal>type2</literal> is a substitution instance of <literal>type1</literal>
661 (but not identical to <literal>type1</literal>), or vice versa.
662 </para>
663 </listitem>
664 </itemizedlist>
665 Notice that these rules
666 <itemizedlist>
667 <listitem>
668
669 <para>
670  make it clear which instance decl to use
671 (pick the most specific one that matches)
672
673 </para>
674 </listitem>
675 <listitem>
676
677 <para>
678  do not mention the contexts <literal>context1</literal>, <literal>context2</literal>
679 Reason: you can pick which instance decl
680 "matches" based on the type.
681 </para>
682 </listitem>
683
684 </itemizedlist>
685 However the rules are over-conservative.  Two instance declarations can overlap,
686 but it can still be clear in particular situations which to use.  For example:
687 <programlisting>
688   instance C (Int,a) where ...
689   instance C (a,Bool) where ...
690 </programlisting>
691 These are rejected by GHC's rules, but it is clear what to do when trying
692 to solve the constraint <literal>C (Int,Int)</literal> because the second instance
693 cannot apply.  Yell if this restriction bites you.
694 </para>
695 <para>
696 GHC is also conservative about committing to an overlapping instance.  For example:
697 <programlisting>
698   class C a where { op :: a -> a }
699   instance C [Int] where ...
700   instance C a => C [a] where ...
701   
702   f :: C b => [b] -> [b]
703   f x = op x
704 </programlisting>
705 From the RHS of f we get the constraint <literal>C [b]</literal>.  But
706 GHC does not commit to the second instance declaration, because in a paricular
707 call of f, b might be instantiate to Int, so the first instance declaration
708 would be appropriate.  So GHC rejects the program.  If you add <option>-fallow-incoherent-instances</option>
709 GHC will instead silently pick the second instance, without complaining about 
710 the problem of subsequent instantiations.
711 </para>
712 <para>
713 Regrettably, GHC doesn't guarantee to detect overlapping instance
714 declarations if they appear in different modules.  GHC can "see" the
715 instance declarations in the transitive closure of all the modules
716 imported by the one being compiled, so it can "see" all instance decls
717 when it is compiling <literal>Main</literal>.  However, it currently chooses not
718 to look at ones that can't possibly be of use in the module currently
719 being compiled, in the interests of efficiency.  (Perhaps we should
720 change that decision, at least for <literal>Main</literal>.)
721
722 </para>
723 </listitem>
724 <listitem>
725
726 <para>
727  <emphasis>There are no restrictions on the type in an instance
728 <emphasis>head</emphasis>, except that at least one must not be a type variable</emphasis>.
729 The instance "head" is the bit after the "=>" in an instance decl. For
730 example, these are OK:
731
732
733 <programlisting>
734   instance C Int a where ...
735
736   instance D (Int, Int) where ...
737
738   instance E [[a]] where ...
739 </programlisting>
740
741
742 Note that instance heads <emphasis>may</emphasis> contain repeated type variables.
743 For example, this is OK:
744
745
746 <programlisting>
747   instance Stateful (ST s) (MutVar s) where ...
748 </programlisting>
749
750
751 The "at least one not a type variable" restriction is to ensure that
752 context reduction terminates: each reduction step removes one type
753 constructor.  For example, the following would make the type checker
754 loop if it wasn't excluded:
755
756
757 <programlisting>
758   instance C a => C a where ...
759 </programlisting>
760
761
762 There are two situations in which the rule is a bit of a pain. First,
763 if one allows overlapping instance declarations then it's quite
764 convenient to have a "default instance" declaration that applies if
765 something more specific does not:
766
767
768 <programlisting>
769   instance C a where
770     op = ... -- Default
771 </programlisting>
772
773
774 Second, sometimes you might want to use the following to get the
775 effect of a "class synonym":
776
777
778 <programlisting>
779   class (C1 a, C2 a, C3 a) => C a where { }
780
781   instance (C1 a, C2 a, C3 a) => C a where { }
782 </programlisting>
783
784
785 This allows you to write shorter signatures:
786
787
788 <programlisting>
789   f :: C a => ...
790 </programlisting>
791
792
793 instead of
794
795
796 <programlisting>
797   f :: (C1 a, C2 a, C3 a) => ...
798 </programlisting>
799
800
801 I'm on the lookout for a simple rule that preserves decidability while
802 allowing these idioms.  The experimental flag
803 <option>-fallow-undecidable-instances</option><indexterm><primary>-fallow-undecidable-instances
804 option</primary></indexterm> lifts this restriction, allowing all the types in an
805 instance head to be type variables.
806
807 </para>
808 </listitem>
809 <listitem>
810
811 <para>
812  <emphasis>Unlike Haskell 1.4, instance heads may use type
813 synonyms</emphasis>.  As always, using a type synonym is just shorthand for
814 writing the RHS of the type synonym definition.  For example:
815
816
817 <programlisting>
818   type Point = (Int,Int)
819   instance C Point   where ...
820   instance C [Point] where ...
821 </programlisting>
822
823
824 is legal.  However, if you added
825
826
827 <programlisting>
828   instance C (Int,Int) where ...
829 </programlisting>
830
831
832 as well, then the compiler will complain about the overlapping
833 (actually, identical) instance declarations.  As always, type synonyms
834 must be fully applied.  You cannot, for example, write:
835
836
837 <programlisting>
838   type P a = [[a]]
839   instance Monad P where ...
840 </programlisting>
841
842
843 This design decision is independent of all the others, and easily
844 reversed, but it makes sense to me.
845
846 </para>
847 </listitem>
848 <listitem>
849
850 <para>
851 <emphasis>The types in an instance-declaration <emphasis>context</emphasis> must all
852 be type variables</emphasis>. Thus
853
854
855 <programlisting>
856 instance C a b => Eq (a,b) where ...
857 </programlisting>
858
859
860 is OK, but
861
862
863 <programlisting>
864 instance C Int b => Foo b where ...
865 </programlisting>
866
867
868 is not OK.  Again, the intent here is to make sure that context
869 reduction terminates.
870
871 Voluminous correspondence on the Haskell mailing list has convinced me
872 that it's worth experimenting with a more liberal rule.  If you use
873 the flag <option>-fallow-undecidable-instances</option> can use arbitrary
874 types in an instance context.  Termination is ensured by having a
875 fixed-depth recursion stack.  If you exceed the stack depth you get a
876 sort of backtrace, and the opportunity to increase the stack depth
877 with <option>-fcontext-stack</option><emphasis>N</emphasis>.
878
879 </para>
880 </listitem>
881
882 </OrderedList>
883
884 </para>
885
886 </sect3>
887
888 </sect2>
889
890 <sect2 id="implicit-parameters">
891 <title>Implicit parameters
892 </title>
893
894 <para> Implicit paramters are implemented as described in 
895 "Implicit parameters: dynamic scoping with static types", 
896 J Lewis, MB Shields, E Meijer, J Launchbury,
897 27th ACM Symposium on Principles of Programming Languages (POPL'00),
898 Boston, Jan 2000.
899 </para>
900 <para>(Most of the following, stil rather incomplete, documentation is due to Jeff Lewis.)</para>
901 <para>
902 A variable is called <emphasis>dynamically bound</emphasis> when it is bound by the calling
903 context of a function and <emphasis>statically bound</emphasis> when bound by the callee's
904 context. In Haskell, all variables are statically bound. Dynamic
905 binding of variables is a notion that goes back to Lisp, but was later
906 discarded in more modern incarnations, such as Scheme. Dynamic binding
907 can be very confusing in an untyped language, and unfortunately, typed
908 languages, in particular Hindley-Milner typed languages like Haskell,
909 only support static scoping of variables.
910 </para>
911 <para>
912 However, by a simple extension to the type class system of Haskell, we
913 can support dynamic binding. Basically, we express the use of a
914 dynamically bound variable as a constraint on the type. These
915 constraints lead to types of the form <literal>(?x::t') => t</literal>, which says "this
916 function uses a dynamically-bound variable <literal>?x</literal> 
917 of type <literal>t'</literal>". For
918 example, the following expresses the type of a sort function,
919 implicitly parameterized by a comparison function named <literal>cmp</literal>.
920 <programlisting>
921   sort :: (?cmp :: a -> a -> Bool) => [a] -> [a]
922 </programlisting>
923 The dynamic binding constraints are just a new form of predicate in the type class system.
924 </para>
925 <para>
926 An implicit parameter is introduced by the special form <literal>?x</literal>, 
927 where <literal>x</literal> is
928 any valid identifier. Use if this construct also introduces new
929 dynamic binding constraints. For example, the following definition
930 shows how we can define an implicitly parameterized sort function in
931 terms of an explicitly parameterized <literal>sortBy</literal> function:
932 <programlisting>
933   sortBy :: (a -> a -> Bool) -> [a] -> [a]
934
935   sort   :: (?cmp :: a -> a -> Bool) => [a] -> [a]
936   sort    = sortBy ?cmp
937 </programlisting>
938 Dynamic binding constraints behave just like other type class
939 constraints in that they are automatically propagated. Thus, when a
940 function is used, its implicit parameters are inherited by the
941 function that called it. For example, our <literal>sort</literal> function might be used
942 to pick out the least value in a list:
943 <programlisting>
944   least   :: (?cmp :: a -> a -> Bool) => [a] -> a
945   least xs = fst (sort xs)
946 </programlisting>
947 Without lifting a finger, the <literal>?cmp</literal> parameter is
948 propagated to become a parameter of <literal>least</literal> as well. With explicit
949 parameters, the default is that parameters must always be explicit
950 propagated. With implicit parameters, the default is to always
951 propagate them.
952 </para>
953 <para>
954 An implicit parameter differs from other type class constraints in the
955 following way: All uses of a particular implicit parameter must have
956 the same type. This means that the type of <literal>(?x, ?x)</literal> 
957 is <literal>(?x::a) => (a,a)</literal>, and not 
958 <literal>(?x::a, ?x::b) => (a, b)</literal>, as would be the case for type
959 class constraints.
960 </para>
961 <para>
962 An implicit parameter is bound using the standard
963 <literal>let</literal> binding form, where the bindings must be a
964 collection of simple bindings to implicit-style variables (no
965 function-style bindings, and no type signatures); these bindings are
966 neither polymorphic or recursive. This form binds the implicit
967 parameters arising in the body, not the free variables as a
968 <literal>let</literal> or <literal>where</literal> would do. For
969 example, we define the <literal>min</literal> function by binding
970 <literal>cmp</literal>.</para>
971 <programlisting>
972   min :: [a] -> a
973   min  = let ?cmp = (<=) in least
974 </programlisting>
975 <para>
976 Note the following points:
977 <itemizedlist>
978 <listitem><para>
979 You may not mix implicit-parameter bindings with ordinary bindings in a 
980 single <literal>let</literal>
981 expression; use two nested <literal>let</literal>s instead.
982 </para></listitem>
983
984 <listitem><para>
985 You may put multiple implicit-parameter bindings in a
986 single <literal>let</literal> expression; they are <emphasis>not</emphasis> treated
987 as a mutually recursive group (as ordinary <literal>let</literal> bindings are).
988 Instead they are treated as a non-recursive group, each scoping over the bindings that
989 follow.  For example, consider:
990 <programlisting>
991   f y = let { ?x = y; ?x = ?x+1 } in ?x
992 </programlisting>
993 This function adds one to its argument.
994 </para></listitem>
995
996 <listitem><para>
997 You may not have an implicit-parameter binding in a <literal>where</literal> clause,
998 only in a <literal>let</literal> binding.
999 </para></listitem>
1000
1001 <listitem>
1002 <para> You can't have an implicit parameter in the context of a class or instance
1003 declaration.  For example, both these declarations are illegal:
1004 <programlisting>
1005   class (?x::Int) => C a where ...
1006   instance (?x::a) => Foo [a] where ...
1007 </programlisting>
1008 Reason: exactly which implicit parameter you pick up depends on exactly where
1009 you invoke a function. But the ``invocation'' of instance declarations is done
1010 behind the scenes by the compiler, so it's hard to figure out exactly where it is done.
1011 Easiest thing is to outlaw the offending types.</para>
1012 </listitem>
1013 </itemizedlist>
1014 </para>
1015
1016 </sect2>
1017
1018 <sect2 id="linear-implicit-parameters">
1019 <title>Linear implicit parameters
1020 </title>
1021 <para>
1022 Linear implicit parameters are an idea developed by Koen Claessen,
1023 Mark Shields, and Simon PJ.  They address the long-standing
1024 problem that monads seem over-kill for certain sorts of problem, notably:
1025 </para>
1026 <itemizedlist>
1027 <listitem> <para> distributing a supply of unique names </para> </listitem>
1028 <listitem> <para> distributing a suppply of random numbers </para> </listitem>
1029 <listitem> <para> distributing an oracle (as in QuickCheck) </para> </listitem>
1030 </itemizedlist>
1031
1032 <para>
1033 Linear implicit parameters are just like ordinary implicit parameters,
1034 except that they are "linear" -- that is, they cannot be copied, and
1035 must be explicitly "split" instead.  Linear implicit parameters are
1036 written '<literal>%x</literal>' instead of '<literal>?x</literal>'.  
1037 (The '/' in the '%' suggests the split!)
1038 </para>
1039 <para>
1040 For example:
1041 <programlisting>
1042     import GHC.Exts( Splittable )
1043
1044     data NameSupply = ...
1045     
1046     splitNS :: NameSupply -> (NameSupply, NameSupply)
1047     newName :: NameSupply -> Name
1048
1049     instance Splittable NameSupply where
1050         split = splitNS
1051
1052
1053     f :: (%ns :: NameSupply) => Env -> Expr -> Expr
1054     f env (Lam x e) = Lam x' (f env e)
1055                     where
1056                       x'   = newName %ns
1057                       env' = extend env x x'
1058     ...more equations for f...
1059 </programlisting>
1060 Notice that the implicit parameter %ns is consumed 
1061 <itemizedlist>
1062 <listitem> <para> once by the call to <literal>newName</literal> </para> </listitem>
1063 <listitem> <para> once by the recursive call to <literal>f</literal> </para></listitem>
1064 </itemizedlist>
1065 </para>
1066 <para>
1067 So the translation done by the type checker makes
1068 the parameter explicit:
1069 <programlisting>
1070     f :: NameSupply -> Env -> Expr -> Expr
1071     f ns env (Lam x e) = Lam x' (f ns1 env e)
1072                        where
1073                          (ns1,ns2) = splitNS ns
1074                          x' = newName ns2
1075                          env = extend env x x'
1076 </programlisting>
1077 Notice the call to 'split' introduced by the type checker.
1078 How did it know to use 'splitNS'?  Because what it really did
1079 was to introduce a call to the overloaded function 'split',
1080 defined by the class <literal>Splittable</literal>:
1081 <programlisting>
1082         class Splittable a where
1083           split :: a -> (a,a)
1084 </programlisting>
1085 The instance for <literal>Splittable NameSupply</literal> tells GHC how to implement
1086 split for name supplies.  But we can simply write
1087 <programlisting>
1088         g x = (x, %ns, %ns)
1089 </programlisting>
1090 and GHC will infer
1091 <programlisting>
1092         g :: (Splittable a, %ns :: a) => b -> (b,a,a)
1093 </programlisting>
1094 The <literal>Splittable</literal> class is built into GHC.  It's exported by module 
1095 <literal>GHC.Exts</literal>.
1096 </para>
1097 <para>
1098 Other points:
1099 <itemizedlist>
1100 <listitem> <para> '<literal>?x</literal>' and '<literal>%x</literal>' 
1101 are entirely distinct implicit parameters: you 
1102   can use them together and they won't intefere with each other. </para>
1103 </listitem>
1104
1105 <listitem> <para> You can bind linear implicit parameters in 'with' clauses. </para> </listitem>
1106
1107 <listitem> <para>You cannot have implicit parameters (whether linear or not)
1108   in the context of a class or instance declaration. </para></listitem>
1109 </itemizedlist>
1110 </para>
1111
1112 <sect3><title>Warnings</title>
1113
1114 <para>
1115 The monomorphism restriction is even more important than usual.
1116 Consider the example above:
1117 <programlisting>
1118     f :: (%ns :: NameSupply) => Env -> Expr -> Expr
1119     f env (Lam x e) = Lam x' (f env e)
1120                     where
1121                       x'   = newName %ns
1122                       env' = extend env x x'
1123 </programlisting>
1124 If we replaced the two occurrences of x' by (newName %ns), which is
1125 usually a harmless thing to do, we get:
1126 <programlisting>
1127     f :: (%ns :: NameSupply) => Env -> Expr -> Expr
1128     f env (Lam x e) = Lam (newName %ns) (f env e)
1129                     where
1130                       env' = extend env x (newName %ns)
1131 </programlisting>
1132 But now the name supply is consumed in <emphasis>three</emphasis> places
1133 (the two calls to newName,and the recursive call to f), so
1134 the result is utterly different.  Urk!  We don't even have 
1135 the beta rule.
1136 </para>
1137 <para>
1138 Well, this is an experimental change.  With implicit
1139 parameters we have already lost beta reduction anyway, and
1140 (as John Launchbury puts it) we can't sensibly reason about
1141 Haskell programs without knowing their typing.
1142 </para>
1143
1144 </sect3>
1145
1146 <sect3><title>Recursive functions</title>
1147 <para>Linear implicit parameters can be particularly tricky when you have a recursive function
1148 Consider
1149 <programlisting>
1150         foo :: %x::T => Int -> [Int]
1151         foo 0 = []
1152         foo n = %x : foo (n-1)
1153 </programlisting>
1154 where T is some type in class Splittable.</para>
1155 <para>
1156 Do you get a list of all the same T's or all different T's
1157 (assuming that split gives two distinct T's back)?
1158 </para><para>
1159 If you supply the type signature, taking advantage of polymorphic
1160 recursion, you get what you'd probably expect.  Here's the
1161 translated term, where the implicit param is made explicit:
1162 <programlisting>
1163         foo x 0 = []
1164         foo x n = let (x1,x2) = split x
1165                   in x1 : foo x2 (n-1)
1166 </programlisting>
1167 But if you don't supply a type signature, GHC uses the Hindley
1168 Milner trick of using a single monomorphic instance of the function
1169 for the recursive calls. That is what makes Hindley Milner type inference
1170 work.  So the translation becomes
1171 <programlisting>
1172         foo x = let
1173                   foom 0 = []
1174                   foom n = x : foom (n-1)
1175                 in
1176                 foom
1177 </programlisting>
1178 Result: 'x' is not split, and you get a list of identical T's.  So the
1179 semantics of the program depends on whether or not foo has a type signature.
1180 Yikes!
1181 </para><para>
1182 You may say that this is a good reason to dislike linear implicit parameters
1183 and you'd be right.  That is why they are an experimental feature. 
1184 </para>
1185 </sect3>
1186
1187 </sect2>
1188
1189 <sect2 id="functional-dependencies">
1190 <title>Functional dependencies
1191 </title>
1192
1193 <para> Functional dependencies are implemented as described by Mark Jones
1194 in &ldquo;<ulink url="http://www.cse.ogi.edu/~mpj/pubs/fundeps.html">Type Classes with Functional Dependencies</ulink>&rdquo;, Mark P. Jones, 
1195 In Proceedings of the 9th European Symposium on Programming, 
1196 ESOP 2000, Berlin, Germany, March 2000, Springer-Verlag LNCS 1782,
1197 .
1198 </para>
1199
1200 <para>
1201 There should be more documentation, but there isn't (yet).  Yell if you need it.
1202 </para>
1203 </sect2>
1204
1205
1206 <sect2 id="universal-quantification">
1207 <title>Arbitrary-rank polymorphism
1208 </title>
1209
1210 <para>
1211 Haskell type signatures are implicitly quantified.  The new keyword <literal>forall</literal>
1212 allows us to say exactly what this means.  For example:
1213 </para>
1214 <para>
1215 <programlisting>
1216         g :: b -> b
1217 </programlisting>
1218 means this:
1219 <programlisting>
1220         g :: forall b. (b -> b)
1221 </programlisting>
1222 The two are treated identically.
1223 </para>
1224
1225 <para>
1226 However, GHC's type system supports <emphasis>arbitrary-rank</emphasis> 
1227 explicit universal quantification in
1228 types. 
1229 For example, all the following types are legal:
1230 <programlisting>
1231     f1 :: forall a b. a -> b -> a
1232     g1 :: forall a b. (Ord a, Eq  b) => a -> b -> a
1233
1234     f2 :: (forall a. a->a) -> Int -> Int
1235     g2 :: (forall a. Eq a => [a] -> a -> Bool) -> Int -> Int
1236
1237     f3 :: ((forall a. a->a) -> Int) -> Bool -> Bool
1238 </programlisting>
1239 Here, <literal>f1</literal> and <literal>g1</literal> are rank-1 types, and
1240 can be written in standard Haskell (e.g. <literal>f1 :: a->b->a</literal>).
1241 The <literal>forall</literal> makes explicit the universal quantification that
1242 is implicitly added by Haskell.
1243 </para>
1244 <para>
1245 The functions <literal>f2</literal> and <literal>g2</literal> have rank-2 types;
1246 the <literal>forall</literal> is on the left of a function arrrow.  As <literal>g2</literal>
1247 shows, the polymorphic type on the left of the function arrow can be overloaded.
1248 </para>
1249 <para>
1250 The functions <literal>f3</literal> and <literal>g3</literal> have rank-3 types;
1251 they have rank-2 types on the left of a function arrow.
1252 </para>
1253 <para>
1254 GHC allows types of arbitrary rank; you can nest <literal>forall</literal>s
1255 arbitrarily deep in function arrows.   (GHC used to be restricted to rank 2, but
1256 that restriction has now been lifted.)
1257 In particular, a forall-type (also called a "type scheme"),
1258 including an operational type class context, is legal:
1259 <itemizedlist>
1260 <listitem> <para> On the left of a function arrow </para> </listitem>
1261 <listitem> <para> On the right of a function arrow (see <xref linkend="hoist">) </para> </listitem>
1262 <listitem> <para> As the argument of a constructor, or type of a field, in a data type declaration. For
1263 example, any of the <literal>f1,f2,f3,g1,g2,g3</literal> above would be valid
1264 field type signatures.</para> </listitem>
1265 <listitem> <para> As the type of an implicit parameter </para> </listitem>
1266 <listitem> <para> In a pattern type signature (see <xref linkend="scoped-type-variables">) </para> </listitem>
1267 </itemizedlist>
1268 There is one place you cannot put a <literal>forall</literal>:
1269 you cannot instantiate a type variable with a forall-type.  So you cannot 
1270 make a forall-type the argument of a type constructor.  So these types are illegal:
1271 <programlisting>
1272     x1 :: [forall a. a->a]
1273     x2 :: (forall a. a->a, Int)
1274     x3 :: Maybe (forall a. a->a)
1275 </programlisting>
1276 Of course <literal>forall</literal> becomes a keyword; you can't use <literal>forall</literal> as
1277 a type variable any more!
1278 </para>
1279
1280
1281 <sect3 id="univ">
1282 <title>Examples
1283 </title>
1284
1285 <para>
1286 In a <literal>data</literal> or <literal>newtype</literal> declaration one can quantify
1287 the types of the constructor arguments.  Here are several examples:
1288 </para>
1289
1290 <para>
1291
1292 <programlisting>
1293 data T a = T1 (forall b. b -> b -> b) a
1294
1295 data MonadT m = MkMonad { return :: forall a. a -> m a,
1296                           bind   :: forall a b. m a -> (a -> m b) -> m b
1297                         }
1298
1299 newtype Swizzle = MkSwizzle (Ord a => [a] -> [a])
1300 </programlisting>
1301
1302 </para>
1303
1304 <para>
1305 The constructors have rank-2 types:
1306 </para>
1307
1308 <para>
1309
1310 <programlisting>
1311 T1 :: forall a. (forall b. b -> b -> b) -> a -> T a
1312 MkMonad :: forall m. (forall a. a -> m a)
1313                   -> (forall a b. m a -> (a -> m b) -> m b)
1314                   -> MonadT m
1315 MkSwizzle :: (Ord a => [a] -> [a]) -> Swizzle
1316 </programlisting>
1317
1318 </para>
1319
1320 <para>
1321 Notice that you don't need to use a <literal>forall</literal> if there's an
1322 explicit context.  For example in the first argument of the
1323 constructor <function>MkSwizzle</function>, an implicit "<literal>forall a.</literal>" is
1324 prefixed to the argument type.  The implicit <literal>forall</literal>
1325 quantifies all type variables that are not already in scope, and are
1326 mentioned in the type quantified over.
1327 </para>
1328
1329 <para>
1330 As for type signatures, implicit quantification happens for non-overloaded
1331 types too.  So if you write this:
1332
1333 <programlisting>
1334   data T a = MkT (Either a b) (b -> b)
1335 </programlisting>
1336
1337 it's just as if you had written this:
1338
1339 <programlisting>
1340   data T a = MkT (forall b. Either a b) (forall b. b -> b)
1341 </programlisting>
1342
1343 That is, since the type variable <literal>b</literal> isn't in scope, it's
1344 implicitly universally quantified.  (Arguably, it would be better
1345 to <emphasis>require</emphasis> explicit quantification on constructor arguments
1346 where that is what is wanted.  Feedback welcomed.)
1347 </para>
1348
1349 <para>
1350 You construct values of types <literal>T1, MonadT, Swizzle</literal> by applying
1351 the constructor to suitable values, just as usual.  For example,
1352 </para>
1353
1354 <para>
1355
1356 <programlisting>
1357     a1 :: T Int
1358     a1 = T1 (\xy->x) 3
1359     
1360     a2, a3 :: Swizzle
1361     a2 = MkSwizzle sort
1362     a3 = MkSwizzle reverse
1363     
1364     a4 :: MonadT Maybe
1365     a4 = let r x = Just x
1366              b m k = case m of
1367                        Just y -> k y
1368                        Nothing -> Nothing
1369          in
1370          MkMonad r b
1371
1372     mkTs :: (forall b. b -> b -> b) -> a -> [T a]
1373     mkTs f x y = [T1 f x, T1 f y]
1374 </programlisting>
1375
1376 </para>
1377
1378 <para>
1379 The type of the argument can, as usual, be more general than the type
1380 required, as <literal>(MkSwizzle reverse)</literal> shows.  (<function>reverse</function>
1381 does not need the <literal>Ord</literal> constraint.)
1382 </para>
1383
1384 <para>
1385 When you use pattern matching, the bound variables may now have
1386 polymorphic types.  For example:
1387 </para>
1388
1389 <para>
1390
1391 <programlisting>
1392     f :: T a -> a -> (a, Char)
1393     f (T1 w k) x = (w k x, w 'c' 'd')
1394
1395     g :: (Ord a, Ord b) => Swizzle -> [a] -> (a -> b) -> [b]
1396     g (MkSwizzle s) xs f = s (map f (s xs))
1397
1398     h :: MonadT m -> [m a] -> m [a]
1399     h m [] = return m []
1400     h m (x:xs) = bind m x          $ \y ->
1401                  bind m (h m xs)   $ \ys ->
1402                  return m (y:ys)
1403 </programlisting>
1404
1405 </para>
1406
1407 <para>
1408 In the function <function>h</function> we use the record selectors <literal>return</literal>
1409 and <literal>bind</literal> to extract the polymorphic bind and return functions
1410 from the <literal>MonadT</literal> data structure, rather than using pattern
1411 matching.
1412 </para>
1413 </sect3>
1414
1415 <sect3>
1416 <title>Type inference</title>
1417
1418 <para>
1419 In general, type inference for arbitrary-rank types is undecideable.
1420 GHC uses an algorithm proposed by Odersky and Laufer ("Putting type annotations to work", POPL'96)
1421 to get a decidable algorithm by requiring some help from the programmer.
1422 We do not yet have a formal specification of "some help" but the rule is this:
1423 </para>
1424 <para>
1425 <emphasis>For a lambda-bound or case-bound variable, x, either the programmer
1426 provides an explicit polymorphic type for x, or GHC's type inference will assume
1427 that x's type has no foralls in it</emphasis>.
1428 </para>
1429 <para>
1430 What does it mean to "provide" an explicit type for x?  You can do that by 
1431 giving a type signature for x directly, using a pattern type signature
1432 (<xref linkend="scoped-type-variables">), thus:
1433 <programlisting>
1434      \ f :: (forall a. a->a) -> (f True, f 'c')
1435 </programlisting>
1436 Alternatively, you can give a type signature to the enclosing
1437 context, which GHC can "push down" to find the type for the variable:
1438 <programlisting>
1439      (\ f -> (f True, f 'c')) :: (forall a. a->a) -> (Bool,Char)
1440 </programlisting>
1441 Here the type signature on the expression can be pushed inwards
1442 to give a type signature for f.  Similarly, and more commonly,
1443 one can give a type signature for the function itself:
1444 <programlisting>
1445      h :: (forall a. a->a) -> (Bool,Char)
1446      h f = (f True, f 'c')
1447 </programlisting>
1448 You don't need to give a type signature if the lambda bound variable
1449 is a constructor argument.  Here is an example we saw earlier:
1450 <programlisting>
1451     f :: T a -> a -> (a, Char)
1452     f (T1 w k) x = (w k x, w 'c' 'd')
1453 </programlisting>
1454 Here we do not need to give a type signature to <literal>w</literal>, because
1455 it is an argument of constructor <literal>T1</literal> and that tells GHC all
1456 it needs to know.
1457 </para>
1458
1459 </sect3>
1460
1461
1462 <sect3 id="implicit-quant">
1463 <title>Implicit quantification</title>
1464
1465 <para>
1466 GHC performs implicit quantification as follows.  <emphasis>At the top level (only) of 
1467 user-written types, if and only if there is no explicit <literal>forall</literal>,
1468 GHC finds all the type variables mentioned in the type that are not already
1469 in scope, and universally quantifies them.</emphasis>  For example, the following pairs are 
1470 equivalent:
1471 <programlisting>
1472   f :: a -> a
1473   f :: forall a. a -> a
1474
1475   g (x::a) = let
1476                 h :: a -> b -> b
1477                 h x y = y
1478              in ...
1479   g (x::a) = let
1480                 h :: forall b. a -> b -> b
1481                 h x y = y
1482              in ...
1483 </programlisting>
1484 </para>
1485 <para>
1486 Notice that GHC does <emphasis>not</emphasis> find the innermost possible quantification
1487 point.  For example:
1488 <programlisting>
1489   f :: (a -> a) -> Int
1490            -- MEANS
1491   f :: forall a. (a -> a) -> Int
1492            -- NOT
1493   f :: (forall a. a -> a) -> Int
1494
1495
1496   g :: (Ord a => a -> a) -> Int
1497            -- MEANS the illegal type
1498   g :: forall a. (Ord a => a -> a) -> Int
1499            -- NOT
1500   g :: (forall a. Ord a => a -> a) -> Int
1501 </programlisting>
1502 The latter produces an illegal type, which you might think is silly,
1503 but at least the rule is simple.  If you want the latter type, you
1504 can write your for-alls explicitly.  Indeed, doing so is strongly advised
1505 for rank-2 types.
1506 </para>
1507 </sect3>
1508 </sect2>
1509
1510 <sect2 id="type-synonyms">
1511 <title>Liberalised type synonyms 
1512 </title>
1513
1514 <para>
1515 Type synonmys are like macros at the type level, and
1516 GHC does validity checking on types <emphasis>only after expanding type synonyms</emphasis>.
1517 That means that GHC can be very much more liberal about type synonyms than Haskell 98:
1518 <itemizedlist>
1519 <listitem> <para>You can write a <literal>forall</literal> (including overloading)
1520 in a type synonym, thus:
1521 <programlisting>
1522   type Discard a = forall b. Show b => a -> b -> (a, String)
1523
1524   f :: Discard a
1525   f x y = (x, show y)
1526
1527   g :: Discard Int -> (Int,Bool)    -- A rank-2 type
1528   g f = f Int True
1529 </programlisting>
1530 </para>
1531 </listitem>
1532
1533 <listitem><para>
1534 You can write an unboxed tuple in a type synonym:
1535 <programlisting>
1536   type Pr = (# Int, Int #)
1537
1538   h :: Int -> Pr
1539   h x = (# x, x #)
1540 </programlisting>
1541 </para></listitem>
1542
1543 <listitem><para>
1544 You can apply a type synonym to a forall type:
1545 <programlisting>
1546   type Foo a = a -> a -> Bool
1547  
1548   f :: Foo (forall b. b->b)
1549 </programlisting>
1550 After expanding the synonym, <literal>f</literal> has the legal (in GHC) type:
1551 <programlisting>
1552   f :: (forall b. b->b) -> (forall b. b->b) -> Bool
1553 </programlisting>
1554 </para></listitem>
1555
1556 <listitem><para>
1557 You can apply a type synonym to a partially applied type synonym:
1558 <programlisting>
1559   type Generic i o = forall x. i x -> o x
1560   type Id x = x
1561   
1562   foo :: Generic Id []
1563 </programlisting>
1564 After epxanding the synonym, <literal>foo</literal> has the legal (in GHC) type:
1565 <programlisting>
1566   foo :: forall x. x -> [x]
1567 </programlisting>
1568 </para></listitem>
1569
1570 </itemizedlist>
1571 </para>
1572
1573 <para>
1574 GHC currently does kind checking before expanding synonyms (though even that
1575 could be changed.)
1576 </para>
1577 <para>
1578 After expanding type synonyms, GHC does validity checking on types, looking for
1579 the following mal-formedness which isn't detected simply by kind checking:
1580 <itemizedlist>
1581 <listitem><para>
1582 Type constructor applied to a type involving for-alls.
1583 </para></listitem>
1584 <listitem><para>
1585 Unboxed tuple on left of an arrow.
1586 </para></listitem>
1587 <listitem><para>
1588 Partially-applied type synonym.
1589 </para></listitem>
1590 </itemizedlist>
1591 So, for example,
1592 this will be rejected:
1593 <programlisting>
1594   type Pr = (# Int, Int #)
1595
1596   h :: Pr -> Int
1597   h x = ...
1598 </programlisting>
1599 because GHC does not allow  unboxed tuples on the left of a function arrow.
1600 </para>
1601 </sect2>
1602
1603 <sect2 id="hoist">
1604 <title>For-all hoisting</title>
1605 <para>
1606 It is often convenient to use generalised type synonyms at the right hand
1607 end of an arrow, thus:
1608 <programlisting>
1609   type Discard a = forall b. a -> b -> a
1610
1611   g :: Int -> Discard Int
1612   g x y z = x+y
1613 </programlisting>
1614 Simply expanding the type synonym would give
1615 <programlisting>
1616   g :: Int -> (forall b. Int -> b -> Int)
1617 </programlisting>
1618 but GHC "hoists" the <literal>forall</literal> to give the isomorphic type
1619 <programlisting>
1620   g :: forall b. Int -> Int -> b -> Int
1621 </programlisting>
1622 In general, the rule is this: <emphasis>to determine the type specified by any explicit
1623 user-written type (e.g. in a type signature), GHC expands type synonyms and then repeatedly
1624 performs the transformation:</emphasis>
1625 <programlisting>
1626   <emphasis>type1</emphasis> -> forall a1..an. <emphasis>context2</emphasis> => <emphasis>type2</emphasis>
1627 ==>
1628   forall a1..an. <emphasis>context2</emphasis> => <emphasis>type1</emphasis> -> <emphasis>type2</emphasis>
1629 </programlisting>
1630 (In fact, GHC tries to retain as much synonym information as possible for use in
1631 error messages, but that is a usability issue.)  This rule applies, of course, whether
1632 or not the <literal>forall</literal> comes from a synonym. For example, here is another
1633 valid way to write <literal>g</literal>'s type signature:
1634 <programlisting>
1635   g :: Int -> Int -> forall b. b -> Int
1636 </programlisting>
1637 </para>
1638 <para>
1639 When doing this hoisting operation, GHC eliminates duplicate constraints.  For
1640 example:
1641 <programlisting>
1642   type Foo a = (?x::Int) => Bool -> a
1643   g :: Foo (Foo Int)
1644 </programlisting>
1645 means
1646 <programlisting>
1647   g :: (?x::Int) => Bool -> Bool -> Int
1648 </programlisting>
1649 </para>
1650 </sect2>
1651
1652
1653 <sect2 id="existential-quantification">
1654 <title>Existentially quantified data constructors
1655 </title>
1656
1657 <para>
1658 The idea of using existential quantification in data type declarations
1659 was suggested by Laufer (I believe, thought doubtless someone will
1660 correct me), and implemented in Hope+. It's been in Lennart
1661 Augustsson's <Command>hbc</Command> Haskell compiler for several years, and
1662 proved very useful.  Here's the idea.  Consider the declaration:
1663 </para>
1664
1665 <para>
1666
1667 <programlisting>
1668   data Foo = forall a. MkFoo a (a -> Bool)
1669            | Nil
1670 </programlisting>
1671
1672 </para>
1673
1674 <para>
1675 The data type <literal>Foo</literal> has two constructors with types:
1676 </para>
1677
1678 <para>
1679
1680 <programlisting>
1681   MkFoo :: forall a. a -> (a -> Bool) -> Foo
1682   Nil   :: Foo
1683 </programlisting>
1684
1685 </para>
1686
1687 <para>
1688 Notice that the type variable <literal>a</literal> in the type of <function>MkFoo</function>
1689 does not appear in the data type itself, which is plain <literal>Foo</literal>.
1690 For example, the following expression is fine:
1691 </para>
1692
1693 <para>
1694
1695 <programlisting>
1696   [MkFoo 3 even, MkFoo 'c' isUpper] :: [Foo]
1697 </programlisting>
1698
1699 </para>
1700
1701 <para>
1702 Here, <literal>(MkFoo 3 even)</literal> packages an integer with a function
1703 <function>even</function> that maps an integer to <literal>Bool</literal>; and <function>MkFoo 'c'
1704 isUpper</function> packages a character with a compatible function.  These
1705 two things are each of type <literal>Foo</literal> and can be put in a list.
1706 </para>
1707
1708 <para>
1709 What can we do with a value of type <literal>Foo</literal>?.  In particular,
1710 what happens when we pattern-match on <function>MkFoo</function>?
1711 </para>
1712
1713 <para>
1714
1715 <programlisting>
1716   f (MkFoo val fn) = ???
1717 </programlisting>
1718
1719 </para>
1720
1721 <para>
1722 Since all we know about <literal>val</literal> and <function>fn</function> is that they
1723 are compatible, the only (useful) thing we can do with them is to
1724 apply <function>fn</function> to <literal>val</literal> to get a boolean.  For example:
1725 </para>
1726
1727 <para>
1728
1729 <programlisting>
1730   f :: Foo -> Bool
1731   f (MkFoo val fn) = fn val
1732 </programlisting>
1733
1734 </para>
1735
1736 <para>
1737 What this allows us to do is to package heterogenous values
1738 together with a bunch of functions that manipulate them, and then treat
1739 that collection of packages in a uniform manner.  You can express
1740 quite a bit of object-oriented-like programming this way.
1741 </para>
1742
1743 <sect3 id="existential">
1744 <title>Why existential?
1745 </title>
1746
1747 <para>
1748 What has this to do with <emphasis>existential</emphasis> quantification?
1749 Simply that <function>MkFoo</function> has the (nearly) isomorphic type
1750 </para>
1751
1752 <para>
1753
1754 <programlisting>
1755   MkFoo :: (exists a . (a, a -> Bool)) -> Foo
1756 </programlisting>
1757
1758 </para>
1759
1760 <para>
1761 But Haskell programmers can safely think of the ordinary
1762 <emphasis>universally</emphasis> quantified type given above, thereby avoiding
1763 adding a new existential quantification construct.
1764 </para>
1765
1766 </sect3>
1767
1768 <sect3>
1769 <title>Type classes</title>
1770
1771 <para>
1772 An easy extension (implemented in <Command>hbc</Command>) is to allow
1773 arbitrary contexts before the constructor.  For example:
1774 </para>
1775
1776 <para>
1777
1778 <programlisting>
1779 data Baz = forall a. Eq a => Baz1 a a
1780          | forall b. Show b => Baz2 b (b -> b)
1781 </programlisting>
1782
1783 </para>
1784
1785 <para>
1786 The two constructors have the types you'd expect:
1787 </para>
1788
1789 <para>
1790
1791 <programlisting>
1792 Baz1 :: forall a. Eq a => a -> a -> Baz
1793 Baz2 :: forall b. Show b => b -> (b -> b) -> Baz
1794 </programlisting>
1795
1796 </para>
1797
1798 <para>
1799 But when pattern matching on <function>Baz1</function> the matched values can be compared
1800 for equality, and when pattern matching on <function>Baz2</function> the first matched
1801 value can be converted to a string (as well as applying the function to it).
1802 So this program is legal:
1803 </para>
1804
1805 <para>
1806
1807 <programlisting>
1808   f :: Baz -> String
1809   f (Baz1 p q) | p == q    = "Yes"
1810                | otherwise = "No"
1811   f (Baz2 v fn)            = show (fn v)
1812 </programlisting>
1813
1814 </para>
1815
1816 <para>
1817 Operationally, in a dictionary-passing implementation, the
1818 constructors <function>Baz1</function> and <function>Baz2</function> must store the
1819 dictionaries for <literal>Eq</literal> and <literal>Show</literal> respectively, and
1820 extract it on pattern matching.
1821 </para>
1822
1823 <para>
1824 Notice the way that the syntax fits smoothly with that used for
1825 universal quantification earlier.
1826 </para>
1827
1828 </sect3>
1829
1830 <sect3>
1831 <title>Restrictions</title>
1832
1833 <para>
1834 There are several restrictions on the ways in which existentially-quantified
1835 constructors can be use.
1836 </para>
1837
1838 <para>
1839
1840 <itemizedlist>
1841 <listitem>
1842
1843 <para>
1844  When pattern matching, each pattern match introduces a new,
1845 distinct, type for each existential type variable.  These types cannot
1846 be unified with any other type, nor can they escape from the scope of
1847 the pattern match.  For example, these fragments are incorrect:
1848
1849
1850 <programlisting>
1851 f1 (MkFoo a f) = a
1852 </programlisting>
1853
1854
1855 Here, the type bound by <function>MkFoo</function> "escapes", because <literal>a</literal>
1856 is the result of <function>f1</function>.  One way to see why this is wrong is to
1857 ask what type <function>f1</function> has:
1858
1859
1860 <programlisting>
1861   f1 :: Foo -> a             -- Weird!
1862 </programlisting>
1863
1864
1865 What is this "<literal>a</literal>" in the result type? Clearly we don't mean
1866 this:
1867
1868
1869 <programlisting>
1870   f1 :: forall a. Foo -> a   -- Wrong!
1871 </programlisting>
1872
1873
1874 The original program is just plain wrong.  Here's another sort of error
1875
1876
1877 <programlisting>
1878   f2 (Baz1 a b) (Baz1 p q) = a==q
1879 </programlisting>
1880
1881
1882 It's ok to say <literal>a==b</literal> or <literal>p==q</literal>, but
1883 <literal>a==q</literal> is wrong because it equates the two distinct types arising
1884 from the two <function>Baz1</function> constructors.
1885
1886
1887 </para>
1888 </listitem>
1889 <listitem>
1890
1891 <para>
1892 You can't pattern-match on an existentially quantified
1893 constructor in a <literal>let</literal> or <literal>where</literal> group of
1894 bindings. So this is illegal:
1895
1896
1897 <programlisting>
1898   f3 x = a==b where { Baz1 a b = x }
1899 </programlisting>
1900
1901
1902 You can only pattern-match
1903 on an existentially-quantified constructor in a <literal>case</literal> expression or
1904 in the patterns of a function definition.
1905
1906 The reason for this restriction is really an implementation one.
1907 Type-checking binding groups is already a nightmare without
1908 existentials complicating the picture.  Also an existential pattern
1909 binding at the top level of a module doesn't make sense, because it's
1910 not clear how to prevent the existentially-quantified type "escaping".
1911 So for now, there's a simple-to-state restriction.  We'll see how
1912 annoying it is.
1913
1914 </para>
1915 </listitem>
1916 <listitem>
1917
1918 <para>
1919 You can't use existential quantification for <literal>newtype</literal>
1920 declarations.  So this is illegal:
1921
1922
1923 <programlisting>
1924   newtype T = forall a. Ord a => MkT a
1925 </programlisting>
1926
1927
1928 Reason: a value of type <literal>T</literal> must be represented as a pair
1929 of a dictionary for <literal>Ord t</literal> and a value of type <literal>t</literal>.
1930 That contradicts the idea that <literal>newtype</literal> should have no
1931 concrete representation.  You can get just the same efficiency and effect
1932 by using <literal>data</literal> instead of <literal>newtype</literal>.  If there is no
1933 overloading involved, then there is more of a case for allowing
1934 an existentially-quantified <literal>newtype</literal>, because the <literal>data</literal>
1935 because the <literal>data</literal> version does carry an implementation cost,
1936 but single-field existentially quantified constructors aren't much
1937 use.  So the simple restriction (no existential stuff on <literal>newtype</literal>)
1938 stands, unless there are convincing reasons to change it.
1939
1940
1941 </para>
1942 </listitem>
1943 <listitem>
1944
1945 <para>
1946  You can't use <literal>deriving</literal> to define instances of a
1947 data type with existentially quantified data constructors.
1948
1949 Reason: in most cases it would not make sense. For example:&num;
1950
1951 <programlisting>
1952 data T = forall a. MkT [a] deriving( Eq )
1953 </programlisting>
1954
1955 To derive <literal>Eq</literal> in the standard way we would need to have equality
1956 between the single component of two <function>MkT</function> constructors:
1957
1958 <programlisting>
1959 instance Eq T where
1960   (MkT a) == (MkT b) = ???
1961 </programlisting>
1962
1963 But <VarName>a</VarName> and <VarName>b</VarName> have distinct types, and so can't be compared.
1964 It's just about possible to imagine examples in which the derived instance
1965 would make sense, but it seems altogether simpler simply to prohibit such
1966 declarations.  Define your own instances!
1967 </para>
1968 </listitem>
1969
1970 </itemizedlist>
1971
1972 </para>
1973
1974 </sect3>
1975
1976 </sect2>
1977
1978 <sect2 id="scoped-type-variables">
1979 <title>Scoped type variables
1980 </title>
1981
1982 <para>
1983 A <emphasis>pattern type signature</emphasis> can introduce a <emphasis>scoped type
1984 variable</emphasis>.  For example
1985 </para>
1986
1987 <para>
1988
1989 <programlisting>
1990 f (xs::[a]) = ys ++ ys
1991            where
1992               ys :: [a]
1993               ys = reverse xs
1994 </programlisting>
1995
1996 </para>
1997
1998 <para>
1999 The pattern <literal>(xs::[a])</literal> includes a type signature for <VarName>xs</VarName>.
2000 This brings the type variable <literal>a</literal> into scope; it scopes over
2001 all the patterns and right hand sides for this equation for <function>f</function>.
2002 In particular, it is in scope at the type signature for <VarName>y</VarName>.
2003 </para>
2004
2005 <para>
2006  Pattern type signatures are completely orthogonal to ordinary, separate
2007 type signatures.  The two can be used independently or together.
2008 At ordinary type signatures, such as that for <VarName>ys</VarName>, any type variables
2009 mentioned in the type signature <emphasis>that are not in scope</emphasis> are
2010 implicitly universally quantified.  (If there are no type variables in
2011 scope, all type variables mentioned in the signature are universally
2012 quantified, which is just as in Haskell 98.)  In this case, since <VarName>a</VarName>
2013 is in scope, it is not universally quantified, so the type of <VarName>ys</VarName> is
2014 the same as that of <VarName>xs</VarName>.  In Haskell 98 it is not possible to declare
2015 a type for <VarName>ys</VarName>; a major benefit of scoped type variables is that
2016 it becomes possible to do so.
2017 </para>
2018
2019 <para>
2020 Scoped type variables are implemented in both GHC and Hugs.  Where the
2021 implementations differ from the specification below, those differences
2022 are noted.
2023 </para>
2024
2025 <para>
2026 So much for the basic idea.  Here are the details.
2027 </para>
2028
2029 <sect3>
2030 <title>What a pattern type signature means</title>
2031 <para>
2032 A type variable brought into scope by a pattern type signature is simply
2033 the name for a type.   The restriction they express is that all occurrences
2034 of the same name mean the same type.  For example:
2035 <programlisting>
2036   f :: [Int] -> Int -> Int
2037   f (xs::[a]) (y::a) = (head xs + y) :: a
2038 </programlisting>
2039 The pattern type signatures on the left hand side of
2040 <literal>f</literal> express the fact that <literal>xs</literal>
2041 must be a list of things of some type <literal>a</literal>; and that <literal>y</literal>
2042 must have this same type.  The type signature on the expression <literal>(head xs)</literal>
2043 specifies that this expression must have the same type <literal>a</literal>.
2044 <emphasis>There is no requirement that the type named by "<literal>a</literal>" is
2045 in fact a type variable</emphasis>.  Indeed, in this case, the type named by "<literal>a</literal>" is
2046 <literal>Int</literal>.  (This is a slight liberalisation from the original rather complex
2047 rules, which specified that a pattern-bound type variable should be universally quantified.)
2048 For example, all of these are legal:</para>
2049
2050 <programlisting>
2051   t (x::a) (y::a) = x+y*2
2052
2053   f (x::a) (y::b) = [x,y]       -- a unifies with b
2054
2055   g (x::a) = x + 1::Int         -- a unifies with Int
2056
2057   h x = let k (y::a) = [x,y]    -- a is free in the
2058         in k x                  -- environment
2059
2060   k (x::a) True    = ...        -- a unifies with Int
2061   k (x::Int) False = ...
2062
2063   w :: [b] -> [b]
2064   w (x::a) = x                  -- a unifies with [b]
2065 </programlisting>
2066
2067 </sect3>
2068
2069 <sect3>
2070 <title>Scope and implicit quantification</title>
2071
2072 <para>
2073
2074 <itemizedlist>
2075 <listitem>
2076
2077 <para>
2078 All the type variables mentioned in a pattern,
2079 that are not already in scope,
2080 are brought into scope by the pattern.  We describe this set as
2081 the <emphasis>type variables bound by the pattern</emphasis>.
2082 For example:
2083 <programlisting>
2084   f (x::a) = let g (y::(a,b)) = fst y
2085              in
2086              g (x,True)
2087 </programlisting>
2088 The pattern <literal>(x::a)</literal> brings the type variable
2089 <literal>a</literal> into scope, as well as the term 
2090 variable <literal>x</literal>.  The pattern <literal>(y::(a,b))</literal>
2091 contains an occurrence of the already-in-scope type variable <literal>a</literal>,
2092 and brings into scope the type variable <literal>b</literal>.
2093 </para>
2094 </listitem>
2095
2096 <listitem>
2097 <para>
2098 The type variable(s) bound by the pattern have the same scope
2099 as the term variable(s) bound by the pattern.  For example:
2100 <programlisting>
2101   let
2102     f (x::a) = <...rhs of f...>
2103     (p::b, q::b) = (1,2)
2104   in <...body of let...>
2105 </programlisting>
2106 Here, the type variable <literal>a</literal> scopes over the right hand side of <literal>f</literal>,
2107 just like <literal>x</literal> does; while the type variable <literal>b</literal> scopes over the
2108 body of the <literal>let</literal>, and all the other definitions in the <literal>let</literal>,
2109 just like <literal>p</literal> and <literal>q</literal> do.
2110 Indeed, the newly bound type variables also scope over any ordinary, separate
2111 type signatures in the <literal>let</literal> group.
2112 </para>
2113 </listitem>
2114
2115
2116 <listitem>
2117 <para>
2118 The type variables bound by the pattern may be 
2119 mentioned in ordinary type signatures or pattern 
2120 type signatures anywhere within their scope.
2121
2122 </para>
2123 </listitem>
2124
2125 <listitem>
2126 <para>
2127  In ordinary type signatures, any type variable mentioned in the
2128 signature that is in scope is <emphasis>not</emphasis> universally quantified.
2129
2130 </para>
2131 </listitem>
2132
2133 <listitem>
2134
2135 <para>
2136  Ordinary type signatures do not bring any new type variables
2137 into scope (except in the type signature itself!). So this is illegal:
2138
2139 <programlisting>
2140   f :: a -> a
2141   f x = x::a
2142 </programlisting>
2143
2144 It's illegal because <VarName>a</VarName> is not in scope in the body of <function>f</function>,
2145 so the ordinary signature <literal>x::a</literal> is equivalent to <literal>x::forall a.a</literal>;
2146 and that is an incorrect typing.
2147
2148 </para>
2149 </listitem>
2150
2151 <listitem>
2152 <para>
2153 The pattern type signature is a monotype:
2154 </para>
2155
2156 <itemizedlist>
2157 <listitem> <para> 
2158 A pattern type signature cannot contain any explicit <literal>forall</literal> quantification.
2159 </para> </listitem>
2160
2161 <listitem>  <para> 
2162 The type variables bound by a pattern type signature can only be instantiated to monotypes,
2163 not to type schemes.
2164 </para> </listitem>
2165
2166 <listitem>  <para> 
2167 There is no implicit universal quantification on pattern type signatures (in contrast to
2168 ordinary type signatures).
2169 </para> </listitem>
2170
2171 </itemizedlist>
2172
2173 </listitem>
2174
2175 <listitem>
2176 <para>
2177
2178 The type variables in the head of a <literal>class</literal> or <literal>instance</literal> declaration
2179 scope over the methods defined in the <literal>where</literal> part.  For example:
2180
2181
2182 <programlisting>
2183   class C a where
2184     op :: [a] -> a
2185
2186     op xs = let ys::[a]
2187                 ys = reverse xs
2188             in
2189             head ys
2190 </programlisting>
2191
2192
2193 (Not implemented in Hugs yet, Dec 98).
2194 </para>
2195 </listitem>
2196
2197 </itemizedlist>
2198
2199 </para>
2200
2201 </sect3>
2202
2203 <sect3>
2204 <title>Result type signatures</title>
2205
2206 <para>
2207
2208 <itemizedlist>
2209 <listitem>
2210
2211 <para>
2212  The result type of a function can be given a signature,
2213 thus:
2214
2215
2216 <programlisting>
2217   f (x::a) :: [a] = [x,x,x]
2218 </programlisting>
2219
2220
2221 The final <literal>:: [a]</literal> after all the patterns gives a signature to the
2222 result type.  Sometimes this is the only way of naming the type variable
2223 you want:
2224
2225
2226 <programlisting>
2227   f :: Int -> [a] -> [a]
2228   f n :: ([a] -> [a]) = let g (x::a, y::a) = (y,x)
2229                         in \xs -> map g (reverse xs `zip` xs)
2230 </programlisting>
2231
2232
2233 </para>
2234 </listitem>
2235
2236 </itemizedlist>
2237
2238 </para>
2239
2240 <para>
2241 Result type signatures are not yet implemented in Hugs.
2242 </para>
2243
2244 </sect3>
2245
2246 <sect3>
2247 <title>Where a pattern type signature can occur</title>
2248
2249 <para>
2250 A pattern type signature can occur in any pattern.  For example:
2251 <itemizedlist>
2252
2253 <listitem>
2254 <para>
2255 A pattern type signature can be on an arbitrary sub-pattern, not
2256 ust on a variable:
2257
2258
2259 <programlisting>
2260   f ((x,y)::(a,b)) = (y,x) :: (b,a)
2261 </programlisting>
2262
2263
2264 </para>
2265 </listitem>
2266 <listitem>
2267
2268 <para>
2269  Pattern type signatures, including the result part, can be used
2270 in lambda abstractions:
2271
2272 <programlisting>
2273   (\ (x::a, y) :: a -> x)
2274 </programlisting>
2275 </para>
2276 </listitem>
2277 <listitem>
2278
2279 <para>
2280  Pattern type signatures, including the result part, can be used
2281 in <literal>case</literal> expressions:
2282
2283
2284 <programlisting>
2285   case e of { (x::a, y) :: a -> x }
2286 </programlisting>
2287
2288 </para>
2289 </listitem>
2290
2291 <listitem>
2292 <para>
2293 To avoid ambiguity, the type after the &ldquo;<literal>::</literal>&rdquo; in a result
2294 pattern signature on a lambda or <literal>case</literal> must be atomic (i.e. a single
2295 token or a parenthesised type of some sort).  To see why,
2296 consider how one would parse this:
2297
2298
2299 <programlisting>
2300   \ x :: a -> b -> x
2301 </programlisting>
2302
2303
2304 </para>
2305 </listitem>
2306
2307 <listitem>
2308
2309 <para>
2310  Pattern type signatures can bind existential type variables.
2311 For example:
2312
2313
2314 <programlisting>
2315   data T = forall a. MkT [a]
2316
2317   f :: T -> T
2318   f (MkT [t::a]) = MkT t3
2319                  where
2320                    t3::[a] = [t,t,t]
2321 </programlisting>
2322
2323
2324 </para>
2325 </listitem>
2326
2327
2328 <listitem>
2329
2330 <para>
2331 Pattern type signatures 
2332 can be used in pattern bindings:
2333
2334 <programlisting>
2335   f x = let (y, z::a) = x in ...
2336   f1 x                = let (y, z::Int) = x in ...
2337   f2 (x::(Int,a))     = let (y, z::a)   = x in ...
2338   f3 :: (b->b)        = \x -> x
2339 </programlisting>
2340
2341 In all such cases, the binding is not generalised over the pattern-bound
2342 type variables.  Thus <literal>f3</literal> is monomorphic; <literal>f3</literal>
2343 has type <literal>b -&gt; b</literal> for some type <literal>b</literal>, 
2344 and <emphasis>not</emphasis> <literal>forall b. b -&gt; b</literal>.
2345 In contrast, the binding
2346 <programlisting>
2347   f4 :: b->b
2348   f4 = \x -> x
2349 </programlisting>
2350 makes a polymorphic function, but <literal>b</literal> is not in scope anywhere
2351 in <literal>f4</literal>'s scope.
2352
2353 </para>
2354 </listitem>
2355 </itemizedlist>
2356 </para>
2357
2358 </sect3>
2359 </sect2>
2360
2361
2362 </sect1>
2363 <!-- ==================== End of type system extensions =================  -->
2364   
2365
2366 <!-- ==================== ASSERTIONS =================  -->
2367
2368 <sect1 id="sec-assertions">
2369 <title>Assertions
2370 <indexterm><primary>Assertions</primary></indexterm>
2371 </title>
2372
2373 <para>
2374 If you want to make use of assertions in your standard Haskell code, you
2375 could define a function like the following:
2376 </para>
2377
2378 <para>
2379
2380 <programlisting>
2381 assert :: Bool -> a -> a
2382 assert False x = error "assertion failed!"
2383 assert _     x = x
2384 </programlisting>
2385
2386 </para>
2387
2388 <para>
2389 which works, but gives you back a less than useful error message --
2390 an assertion failed, but which and where?
2391 </para>
2392
2393 <para>
2394 One way out is to define an extended <function>assert</function> function which also
2395 takes a descriptive string to include in the error message and
2396 perhaps combine this with the use of a pre-processor which inserts
2397 the source location where <function>assert</function> was used.
2398 </para>
2399
2400 <para>
2401 Ghc offers a helping hand here, doing all of this for you. For every
2402 use of <function>assert</function> in the user's source:
2403 </para>
2404
2405 <para>
2406
2407 <programlisting>
2408 kelvinToC :: Double -> Double
2409 kelvinToC k = assert (k &gt;= 0.0) (k+273.15)
2410 </programlisting>
2411
2412 </para>
2413
2414 <para>
2415 Ghc will rewrite this to also include the source location where the
2416 assertion was made,
2417 </para>
2418
2419 <para>
2420
2421 <programlisting>
2422 assert pred val ==> assertError "Main.hs|15" pred val
2423 </programlisting>
2424
2425 </para>
2426
2427 <para>
2428 The rewrite is only performed by the compiler when it spots
2429 applications of <function>Control.Exception.assert</function>, so you
2430 can still define and use your own versions of
2431 <function>assert</function>, should you so wish. If not, import
2432 <literal>Control.Exception</literal> to make use
2433 <function>assert</function> in your code.
2434 </para>
2435
2436 <para>
2437 To have the compiler ignore uses of assert, use the compiler option
2438 <option>-fignore-asserts</option>. <indexterm><primary>-fignore-asserts
2439 option</primary></indexterm> That is, expressions of the form
2440 <literal>assert pred e</literal> will be rewritten to
2441 <literal>e</literal>.
2442 </para>
2443
2444 <para>
2445 Assertion failures can be caught, see the documentation for the
2446 <literal>Control.Exception</literal> library for the details.
2447 </para>
2448
2449 </sect1>
2450
2451
2452 <sect1 id="syntax-extns">
2453 <title>Syntactic extensions</title>
2454
2455 <!-- ====================== HIERARCHICAL MODULES =======================  -->
2456
2457     <sect2 id="hierarchical-modules">
2458       <title>Hierarchical Modules</title>
2459
2460       <para>GHC supports a small extension to the syntax of module
2461       names: a module name is allowed to contain a dot
2462       <literal>&lsquo;.&rsquo;</literal>.  This is also known as the
2463       &ldquo;hierarchical module namespace&rdquo; extension, because
2464       it extends the normally flat Haskell module namespace into a
2465       more flexible hierarchy of modules.</para>
2466
2467       <para>This extension has very little impact on the language
2468       itself; modules names are <emphasis>always</emphasis> fully
2469       qualified, so you can just think of the fully qualified module
2470       name as <quote>the module name</quote>.  In particular, this
2471       means that the full module name must be given after the
2472       <literal>module</literal> keyword at the beginning of the
2473       module; for example, the module <literal>A.B.C</literal> must
2474       begin</para>
2475
2476 <programlisting>module A.B.C</programlisting>
2477
2478
2479       <para>It is a common strategy to use the <literal>as</literal>
2480       keyword to save some typing when using qualified names with
2481       hierarchical modules.  For example:</para>
2482
2483 <programlisting>
2484 import qualified Control.Monad.ST.Strict as ST
2485 </programlisting>
2486
2487       <para>Hierarchical modules have an impact on the way that GHC
2488       searches for files.  For a description, see <xref
2489       linkend="finding-hierarchical-modules">.</para>
2490
2491       <para>GHC comes with a large collection of libraries arranged
2492       hierarchically; see the accompanying library documentation.
2493       There is an ongoing project to create and maintain a stable set
2494       of <quote>core</quote> libraries used by several Haskell
2495       compilers, and the libraries that GHC comes with represent the
2496       current status of that project.  For more details, see <ulink
2497       url="http://www.haskell.org/~simonmar/libraries/libraries.html">Haskell
2498       Libraries</ulink>.</para>
2499
2500     </sect2>
2501
2502 <!-- ====================== PATTERN GUARDS =======================  -->
2503
2504 <sect2 id="pattern-guards">
2505 <title>Pattern guards</title>
2506
2507 <para>
2508 <indexterm><primary>Pattern guards (Glasgow extension)</primary></indexterm>
2509 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.)
2510 </para>
2511
2512 <para>
2513 Suppose we have an abstract data type of finite maps, with a
2514 lookup operation:
2515
2516 <programlisting>
2517 lookup :: FiniteMap -> Int -> Maybe Int
2518 </programlisting>
2519
2520 The lookup returns <function>Nothing</function> if the supplied key is not in the domain of the mapping, and <function>(Just v)</function> otherwise,
2521 where <VarName>v</VarName> is the value that the key maps to.  Now consider the following definition:
2522 </para>
2523
2524 <programlisting>
2525 clunky env var1 var2 | ok1 && ok2 = val1 + val2
2526 | otherwise  = var1 + var2
2527 where
2528   m1 = lookup env var1
2529   m2 = lookup env var2
2530   ok1 = maybeToBool m1
2531   ok2 = maybeToBool m2
2532   val1 = expectJust m1
2533   val2 = expectJust m2
2534 </programlisting>
2535
2536 <para>
2537 The auxiliary functions are 
2538 </para>
2539
2540 <programlisting>
2541 maybeToBool :: Maybe a -&gt; Bool
2542 maybeToBool (Just x) = True
2543 maybeToBool Nothing  = False
2544
2545 expectJust :: Maybe a -&gt; a
2546 expectJust (Just x) = x
2547 expectJust Nothing  = error "Unexpected Nothing"
2548 </programlisting>
2549
2550 <para>
2551 What is <function>clunky</function> doing? The guard <literal>ok1 &&
2552 ok2</literal> checks that both lookups succeed, using
2553 <function>maybeToBool</function> to convert the <function>Maybe</function>
2554 types to booleans. The (lazily evaluated) <function>expectJust</function>
2555 calls extract the values from the results of the lookups, and binds the
2556 returned values to <VarName>val1</VarName> and <VarName>val2</VarName>
2557 respectively.  If either lookup fails, then clunky takes the
2558 <literal>otherwise</literal> case and returns the sum of its arguments.
2559 </para>
2560
2561 <para>
2562 This is certainly legal Haskell, but it is a tremendously verbose and
2563 un-obvious way to achieve the desired effect.  Arguably, a more direct way
2564 to write clunky would be to use case expressions:
2565 </para>
2566
2567 <programlisting>
2568 clunky env var1 var1 = case lookup env var1 of
2569   Nothing -&gt; fail
2570   Just val1 -&gt; case lookup env var2 of
2571     Nothing -&gt; fail
2572     Just val2 -&gt; val1 + val2
2573 where
2574   fail = val1 + val2
2575 </programlisting>
2576
2577 <para>
2578 This is a bit shorter, but hardly better.  Of course, we can rewrite any set
2579 of pattern-matching, guarded equations as case expressions; that is
2580 precisely what the compiler does when compiling equations! The reason that
2581 Haskell provides guarded equations is because they allow us to write down
2582 the cases we want to consider, one at a time, independently of each other. 
2583 This structure is hidden in the case version.  Two of the right-hand sides
2584 are really the same (<function>fail</function>), and the whole expression
2585 tends to become more and more indented. 
2586 </para>
2587
2588 <para>
2589 Here is how I would write clunky:
2590 </para>
2591
2592 <programlisting>
2593 clunky env var1 var1
2594   | Just val1 &lt;- lookup env var1
2595   , Just val2 &lt;- lookup env var2
2596   = val1 + val2
2597 ...other equations for clunky...
2598 </programlisting>
2599
2600 <para>
2601 The semantics should be clear enough.  The qualifers are matched in order. 
2602 For a <literal>&lt;-</literal> qualifier, which I call a pattern guard, the
2603 right hand side is evaluated and matched against the pattern on the left. 
2604 If the match fails then the whole guard fails and the next equation is
2605 tried.  If it succeeds, then the appropriate binding takes place, and the
2606 next qualifier is matched, in the augmented environment.  Unlike list
2607 comprehensions, however, the type of the expression to the right of the
2608 <literal>&lt;-</literal> is the same as the type of the pattern to its
2609 left.  The bindings introduced by pattern guards scope over all the
2610 remaining guard qualifiers, and over the right hand side of the equation.
2611 </para>
2612
2613 <para>
2614 Just as with list comprehensions, boolean expressions can be freely mixed
2615 with among the pattern guards.  For example:
2616 </para>
2617
2618 <programlisting>
2619 f x | [y] <- x
2620     , y > 3
2621     , Just z <- h y
2622     = ...
2623 </programlisting>
2624
2625 <para>
2626 Haskell's current guards therefore emerge as a special case, in which the
2627 qualifier list has just one element, a boolean expression.
2628 </para>
2629 </sect2>
2630
2631 <!-- ===================== PARALLEL LIST COMPREHENSIONS ===================  -->
2632
2633   <sect2 id="parallel-list-comprehensions">
2634     <title>Parallel List Comprehensions</title>
2635     <indexterm><primary>list comprehensions</primary><secondary>parallel</secondary>
2636     </indexterm>
2637     <indexterm><primary>parallel list comprehensions</primary>
2638     </indexterm>
2639
2640     <para>Parallel list comprehensions are a natural extension to list
2641     comprehensions.  List comprehensions can be thought of as a nice
2642     syntax for writing maps and filters.  Parallel comprehensions
2643     extend this to include the zipWith family.</para>
2644
2645     <para>A parallel list comprehension has multiple independent
2646     branches of qualifier lists, each separated by a `|' symbol.  For
2647     example, the following zips together two lists:</para>
2648
2649 <programlisting>
2650    [ (x, y) | x <- xs | y <- ys ] 
2651 </programlisting>
2652
2653     <para>The behavior of parallel list comprehensions follows that of
2654     zip, in that the resulting list will have the same length as the
2655     shortest branch.</para>
2656
2657     <para>We can define parallel list comprehensions by translation to
2658     regular comprehensions.  Here's the basic idea:</para>
2659
2660     <para>Given a parallel comprehension of the form: </para>
2661
2662 <programlisting>
2663    [ e | p1 <- e11, p2 <- e12, ... 
2664        | q1 <- e21, q2 <- e22, ... 
2665        ... 
2666    ] 
2667 </programlisting>
2668
2669     <para>This will be translated to: </para>
2670
2671 <programlisting>
2672    [ e | ((p1,p2), (q1,q2), ...) <- zipN [(p1,p2) | p1 <- e11, p2 <- e12, ...] 
2673                                          [(q1,q2) | q1 <- e21, q2 <- e22, ...] 
2674                                          ... 
2675    ] 
2676 </programlisting>
2677
2678     <para>where `zipN' is the appropriate zip for the given number of
2679     branches.</para>
2680
2681   </sect2>
2682
2683 <sect2 id="rebindable-syntax">
2684 <title>Rebindable syntax</title>
2685
2686
2687       <para>GHC allows most kinds of built-in syntax to be rebound by
2688       the user, to facilitate replacing the <literal>Prelude</literal>
2689       with a home-grown version, for example.</para>
2690
2691             <para>You may want to define your own numeric class
2692             hierarchy.  It completely defeats that purpose if the
2693             literal "1" means "<literal>Prelude.fromInteger
2694             1</literal>", which is what the Haskell Report specifies.
2695             So the <option>-fno-implicit-prelude</option> flag causes
2696             the following pieces of built-in syntax to refer to
2697             <emphasis>whatever is in scope</emphasis>, not the Prelude
2698             versions:</para>
2699
2700             <itemizedlist>
2701               <listitem>
2702                 <para>Integer and fractional literals mean
2703                 "<literal>fromInteger 1</literal>" and
2704                 "<literal>fromRational 3.2</literal>", not the
2705                 Prelude-qualified versions; both in expressions and in
2706                 patterns. </para>
2707                 <para>However, the standard Prelude <literal>Eq</literal> class
2708                 is still used for the equality test necessary for literal patterns.</para>
2709               </listitem>
2710
2711               <listitem>
2712                 <para>Negation (e.g. "<literal>- (f x)</literal>")
2713                 means "<literal>negate (f x)</literal>" (not
2714                 <literal>Prelude.negate</literal>).</para>
2715               </listitem>
2716
2717               <listitem>
2718                 <para>In an n+k pattern, the standard Prelude
2719                 <literal>Ord</literal> class is still used for comparison,
2720                 but the necessary subtraction uses whatever
2721                 "<literal>(-)</literal>" is in scope (not
2722                 "<literal>Prelude.(-)</literal>").</para>
2723               </listitem>
2724
2725               <listitem>
2726           <para>"Do" notation is translated using whatever
2727               functions <literal>(>>=)</literal>,
2728               <literal>(>>)</literal>, <literal>fail</literal>, and
2729               <literal>return</literal>, are in scope (not the Prelude
2730               versions).  List comprehensions, and parallel array
2731               comprehensions, are unaffected.  </para></listitem>
2732             </itemizedlist>
2733
2734              <para>Be warned: this is an experimental facility, with fewer checks than
2735              usual.  In particular, it is essential that the functions GHC finds in scope
2736              must have the appropriate types, namely:
2737              <screen>
2738                 fromInteger  :: forall a. (...) => Integer  -> a
2739                 fromRational :: forall a. (...) => Rational -> a
2740                 negate       :: forall a. (...) => a -> a
2741                 (-)          :: forall a. (...) => a -> a -> a
2742                 (>>=)        :: forall m a. (...) => m a -> (a -> m b) -> m b
2743                 (>>)         :: forall m a. (...) => m a -> m b -> m b
2744                 return       :: forall m a. (...) => a      -> m a
2745                 fail         :: forall m a. (...) => String -> m a
2746              </screen>
2747              (The (...) part can be any context including the empty context; that part 
2748              is up to you.)
2749              If the functions don't have the right type, very peculiar things may 
2750              happen.  Use <literal>-dcore-lint</literal> to
2751              typecheck the desugared program.  If Core Lint is happy you should be all right.</para>
2752
2753 </sect2>
2754 </sect1>
2755
2756 <!-- =============================== PRAGMAS ===========================  -->
2757
2758   <sect1 id="pragmas">
2759     <title>Pragmas</title>
2760
2761     <indexterm><primary>pragma</primary></indexterm>
2762
2763     <para>GHC supports several pragmas, or instructions to the
2764     compiler placed in the source code.  Pragmas don't normally affect
2765     the meaning of the program, but they might affect the efficiency
2766     of the generated code.</para>
2767
2768     <para>Pragmas all take the form
2769
2770 <literal>{-# <replaceable>word</replaceable> ... #-}</literal>  
2771
2772     where <replaceable>word</replaceable> indicates the type of
2773     pragma, and is followed optionally by information specific to that
2774     type of pragma.  Case is ignored in
2775     <replaceable>word</replaceable>.  The various values for
2776     <replaceable>word</replaceable> that GHC understands are described
2777     in the following sections; any pragma encountered with an
2778     unrecognised <replaceable>word</replaceable> is (silently)
2779     ignored.</para>
2780
2781 <sect2 id="inline-pragma">
2782 <title>INLINE pragma
2783
2784 <indexterm><primary>INLINE pragma</primary></indexterm>
2785 <indexterm><primary>pragma, INLINE</primary></indexterm></title>
2786
2787 <para>
2788 GHC (with <option>-O</option>, as always) tries to inline (or &ldquo;unfold&rdquo;)
2789 functions/values that are &ldquo;small enough,&rdquo; thus avoiding the call
2790 overhead and possibly exposing other more-wonderful optimisations.
2791 </para>
2792
2793 <para>
2794 You will probably see these unfoldings (in Core syntax) in your
2795 interface files.
2796 </para>
2797
2798 <para>
2799 Normally, if GHC decides a function is &ldquo;too expensive&rdquo; to inline, it
2800 will not do so, nor will it export that unfolding for other modules to
2801 use.
2802 </para>
2803
2804 <para>
2805 The sledgehammer you can bring to bear is the
2806 <literal>INLINE</literal><indexterm><primary>INLINE pragma</primary></indexterm> pragma, used thusly:
2807
2808 <programlisting>
2809 key_function :: Int -> String -> (Bool, Double)
2810
2811 #ifdef __GLASGOW_HASKELL__
2812 {-# INLINE key_function #-}
2813 #endif
2814 </programlisting>
2815
2816 (You don't need to do the C pre-processor carry-on unless you're going
2817 to stick the code through HBC&mdash;it doesn't like <literal>INLINE</literal> pragmas.)
2818 </para>
2819
2820 <para>
2821 The major effect of an <literal>INLINE</literal> pragma is to declare a function's
2822 &ldquo;cost&rdquo; to be very low.  The normal unfolding machinery will then be
2823 very keen to inline it.
2824 </para>
2825
2826 <para>
2827 An <literal>INLINE</literal> pragma for a function can be put anywhere its type
2828 signature could be put.
2829 </para>
2830
2831 <para>
2832 <literal>INLINE</literal> pragmas are a particularly good idea for the
2833 <literal>then</literal>/<literal>return</literal> (or <literal>bind</literal>/<literal>unit</literal>) functions in a monad.
2834 For example, in GHC's own <literal>UniqueSupply</literal> monad code, we have:
2835
2836 <programlisting>
2837 #ifdef __GLASGOW_HASKELL__
2838 {-# INLINE thenUs #-}
2839 {-# INLINE returnUs #-}
2840 #endif
2841 </programlisting>
2842
2843 </para>
2844
2845 </sect2>
2846
2847 <sect2 id="noinline-pragma">
2848 <title>NOINLINE pragma
2849 </title>
2850
2851 <indexterm><primary>NOINLINE pragma</primary></indexterm>
2852 <indexterm><primary>pragma</primary><secondary>NOINLINE</secondary></indexterm>
2853 <indexterm><primary>NOTINLINE pragma</primary></indexterm>
2854 <indexterm><primary>pragma</primary><secondary>NOTINLINE</secondary></indexterm>
2855
2856 <para>
2857 The <literal>NOINLINE</literal> pragma does exactly what you'd expect:
2858 it stops the named function from being inlined by the compiler.  You
2859 shouldn't ever need to do this, unless you're very cautious about code
2860 size.
2861 </para>
2862
2863 <para><literal>NOTINLINE</literal> is a synonym for
2864 <literal>NOINLINE</literal> (<literal>NOTINLINE</literal> is specified
2865 by Haskell 98 as the standard way to disable inlining, so it should be
2866 used if you want your code to be portable).</para>
2867
2868 </sect2>
2869
2870     <sect2 id="specialize-pragma">
2871       <title>SPECIALIZE pragma</title>
2872
2873       <indexterm><primary>SPECIALIZE pragma</primary></indexterm>
2874       <indexterm><primary>pragma, SPECIALIZE</primary></indexterm>
2875       <indexterm><primary>overloading, death to</primary></indexterm>
2876
2877       <para>(UK spelling also accepted.)  For key overloaded
2878       functions, you can create extra versions (NB: more code space)
2879       specialised to particular types.  Thus, if you have an
2880       overloaded function:</para>
2881
2882 <programlisting>
2883 hammeredLookup :: Ord key => [(key, value)] -> key -> value
2884 </programlisting>
2885
2886       <para>If it is heavily used on lists with
2887       <literal>Widget</literal> keys, you could specialise it as
2888       follows:</para>
2889
2890 <programlisting>
2891 {-# SPECIALIZE hammeredLookup :: [(Widget, value)] -> Widget -> value #-}
2892 </programlisting>
2893
2894       <para>To get very fancy, you can also specify a named function
2895       to use for the specialised value, as in:</para>
2896
2897 <programlisting>
2898 {-# RULES hammeredLookup = blah #-}
2899 </programlisting>
2900
2901       <para>where <literal>blah</literal> is an implementation of
2902       <literal>hammerdLookup</literal> written specialy for
2903       <literal>Widget</literal> lookups.  It's <emphasis>Your
2904       Responsibility</emphasis> to make sure that
2905       <function>blah</function> really behaves as a specialised
2906       version of <function>hammeredLookup</function>!!!</para>
2907
2908       <para>Note we use the <literal>RULE</literal> pragma here to
2909       indicate that <literal>hammeredLookup</literal> applied at a
2910       certain type should be replaced by <literal>blah</literal>.  See
2911       <xref linkend="rules"> for more information on
2912       <literal>RULES</literal>.</para>
2913
2914       <para>An example in which using <literal>RULES</literal> for
2915       specialisation will Win Big:
2916
2917 <programlisting>
2918 toDouble :: Real a => a -> Double
2919 toDouble = fromRational . toRational
2920
2921 {-# SPECIALIZE toDouble :: Int -> Double = i2d #-}
2922 i2d (I# i) = D# (int2Double# i) -- uses Glasgow prim-op directly
2923 </programlisting>
2924
2925       The <function>i2d</function> function is virtually one machine
2926       instruction; the default conversion&mdash;via an intermediate
2927       <literal>Rational</literal>&mdash;is obscenely expensive by
2928       comparison.</para>
2929
2930       <para>A <literal>SPECIALIZE</literal> pragma for a function can
2931       be put anywhere its type signature could be put.</para>
2932
2933     </sect2>
2934
2935 <sect2 id="specialize-instance-pragma">
2936 <title>SPECIALIZE instance pragma
2937 </title>
2938
2939 <para>
2940 <indexterm><primary>SPECIALIZE pragma</primary></indexterm>
2941 <indexterm><primary>overloading, death to</primary></indexterm>
2942 Same idea, except for instance declarations.  For example:
2943
2944 <programlisting>
2945 instance (Eq a) => Eq (Foo a) where { 
2946    {-# SPECIALIZE instance Eq (Foo [(Int, Bar)]) #-}
2947    ... usual stuff ...
2948  }
2949 </programlisting>
2950 The pragma must occur inside the <literal>where</literal> part
2951 of the instance declaration.
2952 </para>
2953 <para>
2954 Compatible with HBC, by the way, except perhaps in the placement
2955 of the pragma.
2956 </para>
2957
2958 </sect2>
2959
2960 <sect2 id="line-pragma">
2961 <title>LINE pragma
2962 </title>
2963
2964 <para>
2965 <indexterm><primary>LINE pragma</primary></indexterm>
2966 <indexterm><primary>pragma, LINE</primary></indexterm>
2967 </para>
2968
2969 <para>
2970 This pragma is similar to C's <literal>&num;line</literal> pragma, and is mainly for use in
2971 automatically generated Haskell code.  It lets you specify the line
2972 number and filename of the original code; for example
2973 </para>
2974
2975 <para>
2976
2977 <programlisting>
2978 {-# LINE 42 "Foo.vhs" #-}
2979 </programlisting>
2980
2981 </para>
2982
2983 <para>
2984 if you'd generated the current file from something called <filename>Foo.vhs</filename>
2985 and this line corresponds to line 42 in the original.  GHC will adjust
2986 its error messages to refer to the line/file named in the <literal>LINE</literal>
2987 pragma.
2988 </para>
2989
2990 </sect2>
2991
2992 <sect2 id="rules">
2993 <title>RULES pragma</title>
2994
2995 <para>
2996 The RULES pragma lets you specify rewrite rules.  It is described in
2997 <xref LinkEnd="rewrite-rules">.
2998 </para>
2999
3000 </sect2>
3001
3002 <sect2 id="deprecated-pragma">
3003 <title>DEPRECATED pragma</title>
3004
3005 <para>
3006 The DEPRECATED pragma lets you specify that a particular function, class, or type, is deprecated.  
3007 There are two forms.  
3008 </para>
3009 <itemizedlist>
3010 <listitem><para>
3011 You can deprecate an entire module thus:</para>
3012 <programlisting>
3013    module Wibble {-# DEPRECATED "Use Wobble instead" #-} where
3014      ...
3015 </programlisting>
3016 <para>
3017 When you compile any module that import <literal>Wibble</literal>, GHC will print
3018 the specified message.</para>
3019 </listitem>
3020
3021 <listitem>
3022 <para>
3023 You can deprecate a function, class, or type, with the following top-level declaration:
3024 </para>
3025 <programlisting>
3026    {-# DEPRECATED f, C, T "Don't use these" #-}
3027 </programlisting>
3028 <para>
3029 When you compile any module that imports and uses any of the specifed entities, 
3030 GHC will print the specified message.
3031 </para>
3032 </listitem>
3033 </itemizedlist>
3034 <para>You can suppress the warnings with the flag <option>-fno-warn-deprecations</option>.</para>
3035
3036 </sect2>
3037
3038 </sect1>
3039
3040 <!--  ======================= REWRITE RULES ======================== -->
3041
3042 <sect1 id="rewrite-rules">
3043 <title>Rewrite rules
3044
3045 <indexterm><primary>RULES pagma</primary></indexterm>
3046 <indexterm><primary>pragma, RULES</primary></indexterm>
3047 <indexterm><primary>rewrite rules</primary></indexterm></title>
3048
3049 <para>
3050 The programmer can specify rewrite rules as part of the source program
3051 (in a pragma).  GHC applies these rewrite rules wherever it can.
3052 </para>
3053
3054 <para>
3055 Here is an example:
3056
3057 <programlisting>
3058   {-# RULES
3059         "map/map"       forall f g xs. map f (map g xs) = map (f.g) xs
3060   #-}
3061 </programlisting>
3062
3063 </para>
3064
3065 <sect2>
3066 <title>Syntax</title>
3067
3068 <para>
3069 From a syntactic point of view:
3070
3071 <itemizedlist>
3072 <listitem>
3073
3074 <para>
3075  Each rule has a name, enclosed in double quotes.  The name itself has
3076 no significance at all.  It is only used when reporting how many times the rule fired.
3077 </para>
3078 </listitem>
3079 <listitem>
3080
3081 <para>
3082  There may be zero or more rules in a <literal>RULES</literal> pragma.
3083 </para>
3084 </listitem>
3085 <listitem>
3086
3087 <para>
3088  Layout applies in a <literal>RULES</literal> pragma.  Currently no new indentation level
3089 is set, so you must lay out your rules starting in the same column as the
3090 enclosing definitions.
3091 </para>
3092 </listitem>
3093 <listitem>
3094
3095 <para>
3096  Each variable mentioned in a rule must either be in scope (e.g. <function>map</function>),
3097 or bound by the <literal>forall</literal> (e.g. <function>f</function>, <function>g</function>, <function>xs</function>).  The variables bound by
3098 the <literal>forall</literal> are called the <emphasis>pattern</emphasis> variables.  They are separated
3099 by spaces, just like in a type <literal>forall</literal>.
3100 </para>
3101 </listitem>
3102 <listitem>
3103
3104 <para>
3105  A pattern variable may optionally have a type signature.
3106 If the type of the pattern variable is polymorphic, it <emphasis>must</emphasis> have a type signature.
3107 For example, here is the <literal>foldr/build</literal> rule:
3108
3109 <programlisting>
3110 "fold/build"  forall k z (g::forall b. (a->b->b) -> b -> b) .
3111               foldr k z (build g) = g k z
3112 </programlisting>
3113
3114 Since <function>g</function> has a polymorphic type, it must have a type signature.
3115
3116 </para>
3117 </listitem>
3118 <listitem>
3119
3120 <para>
3121 The left hand side of a rule must consist of a top-level variable applied
3122 to arbitrary expressions.  For example, this is <emphasis>not</emphasis> OK:
3123
3124 <programlisting>
3125 "wrong1"   forall e1 e2.  case True of { True -> e1; False -> e2 } = e1
3126 "wrong2"   forall f.      f True = True
3127 </programlisting>
3128
3129 In <literal>"wrong1"</literal>, the LHS is not an application; in <literal>"wrong2"</literal>, the LHS has a pattern variable
3130 in the head.
3131 </para>
3132 </listitem>
3133 <listitem>
3134
3135 <para>
3136  A rule does not need to be in the same module as (any of) the
3137 variables it mentions, though of course they need to be in scope.
3138 </para>
3139 </listitem>
3140 <listitem>
3141
3142 <para>
3143  Rules are automatically exported from a module, just as instance declarations are.
3144 </para>
3145 </listitem>
3146
3147 </itemizedlist>
3148
3149 </para>
3150
3151 </sect2>
3152
3153 <sect2>
3154 <title>Semantics</title>
3155
3156 <para>
3157 From a semantic point of view:
3158
3159 <itemizedlist>
3160 <listitem>
3161
3162 <para>
3163 Rules are only applied if you use the <option>-O</option> flag.
3164 </para>
3165 </listitem>
3166
3167 <listitem>
3168 <para>
3169  Rules are regarded as left-to-right rewrite rules.
3170 When GHC finds an expression that is a substitution instance of the LHS
3171 of a rule, it replaces the expression by the (appropriately-substituted) RHS.
3172 By "a substitution instance" we mean that the LHS can be made equal to the
3173 expression by substituting for the pattern variables.
3174
3175 </para>
3176 </listitem>
3177 <listitem>
3178
3179 <para>
3180  The LHS and RHS of a rule are typechecked, and must have the
3181 same type.
3182
3183 </para>
3184 </listitem>
3185 <listitem>
3186
3187 <para>
3188  GHC makes absolutely no attempt to verify that the LHS and RHS
3189 of a rule have the same meaning.  That is undecideable in general, and
3190 infeasible in most interesting cases.  The responsibility is entirely the programmer's!
3191
3192 </para>
3193 </listitem>
3194 <listitem>
3195
3196 <para>
3197  GHC makes no attempt to make sure that the rules are confluent or
3198 terminating.  For example:
3199
3200 <programlisting>
3201   "loop"        forall x,y.  f x y = f y x
3202 </programlisting>
3203
3204 This rule will cause the compiler to go into an infinite loop.
3205
3206 </para>
3207 </listitem>
3208 <listitem>
3209
3210 <para>
3211  If more than one rule matches a call, GHC will choose one arbitrarily to apply.
3212
3213 </para>
3214 </listitem>
3215 <listitem>
3216 <para>
3217  GHC currently uses a very simple, syntactic, matching algorithm
3218 for matching a rule LHS with an expression.  It seeks a substitution
3219 which makes the LHS and expression syntactically equal modulo alpha
3220 conversion.  The pattern (rule), but not the expression, is eta-expanded if
3221 necessary.  (Eta-expanding the epression can lead to laziness bugs.)
3222 But not beta conversion (that's called higher-order matching).
3223 </para>
3224
3225 <para>
3226 Matching is carried out on GHC's intermediate language, which includes
3227 type abstractions and applications.  So a rule only matches if the
3228 types match too.  See <xref LinkEnd="rule-spec"> below.
3229 </para>
3230 </listitem>
3231 <listitem>
3232
3233 <para>
3234  GHC keeps trying to apply the rules as it optimises the program.
3235 For example, consider:
3236
3237 <programlisting>
3238   let s = map f
3239       t = map g
3240   in
3241   s (t xs)
3242 </programlisting>
3243
3244 The expression <literal>s (t xs)</literal> does not match the rule <literal>"map/map"</literal>, but GHC
3245 will substitute for <VarName>s</VarName> and <VarName>t</VarName>, giving an expression which does match.
3246 If <VarName>s</VarName> or <VarName>t</VarName> was (a) used more than once, and (b) large or a redex, then it would
3247 not be substituted, and the rule would not fire.
3248
3249 </para>
3250 </listitem>
3251 <listitem>
3252
3253 <para>
3254  In the earlier phases of compilation, GHC inlines <emphasis>nothing
3255 that appears on the LHS of a rule</emphasis>, because once you have substituted
3256 for something you can't match against it (given the simple minded
3257 matching).  So if you write the rule
3258
3259 <programlisting>
3260         "map/map"       forall f,g.  map f . map g = map (f.g)
3261 </programlisting>
3262
3263 this <emphasis>won't</emphasis> match the expression <literal>map f (map g xs)</literal>.
3264 It will only match something written with explicit use of ".".
3265 Well, not quite.  It <emphasis>will</emphasis> match the expression
3266
3267 <programlisting>
3268 wibble f g xs
3269 </programlisting>
3270
3271 where <function>wibble</function> is defined:
3272
3273 <programlisting>
3274 wibble f g = map f . map g
3275 </programlisting>
3276
3277 because <function>wibble</function> will be inlined (it's small).
3278
3279 Later on in compilation, GHC starts inlining even things on the
3280 LHS of rules, but still leaves the rules enabled.  This inlining
3281 policy is controlled by the per-simplification-pass flag <option>-finline-phase</option><emphasis>n</emphasis>.
3282
3283 </para>
3284 </listitem>
3285 <listitem>
3286
3287 <para>
3288  All rules are implicitly exported from the module, and are therefore
3289 in force in any module that imports the module that defined the rule, directly
3290 or indirectly.  (That is, if A imports B, which imports C, then C's rules are
3291 in force when compiling A.)  The situation is very similar to that for instance
3292 declarations.
3293 </para>
3294 </listitem>
3295
3296 </itemizedlist>
3297
3298 </para>
3299
3300 </sect2>
3301
3302 <sect2>
3303 <title>List fusion</title>
3304
3305 <para>
3306 The RULES mechanism is used to implement fusion (deforestation) of common list functions.
3307 If a "good consumer" consumes an intermediate list constructed by a "good producer", the
3308 intermediate list should be eliminated entirely.
3309 </para>
3310
3311 <para>
3312 The following are good producers:
3313
3314 <itemizedlist>
3315 <listitem>
3316
3317 <para>
3318  List comprehensions
3319 </para>
3320 </listitem>
3321 <listitem>
3322
3323 <para>
3324  Enumerations of <literal>Int</literal> and <literal>Char</literal> (e.g. <literal>['a'..'z']</literal>).
3325 </para>
3326 </listitem>
3327 <listitem>
3328
3329 <para>
3330  Explicit lists (e.g. <literal>[True, False]</literal>)
3331 </para>
3332 </listitem>
3333 <listitem>
3334
3335 <para>
3336  The cons constructor (e.g <literal>3:4:[]</literal>)
3337 </para>
3338 </listitem>
3339 <listitem>
3340
3341 <para>
3342  <function>++</function>
3343 </para>
3344 </listitem>
3345
3346 <listitem>
3347 <para>
3348  <function>map</function>
3349 </para>
3350 </listitem>
3351
3352 <listitem>
3353 <para>
3354  <function>filter</function>
3355 </para>
3356 </listitem>
3357 <listitem>
3358
3359 <para>
3360  <function>iterate</function>, <function>repeat</function>
3361 </para>
3362 </listitem>
3363 <listitem>
3364
3365 <para>
3366  <function>zip</function>, <function>zipWith</function>
3367 </para>
3368 </listitem>
3369
3370 </itemizedlist>
3371
3372 </para>
3373
3374 <para>
3375 The following are good consumers:
3376
3377 <itemizedlist>
3378 <listitem>
3379
3380 <para>
3381  List comprehensions
3382 </para>
3383 </listitem>
3384 <listitem>
3385
3386 <para>
3387  <function>array</function> (on its second argument)
3388 </para>
3389 </listitem>
3390 <listitem>
3391
3392 <para>
3393  <function>length</function>
3394 </para>
3395 </listitem>
3396 <listitem>
3397
3398 <para>
3399  <function>++</function> (on its first argument)
3400 </para>
3401 </listitem>
3402
3403 <listitem>
3404 <para>
3405  <function>foldr</function>
3406 </para>
3407 </listitem>
3408
3409 <listitem>
3410 <para>
3411  <function>map</function>
3412 </para>
3413 </listitem>
3414 <listitem>
3415
3416 <para>
3417  <function>filter</function>
3418 </para>
3419 </listitem>
3420 <listitem>
3421
3422 <para>
3423  <function>concat</function>
3424 </para>
3425 </listitem>
3426 <listitem>
3427
3428 <para>
3429  <function>unzip</function>, <function>unzip2</function>, <function>unzip3</function>, <function>unzip4</function>
3430 </para>
3431 </listitem>
3432 <listitem>
3433
3434 <para>
3435  <function>zip</function>, <function>zipWith</function> (but on one argument only; if both are good producers, <function>zip</function>
3436 will fuse with one but not the other)
3437 </para>
3438 </listitem>
3439 <listitem>
3440
3441 <para>
3442  <function>partition</function>
3443 </para>
3444 </listitem>
3445 <listitem>
3446
3447 <para>
3448  <function>head</function>
3449 </para>
3450 </listitem>
3451 <listitem>
3452
3453 <para>
3454  <function>and</function>, <function>or</function>, <function>any</function>, <function>all</function>
3455 </para>
3456 </listitem>
3457 <listitem>
3458
3459 <para>
3460  <function>sequence&lowbar;</function>
3461 </para>
3462 </listitem>
3463 <listitem>
3464
3465 <para>
3466  <function>msum</function>
3467 </para>
3468 </listitem>
3469 <listitem>
3470
3471 <para>
3472  <function>sortBy</function>
3473 </para>
3474 </listitem>
3475
3476 </itemizedlist>
3477
3478 </para>
3479
3480 <para>
3481 So, for example, the following should generate no intermediate lists:
3482
3483 <programlisting>
3484 array (1,10) [(i,i*i) | i &#60;- map (+ 1) [0..9]]
3485 </programlisting>
3486
3487 </para>
3488
3489 <para>
3490 This list could readily be extended; if there are Prelude functions that you use
3491 a lot which are not included, please tell us.
3492 </para>
3493
3494 <para>
3495 If you want to write your own good consumers or producers, look at the
3496 Prelude definitions of the above functions to see how to do so.
3497 </para>
3498
3499 </sect2>
3500
3501 <sect2 id="rule-spec">
3502 <title>Specialisation
3503 </title>
3504
3505 <para>
3506 Rewrite rules can be used to get the same effect as a feature
3507 present in earlier version of GHC:
3508
3509 <programlisting>
3510   {-# SPECIALIZE fromIntegral :: Int8 -> Int16 = int8ToInt16 #-}
3511 </programlisting>
3512
3513 This told GHC to use <function>int8ToInt16</function> instead of <function>fromIntegral</function> whenever
3514 the latter was called with type <literal>Int8 -&gt; Int16</literal>.  That is, rather than
3515 specialising the original definition of <function>fromIntegral</function> the programmer is
3516 promising that it is safe to use <function>int8ToInt16</function> instead.
3517 </para>
3518
3519 <para>
3520 This feature is no longer in GHC.  But rewrite rules let you do the
3521 same thing:
3522
3523 <programlisting>
3524 {-# RULES
3525   "fromIntegral/Int8/Int16" fromIntegral = int8ToInt16
3526 #-}
3527 </programlisting>
3528
3529 This slightly odd-looking rule instructs GHC to replace <function>fromIntegral</function>
3530 by <function>int8ToInt16</function> <emphasis>whenever the types match</emphasis>.  Speaking more operationally,
3531 GHC adds the type and dictionary applications to get the typed rule
3532
3533 <programlisting>
3534 forall (d1::Integral Int8) (d2::Num Int16) .
3535         fromIntegral Int8 Int16 d1 d2 = int8ToInt16
3536 </programlisting>
3537
3538 What is more,
3539 this rule does not need to be in the same file as fromIntegral,
3540 unlike the <literal>SPECIALISE</literal> pragmas which currently do (so that they
3541 have an original definition available to specialise).
3542 </para>
3543
3544 </sect2>
3545
3546 <sect2>
3547 <title>Controlling what's going on</title>
3548
3549 <para>
3550
3551 <itemizedlist>
3552 <listitem>
3553
3554 <para>
3555  Use <option>-ddump-rules</option> to see what transformation rules GHC is using.
3556 </para>
3557 </listitem>
3558 <listitem>
3559
3560 <para>
3561  Use <option>-ddump-simpl-stats</option> to see what rules are being fired.
3562 If you add <option>-dppr-debug</option> you get a more detailed listing.
3563 </para>
3564 </listitem>
3565 <listitem>
3566
3567 <para>
3568  The defintion of (say) <function>build</function> in <FileName>PrelBase.lhs</FileName> looks llike this:
3569
3570 <programlisting>
3571         build   :: forall a. (forall b. (a -> b -> b) -> b -> b) -> [a]
3572         {-# INLINE build #-}
3573         build g = g (:) []
3574 </programlisting>
3575
3576 Notice the <literal>INLINE</literal>!  That prevents <literal>(:)</literal> from being inlined when compiling
3577 <literal>PrelBase</literal>, so that an importing module will &ldquo;see&rdquo; the <literal>(:)</literal>, and can
3578 match it on the LHS of a rule.  <literal>INLINE</literal> prevents any inlining happening
3579 in the RHS of the <literal>INLINE</literal> thing.  I regret the delicacy of this.
3580
3581 </para>
3582 </listitem>
3583 <listitem>
3584
3585 <para>
3586  In <filename>ghc/lib/std/PrelBase.lhs</filename> look at the rules for <function>map</function> to
3587 see how to write rules that will do fusion and yet give an efficient
3588 program even if fusion doesn't happen.  More rules in <filename>PrelList.lhs</filename>.
3589 </para>
3590 </listitem>
3591
3592 </itemizedlist>
3593
3594 </para>
3595
3596 </sect2>
3597
3598 </sect1>
3599
3600 <sect1 id="generic-classes">
3601 <title>Generic classes</title>
3602
3603     <para>(Note: support for generic classes is currently broken in
3604     GHC 5.02).</para>
3605
3606 <para>
3607 The ideas behind this extension are described in detail in "Derivable type classes",
3608 Ralf Hinze and Simon Peyton Jones, Haskell Workshop, Montreal Sept 2000, pp94-105.
3609 An example will give the idea:
3610 </para>
3611
3612 <programlisting>
3613   import Generics
3614
3615   class Bin a where
3616     toBin   :: a -> [Int]
3617     fromBin :: [Int] -> (a, [Int])
3618   
3619     toBin {| Unit |}    Unit      = []
3620     toBin {| a :+: b |} (Inl x)   = 0 : toBin x
3621     toBin {| a :+: b |} (Inr y)   = 1 : toBin y
3622     toBin {| a :*: b |} (x :*: y) = toBin x ++ toBin y
3623   
3624     fromBin {| Unit |}    bs      = (Unit, bs)
3625     fromBin {| a :+: b |} (0:bs)  = (Inl x, bs')    where (x,bs') = fromBin bs
3626     fromBin {| a :+: b |} (1:bs)  = (Inr y, bs')    where (y,bs') = fromBin bs
3627     fromBin {| a :*: b |} bs      = (x :*: y, bs'') where (x,bs' ) = fromBin bs
3628                                                           (y,bs'') = fromBin bs'
3629 </programlisting>
3630 <para>
3631 This class declaration explains how <literal>toBin</literal> and <literal>fromBin</literal>
3632 work for arbitrary data types.  They do so by giving cases for unit, product, and sum,
3633 which are defined thus in the library module <literal>Generics</literal>:
3634 </para>
3635 <programlisting>
3636   data Unit    = Unit
3637   data a :+: b = Inl a | Inr b
3638   data a :*: b = a :*: b
3639 </programlisting>
3640 <para>
3641 Now you can make a data type into an instance of Bin like this:
3642 <programlisting>
3643   instance (Bin a, Bin b) => Bin (a,b)
3644   instance Bin a => Bin [a]
3645 </programlisting>
3646 That is, just leave off the "where" clasuse.  Of course, you can put in the
3647 where clause and over-ride whichever methods you please.
3648 </para>
3649
3650     <sect2>
3651       <title> Using generics </title>
3652       <para>To use generics you need to</para>
3653       <itemizedlist>
3654         <listitem>
3655           <para>Use the flags <option>-fglasgow-exts</option> (to enable the extra syntax), 
3656                 <option>-fgenerics</option> (to generate extra per-data-type code),
3657                 and <option>-package lang</option> (to make the <literal>Generics</literal> library
3658                 available.  </para>
3659         </listitem>
3660         <listitem>
3661           <para>Import the module <literal>Generics</literal> from the
3662           <literal>lang</literal> package.  This import brings into
3663           scope the data types <literal>Unit</literal>,
3664           <literal>:*:</literal>, and <literal>:+:</literal>.  (You
3665           don't need this import if you don't mention these types
3666           explicitly; for example, if you are simply giving instance
3667           declarations.)</para>
3668         </listitem>
3669       </itemizedlist>
3670     </sect2>
3671
3672 <sect2> <title> Changes wrt the paper </title>
3673 <para>
3674 Note that the type constructors <literal>:+:</literal> and <literal>:*:</literal> 
3675 can be written infix (indeed, you can now use
3676 any operator starting in a colon as an infix type constructor).  Also note that
3677 the type constructors are not exactly as in the paper (Unit instead of 1, etc).
3678 Finally, note that the syntax of the type patterns in the class declaration
3679 uses "<literal>{|</literal>" and "<literal>|}</literal>" brackets; curly braces
3680 alone would ambiguous when they appear on right hand sides (an extension we 
3681 anticipate wanting).
3682 </para>
3683 </sect2>
3684
3685 <sect2> <title>Terminology and restrictions</title>
3686 <para>
3687 Terminology.  A "generic default method" in a class declaration
3688 is one that is defined using type patterns as above.
3689 A "polymorphic default method" is a default method defined as in Haskell 98.
3690 A "generic class declaration" is a class declaration with at least one
3691 generic default method.
3692 </para>
3693
3694 <para>
3695 Restrictions:
3696 <itemizedlist>
3697 <listitem>
3698 <para>
3699 Alas, we do not yet implement the stuff about constructor names and 
3700 field labels.
3701 </para>
3702 </listitem>
3703
3704 <listitem>
3705 <para>
3706 A generic class can have only one parameter; you can't have a generic
3707 multi-parameter class.
3708 </para>
3709 </listitem>
3710
3711 <listitem>
3712 <para>
3713 A default method must be defined entirely using type patterns, or entirely
3714 without.  So this is illegal:
3715 <programlisting>
3716   class Foo a where
3717     op :: a -> (a, Bool)
3718     op {| Unit |} Unit = (Unit, True)
3719     op x               = (x,    False)
3720 </programlisting>
3721 However it is perfectly OK for some methods of a generic class to have 
3722 generic default methods and others to have polymorphic default methods.
3723 </para>
3724 </listitem>
3725
3726 <listitem>
3727 <para>
3728 The type variable(s) in the type pattern for a generic method declaration
3729 scope over the right hand side.  So this is legal (note the use of the type variable ``p'' in a type signature on the right hand side:
3730 <programlisting>
3731   class Foo a where
3732     op :: a -> Bool
3733     op {| p :*: q |} (x :*: y) = op (x :: p)
3734     ...
3735 </programlisting>
3736 </para>
3737 </listitem>
3738
3739 <listitem>
3740 <para>
3741 The type patterns in a generic default method must take one of the forms:
3742 <programlisting>
3743        a :+: b
3744        a :*: b
3745        Unit
3746 </programlisting>
3747 where "a" and "b" are type variables.  Furthermore, all the type patterns for
3748 a single type constructor (<literal>:*:</literal>, say) must be identical; they
3749 must use the same type variables.  So this is illegal:
3750 <programlisting>
3751   class Foo a where
3752     op :: a -> Bool
3753     op {| a :+: b |} (Inl x) = True
3754     op {| p :+: q |} (Inr y) = False
3755 </programlisting>
3756 The type patterns must be identical, even in equations for different methods of the class.
3757 So this too is illegal:
3758 <programlisting>
3759   class Foo a where
3760     op1 :: a -> Bool
3761     op1 {| a :*: b |} (x :*: y) = True
3762
3763     op2 :: a -> Bool
3764     op2 {| p :*: q |} (x :*: y) = False
3765 </programlisting>
3766 (The reason for this restriction is that we gather all the equations for a particular type consructor
3767 into a single generic instance declaration.)
3768 </para>
3769 </listitem>
3770
3771 <listitem>
3772 <para>
3773 A generic method declaration must give a case for each of the three type constructors.
3774 </para>
3775 </listitem>
3776
3777 <listitem>
3778 <para>
3779 The type for a generic method can be built only from:
3780   <itemizedlist>
3781   <listitem> <para> Function arrows </para> </listitem>
3782   <listitem> <para> Type variables </para> </listitem>
3783   <listitem> <para> Tuples </para> </listitem>
3784   <listitem> <para> Arbitrary types not involving type variables </para> </listitem>
3785   </itemizedlist>
3786 Here are some example type signatures for generic methods:
3787 <programlisting>
3788     op1 :: a -> Bool
3789     op2 :: Bool -> (a,Bool)
3790     op3 :: [Int] -> a -> a
3791     op4 :: [a] -> Bool
3792 </programlisting>
3793 Here, op1, op2, op3 are OK, but op4 is rejected, because it has a type variable
3794 inside a list.  
3795 </para>
3796 <para>
3797 This restriction is an implementation restriction: we just havn't got around to
3798 implementing the necessary bidirectional maps over arbitrary type constructors.
3799 It would be relatively easy to add specific type constructors, such as Maybe and list,
3800 to the ones that are allowed.</para>
3801 </listitem>
3802
3803 <listitem>
3804 <para>
3805 In an instance declaration for a generic class, the idea is that the compiler
3806 will fill in the methods for you, based on the generic templates.  However it can only
3807 do so if
3808   <itemizedlist>
3809   <listitem>
3810   <para>
3811   The instance type is simple (a type constructor applied to type variables, as in Haskell 98).
3812   </para>
3813   </listitem>
3814   <listitem>
3815   <para>
3816   No constructor of the instance type has unboxed fields.
3817   </para>
3818   </listitem>
3819   </itemizedlist>
3820 (Of course, these things can only arise if you are already using GHC extensions.)
3821 However, you can still give an instance declarations for types which break these rules,
3822 provided you give explicit code to override any generic default methods.
3823 </para>
3824 </listitem>
3825
3826 </itemizedlist>
3827 </para>
3828
3829 <para>
3830 The option <option>-ddump-deriv</option> dumps incomprehensible stuff giving details of 
3831 what the compiler does with generic declarations.
3832 </para>
3833
3834 </sect2>
3835
3836 <sect2> <title> Another example </title>
3837 <para>
3838 Just to finish with, here's another example I rather like:
3839 <programlisting>
3840   class Tag a where
3841     nCons :: a -> Int
3842     nCons {| Unit |}    _ = 1
3843     nCons {| a :*: b |} _ = 1
3844     nCons {| a :+: b |} _ = nCons (bot::a) + nCons (bot::b)
3845   
3846     tag :: a -> Int
3847     tag {| Unit |}    _       = 1
3848     tag {| a :*: b |} _       = 1   
3849     tag {| a :+: b |} (Inl x) = tag x
3850     tag {| a :+: b |} (Inr y) = nCons (bot::a) + tag y
3851 </programlisting>
3852 </para>
3853 </sect2>
3854 </sect1>
3855
3856 <sect1 id="newtype-deriving">
3857 <title>Generalised derived instances for newtypes</title>
3858
3859 <para>
3860 When you define an abstract type using <literal>newtype</literal>, you may want
3861 the new type to inherit some instances from its representation. In
3862 Haskell 98, you can inherit instances of <literal>Eq</literal>, <literal>Ord</literal>,
3863 <literal>Enum</literal> and <literal>Bounded</literal> by deriving them, but for any
3864 other classes you have to write an explicit instance declaration. For
3865 example, if you define
3866
3867 <programlisting> 
3868   newtype Dollars = Dollars Int 
3869 </programlisting> 
3870
3871 and you want to use arithmetic on <literal>Dollars</literal>, you have to
3872 explicitly define an instance of <literal>Num</literal>:
3873
3874 <programlisting> 
3875   instance Num Dollars where
3876     Dollars a + Dollars b = Dollars (a+b)
3877     ...
3878 </programlisting>
3879 All the instance does is apply and remove the <literal>newtype</literal>
3880 constructor. It is particularly galling that, since the constructor
3881 doesn't appear at run-time, this instance declaration defines a
3882 dictionary which is <emphasis>wholly equivalent</emphasis> to the <literal>Int</literal>
3883 dictionary, only slower!
3884 </para>
3885
3886 <sect2> <title> Generalising the deriving clause </title>
3887 <para>
3888 GHC now permits such instances to be derived instead, so one can write 
3889 <programlisting> 
3890   newtype Dollars = Dollars Int deriving (Eq,Show,Num)
3891 </programlisting> 
3892
3893 and the implementation uses the <emphasis>same</emphasis> <literal>Num</literal> dictionary
3894 for <literal>Dollars</literal> as for <literal>Int</literal>. Notionally, the compiler
3895 derives an instance declaration of the form
3896
3897 <programlisting> 
3898   instance Num Int => Num Dollars
3899 </programlisting> 
3900
3901 which just adds or removes the <literal>newtype</literal> constructor according to the type.
3902 </para>
3903 <para>
3904
3905 We can also derive instances of constructor classes in a similar
3906 way. For example, suppose we have implemented state and failure monad
3907 transformers, such that
3908
3909 <programlisting> 
3910   instance Monad m => Monad (State s m) 
3911   instance Monad m => Monad (Failure m)
3912 </programlisting> 
3913 In Haskell 98, we can define a parsing monad by 
3914 <programlisting> 
3915   type Parser tok m a = State [tok] (Failure m) a
3916 </programlisting> 
3917
3918 which is automatically a monad thanks to the instance declarations
3919 above. With the extension, we can make the parser type abstract,
3920 without needing to write an instance of class <literal>Monad</literal>, via
3921
3922 <programlisting> 
3923   newtype Parser tok m a = Parser (State [tok] (Failure m) a)
3924                          deriving Monad
3925 </programlisting>
3926 In this case the derived instance declaration is of the form 
3927 <programlisting> 
3928   instance Monad (State [tok] (Failure m)) => Monad (Parser tok m) 
3929 </programlisting> 
3930
3931 Notice that, since <literal>Monad</literal> is a constructor class, the
3932 instance is a <emphasis>partial application</emphasis> of the new type, not the
3933 entire left hand side. We can imagine that the type declaration is
3934 ``eta-converted'' to generate the context of the instance
3935 declaration.
3936 </para>
3937 <para>
3938
3939 We can even derive instances of multi-parameter classes, provided the
3940 newtype is the last class parameter. In this case, a ``partial
3941 application'' of the class appears in the <literal>deriving</literal>
3942 clause. For example, given the class
3943
3944 <programlisting> 
3945   class StateMonad s m | m -> s where ... 
3946   instance Monad m => StateMonad s (State s m) where ... 
3947 </programlisting> 
3948 then we can derive an instance of <literal>StateMonad</literal> for <literal>Parser</literal>s by 
3949 <programlisting> 
3950   newtype Parser tok m a = Parser (State [tok] (Failure m) a)
3951                          deriving (Monad, StateMonad [tok])
3952 </programlisting>
3953
3954 The derived instance is obtained by completing the application of the
3955 class to the new type:
3956
3957 <programlisting> 
3958   instance StateMonad [tok] (State [tok] (Failure m)) =>
3959            StateMonad [tok] (Parser tok m)
3960 </programlisting>
3961 </para>
3962 <para>
3963
3964 As a result of this extension, all derived instances in newtype
3965 declarations are treated uniformly (and implemented just by reusing
3966 the dictionary for the representation type), <emphasis>except</emphasis>
3967 <literal>Show</literal> and <literal>Read</literal>, which really behave differently for
3968 the newtype and its representation.
3969 </para>
3970 </sect2>
3971
3972 <sect2> <title> A more precise specification </title>
3973 <para>
3974 Derived instance declarations are constructed as follows. Consider the
3975 declaration (after expansion of any type synonyms)
3976
3977 <programlisting> 
3978   newtype T v1...vn = T' (S t1...tk vk+1...vn) deriving (c1...cm) 
3979 </programlisting> 
3980
3981 where <literal>S</literal> is a type constructor, <literal>t1...tk</literal> are 
3982 types,
3983 <literal>vk+1...vn</literal> are type variables which do not occur in any of
3984 the <literal>ti</literal>, and the <literal>ci</literal> are partial applications of
3985 classes of the form <literal>C t1'...tj'</literal>.  The derived instance
3986 declarations are, for each <literal>ci</literal>,
3987
3988 <programlisting> 
3989   instance ci (S t1...tk vk+1...v) => ci (T v1...vp)
3990 </programlisting>
3991 where <literal>p</literal> is chosen so that <literal>T v1...vp</literal> is of the 
3992 right <emphasis>kind</emphasis> for the last parameter of class <literal>Ci</literal>.
3993 </para>
3994 <para>
3995
3996 As an example which does <emphasis>not</emphasis> work, consider 
3997 <programlisting> 
3998   newtype NonMonad m s = NonMonad (State s m s) deriving Monad 
3999 </programlisting> 
4000 Here we cannot derive the instance 
4001 <programlisting> 
4002   instance Monad (State s m) => Monad (NonMonad m) 
4003 </programlisting> 
4004
4005 because the type variable <literal>s</literal> occurs in <literal>State s m</literal>,
4006 and so cannot be "eta-converted" away. It is a good thing that this
4007 <literal>deriving</literal> clause is rejected, because <literal>NonMonad m</literal> is
4008 not, in fact, a monad --- for the same reason. Try defining
4009 <literal>>>=</literal> with the correct type: you won't be able to.
4010 </para>
4011 <para>
4012
4013 Notice also that the <emphasis>order</emphasis> of class parameters becomes
4014 important, since we can only derive instances for the last one. If the
4015 <literal>StateMonad</literal> class above were instead defined as
4016
4017 <programlisting> 
4018   class StateMonad m s | m -> s where ... 
4019 </programlisting>
4020
4021 then we would not have been able to derive an instance for the
4022 <literal>Parser</literal> type above. We hypothesise that multi-parameter
4023 classes usually have one "main" parameter for which deriving new
4024 instances is most interesting.
4025 </para>
4026 </sect2>
4027
4028 <sect2 id="mdo-notation">
4029 <title>The recursive do-notation
4030 </title>
4031
4032 <para> The recursive do-notation (a.k.a. mdo-notation) is implemented as described in
4033 "A recursive do for Haskell",
4034 Levent Erkok, John Launchbury",
4035 Haskell Workshop 2002, pages: 29-37. Pittsburgh, Pennsylvania. 
4036 </para>
4037 <para>
4038 The do-notation of Haskell does not allow <emphasis>recursive bindings</emphasis>,
4039 that is, the variables bound in a do-expression are visible only in the textually following 
4040 code block. Compare this to a let-expression, where bound variables are visible in the entire binding
4041 group. It turns out that several applications can benefit from recursive bindings in
4042 the do-notation, and this extension provides the necessary syntactic support.
4043 </para>
4044 <para>
4045 Here is a simple (yet contrived) example:
4046 </para>
4047 <programlisting>
4048 import Control.Monad.MonadRec
4049
4050 justOnes = mdo xs <- Just (1:xs)
4051                return xs
4052 </programlisting>
4053 <para>
4054 There are three important points in using the recursive-do notation:
4055 <itemizedlist>
4056 <listitem><para>
4057 The recursive version of the do-notation uses the keyword <literal>mdo</literal> (rather
4058 than <literal>do</literal>).
4059 </para></listitem>
4060
4061 <listitem><para>
4062 The scripts using <literal>mdo</literal> should <literal>import Control.Monad.MonadRec</literal>
4063 </para></listitem>
4064
4065 <listitem><para>
4066 As with other extensions, ghc should be given the flag <literal>-fglasgow-exts</literal>
4067 </para></listitem>
4068 </itemizedlist>
4069 </para>
4070
4071 <para>
4072 The MonadRec library introduces the <literal>MonadRec</literal> class. It's definition is:
4073 </para>
4074 <programlisting>
4075 class Monad m => MonadRec m where
4076    mfix :: (a -> m a) -> m a
4077 </programlisting>
4078 <para>
4079 The <literal>MonadRec</literal> class declares the function <literal>mfix</literal>, 
4080 which dictates how the recursion should behave. If recursive bindings are required for a monad,
4081 then that monad must be declared an instance of the <literal>MonadRec</literal> class.
4082 For details, see the above mentione reference.
4083 </para>
4084 <para>
4085 The MonadRec library automatically declares List, Maybe, IO, and
4086 state monads (both lazy and strict) as instances of the <literal>MonadRec</literal> class.
4087 </para>
4088
4089 <para>
4090 The web page: <ulink url="http://www.cse.ogi.edu/PacSoft/projects/rmb">http://www.cse.ogi.edu/PacSoft/projects/rmb</ulink>
4091 contains up to date information on recursive monadic bindings.
4092 </para>
4093
4094 </sect2>
4095 </sect1>
4096
4097
4098
4099 <!-- Emacs stuff:
4100      ;;; Local Variables: ***
4101      ;;; mode: sgml ***
4102      ;;; sgml-parent-document: ("users_guide.sgml" "book" "chapter" "sect1") ***
4103      ;;; End: ***
4104  -->