Stg.Language

The STG language syntax tree, modeled after the description in the 1992 paper (link).

A Program is typically created using functionality provided by the Stg.Parser module, as opposed to manually combining the data types given in this module.

For plenty of comparisons of STG language source and generated parse trees, have a look at the Stg.Parser.QuasiQuoter module.

Documentation

newtype Program

An STG Program is the unit that can be loaded by the STG machine. It consists of a set of bindings.

Constructors

Program Binds

Instances

Eq Program

Methods

(==) :: Program -> Program -> Bool

(/=) :: Program -> Program -> Bool

Ord Program

Methods

compare :: Program -> Program -> Ordering

(<) :: Program -> Program -> Bool

(<=) :: Program -> Program -> Bool

(>) :: Program -> Program -> Bool

(>=) :: Program -> Program -> Bool

max :: Program -> Program -> Program

min :: Program -> Program -> Program

Show Program

Methods

showsPrec :: Int -> Program -> ShowS

show :: Program -> String

showList :: [Program] -> ShowS

Generic Program

Associated Types

type Rep Program :: * -> *

Methods

from :: Program -> Rep Program x

to :: Rep Program x -> Program

Semigroup Program

Methods

(<>) :: Program -> Program -> Program

sconcat :: NonEmpty Program -> Program

stimes :: Integral b => b -> Program -> Program

Monoid Program

Right-biased union of the contained bindings. This makes for a poor man's module system by appending multiple, potentially partially incomplete, Programs to each other.

map <> filter <> [stg| … actual source … |]

Methods

mempty :: Program

mappend :: Program -> Program -> Program

mconcat :: [Program] -> Program

Lift Program

Methods

lift :: Program -> Q Exp

NFData Program

Methods

rnf :: Program -> ()

PrettyStgi Program

Methods

prettyStgi :: Program -> Doc StgiAnn

FreeVariables Program

Methods

freeVariables :: Program -> Set Var

type Rep Program

type Rep Program = D1 (MetaData "Program" "Stg.Language" "stgi-1.1-LT0PoB9W7KUFnIHxeV3rhx" True) (C1 (MetaCons "Program" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Binds)))

newtype Binds

Bindings are collections of lambda forms, indexed over variables.

They exist at the top level, or as part of a let(rec) binding.

Constructors

Binds (Map Var LambdaForm)

Instances

Eq Binds

Methods

(==) :: Binds -> Binds -> Bool

(/=) :: Binds -> Binds -> Bool

Ord Binds

Methods

compare :: Binds -> Binds -> Ordering

(<) :: Binds -> Binds -> Bool

(<=) :: Binds -> Binds -> Bool

(>) :: Binds -> Binds -> Bool

(>=) :: Binds -> Binds -> Bool

max :: Binds -> Binds -> Binds

min :: Binds -> Binds -> Binds

Show Binds

Methods

showsPrec :: Int -> Binds -> ShowS

show :: Binds -> String

showList :: [Binds] -> ShowS

Generic Binds

Associated Types

type Rep Binds :: * -> *

Methods

from :: Binds -> Rep Binds x

to :: Rep Binds x -> Binds

Semigroup Binds

Methods

(<>) :: Binds -> Binds -> Binds

sconcat :: NonEmpty Binds -> Binds

stimes :: Integral b => b -> Binds -> Binds

Monoid Binds

Right-biased union. See Monoid Program for further information.

Methods

mempty :: Binds

mappend :: Binds -> Binds -> Binds

mconcat :: [Binds] -> Binds

Lift Binds

Methods

lift :: Binds -> Q Exp

NFData Binds

Methods

rnf :: Binds -> ()

PrettyStgi Binds

Methods

prettyStgi :: Binds -> Doc StgiAnn

FreeVariables Binds

Methods

freeVariables :: Binds -> Set Var

type Rep Binds

type Rep Binds = D1 (MetaData "Binds" "Stg.Language" "stgi-1.1-LT0PoB9W7KUFnIHxeV3rhx" True) (C1 (MetaCons "Binds" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map Var LambdaForm))))

data LambdaForm

A lambda form unifies free and bound variables associated with a function body. The lambda body must not be of primitive type, as this would imply the value is both boxed and unboxed.

>>> [stg| \(x) y z -> expr x z |]
LambdaForm [Var "x"] NoUpdate [Var "y",Var "z"] (AppF (Var "expr") [AtomVar (Var "x"),AtomVar (Var "z")])

Constructors

LambdaForm ![Var] !UpdateFlag ![Var] !Expr

• Free variables (excluding globals)
• Update flag
• Bound variables
• Body

Instances

Eq LambdaForm

Methods

(==) :: LambdaForm -> LambdaForm -> Bool

(/=) :: LambdaForm -> LambdaForm -> Bool

Ord LambdaForm

Methods

compare :: LambdaForm -> LambdaForm -> Ordering

