plutus-core
Safe HaskellNone
LanguageHaskell2010

PlutusCore.DeBruijn.Internal

Description

Support for using de Bruijn indices for term and type names.

Synopsis

Documentation

newtype Index Source #

A relative index used for de Bruijn identifiers.

FIXME: downside of using newtype+Num instead of type-synonym is that `-Woverflowed-literals` does not work, e.g.: `DeBruijn (-1)` has no warning. To trigger the warning you have to bypass the Num and write `DeBruijn (Index -1)`. This can be revisited when we implement PLT-1053. Tracked by: https://github.com/IntersectMBO/plutus-private/issues/1552

Constructors

Index Word64 

Instances

Instances details
Enum Index Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

succ :: Index -> Index Source #

pred :: Index -> Index Source #

toEnum :: Int -> Index Source #

fromEnum :: Index -> Int Source #

enumFrom :: Index -> [Index] Source #

enumFromThen :: Index -> Index -> [Index] Source #

enumFromTo :: Index -> Index -> [Index] Source #

enumFromThenTo :: Index -> Index -> Index -> [Index] Source #

Generic Index Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Associated Types

type Rep Index 
Instance details

Defined in PlutusCore.DeBruijn.Internal

type Rep Index = D1 ('MetaData "Index" "PlutusCore.DeBruijn.Internal" "plutus-core-1.60.0.0-LXFqBsoUlXsJIEqLytHte7" 'True) (C1 ('MetaCons "Index" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

Methods

from :: Index -> Rep Index x Source #

to :: Rep Index x -> Index Source #

Num Index Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

(+) :: Index -> Index -> Index Source #

(-) :: Index -> Index -> Index Source #

(*) :: Index -> Index -> Index Source #

negate :: Index -> Index Source #

abs :: Index -> Index Source #

signum :: Index -> Index Source #

fromInteger :: Integer -> Index Source #

Read Index Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

readsPrec :: Int -> ReadS Index Source #

readList :: ReadS [Index] Source #

readPrec :: ReadPrec Index Source #

readListPrec :: ReadPrec [Index] Source #

Integral Index Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

quot :: Index -> Index -> Index Source #

rem :: Index -> Index -> Index Source #

div :: Index -> Index -> Index Source #

mod :: Index -> Index -> Index Source #

quotRem :: Index -> Index -> (Index, Index) Source #

divMod :: Index -> Index -> (Index, Index) Source #

toInteger :: Index -> Integer Source #

Real Index Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

toRational :: Index -> Rational Source #

Show Index Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

showsPrec :: Int -> Index -> ShowS Source #

show :: Index -> String Source #

showList :: [Index] -> ShowS Source #

NFData Index Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

rnf :: Index -> () Source #

Eq Index Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

(==) :: Index -> Index -> Bool Source #

(/=) :: Index -> Index -> Bool Source #

Ord Index Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

compare :: Index -> Index -> Ordering Source #

(<) :: Index -> Index -> Bool Source #

(<=) :: Index -> Index -> Bool Source #

(>) :: Index -> Index -> Bool Source #

(>=) :: Index -> Index -> Bool Source #

max :: Index -> Index -> Index Source #

min :: Index -> Index -> Index Source #

Hashable Index Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

hashWithSalt :: Int -> Index -> Int

hash :: Index -> Int

Flat Index 
Instance details

Defined in PlutusCore.FlatInstances

Methods

encode :: Index -> Encoding

decode :: Get Index

size :: Index -> NumBits -> NumBits

Pretty Index Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

pretty :: Index -> Doc ann #

prettyList :: [Index] -> Doc ann #

type Rep Index Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

type Rep Index = D1 ('MetaData "Index" "PlutusCore.DeBruijn.Internal" "plutus-core-1.60.0.0-LXFqBsoUlXsJIEqLytHte7" 'True) (C1 ('MetaCons "Index" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

class HasIndex a where Source #

Methods

index :: Lens' a Index Source #

Instances

Instances details
HasIndex DeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

index :: Lens' DeBruijn Index Source #

HasIndex NamedDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

index :: Lens' NamedDeBruijn Index Source #

HasIndex NamedTyDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

index :: Lens' NamedTyDeBruijn Index Source #

HasIndex TyDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

index :: Lens' TyDeBruijn Index Source #

newtype DeBruijn Source #

A term name as a de Bruijn index, without the name string.

Constructors

DeBruijn 

Fields

Instances

Instances details
Generic DeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Associated Types

type Rep DeBruijn 
Instance details

Defined in PlutusCore.DeBruijn.Internal

type Rep DeBruijn = D1 ('MetaData "DeBruijn" "PlutusCore.DeBruijn.Internal" "plutus-core-1.60.0.0-LXFqBsoUlXsJIEqLytHte7" 'True) (C1 ('MetaCons "DeBruijn" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbnIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Index)))

Methods

from :: DeBruijn -> Rep DeBruijn x Source #

to :: Rep DeBruijn x -> DeBruijn Source #

Show DeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

showsPrec :: Int -> DeBruijn -> ShowS Source #

show :: DeBruijn -> String Source #

showList :: [DeBruijn] -> ShowS Source #

NFData DeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

rnf :: DeBruijn -> () Source #

Eq DeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

(==) :: DeBruijn -> DeBruijn -> Bool Source #

(/=) :: DeBruijn -> DeBruijn -> Bool Source #

Hashable DeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

hashWithSalt :: Int -> DeBruijn -> Int

hash :: DeBruijn -> Int

Flat DeBruijn 
Instance details

Defined in PlutusCore.FlatInstances

Methods

encode :: DeBruijn -> Encoding

decode :: Get DeBruijn

size :: DeBruijn -> NumBits -> NumBits

HasIndex DeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

index :: Lens' DeBruijn Index Source #

HasPrettyConfigName config => PrettyBy config DeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

prettyBy :: config -> DeBruijn -> Doc ann #

prettyListBy :: config -> [DeBruijn] -> Doc ann #

Flat (Binder DeBruijn) 
Instance details

Defined in PlutusCore.FlatInstances

Methods

encode :: Binder DeBruijn -> Encoding

decode :: Get (Binder DeBruijn)

size :: Binder DeBruijn -> NumBits -> NumBits

(GEq uni, Closed uni, Everywhere uni Eq, Eq fun, Eq ann) => Eq (Term DeBruijn uni fun ann) Source # 
Instance details

Defined in UntypedPlutusCore.Core.Instance.Eq

Methods

(==) :: Term DeBruijn uni fun ann -> Term DeBruijn uni fun ann -> Bool Source #

(/=) :: Term DeBruijn uni fun ann -> Term DeBruijn uni fun ann -> Bool Source #

HashableTermConstraints uni fun ann => Hashable (Term DeBruijn uni fun ann) Source # 
Instance details

Defined in UntypedPlutusCore.Core.Instance.Eq

Methods

hashWithSalt :: Int -> Term DeBruijn uni fun ann -> Int

hash :: Term DeBruijn uni fun ann -> Int

(GEq uni, Closed uni, Everywhere uni Eq, Eq fun, Eq ann) => Eq (Term TyDeBruijn DeBruijn uni fun ann) Source # 
Instance details

Defined in PlutusCore.Core.Instance.Eq

Methods

(==) :: Term TyDeBruijn DeBruijn uni fun ann -> Term TyDeBruijn DeBruijn uni fun ann -> Bool Source #

(/=) :: Term TyDeBruijn DeBruijn uni fun ann -> Term TyDeBruijn DeBruijn uni fun ann -> Bool Source #

type Rep DeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

type Rep DeBruijn = D1 ('MetaData "DeBruijn" "PlutusCore.DeBruijn.Internal" "plutus-core-1.60.0.0-LXFqBsoUlXsJIEqLytHte7" 'True) (C1 ('MetaCons "DeBruijn" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbnIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Index)))

data NamedDeBruijn Source #

A term name as a de Bruijn index.

Constructors

NamedDeBruijn 

Fields

Instances

Instances details
Generic NamedDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Associated Types

type Rep NamedDeBruijn 
Instance details

Defined in PlutusCore.DeBruijn.Internal

type Rep NamedDeBruijn = D1 ('MetaData "NamedDeBruijn" "PlutusCore.DeBruijn.Internal" "plutus-core-1.60.0.0-LXFqBsoUlXsJIEqLytHte7" 'False) (C1 ('MetaCons "NamedDeBruijn" 'PrefixI 'True) (S1 ('MetaSel ('Just "ndbnString") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "ndbnIndex") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Index)))

Methods

from :: NamedDeBruijn -> Rep NamedDeBruijn x Source #

to :: Rep NamedDeBruijn x -> NamedDeBruijn Source #

Read NamedDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

readsPrec :: Int -> ReadS NamedDeBruijn Source #

readList :: ReadS [NamedDeBruijn] Source #

readPrec :: ReadPrec NamedDeBruijn Source #

readListPrec :: ReadPrec [NamedDeBruijn] Source #

Show NamedDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

showsPrec :: Int -> NamedDeBruijn -> ShowS Source #

show :: NamedDeBruijn -> String Source #

showList :: [NamedDeBruijn] -> ShowS Source #

NFData NamedDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

rnf :: NamedDeBruijn -> () Source #

Eq NamedDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

(==) :: NamedDeBruijn -> NamedDeBruijn -> Bool Source #

(/=) :: NamedDeBruijn -> NamedDeBruijn -> Bool Source #

Hashable NamedDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

hashWithSalt :: Int -> NamedDeBruijn -> Int

hash :: NamedDeBruijn -> Int

Flat NamedDeBruijn 
Instance details

Defined in PlutusCore.FlatInstances

Methods

encode :: NamedDeBruijn -> Encoding

decode :: Get NamedDeBruijn

size :: NamedDeBruijn -> NumBits -> NumBits

HasIndex NamedDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

index :: Lens' NamedDeBruijn Index Source #

HasPrettyConfigName config => PrettyBy config NamedDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

prettyBy :: config -> NamedDeBruijn -> Doc ann #

prettyListBy :: config -> [NamedDeBruijn] -> Doc ann #

Flat (Binder NamedDeBruijn) 
Instance details

Defined in PlutusCore.FlatInstances

Methods

encode :: Binder NamedDeBruijn -> Encoding

decode :: Get (Binder NamedDeBruijn)

size :: Binder NamedDeBruijn -> NumBits -> NumBits

ThrowableBuiltins uni fun => MonadError (CekEvaluationException NamedDeBruijn uni fun) (CekM uni fun s) Source # 
Instance details

Defined in UntypedPlutusCore.Evaluation.Machine.Cek.Internal

Methods

throwError :: CekEvaluationException NamedDeBruijn uni fun -> CekM uni fun s a Source #

catchError :: CekM uni fun s a -> (CekEvaluationException NamedDeBruijn uni fun -> CekM uni fun s a) -> CekM uni fun s a Source #

(GEq uni, Closed uni, Everywhere uni Eq, Eq fun, Eq ann) => Eq (Term NamedDeBruijn uni fun ann) Source # 
Instance details

Defined in UntypedPlutusCore.Core.Instance.Eq

Methods

(==) :: Term NamedDeBruijn uni fun ann -> Term NamedDeBruijn uni fun ann -> Bool Source #

(/=) :: Term NamedDeBruijn uni fun ann -> Term NamedDeBruijn uni fun ann -> Bool Source #

HashableTermConstraints uni fun ann => Hashable (Term NamedDeBruijn uni fun ann) Source # 
Instance details

Defined in UntypedPlutusCore.Core.Instance.Eq

Methods

hashWithSalt :: Int -> Term NamedDeBruijn uni fun ann -> Int

hash :: Term NamedDeBruijn uni fun ann -> Int

(GEq uni, Closed uni, Everywhere uni Eq, Eq fun, Eq ann) => Eq (Term NamedTyDeBruijn NamedDeBruijn uni fun ann) Source # 
Instance details

Defined in PlutusCore.Core.Instance.Eq

Methods

(==) :: Term NamedTyDeBruijn NamedDeBruijn uni fun ann -> Term NamedTyDeBruijn NamedDeBruijn uni fun ann -> Bool Source #

(/=) :: Term NamedTyDeBruijn NamedDeBruijn uni fun ann -> Term NamedTyDeBruijn NamedDeBruijn uni fun ann -> Bool Source #

type Rep NamedDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

type Rep NamedDeBruijn = D1 ('MetaData "NamedDeBruijn" "PlutusCore.DeBruijn.Internal" "plutus-core-1.60.0.0-LXFqBsoUlXsJIEqLytHte7" 'False) (C1 ('MetaCons "NamedDeBruijn" 'PrefixI 'True) (S1 ('MetaSel ('Just "ndbnString") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "ndbnIndex") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Index)))

newtype FakeNamedDeBruijn Source #

A wrapper around NamedDeBruijn that *must* hold the invariant of name=fakeName.

We do not export the FakeNamedDeBruijn constructor: the projection `FND->ND` is safe but injection `ND->FND` is unsafe, thus they are not isomorphic.

See Note [Why newtype FakeNamedDeBruijn]

Constructors

FakeNamedDeBruijn 

Fields

Instances

Instances details
Show FakeNamedDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

showsPrec :: Int -> FakeNamedDeBruijn -> ShowS Source #

show :: FakeNamedDeBruijn -> String Source #

showList :: [FakeNamedDeBruijn] -> ShowS Source #

NFData FakeNamedDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

rnf :: FakeNamedDeBruijn -> () Source #

Eq FakeNamedDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

(==) :: FakeNamedDeBruijn -> FakeNamedDeBruijn -> Bool Source #

(/=) :: FakeNamedDeBruijn -> FakeNamedDeBruijn -> Bool Source #

Hashable FakeNamedDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

hashWithSalt :: Int -> FakeNamedDeBruijn -> Int

hash :: FakeNamedDeBruijn -> Int

Flat FakeNamedDeBruijn 
Instance details

Defined in PlutusCore.FlatInstances

Methods

encode :: FakeNamedDeBruijn -> Encoding

decode :: Get FakeNamedDeBruijn

size :: FakeNamedDeBruijn -> NumBits -> NumBits

HasPrettyConfigName config => PrettyBy config FakeNamedDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

prettyBy :: config -> FakeNamedDeBruijn -> Doc ann #

prettyListBy :: config -> [FakeNamedDeBruijn] -> Doc ann #

Flat (Binder FakeNamedDeBruijn) 
Instance details

Defined in PlutusCore.FlatInstances

Methods

encode :: Binder FakeNamedDeBruijn -> Encoding

decode :: Get (Binder FakeNamedDeBruijn)

size :: Binder FakeNamedDeBruijn -> NumBits -> NumBits

(GEq uni, Closed uni, Everywhere uni Eq, Eq fun, Eq ann) => Eq (Term FakeNamedDeBruijn uni fun ann) Source # 
Instance details

Defined in UntypedPlutusCore.Core.Instance.Eq

Methods

(==) :: Term FakeNamedDeBruijn uni fun ann -> Term FakeNamedDeBruijn uni fun ann -> Bool Source #

(/=) :: Term FakeNamedDeBruijn uni fun ann -> Term FakeNamedDeBruijn uni fun ann -> Bool Source #

HashableTermConstraints uni fun ann => Hashable (Term FakeNamedDeBruijn uni fun ann) Source # 
Instance details

Defined in UntypedPlutusCore.Core.Instance.Eq

Methods

hashWithSalt :: Int -> Term FakeNamedDeBruijn uni fun ann -> Int

hash :: Term FakeNamedDeBruijn uni fun ann -> Int

newtype TyDeBruijn Source #

A type name as a de Bruijn index, without the name string.

Constructors

TyDeBruijn DeBruijn 

Instances

Instances details
Generic TyDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Associated Types

type Rep TyDeBruijn 
Instance details

Defined in PlutusCore.DeBruijn.Internal

type Rep TyDeBruijn = D1 ('MetaData "TyDeBruijn" "PlutusCore.DeBruijn.Internal" "plutus-core-1.60.0.0-LXFqBsoUlXsJIEqLytHte7" 'True) (C1 ('MetaCons "TyDeBruijn" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DeBruijn)))

Methods

from :: TyDeBruijn -> Rep TyDeBruijn x Source #

to :: Rep TyDeBruijn x -> TyDeBruijn Source #

Show TyDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

showsPrec :: Int -> TyDeBruijn -> ShowS Source #

show :: TyDeBruijn -> String Source #

showList :: [TyDeBruijn] -> ShowS Source #

NFData TyDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

rnf :: TyDeBruijn -> () Source #

Eq TyDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

(==) :: TyDeBruijn -> TyDeBruijn -> Bool Source #

(/=) :: TyDeBruijn -> TyDeBruijn -> Bool Source #

Wrapped TyDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Associated Types

type Unwrapped TyDeBruijn 
Instance details

Defined in PlutusCore.DeBruijn.Internal

type Unwrapped TyDeBruijn = GUnwrapped (Rep TyDeBruijn)

Methods

_Wrapped' :: Iso' TyDeBruijn (Unwrapped TyDeBruijn)

Flat TyDeBruijn 
Instance details

Defined in PlutusCore.FlatInstances

Methods

encode :: TyDeBruijn -> Encoding

decode :: Get TyDeBruijn

size :: TyDeBruijn -> NumBits -> NumBits

HasIndex TyDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

index :: Lens' TyDeBruijn Index Source #

HasPrettyConfigName config => PrettyBy config TyDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

prettyBy :: config -> TyDeBruijn -> Doc ann #

prettyListBy :: config -> [TyDeBruijn] -> Doc ann #

(GEq uni, Closed uni, Everywhere uni Eq, Eq ann) => Eq (Type TyDeBruijn uni ann) Source # 
Instance details

Defined in PlutusCore.Core.Instance.Eq

Methods

(==) :: Type TyDeBruijn uni ann -> Type TyDeBruijn uni ann -> Bool Source #

(/=) :: Type TyDeBruijn uni ann -> Type TyDeBruijn uni ann -> Bool Source #

(GEq uni, Closed uni, Everywhere uni Eq, Eq fun, Eq ann) => Eq (Term TyDeBruijn DeBruijn uni fun ann) Source # 
Instance details

Defined in PlutusCore.Core.Instance.Eq

Methods

(==) :: Term TyDeBruijn DeBruijn uni fun ann -> Term TyDeBruijn DeBruijn uni fun ann -> Bool Source #

(/=) :: Term TyDeBruijn DeBruijn uni fun ann -> Term TyDeBruijn DeBruijn uni fun ann -> Bool Source #

type Rep TyDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

type Rep TyDeBruijn = D1 ('MetaData "TyDeBruijn" "PlutusCore.DeBruijn.Internal" "plutus-core-1.60.0.0-LXFqBsoUlXsJIEqLytHte7" 'True) (C1 ('MetaCons "TyDeBruijn" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DeBruijn)))
type Unwrapped TyDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

type Unwrapped TyDeBruijn = GUnwrapped (Rep TyDeBruijn)

newtype NamedTyDeBruijn Source #

A type name as a de Bruijn index.

Constructors

NamedTyDeBruijn NamedDeBruijn 

Instances

Instances details
Generic NamedTyDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Associated Types

type Rep NamedTyDeBruijn 
Instance details

Defined in PlutusCore.DeBruijn.Internal

type Rep NamedTyDeBruijn = D1 ('MetaData "NamedTyDeBruijn" "PlutusCore.DeBruijn.Internal" "plutus-core-1.60.0.0-LXFqBsoUlXsJIEqLytHte7" 'True) (C1 ('MetaCons "NamedTyDeBruijn" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NamedDeBruijn)))

Methods

from :: NamedTyDeBruijn -> Rep NamedTyDeBruijn x Source #

to :: Rep NamedTyDeBruijn x -> NamedTyDeBruijn Source #

Show NamedTyDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

showsPrec :: Int -> NamedTyDeBruijn -> ShowS Source #

show :: NamedTyDeBruijn -> String Source #

showList :: [NamedTyDeBruijn] -> ShowS Source #

NFData NamedTyDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

rnf :: NamedTyDeBruijn -> () Source #

Eq NamedTyDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

(==) :: NamedTyDeBruijn -> NamedTyDeBruijn -> Bool Source #

(/=) :: NamedTyDeBruijn -> NamedTyDeBruijn -> Bool Source #

Wrapped NamedTyDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Associated Types

type Unwrapped NamedTyDeBruijn 
Instance details

Defined in PlutusCore.DeBruijn.Internal

type Unwrapped NamedTyDeBruijn = GUnwrapped (Rep NamedTyDeBruijn)

Methods

_Wrapped' :: Iso' NamedTyDeBruijn (Unwrapped NamedTyDeBruijn)

Flat NamedTyDeBruijn 
Instance details

Defined in PlutusCore.FlatInstances

Methods

encode :: NamedTyDeBruijn -> Encoding

decode :: Get NamedTyDeBruijn

size :: NamedTyDeBruijn -> NumBits -> NumBits

HasIndex NamedTyDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

index :: Lens' NamedTyDeBruijn Index Source #

HasPrettyConfigName config => PrettyBy config NamedTyDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

prettyBy :: config -> NamedTyDeBruijn -> Doc ann #

prettyListBy :: config -> [NamedTyDeBruijn] -> Doc ann #

Flat (Binder NamedTyDeBruijn) 
Instance details

Defined in PlutusCore.FlatInstances

Methods

encode :: Binder NamedTyDeBruijn -> Encoding

decode :: Get (Binder NamedTyDeBruijn)

size :: Binder NamedTyDeBruijn -> NumBits -> NumBits

(GEq uni, Closed uni, Everywhere uni Eq, Eq ann) => Eq (Type NamedTyDeBruijn uni ann) Source # 
Instance details

Defined in PlutusCore.Core.Instance.Eq

Methods

(==) :: Type NamedTyDeBruijn uni ann -> Type NamedTyDeBruijn uni ann -> Bool Source #

(/=) :: Type NamedTyDeBruijn uni ann -> Type NamedTyDeBruijn uni ann -> Bool Source #

(GEq uni, Closed uni, Everywhere uni Eq, Eq fun, Eq ann) => Eq (Term NamedTyDeBruijn NamedDeBruijn uni fun ann) Source # 
Instance details

Defined in PlutusCore.Core.Instance.Eq

Methods

(==) :: Term NamedTyDeBruijn NamedDeBruijn uni fun ann -> Term NamedTyDeBruijn NamedDeBruijn uni fun ann -> Bool Source #

(/=) :: Term NamedTyDeBruijn NamedDeBruijn uni fun ann -> Term NamedTyDeBruijn NamedDeBruijn uni fun ann -> Bool Source #

type Rep NamedTyDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

type Rep NamedTyDeBruijn = D1 ('MetaData "NamedTyDeBruijn" "PlutusCore.DeBruijn.Internal" "plutus-core-1.60.0.0-LXFqBsoUlXsJIEqLytHte7" 'True) (C1 ('MetaCons "NamedTyDeBruijn" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NamedDeBruijn)))
type Unwrapped NamedTyDeBruijn Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

type Unwrapped NamedTyDeBruijn = GUnwrapped (Rep NamedTyDeBruijn)

data FreeVariableError Source #

We cannot do a correct translation to or from de Bruijn indices if the program is not well-scoped. So we throw an error in such a case.

Constructors

FreeUnique !Unique 
FreeIndex !Index 

Instances

Instances details
Exception FreeVariableError Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

toException :: FreeVariableError -> SomeException Source #

fromException :: SomeException -> Maybe FreeVariableError Source #

displayException :: FreeVariableError -> String Source #

Generic FreeVariableError Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Associated Types

type Rep FreeVariableError 
Instance details

Defined in PlutusCore.DeBruijn.Internal

type Rep FreeVariableError = D1 ('MetaData "FreeVariableError" "PlutusCore.DeBruijn.Internal" "plutus-core-1.60.0.0-LXFqBsoUlXsJIEqLytHte7" 'False) (C1 ('MetaCons "FreeUnique" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Unique)) :+: C1 ('MetaCons "FreeIndex" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Index)))

Methods

from :: FreeVariableError -> Rep FreeVariableError x Source #

to :: Rep FreeVariableError x -> FreeVariableError Source #

Show FreeVariableError Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

showsPrec :: Int -> FreeVariableError -> ShowS Source #

show :: FreeVariableError -> String Source #

showList :: [FreeVariableError] -> ShowS Source #

NFData FreeVariableError Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

rnf :: FreeVariableError -> () Source #

Eq FreeVariableError Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

(==) :: FreeVariableError -> FreeVariableError -> Bool Source #

(/=) :: FreeVariableError -> FreeVariableError -> Bool Source #

Ord FreeVariableError Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

compare :: FreeVariableError -> FreeVariableError -> Ordering Source #

(<) :: FreeVariableError -> FreeVariableError -> Bool Source #

(<=) :: FreeVariableError -> FreeVariableError -> Bool Source #

(>) :: FreeVariableError -> FreeVariableError -> Bool Source #

(>=) :: FreeVariableError -> FreeVariableError -> Bool Source #

max :: FreeVariableError -> FreeVariableError -> FreeVariableError Source #

min :: FreeVariableError -> FreeVariableError -> FreeVariableError Source #

Pretty FreeVariableError Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

pretty :: FreeVariableError -> Doc ann #

prettyList :: [FreeVariableError] -> Doc ann #

type Rep FreeVariableError Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

type Rep FreeVariableError = D1 ('MetaData "FreeVariableError" "PlutusCore.DeBruijn.Internal" "plutus-core-1.60.0.0-LXFqBsoUlXsJIEqLytHte7" 'False) (C1 ('MetaCons "FreeUnique" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Unique)) :+: C1 ('MetaCons "FreeIndex" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Index)))

newtype Level Source #

An absolute level in the program.

Constructors

Level Integer 

Instances

Instances details
Enum Level Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

succ :: Level -> Level Source #

pred :: Level -> Level Source #

toEnum :: Int -> Level Source #

fromEnum :: Level -> Int Source #

enumFrom :: Level -> [Level] Source #

enumFromThen :: Level -> Level -> [Level] Source #

enumFromTo :: Level -> Level -> [Level] Source #

enumFromThenTo :: Level -> Level -> Level -> [Level] Source #

Num Level Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

(+) :: Level -> Level -> Level Source #

(-) :: Level -> Level -> Level Source #

(*) :: Level -> Level -> Level Source #

negate :: Level -> Level Source #

abs :: Level -> Level Source #

signum :: Level -> Level Source #

fromInteger :: Integer -> Level Source #

Integral Level Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

quot :: Level -> Level -> Level Source #

rem :: Level -> Level -> Level Source #

div :: Level -> Level -> Level Source #

mod :: Level -> Level -> Level Source #

quotRem :: Level -> Level -> (Level, Level) Source #

divMod :: Level -> Level -> (Level, Level) Source #

toInteger :: Level -> Integer Source #

Real Level Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

toRational :: Level -> Rational Source #

Eq Level Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

(==) :: Level -> Level -> Bool Source #

(/=) :: Level -> Level -> Bool Source #

Ord Level Source # 
Instance details

Defined in PlutusCore.DeBruijn.Internal

Methods

compare :: Level -> Level -> Ordering Source #

(<) :: Level -> Level -> Bool Source #

(<=) :: Level -> Level -> Bool Source #

(>) :: Level -> Level -> Bool Source #

(>=) :: Level -> Level -> Bool Source #

max :: Level -> Level -> Level Source #

min :: Level -> Level -> Level Source #

data LevelInfo Source #

During visiting the AST we hold a reader "state" of current level and a current scoping (levelMapping). Invariant-A: the current level is positive and greater than all levels in the levelMapping. Invariant-B: only positive levels are stored in the levelMapping.

Constructors

LevelInfo 

Fields

declareUnique :: (MonadReader LevelInfo m, HasUnique name unique) => name -> m a -> m a Source #

Declare a name with a unique, recording the mapping to a Level.

declareBinder :: (MonadReader LevelInfo m, MonadQuote m) => m a -> m a Source #

Declares a new binder by assigning a fresh unique to the *current level*. Maintains invariant-B of LevelInfo (that only positive levels are stored), since current level is always positive (invariant-A). See Note [DeBruijn indices of Binders]

withScope :: MonadReader LevelInfo m => m a -> m a Source #

Enter a scope, incrementing the current Level by one Maintains invariant-A (that the current level is positive).

getIndex :: MonadReader LevelInfo m => Unique -> (Unique -> m Index) -> m Index Source #

Get the Index corresponding to a given Unique. Uses supplied handler for free names (uniques).

getUnique :: MonadReader LevelInfo m => Index -> (Index -> m Unique) -> m Unique Source #

Get the Unique corresponding to a given Index. Uses supplied handler for free debruijn indices.

unNameDeBruijn :: NamedDeBruijn -> DeBruijn Source #

unNameTyDeBruijn :: NamedTyDeBruijn -> TyDeBruijn Source #

fakeNameDeBruijn :: DeBruijn -> NamedDeBruijn Source #

fakeTyNameDeBruijn :: TyDeBruijn -> NamedTyDeBruijn Source #

nameToDeBruijn :: MonadReader LevelInfo m => (Unique -> m Index) -> Name -> m NamedDeBruijn Source #

tyNameToDeBruijn :: MonadReader LevelInfo m => (Unique -> m Index) -> TyName -> m NamedTyDeBruijn Source #

deBruijnToName :: MonadReader LevelInfo m => (Index -> m Unique) -> NamedDeBruijn -> m Name Source #

deBruijnToTyName :: MonadReader LevelInfo m => (Index -> m Unique) -> NamedTyDeBruijn -> m TyName Source #

freeIndexThrow :: MonadError FreeVariableError m => Index -> m Unique Source #

The default handler of throwing an error upon encountering a free debruijn index.

freeIndexAsConsistentLevel :: (MonadReader LevelInfo m, MonadState (Map Level Unique) m, MonadQuote m) => Index -> m Unique Source #

A different implementation of a handler, where "free" debruijn indices do not throw an error but are instead gracefully converted to fresh uniques. These generated uniques remain free; i.e. if the original term was open, it will remain open after applying this handler. These generated free uniques are consistent across the open term (by using a state cache).

freeUniqueThrow :: MonadError FreeVariableError m => Unique -> m Index Source #

The default handler of throwing an error upon encountering a free name (unique).

runDeBruijnT :: ReaderT LevelInfo m a -> m a Source #

deBruijnInitIndex :: Index Source #

The LamAbs index (for debruijn indices) and the starting level of DeBruijn monad

toFake :: DeBruijn -> FakeNamedDeBruijn Source #

fromFake :: FakeNamedDeBruijn -> DeBruijn Source #