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

PlutusCore.Pretty.Readable

Description

A "readable" Agda-like way to pretty-print PLC entities.

Synopsis

Documentation

data Associativity Source #

Associativity of an operator.

Instances

Instances details
Show Associativity 
Instance details

Defined in Text.Fixity.Internal

Eq Associativity 
Instance details

Defined in Text.Fixity.Internal

data RenderContextOver prec Source #

A context that an expression is being rendered in.

Instances

Instances details
HasRenderContext RenderContext 
Instance details

Defined in Text.PrettyBy.Fixity

PrettyBy RenderContext (DefaultUni a) Source # 
Instance details

Defined in PlutusCore.Default.Universe

PrettyBy RenderContext (SomeTypeIn DefaultUni) Source # 
Instance details

Defined in PlutusCore.Default.Universe

Show prec ⇒ Show (RenderContextOver prec) 
Instance details

Defined in Text.Fixity.Internal

Eq prec ⇒ Eq (RenderContextOver prec) 
Instance details

Defined in Text.Fixity.Internal

data Direction Source #

Direction in which pretty-printing goes. For example in x + y x is pretty-printed to the left of + and y is pretty-printed to the right of +.

Constructors

ToTheLeft 
ToTheRight 

Instances

Instances details
Show Direction 
Instance details

Defined in Text.Fixity.Internal

Eq Direction 
Instance details

Defined in Text.Fixity.Internal

data FixityOver prec Source #

Fixity of an operator.

We allow unary operators to have associativity, because it's useful to distinguish between an expression like -(-x) (unary minus, left-associative) and ~~b (boolean NOT, right-associative).

Associativity of unary operators also matters when pretty-printing expressions like (-x) + y, which is pretty-printed as -x + y, assuming unary minus has the same fixity as + (and both the operators are left-associative). I.e. unary minus is handled just like the binary one: (0 - x) + y is pretty-printed as 0 - x + y.

Postfix operators are handled similarly. E.g. if ! is left-associative, then (x!)! is pretty-printed as x!! and if it's right-associative -- (x!)!.

The data type is parameterized, so that the user can choose precedence to be integer/fractional, bounded/unbounded, etc (we could also allows operators to be partially or totally ordered, but at the moment prec is required to implement Ord, i.e. it has to be totally ordered). By default we go with bounded fractional precedence, see the main Text.Fixity module.

Constructors

Fixity 

Instances

Instances details
Show prec ⇒ Show (FixityOver prec) 
Instance details

Defined in Text.Fixity.Internal

Methods

showsPrecIntFixityOver prec → ShowS Source #

showFixityOver prec → String Source #

showList ∷ [FixityOver prec] → ShowS Source #

Eq prec ⇒ Eq (FixityOver prec) 
Instance details

Defined in Text.Fixity.Internal

Methods

(==)FixityOver prec → FixityOver prec → Bool Source #

(/=)FixityOver prec → FixityOver prec → Bool Source #

type Precedence = Double Source #

Fractional precedence, so that it's always possible to squeeze an operator precedence between two existing precedences. Ranges over [-20, 120]. A normal operator should have a precedence within [0, 100). It might be useful to have a negative precedence if you're trying to model some already existing system, for example in Haskell ($) has precedence 0, but clearly if b then y else f $ x should be rendered without any parens, hence the precedence of if_then_else_ is less than 0, i.e. negative.

The precedence of juxtaposition is 100. Normally you want juxtaposition to have the highest precedence, but some languages have operators that bind tighter than juxtaposition, e.g. Haskell's postfix _{_}: f z { x = y } means f (z {x = y}).

type MonadPretty config env (m ∷ TypeType) = (MonadReader env m, HasPrettyConfig env config) Source #

A constraint for "m is a monad that allows to pretty-print values in it by a config".

class HasPrettyConfig env config | env → config where Source #

A constraint for "config is a part of env".

Methods

prettyConfig ∷ Lens' env config Source #

Instances

Instances details
HasPrettyConfig (Sole config) config

It's not possible to have HasPrettyConfig config config, because that would mean that every environment is a pretty-printing config on its own, which doesn't make sense. We could have an OVERLAPPABLE instance, but I'd rather not.

Instance details

Defined in Text.PrettyBy.Fixity

Methods

prettyConfig ∷ Lens' (Sole config) config Source #

type AnyToDoc config ann = ∀ a. PrettyBy config a ⇒ a → Doc ann Source #

The type of a general config-based pretty-printer.

newtype InContextM config a Source #

A monad for precedence-aware pretty-printing.

Constructors

InContextM 

Fields

Instances

Instances details
Profunctor InContextM Source # 
Instance details

Defined in PlutusCore.Pretty.Extra

Methods

dimap ∷ (a → b) → (c → d) → InContextM b c → InContextM a d #

lmap ∷ (a → b) → InContextM b c → InContextM a c #

rmap ∷ (b → c) → InContextM a b → InContextM a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → InContextM a b → InContextM a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ InContextM b c → q a b → InContextM a c

Applicative (InContextM config) 
Instance details

Defined in Text.PrettyBy.Fixity

Methods

pure ∷ a → InContextM config a Source #

(<*>)InContextM config (a → b) → InContextM config a → InContextM config b Source #