(<) :: LambdaForm -> LambdaForm -> Bool

(<=) :: LambdaForm -> LambdaForm -> Bool

(>) :: LambdaForm -> LambdaForm -> Bool

(>=) :: LambdaForm -> LambdaForm -> Bool

max :: LambdaForm -> LambdaForm -> LambdaForm

min :: LambdaForm -> LambdaForm -> LambdaForm

Show LambdaForm

Methods

showsPrec :: Int -> LambdaForm -> ShowS

show :: LambdaForm -> String

showList :: [LambdaForm] -> ShowS

Generic LambdaForm

Associated Types

type Rep LambdaForm :: * -> *

Methods

from :: LambdaForm -> Rep LambdaForm x

to :: Rep LambdaForm x -> LambdaForm

Lift LambdaForm

Methods

lift :: LambdaForm -> Q Exp

NFData LambdaForm

Methods

rnf :: LambdaForm -> ()

PrettyStgi LambdaForm

Methods

prettyStgi :: LambdaForm -> Doc StgiAnn

FreeVariables LambdaForm

Only takes into account the explicit free variable list of the lambda. This means that globals, which are not explicitly free, will not be considered free variables.

Methods

freeVariables :: LambdaForm -> Set Var

type Rep LambdaForm

type Rep LambdaForm = D1 (MetaData "LambdaForm" "Stg.Language" "stgi-1.1-LT0PoB9W7KUFnIHxeV3rhx" False) (C1 (MetaCons "LambdaForm" PrefixI False) ((:*:) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Var])) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 UpdateFlag))) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Var])) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Expr)))))

prettyLambda

Arguments

:: ([Var] -> Doc StgiAnn)

Free variable list printer

-> LambdaForm

-> Doc StgiAnn

Prettyprint a LambdaForm, given prettyprinters for the free variable list.

Introduced so Closure can hijack it to display the free value list differently.

data UpdateFlag

The update flag distinguishes updatable from non-updatable lambda forms.

Constructors

Update

Overwrite the heap object in-place with its reduced value once available, making recurring access cheap

NoUpdate

Don't touch the heap object after evaluation

Instances

Bounded UpdateFlag

Methods

minBound :: UpdateFlag

maxBound :: UpdateFlag

Enum UpdateFlag

Methods

succ :: UpdateFlag -> UpdateFlag

pred :: UpdateFlag -> UpdateFlag

toEnum :: Int -> UpdateFlag

fromEnum :: UpdateFlag -> Int

enumFrom :: UpdateFlag -> [UpdateFlag]

enumFromThen :: UpdateFlag -> UpdateFlag -> [UpdateFlag]

enumFromTo :: UpdateFlag -> UpdateFlag -> [UpdateFlag]

enumFromThenTo :: UpdateFlag -> UpdateFlag -> UpdateFlag -> [UpdateFlag]

Eq UpdateFlag

Methods

(==) :: UpdateFlag -> UpdateFlag -> Bool

(/=) :: UpdateFlag -> UpdateFlag -> Bool

Ord UpdateFlag

Methods

compare :: UpdateFlag -> UpdateFlag -> Ordering

(<) :: UpdateFlag -> UpdateFlag -> Bool

(<=) :: UpdateFlag -> UpdateFlag -> Bool

(>) :: UpdateFlag -> UpdateFlag -> Bool

(>=) :: UpdateFlag -> UpdateFlag -> Bool

max :: UpdateFlag -> UpdateFlag -> UpdateFlag

min :: UpdateFlag -> UpdateFlag -> UpdateFlag

Show UpdateFlag

Methods

showsPrec :: Int -> UpdateFlag -> ShowS

show :: UpdateFlag -> String

showList :: [UpdateFlag] -> ShowS

Generic UpdateFlag

Associated Types

type Rep UpdateFlag :: * -> *

Methods

from :: UpdateFlag -> Rep UpdateFlag x

to :: Rep UpdateFlag x -> UpdateFlag

Lift UpdateFlag

Methods

lift :: UpdateFlag -> Q Exp

NFData UpdateFlag

Methods

rnf :: UpdateFlag -> ()

type Rep UpdateFlag

type Rep UpdateFlag = D1 (MetaData "UpdateFlag" "Stg.Language" "stgi-1.1-LT0PoB9W7KUFnIHxeV3rhx" False) ((:+:) (C1 (MetaCons "Update" PrefixI False) U1) (C1 (MetaCons "NoUpdate" PrefixI False) U1))

data Rec

Distinguishes let from letrec.

Constructors

NonRecursive

Bindings have no access to each other

Recursive

Bindings can be given to each other as free variables

Instances

Bounded Rec

Methods

minBound :: Rec

maxBound :: Rec

Enum Rec

Methods

succ :: Rec -> Rec

pred :: Rec -> Rec

toEnum :: Int -> Rec

fromEnum :: Rec -> Int

