Skip to content

HORIZON HASKELL Docs lts/ghc-10.0.xaa25b892026-10-10Search names, modules, packages, or :: a typeCtrl K

GHC 10.0.0.20260917 · lts/ghc-10.0.x · aa25b89 · 2026-10-10

Moduleghc-10.0.0.20260917GHC2024

GHC.Types.InlinePragma

10 types
45 values

Packageghc-10.0.0.20260917
Exports56
LanguageGHC2024
LicenceBSD-3-Clause
SourceInlinePragma.hs

Inline Pragma Encoding

0 declarations

InlinePragma

Data-type

datadata InlinePragma pass

Constructors

InlinePragma
- inl_ext :: !XInlinePragma pass
- inl_inline :: !InlineSpec
- inl_act :: !Activation pass
- inl_rule :: !RuleMatchInfo
XInlinePragma !(XXInlinePragma pass)

Instances7Eq, Data, NFData, Outputable, Binary, …

(Eq (XXActivation pass), Eq (XInlinePragma pass), Eq (XXInlinePragma pass)) => Eq (InlinePragma pass)Defined in ghc-10.0.0.20260917 · Language.Haskell.Syntax.Binds.InlinePragma
Data (InlinePragma GhcPs)Defined in ghc-10.0.0.20260917 · GHC.Hs.Instances · orphan
Data (InlinePragma GhcRn)Defined in ghc-10.0.0.20260917 · GHC.Hs.Instances · orphan
Data (InlinePragma GhcTc)Defined in ghc-10.0.0.20260917 · GHC.Hs.Instances · orphan
(NFData (XInlinePragma p), NFData (XXInlinePragma p), NFData (XXActivation p)) => NFData (InlinePragma p)Defined in ghc-10.0.0.20260917 · Language.Haskell.Syntax.Binds.InlinePragma
IsPass p => Outputable (InlinePragma (GhcPass p))Defined in ghc-10.0.0.20260917 · GHC.Types.InlinePragma · orphan
IsPass p => Binary (InlinePragma (GhcPass p))Defined in ghc-10.0.0.20260917 · GHC.Types.InlinePragma · orphan

typetype InlinePragmaInfo = InlinePragma GhcTc

Inline Pragma Information

Tells when the inlining is active. When it is active the thing may be inlined, depending on how big it is.

If there was an INLINE pragma, then as a separate matter, the RHS will have been made to look small with a Core inline Note

The default InlinePragInfo is AlwaysActive, so the info serves entirely as a way to inhibit inlining until we want it

Constants

valuedefaultInlinePragma :: IsPass p => InlinePragma (GhcPass p)

The default InlinePragma definition for GHC. The type and value of inl_ext provided will differ between the passes of GHC. Consequently, it may be necessary to apply type annotation at the call site to help the type checker disambiguate the correct type of inl_ext.

valuealwaysConLikePragma :: IsPass p => InlinePragma (GhcPass p)

The default InlinePragma definition for the "parser pass" of GHC.

valuealwaysInlinePragma :: IsPass p => InlinePragma (GhcPass p)

The default InlinePragma definition for the "parser pass" of GHC.

valuealwaysInlineConLikePragma :: IsPass p => InlinePragma (GhcPass p)

The default InlinePragma definition for the "parser pass" of GHC.

valuedfunInlinePragma :: IsPass p => InlinePragma (GhcPass p)

The default InlinePragma definition for the "parser pass" of GHC.

valueneverInlinePragma :: IsPass p => InlinePragma (GhcPass p)

The default InlinePragma definition for the "parser pass" of GHC.

Field accessors

valueinlinePragmaActivation :: InlinePragma (GhcPass p) -> ActivationGhc

valueinlinePragmaSaturation

:: XInlinePragma (GhcPass p) ~ XInlinePragmaGhc
=> InlinePragma (GhcPass p)
-> InlineSaturation

valueinlinePragmaName :: InlineSpec -> SDoc

Outputs string for pragma name for any of INLINEINLINABLENOINLINE. This differs from the Outputable instance for the InlineSpec type where the pragma name string as well as the accompanying SourceText (if any) is printed.

valueinlinePragmaRuleMatchInfo :: InlinePragma (GhcPass p) -> RuleMatchInfo

valueinlinePragmaSource :: IsPass p => InlinePragma (GhcPass p) -> SourceText

valueinlinePragmaSpec :: InlinePragma (GhcPass p) -> InlineSpec

Queries

valueisAnyInlinePragma :: InlinePragma p -> Bool

valueisDefaultInlinePragma :: InlinePragma (GhcPass p) -> Bool

valueisInlinablePragma :: InlinePragma p -> Bool

valueisInlinePragma :: InlinePragma p -> Bool

valueisNoInlinePragma :: InlinePragma p -> Bool

