plutus-core-1.34.0.0: Language library for Plutus Core
Safe HaskellSafe-Inferred
LanguageHaskell2010

PlutusIR.Compiler.Provenance

Description

Module handling provenances of terms.

Synopsis

Documentation

data Provenance a Source #

Indicates where a value comes from.

This is either an original annotation or a pieces of context explaining how the term relates to a previous Provenance. We also provide noProvenance for convenience.

The provenance should always be just the original annotation, if we have one. It should only be another kind of provenance if we're in the process of generating some term that doesn't correspond directly to a term in the original AST.

Constructors

Original a 
LetBinding Recursivity (Provenance a) 
TermBinding String (Provenance a) 
TypeBinding String (Provenance a) 
DatatypeComponent DatatypeComponent (Provenance a) 
MultipleSources (Set (Provenance a))

Added for accumulating difference provenances when floating lets

Instances

Instances details
Foldable Provenance Source # 
Instance details

Defined in PlutusIR.Compiler.Provenance

Methods

fold ∷ Monoid m ⇒ Provenance m → m Source #

foldMap ∷ Monoid m ⇒ (a → m) → Provenance a → m Source #

foldMap' ∷ Monoid m ⇒ (a → m) → Provenance a → m Source #

foldr ∷ (a → b → b) → b → Provenance a → b Source #

foldr' ∷ (a → b → b) → b → Provenance a → b Source #

foldl ∷ (b → a → b) → b → Provenance a → b Source #

foldl' ∷ (b → a → b) → b → Provenance a → b Source #

foldr1 ∷ (a → a → a) → Provenance a → a Source #

foldl1 ∷ (a → a → a) → Provenance a → a Source #

toList ∷ Provenance a → [a] Source #

null ∷ Provenance a → Bool Source #

length ∷ Provenance a → Int Source #

elem ∷ Eq a ⇒ a → Provenance a → Bool Source #

maximum ∷ Ord a ⇒ Provenance a → a Source #

minimum ∷ Ord a ⇒ Provenance a → a Source #

sum ∷ Num a ⇒ Provenance a → a Source #

product ∷ Num a ⇒ Provenance a → a Source #

Ord a ⇒ Monoid (Provenance a) Source # 
Instance details

Defined in PlutusIR.Compiler.Provenance

Methods

mempty ∷ Provenance a Source #

mappend ∷ Provenance a → Provenance a → Provenance a Source #

mconcat ∷ [Provenance a] → Provenance a Source #

Ord a ⇒ Semigroup (Provenance a) Source # 
Instance details

Defined in PlutusIR.Compiler.Provenance

Methods

(<>) ∷ Provenance a → Provenance a → Provenance a Source #

sconcat ∷ NonEmpty (Provenance a) → Provenance a Source #

stimes ∷ Integral b ⇒ b → Provenance a → Provenance a Source #

Generic (Provenance a) Source # 
Instance details

Defined in PlutusIR.Compiler.Provenance

Associated Types

type Rep (Provenance a) ∷ Type → Type Source #

Methods

from ∷ Provenance a → Rep (Provenance a) x Source #

to ∷ Rep (Provenance a) x → Provenance a Source #

Show a ⇒ Show (Provenance a) Source # 
Instance details

Defined in PlutusIR.Compiler.Provenance

Methods

showsPrec ∷ Int → Provenance a → ShowS Source #

show ∷ Provenance a → String Source #

showList ∷ [Provenance a] → ShowS Source #

Eq a ⇒ Eq (Provenance a) Source # 
Instance details

Defined in PlutusIR.Compiler.Provenance

Methods

(==) ∷ Provenance a → Provenance a → Bool Source #

(/=) ∷ Provenance a → Provenance a → Bool Source #

Ord a ⇒ Ord (Provenance a) Source # 
Instance details

Defined in PlutusIR.Compiler.Provenance

Methods

compare ∷ Provenance a → Provenance a → Ordering Source #

(<) ∷ Provenance a → Provenance a → Bool Source #

(<=) ∷ Provenance a → Provenance a → Bool Source #

(>) ∷ Provenance a → Provenance a → Bool Source #

(>=) ∷ Provenance a → Provenance a → Bool Source #

max ∷ Provenance a → Provenance a → Provenance a Source #

min ∷ Provenance a → Provenance a → Provenance a Source #

Hashable a ⇒ Hashable (Provenance a) Source # 
Instance details

Defined in PlutusIR.Compiler.Provenance

Methods

hashWithSalt ∷ Int → Provenance a → Int Source #

hash ∷ Provenance a → Int Source #

Pretty a ⇒ Pretty (Provenance a) Source # 
Instance details

Defined in PlutusIR.Compiler.Provenance

Methods

pretty ∷ Provenance a → Doc ann Source #

prettyList ∷ [Provenance a] → Doc ann Source #

type Rep (Provenance a) Source # 
Instance details

