{-
(c) The GRASP/AQUA Project, Glasgow University, 1992-1998

Shared term graph (STG) syntax for spineless-tagless code generation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This data type represents programs just before code generation (conversion to
@Cmm@): basically, what we have is a stylised form of @CoreSyntax@, the style
being one that happens to be ideally suited to spineless tagless code
generation.
-}

{-# LANGUAGE CPP #-}
{-# LANGUAGE DataKinds #-}
{-# LANGUAGE DeriveDataTypeable #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE UndecidableInstances #-}
{-# LANGUAGE ConstraintKinds #-}

module StgSyn (
        StgArg(..),

        GenStgTopBinding(..), GenStgBinding(..), GenStgExpr(..), GenStgRhs(..),
        GenStgAlt, AltType(..),

        StgPass(..), BinderP, XRhsClosure, XLet, XLetNoEscape,
        NoExtFieldSilent, noExtFieldSilent,
        OutputablePass,

        UpdateFlag(..), isUpdatable,

        -- a set of synonyms for the vanilla parameterisation
        StgTopBinding, StgBinding, StgExpr, StgRhs, StgAlt,

        -- a set of synonyms for the code gen parameterisation
        CgStgTopBinding, CgStgBinding, CgStgExpr, CgStgRhs, CgStgAlt,

        -- a set of synonyms for the lambda lifting parameterisation
        LlStgTopBinding, LlStgBinding, LlStgExpr, LlStgRhs, LlStgAlt,

        -- a set of synonyms to distinguish in- and out variants
        InStgArg,  InStgTopBinding,  InStgBinding,  InStgExpr,  InStgRhs,  InStgAlt,
        OutStgArg, OutStgTopBinding, OutStgBinding, OutStgExpr, OutStgRhs, OutStgAlt,

        -- StgOp
        StgOp(..),

        -- utils
        topStgBindHasCafRefs, stgArgHasCafRefs, stgRhsArity,
        isDllConApp,
        stgArgType,
        stripStgTicksTop, stripStgTicksTopE,
        stgCaseBndrInScope,

        pprStgBinding, pprGenStgTopBindings, pprStgTopBindings
    ) where

#include "HsVersions.h"

import GhcPrelude

import CoreSyn     ( AltCon, Tickish )
import CostCentre  ( CostCentreStack )
import Data.ByteString ( ByteString )
import Data.Data   ( Data )
import Data.List   ( intersperse )
import DataCon
import DynFlags
import ForeignCall ( ForeignCall )
import Id
import IdInfo      ( mayHaveCafRefs )
import VarSet
import Literal     ( Literal, literalType )
import Module      ( Module )
import Outputable
import Packages    ( isDllName )
import GHC.Platform
import PprCore     ( {- instances -} )
import PrimOp      ( PrimOp, PrimCall )
import TyCon       ( PrimRep(..), TyCon )
import Type        ( Type )
import RepType     ( typePrimRep1 )
import Util

import Data.List.NonEmpty ( NonEmpty, toList )

{-
************************************************************************
*                                                                      *
GenStgBinding
*                                                                      *
************************************************************************

As usual, expressions are interesting; other things are boring. Here are the
boring things (except note the @GenStgRhs@), parameterised with respect to
binder and occurrence information (just as in @CoreSyn@):
-}

-- | A top-level binding.
data GenStgTopBinding pass
-- See Note [CoreSyn top-level string literals]
  = StgTopLifted (GenStgBinding pass)
  | StgTopStringLit Id ByteString

data GenStgBinding pass
  = StgNonRec (BinderP pass) (GenStgRhs pass)
  | StgRec    [(BinderP pass, GenStgRhs pass)]

{-
************************************************************************
*                                                                      *
StgArg
*                                                                      *
************************************************************************
-}

data StgArg
  = StgVarArg  Id
  | StgLitArg  Literal

-- | Does this constructor application refer to anything in a different
-- *Windows* DLL?
-- If so, we can't allocate it statically
isDllConApp :: DynFlags -> Module -> DataCon -> [StgArg] -> Bool
isDllConApp :: DynFlags -> Module -> DataCon -> [StgArg] -> Bool
isDllConApp DynFlags
dflags Module
this_mod DataCon
con [StgArg]
args
 | Platform -> OS
platformOS (DynFlags -> Platform
targetPlatform DynFlags
dflags) OS -> OS -> Bool
forall a. Eq a => a -> a -> Bool
== OS
OSMinGW32
    = DynFlags -> Module -> Name -> Bool
isDllName DynFlags
dflags Module
this_mod (DataCon -> Name
dataConName DataCon
con) Bool -> Bool -> Bool
|| (StgArg -> Bool) -> [StgArg] -> Bool
forall (t :: * -> *) a. Foldable t => (a -> Bool) -> t a -> Bool
any StgArg -> Bool
is_dll_arg [StgArg]
args
 | Bool
otherwise = Bool
False
  where
    -- NB: typePrimRep1 is legit because any free variables won't have
    -- unlifted type (there are no unlifted things at top level)
    is_dll_arg :: StgArg -> Bool
    is_dll_arg :: StgArg -> Bool
is_dll_arg (StgVarArg Id
v) =  PrimRep -> Bool
isAddrRep (HasDebugCallStack => UnaryType -> PrimRep
UnaryType -> PrimRep
typePrimRep1 (Id -> UnaryType
idType Id
v))
                             Bool -> Bool -> Bool
&& DynFlags -> Module -> Name -> Bool
isDllName DynFlags
dflags Module
this_mod (Id -> Name
idName Id
v)
    is_dll_arg StgArg
_             = Bool
False

-- True of machine addresses; these are the things that don't work across DLLs.
-- The key point here is that VoidRep comes out False, so that a top level
-- nullary GADT constructor is False for isDllConApp
--
--    data T a where
--      T1 :: T Int
--
-- gives
--
--    T1 :: forall a. (a~Int) -> T a
--
-- and hence the top-level binding
--
--    $WT1 :: T Int
--    $WT1 = T1 Int (Coercion (Refl Int))
--
-- The coercion argument here gets VoidRep
isAddrRep :: PrimRep -> Bool
isAddrRep :: PrimRep -> Bool
isAddrRep PrimRep
AddrRep     = Bool
True
isAddrRep PrimRep
LiftedRep   = Bool
True
isAddrRep PrimRep
UnliftedRep = Bool
True
isAddrRep PrimRep
_           = Bool
False

-- | Type of an @StgArg@
--
-- Very half baked because we have lost the type arguments.
stgArgType :: StgArg -> Type
stgArgType :: StgArg -> UnaryType
stgArgType (StgVarArg Id
v)   = Id -> UnaryType
idType Id
v
stgArgType (StgLitArg Literal
lit) = Literal -> UnaryType
literalType Literal
lit


-- | Strip ticks of a given type from an STG expression.
stripStgTicksTop :: (Tickish Id -> Bool) -> GenStgExpr p -> ([Tickish Id], GenStgExpr p)
stripStgTicksTop :: (Tickish Id -> Bool)
-> GenStgExpr p -> ([Tickish Id], GenStgExpr p)
stripStgTicksTop Tickish Id -> Bool
p = [Tickish Id] -> GenStgExpr p -> ([Tickish Id], GenStgExpr p)
go []
   where go :: [Tickish Id] -> GenStgExpr p -> ([Tickish Id], GenStgExpr p)
go [Tickish Id]
ts (StgTick Tickish Id
t GenStgExpr p
e) | Tickish Id -> Bool
p Tickish Id
t = [Tickish Id] -> GenStgExpr p -> ([Tickish Id], GenStgExpr p)
go (Tickish Id
tTickish Id -> [Tickish Id] -> [Tickish Id]
forall a. a -> [a] -> [a]
:[Tickish Id]
ts) GenStgExpr p
e
         go [Tickish Id]
ts GenStgExpr p
other               = ([Tickish Id] -> [Tickish Id]
forall a. [a] -> [a]
reverse [Tickish Id]
ts, GenStgExpr p
other)

-- | Strip ticks of a given type from an STG expression returning only the expression.
stripStgTicksTopE :: (Tickish Id -> Bool) -> GenStgExpr p -> GenStgExpr p
stripStgTicksTopE :: (Tickish Id -> Bool) -> GenStgExpr p -> GenStgExpr p
stripStgTicksTopE Tickish Id -> Bool
p = GenStgExpr p -> GenStgExpr p
go
   where go :: GenStgExpr p -> GenStgExpr p
go (StgTick Tickish Id
t GenStgExpr p
e) | Tickish Id -> Bool
p Tickish Id
t = GenStgExpr p -> GenStgExpr p
go GenStgExpr p
e
         go GenStgExpr p
other               = GenStgExpr p
other

-- | Given an alt type and whether the program is unarised, return whether the
-- case binder is in scope.
--
-- Case binders of unboxed tuple or unboxed sum type always dead after the
-- unariser has run. See Note [Post-unarisation invariants].
stgCaseBndrInScope :: AltType -> Bool {- ^ unarised? -} -> Bool
stgCaseBndrInScope :: AltType -> Bool -> Bool
stgCaseBndrInScope AltType
alt_ty Bool
unarised =
    case AltType
alt_ty of
      AlgAlt TyCon
_      -> Bool
True
      PrimAlt PrimRep
_     -> Bool
True
      MultiValAlt Int
_ -> Bool -> Bool
not Bool
unarised
      AltType
PolyAlt       -> Bool
True

{-
************************************************************************
*                                                                      *
STG expressions
*                                                                      *
************************************************************************

The @GenStgExpr@ data type is parameterised on binder and occurrence info, as
before.

************************************************************************
*                                                                      *
GenStgExpr
*                                                                      *
************************************************************************

An application is of a function to a list of atoms (not expressions).
Operationally, we want to push the arguments on the stack and call the function.
(If the arguments were expressions, we would have to build their closures
first.)

There is no constructor for a lone variable; it would appear as @StgApp var []@.
-}

data GenStgExpr pass
  = StgApp
        Id       -- function
        [StgArg] -- arguments; may be empty

{-
************************************************************************
*                                                                      *
StgConApp and StgPrimApp --- saturated applications
*                                                                      *
************************************************************************

There are specialised forms of application, for constructors, primitives, and
literals.
-}

  | StgLit      Literal

        -- StgConApp is vital for returning unboxed tuples or sums
        -- which can't be let-bound
  | StgConApp   DataCon
                [StgArg] -- Saturated
                [Type]   -- See Note [Types in StgConApp] in UnariseStg

  | StgOpApp    StgOp    -- Primitive op or foreign call
                [StgArg] -- Saturated.
                Type     -- Result type
                         -- We need to know this so that we can
                         -- assign result registers

{-
************************************************************************
*                                                                      *
StgLam
*                                                                      *
************************************************************************

StgLam is used *only* during CoreToStg's work. Before CoreToStg has finished it
encodes (\x -> e) as (let f = \x -> e in f) TODO: Encode this via an extension
to GenStgExpr à la TTG.
-}

  | StgLam
        (NonEmpty (BinderP pass))
        StgExpr    -- Body of lambda

{-
************************************************************************
*                                                                      *
GenStgExpr: case-expressions
*                                                                      *
************************************************************************

This has the same boxed/unboxed business as Core case expressions.
-}

  | StgCase
        (GenStgExpr pass) -- the thing to examine
        (BinderP pass) -- binds the result of evaluating the scrutinee
        AltType
        [GenStgAlt pass]
                    -- The DEFAULT case is always *first*
                    -- if it is there at all

{-
************************************************************************
*                                                                      *
GenStgExpr: let(rec)-expressions
*                                                                      *
************************************************************************

The various forms of let(rec)-expression encode most of the interesting things
we want to do.

-   let-closure x = [free-vars] [args] expr in e

  is equivalent to

    let x = (\free-vars -> \args -> expr) free-vars

  @args@ may be empty (and is for most closures). It isn't under circumstances
  like this:

    let x = (\y -> y+z)

  This gets mangled to

    let-closure x = [z] [y] (y+z)

  The idea is that we compile code for @(y+z)@ in an environment in which @z@ is
  bound to an offset from Node, and `y` is bound to an offset from the stack
  pointer.

  (A let-closure is an @StgLet@ with a @StgRhsClosure@ RHS.)

-   let-constructor x = Constructor [args] in e

  (A let-constructor is an @StgLet@ with a @StgRhsCon@ RHS.)

- Letrec-expressions are essentially the same deal as let-closure/
  let-constructor, so we use a common structure and distinguish between them
  with an @is_recursive@ boolean flag.

-   let-unboxed u = <an arbitrary arithmetic expression in unboxed values> in e

  All the stuff on the RHS must be fully evaluated. No function calls either!

  (We've backed away from this toward case-expressions with suitably-magical
  alts ...)

- Advanced stuff here! Not to start with, but makes pattern matching generate
  more efficient code.

    let-escapes-not fail = expr
    in e'

  Here the idea is that @e'@ guarantees not to put @fail@ in a data structure,
  or pass it to another function. All @e'@ will ever do is tail-call @fail@.
  Rather than build a closure for @fail@, all we need do is to record the stack
  level at the moment of the @let-escapes-not@; then entering @fail@ is just a
  matter of adjusting the stack pointer back down to that point and entering the
  code for it.

  Another example:

    f x y = let z = huge-expression in
            if y==1 then z else
            if y==2 then z else
            1

  (A let-escapes-not is an @StgLetNoEscape@.)

- We may eventually want:

    let-literal x = Literal in e

And so the code for let(rec)-things:
-}

  | StgLet
        (XLet pass)
        (GenStgBinding pass)    -- right hand sides (see below)
        (GenStgExpr pass)       -- body

  | StgLetNoEscape
        (XLetNoEscape pass)
        (GenStgBinding pass)    -- right hand sides (see below)
        (GenStgExpr pass)       -- body

{-
*************************************************************************
*                                                                      *
GenStgExpr: hpc, scc and other debug annotations
*                                                                      *
*************************************************************************

Finally for @hpc@ expressions we introduce a new STG construct.
-}

  | StgTick
    (Tickish Id)
    (GenStgExpr pass)       -- sub expression

-- END of GenStgExpr

{-
************************************************************************
*                                                                      *
STG right-hand sides
*                                                                      *
************************************************************************

Here's the rest of the interesting stuff for @StgLet@s; the first flavour is for
closures:
-}

data GenStgRhs pass
  = StgRhsClosure
        (XRhsClosure pass) -- ^ Extension point for non-global free var
                           --   list just before 'CodeGen'.
        CostCentreStack    -- ^ CCS to be attached (default is CurrentCCS)
        !UpdateFlag        -- ^ 'ReEntrant' | 'Updatable' | 'SingleEntry'
        [BinderP pass]     -- ^ arguments; if empty, then not a function;
                           --   as above, order is important.
        (GenStgExpr pass)  -- ^ body

{-
An example may be in order.  Consider:

  let t = \x -> \y -> ... x ... y ... p ... q in e

Pulling out the free vars and stylising somewhat, we get the equivalent:

  let t = (\[p,q] -> \[x,y] -> ... x ... y ... p ...q) p q

Stg-operationally, the @[x,y]@ are on the stack, the @[p,q]@ are offsets from
@Node@ into the closure, and the code ptr for the closure will be exactly that
in parentheses above.

The second flavour of right-hand-side is for constructors (simple but
important):
-}

  | StgRhsCon
        CostCentreStack -- CCS to be attached (default is CurrentCCS).
                        -- Top-level (static) ones will end up with
                        -- DontCareCCS, because we don't count static
                        -- data in heap profiles, and we don't set CCCS
                        -- from static closure.
        DataCon         -- Constructor. Never an unboxed tuple or sum, as those
                        -- are not allocated.
        [StgArg]        -- Args

-- | Used as a data type index for the stgSyn AST
data StgPass
  = Vanilla
  | LiftLams
  | CodeGen

-- | Like 'GHC.Hs.Extension.NoExtField', but with an 'Outputable' instance that
-- returns 'empty'.
data NoExtFieldSilent = NoExtFieldSilent
  deriving (Typeable NoExtFieldSilent
DataType
Constr
Typeable NoExtFieldSilent
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> NoExtFieldSilent -> c NoExtFieldSilent)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c NoExtFieldSilent)
-> (NoExtFieldSilent -> Constr)
-> (NoExtFieldSilent -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c NoExtFieldSilent))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e))
    -> Maybe (c NoExtFieldSilent))