enumFrom :: Rec -> [Rec]

enumFromThen :: Rec -> Rec -> [Rec]

enumFromTo :: Rec -> Rec -> [Rec]

enumFromThenTo :: Rec -> Rec -> Rec -> [Rec]

Eq Rec

Methods

(==) :: Rec -> Rec -> Bool

(/=) :: Rec -> Rec -> Bool

Ord Rec

Methods

compare :: Rec -> Rec -> Ordering

(<) :: Rec -> Rec -> Bool

(<=) :: Rec -> Rec -> Bool

(>) :: Rec -> Rec -> Bool

(>=) :: Rec -> Rec -> Bool

max :: Rec -> Rec -> Rec

min :: Rec -> Rec -> Rec

Show Rec

Methods

showsPrec :: Int -> Rec -> ShowS

show :: Rec -> String

showList :: [Rec] -> ShowS

Generic Rec

Associated Types

type Rep Rec :: * -> *

Methods

from :: Rec -> Rep Rec x

to :: Rep Rec x -> Rec

Lift Rec

Methods

lift :: Rec -> Q Exp

NFData Rec

Methods

rnf :: Rec -> ()

PrettyStgi Rec

Methods

prettyStgi :: Rec -> Doc StgiAnn

type Rep Rec

type Rep Rec = D1 (MetaData "Rec" "Stg.Language" "stgi-1.1-LT0PoB9W7KUFnIHxeV3rhx" False) ((:+:) (C1 (MetaCons "NonRecursive" PrefixI False) U1) (C1 (MetaCons "Recursive" PrefixI False) U1))

data Expr

An expression in the STG language.

Constructors

Let !Rec !Binds !Expr

Let expression let(rec) ... in ...

Case !Expr !Alts

Case expression case ... of ... x -> y

AppF !Var ![Atom]

Function application f x y z

AppC !Constr ![Atom]

Saturated constructor application Just a

AppP !PrimOp !Atom !Atom

Primitive function application + 2#

LitE !Literal

Literal expression 1#

Instances

Eq Expr

Methods

(==) :: Expr -> Expr -> Bool

(/=) :: Expr -> Expr -> Bool

Ord Expr

Methods

compare :: Expr -> Expr -> Ordering

(<) :: Expr -> Expr -> Bool

(<=) :: Expr -> Expr -> Bool

(>) :: Expr -> Expr -> Bool

(>=) :: Expr -> Expr -> Bool

max :: Expr -> Expr -> Expr

min :: Expr -> Expr -> Expr

Show Expr

Methods

showsPrec :: Int -> Expr -> ShowS

show :: Expr -> String

showList :: [Expr] -> ShowS

Generic Expr

Associated Types

type Rep Expr :: * -> *

Methods

from :: Expr -> Rep Expr x

to :: Rep Expr x -> Expr

Lift Expr

Methods

lift :: Expr -> Q Exp

NFData Expr

Methods

rnf :: Expr -> ()

PrettyStgi Expr

Methods

prettyStgi :: Expr -> Doc StgiAnn

FreeVariables Expr

Methods

freeVariables :: Expr -> Set Var

type Rep Expr

type Rep Expr = D1 (MetaData "Expr" "Stg.Language" "stgi-1.1-LT0PoB9W7KUFnIHxeV3rhx" False) ((:+:) ((:+:) (C1 (MetaCons "Let" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Rec)) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Binds)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Expr))))) ((:+:) (C1 (MetaCons "Case" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Expr)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Alts)))) (C1 (MetaCons "AppF" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Var)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Atom])))))) ((:+:) (C1 (MetaCons "AppC" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Constr)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Atom])))) ((:+:) (C1 (MetaCons "AppP" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PrimOp)) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Atom)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Atom))))) (C1 (MetaCons "LitE" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Literal))))))

data Alts

List of possible alternatives in a Case expression.

The list of alts has to be homogeneous. This is not ensured by the type system, and should be handled by the parser instead.

Constructors

Alts !NonDefaultAlts !DefaultAlt

Instances

Eq Alts

Methods

(==) :: Alts -> Alts -> Bool

(/=) :: Alts -> Alts -> Bool

Ord Alts

Methods

compare :: Alts -> Alts -> Ordering

(<) :: Alts -> Alts -> Bool

(<=) :: Alts -> Alts -> Bool

(>) :: Alts -> Alts -> Bool

(>=) :: Alts -> Alts -> Bool

max :: Alts -> Alts -> Alts

min :: Alts -> Alts -> Alts

Show Alts

Methods

showsPrec :: Int -> Alts -> ShowS

show :: Alts -> String

showList :: [Alts] -> ShowS

Generic Alts

Associated Types

type Rep Alts :: * -> *

Methods

from :: Alts -> Rep Alts x

to :: Rep Alts x -> Alts

Lift Alts

Methods

lift :: Alts -> Q Exp

