ghc-6.12.3: The GHC API Source code Contents Index

CoreUnfold

Synopsis

data Unfolding data UnfoldingGuidance noUnfolding :: Unfolding mkTopUnfolding :: CoreExpr -> Unfolding mkImplicitUnfolding :: CoreExpr -> Unfolding mkUnfolding :: Bool -> CoreExpr -> Unfolding mkCompulsoryUnfolding :: CoreExpr -> Unfolding seqUnfolding :: Unfolding -> () evaldUnfolding :: Unfolding mkOtherCon :: [AltCon] -> Unfolding otherCons :: Unfolding -> [AltCon] unfoldingTemplate :: Unfolding -> CoreExpr maybeUnfoldingTemplate :: Unfolding -> Maybe CoreExpr isEvaldUnfolding :: Unfolding -> Bool isValueUnfolding :: Unfolding -> Bool isExpandableUnfolding :: Unfolding -> Bool isCompulsoryUnfolding :: Unfolding -> Bool hasUnfolding :: Unfolding -> Bool hasSomeUnfolding :: Unfolding -> Bool neverUnfold :: Unfolding -> Bool interestingArg :: CoreExpr -> ArgSummary data ArgSummary = TrivArg | NonTrivArg | ValueArg couldBeSmallEnoughToInline :: Int -> CoreExpr -> Bool certainlyWillInline :: Unfolding -> Bool smallEnoughToInline :: Unfolding -> Bool callSiteInline :: DynFlags -> Bool -> Id -> Bool -> [ArgSummary] -> CallCtxt -> Maybe CoreExpr data CallCtxt = BoringCtxt | ArgCtxt Bool Int | ValAppCtxt | CaseCtxt

Documentation

data Unfolding Source

Records the unfolding of an identifier, which is approximately the form the identifier would have if we substituted its definition in for the identifier. This type should be treated as abstract everywhere except in CoreUnfold Instances Outputable Unfolding

data UnfoldingGuidance Source

When unfolding should take place Instances Outputable UnfoldingGuidance

noUnfolding :: Unfolding Source

There is no known Unfolding

mkTopUnfolding :: CoreExpr -> Unfolding Source

mkImplicitUnfolding :: CoreExpr -> Unfolding Source

mkUnfolding :: Bool -> CoreExpr -> Unfolding Source

mkCompulsoryUnfolding :: CoreExpr -> Unfolding Source

seqUnfolding :: Unfolding -> () Source

evaldUnfolding :: Unfolding Source

This unfolding marks the associated thing as being evaluated

mkOtherCon :: [AltCon] -> Unfolding Source

otherCons :: Unfolding -> [AltCon] Source

The constructors that the unfolding could never be: returns [] if no information is available

unfoldingTemplate :: Unfolding -> CoreExpr Source

Retrieves the template of an unfolding: panics if none is known

maybeUnfoldingTemplate :: Unfolding -> Maybe CoreExpr Source

Retrieves the template of an unfolding if possible

isEvaldUnfolding :: Unfolding -> Bool Source

Determines if it possibly the case that the unfolding will yield a value. Unlike isValueUnfolding it returns True for OtherCon

isValueUnfolding :: Unfolding -> Bool Source

Determines if it is certainly the case that the unfolding will yield a value (something in HNF): returns False if unsure

isExpandableUnfolding :: Unfolding -> Bool Source

isCompulsoryUnfolding :: Unfolding -> Bool Source

Must this unfolding happen for the code to be executable?

hasUnfolding :: Unfolding -> Bool Source

Do we have an available or compulsory unfolding?

hasSomeUnfolding :: Unfolding -> Bool Source

Only returns False if there is no unfolding information available at all

neverUnfold :: Unfolding -> Bool Source

Similar to not . hasUnfolding, but also returns True if it has an unfolding that says it should never occur

interestingArg :: CoreExpr -> ArgSummary Source

data ArgSummary Source

Constructors TrivArg NonTrivArg ValueArg Instances Outputable ArgSummary

couldBeSmallEnoughToInline :: Int -> CoreExpr -> Bool Source

certainlyWillInline :: Unfolding -> Bool Source

smallEnoughToInline :: Unfolding -> Bool Source

callSiteInline :: DynFlags -> Bool -> Id -> Bool -> [ArgSummary] -> CallCtxt -> Maybe CoreExpr Source

data CallCtxt Source

Constructors BoringCtxt ArgCtxt Bool Int ValAppCtxt CaseCtxt Instances Outputable CallCtxt

Produced by Haddock version 2.6.1