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                     (HsVar (maxtag_RDR tycon)))
 509
 510     from_enum
 511       = mk_easy_FunMonoBind tycon_loc fromEnum_RDR [a_Pat] [] $
 512           untag_Expr tycon [(a_RDR, ah_RDR)] $
 513           (mk_easy_App mkInt_RDR [ah_RDR])
 514 \end{code}
 515
 516 %************************************************************************
 517 %*                                                                      *
 518 \subsubsection{Generating @Bounded@ instance declarations}
 519 %*                                                                      *
 520 %************************************************************************
 521
 522 \begin{code}
 523 gen_Bounded_binds tycon
 524   = if isEnumerationTyCon tycon then
 525         min_bound_enum `AndMonoBinds` max_bound_enum
 526     else
 527         ASSERT(length data_cons == 1)
 528         min_bound_1con `AndMonoBinds` max_bound_1con
 529   where
 530     data_cons = tyConDataCons tycon
 531     tycon_loc = getSrcLoc tycon
 532
 533     ----- enum-flavored: ---------------------------
 534     min_bound_enum = mk_easy_FunMonoBind tycon_loc minBound_RDR [] [] (HsVar data_con_1_RDR)
 535     max_bound_enum = mk_easy_FunMonoBind tycon_loc maxBound_RDR [] [] (HsVar data_con_N_RDR)
 536
 537     data_con_1    = head data_cons
 538     data_con_N    = last data_cons
 539     data_con_1_RDR = qual_orig_name data_con_1
 540     data_con_N_RDR = qual_orig_name data_con_N
 541
 542     ----- single-constructor-flavored: -------------
 543     arity          = argFieldCount data_con_1
 544
 545     min_bound_1con = mk_easy_FunMonoBind tycon_loc minBound_RDR [] [] $
 546                      mk_easy_App data_con_1_RDR (nOfThem arity minBound_RDR)
 547     max_bound_1con = mk_easy_FunMonoBind tycon_loc maxBound_RDR [] [] $
 548                      mk_easy_App data_con_1_RDR (nOfThem arity maxBound_RDR)
 549 \end{code}
 550
 551 %************************************************************************
 552 %*                                                                      *
 553 \subsubsection{Generating @Ix@ instance declarations}
 554 %*                                                                      *
 555 %************************************************************************
 556
 557 Deriving @Ix@ is only possible for enumeration types and
 558 single-constructor types.  We deal with them in turn.
 559
 560 For an enumeration type, e.g.,
 561 \begin{verbatim}
 562     data Foo ... = N1 | N2 | ... | Nn
 563 \end{verbatim}
 564 things go not too differently from @Enum@:
 565 \begin{verbatim}
 566 instance ... Ix (Foo ...) where
 567     range (a, b)
 568       = map tag2con_Foo [con2tag_Foo a .. con2tag_Foo b]
 569
 570     -- or, really...
 571     range (a, b)
 572       = case (con2tag_Foo a) of { a# ->
 573         case (con2tag_Foo b) of { b# ->
 574         map tag2con_Foo (enumFromTo (I# a#) (I# b#))
 575         }}
 576
 577     index c@(a, b) d
 578       = if inRange c d
 579         then case (con2tag_Foo d -# con2tag_Foo a) of
 580                r# -> I# r#
 581         else error "Ix.Foo.index: out of range"
 582
 583     inRange (a, b) c
 584       = let
 585             p_tag = con2tag_Foo c
 586         in
 587         p_tag >= con2tag_Foo a && p_tag <= con2tag_Foo b
 588
 589     -- or, really...
 590     inRange (a, b) c
 591       = case (con2tag_Foo a)   of { a_tag ->
 592         case (con2tag_Foo b)   of { b_tag ->
 593         case (con2tag_Foo c)   of { c_tag ->
 594         if (c_tag >=# a_tag) then
 595           c_tag <=# b_tag
 596         else
 597           False
 598         }}}
 599 \end{verbatim}
 600 (modulo suitable case-ification to handle the unboxed tags)
 601
 602 For a single-constructor type (NB: this includes all tuples), e.g.,
 603 \begin{verbatim}
 604     data Foo ... = MkFoo a b Int Double c c
 605 \end{verbatim}
 606 we follow the scheme given in Figure~19 of the Haskell~1.2 report
 607 (p.~147).
 608
 609 \begin{code}
 610 gen_Ix_binds :: TyCon -> RdrNameMonoBinds
 611
 612 gen_Ix_binds tycon
 613   = if isEnumerationTyCon tycon
 614     then enum_ixes
 615     else single_con_ixes
 616   where
 617     tycon_str = getOccString tycon
 618     tycon_loc = getSrcLoc tycon
 619
 620     --------------------------------------------------------------
 621     enum_ixes = enum_range `AndMonoBinds`
 622                 enum_index `AndMonoBinds` enum_inRange
 623
 624     enum_range
 625       = mk_easy_FunMonoBind tycon_loc range_RDR
 626                 [TuplePatIn [a_Pat, b_Pat] True{-boxed-}] [] $
 627           untag_Expr tycon [(a_RDR, ah_RDR)] $
 628           untag_Expr tycon [(b_RDR, bh_RDR)] $
 629           HsApp (mk_easy_App map_RDR [tag2con_RDR tycon]) $
 630               HsPar (enum_from_to_Expr
 631                         (mk_easy_App mkInt_RDR [ah_RDR])
 632                         (mk_easy_App mkInt_RDR [bh_RDR]))
 633
 634     enum_index
 635       = mk_easy_FunMonoBind tycon_loc index_RDR
 636                 [AsPatIn c_RDR (TuplePatIn [a_Pat, b_Pat] True{-boxed-}),
 637                                 d_Pat] [] (
 638         HsIf (HsPar (mk_easy_App inRange_RDR [c_RDR, d_RDR])) (
 639            untag_Expr tycon [(a_RDR, ah_RDR)] (
 640            untag_Expr tycon [(d_RDR, dh_RDR)] (
 641            let
 642                 rhs = mk_easy_App mkInt_RDR [c_RDR]
 643            in
 644            HsCase
 645              (genOpApp (HsVar dh_RDR) minusH_RDR (HsVar ah_RDR))
 646              [mkSimpleMatch [VarPatIn c_RDR] rhs Nothing tycon_loc]
 647              tycon_loc
 648            ))
 649         ) {-else-} (
 650            HsApp (HsVar error_RDR) (HsLit (HsString (_PK_ ("Ix."++tycon_str++".index: out of range\n"))))
 651         )
 652         tycon_loc)
 653
 654     enum_inRange
 655       = mk_easy_FunMonoBind tycon_loc inRange_RDR
 656           [TuplePatIn [a_Pat, b_Pat] True{-boxed-}, c_Pat] [] (
 657           untag_Expr tycon [(a_RDR, ah_RDR)] (
 658           untag_Expr tycon [(b_RDR, bh_RDR)] (
 659           untag_Expr tycon [(c_RDR, ch_RDR)] (
 660           HsIf (genOpApp (HsVar ch_RDR) geH_RDR (HsVar ah_RDR)) (
 661              (genOpApp (HsVar ch_RDR) leH_RDR (HsVar bh_RDR))
 662           ) {-else-} (
 663              false_Expr
 664           ) tycon_loc))))
 665
 666     --------------------------------------------------------------
 667     single_con_ixes
 668       = single_con_range `AndMonoBinds`
 669         single_con_index `AndMonoBinds`
 670         single_con_inRange
 671
 672     data_con
 673       = case maybeTyConSingleCon tycon of -- just checking...
 674           Nothing -> panic "get_Ix_binds"
 675           Just dc -> if (any isUnLiftedType (dataConRawArgTys dc)) then
 676                          error ("ERROR: Can't derive Ix for a single-constructor type with primitive argument types: "++tycon_str)
 677                      else
 678                          dc
 679
 680     con_arity    = argFieldCount data_con
 681     data_con_RDR = qual_orig_name data_con
 682
 683     as_needed = take con_arity as_RDRs
 684     bs_needed = take con_arity bs_RDRs
 685     cs_needed = take con_arity cs_RDRs
 686
 687     con_pat  xs  = ConPatIn data_con_RDR (map VarPatIn xs)
 688     con_expr     = mk_easy_App data_con_RDR cs_needed
 689
 690     --------------------------------------------------------------
 691     single_con_range
 692       = mk_easy_FunMonoBind tycon_loc range_RDR
 693           [TuplePatIn [con_pat as_needed, con_pat bs_needed] True{-boxed-}] [] $
 694         HsDo ListComp stmts tycon_loc
 695       where
 696         stmts = zipWith3Equal "single_con_range" mk_qual as_needed bs_needed cs_needed
 697                 ++
 698                 [ReturnStmt con_expr]
 699
 700         mk_qual a b c = BindStmt (VarPatIn c)
 701                                  (HsApp (HsVar range_RDR)
 702                                         (ExplicitTuple [HsVar a, HsVar b] True))
 703                                  tycon_loc
 704
 705     ----------------
 706     single_con_index
 707       = mk_easy_FunMonoBind tycon_loc index_RDR
 708                 [TuplePatIn [con_pat as_needed, con_pat bs_needed] True,
 709                  con_pat cs_needed] [range_size] (
 710         foldl mk_index (HsLit (HsInt 0)) (zip3 as_needed bs_needed cs_needed))
 711       where
 712         mk_index multiply_by (l, u, i)
 713           = genOpApp (
 714                (HsApp (HsApp (HsVar index_RDR)
 715                       (ExplicitTuple [HsVar l, HsVar u] True)) (HsVar i))
 716            ) plus_RDR (
 717                 genOpApp (
 718                     (HsApp (HsVar rangeSize_RDR)
 719                            (ExplicitTuple [HsVar l, HsVar u] True))
 720                 ) times_RDR multiply_by
 721            )
 722
 723         range_size
 724           = mk_easy_FunMonoBind tycon_loc rangeSize_RDR
 725                         [TuplePatIn [a_Pat, b_Pat] True] [] (
 726                 genOpApp (
 727                     (HsApp (HsApp (HsVar index_RDR)
 728                            (ExplicitTuple [a_Expr, b_Expr] True)) b_Expr)
 729                 ) plus_RDR (HsLit (HsInt 1)))
 730
 731     ------------------
 732     single_con_inRange
 733       = mk_easy_FunMonoBind tycon_loc inRange_RDR
 734                 [TuplePatIn [con_pat as_needed, con_pat bs_needed] True,
 735                  con_pat cs_needed]
 736                            [] (
 737           foldl1 and_Expr (zipWith3Equal "single_con_inRange" in_range as_needed bs_needed cs_needed))
 738       where
 739         in_range a b c = HsApp (HsApp (HsVar inRange_RDR)
 740                                       (ExplicitTuple [HsVar a, HsVar b] True))
 741                                (HsVar c)
 742 \end{code}
 743
 744 %************************************************************************
 745 %*                                                                      *
 746 \subsubsection{Generating @Read@ instance declarations}
 747 %*                                                                      *
 748 %************************************************************************
 749
 750 Ignoring all the infix-ery mumbo jumbo (ToDo)
 751
 752 \begin{code}
 753 gen_Read_binds :: TyCon -> RdrNameMonoBinds
 754
 755 gen_Read_binds tycon
 756   = reads_prec `AndMonoBinds` read_list
 757   where
 758     tycon_loc = getSrcLoc tycon
 759     -----------------------------------------------------------------------
 760     read_list = mk_easy_FunMonoBind tycon_loc readList_RDR [] []
 761                   (HsApp (HsVar readList___RDR) (HsPar (HsApp (HsVar readsPrec_RDR) (HsLit (HsInt 0)))))
 762     -----------------------------------------------------------------------
 763     reads_prec
 764       = let
 765             read_con_comprehensions
 766               = map read_con (tyConDataCons tycon)
 767         in
 768         mk_easy_FunMonoBind tycon_loc readsPrec_RDR [a_Pat, b_Pat] [] (
 769               foldr1 append_Expr read_con_comprehensions
 770         )
 771       where
 772         read_con data_con   -- note: "b" is the string being "read"
 773           = let
 774                 data_con_RDR = qual_orig_name data_con
 775                 data_con_str= occNameString (getOccName data_con)
 776                 con_arity   = argFieldCount data_con
 777                 con_expr    = mk_easy_App data_con_RDR as_needed
 778                 nullary_con = con_arity == 0
 779                 labels      = dataConFieldLabels data_con
 780                 lab_fields  = length labels
 781
 782                 as_needed   = take con_arity as_RDRs
 783                 bs_needed
 784                  | lab_fields == 0 = take con_arity bs_RDRs
 785                  | otherwise       = take (4*lab_fields + 1) bs_RDRs
 786                                        -- (label, '=' and field)*n, (n-1)*',' + '{' + '}'
 787                 con_qual
 788                   = BindStmt
 789                           (TuplePatIn [LitPatIn (mkHsString data_con_str),
 790                                        d_Pat] True)
 791                           (HsApp (HsVar lex_RDR) c_Expr)
 792                           tycon_loc
 793
 794                 str_qual str res draw_from
 795                   = BindStmt
 796                        (TuplePatIn [LitPatIn (mkHsString str), VarPatIn res] True)
 797                        (HsApp (HsVar lex_RDR) draw_from)
 798                        tycon_loc
 799
 800                 read_label f
 801                   = let nm = occNameString (getOccName (fieldLabelName f))
 802                     in
 803                         [str_qual nm, str_qual "="]
 804                             -- There might be spaces between the label and '='
 805
 806                 field_quals
 807                   | lab_fields == 0 =
 808                      snd (mapAccumL mk_qual
 809                                     d_Expr
 810                                     (zipWithEqual "as_needed"
 811                                                   (\ con_field draw_from -> (mk_read_qual con_field,
 812                                                                              draw_from))
 813                                                   as_needed bs_needed))
 814                   | otherwise =
 815                      snd $
 816                      mapAccumL mk_qual d_Expr
 817                         (zipEqual "bs_needed"
 818                            ((str_qual "{":
 819                              concat (
 820                              intersperse [str_qual ","] $
 821                              zipWithEqual
 822                                 "field_quals"
 823                                 (\ as b -> as ++ [b])
 824                                     -- The labels
 825                                 (map read_label labels)
 826                                     -- The fields
 827                                 (map mk_read_qual as_needed))) ++ [str_qual "}"])
 828                             bs_needed)
 829
 830                 mk_qual draw_from (f, str_left)
 831                   = (HsVar str_left,    -- what to draw from down the line...
 832                      f str_left draw_from)
 833
 834                 mk_read_qual con_field res draw_from =
 835                   BindStmt
 836                    (TuplePatIn [VarPatIn con_field, VarPatIn res] True)
 837                    (HsApp (HsApp (HsVar readsPrec_RDR) (HsLit (HsInt 10))) draw_from)
 838                    tycon_loc
 839
 840                 result_expr = ExplicitTuple [con_expr, if null bs_needed
 841                                                        then d_Expr
 842                                                        else HsVar (last bs_needed)] True
 843
 844                 stmts = con_qual:field_quals ++ [ReturnStmt result_expr]
 845
 846                 read_paren_arg
 847                   = if nullary_con then -- must be False (parens are surely optional)
 848                        false_Expr
 849                     else -- parens depend on precedence...
 850                        HsPar (genOpApp a_Expr gt_RDR (HsLit (HsInt 9)))
 851             in
 852             HsApp (
 853               readParen_Expr read_paren_arg $ HsPar $
 854                  HsLam (mk_easy_Match tycon_loc [c_Pat] [] $
 855                         HsDo ListComp stmts tycon_loc)
 856               ) (HsVar b_RDR)
 857
 858 \end{code}
 859
 860 %************************************************************************
 861 %*                                                                      *
 862 \subsubsection{Generating @Show@ instance declarations}
 863 %*                                                                      *
 864 %************************************************************************
 865
 866 Ignoring all the infix-ery mumbo jumbo (ToDo)
 867
 868 \begin{code}
 869 gen_Show_binds :: TyCon -> RdrNameMonoBinds
 870
 871 gen_Show_binds tycon
 872   = shows_prec `AndMonoBinds` show_list
 873   where
 874     tycon_loc = getSrcLoc tycon
 875     -----------------------------------------------------------------------
 876     show_list = mk_easy_FunMonoBind tycon_loc showList_RDR [] []
 877                   (HsApp (HsVar showList___RDR) (HsPar (HsApp (HsVar showsPrec_RDR) (HsLit (HsInt 0)))))
 878     -----------------------------------------------------------------------
 879     shows_prec
 880       = mk_FunMonoBind tycon_loc showsPrec_RDR (map pats_etc (tyConDataCons tycon))
 881       where
 882         pats_etc data_con
 883           = let
 884                 data_con_RDR = qual_orig_name data_con
 885                 con_arity    = argFieldCount data_con
 886                 bs_needed    = take con_arity bs_RDRs
 887                 con_pat      = ConPatIn data_con_RDR (map VarPatIn bs_needed)
 888                 nullary_con  = con_arity == 0
 889                 labels       = dataConFieldLabels data_con
 890                 lab_fields   = length labels
 891
 892                 show_con
 893                   = let nm = occNameString (getOccName data_con)
 894                         space_ocurly_maybe
 895                           | nullary_con     = ""
 896                           | lab_fields == 0 = " "
 897                           | otherwise       = "{"
 898
 899                     in
 900                         mk_showString_app (nm ++ space_ocurly_maybe)
 901
 902                 show_all con fs
 903                   = let
 904                         ccurly_maybe
 905                           | lab_fields > 0  = [mk_showString_app "}"]
 906                           | otherwise       = []
 907                     in
 908                         con:fs ++ ccurly_maybe
 909
 910                 show_thingies = show_all show_con real_show_thingies_with_labs
 911
 912                 show_label l
 913                   = let nm = occNameString (getOccName (fieldLabelName l))
 914                     in
 915                     mk_showString_app (nm ++ "=")
 916
 917                 mk_showString_app str = HsApp (HsVar showString_RDR)
 918                                               (HsLit (mkHsString str))
 919
 920                 real_show_thingies =
 921                      [ HsApp (HsApp (HsVar showsPrec_RDR) (HsLit (HsInt 10))) (HsVar b)
 922                      | b <- bs_needed ]
 923
 924                 real_show_thingies_with_labs
 925                  | lab_fields == 0 = intersperse (HsVar showSpace_RDR) real_show_thingies
 926                  | otherwise       = --Assumption: no of fields == no of labelled fields
 927                                      --            (and in same order)
 928                     concat $
 929                     intersperse ([mk_showString_app ","]) $ -- Using SLIT()s containing ,s spells trouble.
 930                     zipWithEqual "gen_Show_binds"
 931                                  (\ a b -> [a,b])
 932                                  (map show_label labels)
 933                                  real_show_thingies
 934
 935
 936             in
 937             if nullary_con then  -- skip the showParen junk...
 938                 ASSERT(null bs_needed)
 939                 ([a_Pat, con_pat], show_con)
 940             else
 941                 ([a_Pat, con_pat],
 942                     showParen_Expr (HsPar (genOpApp a_Expr ge_RDR (HsLit (HsInt 10))))
 943                                    (HsPar (nested_compose_Expr show_thingies)))
 944 \end{code}
 945
 946 %************************************************************************
 947 %*                                                                      *
 948 \subsection{Generating extra binds (@con2tag@ and @tag2con@)}
 949 %*                                                                      *
 950 %************************************************************************
 951
 952 \begin{verbatim}
 953 data Foo ... = ...
 954
 955 con2tag_Foo :: Foo ... -> Int#
 956 tag2con_Foo :: Int -> Foo ...   -- easier if Int, not Int#
 957 maxtag_Foo  :: Int              -- ditto (NB: not unboxed)
 958 \end{verbatim}
 959
 960 The `tags' here start at zero, hence the @fIRST_TAG@ (currently one)
 961 fiddling around.
 962
 963 \begin{code}
 964 data TagThingWanted
 965   = GenCon2Tag | GenTag2Con | GenMaxTag
 966
 967 gen_tag_n_con_monobind
 968     :: (RdrName,            -- (proto)Name for the thing in question
 969         TyCon,              -- tycon in question
 970         TagThingWanted)
 971     -> RdrNameMonoBinds
 972
 973 gen_tag_n_con_monobind (rdr_name, tycon, GenCon2Tag)
 974   = mk_FunMonoBind (getSrcLoc tycon) rdr_name (map mk_stuff (tyConDataCons tycon))
 975   where
 976     mk_stuff :: DataCon -> ([RdrNamePat], RdrNameHsExpr)
 977
 978     mk_stuff var
 979       = ([pat], HsLit (HsIntPrim (toInteger ((dataConTag var) - fIRST_TAG))))
 980       where
 981         pat    = ConPatIn var_RDR (nOfThem (argFieldCount var) WildPatIn)
 982         var_RDR = qual_orig_name var
 983
 984 gen_tag_n_con_monobind (rdr_name, tycon, GenTag2Con)
 985   = mk_FunMonoBind (getSrcLoc tycon) rdr_name (map mk_stuff (tyConDataCons tycon) ++
 986                                                              [([WildPatIn], impossible_Expr)])
 987   where
 988     mk_stuff :: DataCon -> ([RdrNamePat], RdrNameHsExpr)
 989     mk_stuff var = ([lit_pat], HsVar var_RDR)
 990       where
 991         lit_pat = ConPatIn mkInt_RDR [LitPatIn (HsIntPrim (toInteger ((dataConTag var) - fIRST_TAG)))]
 992         var_RDR  = qual_orig_name var
 993
 994 gen_tag_n_con_monobind (rdr_name, tycon, GenMaxTag)
 995   = mk_easy_FunMonoBind (getSrcLoc tycon)
 996                 rdr_name [] [] (HsApp (HsVar mkInt_RDR) (HsLit (HsIntPrim max_tag)))
 997   where
 998     max_tag =  case (tyConDataCons tycon) of
 999                  data_cons -> toInteger ((length data_cons) - fIRST_TAG)
1000
1001 \end{code}
1002
1003 %************************************************************************
1004 %*                                                                      *
1005 \subsection{Utility bits for generating bindings}
1006 %*                                                                      *
1007 %************************************************************************
1008
1009 @mk_easy_FunMonoBind fun pats binds expr@ generates:
1010 \begin{verbatim}
1011     fun pat1 pat2 ... patN = expr where binds
1012 \end{verbatim}
1013
1014 @mk_FunMonoBind fun [([p1a, p1b, ...], e1), ...]@ is for
1015 multi-clause definitions; it generates:
1016 \begin{verbatim}
1017     fun p1a p1b ... p1N = e1
1018     fun p2a p2b ... p2N = e2
1019     ...
1020     fun pMa pMb ... pMN = eM
1021 \end{verbatim}
1022
1023 \begin{code}
1024 mk_easy_FunMonoBind :: SrcLoc -> RdrName -> [RdrNamePat]
1025                     -> [RdrNameMonoBinds] -> RdrNameHsExpr
1026                     -> RdrNameMonoBinds
1027
1028 mk_easy_FunMonoBind loc fun pats binds expr
1029   = FunMonoBind fun False{-not infix-} [mk_easy_Match loc pats binds expr] loc
1030
1031 mk_easy_Match loc pats binds expr
1032   = mk_match loc pats expr (mkbind binds)
1033   where
1034     mkbind [] = EmptyBinds
1035     mkbind bs = MonoBind (foldr1 AndMonoBinds bs) [] Recursive
1036         -- The renamer expects everything in its input to be a
1037         -- "recursive" MonoBinds, and it is its job to sort things out
1038         -- from there.
1039
1040 mk_FunMonoBind  :: SrcLoc -> RdrName
1041                 -> [([RdrNamePat], RdrNameHsExpr)]
1042                 -> RdrNameMonoBinds
1043
1044 mk_FunMonoBind loc fun [] = panic "TcGenDeriv:mk_FunMonoBind"
1045 mk_FunMonoBind loc fun pats_and_exprs
1046   = FunMonoBind fun False{-not infix-}
1047                 [ mk_match loc p e EmptyBinds | (p,e) <-pats_and_exprs ]
1048                 loc
1049
1050 mk_match loc pats expr binds
1051   = Match [] (map paren pats) Nothing
1052           (GRHSs (unguardedRHS expr loc) binds Nothing)
1053   where
1054     paren p@(VarPatIn _) = p
1055     paren other_p        = ParPatIn other_p
1056 \end{code}
1057
1058 \begin{code}
1059 mk_easy_App f xs = foldl HsApp (HsVar f) (map HsVar xs)
1060 \end{code}
1061
1062 ToDo: Better SrcLocs.
1063
1064 \begin{code}
1065 compare_Case ::
1066           RdrNameHsExpr -> RdrNameHsExpr -> RdrNameHsExpr
1067           -> RdrNameHsExpr -> RdrNameHsExpr
1068           -> RdrNameHsExpr
1069 compare_gen_Case ::
1070           RdrName
1071           -> RdrNameHsExpr -> RdrNameHsExpr -> RdrNameHsExpr
1072           -> RdrNameHsExpr -> RdrNameHsExpr
1073           -> RdrNameHsExpr
1074 careful_compare_Case :: -- checks for primitive types...
1075           Type
1076           -> RdrNameHsExpr -> RdrNameHsExpr -> RdrNameHsExpr
1077           -> RdrNameHsExpr -> RdrNameHsExpr
1078           -> RdrNameHsExpr
1079
1080 compare_Case = compare_gen_Case compare_RDR
1081 cmp_eq_Expr a b = HsApp (HsApp (HsVar cmp_eq_RDR) a) b
1082         -- Was: compare_gen_Case cmp_eq_RDR
1083
1084 compare_gen_Case fun lt eq gt a b
1085   = HsCase (HsPar (HsApp (HsApp (HsVar fun) a) b)) {-of-}
1086       [mkSimpleMatch [ConPatIn ltTag_RDR []] lt Nothing mkGeneratedSrcLoc,
1087        mkSimpleMatch [ConPatIn eqTag_RDR []] eq Nothing mkGeneratedSrcLoc,
1088        mkSimpleMatch [ConPatIn gtTag_RDR []] gt Nothing mkGeneratedSrcLoc]
1089       mkGeneratedSrcLoc
1090
1091 careful_compare_Case ty lt eq gt a b
1092   = if not (isUnboxedType ty) then
1093        compare_gen_Case compare_RDR lt eq gt a b
1094
1095     else -- we have to do something special for primitive things...
1096        HsIf (genOpApp a relevant_eq_op b)
1097             eq
1098             (HsIf (genOpApp a relevant_lt_op b) lt gt mkGeneratedSrcLoc)
1099             mkGeneratedSrcLoc
1100   where
1101     relevant_eq_op = assoc_ty_id eq_op_tbl ty
1102     relevant_lt_op = assoc_ty_id lt_op_tbl ty
1103
1104 assoc_ty_id tyids ty
1105   = if null res then panic "assoc_ty"
1106     else head res
1107   where
1108     res = [id | (ty',id) <- tyids, ty == ty']
1109
1110 eq_op_tbl =
1111     [(charPrimTy,       eqH_Char_RDR)
1112     ,(intPrimTy,        eqH_Int_RDR)
1113     ,(wordPrimTy,       eqH_Word_RDR)
1114     ,(addrPrimTy,       eqH_Addr_RDR)
1115     ,(floatPrimTy,      eqH_Float_RDR)
1116     ,(doublePrimTy,     eqH_Double_RDR)
1117     ]
1118
1119 lt_op_tbl =
1120     [(charPrimTy,       ltH_Char_RDR)
1121     ,(intPrimTy,        ltH_Int_RDR)
1122     ,(wordPrimTy,       ltH_Word_RDR)
1123     ,(addrPrimTy,       ltH_Addr_RDR)
1124     ,(floatPrimTy,      ltH_Float_RDR)
1125     ,(doublePrimTy,     ltH_Double_RDR)
1126     ]
1127
1128 -----------------------------------------------------------------------
1129
1130 and_Expr, append_Expr :: RdrNameHsExpr -> RdrNameHsExpr -> RdrNameHsExpr
1131
1132 and_Expr    a b = genOpApp a and_RDR    b
1133 append_Expr a b = genOpApp a append_RDR b
1134
1135 -----------------------------------------------------------------------
1136
1137 eq_Expr :: Type -> RdrNameHsExpr -> RdrNameHsExpr -> RdrNameHsExpr
1138 eq_Expr ty a b
1139   = if not (isUnboxedType ty) then
1140        genOpApp a eq_RDR  b
1141     else -- we have to do something special for primitive things...
1142        genOpApp a relevant_eq_op b
1143   where
1144     relevant_eq_op = assoc_ty_id eq_op_tbl ty
1145 \end{code}
1146
1147 \begin{code}
1148 argFieldCount :: DataCon -> Int -- Works on data and newtype constructors
1149 argFieldCount con = length (dataConRawArgTys con)
1150 \end{code}
1151
1152 \begin{code}
1153 untag_Expr :: TyCon -> [(RdrName, RdrName)] -> RdrNameHsExpr -> RdrNameHsExpr
1154 untag_Expr tycon [] expr = expr
1155 untag_Expr tycon ((untag_this, put_tag_here) : more) expr
1156   = HsCase (HsPar (HsApp (con2tag_Expr tycon) (HsVar untag_this))) {-of-}
1157       [mkSimpleMatch [VarPatIn put_tag_here] (untag_Expr tycon more expr) Nothing mkGeneratedSrcLoc]
1158       mkGeneratedSrcLoc
1159
1160 cmp_tags_Expr :: RdrName                -- Comparison op
1161              -> RdrName -> RdrName      -- Things to compare
1162              -> RdrNameHsExpr           -- What to return if true
1163              -> RdrNameHsExpr           -- What to return if false
1164              -> RdrNameHsExpr
1165
1166 cmp_tags_Expr op a b true_case false_case
1167   = HsIf (genOpApp (HsVar a) op (HsVar b)) true_case false_case mkGeneratedSrcLoc
1168
1169 enum_from_to_Expr
1170         :: RdrNameHsExpr -> RdrNameHsExpr
1171         -> RdrNameHsExpr
1172 enum_from_then_to_Expr
1173         :: RdrNameHsExpr -> RdrNameHsExpr -> RdrNameHsExpr
1174         -> RdrNameHsExpr
1175
1176 enum_from_to_Expr      f   t2 = HsApp (HsApp (HsVar enumFromTo_RDR) f) t2
1177 enum_from_then_to_Expr f t t2 = HsApp (HsApp (HsApp (HsVar enumFromThenTo_RDR) f) t) t2
1178
1179 showParen_Expr, readParen_Expr
1180         :: RdrNameHsExpr -> RdrNameHsExpr
1181         -> RdrNameHsExpr
1182
1183 showParen_Expr e1 e2 = HsApp (HsApp (HsVar showParen_RDR) e1) e2
1184 readParen_Expr e1 e2 = HsApp (HsApp (HsVar readParen_RDR) e1) e2
1185
1186 nested_compose_Expr :: [RdrNameHsExpr] -> RdrNameHsExpr
1187
1188 nested_compose_Expr [e] = parenify e
1189 nested_compose_Expr (e:es)
1190   = HsApp (HsApp (HsVar compose_RDR) (parenify e)) (nested_compose_Expr es)
1191
1192 -- impossible_Expr is used in case RHSs that should never happen.
1193 -- We generate these to keep the desugarer from complaining that they *might* happen!
1194 impossible_Expr = HsApp (HsVar error_RDR) (HsLit (HsString (_PK_ "Urk! in TcGenDeriv")))
1195
1196 -- illegal_Expr is used when signalling error conditions in the RHS of a derived
1197 -- method. It is currently only used by Enum.{succ,pred}
1198 illegal_Expr meth tp msg =
1199    HsApp (HsVar error_RDR) (HsLit (HsString (_PK_ (meth ++ '{':tp ++ "}: " ++ msg))))
1200
1201 -- illegal_toEnum_tag is an extended version of illegal_Expr, which also allows you
1202 -- to include the value of a_RDR in the error string.
1203 illegal_toEnum_tag tp maxtag =
1204    HsApp (HsVar error_RDR)
1205          (HsApp (HsApp (HsVar append_RDR)
1206                        (HsLit (HsString (_PK_ ("toEnum{" ++ tp ++ "}: tag (")))))
1207                        (HsApp (HsApp (HsApp
1208                            (HsVar showsPrec_RDR)
1209                            (HsLit (HsInt 0)))
1210                            (HsVar a_RDR))
1211                            (HsApp (HsApp
1212                                (HsVar append_RDR)
1213                                (HsLit (HsString (_PK_ ") is outside of enumeration's range (0,"))))
1214                                (HsApp (HsApp (HsApp
1215                                         (HsVar showsPrec_RDR)
1216                                         (HsLit (HsInt 0)))
1217                                         (HsVar maxtag))
1218                                         (HsLit (HsString (_PK_ ")")))))))
1219
1220 parenify e@(HsVar _) = e
1221 parenify e           = HsPar e
1222
1223 -- genOpApp wraps brackets round the operator application, so that the
1224 -- renamer won't subsequently try to re-associate it.
1225 -- For some reason the renamer doesn't reassociate it right, and I can't
1226 -- be bothered to find out why just now.
1227
1228 genOpApp e1 op e2 = mkOpApp e1 op e2
1229 \end{code}
1230
1231 \begin{code}
1232 qual_orig_name n = case modAndOcc n of { (m,n) -> Qual m n HiFile }
1233
1234 a_RDR           = varUnqual SLIT("a")
1235 b_RDR           = varUnqual SLIT("b")
1236 c_RDR           = varUnqual SLIT("c")
1237 d_RDR           = varUnqual SLIT("d")
1238 ah_RDR          = varUnqual SLIT("a#")
1239 bh_RDR          = varUnqual SLIT("b#")
1240 ch_RDR          = varUnqual SLIT("c#")
1241 dh_RDR          = varUnqual SLIT("d#")
1242 cmp_eq_RDR      = varUnqual SLIT("cmp_eq")
1243 rangeSize_RDR   = varUnqual SLIT("rangeSize")
1244
1245 as_RDRs         = [ varUnqual (_PK_ ("a"++show i)) | i <- [(1::Int) .. ] ]
1246 bs_RDRs         = [ varUnqual (_PK_ ("b"++show i)) | i <- [(1::Int) .. ] ]
1247 cs_RDRs         = [ varUnqual (_PK_ ("c"++show i)) | i <- [(1::Int) .. ] ]
1248
1249 mkHsString s = HsString (_PK_ s)
1250
1251 a_Expr          = HsVar a_RDR
1252 b_Expr          = HsVar b_RDR
1253 c_Expr          = HsVar c_RDR
1254 d_Expr          = HsVar d_RDR
1255 ltTag_Expr      = HsVar ltTag_RDR
1256 eqTag_Expr      = HsVar eqTag_RDR
1257 gtTag_Expr      = HsVar gtTag_RDR
1258 false_Expr      = HsVar false_RDR
1259 true_Expr       = HsVar true_RDR
1260
1261 con2tag_Expr tycon = HsVar (con2tag_RDR tycon)
1262
1263 a_Pat           = VarPatIn a_RDR
1264 b_Pat           = VarPatIn b_RDR
1265 c_Pat           = VarPatIn c_RDR
1266 d_Pat           = VarPatIn d_RDR
1267
1268 con2tag_RDR, tag2con_RDR, maxtag_RDR :: TyCon -> RdrName
1269
1270 con2tag_RDR tycon = varUnqual (_PK_ ("con2tag_" ++ occNameString (getOccName tycon) ++ "#"))
1271 tag2con_RDR tycon = varUnqual (_PK_ ("tag2con_" ++ occNameString (getOccName tycon) ++ "#"))
1272 maxtag_RDR tycon  = varUnqual (_PK_ ("maxtag_"  ++ occNameString (getOccName tycon) ++ "#"))
1273 \end{code}