Type.hs 130 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

6
{-# LANGUAGE CPP, FlexibleContexts, PatternSynonyms, ViewPatterns #-}
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
Sylvain Henry's avatar
Sylvain Henry committed
18
        Type, ArgFlag(..), AnonArgFlag(..),
Gert-Jan Bottu's avatar
Gert-Jan Bottu committed
19
        Specificity(..),
Simon Peyton Jones's avatar
Simon Peyton Jones committed
20
        KindOrType, PredType, ThetaType,
Ningning Xie's avatar
Ningning Xie committed
21
        Var, TyVar, isTyVar, TyCoVar, TyCoBinder, TyCoVarBinder, TyVarBinder,
Krzysztof Gogolewski's avatar
Krzysztof Gogolewski committed
22
        Mult, Scaled,
23
        KnotTied,
24

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

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

Krzysztof Gogolewski's avatar
Krzysztof Gogolewski committed
32 33 34 35
        mkVisFunTy, mkInvisFunTy,
        mkVisFunTys,
        mkVisFunTyMany, mkInvisFunTyMany,
        mkVisFunTysMany, mkInvisFunTysMany,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
36
        splitFunTy, splitFunTy_maybe,
37
        splitFunTys, funResultTy, funArgTy,
38

ian@well-typed.com's avatar
ian@well-typed.com committed
39
        mkTyConApp, mkTyConTy,
40 41
        tyConAppTyCon_maybe, tyConAppTyConPicky_maybe,
        tyConAppArgs_maybe, tyConAppTyCon, tyConAppArgs,
Krzysztof Gogolewski's avatar
Krzysztof Gogolewski committed
42
        splitTyConApp_maybe, splitTyConApp, tyConAppArgN,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
43
        tcSplitTyConApp_maybe,
44 45 46
        splitListTyConApp_maybe,
        repSplitTyConApp_maybe,

Gert-Jan Bottu's avatar
Gert-Jan Bottu committed
47
        mkForAllTy, mkForAllTys, mkInvisForAllTys, mkTyCoInvForAllTys,
48
        mkSpecForAllTy, mkSpecForAllTys,
Ningning Xie's avatar
Ningning Xie committed
49
        mkVisForAllTys, mkTyCoInvForAllTy,
Gert-Jan Bottu's avatar
Gert-Jan Bottu committed
50
        mkInfForAllTy, mkInfForAllTys,
51
        splitForAllTys,
52
        splitForAllTysReq, splitForAllTysInvis,
53
        splitForAllVarBndrs,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
54
        splitForAllTy_maybe, splitForAllTy,
Ningning Xie's avatar
Ningning Xie committed
55
        splitForAllTy_ty_maybe, splitForAllTy_co_maybe,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
56
        splitPiTy_maybe, splitPiTy, splitPiTys,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
57 58
        mkTyConBindersPreferAnon,
        mkPiTy, mkPiTys,
59
        piResultTy, piResultTys,
60
        applyTysX, dropForAlls,
61
        mkFamilyTyConApp,
62
        buildSynTyCon,
63

64 65
        mkNumLitTy, isNumLitTy,
        mkStrLitTy, isStrLitTy,
66
        isLitTy,
67

68 69
        isPredTy,

70
        getRuntimeRep_maybe, kindRep_maybe, kindRep,
Ben Gamari's avatar
Ben Gamari committed
71

Simon Peyton Jones's avatar
Simon Peyton Jones committed
72
        mkCastTy, mkCoercionTy, splitCastTy_maybe,
73

74
        userTypeError_maybe, pprUserTypeErrorTy,
75

76
        coAxNthLHS,
77
        stripCoercionTy,
78

79 80 81
        splitPiTysInvisible, splitPiTysInvisibleN,
        invisibleTyBndrCount,
        filterOutInvisibleTypes, filterOutInferredTypes,
82 83
        partitionInvisibleTypes, partitionInvisibles,
        tyConArgFlags, appTyArgFlags,
84

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

        -- (Newtypes)
        newTyConInstRhs,

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

ian@well-typed.com's avatar
ian@well-typed.com committed
107
        -- ** Common type constructors
Krzysztof Gogolewski's avatar
Krzysztof Gogolewski committed
108
        funTyCon, unrestrictedFunTyCon,
109

batterseapower's avatar
batterseapower committed
110
        -- ** Predicates on types
111
        isTyVarTy, isFunTy, isCoercionTy,
112
        isCoercionTy_maybe, isForAllTy,
Ningning Xie's avatar
Ningning Xie committed
113
        isForAllTy_ty, isForAllTy_co,
114
        isPiTy, isTauTy, isFamFreeTy,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
115
        isCoVarType, isAtomicTy,
batterseapower's avatar
batterseapower committed
116

lukemaurer's avatar
lukemaurer committed
117
        isValidJoinPointType,
Ben Gamari's avatar
Ben Gamari committed
118
        tyConAppNeedsKindSig,
lukemaurer's avatar
lukemaurer committed
119

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

131
        -- * Multiplicity
Krzysztof Gogolewski's avatar
Krzysztof Gogolewski committed
132 133

        isMultiplicityTy, isMultiplicityVar,
134 135 136 137
        unrestricted, linear, tymult,
        mkScaled, irrelevantMult, scaledSet,
        pattern One, pattern Many,
        isOneDataConTy, isManyDataConTy,
Krzysztof Gogolewski's avatar
Krzysztof Gogolewski committed
138 139
        isLinearType,

ian@well-typed.com's avatar
ian@well-typed.com committed
140
        -- * Main data types representing Kinds
141
        Kind,
batterseapower's avatar
batterseapower committed
142 143

        -- ** Finding the kind of a type
144
        typeKind, tcTypeKind, isTypeLevPoly, resultIsLevPoly,
145
        tcIsLiftedTypeKind, tcIsConstraintKind, tcReturnsConstraintKind,
146
        tcIsRuntimeTypeKind,
ian@well-typed.com's avatar
ian@well-typed.com committed
147

148
        -- ** Common Kind
149
        liftedTypeKind,
batterseapower's avatar
batterseapower committed
150

ian@well-typed.com's avatar
ian@well-typed.com committed
151
        -- * Type free variables
152
        tyCoFVsOfType, tyCoFVsBndr, tyCoFVsVarBndr, tyCoFVsVarBndrs,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
153
        tyCoVarsOfType, tyCoVarsOfTypes,
154 155
        tyCoVarsOfTypeDSet,
        coVarsOfType,
Tobias Dammers's avatar
Tobias Dammers committed
156 157
        coVarsOfTypes,

Richard Eisenberg's avatar
Richard Eisenberg committed
158
        noFreeVarsOfType,
159
        splitVisVarsOfType, splitVisVarsOfTypes,
ian@well-typed.com's avatar
ian@well-typed.com committed
160
        expandTypeSynonyms,
161
        typeSize, occCheckExpand,
162

163
        -- ** Closing over kinds
Simon Peyton Jones's avatar
Simon Peyton Jones committed
164
        closeOverKindsDSet, closeOverKindsList,
165 166
        closeOverKinds,

167
        -- * Well-scoped lists of variables
168 169
        scopedSort, tyCoVarsOfTypeWellScoped,
        tyCoVarsOfTypesWellScoped,
170

ian@well-typed.com's avatar
ian@well-typed.com committed
171
        -- * Type comparison
niteria's avatar
niteria committed
172 173
        eqType, eqTypeX, eqTypes, nonDetCmpType, nonDetCmpTypes, nonDetCmpTypeX,
        nonDetCmpTypesX, nonDetCmpTc,
174
        eqVarBndrs,
175

ian@well-typed.com's avatar
ian@well-typed.com committed
176
        -- * Forcing evaluation of types
batterseapower's avatar
batterseapower committed
177
        seqType, seqTypes,
178

batterseapower's avatar
batterseapower committed
179
        -- * Other views onto Types
Ben Gamari's avatar
Ben Gamari committed
180
        coreView, tcView,
batterseapower's avatar
batterseapower committed
181

182
        tyConsOfType,
batterseapower's avatar
batterseapower committed
183

ian@well-typed.com's avatar
ian@well-typed.com committed
184 185
        -- * Main type substitution data types
        TvSubstEnv,     -- Representation widely visible
186
        TCvSubst(..),    -- Representation visible to a few friends
ian@well-typed.com's avatar
ian@well-typed.com committed
187 188

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

niteria's avatar
niteria committed
191
        mkTCvSubst, zipTvSubst, mkTvSubstPrs,
Ningning Xie's avatar
Ningning Xie committed
192
        zipTCvSubst,
193
        notElemTCvSubst,
194
        getTvSubstEnv, setTvSubstEnv,
195
        zapTCvSubst, getTCvInScope, getTCvSubstRangeFVs,
196
        extendTCvInScope, extendTCvInScopeList, extendTCvInScopeSet,
197
        extendTCvSubst, extendCvSubst,
Richard Eisenberg's avatar
Richard Eisenberg committed
198
        extendTvSubst, extendTvSubstBinderAndInScope,
199
        extendTvSubstList, extendTvSubstAndInScope,
Ningning Xie's avatar
Ningning Xie committed
200
        extendTCvSubstList,
201
        extendTvSubstWithClone,
Ningning Xie's avatar
Ningning Xie committed
202
        extendTCvSubstWithClone,
203 204
        isInScope, composeTCvSubstEnv, composeTCvSubst, zipTyEnv, zipCoEnv,
        isEmptyTCvSubst, unionTCvSubst,
205

ian@well-typed.com's avatar
ian@well-typed.com committed
206
        -- ** Performing substitution on types and kinds
Krzysztof Gogolewski's avatar
Krzysztof Gogolewski committed
207
        substTy, substTys, substScaledTy, substScaledTys, substTyWith, substTysWith, substTheta,
208
        substTyAddInScope,
Krzysztof Gogolewski's avatar
Krzysztof Gogolewski committed
209 210
        substTyUnchecked, substTysUnchecked, substScaledTyUnchecked, substScaledTysUnchecked,
        substThetaUnchecked, substTyWithUnchecked,
211
        substCoUnchecked, substCoWithUnchecked,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
212
        substTyVarBndr, substTyVarBndrs, substTyVar, substTyVars,
Ningning Xie's avatar
Ningning Xie committed
213
        substVarBndr, substVarBndrs,
214
        cloneTyVarBndr, cloneTyVarBndrs, lookupTyVar,
215

Simon Peyton Jones's avatar
Simon Peyton Jones committed
216 217 218 219
        -- * Tidying type related things up for printing
        tidyType,      tidyTypes,
        tidyOpenType,  tidyOpenTypes,
        tidyOpenKind,
Ningning Xie's avatar
Ningning Xie committed
220
        tidyVarBndr, tidyVarBndrs, tidyFreeTyCoVars,
221
        tidyOpenTyCoVar, tidyOpenTyCoVars,
Ningning Xie's avatar
Ningning Xie committed
222
        tidyTyCoVarOcc,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
223
        tidyTopType,
224
        tidyKind,
225 226 227 228 229 230
        tidyTyCoVarBinder, tidyTyCoVarBinders,

        -- * Kinds
        isConstraintKindCon,
        classifiesTypeWithValues,
        isKindLevPoly
231
    ) where
