Michelson.Printer.Util

Documentation

class RenderDoc a where

Generalize converting a type into a Text.PrettyPrint.Leijen.Text.Doc. Used to pretty print Michelson code and define Fmt.Buildable instances.

Minimal complete definition

renderDoc

Methods

renderDoc :: RenderContext -> a -> Doc

isRenderable :: a -> Bool

Whether a value can be represented in Michelson code. Normally either all values of some type are renderable or not renderable. However, in case of instructions we have extra instructions which should not be rendered. Note: it's not suficcient to just return mempty for such instructions, because sometimes we want to print lists of instructions and we need to ignore them complete (to avoid putting redundant separators).

Instances

RenderDoc AnnotationSet

Defined in Michelson.Untyped.Annotation

Methods

renderDoc :: RenderContext -> AnnotationSet -> Doc

isRenderable :: AnnotationSet -> Bool

RenderDoc T

Defined in Michelson.Untyped.Type

Methods

renderDoc :: RenderContext -> T -> Doc

isRenderable :: T -> Bool

RenderDoc ParameterType

Defined in Michelson.Untyped.Type

Methods

renderDoc :: RenderContext -> ParameterType -> Doc

isRenderable :: ParameterType -> Bool

RenderDoc Type

Defined in Michelson.Untyped.Type

Methods

renderDoc :: RenderContext -> Type -> Doc

isRenderable :: Type -> Bool

RenderDoc ExpandedOp

Defined in Michelson.Untyped.Instr

Methods

renderDoc :: RenderContext -> ExpandedOp -> Doc

isRenderable :: ExpandedOp -> Bool

RenderDoc TypeCheckedOp

Defined in Michelson.TypeCheck.TypeCheckedOp

Methods

renderDoc :: RenderContext -> TypeCheckedOp -> Doc

isRenderable :: TypeCheckedOp -> Bool

RenderDoc ParsedOp

Defined in Michelson.Macro

Methods

renderDoc :: RenderContext -> ParsedOp -> Doc

isRenderable :: ParsedOp -> Bool

RenderDoc (Prettier ParameterType)

Defined in Michelson.Untyped.Type

Methods

renderDoc :: RenderContext -> Prettier ParameterType -> Doc

isRenderable :: Prettier ParameterType -> Bool

RenderDoc (Prettier Type)

Defined in Michelson.Untyped.Type

Methods

renderDoc :: RenderContext -> Prettier Type -> Doc

isRenderable :: Prettier Type -> Bool

RenderDoc op => RenderDoc (ExtInstrAbstract op)

Defined in Michelson.Untyped.Ext

Methods

renderDoc :: RenderContext -> ExtInstrAbstract op -> Doc

isRenderable :: ExtInstrAbstract op -> Bool

RenderDoc op => RenderDoc (Contract' op)

Defined in Michelson.Untyped.Contract

Methods

renderDoc :: RenderContext -> Contract' op -> Doc

isRenderable :: Contract' op -> Bool

RenderDoc op => RenderDoc (Elt op)

Defined in Michelson.Untyped.Value

Methods

renderDoc :: RenderContext -> Elt op -> Doc

isRenderable :: Elt op -> Bool

RenderDoc op => RenderDoc (Value' op)

Defined in Michelson.Untyped.Value

Methods

renderDoc :: RenderContext -> Value' op -> Doc

isRenderable :: Value' op -> Bool

RenderDoc op => RenderDoc (InstrAbstract op)

Defined in Michelson.Untyped.Instr

Methods

renderDoc :: RenderContext -> InstrAbstract op -> Doc

isRenderable :: InstrAbstract op -> Bool

RenderDoc (Notes t)

Defined in Michelson.Typed.Annotation

Methods

renderDoc :: RenderContext -> Notes t -> Doc

isRenderable :: Notes t -> Bool

RenderDoc (PackedNotes a)

Defined in Michelson.Typed.Instr

Methods

renderDoc :: RenderContext -> PackedNotes a -> Doc

isRenderable :: PackedNotes a -> Bool

KnownAnnTag tag => RenderDoc (Annotation tag)

Defined in Michelson.Untyped.Annotation

Methods

renderDoc :: RenderContext -> Annotation tag -> Doc

isRenderable :: Annotation tag -> Bool

newtype Prettier a

A new type that can wrap values so that the RenderDoc instances of the combined value can have a different behavior for the pretty printer.

Constructors

Prettier a

Instances

RenderDoc (Prettier ParameterType)

Defined in Michelson.Untyped.Type

Methods

renderDoc :: RenderContext -> Prettier ParameterType -> Doc

isRenderable :: Prettier ParameterType -> Bool

RenderDoc (Prettier Type)

Defined in Michelson.Untyped.Type

Methods

renderDoc :: RenderContext -> Prettier Type -> Doc

isRenderable :: Prettier Type -> Bool

printDoc :: Bool -> Doc -> Text

Convert Doc to Text with a line width of 80.

printDocB :: Bool -> Doc -> Builder

Convert Doc to Builder in the same maner as printDoc.

printDocS :: Bool -> Doc -> String

Convert Doc to String in the same maner as printDoc.

renderOps :: RenderDoc op => Bool -> NonEmpty op -> Doc

Generic way to render the different op types that get passed to a contract.

renderOpsList :: RenderDoc op => Bool -> [op] -> Doc

renderOpsListNoBraces :: RenderDoc op => Bool -> [op] -> Doc

spaces :: Int -> Doc

Create a specific number of spaces.

wrapInParens :: RenderContext -> NonEmpty Doc -> Doc

Wrap documents in parentheses if there are two or more in the list.

buildRenderDoc :: RenderDoc a => a -> Builder

Turn something that is instance of RenderDoc into a Builder. It's formatted the same way as printDoc formats docs.

Smart parentheses

data RenderContext

Environment carried during recursive rendering.

needsParens :: RenderContext

ParensNeeded constant.

doesntNeedParens :: RenderContext

ParensNeeded constant.

addParens :: RenderContext -> Doc -> Doc

Add parentheses if needed.

assertParensNotNeeded :: RenderContext -> a -> a

Ensure parentheses are not required, for case when you cannot sensibly wrap your expression into them.