NFData Alts

Methods

rnf :: Alts -> ()

PrettyStgi Alts

Methods

prettyStgi :: Alts -> Doc StgiAnn

FreeVariables Alts

Methods

freeVariables :: Alts -> Set Var

type Rep Alts

type Rep Alts = D1 (MetaData "Alts" "Stg.Language" "stgi-1.1-LT0PoB9W7KUFnIHxeV3rhx" False) (C1 (MetaCons "Alts" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 NonDefaultAlts)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 DefaultAlt))))

data NonDefaultAlts

The part of a Case alternative that's not the default.

Constructors

NoNonDefaultAlts

Used in 'case' statements that consist only of a default alternative. These can be useful to force or unpack values.

AlgebraicAlts !(NonEmpty AlgebraicAlt)

Algebraic alternative, like Cons x xs.

PrimitiveAlts !(NonEmpty PrimitiveAlt)

Primitive alternative, like 1#.

Instances

Eq NonDefaultAlts

Methods

(==) :: NonDefaultAlts -> NonDefaultAlts -> Bool

(/=) :: NonDefaultAlts -> NonDefaultAlts -> Bool

Ord NonDefaultAlts

Methods

compare :: NonDefaultAlts -> NonDefaultAlts -> Ordering

(<) :: NonDefaultAlts -> NonDefaultAlts -> Bool

(<=) :: NonDefaultAlts -> NonDefaultAlts -> Bool

(>) :: NonDefaultAlts -> NonDefaultAlts -> Bool

(>=) :: NonDefaultAlts -> NonDefaultAlts -> Bool

max :: NonDefaultAlts -> NonDefaultAlts -> NonDefaultAlts

min :: NonDefaultAlts -> NonDefaultAlts -> NonDefaultAlts

Show NonDefaultAlts

Methods

showsPrec :: Int -> NonDefaultAlts -> ShowS

show :: NonDefaultAlts -> String

showList :: [NonDefaultAlts] -> ShowS

Generic NonDefaultAlts

Associated Types

type Rep NonDefaultAlts :: * -> *

Methods

from :: NonDefaultAlts -> Rep NonDefaultAlts x

to :: Rep NonDefaultAlts x -> NonDefaultAlts

Lift NonDefaultAlts

Methods

lift :: NonDefaultAlts -> Q Exp

NFData NonDefaultAlts

Methods

rnf :: NonDefaultAlts -> ()

FreeVariables NonDefaultAlts

Methods

freeVariables :: NonDefaultAlts -> Set Var

type Rep NonDefaultAlts

type Rep NonDefaultAlts = D1 (MetaData "NonDefaultAlts" "Stg.Language" "stgi-1.1-LT0PoB9W7KUFnIHxeV3rhx" False) ((:+:) (C1 (MetaCons "NoNonDefaultAlts" PrefixI False) U1) ((:+:) (C1 (MetaCons "AlgebraicAlts" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (NonEmpty AlgebraicAlt)))) (C1 (MetaCons "PrimitiveAlts" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (NonEmpty PrimitiveAlt))))))

data AlgebraicAlt

As in True | False

Constructors

AlgebraicAlt !Constr ![Var] !Expr

Instances

Eq AlgebraicAlt

Methods

(==) :: AlgebraicAlt -> AlgebraicAlt -> Bool

(/=) :: AlgebraicAlt -> AlgebraicAlt -> Bool

Ord AlgebraicAlt

Methods

compare :: AlgebraicAlt -> AlgebraicAlt -> Ordering

(<) :: AlgebraicAlt -> AlgebraicAlt -> Bool

(<=) :: AlgebraicAlt -> AlgebraicAlt -> Bool

(>) :: AlgebraicAlt -> AlgebraicAlt -> Bool

(>=) :: AlgebraicAlt -> AlgebraicAlt -> Bool

max :: AlgebraicAlt -> AlgebraicAlt -> AlgebraicAlt

min :: AlgebraicAlt -> AlgebraicAlt -> AlgebraicAlt

Show AlgebraicAlt

Methods

showsPrec :: Int -> AlgebraicAlt -> ShowS

show :: AlgebraicAlt -> String

showList :: [AlgebraicAlt] -> ShowS

Generic AlgebraicAlt

Associated Types

type Rep AlgebraicAlt :: * -> *

Methods

from :: AlgebraicAlt -> Rep AlgebraicAlt x

to :: Rep AlgebraicAlt x -> AlgebraicAlt

Lift AlgebraicAlt

Methods

lift :: AlgebraicAlt -> Q Exp

NFData AlgebraicAlt

Methods

rnf :: AlgebraicAlt -> ()

PrettyStgi AlgebraicAlt

Methods

prettyStgi :: AlgebraicAlt -> Doc StgiAnn

FreeVariables AlgebraicAlt

Methods

freeVariables :: AlgebraicAlt -> Set Var

