ghc/compiler/typecheck/TcEnv.lhs

   1 \begin{code}
   2 module TcEnv(
   3         TcId, TcIdSet,
   4         TyThing(..), TyThingDetails(..), TcTyThing(..),
   5
   6         -- Getting stuff from the environment
   7         TcEnv, initTcEnv,
   8         tcEnvTyCons, tcEnvClasses, tcEnvIds, tcLEnvElts,
   9         getTcGEnv,
  10
  11         -- Instance environment, and InstInfo type
  12         tcGetInstEnv, tcSetInstEnv,
  13         InstInfo(..), pprInstInfo,
  14         simpleInstInfoTy, simpleInstInfoTyCon,
  15
  16         -- Global environment
  17         tcExtendGlobalEnv, tcExtendGlobalValEnv, tcExtendGlobalTypeEnv,
  18         tcLookupTyCon, tcLookupClass, tcLookupGlobalId, tcLookupDataCon,
  19         tcLookupGlobal_maybe, tcLookupGlobal,
  20
  21         -- Local environment
  22         tcExtendKindEnv,  tcLookupLocalIds, tcInLocalScope,
  23         tcExtendTyVarEnv, tcExtendTyVarEnvForMeths,
  24         tcExtendLocalValEnv, tcLookup, tcLookup_maybe, tcLookupId,
  25
  26         -- Global type variables
  27         tcGetGlobalTyVars, tcExtendGlobalTyVars,
  28
  29         -- Random useful things
  30         RecTcEnv, tcAddImportedIdInfo, tcLookupRecId, tcLookupRecId_maybe,
  31
  32         -- New Ids
  33         newLocalId, newSpecPragmaId,
  34         newDFunName,
  35
  36         -- Misc
  37         isLocalThing, tcSetEnv
  38   ) where
  39
  40 #include "HsVersions.h"
  41
  42 import RnHsSyn          ( RenamedMonoBinds, RenamedSig )
  43 import TcMonad
  44 import TcMType          ( zonkTcTyVarsAndFV )
  45 import TcType           ( Type, ThetaType, TcType, TcKind, TcTyVar, TcTyVarSet,
  46                           tyVarsOfTypes, tcSplitDFunTy,
  47                           getDFunTyKey, tcTyConAppTyCon
  48                         )
  49 import Id               ( idName, mkSpecPragmaId, mkUserLocal, isDataConWrapId_maybe )
  50 import IdInfo           ( vanillaIdInfo )
  51 import Var              ( TyVar, Id, idType, lazySetIdInfo, idInfo )
  52 import VarSet
  53 import DataCon          ( DataCon )
  54 import TyCon            ( TyCon )
  55 import Class            ( Class, ClassOpItem )
  56 import Name             ( Name, OccName, NamedThing(..),
  57                           nameOccName, getSrcLoc, mkLocalName, isLocalName,
  58                           nameIsLocalOrFrom
  59                         )
  60 import NameEnv          ( NameEnv, lookupNameEnv, nameEnvElts, elemNameEnv,
  61                           extendNameEnvList, emptyNameEnv, plusNameEnv )
  62 import OccName          ( mkDFunOcc, occNameString )
  63 import HscTypes         ( DFunId,
  64                           PackageTypeEnv, TypeEnv,
  65                           extendTypeEnvList, extendTypeEnvWithIds,
  66                           typeEnvTyCons, typeEnvClasses, typeEnvIds,
  67                           HomeSymbolTable
  68                         )
  69 import Module           ( Module )
  70 import InstEnv          ( InstEnv, emptyInstEnv )
  71 import HscTypes         ( lookupType, TyThing(..) )
  72 import Util             ( zipEqual )
  73 import SrcLoc           ( SrcLoc )
  74 import Outputable
  75
  76 import IOExts           ( newIORef )
  77 \end{code}
  78
  79 %************************************************************************
  80 %*                                                                      *
  81 \subsection{TcEnv}
  82 %*                                                                      *
  83 %************************************************************************
  84
  85 \begin{code}
  86 type TcId    = Id                       -- Type may be a TcType
  87 type TcIdSet = IdSet
  88
  89 data TcEnv
  90   = TcEnv {
  91         tcGST    :: Name -> Maybe TyThing,      -- The type environment at the moment we began this compilation
  92
  93         tcInsts  :: InstEnv,            -- All instances (both imported and in this module)
  94
  95         tcGEnv   :: TypeEnv,            -- The global type environment we've accumulated while
  96                  {- NameEnv TyThing-}   -- compiling this module:
  97                                         --      types and classes (both imported and local)
  98                                         --      imported Ids
  99                                         -- (Ids defined in this module start in the local envt,
 100                                         --  though they move to the global envt during zonking)
 101
 102         tcLEnv   :: NameEnv TcTyThing,  -- The local type environment: Ids and TyVars
 103                                         -- defined in this module
 104
 105         tcTyVars :: TcRef TcTyVarSet    -- The "global tyvars"
 106                                         -- Namely, the in-scope TyVars bound in tcLEnv, plus the tyvars
 107                                         -- mentioned in the types of Ids bound in tcLEnv
 108                                         -- Why mutable? see notes with tcGetGlobalTyVars
 109     }
 110
 111 \end{code}
 112
 113 The Global-Env/Local-Env story
 114 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 115 During type checking, we keep in the GlobalEnv
 116         * All types and classes
 117         * All Ids derived from types and classes (constructors, selectors)
 118         * Imported Ids
 119
 120 At the end of type checking, we zonk the local bindings,
 121 and as we do so we add to the GlobalEnv
 122         * Locally defined top-level Ids
 123
 124 Why?  Because they are now Ids not TcIds.  This final GlobalEnv is
 125 used thus:
 126         a) fed back (via the knot) to typechecking the
 127            unfoldings of interface signatures
 128
 129         b) used to augment the GlobalSymbolTable
 130
 131
 132 \begin{code}
 133 initTcEnv :: HomeSymbolTable -> PackageTypeEnv -> IO TcEnv
 134 initTcEnv hst pte
 135   = do { gtv_var <- newIORef emptyVarSet ;
 136          return (TcEnv { tcGST    = lookup,
 137                          tcGEnv   = emptyNameEnv,
 138                          tcInsts  = emptyInstEnv,
 139                          tcLEnv   = emptyNameEnv,
 140                          tcTyVars = gtv_var
 141          })}
 142   where
 143     lookup name | isLocalName name = Nothing
 144                 | otherwise        = lookupType hst pte name
 145
 146
 147 tcEnvClasses env = typeEnvClasses (tcGEnv env)
 148 tcEnvTyCons  env = typeEnvTyCons  (tcGEnv env)
 149 tcEnvIds     env = typeEnvIds     (tcGEnv env)
 150 tcLEnvElts   env = nameEnvElts (tcLEnv env)
 151
 152 getTcGEnv (TcEnv { tcGEnv = genv }) = genv
 153
 154 tcInLocalScope :: TcEnv -> Name -> Bool
 155 tcInLocalScope env v = v `elemNameEnv` (tcLEnv env)
 156 \end{code}
 157
 158 \begin{code}
 159 data TcTyThing
 160   = AGlobal TyThing             -- Used only in the return type of a lookup
 161   | ATcId   TcId                -- Ids defined in this module
 162   | ATyVar  TyVar               -- Type variables
 163   | AThing  TcKind              -- Used temporarily, during kind checking
 164 -- Here's an example of how the AThing guy is used
 165 -- Suppose we are checking (forall a. T a Int):
 166 --      1. We first bind (a -> AThink kv), where kv is a kind variable.
 167 --      2. Then we kind-check the (T a Int) part.
 168 --      3. Then we zonk the kind variable.
 169 --      4. Now we know the kind for 'a', and we add (a -> ATyVar a::K) to the environment
 170
 171 \end{code}
 172
 173 This data type is used to help tie the knot
 174  when type checking type and class declarations
 175
 176 \begin{code}
 177 data TyThingDetails = SynTyDetails Type
 178                     | DataTyDetails ThetaType [DataCon] [Id]
 179                     | ClassDetails ThetaType [Id] [ClassOpItem] DataCon
 180                     | ForeignTyDetails  -- Nothing yet
 181 \end{code}
 182
 183 %************************************************************************
 184 %*                                                                      *
 185 \subsection{Basic lookups}
 186 %*                                                                      *
 187 %************************************************************************
 188
 189 \begin{code}
 190 lookup_global :: TcEnv -> Name -> Maybe TyThing
 191         -- Try the global envt and then the global symbol table
 192 lookup_global env name
 193   = case lookupNameEnv (tcGEnv env) name of
 194         Just thing -> Just thing
 195         Nothing    -> tcGST env name
 196
 197 lookup_local :: TcEnv -> Name -> Maybe TcTyThing
 198         -- Try the local envt and then try the global
 199 lookup_local env name
 200   = case lookupNameEnv (tcLEnv env) name of
 201         Just thing -> Just thing
 202         Nothing    -> case lookup_global env name of
 203                         Just thing -> Just (AGlobal thing)
 204                         Nothing    -> Nothing
 205 \end{code}
 206
 207 \begin{code}
 208 type RecTcEnv = TcEnv
 209 -- This environment is used for getting the 'right' IdInfo
 210 -- on imported things and for looking up Ids in unfoldings
 211 -- The environment doesn't have any local Ids in it
 212
 213 tcAddImportedIdInfo :: RecTcEnv -> Id -> Id
 214 tcAddImportedIdInfo env id
 215   = id `lazySetIdInfo` new_info
 216         -- The Id must be returned without a data dependency on maybe_id
 217   where
 218     new_info = case tcLookupRecId_maybe env (idName id) of
 219                   Nothing          -> pprTrace "tcAddIdInfo" (ppr id) vanillaIdInfo
 220                   Just imported_id -> idInfo imported_id
 221                 -- ToDo: could check that types are the same
 222
 223 tcLookupRecId_maybe :: RecTcEnv -> Name -> Maybe Id
 224 tcLookupRecId_maybe env name = case lookup_global env name of
 225                                    Just (AnId id) -> Just id
 226                                    other          -> Nothing
 227
 228 tcLookupRecId ::  RecTcEnv -> Name -> Id
 229 tcLookupRecId env name = case lookup_global env name of
 230                                 Just (AnId id) -> id
 231                                 Nothing        -> pprPanic "tcLookupRecId" (ppr name)
 232 \end{code}
 233
 234 %************************************************************************
 235 %*                                                                      *
 236 \subsection{Making new Ids}
 237 %*                                                                      *
 238 %************************************************************************
 239
 240 Constructing new Ids
 241
 242 \begin{code}
 243 newLocalId :: OccName -> TcType -> SrcLoc -> NF_TcM TcId
 244 newLocalId name ty loc
 245   = tcGetUnique         `thenNF_Tc` \ uniq ->
 246     returnNF_Tc (mkUserLocal name uniq ty loc)
 247
 248 newSpecPragmaId :: Name -> TcType -> NF_TcM TcId
 249 newSpecPragmaId name ty
 250   = tcGetUnique         `thenNF_Tc` \ uniq ->
 251     returnNF_Tc (mkSpecPragmaId (nameOccName name) uniq ty (getSrcLoc name))
 252 \end{code}
 253
 254 Make a name for the dict fun for an instance decl.
 255 It's a *local* name for the moment.  The CoreTidy pass
 256 will globalise it.
 257
 258 \begin{code}
 259 newDFunName :: Class -> [Type] -> SrcLoc -> NF_TcM Name
 260 newDFunName clas (ty:_) loc
 261   = tcGetUnique                 `thenNF_Tc` \ uniq ->
 262     returnNF_Tc (mkLocalName uniq (mkDFunOcc dfun_string) loc)
 263   where
 264         -- Any string that is somewhat unique will do
 265     dfun_string = occNameString (getOccName clas) ++ occNameString (getDFunTyKey ty)
 266
 267 newDFunName clas [] loc = pprPanic "newDFunName" (ppr clas <+> ppr loc)
 268 \end{code}
 269
 270 \begin{code}
 271 isLocalThing :: NamedThing a => Module -> a -> Bool
 272 isLocalThing mod thing = nameIsLocalOrFrom mod (getName thing)
 273 \end{code}
 274
 275 %************************************************************************
 276 %*                                                                      *
 277 \subsection{The global environment}
 278 %*                                                                      *
 279 %************************************************************************
 280
 281 \begin{code}
 282 tcExtendGlobalEnv :: [TyThing] -> TcM r -> TcM r
 283 tcExtendGlobalEnv things thing_inside
 284   = tcGetEnv                            `thenNF_Tc` \ env ->
 285     let
 286         ge' = extendTypeEnvList (tcGEnv env) things
 287     in
 288     tcSetEnv (env {tcGEnv = ge'}) thing_inside
 289
 290
 291 tcExtendGlobalTypeEnv :: TypeEnv -> TcM r -> TcM r
 292 tcExtendGlobalTypeEnv extra_env thing_inside
 293   = tcGetEnv                            `thenNF_Tc` \ env ->
 294     let
 295         ge' = tcGEnv env `plusNameEnv` extra_env
 296     in
 297     tcSetEnv (env {tcGEnv = ge'}) thing_inside
 298
 299 tcExtendGlobalValEnv :: [Id] -> TcM a -> TcM a
 300 tcExtendGlobalValEnv ids thing_inside
 301   = tcGetEnv                            `thenNF_Tc` \ env ->
 302     let
 303         ge' = extendTypeEnvWithIds (tcGEnv env) ids
 304     in
 305     tcSetEnv (env {tcGEnv = ge'}) thing_inside
 306 \end{code}
 307
 308
 309 \begin{code}
 310 tcLookupGlobal_maybe :: Name -> NF_TcM (Maybe TyThing)
 311 tcLookupGlobal_maybe name
 312   = tcGetEnv            `thenNF_Tc` \ env ->
 313     returnNF_Tc (lookup_global env name)
 314 \end{code}
 315
 316 A variety of global lookups, when we know what we are looking for.
 317
 318 \begin{code}
 319 tcLookupGlobal :: Name -> NF_TcM TyThing
 320 tcLookupGlobal name
 321   = tcLookupGlobal_maybe name   `thenNF_Tc` \ maybe_thing ->
 322     case maybe_thing of
 323         Just thing -> returnNF_Tc thing
 324         other      -> notFound "tcLookupGlobal" name
 325
 326 tcLookupGlobalId :: Name -> NF_TcM Id
 327 tcLookupGlobalId name
 328   = tcLookupGlobal_maybe name   `thenNF_Tc` \ maybe_id ->
 329     case maybe_id of
 330         Just (AnId id) -> returnNF_Tc id
 331         other          -> notFound "tcLookupGlobalId" name
 332
 333 tcLookupDataCon :: Name -> TcM DataCon
 334 tcLookupDataCon con_name
 335   = tcLookupGlobalId con_name           `thenNF_Tc` \ con_id ->
 336     case isDataConWrapId_maybe con_id of
 337         Just data_con -> returnTc data_con
 338         Nothing       -> failWithTc (badCon con_id)
 339
 340
 341 tcLookupClass :: Name -> NF_TcM Class
 342 tcLookupClass name
 343   = tcLookupGlobal_maybe name   `thenNF_Tc` \ maybe_clas ->
 344     case maybe_clas of
 345         Just (AClass clas) -> returnNF_Tc clas
 346         other              -> notFound "tcLookupClass" name
 347
 348 tcLookupTyCon :: Name -> NF_TcM TyCon
 349 tcLookupTyCon name
 350   = tcLookupGlobal_maybe name   `thenNF_Tc` \ maybe_tc ->
 351     case maybe_tc of
 352         Just (ATyCon tc) -> returnNF_Tc tc
 353         other            -> notFound "tcLookupTyCon" name
 354
 355 tcLookupId :: Name -> NF_TcM Id
 356 tcLookupId name
 357   = tcLookup name       `thenNF_Tc` \ thing ->
 358     case thing of
 359         ATcId tc_id       -> returnNF_Tc tc_id
 360         AGlobal (AnId id) -> returnNF_Tc id
 361         other             -> pprPanic "tcLookupId" (ppr name)
 362
 363 tcLookupLocalIds :: [Name] -> NF_TcM [TcId]
 364 tcLookupLocalIds ns
 365   = tcGetEnv            `thenNF_Tc` \ env ->
 366     returnNF_Tc (map (lookup (tcLEnv env)) ns)
 367   where
 368     lookup lenv name = case lookupNameEnv lenv name of
 369                         Just (ATcId id) -> id
 370                         other           -> pprPanic "tcLookupLocalIds" (ppr name)
 371 \end{code}
 372
 373
 374 %************************************************************************
 375 %*                                                                      *
 376 \subsection{The local environment}
 377 %*                                                                      *
 378 %************************************************************************
 379
 380 \begin{code}
 381 tcLookup_maybe :: Name -> NF_TcM (Maybe TcTyThing)
 382 tcLookup_maybe name
 383   = tcGetEnv            `thenNF_Tc` \ env ->
 384     returnNF_Tc (lookup_local env name)
 385
 386 tcLookup :: Name -> NF_TcM TcTyThing
 387 tcLookup name
 388   = tcLookup_maybe name         `thenNF_Tc` \ maybe_thing ->
 389     case maybe_thing of
 390         Just thing -> returnNF_Tc thing
 391         other      -> notFound "tcLookup" name
 392         -- Extract the IdInfo from an IfaceSig imported from an interface file
 393 \end{code}
 394
 395
 396 \begin{code}
 397 tcExtendKindEnv :: [(Name,TcKind)] -> TcM r -> TcM r
 398 tcExtendKindEnv pairs thing_inside
 399   = tcGetEnv                            `thenNF_Tc` \ env ->
 400     let
 401         le' = extendNameEnvList (tcLEnv env) [(n, AThing k) | (n,k) <- pairs]
 402         -- No need to extend global tyvars for kind checking
 403     in
 404     tcSetEnv (env {tcLEnv = le'}) thing_inside
 405
 406 tcExtendTyVarEnv :: [TyVar] -> TcM r -> TcM r
 407 tcExtendTyVarEnv tyvars thing_inside
 408   = tcGetEnv                    `thenNF_Tc` \ env@(TcEnv {tcLEnv = le, tcTyVars = gtvs}) ->
 409     let
 410         le'        = extendNameEnvList le [ (getName tv, ATyVar tv) | tv <- tyvars]
 411         new_tv_set = mkVarSet tyvars
 412     in
 413         -- It's important to add the in-scope tyvars to the global tyvar set
 414         -- as well.  Consider
 415         --      f (x::r) = let g y = y::r in ...
 416         -- Here, g mustn't be generalised.  This is also important during
 417         -- class and instance decls, when we mustn't generalise the class tyvars
 418         -- when typechecking the methods.
 419     tc_extend_gtvs gtvs new_tv_set              `thenNF_Tc` \ gtvs' ->
 420     tcSetEnv (env {tcLEnv = le', tcTyVars = gtvs'}) thing_inside
 421
 422 -- This variant, tcExtendTyVarEnvForMeths, takes *two* bunches of tyvars:
 423 --      the signature tyvars contain the original names
 424 --      the instance  tyvars are what those names should be mapped to
 425 -- It's needed when typechecking the method bindings of class and instance decls
 426 -- It does *not* extend the global tyvars; tcMethodBind does that for itself
 427
 428 tcExtendTyVarEnvForMeths :: [TyVar] -> [TcTyVar] -> TcM r -> TcM r
 429 tcExtendTyVarEnvForMeths sig_tyvars inst_tyvars thing_inside
 430   = tcGetEnv                                    `thenNF_Tc` \ env ->
 431     let
 432         le'   = extendNameEnvList (tcLEnv env) stuff
 433         stuff = [ (getName sig_tv, ATyVar inst_tv)
 434                 | (sig_tv, inst_tv) <- zipEqual "tcMeth" sig_tyvars inst_tyvars
 435                 ]
 436     in
 437     tcSetEnv (env {tcLEnv = le'}) thing_inside
 438 \end{code}
 439
 440
 441 \begin{code}
 442 tcExtendLocalValEnv :: [(Name,TcId)] -> TcM a -> TcM a
 443 tcExtendLocalValEnv names_w_ids thing_inside
 444   = tcGetEnv            `thenNF_Tc` \ env ->
 445     let
 446         extra_global_tyvars = tyVarsOfTypes [idType id | (name,id) <- names_w_ids]
 447         extra_env           = [(name, ATcId id) | (name,id) <- names_w_ids]
 448         le'                 = extendNameEnvList (tcLEnv env) extra_env
 449     in
 450     tc_extend_gtvs (tcTyVars env) extra_global_tyvars   `thenNF_Tc` \ gtvs' ->
 451     tcSetEnv (env {tcLEnv = le', tcTyVars = gtvs'}) thing_inside
 452 \end{code}
 453
 454
 455 %************************************************************************
 456 %*                                                                      *
 457 \subsection{The global tyvars}
 458 %*                                                                      *
 459 %************************************************************************
 460
 461 \begin{code}
 462 tcExtendGlobalTyVars extra_global_tvs thing_inside
 463   = tcGetEnv                                            `thenNF_Tc` \ env ->
 464     tc_extend_gtvs (tcTyVars env) extra_global_tvs      `thenNF_Tc` \ gtvs' ->
 465     tcSetEnv (env {tcTyVars = gtvs'}) thing_inside
 466
 467 tc_extend_gtvs gtvs extra_global_tvs
 468   = tcReadMutVar gtvs                   `thenNF_Tc` \ global_tvs ->
 469     tcNewMutVar (global_tvs `unionVarSet` extra_global_tvs)
 470 \end{code}
 471
 472 @tcGetGlobalTyVars@ returns a fully-zonked set of tyvars free in the environment.
 473 To improve subsequent calls to the same function it writes the zonked set back into
 474 the environment.
 475
 476 \begin{code}
 477 tcGetGlobalTyVars :: NF_TcM TcTyVarSet
 478 tcGetGlobalTyVars
 479   = tcGetEnv                                    `thenNF_Tc` \ (TcEnv {tcTyVars = gtv_var}) ->
 480     tcReadMutVar gtv_var                        `thenNF_Tc` \ gbl_tvs ->
 481     zonkTcTyVarsAndFV (varSetElems gbl_tvs)     `thenNF_Tc` \ gbl_tvs' ->
 482     tcWriteMutVar gtv_var gbl_tvs'              `thenNF_Tc_`
 483     returnNF_Tc gbl_tvs'
 484 \end{code}
 485
 486
 487 %************************************************************************
 488 %*                                                                      *
 489 \subsection{The instance environment}
 490 %*                                                                      *
 491 %************************************************************************
 492
 493 \begin{code}
 494 tcGetInstEnv :: NF_TcM InstEnv
 495 tcGetInstEnv = tcGetEnv         `thenNF_Tc` \ env ->
 496                returnNF_Tc (tcInsts env)
 497
 498 tcSetInstEnv :: InstEnv -> TcM a -> TcM a
 499 tcSetInstEnv ie thing_inside
 500   = tcGetEnv    `thenNF_Tc` \ env ->
 501     tcSetEnv (env {tcInsts = ie}) thing_inside
 502 \end{code}
 503
 504
 505 %************************************************************************
 506 %*                                                                      *
 507 \subsection{The InstInfo type}
 508 %*                                                                      *
 509 %************************************************************************
 510
 511 The InstInfo type summarises the information in an instance declaration
 512
 513     instance c => k (t tvs) where b
 514
 515 \begin{code}
 516 data InstInfo
 517   = InstInfo {
 518       iDFunId :: DFunId,                -- The dfun id
 519       iBinds  :: RenamedMonoBinds,      -- Bindings, b
 520       iPrags  :: [RenamedSig]           -- User pragmas recorded for generating specialised instances
 521     }
 522
 523 pprInstInfo info = vcat [ptext SLIT("InstInfo:") <+> ppr (idType (iDFunId info)),
 524                          nest 4 (ppr (iBinds info))]
 525
 526 simpleInstInfoTy :: InstInfo -> Type
 527 simpleInstInfoTy info = case tcSplitDFunTy (idType (iDFunId info)) of
 528                           (_, _, _, [ty]) -> ty
 529
 530 simpleInstInfoTyCon :: InstInfo -> TyCon
 531   -- Gets the type constructor for a simple instance declaration,
 532   -- i.e. one of the form       instance (...) => C (T a b c) where ...
 533 simpleInstInfoTyCon inst = tcTyConAppTyCon (simpleInstInfoTy inst)
 534 \end{code}
 535
 536
 537 %************************************************************************
 538 %*                                                                      *
 539 \subsection{Errors}
 540 %*                                                                      *
 541 %************************************************************************
 542
 543 \begin{code}
 544 badCon con_id = quotes (ppr con_id) <+> ptext SLIT("is not a data constructor")
 545
 546 notFound wheRe name = failWithTc (text wheRe <> colon <+> quotes (ppr name) <+>
 547                                   ptext SLIT("is not in scope"))
 548 \end{code}