TcRnTypes.hs 133 KB
Newer Older
Austin Seipp's avatar
Austin Seipp committed
1 2 3
{-
(c) The University of Glasgow 2006-2012
(c) The GRASP Project, Glasgow University, 1992-2002
4

5 6 7 8 9 10 11 12 13 14 15 16

Various types used during typechecking, please see TcRnMonad as well for
operations on these types. You probably want to import it, instead of this
module.

All the monads exported here are built on top of the same IOEnv monad. The
monad functions like a Reader monad in the way it passes the environment
around. This is done to allow the environment to be manipulated in a stack
like fashion when entering expressions... ect.

For state that is global and should be returned at the end (e.g not part
of the stack mechanism), you should use an TcRef (= IORef) to store them.
Austin Seipp's avatar
Austin Seipp committed
17
-}
18

19 20
{-# LANGUAGE CPP, ExistentialQuantification, GeneralizedNewtypeDeriving,
             ViewPatterns #-}
21

22
module TcRnTypes(
23 24
        TcRnIf, TcRn, TcM, RnM, IfM, IfL, IfG, -- The monad is opaque outside this module
        TcRef,
25

26 27 28 29
        -- The environment types
        Env(..),
        TcGblEnv(..), TcLclEnv(..),
        IfGblEnv(..), IfLclEnv(..),
30
        tcVisibleOrphanMods,
31

32 33 34
        -- Frontend types (shouldn't really be here)
        FrontendResult(..),

35
        -- Renamer types
Adam Gundry's avatar
Adam Gundry committed
36
        ErrCtxt, RecFieldEnv,
37 38
        ImportAvails(..), emptyImportAvails, plusImportAvails,
        WhereFrom(..), mkModDeps,
39

40
        -- Typechecker types
41 42
        TcTypeEnv, TcIdBinderStack, TcIdBinder(..),
        TcTyThing(..), PromotionErr(..),
43 44
        IdBindingInfo(..),
        IsGroupClosed(..),
Simon Peyton Jones's avatar
Simon Peyton Jones committed
45
        SelfBootInfo(..),
46
        pprTcTyThingCategory, pprPECategory,
47

48 49 50 51
        -- Desugaring types
        DsM, DsLclEnv(..), DsGblEnv(..), PArrBuiltin(..),
        DsMetaEnv, DsMetaVal(..),

52
        -- Template Haskell
53 54
        ThStage(..), SpliceType(..), PendingStuff(..),
        topStage, topAnnStage, topSpliceStage,
55
        ThLevel, impLevel, outerLevel, thLevel,
56

57
        -- Arrows
58
        ArrowCtxt(..),
ross's avatar
ross committed
59

60
        -- TcSigInfo
61 62 63
        TcSigInfo(..), TcIdSigInfo(..),
        TcIdSigInst(..), TcPatSynInfo(..),
        isPartialSig,
64

65
        -- Canonical constraints
66 67
        Xi, Ct(..), Cts, emptyCts, andCts, andManyCts, pprCts,
        singleCt, listToCts, ctsElts, consCts, snocCts, extendCtsList,
68
        isEmptyCts, isCTyEqCan, isCFunEqCan,
69
        isPendingScDict, superClassesMightHelp,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
70
        isCDictCan_Maybe, isCFunEqCan_maybe,
71
        isCIrredEvCan, isCNonCanonical, isWantedCt, isDerivedCt,
72
        isGivenCt, isHoleCt, isOutOfScopeCt, isExprHoleCt, isTypeHoleCt,
Eric Seidel's avatar
Eric Seidel committed
73
        isUserTypeErrorCt, getUserTypeErrorMsg,
74
        ctEvidence, ctLoc, setCtLoc, ctPred, ctFlavour, ctEqRel, ctOrigin,
75
        mkTcEqPredLikeEv,
76
        mkNonCanonical, mkNonCanonicalCt, mkGivens,
77
        ctEvPred, ctEvLoc, ctEvOrigin, ctEvEqRel,
78
        ctEvTerm, ctEvCoercion, ctEvId,
79 80
        tyCoVarsOfCt, tyCoVarsOfCts,
        tyCoVarsOfCtList, tyCoVarsOfCtsList,
81

82
        WantedConstraints(..), insolubleWC, emptyWC, isEmptyWC,
83
        andWC, unionsWC, mkSimpleWC, mkImplicWC,
84
        addInsols, getInsolubles, insolublesOnly, addSimples, addImplics,
85
        tyCoVarsOfWC, dropDerivedWC, dropDerivedSimples, dropDerivedInsols,
86
        tyCoVarsOfWCList,
87
        isDroppableDerivedLoc, insolubleImplic,
88
        arisesFromGivens,
89

90
        Implication(..), ImplicStatus(..), isInsolubleStatus, isSolvedStatus,
91
        SubGoalDepth, initialSubGoalDepth, maxSubGoalDepth,
92
        bumpSubGoalDepth, subGoalDepthExceeded,
93
        CtLoc(..), ctLocSpan, ctLocEnv, ctLocLevel, ctLocOrigin,
94
        ctLocTypeOrKind_maybe,
95
        ctLocDepth, bumpCtLocDepth,
thomasw's avatar
thomasw committed
96
        setCtLocOrigin, setCtLocEnv, setCtLocSpan,
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
97 98
        CtOrigin(..), exprCtOrigin, matchesCtOrigin, grhssCtOrigin,
        ErrorThing(..), mkErrorThing, errorThingNumArgs_maybe,
99 100
        TypeOrKind(..), isTypeLevel, isKindLevel,
        pprCtOrigin, pprCtLoc,
101
        pushErrCtxt, pushErrCtxtSameOrigin,
102

103
        SkolemInfo(..), pprSigSkolInfo, pprSkolInfo,
104
        termEvidenceAllowed,
105

106 107
        CtEvidence(..), TcEvDest(..),
        mkGivenLoc, mkKindLoc, toKindLoc,
108
        isWanted, isGiven, isDerived, isGivenOrWDeriv,
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
109
        ctEvRole,
110

Adam Gundry's avatar
Adam Gundry committed
111 112 113
        -- Constraint solver plugins
        TcPlugin(..), TcPluginResult(..), TcPluginSolver,
        TcPluginM, runTcPluginM, unsafeTcPluginTcM,
114
        getEvBindsTcPluginM,
Adam Gundry's avatar
Adam Gundry committed
115

116
        CtFlavour(..), ShadowInfo(..), ctEvFlavour,
117
        CtFlavourRole, ctEvFlavourRole, ctFlavourRole,
118 119 120
        eqCanRewriteFR, eqMayRewriteFR,
        eqCanDischarge,
        funEqCanDischarge, funEqCanDischargeF,
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
121

122
        -- Pretty printing
Austin Seipp's avatar
Austin Seipp committed
123
        pprEvVarTheta,
124
        pprEvVars, pprEvVarWithType,
125

126
        -- Misc other types
127
        TcId, TcIdSet,
Edward Z. Yang's avatar
Edward Z. Yang committed
128 129
        Hole(..), holeOcc,
        NameShape(..)
130

131 132 133 134
  ) where

#include "HsVersions.h"

135
import HsSyn
Facundo Domínguez's avatar
Facundo Domínguez committed
136
import CoreSyn
137
import HscTypes
138
import TcEvidence
139
import Type
140
import Class    ( Class )
141
import TyCon    ( TyCon )
142
import Coercion ( Coercion, mkHoleCo )
cactus's avatar
cactus committed
143
import ConLike  ( ConLike(..) )
144
import DataCon  ( DataCon, dataConUserType, dataConOrigArgTys )
145
import PatSyn   ( PatSyn, pprPatSynType )
146
import Id       ( idType, idName )
Adam Gundry's avatar
Adam Gundry committed
147
import FieldLabel ( FieldLabel )
148
import TcType
149
import Annotations
150 151
import InstEnv
import FamInstEnv
152
import PmExpr
153
import IOEnv
154 155
import RdrName
import Name
156
import NameEnv
157
import NameSet
158
import Avail
159
import Var
160
import FV
161
import VarEnv
162
import Module
163 164 165
import SrcLoc
import VarSet
import ErrUtils
166
import UniqDFM
167 168
import UniqSupply
import BasicTypes
169
import Bag
Ian Lynagh's avatar
Ian Lynagh committed
170
import DynFlags
171
import Outputable
172
import ListSetOps
173
import FastString
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
174
import qualified GHC.LanguageExtensions as LangExt
Edward Z. Yang's avatar
Edward Z. Yang committed
175
import Fingerprint
176
import Util
177

178
import Control.Monad (ap, liftM, msum)
quchen's avatar
quchen committed
179 180 181
#if __GLASGOW_HASKELL__ > 710
import qualified Control.Monad.Fail as MonadFail
#endif
182
import Data.Set      ( Set )
183

184 185 186
import Data.Map      ( Map )
import Data.Dynamic  ( Dynamic )
import Data.Typeable ( TypeRep )
187
import GHCi.Message
188
import GHCi.RemoteTypes
189

190
import qualified Language.Haskell.TH as TH
191

Edward Z. Yang's avatar
Edward Z. Yang committed
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
-- | A 'NameShape' is a substitution on 'Name's that can be used
-- to refine the identities of a hole while we are renaming interfaces
-- (see 'RnModIface').  Specifically, a 'NameShape' for
-- 'ns_module_name' @A@, defines a mapping from @{A.T}@
-- (for some 'OccName' @T@) to some arbitrary other 'Name'.
--
-- The most intruiging thing about a 'NameShape', however, is
-- how it's constructed.  A 'NameShape' is *implied* by the
-- exported 'AvailInfo's of the implementor of an interface:
-- if an implementor of signature @<H>@ exports @M.T@, you implicitly
-- define a substitution from @{H.T}@ to @M.T@.  So a 'NameShape'
-- is computed from the list of 'AvailInfo's that are exported
-- by the implementation of a module, or successively merged
-- together by the export lists of signatures which are joining
-- together.
--
-- It's not the most obvious way to go about doing this, but it
-- does seem to work!
--
-- NB: Can't boot this and put it in NameShape because then we
-- start pulling in too many DynFlags things.
data NameShape = NameShape {
        ns_mod_name :: ModuleName,
        ns_exports :: [AvailInfo],
        ns_map :: OccEnv Name
    }


Austin Seipp's avatar
Austin Seipp committed
220 221 222
{-
************************************************************************
*                                                                      *
223
               Standard monad definition for TcRn
224
    All the combinators for the monad can be found in TcRnMonad
Austin Seipp's avatar
Austin Seipp committed
225 226
*                                                                      *
************************************************************************
227

228
The monad itself has to be defined here, because it is mentioned by ErrCtxt
Austin Seipp's avatar
Austin Seipp committed
229
-}
230

cactus's avatar
cactus committed
231
type TcRnIf a b = IOEnv (Env a b)
232 233 234 235 236 237 238 239 240 241 242 243
type TcRn       = TcRnIf TcGblEnv TcLclEnv    -- Type inference
type IfM lcl    = TcRnIf IfGblEnv lcl         -- Iface stuff
type IfG        = IfM ()                      --    Top level
type IfL        = IfM IfLclEnv                --    Nested
type DsM        = TcRnIf DsGblEnv DsLclEnv    -- Desugaring

-- TcRn is the type-checking and renaming monad: the main monad that
-- most type-checking takes place in.  The global environment is
-- 'TcGblEnv', which tracks all of the top-level type-checking
-- information we've accumulated while checking a module, while the
-- local environment is 'TcLclEnv', which tracks local information as
-- we move inside expressions.
Edward Z. Yang's avatar
Edward Z. Yang committed
244 245 246 247 248 249

-- | Historical "renaming monad" (now it's just 'TcRn').
type RnM  = TcRn

-- | Historical "type-checking monad" (now it's just 'TcRn').
type TcM  = TcRn
250

Rik Steenkamp's avatar
Rik Steenkamp committed
251
-- We 'stack' these envs through the Reader like monad infrastructure
252 253 254
-- as we move into an expression (although the change is focused in
-- the lcl type).
data Env gbl lcl
255
  = Env {
256 257
        env_top  :: HscEnv,  -- Top-level stuff that never changes
                             -- Includes all info about imported things
258

259
        env_us   :: {-# UNPACK #-} !(IORef UniqSupply),
Rik Steenkamp's avatar
Rik Steenkamp committed
260
                             -- Unique supply for local variables
261

262 263
        env_gbl  :: gbl,     -- Info about things defined at the top level
                             -- of the module being compiled
264

265
        env_lcl  :: lcl      -- Nested stuff; changes as we go into
266
    }
267

Ian Lynagh's avatar
Ian Lynagh committed
268 269 270
instance ContainsDynFlags (Env gbl lcl) where
    extractDynFlags env = hsc_dflags (env_top env)

271 272 273
instance ContainsModule gbl => ContainsModule (Env gbl lcl) where
    extractModule env = extractModule (env_gbl env)

274 275 276 277 278 279 280 281 282 283 284 285

{-
************************************************************************
*                                                                      *
                The interface environments
              Used when dealing with IfaceDecls
*                                                                      *
************************************************************************
-}

data IfGblEnv
  = IfGblEnv {
286 287 288
        -- Some information about where this environment came from;
        -- useful for debugging.
        if_doc :: SDoc,
289 290 291 292 293
        -- The type environment for the module being compiled,
        -- in case the interface refers back to it via a reference that
        -- was originally a hi-boot file.
        -- We need the module name so we can test when it's appropriate
        -- to look in this env.
294
        -- See Note [Tying the knot] in TcIface
295 296 297 298 299 300 301 302 303 304 305
        if_rec_types :: Maybe (Module, IfG TypeEnv)
                -- Allows a read effect, so it can be in a mutable
                -- variable; c.f. handling the external package type env
                -- Nothing => interactive stuff, no loops possible
    }

data IfLclEnv
  = IfLclEnv {
        -- The module for the current IfaceDecl
        -- So if we see   f = \x -> x
        -- it means M.f = \x -> x, where M is the if_mod
Edward Z. Yang's avatar
Edward Z. Yang committed
306 307
        -- NB: This is a semantic module, see
        -- Note [Identity versus semantic module]
308 309
        if_mod :: Module,

310 311 312 313 314
        -- Whether or not the IfaceDecl came from a boot
        -- file or not; we'll use this to choose between
        -- NoUnfolding and BootUnfolding
        if_boot :: Bool,

315 316 317 318 319 320 321
        -- The field is used only for error reporting
        -- if (say) there's a Lint error in it
        if_loc :: SDoc,
                -- Where the interface came from:
                --      .hi file, or GHCi state, or ext core
                -- plus which bit is currently being examined

Edward Z. Yang's avatar
Edward Z. Yang committed
322 323
        if_nsubst :: Maybe NameShape,

324 325 326
        -- This field is used to make sure "implicit" declarations
        -- (anything that cannot be exported in mi_exports) get
        -- wired up correctly in typecheckIfacesForMerging.  Most
327
        -- of the time it's @Nothing@.  See Note [Resolving never-exported Names in TcIface]
328 329 330
        -- in TcIface.
        if_implicits_env :: Maybe TypeEnv,

niteria's avatar
niteria committed
331 332
        if_tv_env  :: FastStringEnv TyVar,     -- Nested tyvar bindings
        if_id_env  :: FastStringEnv Id         -- Nested id binding
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
    }

{-
************************************************************************
*                                                                      *
                Desugarer monad
*                                                                      *
************************************************************************

Now the mondo monad magic (yes, @DsM@ is a silly name)---carry around
a @UniqueSupply@ and some annotations, which
presumably include source-file location information:
-}

-- If '-XParallelArrays' is given, the desugarer populates this table with the corresponding
-- variables found in 'Data.Array.Parallel'.
--
data PArrBuiltin
        = PArrBuiltin
        { lengthPVar         :: Var     -- ^ lengthP
        , replicatePVar      :: Var     -- ^ replicateP
        , singletonPVar      :: Var     -- ^ singletonP
        , mapPVar            :: Var     -- ^ mapP
        , filterPVar         :: Var     -- ^ filterP
        , zipPVar            :: Var     -- ^ zipP
        , crossMapPVar       :: Var     -- ^ crossMapP
        , indexPVar          :: Var     -- ^ (!:)
        , emptyPVar          :: Var     -- ^ emptyP
        , appPVar            :: Var     -- ^ (+:+)
        , enumFromToPVar     :: Var     -- ^ enumFromToP
        , enumFromThenToPVar :: Var     -- ^ enumFromThenToP
        }

data DsGblEnv
        = DsGblEnv
        { ds_mod          :: Module             -- For SCC profiling
        , ds_fam_inst_env :: FamInstEnv         -- Like tcg_fam_inst_env
        , ds_unqual  :: PrintUnqualified
        , ds_msgs    :: IORef Messages          -- Warning messages
        , ds_if_env  :: (IfGblEnv, IfLclEnv)    -- Used for looking up global,
                                                -- possibly-imported things
        , ds_dph_env :: GlobalRdrEnv            -- exported entities of 'Data.Array.Parallel.Prim'
                                                -- iff '-fvectorise' flag was given as well as
                                                -- exported entities of 'Data.Array.Parallel' iff
                                                -- '-XParallelArrays' was given; otherwise, empty
        , ds_parr_bi :: PArrBuiltin             -- desugarar names for '-XParallelArrays'
        }

instance ContainsModule DsGblEnv where
    extractModule = ds_mod

data DsLclEnv = DsLclEnv {
        dsl_meta    :: DsMetaEnv,        -- Template Haskell bindings
386 387
        dsl_loc     :: RealSrcSpan,      -- To put in pattern-matching error msgs
        dsl_dicts   :: Bag EvVar,        -- Constraints from GADT pattern-matching
388 389
        dsl_tm_cs   :: Bag SimpleEq,
        dsl_pm_iter :: IORef Int         -- no iterations for pmcheck
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
     }

-- Inside [| |] brackets, the desugarer looks
-- up variables in the DsMetaEnv
type DsMetaEnv = NameEnv DsMetaVal

data DsMetaVal
   = DsBound Id         -- Bound by a pattern inside the [| |].
                        -- Will be dynamically alpha renamed.
                        -- The Id has type THSyntax.Var

   | DsSplice (HsExpr Id) -- These bindings are introduced by
                          -- the PendingSplices on a HsBracketOut


{-
************************************************************************
*                                                                      *
                Global typechecker environment
*                                                                      *
************************************************************************
-}

413 414 415 416 417 418 419 420
-- | 'FrontendResult' describes the result of running the
-- frontend of a Haskell module.  Usually, you'll get
-- a 'FrontendTypecheck', since running the frontend involves
-- typechecking a program, but for an hs-boot merge you'll
-- just get a ModIface, since no actual typechecking occurred.
--
-- This data type really should be in HscTypes, but it needs
-- to have a TcGblEnv which is only defined here.
421 422 423
data FrontendResult
        = FrontendTypecheck TcGblEnv

Edward Z. Yang's avatar
Edward Z. Yang committed
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
-- Note [Identity versus semantic module]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- When typechecking an hsig file, it is convenient to keep track
-- of two different "this module" identifiers:
--
--      - The IDENTITY module is simply thisPackage + the module
--        name; i.e. it uniquely *identifies* the interface file
--        we're compiling.  For example, p[A=<A>]:A is an
--        identity module identifying the requirement named A
--        from library p.
--
--      - The SEMANTIC module, which is the actual module that
--        this signature is intended to represent (e.g. if
--        we have a identity module p[A=base:Data.IORef]:A,
--        then the semantic module is base:Data.IORef)
--
-- Which one should you use?
--
--      - In the desugarer and later phases of compilation,
--        identity and semantic modules coincide, since we never compile
--        signatures (we just generate blank object files for
--        hsig files.)
--
447 448 449 450 451 452 453
--        A corrolary of this is that the following invariant holds at any point
--        past desugaring,
--
--            if I have a Module, this_mod, in hand representing the module
--            currently being compiled,
--            then moduleUnitId this_mod == thisPackage dflags
--
Edward Z. Yang's avatar
Edward Z. Yang committed
454 455 456 457 458 459 460 461 462 463 464 465 466
--      - For any code involving Names, we want semantic modules.
--        See lookupIfaceTop in IfaceEnv, mkIface and addFingerprints
--        in MkIface, and tcLookupGlobal in TcEnv
--
--      - When reading interfaces, we want the identity module to
--        identify the specific interface we want (such interfaces
--        should never be loaded into the EPS).  However, if a
--        hole module <A> is requested, we look for A.hi
--        in the home library we are compiling.  (See LoadIface.)
--        Similarly, in RnNames we check for self-imports using
--        identity modules, to allow signatures to import their implementor.


Edward Z. Yang's avatar
Edward Z. Yang committed
467
-- | 'TcGblEnv' describes the top-level of the module at the
468 469
-- point at which the typechecker is finished work.
-- It is this structure that is handed on to the desugarer
470
-- For state that needs to be updated during the typechecking
Edward Z. Yang's avatar
Edward Z. Yang committed
471
-- phase and returned at end, use a 'TcRef' (= 'IORef').
472 473
data TcGblEnv
  = TcGblEnv {
474
        tcg_mod     :: Module,         -- ^ Module being compiled
Edward Z. Yang's avatar
Edward Z. Yang committed
475 476
        tcg_semantic_mod :: Module,    -- ^ If a signature, the backing module
            -- See also Note [Identity versus semantic module]
477
        tcg_src     :: HscSource,
478
          -- ^ What kind of module (regular Haskell, hs-boot, hsig)
479

480 481
        tcg_rdr_env :: GlobalRdrEnv,   -- ^ Top level envt; used during renaming
        tcg_default :: Maybe [Type],
482
          -- ^ Types used for defaulting. @Nothing@ => no @default@ decl
483

484 485
        tcg_fix_env   :: FixityEnv,     -- ^ Just for things in this module
        tcg_field_env :: RecFieldEnv,   -- ^ Just for things in this module
486
                                        -- See Note [The interactive package] in HscTypes
487

488
        tcg_type_env :: TypeEnv,
489
          -- ^ Global type env for the module we are compiling now.  All
490 491 492 493 494
          -- TyCons and Classes (for this module) end up in here right away,
          -- along with their derived constructors, selectors.
          --
          -- (Ids defined in this module start in the local envt, though they
          --  move to the global envt during zonking)
495 496 497
          --
          -- NB: for what "things in this module" means, see
          -- Note [The interactive package] in HscTypes
498 499 500 501 502 503 504 505 506

        tcg_type_env_var :: TcRef TypeEnv,
                -- Used only to initialise the interface-file
                -- typechecker in initIfaceTcRn, so that it can see stuff
                -- bound in this module when dealing with hi-boot recursions
                -- Updated at intervals (e.g. after dealing with types and classes)

        tcg_inst_env     :: InstEnv,
          -- ^ Instance envt for all /home-package/ modules;
507
          -- Includes the dfuns in tcg_insts
508
        tcg_fam_inst_env :: FamInstEnv, -- ^ Ditto for family instances
509
        tcg_ann_env      :: AnnEnv,     -- ^ And for annotations
510

511 512 513 514 515 516 517
        -- | Family instances we have to check for consistency.
        -- Invariant: each FamInst in the list's fi_fam matches the
        -- key of the entry in the 'NameEnv'.  This gets consumed
        -- by 'checkRecFamInstConsistency'.
        -- See Note [Don't check hs-boot type family instances too early]
        tcg_pending_fam_checks :: NameEnv [([FamInst], FamInstEnv)],

518 519 520 521 522 523
                -- Now a bunch of things about this module that are simply
                -- accumulated, but never consulted until the end.
                -- Nevertheless, it's convenient to accumulate them along
                -- with the rest of the info from this module.
        tcg_exports :: [AvailInfo],     -- ^ What is exported
        tcg_imports :: ImportAvails,
524
          -- ^ Information about what was imported from where, including
525
          -- things bound in this module. Also store Safe Haskell info
526
          -- here about transative trusted packaage requirements.
527

528 529
        tcg_dus       :: DefUses,   -- ^ What is defined in this module and what is used.
        tcg_used_gres :: TcRef [GlobalRdrElt],  -- ^ Records occurrences of imported entities
530
          -- See Note [Tracking unused binding and imports]
531

532
        tcg_keep :: TcRef NameSet,
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
          -- ^ Locally-defined top-level names to keep alive.
          --
          -- "Keep alive" means give them an Exported flag, so that the
          -- simplifier does not discard them as dead code, and so that they
          -- are exposed in the interface file (but not to export to the
          -- user).
          --
          -- Some things, like dict-fun Ids and default-method Ids are "born"
          -- with the Exported flag on, for exactly the above reason, but some
          -- we only discover as we go.  Specifically:
          --
          --   * The to/from functions for generic data types
          --
          --   * Top-level variables appearing free in the RHS of an orphan
          --     rule
          --
          --   * Top-level variables appearing free in a TH bracket

551
        tcg_th_used :: TcRef Bool,
552 553
          -- ^ @True@ <=> Template Haskell syntax used.
          --
554
          -- We need this so that we can generate a dependency on the
Gabor Greif's avatar
typos  
Gabor Greif committed
555
          -- Template Haskell package, because the desugarer is going
556 557
          -- to emit loads of references to TH symbols.  The reference
          -- is implicit rather than explicit, so we have to zap a
558 559
          -- mutable variable.

560 561 562 563 564
        tcg_th_splice_used :: TcRef Bool,
          -- ^ @True@ <=> A Template Haskell splice was used.
          --
          -- Splices disable recompilation avoidance (see #481)

565 566 567 568
        tcg_th_top_level_locs :: TcRef (Set RealSrcSpan),
          -- ^ Locations of the top-level splices; used for providing details on
          -- scope in error messages for out-of-scope variables

569
        tcg_dfun_n  :: TcRef OccSet,
570
          -- ^ Allows us to choose unique DFun names.
571

Edward Z. Yang's avatar
Edward Z. Yang committed
572 573 574 575
        tcg_merged :: [(Module, Fingerprint)],
          -- ^ The requirements we merged with; we always have to recompile
          -- if any of these changed.

576
        -- The next fields accumulate the payload of the module
Gabor Greif's avatar
Gabor Greif committed
577
        -- The binds, rules and foreign-decl fields are collected
578
        -- initially in un-zonked form and are finally zonked in tcRnSrcDecls
579

580
        tcg_rn_exports :: Maybe [Located (IE Name)],
581
                -- Nothing <=> no explicit export list
582 583
                -- Is always Nothing if we don't want to retain renamed
                -- exports
584

585
        tcg_rn_imports :: [LImportDecl Name],
586 587
                -- Keep the renamed imports regardless.  They are not
                -- voluminous and are needed if you want to report unused imports
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
588

589
        tcg_rn_decls :: Maybe (HsGroup Name),
590 591
          -- ^ Renamed decls, maybe.  @Nothing@ <=> Don't retain renamed
          -- decls.
592

593
        tcg_dependent_files :: TcRef [FilePath], -- ^ dependencies from addDependentFile
GregWeber's avatar
GregWeber committed
594

595 596 597 598 599
        tcg_th_topdecls :: TcRef [LHsDecl RdrName],
        -- ^ Top-level declarations from addTopDecls

        tcg_th_topnames :: TcRef NameSet,
        -- ^ Exact names bound in top-level declarations in tcg_th_topdecls
600

601 602 603 604 605
        tcg_th_modfinalizers :: TcRef [TcM ()],
        -- ^ Template Haskell module finalizers.
        --
        -- They are computations in the @TcM@ monad rather than @Q@ because we
        -- set them to use particular local environments.
606 607

        tcg_th_state :: TcRef (Map TypeRep Dynamic),
608
        tcg_th_remote_state :: TcRef (Maybe (ForeignRef (IORef QState))),
609
        -- ^ Template Haskell state
610

611
        tcg_ev_binds  :: Bag EvBind,        -- Top-level evidence bindings
612

613 614 615
        -- Things defined in this module, or (in GHCi)
        -- in the declarations for a single GHCi command.
        -- For the latter, see Note [The interactive package] in HscTypes
616 617 618
        tcg_tr_module :: Maybe Id,           -- Id for $trModule :: GHC.Types.Module
                                             -- for which every module has a top-level defn
                                             -- except in GHCi in which case we have Nothing
619 620 621 622 623 624 625 626 627 628 629 630
        tcg_binds     :: LHsBinds Id,        -- Value bindings in this module
        tcg_sigs      :: NameSet,            -- ...Top-level names that *lack* a signature
        tcg_imp_specs :: [LTcSpecPrag],      -- ...SPECIALISE prags for imported Ids
        tcg_warns     :: Warnings,           -- ...Warnings and deprecations
        tcg_anns      :: [Annotation],       -- ...Annotations
        tcg_tcs       :: [TyCon],            -- ...TyCons and Classes
        tcg_insts     :: [ClsInst],          -- ...Instances
        tcg_fam_insts :: [FamInst],          -- ...Family instances
        tcg_rules     :: [LRuleDecl Id],     -- ...Rules
        tcg_fords     :: [LForeignDecl Id],  -- ...Foreign import & exports
        tcg_vects     :: [LVectDecl Id],     -- ...Vectorisation declarations
        tcg_patsyns   :: [PatSyn],           -- ...Pattern synonyms
631

632
        tcg_doc_hdr   :: Maybe LHsDocString, -- ^ Maybe Haddock header docs
633 634 635
        tcg_hpc       :: AnyHpcUsage,        -- ^ @True@ if any part of the
                                             --  prog uses hpc instrumentation.

Simon Peyton Jones's avatar
Simon Peyton Jones committed
636 637 638
        tcg_self_boot :: SelfBootInfo,       -- ^ Whether this module has a
                                             -- corresponding hi-boot file

639
        tcg_main      :: Maybe Name,         -- ^ The Name of the main
640 641
                                             -- function, if this module is
                                             -- the main module.
Adam Gundry's avatar
Adam Gundry committed
642

643 644 645 646 647
        tcg_safeInfer :: TcRef (Bool, WarningMessages),
        -- ^ Has the typechecker inferred this module as -XSafe (Safe Haskell)
        -- See Note [Safe Haskell Overlapping Instances Implementation],
        -- although this is used for more than just that failure case.

Facundo Domínguez's avatar
Facundo Domínguez committed
648
        tcg_tc_plugins :: [TcPluginSolver],
649
        -- ^ A list of user-defined plugins for the constraint solver.
Facundo Domínguez's avatar
Facundo Domínguez committed
650

Edward Z. Yang's avatar
Edward Z. Yang committed
651 652 653
        tcg_top_loc :: RealSrcSpan,
        -- ^ The RealSrcSpan this module came from

Facundo Domínguez's avatar
Facundo Domínguez committed
654
        tcg_static_wc :: TcRef WantedConstraints
655 656
        -- ^ Wanted constraints of static forms.
        -- See Note [Constraints in static forms].
657
    }
658

Edward Z. Yang's avatar
Edward Z. Yang committed
659 660 661
-- NB: topModIdentity, not topModSemantic!
-- Definition sites of orphan identities will be identity modules, not semantic
-- modules.
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683

-- Note [Constraints in static forms]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
-- When a static form produces constraints like
--
-- f :: StaticPtr (Bool -> String)
-- f = static show
--
-- we collect them in tcg_static_wc and resolve them at the end
-- of type checking. They need to be resolved separately because
-- we don't want to resolve them in the context of the enclosing
-- expression. Consider
--
-- g :: Show a => StaticPtr (a -> String)
-- g = static show
--
-- If the @Show a0@ constraint that the body of the static form produces was
-- resolved in the context of the enclosing expression, then the body of the
-- static form wouldn't be closed because the Show dictionary would come from
-- g's context instead of coming from the top level.

684 685 686 687
tcVisibleOrphanMods :: TcGblEnv -> ModuleSet
tcVisibleOrphanMods tcg_env
    = mkModuleSet (tcg_mod tcg_env : imp_orphs (tcg_imports tcg_env))

688
instance ContainsModule TcGblEnv where
Edward Z. Yang's avatar
Edward Z. Yang committed
689
    extractModule env = tcg_semantic_mod env
690

Adam Gundry's avatar
Adam Gundry committed
691 692 693
type RecFieldEnv = NameEnv [FieldLabel]
        -- Maps a constructor name *in this module*
        -- to the fields for that constructor.
694 695 696 697 698
        -- This is used when dealing with ".." notation in record
        -- construction and pattern matching.
        -- The FieldEnv deals *only* with constructors defined in *this*
        -- module.  For imported modules, we get the same info from the
        -- TypeEnv
699

Simon Peyton Jones's avatar
Simon Peyton Jones committed
700 701 702 703
data SelfBootInfo
  = NoSelfBoot    -- No corresponding hi-boot file
  | SelfBoot
       { sb_mds :: ModDetails   -- There was a hi-boot file,
704 705 706 707
       , sb_tcs :: NameSet }    -- defining these TyCons,
-- What is sb_tcs used for?  See Note [Extra dependencies from .hs-boot files]
-- in RnSource

Simon Peyton Jones's avatar
Simon Peyton Jones committed
708

709 710 711 712
{- Note [Tracking unused binding and imports]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
We gather two sorts of usage information

713 714 715 716 717 718 719 720
 * tcg_dus (defs/uses)
      Records *defined* Names (local, top-level)
          and *used*    Names (local or imported)

      Used (a) to report "defined but not used"
               (see RnNames.reportUnusedNames)
           (b) to generate version-tracking usage info in interface
               files (see MkIface.mkUsedNames)
721
   This usage info is mainly gathered by the renamer's
722 723
   gathering of free-variables

724
 * tcg_used_gres
725
      Used only to report unused import declarations
726 727 728 729 730 731 732

      Records each *occurrence* an *imported* (not locally-defined) entity.
      The occurrence is recorded by keeping a GlobalRdrElt for it.
      These is not the GRE that is in the GlobalRdrEnv; rather it
      is recorded *after* the filtering done by pickGREs.  So it reflect
      /how that occurrence is in scope/.   See Note [GRE filtering] in
      RdrName.
Adam Gundry's avatar
Adam Gundry committed
733

734

Austin Seipp's avatar
Austin Seipp committed
735 736
************************************************************************
*                                                                      *
737
                The local typechecker environment
Austin Seipp's avatar
Austin Seipp committed
738 739
*                                                                      *
************************************************************************
740

Edward Z. Yang's avatar
Edward Z. Yang committed
741 742
Note [The Global-Env/Local-Env story]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
743
During type checking, we keep in the tcg_type_env
744 745
        * All types and classes
        * All Ids derived from types and classes (constructors, selectors)
746 747 748

At the end of type checking, we zonk the local bindings,
and as we do so we add to the tcg_type_env
749
        * Locally defined top-level Ids
750 751

Why?  Because they are now Ids not TcIds.  This final GlobalEnv is
752 753 754
        a) fed back (via the knot) to typechecking the
           unfoldings of interface signatures
        b) used in the ModDetails of this module
Austin Seipp's avatar
Austin Seipp committed
755
-}
756

757 758
data TcLclEnv           -- Changes as we move inside an expression
                        -- Discarded after typecheck/rename; not passed on to desugarer
759
  = TcLclEnv {
760
        tcl_loc        :: RealSrcSpan,     -- Source span
761
        tcl_ctxt       :: [ErrCtxt],       -- Error context, innermost on top
762
        tcl_tclvl      :: TcLevel,         -- Birthplace for new unification variables
763

764
        tcl_th_ctxt    :: ThStage,         -- Template Haskell context
765 766 767
        tcl_th_bndrs   :: ThBindEnv,       -- Binding level of in-scope Names
                                           -- defined in this module (not imported)

768 769 770 771 772 773 774 775 776 777
        tcl_arrow_ctxt :: ArrowCtxt,       -- Arrow-notation context

        tcl_rdr :: LocalRdrEnv,         -- Local name envt
                -- Maintained during renaming, of course, but also during
                -- type checking, solely so that when renaming a Template-Haskell
                -- splice we have the right environment for the renamer.
                --
                --   Does *not* include global name envt; may shadow it
                --   Includes both ordinary variables and type variables;
                --   they are kept distinct because tyvar have a different
Gabor Greif's avatar
Gabor Greif committed
778
                --   occurrence constructor (Name.TvOcc)
779 780 781 782 783
                -- We still need the unsullied global name env so that
                --   we can look up record field names

        tcl_env  :: TcTypeEnv,    -- The local type environment:
                                  -- Ids and TyVars defined in this module
784

785
        tcl_bndrs :: TcIdBinderStack,   -- Used for reporting relevant bindings
786 787 788

        tcl_tidy :: TidyEnv,      -- Used for tidying types; contains all
                                  -- in-scope type variables (but not term variables)
789 790 791 792 793

        tcl_tyvars :: TcRef TcTyVarSet, -- The "global tyvars"
                        -- Namely, the in-scope TyVars bound in tcl_env,
                        -- plus the tyvars mentioned in the types of Ids bound
                        -- in tcl_lenv.
794
                        -- Why mutable? see notes with tcGetGlobalTyCoVars
795

796 797
        tcl_lie  :: TcRef WantedConstraints,    -- Place to accumulate type constraints
        tcl_errs :: TcRef Messages              -- Place to accumulate errors
798 799
    }

800
type TcTypeEnv = NameEnv TcTyThing
801

802 803 804 805 806 807 808 809 810
type ThBindEnv = NameEnv (TopLevelFlag, ThLevel)
   -- Domain = all Ids bound in this module (ie not imported)
   -- The TopLevelFlag tells if the binding is syntactically top level.
   -- We need to know this, because the cross-stage persistence story allows
   -- cross-stage at arbitrary types if the Id is bound at top level.
   --
   -- Nota bene: a ThLevel of 'outerLevel' is *not* the same as being
   -- bound at top level!  See Note [Template Haskell levels] in TcSplice

811 812
{- Note [Given Insts]
   ~~~~~~~~~~~~~~~~~~
813
Because of GADTs, we have to pass inwards the Insts provided by type signatures
814
and existential contexts. Consider
815 816 817
        data T a where { T1 :: b -> b -> T [b] }
        f :: Eq a => T a -> Bool
        f (T1 x y) = [x]==[y]
818 819

The constructor T1 binds an existential variable 'b', and we need Eq [b].
820
Well, we have it, because Eq a refines to Eq [b], but we can only spot that if we
821 822 823
pass it inwards.

-}
824

825 826 827 828 829 830 831 832
-- | Type alias for 'IORef'; the convention is we'll use this for mutable
-- bits of data in 'TcGblEnv' which are updated during typechecking and
-- returned at the end.
type TcRef a     = IORef a
-- ToDo: when should I refer to it as a 'TcId' instead of an 'Id'?
type TcId        = Id
type TcIdSet     = IdSet

833 834 835 836 837 838 839
---------------------------
-- The TcIdBinderStack
---------------------------

type TcIdBinderStack = [TcIdBinder]
   -- This is a stack of locally-bound ids, innermost on top
   -- Used ony in error reporting (relevantBindings in TcError)
Simon Peyton Jones's avatar
Simon Peyton Jones committed
840 841
   -- We can't use the tcl_env type environment, because it doesn't
   --   keep track of the nesting order
842 843 844 845 846 847 848

data TcIdBinder
  = TcIdBndr
       TcId
       TopLevelFlag    -- Tells whether the bindind is syntactically top-level
                       -- (The monomorphic Ids for a recursive group count
                       --  as not-top-level for this purpose.)
849 850 851 852 853
  | TcIdBndr_ExpType  -- Variant that allows the type to be specified as
                      -- an ExpType
       Name
       ExpType
       TopLevelFlag
854 855

instance Outputable TcIdBinder where
856 857
   ppr (TcIdBndr id top_lvl)           = ppr id <> brackets (ppr top_lvl)
   ppr (TcIdBndr_ExpType id _ top_lvl) = ppr id <> brackets (ppr top_lvl)
858

859 860 861 862
instance HasOccName TcIdBinder where
    occName (TcIdBndr id _) = (occName (idName id))
    occName (TcIdBndr_ExpType name _ _) = (occName name)

863
---------------------------
864
-- Template Haskell stages and levels
865 866
---------------------------

867 868
data SpliceType = Typed | Untyped

869
data ThStage    -- See Note [Template Haskell state diagram] in TcSplice
870 871 872 873
  = Splice SpliceType -- Inside a top-level splice
                      -- This code will be run *at compile time*;
                      --   the result replaces the splice
                      -- Binding level = 0
874

875 876 877 878 879 880 881 882 883 884 885 886 887 888 889
  | RunSplice (TcRef [ForeignRef (TH.Q ())])
      -- Set when running a splice, i.e. NOT when renaming or typechecking the
      -- Haskell code for the splice. See Note [RunSplice ThLevel].
      --
      -- Contains a list of mod finalizers collected while executing the splice.
      --
      -- 'addModFinalizer' inserts finalizers here, and from here they are taken
      -- to construct an @HsSpliced@ annotation for untyped splices. See Note
      -- [Delaying modFinalizers in untyped splices] in "RnSplice".
      --
      -- For typed splices, the typechecker takes finalizers from here and
      -- inserts them in the list of finalizers in the global environment.
      --
      -- See Note [Collecting modFinalizers in typed splices] in "TcSplice".

890 891
  | Comp        -- Ordinary Haskell code
                -- Binding level = 1
892

893
  | Brack                       -- Inside brackets
894 895 896 897 898 899 900 901 902
      ThStage                   --   Enclosing stage
      PendingStuff

data PendingStuff
  = RnPendingUntyped              -- Renaming the inside of an *untyped* bracket
      (TcRef [PendingRnSplice])   -- Pending splices in here

  | RnPendingTyped                -- Renaming the inside of a *typed* bracket

903
  | TcPending                     -- Typechecking the inside of a typed bracket
904 905
      (TcRef [PendingTcSplice])   --   Accumulate pending splices here
      (TcRef WantedConstraints)   --     and type constraints here
906 907 908

topStage, topAnnStage, topSpliceStage :: ThStage
topStage       = Comp
909 910
topAnnStage    = Splice Untyped
topSpliceStage = Splice Untyped
911 912

instance Outputable ThStage where
913 914 915 916
   ppr (Splice _)    = text "Splice"
   ppr (RunSplice _) = text "RunSplice"
   ppr Comp          = text "Comp"
   ppr (Brack s _)   = text "Brack" <> parens (ppr s)
917

918
type ThLevel = Int
919 920 921 922 923
    -- NB: see Note [Template Haskell levels] in TcSplice
    -- Incremented when going inside a bracket,
    -- decremented when going inside a splice
    -- NB: ThLevel is one greater than the 'n' in Fig 2 of the
    --     original "Template meta-programming for Haskell" paper
924

925
impLevel, outerLevel :: ThLevel
926 927
impLevel = 0    -- Imported things; they can be used inside a top level splice
outerLevel = 1  -- Things defined outside brackets
928

929
thLevel :: ThStage -> ThLevel
930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948
thLevel (Splice _)    = 0
thLevel (RunSplice _) =
    -- See Note [RunSplice ThLevel].
    panic "thLevel: called when running a splice"
thLevel Comp          = 1
thLevel (Brack s _)   = thLevel s + 1

{- Node [RunSplice ThLevel]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'RunSplice' stage is set when executing a splice, and only when running a
splice. In particular it is not set when the splice is renamed or typechecked.

'RunSplice' is needed to provide a reference where 'addModFinalizer' can insert
the finalizer (see Note [Delaying modFinalizers in untyped splices]), and
'addModFinalizer' runs when doing Q things. Therefore, It doesn't make sense to
set 'RunSplice' when renaming or typechecking the splice, where 'Splice', 'Brak'
or 'Comp' are used instead.

-}
949

ross's avatar
ross committed
950 951 952 953
---------------------------
-- Arrow-notation context
---------------------------

954 955
{- Note [Escaping the arrow scope]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
ross's avatar
ross committed
956 957 958 959
In arrow notation, a variable bound by a proc (or enclosed let/kappa)
is not in scope to the left of an arrow tail (-<) or the head of (|..|).
For example

960
        proc x -> (e1 -< e2)
ross's avatar
ross committed
961 962 963 964

Here, x is not in scope in e1, but it is in scope in e2.  This can get
a bit complicated:

965 966
        let x = 3 in
        proc y -> (proc z -> e1) -< e2
ross's avatar
ross committed
967

968
Here, x and z are in scope in e1, but y is not.
969 970

We implement this by
ross's avatar
ross committed
971 972 973
recording the environment when passing a proc (using newArrowScope),
and returning to that (using escapeArrowScope) on the left of -< and the
head of (|..|).
974

975 976 977 978 979 980 981 982 983 984
All this can be dealt with by the *renamer*. But the type checker needs
to be involved too.  Example (arrowfail001)
  class Foo a where foo :: a -> ()
  data Bar = forall a. Foo a => Bar a
  get :: Bar -> ()
  get = proc x -> case x of Bar a -> foo -< a
Here the call of 'foo' gives rise to a (Foo a) constraint that should not
be captured by the pattern match on 'Bar'.  Rather it should join the
constraints from further out.  So we must capture the constraint bag
from further out in the ArrowCtxt that we push inwards.
ross's avatar
ross committed
985 986
-}

987
data ArrowCtxt   -- Note [Escaping the arrow scope]
ross's avatar
ross committed
988
  = NoArrowCtxt
989 990
  | ArrowCtxt LocalRdrEnv (TcRef WantedConstraints)

991

992 993 994 995
---------------------------
-- TcTyThing
---------------------------

Edward Z. Yang's avatar
Edward Z. Yang committed
996 997 998
-- | A typecheckable thing available in a local context.  Could be
-- 'AGlobal' 'TyThing', but also lexically scoped variables, etc.
-- See 'TcEnv' for how to retrieve a 'TyThing' given a 'Name'.
999
data TcTyThing
1000
  = AGlobal TyThing             -- Used only in the return type of a lookup
1001

1002 1003
  | ATcId   {           -- Ids defined in this module; may not be fully zonked
        tct_id     :: TcId,
1004
        tct_info :: IdBindingInfo }   -- See Note [Bindings with closed types]
1005

1006 1007 1008 1009
  | ATyVar  Name TcTyVar        -- The type variable to which the lexically scoped type
                                -- variable is bound. We only need the Name
                                -- for error-message purposes; it is the corresponding
                                -- Name in the domain of the envt
1010

1011
  | ATcTyCon TyCon   -- Used temporarily, during kind checking, for the
1012
                     -- tycons and clases in this recursive group
Simon Peyton Jones's avatar