2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1996
4 \section[TcGenDeriv]{Generating derived instance declarations}
6 This module is nominally ``subordinate'' to @TcDeriv@, which is the
7 ``official'' interface to deriving-related things.
9 This is where we do all the grimy bindings' generation.
12 #include "HsVersions.h"
23 gen_tag_n_con_monobind,
25 con2tag_RDR, tag2con_RDR, maxtag_RDR,
31 IMPORT_1_3(List(partition))
33 import HsSyn ( HsBinds(..), Bind(..), MonoBinds(..), Match(..), GRHSsAndBinds(..),
34 GRHS(..), HsExpr(..), HsLit(..), InPat(..), Stmt(..), DoOrListComp(..),
35 ArithSeqInfo, Sig, HsType, FixityDecl, Fixity, Fake )
36 import RdrHsSyn ( RdrName(..), varQual, varUnqual, mkOpApp,
37 SYN_IE(RdrNameMonoBinds), SYN_IE(RdrNameHsExpr), SYN_IE(RdrNamePat)
39 -- import RnHsSyn ( RenamedFixityDecl(..) )
41 import Id ( GenId, dataConNumFields, isNullaryDataCon, dataConTag,
42 dataConRawArgTys, fIRST_TAG,
43 isDataCon, SYN_IE(DataCon), SYN_IE(ConTag) )
44 import Maybes ( maybeToBool )
45 import Name ( getOccString, getOccName, getSrcLoc, occNameString, modAndOcc, OccName, Name )
47 import PrimOp ( PrimOp(..) )
48 import PrelInfo -- Lots of RdrNames
49 import SrcLoc ( mkGeneratedSrcLoc )
50 import TyCon ( TyCon, tyConDataCons, isEnumerationTyCon, maybeTyConSingleCon )
51 import Type ( eqTy, isPrimType )
52 import TysPrim ( charPrimTy, intPrimTy, wordPrimTy, addrPrimTy,
53 floatPrimTy, doublePrimTy
55 import Util ( mapAccumL, zipEqual, zipWith3Equal, nOfThem, panic, assertPanic )
58 %************************************************************************
60 \subsection{Generating code, by derivable class}
62 %************************************************************************
64 %************************************************************************
66 \subsubsection{Generating @Eq@ instance declarations}
68 %************************************************************************
70 Here are the heuristics for the code we generate for @Eq@:
73 Let's assume we have a data type with some (possibly zero) nullary
74 data constructors and some ordinary, non-nullary ones (the rest,
75 also possibly zero of them). Here's an example, with both \tr{N}ullary
76 and \tr{O}rdinary data cons.
78 data Foo ... = N1 | N2 ... | Nn | O1 a b | O2 Int | O3 Double b b | ...
82 For the ordinary constructors (if any), we emit clauses to do The
86 (==) (O1 a1 b1) (O1 a2 b2) = a1 == a2 && b1 == b2
87 (==) (O2 a1) (O2 a2) = a1 == a2
88 (==) (O3 a1 b1 c1) (O3 a2 b2 c2) = a1 == a2 && b1 == b2 && c1 == c2
91 Note: if we're comparing unboxed things, e.g., if \tr{a1} and
92 \tr{a2} are \tr{Float#}s, then we have to generate
94 case (a1 `eqFloat#` a2) of
97 for that particular test.
100 If there are any nullary constructors, we emit a catch-all clause of
104 (==) a b = case (con2tag_Foo a) of { a# ->
105 case (con2tag_Foo b) of { b# ->
106 case (a# ==# b#) of {
111 If there aren't any nullary constructors, we emit a simpler
118 For the @(/=)@ method, we normally just use the default method.
120 If the type is an enumeration type, we could/may/should? generate
121 special code that calls @con2tag_Foo@, much like for @(==)@ shown
125 We thought about doing this: If we're also deriving @Ord@ for this
128 instance ... Eq (Foo ...) where
129 (==) a b = case (compare a b) of { _LT -> False; _EQ -> True ; _GT -> False}
130 (/=) a b = case (compare a b) of { _LT -> True ; _EQ -> False; _GT -> True }
132 However, that requires that \tr{Ord <whatever>} was put in the context
133 for the instance decl, which it probably wasn't, so the decls
134 produced don't get through the typechecker.
138 gen_Eq_binds :: TyCon -> RdrNameMonoBinds
142 tycon_loc = getSrcLoc tycon
143 (nullary_cons, nonnullary_cons)
144 = partition isNullaryDataCon (tyConDataCons tycon)
147 = if (null nullary_cons) then
148 case maybeTyConSingleCon tycon of
150 Nothing -> -- if cons don't match, then False
151 [([a_Pat, b_Pat], false_Expr)]
152 else -- calc. and compare the tags
154 untag_Expr tycon [(a_RDR,ah_RDR), (b_RDR,bh_RDR)]
155 (cmp_tags_Expr eqH_Int_RDR ah_RDR bh_RDR true_Expr false_Expr))]
157 mk_FunMonoBind tycon_loc eq_RDR ((map pats_etc nonnullary_cons) ++ rest)
159 mk_easy_FunMonoBind tycon_loc ne_RDR [a_Pat, b_Pat] [] (
160 HsApp (HsVar not_RDR) (HsPar (mk_easy_App eq_RDR [a_RDR, b_RDR])))
162 ------------------------------------------------------------------
165 con1_pat = ConPatIn data_con_RDR (map VarPatIn as_needed)
166 con2_pat = ConPatIn data_con_RDR (map VarPatIn bs_needed)
168 data_con_RDR = qual_orig_name data_con
169 con_arity = length tys_needed
170 as_needed = take con_arity as_RDRs
171 bs_needed = take con_arity bs_RDRs
172 tys_needed = dataConRawArgTys data_con
174 ([con1_pat, con2_pat], nested_eq_expr tys_needed as_needed bs_needed)
176 nested_eq_expr [] [] [] = true_Expr
177 nested_eq_expr tys as bs
178 = foldl1 and_Expr (zipWith3Equal "nested_eq" nested_eq tys as bs)
180 nested_eq ty a b = HsPar (eq_Expr ty (HsVar a) (HsVar b))
183 %************************************************************************
185 \subsubsection{Generating @Ord@ instance declarations}
187 %************************************************************************
189 For a derived @Ord@, we concentrate our attentions on @compare@
191 compare :: a -> a -> Ordering
192 data Ordering = LT | EQ | GT deriving ()
195 We will use the same example data type as above:
197 data Foo ... = N1 | N2 ... | Nn | O1 a b | O2 Int | O3 Double b b | ...
202 We do all the other @Ord@ methods with calls to @compare@:
204 instance ... (Ord <wurble> <wurble>) where
205 a < b = case (compare a b) of { LT -> True; EQ -> False; GT -> False }
206 a <= b = case (compare a b) of { LT -> True; EQ -> True; GT -> False }
207 a >= b = case (compare a b) of { LT -> False; EQ -> True; GT -> True }
208 a > b = case (compare a b) of { LT -> False; EQ -> False; GT -> True }
210 max a b = case (compare a b) of { LT -> b; EQ -> a; GT -> a }
211 min a b = case (compare a b) of { LT -> a; EQ -> b; GT -> b }
213 -- compare to come...
217 @compare@ always has two parts. First, we use the compared
218 data-constructors' tags to deal with the case of different
221 compare a b = case (con2tag_Foo a) of { a# ->
222 case (con2tag_Foo b) of { b# ->
223 case (a# ==# b#) of {
225 False -> case (a# <# b#) of
230 cmp_eq = ... to come ...
234 We are only left with the ``help'' function @cmp_eq@, to deal with
235 comparing data constructors with the same tag.
237 For the ordinary constructors (if any), we emit the sorta-obvious
238 compare-style stuff; for our example:
240 cmp_eq (O1 a1 b1) (O1 a2 b2)
241 = case (compare a1 a2) of { LT -> LT; EQ -> compare b1 b2; GT -> GT }
243 cmp_eq (O2 a1) (O2 a2)
246 cmp_eq (O3 a1 b1 c1) (O3 a2 b2 c2)
247 = case (compare a1 a2) of {
250 EQ -> case compare b1 b2 of {
258 Again, we must be careful about unboxed comparisons. For example,
259 if \tr{a1} and \tr{a2} were \tr{Int#}s in the 2nd example above, we'd need to
262 cmp_eq lt eq gt (O2 a1) (O2 a2)
264 -- or maybe the unfolded equivalent
268 For the remaining nullary constructors, we already know that the
276 gen_Ord_binds :: TyCon -> RdrNameMonoBinds
279 = defaulted `AndMonoBinds` compare
281 tycon_loc = getSrcLoc tycon
282 --------------------------------------------------------------------
283 compare = mk_easy_FunMonoBind tycon_loc compare_RDR
286 (if maybeToBool (maybeTyConSingleCon tycon) then
287 cmp_eq_Expr ltTag_Expr eqTag_Expr gtTag_Expr a_Expr b_Expr
289 untag_Expr tycon [(a_RDR, ah_RDR), (b_RDR, bh_RDR)]
290 (cmp_tags_Expr eqH_Int_RDR ah_RDR bh_RDR
291 -- True case; they are equal
292 -- If an enumeration type we are done; else
293 -- recursively compare their components
294 (if isEnumerationTyCon tycon then
297 cmp_eq_Expr ltTag_Expr eqTag_Expr gtTag_Expr a_Expr b_Expr
299 -- False case; they aren't equal
300 -- So we need to do a less-than comparison on the tags
301 (cmp_tags_Expr ltH_Int_RDR ah_RDR bh_RDR ltTag_Expr gtTag_Expr)))
303 (nullary_cons, nonnullary_cons)
304 = partition isNullaryDataCon (tyConDataCons tycon)
307 = mk_FunMonoBind tycon_loc cmp_eq_RDR (map pats_etc nonnullary_cons ++
308 [([WildPatIn, WildPatIn], default_rhs)])
311 = ([con1_pat, con2_pat],
312 nested_compare_expr tys_needed as_needed bs_needed)
314 con1_pat = ConPatIn data_con_RDR (map VarPatIn as_needed)
315 con2_pat = ConPatIn data_con_RDR (map VarPatIn bs_needed)
317 data_con_RDR = qual_orig_name data_con
318 con_arity = length tys_needed
319 as_needed = take con_arity as_RDRs
320 bs_needed = take con_arity bs_RDRs
321 tys_needed = dataConRawArgTys data_con
323 nested_compare_expr [ty] [a] [b]
324 = careful_compare_Case ty ltTag_Expr eqTag_Expr gtTag_Expr (HsVar a) (HsVar b)
326 nested_compare_expr (ty:tys) (a:as) (b:bs)
327 = let eq_expr = nested_compare_expr tys as bs
328 in careful_compare_Case ty ltTag_Expr eq_expr gtTag_Expr (HsVar a) (HsVar b)
330 default_rhs | null nullary_cons = impossible_Expr -- Keep desugarer from complaining about
331 -- inexhaustive patterns
332 | otherwise = eqTag_Expr -- Some nullary constructors;
333 -- Tags are equal, no args => return EQ
334 --------------------------------------------------------------------
336 defaulted = foldr1 AndMonoBinds [lt, le, ge, gt, max_, min_]
338 lt = mk_easy_FunMonoBind mkGeneratedSrcLoc lt_RDR [a_Pat, b_Pat] [] (
339 compare_Case true_Expr false_Expr false_Expr a_Expr b_Expr)
340 le = mk_easy_FunMonoBind mkGeneratedSrcLoc le_RDR [a_Pat, b_Pat] [] (
341 compare_Case true_Expr true_Expr false_Expr a_Expr b_Expr)
342 ge = mk_easy_FunMonoBind mkGeneratedSrcLoc ge_RDR [a_Pat, b_Pat] [] (
343 compare_Case false_Expr true_Expr true_Expr a_Expr b_Expr)
344 gt = mk_easy_FunMonoBind mkGeneratedSrcLoc gt_RDR [a_Pat, b_Pat] [] (
345 compare_Case false_Expr false_Expr true_Expr a_Expr b_Expr)
347 max_ = mk_easy_FunMonoBind mkGeneratedSrcLoc max_RDR [a_Pat, b_Pat] [] (
348 compare_Case b_Expr a_Expr a_Expr a_Expr b_Expr)
349 min_ = mk_easy_FunMonoBind mkGeneratedSrcLoc min_RDR [a_Pat, b_Pat] [] (
350 compare_Case a_Expr b_Expr b_Expr a_Expr b_Expr)
353 %************************************************************************
355 \subsubsection{Generating @Enum@ instance declarations}
357 %************************************************************************
359 @Enum@ can only be derived for enumeration types. For a type
361 data Foo ... = N1 | N2 | ... | Nn
364 we use both @con2tag_Foo@ and @tag2con_Foo@ functions, as well as a
365 @maxtag_Foo@ variable (all generated by @gen_tag_n_con_binds@).
368 instance ... Enum (Foo ...) where
369 toEnum i = tag2con_Foo i
371 enumFrom a = map tag2con_Foo [con2tag_Foo a .. maxtag_Foo]
375 = case con2tag_Foo a of
376 a# -> map tag2con_Foo (enumFromTo (I# a#) maxtag_Foo)
379 = map tag2con_Foo [con2tag_Foo a, con2tag_Foo b .. maxtag_Foo]
383 = case con2tag_Foo a of { a# ->
384 case con2tag_Foo b of { b# ->
385 map tag2con_Foo (enumFromThenTo (I# a#) (I# b#) maxtag_Foo)
389 For @enumFromTo@ and @enumFromThenTo@, we use the default methods.
392 gen_Enum_binds :: TyCon -> RdrNameMonoBinds
395 = to_enum `AndMonoBinds`
396 enum_from `AndMonoBinds`
397 enum_from_then `AndMonoBinds`
400 tycon_loc = getSrcLoc tycon
403 = mk_easy_FunMonoBind tycon_loc toEnum_RDR [a_Pat] [] $
404 mk_easy_App (tag2con_RDR tycon) [a_RDR]
407 = mk_easy_FunMonoBind tycon_loc enumFrom_RDR [a_Pat] [] $
408 untag_Expr tycon [(a_RDR, ah_RDR)] $
409 HsApp (mk_easy_App map_RDR [tag2con_RDR tycon]) $
410 HsPar (enum_from_to_Expr
411 (mk_easy_App mkInt_RDR [ah_RDR])
412 (HsVar (maxtag_RDR tycon)))
415 = mk_easy_FunMonoBind tycon_loc enumFromThen_RDR [a_Pat, b_Pat] [] $
416 untag_Expr tycon [(a_RDR, ah_RDR), (b_RDR, bh_RDR)] $
417 HsApp (mk_easy_App map_RDR [tag2con_RDR tycon]) $
418 HsPar (enum_from_then_to_Expr
419 (mk_easy_App mkInt_RDR [ah_RDR])
420 (mk_easy_App mkInt_RDR [bh_RDR])
421 (HsVar (maxtag_RDR tycon)))
424 = mk_easy_FunMonoBind tycon_loc fromEnum_RDR [a_Pat] [] $
425 untag_Expr tycon [(a_RDR, ah_RDR)] $
426 (mk_easy_App mkInt_RDR [ah_RDR])
429 %************************************************************************
431 \subsubsection{Generating @Eval@ instance declarations}
433 %************************************************************************
436 gen_Eval_binds tycon = EmptyMonoBinds
439 %************************************************************************
441 \subsubsection{Generating @Bounded@ instance declarations}
443 %************************************************************************
446 gen_Bounded_binds tycon
447 = if isEnumerationTyCon tycon then
448 min_bound_enum `AndMonoBinds` max_bound_enum
450 ASSERT(length data_cons == 1)
451 min_bound_1con `AndMonoBinds` max_bound_1con
453 data_cons = tyConDataCons tycon
454 tycon_loc = getSrcLoc tycon
456 ----- enum-flavored: ---------------------------
457 min_bound_enum = mk_easy_FunMonoBind tycon_loc minBound_RDR [] [] (HsVar data_con_1_RDR)
458 max_bound_enum = mk_easy_FunMonoBind tycon_loc maxBound_RDR [] [] (HsVar data_con_N_RDR)
460 data_con_1 = head data_cons
461 data_con_N = last data_cons
462 data_con_1_RDR = qual_orig_name data_con_1
463 data_con_N_RDR = qual_orig_name data_con_N
465 ----- single-constructor-flavored: -------------
466 arity = dataConNumFields data_con_1
468 min_bound_1con = mk_easy_FunMonoBind tycon_loc minBound_RDR [] [] $
469 mk_easy_App data_con_1_RDR (nOfThem arity minBound_RDR)
470 max_bound_1con = mk_easy_FunMonoBind tycon_loc maxBound_RDR [] [] $
471 mk_easy_App data_con_1_RDR (nOfThem arity maxBound_RDR)
474 %************************************************************************
476 \subsubsection{Generating @Ix@ instance declarations}
478 %************************************************************************
480 Deriving @Ix@ is only possible for enumeration types and
481 single-constructor types. We deal with them in turn.
483 For an enumeration type, e.g.,
485 data Foo ... = N1 | N2 | ... | Nn
487 things go not too differently from @Enum@:
489 instance ... Ix (Foo ...) where
491 = map tag2con_Foo [con2tag_Foo a .. con2tag_Foo b]
495 = case (con2tag_Foo a) of { a# ->
496 case (con2tag_Foo b) of { b# ->
497 map tag2con_Foo (enumFromTo (I# a#) (I# b#))
502 then case (con2tag_Foo d -# con2tag_Foo a) of
504 else error "Ix.Foo.index: out of range"
508 p_tag = con2tag_Foo c
510 p_tag >= con2tag_Foo a && p_tag <= con2tag_Foo b
514 = case (con2tag_Foo a) of { a_tag ->
515 case (con2tag_Foo b) of { b_tag ->
516 case (con2tag_Foo c) of { c_tag ->
517 if (c_tag >=# a_tag) then
523 (modulo suitable case-ification to handle the unboxed tags)
525 For a single-constructor type (NB: this includes all tuples), e.g.,
527 data Foo ... = MkFoo a b Int Double c c
529 we follow the scheme given in Figure~19 of the Haskell~1.2 report
533 gen_Ix_binds :: TyCon -> RdrNameMonoBinds
536 = if isEnumerationTyCon tycon
540 tycon_str = getOccString tycon
541 tycon_loc = getSrcLoc tycon
543 --------------------------------------------------------------
544 enum_ixes = enum_range `AndMonoBinds`
545 enum_index `AndMonoBinds` enum_inRange
548 = mk_easy_FunMonoBind tycon_loc range_RDR [TuplePatIn [a_Pat, b_Pat]] [] $
549 untag_Expr tycon [(a_RDR, ah_RDR)] $
550 untag_Expr tycon [(b_RDR, bh_RDR)] $
551 HsApp (mk_easy_App map_RDR [tag2con_RDR tycon]) $
552 HsPar (enum_from_to_Expr
553 (mk_easy_App mkInt_RDR [ah_RDR])
554 (mk_easy_App mkInt_RDR [bh_RDR]))
557 = mk_easy_FunMonoBind tycon_loc index_RDR [AsPatIn c_RDR (TuplePatIn [a_Pat, b_Pat]), d_Pat] [] (
558 HsIf (HsPar (mk_easy_App inRange_RDR [c_RDR, d_RDR])) (
559 untag_Expr tycon [(a_RDR, ah_RDR)] (
560 untag_Expr tycon [(d_RDR, dh_RDR)] (
562 grhs = [OtherwiseGRHS (mk_easy_App mkInt_RDR [c_RDR]) tycon_loc]
565 (genOpApp (HsVar dh_RDR) minusH_RDR (HsVar ah_RDR))
566 [PatMatch (VarPatIn c_RDR)
567 (GRHSMatch (GRHSsAndBindsIn grhs EmptyBinds))]
571 HsApp (HsVar error_RDR) (HsLit (HsString (_PK_ ("Ix."++tycon_str++".index: out of range\n"))))
576 = mk_easy_FunMonoBind tycon_loc inRange_RDR [TuplePatIn [a_Pat, b_Pat], c_Pat] [] (
577 untag_Expr tycon [(a_RDR, ah_RDR)] (
578 untag_Expr tycon [(b_RDR, bh_RDR)] (
579 untag_Expr tycon [(c_RDR, ch_RDR)] (
580 HsIf (genOpApp (HsVar ch_RDR) geH_RDR (HsVar ah_RDR)) (
581 (genOpApp (HsVar ch_RDR) leH_RDR (HsVar bh_RDR))
586 --------------------------------------------------------------
587 single_con_ixes = single_con_range `AndMonoBinds`
588 single_con_index `AndMonoBinds` single_con_inRange
591 = case maybeTyConSingleCon tycon of -- just checking...
592 Nothing -> panic "get_Ix_binds"
593 Just dc -> if (any isPrimType (dataConRawArgTys dc)) then
594 error ("ERROR: Can't derive Ix for a single-constructor type with primitive argument types: "++tycon_str)
598 con_arity = dataConNumFields data_con
599 data_con_RDR = qual_orig_name data_con
600 con_pat xs = ConPatIn data_con_RDR (map VarPatIn xs)
601 con_expr xs = mk_easy_App data_con_RDR xs
603 as_needed = take con_arity as_RDRs
604 bs_needed = take con_arity bs_RDRs
605 cs_needed = take con_arity cs_RDRs
607 --------------------------------------------------------------
609 = mk_easy_FunMonoBind tycon_loc range_RDR [TuplePatIn [con_pat as_needed, con_pat bs_needed]] [] $
610 HsDo ListComp stmts tycon_loc
612 stmts = zipWith3Equal "single_con_range" mk_qual as_needed bs_needed cs_needed
614 [ReturnStmt (con_expr cs_needed)]
616 mk_qual a b c = BindStmt (VarPatIn c)
617 (HsApp (HsVar range_RDR) (ExplicitTuple [HsVar a, HsVar b]))
622 = mk_easy_FunMonoBind tycon_loc index_RDR [TuplePatIn [con_pat as_needed, con_pat bs_needed], con_pat cs_needed] [range_size] (
623 foldl mk_index (HsLit (HsInt 0)) (zip3 as_needed bs_needed cs_needed))
625 mk_index multiply_by (l, u, i)
627 (HsApp (HsApp (HsVar index_RDR) (ExplicitTuple [HsVar l, HsVar u])) (HsVar i))
630 (HsApp (HsVar rangeSize_RDR) (ExplicitTuple [HsVar l, HsVar u]))
631 ) times_RDR multiply_by
635 = mk_easy_FunMonoBind tycon_loc rangeSize_RDR [TuplePatIn [a_Pat, b_Pat]] [] (
637 (HsApp (HsApp (HsVar index_RDR) (ExplicitTuple [a_Expr, b_Expr])) b_Expr)
638 ) plus_RDR (HsLit (HsInt 1)))
642 = mk_easy_FunMonoBind tycon_loc inRange_RDR
643 [TuplePatIn [con_pat as_needed, con_pat bs_needed], con_pat cs_needed]
645 foldl1 and_Expr (zipWith3Equal "single_con_inRange" in_range as_needed bs_needed cs_needed))
647 in_range a b c = HsApp (HsApp (HsVar inRange_RDR) (ExplicitTuple [HsVar a, HsVar b])) (HsVar c)
650 %************************************************************************
652 \subsubsection{Generating @Read@ instance declarations}
654 %************************************************************************
656 Ignoring all the infix-ery mumbo jumbo (ToDo)
659 gen_Read_binds :: TyCon -> RdrNameMonoBinds
662 = reads_prec `AndMonoBinds` read_list
664 tycon_loc = getSrcLoc tycon
665 -----------------------------------------------------------------------
666 read_list = mk_easy_FunMonoBind tycon_loc readList_RDR [] []
667 (HsApp (HsVar readList___RDR) (HsPar (HsApp (HsVar readsPrec_RDR) (HsLit (HsInt 0)))))
668 -----------------------------------------------------------------------
671 read_con_comprehensions
672 = map read_con (tyConDataCons tycon)
674 mk_easy_FunMonoBind tycon_loc readsPrec_RDR [a_Pat, b_Pat] [] (
675 foldr1 append_Expr read_con_comprehensions
678 read_con data_con -- note: "b" is the string being "read"
680 data_con_RDR = qual_orig_name data_con
681 data_con_str= occNameString (getOccName data_con)
682 con_arity = dataConNumFields data_con
683 as_needed = take con_arity as_RDRs
684 bs_needed = take con_arity bs_RDRs
685 con_expr = mk_easy_App data_con_RDR as_needed
686 nullary_con = isNullaryDataCon data_con
690 (TuplePatIn [LitPatIn (HsString data_con_str), d_Pat])
691 (HsApp (HsVar lex_RDR) c_Expr)
694 field_quals = snd (mapAccumL mk_qual d_Expr (zipEqual "as_needed" as_needed bs_needed))
695 mk_qual draw_from (con_field, str_left)
696 = (HsVar str_left, -- what to draw from down the line...
698 (TuplePatIn [VarPatIn con_field, VarPatIn str_left])
699 (HsApp (HsApp (HsVar readsPrec_RDR) (HsLit (HsInt 10))) draw_from)
703 result_expr = ExplicitTuple [con_expr, if null bs_needed
705 else HsVar (last bs_needed)]
707 stmts = (con_qual : field_quals) ++ [ReturnStmt result_expr]
711 = if nullary_con then -- must be False (parens are surely optional)
713 else -- parens depend on precedence...
714 HsPar (genOpApp a_Expr gt_RDR (HsLit (HsInt 9)))
717 readParen_Expr read_paren_arg $ HsPar $
718 HsLam (mk_easy_Match tycon_loc [c_Pat] [] $
719 HsDo ListComp stmts tycon_loc)
723 %************************************************************************
725 \subsubsection{Generating @Show@ instance declarations}
727 %************************************************************************
729 Ignoring all the infix-ery mumbo jumbo (ToDo)
732 gen_Show_binds :: TyCon -> RdrNameMonoBinds
735 = shows_prec `AndMonoBinds` show_list
737 tycon_loc = getSrcLoc tycon
738 -----------------------------------------------------------------------
739 show_list = mk_easy_FunMonoBind tycon_loc showList_RDR [] []
740 (HsApp (HsVar showList___RDR) (HsPar (HsApp (HsVar showsPrec_RDR) (HsLit (HsInt 0)))))
741 -----------------------------------------------------------------------
743 = mk_FunMonoBind tycon_loc showsPrec_RDR (map pats_etc (tyConDataCons tycon))
747 data_con_RDR = qual_orig_name data_con
748 con_arity = dataConNumFields data_con
749 bs_needed = take con_arity bs_RDRs
750 con_pat = ConPatIn data_con_RDR (map VarPatIn bs_needed)
751 nullary_con = isNullaryDataCon data_con
754 = let nm = occNameString (getOccName data_con)
755 space_maybe = if nullary_con then _NIL_ else SLIT(" ")
757 HsApp (HsVar showString_RDR) (HsLit (HsString (nm _APPEND_ space_maybe)))
759 show_thingies = show_con : (spacified real_show_thingies)
762 = [ HsApp (HsApp (HsVar showsPrec_RDR) (HsLit (HsInt 10))) (HsVar b)
765 if nullary_con then -- skip the showParen junk...
766 ASSERT(null bs_needed)
767 ([a_Pat, con_pat], show_con)
770 showParen_Expr (HsPar (genOpApp a_Expr ge_RDR (HsLit (HsInt 10))))
771 (HsPar (nested_compose_Expr show_thingies)))
775 spacified (x:xs) = (x : (HsVar showSpace_RDR) : spacified xs)
778 %************************************************************************
780 \subsection{Generating extra binds (@con2tag@ and @tag2con@)}
782 %************************************************************************
787 con2tag_Foo :: Foo ... -> Int#
788 tag2con_Foo :: Int -> Foo ... -- easier if Int, not Int#
789 maxtag_Foo :: Int -- ditto (NB: not unboxed)
792 The `tags' here start at zero, hence the @fIRST_TAG@ (currently one)
797 = GenCon2Tag | GenTag2Con | GenMaxTag
799 gen_tag_n_con_monobind
800 :: (RdrName, -- (proto)Name for the thing in question
801 TyCon, -- tycon in question
805 gen_tag_n_con_monobind (rdr_name, tycon, GenCon2Tag)
806 = mk_FunMonoBind (getSrcLoc tycon) rdr_name (map mk_stuff (tyConDataCons tycon))
808 mk_stuff :: DataCon -> ([RdrNamePat], RdrNameHsExpr)
811 = ASSERT(isDataCon var)
812 ([pat], HsLit (HsIntPrim (toInteger ((dataConTag var) - fIRST_TAG))))
814 pat = ConPatIn var_RDR (nOfThem (dataConNumFields var) WildPatIn)
815 var_RDR = qual_orig_name var
817 gen_tag_n_con_monobind (rdr_name, tycon, GenTag2Con)
818 = mk_FunMonoBind (getSrcLoc tycon) rdr_name (map mk_stuff (tyConDataCons tycon) ++
819 [([WildPatIn], impossible_Expr)])
821 mk_stuff :: DataCon -> ([RdrNamePat], RdrNameHsExpr)
824 = ASSERT(isDataCon var)
825 ([lit_pat], HsVar var_RDR)
827 lit_pat = ConPatIn mkInt_RDR [LitPatIn (HsIntPrim (toInteger ((dataConTag var) - fIRST_TAG)))]
828 var_RDR = qual_orig_name var
830 gen_tag_n_con_monobind (rdr_name, tycon, GenMaxTag)
831 = mk_easy_FunMonoBind (getSrcLoc tycon)
832 rdr_name [] [] (HsApp (HsVar mkInt_RDR) (HsLit (HsIntPrim max_tag)))
834 max_tag = case (tyConDataCons tycon) of
835 data_cons -> toInteger ((length data_cons) - fIRST_TAG)
839 %************************************************************************
841 \subsection{Utility bits for generating bindings}
843 %************************************************************************
845 @mk_easy_FunMonoBind fun pats binds expr@ generates:
847 fun pat1 pat2 ... patN = expr where binds
850 @mk_FunMonoBind fun [([p1a, p1b, ...], e1), ...]@ is for
851 multi-clause definitions; it generates:
853 fun p1a p1b ... p1N = e1
854 fun p2a p2b ... p2N = e2
856 fun pMa pMb ... pMN = eM
860 mk_easy_FunMonoBind :: SrcLoc -> RdrName -> [RdrNamePat]
861 -> [RdrNameMonoBinds] -> RdrNameHsExpr
864 mk_easy_FunMonoBind loc fun pats binds expr
865 = FunMonoBind fun False{-not infix-} [mk_easy_Match loc pats binds expr] loc
867 mk_easy_Match loc pats binds expr
868 = mk_match loc pats expr (mkbind binds)
870 mkbind [] = EmptyBinds
871 mkbind bs = SingleBind (RecBind (foldr1 AndMonoBinds bs))
872 -- The renamer expects everything in its input to be a
873 -- "recursive" MonoBinds, and it is its job to sort things out
876 mk_FunMonoBind :: SrcLoc -> RdrName
877 -> [([RdrNamePat], RdrNameHsExpr)]
880 mk_FunMonoBind loc fun [] = panic "TcGenDeriv:mk_FunMonoBind"
881 mk_FunMonoBind loc fun pats_and_exprs
882 = FunMonoBind fun False{-not infix-}
883 [ mk_match loc p e EmptyBinds | (p,e) <-pats_and_exprs ]
886 mk_match loc pats expr binds
888 (GRHSMatch (GRHSsAndBindsIn [OtherwiseGRHS expr loc] binds))
891 paren p@(VarPatIn _) = p
892 paren other_p = ParPatIn other_p
896 mk_easy_App f xs = foldl HsApp (HsVar f) (map HsVar xs)
899 ToDo: Better SrcLocs.
902 compare_Case, cmp_eq_Expr ::
903 RdrNameHsExpr -> RdrNameHsExpr -> RdrNameHsExpr
904 -> RdrNameHsExpr -> RdrNameHsExpr
908 -> RdrNameHsExpr -> RdrNameHsExpr -> RdrNameHsExpr
909 -> RdrNameHsExpr -> RdrNameHsExpr
911 careful_compare_Case :: -- checks for primitive types...
913 -> RdrNameHsExpr -> RdrNameHsExpr -> RdrNameHsExpr
914 -> RdrNameHsExpr -> RdrNameHsExpr
917 compare_Case = compare_gen_Case compare_RDR
918 cmp_eq_Expr = compare_gen_Case cmp_eq_RDR
920 compare_gen_Case fun lt eq gt a b
921 = HsCase (HsPar (HsApp (HsApp (HsVar fun) a) b)) {-of-}
922 [PatMatch (ConPatIn ltTag_RDR [])
923 (GRHSMatch (GRHSsAndBindsIn [OtherwiseGRHS lt mkGeneratedSrcLoc] EmptyBinds)),
925 PatMatch (ConPatIn eqTag_RDR [])
926 (GRHSMatch (GRHSsAndBindsIn [OtherwiseGRHS eq mkGeneratedSrcLoc] EmptyBinds)),
928 PatMatch (ConPatIn gtTag_RDR [])
929 (GRHSMatch (GRHSsAndBindsIn [OtherwiseGRHS gt mkGeneratedSrcLoc] EmptyBinds))]
932 careful_compare_Case ty lt eq gt a b
933 = if not (isPrimType ty) then
934 compare_gen_Case compare_RDR lt eq gt a b
936 else -- we have to do something special for primitive things...
937 HsIf (genOpApp a relevant_eq_op b)
939 (HsIf (genOpApp a relevant_lt_op b) lt gt mkGeneratedSrcLoc)
942 relevant_eq_op = assoc_ty_id eq_op_tbl ty
943 relevant_lt_op = assoc_ty_id lt_op_tbl ty
946 = if null res then panic "assoc_ty"
949 res = [id | (ty',id) <- tyids, eqTy ty ty']
952 [(charPrimTy, eqH_Char_RDR)
953 ,(intPrimTy, eqH_Int_RDR)
954 ,(wordPrimTy, eqH_Word_RDR)
955 ,(addrPrimTy, eqH_Addr_RDR)
956 ,(floatPrimTy, eqH_Float_RDR)
957 ,(doublePrimTy, eqH_Double_RDR)
961 [(charPrimTy, ltH_Char_RDR)
962 ,(intPrimTy, ltH_Int_RDR)
963 ,(wordPrimTy, ltH_Word_RDR)
964 ,(addrPrimTy, ltH_Addr_RDR)
965 ,(floatPrimTy, ltH_Float_RDR)
966 ,(doublePrimTy, ltH_Double_RDR)
969 -----------------------------------------------------------------------
971 and_Expr, append_Expr :: RdrNameHsExpr -> RdrNameHsExpr -> RdrNameHsExpr
973 and_Expr a b = genOpApp a and_RDR b
974 append_Expr a b = genOpApp a append_RDR b
976 -----------------------------------------------------------------------
978 eq_Expr :: Type -> RdrNameHsExpr -> RdrNameHsExpr -> RdrNameHsExpr
980 = if not (isPrimType ty) then
982 else -- we have to do something special for primitive things...
983 genOpApp a relevant_eq_op b
985 relevant_eq_op = assoc_ty_id eq_op_tbl ty
989 untag_Expr :: TyCon -> [(RdrName, RdrName)] -> RdrNameHsExpr -> RdrNameHsExpr
990 untag_Expr tycon [] expr = expr
991 untag_Expr tycon ((untag_this, put_tag_here) : more) expr
992 = HsCase (HsPar (HsApp (con2tag_Expr tycon) (HsVar untag_this))) {-of-}
993 [PatMatch (VarPatIn put_tag_here)
994 (GRHSMatch (GRHSsAndBindsIn grhs EmptyBinds))]
997 grhs = [OtherwiseGRHS (untag_Expr tycon more expr) mkGeneratedSrcLoc]
999 cmp_tags_Expr :: RdrName -- Comparison op
1000 -> RdrName -> RdrName -- Things to compare
1001 -> RdrNameHsExpr -- What to return if true
1002 -> RdrNameHsExpr -- What to return if false
1005 cmp_tags_Expr op a b true_case false_case
1006 = HsIf (genOpApp (HsVar a) op (HsVar b)) true_case false_case mkGeneratedSrcLoc
1009 :: RdrNameHsExpr -> RdrNameHsExpr
1011 enum_from_then_to_Expr
1012 :: RdrNameHsExpr -> RdrNameHsExpr -> RdrNameHsExpr
1015 enum_from_to_Expr f t2 = HsApp (HsApp (HsVar enumFromTo_RDR) f) t2
1016 enum_from_then_to_Expr f t t2 = HsApp (HsApp (HsApp (HsVar enumFromThenTo_RDR) f) t) t2
1018 showParen_Expr, readParen_Expr
1019 :: RdrNameHsExpr -> RdrNameHsExpr
1022 showParen_Expr e1 e2 = HsApp (HsApp (HsVar showParen_RDR) e1) e2
1023 readParen_Expr e1 e2 = HsApp (HsApp (HsVar readParen_RDR) e1) e2
1025 nested_compose_Expr :: [RdrNameHsExpr] -> RdrNameHsExpr
1027 nested_compose_Expr [e] = parenify e
1028 nested_compose_Expr (e:es)
1029 = HsApp (HsApp (HsVar compose_RDR) (parenify e)) (nested_compose_Expr es)
1031 -- impossible_Expr is used in case RHSs that should never happen.
1032 -- We generate these to keep the desugarer from complaining that they *might* happen!
1033 impossible_Expr = HsApp (HsVar error_RDR) (HsLit (HsString (_PK_ "Urk! in TcGenDeriv")))
1035 parenify e@(HsVar _) = e
1036 parenify e = HsPar e
1038 -- genOpApp wraps brackets round the operator application, so that the
1039 -- renamer won't subsequently try to re-associate it.
1040 -- For some reason the renamer doesn't reassociate it right, and I can't
1041 -- be bothered to find out why just now.
1043 genOpApp e1 op e2 = mkOpApp e1 op e2
1047 qual_orig_name n = case modAndOcc n of { (m,n) -> Qual m n }
1049 a_RDR = varUnqual SLIT("a")
1050 b_RDR = varUnqual SLIT("b")
1051 c_RDR = varUnqual SLIT("c")
1052 d_RDR = varUnqual SLIT("d")
1053 ah_RDR = varUnqual SLIT("a#")
1054 bh_RDR = varUnqual SLIT("b#")
1055 ch_RDR = varUnqual SLIT("c#")
1056 dh_RDR = varUnqual SLIT("d#")
1057 cmp_eq_RDR = varUnqual SLIT("cmp_eq")
1058 rangeSize_RDR = varUnqual SLIT("rangeSize")
1060 as_RDRs = [ varUnqual (_PK_ ("a"++show i)) | i <- [(1::Int) .. ] ]
1061 bs_RDRs = [ varUnqual (_PK_ ("b"++show i)) | i <- [(1::Int) .. ] ]
1062 cs_RDRs = [ varUnqual (_PK_ ("c"++show i)) | i <- [(1::Int) .. ] ]
1064 a_Expr = HsVar a_RDR
1065 b_Expr = HsVar b_RDR
1066 c_Expr = HsVar c_RDR
1067 d_Expr = HsVar d_RDR
1068 ltTag_Expr = HsVar ltTag_RDR
1069 eqTag_Expr = HsVar eqTag_RDR
1070 gtTag_Expr = HsVar gtTag_RDR
1071 false_Expr = HsVar false_RDR
1072 true_Expr = HsVar true_RDR
1074 con2tag_Expr tycon = HsVar (con2tag_RDR tycon)
1076 a_Pat = VarPatIn a_RDR
1077 b_Pat = VarPatIn b_RDR
1078 c_Pat = VarPatIn c_RDR
1079 d_Pat = VarPatIn d_RDR
1081 con2tag_RDR, tag2con_RDR, maxtag_RDR :: TyCon -> RdrName
1083 con2tag_RDR tycon = varUnqual (SLIT("con2tag_") _APPEND_ occNameString (getOccName tycon) _APPEND_ SLIT("#"))
1084 tag2con_RDR tycon = varUnqual (SLIT("tag2con_") _APPEND_ occNameString (getOccName tycon) _APPEND_ SLIT("#"))
1085 maxtag_RDR tycon = varUnqual (SLIT("maxtag_") _APPEND_ occNameString (getOccName tycon) _APPEND_ SLIT("#"))