Language.Thrift.Pretty

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.

Documentation

prettyPrintHighlighted :: Program ann -> Doc

Top-level pretty printer for Thrift documents.

prettyPrint :: Program ann -> Doc

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

Components

program :: Config -> Program ann -> Doc

Pretty print a Thrift IDL.

header :: Header ann -> Doc

Print the headers for a program.

include :: Include ann -> Doc

namespace :: Namespace ann -> Doc

definition :: Config -> Definition ann -> Doc

Print a constant, type, or service definition.

constant :: Config -> Const ann -> Doc

typeDefinition :: Config -> Type ann -> Doc

service :: Config -> Service ann -> Doc

typedef :: Config -> Typedef ann -> Doc

enum :: Config -> Enum ann -> Doc

struct :: Config -> Struct ann -> Doc

union :: Config -> Struct ann -> Doc

Deprecated: Use struct.

exception :: Config -> Struct ann -> Doc

Deprecated: Use struct.

senum :: Config -> Senum ann -> Doc

typeReference :: Config -> TypeReference ann -> Doc

Pretty print a field type.

constantValue :: Config -> ConstValue ann -> Doc

Pretty print a constant value.

docstring :: Text -> Doc

Configuration

data Config

Configuration for the pretty printer.

Constructors

Config

Fields

• indentWidth :: Int

  Number of spaces to use for indentation.

Instances

Eq Config

Defined in Language.Thrift.Pretty

Methods

(==) :: Config -> Config -> Bool

(/=) :: Config -> Config -> Bool

Ord Config

Defined in Language.Thrift.Pretty

Methods

compare :: Config -> Config -> Ordering

(<) :: Config -> Config -> Bool

(<=) :: Config -> Config -> Bool

(>) :: Config -> Config -> Bool

(>=) :: Config -> Config -> Bool

max :: Config -> Config -> Config

min :: Config -> Config -> Config

Show Config

Defined in Language.Thrift.Pretty

Methods

showsPrec :: Int -> Config -> ShowS

show :: Config -> String

showList :: [Config] -> ShowS

defaultConfig :: Config

Default pretty printing configuration.

Orphan instances

Pretty FieldRequiredness

Methods

pretty :: FieldRequiredness -> Doc

prettyList :: [FieldRequiredness] -> Doc

Pretty TypeAnnotation

Methods

pretty :: TypeAnnotation -> Doc

prettyList :: [TypeAnnotation] -> Doc

Pretty (Program a)

Methods

pretty :: Program a -> Doc

prettyList :: [Program a] -> Doc

Pretty (Header a)

Methods

pretty :: Header a -> Doc

prettyList :: [Header a] -> Doc

Pretty (Include a)

Methods

pretty :: Include a -> Doc

prettyList :: [Include a] -> Doc

Pretty (Namespace a)

Methods

pretty :: Namespace a -> Doc

prettyList :: [Namespace a] -> Doc

Pretty (Definition a)

Methods

pretty :: Definition a -> Doc

prettyList :: [Definition a] -> Doc

Pretty (Type a)

Methods

pretty :: Type a -> Doc

prettyList :: [Type a] -> Doc

Pretty (Senum a)

Methods

pretty :: Senum a -> Doc

prettyList :: [Senum a] -> Doc

Pretty (Struct a)

Methods

pretty :: Struct a -> Doc

prettyList :: [Struct a] -> Doc

Pretty (Enum a)

Methods

pretty :: Enum a -> Doc

prettyList :: [Enum a] -> Doc

Pretty (EnumDef a)

Methods

pretty :: EnumDef a -> Doc

prettyList :: [EnumDef a] -> Doc

Pretty (Typedef a)

Methods

pretty :: Typedef a -> Doc

prettyList :: [Typedef a] -> Doc

Pretty (Const a)

Methods

pretty :: Const a -> Doc

prettyList :: [Const a] -> Doc

Pretty (Service a)

Methods

pretty :: Service a -> Doc

prettyList :: [Service a] -> Doc

Pretty (Function a)

Methods

pretty :: Function a -> Doc

prettyList :: [Function a] -> Doc

Pretty (Field a)

Methods

pretty :: Field a -> Doc

prettyList :: [Field a] -> Doc

Pretty (TypeReference a)

Methods

pretty :: TypeReference a -> Doc

prettyList :: [TypeReference a] -> Doc

Pretty (ConstValue a)

Methods

pretty :: ConstValue a -> Doc

prettyList :: [ConstValue a] -> Doc