type Rep AlgebraicAlt

type Rep AlgebraicAlt = D1 (MetaData "AlgebraicAlt" "Stg.Language" "stgi-1.1-LT0PoB9W7KUFnIHxeV3rhx" False) (C1 (MetaCons "AlgebraicAlt" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Constr)) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Var])) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Expr)))))

data PrimitiveAlt

As in 1#, 2#, 3#

Constructors

PrimitiveAlt !Literal !Expr

Instances

Eq PrimitiveAlt

Methods

(==) :: PrimitiveAlt -> PrimitiveAlt -> Bool

(/=) :: PrimitiveAlt -> PrimitiveAlt -> Bool

Ord PrimitiveAlt

Methods

compare :: PrimitiveAlt -> PrimitiveAlt -> Ordering

(<) :: PrimitiveAlt -> PrimitiveAlt -> Bool

(<=) :: PrimitiveAlt -> PrimitiveAlt -> Bool

(>) :: PrimitiveAlt -> PrimitiveAlt -> Bool

(>=) :: PrimitiveAlt -> PrimitiveAlt -> Bool

max :: PrimitiveAlt -> PrimitiveAlt -> PrimitiveAlt

min :: PrimitiveAlt -> PrimitiveAlt -> PrimitiveAlt

Show PrimitiveAlt

Methods

showsPrec :: Int -> PrimitiveAlt -> ShowS

show :: PrimitiveAlt -> String

showList :: [PrimitiveAlt] -> ShowS

Generic PrimitiveAlt

Associated Types

type Rep PrimitiveAlt :: * -> *

Methods

from :: PrimitiveAlt -> Rep PrimitiveAlt x

to :: Rep PrimitiveAlt x -> PrimitiveAlt

Lift PrimitiveAlt

Methods

lift :: PrimitiveAlt -> Q Exp

NFData PrimitiveAlt

Methods

rnf :: PrimitiveAlt -> ()

PrettyStgi PrimitiveAlt

Methods

prettyStgi :: PrimitiveAlt -> Doc StgiAnn

FreeVariables PrimitiveAlt

Methods

freeVariables :: PrimitiveAlt -> Set Var

type Rep PrimitiveAlt

type Rep PrimitiveAlt = D1 (MetaData "PrimitiveAlt" "Stg.Language" "stgi-1.1-LT0PoB9W7KUFnIHxeV3rhx" False) (C1 (MetaCons "PrimitiveAlt" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Literal)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Expr))))

data DefaultAlt

If no viable alternative is found in a pattern match, use a DefaultAlt as fallback.

Constructors

DefaultNotBound !Expr

DefaultBound !Var !Expr

Instances

Eq DefaultAlt

Methods

(==) :: DefaultAlt -> DefaultAlt -> Bool

(/=) :: DefaultAlt -> DefaultAlt -> Bool

Ord DefaultAlt

Methods

compare :: DefaultAlt -> DefaultAlt -> Ordering

(<) :: DefaultAlt -> DefaultAlt -> Bool

(<=) :: DefaultAlt -> DefaultAlt -> Bool

(>) :: DefaultAlt -> DefaultAlt -> Bool

(>=) :: DefaultAlt -> DefaultAlt -> Bool

max :: DefaultAlt -> DefaultAlt -> DefaultAlt

min :: DefaultAlt -> DefaultAlt -> DefaultAlt

Show DefaultAlt

Methods

showsPrec :: Int -> DefaultAlt -> ShowS

show :: DefaultAlt -> String

showList :: [DefaultAlt] -> ShowS

Generic DefaultAlt

Associated Types

type Rep DefaultAlt :: * -> *

Methods

from :: DefaultAlt -> Rep DefaultAlt x

to :: Rep DefaultAlt x -> DefaultAlt

Lift DefaultAlt

Methods

lift :: DefaultAlt -> Q Exp

NFData DefaultAlt

Methods

rnf :: DefaultAlt -> ()

PrettyStgi DefaultAlt

Methods

prettyStgi :: DefaultAlt -> Doc StgiAnn

FreeVariables DefaultAlt

Methods

freeVariables :: DefaultAlt -> Set Var

type Rep DefaultAlt

type Rep DefaultAlt = D1 (MetaData "DefaultAlt" "Stg.Language" "stgi-1.1-LT0PoB9W7KUFnIHxeV3rhx" False) ((:+:) (C1 (MetaCons "DefaultNotBound" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Expr))) (C1 (MetaCons "DefaultBound" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Var)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Expr)))))

newtype Literal

Literals are the basis of primitive operations.

Constructors

Literal Integer

Instances

Eq Literal

Methods

(==) :: Literal -> Literal -> Bool

(/=) :: Literal -> Literal -> Bool

Ord Literal

Methods

compare :: Literal -> Literal -> Ordering

(<) :: Literal -> Literal -> Bool