liftA2 ∷ (a → b → c) → InContextM config a → InContextM config b → InContextM config c Source #

(*>)InContextM config a → InContextM config b → InContextM config b Source #

(<*)InContextM config a → InContextM config b → InContextM config a Source #

Functor (InContextM config) 
Instance details

Defined in Text.PrettyBy.Fixity

Methods

fmap ∷ (a → b) → InContextM config a → InContextM config b Source #

(<$) ∷ a → InContextM config b → InContextM config a Source #

Monad (InContextM config) 
Instance details

Defined in Text.PrettyBy.Fixity

Methods

(>>=)InContextM config a → (a → InContextM config b) → InContextM config b Source #

(>>)InContextM config a → InContextM config b → InContextM config b Source #

return ∷ a → InContextM config a Source #

MonadReader (Sole config) (InContextM config) 
Instance details

Defined in Text.PrettyBy.Fixity

Methods

askInContextM config (Sole config)

local ∷ (Sole config → Sole config) → InContextM config a → InContextM config a

reader ∷ (Sole config → a) → InContextM config a

(HasRenderContext config, doc ~ Doc ann) ⇒ IsString (InContextM config doc)

A string written in the InContextM monad gets enclosed with unitDocM automatically.

Instance details

Defined in Text.PrettyBy.Fixity

Methods

fromStringStringInContextM config doc Source #

newtype Sole a Source #

A newtype wrapper around a introduced for its HasPrettyConfig instance.

Constructors

Sole 

Fields

Instances

Instances details
HasPrettyConfigName (Sole PrettyConfigName) Source # 
Instance details

Defined in PlutusCore.Pretty.ConfigName

HasPrettyConfig (Sole config) config

It's not possible to have HasPrettyConfig config config, because that would mean that every environment is a pretty-printing config on its own, which doesn't make sense. We could have an OVERLAPPABLE instance, but I'd rather not.

Instance details

Defined in Text.PrettyBy.Fixity

Methods

prettyConfig ∷ Lens' (Sole config) config Source #

MonadReader (Sole config) (InContextM config) 
Instance details

Defined in Text.PrettyBy.Fixity

Methods

askInContextM config (Sole config)

local ∷ (Sole config → Sole config) → InContextM config a → InContextM config a

reader ∷ (Sole config → a) → InContextM config a

type HasPrettyDefaults (Sole config) Source # 
Instance details

Defined in PlutusCore.Pretty.Extra

type MonadPrettyContext config env (m ∷ TypeType) = (MonadPretty config env m, HasRenderContext config) Source #

A constraint for "m is a Monad supporting configurable precedence-aware pretty-printing".

class HasRenderContext config where Source #

A constraint for "RenderContext is a part of config".

Methods

renderContext ∷ Lens' config RenderContext Source #

type PrettyParens = PrettyBy RenderContext Source #

For pretty-printing a value with a minimum amount of parens.

class Profunctor (p ∷ TypeTypeType) where #

Minimal complete definition

dimap | lmap, rmap

Methods

dimap ∷ (a → b) → (c → d) → p b c → p a d #

lmap ∷ (a → b) → p b c → p a c #

rmap ∷ (b → c) → p a b → p a c #

Instances

Instances details
Profunctor ReifiedFold 
Instance details

Defined in Control.Lens.Reified

Methods

dimap ∷ (a → b) → (c → d) → ReifiedFold b c → ReifiedFold a d #

lmap ∷ (a → b) → ReifiedFold b c → ReifiedFold a c #

rmap ∷ (b → c) → ReifiedFold a b → ReifiedFold a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → ReifiedFold a b → ReifiedFold a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ ReifiedFold b c → q a b → ReifiedFold a c

Profunctor ReifiedGetter 
Instance details

Defined in Control.Lens.Reified

Methods

dimap ∷ (a → b) → (c → d) → ReifiedGetter b c → ReifiedGetter a d #

lmap ∷ (a → b) → ReifiedGetter b c → ReifiedGetter a c #

rmap ∷ (b → c) → ReifiedGetter a b → ReifiedGetter a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → ReifiedGetter a b → ReifiedGetter a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ ReifiedGetter b c → q a b → ReifiedGetter a c

Profunctor InContextM Source # 
Instance details

Defined in PlutusCore.Pretty.Extra

Methods

dimap ∷ (a → b) → (c → d) → InContextM b c → InContextM a d #

lmap ∷ (a → b) → InContextM b c → InContextM a c #

rmap ∷ (b → c) → InContextM a b → InContextM a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → InContextM a b → InContextM a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ InContextM b c → q a b → InContextM a c

Monad m ⇒ Profunctor (Kleisli m) 
Instance details

Defined in Data.Profunctor.Unsafe

Methods

dimap ∷ (a → b) → (c → d) → Kleisli m b c → Kleisli m a d #

lmap ∷ (a → b) → Kleisli m b c → Kleisli m a c #

rmap ∷ (b → c) → Kleisli m a b → Kleisli m a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → Kleisli m a b → Kleisli m a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ Kleisli m b c → q a b → Kleisli m a c

Profunctor (Indexed i) 
Instance details

Defined in Control.Lens.Internal.Indexed

Methods

dimap ∷ (a → b) → (c → d) → Indexed i b c → Indexed i a d #

lmap ∷ (a → b) → Indexed i b c → Indexed i a c #

