ghc/compiler/typecheck/TcGenDeriv.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 \section[TcGenDeriv]{Generating derived instance declarations}
   5
   6 This module is nominally ``subordinate'' to @TcDeriv@, which is the
   7 ``official'' interface to deriving-related things.
   8
   9 This is where we do all the grimy bindings' generation.
  10
  11 \begin{code}
  12 module TcGenDeriv (
  13         gen_Bounded_binds,
  14         gen_Enum_binds,
  15         gen_Eq_binds,
  16         gen_Ix_binds,
  17         gen_Ord_binds,
  18         gen_Read_binds,
  19         gen_Show_binds,
  20         gen_tag_n_con_monobind,
  21
  22         con2tag_RDR, tag2con_RDR, maxtag_RDR,
  23
  24         TagThingWanted(..)
  25     ) where
  26
  27 #include "HsVersions.h"
  28
  29 import HsSyn            ( InPat(..), HsExpr(..), MonoBinds(..),
  30                           Match(..), GRHSs(..), Stmt(..), HsLit(..),
  31                           HsBinds(..), StmtCtxt(..),
  32                           unguardedRHS, mkSimpleMatch
  33                         )
  34 import RdrHsSyn         ( RdrName(..), varUnqual, mkOpApp,
  35                           RdrNameMonoBinds, RdrNameHsExpr, RdrNamePat
  36                         )
  37 import BasicTypes       ( IfaceFlavour(..), RecFlag(..) )
  38 import FieldLabel       ( fieldLabelName )
  39 import DataCon          ( isNullaryDataCon, dataConTag,
  40                           dataConRawArgTys, fIRST_TAG,
  41                           DataCon, ConTag,
  42                           dataConFieldLabels )
  43 import Name             ( getOccString, getOccName, getSrcLoc, occNameString,
  44                           modAndOcc, OccName, Name )
  45
  46 import PrimOp           ( PrimOp(..) )
  47 import PrelInfo         -- Lots of RdrNames
  48 import SrcLoc           ( mkGeneratedSrcLoc, SrcLoc )
  49 import TyCon            ( TyCon, isNewTyCon, tyConDataCons, isEnumerationTyCon,
  50                           maybeTyConSingleCon
  51                         )
  52 import Type             ( isUnLiftedType, isUnboxedType, Type )
  53 import TysPrim          ( charPrimTy, intPrimTy, wordPrimTy, addrPrimTy,
  54                           floatPrimTy, doublePrimTy
  55                         )
  56 import Util             ( mapAccumL, zipEqual, zipWithEqual,
  57                           zipWith3Equal, nOfThem )
  58 import Panic            ( panic, assertPanic )
  59 import Maybes           ( maybeToBool )
  60 import List             ( partition, intersperse )
  61 \end{code}
  62
  63 %************************************************************************
  64 %*                                                                      *
  65 \subsection{Generating code, by derivable class}
  66 %*                                                                      *
  67 %************************************************************************
  68
  69 %************************************************************************
  70 %*                                                                      *
  71 \subsubsection{Generating @Eq@ instance declarations}
  72 %*                                                                      *
  73 %************************************************************************
  74
  75 Here are the heuristics for the code we generate for @Eq@:
  76 \begin{itemize}
  77 \item
  78   Let's assume we have a data type with some (possibly zero) nullary
  79   data constructors and some ordinary, non-nullary ones (the rest,
  80   also possibly zero of them).  Here's an example, with both \tr{N}ullary
  81   and \tr{O}rdinary data cons.
  82 \begin{verbatim}
  83 data Foo ... = N1 | N2 ... | Nn | O1 a b | O2 Int | O3 Double b b | ...
  84 \end{verbatim}
  85
  86 \item
  87   For the ordinary constructors (if any), we emit clauses to do The
  88   Usual Thing, e.g.,:
  89
  90 \begin{verbatim}
  91 (==) (O1 a1 b1)    (O1 a2 b2)    = a1 == a2 && b1 == b2
  92 (==) (O2 a1)       (O2 a2)       = a1 == a2
  93 (==) (O3 a1 b1 c1) (O3 a2 b2 c2) = a1 == a2 && b1 == b2 && c1 == c2
  94 \end{verbatim}
  95
  96   Note: if we're comparing unboxed things, e.g., if \tr{a1} and
  97   \tr{a2} are \tr{Float#}s, then we have to generate
  98 \begin{verbatim}
  99 case (a1 `eqFloat#` a2) of
 100   r -> r
 101 \end{verbatim}
 102   for that particular test.
 103
 104 \item
 105   If there are any nullary constructors, we emit a catch-all clause of
 106   the form:
 107
 108 \begin{verbatim}
 109 (==) a b  = case (con2tag_Foo a) of { a# ->
 110             case (con2tag_Foo b) of { b# ->
 111             case (a# ==# b#)     of {
 112               r -> r
 113             }}}
 114 \end{verbatim}
 115
 116   If there aren't any nullary constructors, we emit a simpler
 117   catch-all:
 118 \begin{verbatim}
 119 (==) a b  = False
 120 \end{verbatim}
 121
 122 \item
 123   For the @(/=)@ method, we normally just use the default method.
 124
 125   If the type is an enumeration type, we could/may/should? generate
 126   special code that calls @con2tag_Foo@, much like for @(==)@ shown
 127   above.
 128
 129 \item
 130   We thought about doing this: If we're also deriving @Ord@ for this
 131   tycon, we generate:
 132 \begin{verbatim}
 133 instance ... Eq (Foo ...) where
 134   (==) a b  = case (compare a b) of { _LT -> False; _EQ -> True ; _GT -> False}
 135   (/=) a b  = case (compare a b) of { _LT -> True ; _EQ -> False; _GT -> True }
 136 \begin{verbatim}
 137   However, that requires that \tr{Ord <whatever>} was put in the context
 138   for the instance decl, which it probably wasn't, so the decls
 139   produced don't get through the typechecker.
 140 \end{itemize}
 141
 142
 143 deriveEq :: RdrName                             -- Class
 144          -> RdrName                             -- Type constructor
 145          -> [ (RdrName, [RdrType]) ]    -- Constructors
 146          -> (RdrContext,                -- Context for the inst decl
 147              [RdrBind],                 -- Binds in the inst decl
 148              [RdrBind])                 -- Extra value bindings outside
 149
 150 deriveEq clas tycon constrs
 151   = (context, [eq_bind, ne_bind], [])
 152   where
 153     context = [(clas, [ty]) | (_, tys) <- constrs, ty <- tys]
 154
 155     ne_bind = mkBind
 156     (nullary_cons, non_nullary_cons) = partition is_nullary constrs
 157     is_nullary (_, args) = null args
 158
 159 \begin{code}
 160 gen_Eq_binds :: TyCon -> RdrNameMonoBinds
 161
 162 gen_Eq_binds tycon
 163   = let
 164         tycon_loc = getSrcLoc tycon
 165         (nullary_cons, nonnullary_cons)
 166            | isNewTyCon tycon = ([], tyConDataCons tycon)
 167            | otherwise        = partition isNullaryDataCon (tyConDataCons tycon)
 168
 169         rest
 170           = if (null nullary_cons) then
 171                 case maybeTyConSingleCon tycon of
 172                   Just _ -> []
 173                   Nothing -> -- if cons don't match, then False
 174                      [([a_Pat, b_Pat], false_Expr)]
 175             else -- calc. and compare the tags
 176                  [([a_Pat, b_Pat],
 177                     untag_Expr tycon [(a_RDR,ah_RDR), (b_RDR,bh_RDR)]
 178                       (cmp_tags_Expr eqH_Int_RDR ah_RDR bh_RDR true_Expr false_Expr))]
 179     in
 180     mk_FunMonoBind tycon_loc eq_RDR ((map pats_etc nonnullary_cons) ++ rest)
 181             `AndMonoBinds`
 182     mk_easy_FunMonoBind tycon_loc ne_RDR [a_Pat, b_Pat] [] (
 183         HsApp (HsVar not_RDR) (HsPar (mk_easy_App eq_RDR [a_RDR, b_RDR])))
 184   where
 185     ------------------------------------------------------------------
 186     pats_etc data_con
 187       = let
 188             con1_pat = ConPatIn data_con_RDR (map VarPatIn as_needed)
 189             con2_pat = ConPatIn data_con_RDR (map VarPatIn bs_needed)
 190
 191             data_con_RDR = qual_orig_name data_con
 192             con_arity   = length tys_needed
 193             as_needed   = take con_arity as_RDRs
 194             bs_needed   = take con_arity bs_RDRs
 195             tys_needed  = dataConRawArgTys data_con
 196         in
 197         ([con1_pat, con2_pat], nested_eq_expr tys_needed as_needed bs_needed)
 198       where
 199         nested_eq_expr []  [] [] = true_Expr
 200         nested_eq_expr tys as bs
 201           = foldl1 and_Expr (zipWith3Equal "nested_eq" nested_eq tys as bs)
 202           where
 203             nested_eq ty a b = HsPar (eq_Expr ty (HsVar a) (HsVar b))
 204 \end{code}
 205
 206 %************************************************************************
 207 %*                                                                      *
 208 \subsubsection{Generating @Ord@ instance declarations}
 209 %*                                                                      *
 210 %************************************************************************
 211
 212 For a derived @Ord@, we concentrate our attentions on @compare@
 213 \begin{verbatim}
 214 compare :: a -> a -> Ordering
 215 data Ordering = LT | EQ | GT deriving ()
 216 \end{verbatim}
 217
 218 We will use the same example data type as above:
 219 \begin{verbatim}
 220 data Foo ... = N1 | N2 ... | Nn | O1 a b | O2 Int | O3 Double b b | ...
 221 \end{verbatim}
 222
 223 \begin{itemize}
 224 \item
 225   We do all the other @Ord@ methods with calls to @compare@:
 226 \begin{verbatim}
 227 instance ... (Ord <wurble> <wurble>) where
 228     a <  b  = case (compare a b) of { LT -> True;  EQ -> False; GT -> False }
 229     a <= b  = case (compare a b) of { LT -> True;  EQ -> True;  GT -> False }
 230     a >= b  = case (compare a b) of { LT -> False; EQ -> True;  GT -> True  }
 231     a >  b  = case (compare a b) of { LT -> False; EQ -> False; GT -> True  }
 232
 233     max a b = case (compare a b) of { LT -> b; EQ -> a;  GT -> a }
 234     min a b = case (compare a b) of { LT -> a; EQ -> b;  GT -> b }
 235
 236     -- compare to come...
 237 \end{verbatim}
 238
 239 \item
 240   @compare@ always has two parts.  First, we use the compared
 241   data-constructors' tags to deal with the case of different
 242   constructors:
 243 \begin{verbatim}
 244 compare a b = case (con2tag_Foo a) of { a# ->
 245               case (con2tag_Foo b) of { b# ->
 246               case (a# ==# b#)     of {
 247                True  -> cmp_eq a b
 248                False -> case (a# <# b#) of
 249                          True  -> _LT
 250                          False -> _GT
 251               }}}
 252   where
 253     cmp_eq = ... to come ...
 254 \end{verbatim}
 255
 256 \item
 257   We are only left with the ``help'' function @cmp_eq@, to deal with
 258   comparing data constructors with the same tag.
 259
 260   For the ordinary constructors (if any), we emit the sorta-obvious
 261   compare-style stuff; for our example:
 262 \begin{verbatim}
 263 cmp_eq (O1 a1 b1) (O1 a2 b2)
 264   = case (compare a1 a2) of { LT -> LT; EQ -> compare b1 b2; GT -> GT }
 265
 266 cmp_eq (O2 a1) (O2 a2)
 267   = compare a1 a2
 268
 269 cmp_eq (O3 a1 b1 c1) (O3 a2 b2 c2)
 270   = case (compare a1 a2) of {
 271       LT -> LT;
 272       GT -> GT;
 273       EQ -> case compare b1 b2 of {
 274               LT -> LT;
 275               GT -> GT;
 276               EQ -> compare c1 c2
 277             }
 278     }
 279 \end{verbatim}
 280
 281   Again, we must be careful about unboxed comparisons.  For example,
 282   if \tr{a1} and \tr{a2} were \tr{Int#}s in the 2nd example above, we'd need to
 283   generate:
 284
 285 \begin{verbatim}
 286 cmp_eq lt eq gt (O2 a1) (O2 a2)
 287   = compareInt# a1 a2
 288   -- or maybe the unfolded equivalent
 289 \end{verbatim}
 290
 291 \item
 292   For the remaining nullary constructors, we already know that the
 293   tags are equal so:
 294 \begin{verbatim}
 295 cmp_eq _ _ = EQ
 296 \end{verbatim}
 297 \end{itemize}
 298
 299 If there is only one constructor in the Data Type we don't need the WildCard Pattern.
 300 JJQC-30-Nov-1997
 301
 302 \begin{code}
 303 gen_Ord_binds :: TyCon -> RdrNameMonoBinds
 304
 305 gen_Ord_binds tycon
 306   = defaulted `AndMonoBinds` compare
 307   where
 308     tycon_loc = getSrcLoc tycon
 309     --------------------------------------------------------------------
 310     compare = mk_easy_FunMonoBind tycon_loc compare_RDR
 311                 [a_Pat, b_Pat]
 312                 [cmp_eq]
 313             (if maybeToBool (maybeTyConSingleCon tycon) then
 314
 315 --              cmp_eq_Expr ltTag_Expr eqTag_Expr gtTag_Expr a_Expr b_Expr
 316 -- Wierd.  Was: case (cmp a b) of { LT -> LT; EQ -> EQ; GT -> GT }
 317
 318                 cmp_eq_Expr a_Expr b_Expr
 319              else
 320                 untag_Expr tycon [(a_RDR, ah_RDR), (b_RDR, bh_RDR)]
 321                   (cmp_tags_Expr eqH_Int_RDR ah_RDR bh_RDR
 322                         -- True case; they are equal
 323                         -- If an enumeration type we are done; else
 324                         -- recursively compare their components
 325                     (if isEnumerationTyCon tycon then
 326                         eqTag_Expr
 327                      else
 328 --                      cmp_eq_Expr ltTag_Expr eqTag_Expr gtTag_Expr a_Expr b_Expr
 329 -- Ditto
 330                         cmp_eq_Expr a_Expr b_Expr
 331                     )
 332                         -- False case; they aren't equal
 333                         -- So we need to do a less-than comparison on the tags
 334                     (cmp_tags_Expr ltH_Int_RDR ah_RDR bh_RDR ltTag_Expr gtTag_Expr)))
 335
 336     tycon_data_cons = tyConDataCons tycon
 337     (nullary_cons, nonnullary_cons)
 338        | isNewTyCon tycon = ([], tyConDataCons tycon)
 339        | otherwise        = partition isNullaryDataCon tycon_data_cons
 340
 341     cmp_eq =
 342        mk_FunMonoBind tycon_loc
 343                       cmp_eq_RDR
 344                       (if null nonnullary_cons && (length nullary_cons == 1) then
 345                            -- catch this specially to avoid warnings
 346                            -- about overlapping patterns from the desugarer.
 347                           let
 348                            data_con     = head nullary_cons
 349                            data_con_RDR = qual_orig_name data_con
 350                            pat          = ConPatIn data_con_RDR []
 351                           in
 352                           [([pat,pat], eqTag_Expr)]
 353                        else
 354                           map pats_etc nonnullary_cons ++
 355                           -- leave out wildcards to silence desugarer.
 356                           (if length tycon_data_cons == 1 then
 357                               []
 358                            else
 359                               [([WildPatIn, WildPatIn], default_rhs)]))
 360       where
 361         pats_etc data_con
 362           = ([con1_pat, con2_pat],
 363              nested_compare_expr tys_needed as_needed bs_needed)
 364           where
 365             con1_pat = ConPatIn data_con_RDR (map VarPatIn as_needed)
 366             con2_pat = ConPatIn data_con_RDR (map VarPatIn bs_needed)
 367
 368             data_con_RDR = qual_orig_name data_con
 369             con_arity   = length tys_needed
 370             as_needed   = take con_arity as_RDRs
 371             bs_needed   = take con_arity bs_RDRs
 372             tys_needed  = dataConRawArgTys data_con
 373
 374             nested_compare_expr [ty] [a] [b]
 375               = careful_compare_Case ty ltTag_Expr eqTag_Expr gtTag_Expr (HsVar a) (HsVar b)
 376
 377             nested_compare_expr (ty:tys) (a:as) (b:bs)
 378               = let eq_expr = nested_compare_expr tys as bs
 379                 in  careful_compare_Case ty ltTag_Expr eq_expr gtTag_Expr (HsVar a) (HsVar b)
 380
 381         default_rhs | null nullary_cons = impossible_Expr       -- Keep desugarer from complaining about
 382                                                                 -- inexhaustive patterns
 383                     | otherwise         = eqTag_Expr            -- Some nullary constructors;
 384                                                                 -- Tags are equal, no args => return EQ
 385     --------------------------------------------------------------------
 386
 387 defaulted = foldr1 AndMonoBinds [lt, le, ge, gt, max_, min_]
 388
 389 lt = mk_easy_FunMonoBind mkGeneratedSrcLoc lt_RDR [a_Pat, b_Pat] [] (
 390             compare_Case true_Expr  false_Expr false_Expr a_Expr b_Expr)
 391 le = mk_easy_FunMonoBind mkGeneratedSrcLoc le_RDR [a_Pat, b_Pat] [] (
 392             compare_Case true_Expr  true_Expr  false_Expr a_Expr b_Expr)
 393 ge = mk_easy_FunMonoBind mkGeneratedSrcLoc ge_RDR [a_Pat, b_Pat] [] (
 394             compare_Case false_Expr true_Expr  true_Expr  a_Expr b_Expr)
 395 gt = mk_easy_FunMonoBind mkGeneratedSrcLoc gt_RDR [a_Pat, b_Pat] [] (
 396             compare_Case false_Expr false_Expr true_Expr  a_Expr b_Expr)
 397
 398 max_ = mk_easy_FunMonoBind mkGeneratedSrcLoc max_RDR [a_Pat, b_Pat] [] (
 399             compare_Case b_Expr a_Expr a_Expr a_Expr b_Expr)
 400 min_ = mk_easy_FunMonoBind mkGeneratedSrcLoc min_RDR [a_Pat, b_Pat] [] (
 401             compare_Case a_Expr b_Expr b_Expr a_Expr b_Expr)
 402 \end{code}
 403
 404 %************************************************************************
 405 %*                                                                      *
 406 \subsubsection{Generating @Enum@ instance declarations}
 407 %*                                                                      *
 408 %************************************************************************
 409
 410 @Enum@ can only be derived for enumeration types.  For a type
 411 \begin{verbatim}
 412 data Foo ... = N1 | N2 | ... | Nn
 413 \end{verbatim}
 414
 415 we use both @con2tag_Foo@ and @tag2con_Foo@ functions, as well as a
 416 @maxtag_Foo@ variable (all generated by @gen_tag_n_con_binds@).
 417
 418 \begin{verbatim}
 419 instance ... Enum (Foo ...) where
 420     succ x   = toEnum (1 + fromEnum x)
 421     pred x   = toEnum (fromEnum x - 1)
 422
 423     toEnum i = tag2con_Foo i
 424
 425     enumFrom a = map tag2con_Foo [con2tag_Foo a .. maxtag_Foo]
 426
 427     -- or, really...
 428     enumFrom a
 429       = case con2tag_Foo a of
 430           a# -> map tag2con_Foo (enumFromTo (I# a#) maxtag_Foo)
 431
 432    enumFromThen a b
 433      = map tag2con_Foo [con2tag_Foo a, con2tag_Foo b .. maxtag_Foo]
 434
 435     -- or, really...
 436     enumFromThen a b
 437       = case con2tag_Foo a of { a# ->
 438         case con2tag_Foo b of { b# ->
 439         map tag2con_Foo (enumFromThenTo (I# a#) (I# b#) maxtag_Foo)
 440         }}
 441 \end{verbatim}
 442
 443 For @enumFromTo@ and @enumFromThenTo@, we use the default methods.
 444
 445 \begin{code}
 446 gen_Enum_binds :: TyCon -> RdrNameMonoBinds
 447
 448 gen_Enum_binds tycon
 449   = succ_enum           `AndMonoBinds`
 450     pred_enum           `AndMonoBinds`
 451     to_enum             `AndMonoBinds`
 452     enum_from           `AndMonoBinds`
 453     enum_from_then      `AndMonoBinds`
 454     from_enum
 455   where
 456     tycon_loc = getSrcLoc tycon
 457     occ_nm    = getOccString tycon
 458
 459     succ_enum
 460       = mk_easy_FunMonoBind tycon_loc succ_RDR [a_Pat] [] $
 461         untag_Expr tycon [(a_RDR, ah_RDR)] $
 462         HsIf (HsApp (HsApp (HsVar eq_RDR)
 463                            (HsVar (maxtag_RDR tycon)))
 464                            (mk_easy_App mkInt_RDR [ah_RDR]))
 465              (illegal_Expr "succ" occ_nm "tried to take `succ' of last tag in enumeration")
 466              (HsApp (HsVar (tag2con_RDR tycon))
 467                     (HsApp (HsApp (HsVar plus_RDR)
 468                                   (mk_easy_App mkInt_RDR [ah_RDR]))
 469                            (HsLit (HsInt 1))))
 470              tycon_loc
 471
 472     pred_enum
 473       = mk_easy_FunMonoBind tycon_loc pred_RDR [a_Pat] [] $
 474         untag_Expr tycon [(a_RDR, ah_RDR)] $
 475         HsIf (HsApp (HsApp (HsVar eq_RDR) (HsLit (HsInt 0)))
 476                     (mk_easy_App mkInt_RDR [ah_RDR]))
 477              (illegal_Expr "pred" occ_nm "tried to take `pred' of first tag in enumeration")
 478              (HsApp (HsVar (tag2con_RDR tycon))
 479                            (HsApp (HsApp (HsVar plus_RDR)
 480                                          (mk_easy_App mkInt_RDR [ah_RDR]))
 481                                   (HsLit (HsInt (-1)))))
 482              tycon_loc
 483
 484     to_enum
 485       = mk_easy_FunMonoBind tycon_loc toEnum_RDR [a_Pat] [] $
 486         HsIf (HsApp (HsApp (HsVar gt_RDR)
 487                            (HsVar a_RDR))
 488                            (HsVar (maxtag_RDR tycon)))
 489              (illegal_toEnum_tag occ_nm (maxtag_RDR tycon))
 490              (mk_easy_App (tag2con_RDR tycon) [a_RDR])
 491              tycon_loc
 492
 493     enum_from
 494       = mk_easy_FunMonoBind tycon_loc enumFrom_RDR [a_Pat] [] $
 495           untag_Expr tycon [(a_RDR, ah_RDR)] $
 496           HsApp (mk_easy_App map_RDR [tag2con_RDR tycon]) $
 497             HsPar (enum_from_to_Expr
 498                     (mk_easy_App mkInt_RDR [ah_RDR])
 499                     (HsVar (maxtag_RDR tycon)))
 500
 501     enum_from_then
 502       = mk_easy_FunMonoBind tycon_loc enumFromThen_RDR [a_Pat, b_Pat] [] $
 503           untag_Expr tycon [(a_RDR, ah_RDR), (b_RDR, bh_RDR)] $
 504           HsApp (mk_easy_App map_RDR [tag2con_RDR tycon]) $
 505             HsPar (enum_from_then_to_Expr
 506                     (mk_easy_App mkInt_RDR [ah_RDR])
 507                     (mk_easy_App mkInt_RDR [bh_RDR])
 508                     (HsIf  (HsApp (HsApp (HsVar gt_RDR)
 509                                          (HsVar a_RDR))
 510                                          (HsVar b_RDR))
 511                            (HsLit (HsInt 0))
 512                            (HsVar (maxtag_RDR tycon))
 513                            tycon_loc))
 514
 515     from_enum
 516       = mk_easy_FunMonoBind tycon_loc fromEnum_RDR [a_Pat] [] $
 517           untag_Expr tycon [(a_RDR, ah_RDR)] $
 518           (mk_easy_App mkInt_RDR [ah_RDR])
 519 \end{code}
 520
 521 %************************************************************************
 522 %*                                                                      *
 523 \subsubsection{Generating @Bounded@ instance declarations}
 524 %*                                                                      *
 525 %************************************************************************
 526
 527 \begin{code}
 528 gen_Bounded_binds tycon
 529   = if isEnumerationTyCon tycon then
 530         min_bound_enum `AndMonoBinds` max_bound_enum
 531     else
 532         ASSERT(length data_cons == 1)
 533         min_bound_1con `AndMonoBinds` max_bound_1con
 534   where
 535     data_cons = tyConDataCons tycon
 536     tycon_loc = getSrcLoc tycon
 537
 538     ----- enum-flavored: ---------------------------
 539     min_bound_enum = mk_easy_FunMonoBind tycon_loc minBound_RDR [] [] (HsVar data_con_1_RDR)
 540     max_bound_enum = mk_easy_FunMonoBind tycon_loc maxBound_RDR [] [] (HsVar data_con_N_RDR)
 541
 542     data_con_1    = head data_cons
 543     data_con_N    = last data_cons
 544     data_con_1_RDR = qual_orig_name data_con_1
 545     data_con_N_RDR = qual_orig_name data_con_N
 546
 547     ----- single-constructor-flavored: -------------
 548     arity          = argFieldCount data_con_1
 549
 550     min_bound_1con = mk_easy_FunMonoBind tycon_loc minBound_RDR [] [] $
 551                      mk_easy_App data_con_1_RDR (nOfThem arity minBound_RDR)
 552     max_bound_1con = mk_easy_FunMonoBind tycon_loc maxBound_RDR [] [] $
 553                      mk_easy_App data_con_1_RDR (nOfThem arity maxBound_RDR)
 554 \end{code}
 555
 556 %************************************************************************
 557 %*                                                                      *
 558 \subsubsection{Generating @Ix@ instance declarations}
 559 %*                                                                      *
 560 %************************************************************************
 561
 562 Deriving @Ix@ is only possible for enumeration types and
 563 single-constructor types.  We deal with them in turn.
 564
 565 For an enumeration type, e.g.,
 566 \begin{verbatim}
 567     data Foo ... = N1 | N2 | ... | Nn
 568 \end{verbatim}
 569 things go not too differently from @Enum@:
 570 \begin{verbatim}
 571 instance ... Ix (Foo ...) where
 572     range (a, b)
 573       = map tag2con_Foo [con2tag_Foo a .. con2tag_Foo b]
 574
 575     -- or, really...
 576     range (a, b)
 577       = case (con2tag_Foo a) of { a# ->
 578         case (con2tag_Foo b) of { b# ->
 579         map tag2con_Foo (enumFromTo (I# a#) (I# b#))
 580         }}
 581
 582     index c@(a, b) d
 583       = if inRange c d
 584         then case (con2tag_Foo d -# con2tag_Foo a) of
 585                r# -> I# r#
 586         else error "Ix.Foo.index: out of range"
 587
 588     inRange (a, b) c
 589       = let
 590             p_tag = con2tag_Foo c
 591         in
 592         p_tag >= con2tag_Foo a && p_tag <= con2tag_Foo b
 593
 594     -- or, really...
 595     inRange (a, b) c
 596       = case (con2tag_Foo a)   of { a_tag ->
 597         case (con2tag_Foo b)   of { b_tag ->
 598         case (con2tag_Foo c)   of { c_tag ->
 599         if (c_tag >=# a_tag) then
 600           c_tag <=# b_tag
 601         else
 602           False
 603         }}}
 604 \end{verbatim}
 605 (modulo suitable case-ification to handle the unboxed tags)
 606
 607 For a single-constructor type (NB: this includes all tuples), e.g.,
 608 \begin{verbatim}
 609     data Foo ... = MkFoo a b Int Double c c
 610 \end{verbatim}
 611 we follow the scheme given in Figure~19 of the Haskell~1.2 report
 612 (p.~147).
 613
 614 \begin{code}
 615 gen_Ix_binds :: TyCon -> RdrNameMonoBinds
 616
 617 gen_Ix_binds tycon
 618   = if isEnumerationTyCon tycon
 619     then enum_ixes
 620     else single_con_ixes
 621   where
 622     tycon_str = getOccString tycon
 623     tycon_loc = getSrcLoc tycon
 624
 625     --------------------------------------------------------------
 626     enum_ixes = enum_range `AndMonoBinds`
 627                 enum_index `AndMonoBinds` enum_inRange
 628
 629     enum_range
 630       = mk_easy_FunMonoBind tycon_loc range_RDR
 631                 [TuplePatIn [a_Pat, b_Pat] True{-boxed-}] [] $
 632           untag_Expr tycon [(a_RDR, ah_RDR)] $
 633           untag_Expr tycon [(b_RDR, bh_RDR)] $
 634           HsApp (mk_easy_App map_RDR [tag2con_RDR tycon]) $
 635               HsPar (enum_from_to_Expr
 636                         (mk_easy_App mkInt_RDR [ah_RDR])
 637                         (mk_easy_App mkInt_RDR [bh_RDR]))
 638
 639     enum_index
 640       = mk_easy_FunMonoBind tycon_loc index_RDR
 641                 [AsPatIn c_RDR (TuplePatIn [a_Pat, b_Pat] True{-boxed-}),
 642                                 d_Pat] [] (
 643         HsIf (HsPar (mk_easy_App inRange_RDR [c_RDR, d_RDR])) (
 644            untag_Expr tycon [(a_RDR, ah_RDR)] (
 645            untag_Expr tycon [(d_RDR, dh_RDR)] (
 646            let
 647                 rhs = mk_easy_App mkInt_RDR [c_RDR]
 648            in
 649            HsCase
 650              (genOpApp (HsVar dh_RDR) minusH_RDR (HsVar ah_RDR))
 651              [mkSimpleMatch [VarPatIn c_RDR] rhs Nothing tycon_loc]
 652              tycon_loc
 653            ))
 654         ) {-else-} (
 655            HsApp (HsVar error_RDR) (HsLit (HsString (_PK_ ("Ix."++tycon_str++".index: out of range\n"))))
 656         )
 657         tycon_loc)
 658
 659     enum_inRange
 660       = mk_easy_FunMonoBind tycon_loc inRange_RDR
 661           [TuplePatIn [a_Pat, b_Pat] True{-boxed-}, c_Pat] [] (
 662           untag_Expr tycon [(a_RDR, ah_RDR)] (
 663           untag_Expr tycon [(b_RDR, bh_RDR)] (
 664           untag_Expr tycon [(c_RDR, ch_RDR)] (
 665           HsIf (genOpApp (HsVar ch_RDR) geH_RDR (HsVar ah_RDR)) (
 666              (genOpApp (HsVar ch_RDR) leH_RDR (HsVar bh_RDR))
 667           ) {-else-} (
 668              false_Expr
 669           ) tycon_loc))))
 670
 671     --------------------------------------------------------------
 672     single_con_ixes
 673       = single_con_range `AndMonoBinds`
 674         single_con_index `AndMonoBinds`
 675         single_con_inRange
 676
 677     data_con
 678       = case maybeTyConSingleCon tycon of -- just checking...
 679           Nothing -> panic "get_Ix_binds"
 680           Just dc -> if (any isUnLiftedType (dataConRawArgTys dc)) then
 681                          error ("ERROR: Can't derive Ix for a single-constructor type with primitive argument types: "++tycon_str)
 682                      else
 683                          dc
 684
 685     con_arity    = argFieldCount data_con
 686     data_con_RDR = qual_orig_name data_con
 687
 688     as_needed = take con_arity as_RDRs
 689     bs_needed = take con_arity bs_RDRs
 690     cs_needed = take con_arity cs_RDRs
 691
 692     con_pat  xs  = ConPatIn data_con_RDR (map VarPatIn xs)
 693     con_expr     = mk_easy_App data_con_RDR cs_needed
 694
 695     --------------------------------------------------------------
 696     single_con_range
 697       = mk_easy_FunMonoBind tycon_loc range_RDR
 698           [TuplePatIn [con_pat as_needed, con_pat bs_needed] True{-boxed-}] [] $
 699         HsDo ListComp stmts tycon_loc
 700       where
 701         stmts = zipWith3Equal "single_con_range" mk_qual as_needed bs_needed cs_needed
 702                 ++
 703                 [ReturnStmt con_expr]
 704
 705         mk_qual a b c = BindStmt (VarPatIn c)
 706                                  (HsApp (HsVar range_RDR)
 707                                         (ExplicitTuple [HsVar a, HsVar b] True))
 708                                  tycon_loc
 709
 710     ----------------
 711     single_con_index
 712       = mk_easy_FunMonoBind tycon_loc index_RDR
 713                 [TuplePatIn [con_pat as_needed, con_pat bs_needed] True,
 714                  con_pat cs_needed] [range_size] (
 715         foldl mk_index (HsLit (HsInt 0)) (zip3 as_needed bs_needed cs_needed))
 716       where
 717         mk_index multiply_by (l, u, i)
 718           = genOpApp (
 719                (HsApp (HsApp (HsVar index_RDR)
 720                       (ExplicitTuple [HsVar l, HsVar u] True)) (HsVar i))
 721            ) plus_RDR (
 722                 genOpApp (
 723                     (HsApp (HsVar rangeSize_RDR)
 724                            (ExplicitTuple [HsVar l, HsVar u] True))
 725                 ) times_RDR multiply_by
 726            )
 727
 728         range_size
 729           = mk_easy_FunMonoBind tycon_loc rangeSize_RDR
 730                         [TuplePatIn [a_Pat, b_Pat] True] [] (
 731                 genOpApp (
 732                     (HsApp (HsApp (HsVar index_RDR)
 733                            (ExplicitTuple [a_Expr, b_Expr] True)) b_Expr)
 734                 ) plus_RDR (HsLit (HsInt 1)))
 735
 736     ------------------
 737     single_con_inRange
 738       = mk_easy_FunMonoBind tycon_loc inRange_RDR
 739                 [TuplePatIn [con_pat as_needed, con_pat bs_needed] True,
 740                  con_pat cs_needed]
 741                            [] (
 742           foldl1 and_Expr (zipWith3Equal "single_con_inRange" in_range as_needed bs_needed cs_needed))
 743       where
 744         in_range a b c = HsApp (HsApp (HsVar inRange_RDR)
 745                                       (ExplicitTuple [HsVar a, HsVar b] True))
 746                                (HsVar c)
 747 \end{code}
 748
 749 %************************************************************************
 750 %*                                                                      *
 751 \subsubsection{Generating @Read@ instance declarations}
 752 %*                                                                      *
 753 %************************************************************************
 754
 755 Ignoring all the infix-ery mumbo jumbo (ToDo)
 756
 757 \begin{code}
 758 gen_Read_binds :: TyCon -> RdrNameMonoBinds
 759
 760 gen_Read_binds tycon
 761   = reads_prec `AndMonoBinds` read_list
 762   where
 763     tycon_loc = getSrcLoc tycon
 764     -----------------------------------------------------------------------
 765     read_list = mk_easy_FunMonoBind tycon_loc readList_RDR [] []
 766                   (HsApp (HsVar readList___RDR) (HsPar (HsApp (HsVar readsPrec_RDR) (HsLit (HsInt 0)))))
 767     -----------------------------------------------------------------------
 768     reads_prec
 769       = let
 770             read_con_comprehensions
 771               = map read_con (tyConDataCons tycon)
 772         in
 773         mk_easy_FunMonoBind tycon_loc readsPrec_RDR [a_Pat, b_Pat] [] (
 774               foldr1 append_Expr read_con_comprehensions
 775         )
 776       where
 777         read_con data_con   -- note: "b" is the string being "read"
 778           = let
 779                 data_con_RDR = qual_orig_name data_con
 780                 data_con_str= occNameString (getOccName data_con)
 781                 con_arity   = argFieldCount data_con
 782                 con_expr    = mk_easy_App data_con_RDR as_needed
 783                 nullary_con = con_arity == 0
 784                 labels      = dataConFieldLabels data_con
 785                 lab_fields  = length labels
 786
 787                 as_needed   = take con_arity as_RDRs
 788                 bs_needed
 789                  | lab_fields == 0 = take con_arity bs_RDRs
 790                  | otherwise       = take (4*lab_fields + 1) bs_RDRs
 791                                        -- (label, '=' and field)*n, (n-1)*',' + '{' + '}'
 792                 con_qual
 793                   = BindStmt
 794                           (TuplePatIn [LitPatIn (mkHsString data_con_str),
 795                                        d_Pat] True)
 796                           (HsApp (HsVar lex_RDR) c_Expr)
 797                           tycon_loc
 798
 799                 str_qual str res draw_from
 800                   = BindStmt
 801                        (TuplePatIn [LitPatIn (mkHsString str), VarPatIn res] True)
 802                        (HsApp (HsVar lex_RDR) draw_from)
 803                        tycon_loc
 804
 805                 read_label f
 806                   = let nm = occNameString (getOccName (fieldLabelName f))
 807                     in
 808                         [str_qual nm, str_qual "="]
 809                             -- There might be spaces between the label and '='
 810
 811                 field_quals
 812                   | lab_fields == 0 =
 813                      snd (mapAccumL mk_qual
 814                                     d_Expr
 815                                     (zipWithEqual "as_needed"
 816                                                   (\ con_field draw_from -> (mk_read_qual con_field,
 817                                                                              draw_from))
 818                                                   as_needed bs_needed))
 819                   | otherwise =
 820                      snd $
 821                      mapAccumL mk_qual d_Expr
 822                         (zipEqual "bs_needed"
 823                            ((str_qual "{":
 824                              concat (
 825                              intersperse [str_qual ","] $
 826                              zipWithEqual
 827                                 "field_quals"
 828                                 (\ as b -> as ++ [b])
 829                                     -- The labels
 830                                 (map read_label labels)
 831                                     -- The fields
 832                                 (map mk_read_qual as_needed))) ++ [str_qual "}"])
 833                             bs_needed)
 834
 835                 mk_qual draw_from (f, str_left)
 836                   = (HsVar str_left,    -- what to draw from down the line...
 837                      f str_left draw_from)
 838
 839                 mk_read_qual con_field res draw_from =
 840                   BindStmt
 841                    (TuplePatIn [VarPatIn con_field, VarPatIn res] True)
 842                    (HsApp (HsApp (HsVar readsPrec_RDR) (HsLit (HsInt 10))) draw_from)
 843                    tycon_loc
 844
 845                 result_expr = ExplicitTuple [con_expr, if null bs_needed
 846                                                        then d_Expr
 847                                                        else HsVar (last bs_needed)] True
 848
 849                 stmts = con_qual:field_quals ++ [ReturnStmt result_expr]
 850
 851                 read_paren_arg
 852                   = if nullary_con then -- must be False (parens are surely optional)
 853                        false_Expr
 854                     else -- parens depend on precedence...
 855                        HsPar (genOpApp a_Expr gt_RDR (HsLit (HsInt 9)))
 856             in
 857             HsApp (
 858               readParen_Expr read_paren_arg $ HsPar $
 859                  HsLam (mk_easy_Match tycon_loc [c_Pat] [] $
 860                         HsDo ListComp stmts tycon_loc)
 861               ) (HsVar b_RDR)
 862
 863 \end{code}
 864
 865 %************************************************************************
 866 %*                                                                      *
 867 \subsubsection{Generating @Show@ instance declarations}
 868 %*                                                                      *
 869 %************************************************************************
 870
 871 Ignoring all the infix-ery mumbo jumbo (ToDo)
 872
 873 \begin{code}
 874 gen_Show_binds :: TyCon -> RdrNameMonoBinds
 875
 876 gen_Show_binds tycon
 877   = shows_prec `AndMonoBinds` show_list
 878   where
 879     tycon_loc = getSrcLoc tycon
 880     -----------------------------------------------------------------------
 881     show_list = mk_easy_FunMonoBind tycon_loc showList_RDR [] []
 882                   (HsApp (HsVar showList___RDR) (HsPar (HsApp (HsVar showsPrec_RDR) (HsLit (HsInt 0)))))
 883     -----------------------------------------------------------------------
 884     shows_prec
 885       = mk_FunMonoBind tycon_loc showsPrec_RDR (map pats_etc (tyConDataCons tycon))
 886       where
 887         pats_etc data_con
 888           = let
 889                 data_con_RDR = qual_orig_name data_con
 890                 con_arity    = argFieldCount data_con
 891                 bs_needed    = take con_arity bs_RDRs
 892                 con_pat      = ConPatIn data_con_RDR (map VarPatIn bs_needed)
 893                 nullary_con  = con_arity == 0
 894                 labels       = dataConFieldLabels data_con
 895                 lab_fields   = length labels
 896
 897                 show_con
 898                   = let nm = occNameString (getOccName data_con)
 899                         space_ocurly_maybe
 900                           | nullary_con     = ""
 901                           | lab_fields == 0 = " "
 902                           | otherwise       = "{"
 903
 904                     in
 905                         mk_showString_app (nm ++ space_ocurly_maybe)
 906
 907                 show_all con fs
 908                   = let
 909                         ccurly_maybe
 910                           | lab_fields > 0  = [mk_showString_app "}"]
 911                           | otherwise       = []
 912                     in
 913                         con:fs ++ ccurly_maybe
 914
 915                 show_thingies = show_all show_con real_show_thingies_with_labs
 916
 917                 show_label l
 918                   = let nm = occNameString (getOccName (fieldLabelName l))
 919                     in
 920                     mk_showString_app (nm ++ "=")
 921
 922                 mk_showString_app str = HsApp (HsVar showString_RDR)
 923                                               (HsLit (mkHsString str))
 924
 925                 real_show_thingies =
 926                      [ HsApp (HsApp (HsVar showsPrec_RDR) (HsLit (HsInt 10))) (HsVar b)
 927                      | b <- bs_needed ]
 928
 929                 real_show_thingies_with_labs
 930                  | lab_fields == 0 = intersperse (HsVar showSpace_RDR) real_show_thingies
 931                  | otherwise       = --Assumption: no of fields == no of labelled fields
 932                                      --            (and in same order)
 933                     concat $
 934                     intersperse ([mk_showString_app ","]) $ -- Using SLIT()s containing ,s spells trouble.
 935                     zipWithEqual "gen_Show_binds"
 936                                  (\ a b -> [a,b])
 937                                  (map show_label labels)
 938                                  real_show_thingies
 939
 940
 941             in
 942             if nullary_con then  -- skip the showParen junk...
 943                 ASSERT(null bs_needed)
 944                 ([a_Pat, con_pat], show_con)
 945             else
 946                 ([a_Pat, con_pat],
 947                     showParen_Expr (HsPar (genOpApp a_Expr ge_RDR (HsLit (HsInt 10))))
 948                                    (HsPar (nested_compose_Expr show_thingies)))
 949 \end{code}
 950
 951 %************************************************************************
 952 %*                                                                      *
 953 \subsection{Generating extra binds (@con2tag@ and @tag2con@)}
 954 %*                                                                      *
 955 %************************************************************************
 956
 957 \begin{verbatim}
 958 data Foo ... = ...
 959
 960 con2tag_Foo :: Foo ... -> Int#
 961 tag2con_Foo :: Int -> Foo ...   -- easier if Int, not Int#
 962 maxtag_Foo  :: Int              -- ditto (NB: not unboxed)
 963 \end{verbatim}
 964
 965 The `tags' here start at zero, hence the @fIRST_TAG@ (currently one)
 966 fiddling around.
 967
 968 \begin{code}
 969 data TagThingWanted
 970   = GenCon2Tag | GenTag2Con | GenMaxTag
 971
 972 gen_tag_n_con_monobind
 973     :: (RdrName,            -- (proto)Name for the thing in question
 974         TyCon,              -- tycon in question
 975         TagThingWanted)
 976     -> RdrNameMonoBinds
 977
 978 gen_tag_n_con_monobind (rdr_name, tycon, GenCon2Tag)
 979   = mk_FunMonoBind (getSrcLoc tycon) rdr_name (map mk_stuff (tyConDataCons tycon))
 980   where
 981     mk_stuff :: DataCon -> ([RdrNamePat], RdrNameHsExpr)
 982
 983     mk_stuff var
 984       = ([pat], HsLit (HsIntPrim (toInteger ((dataConTag var) - fIRST_TAG))))
 985       where
 986         pat    = ConPatIn var_RDR (nOfThem (argFieldCount var) WildPatIn)
 987         var_RDR = qual_orig_name var
 988
 989 gen_tag_n_con_monobind (rdr_name, tycon, GenTag2Con)
 990   = mk_FunMonoBind (getSrcLoc tycon) rdr_name (map mk_stuff (tyConDataCons tycon) ++
 991                                                              [([WildPatIn], impossible_Expr)])
 992   where
 993     mk_stuff :: DataCon -> ([RdrNamePat], RdrNameHsExpr)
 994     mk_stuff var = ([lit_pat], HsVar var_RDR)
 995       where
 996         lit_pat = ConPatIn mkInt_RDR [LitPatIn (HsIntPrim (toInteger ((dataConTag var) - fIRST_TAG)))]
 997         var_RDR  = qual_orig_name var
 998
 999 gen_tag_n_con_monobind (rdr_name, tycon, GenMaxTag)
1000   = mk_easy_FunMonoBind (getSrcLoc tycon)
1001                 rdr_name [] [] (HsApp (HsVar mkInt_RDR) (HsLit (HsIntPrim max_tag)))
1002   where
1003     max_tag =  case (tyConDataCons tycon) of
1004                  data_cons -> toInteger ((length data_cons) - fIRST_TAG)
1005
1006 \end{code}
1007
1008 %************************************************************************
1009 %*                                                                      *
1010 \subsection{Utility bits for generating bindings}
1011 %*                                                                      *
1012 %************************************************************************
1013
1014 @mk_easy_FunMonoBind fun pats binds expr@ generates:
1015 \begin{verbatim}
1016     fun pat1 pat2 ... patN = expr where binds
1017 \end{verbatim}
1018
1019 @mk_FunMonoBind fun [([p1a, p1b, ...], e1), ...]@ is for
1020 multi-clause definitions; it generates:
1021 \begin{verbatim}
1022     fun p1a p1b ... p1N = e1
1023     fun p2a p2b ... p2N = e2
1024     ...
1025     fun pMa pMb ... pMN = eM
1026 \end{verbatim}
1027
1028 \begin{code}
1029 mk_easy_FunMonoBind :: SrcLoc -> RdrName -> [RdrNamePat]
1030                     -> [RdrNameMonoBinds] -> RdrNameHsExpr
1031                     -> RdrNameMonoBinds
1032
1033 mk_easy_FunMonoBind loc fun pats binds expr
1034   = FunMonoBind fun False{-not infix-} [mk_easy_Match loc pats binds expr] loc
1035
1036 mk_easy_Match loc pats binds expr
1037   = mk_match loc pats expr (mkbind binds)
1038   where
1039     mkbind [] = EmptyBinds
1040     mkbind bs = MonoBind (foldr1 AndMonoBinds bs) [] Recursive
1041         -- The renamer expects everything in its input to be a
1042         -- "recursive" MonoBinds, and it is its job to sort things out
1043         -- from there.
1044
1045 mk_FunMonoBind  :: SrcLoc -> RdrName
1046                 -> [([RdrNamePat], RdrNameHsExpr)]
1047                 -> RdrNameMonoBinds
1048
1049 mk_FunMonoBind loc fun [] = panic "TcGenDeriv:mk_FunMonoBind"
1050 mk_FunMonoBind loc fun pats_and_exprs
1051   = FunMonoBind fun False{-not infix-}
1052                 [ mk_match loc p e EmptyBinds | (p,e) <-pats_and_exprs ]
1053                 loc
1054
1055 mk_match loc pats expr binds
1056   = Match [] (map paren pats) Nothing
1057           (GRHSs (unguardedRHS expr loc) binds Nothing)
1058   where
1059     paren p@(VarPatIn _) = p
1060     paren other_p        = ParPatIn other_p
1061 \end{code}
1062
1063 \begin{code}
1064 mk_easy_App f xs = foldl HsApp (HsVar f) (map HsVar xs)
1065 \end{code}
1066
1067 ToDo: Better SrcLocs.
1068
1069 \begin{code}
1070 compare_Case ::
1071           RdrNameHsExpr -> RdrNameHsExpr -> RdrNameHsExpr
1072           -> RdrNameHsExpr -> RdrNameHsExpr
1073           -> RdrNameHsExpr
1074 compare_gen_Case ::
1075           RdrName
1076           -> RdrNameHsExpr -> RdrNameHsExpr -> RdrNameHsExpr
1077           -> RdrNameHsExpr -> RdrNameHsExpr
1078           -> RdrNameHsExpr
1079 careful_compare_Case :: -- checks for primitive types...
1080           Type
1081           -> RdrNameHsExpr -> RdrNameHsExpr -> RdrNameHsExpr
1082           -> RdrNameHsExpr -> RdrNameHsExpr
1083           -> RdrNameHsExpr
1084
1085 compare_Case = compare_gen_Case compare_RDR
1086 cmp_eq_Expr a b = HsApp (HsApp (HsVar cmp_eq_RDR) a) b
1087         -- Was: compare_gen_Case cmp_eq_RDR
1088
1089 compare_gen_Case fun lt eq gt a b
1090   = HsCase (HsPar (HsApp (HsApp (HsVar fun) a) b)) {-of-}
1091       [mkSimpleMatch [ConPatIn ltTag_RDR []] lt Nothing mkGeneratedSrcLoc,
1092        mkSimpleMatch [ConPatIn eqTag_RDR []] eq Nothing mkGeneratedSrcLoc,
1093        mkSimpleMatch [ConPatIn gtTag_RDR []] gt Nothing mkGeneratedSrcLoc]
1094       mkGeneratedSrcLoc
1095
1096 careful_compare_Case ty lt eq gt a b
1097   = if not (isUnboxedType ty) then
1098        compare_gen_Case compare_RDR lt eq gt a b
1099
1100     else -- we have to do something special for primitive things...
1101        HsIf (genOpApp a relevant_eq_op b)
1102             eq
1103             (HsIf (genOpApp a relevant_lt_op b) lt gt mkGeneratedSrcLoc)
1104             mkGeneratedSrcLoc
1105   where
1106     relevant_eq_op = assoc_ty_id eq_op_tbl ty
1107     relevant_lt_op = assoc_ty_id lt_op_tbl ty
1108
1109 assoc_ty_id tyids ty
1110   = if null res then panic "assoc_ty"
1111     else head res
1112   where
1113     res = [id | (ty',id) <- tyids, ty == ty']
1114
1115 eq_op_tbl =
1116     [(charPrimTy,       eqH_Char_RDR)
1117     ,(intPrimTy,        eqH_Int_RDR)
1118     ,(wordPrimTy,       eqH_Word_RDR)
1119     ,(addrPrimTy,       eqH_Addr_RDR)
1120     ,(floatPrimTy,      eqH_Float_RDR)
1121     ,(doublePrimTy,     eqH_Double_RDR)
1122     ]
1123
1124 lt_op_tbl =
1125     [(charPrimTy,       ltH_Char_RDR)
1126     ,(intPrimTy,        ltH_Int_RDR)
1127     ,(wordPrimTy,       ltH_Word_RDR)
1128     ,(addrPrimTy,       ltH_Addr_RDR)
1129     ,(floatPrimTy,      ltH_Float_RDR)
1130     ,(doublePrimTy,     ltH_Double_RDR)
1131     ]
1132
1133 -----------------------------------------------------------------------
1134
1135 and_Expr, append_Expr :: RdrNameHsExpr -> RdrNameHsExpr -> RdrNameHsExpr
1136
1137 and_Expr    a b = genOpApp a and_RDR    b
1138 append_Expr a b = genOpApp a append_RDR b
1139
1140 -----------------------------------------------------------------------
1141
1142 eq_Expr :: Type -> RdrNameHsExpr -> RdrNameHsExpr -> RdrNameHsExpr
1143 eq_Expr ty a b
1144   = if not (isUnboxedType ty) then
1145        genOpApp a eq_RDR  b
1146     else -- we have to do something special for primitive things...
1147        genOpApp a relevant_eq_op b
1148   where
1149     relevant_eq_op = assoc_ty_id eq_op_tbl ty
1150 \end{code}
1151
1152 \begin{code}
1153 argFieldCount :: DataCon -> Int -- Works on data and newtype constructors
1154 argFieldCount con = length (dataConRawArgTys con)
1155 \end{code}
1156
1157 \begin{code}
1158 untag_Expr :: TyCon -> [(RdrName, RdrName)] -> RdrNameHsExpr -> RdrNameHsExpr
1159 untag_Expr tycon [] expr = expr
1160 untag_Expr tycon ((untag_this, put_tag_here) : more) expr
1161   = HsCase (HsPar (HsApp (con2tag_Expr tycon) (HsVar untag_this))) {-of-}
1162       [mkSimpleMatch [VarPatIn put_tag_here] (untag_Expr tycon more expr) Nothing mkGeneratedSrcLoc]
1163       mkGeneratedSrcLoc
1164
1165 cmp_tags_Expr :: RdrName                -- Comparison op
1166              -> RdrName -> RdrName      -- Things to compare
1167              -> RdrNameHsExpr           -- What to return if true
1168              -> RdrNameHsExpr           -- What to return if false
1169              -> RdrNameHsExpr
1170
1171 cmp_tags_Expr op a b true_case false_case
1172   = HsIf (genOpApp (HsVar a) op (HsVar b)) true_case false_case mkGeneratedSrcLoc
1173
1174 enum_from_to_Expr
1175         :: RdrNameHsExpr -> RdrNameHsExpr
1176         -> RdrNameHsExpr
1177 enum_from_then_to_Expr
1178         :: RdrNameHsExpr -> RdrNameHsExpr -> RdrNameHsExpr
1179         -> RdrNameHsExpr
1180
1181 enum_from_to_Expr      f   t2 = HsApp (HsApp (HsVar enumFromTo_RDR) f) t2
1182 enum_from_then_to_Expr f t t2 = HsApp (HsApp (HsApp (HsVar enumFromThenTo_RDR) f) t) t2
1183
1184 showParen_Expr, readParen_Expr
1185         :: RdrNameHsExpr -> RdrNameHsExpr
1186         -> RdrNameHsExpr
1187
1188 showParen_Expr e1 e2 = HsApp (HsApp (HsVar showParen_RDR) e1) e2
1189 readParen_Expr e1 e2 = HsApp (HsApp (HsVar readParen_RDR) e1) e2
1190
1191 nested_compose_Expr :: [RdrNameHsExpr] -> RdrNameHsExpr
1192
1193 nested_compose_Expr [e] = parenify e
1194 nested_compose_Expr (e:es)
1195   = HsApp (HsApp (HsVar compose_RDR) (parenify e)) (nested_compose_Expr es)
1196
1197 -- impossible_Expr is used in case RHSs that should never happen.
1198 -- We generate these to keep the desugarer from complaining that they *might* happen!
1199 impossible_Expr = HsApp (HsVar error_RDR) (HsLit (HsString (_PK_ "Urk! in TcGenDeriv")))
1200
1201 -- illegal_Expr is used when signalling error conditions in the RHS of a derived
1202 -- method. It is currently only used by Enum.{succ,pred}
1203 illegal_Expr meth tp msg =
1204    HsApp (HsVar error_RDR) (HsLit (HsString (_PK_ (meth ++ '{':tp ++ "}: " ++ msg))))
1205
1206 -- illegal_toEnum_tag is an extended version of illegal_Expr, which also allows you
1207 -- to include the value of a_RDR in the error string.
1208 illegal_toEnum_tag tp maxtag =
1209    HsApp (HsVar error_RDR)
1210          (HsApp (HsApp (HsVar append_RDR)
1211                        (HsLit (HsString (_PK_ ("toEnum{" ++ tp ++ "}: tag (")))))
1212                        (HsApp (HsApp (HsApp
1213                            (HsVar showsPrec_RDR)
1214                            (HsLit (HsInt 0)))
1215                            (HsVar a_RDR))
1216                            (HsApp (HsApp
1217                                (HsVar append_RDR)
1218                                (HsLit (HsString (_PK_ ") is outside of enumeration's range (0,"))))
1219                                (HsApp (HsApp (HsApp
1220                                         (HsVar showsPrec_RDR)
1221                                         (HsLit (HsInt 0)))
1222                                         (HsVar maxtag))
1223                                         (HsLit (HsString (_PK_ ")")))))))
1224
1225 parenify e@(HsVar _) = e
1226 parenify e           = HsPar e
1227
1228 -- genOpApp wraps brackets round the operator application, so that the
1229 -- renamer won't subsequently try to re-associate it.
1230 -- For some reason the renamer doesn't reassociate it right, and I can't
1231 -- be bothered to find out why just now.
1232
1233 genOpApp e1 op e2 = mkOpApp e1 op e2
1234 \end{code}
1235
1236 \begin{code}
1237 qual_orig_name n = case modAndOcc n of { (m,n) -> Qual m n HiFile }
1238
1239 a_RDR           = varUnqual SLIT("a")
1240 b_RDR           = varUnqual SLIT("b")
1241 c_RDR           = varUnqual SLIT("c")
1242 d_RDR           = varUnqual SLIT("d")
1243 ah_RDR          = varUnqual SLIT("a#")
1244 bh_RDR          = varUnqual SLIT("b#")
1245 ch_RDR          = varUnqual SLIT("c#")
1246 dh_RDR          = varUnqual SLIT("d#")
1247 cmp_eq_RDR      = varUnqual SLIT("cmp_eq")
1248 rangeSize_RDR   = varUnqual SLIT("rangeSize")
1249
1250 as_RDRs         = [ varUnqual (_PK_ ("a"++show i)) | i <- [(1::Int) .. ] ]
1251 bs_RDRs         = [ varUnqual (_PK_ ("b"++show i)) | i <- [(1::Int) .. ] ]
1252 cs_RDRs         = [ varUnqual (_PK_ ("c"++show i)) | i <- [(1::Int) .. ] ]
1253
1254 mkHsString s = HsString (_PK_ s)
1255
1256 a_Expr          = HsVar a_RDR
1257 b_Expr          = HsVar b_RDR
1258 c_Expr          = HsVar c_RDR
1259 d_Expr          = HsVar d_RDR
1260 ltTag_Expr      = HsVar ltTag_RDR
1261 eqTag_Expr      = HsVar eqTag_RDR
1262 gtTag_Expr      = HsVar gtTag_RDR
1263 false_Expr      = HsVar false_RDR
1264 true_Expr       = HsVar true_RDR
1265
1266 con2tag_Expr tycon = HsVar (con2tag_RDR tycon)
1267
1268 a_Pat           = VarPatIn a_RDR
1269 b_Pat           = VarPatIn b_RDR
1270 c_Pat           = VarPatIn c_RDR
1271 d_Pat           = VarPatIn d_RDR
1272
1273 con2tag_RDR, tag2con_RDR, maxtag_RDR :: TyCon -> RdrName
1274
1275 con2tag_RDR tycon = varUnqual (_PK_ ("con2tag_" ++ occNameString (getOccName tycon) ++ "#"))
1276 tag2con_RDR tycon = varUnqual (_PK_ ("tag2con_" ++ occNameString (getOccName tycon) ++ "#"))
1277 maxtag_RDR tycon  = varUnqual (_PK_ ("maxtag_"  ++ occNameString (getOccName tycon) ++ "#"))
1278 \end{code}