232

233 234
#include "HsVersions.h"

235
import GHC.Prelude
236

Sylvain Henry's avatar
Sylvain Henry committed
237
import GHC.Types.Basic
lukemaurer's avatar
lukemaurer committed
238

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

Sylvain Henry's avatar
Sylvain Henry committed
242 243 244 245
import GHC.Core.TyCo.Rep
import GHC.Core.TyCo.Subst
import GHC.Core.TyCo.Tidy
import GHC.Core.TyCo.FVs
246

247
-- friends:
Sylvain Henry's avatar
Sylvain Henry committed
248 249 250 251
import GHC.Types.Var
import GHC.Types.Var.Env
import GHC.Types.Var.Set
import GHC.Types.Unique.Set
252

Sylvain Henry's avatar
Sylvain Henry committed
253
import GHC.Core.TyCon
Sylvain Henry's avatar
Sylvain Henry committed
254 255
import GHC.Builtin.Types.Prim
import {-# SOURCE #-} GHC.Builtin.Types
256
                                 ( naturalTy, listTyCon
257
                                 , typeSymbolKind, liftedTypeKind
Krzysztof Gogolewski's avatar
Krzysztof Gogolewski committed
258
                                 , constraintKind
259 260
                                 , unrestrictedFunTyCon
                                 , manyDataConTy, oneDataConTy )
Sylvain Henry's avatar
Sylvain Henry committed
261
import GHC.Types.Name( Name )
Sylvain Henry's avatar
Sylvain Henry committed
262
import GHC.Builtin.Names
Sylvain Henry's avatar
Sylvain Henry committed
263 264 265 266 267 268
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
269
   , mkKindCo, mkSubCo
Sylvain Henry's avatar
Sylvain Henry committed
270 271 272
   , decomposePiCos, coercionKind, coercionLKind
   , coercionRKind, coercionType
   , isReflexiveCo, seqCo )