Defined in PlutusIR.Compiler.Provenance

type Rep (Provenance a) = D1 ('MetaData "Provenance" "PlutusIR.Compiler.Provenance" "plutus-core-1.34.0.0-inplace-plutus-ir" 'False) ((C1 ('MetaCons "Original" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)) :+: (C1 ('MetaCons "LetBinding" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Recursivity) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Provenance a))) :+: C1 ('MetaCons "TermBinding" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Provenance a))))) :+: (C1 ('MetaCons "TypeBinding" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Provenance a))) :+: (C1 ('MetaCons "DatatypeComponent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DatatypeComponent) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Provenance a))) :+: C1 ('MetaCons "MultipleSources" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set (Provenance a)))))))

noProvenance ∷ Provenance a Source #

data DatatypeComponent Source #

Constructors

Constructor 
ConstructorType 
Destructor 
DestructorType 
DatatypeType 
PatternFunctor 

Instances

Instances details
Generic DatatypeComponent Source # 
Instance details

Defined in PlutusIR.Compiler.Provenance

Associated Types

type Rep DatatypeComponent ∷ Type → Type Source #

Methods

from ∷ DatatypeComponent → Rep DatatypeComponent x Source #

to ∷ Rep DatatypeComponent x → DatatypeComponent Source #

Show DatatypeComponent Source # 
Instance details

Defined in PlutusIR.Compiler.Provenance

Methods

showsPrec ∷ Int → DatatypeComponent → ShowS Source #

show ∷ DatatypeComponent → String Source #

showList ∷ [DatatypeComponent] → ShowS Source #

Eq DatatypeComponent Source # 
Instance details

Defined in PlutusIR.Compiler.Provenance

Methods

(==) ∷ DatatypeComponent → DatatypeComponent → Bool Source #

(/=) ∷ DatatypeComponent → DatatypeComponent → Bool Source #

Ord DatatypeComponent Source # 
Instance details

Defined in PlutusIR.Compiler.Provenance

Methods

compare ∷ DatatypeComponent → DatatypeComponent → Ordering Source #

(<) ∷ DatatypeComponent → DatatypeComponent → Bool Source #

(<=) ∷ DatatypeComponent → DatatypeComponent → Bool Source #

(>) ∷ DatatypeComponent → DatatypeComponent → Bool Source #

(>=) ∷ DatatypeComponent → DatatypeComponent → Bool Source #

max ∷ DatatypeComponent → DatatypeComponent → DatatypeComponent Source #

min ∷ DatatypeComponent → DatatypeComponent → DatatypeComponent Source #

Hashable DatatypeComponent Source # 
Instance details

Defined in PlutusIR.Compiler.Provenance

Methods

hashWithSalt ∷ Int → DatatypeComponent → Int Source #

hash ∷ DatatypeComponent → Int Source #

Pretty DatatypeComponent Source # 
Instance details

Defined in PlutusIR.Compiler.Provenance

Methods

pretty ∷ DatatypeComponent → Doc ann Source #

prettyList ∷ [DatatypeComponent] → Doc ann Source #

type Rep DatatypeComponent Source # 
Instance details

Defined in PlutusIR.Compiler.Provenance

type Rep DatatypeComponent = D1 ('MetaData "DatatypeComponent" "PlutusIR.Compiler.Provenance" "plutus-core-1.34.0.0-inplace-plutus-ir" 'False) ((C1 ('MetaCons "Constructor" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "ConstructorType" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "Destructor" 'PrefixI 'False) (U1 ∷ Type → Type))) :+: (C1 ('MetaCons "DestructorType" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "DatatypeType" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "PatternFunctor" 'PrefixI 'False) (U1 ∷ Type → Type))))

data GeneratedKind Source #

Constructors

RecursiveLet 

Instances

Instances details
Show GeneratedKind Source # 
Instance details

Defined in PlutusIR.Compiler.Provenance

Methods

showsPrec ∷ Int → GeneratedKind → ShowS Source #

show ∷ GeneratedKind → String Source #

showList ∷ [GeneratedKind] → ShowS Source #

Eq GeneratedKind Source # 
Instance details

Defined in PlutusIR.Compiler.Provenance

Methods

(==) ∷ GeneratedKind → GeneratedKind → Bool Source #

(/=) ∷ GeneratedKind → GeneratedKind → Bool Source #

Pretty GeneratedKind Source # 
Instance details

Defined in PlutusIR.Compiler.Provenance

Methods

pretty ∷ GeneratedKind → Doc ann Source #

prettyList ∷ [GeneratedKind] → Doc ann Source #

setProvenance ∷ Functor f ⇒ Provenance b → f a → f (Provenance b) Source #

Set the provenance on a term to the given value.

original ∷ Functor f ⇒ f a → f (Provenance a) Source #

Mark all the annotations on a term as original. Useful for preparing terms for the PIR compiler.