rmap ∷ (b → c) → Indexed i a b → Indexed i a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → Indexed i a b → Indexed i a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ Indexed i b c → q a b → Indexed i a c

Profunctor (ReifiedIndexedFold i) 
Instance details

Defined in Control.Lens.Reified

Methods

dimap ∷ (a → b) → (c → d) → ReifiedIndexedFold i b c → ReifiedIndexedFold i a d #

lmap ∷ (a → b) → ReifiedIndexedFold i b c → ReifiedIndexedFold i a c #

rmap ∷ (b → c) → ReifiedIndexedFold i a b → ReifiedIndexedFold i a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → ReifiedIndexedFold i a b → ReifiedIndexedFold i a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ ReifiedIndexedFold i b c → q a b → ReifiedIndexedFold i a c

Profunctor (ReifiedIndexedGetter i) 
Instance details

Defined in Control.Lens.Reified

Methods

dimap ∷ (a → b) → (c → d) → ReifiedIndexedGetter i b c → ReifiedIndexedGetter i a d #

lmap ∷ (a → b) → ReifiedIndexedGetter i b c → ReifiedIndexedGetter i a c #

rmap ∷ (b → c) → ReifiedIndexedGetter i a b → ReifiedIndexedGetter i a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → ReifiedIndexedGetter i a b → ReifiedIndexedGetter i a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ ReifiedIndexedGetter i b c → q a b → ReifiedIndexedGetter i a c

Profunctor (CopastroSum p) 
Instance details

Defined in Data.Profunctor.Choice

Methods

dimap ∷ (a → b) → (c → d) → CopastroSum p b c → CopastroSum p a d #

lmap ∷ (a → b) → CopastroSum p b c → CopastroSum p a c #

rmap ∷ (b → c) → CopastroSum p a b → CopastroSum p a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → CopastroSum p a b → CopastroSum p a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ CopastroSum p b c → q a b → CopastroSum p a c

Profunctor (CotambaraSum p) 
Instance details

Defined in Data.Profunctor.Choice

Methods

dimap ∷ (a → b) → (c → d) → CotambaraSum p b c → CotambaraSum p a d #

lmap ∷ (a → b) → CotambaraSum p b c → CotambaraSum p a c #

rmap ∷ (b → c) → CotambaraSum p a b → CotambaraSum p a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → CotambaraSum p a b → CotambaraSum p a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ CotambaraSum p b c → q a b → CotambaraSum p a c

Profunctor (PastroSum p) 
Instance details

Defined in Data.Profunctor.Choice

Methods

dimap ∷ (a → b) → (c → d) → PastroSum p b c → PastroSum p a d #

lmap ∷ (a → b) → PastroSum p b c → PastroSum p a c #

rmap ∷ (b → c) → PastroSum p a b → PastroSum p a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → PastroSum p a b → PastroSum p a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ PastroSum p b c → q a b → PastroSum p a c

Profunctor p ⇒ Profunctor (TambaraSum p) 
Instance details

Defined in Data.Profunctor.Choice

Methods

dimap ∷ (a → b) → (c → d) → TambaraSum p b c → TambaraSum p a d #

lmap ∷ (a → b) → TambaraSum p b c → TambaraSum p a c #

rmap ∷ (b → c) → TambaraSum p a b → TambaraSum p a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → TambaraSum p a b → TambaraSum p a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ TambaraSum p b c → q a b → TambaraSum p a c

Profunctor p ⇒ Profunctor (Closure p) 
Instance details

Defined in Data.Profunctor.Closed

Methods

dimap ∷ (a → b) → (c → d) → Closure p b c → Closure p a d #

lmap ∷ (a → b) → Closure p b c → Closure p a c #

rmap ∷ (b → c) → Closure p a b → Closure p a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → Closure p a b → Closure p a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ Closure p b c → q a b → Closure p a c

Profunctor (Environment p) 
Instance details

Defined in Data.Profunctor.Closed

Methods

dimap ∷ (a → b) → (c → d) → Environment p b c → Environment p a d #

lmap ∷ (a → b) → Environment p b c → Environment p a c #

rmap ∷ (b → c) → Environment p a b → Environment p a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → Environment p a b → Environment p a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ Environment p b c → q a b → Environment p a c

Profunctor p ⇒ Profunctor (CofreeMapping p) 
Instance details

Defined in Data.Profunctor.Mapping

Methods

dimap ∷ (a → b) → (c → d) → CofreeMapping p b c → CofreeMapping p a d #

lmap ∷ (a → b) → CofreeMapping p b c → CofreeMapping p a c #

rmap ∷ (b → c) → CofreeMapping p a b → CofreeMapping p a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → CofreeMapping p a b → CofreeMapping p a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ CofreeMapping p b c → q a b → CofreeMapping p a c

Profunctor (FreeMapping p) 
Instance details

Defined in Data.Profunctor.Mapping

Methods

dimap ∷ (a → b) → (c → d) → FreeMapping p b c → FreeMapping p a d #

lmap ∷ (a → b) → FreeMapping p b c → FreeMapping p a c #

rmap ∷ (b → c) → FreeMapping p a b → FreeMapping p a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → FreeMapping p a b → FreeMapping p a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ FreeMapping p b c → q a b → FreeMapping p a c