273

274
-- others
275 276 277
import GHC.Utils.Misc
import GHC.Utils.FV
import GHC.Utils.Outputable
278
import GHC.Utils.Panic
279 280 281
import GHC.Data.FastString
import GHC.Data.Pair
import GHC.Data.List.SetOps
Sylvain Henry's avatar
Sylvain Henry committed
282
import GHC.Types.Unique ( nonDetCmpUnique )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
283

284
import GHC.Data.Maybe   ( orElse, expectJust )
285
import Data.Maybe       ( isJust )
286
import Control.Monad    ( guard )
287

batterseapower's avatar
batterseapower committed
288 289
-- $type_classification
-- #type_classification#
ian@well-typed.com's avatar
ian@well-typed.com committed
290
--
batterseapower's avatar
batterseapower committed
291
-- Types are one of:
ian@well-typed.com's avatar
ian@well-typed.com committed
292
--
batterseapower's avatar
batterseapower committed
293
-- [Unboxed]            Iff its representation is other than a pointer
ian@well-typed.com's avatar
ian@well-typed.com committed
294 295
--                      Unboxed types are also unlifted.
--
batterseapower's avatar
batterseapower committed
296
-- [Lifted]             Iff it has bottom as an element.
ian@well-typed.com's avatar
ian@well-typed.com committed
297 298 299 300 301 302
--                      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
303
-- [Algebraic]          Iff it is a type with one or more constructors, whether
ian@well-typed.com's avatar
ian@well-typed.com committed
304 305 306 307 308 309
--                      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
310
-- [Data]               Iff it is a type declared with @data@, or a boxed tuple.
ian@well-typed.com's avatar
ian@well-typed.com committed
311
--
batterseapower's avatar
batterseapower committed
312
-- [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
313
--
batterseapower's avatar
batterseapower committed
314 315
-- 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
316
--
batterseapower's avatar
batterseapower committed
317 318 319
-- 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
320
--
batterseapower's avatar
batterseapower committed
321
-- Some examples of type classifications that may make this a bit clearer are:
ian@well-typed.com's avatar
ian@well-typed.com committed
322
--
batterseapower's avatar
batterseapower committed
323
-- @
324
-- Type          primitive       boxed           lifted          algebraic
batterseapower's avatar
batterseapower committed
325
-- -----------------------------------------------------------------------------
326 327 328 329 330 331
-- 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
332 333 334 335 336
-- @

-- $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
337
-- passes and the rest of the back end is concerned.
batterseapower's avatar
batterseapower committed
338 339 340
--
-- 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
341
-- if they are spotted, to the best of its abilities. If you don't want this
batterseapower's avatar
batterseapower committed
342
-- to happen, use the equivalent functions from the "TcType" module.
343

344 345 346
{-
************************************************************************
*                                                                      *
ian@well-typed.com's avatar
ian@well-typed.com committed
347
                Type representation
348 349
*                                                                      *
************************************************************************
Ben Gamari's avatar
Ben Gamari committed
350 351 352

Note [coreView vs tcView]
~~~~~~~~~~~~~~~~~~~~~~~~~
353 354
So far as the typechecker is concerned, 'Constraint' and 'TYPE
LiftedRep' are distinct kinds.
Ben Gamari's avatar
Ben Gamari committed
355 356 357

But in Core these two are treated as identical.

358 359
We implement this by making 'coreView' convert 'Constraint' to 'TYPE
LiftedRep' on the fly.  The function tcView (used in the type checker)
360 361 362
does not do this. Accordingly, tcView is used in type-checker-oriented
functions (including the pure unifier, used in instance resolution),
while coreView is used during e.g. optimisation passes.
Ben Gamari's avatar
Ben Gamari committed
363

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

366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
The inconsistency actually leads to a potential soundness bug, in that
Constraint and Type are considered *apart* by the type family engine.
To wit, we can write

  type family F a
  type instance F Type = Bool
  type instance F Constraint = Int

and (because Type ~# Constraint in Core), thus build a coercion between
Int and Bool. I (Richard E) conjecture that this never happens in practice,
but it's very uncomfortable. This, essentially, is the root problem
underneath #11715, which is quite resistant to an easy fix. The best
idea is to have roles in kind coercions, but that has yet to be implemented.
See also "A Role for Dependent Types in Haskell", ICFP 2019, which describes
how roles in kinds might work out.

382
-}
383

Ben Gamari's avatar
Ben Gamari committed
384 385 386
-- | 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.
387
-- See also Note [coreView vs tcView]
Ben Gamari's avatar
Ben Gamari committed
388 389 390 391 392 393
{-# 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
394
               -- See also Note [The substitution invariant] in GHC.Core.TyCo.Subst.
Ben Gamari's avatar
Ben Gamari committed
395 396 397 398
               -- 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
399

400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
{-# 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

422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
{-# INLINE coreFullView #-}
coreFullView :: Type -> Type
-- ^ Iterates 'coreView' until there is no more to synonym to expand.
-- See Note [Inlining coreView].
coreFullView ty@(TyConApp tc _)
  | isTypeSynonymTyCon tc || isConstraintKindCon tc = go ty
  where
    go ty
      | Just ty' <- coreView ty = go ty'
      | otherwise = ty

coreFullView ty = ty

{- Note [Inlining coreView] in GHC.Core.Type
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
It is very common to have a function

  f :: Type -> ...
  f ty | Just ty' <- coreView ty = f ty'
  f (TyVarTy ...) = ...
  f ...           = ...

If f is not otherwise recursive, the initial call to coreView
causes f to become recursive, which kills the possibility of
inlining. Instead, for non-recursive functions, we prefer to
use coreFullView, which guarantees to unwrap top-level type
synonyms. It can be inlined and is efficient and non-allocating
in its fast path. For this to really be fast, all calls made
on its fast path must also be inlined, linked back to this Note.
-}

453 454 455 456 457
-----------------------------------------------
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.
458 459 460
--
-- 'expandTypeSynonyms' only expands out type synonyms mentioned in the type,
-- not in the kinds of any TyCon or TyVar mentioned in the type.
461 462
--
-- Keep this synchronized with 'synonymTyConsOfType'
ian@well-typed.com's avatar
ian@well-typed.com committed
463
expandTypeSynonyms ty
464
  = go (mkEmptyTCvSubst in_scope) ty
465
  where
466 467
    in_scope = mkInScopeSet (tyCoVarsOfType ty)

468
    go subst (TyConApp tc tys)
469 470 471 472 473 474 475 476
      | 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
477
            -- (#11665)
478
        in  mkAppTys (go subst' rhs) tys'
479
      | otherwise
480 481 482 483
      = TyConApp tc expanded_tys
      where
        expanded_tys = (map (go subst) tys)

484 485 486
    go _     (LitTy l)     = LitTy l
    go subst (TyVarTy tv)  = substTyVar subst tv
    go subst (AppTy t1 t2) = mkAppTy (go subst t1) (go subst t2)
Krzysztof Gogolewski's avatar
Krzysztof Gogolewski committed
487 488
    go subst ty@(FunTy _ mult arg res)
      = ty { ft_mult = go subst mult, ft_arg = go subst arg, ft_res = go subst res }
Ningning Xie's avatar
Ningning Xie committed
489 490 491
    go subst (ForAllTy (Bndr tv vis) t)
      = let (subst', tv') = substVarBndrUsing go subst tv in
        ForAllTy (Bndr tv' vis) (go subst' t)
492 493 494
    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
495 496 497 498 499 500 501
    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)
502 503 504 505 506 507 508 509
       -- 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)
Krzysztof Gogolewski's avatar
Krzysztof Gogolewski committed
510 511
    go_co subst (FunCo r w co1 co2)
      = mkFunCo r (go_co subst w) (go_co subst co1) (go_co subst co2)
512 513 514 515 516 517 518 519 520 521
    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)
522 523
    go_co subst (NthCo r n co)
      = mkNthCo r n (go_co subst co)
524 525 526 527 528 529 530 531
    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
532 533 534 535
    go_co subst (AxiomRuleCo ax cs)
      = AxiomRuleCo ax (map (go_co subst) cs)
    go_co _ (HoleCo h)
      = pprPanic "expandTypeSynonyms hit a hole" (ppr h)
536 537 538 539 540 541

    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
542
      -- substForAllCoBndrUsing, which is general enough to
543 544
      -- handle coercion optimization (which sometimes swaps the
      -- order of a coercion)
Simon Peyton Jones's avatar
Simon Peyton Jones committed
545
    go_cobndr subst = substForAllCoBndrUsing False (go_co subst) subst
546

547 548 549 550 551 552 553 554 555 556 557 558 559 560 561

-- | 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
562
  | TyConApp tc [arg] <- coreFullView kind
563 564 565 566 567 568 569 570 571 572 573 574
  , 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

575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
pickyIsLiftedTypeKind :: Kind -> Bool
-- Checks whether the kind is literally
--      TYPE LiftedRep
-- or   Type
-- without expanding type synonyms or anything
-- Used only when deciding whether to suppress the ":: *" in
-- (a :: *) when printing kinded type variables
-- See Note [Suppressing * kinds] in GHC.Core.TyCo.Ppr
pickyIsLiftedTypeKind kind
  | TyConApp tc [arg] <- kind
  , tc `hasKey` tYPETyConKey
  , TyConApp rr_tc [] <- arg
  , rr_tc `hasKey` liftedRepDataConKey = True
  | TyConApp tc [] <- kind
  , tc `hasKey` liftedTypeKindTyConKey = True
  | otherwise                          = False

592 593 594 595 596
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
597
  | TyConApp rr_tc args <- coreFullView rep
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
  , 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
615 616
  | TyConApp rr_tc _ <- coreFullView rep   -- NB: args might be non-empty
                                           --     e.g. TupleRep [r1, .., rn]
617 618 619 620 621 622 623 624 625
  = 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
626 627 628 629 630
isRuntimeRepTy ty
  | TyConApp tc args <- coreFullView ty
  , tc `hasKey` runtimeRepTyConKey = ASSERT( null args ) True

  | otherwise = False
631 632 633 634 635

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

Krzysztof Gogolewski's avatar
Krzysztof Gogolewski committed
636 637
-- | Is this the type 'Multiplicity'?
isMultiplicityTy :: Type -> Bool
638 639 640
isMultiplicityTy ty
  | TyConApp tc [] <- coreFullView ty = tc `hasKey` multiplicityTyConKey
  | otherwise                         = False
Krzysztof Gogolewski's avatar
Krzysztof Gogolewski committed
641 642 643 644 645

-- | Is a tyvar of type 'Multiplicity'?
isMultiplicityVar :: TyVar -> Bool
isMultiplicityVar = isMultiplicityTy . tyVarKind

646
{- *********************************************************************
647
*                                                                      *
648
               mapType
649 650 651 652 653 654
*                                                                      *
************************************************************************

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

655
Note [Efficiency for ForAllCo case of mapTyCoX]
656
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sylvain Henry's avatar
Sylvain Henry committed
657
As noted in Note [Forall coercions] in GHC.Core.TyCo.Rep, a ForAllCo is a bit redundant.
Ningning Xie's avatar
Ningning Xie committed
658
It stores a TyCoVar and a Coercion, where the kind of the TyCoVar always matches
659 660 661
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
662
The problem is that tcm_tybinder will affect the TyCoVar's kind and
663 664 665 666 667 668 669 670 671 672 673 674 675 676
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]
~~~~~~~~~~~~~~~~~~~~~~~~~~~
677
These INLINE pragmas are indispensable. mapTyCo and mapTyCoX are used
678
to implement zonking, and it's vital that they get specialised to the TcM
679
monad and the particular mapper in use.
680

681 682 683
Even specialising to the monad alone made a 20% allocation difference
in perf/compiler/T5030.

684
See Note [Specialising foldType] in "GHC.Core.TyCo.Rep" for more details of this
685
idiom.
686 687 688 689 690
-}

-- | This describes how a "map" operation over a type/coercion should behave
data TyCoMapper env m
  = TyCoMapper
691
      { tcm_tyvar :: env -> TyVar -> m Type
692
      , tcm_covar :: env -> CoVar -> m Coercion
Simon Peyton Jones's avatar
Simon Peyton Jones committed
693 694
      , tcm_hole  :: env -> CoercionHole -> m Coercion
          -- ^ What to do with coercion holes.
695
          -- See Note [Coercion holes] in "GHC.Core.TyCo.Rep".
696

Ningning Xie's avatar
Ningning Xie committed
697
      , tcm_tycobinder :: env -> TyCoVar -> ArgFlag -> m (env, TyCoVar)
698
          -- ^ The returned env is used in the extended scope
699 700

      , tcm_tycon :: TyCon -> m TyCon
Simon Peyton Jones's avatar
Simon Peyton Jones committed
701 702 703 704
          -- ^ 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]
705
          --    in "GHC.Tc.TyCl"
706 707
      }

708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
{-# 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)
731
  where
732 733 734 735 736 737 738 739 740
    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

Krzysztof Gogolewski's avatar
Krzysztof Gogolewski committed
741 742 743
    go_ty env ty@(FunTy _ w arg res)
      = do { w' <- go_ty env w; arg' <- go_ty env arg; res' <- go_ty env res
           ; return (ty { ft_mult = w', ft_arg = arg', ft_res = res' }) }
Simon Peyton Jones's avatar
Simon Peyton Jones committed
744

745
    go_ty env ty@(TyConApp tc tys)
Simon Peyton Jones's avatar
Simon Peyton Jones committed
746
      | isTcTyCon tc
747
      = do { tc' <- tycon tc
748
           ; mkTyConApp tc' <$> go_tys env tys }
Simon Peyton Jones's avatar
Simon Peyton Jones committed
749 750 751 752 753 754

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

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

757
    go_ty env (ForAllTy (Bndr tv vis) inner)
Ningning Xie's avatar
Ningning Xie committed
758
      = do { (env', tv') <- tycobinder env tv vis
759
           ; inner' <- go_ty env' inner
Ningning Xie's avatar
Ningning Xie committed
760
           ; return $ ForAllTy (Bndr tv' vis) inner' }
761

762 763 764 765 766 767 768 769 770
    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
Krzysztof Gogolewski's avatar
Krzysztof Gogolewski committed
771
    go_co env (FunCo r cw c1 c2)   = mkFunCo r <$> go_co env cw <*> go_co env c1 <*> go_co env c2
772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797
    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
798
           ; (env', tv') <- tycobinder env tv Inferred
799
           ; co' <- go_co env' co
800
           ; return $ mkForAllCo tv' kind_co' co' }
801 802 803 804 805
        -- 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
806

807

808 809 810
{-
************************************************************************
*                                                                      *
811
\subsection{Constructor-specific functions}
812 813
*                                                                      *
************************************************************************
sof's avatar
sof committed
814 815


816
---------------------------------------------------------------------
ian@well-typed.com's avatar
ian@well-typed.com committed
817 818
                                TyVarTy
                                ~~~~~~~
819 820
-}

batterseapower's avatar
batterseapower committed
821 822
-- | 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'
823
getTyVar :: String -> Type -> TyVar
824
getTyVar msg ty = case getTyVar_maybe ty of
ian@well-typed.com's avatar
ian@well-typed.com committed
825 826
                    Just tv -> tv
                    Nothing -> panic ("getTyVar: " ++ msg)
827

828
isTyVarTy :: Type -> Bool
829 830
isTyVarTy ty = isJust (getTyVar_maybe ty)

batterseapower's avatar
batterseapower committed
831
-- | Attempts to obtain the type variable underlying a 'Type'
832
getTyVar_maybe :: Type -> Maybe TyVar
833
getTyVar_maybe = repGetTyVar_maybe . coreFullView
834 835

-- | If the type is a tyvar, possibly under a cast, returns it, along
Ningning Xie's avatar
Ningning Xie committed
836
-- with the coercion. Thus, the co is :: kind tv ~N kind ty
837
getCastedTyVar_maybe :: Type -> Maybe (TyVar, CoercionN)
838 839 840 841
getCastedTyVar_maybe ty = case coreFullView ty of
  CastTy (TyVarTy tv) co -> Just (tv, co)
  TyVarTy tv             -> Just (tv, mkReflCo Nominal (tyVarKind tv))
  _                      -> Nothing
842 843 844 845 846 847

-- | 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
848

849
{-
850
---------------------------------------------------------------------
ian@well-typed.com's avatar
ian@well-typed.com committed
851 852 853
                                AppTy
                                ~~~~~
We need to be pretty careful with AppTy to make sure we obey the
854 855
invariant that a TyConApp is always visibly so.  mkAppTy maintains the
invariant: use it.
856 857 858 859