language-thrift-0.10.0.0: Parser and pretty printer for the Thrift IDL format.

Copyright(c) Abhinav Gupta 2016
LicenseBSD3
MaintainerAbhinav Gupta <mail@abhinavg.net>
Stabilityexperimental
Safe HaskellSafe
LanguageHaskell2010

Language.Thrift.Pretty

Contents

Description

This module provides a pretty printer for Thrift IDLs. Most of the printers defined in this module produce output highlighted using ANSI escape codes. Get plain output by using plain.

Use prettyPrintHighlighted to produce output highlighted using ANSI escape codes. Note that this output will be unparseable and is suitable for printing inside a compatible terminal only. Use prettyPrint if you don't want highlighted output.

The behavior of the printer can be customized using Config objects.

The module also exports instances of the Pretty typeclass for elements of the AST.

Synopsis

Documentation

prettyPrintHighlighted :: Program ann -> Doc Source

Top-level pretty printer for Thrift documents.

prettyPrint :: Program ann -> Doc Source

Top-level pretty printer for Thrift documents that uses the default configuration (defaultConfig) for pretty printing.

Components

program :: Config -> Program ann -> Doc Source

Pretty print a Thrift IDL.

header :: Header ann -> Doc Source

Print the headers for a program.

include :: Include ann -> Doc Source

namespace :: Namespace ann -> Doc Source

definition :: Config -> Definition ann -> Doc Source

Print a constant, type, or service definition.

constant :: Config -> Const ann -> Doc Source

typeDefinition :: Config -> Type ann -> Doc Source

service :: Config -> Service ann -> Doc Source

typedef :: Config -> Typedef ann -> Doc Source

enum :: Config -> Enum ann -> Doc Source

struct :: Config -> Struct ann -> Doc Source

union :: Config -> Struct ann -> Doc Source

Deprecated: Use struct.

exception :: Config -> Struct ann -> Doc Source

Deprecated: Use struct.

senum :: Config -> Senum ann -> Doc Source

typeReference :: Config -> TypeReference ann -> Doc Source

Pretty print a field type.

constantValue :: Config -> ConstValue ann -> Doc Source

Pretty print a constant value.

docstring :: Text -> Doc Source

Configuration

data Config Source

Configuration for the pretty printer.

Constructors

Config 

Fields

indentWidth :: Int

Number of spaces to use for indentation.

Instances

defaultConfig :: Config Source

Default pretty printing configuration.