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 :: 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 VarAnn

Defined in Michelson.Untyped.Annotation

Methods

renderDoc :: VarAnn -> Doc

isRenderable :: VarAnn -> Bool

RenderDoc FieldAnn

Defined in Michelson.Untyped.Annotation

Methods

renderDoc :: FieldAnn -> Doc

isRenderable :: FieldAnn -> Bool

RenderDoc TypeAnn

Defined in Michelson.Untyped.Annotation

Methods

renderDoc :: TypeAnn -> Doc

isRenderable :: TypeAnn -> Bool

RenderDoc CT

Defined in Michelson.Untyped.Type

Methods

renderDoc :: CT -> Doc

isRenderable :: CT -> Bool

RenderDoc T

Defined in Michelson.Untyped.Type

Methods

renderDoc :: T -> Doc

isRenderable :: T -> Bool

RenderDoc Comparable

Defined in Michelson.Untyped.Type

Methods

renderDoc :: Comparable -> Doc

isRenderable :: Comparable -> Bool

RenderDoc Type

Defined in Michelson.Untyped.Type

Methods

renderDoc :: Type -> Doc

isRenderable :: Type -> Bool

RenderDoc ExpandedOp

Defined in Michelson.Untyped.Instr

Methods

renderDoc :: ExpandedOp -> Doc

isRenderable :: ExpandedOp -> Bool

RenderDoc Op

Defined in Michelson.Untyped.Instr

Methods

renderDoc :: Op -> Doc

isRenderable :: Op -> Bool

RenderDoc ParsedOp

Defined in Morley.Types

Methods

renderDoc :: ParsedOp -> Doc

isRenderable :: ParsedOp -> Bool

RenderDoc op => RenderDoc (Elt op)

Defined in Michelson.Untyped.Value

Methods

renderDoc :: Elt op -> Doc

isRenderable :: Elt op -> Bool

RenderDoc op => RenderDoc (Value op)

Defined in Michelson.Untyped.Value

Methods

renderDoc :: Value op -> Doc

isRenderable :: Value op -> Bool

RenderDoc op => RenderDoc (Contract op)

Defined in Michelson.Untyped.Contract

Methods

renderDoc :: Contract op -> Doc

isRenderable :: Contract op -> Bool

RenderDoc op => RenderDoc (InstrAbstract op)

Defined in Michelson.Untyped.Instr

Methods

renderDoc :: InstrAbstract op -> Doc

isRenderable :: InstrAbstract op -> Bool

printDoc :: Doc -> Text

Convert Doc to Text with a line width of 80.

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

spaces :: Int -> Doc

Create a specific number of spaces.

wrapInParens :: 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.