valueisOpaquePragma :: InlinePragma p -> Bool

Mutators

valuesetInlinePragmaSource

valuesetInlinePragmaSaturation

:: (IsPass p, XInlinePragma (GhcPass q) ~ XInlinePragmaGhc)
=> InlinePragma (GhcPass p)
-> InlineSaturation
-> InlinePragma (GhcPass q)

valuesetInlinePragmaActivation

valuesetInlinePragmaSpec

valuesetInlinePragmaRuleMatchInfo

GHC pass conversions

valuetcInlinePragma :: InlinePragma GhcRn -> InlinePragma GhcTc

Pretty-printing

valuepprInline :: IsPass p => InlinePragma (GhcPass p) -> SDoc

Pretty-print without displaying the user-specified InlineSpec.

valuepprInlineDebug :: IsPass p => InlinePragma (GhcPass p) -> SDoc

Pretty-print including the user-specified InlineSpec.

Extensible record type for GhcRn & GhcTc

datadata XInlinePragmaGhc

Constructors

XInlinePragmaGhc
- xinl_src :: SourceText
  See Note [Pragma source text]
- xinl_sat :: InlineSaturation
  Inline only when applied to n explicit (non-type, non-dictionary) arguments.
  That is, xinl_sat describes the number of *source-code* arguments the thing must be applied to. We add on the number of implicit, dictionary arguments when making the Unfolding, and don't look at inl_sat further

Instances4Eq, Data, NFData, Binary

Eq XInlinePragmaGhcDefined in ghc-10.0.0.20260917 · GHC.Types.InlinePragma
Data XInlinePragmaGhcDefined in ghc-10.0.0.20260917 · GHC.Types.InlinePragma
NFData XInlinePragmaGhcDefined in ghc-10.0.0.20260917 · GHC.Types.InlinePragma
Binary XInlinePragmaGhcDefined in ghc-10.0.0.20260917 · GHC.Types.InlinePragma

datadata InlineSaturation

The arity at which to inline a function. This may differ from the function's syntactic arity.

Constructors

AppliedToAtLeast !Arity
Inline only when applied to n explicit (non-type, non-dictionary) arguments.
That is, AppliedToAtLeast describes the number of *source-code* arguments the thing must be applied to.
AnySaturation
There does not exist an explicit number of arguments that the inlining process should be applied to.

Instances4Eq, Data, NFData, Binary

Eq InlineSaturationDefined in ghc-10.0.0.20260917 · GHC.Types.InlinePragma
Data InlineSaturationDefined in ghc-10.0.0.20260917 · GHC.Types.InlinePragma
NFData InlineSaturationDefined in ghc-10.0.0.20260917 · GHC.Types.InlinePragma
Binary InlineSaturationDefined in ghc-10.0.0.20260917 · GHC.Types.InlinePragma

InlineSpec

Data-type

datadata InlineSpec

Inline Specification

Inline Inlinable NoInline Opaque NoUserInlinePrag

Instances6Eq, Data, Show, NFData, Outputable, Binary

Eq InlineSpecDefined in ghc-10.0.0.20260917 · Language.Haskell.Syntax.Binds.InlinePragma
Data InlineSpecDefined in ghc-10.0.0.20260917 · Language.Haskell.Syntax.Binds.InlinePragma
Show InlineSpecDefined in ghc-10.0.0.20260917 · Language.Haskell.Syntax.Binds.InlinePragma
NFData InlineSpecDefined in ghc-10.0.0.20260917 · Language.Haskell.Syntax.Binds.InlinePragma
Outputable InlineSpecDefined in ghc-10.0.0.20260917 · GHC.Utils.Outputable
Binary InlineSpecDefined in ghc-10.0.0.20260917 · GHC.Utils.Binary

Queries

valuenoUserInlineSpec :: InlineSpec -> Bool

RuleMatchInfo

Data-type

datadata RuleMatchInfo

Rule Match Information

ConLike FunLike

Instances6Eq, Data, Show, NFData, Outputable, Binary

Eq RuleMatchInfoDefined in ghc-10.0.0.20260917 · Language.Haskell.Syntax.Binds.InlinePragma
Data RuleMatchInfoDefined in ghc-10.0.0.20260917 · Language.Haskell.Syntax.Binds.InlinePragma
Show RuleMatchInfoDefined in ghc-10.0.0.20260917 · Language.Haskell.Syntax.Binds.InlinePragma
NFData RuleMatchInfoDefined in ghc-10.0.0.20260917 · Language.Haskell.Syntax.Binds.InlinePragma
Outputable RuleMatchInfoDefined in ghc-10.0.0.20260917 · GHC.Utils.Outputable
Binary RuleMatchInfoDefined in ghc-10.0.0.20260917 · GHC.Utils.Binary

