Fix #481: use a safe recompilation check when Template Haskell is
[ghc.git] / 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         TcTypeEnv, TcTyThing(..), pprTcTyThingCategory, 
22
23         -- Template Haskell
24         ThStage(..), topStage, topAnnStage, topSpliceStage,
25         ThLevel, impLevel, outerLevel, thLevel,
26
27         -- Arrows
28         ArrowCtxt(NoArrowCtxt), newArrowScope, escapeArrowScope,
29
30         -- Constraints
31         Untouchables(..), inTouchableRange, isNoUntouchables,
32
33         WantedConstraints(..), insolubleWC, emptyWC, isEmptyWC,
34         andWC, addFlats, addImplics, mkFlatWC,
35
36         EvVarX(..), mkEvVarX, evVarOf, evVarX, evVarOfPred,
37         WantedEvVar, wantedToFlavored,
38         keepWanted,
39
40         Implication(..),
41         CtLoc(..), ctLocSpan, ctLocOrigin, setCtLocOrigin,
42         CtOrigin(..), EqOrigin(..), 
43         WantedLoc, GivenLoc, GivenKind(..), pushErrCtxt,
44
45         SkolemInfo(..),
46
47         CtFlavor(..), pprFlavorArising, isWanted, 
48         isGivenOrSolved, isGiven_maybe,
49         isDerived,
50         FlavoredEvVar,
51
52         -- Pretty printing
53         pprEvVarTheta, pprWantedEvVar, pprWantedsWithLocs,
54         pprEvVars, pprEvVarWithType,
55         pprArising, pprArisingAt,
56
57         -- Misc other types
58         TcId, TcIdSet, TcTyVarBind(..), TcTyVarBinds
59         
60   ) where
61
62 #include "HsVersions.h"
63
64 import HsSyn
65 import HscTypes
66 import Type
67 import Id       ( evVarPred )
68 import Class    ( Class )
69 import DataCon  ( DataCon, dataConUserType )
70 import TcType
71 import Annotations
72 import InstEnv
73 import FamInstEnv
74 import IOEnv
75 import RdrName
76 import Name
77 import NameEnv
78 import NameSet
79 import Var
80 import VarEnv
81 import Module
82 import SrcLoc
83 import VarSet
84 import ErrUtils
85 import UniqFM
86 import UniqSupply
87 import Unique
88 import BasicTypes
89 import Bag
90 import Outputable
91 import ListSetOps
92 import FastString
93
94 import Data.Set (Set)
95 \end{code}
96
97
98 %************************************************************************
99 %*                                                                      *
100                Standard monad definition for TcRn
101     All the combinators for the monad can be found in TcRnMonad
102 %*                                                                      *
103 %************************************************************************
104
105 The monad itself has to be defined here, because it is mentioned by ErrCtxt
106
107 \begin{code}
108 type TcRef a     = IORef a
109 type TcId        = Id                   -- Type may be a TcType  DV: WHAT??????????
110 type TcIdSet     = IdSet
111
112
113 type TcRnIf a b c = IOEnv (Env a b) c
114 type IfM lcl a  = TcRnIf IfGblEnv lcl a         -- Iface stuff
115
116 type IfG a  = IfM () a                          -- Top level
117 type IfL a  = IfM IfLclEnv a                    -- Nested
118 type TcRn a = TcRnIf TcGblEnv TcLclEnv a
119 type RnM  a = TcRn a            -- Historical
120 type TcM  a = TcRn a            -- Historical
121 \end{code}
122
123 Representation of type bindings to uninstantiated meta variables used during
124 constraint solving.
125
126 \begin{code}
127 data TcTyVarBind = TcTyVarBind TcTyVar TcType
128
129 type TcTyVarBinds = Bag TcTyVarBind
130
131 instance Outputable TcTyVarBind where
132   ppr (TcTyVarBind tv ty) = ppr tv <+> text ":=" <+> ppr ty
133 \end{code}
134
135
136 %************************************************************************
137 %*                                                                      *
138                 The main environment types
139 %*                                                                      *
140 %************************************************************************
141
142 \begin{code}
143 data Env gbl lcl        -- Changes as we move into an expression
144   = Env {
145         env_top  :: HscEnv,     -- Top-level stuff that never changes
146                                 -- Includes all info about imported things
147
148         env_us   :: {-# UNPACK #-} !(IORef UniqSupply), 
149                                 -- Unique supply for local varibles
150
151         env_gbl  :: gbl,        -- Info about things defined at the top level
152                                 -- of the module being compiled
153
154         env_lcl  :: lcl         -- Nested stuff; changes as we go into 
155     }
156
157 -- TcGblEnv describes the top-level of the module at the 
158 -- point at which the typechecker is finished work.
159 -- It is this structure that is handed on to the desugarer
160
161 data TcGblEnv
162   = TcGblEnv {
163         tcg_mod     :: Module,         -- ^ Module being compiled
164         tcg_src     :: HscSource,
165           -- ^ What kind of module (regular Haskell, hs-boot, ext-core)
166
167         tcg_rdr_env :: GlobalRdrEnv,   -- ^ Top level envt; used during renaming
168         tcg_default :: Maybe [Type],
169           -- ^ Types used for defaulting. @Nothing@ => no @default@ decl
170
171         tcg_fix_env   :: FixityEnv,     -- ^ Just for things in this module
172         tcg_field_env :: RecFieldEnv,   -- ^ Just for things in this module
173
174         tcg_type_env :: TypeEnv,
175           -- ^ Global type env for the module we are compiling now.  All
176           -- TyCons and Classes (for this module) end up in here right away,
177           -- along with their derived constructors, selectors.
178           --
179           -- (Ids defined in this module start in the local envt, though they
180           --  move to the global envt during zonking)
181
182         tcg_type_env_var :: TcRef TypeEnv,
183                 -- Used only to initialise the interface-file
184                 -- typechecker in initIfaceTcRn, so that it can see stuff
185                 -- bound in this module when dealing with hi-boot recursions
186                 -- Updated at intervals (e.g. after dealing with types and classes)
187         
188         tcg_inst_env     :: InstEnv,
189           -- ^ Instance envt for /home-package/ modules; Includes the dfuns in
190           -- tcg_insts
191         tcg_fam_inst_env :: FamInstEnv, -- ^ Ditto for family instances
192
193                 -- Now a bunch of things about this module that are simply 
194                 -- accumulated, but never consulted until the end.  
195                 -- Nevertheless, it's convenient to accumulate them along 
196                 -- with the rest of the info from this module.
197         tcg_exports :: [AvailInfo],     -- ^ What is exported
198         tcg_imports :: ImportAvails,
199           -- ^ Information about what was imported from where, including
200           -- things bound in this module.
201
202         tcg_dus :: DefUses,
203           -- ^ What is defined in this module and what is used.
204           -- The latter is used to generate
205           --
206           --  (a) version tracking; no need to recompile if these things have
207           --      not changed version stamp
208           --
209           --  (b) unused-import info
210
211         tcg_keep :: TcRef NameSet,
212           -- ^ Locally-defined top-level names to keep alive.
213           --
214           -- "Keep alive" means give them an Exported flag, so that the
215           -- simplifier does not discard them as dead code, and so that they
216           -- are exposed in the interface file (but not to export to the
217           -- user).
218           --
219           -- Some things, like dict-fun Ids and default-method Ids are "born"
220           -- with the Exported flag on, for exactly the above reason, but some
221           -- we only discover as we go.  Specifically:
222           --
223           --   * The to/from functions for generic data types
224           --
225           --   * Top-level variables appearing free in the RHS of an orphan
226           --     rule
227           --
228           --   * Top-level variables appearing free in a TH bracket
229
230         tcg_th_used :: TcRef Bool,
231           -- ^ @True@ <=> Template Haskell syntax used.
232           --
233           -- We need this so that we can generate a dependency on the
234           -- Template Haskell package, becuase the desugarer is going
235           -- to emit loads of references to TH symbols.  The reference
236           -- is implicit rather than explicit, so we have to zap a
237           -- mutable variable.
238
239         tcg_th_splice_used :: TcRef Bool,
240           -- ^ @True@ <=> A Template Haskell splice was used.
241           --
242           -- Splices disable recompilation avoidance (see #481)
243
244         tcg_dfun_n  :: TcRef OccSet,
245           -- ^ Allows us to choose unique DFun names.
246
247         -- The next fields accumulate the payload of the module
248         -- The binds, rules and foreign-decl fiels are collected
249         -- initially in un-zonked form and are finally zonked in tcRnSrcDecls
250
251         tcg_rn_exports :: Maybe [Located (IE Name)],
252         tcg_rn_imports :: [LImportDecl Name],
253                 -- Keep the renamed imports regardless.  They are not 
254                 -- voluminous and are needed if you want to report unused imports
255
256         tcg_used_rdrnames :: TcRef (Set RdrName),
257                 -- The set of used *imported* (not locally-defined) RdrNames
258                 -- Used only to report unused import declarations
259
260         tcg_rn_decls :: Maybe (HsGroup Name),
261           -- ^ Renamed decls, maybe.  @Nothing@ <=> Don't retain renamed
262           -- decls.
263
264         tcg_ev_binds  :: Bag EvBind,        -- Top-level evidence bindings
265         tcg_binds     :: LHsBinds Id,       -- Value bindings in this module
266         tcg_sigs      :: NameSet,           -- ...Top-level names that *lack* a signature
267         tcg_imp_specs :: [LTcSpecPrag],     -- ...SPECIALISE prags for imported Ids
268         tcg_warns     :: Warnings,          -- ...Warnings and deprecations
269         tcg_anns      :: [Annotation],      -- ...Annotations
270         tcg_insts     :: [Instance],        -- ...Instances
271         tcg_fam_insts :: [FamInst],         -- ...Family instances
272         tcg_rules     :: [LRuleDecl Id],    -- ...Rules
273         tcg_fords     :: [LForeignDecl Id], -- ...Foreign import & exports
274         tcg_vects     :: [LVectDecl Id],    -- ...Vectorisation declarations
275
276         tcg_doc_hdr   :: Maybe LHsDocString, -- ^ Maybe Haddock header docs
277         tcg_hpc       :: AnyHpcUsage,        -- ^ @True@ if any part of the
278                                              --  prog uses hpc instrumentation.
279
280         tcg_main      :: Maybe Name          -- ^ The Name of the main
281                                              -- function, if this module is
282                                              -- the main module.
283     }
284
285 data RecFieldEnv 
286   = RecFields (NameEnv [Name])  -- Maps a constructor name *in this module*
287                                 -- to the fields for that constructor
288               NameSet           -- Set of all fields declared *in this module*;
289                                 -- used to suppress name-shadowing complaints
290                                 -- when using record wild cards
291                                 -- E.g.  let fld = e in C {..}
292         -- This is used when dealing with ".." notation in record 
293         -- construction and pattern matching.
294         -- The FieldEnv deals *only* with constructors defined in *this*
295         -- module.  For imported modules, we get the same info from the
296         -- TypeEnv
297 \end{code}
298
299 %************************************************************************
300 %*                                                                      *
301                 The interface environments
302               Used when dealing with IfaceDecls
303 %*                                                                      *
304 %************************************************************************
305
306 \begin{code}
307 data IfGblEnv 
308   = IfGblEnv {
309         -- The type environment for the module being compiled,
310         -- in case the interface refers back to it via a reference that
311         -- was originally a hi-boot file.
312         -- We need the module name so we can test when it's appropriate
313         -- to look in this env.
314         if_rec_types :: Maybe (Module, IfG TypeEnv)
315                 -- Allows a read effect, so it can be in a mutable
316                 -- variable; c.f. handling the external package type env
317                 -- Nothing => interactive stuff, no loops possible
318     }
319
320 data IfLclEnv
321   = IfLclEnv {
322         -- The module for the current IfaceDecl
323         -- So if we see   f = \x -> x
324         -- it means M.f = \x -> x, where M is the if_mod
325         if_mod :: Module,
326
327         -- The field is used only for error reporting
328         -- if (say) there's a Lint error in it
329         if_loc :: SDoc,
330                 -- Where the interface came from:
331                 --      .hi file, or GHCi state, or ext core
332                 -- plus which bit is currently being examined
333
334         if_tv_env  :: UniqFM TyVar,     -- Nested tyvar bindings
335                                         -- (and coercions)
336         if_id_env  :: UniqFM Id         -- Nested id binding
337     }
338 \end{code}
339
340
341 %************************************************************************
342 %*                                                                      *
343                 The local typechecker environment
344 %*                                                                      *
345 %************************************************************************
346
347 The Global-Env/Local-Env story
348 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
349 During type checking, we keep in the tcg_type_env
350         * All types and classes
351         * All Ids derived from types and classes (constructors, selectors)
352
353 At the end of type checking, we zonk the local bindings,
354 and as we do so we add to the tcg_type_env
355         * Locally defined top-level Ids
356
357 Why?  Because they are now Ids not TcIds.  This final GlobalEnv is
358         a) fed back (via the knot) to typechecking the 
359            unfoldings of interface signatures
360         b) used in the ModDetails of this module
361
362 \begin{code}
363 data TcLclEnv           -- Changes as we move inside an expression
364                         -- Discarded after typecheck/rename; not passed on to desugarer
365   = TcLclEnv {
366         tcl_loc  :: SrcSpan,            -- Source span
367         tcl_ctxt :: [ErrCtxt],          -- Error context, innermost on top
368         tcl_errs :: TcRef Messages,     -- Place to accumulate errors
369
370         tcl_th_ctxt    :: ThStage,            -- Template Haskell context
371         tcl_arrow_ctxt :: ArrowCtxt,          -- Arrow-notation context
372
373         tcl_rdr :: LocalRdrEnv,         -- Local name envt
374                 -- Maintained during renaming, of course, but also during
375                 -- type checking, solely so that when renaming a Template-Haskell
376                 -- splice we have the right environment for the renamer.
377                 -- 
378                 --   Does *not* include global name envt; may shadow it
379                 --   Includes both ordinary variables and type variables;
380                 --   they are kept distinct because tyvar have a different
381                 --   occurrence contructor (Name.TvOcc)
382                 -- We still need the unsullied global name env so that
383                 --   we can look up record field names
384
385         tcl_env  :: TcTypeEnv,    -- The local type environment: Ids and
386                                   -- TyVars defined in this module
387                                         
388         tcl_tyvars :: TcRef TcTyVarSet, -- The "global tyvars"
389                         -- Namely, the in-scope TyVars bound in tcl_env, 
390                         -- plus the tyvars mentioned in the types of Ids bound
391                         -- in tcl_lenv. 
392                         -- Why mutable? see notes with tcGetGlobalTyVars
393
394         tcl_lie   :: TcRef WantedConstraints,    -- Place to accumulate type constraints
395
396         -- TcMetaTyVars have 
397         tcl_meta  :: TcRef Unique,  -- The next free unique for TcMetaTyVars
398                                     -- Guaranteed to be allocated linearly
399         tcl_untch :: Unique         -- Any TcMetaTyVar with 
400                                     --     unique >= tcl_untch is touchable
401                                     --     unique <  tcl_untch is untouchable
402     }
403
404 type TcTypeEnv = NameEnv TcTyThing
405
406
407 {- Note [Given Insts]
408    ~~~~~~~~~~~~~~~~~~
409 Because of GADTs, we have to pass inwards the Insts provided by type signatures 
410 and existential contexts. Consider
411         data T a where { T1 :: b -> b -> T [b] }
412         f :: Eq a => T a -> Bool
413         f (T1 x y) = [x]==[y]
414
415 The constructor T1 binds an existential variable 'b', and we need Eq [b].
416 Well, we have it, because Eq a refines to Eq [b], but we can only spot that if we 
417 pass it inwards.
418
419 -}
420
421 ---------------------------
422 -- Template Haskell stages and levels 
423 ---------------------------
424
425 data ThStage    -- See Note [Template Haskell state diagram] in TcSplice
426   = Splice      -- Top-level splicing
427                 -- This code will be run *at compile time*;
428                 --   the result replaces the splice
429                 -- Binding level = 0
430  
431   | Comp        -- Ordinary Haskell code
432                 -- Binding level = 1
433
434   | Brack                       -- Inside brackets 
435       ThStage                   --   Binding level = level(stage) + 1
436       (TcRef [PendingSplice])   --   Accumulate pending splices here
437       (TcRef WantedConstraints) --     and type constraints here
438
439 topStage, topAnnStage, topSpliceStage :: ThStage
440 topStage       = Comp
441 topAnnStage    = Splice
442 topSpliceStage = Splice
443
444 instance Outputable ThStage where
445    ppr Splice        = text "Splice"
446    ppr Comp          = text "Comp"
447    ppr (Brack s _ _) = text "Brack" <> parens (ppr s)
448
449 type ThLevel = Int      
450         -- See Note [Template Haskell levels] in TcSplice
451         -- Incremented when going inside a bracket,
452         -- decremented when going inside a splice
453         -- NB: ThLevel is one greater than the 'n' in Fig 2 of the
454         --     original "Template meta-programming for Haskell" paper
455
456 impLevel, outerLevel :: ThLevel
457 impLevel = 0    -- Imported things; they can be used inside a top level splice
458 outerLevel = 1  -- Things defined outside brackets
459 -- NB: Things at level 0 are not *necessarily* imported.
460 --      eg  $( \b -> ... )   here b is bound at level 0
461 --
462 -- For example: 
463 --      f = ...
464 --      g1 = $(map ...)         is OK
465 --      g2 = $(f ...)           is not OK; because we havn't compiled f yet
466
467 thLevel :: ThStage -> ThLevel
468 thLevel Splice        = 0
469 thLevel Comp          = 1
470 thLevel (Brack s _ _) = thLevel s + 1
471
472 ---------------------------
473 -- Arrow-notation context
474 ---------------------------
475
476 {-
477 In arrow notation, a variable bound by a proc (or enclosed let/kappa)
478 is not in scope to the left of an arrow tail (-<) or the head of (|..|).
479 For example
480
481         proc x -> (e1 -< e2)
482
483 Here, x is not in scope in e1, but it is in scope in e2.  This can get
484 a bit complicated:
485
486         let x = 3 in
487         proc y -> (proc z -> e1) -< e2
488
489 Here, x and z are in scope in e1, but y is not.  We implement this by
490 recording the environment when passing a proc (using newArrowScope),
491 and returning to that (using escapeArrowScope) on the left of -< and the
492 head of (|..|).
493 -}
494
495 data ArrowCtxt
496   = NoArrowCtxt
497   | ArrowCtxt (Env TcGblEnv TcLclEnv)
498
499 -- Record the current environment (outside a proc)
500 newArrowScope :: TcM a -> TcM a
501 newArrowScope
502   = updEnv $ \env ->
503         env { env_lcl = (env_lcl env) { tcl_arrow_ctxt = ArrowCtxt env } }
504
505 -- Return to the stored environment (from the enclosing proc)
506 escapeArrowScope :: TcM a -> TcM a
507 escapeArrowScope
508   = updEnv $ \ env -> case tcl_arrow_ctxt (env_lcl env) of
509         NoArrowCtxt -> env
510         ArrowCtxt env' -> env'
511
512 ---------------------------
513 -- TcTyThing
514 ---------------------------
515
516 data TcTyThing
517   = AGlobal TyThing             -- Used only in the return type of a lookup
518
519   | ATcId   {           -- Ids defined in this module; may not be fully zonked
520         tct_id    :: TcId,              
521         tct_level :: ThLevel }
522
523   | ATyVar  Name TcType         -- The type to which the lexically scoped type vaiable
524                                 -- is currently refined. We only need the Name
525                                 -- for error-message purposes; it is the corresponding
526                                 -- Name in the domain of the envt
527
528   | AThing  TcKind              -- Used temporarily, during kind checking, for the
529                                 --      tycons and clases in this recursive group
530
531 instance Outputable TcTyThing where     -- Debugging only
532    ppr (AGlobal g)      = pprTyThing g
533    ppr elt@(ATcId {})   = text "Identifier" <> 
534                           brackets (ppr (tct_id elt) <> dcolon 
535                                  <> ppr (varType (tct_id elt)) <> comma
536                                  <+> ppr (tct_level elt))
537    ppr (ATyVar tv _)    = text "Type variable" <+> quotes (ppr tv)
538    ppr (AThing k)       = text "AThing" <+> ppr k
539
540 pprTcTyThingCategory :: TcTyThing -> SDoc
541 pprTcTyThingCategory (AGlobal thing) = pprTyThingCategory thing
542 pprTcTyThingCategory (ATyVar {})     = ptext (sLit "Type variable")
543 pprTcTyThingCategory (ATcId {})      = ptext (sLit "Local identifier")
544 pprTcTyThingCategory (AThing {})     = ptext (sLit "Kinded thing")
545 \end{code}
546
547 \begin{code}
548 type ErrCtxt = (Bool, TidyEnv -> TcM (TidyEnv, Message))
549         -- Monadic so that we have a chance
550         -- to deal with bound type variables just before error
551         -- message construction
552
553         -- Bool:  True <=> this is a landmark context; do not
554         --                 discard it when trimming for display
555 \end{code}
556
557
558 %************************************************************************
559 %*                                                                      *
560         Operations over ImportAvails
561 %*                                                                      *
562 %************************************************************************
563
564 \begin{code}
565 -- | 'ImportAvails' summarises what was imported from where, irrespective of
566 -- whether the imported things are actually used or not.  It is used:
567 --
568 --  * when processing the export list,
569 --
570 --  * when constructing usage info for the interface file,
571 --
572 --  * to identify the list of directly imported modules for initialisation
573 --    purposes and for optimised overlap checking of family instances,
574 --
575 --  * when figuring out what things are really unused
576 --
577 data ImportAvails 
578    = ImportAvails {
579         imp_mods :: ImportedMods,
580           --      = ModuleEnv [(ModuleName, Bool, SrcSpan, Bool)],
581           -- ^ Domain is all directly-imported modules
582           -- The 'ModuleName' is what the module was imported as, e.g. in
583           -- @
584           --     import Foo as Bar
585           -- @
586           -- it is @Bar@.
587           --
588           -- The 'Bool' means:
589           --
590           --  - @True@ => import was @import Foo ()@
591           --
592           --  - @False@ => import was some other form
593           --
594           -- Used
595           --
596           --   (a) to help construct the usage information in the interface
597           --       file; if we import somethign we need to recompile if the
598           --       export version changes
599           --
600           --   (b) to specify what child modules to initialise
601           --
602           -- We need a full ModuleEnv rather than a ModuleNameEnv here,
603           -- because we might be importing modules of the same name from
604           -- different packages. (currently not the case, but might be in the
605           -- future).
606
607         imp_dep_mods :: ModuleNameEnv (ModuleName, IsBootInterface),
608           -- ^ Home-package modules needed by the module being compiled
609           --
610           -- It doesn't matter whether any of these dependencies
611           -- are actually /used/ when compiling the module; they
612           -- are listed if they are below it at all.  For
613           -- example, suppose M imports A which imports X.  Then
614           -- compiling M might not need to consult X.hi, but X
615           -- is still listed in M's dependencies.
616
617         imp_dep_pkgs :: [PackageId],
618           -- ^ Packages needed by the module being compiled, whether directly,
619           -- or via other modules in this package, or via modules imported
620           -- from other packages.
621         
622         imp_trust_pkgs :: [PackageId],
623           -- ^ This is strictly a subset of imp_dep_pkgs and records the
624           -- packages the current module needs to trust for Safe Haskell
625           -- compilation to succeed. A package is required to be trusted if
626           -- we are dependent on a trustworthy module in that package.
627           -- While perhaps making imp_dep_pkgs a tuple of (PackageId, Bool)
628           -- where True for the bool indicates the package is required to be
629           -- trusted is the more logical  design, doing so complicates a lot
630           -- of code not concerned with Safe Haskell.
631           -- See Note [RnNames . Tracking Trust Transitively]
632
633         imp_trust_own_pkg :: Bool,
634           -- ^ Do we require that our own package is trusted?
635           -- This is to handle efficiently the case where a Safe module imports
636           -- a Trustworthy module that resides in the same package as it.
637           -- See Note [RnNames . Trust Own Package]
638
639         imp_orphs :: [Module],
640           -- ^ Orphan modules below us in the import tree (and maybe including
641           -- us for imported modules)
642
643         imp_finsts :: [Module]
644           -- ^ Family instance modules below us in the import tree (and maybe
645           -- including us for imported modules)
646       }
647
648 mkModDeps :: [(ModuleName, IsBootInterface)]
649           -> ModuleNameEnv (ModuleName, IsBootInterface)
650 mkModDeps deps = foldl add emptyUFM deps
651                where
652                  add env elt@(m,_) = addToUFM env m elt
653
654 emptyImportAvails :: ImportAvails
655 emptyImportAvails = ImportAvails { imp_mods          = emptyModuleEnv,
656                                    imp_dep_mods      = emptyUFM,
657                                    imp_dep_pkgs      = [],
658                                    imp_trust_pkgs    = [],
659                                    imp_trust_own_pkg = False,
660                                    imp_orphs         = [],
661                                    imp_finsts        = [] }
662
663 -- | Union two ImportAvails
664 --
665 -- This function is a key part of Import handling, basically
666 -- for each import we create a seperate ImportAvails structure
667 -- and then union them all together with this function.
668 plusImportAvails ::  ImportAvails ->  ImportAvails ->  ImportAvails
669 plusImportAvails
670   (ImportAvails { imp_mods = mods1,
671                   imp_dep_mods = dmods1, imp_dep_pkgs = dpkgs1,
672                   imp_trust_pkgs = tpkgs1, imp_trust_own_pkg = tself1,
673                   imp_orphs = orphs1, imp_finsts = finsts1 })
674   (ImportAvails { imp_mods = mods2,
675                   imp_dep_mods = dmods2, imp_dep_pkgs = dpkgs2,
676                   imp_trust_pkgs = tpkgs2, imp_trust_own_pkg = tself2,
677                   imp_orphs = orphs2, imp_finsts = finsts2 })
678   = ImportAvails { imp_mods          = plusModuleEnv_C (++) mods1 mods2,
679                    imp_dep_mods      = plusUFM_C plus_mod_dep dmods1 dmods2,
680                    imp_dep_pkgs      = dpkgs1 `unionLists` dpkgs2,
681                    imp_trust_pkgs    = tpkgs1 `unionLists` tpkgs2,
682                    imp_trust_own_pkg = tself1 || tself2,
683                    imp_orphs         = orphs1 `unionLists` orphs2,
684                    imp_finsts        = finsts1 `unionLists` finsts2 }
685   where
686     plus_mod_dep (m1, boot1) (m2, boot2) 
687         = WARN( not (m1 == m2), (ppr m1 <+> ppr m2) $$ (ppr boot1 <+> ppr boot2) )
688                 -- Check mod-names match
689           (m1, boot1 && boot2) -- If either side can "see" a non-hi-boot interface, use that
690 \end{code}
691
692 %************************************************************************
693 %*                                                                      *
694 \subsection{Where from}
695 %*                                                                      *
696 %************************************************************************
697
698 The @WhereFrom@ type controls where the renamer looks for an interface file
699
700 \begin{code}
701 data WhereFrom 
702   = ImportByUser IsBootInterface        -- Ordinary user import (perhaps {-# SOURCE #-})
703   | ImportBySystem                      -- Non user import.
704
705 instance Outputable WhereFrom where
706   ppr (ImportByUser is_boot) | is_boot     = ptext (sLit "{- SOURCE -}")
707                              | otherwise   = empty
708   ppr ImportBySystem                       = ptext (sLit "{- SYSTEM -}")
709 \end{code}
710
711
712 %************************************************************************
713 %*                                                                      *
714                 Wanted constraints
715      These are forced to be in TcRnTypes because
716            TcLclEnv mentions WantedConstraints
717            WantedConstraint mentions CtLoc
718            CtLoc mentions ErrCtxt
719            ErrCtxt mentions TcM
720 %*                                                                      *
721 v%************************************************************************
722
723 \begin{code}
724 data WantedConstraints
725   = WC { wc_flat  :: Bag WantedEvVar   -- Unsolved constraints, all wanted
726        , wc_impl  :: Bag Implication
727        , wc_insol :: Bag FlavoredEvVar -- Insoluble constraints, can be
728                                        -- wanted, given, or derived
729                                        -- See Note [Insoluble constraints]
730     }
731
732 emptyWC :: WantedConstraints
733 emptyWC = WC { wc_flat = emptyBag, wc_impl = emptyBag, wc_insol = emptyBag }
734
735 mkFlatWC :: Bag WantedEvVar -> WantedConstraints
736 mkFlatWC wevs = WC { wc_flat = wevs, wc_impl = emptyBag, wc_insol = emptyBag }
737
738 isEmptyWC :: WantedConstraints -> Bool
739 isEmptyWC (WC { wc_flat = f, wc_impl = i, wc_insol = n })
740   = isEmptyBag f && isEmptyBag i && isEmptyBag n
741
742 insolubleWC :: WantedConstraints -> Bool
743 -- True if there are any insoluble constraints in the wanted bag
744 insolubleWC wc = not (isEmptyBag (wc_insol wc))
745                || anyBag ic_insol (wc_impl wc)
746
747 andWC :: WantedConstraints -> WantedConstraints -> WantedConstraints
748 andWC (WC { wc_flat = f1, wc_impl = i1, wc_insol = n1 })
749       (WC { wc_flat = f2, wc_impl = i2, wc_insol = n2 })
750   = WC { wc_flat  = f1 `unionBags` f2
751        , wc_impl  = i1 `unionBags` i2
752        , wc_insol = n1 `unionBags` n2 }
753
754 addFlats :: WantedConstraints -> Bag WantedEvVar -> WantedConstraints
755 addFlats wc wevs = wc { wc_flat = wc_flat wc `unionBags` wevs }
756
757 addImplics :: WantedConstraints -> Bag Implication -> WantedConstraints
758 addImplics wc implic = wc { wc_impl = wc_impl wc `unionBags` implic }
759
760 instance Outputable WantedConstraints where
761   ppr (WC {wc_flat = f, wc_impl = i, wc_insol = n})
762    = ptext (sLit "WC") <+> braces (vcat
763         [ if isEmptyBag f then empty else
764           ptext (sLit "wc_flat =")  <+> pprBag pprWantedEvVar f
765         , if isEmptyBag i then empty else
766           ptext (sLit "wc_impl =")  <+> pprBag ppr i
767         , if isEmptyBag n then empty else
768           ptext (sLit "wc_insol =") <+> pprBag ppr n ])
769
770 pprBag :: (a -> SDoc) -> Bag a -> SDoc
771 pprBag pp b = foldrBag (($$) . pp) empty b
772 \end{code}
773  
774
775 \begin{code}
776 data Untouchables = NoUntouchables
777                   | TouchableRange
778                           Unique  -- Low end
779                           Unique  -- High end
780  -- A TcMetaTyvar is *touchable* iff its unique u satisfies
781  --   u >= low
782  --   u < high
783
784 instance Outputable Untouchables where
785   ppr NoUntouchables = ptext (sLit "No untouchables")
786   ppr (TouchableRange low high) = ptext (sLit "Touchable range:") <+> 
787                                   ppr low <+> char '-' <+> ppr high
788
789 isNoUntouchables :: Untouchables -> Bool
790 isNoUntouchables NoUntouchables      = True
791 isNoUntouchables (TouchableRange {}) = False
792
793 inTouchableRange :: Untouchables -> TcTyVar -> Bool
794 inTouchableRange NoUntouchables _ = True
795 inTouchableRange (TouchableRange low high) tv 
796   = uniq >= low && uniq < high
797   where
798     uniq = varUnique tv
799
800 -- EvVar defined in module Var.lhs:
801 -- Evidence variables include all *quantifiable* constraints
802 --   dictionaries
803 --   implicit parameters
804 --   coercion variables
805 \end{code}
806
807 %************************************************************************
808 %*                                                                      *
809                 Implication constraints
810 %*                                                                      *
811 %************************************************************************
812
813 \begin{code}
814 data Implication
815   = Implic {  
816       ic_untch :: Untouchables, -- Untouchables: unification variables
817                                 -- free in the environment
818       ic_env   :: TcTypeEnv,    -- The type environment
819                                 -- Used only when generating error messages
820           -- Generally, ic_untch is a superset of tvsof(ic_env)
821           -- However, we don't zonk ic_env when zonking the Implication
822           -- Instead we do that when generating a skolem-escape error message
823
824       ic_skols  :: TcTyVarSet,   -- Introduced skolems 
825                                  -- See Note [Skolems in an implication]
826
827       ic_given  :: [EvVar],      -- Given evidence variables
828                                  --   (order does not matter)
829       ic_loc   :: GivenLoc,      -- Binding location of the implication,
830                                  --   which is also the location of all the
831                                  --   given evidence variables
832
833       ic_wanted :: WantedConstraints,  -- The wanted
834       ic_insol  :: Bool,               -- True iff insolubleWC ic_wanted is true
835
836       ic_binds  :: EvBindsVar   -- Points to the place to fill in the
837                                 -- abstraction and bindings
838     }
839
840 instance Outputable Implication where
841   ppr (Implic { ic_untch = untch, ic_skols = skols, ic_given = given
842               , ic_wanted = wanted
843               , ic_binds = binds, ic_loc = loc })
844    = ptext (sLit "Implic") <+> braces 
845      (sep [ ptext (sLit "Untouchables = ") <+> ppr untch
846           , ptext (sLit "Skolems = ") <+> ppr skols
847           , ptext (sLit "Given = ") <+> pprEvVars given
848           , ptext (sLit "Wanted = ") <+> ppr wanted
849           , ptext (sLit "Binds = ") <+> ppr binds
850           , pprSkolInfo (ctLocOrigin loc)
851           , ppr (ctLocSpan loc) ])
852 \end{code}
853
854 Note [Skolems in an implication]
855 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
856 The skolems in an implication are not there to perform a skolem escape
857 check.  That happens because all the environment variables are in the
858 untouchables, and therefore cannot be unified with anything at all,
859 let alone the skolems.
860
861 Instead, ic_skols is used only when considering floating a constraint
862 outside the implication in TcSimplify.floatEqualities or 
863 TcSimplify.approximateImplications
864
865 Note [Insoluble constraints]
866 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
867 Some of the errors that we get during canonicalization are best
868 reported when all constraints have been simplified as much as
869 possible. For instance, assume that during simplification the
870 following constraints arise:
871    
872  [Wanted]   F alpha ~  uf1 
873  [Wanted]   beta ~ uf1 beta 
874
875 When canonicalizing the wanted (beta ~ uf1 beta), if we eagerly fail
876 we will simply see a message:
877     'Can't construct the infinite type  beta ~ uf1 beta' 
878 and the user has no idea what the uf1 variable is.
879
880 Instead our plan is that we will NOT fail immediately, but:
881     (1) Record the "frozen" error in the ic_insols field
882     (2) Isolate the offending constraint from the rest of the inerts 
883     (3) Keep on simplifying/canonicalizing
884
885 At the end, we will hopefully have substituted uf1 := F alpha, and we
886 will be able to report a more informative error:
887     'Can't construct the infinite type beta ~ F alpha beta'
888
889 %************************************************************************
890 %*                                                                      *
891             EvVarX, WantedEvVar, FlavoredEvVar
892 %*                                                                      *
893 %************************************************************************
894
895 \begin{code}
896 data EvVarX a = EvVarX EvVar a
897      -- An evidence variable with accompanying info
898
899 type WantedEvVar   = EvVarX WantedLoc     -- The location where it arose
900 type FlavoredEvVar = EvVarX CtFlavor
901
902 instance Outputable (EvVarX a) where
903   ppr (EvVarX ev _) = pprEvVarWithType ev
904   -- If you want to see the associated info,
905   -- use a more specific printing function
906
907 mkEvVarX :: EvVar -> a -> EvVarX a
908 mkEvVarX = EvVarX
909
910 evVarOf :: EvVarX a -> EvVar
911 evVarOf (EvVarX ev _) = ev
912
913 evVarX :: EvVarX a -> a
914 evVarX (EvVarX _ a) = a
915
916 evVarOfPred :: EvVarX a -> PredType
917 evVarOfPred wev = evVarPred (evVarOf wev)
918
919 wantedToFlavored :: WantedEvVar -> FlavoredEvVar
920 wantedToFlavored (EvVarX v wl) = EvVarX v (Wanted wl)
921
922 keepWanted :: Bag FlavoredEvVar -> Bag WantedEvVar
923 keepWanted flevs
924   = foldrBag keep_wanted emptyBag flevs
925     -- Important: use fold*r*Bag to preserve the order of the evidence variables.
926   where
927     keep_wanted :: FlavoredEvVar -> Bag WantedEvVar -> Bag WantedEvVar
928     keep_wanted (EvVarX ev (Wanted wloc)) r = consBag (EvVarX ev wloc) r
929     keep_wanted _                         r = r
930 \end{code}
931
932
933 \begin{code}
934 pprEvVars :: [EvVar] -> SDoc    -- Print with their types
935 pprEvVars ev_vars = vcat (map pprEvVarWithType ev_vars)
936
937 pprEvVarTheta :: [EvVar] -> SDoc
938 pprEvVarTheta ev_vars = pprTheta (map evVarPred ev_vars)
939                               
940 pprEvVarWithType :: EvVar -> SDoc
941 pprEvVarWithType v = ppr v <+> dcolon <+> pprPredTy (evVarPred v)
942
943 pprWantedsWithLocs :: WantedConstraints -> SDoc
944 pprWantedsWithLocs wcs
945   =  vcat [ pprBag pprWantedEvVarWithLoc (wc_flat wcs)
946           , pprBag ppr (wc_impl wcs)
947           , pprBag ppr (wc_insol wcs) ]
948
949 pprWantedEvVarWithLoc, pprWantedEvVar :: WantedEvVar -> SDoc
950 pprWantedEvVarWithLoc (EvVarX v loc) = hang (pprEvVarWithType v)
951                                           2 (pprArisingAt loc)
952 pprWantedEvVar        (EvVarX v _)   = pprEvVarWithType v
953 \end{code}
954
955 %************************************************************************
956 %*                                                                      *
957             CtLoc
958 %*                                                                      *
959 %************************************************************************
960
961 \begin{code}
962 data CtFlavor
963   = Given GivenLoc GivenKind -- We have evidence for this constraint in TcEvBinds
964   | Derived WantedLoc        -- Derived's are just hints for unifications 
965   | Wanted WantedLoc         -- We have no evidence bindings for this constraint. 
966
967 data GivenKind
968   = GivenOrig   -- Originates in some given, such as signature or pattern match
969   | GivenSolved -- Is given as result of being solved, maybe provisionally on
970                 -- some other wanted constraints. 
971
972 instance Outputable CtFlavor where
973   ppr (Given _ GivenOrig)   = ptext (sLit "[G]")
974   ppr (Given _ GivenSolved) = ptext (sLit "[S]") -- Print [S] for Given/Solved's
975   ppr (Wanted {})           = ptext (sLit "[W]")
976   ppr (Derived {})          = ptext (sLit "[D]") 
977
978 pprFlavorArising :: CtFlavor -> SDoc
979 pprFlavorArising (Derived wl)   = pprArisingAt wl
980 pprFlavorArising (Wanted  wl)   = pprArisingAt wl
981 pprFlavorArising (Given gl _)   = pprArisingAt gl
982
983 isWanted :: CtFlavor -> Bool
984 isWanted (Wanted {}) = True
985 isWanted _           = False
986
987 isGivenOrSolved :: CtFlavor -> Bool
988 isGivenOrSolved (Given {}) = True
989 isGivenOrSolved _ = False
990
991 isGiven_maybe :: CtFlavor -> Maybe GivenKind 
992 isGiven_maybe (Given _ gk) = Just gk
993 isGiven_maybe _            = Nothing
994
995 isDerived :: CtFlavor -> Bool 
996 isDerived (Derived {}) = True
997 isDerived _            = False
998 \end{code}
999
1000 %************************************************************************
1001 %*                                                                      *
1002             CtLoc
1003 %*                                                                      *
1004 %************************************************************************
1005
1006 The 'CtLoc' gives information about where a constraint came from.
1007 This is important for decent error message reporting because
1008 dictionaries don't appear in the original source code.
1009 type will evolve...
1010
1011 \begin{code}
1012 data CtLoc orig = CtLoc orig SrcSpan [ErrCtxt]
1013
1014 type WantedLoc = CtLoc CtOrigin      -- Instantiation for wanted constraints
1015 type GivenLoc  = CtLoc SkolemInfo    -- Instantiation for given constraints
1016
1017 ctLocSpan :: CtLoc o -> SrcSpan
1018 ctLocSpan (CtLoc _ s _) = s
1019
1020 ctLocOrigin :: CtLoc o -> o
1021 ctLocOrigin (CtLoc o _ _) = o
1022
1023 setCtLocOrigin :: CtLoc o -> o' -> CtLoc o'
1024 setCtLocOrigin (CtLoc _ s c) o = CtLoc o s c
1025
1026 pushErrCtxt :: orig -> ErrCtxt -> CtLoc orig -> CtLoc orig
1027 pushErrCtxt o err (CtLoc _ s errs) = CtLoc o s (err:errs)
1028
1029 pprArising :: CtOrigin -> SDoc
1030 -- Used for the main, top-level error message
1031 -- We've done special processing for TypeEq and FunDep origins
1032 pprArising (TypeEqOrigin {}) = empty
1033 pprArising FunDepOrigin      = empty
1034 pprArising orig              = text "arising from" <+> ppr orig
1035
1036 pprArisingAt :: Outputable o => CtLoc o -> SDoc
1037 pprArisingAt (CtLoc o s _) = sep [ text "arising from" <+> ppr o
1038                                  , text "at" <+> ppr s]
1039 \end{code}
1040
1041 %************************************************************************
1042 %*                                                                      *
1043                 SkolemInfo
1044 %*                                                                      *
1045 %************************************************************************
1046
1047 \begin{code}
1048 -- SkolemInfo gives the origin of *given* constraints
1049 --   a) type variables are skolemised
1050 --   b) an implication constraint is generated
1051 data SkolemInfo
1052   = SigSkol UserTypeCtxt        -- A skolem that is created by instantiating
1053             Type                -- a programmer-supplied type signature
1054                                 -- Location of the binding site is on the TyVar
1055
1056         -- The rest are for non-scoped skolems
1057   | ClsSkol Class       -- Bound at a class decl
1058   | InstSkol            -- Bound at an instance decl
1059   | DataSkol            -- Bound at a data type declaration
1060   | FamInstSkol         -- Bound at a family instance decl
1061   | PatSkol             -- An existential type variable bound by a pattern for
1062       DataCon           -- a data constructor with an existential type.
1063       (HsMatchContext Name)     
1064              -- e.g.   data T = forall a. Eq a => MkT a
1065              --        f (MkT x) = ...
1066              -- The pattern MkT x will allocate an existential type
1067              -- variable for 'a'.  
1068
1069   | ArrowSkol           -- An arrow form (see TcArrows)
1070
1071   | IPSkol [IPName Name]  -- Binding site of an implicit parameter
1072
1073   | RuleSkol RuleName   -- The LHS of a RULE
1074
1075   | InferSkol [(Name,TcType)]
1076                         -- We have inferred a type for these (mutually-recursivive)
1077                         -- polymorphic Ids, and are now checking that their RHS
1078                         -- constraints are satisfied.
1079
1080   | BracketSkol         -- Template Haskell bracket
1081
1082   | UnkSkol             -- Unhelpful info (until I improve it)
1083
1084 instance Outputable SkolemInfo where
1085   ppr = pprSkolInfo
1086
1087 pprSkolInfo :: SkolemInfo -> SDoc
1088 -- Complete the sentence "is a rigid type variable bound by..."
1089 pprSkolInfo (SigSkol (FunSigCtxt f) ty)
1090                             = hang (ptext (sLit "the type signature for"))
1091                                  2 (ppr f <+> dcolon <+> ppr ty)
1092 pprSkolInfo (SigSkol cx ty) = hang (pprUserTypeCtxt cx <> colon)
1093                                  2 (ppr ty)
1094 pprSkolInfo (IPSkol ips)    = ptext (sLit "the implicit-parameter bindings for")
1095                               <+> pprWithCommas ppr ips
1096 pprSkolInfo (ClsSkol cls)   = ptext (sLit "the class declaration for") <+> quotes (ppr cls)
1097 pprSkolInfo InstSkol        = ptext (sLit "the instance declaration")
1098 pprSkolInfo DataSkol        = ptext (sLit "the data type declaration")
1099 pprSkolInfo FamInstSkol     = ptext (sLit "the family instance declaration")
1100 pprSkolInfo BracketSkol     = ptext (sLit "a Template Haskell bracket")
1101 pprSkolInfo (RuleSkol name) = ptext (sLit "the RULE") <+> doubleQuotes (ftext name)
1102 pprSkolInfo ArrowSkol       = ptext (sLit "the arrow form")
1103 pprSkolInfo (PatSkol dc mc)  = sep [ ptext (sLit "a pattern with constructor")
1104                                    , nest 2 $ ppr dc <+> dcolon
1105                                               <+> ppr (dataConUserType dc) <> comma
1106                                   , ptext (sLit "in") <+> pprMatchContext mc ]
1107 pprSkolInfo (InferSkol ids) = sep [ ptext (sLit "the inferred type of")
1108                                   , vcat [ ppr name <+> dcolon <+> ppr ty
1109                                          | (name,ty) <- ids ]]
1110
1111 -- UnkSkol
1112 -- For type variables the others are dealt with by pprSkolTvBinding.  
1113 -- For Insts, these cases should not happen
1114 pprSkolInfo UnkSkol = WARN( True, text "pprSkolInfo: UnkSkol" ) ptext (sLit "UnkSkol")
1115 \end{code}
1116
1117
1118 %************************************************************************
1119 %*                                                                      *
1120             CtOrigin
1121 %*                                                                      *
1122 %************************************************************************
1123
1124 \begin{code}
1125 -- CtOrigin gives the origin of *wanted* constraints
1126 data CtOrigin
1127   = OccurrenceOf Name           -- Occurrence of an overloaded identifier
1128   | AppOrigin                   -- An application of some kind
1129
1130   | SpecPragOrigin Name         -- Specialisation pragma for identifier
1131
1132   | TypeEqOrigin EqOrigin
1133
1134   | IPOccOrigin  (IPName Name)  -- Occurrence of an implicit parameter
1135
1136   | LiteralOrigin (HsOverLit Name)      -- Occurrence of a literal
1137   | NegateOrigin                        -- Occurrence of syntactic negation
1138
1139   | ArithSeqOrigin (ArithSeqInfo Name) -- [x..], [x..y] etc
1140   | PArrSeqOrigin  (ArithSeqInfo Name) -- [:x..y:] and [:x,y..z:]
1141   | SectionOrigin
1142   | TupleOrigin                        -- (..,..)
1143   | ExprSigOrigin       -- e :: ty
1144   | PatSigOrigin        -- p :: ty
1145   | PatOrigin           -- Instantiating a polytyped pattern at a constructor
1146   | RecordUpdOrigin
1147   | ViewPatOrigin
1148
1149   | ScOrigin            -- Typechecking superclasses of an instance declaration
1150   | DerivOrigin         -- Typechecking deriving
1151   | StandAloneDerivOrigin -- Typechecking stand-alone deriving
1152   | DefaultOrigin       -- Typechecking a default decl
1153   | DoOrigin            -- Arising from a do expression
1154   | MCompOrigin         -- Arising from a monad comprehension
1155   | IfOrigin            -- Arising from an if statement
1156   | ProcOrigin          -- Arising from a proc expression
1157   | AnnOrigin           -- An annotation
1158   | FunDepOrigin
1159
1160 data EqOrigin 
1161   = UnifyOrigin 
1162        { uo_actual   :: TcType
1163        , uo_expected :: TcType }
1164
1165 instance Outputable CtOrigin where
1166   ppr orig = pprO orig
1167
1168 pprO :: CtOrigin -> SDoc
1169 pprO (OccurrenceOf name)   = hsep [ptext (sLit "a use of"), quotes (ppr name)]
1170 pprO AppOrigin             = ptext (sLit "an application")
1171 pprO (SpecPragOrigin name) = hsep [ptext (sLit "a specialisation pragma for"), quotes (ppr name)]
1172 pprO (IPOccOrigin name)    = hsep [ptext (sLit "a use of implicit parameter"), quotes (ppr name)]
1173 pprO RecordUpdOrigin       = ptext (sLit "a record update")
1174 pprO ExprSigOrigin         = ptext (sLit "an expression type signature")
1175 pprO PatSigOrigin          = ptext (sLit "a pattern type signature")
1176 pprO PatOrigin             = ptext (sLit "a pattern")
1177 pprO ViewPatOrigin         = ptext (sLit "a view pattern")
1178 pprO IfOrigin              = ptext (sLit "an if statement")
1179 pprO (LiteralOrigin lit)   = hsep [ptext (sLit "the literal"), quotes (ppr lit)]
1180 pprO (ArithSeqOrigin seq)  = hsep [ptext (sLit "the arithmetic sequence"), quotes (ppr seq)]
1181 pprO (PArrSeqOrigin seq)   = hsep [ptext (sLit "the parallel array sequence"), quotes (ppr seq)]
1182 pprO SectionOrigin         = ptext (sLit "an operator section")
1183 pprO TupleOrigin           = ptext (sLit "a tuple")
1184 pprO NegateOrigin          = ptext (sLit "a use of syntactic negation")
1185 pprO ScOrigin              = ptext (sLit "the superclasses of an instance declaration")
1186 pprO DerivOrigin           = ptext (sLit "the 'deriving' clause of a data type declaration")
1187 pprO StandAloneDerivOrigin = ptext (sLit "a 'deriving' declaration")
1188 pprO DefaultOrigin         = ptext (sLit "a 'default' declaration")
1189 pprO DoOrigin              = ptext (sLit "a do statement")
1190 pprO MCompOrigin           = ptext (sLit "a statement in a monad comprehension")
1191 pprO ProcOrigin            = ptext (sLit "a proc expression")
1192 pprO (TypeEqOrigin eq)     = ptext (sLit "an equality") <+> ppr eq
1193 pprO AnnOrigin             = ptext (sLit "an annotation")
1194 pprO FunDepOrigin          = ptext (sLit "a functional dependency")
1195
1196 instance Outputable EqOrigin where
1197   ppr (UnifyOrigin t1 t2) = ppr t1 <+> char '~' <+> ppr t2
1198 \end{code}
1199