compiler/typecheck/TcRnTypes.lhs

   1
   2 % (c) The University of Glasgow 2006
   3 % (c) The GRASP Project, Glasgow University, 1992-2002
   4 %
   5 \begin{code}
   6 module TcRnTypes(
   7         TcRnIf, TcRn, TcM, RnM, IfM, IfL, IfG, -- The monad is opaque outside this module
   8         TcRef,
   9
  10         -- The environment types
  11         Env(..),
  12         TcGblEnv(..), TcLclEnv(..),
  13         IfGblEnv(..), IfLclEnv(..),
  14
  15         -- Ranamer types
  16         ErrCtxt, RecFieldEnv(..),
  17         ImportAvails(..), emptyImportAvails, plusImportAvails,
  18         WhereFrom(..), mkModDeps,
  19
  20         -- Typechecker types
  21         TcTyThing(..), pprTcTyThingCategory, RefinementVisibility(..),
  22
  23         -- Template Haskell
  24         ThStage(..), topStage, topAnnStage, topSpliceStage,
  25         ThLevel, impLevel, topLevel,
  26
  27         -- Arrows
  28         ArrowCtxt(NoArrowCtxt), newArrowScope, escapeArrowScope,
  29
  30         -- Insts
  31         Inst(..), EqInstCo, InstOrigin(..), InstLoc(..),
  32         pprInstLoc, pprInstArising, instLocSpan, instLocOrigin, setInstLoc,
  33         LIE, emptyLIE, unitLIE, plusLIE, consLIE, instLoc, instSpan,
  34         plusLIEs, mkLIE, isEmptyLIE, lieToList, listToLIE,
  35
  36         -- Misc other types
  37         TcId, TcIdSet, TcDictBinds, TcTyVarBind(..), TcTyVarBinds
  38
  39   ) where
  40
  41 #include "HsVersions.h"
  42
  43 import HsSyn hiding (LIE)
  44 import HscTypes
  45 import Type
  46 import Coercion
  47 import TcType
  48 import Annotations
  49 import InstEnv
  50 import FamInstEnv
  51 import IOEnv
  52 import RdrName
  53 import Name
  54 import NameEnv
  55 import NameSet
  56 import Var
  57 import VarEnv
  58 import Module
  59 import LazyUniqFM
  60 import SrcLoc
  61 import VarSet
  62 import ErrUtils
  63 import UniqSupply
  64 import BasicTypes
  65 import Util
  66 import Bag
  67 import Outputable
  68 import ListSetOps
  69 import FastString
  70
  71 import Data.Set (Set)
  72 \end{code}
  73
  74
  75 %************************************************************************
  76 %*                                                                      *
  77                Standard monad definition for TcRn
  78     All the combinators for the monad can be found in TcRnMonad
  79 %*                                                                      *
  80 %************************************************************************
  81
  82 The monad itself has to be defined here, because it is mentioned by ErrCtxt
  83
  84 \begin{code}
  85 type TcRef a     = IORef a
  86 type TcId        = Id                   -- Type may be a TcType
  87 type TcIdSet     = IdSet
  88 type TcDictBinds = DictBinds TcId       -- Bag of dictionary bindings
  89
  90 type TcRnIf a b c = IOEnv (Env a b) c
  91 type IfM lcl a  = TcRnIf IfGblEnv lcl a         -- Iface stuff
  92
  93 type IfG a  = IfM () a                          -- Top level
  94 type IfL a  = IfM IfLclEnv a                    -- Nested
  95 type TcRn a = TcRnIf TcGblEnv TcLclEnv a
  96 type RnM  a = TcRn a            -- Historical
  97 type TcM  a = TcRn a            -- Historical
  98 \end{code}
  99
 100 Representation of type bindings to uninstantiated meta variables used during
 101 constraint solving.
 102
 103 \begin{code}
 104 data TcTyVarBind = TcTyVarBind TcTyVar TcType
 105
 106 type TcTyVarBinds = Bag TcTyVarBind
 107
 108 instance Outputable TcTyVarBind where
 109   ppr (TcTyVarBind tv ty) = ppr tv <+> text ":=" <+> ppr ty
 110 \end{code}
 111
 112
 113 %************************************************************************
 114 %*                                                                      *
 115                 The main environment types
 116 %*                                                                      *
 117 %************************************************************************
 118
 119 \begin{code}
 120 data Env gbl lcl        -- Changes as we move into an expression
 121   = Env {
 122         env_top  :: HscEnv,     -- Top-level stuff that never changes
 123                                 -- Includes all info about imported things
 124
 125         env_us   :: {-# UNPACK #-} !(IORef UniqSupply),
 126                                 -- Unique supply for local varibles
 127
 128         env_gbl  :: gbl,        -- Info about things defined at the top level
 129                                 -- of the module being compiled
 130
 131         env_lcl  :: lcl         -- Nested stuff; changes as we go into
 132     }
 133
 134 -- TcGblEnv describes the top-level of the module at the
 135 -- point at which the typechecker is finished work.
 136 -- It is this structure that is handed on to the desugarer
 137
 138 data TcGblEnv
 139   = TcGblEnv {
 140         tcg_mod     :: Module,         -- ^ Module being compiled
 141         tcg_src     :: HscSource,
 142           -- ^ What kind of module (regular Haskell, hs-boot, ext-core)
 143
 144         tcg_rdr_env :: GlobalRdrEnv,   -- ^ Top level envt; used during renaming
 145         tcg_default :: Maybe [Type],
 146           -- ^ Types used for defaulting. @Nothing@ => no @default@ decl
 147
 148         tcg_fix_env   :: FixityEnv,     -- ^ Just for things in this module
 149         tcg_field_env :: RecFieldEnv,   -- ^ Just for things in this module
 150
 151         tcg_type_env :: TypeEnv,
 152           -- ^ Global type env for the module we are compiling now.  All
 153           -- TyCons and Classes (for this module) end up in here right away,
 154           -- along with their derived constructors, selectors.
 155           --
 156           -- (Ids defined in this module start in the local envt, though they
 157           --  move to the global envt during zonking)
 158
 159         tcg_type_env_var :: TcRef TypeEnv,
 160                 -- Used only to initialise the interface-file
 161                 -- typechecker in initIfaceTcRn, so that it can see stuff
 162                 -- bound in this module when dealing with hi-boot recursions
 163                 -- Updated at intervals (e.g. after dealing with types and classes)
 164
 165         tcg_inst_env     :: InstEnv,
 166           -- ^ Instance envt for /home-package/ modules; Includes the dfuns in
 167           -- tcg_insts
 168         tcg_fam_inst_env :: FamInstEnv, -- ^ Ditto for family instances
 169
 170                 -- Now a bunch of things about this module that are simply
 171                 -- accumulated, but never consulted until the end.
 172                 -- Nevertheless, it's convenient to accumulate them along
 173                 -- with the rest of the info from this module.
 174         tcg_exports :: [AvailInfo],     -- ^ What is exported
 175         tcg_imports :: ImportAvails,
 176           -- ^ Information about what was imported from where, including
 177           -- things bound in this module.
 178
 179         tcg_dus :: DefUses,
 180           -- ^ What is defined in this module and what is used.
 181           -- The latter is used to generate
 182           --
 183           --  (a) version tracking; no need to recompile if these things have
 184           --      not changed version stamp
 185           --
 186           --  (b) unused-import info
 187
 188         tcg_keep :: TcRef NameSet,
 189           -- ^ Locally-defined top-level names to keep alive.
 190           --
 191           -- "Keep alive" means give them an Exported flag, so that the
 192           -- simplifier does not discard them as dead code, and so that they
 193           -- are exposed in the interface file (but not to export to the
 194           -- user).
 195           --
 196           -- Some things, like dict-fun Ids and default-method Ids are "born"
 197           -- with the Exported flag on, for exactly the above reason, but some
 198           -- we only discover as we go.  Specifically:
 199           --
 200           --   * The to/from functions for generic data types
 201           --
 202           --   * Top-level variables appearing free in the RHS of an orphan
 203           --     rule
 204           --
 205           --   * Top-level variables appearing free in a TH bracket
 206
 207         tcg_inst_uses :: TcRef NameSet,
 208           -- ^ Home-package Dfuns actually used.
 209           --
 210           -- Used to generate version dependencies This records usages, rather
 211           -- like tcg_dus, but it has to be a mutable variable so it can be
 212           -- augmented when we look up an instance.  These uses of dfuns are
 213           -- rather like the free variables of the program, but are implicit
 214           -- instead of explicit.
 215
 216         tcg_th_used :: TcRef Bool,
 217           -- ^ @True@ <=> Template Haskell syntax used.
 218           --
 219           -- We need this so that we can generate a dependency on the Template
 220           -- Haskell package, becuase the desugarer is going to emit loads of
 221           -- references to TH symbols.  It's rather like tcg_inst_uses; the
 222           -- reference is implicit rather than explicit, so we have to zap a
 223           -- mutable variable.
 224
 225         tcg_dfun_n  :: TcRef OccSet,
 226           -- ^ Allows us to choose unique DFun names.
 227
 228         -- The next fields accumulate the payload of the module
 229         -- The binds, rules and foreign-decl fiels are collected
 230         -- initially in un-zonked form and are finally zonked in tcRnSrcDecls
 231
 232         tcg_rn_exports :: Maybe [Located (IE Name)],
 233         tcg_rn_imports :: [LImportDecl Name],
 234                 -- Keep the renamed imports regardless.  They are not
 235                 -- voluminous and are needed if you want to report unused imports
 236         tcg_used_rdrnames :: TcRef (Set RdrName),
 237         tcg_rn_decls :: Maybe (HsGroup Name),
 238           -- ^ Renamed decls, maybe.  @Nothing@ <=> Don't retain renamed
 239           -- decls.
 240
 241         tcg_binds     :: LHsBinds Id,       -- Value bindings in this module
 242         tcg_warns     :: Warnings,          -- ...Warnings and deprecations
 243         tcg_anns      :: [Annotation],      -- ...Annotations
 244         tcg_insts     :: [Instance],        -- ...Instances
 245         tcg_fam_insts :: [FamInst],         -- ...Family instances
 246         tcg_rules     :: [LRuleDecl Id],    -- ...Rules
 247         tcg_fords     :: [LForeignDecl Id], -- ...Foreign import & exports
 248
 249         tcg_doc_hdr   :: Maybe LHsDocString, -- ^ Maybe Haddock header docs
 250         tcg_hpc :: AnyHpcUsage -- ^ @True@ if any part of the prog uses hpc
 251                                -- instrumentation.
 252     }
 253
 254 data RecFieldEnv
 255   = RecFields (NameEnv [Name])  -- Maps a constructor name *in this module*
 256                                 -- to the fields for that constructor
 257               NameSet           -- Set of all fields declared *in this module*;
 258                                 -- used to suppress name-shadowing complaints
 259                                 -- when using record wild cards
 260                                 -- E.g.  let fld = e in C {..}
 261         -- This is used when dealing with ".." notation in record
 262         -- construction and pattern matching.
 263         -- The FieldEnv deals *only* with constructors defined in *this*
 264         -- module.  For imported modules, we get the same info from the
 265         -- TypeEnv
 266 \end{code}
 267
 268 %************************************************************************
 269 %*                                                                      *
 270                 The interface environments
 271               Used when dealing with IfaceDecls
 272 %*                                                                      *
 273 %************************************************************************
 274
 275 \begin{code}
 276 data IfGblEnv
 277   = IfGblEnv {
 278         -- The type environment for the module being compiled,
 279         -- in case the interface refers back to it via a reference that
 280         -- was originally a hi-boot file.
 281         -- We need the module name so we can test when it's appropriate
 282         -- to look in this env.
 283         if_rec_types :: Maybe (Module, IfG TypeEnv)
 284                 -- Allows a read effect, so it can be in a mutable
 285                 -- variable; c.f. handling the external package type env
 286                 -- Nothing => interactive stuff, no loops possible
 287     }
 288
 289 data IfLclEnv
 290   = IfLclEnv {
 291         -- The module for the current IfaceDecl
 292         -- So if we see   f = \x -> x
 293         -- it means M.f = \x -> x, where M is the if_mod
 294         if_mod :: Module,
 295
 296         -- The field is used only for error reporting
 297         -- if (say) there's a Lint error in it
 298         if_loc :: SDoc,
 299                 -- Where the interface came from:
 300                 --      .hi file, or GHCi state, or ext core
 301                 -- plus which bit is currently being examined
 302
 303         if_tv_env  :: UniqFM TyVar,     -- Nested tyvar bindings
 304         if_id_env  :: UniqFM Id         -- Nested id binding
 305     }
 306 \end{code}
 307
 308
 309 %************************************************************************
 310 %*                                                                      *
 311                 The local typechecker environment
 312 %*                                                                      *
 313 %************************************************************************
 314
 315 The Global-Env/Local-Env story
 316 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 317 During type checking, we keep in the tcg_type_env
 318         * All types and classes
 319         * All Ids derived from types and classes (constructors, selectors)
 320
 321 At the end of type checking, we zonk the local bindings,
 322 and as we do so we add to the tcg_type_env
 323         * Locally defined top-level Ids
 324
 325 Why?  Because they are now Ids not TcIds.  This final GlobalEnv is
 326         a) fed back (via the knot) to typechecking the
 327            unfoldings of interface signatures
 328         b) used in the ModDetails of this module
 329
 330 \begin{code}
 331 data TcLclEnv           -- Changes as we move inside an expression
 332                         -- Discarded after typecheck/rename; not passed on to desugarer
 333   = TcLclEnv {
 334         tcl_loc  :: SrcSpan,            -- Source span
 335         tcl_ctxt :: [ErrCtxt],          -- Error context, innermost on top
 336         tcl_errs :: TcRef Messages,     -- Place to accumulate errors
 337
 338         tcl_th_ctxt    :: ThStage,            -- Template Haskell context
 339         tcl_arrow_ctxt :: ArrowCtxt,          -- Arrow-notation context
 340
 341         tcl_rdr :: LocalRdrEnv,         -- Local name envt
 342                 -- Maintained during renaming, of course, but also during
 343                 -- type checking, solely so that when renaming a Template-Haskell
 344                 -- splice we have the right environment for the renamer.
 345                 --
 346                 --   Does *not* include global name envt; may shadow it
 347                 --   Includes both ordinary variables and type variables;
 348                 --   they are kept distinct because tyvar have a different
 349                 --   occurrence contructor (Name.TvOcc)
 350                 -- We still need the unsullied global name env so that
 351                 --   we can look up record field names
 352
 353         tcl_env  :: NameEnv TcTyThing,  -- The local type environment: Ids and
 354                                         -- TyVars defined in this module
 355
 356         tcl_tyvars :: TcRef TcTyVarSet, -- The "global tyvars"
 357                         -- Namely, the in-scope TyVars bound in tcl_env,
 358                         -- plus the tyvars mentioned in the types of Ids bound
 359                         -- in tcl_lenv.
 360                         -- Why mutable? see notes with tcGetGlobalTyVars
 361
 362         tcl_lie   :: TcRef LIE,         -- Place to accumulate type constraints
 363
 364         tcl_tybinds :: TcRef TcTyVarBinds -- Meta and coercion type variable
 365                                           -- bindings accumulated during
 366                                           -- constraint solving
 367     }
 368
 369
 370 {- Note [Given Insts]
 371    ~~~~~~~~~~~~~~~~~~
 372 Because of GADTs, we have to pass inwards the Insts provided by type signatures
 373 and existential contexts. Consider
 374         data T a where { T1 :: b -> b -> T [b] }
 375         f :: Eq a => T a -> Bool
 376         f (T1 x y) = [x]==[y]
 377
 378 The constructor T1 binds an existential variable 'b', and we need Eq [b].
 379 Well, we have it, because Eq a refines to Eq [b], but we can only spot that if we
 380 pass it inwards.
 381
 382 -}
 383
 384 ---------------------------
 385 -- Template Haskell levels
 386 ---------------------------
 387
 388 type ThLevel = Int
 389         -- Indicates how many levels of brackets we are inside
 390         --      (always >= 0)
 391         -- Incremented when going inside a bracket,
 392         -- decremented when going inside a splice
 393         -- NB: ThLevel is one greater than the 'n' in Fig 2 of the
 394         --     original "Template meta-programming for Haskell" paper
 395
 396 impLevel, topLevel :: ThLevel
 397 topLevel = 1    -- Things defined at top level of this module
 398 impLevel = 0    -- Imported things; they can be used inside a top level splice
 399 --
 400 -- For example:
 401 --      f = ...
 402 --      g1 = $(map ...)         is OK
 403 --      g2 = $(f ...)           is not OK; because we havn't compiled f yet
 404
 405
 406 data ThStage
 407   = Comp   ThLevel                      -- Ordinary compiling, usually at level topLevel but annotations use a lower level
 408   | Splice ThLevel                      -- Inside a splice
 409   | Brack  ThLevel                      -- Inside brackets;
 410            (TcRef [PendingSplice])      --   accumulate pending splices here
 411            (TcRef LIE)                  --   and type constraints here
 412 topStage, topAnnStage, topSpliceStage :: ThStage
 413 topStage       = Comp topLevel
 414 topAnnStage    = Comp (topLevel - 1)
 415 topSpliceStage = Splice (topLevel - 1)  -- Stage for the body of a top-level splice
 416
 417 ---------------------------
 418 -- Arrow-notation context
 419 ---------------------------
 420
 421 {-
 422 In arrow notation, a variable bound by a proc (or enclosed let/kappa)
 423 is not in scope to the left of an arrow tail (-<) or the head of (|..|).
 424 For example
 425
 426         proc x -> (e1 -< e2)
 427
 428 Here, x is not in scope in e1, but it is in scope in e2.  This can get
 429 a bit complicated:
 430
 431         let x = 3 in
 432         proc y -> (proc z -> e1) -< e2
 433
 434 Here, x and z are in scope in e1, but y is not.  We implement this by
 435 recording the environment when passing a proc (using newArrowScope),
 436 and returning to that (using escapeArrowScope) on the left of -< and the
 437 head of (|..|).
 438 -}
 439
 440 data ArrowCtxt
 441   = NoArrowCtxt
 442   | ArrowCtxt (Env TcGblEnv TcLclEnv)
 443
 444 -- Record the current environment (outside a proc)
 445 newArrowScope :: TcM a -> TcM a
 446 newArrowScope
 447   = updEnv $ \env ->
 448         env { env_lcl = (env_lcl env) { tcl_arrow_ctxt = ArrowCtxt env } }
 449
 450 -- Return to the stored environment (from the enclosing proc)
 451 escapeArrowScope :: TcM a -> TcM a
 452 escapeArrowScope
 453   = updEnv $ \ env -> case tcl_arrow_ctxt (env_lcl env) of
 454         NoArrowCtxt -> env
 455         ArrowCtxt env' -> env'
 456
 457 ---------------------------
 458 -- TcTyThing
 459 ---------------------------
 460
 461 data TcTyThing
 462   = AGlobal TyThing             -- Used only in the return type of a lookup
 463
 464   | ATcId   {           -- Ids defined in this module; may not be fully zonked
 465         tct_id :: TcId,
 466         tct_co :: RefinementVisibility, -- Previously: Maybe HsWrapper
 467                                         -- Nothing <=>  Do not apply a GADT type refinement
 468                                         --              I am wobbly, or have no free
 469                                         --              type variables
 470                                         -- Just co <=>  Apply any type refinement to me,
 471                                         --              and record it in the coercion
 472         tct_type  :: TcType,    -- Type of (coercion applied to id)
 473         tct_level :: ThLevel }
 474
 475   | ATyVar  Name TcType         -- The type to which the lexically scoped type vaiable
 476                                 -- is currently refined. We only need the Name
 477                                 -- for error-message purposes
 478
 479   | AThing  TcKind              -- Used temporarily, during kind checking, for the
 480                                 --      tycons and clases in this recursive group
 481
 482 data RefinementVisibility
 483   = Unrefineable                        -- Do not apply a GADT refinement
 484                                         -- I have no free variables
 485
 486   | Rigid HsWrapper                     -- Apply any refinement to me
 487                                         -- and record it in the coercion
 488
 489   | Wobbly                              -- Do not apply a GADT refinement
 490                                         -- I am wobbly
 491
 492   | WobblyInvisible                     -- Wobbly type, not available inside current
 493                                         -- GADT refinement
 494
 495 instance Outputable TcTyThing where     -- Debugging only
 496    ppr (AGlobal g)      = pprTyThing g
 497    ppr elt@(ATcId {})   = text "Identifier" <>
 498                           ifPprDebug (brackets (ppr (tct_id elt) <> dcolon <> ppr (tct_type elt) <> comma
 499                                  <+> ppr (tct_level elt) <+> ppr (tct_co elt)))
 500    ppr (ATyVar tv _)    = text "Type variable" <+> quotes (ppr tv)
 501    ppr (AThing k)       = text "AThing" <+> ppr k
 502
 503 pprTcTyThingCategory :: TcTyThing -> SDoc
 504 pprTcTyThingCategory (AGlobal thing) = pprTyThingCategory thing
 505 pprTcTyThingCategory (ATyVar {})     = ptext (sLit "Type variable")
 506 pprTcTyThingCategory (ATcId {})      = ptext (sLit "Local identifier")
 507 pprTcTyThingCategory (AThing {})     = ptext (sLit "Kinded thing")
 508
 509 instance Outputable RefinementVisibility where
 510     ppr Unrefineable          = ptext (sLit "unrefineable")
 511     ppr (Rigid co)            = ptext (sLit "rigid") <+> ppr co
 512     ppr Wobbly                = ptext (sLit "wobbly")
 513     ppr WobblyInvisible       = ptext (sLit "wobbly-invisible")
 514
 515 \end{code}
 516
 517 \begin{code}
 518 type ErrCtxt = (Bool, TidyEnv -> TcM (TidyEnv, Message))
 519         -- Monadic so that we have a chance
 520         -- to deal with bound type variables just before error
 521         -- message construction
 522
 523         -- Bool:  True <=> this is a landmark context; do not
 524         --                 discard it when trimming for display
 525 \end{code}
 526
 527
 528 %************************************************************************
 529 %*                                                                      *
 530         Operations over ImportAvails
 531 %*                                                                      *
 532 %************************************************************************
 533
 534 \begin{code}
 535 -- | 'ImportAvails' summarises what was imported from where, irrespective of
 536 -- whether the imported things are actually used or not.  It is used:
 537 --
 538 --  * when processing the export list,
 539 --
 540 --  * when constructing usage info for the interface file,
 541 --
 542 --  * to identify the list of directly imported modules for initialisation
 543 --    purposes and for optimised overlap checking of family instances,
 544 --
 545 --  * when figuring out what things are really unused
 546 --
 547 data ImportAvails
 548    = ImportAvails {
 549         imp_mods :: ModuleEnv [(ModuleName, Bool, SrcSpan)],
 550           -- ^ Domain is all directly-imported modules
 551           -- The 'ModuleName' is what the module was imported as, e.g. in
 552           -- @
 553           --     import Foo as Bar
 554           -- @
 555           -- it is @Bar@.
 556           --
 557           -- The 'Bool' means:
 558           --
 559           --  - @True@ => import was @import Foo ()@
 560           --
 561           --  - @False@ => import was some other form
 562           --
 563           -- Used
 564           --
 565           --   (a) to help construct the usage information in the interface
 566           --       file; if we import somethign we need to recompile if the
 567           --       export version changes
 568           --
 569           --   (b) to specify what child modules to initialise
 570           --
 571           -- We need a full ModuleEnv rather than a ModuleNameEnv here,
 572           -- because we might be importing modules of the same name from
 573           -- different packages. (currently not the case, but might be in the
 574           -- future).
 575
 576         imp_dep_mods :: ModuleNameEnv (ModuleName, IsBootInterface),
 577           -- ^ Home-package modules needed by the module being compiled
 578           --
 579           -- It doesn't matter whether any of these dependencies
 580           -- are actually /used/ when compiling the module; they
 581           -- are listed if they are below it at all.  For
 582           -- example, suppose M imports A which imports X.  Then
 583           -- compiling M might not need to consult X.hi, but X
 584           -- is still listed in M's dependencies.
 585
 586         imp_dep_pkgs :: [PackageId],
 587           -- ^ Packages needed by the module being compiled, whether directly,
 588           -- or via other modules in this package, or via modules imported
 589           -- from other packages.
 590
 591         imp_orphs :: [Module],
 592           -- ^ Orphan modules below us in the import tree (and maybe including
 593           -- us for imported modules)
 594
 595         imp_finsts :: [Module]
 596           -- ^ Family instance modules below us in the import tree (and maybe
 597           -- including us for imported modules)
 598       }
 599
 600 mkModDeps :: [(ModuleName, IsBootInterface)]
 601           -> ModuleNameEnv (ModuleName, IsBootInterface)
 602 mkModDeps deps = foldl add emptyUFM deps
 603                where
 604                  add env elt@(m,_) = addToUFM env m elt
 605
 606 emptyImportAvails :: ImportAvails
 607 emptyImportAvails = ImportAvails { imp_mods     = emptyModuleEnv,
 608                                    imp_dep_mods = emptyUFM,
 609                                    imp_dep_pkgs = [],
 610                                    imp_orphs    = [],
 611                                    imp_finsts   = [] }
 612
 613 plusImportAvails ::  ImportAvails ->  ImportAvails ->  ImportAvails
 614 plusImportAvails
 615   (ImportAvails { imp_mods = mods1,
 616                   imp_dep_mods = dmods1, imp_dep_pkgs = dpkgs1,
 617                   imp_orphs = orphs1, imp_finsts = finsts1 })
 618   (ImportAvails { imp_mods = mods2,
 619                   imp_dep_mods = dmods2, imp_dep_pkgs = dpkgs2,
 620                   imp_orphs = orphs2, imp_finsts = finsts2 })
 621   = ImportAvails { imp_mods     = plusModuleEnv_C (++) mods1 mods2,
 622                    imp_dep_mods = plusUFM_C plus_mod_dep dmods1 dmods2,
 623                    imp_dep_pkgs = dpkgs1 `unionLists` dpkgs2,
 624                    imp_orphs    = orphs1 `unionLists` orphs2,
 625                    imp_finsts   = finsts1 `unionLists` finsts2 }
 626   where
 627     plus_mod_dep (m1, boot1) (m2, boot2)
 628         = WARN( not (m1 == m2), (ppr m1 <+> ppr m2) $$ (ppr boot1 <+> ppr boot2) )
 629                 -- Check mod-names match
 630           (m1, boot1 && boot2)  -- If either side can "see" a non-hi-boot interface, use that
 631 \end{code}
 632
 633 %************************************************************************
 634 %*                                                                      *
 635 \subsection{Where from}
 636 %*                                                                      *
 637 %************************************************************************
 638
 639 The @WhereFrom@ type controls where the renamer looks for an interface file
 640
 641 \begin{code}
 642 data WhereFrom
 643   = ImportByUser IsBootInterface        -- Ordinary user import (perhaps {-# SOURCE #-})
 644   | ImportBySystem                      -- Non user import.
 645
 646 instance Outputable WhereFrom where
 647   ppr (ImportByUser is_boot) | is_boot     = ptext (sLit "{- SOURCE -}")
 648                              | otherwise   = empty
 649   ppr ImportBySystem                       = ptext (sLit "{- SYSTEM -}")
 650 \end{code}
 651
 652
 653 %************************************************************************
 654 %*                                                                      *
 655 \subsection[Inst-types]{@Inst@ types}
 656 %*                                                                      *
 657 v%************************************************************************
 658
 659 An @Inst@ is either a dictionary, an instance of an overloaded
 660 literal, or an instance of an overloaded value.  We call the latter a
 661 ``method'' even though it may not correspond to a class operation.
 662 For example, we might have an instance of the @double@ function at
 663 type Int, represented by
 664
 665         Method 34 doubleId [Int] origin
 666
 667 In addition to the basic Haskell variants of 'Inst's, they can now also
 668 represent implication constraints 'forall tvs. given => wanted'
 669 and equality constraints 'co :: ty1 ~ ty2'.
 670
 671 NB: Equalities occur in two flavours:
 672
 673   (1) Dict {tci_pred = EqPred ty1 ty2}
 674   (2) EqInst {tci_left = ty1, tci_right = ty2, tci_co = coe}
 675
 676 The former arises from equalities in contexts, whereas the latter is used
 677 whenever the type checker introduces an equality (e.g., during deferring
 678 unification).
 679
 680 I am not convinced that this duplication is necessary or useful! -=chak
 681
 682 \begin{code}
 683 data Inst
 684   = Dict {
 685         tci_name :: Name,
 686         tci_pred :: TcPredType,   -- Class or implicit parameter only
 687         tci_loc  :: InstLoc
 688     }
 689
 690   | ImplicInst {        -- An implication constraint
 691                         -- forall tvs. given => wanted
 692         tci_name   :: Name,
 693         tci_tyvars :: [TcTyVar],    -- Quantified type variables
 694         tci_given  :: [Inst],       -- Only Dicts and EqInsts
 695                                     --   (no Methods, LitInsts, ImplicInsts)
 696         tci_wanted :: [Inst],       -- Only Dicts, EqInst, and ImplicInsts
 697                                     --   (no Methods or LitInsts)
 698
 699         tci_loc    :: InstLoc
 700     }
 701         -- NB: the tci_given are not necessarily rigid
 702
 703   | Method {
 704         tci_id :: TcId,         -- The Id for the Inst
 705
 706         tci_oid :: TcId,        -- The overloaded function
 707                 -- This function will be a global, local, or ClassOpId;
 708                 --   inside instance decls (only) it can also be an InstId!
 709                 -- The id needn't be completely polymorphic.
 710                 -- You'll probably find its name (for documentation purposes)
 711                 --        inside the InstOrigin
 712
 713         tci_tys :: [TcType],    -- The types to which its polymorphic tyvars
 714                                 --      should be instantiated.
 715                                 -- These types must saturate the Id's foralls.
 716
 717         tci_theta :: TcThetaType,
 718                         -- The (types of the) dictionaries to which the function
 719                         -- must be applied to get the method
 720
 721         tci_loc :: InstLoc
 722     }
 723         -- INVARIANT 1: in (Method m f tys theta tau loc)
 724         --      type of m = type of (f tys dicts(from theta))
 725
 726         -- INVARIANT 2: type of m must not be of form (Pred -> Tau)
 727         --   Reason: two methods are considered equal if the
 728         --           base Id matches, and the instantiating types
 729         --           match.  The TcThetaType should then match too.
 730         --   This only bites in the call to tcInstClassOp in TcClassDcl.mkMethodBind
 731
 732   | LitInst {
 733         tci_name :: Name,
 734         tci_lit  :: HsOverLit Name,     -- The literal from the occurrence site
 735                         -- INVARIANT: never a rebindable-syntax literal
 736                         -- Reason: tcSyntaxName does unification, and we
 737                         --         don't want to deal with that during tcSimplify,
 738                         --         when resolving LitInsts
 739
 740         tci_ty :: TcType,       -- The type at which the literal is used
 741         tci_loc :: InstLoc
 742     }
 743
 744   | EqInst {                      -- delayed unification of the form
 745                                   --    co :: ty1 ~ ty2
 746         tci_left  :: TcType,      -- ty1    -- both types are...
 747         tci_right :: TcType,      -- ty2    -- ...free of boxes
 748         tci_co    :: EqInstCo,            -- co
 749         tci_loc   :: InstLoc,
 750
 751         tci_name  :: Name       -- Debugging help only: this makes it easier to
 752                                 -- follow where a constraint is used in a morass
 753                                 -- of trace messages!  Unlike other Insts, it
 754                                 -- has no semantic significance whatsoever.
 755     }
 756
 757 type EqInstCo = Either    -- Distinguish between given and wanted coercions
 758                   TcTyVar   --  - a wanted equation, with a hole, to be filled
 759                             --    with a witness for the equality; for equation
 760                             --    arising from deferring unification, 'ty1' is
 761                             --    the actual and 'ty2' the expected type
 762                   Coercion  --  - a given equation, with a coercion witnessing
 763                             --    the equality; a coercion that originates
 764                             --    from a signature or a GADT is a CoVar, but
 765                             --    after normalisation of coercions, they can
 766                             --    be arbitrary Coercions involving constructors
 767                             --    and pseudo-constructors like sym and trans.
 768 \end{code}
 769
 770 @Insts@ are ordered by their class/type info, rather than by their
 771 unique.  This allows the context-reduction mechanism to use standard finite
 772 maps to do their stuff.  It's horrible that this code is here, rather
 773 than with the Avails handling stuff in TcSimplify
 774
 775 \begin{code}
 776 instance Ord Inst where
 777    compare = cmpInst
 778         -- Used *only* for AvailEnv in TcSimplify
 779
 780 instance Eq Inst where
 781   (==) i1 i2 = case i1 `cmpInst` i2 of
 782                EQ -> True
 783                _  -> False
 784
 785 cmpInst :: Inst -> Inst -> Ordering
 786 cmpInst d1@(Dict {})    d2@(Dict {})    = tci_pred d1 `tcCmpPred` tci_pred d2
 787 cmpInst (Dict {})       _               = LT
 788
 789 cmpInst (Method {})     (Dict {})       = GT
 790 cmpInst m1@(Method {})  m2@(Method {})  = (tci_oid m1 `compare` tci_oid m2) `thenCmp`
 791                                           (tci_tys m1 `tcCmpTypes` tci_tys m2)
 792 cmpInst (Method {})     _               = LT
 793
 794 cmpInst (LitInst {})    (Dict {})       = GT
 795 cmpInst (LitInst {})    (Method {})     = GT
 796 cmpInst l1@(LitInst {}) l2@(LitInst {}) = (tci_lit l1 `compare` tci_lit l2) `thenCmp`
 797                                           (tci_ty l1 `tcCmpType` tci_ty l2)
 798 cmpInst (LitInst {})    _               = LT
 799
 800         -- Implication constraints are compared by *name*
 801         -- not by type; that is, we make no attempt to do CSE on them
 802 cmpInst (ImplicInst {})    (Dict {})          = GT
 803 cmpInst (ImplicInst {})    (Method {})        = GT
 804 cmpInst (ImplicInst {})    (LitInst {})       = GT
 805 cmpInst i1@(ImplicInst {}) i2@(ImplicInst {}) = tci_name i1 `compare` tci_name i2
 806 cmpInst (ImplicInst {})    _                  = LT
 807
 808         -- same for Equality constraints
 809 cmpInst (EqInst {})    (Dict {})       = GT
 810 cmpInst (EqInst {})    (Method {})     = GT
 811 cmpInst (EqInst {})    (LitInst {})    = GT
 812 cmpInst (EqInst {})    (ImplicInst {}) = GT
 813 cmpInst i1@(EqInst {}) i2@(EqInst {})  = (tci_left  i1 `tcCmpType` tci_left  i2) `thenCmp`
 814                                          (tci_right i1 `tcCmpType` tci_right i2)
 815 \end{code}
 816
 817
 818 %************************************************************************
 819 %*                                                                      *
 820 \subsection[Inst-collections]{LIE: a collection of Insts}
 821 %*                                                                      *
 822 %************************************************************************
 823
 824 \begin{code}
 825 -- FIXME: Rename this. It clashes with (Located (IE ...))
 826 type LIE = Bag Inst
 827
 828 isEmptyLIE :: LIE -> Bool
 829 isEmptyLIE = isEmptyBag
 830
 831 emptyLIE :: LIE
 832 emptyLIE = emptyBag
 833
 834 unitLIE :: Inst -> LIE
 835 unitLIE inst = unitBag inst
 836
 837 mkLIE :: [Inst] -> LIE
 838 mkLIE insts = listToBag insts
 839
 840 plusLIE :: LIE -> LIE -> LIE
 841 plusLIE lie1 lie2 = lie1 `unionBags` lie2
 842
 843 plusLIEs :: [LIE] -> LIE
 844 plusLIEs lies = unionManyBags lies
 845
 846 lieToList :: LIE -> [Inst]
 847 lieToList = bagToList
 848
 849 listToLIE :: [Inst] -> LIE
 850 listToLIE = listToBag
 851
 852 consLIE :: Inst -> LIE -> LIE
 853 consLIE inst lie  = lie `snocBag` inst
 854 -- Putting the new Inst at the *end* of the bag is a half-hearted attempt
 855 -- to ensure that we tend to report the *leftmost* type-constraint error
 856 -- E.g.         f :: [a]
 857 --              f = [1,2,3]
 858 -- we'd like to complain about the '1', not the '3'.
 859 --
 860 -- "Half-hearted" because the rest of the type checker makes no great
 861 -- claims for retaining order in the constraint set.  Still, this
 862 -- seems to improve matters slightly.  Exampes: mdofail001, tcfail015
 863 \end{code}
 864
 865
 866 %************************************************************************
 867 %*                                                                      *
 868 \subsection[Inst-origin]{The @InstOrigin@ type}
 869 %*                                                                      *
 870 %************************************************************************
 871
 872 The @InstOrigin@ type gives information about where a dictionary came from.
 873 This is important for decent error message reporting because dictionaries
 874 don't appear in the original source code.  Doubtless this type will evolve...
 875
 876 It appears in TcMonad because there are a couple of error-message-generation
 877 functions that deal with it.
 878
 879 \begin{code}
 880 -------------------------------------------
 881 data InstLoc = InstLoc InstOrigin SrcSpan [ErrCtxt]
 882
 883 instLoc :: Inst -> InstLoc
 884 instLoc inst = tci_loc inst
 885
 886 setInstLoc :: Inst -> InstLoc -> Inst
 887 setInstLoc inst new_loc = inst { tci_loc = new_loc }
 888
 889 instSpan :: Inst -> SrcSpan
 890 instSpan wanted = instLocSpan (instLoc wanted)
 891
 892 instLocSpan :: InstLoc -> SrcSpan
 893 instLocSpan (InstLoc _ s _) = s
 894
 895 instLocOrigin :: InstLoc -> InstOrigin
 896 instLocOrigin (InstLoc o _ _) = o
 897
 898 pprInstArising :: Inst -> SDoc
 899 pprInstArising loc = ptext (sLit "arising from") <+> pprInstLoc (tci_loc loc)
 900
 901 pprInstLoc :: InstLoc -> SDoc
 902 pprInstLoc (InstLoc orig span _) = sep [ppr orig, text "at" <+> ppr span]
 903
 904 -------------------------------------------
 905 data InstOrigin
 906   = SigOrigin SkolemInfo        -- Pattern, class decl, inst decl etc;
 907                                 -- Places that bind type variables and introduce
 908                                 -- available constraints
 909
 910   | IPBindOrigin (IPName Name)  -- Binding site of an implicit parameter
 911
 912         -------------------------------------------------------
 913         -- The rest are all occurrences: Insts that are 'wanted'
 914         -------------------------------------------------------
 915   | OccurrenceOf Name           -- Occurrence of an overloaded identifier
 916   | SpecPragOrigin Name         -- Specialisation pragma for identifier
 917
 918   | IPOccOrigin  (IPName Name)  -- Occurrence of an implicit parameter
 919
 920   | LiteralOrigin (HsOverLit Name)      -- Occurrence of a literal
 921   | NegateOrigin                        -- Occurrence of syntactic negation
 922
 923   | ArithSeqOrigin (ArithSeqInfo Name) -- [x..], [x..y] etc
 924   | PArrSeqOrigin  (ArithSeqInfo Name) -- [:x..y:] and [:x,y..z:]
 925   | TupleOrigin                        -- (..,..)
 926
 927   | InstSigOrigin       -- A dict occurrence arising from instantiating
 928                         -- a polymorphic type during a subsumption check
 929
 930   | ExprSigOrigin       -- e :: ty
 931   | RecordUpdOrigin
 932   | ViewPatOrigin
 933
 934   | InstScOrigin        -- Typechecking superclasses of an instance declaration
 935
 936   | NoScOrigin          -- A very special hack; see TcSimplify,
 937                         --   Note [Recursive instances and superclases]
 938
 939
 940   | DerivOrigin         -- Typechecking deriving
 941   | StandAloneDerivOrigin -- Typechecking stand-alone deriving
 942   | DefaultOrigin       -- Typechecking a default decl
 943   | DoOrigin            -- Arising from a do expression
 944   | ProcOrigin          -- Arising from a proc expression
 945   | ImplicOrigin SDoc   -- An implication constraint
 946   | EqOrigin            -- A type equality
 947   | AnnOrigin           -- An annotation
 948
 949 instance Outputable InstOrigin where
 950     ppr (OccurrenceOf name)   = hsep [ptext (sLit "a use of"), quotes (ppr name)]
 951     ppr (SpecPragOrigin name) = hsep [ptext (sLit "a specialisation pragma for"), quotes (ppr name)]
 952     ppr (IPOccOrigin name)    = hsep [ptext (sLit "a use of implicit parameter"), quotes (ppr name)]
 953     ppr (IPBindOrigin name)   = hsep [ptext (sLit "a binding for implicit parameter"), quotes (ppr name)]
 954     ppr RecordUpdOrigin       = ptext (sLit "a record update")
 955     ppr ExprSigOrigin         = ptext (sLit "an expression type signature")
 956     ppr ViewPatOrigin         = ptext (sLit "a view pattern")
 957     ppr (LiteralOrigin lit)   = hsep [ptext (sLit "the literal"), quotes (ppr lit)]
 958     ppr (ArithSeqOrigin seq)  = hsep [ptext (sLit "the arithmetic sequence"), quotes (ppr seq)]
 959     ppr (PArrSeqOrigin seq)   = hsep [ptext (sLit "the parallel array sequence"), quotes (ppr seq)]
 960     ppr TupleOrigin           = ptext (sLit "a tuple")
 961     ppr NegateOrigin          = ptext (sLit "a use of syntactic negation")
 962     ppr InstScOrigin          = ptext (sLit "the superclasses of an instance declaration")
 963     ppr NoScOrigin            = ptext (sLit "an instance declaration")
 964     ppr DerivOrigin           = ptext (sLit "the 'deriving' clause of a data type declaration")
 965     ppr StandAloneDerivOrigin = ptext (sLit "a 'deriving' declaration")
 966     ppr DefaultOrigin         = ptext (sLit "a 'default' declaration")
 967     ppr DoOrigin              = ptext (sLit "a do statement")
 968     ppr ProcOrigin            = ptext (sLit "a proc expression")
 969     ppr (ImplicOrigin doc)    = doc
 970     ppr (SigOrigin info)      = pprSkolInfo info
 971     ppr EqOrigin              = ptext (sLit "a type equality")
 972     ppr InstSigOrigin         = panic "ppr InstSigOrigin"
 973     ppr AnnOrigin             = ptext (sLit "an annotation")
 974 \end{code}