Profunctor (Copastro p) 
Instance details

Defined in Data.Profunctor.Strong

Methods

dimap ∷ (a → b) → (c → d) → Copastro p b c → Copastro p a d #

lmap ∷ (a → b) → Copastro p b c → Copastro p a c #

rmap ∷ (b → c) → Copastro p a b → Copastro p a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → Copastro p a b → Copastro p a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ Copastro p b c → q a b → Copastro p a c

Profunctor (Cotambara p) 
Instance details

Defined in Data.Profunctor.Strong

Methods

dimap ∷ (a → b) → (c → d) → Cotambara p b c → Cotambara p a d #

lmap ∷ (a → b) → Cotambara p b c → Cotambara p a c #

rmap ∷ (b → c) → Cotambara p a b → Cotambara p a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → Cotambara p a b → Cotambara p a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ Cotambara p b c → q a b → Cotambara p a c

Profunctor (Pastro p) 
Instance details

Defined in Data.Profunctor.Strong

Methods

dimap ∷ (a → b) → (c → d) → Pastro p b c → Pastro p a d #

lmap ∷ (a → b) → Pastro p b c → Pastro p a c #

rmap ∷ (b → c) → Pastro p a b → Pastro p a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → Pastro p a b → Pastro p a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ Pastro p b c → q a b → Pastro p a c

Profunctor p ⇒ Profunctor (Tambara p) 
Instance details

Defined in Data.Profunctor.Strong

Methods

dimap ∷ (a → b) → (c → d) → Tambara p b c → Tambara p a d #

lmap ∷ (a → b) → Tambara p b c → Tambara p a c #

rmap ∷ (b → c) → Tambara p a b → Tambara p a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → Tambara p a b → Tambara p a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ Tambara p b c → q a b → Tambara p a c

Profunctor (Tagged ∷ TypeTypeType) 
Instance details

Defined in Data.Profunctor.Unsafe

Methods

dimap ∷ (a → b) → (c → d) → Tagged b c → Tagged a d #

lmap ∷ (a → b) → Tagged b c → Tagged a c #

rmap ∷ (b → c) → Tagged a b → Tagged a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → Tagged a b → Tagged a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ Tagged b c → q a b → Tagged a c

Functor w ⇒ Profunctor (Cokleisli w) 
Instance details

Defined in Data.Profunctor.Unsafe

Methods

dimap ∷ (a → b) → (c → d) → Cokleisli w b c → Cokleisli w a d #

lmap ∷ (a → b) → Cokleisli w b c → Cokleisli w a c #

rmap ∷ (b → c) → Cokleisli w a b → Cokleisli w a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → Cokleisli w a b → Cokleisli w a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ Cokleisli w b c → q a b → Cokleisli w a c

Profunctor (Exchange a b) 
Instance details

Defined in Control.Lens.Internal.Iso

Methods

dimap ∷ (a0 → b0) → (c → d) → Exchange a b b0 c → Exchange a b a0 d #

lmap ∷ (a0 → b0) → Exchange a b b0 c → Exchange a b a0 c #

rmap ∷ (b0 → c) → Exchange a b a0 b0 → Exchange a b a0 c #