(<=) :: Literal -> Literal -> Bool

(>) :: Literal -> Literal -> Bool

(>=) :: Literal -> Literal -> Bool

max :: Literal -> Literal -> Literal

min :: Literal -> Literal -> Literal

Show Literal

Methods

showsPrec :: Int -> Literal -> ShowS

show :: Literal -> String

showList :: [Literal] -> ShowS

Generic Literal

Associated Types

type Rep Literal :: * -> *

Methods

from :: Literal -> Rep Literal x

to :: Rep Literal x -> Literal

Lift Literal

Methods

lift :: Literal -> Q Exp

NFData Literal

Methods

rnf :: Literal -> ()

PrettyStgi Literal

Methods

prettyStgi :: Literal -> Doc StgiAnn

FreeVariables Literal

Methods

freeVariables :: Literal -> Set Var

type Rep Literal

type Rep Literal = D1 (MetaData "Literal" "Stg.Language" "stgi-1.1-LT0PoB9W7KUFnIHxeV3rhx" True) (C1 (MetaCons "Literal" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Integer)))

data PrimOp

Primitive operations.

Constructors

Add

+

Sub

-

Mul

*

Div

/

Mod

%

Eq

==

Lt

<

Leq

<=

Gt

>

Geq

>=

Neq

/=

Instances

Bounded PrimOp

Methods

minBound :: PrimOp

maxBound :: PrimOp

Enum PrimOp

Methods

succ :: PrimOp -> PrimOp

pred :: PrimOp -> PrimOp

toEnum :: Int -> PrimOp

fromEnum :: PrimOp -> Int

enumFrom :: PrimOp -> [PrimOp]

enumFromThen :: PrimOp -> PrimOp -> [PrimOp]

enumFromTo :: PrimOp -> PrimOp -> [PrimOp]

enumFromThenTo :: PrimOp -> PrimOp -> PrimOp -> [PrimOp]

Eq PrimOp

Methods

(==) :: PrimOp -> PrimOp -> Bool

(/=) :: PrimOp -> PrimOp -> Bool

Ord PrimOp

Methods

compare :: PrimOp -> PrimOp -> Ordering

(<) :: PrimOp -> PrimOp -> Bool

(<=) :: PrimOp -> PrimOp -> Bool

(>) :: PrimOp -> PrimOp -> Bool

(>=) :: PrimOp -> PrimOp -> Bool

max :: PrimOp -> PrimOp -> PrimOp

min :: PrimOp -> PrimOp -> PrimOp

Show PrimOp

Methods

showsPrec :: Int -> PrimOp -> ShowS

show :: PrimOp -> String

showList :: [PrimOp] -> ShowS

Generic PrimOp

Associated Types

type Rep PrimOp :: * -> *

Methods

from :: PrimOp -> Rep PrimOp x

to :: Rep PrimOp x -> PrimOp

Lift PrimOp

Methods

lift :: PrimOp -> Q Exp

NFData PrimOp

Methods

rnf :: PrimOp -> ()

PrettyStgi PrimOp

Methods

prettyStgi :: PrimOp -> Doc StgiAnn

type Rep PrimOp

type Rep PrimOp = D1 (MetaData "PrimOp" "Stg.Language" "stgi-1.1-LT0PoB9W7KUFnIHxeV3rhx" False) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "Add" PrefixI False) U1) (C1 (MetaCons "Sub" PrefixI False) U1)) ((:+:) (C1 (MetaCons "Mul" PrefixI False) U1) ((:+:) (C1 (MetaCons "Div" PrefixI False) U1) (C1 (MetaCons "Mod" PrefixI False) U1)))) ((:+:) ((:+:) (C1 (MetaCons "Eq" PrefixI False) U1) ((:+:) (C1 (MetaCons "Lt" PrefixI False) U1) (C1 (MetaCons "Leq" PrefixI False) U1))) ((:+:) (C1 (MetaCons "Gt" PrefixI False) U1) ((:+:) (C1 (MetaCons "Geq" PrefixI False) U1) (C1 (MetaCons "Neq" PrefixI False) U1)))))

newtype Var

Variable.

Constructors

Var Text

Instances

Eq Var

Methods

(==) :: Var -> Var -> Bool

(/=) :: Var -> Var -> Bool

Ord Var

Methods

compare :: Var -> Var -> Ordering

(<) :: Var -> Var -> Bool

(<=) :: Var -> Var -> Bool

(>) :: Var -> Var -> Bool

(>=) :: Var -> Var -> Bool

max :: Var -> Var -> Var

min :: Var -> Var -> Var

Show Var

Methods

showsPrec :: Int -> Var -> ShowS

show :: Var -> String

showList :: [Var] -> ShowS

IsString Var

Methods

fromString :: String -> Var

Generic Var

Associated Types

type Rep Var :: * -> *

Methods

from :: Var -> Rep Var x