Queries

valueisConLike :: RuleMatchInfo -> Bool

valueisFunLike :: RuleMatchInfo -> Bool

Phase Activation

0 declarations

Activation

Data-type

typetype ActivationGhc = ActivationX XXActivationGhc

datadata ActivationX e

An activation is a range of phases throughout which something is active (like an INLINE pragma, SPECIALISE pragma, or RULE).

Constructors

AlwaysActive
ActiveBefore PhaseNum
Active only *strictly before* this phase
ActiveAfter PhaseNum
Active in this phase and later phases
NeverActive
Active in the final phase only

Instances5Data, Binary, Eq, NFData, Outputable

Data ActivationGhcDefined in ghc-10.0.0.20260917 · GHC.Hs.Instances · orphan
Binary ActivationGhcDefined in ghc-10.0.0.20260917 · GHC.Types.InlinePragma
Eq e => Eq (ActivationX e)Defined in ghc-10.0.0.20260917 · Language.Haskell.Syntax.Binds.InlinePragma
NFData e => NFData (ActivationX e)Defined in ghc-10.0.0.20260917 · Language.Haskell.Syntax.Binds.InlinePragma
Outputable (ActivationX p)Defined in ghc-10.0.0.20260917 · GHC.Utils.Outputable

patternpattern ActiveFinal :: Activation (GhcPass p)

typetype PhaseNum = Int

Compilation phase number, as can be written by users in INLINE pragmas, SPECIALISE pragmas, and RULES.

phases decrease towards zero
zero is the last phase

Does not include GHC internal "initial" and "final" phases; see CompilerPhase.

Construction

valueactiveAfter :: CompilerPhase -> ActivationGhc

Constants

valueactivateAfterInitial :: ActivationGhc

Active in the first phase after the initial phase

valueactivateDuringFinal :: ActivationGhc

Active in the final simplification phase (which is repeated)

Queries

valueactiveInFinalPhase :: ActivationGhc -> Bool

valueactiveInInitialPhase :: ActivationGhc -> Bool

valueactiveInPhase :: PhaseNum -> ActivationGhc -> Bool

valuecompetesWith :: ActivationGhc -> ActivationGhc -> Bool

act1 competesWith act2 returns whether act1 is active in the phase when act2 becomes active.

This answers the question: might act1 fire first?

NB: this is not the same as computing whether act1 and act2 are ever active at the same time.

See Note [Competing activations]

valueisAlwaysActive :: ActivationGhc -> Bool

valueisNeverActive :: ActivationGhc -> Bool

CompilerPhase

Data-type

datadata CompilerPhase

Compilation phase number, including the user-specifiable PhaseNum and the GHC internal "initial" and "final" phases.

Constructors

InitialPhase
The first phase; number = infinity!
Phase PhaseNum
User-specifiable phases
FinalPhase
The last phase; number = -infinity!

Instances5Eq, Data, NFData, Outputable, Binary

Eq CompilerPhaseDefined in ghc-10.0.0.20260917 · GHC.Types.InlinePragma
Data CompilerPhaseDefined in ghc-10.0.0.20260917 · GHC.Types.InlinePragma
NFData CompilerPhaseDefined in ghc-10.0.0.20260917 · GHC.Types.InlinePragma
activeAfter p makes an Activation that is active in phase p and after
Invariant: beginPhase (activeAfter p) = p
Outputable CompilerPhaseDefined in ghc-10.0.0.20260917 · GHC.Types.InlinePragma
Binary CompilerPhaseDefined in ghc-10.0.0.20260917 · GHC.Types.InlinePragma

Constructors

valuebeginPhase :: ActivationGhc -> CompilerPhase

First phase in which the Activation is active, or FinalPhase if it is never active

valueendPhase :: ActivationGhc -> CompilerPhase

Last phase in which the Activation is active, or InitialPhase if it is never active

Queries

valueisActiveInPhase :: CompilerPhase -> ActivationGhc -> Bool

valuelatestPhase :: CompilerPhase -> CompilerPhase -> CompilerPhase

Returns the latest of two phases

valueearliestPhase :: CompilerPhase -> CompilerPhase -> CompilerPhase

Returns the earliest of two phases

valuelaterThanPhase :: CompilerPhase -> CompilerPhase -> Bool

p1 laterThanOrEqualPhase p2 computes whether p1 happens (strictly) after p2.

valuenextPhase :: CompilerPhase -> CompilerPhase

Tells you the next phase after this one

Currently we have just phases [2,1,0,FinalPhase,FinalPhase,...], where FinalPhase means GHC's internal simplification steps after all rules have run

Orphan instances

2 instances

IsPass p => Outputable (InlinePragma (GhcPass p))
IsPass p => Binary (InlinePragma (GhcPass p))