compiler/typecheck/Inst.lhs

   1 %
   2 % (c) The University of Glasgow 2006
   3 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   4 %
   5
   6 The @Inst@ type: dictionaries or method instances
   7
   8 \begin{code}
   9 {-# OPTIONS -w #-}
  10 -- The above warning supression flag is a temporary kludge.
  11 -- While working on this module you are encouraged to remove it and fix
  12 -- any warnings in the module. See
  13 --     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
  14 -- for details
  15
  16 module Inst (
  17         Inst,
  18
  19         pprInstances, pprDictsTheta, pprDictsInFull,    -- User error messages
  20         showLIE, pprInst, pprInsts, pprInstInFull,      -- Debugging messages
  21
  22         tidyInsts, tidyMoreInsts,
  23
  24         newDictBndr, newDictBndrs, newDictBndrsO,
  25         instCall, instStupidTheta,
  26         cloneDict,
  27         shortCutFracLit, shortCutIntLit, shortCutStringLit, newIPDict,
  28         newMethod, newMethodFromName, newMethodWithGivenTy,
  29         tcInstClassOp,
  30         tcSyntaxName, isHsVar,
  31
  32         tyVarsOfInst, tyVarsOfInsts, tyVarsOfLIE,
  33         ipNamesOfInst, ipNamesOfInsts, fdPredsOfInst, fdPredsOfInsts,
  34         getDictClassTys, dictPred,
  35
  36         lookupSimpleInst, LookupInstResult(..),
  37         tcExtendLocalInstEnv, tcGetInstEnvs, getOverlapFlag,
  38
  39         isAbstractableInst, isEqInst,
  40         isDict, isClassDict, isMethod, isImplicInst,
  41         isIPDict, isInheritableInst, isMethodOrLit,
  42         isTyVarDict, isMethodFor,
  43
  44         zonkInst, zonkInsts,
  45         instToId, instToVar, instType, instName, instToDictBind,
  46         addInstToDictBind,
  47
  48         InstOrigin(..), InstLoc, pprInstLoc,
  49
  50         mkWantedCo, mkGivenCo,
  51         fromWantedCo, fromGivenCo,
  52         eitherEqInst, mkEqInst, mkEqInsts, mkWantedEqInst,
  53         finalizeEqInst, writeWantedCoercion,
  54         eqInstType, updateEqInstCoercion,
  55         eqInstCoercion, eqInstTys
  56     ) where
  57
  58 #include "HsVersions.h"
  59
  60 import {-# SOURCE #-}   TcExpr( tcPolyExpr )
  61 import {-# SOURCE #-}   TcUnify( boxyUnify, unifyType )
  62
  63 import FastString
  64 import HsSyn
  65 import TcHsSyn
  66 import TcRnMonad
  67 import TcEnv
  68 import InstEnv
  69 import FunDeps
  70 import TcMType
  71 import TcType
  72 import Type
  73 import TypeRep
  74 import Class
  75 import Unify
  76 import Module
  77 import Coercion
  78 import HscTypes
  79 import CoreFVs
  80 import DataCon
  81 import Id
  82 import Name
  83 import NameSet
  84 import Literal
  85 import Var      ( Var, TyVar )
  86 import qualified Var
  87 import VarEnv
  88 import VarSet
  89 import TysWiredIn
  90 import PrelNames
  91 import BasicTypes
  92 import SrcLoc
  93 import DynFlags
  94 import Bag
  95 import Maybes
  96 import Util
  97 import Unique
  98 import Outputable
  99 import Data.List
 100 import TypeRep
 101 import Class
 102
 103 import Control.Monad
 104 \end{code}
 105
 106
 107 Selection
 108 ~~~~~~~~~
 109 \begin{code}
 110 instName :: Inst -> Name
 111 instName (EqInst {tci_name = name}) = name
 112 instName inst = Var.varName (instToVar inst)
 113
 114 instToId :: Inst -> TcId
 115 instToId inst = WARN( not (isId id), ppr inst )
 116               id
 117               where
 118                 id = instToVar inst
 119
 120 instToVar :: Inst -> Var
 121 instToVar (LitInst {tci_name = nm, tci_ty = ty})
 122   = mkLocalId nm ty
 123 instToVar (Method {tci_id = id})
 124   = id
 125 instToVar (Dict {tci_name = nm, tci_pred = pred})
 126   | isEqPred pred = Var.mkCoVar nm (mkPredTy pred)
 127   | otherwise     = mkLocalId nm (mkPredTy pred)
 128 instToVar (ImplicInst {tci_name = nm, tci_tyvars = tvs, tci_given = givens,
 129                        tci_wanted = wanteds})
 130   = mkLocalId nm (mkImplicTy tvs givens wanteds)
 131 instToVar i@(EqInst {})
 132   = eitherEqInst i id (\(TyVarTy covar) -> covar)
 133
 134 instType :: Inst -> Type
 135 instType (LitInst {tci_ty = ty})  = ty
 136 instType (Method {tci_id = id})   = idType id
 137 instType (Dict {tci_pred = pred}) = mkPredTy pred
 138 instType imp@(ImplicInst {})      = mkImplicTy (tci_tyvars imp) (tci_given imp)
 139                                                (tci_wanted imp)
 140 -- instType i@(EqInst {tci_co = co}) = eitherEqInst i TyVarTy id
 141 instType (EqInst {tci_left = ty1, tci_right = ty2}) = mkPredTy (EqPred ty1 ty2)
 142
 143 mkImplicTy tvs givens wanteds   -- The type of an implication constraint
 144   = ASSERT( all isAbstractableInst givens )
 145     -- pprTrace "mkImplicTy" (ppr givens) $
 146     -- See [Equational Constraints in Implication Constraints]
 147     let dict_wanteds = filter (not . isEqInst) wanteds
 148     in
 149       mkForAllTys tvs $
 150       mkPhiTy (map dictPred givens) $
 151       if isSingleton dict_wanteds then
 152         instType (head dict_wanteds)
 153       else
 154         mkTupleTy Boxed (length dict_wanteds) (map instType dict_wanteds)
 155
 156 dictPred (Dict {tci_pred = pred}) = pred
 157 dictPred (EqInst {tci_left=ty1,tci_right=ty2}) = EqPred ty1 ty2
 158 dictPred inst                     = pprPanic "dictPred" (ppr inst)
 159
 160 getDictClassTys (Dict {tci_pred = pred}) = getClassPredTys pred
 161 getDictClassTys inst                     = pprPanic "getDictClassTys" (ppr inst)
 162
 163 -- fdPredsOfInst is used to get predicates that contain functional
 164 -- dependencies *or* might do so.  The "might do" part is because
 165 -- a constraint (C a b) might have a superclass with FDs
 166 -- Leaving these in is really important for the call to fdPredsOfInsts
 167 -- in TcSimplify.inferLoop, because the result is fed to 'grow',
 168 -- which is supposed to be conservative
 169 fdPredsOfInst (Dict {tci_pred = pred})       = [pred]
 170 fdPredsOfInst (Method {tci_theta = theta})   = theta
 171 fdPredsOfInst (ImplicInst {tci_given = gs,
 172                            tci_wanted = ws}) = fdPredsOfInsts (gs ++ ws)
 173 fdPredsOfInst (LitInst {})                   = []
 174 fdPredsOfInst (EqInst {})                    = []
 175
 176 fdPredsOfInsts :: [Inst] -> [PredType]
 177 fdPredsOfInsts insts = concatMap fdPredsOfInst insts
 178
 179 isInheritableInst (Dict {tci_pred = pred})     = isInheritablePred pred
 180 isInheritableInst (Method {tci_theta = theta}) = all isInheritablePred theta
 181 isInheritableInst other                        = True
 182
 183
 184 ---------------------------------
 185 -- Get the implicit parameters mentioned by these Insts
 186 -- NB: the results of these functions are insensitive to zonking
 187
 188 ipNamesOfInsts :: [Inst] -> [Name]
 189 ipNamesOfInst  :: Inst   -> [Name]
 190 ipNamesOfInsts insts = [n | inst <- insts, n <- ipNamesOfInst inst]
 191
 192 ipNamesOfInst (Dict {tci_pred = IParam n _}) = [ipNameName n]
 193 ipNamesOfInst (Method {tci_theta = theta})   = [ipNameName n | IParam n _ <- theta]
 194 ipNamesOfInst other                          = []
 195
 196 ---------------------------------
 197 tyVarsOfInst :: Inst -> TcTyVarSet
 198 tyVarsOfInst (LitInst {tci_ty = ty})  = tyVarsOfType  ty
 199 tyVarsOfInst (Dict {tci_pred = pred}) = tyVarsOfPred pred
 200 tyVarsOfInst (Method {tci_oid = id, tci_tys = tys}) = tyVarsOfTypes tys `unionVarSet` varTypeTyVars id
 201                                  -- The id might have free type variables; in the case of
 202                                  -- locally-overloaded class methods, for example
 203 tyVarsOfInst (ImplicInst {tci_tyvars = tvs, tci_given = givens, tci_wanted = wanteds})
 204   = (tyVarsOfInsts givens `unionVarSet` tyVarsOfInsts wanteds)
 205     `minusVarSet` mkVarSet tvs
 206     `unionVarSet` unionVarSets (map varTypeTyVars tvs)
 207                 -- Remember the free tyvars of a coercion
 208 tyVarsOfInst (EqInst {tci_left = ty1, tci_right = ty2}) = tyVarsOfType ty1 `unionVarSet` tyVarsOfType ty2
 209
 210 tyVarsOfInsts insts = foldr (unionVarSet . tyVarsOfInst) emptyVarSet insts
 211 tyVarsOfLIE   lie   = tyVarsOfInsts (lieToList lie)
 212
 213
 214 --------------------------
 215 instToDictBind :: Inst -> LHsExpr TcId -> TcDictBinds
 216 instToDictBind inst rhs
 217   = unitBag (L (instSpan inst) (VarBind (instToId inst) rhs))
 218
 219 addInstToDictBind :: TcDictBinds -> Inst -> LHsExpr TcId -> TcDictBinds
 220 addInstToDictBind binds inst rhs = binds `unionBags` instToDictBind inst rhs
 221 \end{code}
 222
 223 Predicates
 224 ~~~~~~~~~~
 225 \begin{code}
 226
 227 isAbstractableInst :: Inst -> Bool
 228 isAbstractableInst inst = isDict inst || isEqInst inst
 229
 230 isEqInst :: Inst -> Bool
 231 isEqInst (EqInst {}) = True
 232 isEqInst other       = False
 233
 234 isDict :: Inst -> Bool
 235 isDict (Dict {}) = True
 236 isDict other     = False
 237
 238 isClassDict :: Inst -> Bool
 239 isClassDict (Dict {tci_pred = pred}) = isClassPred pred
 240 isClassDict other                    = False
 241
 242 isTyVarDict :: Inst -> Bool
 243 isTyVarDict (Dict {tci_pred = pred}) = isTyVarClassPred pred
 244 isTyVarDict other                    = False
 245
 246 isIPDict :: Inst -> Bool
 247 isIPDict (Dict {tci_pred = pred}) = isIPPred pred
 248 isIPDict other                    = False
 249
 250 isImplicInst (ImplicInst {}) = True
 251 isImplicInst other           = False
 252
 253 isMethod :: Inst -> Bool
 254 isMethod (Method {}) = True
 255 isMethod other       = False
 256
 257 isMethodFor :: TcIdSet -> Inst -> Bool
 258 isMethodFor ids (Method {tci_oid = id}) = id `elemVarSet` ids
 259 isMethodFor ids inst                    = False
 260
 261 isMethodOrLit :: Inst -> Bool
 262 isMethodOrLit (Method {})  = True
 263 isMethodOrLit (LitInst {}) = True
 264 isMethodOrLit other        = False
 265 \end{code}
 266
 267
 268 %************************************************************************
 269 %*                                                                      *
 270 \subsection{Building dictionaries}
 271 %*                                                                      *
 272 %************************************************************************
 273
 274 -- newDictBndrs makes a dictionary at a binding site
 275 -- instCall makes a dictionary at an occurrence site
 276 --      and throws it into the LIE
 277
 278 \begin{code}
 279 ----------------
 280 newDictBndrsO :: InstOrigin -> TcThetaType -> TcM [Inst]
 281 newDictBndrsO orig theta = do { loc <- getInstLoc orig
 282                               ; newDictBndrs loc theta }
 283
 284 newDictBndrs :: InstLoc -> TcThetaType -> TcM [Inst]
 285 newDictBndrs inst_loc theta = mapM (newDictBndr inst_loc) theta
 286
 287 newDictBndr :: InstLoc -> TcPredType -> TcM Inst
 288 newDictBndr inst_loc pred@(EqPred ty1 ty2)
 289   = do { uniq <- newUnique
 290         ; let name = mkPredName uniq inst_loc pred
 291         ; return (EqInst {tci_name  = name,
 292                           tci_loc   = inst_loc,
 293                           tci_left  = ty1,
 294                           tci_right = ty2,
 295                           tci_co    = mkGivenCo $ TyVarTy (Var.mkCoVar name (PredTy pred))})
 296        }
 297 newDictBndr inst_loc pred
 298   = do  { uniq <- newUnique
 299         ; let name = mkPredName uniq inst_loc pred
 300         ; return (Dict {tci_name = name, tci_pred = pred, tci_loc = inst_loc}) }
 301
 302 ----------------
 303 instCall :: InstOrigin -> [TcType] -> TcThetaType -> TcM HsWrapper
 304 -- Instantiate the constraints of a call
 305 --      (instCall o tys theta)
 306 -- (a) Makes fresh dictionaries as necessary for the constraints (theta)
 307 -- (b) Throws these dictionaries into the LIE
 308 -- (c) Returns an HsWrapper ([.] tys dicts)
 309
 310 instCall orig tys theta
 311   = do  { loc <- getInstLoc orig
 312         ; dict_app <- instCallDicts loc theta
 313         ; return (dict_app <.> mkWpTyApps tys) }
 314
 315 ----------------
 316 instStupidTheta :: InstOrigin -> TcThetaType -> TcM ()
 317 -- Similar to instCall, but only emit the constraints in the LIE
 318 -- Used exclusively for the 'stupid theta' of a data constructor
 319 instStupidTheta orig theta
 320   = do  { loc <- getInstLoc orig
 321         ; _co <- instCallDicts loc theta        -- Discard the coercion
 322         ; return () }
 323
 324 ----------------
 325 instCallDicts :: InstLoc -> TcThetaType -> TcM HsWrapper
 326 -- Instantiates the TcTheta, puts all constraints thereby generated
 327 -- into the LIE, and returns a HsWrapper to enclose the call site.
 328 -- This is the key place where equality predicates
 329 -- are unleashed into the world
 330 instCallDicts loc [] = return idHsWrapper
 331
 332 -- instCallDicts loc (EqPred ty1 ty2 : preds)
 333 --   = do  { unifyType ty1 ty2  -- For now, we insist that they unify right away
 334 --                              -- Later on, when we do associated types,
 335 --                              -- unifyType :: Type -> Type -> TcM ([Inst], Coercion)
 336 --      ; (dicts, co_fn) <- instCallDicts loc preds
 337 --      ; return (dicts, co_fn <.> WpTyApp ty1) }
 338 --      -- We use type application to apply the function to the
 339 --      -- coercion; here ty1 *is* the appropriate identity coercion
 340
 341 instCallDicts loc (EqPred ty1 ty2 : preds)
 342   = do  { traceTc (text "instCallDicts" <+> ppr (EqPred ty1 ty2))
 343         ; coi <- boxyUnify ty1 ty2
 344 --      ; coi <- unifyType ty1 ty2
 345         ; let co = fromCoI coi ty1
 346         ; co_fn <- instCallDicts loc preds
 347         ; return (co_fn <.> WpTyApp co) }
 348
 349 instCallDicts loc (pred : preds)
 350   = do  { uniq <- newUnique
 351         ; let name = mkPredName uniq loc pred
 352               dict = Dict {tci_name = name, tci_pred = pred, tci_loc = loc}
 353         ; extendLIE dict
 354         ; co_fn <- instCallDicts loc preds
 355         ; return (co_fn <.> WpApp (instToId dict)) }
 356
 357 -------------
 358 cloneDict :: Inst -> TcM Inst
 359 cloneDict dict@(Dict nm ty loc) = do { uniq <- newUnique
 360                                      ; return (dict {tci_name = setNameUnique nm uniq}) }
 361 cloneDict eq@(EqInst {})        = return eq
 362 cloneDict other = pprPanic "cloneDict" (ppr other)
 363
 364 -- For vanilla implicit parameters, there is only one in scope
 365 -- at any time, so we used to use the name of the implicit parameter itself
 366 -- But with splittable implicit parameters there may be many in
 367 -- scope, so we make up a new namea.
 368 newIPDict :: InstOrigin -> IPName Name -> Type
 369           -> TcM (IPName Id, Inst)
 370 newIPDict orig ip_name ty = do
 371     inst_loc <- getInstLoc orig
 372     uniq <- newUnique
 373     let
 374         pred = IParam ip_name ty
 375         name = mkPredName uniq inst_loc pred
 376         dict = Dict {tci_name = name, tci_pred = pred, tci_loc = inst_loc}
 377
 378     return (mapIPName (\n -> instToId dict) ip_name, dict)
 379 \end{code}
 380
 381
 382 \begin{code}
 383 mkPredName :: Unique -> InstLoc -> PredType -> Name
 384 mkPredName uniq loc pred_ty
 385   = mkInternalName uniq occ (instLocSpan loc)
 386   where
 387     occ = case pred_ty of
 388             ClassP cls _ -> mkDictOcc (getOccName cls)
 389             IParam ip  _ -> getOccName (ipNameName ip)
 390             EqPred ty  _ -> mkEqPredCoOcc baseOcc
 391               where
 392                 -- we use the outermost tycon of the lhs, if there is one, to
 393                 -- improve readability of Core code
 394                 baseOcc = case splitTyConApp_maybe ty of
 395                             Nothing      -> mkOccName tcName "$"
 396                             Just (tc, _) -> getOccName tc
 397 \end{code}
 398
 399 %************************************************************************
 400 %*                                                                      *
 401 \subsection{Building methods (calls of overloaded functions)}
 402 %*                                                                      *
 403 %************************************************************************
 404
 405
 406 \begin{code}
 407 newMethodFromName :: InstOrigin -> BoxyRhoType -> Name -> TcM TcId
 408 newMethodFromName origin ty name = do
 409     id <- tcLookupId name
 410         -- Use tcLookupId not tcLookupGlobalId; the method is almost
 411         -- always a class op, but with -fno-implicit-prelude GHC is
 412         -- meant to find whatever thing is in scope, and that may
 413         -- be an ordinary function.
 414     loc <- getInstLoc origin
 415     inst <- tcInstClassOp loc id [ty]
 416     extendLIE inst
 417     return (instToId inst)
 418
 419 newMethodWithGivenTy orig id tys = do
 420     loc <- getInstLoc orig
 421     inst <- newMethod loc id tys
 422     extendLIE inst
 423     return (instToId inst)
 424
 425 --------------------------------------------
 426 -- tcInstClassOp, and newMethod do *not* drop the
 427 -- Inst into the LIE; they just returns the Inst
 428 -- This is important because they are used by TcSimplify
 429 -- to simplify Insts
 430
 431 -- NB: the kind of the type variable to be instantiated
 432 --     might be a sub-kind of the type to which it is applied,
 433 --     notably when the latter is a type variable of kind ??
 434 --     Hence the call to checkKind
 435 -- A worry: is this needed anywhere else?
 436 tcInstClassOp :: InstLoc -> Id -> [TcType] -> TcM Inst
 437 tcInstClassOp inst_loc sel_id tys = do
 438     let
 439         (tyvars, _rho) = tcSplitForAllTys (idType sel_id)
 440     zipWithM_ checkKind tyvars tys
 441     newMethod inst_loc sel_id tys
 442
 443 checkKind :: TyVar -> TcType -> TcM ()
 444 -- Ensure that the type has a sub-kind of the tyvar
 445 checkKind tv ty
 446   = do  { let ty1 = ty
 447                 -- ty1 <- zonkTcType ty
 448         ; if typeKind ty1 `isSubKind` Var.tyVarKind tv
 449           then return ()
 450           else
 451
 452     pprPanic "checkKind: adding kind constraint"
 453              (vcat [ppr tv <+> ppr (Var.tyVarKind tv),
 454                     ppr ty <+> ppr ty1 <+> ppr (typeKind ty1)])
 455         }
 456 --    do        { tv1 <- tcInstTyVar tv
 457 --      ; unifyType ty1 (mkTyVarTy tv1) } }
 458
 459
 460 ---------------------------
 461 newMethod inst_loc id tys = do
 462     new_uniq <- newUnique
 463     let
 464         (theta,tau) = tcSplitPhiTy (applyTys (idType id) tys)
 465         meth_id     = mkUserLocal (mkMethodOcc (getOccName id)) new_uniq tau loc
 466         inst        = Method {tci_id = meth_id, tci_oid = id, tci_tys = tys,
 467                               tci_theta = theta, tci_loc = inst_loc}
 468         loc         = instLocSpan inst_loc
 469
 470     return inst
 471 \end{code}
 472
 473 \begin{code}
 474 shortCutIntLit :: Integer -> TcType -> Maybe (HsExpr TcId)
 475 shortCutIntLit i ty
 476   | isIntTy ty && inIntRange i = Just (HsLit (HsInt i))
 477   | isIntegerTy ty             = Just (HsLit (HsInteger i ty))
 478   | otherwise                  = shortCutFracLit (fromInteger i) ty
 479         -- The 'otherwise' case is important
 480         -- Consider (3 :: Float).  Syntactically it looks like an IntLit,
 481         -- so we'll call shortCutIntLit, but of course it's a float
 482         -- This can make a big difference for programs with a lot of
 483         -- literals, compiled without -O
 484
 485 shortCutFracLit :: Rational -> TcType -> Maybe (HsExpr TcId)
 486 shortCutFracLit f ty
 487   | isFloatTy ty  = Just (mk_lit floatDataCon  (HsFloatPrim f))
 488   | isDoubleTy ty = Just (mk_lit doubleDataCon (HsDoublePrim f))
 489   | otherwise     = Nothing
 490   where
 491     mk_lit con lit = HsApp (nlHsVar (dataConWrapId con)) (nlHsLit lit)
 492
 493 shortCutStringLit :: FastString -> TcType -> Maybe (HsExpr TcId)
 494 shortCutStringLit s ty
 495   | isStringTy ty                       -- Short cut for String
 496   = Just (HsLit (HsString s))
 497   | otherwise = Nothing
 498
 499 mkIntegerLit :: Integer -> TcM (LHsExpr TcId)
 500 mkIntegerLit i = do
 501     integer_ty <- tcMetaTy integerTyConName
 502     span <- getSrcSpanM
 503     return (L span $ HsLit (HsInteger i integer_ty))
 504
 505 mkRatLit :: Rational -> TcM (LHsExpr TcId)
 506 mkRatLit r = do
 507     rat_ty <- tcMetaTy rationalTyConName
 508     span <- getSrcSpanM
 509     return (L span $ HsLit (HsRat r rat_ty))
 510
 511 mkStrLit :: FastString -> TcM (LHsExpr TcId)
 512 mkStrLit s = do
 513     --string_ty <- tcMetaTy stringTyConName
 514     span <- getSrcSpanM
 515     return (L span $ HsLit (HsString s))
 516
 517 isHsVar :: HsExpr Name -> Name -> Bool
 518 isHsVar (HsVar f) g = f==g
 519 isHsVar other     g = False
 520 \end{code}
 521
 522
 523 %************************************************************************
 524 %*                                                                      *
 525 \subsection{Zonking}
 526 %*                                                                      *
 527 %************************************************************************
 528
 529 Zonking makes sure that the instance types are fully zonked.
 530
 531 \begin{code}
 532 zonkInst :: Inst -> TcM Inst
 533 zonkInst dict@(Dict { tci_pred = pred}) = do
 534     new_pred <- zonkTcPredType pred
 535     return (dict {tci_pred = new_pred})
 536
 537 zonkInst meth@(Method {tci_oid = id, tci_tys = tys, tci_theta = theta}) = do
 538     new_id <- zonkId id
 539         -- Essential to zonk the id in case it's a local variable
 540         -- Can't use zonkIdOcc because the id might itself be
 541         -- an InstId, in which case it won't be in scope
 542
 543     new_tys <- zonkTcTypes tys
 544     new_theta <- zonkTcThetaType theta
 545     return (meth { tci_oid = new_id, tci_tys = new_tys, tci_theta = new_theta })
 546         -- No need to zonk the tci_id
 547
 548 zonkInst lit@(LitInst {tci_ty = ty}) = do
 549     new_ty <- zonkTcType ty
 550     return (lit {tci_ty = new_ty})
 551
 552 zonkInst implic@(ImplicInst {})
 553   = ASSERT( all isImmutableTyVar (tci_tyvars implic) )
 554     do  { givens'  <- zonkInsts (tci_given  implic)
 555         ; wanteds' <- zonkInsts (tci_wanted implic)
 556         ; return (implic {tci_given = givens',tci_wanted = wanteds'}) }
 557
 558 zonkInst eqinst@(EqInst {tci_left = ty1, tci_right = ty2})
 559   = do { co' <- eitherEqInst eqinst
 560                   (\covar -> return (mkWantedCo covar))
 561                   (\co    -> liftM mkGivenCo $ zonkTcType co)
 562        ; ty1' <- zonkTcType ty1
 563        ; ty2' <- zonkTcType ty2
 564        ; return (eqinst {tci_co = co', tci_left= ty1', tci_right = ty2' })
 565        }
 566
 567 zonkInsts insts = mapM zonkInst insts
 568 \end{code}
 569
 570
 571 %************************************************************************
 572 %*                                                                      *
 573 \subsection{Printing}
 574 %*                                                                      *
 575 %************************************************************************
 576
 577 ToDo: improve these pretty-printing things.  The ``origin'' is really only
 578 relevant in error messages.
 579
 580 \begin{code}
 581 instance Outputable Inst where
 582     ppr inst = pprInst inst
 583
 584 pprDictsTheta :: [Inst] -> SDoc
 585 -- Print in type-like fashion (Eq a, Show b)
 586 -- The Inst can be an implication constraint, but not a Method or LitInst
 587 pprDictsTheta insts = parens (sep (punctuate comma (map (ppr . instType) insts)))
 588
 589 pprDictsInFull :: [Inst] -> SDoc
 590 -- Print in type-like fashion, but with source location
 591 pprDictsInFull dicts
 592   = vcat (map go dicts)
 593   where
 594     go dict = sep [quotes (ppr (instType dict)), nest 2 (pprInstArising dict)]
 595
 596 pprInsts :: [Inst] -> SDoc
 597 -- Debugging: print the evidence :: type
 598 pprInsts insts = brackets (interpp'SP insts)
 599
 600 pprInst, pprInstInFull :: Inst -> SDoc
 601 -- Debugging: print the evidence :: type
 602 pprInst i@(EqInst {tci_left = ty1, tci_right = ty2, tci_co = co})
 603         = eitherEqInst i
 604                 (\covar -> text "Wanted" <+> ppr (TyVarTy covar) <+> dcolon <+> ppr (EqPred ty1 ty2))
 605                 (\co    -> text "Given"  <+> ppr co              <+> dcolon <+> ppr (EqPred ty1 ty2))
 606 pprInst inst = ppr name <> braces (pprUnique (getUnique name)) <+> dcolon
 607                 <+> braces (ppr (instType inst) <> implicWantedEqs)
 608   where
 609     name = instName inst
 610     implicWantedEqs
 611       | isImplicInst inst = text " &" <+>
 612                             ppr (filter isEqInst (tci_wanted inst))
 613       | otherwise         = empty
 614
 615 pprInstInFull inst@(EqInst {}) = pprInst inst
 616 pprInstInFull inst = sep [quotes (pprInst inst), nest 2 (pprInstArising inst)]
 617
 618 tidyInst :: TidyEnv -> Inst -> Inst
 619 tidyInst env eq@(EqInst {tci_left = lty, tci_right = rty, tci_co = co}) =
 620   eq { tci_left  = tidyType env lty
 621      , tci_right = tidyType env rty
 622      , tci_co    = either Left (Right . tidyType env) co
 623      }
 624 tidyInst env lit@(LitInst {tci_ty = ty})   = lit {tci_ty = tidyType env ty}
 625 tidyInst env dict@(Dict {tci_pred = pred}) = dict {tci_pred = tidyPred env pred}
 626 tidyInst env meth@(Method {tci_tys = tys}) = meth {tci_tys = tidyTypes env tys}
 627 tidyInst env implic@(ImplicInst {})
 628   = implic { tci_tyvars = tvs'
 629            , tci_given  = map (tidyInst env') (tci_given  implic)
 630            , tci_wanted = map (tidyInst env') (tci_wanted implic) }
 631   where
 632     (env', tvs') = mapAccumL tidyTyVarBndr env (tci_tyvars implic)
 633
 634 tidyMoreInsts :: TidyEnv -> [Inst] -> (TidyEnv, [Inst])
 635 -- This function doesn't assume that the tyvars are in scope
 636 -- so it works like tidyOpenType, returning a TidyEnv
 637 tidyMoreInsts env insts
 638   = (env', map (tidyInst env') insts)
 639   where
 640     env' = tidyFreeTyVars env (tyVarsOfInsts insts)
 641
 642 tidyInsts :: [Inst] -> (TidyEnv, [Inst])
 643 tidyInsts insts = tidyMoreInsts emptyTidyEnv insts
 644
 645 showLIE :: SDoc -> TcM ()       -- Debugging
 646 showLIE str
 647   = do { lie_var <- getLIEVar ;
 648          lie <- readMutVar lie_var ;
 649          traceTc (str <+> vcat (map pprInstInFull (lieToList lie))) }
 650 \end{code}
 651
 652
 653 %************************************************************************
 654 %*                                                                      *
 655         Extending the instance environment
 656 %*                                                                      *
 657 %************************************************************************
 658
 659 \begin{code}
 660 tcExtendLocalInstEnv :: [Instance] -> TcM a -> TcM a
 661   -- Add new locally-defined instances
 662 tcExtendLocalInstEnv dfuns thing_inside
 663  = do { traceDFuns dfuns
 664       ; env <- getGblEnv
 665       ; inst_env' <- foldlM addLocalInst (tcg_inst_env env) dfuns
 666       ; let env' = env { tcg_insts = dfuns ++ tcg_insts env,
 667                          tcg_inst_env = inst_env' }
 668       ; setGblEnv env' thing_inside }
 669
 670 addLocalInst :: InstEnv -> Instance -> TcM InstEnv
 671 -- Check that the proposed new instance is OK,
 672 -- and then add it to the home inst env
 673 addLocalInst home_ie ispec
 674   = do  {       -- Instantiate the dfun type so that we extend the instance
 675                 -- envt with completely fresh template variables
 676                 -- This is important because the template variables must
 677                 -- not overlap with anything in the things being looked up
 678                 -- (since we do unification).
 679                 -- We use tcInstSkolType because we don't want to allocate fresh
 680                 --  *meta* type variables.
 681           let dfun = instanceDFunId ispec
 682         ; (tvs', theta', tau') <- tcInstSkolType InstSkol (idType dfun)
 683         ; let   (cls, tys') = tcSplitDFunHead tau'
 684                 dfun'       = setIdType dfun (mkSigmaTy tvs' theta' tau')
 685                 ispec'      = setInstanceDFunId ispec dfun'
 686
 687                 -- Load imported instances, so that we report
 688                 -- duplicates correctly
 689         ; eps <- getEps
 690         ; let inst_envs = (eps_inst_env eps, home_ie)
 691
 692                 -- Check functional dependencies
 693         ; case checkFunDeps inst_envs ispec' of
 694                 Just specs -> funDepErr ispec' specs
 695                 Nothing    -> return ()
 696
 697                 -- Check for duplicate instance decls
 698         ; let { (matches, _) = lookupInstEnv inst_envs cls tys'
 699               ; dup_ispecs = [ dup_ispec
 700                              | (dup_ispec, _) <- matches
 701                              , let (_,_,_,dup_tys) = instanceHead dup_ispec
 702                              , isJust (tcMatchTys (mkVarSet tvs') tys' dup_tys)] }
 703                 -- Find memebers of the match list which ispec itself matches.
 704                 -- If the match is 2-way, it's a duplicate
 705         ; case dup_ispecs of
 706             dup_ispec : _ -> dupInstErr ispec' dup_ispec
 707             []            -> return ()
 708
 709                 -- OK, now extend the envt
 710         ; return (extendInstEnv home_ie ispec') }
 711
 712 getOverlapFlag :: TcM OverlapFlag
 713 getOverlapFlag
 714   = do  { dflags <- getDOpts
 715         ; let overlap_ok    = dopt Opt_OverlappingInstances dflags
 716               incoherent_ok = dopt Opt_IncoherentInstances  dflags
 717               overlap_flag | incoherent_ok = Incoherent
 718                            | overlap_ok    = OverlapOk
 719                            | otherwise     = NoOverlap
 720
 721         ; return overlap_flag }
 722
 723 traceDFuns ispecs
 724   = traceTc (hang (text "Adding instances:") 2 (vcat (map pp ispecs)))
 725   where
 726     pp ispec = ppr (instanceDFunId ispec) <+> colon <+> ppr ispec
 727         -- Print the dfun name itself too
 728
 729 funDepErr ispec ispecs
 730   = addDictLoc ispec $
 731     addErr (hang (ptext SLIT("Functional dependencies conflict between instance declarations:"))
 732                2 (pprInstances (ispec:ispecs)))
 733 dupInstErr ispec dup_ispec
 734   = addDictLoc ispec $
 735     addErr (hang (ptext SLIT("Duplicate instance declarations:"))
 736                2 (pprInstances [ispec, dup_ispec]))
 737
 738 addDictLoc ispec thing_inside
 739   = setSrcSpan (mkSrcSpan loc loc) thing_inside
 740   where
 741    loc = getSrcLoc ispec
 742 \end{code}
 743
 744
 745 %************************************************************************
 746 %*                                                                      *
 747 \subsection{Looking up Insts}
 748 %*                                                                      *
 749 %************************************************************************
 750
 751 \begin{code}
 752 data LookupInstResult
 753   = NoInstance
 754   | GenInst [Inst] (LHsExpr TcId)       -- The expression and its needed insts
 755
 756 lookupSimpleInst :: Inst -> TcM LookupInstResult
 757 -- This is "simple" in that it returns NoInstance for implication constraints
 758
 759 -- It's important that lookupInst does not put any new stuff into
 760 -- the LIE.  Instead, any Insts needed by the lookup are returned in
 761 -- the LookupInstResult, where they can be further processed by tcSimplify
 762
 763 lookupSimpleInst (EqInst {}) = return NoInstance
 764
 765 --------------------- Implications ------------------------
 766 lookupSimpleInst (ImplicInst {}) = return NoInstance
 767
 768 --------------------- Methods ------------------------
 769 lookupSimpleInst (Method {tci_oid = id, tci_tys = tys, tci_theta = theta, tci_loc = loc})
 770   = do  { (dict_app, dicts) <- getLIE $ instCallDicts loc theta
 771         ; let co_fn = dict_app <.> mkWpTyApps tys
 772         ; return (GenInst dicts (L span $ HsWrap co_fn (HsVar id))) }
 773   where
 774     span = instLocSpan loc
 775
 776 --------------------- Literals ------------------------
 777 -- Look for short cuts first: if the literal is *definitely* a
 778 -- int, integer, float or a double, generate the real thing here.
 779 -- This is essential (see nofib/spectral/nucleic).
 780 -- [Same shortcut as in newOverloadedLit, but we
 781 --  may have done some unification by now]
 782
 783 lookupSimpleInst (LitInst {tci_lit = HsIntegral i from_integer_name _, tci_ty = ty, tci_loc = loc})
 784   | Just expr <- shortCutIntLit i ty
 785   = return (GenInst [] (noLoc expr))
 786   | otherwise
 787   = ASSERT( from_integer_name `isHsVar` fromIntegerName ) do    -- A LitInst invariant
 788     from_integer <- tcLookupId fromIntegerName
 789     method_inst <- tcInstClassOp loc from_integer [ty]
 790     integer_lit <- mkIntegerLit i
 791     return (GenInst [method_inst]
 792                      (mkHsApp (L (instLocSpan loc)
 793                                  (HsVar (instToId method_inst))) integer_lit))
 794
 795 lookupSimpleInst (LitInst {tci_lit = HsFractional f from_rat_name _, tci_ty = ty, tci_loc = loc})
 796   | Just expr <- shortCutFracLit f ty
 797   = return (GenInst [] (noLoc expr))
 798
 799   | otherwise
 800   = ASSERT( from_rat_name `isHsVar` fromRationalName ) do       -- A LitInst invariant
 801     from_rational <- tcLookupId fromRationalName
 802     method_inst <- tcInstClassOp loc from_rational [ty]
 803     rat_lit <- mkRatLit f
 804     return (GenInst [method_inst] (mkHsApp (L (instLocSpan loc)
 805                                                (HsVar (instToId method_inst))) rat_lit))
 806
 807 lookupSimpleInst (LitInst {tci_lit = HsIsString s from_string_name _, tci_ty = ty, tci_loc = loc})
 808   | Just expr <- shortCutStringLit s ty
 809   = return (GenInst [] (noLoc expr))
 810   | otherwise
 811   = ASSERT( from_string_name `isHsVar` fromStringName ) do      -- A LitInst invariant
 812     from_string <- tcLookupId fromStringName
 813     method_inst <- tcInstClassOp loc from_string [ty]
 814     string_lit <- mkStrLit s
 815     return (GenInst [method_inst]
 816                      (mkHsApp (L (instLocSpan loc)
 817                                  (HsVar (instToId method_inst))) string_lit))
 818
 819 --------------------- Dictionaries ------------------------
 820 lookupSimpleInst (Dict {tci_pred = pred, tci_loc = loc})
 821   = do  { mb_result <- lookupPred pred
 822         ; case mb_result of {
 823             Nothing -> return NoInstance ;
 824             Just (dfun_id, mb_inst_tys) -> do
 825
 826     { use_stage <- getStage
 827     ; checkWellStaged (ptext SLIT("instance for") <+> quotes (ppr pred))
 828                       (topIdLvl dfun_id) use_stage
 829
 830         -- It's possible that not all the tyvars are in
 831         -- the substitution, tenv. For example:
 832         --      instance C X a => D X where ...
 833         -- (presumably there's a functional dependency in class C)
 834         -- Hence mb_inst_tys :: Either TyVar TcType
 835
 836     ; let inst_tv (Left tv)  = do { tv' <- tcInstTyVar tv; return (mkTyVarTy tv') }
 837           inst_tv (Right ty) = return ty
 838     ; tys <- mapM inst_tv mb_inst_tys
 839     ; let
 840         (theta, _) = tcSplitPhiTy (applyTys (idType dfun_id) tys)
 841         src_loc    = instLocSpan loc
 842         dfun       = HsVar dfun_id
 843     ; if null theta then
 844         return (GenInst [] (L src_loc $ HsWrap (mkWpTyApps tys) dfun))
 845       else do
 846     { (dict_app, dicts) <- getLIE $ instCallDicts loc theta -- !!!
 847     ; let co_fn = dict_app <.> mkWpTyApps tys
 848     ; return (GenInst dicts (L src_loc $ HsWrap co_fn dfun))
 849     }}}}
 850
 851 ---------------
 852 lookupPred :: TcPredType -> TcM (Maybe (DFunId, [Either TyVar TcType]))
 853 -- Look up a class constraint in the instance environment
 854 lookupPred pred@(ClassP clas tys)
 855   = do  { eps     <- getEps
 856         ; tcg_env <- getGblEnv
 857         ; let inst_envs = (eps_inst_env eps, tcg_inst_env tcg_env)
 858         ; case lookupInstEnv inst_envs clas tys of {
 859             ([(ispec, inst_tys)], [])
 860                 -> do   { let dfun_id = is_dfun ispec
 861                         ; traceTc (text "lookupInst success" <+>
 862                                    vcat [text "dict" <+> ppr pred,
 863                                          text "witness" <+> ppr dfun_id
 864                                          <+> ppr (idType dfun_id) ])
 865                                 -- Record that this dfun is needed
 866                         ; record_dfun_usage dfun_id
 867                         ; return (Just (dfun_id, inst_tys)) } ;
 868
 869             (matches, unifs)
 870                 -> do   { traceTc (text "lookupInst fail" <+>
 871                                    vcat [text "dict" <+> ppr pred,
 872                                          text "matches" <+> ppr matches,
 873                                          text "unifs" <+> ppr unifs])
 874                 -- In the case of overlap (multiple matches) we report
 875                 -- NoInstance here.  That has the effect of making the
 876                 -- context-simplifier return the dict as an irreducible one.
 877                 -- Then it'll be given to addNoInstanceErrs, which will do another
 878                 -- lookupInstEnv to get the detailed info about what went wrong.
 879                         ; return Nothing }
 880         }}
 881
 882 lookupPred ip_pred = return Nothing     -- Implicit parameters
 883
 884 record_dfun_usage dfun_id
 885   = do  { hsc_env <- getTopEnv
 886         ; let  dfun_name = idName dfun_id
 887                dfun_mod  = nameModule dfun_name
 888         ; if isInternalName dfun_name ||    -- Internal name => defined in this module
 889              modulePackageId dfun_mod /= thisPackage (hsc_dflags hsc_env)
 890           then return () -- internal, or in another package
 891            else do { tcg_env <- getGblEnv
 892                    ; updMutVar (tcg_inst_uses tcg_env)
 893                                (`addOneToNameSet` idName dfun_id) }}
 894
 895
 896 tcGetInstEnvs :: TcM (InstEnv, InstEnv)
 897 -- Gets both the external-package inst-env
 898 -- and the home-pkg inst env (includes module being compiled)
 899 tcGetInstEnvs = do { eps <- getEps; env <- getGblEnv;
 900                      return (eps_inst_env eps, tcg_inst_env env) }
 901 \end{code}
 902
 903
 904
 905 %************************************************************************
 906 %*                                                                      *
 907                 Re-mappable syntax
 908 %*                                                                      *
 909 %************************************************************************
 910
 911 Suppose we are doing the -fno-implicit-prelude thing, and we encounter
 912 a do-expression.  We have to find (>>) in the current environment, which is
 913 done by the rename. Then we have to check that it has the same type as
 914 Control.Monad.(>>).  Or, more precisely, a compatible type. One 'customer' had
 915 this:
 916
 917   (>>) :: HB m n mn => m a -> n b -> mn b
 918
 919 So the idea is to generate a local binding for (>>), thus:
 920
 921         let then72 :: forall a b. m a -> m b -> m b
 922             then72 = ...something involving the user's (>>)...
 923         in
 924         ...the do-expression...
 925
 926 Now the do-expression can proceed using then72, which has exactly
 927 the expected type.
 928
 929 In fact tcSyntaxName just generates the RHS for then72, because we only
 930 want an actual binding in the do-expression case. For literals, we can
 931 just use the expression inline.
 932
 933 \begin{code}
 934 tcSyntaxName :: InstOrigin
 935              -> TcType                  -- Type to instantiate it at
 936              -> (Name, HsExpr Name)     -- (Standard name, user name)
 937              -> TcM (Name, HsExpr TcId) -- (Standard name, suitable expression)
 938 --      *** NOW USED ONLY FOR CmdTop (sigh) ***
 939 -- NB: tcSyntaxName calls tcExpr, and hence can do unification.
 940 -- So we do not call it from lookupInst, which is called from tcSimplify
 941
 942 tcSyntaxName orig ty (std_nm, HsVar user_nm)
 943   | std_nm == user_nm
 944   = do id <- newMethodFromName orig ty std_nm
 945        return (std_nm, HsVar id)
 946
 947 tcSyntaxName orig ty (std_nm, user_nm_expr) = do
 948     std_id <- tcLookupId std_nm
 949     let
 950         -- C.f. newMethodAtLoc
 951         ([tv], _, tau)  = tcSplitSigmaTy (idType std_id)
 952         sigma1          = substTyWith [tv] [ty] tau
 953         -- Actually, the "tau-type" might be a sigma-type in the
 954         -- case of locally-polymorphic methods.
 955
 956     addErrCtxtM (syntaxNameCtxt user_nm_expr orig sigma1) $ do
 957
 958         -- Check that the user-supplied thing has the
 959         -- same type as the standard one.
 960         -- Tiresome jiggling because tcCheckSigma takes a located expression
 961      span <- getSrcSpanM
 962      expr <- tcPolyExpr (L span user_nm_expr) sigma1
 963      return (std_nm, unLoc expr)
 964
 965 syntaxNameCtxt name orig ty tidy_env = do
 966     inst_loc <- getInstLoc orig
 967     let
 968         msg = vcat [ptext SLIT("When checking that") <+> quotes (ppr name) <+>
 969                                 ptext SLIT("(needed by a syntactic construct)"),
 970                     nest 2 (ptext SLIT("has the required type:") <+> ppr (tidyType tidy_env ty)),
 971                     nest 2 (ptext SLIT("arising from") <+> pprInstLoc inst_loc)]
 972
 973     return (tidy_env, msg)
 974 \end{code}
 975
 976 %************************************************************************
 977 %*                                                                      *
 978                 EqInsts
 979 %*                                                                      *
 980 %************************************************************************
 981
 982 \begin{code}
 983 mkGivenCo   :: Coercion -> Either TcTyVar Coercion
 984 mkGivenCo   =  Right
 985
 986 mkWantedCo  :: TcTyVar  -> Either TcTyVar Coercion
 987 mkWantedCo  =  Left
 988
 989 fromGivenCo :: Either TcTyVar Coercion -> Coercion
 990 fromGivenCo (Right co)   = co
 991 fromGivenCo _            = panic "fromGivenCo: not a wanted coercion"
 992
 993 fromWantedCo :: String -> Either TcTyVar Coercion -> TcTyVar
 994 fromWantedCo _ (Left covar) = covar
 995 fromWantedCo msg _          = panic ("fromWantedCo: not a wanted coercion: " ++ msg)
 996
 997 eitherEqInst :: Inst                -- given or wanted EqInst
 998              -> (TcTyVar  -> a)     --  result if wanted
 999              -> (Coercion -> a)     --  result if given
1000              -> a
1001 eitherEqInst (EqInst {tci_co = either_co}) withWanted withGiven
1002         = case either_co of
1003                 Left  covar -> withWanted covar
1004                 Right co    -> withGiven  co
1005
1006 mkEqInsts :: [PredType] -> [Either TcTyVar Coercion] -> TcM [Inst]
1007 mkEqInsts preds cos = zipWithM mkEqInst preds cos
1008
1009 mkEqInst :: PredType -> Either TcTyVar Coercion -> TcM Inst
1010 mkEqInst (EqPred ty1 ty2) co
1011         = do { uniq <- newUnique
1012              ; src_span <- getSrcSpanM
1013              ; err_ctxt <- getErrCtxt
1014              ; let loc  = InstLoc EqOrigin src_span err_ctxt
1015                    name = mkName uniq src_span
1016                    inst = EqInst {tci_left = ty1, tci_right = ty2, tci_co = co, tci_loc = loc, tci_name = name}
1017              ; return inst
1018              }
1019         where mkName uniq src_span = mkInternalName uniq (mkVarOcc "co") src_span
1020
1021 mkWantedEqInst :: PredType -> TcM Inst
1022 mkWantedEqInst pred@(EqPred ty1 ty2)
1023   = do { cotv <- newMetaCoVar ty1 ty2
1024        ; mkEqInst pred (Left cotv)
1025        }
1026
1027 -- type inference:
1028 --      We want to promote the wanted EqInst to a given EqInst
1029 --      in the signature context.
1030 --      This means we have to give the coercion a name
1031 --      and fill it in as its own name.
1032 finalizeEqInst
1033         :: Inst                 -- wanted
1034         -> TcM Inst             -- given
1035 finalizeEqInst wanted@(EqInst {tci_left = ty1, tci_right = ty2, tci_name = name})
1036         = do { let var = Var.mkCoVar name (PredTy $ EqPred ty1 ty2)
1037              ; writeWantedCoercion wanted (TyVarTy var)
1038              ; let given = wanted { tci_co = mkGivenCo $ TyVarTy var }
1039              ; return given
1040              }
1041
1042 writeWantedCoercion
1043         :: Inst         -- wanted EqInst
1044         -> Coercion     -- coercion to fill the hole with
1045         -> TcM ()
1046 writeWantedCoercion wanted co
1047         = do { let cotv = fromWantedCo "writeWantedCoercion" $ tci_co wanted
1048              ; writeMetaTyVar cotv co
1049              }
1050
1051 eqInstType :: Inst -> TcType
1052 eqInstType inst = eitherEqInst inst mkTyVarTy id
1053
1054 eqInstCoercion :: Inst -> Either TcTyVar Coercion
1055 eqInstCoercion = tci_co
1056
1057 eqInstTys :: Inst -> (TcType, TcType)
1058 eqInstTys inst = (tci_left inst, tci_right inst)
1059
1060 updateEqInstCoercion :: (Either TcTyVar Coercion -> Either TcTyVar Coercion) -> Inst -> Inst
1061 updateEqInstCoercion f inst = inst {tci_co = f $ tci_co inst}
1062 \end{code}