(#.) ∷ ∀ a0 b0 c q. Coercible c b0 ⇒ q b0 c → Exchange a b a0 b0 → Exchange a b a0 c

(.#) ∷ ∀ a0 b0 c q. Coercible b0 a0 ⇒ Exchange a b b0 c → q a0 b0 → Exchange a b a0 c

Profunctor (Market a b) 
Instance details

Defined in Control.Lens.Internal.Prism

Methods

dimap ∷ (a0 → b0) → (c → d) → Market a b b0 c → Market a b a0 d #

lmap ∷ (a0 → b0) → Market a b b0 c → Market a b a0 c #

rmap ∷ (b0 → c) → Market a b a0 b0 → Market a b a0 c #

(#.) ∷ ∀ a0 b0 c q. Coercible c b0 ⇒ q b0 c → Market a b a0 b0 → Market a b a0 c

(.#) ∷ ∀ a0 b0 c q. Coercible b0 a0 ⇒ Market a b b0 c → q a0 b0 → Market a b a0 c

Functor f ⇒ Profunctor (Costar f) 
Instance details

Defined in Data.Profunctor.Types

Methods

dimap ∷ (a → b) → (c → d) → Costar f b c → Costar f a d #

lmap ∷ (a → b) → Costar f b c → Costar f a c #

rmap ∷ (b → c) → Costar f a b → Costar f a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → Costar f a b → Costar f a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ Costar f b c → q a b → Costar f a c

Profunctor (Forget r ∷ TypeTypeType) 
Instance details

Defined in Data.Profunctor.Types

Methods

dimap ∷ (a → b) → (c → d) → Forget r b c → Forget r a d #

lmap ∷ (a → b) → Forget r b c → Forget r a c #

rmap ∷ (b → c) → Forget r a b → Forget r a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → Forget r a b → Forget r a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ Forget r b c → q a b → Forget r a c

Functor f ⇒ Profunctor (Star f) 
Instance details

Defined in Data.Profunctor.Types

Methods

dimap ∷ (a → b) → (c → d) → Star f b c → Star f a d #

lmap ∷ (a → b) → Star f b c → Star f a c #

rmap ∷ (b → c) → Star f a b → Star f a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → Star f a b → Star f a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ Star f b c → q a b → Star f a c

Profunctor (->) 
Instance details

Defined in Data.Profunctor.Unsafe

Methods

dimap ∷ (a → b) → (c → d) → (b -> c) → a -> d #

lmap ∷ (a → b) → (b -> c) → a -> c #

rmap ∷ (b → c) → (a -> b) → a -> c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → (a -> b) → a -> c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ (b -> c) → q a b → a -> c

Contravariant f ⇒ Profunctor (Clown f ∷ TypeTypeType) 
Instance details

Defined in Data.Profunctor.Unsafe

Methods

dimap ∷ (a → b) → (c → d) → Clown f b c → Clown f a d #

lmap ∷ (a → b) → Clown f b c → Clown f a c #

rmap ∷ (b → c) → Clown f a b → Clown f a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → Clown f a b → Clown f a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ Clown f b c → q a b → Clown f a c

Functor f ⇒ Profunctor (Joker f ∷ TypeTypeType) 
Instance details

Defined in Data.Profunctor.Unsafe

Methods

dimap ∷ (a → b) → (c → d) → Joker f b c → Joker f a d #

lmap ∷ (a → b) → Joker f b c → Joker f a c #

rmap ∷ (b → c) → Joker f a b → Joker f a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → Joker f a b → Joker f a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ Joker f b c → q a b → Joker f a c

Arrow p ⇒ Profunctor (WrappedArrow p) 
Instance details

Defined in Data.Profunctor.Types

Methods

dimap ∷ (a → b) → (c → d) → WrappedArrow p b c → WrappedArrow p a d #

lmap ∷ (a → b) → WrappedArrow p b c → WrappedArrow p a c #

rmap ∷ (b → c) → WrappedArrow p a b → WrappedArrow p a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → WrappedArrow p a b → WrappedArrow p a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ WrappedArrow p b c → q a b → WrappedArrow p a c

(Profunctor p, Profunctor q) ⇒ Profunctor (Product p q) 
Instance details

Defined in Data.Profunctor.Unsafe

Methods

dimap ∷ (a → b) → (c → d) → Product p q b c → Product p q a d #

lmap ∷ (a → b) → Product p q b c → Product p q a c #

rmap ∷ (b → c) → Product p q a b → Product p q a c #

(#.) ∷ ∀ a b c q0. Coercible c b ⇒ q0 b c → Product p q a b → Product p q a c

(.#) ∷ ∀ a b c q0. Coercible b a ⇒ Product p q b c → q0 a b → Product p q a c

(Profunctor p, Profunctor q) ⇒ Profunctor (Sum p q) 
Instance details

Defined in Data.Profunctor.Unsafe

Methods

dimap ∷ (a → b) → (c → d) → Sum p q b c → Sum p q a d #

lmap ∷ (a → b) → Sum p q b c → Sum p q a c #

rmap ∷ (b → c) → Sum p q a b → Sum p q a c #

(#.) ∷ ∀ a b c q0. Coercible c b ⇒ q0 b c → Sum p q a b → Sum p q a c

(.#) ∷ ∀ a b c q0. Coercible b a ⇒ Sum p q b c → q0 a b → Sum p q a c

(Functor f, Profunctor p) ⇒ Profunctor (Tannen f p) 
Instance details

Defined in Data.Profunctor.Unsafe

Methods

dimap ∷ (a → b) → (c → d) → Tannen f p b c → Tannen f p a d #

lmap ∷ (a → b) → Tannen f p b c → Tannen f p a c #

rmap ∷ (b → c) → Tannen f p a b → Tannen f p a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → Tannen f p a b → Tannen f p a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ Tannen f p b c → q a b → Tannen f p a c

(Profunctor p, Profunctor q) ⇒ Profunctor (Procompose p q) 
Instance details

Defined in Data.Profunctor.Composition

Methods

dimap ∷ (a → b) → (c → d) → Procompose p q b c → Procompose p q a d #

lmap ∷ (a → b) → Procompose p q b c → Procompose p q a c #

rmap ∷ (b → c) → Procompose p q a b → Procompose p q a c #

(#.) ∷ ∀ a b c q0. Coercible c b ⇒ q0 b c → Procompose p q a b → Procompose p q a c

(.#) ∷ ∀ a b c q0. Coercible b a ⇒ Procompose p q b c → q0 a b → Procompose p q a c

(Profunctor p, Profunctor q) ⇒ Profunctor (Rift p q) 
Instance details

Defined in Data.Profunctor.Composition

Methods

dimap ∷ (a → b) → (c → d) → Rift p q b c → Rift p q a d #

lmap ∷ (a → b) → Rift p q b c → Rift p q a c #

rmap ∷ (b → c) → Rift p q a b → Rift p q a c #

(#.) ∷ ∀ a b c q0. Coercible c b ⇒ q0 b c → Rift p q a b → Rift p q a c

(.#) ∷ ∀ a b c q0. Coercible b a ⇒ Rift p q b c → q0 a b → Rift p q a c

(Profunctor p, Functor f, Functor g) ⇒ Profunctor (Biff p f g) 
Instance details

Defined in Data.Profunctor.Unsafe

Methods

dimap ∷ (a → b) → (c → d) → Biff p f g b c → Biff p f g a d #

lmap ∷ (a → b) → Biff p f g b c → Biff p f g a c #

rmap ∷ (b → c) → Biff p f g a b → Biff p f g a c #

(#.) ∷ ∀ a b c q. Coercible c b ⇒ q b c → Biff p f g a b → Biff p f g a c

(.#) ∷ ∀ a b c q. Coercible b a ⇒ Biff p f g b c → q a b → Biff p f g a c

encloseIn Source #

Arguments

Ord prec 
⇒ (a → a)

Enclose a value of type a in parens.

RenderContextOver prec

An outer context.

FixityOver prec

An inner fixity.

→ a 
→ a 

Enclose an a (using the provided function) if required or leave it as is. The need for enclosing is determined from an outer RenderContext and the inner fixity.

botFixityFixity Source #

A fixity with the lowest precedence. When used as a part of an outer context, never causes addition of parens.

juxtFixityFixity Source #

The fixity of juxtaposition.

unitFixityFixity Source #

The fixity of a unitary expression which is safe to render without parens in any context.

topFixityFixity Source #

A fixity with the highest precedence. When used as a part of an outer context, always causes addition of parens.

botRenderContextRenderContext Source #

An initial RenderContext. An expression printed in this context never gets enclosed in parens.

topRenderContextRenderContext Source #

An initial RenderContext. An expression printed in this context always gets enclosed in parens.

prettyM ∷ (MonadPretty config env m, PrettyBy config a) ⇒ a → m (Doc ann) Source #

Pretty-print a value in a configurable way in a monad holding a config.

displayM ∷ ∀ str a m env config. (MonadPretty config env m, PrettyBy config a, Render str) ⇒ a → m str Source #

Pretty-print and render a value as a string type in a configurable way in a monad holding a config.

runInContextM ∷ config → InContextM config a → a Source #

Run InContextM by supplying a config.

inContextM ∷ (a → InContextM config (Doc ann)) → config → a → Doc ann Source #

Takes a monadic pretty-printer and turns it into one that receives a config explicitly. Useful for defining instances of PrettyBy monadically when writing precedence-aware pretty-printing code (and since all functions below are monadic, it's currenty the only option).

encloseMMonadPrettyContext config env m ⇒ FixityDoc ann → m (Doc ann) Source #

Enclose a Doc in parentheses if required or leave it as is. The need for enclosing is determined from an outer RenderContext (stored in the environment of the monad) and the inner fixity provided as an argument.

withPrettyInMonadPrettyContext config env m ⇒ ((∀ a. PrettyBy config a ⇒ DirectionFixity → a → Doc ann) → m r) → m r Source #

Instantiate a supplied continuation with a precedence-aware pretty-printer.

withPrettyAtMonadPrettyContext config env m ⇒ DirectionFixity → (AnyToDoc config ann → m r) → m r Source #

Instantiate a supplied continuation with a pretty-printer specialized to supplied Fixity and Direction.

unitDocMMonadPrettyContext config env m ⇒ Doc ann → m (Doc ann) Source #

compoundDocMMonadPrettyContext config env m ⇒ Fixity → ((∀ a. PrettyBy config a ⇒ DirectionFixity → a → Doc ann) → Doc ann) → m (Doc ann) Source #

Instantiate a supplied continuation with a pretty-printer and apply encloseM, specialized to supplied Fixity, to the result.

sequenceDocMMonadPrettyContext config env m ⇒ DirectionFixity → (AnyToDoc config ann → Doc ann) → m (Doc ann) Source #

Instantiate a supplied continuation with a pretty-printer specialized to supplied Fixity and Direction and apply encloseM specialized to the provided fixity to the result. This can be useful for pretty-printing a sequence of values (possibly consisting of a single value).

infixDocMMonadPrettyContext config env m ⇒ Fixity → (AnyToDoc config ann → AnyToDoc config ann → Doc ann) → m (Doc ann) Source #

Instantiate a supplied continuation with two pretty-printers (one is going in the ToTheLeft direction, the other is in the ToTheRight direction) specialized to supplied Fixity and apply encloseM, specialized to the same fixity, to the result. The idea is that to the outside an infix operator has the same inner fixity as it has the outer fixity to inner subexpressions.

juxtPrettyM ∷ (MonadPrettyContext config env m, PrettyBy config a, PrettyBy config b) ⇒ a → b → m (Doc ann) Source #

Pretty-print two things with a space between them. The fixity of the context in which the arguments get pretty-printed is set to juxtFixity.

juxtRenderContextRenderContext Source #

An initial RenderContext. An expression printed in this context gets enclosed in parens unless its outermost operator (if any) binds even stronger than function application.

data ShowKinds Source #

Instances

Instances details
Show ShowKinds Source # 
Instance details

Defined in PlutusCore.Pretty.Readable

Default ShowKinds Source # 
Instance details

Defined in PlutusCore.Pretty.Readable

Methods

defShowKinds #

Eq ShowKinds Source # 
Instance details

Defined in PlutusCore.Pretty.Readable

data PrettyConfigReadable configName Source #

Configuration for the readable pretty-printing.

Instances

Instances details
configName ~ PrettyConfigNameHasPrettyConfigName (PrettyConfigReadable configName) Source # 
Instance details

Defined in PlutusCore.Pretty.Readable

HasRenderContext (PrettyConfigReadable configName) Source # 
Instance details

Defined in PlutusCore.Pretty.Readable

PrettyBy (PrettyConfigReadable configName) (Kind a) Source # 
Instance details

Defined in PlutusCore.Core.Instance.Pretty.Readable

Methods

prettyByPrettyConfigReadable configName → Kind a → Doc ann Source #

prettyListByPrettyConfigReadable configName → [Kind a] → Doc ann Source #

PrettyReadableBy configName a ⇒ PrettyBy (PrettyConfigReadable configName) (Parened a) Source # 
Instance details

Defined in PlutusCore.Pretty.Readable

Methods

prettyByPrettyConfigReadable configName → Parened a → Doc ann Source #

prettyListByPrettyConfigReadable configName → [Parened a] → Doc ann Source #

PrettyReadableBy configName tyname ⇒ PrettyBy (PrettyConfigReadable configName) (TyVarDecl tyname ann) Source # 
Instance details

Defined in PlutusCore.Core.Instance.Pretty.Readable

Methods

prettyByPrettyConfigReadable configName → TyVarDecl tyname ann → Doc ann0 Source #

prettyListByPrettyConfigReadable configName → [TyVarDecl tyname ann] → Doc ann0 Source #

(PrettyReadableBy configName tyname, PrettyParens (SomeTypeIn uni)) ⇒ PrettyBy (PrettyConfigReadable configName) (Type tyname uni a) Source # 
Instance details

Defined in PlutusCore.Core.Instance.Pretty.Readable

Methods

prettyByPrettyConfigReadable configName → Type tyname uni a → Doc ann Source #

prettyListByPrettyConfigReadable configName → [Type tyname uni a] → Doc ann Source #

(PrettyReadable name, PrettyUni uni, Pretty fun) ⇒ PrettyBy (PrettyConfigReadable PrettyConfigName) (UnrestrictedProgram name uni fun ann) Source # 
Instance details

Defined in UntypedPlutusCore.Core.Instance.Flat

(PrettyReadableBy configName tyname, PrettyReadableBy configName name, PrettyUni uni) ⇒ PrettyBy (PrettyConfigReadable configName) (VarDecl tyname name uni ann) Source # 
Instance details

Defined in PlutusCore.Core.Instance.Pretty.Readable

Methods

prettyByPrettyConfigReadable configName → VarDecl tyname name uni ann → Doc ann0 Source #

prettyListByPrettyConfigReadable configName → [VarDecl tyname name uni ann] → Doc ann0 Source #

PrettyReadableBy configName (Term name uni fun a) ⇒ PrettyBy (PrettyConfigReadable configName) (Program name uni fun a) Source # 
Instance details

Defined in UntypedPlutusCore.Core.Instance.Pretty.Readable

Methods

prettyByPrettyConfigReadable configName → Program name uni fun a → Doc ann Source #

prettyListByPrettyConfigReadable configName → [Program name uni fun a] → Doc ann Source #

(PrettyReadableBy configName name, PrettyUni uni, Pretty fun) ⇒ PrettyBy (PrettyConfigReadable configName) (Term name uni fun a) Source # 
Instance details

Defined in UntypedPlutusCore.Core.Instance.Pretty.Readable

Methods

prettyByPrettyConfigReadable configName → Term name uni fun a → Doc ann Source #

prettyListByPrettyConfigReadable configName → [Term name uni fun a] → Doc ann Source #

PrettyReadableBy configName (Term tyname name uni fun a) ⇒ PrettyBy (PrettyConfigReadable configName) (Program tyname name uni fun a) Source # 
Instance details

Defined in PlutusCore.Core.Instance.Pretty.Readable

Methods

prettyByPrettyConfigReadable configName → Program tyname name uni fun a → Doc ann Source #

prettyListByPrettyConfigReadable configName → [Program tyname name uni fun a] → Doc ann Source #

(PrettyReadableBy configName tyname, PrettyReadableBy configName name, PrettyUni uni, Pretty fun) ⇒ PrettyBy (PrettyConfigReadable configName) (Term tyname name uni fun a) Source # 
Instance details

Defined in PlutusCore.Core.Instance.Pretty.Readable

Methods

prettyByPrettyConfigReadable configName → Term tyname name uni fun a → Doc ann Source #

prettyListByPrettyConfigReadable configName → [Term tyname name uni fun a] → Doc ann Source #

type HasPrettyDefaults (PrettyConfigReadable _1) Source # 
Instance details

Defined in PlutusCore.Pretty.Readable

type PrettyReadableBy configName = PrettyBy (PrettyConfigReadable configName) Source #

The "readably pretty-printable" constraint.

newtype AsReadable a Source #

For rendering things in a readable manner regardless of the pretty-printing function chosen. I.e. all of show, pretty, prettyClassicDef will use PrettyReadable instead of doing what they normally do. prettyBy config (AsReadable x) requires config to have a PrettyConfigName and respects it.

This wrapper can be particularly useful if you want to apply a function having a Show or Pretty or PrettyClassic or PrettyPlc or whatever constraint, but want to get the argument rendered in a readable manner instead.

Constructors

AsReadable 

Fields

Instances

Instances details
(HasPrettyConfigName config, PrettyReadable a) ⇒ DefaultPrettyBy config (AsReadable a) Source # 
Instance details

Defined in PlutusCore.Pretty.Readable

Methods

defaultPrettyBy ∷ config → AsReadable a → Doc ann Source #

defaultPrettyListBy ∷ config → [AsReadable a] → Doc ann Source #

PrettyDefaultBy config (AsReadable a) ⇒ PrettyBy config (AsReadable a) Source # 
Instance details

Defined in PlutusCore.Pretty.Readable

Methods

prettyBy ∷ config → AsReadable a → Doc ann Source #

prettyListBy ∷ config → [AsReadable a] → Doc ann Source #

PrettyReadable a ⇒ Show (AsReadable a) Source # 
Instance details

Defined in PlutusCore.Pretty.Readable

PrettyReadable a ⇒ Pretty (AsReadable a) Source # 
Instance details

Defined in PlutusCore.Pretty.Readable

Methods

prettyAsReadable a → Doc ann #

prettyList ∷ [AsReadable a] → Doc ann #

data Parened a Source #

A value of type a to render in parens using the readable pretty-printer.

Constructors

Parened 

Instances

Instances details
PrettyReadableBy configName a ⇒ PrettyBy (PrettyConfigReadable configName) (Parened a) Source # 
Instance details

Defined in PlutusCore.Pretty.Readable

Methods

prettyByPrettyConfigReadable configName → Parened a → Doc ann Source #

prettyListByPrettyConfigReadable configName → [Parened a] → Doc ann Source #

type MonadPrettyReadable configName env m = MonadPretty (PrettyConfigReadable configName) env m Source #

A constraint for "m is a monad that allows for pretty-printing values via a PrettyConfigReadable.

type ReadableToDoc configName ann = ∀ a. PrettyReadableBy configName a ⇒ a → Doc ann Source #

The type of a PrettyConfigReadable-based pretty-printer, similar to AnyToDoc.

pcrConfigName ∷ ∀ configName configName. Lens (PrettyConfigReadable configName) (PrettyConfigReadable configName) configName configName Source #

pcrShowKinds ∷ ∀ configName. Lens' (PrettyConfigReadable configName) ShowKinds Source #

inBraces ∷ a → Parened a Source #

Enclose the given value, so that it's rendered inside of braces with no additional parens regardless of the RenderContext.

topPrettyConfigReadable ∷ configName → ShowKindsPrettyConfigReadable configName Source #

A PrettyConfigReadable with the fixity specified to topFixity.

botPrettyConfigReadable ∷ configName → ShowKindsPrettyConfigReadable configName Source #

A PrettyConfigReadable with the fixity specified to botFixity.

binderFixityFixity Source #

The fixity of a binder.

arrowFixityFixity Source #

The fixity of (->).

iterTyForallPrettyM ∷ (MonadPrettyReadable configName env m, PrettyReadableBy configName arg, PrettyReadableBy configName body) ⇒ [arg] → body → m (Doc ann) Source #

Lay out an iterated TyForall via iterBinderPrettyM.

iterLamAbsPrettyM ∷ (MonadPrettyReadable configName env m, PrettyReadableBy configName arg, PrettyReadableBy configName body) ⇒ [arg] → body → m (Doc ann) Source #

Lay out an iterated LamAbs via iterBinderPrettyM.

iterTyAbsPrettyM ∷ (MonadPrettyReadable configName env m, PrettyReadableBy configName arg, PrettyReadableBy configName body) ⇒ [arg] → body → m (Doc ann) Source #

Lay out an iterated TyAbs via iterBinderPrettyM.

iterArrowPrettyM ∷ (MonadPrettyReadable configName env m, PrettyReadableBy configName a) ⇒ [a] → a → m (Doc ann) Source #

Lay out an iterated ->.

iterAppDocMMonadPrettyContext config env m ⇒ (AnyToDoc config ann → AnyToDoc config ann → NonEmpty (Doc ann)) → m (Doc ann) Source #

Lay out an iteration application, providing to the caller a function to render the head of the application and a function to render each of the arguments.

iterInterAppPrettyM ∷ (MonadPrettyReadable configName env m, PrettyReadableBy configName fun, PrettyReadableBy configName ty, PrettyReadableBy configName term) ⇒ fun → [Either ty term] → m (Doc ann) Source #

Lay out interleaved function applications either as

foo {a} x {b} y z

or as

foo
  {a}
  x
  {b}
  y
  z

Lefts are laid out in braces, Rights are laid out without braces.

iterAppPrettyM ∷ (MonadPrettyContext config env m, PrettyBy config fun, PrettyBy config term) ⇒ fun → [term] → m (Doc ann) Source #

Lay out iterated function applications either as

foo x y z

or as

foo
  x
  y
  z

iterBinderPrettyM ∷ (MonadPrettyReadable configName env m, PrettyReadableBy configName arg, PrettyReadableBy configName body) ⇒ (Doc ann → Doc ann) → [arg] → body → m (Doc ann) Source #

Lay out an iterated binder. For example, this function lays out iterated lambdas either as

\(x : a) (y : b) (z : c) -> body

or as

\(x : a)
 (y : b)
 (z : c) ->
  body