Safe Haskell	None
Language	Haskell2010

Michelson.Printer

Synopsis

class RenderDoc a where
- renderDoc :: RenderContext -> a -> Doc
- isRenderable :: a -> Bool
printDoc :: Bool -> Doc -> Text
printUntypedContract :: RenderDoc op => Bool -> Contract' op -> Text
printTypedContractCode :: (SingI p, SingI s) => Bool -> ContractCode p s -> Text
printTypedContract :: Bool -> Contract p s -> Text
printSomeContract :: Bool -> SomeContract -> Text
printTypedValue :: forall t. ProperPrintedValBetterErrors t => Bool -> Value t -> Text
printUntypedValue :: RenderDoc op => Bool -> Value' op -> Text

Documentation

class RenderDoc a where Source #

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 Source #

isRenderable :: a -> Bool Source #

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

Instances details

RenderDoc AnnotationSet Source #
Instance details Defined in Michelson.Untyped.Annotation Methods renderDoc :: RenderContext -> AnnotationSet -> Doc Source # isRenderable :: AnnotationSet -> Bool Source #
RenderDoc T Source #
Instance details Defined in Michelson.Untyped.Type Methods renderDoc :: RenderContext -> T -> Doc Source # isRenderable :: T -> Bool Source #
RenderDoc ParameterType Source #
Instance details Defined in Michelson.Untyped.Type Methods renderDoc :: RenderContext -> ParameterType -> Doc Source # isRenderable :: ParameterType -> Bool Source #
RenderDoc Type Source #
Instance details Defined in Michelson.Untyped.Type Methods renderDoc :: RenderContext -> Type -> Doc Source # isRenderable :: Type -> Bool Source #
RenderDoc ExpandedOp Source #
Instance details Defined in Michelson.Untyped.Instr Methods renderDoc :: RenderContext -> ExpandedOp -> Doc Source # isRenderable :: ExpandedOp -> Bool Source #
RenderDoc TypeCheckedOp Source #
Instance details Defined in Michelson.TypeCheck.TypeCheckedOp Methods renderDoc :: RenderContext -> TypeCheckedOp -> Doc Source # isRenderable :: TypeCheckedOp -> Bool Source #
RenderDoc ParsedOp Source #
Instance details Defined in Michelson.Macro Methods renderDoc :: RenderContext -> ParsedOp -> Doc Source # isRenderable :: ParsedOp -> Bool Source #
RenderDoc (Prettier ParameterType) Source #
Instance details Defined in Michelson.Untyped.Type Methods renderDoc :: RenderContext -> Prettier ParameterType -> Doc Source # isRenderable :: Prettier ParameterType -> Bool Source #
RenderDoc (Prettier Type) Source #
Instance details Defined in Michelson.Untyped.Type Methods renderDoc :: RenderContext -> Prettier Type -> Doc Source # isRenderable :: Prettier Type -> Bool Source #
RenderDoc op => RenderDoc (ExtInstrAbstract op) Source #
Instance details Defined in Michelson.Untyped.Ext Methods renderDoc :: RenderContext -> ExtInstrAbstract op -> Doc Source # isRenderable :: ExtInstrAbstract op -> Bool Source #
RenderDoc op => RenderDoc (Contract' op) Source #
Instance details Defined in Michelson.Untyped.Contract Methods renderDoc :: RenderContext -> Contract' op -> Doc Source # isRenderable :: Contract' op -> Bool Source #
RenderDoc op => RenderDoc (Elt op) Source #
Instance details Defined in Michelson.Untyped.Value Methods renderDoc :: RenderContext -> Elt op -> Doc Source # isRenderable :: Elt op -> Bool Source #
RenderDoc op => RenderDoc (Value' op) Source #
Instance details Defined in Michelson.Untyped.Value Methods renderDoc :: RenderContext -> Value' op -> Doc Source # isRenderable :: Value' op -> Bool Source #
RenderDoc op => RenderDoc (InstrAbstract op) Source #
Instance details Defined in Michelson.Untyped.Instr Methods renderDoc :: RenderContext -> InstrAbstract op -> Doc Source # isRenderable :: InstrAbstract op -> Bool Source #
RenderDoc (Notes t) Source #
Instance details Defined in Michelson.Typed.Annotation Methods renderDoc :: RenderContext -> Notes t -> Doc Source # isRenderable :: Notes t -> Bool Source #
RenderDoc (PackedNotes a) Source #
Instance details Defined in Michelson.Typed.Instr Methods renderDoc :: RenderContext -> PackedNotes a -> Doc Source # isRenderable :: PackedNotes a -> Bool Source #
KnownAnnTag tag => RenderDoc (Annotation tag) Source #
Instance details Defined in Michelson.Untyped.Annotation Methods renderDoc :: RenderContext -> Annotation tag -> Doc Source # isRenderable :: Annotation tag -> Bool Source #

printDoc :: Bool -> Doc -> Text Source #

Convert Doc to Text with a line width of 80.

printUntypedContract :: RenderDoc op => Bool -> Contract' op -> Text Source #

Convert an untyped contract into a textual representation which will be accepted by the OCaml reference client.

printTypedContractCode :: (SingI p, SingI s) => Bool -> ContractCode p s -> Text Source #

Convert a typed contract into a textual representation which will be accepted by the OCaml reference client.

printTypedContract :: Bool -> Contract p s -> Text Source #

Convert typed contract into a textual representation which will be accepted by the OCaml reference client.

printSomeContract :: Bool -> SomeContract -> Text Source #

Convert SomeContract into a textual representation which will be accepted by the OCaml reference client.

printTypedValue :: forall t. ProperPrintedValBetterErrors t => Bool -> Value t -> Text Source #

Convert typed value into a textual representation which will be accepted by the OCaml reference client.

printUntypedValue :: RenderDoc op => Bool -> Value' op -> Text Source #

Convert untyped value into a textual representation which will be accepted by the OCaml reference client.