to :: Rep Var x -> Var

Lift Var

Methods

lift :: Var -> Q Exp

NFData Var

Methods

rnf :: Var -> ()

PrettyStgi Var

Methods

prettyStgi :: Var -> Doc StgiAnn

FreeVariables Var

Methods

freeVariables :: Var -> Set Var

type Rep Var

type Rep Var = D1 (MetaData "Var" "Stg.Language" "stgi-1.1-LT0PoB9W7KUFnIHxeV3rhx" True) (C1 (MetaCons "Var" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data Atom

Smallest unit of data. Atoms unify variables and literals, and are what functions take as arguments.

Constructors

AtomVar !Var

AtomLit !Literal

Instances

Eq Atom

Methods

(==) :: Atom -> Atom -> Bool

(/=) :: Atom -> Atom -> Bool

Ord Atom

Methods

compare :: Atom -> Atom -> Ordering

(<) :: Atom -> Atom -> Bool

(<=) :: Atom -> Atom -> Bool

(>) :: Atom -> Atom -> Bool

(>=) :: Atom -> Atom -> Bool

max :: Atom -> Atom -> Atom

min :: Atom -> Atom -> Atom

Show Atom

Methods

showsPrec :: Int -> Atom -> ShowS

show :: Atom -> String

showList :: [Atom] -> ShowS

Generic Atom

Associated Types

type Rep Atom :: * -> *

Methods

from :: Atom -> Rep Atom x

to :: Rep Atom x -> Atom

Lift Atom

Methods

lift :: Atom -> Q Exp

NFData Atom

Methods

rnf :: Atom -> ()

PrettyStgi Atom

Methods

prettyStgi :: Atom -> Doc StgiAnn

FreeVariables Atom

Methods

freeVariables :: Atom -> Set Var

type Rep Atom

type Rep Atom = D1 (MetaData "Atom" "Stg.Language" "stgi-1.1-LT0PoB9W7KUFnIHxeV3rhx" False) ((:+:) (C1 (MetaCons "AtomVar" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Var))) (C1 (MetaCons "AtomLit" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Literal))))

newtype Constr

Constructors of algebraic data types.

Constructors

Constr Text

Instances

Eq Constr

Methods

(==) :: Constr -> Constr -> Bool

(/=) :: Constr -> Constr -> Bool

Ord Constr

Methods

compare :: Constr -> Constr -> Ordering

(<) :: Constr -> Constr -> Bool

(<=) :: Constr -> Constr -> Bool

(>) :: Constr -> Constr -> Bool

(>=) :: Constr -> Constr -> Bool

max :: Constr -> Constr -> Constr

min :: Constr -> Constr -> Constr

Show Constr

Methods

showsPrec :: Int -> Constr -> ShowS

show :: Constr -> String

showList :: [Constr] -> ShowS

IsString Constr

Methods

fromString :: String -> Constr

Generic Constr

Associated Types

type Rep Constr :: * -> *

Methods

from :: Constr -> Rep Constr x

to :: Rep Constr x -> Constr

Lift Constr

Methods

lift :: Constr -> Q Exp

NFData Constr

Methods

rnf :: Constr -> ()

PrettyStgi Constr

Methods

prettyStgi :: Constr -> Doc StgiAnn

type Rep Constr

