Type.hs 126 KB
Newer Older
1 2 3 4
-- (c) The University of Glasgow 2006
-- (c) The GRASP/AQUA Project, Glasgow University, 1998
--
-- Type - public interface
5

Richard Eisenberg's avatar
Richard Eisenberg committed
6
{-# LANGUAGE CPP, FlexibleContexts #-}
7
{-# OPTIONS_GHC -fno-warn-orphans #-}
8
{-# OPTIONS_GHC -Wno-incomplete-record-updates #-}
Ian Lynagh's avatar
Ian Lynagh committed
9

batterseapower's avatar
batterseapower committed
10
-- | Main functions for manipulating types and type-related things
Sylvain Henry's avatar
Sylvain Henry committed
11
module GHC.Core.Type (
ian@well-typed.com's avatar
ian@well-typed.com committed
12
        -- Note some of this is just re-exports from TyCon..
13

batterseapower's avatar
batterseapower committed
14
        -- * Main data types representing Types
ian@well-typed.com's avatar
ian@well-typed.com committed
15 16
        -- $type_classification

batterseapower's avatar
batterseapower committed
17
        -- $representation_types
Ryan Scott's avatar
Ryan Scott committed
18
        TyThing(..), Type, ArgFlag(..), AnonArgFlag(..), ForallVisFlag(..),
Simon Peyton Jones's avatar
Simon Peyton Jones committed
19
        KindOrType, PredType, ThetaType,
Ningning Xie's avatar
Ningning Xie committed
20
        Var, TyVar, isTyVar, TyCoVar, TyCoBinder, TyCoVarBinder, TyVarBinder,
21
        KnotTied,
22

batterseapower's avatar
batterseapower committed
23
        -- ** Constructing and deconstructing types
24
        mkTyVarTy, mkTyVarTys, getTyVar, getTyVar_maybe, repGetTyVar_maybe,
Ningning Xie's avatar
Ningning Xie committed
25
        getCastedTyVar_maybe, tyVarKind, varType,
26

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
27
        mkAppTy, mkAppTys, splitAppTy, splitAppTys, repSplitAppTys,
28
        splitAppTy_maybe, repSplitAppTy_maybe, tcRepSplitAppTy_maybe,
29

Simon Peyton Jones's avatar
Simon Peyton Jones committed
30 31
        mkVisFunTy, mkInvisFunTy, mkVisFunTys, mkInvisFunTys,
        splitFunTy, splitFunTy_maybe,
32
        splitFunTys, funResultTy, funArgTy,
33

ian@well-typed.com's avatar
ian@well-typed.com committed
34
        mkTyConApp, mkTyConTy,
35 36
        tyConAppTyCon_maybe, tyConAppTyConPicky_maybe,
        tyConAppArgs_maybe, tyConAppTyCon, tyConAppArgs,
Krzysztof Gogolewski's avatar
Krzysztof Gogolewski committed
37
        splitTyConApp_maybe, splitTyConApp, tyConAppArgN,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
38
        tcSplitTyConApp_maybe,
39 40 41
        splitListTyConApp_maybe,
        repSplitTyConApp_maybe,

42 43
        mkForAllTy, mkForAllTys, mkTyCoInvForAllTys,
        mkSpecForAllTy, mkSpecForAllTys,
Ningning Xie's avatar
Ningning Xie committed
44 45
        mkVisForAllTys, mkTyCoInvForAllTy,
        mkInvForAllTy, mkInvForAllTys,
46 47
        splitForAllTys, splitForAllTysSameVis,
        splitForAllVarBndrs,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
48
        splitForAllTy_maybe, splitForAllTy,
Ningning Xie's avatar
Ningning Xie committed
49
        splitForAllTy_ty_maybe, splitForAllTy_co_maybe,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
50
        splitPiTy_maybe, splitPiTy, splitPiTys,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
51 52
        mkTyConBindersPreferAnon,
        mkPiTy, mkPiTys,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
53
        mkLamType, mkLamTypes,
54
        piResultTy, piResultTys,
55
        applyTysX, dropForAlls,
56
        mkFamilyTyConApp,
57
        buildSynTyCon,
58

59 60
        mkNumLitTy, isNumLitTy,
        mkStrLitTy, isStrLitTy,
61
        isLitTy,
62

63 64
        isPredTy,

65
        getRuntimeRep_maybe, kindRep_maybe, kindRep,
Ben Gamari's avatar
Ben Gamari committed
66

Simon Peyton Jones's avatar
Simon Peyton Jones committed
67
        mkCastTy, mkCoercionTy, splitCastTy_maybe,
68
        discardCast,
69

70
        userTypeError_maybe, pprUserTypeErrorTy,
71

72
        coAxNthLHS,
73
        stripCoercionTy,
74

75 76 77
        splitPiTysInvisible, splitPiTysInvisibleN,
        invisibleTyBndrCount,
        filterOutInvisibleTypes, filterOutInferredTypes,
78 79
        partitionInvisibleTypes, partitionInvisibles,
        tyConArgFlags, appTyArgFlags,
80 81
        synTyConResKind,

lukemaurer's avatar
lukemaurer committed
82 83
        modifyJoinResTy, setJoinResTy,

84
        -- ** Analyzing types
85
        TyCoMapper(..), mapTyCo, mapTyCoX,
86
        TyCoFolder(..), foldTyCo,
ian@well-typed.com's avatar
ian@well-typed.com committed
87 88 89 90

        -- (Newtypes)
        newTyConInstRhs,

91
        -- ** Binders
92
        sameVis,
Ningning Xie's avatar
Ningning Xie committed
93 94
        mkTyCoVarBinder, mkTyCoVarBinders,
        mkTyVarBinders,
95
        mkAnonBinder,
96
        isAnonTyCoBinder,
Ningning Xie's avatar
Ningning Xie committed
97 98 99
        binderVar, binderVars, binderType, binderArgFlag,
        tyCoBinderType, tyCoBinderVar_maybe,
        tyBinderType,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
100
        binderRelevantType_maybe,
101 102
        isVisibleArgFlag, isInvisibleArgFlag, isVisibleBinder,
        isInvisibleBinder, isNamedBinder,
Ningning Xie's avatar
Ningning Xie committed
103
        tyConBindersTyCoBinders,
104

ian@well-typed.com's avatar
ian@well-typed.com committed
105
        -- ** Common type constructors
batterseapower's avatar
batterseapower committed
106
        funTyCon,
107

batterseapower's avatar
batterseapower committed
108
        -- ** Predicates on types
109
        isTyVarTy, isFunTy, isCoercionTy,
110
        isCoercionTy_maybe, isForAllTy,
Ningning Xie's avatar
Ningning Xie committed
111
        isForAllTy_ty, isForAllTy_co,
112
        isPiTy, isTauTy, isFamFreeTy,
113
        isCoVarType,
batterseapower's avatar
batterseapower committed
114

lukemaurer's avatar
lukemaurer committed
115
        isValidJoinPointType,
Ben Gamari's avatar
Ben Gamari committed
116
        tyConAppNeedsKindSig,
lukemaurer's avatar
lukemaurer committed
117

118 119 120 121 122
        -- *** Levity and boxity
        isLiftedType_maybe,
        isLiftedTypeKind, isUnliftedTypeKind,
        isLiftedRuntimeRep, isUnliftedRuntimeRep,
        isUnliftedType, mightBeUnliftedType, isUnboxedTupleType, isUnboxedSumType,
123
        isAlgType, isDataFamilyAppType,
ian@well-typed.com's avatar
ian@well-typed.com committed
124
        isPrimitiveType, isStrictType,
125 126
        isRuntimeRepTy, isRuntimeRepVar, isRuntimeRepKindedTy,
        dropRuntimeRepArgs,
127
        getRuntimeRep,
128

ian@well-typed.com's avatar
ian@well-typed.com committed
129
        -- * Main data types representing Kinds
130
        Kind,
batterseapower's avatar
batterseapower committed
131 132

        -- ** Finding the kind of a type
133
        typeKind, tcTypeKind, isTypeLevPoly, resultIsLevPoly,
134
        tcIsLiftedTypeKind, tcIsConstraintKind, tcReturnsConstraintKind,
135
        tcIsRuntimeTypeKind,
ian@well-typed.com's avatar
ian@well-typed.com committed
136

137
        -- ** Common Kind
138
        liftedTypeKind,
batterseapower's avatar
batterseapower committed
139

ian@well-typed.com's avatar
ian@well-typed.com committed
140
        -- * Type free variables
141
        tyCoFVsOfType, tyCoFVsBndr, tyCoFVsVarBndr, tyCoFVsVarBndrs,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
142
        tyCoVarsOfType, tyCoVarsOfTypes,
143 144
        tyCoVarsOfTypeDSet,
        coVarsOfType,
Tobias Dammers's avatar
Tobias Dammers committed
145 146
        coVarsOfTypes,

Richard Eisenberg's avatar
Richard Eisenberg committed
147
        noFreeVarsOfType,
148
        splitVisVarsOfType, splitVisVarsOfTypes,
ian@well-typed.com's avatar
ian@well-typed.com committed
149
        expandTypeSynonyms,
150
        typeSize, occCheckExpand,
151

152
        -- ** Closing over kinds
Simon Peyton Jones's avatar
Simon Peyton Jones committed
153
        closeOverKindsDSet, closeOverKindsList,
154 155
        closeOverKinds,

156
        -- * Well-scoped lists of variables
157 158
        scopedSort, tyCoVarsOfTypeWellScoped,
        tyCoVarsOfTypesWellScoped,
159

ian@well-typed.com's avatar
ian@well-typed.com committed
160
        -- * Type comparison
niteria's avatar
niteria committed
161 162
        eqType, eqTypeX, eqTypes, nonDetCmpType, nonDetCmpTypes, nonDetCmpTypeX,
        nonDetCmpTypesX, nonDetCmpTc,
163
        eqVarBndrs,
164

ian@well-typed.com's avatar
ian@well-typed.com committed
165
        -- * Forcing evaluation of types
batterseapower's avatar
batterseapower committed
166
        seqType, seqTypes,
167

batterseapower's avatar
batterseapower committed
168
        -- * Other views onto Types
Ben Gamari's avatar
Ben Gamari committed
169
        coreView, tcView,
batterseapower's avatar
batterseapower committed
170

171
        tyConsOfType,
batterseapower's avatar
batterseapower committed
172

ian@well-typed.com's avatar
ian@well-typed.com committed
173 174
        -- * Main type substitution data types
        TvSubstEnv,     -- Representation widely visible
175
        TCvSubst(..),    -- Representation visible to a few friends
ian@well-typed.com's avatar
ian@well-typed.com committed
176 177

        -- ** Manipulating type substitutions
178
        emptyTvSubstEnv, emptyTCvSubst, mkEmptyTCvSubst,
ian@well-typed.com's avatar
ian@well-typed.com committed
179

niteria's avatar
niteria committed
180
        mkTCvSubst, zipTvSubst, mkTvSubstPrs,
Ningning Xie's avatar
Ningning Xie committed
181
        zipTCvSubst,
182
        notElemTCvSubst,
183
        getTvSubstEnv, setTvSubstEnv,
184
        zapTCvSubst, getTCvInScope, getTCvSubstRangeFVs,
185
        extendTCvInScope, extendTCvInScopeList, extendTCvInScopeSet,
186
        extendTCvSubst, extendCvSubst,
Richard Eisenberg's avatar
Richard Eisenberg committed
187
        extendTvSubst, extendTvSubstBinderAndInScope,
188
        extendTvSubstList, extendTvSubstAndInScope,
Ningning Xie's avatar
Ningning Xie committed
189
        extendTCvSubstList,
190
        extendTvSubstWithClone,
Ningning Xie's avatar
Ningning Xie committed
191
        extendTCvSubstWithClone,
192 193
        isInScope, composeTCvSubstEnv, composeTCvSubst, zipTyEnv, zipCoEnv,
        isEmptyTCvSubst, unionTCvSubst,
194

ian@well-typed.com's avatar
ian@well-typed.com committed
195 196
        -- ** Performing substitution on types and kinds
        substTy, substTys, substTyWith, substTysWith, substTheta,
197 198
        substTyAddInScope,
        substTyUnchecked, substTysUnchecked, substThetaUnchecked,
199
        substTyWithUnchecked,
200
        substCoUnchecked, substCoWithUnchecked,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
201
        substTyVarBndr, substTyVarBndrs, substTyVar, substTyVars,
Ningning Xie's avatar
Ningning Xie committed
202
        substVarBndr, substVarBndrs,
203
        cloneTyVarBndr, cloneTyVarBndrs, lookupTyVar,
204

Simon Peyton Jones's avatar
Simon Peyton Jones committed
205 206 207 208
        -- * Tidying type related things up for printing
        tidyType,      tidyTypes,
        tidyOpenType,  tidyOpenTypes,
        tidyOpenKind,
Ningning Xie's avatar
Ningning Xie committed
209
        tidyVarBndr, tidyVarBndrs, tidyFreeTyCoVars,
210
        tidyOpenTyCoVar, tidyOpenTyCoVars,
Ningning Xie's avatar
Ningning Xie committed
211
        tidyTyCoVarOcc,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
212
        tidyTopType,
213
        tidyKind,
214 215 216 217 218 219
        tidyTyCoVarBinder, tidyTyCoVarBinders,

        -- * Kinds
        isConstraintKindCon,
        classifiesTypeWithValues,
        isKindLevPoly
220
    ) where
221

222 223
#include "HsVersions.h"

224 225
import GhcPrelude

lukemaurer's avatar
lukemaurer committed
226 227
import BasicTypes

Sylvain Henry's avatar
Sylvain Henry committed
228
-- We import the representation and primitive functions from GHC.Core.TyCo.Rep.
229 230
-- Many things are reexported, but not the representation!

Sylvain Henry's avatar
Sylvain Henry committed
231 232 233 234
import GHC.Core.TyCo.Rep
import GHC.Core.TyCo.Subst
import GHC.Core.TyCo.Tidy
import GHC.Core.TyCo.FVs
235

236
-- friends:
237
import Var
238 239
import VarEnv
import VarSet
David Feuer's avatar
David Feuer committed
240
import UniqSet
241

Sylvain Henry's avatar
Sylvain Henry committed
242
import GHC.Core.TyCon
243
import TysPrim
244
import {-# SOURCE #-} TysWiredIn ( listTyCon, typeNatKind
245
                                 , typeSymbolKind, liftedTypeKind
246
                                 , liftedTypeKindTyCon
247
                                 , constraintKind )
248
import Name( Name )
249
import PrelNames
Sylvain Henry's avatar
Sylvain Henry committed
250 251 252 253 254 255 256 257 258 259
import GHC.Core.Coercion.Axiom
import {-# SOURCE #-} GHC.Core.Coercion
   ( mkNomReflCo, mkGReflCo, mkReflCo
   , mkTyConAppCo, mkAppCo, mkCoVarCo, mkAxiomRuleCo
   , mkForAllCo, mkFunCo, mkAxiomInstCo, mkUnivCo
   , mkSymCo, mkTransCo, mkNthCo, mkLRCo, mkInstCo
   , mkKindCo, mkSubCo, mkFunCo, mkAxiomInstCo
   , decomposePiCos, coercionKind, coercionLKind
   , coercionRKind, coercionType
   , isReflexiveCo, seqCo )
260

261
-- others
262
import Util
Tobias Dammers's avatar
Tobias Dammers committed
263
import FV
264
import Outputable
265
import FastString
266 267
import Pair
import ListSetOps
268
import Unique ( nonDetCmpUnique )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
269

ian@well-typed.com's avatar
ian@well-typed.com committed
270
import Maybes           ( orElse )
Tobias Dammers's avatar
Tobias Dammers committed
271
import Data.Maybe       ( isJust )
272
import Control.Monad    ( guard )
273

batterseapower's avatar
batterseapower committed
274 275
-- $type_classification
-- #type_classification#
ian@well-typed.com's avatar
ian@well-typed.com committed
276
--
batterseapower's avatar
batterseapower committed
277
-- Types are one of:
ian@well-typed.com's avatar
ian@well-typed.com committed
278
--
batterseapower's avatar
batterseapower committed
279
-- [Unboxed]            Iff its representation is other than a pointer
ian@well-typed.com's avatar
ian@well-typed.com committed
280 281
--                      Unboxed types are also unlifted.
--
batterseapower's avatar
batterseapower committed
282
-- [Lifted]             Iff it has bottom as an element.
ian@well-typed.com's avatar
ian@well-typed.com committed
283 284 285 286 287 288
--                      Closures always have lifted types: i.e. any
--                      let-bound identifier in Core must have a lifted
--                      type. Operationally, a lifted object is one that
--                      can be entered.
--                      Only lifted types may be unified with a type variable.
--
batterseapower's avatar
batterseapower committed
289
-- [Algebraic]          Iff it is a type with one or more constructors, whether
ian@well-typed.com's avatar
ian@well-typed.com committed
290 291 292 293 294 295
--                      declared with @data@ or @newtype@.
--                      An algebraic type is one that can be deconstructed
--                      with a case expression. This is /not/ the same as
--                      lifted types, because we also include unboxed
--                      tuples in this classification.
--
batterseapower's avatar
batterseapower committed
296
-- [Data]               Iff it is a type declared with @data@, or a boxed tuple.
ian@well-typed.com's avatar
ian@well-typed.com committed
297
--
batterseapower's avatar
batterseapower committed
298
-- [Primitive]          Iff it is a built-in type that can't be expressed in Haskell.
ian@well-typed.com's avatar
ian@well-typed.com committed
299
--
batterseapower's avatar
batterseapower committed
300 301
-- Currently, all primitive types are unlifted, but that's not necessarily
-- the case: for example, @Int@ could be primitive.
ian@well-typed.com's avatar
ian@well-typed.com committed
302
--
batterseapower's avatar
batterseapower committed
303 304 305
-- Some primitive types are unboxed, such as @Int#@, whereas some are boxed
-- but unlifted (such as @ByteArray#@).  The only primitive types that we
-- classify as algebraic are the unboxed tuples.
ian@well-typed.com's avatar
ian@well-typed.com committed
306
--
batterseapower's avatar
batterseapower committed
307
-- Some examples of type classifications that may make this a bit clearer are:
ian@well-typed.com's avatar
ian@well-typed.com committed
308
--
batterseapower's avatar
batterseapower committed
309
-- @
310
-- Type          primitive       boxed           lifted          algebraic
batterseapower's avatar
batterseapower committed
311
-- -----------------------------------------------------------------------------
312 313 314 315 316 317
-- Int#          Yes             No              No              No
-- ByteArray#    Yes             Yes             No              No
-- (\# a, b \#)  Yes             No              No              Yes
-- (\# a | b \#) Yes             No              No              Yes
-- (  a, b  )    No              Yes             Yes             Yes
-- [a]           No              Yes             Yes             Yes
batterseapower's avatar
batterseapower committed
318 319 320 321 322
-- @

-- $representation_types
-- A /source type/ is a type that is a separate type as far as the type checker is
-- concerned, but which has a more low-level representation as far as Core-to-Core
batterseapower's avatar
batterseapower committed
323
-- passes and the rest of the back end is concerned.
batterseapower's avatar
batterseapower committed
324 325 326
--
-- You don't normally have to worry about this, as the utility functions in
-- this module will automatically convert a source into a representation type
Ningning Xie's avatar
Ningning Xie committed
327
-- if they are spotted, to the best of its abilities. If you don't want this
batterseapower's avatar
batterseapower committed
328
-- to happen, use the equivalent functions from the "TcType" module.
329

330 331 332
{-
************************************************************************
*                                                                      *
ian@well-typed.com's avatar
ian@well-typed.com committed
333
                Type representation
334 335
*                                                                      *
************************************************************************
Ben Gamari's avatar
Ben Gamari committed
336 337 338

Note [coreView vs tcView]
~~~~~~~~~~~~~~~~~~~~~~~~~
339 340
So far as the typechecker is concerned, 'Constraint' and 'TYPE
LiftedRep' are distinct kinds.
Ben Gamari's avatar
Ben Gamari committed
341 342 343

But in Core these two are treated as identical.

344 345 346
We implement this by making 'coreView' convert 'Constraint' to 'TYPE
LiftedRep' on the fly.  The function tcView (used in the type checker)
does not do this.
Ben Gamari's avatar
Ben Gamari committed
347

348
See also #11715, which tracks removing this inconsistency.
Ben Gamari's avatar
Ben Gamari committed
349

350
-}
351

Ben Gamari's avatar
Ben Gamari committed
352 353 354
-- | Gives the typechecker view of a type. This unwraps synonyms but
-- leaves 'Constraint' alone. c.f. coreView, which turns Constraint into
-- TYPE LiftedRep. Returns Nothing if no unwrapping happens.
355
-- See also Note [coreView vs tcView]
Ben Gamari's avatar
Ben Gamari committed
356 357 358 359 360 361
{-# INLINE tcView #-}
tcView :: Type -> Maybe Type
tcView (TyConApp tc tys) | Just (tenv, rhs, tys') <- expandSynTyCon_maybe tc tys
  = Just (mkAppTys (substTy (mkTvSubstPrs tenv) rhs) tys')
               -- The free vars of 'rhs' should all be bound by 'tenv', so it's
               -- ok to use 'substTy' here.
Sylvain Henry's avatar
Sylvain Henry committed
362
               -- See also Note [The substitution invariant] in GHC.Core.TyCo.Subst.
Ben Gamari's avatar
Ben Gamari committed
363 364 365 366
               -- Its important to use mkAppTys, rather than (foldl AppTy),
               -- because the function part might well return a
               -- partially-applied type constructor; indeed, usually will!
tcView _ = Nothing
367

368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
{-# INLINE coreView #-}
coreView :: Type -> Maybe Type
-- ^ This function Strips off the /top layer only/ of a type synonym
-- application (if any) its underlying representation type.
-- Returns Nothing if there is nothing to look through.
-- This function considers 'Constraint' to be a synonym of @TYPE LiftedRep@.
--
-- By being non-recursive and inlined, this case analysis gets efficiently
-- joined onto the case analysis that the caller is already doing
coreView ty@(TyConApp tc tys)
  | Just (tenv, rhs, tys') <- expandSynTyCon_maybe tc tys
  = Just (mkAppTys (substTy (mkTvSubstPrs tenv) rhs) tys')
    -- This equation is exactly like tcView

  -- At the Core level, Constraint = Type
  -- See Note [coreView vs tcView]
  | isConstraintKindCon tc
  = ASSERT2( null tys, ppr ty )
    Just liftedTypeKind

coreView _ = Nothing

390 391 392 393 394
-----------------------------------------------
expandTypeSynonyms :: Type -> Type
-- ^ Expand out all type synonyms.  Actually, it'd suffice to expand out
-- just the ones that discard type variables (e.g.  type Funny a = Int)
-- But we don't know which those are currently, so we just expand all.
395 396 397
--
-- 'expandTypeSynonyms' only expands out type synonyms mentioned in the type,
-- not in the kinds of any TyCon or TyVar mentioned in the type.
398 399
--
-- Keep this synchronized with 'synonymTyConsOfType'
ian@well-typed.com's avatar
ian@well-typed.com committed
400
expandTypeSynonyms ty
401
  = go (mkEmptyTCvSubst in_scope) ty
402
  where
403 404
    in_scope = mkInScopeSet (tyCoVarsOfType ty)

405
    go subst (TyConApp tc tys)
406 407 408 409 410 411 412 413
      | Just (tenv, rhs, tys') <- expandSynTyCon_maybe tc expanded_tys
      = let subst' = mkTvSubst in_scope (mkVarEnv tenv)
            -- Make a fresh substitution; rhs has nothing to
            -- do with anything that has happened so far
            -- NB: if you make changes here, be sure to build an
            --     /idempotent/ substitution, even in the nested case
            --        type T a b = a -> b
            --        type S x y = T y x
414
            -- (#11665)
415
        in  mkAppTys (go subst' rhs) tys'
416
      | otherwise
417 418 419 420
      = TyConApp tc expanded_tys
      where
        expanded_tys = (map (go subst) tys)

421 422 423
    go _     (LitTy l)     = LitTy l
    go subst (TyVarTy tv)  = substTyVar subst tv
    go subst (AppTy t1 t2) = mkAppTy (go subst t1) (go subst t2)
Simon Peyton Jones's avatar
Simon Peyton Jones committed
424 425
    go subst ty@(FunTy _ arg res)
      = ty { ft_arg = go subst arg, ft_res = go subst res }
Ningning Xie's avatar
Ningning Xie committed
426 427 428
    go subst (ForAllTy (Bndr tv vis) t)
      = let (subst', tv') = substVarBndrUsing go subst tv in
        ForAllTy (Bndr tv' vis) (go subst' t)
429 430 431
    go subst (CastTy ty co)  = mkCastTy (go subst ty) (go_co subst co)
    go subst (CoercionTy co) = mkCoercionTy (go_co subst co)

Ningning Xie's avatar
Ningning Xie committed
432 433 434 435 436 437 438
    go_mco _     MRefl    = MRefl
    go_mco subst (MCo co) = MCo (go_co subst co)

    go_co subst (Refl ty)
      = mkNomReflCo (go subst ty)
    go_co subst (GRefl r ty mco)
      = mkGReflCo r (go subst ty) (go_mco subst mco)
439 440 441 442 443 444 445 446
       -- NB: coercions are always expanded upon creation
    go_co subst (TyConAppCo r tc args)
      = mkTyConAppCo r tc (map (go_co subst) args)
    go_co subst (AppCo co arg)
      = mkAppCo (go_co subst co) (go_co subst arg)
    go_co subst (ForAllCo tv kind_co co)
      = let (subst', tv', kind_co') = go_cobndr subst tv kind_co in
        mkForAllCo tv' kind_co' (go_co subst' co)
Ben Gamari's avatar
Ben Gamari committed
447 448
    go_co subst (FunCo r co1 co2)
      = mkFunCo r (go_co subst co1) (go_co subst co2)
449 450 451 452 453 454 455 456 457 458
    go_co subst (CoVarCo cv)
      = substCoVar subst cv
    go_co subst (AxiomInstCo ax ind args)
      = mkAxiomInstCo ax ind (map (go_co subst) args)
    go_co subst (UnivCo p r t1 t2)
      = mkUnivCo (go_prov subst p) r (go subst t1) (go subst t2)
    go_co subst (SymCo co)
      = mkSymCo (go_co subst co)
    go_co subst (TransCo co1 co2)
      = mkTransCo (go_co subst co1) (go_co subst co2)
459 460
    go_co subst (NthCo r n co)
      = mkNthCo r n (go_co subst co)
461 462 463 464 465 466 467 468
    go_co subst (LRCo lr co)
      = mkLRCo lr (go_co subst co)
    go_co subst (InstCo co arg)
      = mkInstCo (go_co subst co) (go_co subst arg)
    go_co subst (KindCo co)
      = mkKindCo (go_co subst co)
    go_co subst (SubCo co)
      = mkSubCo (go_co subst co)
Simon Peyton Jones's avatar
Simon Peyton Jones committed
469 470 471 472
    go_co subst (AxiomRuleCo ax cs)
      = AxiomRuleCo ax (map (go_co subst) cs)
    go_co _ (HoleCo h)
      = pprPanic "expandTypeSynonyms hit a hole" (ppr h)
473 474 475 476 477 478

    go_prov subst (PhantomProv co)    = PhantomProv (go_co subst co)
    go_prov subst (ProofIrrelProv co) = ProofIrrelProv (go_co subst co)
    go_prov _     p@(PluginProv _)    = p

      -- the "False" and "const" are to accommodate the type of
Simon Peyton Jones's avatar
Simon Peyton Jones committed
479
      -- substForAllCoBndrUsing, which is general enough to
480 481
      -- handle coercion optimization (which sometimes swaps the
      -- order of a coercion)
Simon Peyton Jones's avatar
Simon Peyton Jones committed
482
    go_cobndr subst = substForAllCoBndrUsing False (go_co subst) subst
483

484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558

-- | Extract the RuntimeRep classifier of a type from its kind. For example,
-- @kindRep * = LiftedRep@; Panics if this is not possible.
-- Treats * and Constraint as the same
kindRep :: HasDebugCallStack => Kind -> Type
kindRep k = case kindRep_maybe k of
              Just r  -> r
              Nothing -> pprPanic "kindRep" (ppr k)

-- | Given a kind (TYPE rr), extract its RuntimeRep classifier rr.
-- For example, @kindRep_maybe * = Just LiftedRep@
-- Returns 'Nothing' if the kind is not of form (TYPE rr)
-- Treats * and Constraint as the same
kindRep_maybe :: HasDebugCallStack => Kind -> Maybe Type
kindRep_maybe kind
  | Just kind' <- coreView kind = kindRep_maybe kind'
  | TyConApp tc [arg] <- kind
  , tc `hasKey` tYPETyConKey    = Just arg
  | otherwise                   = Nothing

-- | This version considers Constraint to be the same as *. Returns True
-- if the argument is equivalent to Type/Constraint and False otherwise.
-- See Note [Kind Constraint and kind Type]
isLiftedTypeKind :: Kind -> Bool
isLiftedTypeKind kind
  = case kindRep_maybe kind of
      Just rep -> isLiftedRuntimeRep rep
      Nothing  -> False

isLiftedRuntimeRep :: Type -> Bool
-- isLiftedRuntimeRep is true of LiftedRep :: RuntimeRep
-- False of type variables (a :: RuntimeRep)
--   and of other reps e.g. (IntRep :: RuntimeRep)
isLiftedRuntimeRep rep
  | Just rep' <- coreView rep          = isLiftedRuntimeRep rep'
  | TyConApp rr_tc args <- rep
  , rr_tc `hasKey` liftedRepDataConKey = ASSERT( null args ) True
  | otherwise                          = False

-- | Returns True if the kind classifies unlifted types and False otherwise.
-- Note that this returns False for levity-polymorphic kinds, which may
-- be specialized to a kind that classifies unlifted types.
isUnliftedTypeKind :: Kind -> Bool
isUnliftedTypeKind kind
  = case kindRep_maybe kind of
      Just rep -> isUnliftedRuntimeRep rep
      Nothing  -> False

isUnliftedRuntimeRep :: Type -> Bool
-- True of definitely-unlifted RuntimeReps
-- False of           (LiftedRep :: RuntimeRep)
--   and of variables (a :: RuntimeRep)
isUnliftedRuntimeRep rep
  | Just rep' <- coreView rep = isUnliftedRuntimeRep rep'
  | TyConApp rr_tc _ <- rep   -- NB: args might be non-empty
                              --     e.g. TupleRep [r1, .., rn]
  = isPromotedDataCon rr_tc && not (rr_tc `hasKey` liftedRepDataConKey)
        -- Avoid searching all the unlifted RuntimeRep type cons
        -- In the RuntimeRep data type, only LiftedRep is lifted
        -- But be careful of type families (F tys) :: RuntimeRep
  | otherwise {- Variables, applications -}
  = False

-- | Is this the type 'RuntimeRep'?
isRuntimeRepTy :: Type -> Bool
isRuntimeRepTy ty | Just ty' <- coreView ty = isRuntimeRepTy ty'
isRuntimeRepTy (TyConApp tc args)
  | tc `hasKey` runtimeRepTyConKey = ASSERT( null args ) True
isRuntimeRepTy _ = False

-- | Is a tyvar of type 'RuntimeRep'?
isRuntimeRepVar :: TyVar -> Bool
isRuntimeRepVar = isRuntimeRepTy . tyVarKind


559
{- *********************************************************************
560
*                                                                      *
561
               mapType
562 563 564 565 566 567
*                                                                      *
************************************************************************

These functions do a map-like operation over types, performing some operation
on all variables and binding sites. Primarily used for zonking.

568
Note [Efficiency for ForAllCo case of mapTyCoX]
569
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sylvain Henry's avatar
Sylvain Henry committed
570
As noted in Note [Forall coercions] in GHC.Core.TyCo.Rep, a ForAllCo is a bit redundant.
Ningning Xie's avatar
Ningning Xie committed
571
It stores a TyCoVar and a Coercion, where the kind of the TyCoVar always matches
572 573 574
the left-hand kind of the coercion. This is convenient lots of the time, but
not when mapping a function over a coercion.

Ningning Xie's avatar
Ningning Xie committed
575
The problem is that tcm_tybinder will affect the TyCoVar's kind and
576 577 578 579 580 581 582 583 584 585 586 587 588 589
mapCoercion will affect the Coercion, and we hope that the results will be
the same. Even if they are the same (which should generally happen with
correct algorithms), then there is an efficiency issue. In particular,
this problem seems to make what should be a linear algorithm into a potentially
exponential one. But it's only going to be bad in the case where there's
lots of foralls in the kinds of other foralls. Like this:

  forall a : (forall b : (forall c : ...). ...). ...

This construction seems unlikely. So we'll do the inefficient, easy way
for now.

Note [Specialising mappers]
~~~~~~~~~~~~~~~~~~~~~~~~~~~
590
These INLINE pragmas are indispensable. mapTyCo and mapTyCoX are used
591
to implement zonking, and it's vital that they get specialised to the TcM
592
monad and the particular mapper in use.
593

594 595 596 597 598
Even specialising to the monad alone made a 20% allocation difference
in perf/compiler/T5030.

See Note [Specialising foldType] in TyCoRep for more details of this
idiom.
599 600 601 602 603
-}

-- | This describes how a "map" operation over a type/coercion should behave
data TyCoMapper env m
  = TyCoMapper
604
      { tcm_tyvar :: env -> TyVar -> m Type
605
      , tcm_covar :: env -> CoVar -> m Coercion
Simon Peyton Jones's avatar
Simon Peyton Jones committed
606 607
      , tcm_hole  :: env -> CoercionHole -> m Coercion
          -- ^ What to do with coercion holes.
Sylvain Henry's avatar
Sylvain Henry committed
608
          -- See Note [Coercion holes] in GHC.Core.TyCo.Rep.
609

Ningning Xie's avatar
Ningning Xie committed
610
      , tcm_tycobinder :: env -> TyCoVar -> ArgFlag -> m (env, TyCoVar)
611
          -- ^ The returned env is used in the extended scope
612 613

      , tcm_tycon :: TyCon -> m TyCon
Simon Peyton Jones's avatar
Simon Peyton Jones committed
614 615 616 617 618
          -- ^ This is used only for TcTyCons
          -- a) To zonk TcTyCons
          -- b) To turn TcTyCons into TyCons.
          --    See Note [Type checking recursive type and class declarations]
          --    in TcTyClsDecls
619 620
      }

621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
{-# INLINE mapTyCo #-}  -- See Note [Specialising mappers]
mapTyCo :: Monad m => TyCoMapper () m
         -> ( Type       -> m Type
            , [Type]     -> m [Type]
            , Coercion   -> m Coercion
            , [Coercion] -> m[Coercion])
mapTyCo mapper
  = case mapTyCoX mapper of
     (go_ty, go_tys, go_co, go_cos)
        -> (go_ty (), go_tys (), go_co (), go_cos ())

{-# INLINE mapTyCoX #-}  -- See Note [Specialising mappers]
mapTyCoX :: Monad m => TyCoMapper env m
         -> ( env -> Type       -> m Type
            , env -> [Type]     -> m [Type]
            , env -> Coercion   -> m Coercion
            , env -> [Coercion] -> m[Coercion])
mapTyCoX (TyCoMapper { tcm_tyvar = tyvar
                     , tcm_tycobinder = tycobinder
                     , tcm_tycon = tycon
                     , tcm_covar = covar
                     , tcm_hole = cohole })
  = (go_ty, go_tys, go_co, go_cos)
644
  where
645 646 647 648 649 650 651 652 653 654 655
    go_tys _   []       = return []
    go_tys env (ty:tys) = (:) <$> go_ty env ty <*> go_tys env tys

    go_ty env (TyVarTy tv)    = tyvar env tv
    go_ty env (AppTy t1 t2)   = mkAppTy <$> go_ty env t1 <*> go_ty env t2
    go_ty _   ty@(LitTy {})   = return ty
    go_ty env (CastTy ty co)  = mkCastTy <$> go_ty env ty <*> go_co env co
    go_ty env (CoercionTy co) = CoercionTy <$> go_co env co

    go_ty env ty@(FunTy _ arg res)
      = do { arg' <- go_ty env arg; res' <- go_ty env res
Simon Peyton Jones's avatar
Simon Peyton Jones committed
656 657
           ; return (ty { ft_arg = arg', ft_res = res' }) }

658
    go_ty env ty@(TyConApp tc tys)
Simon Peyton Jones's avatar
Simon Peyton Jones committed
659
      | isTcTyCon tc
660
      = do { tc' <- tycon tc
661
           ; mkTyConApp tc' <$> go_tys env tys }
Simon Peyton Jones's avatar
Simon Peyton Jones committed
662 663 664 665 666 667

      -- Not a TcTyCon
      | null tys    -- Avoid allocation in this very
      = return ty   -- common case (E.g. Int, LiftedRep etc)

      | otherwise
668
      = mkTyConApp tc <$> go_tys env tys
Simon Peyton Jones's avatar
Simon Peyton Jones committed
669

670
    go_ty env (ForAllTy (Bndr tv vis) inner)
Ningning Xie's avatar
Ningning Xie committed
671
      = do { (env', tv') <- tycobinder env tv vis
672
           ; inner' <- go_ty env' inner
Ningning Xie's avatar
Ningning Xie committed
673
           ; return $ ForAllTy (Bndr tv' vis) inner' }
674

675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710
    go_cos _   []       = return []
    go_cos env (co:cos) = (:) <$> go_co env co <*> go_cos env cos

    go_mco _   MRefl    = return MRefl
    go_mco env (MCo co) = MCo <$> (go_co env co)

    go_co env (Refl ty)           = Refl <$> go_ty env ty
    go_co env (GRefl r ty mco)    = mkGReflCo r <$> go_ty env ty <*> go_mco env mco
    go_co env (AppCo c1 c2)       = mkAppCo <$> go_co env c1 <*> go_co env c2
    go_co env (FunCo r c1 c2)     = mkFunCo r <$> go_co env c1 <*> go_co env c2
    go_co env (CoVarCo cv)        = covar env cv
    go_co env (HoleCo hole)       = cohole env hole
    go_co env (UnivCo p r t1 t2)  = mkUnivCo <$> go_prov env p <*> pure r
                                    <*> go_ty env t1 <*> go_ty env t2
    go_co env (SymCo co)          = mkSymCo <$> go_co env co
    go_co env (TransCo c1 c2)     = mkTransCo <$> go_co env c1 <*> go_co env c2
    go_co env (AxiomRuleCo r cos) = AxiomRuleCo r <$> go_cos env cos
    go_co env (NthCo r i co)      = mkNthCo r i <$> go_co env co
    go_co env (LRCo lr co)        = mkLRCo lr <$> go_co env co
    go_co env (InstCo co arg)     = mkInstCo <$> go_co env co <*> go_co env arg
    go_co env (KindCo co)         = mkKindCo <$> go_co env co
    go_co env (SubCo co)          = mkSubCo <$> go_co env co
    go_co env (AxiomInstCo ax i cos) = mkAxiomInstCo ax i <$> go_cos env cos
    go_co env co@(TyConAppCo r tc cos)
      | isTcTyCon tc
      = do { tc' <- tycon tc
           ; mkTyConAppCo r tc' <$> go_cos env cos }

      -- Not a TcTyCon
      | null cos    -- Avoid allocation in this very
      = return co   -- common case (E.g. Int, LiftedRep etc)

      | otherwise
      = mkTyConAppCo r tc <$> go_cos env cos
    go_co env (ForAllCo tv kind_co co)
      = do { kind_co' <- go_co env kind_co
Ningning Xie's avatar
Ningning Xie committed
711
           ; (env', tv') <- tycobinder env tv Inferred
712
           ; co' <- go_co env' co
713
           ; return $ mkForAllCo tv' kind_co' co' }
714 715 716 717 718
        -- See Note [Efficiency for ForAllCo case of mapTyCoX]

    go_prov env (PhantomProv co)    = PhantomProv <$> go_co env co
    go_prov env (ProofIrrelProv co) = ProofIrrelProv <$> go_co env co
    go_prov _   p@(PluginProv _)    = return p
719

720

721 722 723
{-
************************************************************************
*                                                                      *
724
\subsection{Constructor-specific functions}
725 726
*                                                                      *
************************************************************************
sof's avatar
sof committed
727 728


729
---------------------------------------------------------------------
ian@well-typed.com's avatar
ian@well-typed.com committed
730 731
                                TyVarTy
                                ~~~~~~~
732 733
-}

batterseapower's avatar
batterseapower committed
734 735
-- | Attempts to obtain the type variable underlying a 'Type', and panics with the
-- given message if this is not a type variable type. See also 'getTyVar_maybe'
736
getTyVar :: String -> Type -> TyVar
737
getTyVar msg ty = case getTyVar_maybe ty of
ian@well-typed.com's avatar
ian@well-typed.com committed
738 739
                    Just tv -> tv
                    Nothing -> panic ("getTyVar: " ++ msg)
740

741
isTyVarTy :: Type -> Bool
742 743
isTyVarTy ty = isJust (getTyVar_maybe ty)

batterseapower's avatar
batterseapower committed
744
-- | Attempts to obtain the type variable underlying a 'Type'
745
getTyVar_maybe :: Type -> Maybe TyVar
746
getTyVar_maybe ty | Just ty' <- coreView ty = getTyVar_maybe ty'
747 748 749
                  | otherwise               = repGetTyVar_maybe ty

-- | If the type is a tyvar, possibly under a cast, returns it, along
Ningning Xie's avatar
Ningning Xie committed
750
-- with the coercion. Thus, the co is :: kind tv ~N kind ty
751
getCastedTyVar_maybe :: Type -> Maybe (TyVar, CoercionN)
752 753 754 755 756 757 758 759 760 761 762
getCastedTyVar_maybe ty | Just ty' <- coreView ty = getCastedTyVar_maybe ty'
getCastedTyVar_maybe (CastTy (TyVarTy tv) co)     = Just (tv, co)
getCastedTyVar_maybe (TyVarTy tv)
  = Just (tv, mkReflCo Nominal (tyVarKind tv))
getCastedTyVar_maybe _                            = Nothing

-- | Attempts to obtain the type variable underlying a 'Type', without
-- any expansion
repGetTyVar_maybe :: Type -> Maybe TyVar
repGetTyVar_maybe (TyVarTy tv) = Just tv
repGetTyVar_maybe _            = Nothing
763

764
{-
765
---------------------------------------------------------------------
ian@well-typed.com's avatar
ian@well-typed.com committed
766 767 768
                                AppTy
                                ~~~~~
We need to be pretty careful with AppTy to make sure we obey the
769 770
invariant that a TyConApp is always visibly so.  mkAppTy maintains the
invariant: use it.
771 772 773 774 775

Note [Decomposing fat arrow c=>t]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Can we unify (a b) with (Eq a => ty)?   If we do so, we end up with
a partial application like ((=>) Eq a) which doesn't make sense in
Gabor Greif's avatar
Gabor Greif committed
776
source Haskell.  In contrast, we *can* unify (a b) with (t1 -> t2).
777
Here's an example (#9858) of how you might do it:
778 779 780 781 782 783 784 785 786 787 788
   i :: (Typeable a, Typeable b) => Proxy (a b) -> TypeRep
   i p = typeRep p

   j = i (Proxy :: Proxy (Eq Int => Int))
The type (Proxy (Eq Int => Int)) is only accepted with -XImpredicativeTypes,
but suppose we want that.  But then in the call to 'i', we end
up decomposing (Eq Int => Int), and we definitely don't want that.

This really only applies to the type checker; in Core, '=>' and '->'
are the same, as are 'Constraint' and '*'.  But for now I've put
the test in repSplitAppTy_maybe, which applies throughout, because
Sylvain Henry's avatar
Sylvain Henry committed
789
the other calls to splitAppTy are in GHC.Core.Unify, which is also used by
790
the type checker (e.g. when matching type-function equations).
791

792
-}
793

batterseapower's avatar
batterseapower committed
794
-- | Applies a type to another, as in e.g. @k a@
795
mkAppTy :: Type -> Type -> Type
796 797
  -- See Note [Respecting definitional equality], invariant (EQ1).
mkAppTy (CastTy fun_ty co) arg_ty
798
  | ([arg_co], res_co) <- decomposePiCos co (coercionKind co) [arg_ty]
799 800
  = (fun_ty `mkAppTy` (arg_ty `mkCastTy` arg_co)) `mkCastTy` res_co

801 802
mkAppTy (TyConApp tc tys) ty2 = mkTyConApp tc (tys ++ [ty2])
mkAppTy ty1               ty2 = AppTy ty1 ty2
ian@well-typed.com's avatar
ian@well-typed.com committed
803 804 805 806 807 808 809 810
        -- Note that the TyConApp could be an
        -- under-saturated type synonym.  GHC allows that; e.g.
        --      type Foo k = k a -> k a
        --      type Id x = x
        --      foo :: Foo Id -> Foo Id
        --
        -- Here Id is partially applied in the type sig for Foo,
        -- but once the type synonyms are expanded all is well
Simon Peyton Jones's avatar
Simon Peyton Jones committed
811 812 813 814
        --
        -- Moreover in TcHsTypes.tcInferApps we build up a type
        --   (T t1 t2 t3) one argument at a type, thus forming
        --   (T t1), (T t1 t2), etc
815

816
mkAppTys :: Type -> [Type] -> Type
ian@well-typed.com's avatar
ian@well-typed.com committed
817
mkAppTys ty1                []   = ty1
818 819 820
mkAppTys (CastTy fun_ty co) arg_tys  -- much more efficient then nested mkAppTy
                                     -- Why do this? See (EQ1) of
                                     -- Note [Respecting definitional equality]
Sylvain Henry's avatar
Sylvain Henry committed
821
                                     -- in GHC.Core.TyCo.Rep
822
  = foldl' AppTy ((mkAppTys fun_ty casted_arg_tys) `mkCastTy` res_co) leftovers
823
  where
824
    (arg_cos, res_co) = decomposePiCos co (coercionKind co) arg_tys
825 826
    (args_to_cast, leftovers) = splitAtList arg_cos arg_tys
    casted_arg_tys = zipWith mkCastTy args_to_cast arg_cos
827
mkAppTys (TyConApp tc tys1) tys2 = mkTyConApp tc (tys1 ++ tys2)
828
mkAppTys ty1                tys2 = foldl' AppTy ty1 tys2
829

830
-------------
831
splitAppTy_maybe :: Type -> Maybe (Type, Type)
batterseapower's avatar
batterseapower committed
832 833 834
-- ^ Attempt to take a type application apart, whether it is a
-- function, type constructor, or plain type application. Note
-- that type family applications are NEVER unsaturated by this!
835
splitAppTy_maybe ty | Just ty' <- coreView ty
ian@well-typed.com's avatar
ian@well-typed.com committed
836
                    = splitAppTy_maybe ty'
837
splitAppTy_maybe ty = repSplitAppTy_maybe ty
838

839
-------------
840
repSplitAppTy_maybe :: HasDebugCallStack => Type -> Maybe (Type,Type)
ian@well-typed.com's avatar
ian@well-typed.com committed
841
-- ^ Does the AppTy split as in 'splitAppTy_maybe', but assumes that
batterseapower's avatar
batterseapower committed
842
-- any Core view stuff is already done