-> ((forall b. Data b => b -> b)
    -> NoExtFieldSilent -> NoExtFieldSilent)
-> (forall r r'.
    (r -> r' -> r)
    -> r -> (forall d. Data d => d -> r') -> NoExtFieldSilent -> r)
-> (forall r r'.
    (r' -> r -> r)
    -> r -> (forall d. Data d => d -> r') -> NoExtFieldSilent -> r)
-> (forall u.
    (forall d. Data d => d -> u) -> NoExtFieldSilent -> [u])
-> (forall u.
    Int -> (forall d. Data d => d -> u) -> NoExtFieldSilent -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d)
    -> NoExtFieldSilent -> m NoExtFieldSilent)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d)
    -> NoExtFieldSilent -> m NoExtFieldSilent)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d)
    -> NoExtFieldSilent -> m NoExtFieldSilent)
-> Data NoExtFieldSilent
NoExtFieldSilent -> DataType
NoExtFieldSilent -> Constr
(forall b. Data b => b -> b)
-> NoExtFieldSilent -> NoExtFieldSilent
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> NoExtFieldSilent -> c NoExtFieldSilent
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c NoExtFieldSilent
forall a.
Typeable a
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> a -> c a)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c a)
-> (a -> Constr)
-> (a -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c a))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c a))
-> ((forall b. Data b => b -> b) -> a -> a)
-> (forall r r'.
    (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall r r'.
    (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall u. (forall d. Data d => d -> u) -> a -> [u])
-> (forall u. Int -> (forall d. Data d => d -> u) -> a -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> Data a
forall u.
Int -> (forall d. Data d => d -> u) -> NoExtFieldSilent -> u
forall u. (forall d. Data d => d -> u) -> NoExtFieldSilent -> [u]
forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> NoExtFieldSilent -> r
forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> NoExtFieldSilent -> r
forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d)
-> NoExtFieldSilent -> m NoExtFieldSilent
forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d)
-> NoExtFieldSilent -> m NoExtFieldSilent
forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c NoExtFieldSilent
forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> NoExtFieldSilent -> c NoExtFieldSilent
forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c NoExtFieldSilent)
forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c NoExtFieldSilent)
$cNoExtFieldSilent :: Constr
$tNoExtFieldSilent :: DataType
gmapMo :: (forall d. Data d => d -> m d)
-> NoExtFieldSilent -> m NoExtFieldSilent
$cgmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d)
-> NoExtFieldSilent -> m NoExtFieldSilent
gmapMp :: (forall d. Data d => d -> m d)
-> NoExtFieldSilent -> m NoExtFieldSilent
$cgmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d)
-> NoExtFieldSilent -> m NoExtFieldSilent
gmapM :: (forall d. Data d => d -> m d)
-> NoExtFieldSilent -> m NoExtFieldSilent
$cgmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d)
-> NoExtFieldSilent -> m NoExtFieldSilent
gmapQi :: Int -> (forall d. Data d => d -> u) -> NoExtFieldSilent -> u
$cgmapQi :: forall u.
Int -> (forall d. Data d => d -> u) -> NoExtFieldSilent -> u
gmapQ :: (forall d. Data d => d -> u) -> NoExtFieldSilent -> [u]
$cgmapQ :: forall u. (forall d. Data d => d -> u) -> NoExtFieldSilent -> [u]
gmapQr :: (r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> NoExtFieldSilent -> r
$cgmapQr :: forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> NoExtFieldSilent -> r
gmapQl :: (r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> NoExtFieldSilent -> r
$cgmapQl :: forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> NoExtFieldSilent -> r
gmapT :: (forall b. Data b => b -> b)
-> NoExtFieldSilent -> NoExtFieldSilent
$cgmapT :: (forall b. Data b => b -> b)
-> NoExtFieldSilent -> NoExtFieldSilent
dataCast2 :: (forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c NoExtFieldSilent)
$cdataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c NoExtFieldSilent)
dataCast1 :: (forall d. Data d => c (t d)) -> Maybe (c NoExtFieldSilent)
$cdataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c NoExtFieldSilent)
dataTypeOf :: NoExtFieldSilent -> DataType
$cdataTypeOf :: NoExtFieldSilent -> DataType
toConstr :: NoExtFieldSilent -> Constr
$ctoConstr :: NoExtFieldSilent -> Constr
gunfold :: (forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c NoExtFieldSilent
$cgunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c NoExtFieldSilent
gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> NoExtFieldSilent -> c NoExtFieldSilent
$cgfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> NoExtFieldSilent -> c NoExtFieldSilent
$cp1Data :: Typeable NoExtFieldSilent
Data, NoExtFieldSilent -> NoExtFieldSilent -> Bool
(NoExtFieldSilent -> NoExtFieldSilent -> Bool)
-> (NoExtFieldSilent -> NoExtFieldSilent -> Bool)
-> Eq NoExtFieldSilent
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: NoExtFieldSilent -> NoExtFieldSilent -> Bool
$c/= :: NoExtFieldSilent -> NoExtFieldSilent -> Bool
== :: NoExtFieldSilent -> NoExtFieldSilent -> Bool
$c== :: NoExtFieldSilent -> NoExtFieldSilent -> Bool
Eq, Eq NoExtFieldSilent
Eq NoExtFieldSilent
-> (NoExtFieldSilent -> NoExtFieldSilent -> Ordering)
-> (NoExtFieldSilent -> NoExtFieldSilent -> Bool)
-> (NoExtFieldSilent -> NoExtFieldSilent -> Bool)
-> (NoExtFieldSilent -> NoExtFieldSilent -> Bool)
-> (NoExtFieldSilent -> NoExtFieldSilent -> Bool)
-> (NoExtFieldSilent -> NoExtFieldSilent -> NoExtFieldSilent)
-> (NoExtFieldSilent -> NoExtFieldSilent -> NoExtFieldSilent)
-> Ord NoExtFieldSilent
NoExtFieldSilent -> NoExtFieldSilent -> Bool
NoExtFieldSilent -> NoExtFieldSilent -> Ordering
NoExtFieldSilent -> NoExtFieldSilent -> NoExtFieldSilent
forall a.
Eq a
-> (a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
min :: NoExtFieldSilent -> NoExtFieldSilent -> NoExtFieldSilent
$cmin :: NoExtFieldSilent -> NoExtFieldSilent -> NoExtFieldSilent
max :: NoExtFieldSilent -> NoExtFieldSilent -> NoExtFieldSilent
$cmax :: NoExtFieldSilent -> NoExtFieldSilent -> NoExtFieldSilent
>= :: NoExtFieldSilent -> NoExtFieldSilent -> Bool
$c>= :: NoExtFieldSilent -> NoExtFieldSilent -> Bool
> :: NoExtFieldSilent -> NoExtFieldSilent -> Bool
$c> :: NoExtFieldSilent -> NoExtFieldSilent -> Bool
<= :: NoExtFieldSilent -> NoExtFieldSilent -> Bool
$c<= :: NoExtFieldSilent -> NoExtFieldSilent -> Bool
< :: NoExtFieldSilent -> NoExtFieldSilent -> Bool
$c< :: NoExtFieldSilent -> NoExtFieldSilent -> Bool
compare :: NoExtFieldSilent -> NoExtFieldSilent -> Ordering
$ccompare :: NoExtFieldSilent -> NoExtFieldSilent -> Ordering
$cp1Ord :: Eq NoExtFieldSilent
Ord)

instance Outputable NoExtFieldSilent where
  ppr :: NoExtFieldSilent -> SDoc
ppr NoExtFieldSilent
_ = SDoc
empty

-- | Used when constructing a term with an unused extension point that should
-- not appear in pretty-printed output at all.
noExtFieldSilent :: NoExtFieldSilent
noExtFieldSilent :: NoExtFieldSilent
noExtFieldSilent = NoExtFieldSilent
NoExtFieldSilent
-- TODO: Maybe move this to GHC.Hs.Extension? I'm not sure about the
-- implications on build time...

-- TODO: Do we really want to the extension point type families to have a closed
-- domain?
type family BinderP (pass :: StgPass)
type instance BinderP 'Vanilla = Id
type instance BinderP 'CodeGen = Id

type family XRhsClosure (pass :: StgPass)
type instance XRhsClosure 'Vanilla = NoExtFieldSilent
-- | Code gen needs to track non-global free vars
type instance XRhsClosure 'CodeGen = DIdSet

type family XLet (pass :: StgPass)
type instance XLet 'Vanilla = NoExtFieldSilent
type instance XLet 'CodeGen = NoExtFieldSilent

type family XLetNoEscape (pass :: StgPass)
type instance XLetNoEscape 'Vanilla = NoExtFieldSilent
type instance XLetNoEscape 'CodeGen = NoExtFieldSilent

stgRhsArity :: StgRhs -> Int
stgRhsArity :: StgRhs -> Int
stgRhsArity (StgRhsClosure XRhsClosure 'Vanilla
_ CostCentreStack
_ UpdateFlag
_ [BinderP 'Vanilla]
bndrs GenStgExpr 'Vanilla
_)
  = ASSERT( all isId bndrs ) length bndrs
  -- The arity never includes type parameters, but they should have gone by now
stgRhsArity (StgRhsCon CostCentreStack
_ DataCon
_ [StgArg]
_) = Int
0

-- Note [CAF consistency]
-- ~~~~~~~~~~~~~~~~~~~~~~
--
-- `topStgBindHasCafRefs` is only used by an assert (`consistentCafInfo` in
-- `CoreToStg`) to make sure CAF-ness predicted by `TidyPgm` is consistent with
-- reality.
--
-- Specifically, if the RHS mentions any Id that itself is marked
-- `MayHaveCafRefs`; or if the binding is a top-level updateable thunk; then the
-- `Id` for the binding should be marked `MayHaveCafRefs`. The potential trouble
-- is that `TidyPgm` computed the CAF info on the `Id` but some transformations
-- have taken place since then.

topStgBindHasCafRefs :: GenStgTopBinding pass -> Bool
topStgBindHasCafRefs :: GenStgTopBinding pass -> Bool
topStgBindHasCafRefs (StgTopLifted (StgNonRec BinderP pass
_ GenStgRhs pass
rhs))
  = GenStgRhs pass -> Bool
forall (pass :: StgPass). GenStgRhs pass -> Bool
topRhsHasCafRefs GenStgRhs pass
rhs
topStgBindHasCafRefs (StgTopLifted (StgRec [(BinderP pass, GenStgRhs pass)]
binds))
  = (GenStgRhs pass -> Bool) -> [GenStgRhs pass] -> Bool
forall (t :: * -> *) a. Foldable t => (a -> Bool) -> t a -> Bool
any GenStgRhs pass -> Bool
forall (pass :: StgPass). GenStgRhs pass -> Bool
topRhsHasCafRefs (((BinderP pass, GenStgRhs pass) -> GenStgRhs pass)
-> [(BinderP pass, GenStgRhs pass)] -> [GenStgRhs pass]
forall a b. (a -> b) -> [a] -> [b]
map (BinderP pass, GenStgRhs pass) -> GenStgRhs pass
forall a b. (a, b) -> b
snd [(BinderP pass, GenStgRhs pass)]
binds)
topStgBindHasCafRefs StgTopStringLit{}
  = Bool
False

topRhsHasCafRefs :: GenStgRhs pass -> Bool
topRhsHasCafRefs :: GenStgRhs pass -> Bool
topRhsHasCafRefs (StgRhsClosure XRhsClosure pass
_ CostCentreStack
_ UpdateFlag
upd [BinderP pass]
_ GenStgExpr pass
body)
  = -- See Note [CAF consistency]
    UpdateFlag -> Bool
isUpdatable UpdateFlag
upd Bool -> Bool -> Bool
|| GenStgExpr pass -> Bool
forall (pass :: StgPass). GenStgExpr pass -> Bool
exprHasCafRefs GenStgExpr pass
body
topRhsHasCafRefs (StgRhsCon CostCentreStack
_ DataCon
_ [StgArg]
args)
  = (StgArg -> Bool) -> [StgArg] -> Bool
forall (t :: * -> *) a. Foldable t => (a -> Bool) -> t a -> Bool
any StgArg -> Bool
stgArgHasCafRefs [StgArg]
args

exprHasCafRefs :: GenStgExpr pass -> Bool
exprHasCafRefs :: GenStgExpr pass -> Bool
exprHasCafRefs (StgApp Id
f [StgArg]
args)
  = Id -> Bool
stgIdHasCafRefs Id
f Bool -> Bool -> Bool
|| (StgArg -> Bool) -> [StgArg] -> Bool
forall (t :: * -> *) a. Foldable t => (a -> Bool) -> t a -> Bool
any StgArg -> Bool
stgArgHasCafRefs [StgArg]
args
exprHasCafRefs StgLit{}
  = Bool
False
exprHasCafRefs (StgConApp DataCon
_ [StgArg]
args [UnaryType]
_)
  = (StgArg -> Bool) -> [StgArg] -> Bool
forall (t :: * -> *) a. Foldable t => (a -> Bool) -> t a -> Bool
any StgArg -> Bool
stgArgHasCafRefs [StgArg]
args
exprHasCafRefs (StgOpApp StgOp
_ [StgArg]
args UnaryType
_)
  = (StgArg -> Bool) -> [StgArg] -> Bool
forall (t :: * -> *) a. Foldable t => (a -> Bool) -> t a -> Bool
any StgArg -> Bool
stgArgHasCafRefs [StgArg]
args
exprHasCafRefs (StgLam NonEmpty (BinderP pass)
_ GenStgExpr 'Vanilla
body)
  = GenStgExpr 'Vanilla -> Bool
forall (pass :: StgPass). GenStgExpr pass -> Bool
exprHasCafRefs GenStgExpr 'Vanilla
body
exprHasCafRefs (StgCase GenStgExpr pass
scrt BinderP pass
_ AltType
_ [GenStgAlt pass]
alts)
  = GenStgExpr pass -> Bool
forall (pass :: StgPass). GenStgExpr pass -> Bool
exprHasCafRefs GenStgExpr pass
scrt Bool -> Bool -> Bool
|| (GenStgAlt pass -> Bool) -> [GenStgAlt pass] -> Bool
forall (t :: * -> *) a. Foldable t => (a -> Bool) -> t a -> Bool
any GenStgAlt pass -> Bool
forall (pass :: StgPass). GenStgAlt pass -> Bool
altHasCafRefs [GenStgAlt pass]
alts
exprHasCafRefs (StgLet XLet pass
_ GenStgBinding pass
bind GenStgExpr pass
body)
  = GenStgBinding pass -> Bool
forall (pass :: StgPass). GenStgBinding pass -> Bool
bindHasCafRefs GenStgBinding pass
bind Bool -> Bool -> Bool
|| GenStgExpr pass -> Bool
forall (pass :: StgPass). GenStgExpr pass -> Bool
exprHasCafRefs GenStgExpr pass
body
exprHasCafRefs (StgLetNoEscape XLetNoEscape pass
_ GenStgBinding pass
bind GenStgExpr pass
body)
  = GenStgBinding pass -> Bool
forall (pass :: StgPass). GenStgBinding pass -> Bool
bindHasCafRefs GenStgBinding pass
bind Bool -> Bool -> Bool
|| GenStgExpr pass -> Bool
forall (pass :: StgPass). GenStgExpr pass -> Bool
exprHasCafRefs GenStgExpr pass
body
exprHasCafRefs (StgTick Tickish Id
_ GenStgExpr pass
expr)
  = GenStgExpr pass -> Bool
forall (pass :: StgPass). GenStgExpr pass -> Bool
exprHasCafRefs GenStgExpr pass
expr

bindHasCafRefs :: GenStgBinding pass -> Bool
bindHasCafRefs :: GenStgBinding pass -> Bool
bindHasCafRefs (StgNonRec BinderP pass
_ GenStgRhs pass
rhs)
  = GenStgRhs pass -> Bool
forall (pass :: StgPass). GenStgRhs pass -> Bool
rhsHasCafRefs GenStgRhs pass
rhs
bindHasCafRefs (StgRec [(BinderP pass, GenStgRhs pass)]
binds)
  = (GenStgRhs pass -> Bool) -> [GenStgRhs pass] -> Bool
forall (t :: * -> *) a. Foldable t => (a -> Bool) -> t a -> Bool
any GenStgRhs pass -> Bool
forall (pass :: StgPass). GenStgRhs pass -> Bool
rhsHasCafRefs (((BinderP pass, GenStgRhs pass) -> GenStgRhs pass)
-> [(BinderP pass, GenStgRhs pass)] -> [GenStgRhs pass]
forall a b. (a -> b) -> [a] -> [b]
map (BinderP pass, GenStgRhs pass) -> GenStgRhs pass
forall a b. (a, b) -> b
snd [(BinderP pass, GenStgRhs pass)]
binds)

rhsHasCafRefs :: GenStgRhs pass -> Bool
rhsHasCafRefs :: GenStgRhs pass -> Bool
rhsHasCafRefs (StgRhsClosure XRhsClosure pass
_ CostCentreStack
_ UpdateFlag
_ [BinderP pass]
_ GenStgExpr pass
body)
  = GenStgExpr pass -> Bool
forall (pass :: StgPass). GenStgExpr pass -> Bool
exprHasCafRefs GenStgExpr pass
body
rhsHasCafRefs (StgRhsCon CostCentreStack
_ DataCon
_ [StgArg]
args)
  = (StgArg -> Bool) -> [StgArg] -> Bool
forall (t :: * -> *) a. Foldable t => (a -> Bool) -> t a -> Bool
any StgArg -> Bool
stgArgHasCafRefs [StgArg]
args

altHasCafRefs :: GenStgAlt pass -> Bool
altHasCafRefs :: GenStgAlt pass -> Bool
altHasCafRefs (AltCon
_, [BinderP pass]
_, GenStgExpr pass
rhs) = GenStgExpr pass -> Bool
forall (pass :: StgPass). GenStgExpr pass -> Bool
exprHasCafRefs GenStgExpr pass
rhs

stgArgHasCafRefs :: StgArg -> Bool
stgArgHasCafRefs :: StgArg -> Bool
stgArgHasCafRefs (StgVarArg Id
id)
  = Id -> Bool
stgIdHasCafRefs Id
id
stgArgHasCafRefs StgArg
_
  = Bool
False

stgIdHasCafRefs :: Id -> Bool
stgIdHasCafRefs :: Id -> Bool
stgIdHasCafRefs Id
id =
  -- We are looking for occurrences of an Id that is bound at top level, and may
  -- have CAF refs. At this point (after TidyPgm) top-level Ids (whether
  -- imported or defined in this module) are GlobalIds, so the test is easy.
  Id -> Bool
isGlobalId Id
id Bool -> Bool -> Bool
&& CafInfo -> Bool
mayHaveCafRefs (Id -> CafInfo
idCafInfo Id
id)

{-
************************************************************************
*                                                                      *
STG case alternatives
*                                                                      *
************************************************************************

Very like in @CoreSyntax@ (except no type-world stuff).

The type constructor is guaranteed not to be abstract; that is, we can see its
representation. This is important because the code generator uses it to
determine return conventions etc. But it's not trivial where there's a module
loop involved, because some versions of a type constructor might not have all
the constructors visible. So mkStgAlgAlts (in CoreToStg) ensures that it gets
the TyCon from the constructors or literals (which are guaranteed to have the
Real McCoy) rather than from the scrutinee type.
-}

type GenStgAlt pass
  = (AltCon,          -- alts: data constructor,
     [BinderP pass],  -- constructor's parameters,
     GenStgExpr pass) -- ...right-hand side.

data AltType
  = PolyAlt             -- Polymorphic (a lifted type variable)
  | MultiValAlt Int     -- Multi value of this arity (unboxed tuple or sum)
                        -- the arity could indeed be 1 for unary unboxed tuple
                        -- or enum-like unboxed sums
  | AlgAlt      TyCon   -- Algebraic data type; the AltCons will be DataAlts
  | PrimAlt     PrimRep -- Primitive data type; the AltCons (if any) will be LitAlts

{-
************************************************************************
*                                                                      *
The Plain STG parameterisation
*                                                                      *
************************************************************************

This happens to be the only one we use at the moment.
-}

type StgTopBinding = GenStgTopBinding 'Vanilla
type StgBinding    = GenStgBinding    'Vanilla
type StgExpr       = GenStgExpr       'Vanilla
type StgRhs        = GenStgRhs        'Vanilla
type StgAlt        = GenStgAlt        'Vanilla

type LlStgTopBinding = GenStgTopBinding 'LiftLams
type LlStgBinding    = GenStgBinding    'LiftLams
type LlStgExpr       = GenStgExpr       'LiftLams
type LlStgRhs        = GenStgRhs        'LiftLams
type LlStgAlt        = GenStgAlt        'LiftLams

type CgStgTopBinding = GenStgTopBinding 'CodeGen
type CgStgBinding    = GenStgBinding    'CodeGen
type CgStgExpr       = GenStgExpr       'CodeGen
type CgStgRhs        = GenStgRhs        'CodeGen
type CgStgAlt        = GenStgAlt        'CodeGen

{- Many passes apply a substitution, and it's very handy to have type
   synonyms to remind us whether or not the substitution has been applied.
   See CoreSyn for precedence in Core land
-}

type InStgTopBinding  = StgTopBinding
type InStgBinding     = StgBinding
type InStgArg         = StgArg
type InStgExpr        = StgExpr
type InStgRhs         = StgRhs
type InStgAlt         = StgAlt
type OutStgTopBinding = StgTopBinding
type OutStgBinding    = StgBinding
type OutStgArg        = StgArg
type OutStgExpr       = StgExpr
type OutStgRhs        = StgRhs
type OutStgAlt        = StgAlt

{-

************************************************************************
*                                                                      *
UpdateFlag
*                                                                      *
************************************************************************

This is also used in @LambdaFormInfo@ in the @ClosureInfo@ module.

A @ReEntrant@ closure may be entered multiple times, but should not be updated
or blackholed. An @Updatable@ closure should be updated after evaluation (and
may be blackholed during evaluation). A @SingleEntry@ closure will only be
entered once, and so need not be updated but may safely be blackholed.
-}

data UpdateFlag = ReEntrant | Updatable | SingleEntry

instance Outputable UpdateFlag where
    ppr :: UpdateFlag -> SDoc
ppr UpdateFlag
u = Char -> SDoc
char (Char -> SDoc) -> Char -> SDoc
forall a b. (a -> b) -> a -> b
$ case UpdateFlag
u of
                       UpdateFlag
ReEntrant   -> Char
'r'
                       UpdateFlag
Updatable   -> Char
'u'
                       UpdateFlag
SingleEntry -> Char
's'

isUpdatable :: UpdateFlag -> Bool
isUpdatable :: UpdateFlag -> Bool
isUpdatable UpdateFlag
ReEntrant   = Bool
False
isUpdatable UpdateFlag
SingleEntry = Bool
False
isUpdatable UpdateFlag
Updatable   = Bool
True

{-
************************************************************************
*                                                                      *
StgOp
*                                                                      *
************************************************************************

An StgOp allows us to group together PrimOps and ForeignCalls. It's quite useful
to move these around together, notably in StgOpApp and COpStmt.
-}

data StgOp
  = StgPrimOp  PrimOp

  | StgPrimCallOp PrimCall

  | StgFCallOp ForeignCall Type
        -- The Type, which is obtained from the foreign import declaration
        -- itself, is needed by the stg-to-cmm pass to determine the offset to
        -- apply to unlifted boxed arguments in GHC.StgToCmm.Foreign. See Note
        -- [Unlifted boxed arguments to foreign calls]

{-
************************************************************************
*                                                                      *
Pretty-printing
*                                                                      *
************************************************************************

Robin Popplestone asked for semi-colon separators on STG binds; here's hoping he
likes terminators instead...  Ditto for case alternatives.
-}

type OutputablePass pass =
  ( Outputable (XLet pass)
  , Outputable (XLetNoEscape pass)
  , Outputable (XRhsClosure pass)
  , OutputableBndr (BinderP pass)
  )

pprGenStgTopBinding
  :: OutputablePass pass => GenStgTopBinding pass -> SDoc
pprGenStgTopBinding :: GenStgTopBinding pass -> SDoc
pprGenStgTopBinding (StgTopStringLit Id
bndr ByteString
str)
  = SDoc -> Int -> SDoc -> SDoc
hang ([SDoc] -> SDoc
hsep [BindingSite -> Id -> SDoc
forall a. OutputableBndr a => BindingSite -> a -> SDoc
pprBndr BindingSite
LetBind Id
bndr, SDoc
equals])
        Int
4 (ByteString -> SDoc
pprHsBytes ByteString
str SDoc -> SDoc -> SDoc
<> SDoc
semi)
pprGenStgTopBinding (StgTopLifted GenStgBinding pass
bind)
  = GenStgBinding pass -> SDoc
forall (pass :: StgPass).
OutputablePass pass =>
GenStgBinding pass -> SDoc
pprGenStgBinding GenStgBinding pass
bind

pprGenStgBinding
  :: OutputablePass pass => GenStgBinding pass -> SDoc

pprGenStgBinding :: GenStgBinding pass -> SDoc
pprGenStgBinding (StgNonRec BinderP pass
bndr GenStgRhs pass
rhs)
  = SDoc -> Int -> SDoc -> SDoc
hang ([SDoc] -> SDoc
hsep [BindingSite -> BinderP pass -> SDoc
forall a. OutputableBndr a => BindingSite -> a -> SDoc
pprBndr BindingSite
LetBind BinderP pass
bndr, SDoc
equals])
        Int
4 (GenStgRhs pass -> SDoc
forall a. Outputable a => a -> SDoc
ppr GenStgRhs pass
rhs SDoc -> SDoc -> SDoc
<> SDoc
semi)

pprGenStgBinding (StgRec [(BinderP pass, GenStgRhs pass)]
pairs)
  = [SDoc] -> SDoc
vcat [ String -> SDoc
text String
"Rec {"
         , [SDoc] -> SDoc
vcat (SDoc -> [SDoc] -> [SDoc]
forall a. a -> [a] -> [a]
intersperse SDoc
blankLine (((BinderP pass, GenStgRhs pass) -> SDoc)
-> [(BinderP pass, GenStgRhs pass)] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map (BinderP pass, GenStgRhs pass) -> SDoc
forall a a. (OutputableBndr a, Outputable a) => (a, a) -> SDoc
ppr_bind [(BinderP pass, GenStgRhs pass)]
pairs))
         , String -> SDoc
text String
"end Rec }" ]
  where
    ppr_bind :: (a, a) -> SDoc
ppr_bind (a
bndr, a
expr)
      = SDoc -> Int -> SDoc -> SDoc
hang ([SDoc] -> SDoc
hsep [BindingSite -> a -> SDoc
forall a. OutputableBndr a => BindingSite -> a -> SDoc
pprBndr BindingSite
LetBind a
bndr, SDoc
equals])
             Int
4 (a -> SDoc
forall a. Outputable a => a -> SDoc
ppr a
expr SDoc -> SDoc -> SDoc
<> SDoc
semi)

pprGenStgTopBindings
  :: (OutputablePass pass) => [GenStgTopBinding pass] -> SDoc
pprGenStgTopBindings :: [GenStgTopBinding pass] -> SDoc
pprGenStgTopBindings [GenStgTopBinding pass]
binds
  = [SDoc] -> SDoc
vcat ([SDoc] -> SDoc) -> [SDoc] -> SDoc
forall a b. (a -> b) -> a -> b
$ SDoc -> [SDoc] -> [SDoc]
forall a. a -> [a] -> [a]
intersperse SDoc
blankLine ((GenStgTopBinding pass -> SDoc)
-> [GenStgTopBinding pass] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map GenStgTopBinding pass -> SDoc
forall (pass :: StgPass).
OutputablePass pass =>
GenStgTopBinding pass -> SDoc
pprGenStgTopBinding [GenStgTopBinding pass]
binds)

pprStgBinding :: StgBinding -> SDoc
pprStgBinding :: StgBinding -> SDoc
pprStgBinding = StgBinding -> SDoc
forall (pass :: StgPass).
OutputablePass pass =>
GenStgBinding pass -> SDoc
pprGenStgBinding

pprStgTopBindings :: [StgTopBinding] -> SDoc
pprStgTopBindings :: [StgTopBinding] -> SDoc
pprStgTopBindings = [StgTopBinding] -> SDoc
forall (pass :: StgPass).
OutputablePass pass =>
[GenStgTopBinding pass] -> SDoc
pprGenStgTopBindings

instance Outputable StgArg where
    ppr :: StgArg -> SDoc
ppr = StgArg -> SDoc
pprStgArg

instance OutputablePass pass => Outputable (GenStgTopBinding pass) where
    ppr :: GenStgTopBinding pass -> SDoc
ppr = GenStgTopBinding pass -> SDoc
forall (pass :: StgPass).
OutputablePass pass =>
GenStgTopBinding pass -> SDoc
pprGenStgTopBinding

instance OutputablePass pass => Outputable (GenStgBinding pass) where
    ppr :: GenStgBinding pass -> SDoc
ppr = GenStgBinding pass -> SDoc
forall (pass :: StgPass).
OutputablePass pass =>
GenStgBinding pass -> SDoc
pprGenStgBinding

instance OutputablePass pass => Outputable (GenStgExpr pass) where
    ppr :: GenStgExpr pass -> SDoc
ppr = GenStgExpr pass -> SDoc
forall (pass :: StgPass).
OutputablePass pass =>
GenStgExpr pass -> SDoc
pprStgExpr

instance OutputablePass pass => Outputable (GenStgRhs pass) where
    ppr :: GenStgRhs pass -> SDoc
ppr GenStgRhs pass
rhs = GenStgRhs pass -> SDoc
forall (pass :: StgPass).
OutputablePass pass =>
GenStgRhs pass -> SDoc
pprStgRhs GenStgRhs pass
rhs

pprStgArg :: StgArg -> SDoc
pprStgArg :: StgArg -> SDoc
pprStgArg (StgVarArg Id
var) = Id -> SDoc
forall a. Outputable a => a -> SDoc
ppr Id
var
pprStgArg (StgLitArg Literal
con) = Literal -> SDoc
forall a. Outputable a => a -> SDoc
ppr Literal
con

pprStgExpr :: OutputablePass pass => GenStgExpr pass -> SDoc
-- special case
pprStgExpr :: GenStgExpr pass -> SDoc
pprStgExpr (StgLit Literal
lit)     = Literal -> SDoc
forall a. Outputable a => a -> SDoc
ppr Literal
lit

-- general case
pprStgExpr (StgApp Id
func [StgArg]
args)
  = SDoc -> Int -> SDoc -> SDoc
hang (Id -> SDoc
forall a. Outputable a => a -> SDoc
ppr Id
func) Int
4 ([SDoc] -> SDoc
sep ((StgArg -> SDoc) -> [StgArg] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map (StgArg -> SDoc
forall a. Outputable a => a -> SDoc
ppr) [StgArg]
args))

pprStgExpr (StgConApp DataCon
con [StgArg]
args [UnaryType]
_)
  = [SDoc] -> SDoc
hsep [ DataCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr DataCon
con, SDoc -> SDoc
brackets ([StgArg] -> SDoc
forall a. Outputable a => [a] -> SDoc
interppSP [StgArg]
args) ]

pprStgExpr (StgOpApp StgOp
op [StgArg]
args UnaryType
_)
  = [SDoc] -> SDoc
hsep [ StgOp -> SDoc
pprStgOp StgOp
op, SDoc -> SDoc
brackets ([StgArg] -> SDoc
forall a. Outputable a => [a] -> SDoc
interppSP [StgArg]
args)]

pprStgExpr (StgLam NonEmpty (BinderP pass)
bndrs GenStgExpr 'Vanilla
body)
  = [SDoc] -> SDoc
sep [ Char -> SDoc
char Char
'\\' SDoc -> SDoc -> SDoc
<+> [SDoc] -> SDoc
ppr_list ((BinderP pass -> SDoc) -> [BinderP pass] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map (BindingSite -> BinderP pass -> SDoc
forall a. OutputableBndr a => BindingSite -> a -> SDoc
pprBndr BindingSite
LambdaBind) (NonEmpty (BinderP pass) -> [BinderP pass]
forall a. NonEmpty a -> [a]
toList NonEmpty (BinderP pass)
bndrs))
            SDoc -> SDoc -> SDoc
<+> String -> SDoc
text String
"->",
         GenStgExpr 'Vanilla -> SDoc
forall (pass :: StgPass).
OutputablePass pass =>
GenStgExpr pass -> SDoc
pprStgExpr GenStgExpr 'Vanilla
body ]
  where ppr_list :: [SDoc] -> SDoc
ppr_list = SDoc -> SDoc
brackets (SDoc -> SDoc) -> ([SDoc] -> SDoc) -> [SDoc] -> SDoc
forall b c a. (b -> c) -> (a -> b) -> a -> c
. [SDoc] -> SDoc
fsep ([SDoc] -> SDoc) -> ([SDoc] -> [SDoc]) -> [SDoc] -> SDoc
forall b c a. (b -> c) -> (a -> b) -> a -> c
. SDoc -> [SDoc] -> [SDoc]
punctuate SDoc
comma

-- special case: let v = <very specific thing>
--               in
--               let ...
--               in
--               ...
--
-- Very special!  Suspicious! (SLPJ)

{-
pprStgExpr (StgLet srt (StgNonRec bndr (StgRhsClosure cc bi free_vars upd_flag args rhs))
                        expr@(StgLet _ _))
  = ($$)
      (hang (hcat [text "let { ", ppr bndr, ptext (sLit " = "),
                          ppr cc,
                          pp_binder_info bi,
                          text " [", whenPprDebug (interppSP free_vars), ptext (sLit "] \\"),
                          ppr upd_flag, text " [",
                          interppSP args, char ']'])
            8 (sep [hsep [ppr rhs, text "} in"]]))
      (ppr expr)
-}

-- special case: let ... in let ...

pprStgExpr (StgLet XLet pass
ext GenStgBinding pass
bind expr :: GenStgExpr pass
expr@StgLet{})
  = SDoc -> SDoc -> SDoc
($$)
      ([SDoc] -> SDoc
sep [SDoc -> Int -> SDoc -> SDoc
hang (String -> SDoc
text String
"let" SDoc -> SDoc -> SDoc
<+> XLet pass -> SDoc
forall a. Outputable a => a -> SDoc
ppr XLet pass
ext SDoc -> SDoc -> SDoc
<+> String -> SDoc
text String
"{")
                Int
2 ([SDoc] -> SDoc
hsep [GenStgBinding pass -> SDoc
forall (pass :: StgPass).
OutputablePass pass =>
GenStgBinding pass -> SDoc
pprGenStgBinding GenStgBinding pass
bind, String -> SDoc
text String
"} in"])])
      (GenStgExpr pass -> SDoc
forall a. Outputable a => a -> SDoc
ppr GenStgExpr pass
expr)

-- general case
pprStgExpr (StgLet XLet pass
ext GenStgBinding pass
bind GenStgExpr pass
expr)
  = [SDoc] -> SDoc
sep [SDoc -> Int -> SDoc -> SDoc
hang (String -> SDoc
text String
"let" SDoc -> SDoc -> SDoc
<+> XLet pass -> SDoc
forall a. Outputable a => a -> SDoc
ppr XLet pass
ext SDoc -> SDoc -> SDoc
<+> String -> SDoc
text String
"{") Int
2 (GenStgBinding pass -> SDoc
forall (pass :: StgPass).
OutputablePass pass =>
GenStgBinding pass -> SDoc
pprGenStgBinding GenStgBinding pass
bind),
           SDoc -> Int -> SDoc -> SDoc
hang (String -> SDoc
text String
"} in ") Int
2 (GenStgExpr pass -> SDoc
forall a. Outputable a => a -> SDoc
ppr GenStgExpr pass
expr)]

pprStgExpr (StgLetNoEscape XLetNoEscape pass
ext GenStgBinding pass
bind GenStgExpr pass
expr)
  = [SDoc] -> SDoc
sep [SDoc -> Int -> SDoc -> SDoc
hang (String -> SDoc
text String
"let-no-escape" SDoc -> SDoc -> SDoc
<+> XLetNoEscape pass -> SDoc
forall a. Outputable a => a -> SDoc
ppr XLetNoEscape pass
ext SDoc -> SDoc -> SDoc
<+> String -> SDoc
text String
"{")
                Int
2 (GenStgBinding pass -> SDoc
forall (pass :: StgPass).
OutputablePass pass =>
GenStgBinding pass -> SDoc
pprGenStgBinding GenStgBinding pass
bind),
           SDoc -> Int -> SDoc -> SDoc
hang (String -> SDoc
text String
"} in ")
                Int
2 (GenStgExpr pass -> SDoc
forall a. Outputable a => a -> SDoc
ppr GenStgExpr pass
expr)]

pprStgExpr (StgTick Tickish Id
tickish GenStgExpr pass
expr)
  = (DynFlags -> SDoc) -> SDoc
sdocWithDynFlags ((DynFlags -> SDoc) -> SDoc) -> (DynFlags -> SDoc) -> SDoc
forall a b. (a -> b) -> a -> b
$ \DynFlags
dflags ->
    if GeneralFlag -> DynFlags -> Bool
gopt GeneralFlag
Opt_SuppressTicks DynFlags
dflags
    then GenStgExpr pass -> SDoc
forall (pass :: StgPass).
OutputablePass pass =>
GenStgExpr pass -> SDoc
pprStgExpr GenStgExpr pass
expr
    else [SDoc] -> SDoc
sep [ Tickish Id -> SDoc
forall a. Outputable a => a -> SDoc
ppr Tickish Id
tickish, GenStgExpr pass -> SDoc
forall (pass :: StgPass).
OutputablePass pass =>
GenStgExpr pass -> SDoc
pprStgExpr GenStgExpr pass
expr ]


-- Don't indent for a single case alternative.
pprStgExpr (StgCase GenStgExpr pass
expr BinderP pass
bndr AltType
alt_type [GenStgAlt pass
alt])
  = [SDoc] -> SDoc
sep [[SDoc] -> SDoc
sep [String -> SDoc
text String
"case",
           Int -> SDoc -> SDoc
nest Int
4 ([SDoc] -> SDoc
hsep [GenStgExpr pass -> SDoc
forall (pass :: StgPass).
OutputablePass pass =>
GenStgExpr pass -> SDoc
pprStgExpr GenStgExpr pass
expr,
             SDoc -> SDoc
whenPprDebug (SDoc
dcolon SDoc -> SDoc -> SDoc
<+> AltType -> SDoc
forall a. Outputable a => a -> SDoc
ppr AltType
alt_type)]),
           String -> SDoc
text String
"of", BindingSite -> BinderP pass -> SDoc
forall a. OutputableBndr a => BindingSite -> a -> SDoc
pprBndr BindingSite
CaseBind BinderP pass
bndr, Char -> SDoc
char Char
'{'],
           Bool -> GenStgAlt pass -> SDoc
forall (pass :: StgPass).
OutputablePass pass =>
Bool -> GenStgAlt pass -> SDoc
pprStgAlt Bool
False GenStgAlt pass
alt,
           Char -> SDoc
char Char
'}']

pprStgExpr (StgCase GenStgExpr pass
expr BinderP pass
bndr AltType
alt_type [GenStgAlt pass]
alts)
  = [SDoc] -> SDoc
sep [[SDoc] -> SDoc
sep [String -> SDoc
text String
"case",
           Int -> SDoc -> SDoc
nest Int
4 ([SDoc] -> SDoc
hsep [GenStgExpr pass -> SDoc
forall (pass :: StgPass).
OutputablePass pass =>
GenStgExpr pass -> SDoc
pprStgExpr GenStgExpr pass
expr,
             SDoc -> SDoc
whenPprDebug (SDoc
dcolon SDoc -> SDoc -> SDoc
<+> AltType -> SDoc
forall a. Outputable a => a -> SDoc
ppr AltType
alt_type)]),
           String -> SDoc
text String
"of", BindingSite -> BinderP pass -> SDoc
forall a. OutputableBndr a => BindingSite -> a -> SDoc
pprBndr BindingSite
CaseBind BinderP pass
bndr, Char -> SDoc
char Char
'{'],
           Int -> SDoc -> SDoc
nest Int
2 ([SDoc] -> SDoc
vcat ((GenStgAlt pass -> SDoc) -> [GenStgAlt pass] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map (Bool -> GenStgAlt pass -> SDoc
forall (pass :: StgPass).
OutputablePass pass =>
Bool -> GenStgAlt pass -> SDoc
pprStgAlt Bool
True) [GenStgAlt pass]
alts)),
           Char -> SDoc
char Char
'}']


pprStgAlt :: OutputablePass pass => Bool -> GenStgAlt pass -> SDoc
pprStgAlt :: Bool -> GenStgAlt pass -> SDoc
pprStgAlt Bool
indent (AltCon
con, [BinderP pass]
params, GenStgExpr pass
expr)
  | Bool
indent    = SDoc -> Int -> SDoc -> SDoc
hang SDoc
altPattern Int
4 (GenStgExpr pass -> SDoc
forall a. Outputable a => a -> SDoc
ppr GenStgExpr pass
expr SDoc -> SDoc -> SDoc
<> SDoc
semi)
  | Bool
otherwise = [SDoc] -> SDoc
sep [SDoc
altPattern, GenStgExpr pass -> SDoc
forall a. Outputable a => a -> SDoc
ppr GenStgExpr pass
expr SDoc -> SDoc -> SDoc
<> SDoc
semi]
    where
      altPattern :: SDoc
altPattern = ([SDoc] -> SDoc
hsep [AltCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr AltCon
con, [SDoc] -> SDoc
sep ((BinderP pass -> SDoc) -> [BinderP pass] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map (BindingSite -> BinderP pass -> SDoc
forall a. OutputableBndr a => BindingSite -> a -> SDoc
pprBndr BindingSite
CasePatBind) [BinderP pass]
params), String -> SDoc
text String
"->"])


pprStgOp :: StgOp -> SDoc
pprStgOp :: StgOp -> SDoc
pprStgOp (StgPrimOp  PrimOp
op)   = PrimOp -> SDoc
forall a. Outputable a => a -> SDoc
ppr PrimOp
op
pprStgOp (StgPrimCallOp PrimCall
op)= PrimCall -> SDoc
forall a. Outputable a => a -> SDoc
ppr PrimCall
op
pprStgOp (StgFCallOp ForeignCall
op UnaryType
_) = ForeignCall -> SDoc
forall a. Outputable a => a -> SDoc
ppr ForeignCall
op

instance Outputable AltType where
  ppr :: AltType -> SDoc
ppr AltType
PolyAlt         = String -> SDoc
text String
"Polymorphic"
  ppr (MultiValAlt Int
n) = String -> SDoc
text String
"MultiAlt" SDoc -> SDoc -> SDoc
<+> Int -> SDoc
forall a. Outputable a => a -> SDoc
ppr Int
n
  ppr (AlgAlt TyCon
tc)     = String -> SDoc
text String
"Alg"    SDoc -> SDoc -> SDoc
<+> TyCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr TyCon
tc
  ppr (PrimAlt PrimRep
tc)    = String -> SDoc
text String
"Prim"   SDoc -> SDoc -> SDoc
<+> PrimRep -> SDoc
forall a. Outputable a => a -> SDoc
ppr PrimRep
tc

pprStgRhs :: OutputablePass pass => GenStgRhs pass -> SDoc

pprStgRhs :: GenStgRhs pass -> SDoc
pprStgRhs (StgRhsClosure XRhsClosure pass
ext CostCentreStack
cc UpdateFlag
upd_flag [BinderP pass]
args GenStgExpr pass
body)
  = (DynFlags -> SDoc) -> SDoc
sdocWithDynFlags ((DynFlags -> SDoc) -> SDoc) -> (DynFlags -> SDoc) -> SDoc
forall a b. (a -> b) -> a -> b
$ \DynFlags
dflags ->
    SDoc -> Int -> SDoc -> SDoc
hang ([SDoc] -> SDoc
hsep [if GeneralFlag -> DynFlags -> Bool
gopt GeneralFlag
Opt_SccProfilingOn DynFlags
dflags then CostCentreStack -> SDoc
forall a. Outputable a => a -> SDoc
ppr CostCentreStack
cc else SDoc
empty,
                if Bool -> Bool
not (Bool -> Bool) -> Bool -> Bool
forall a b. (a -> b) -> a -> b
$ GeneralFlag -> DynFlags -> Bool
gopt GeneralFlag
Opt_SuppressStgExts DynFlags
dflags
                  then XRhsClosure pass -> SDoc
forall a. Outputable a => a -> SDoc
ppr XRhsClosure pass
ext else SDoc
empty,
                Char -> SDoc
char Char
'\\' SDoc -> SDoc -> SDoc
<> UpdateFlag -> SDoc
forall a. Outputable a => a -> SDoc
ppr UpdateFlag
upd_flag, SDoc -> SDoc
brackets ([BinderP pass] -> SDoc
forall a. Outputable a => [a] -> SDoc
interppSP [BinderP pass]
args)])
         Int
4 (GenStgExpr pass -> SDoc
forall a. Outputable a => a -> SDoc
ppr GenStgExpr pass
body)

pprStgRhs (StgRhsCon CostCentreStack
cc DataCon
con [StgArg]
args)
  = [SDoc] -> SDoc
hcat [ CostCentreStack -> SDoc
forall a. Outputable a => a -> SDoc
ppr CostCentreStack
cc,
           SDoc
space, DataCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr DataCon
con, String -> SDoc
text String
"! ", SDoc -> SDoc
brackets ([StgArg] -> SDoc
forall a. Outputable a => [a] -> SDoc
interppSP [StgArg]
args)]