type Rep Constr = D1 (MetaData "Constr" "Stg.Language" "stgi-1.1-LT0PoB9W7KUFnIHxeV3rhx" True) (C1 (MetaCons "Constr" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

class Pretty a where

Overloaded conversion to Doc.

Laws:

1. output should be pretty. :-)

Minimal complete definition

pretty

Methods

pretty :: a -> Doc ann

>>> pretty 1 <+> pretty "hello" <+> pretty 1.234
1 hello 1.234

prettyList :: [a] -> Doc ann

prettyList is only used to define the instance Pretty a => Pretty [a]. In normal circumstances only the pretty function is used.

>>> prettyList [1, 23, 456]
[1, 23, 456]

Instances

Pretty Bool

>>> pretty True
True

Methods

pretty :: Bool -> Doc ann

prettyList :: [Bool] -> Doc ann

Pretty Char

Instead of (pretty '\n'), consider using line as a more readable alternative.

>>> pretty 'f' <> pretty 'o' <> pretty 'o'
foo
>>> pretty ("string" :: String)
string

Methods

pretty :: Char -> Doc ann

prettyList :: [Char] -> Doc ann

Pretty Double

>>> pretty (exp 1 :: Double)
2.718281828459045

Methods

pretty :: Double -> Doc ann

prettyList :: [Double] -> Doc ann

Pretty Float

>>> pretty (pi :: Float)
3.1415927

Methods

pretty :: Float -> Doc ann

prettyList :: [Float] -> Doc ann

Pretty Int

>>> pretty (123 :: Int)
123

Methods

pretty :: Int -> Doc ann

prettyList :: [Int] -> Doc ann

Pretty Int8

Methods

pretty :: Int8 -> Doc ann

prettyList :: [Int8] -> Doc ann

Pretty Int16

Methods

pretty :: Int16 -> Doc ann

prettyList :: [Int16] -> Doc ann

Pretty Int32

Methods

pretty :: Int32 -> Doc ann

prettyList :: [Int32] -> Doc ann

Pretty Int64

Methods

pretty :: Int64 -> Doc ann

prettyList :: [Int64] -> Doc ann

Pretty Integer

>>> pretty (2^123 :: Integer)
10633823966279326983230456482242756608

Methods

pretty :: Integer -> Doc ann

prettyList :: [Integer] -> Doc ann

Pretty Word

Methods

pretty :: Word -> Doc ann

prettyList :: [Word] -> Doc ann

Pretty Word8

Methods

pretty :: Word8 -> Doc ann

prettyList :: [Word8] -> Doc ann

Pretty Word16

Methods

pretty :: Word16 -> Doc ann

prettyList :: [Word16] -> Doc ann

Pretty Word32

Methods

pretty :: Word32 -> Doc ann

prettyList :: [Word32] -> Doc ann

Pretty Word64

Methods

pretty :: Word64 -> Doc ann

prettyList :: [Word64] -> Doc ann

Pretty ()

>>> pretty ()
()

The argument is not used,

>>> pretty (error "Strict?" :: ())
()

Methods

pretty :: () -> Doc ann

prettyList :: [()] -> Doc ann

Pretty Text

(lazy Text instance, identical to the strict version)

Methods

pretty :: Text -> Doc ann

prettyList :: [Text] -> Doc ann

Pretty Text

Automatically converts all newlines to line.

>>> pretty ("hello\nworld" :: Text)
hello
world

Note that line can be undone by group:

>>> group (pretty ("hello\nworld" :: Text))
hello world

Manually use hardline if you definitely want newlines.

Methods

pretty :: Text -> Doc ann

prettyList :: [Text] -> Doc ann

Pretty Natural

Methods

pretty :: Natural -> Doc ann

prettyList :: [Natural] -> Doc ann

Pretty Void

Finding a good example for printing something that does not exist is hard, so here is an example of printing a list full of nothing.

>>> pretty ([] :: [Void])
[]

Methods

pretty :: Void -> Doc ann

prettyList :: [Void] -> Doc ann

Pretty a => Pretty [a]

>>> pretty [1,2,3]
[1, 2, 3]

Methods

pretty :: [a] -> Doc ann

prettyList :: [[a]] -> Doc ann

Pretty a => Pretty (Maybe a)

Ignore Nothings, print Just contents.

>>> pretty (Just True)
True
>>> braces (pretty (Nothing :: Maybe Bool))
{}

>>> pretty [Just 1, Nothing, Just 3, Nothing]
[1, 3]

Methods

pretty :: Maybe a -> Doc ann

prettyList :: [Maybe a] -> Doc ann

Pretty a => Pretty (NonEmpty a)

Methods

pretty :: NonEmpty a -> Doc ann

prettyList :: [NonEmpty a] -> Doc ann

(Pretty a1, Pretty a2) => Pretty (a1, a2)

>>> pretty (123, "hello")
(123, hello)

Methods

pretty :: (a1, a2) -> Doc ann

prettyList :: [(a1, a2)] -> Doc ann

(Pretty a1, Pretty a2, Pretty a3) => Pretty (a1, a2, a3)

>>> pretty (123, "hello", False)
(123, hello, False)

Methods

pretty :: (a1, a2, a3) -> Doc ann

prettyList :: [(a1, a2, a3)] -> Doc ann

Meta information

classify :: LambdaForm -> LambdaType

Classify the type of a lambda form based on its shape.

data LambdaType

Possible classification of lambda forms.

Constructors

LambdaCon

Data constructor (AppC as body)

LambdaFun

Function (lambda with non-empty argument list)

LambdaThunk

Thunk (everything else)

Instances

Eq LambdaType

Methods

(==) :: LambdaType -> LambdaType -> Bool

(/=) :: LambdaType -> LambdaType -> Bool

Ord LambdaType

Methods

compare :: LambdaType -> LambdaType -> Ordering

(<) :: LambdaType -> LambdaType -> Bool

(<=) :: LambdaType -> LambdaType -> Bool

(>) :: LambdaType -> LambdaType -> Bool

(>=) :: LambdaType -> LambdaType -> Bool

max :: LambdaType -> LambdaType -> LambdaType

min :: LambdaType -> LambdaType -> LambdaType

Show LambdaType

Methods

showsPrec :: Int -> LambdaType -> ShowS

show :: LambdaType -> String

showList :: [LambdaType] -> ShowS

PrettyStgi LambdaType

Methods

prettyStgi :: LambdaType -> Doc StgiAnn