proto3-suite-0.4.2: A low level library for writing out data in the Protocol Buffers wire format
Safe HaskellNone
LanguageHaskell2010

Proto3.Suite.DotProto.Rendering

Description

This module provides types and functions to generate .proto files.

Synopsis

Documentation

renderDotProto :: RenderingOptions -> DotProto -> Doc Source #

Traverses a DotProto AST and generates a .proto file from it

defRenderingOptions :: RenderingOptions Source #

Default rendering options.

defSelectorName :: DotProtoIdentifier -> DotProtoIdentifier -> FieldNumber -> Doc Source #

The default choice of field name for a selector.

defEnumMemberName :: DotProtoIdentifier -> DotProtoIdentifier -> Doc Source #

The default choice of enum member name for an enum

packageFromDefs :: String -> [DotProtoDefinition] -> DotProto Source #

toProtoFile :: RenderingOptions -> DotProto -> String Source #

Render protobufs metadata as a .proto file stringy

toProtoFileDef :: DotProto -> String Source #

Render protobufs metadata as a .proto file string, using the default rendering options.

data RenderingOptions Source #

Options for rendering a .proto file.

Constructors

RenderingOptions 

Fields

class Pretty a where #

Pretty printing class. The precedence level is used in a similar way as in the Show class. Minimal complete definition is either pPrintPrec or pPrint.

Minimal complete definition

pPrintPrec | pPrint

Methods

pPrintPrec :: PrettyLevel -> Rational -> a -> Doc #

pPrint :: a -> Doc #

pPrintList :: PrettyLevel -> [a] -> Doc #

Instances

Instances details
Pretty Bool 
Instance details

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Bool -> Doc #

pPrint :: Bool -> Doc #

pPrintList :: PrettyLevel -> [Bool] -> Doc #

Pretty Char 
Instance details

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Char -> Doc #

pPrint :: Char -> Doc #

pPrintList :: PrettyLevel -> [Char] -> Doc #

Pretty Double 
Instance details

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Double -> Doc #

pPrint :: Double -> Doc #

pPrintList :: PrettyLevel -> [Double] -> Doc #

Pretty Float 
Instance details

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Float -> Doc #

pPrint :: Float -> Doc #

pPrintList :: PrettyLevel -> [Float] -> Doc #

Pretty Int 
Instance details

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Int -> Doc #

pPrint :: Int -> Doc #

pPrintList :: PrettyLevel -> [Int] -> Doc #

Pretty Integer 
Instance details

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Integer -> Doc #

pPrint :: Integer -> Doc #

pPrintList :: PrettyLevel -> [Integer] -> Doc #

Pretty Ordering 
Instance details

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Ordering -> Doc #

pPrint :: Ordering -> Doc #

pPrintList :: PrettyLevel -> [Ordering] -> Doc #

Pretty () 
Instance details

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> () -> Doc #

pPrint :: () -> Doc #

pPrintList :: PrettyLevel -> [()] -> Doc #

Pretty FieldNumber Source # 
Instance details

Defined in Proto3.Suite.DotProto.Rendering

Methods

pPrintPrec :: PrettyLevel -> Rational -> FieldNumber -> Doc #

pPrint :: FieldNumber -> Doc #

pPrintList :: PrettyLevel -> [FieldNumber] -> Doc #

Pretty DotProtoReservedField Source # 
Instance details

Defined in Proto3.Suite.DotProto.Rendering

Methods

pPrintPrec :: PrettyLevel -> Rational -> DotProtoReservedField -> Doc #

pPrint :: DotProtoReservedField -> Doc #

pPrintList :: PrettyLevel -> [DotProtoReservedField] -> Doc #

Pretty DotProtoServicePart Source # 
Instance details

Defined in Proto3.Suite.DotProto.Rendering

Methods

pPrintPrec :: PrettyLevel -> Rational -> DotProtoServicePart -> Doc #

pPrint :: DotProtoServicePart -> Doc #

pPrintList :: PrettyLevel -> [DotProtoServicePart] -> Doc #

Pretty Streaming Source # 
Instance details

Defined in Proto3.Suite.DotProto.Rendering

Methods

pPrintPrec :: PrettyLevel -> Rational -> Streaming -> Doc #

pPrint :: Streaming -> Doc #

pPrintList :: PrettyLevel -> [Streaming] -> Doc #

Pretty DotProtoType Source # 
Instance details

Defined in Proto3.Suite.DotProto.Rendering

Methods

pPrintPrec :: PrettyLevel -> Rational -> DotProtoType -> Doc #

pPrint :: DotProtoType -> Doc #

pPrintList :: PrettyLevel -> [DotProtoType] -> Doc #

Pretty DotProtoPrimType Source # 
Instance details

Defined in Proto3.Suite.DotProto.Rendering

Methods

pPrintPrec :: PrettyLevel -> Rational -> DotProtoPrimType -> Doc #

pPrint :: DotProtoPrimType -> Doc #

pPrintList :: PrettyLevel -> [DotProtoPrimType] -> Doc #

Pretty DotProtoValue Source # 
Instance details

Defined in Proto3.Suite.DotProto.Rendering

Methods

pPrintPrec :: PrettyLevel -> Rational -> DotProtoValue -> Doc #

pPrint :: DotProtoValue -> Doc #

pPrintList :: PrettyLevel -> [DotProtoValue] -> Doc #

Pretty DotProtoOption Source # 
Instance details

Defined in Proto3.Suite.DotProto.Rendering

Methods

pPrintPrec :: PrettyLevel -> Rational -> DotProtoOption -> Doc #

pPrint :: DotProtoOption -> Doc #

pPrintList :: PrettyLevel -> [DotProtoOption] -> Doc #

Pretty DotProtoPackageSpec Source # 
Instance details

Defined in Proto3.Suite.DotProto.Rendering

Methods

pPrintPrec :: PrettyLevel -> Rational -> DotProtoPackageSpec -> Doc #

pPrint :: DotProtoPackageSpec -> Doc #

pPrintList :: PrettyLevel -> [DotProtoPackageSpec] -> Doc #

Pretty DotProtoImportQualifier Source # 
Instance details

Defined in Proto3.Suite.DotProto.Rendering

Methods

pPrintPrec :: PrettyLevel -> Rational -> DotProtoImportQualifier -> Doc #

pPrint :: DotProtoImportQualifier -> Doc #

pPrintList :: PrettyLevel -> [DotProtoImportQualifier] -> Doc #

Pretty DotProtoImport Source # 
Instance details

Defined in Proto3.Suite.DotProto.Rendering

Methods

pPrintPrec :: PrettyLevel -> Rational -> DotProtoImport -> Doc #

pPrint :: DotProtoImport -> Doc #

pPrintList :: PrettyLevel -> [DotProtoImport] -> Doc #

Pretty DotProtoIdentifier Source # 
Instance details

Defined in Proto3.Suite.DotProto.Rendering

Methods

pPrintPrec :: PrettyLevel -> Rational -> DotProtoIdentifier -> Doc #

pPrint :: DotProtoIdentifier -> Doc #

pPrintList :: PrettyLevel -> [DotProtoIdentifier] -> Doc #

Pretty a => Pretty [a] 
Instance details

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> [a] -> Doc #

pPrint :: [a] -> Doc #

pPrintList :: PrettyLevel -> [[a]] -> Doc #

Pretty a => Pretty (Maybe a) 
Instance details

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Maybe a -> Doc #

pPrint :: Maybe a -> Doc #

pPrintList :: PrettyLevel -> [Maybe a] -> Doc #

(Pretty a, Pretty b) => Pretty (Either a b) 
Instance details

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Either a b -> Doc #

pPrint :: Either a b -> Doc #

pPrintList :: PrettyLevel -> [Either a b] -> Doc #

(Pretty a, Pretty b) => Pretty (a, b) 
Instance details

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b) -> Doc #

pPrint :: (a, b) -> Doc #

pPrintList :: PrettyLevel -> [(a, b)] -> Doc #

(Pretty a, Pretty b, Pretty c) => Pretty (a, b, c) 
Instance details

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b, c) -> Doc #

pPrint :: (a, b, c) -> Doc #

pPrintList :: PrettyLevel -> [(a, b, c)] -> Doc #

(Pretty a, Pretty b, Pretty c, Pretty d) => Pretty (a, b, c, d) 
Instance details

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d) -> Doc #

pPrint :: (a, b, c, d) -> Doc #

pPrintList :: PrettyLevel -> [(a, b, c, d)] -> Doc #

(Pretty a, Pretty b, Pretty c, Pretty d, Pretty e) => Pretty (a, b, c, d, e) 
Instance details

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d, e) -> Doc #

pPrint :: (a, b, c, d, e) -> Doc #

pPrintList :: PrettyLevel -> [(a, b, c, d, e)] -> Doc #

(Pretty a, Pretty b, Pretty c, Pretty d, Pretty e, Pretty f) => Pretty (a, b, c, d, e, f) 
Instance details

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d, e, f) -> Doc #

pPrint :: (a, b, c, d, e, f) -> Doc #

pPrintList :: PrettyLevel -> [(a, b, c, d, e, f)] -> Doc #

(Pretty a, Pretty b, Pretty c, Pretty d, Pretty e, Pretty f, Pretty g) => Pretty (a, b, c, d, e, f, g) 
Instance details

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d, e, f, g) -> Doc #

pPrint :: (a, b, c, d, e, f, g) -> Doc #

pPrintList :: PrettyLevel -> [(a, b, c, d, e, f, g)] -> Doc #

(Pretty a, Pretty b, Pretty c, Pretty d, Pretty e, Pretty f, Pretty g, Pretty h) => Pretty (a, b, c, d, e, f, g, h) 
Instance details

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d, e, f, g, h) -> Doc #

pPrint :: (a, b, c, d, e, f, g, h) -> Doc #

pPrintList :: PrettyLevel -> [(a, b, c, d, e, f, g, h)] -> Doc #

Orphan instances

Pretty FieldNumber Source # 
Instance details

Methods

pPrintPrec :: PrettyLevel -> Rational -> FieldNumber -> Doc #

pPrint :: FieldNumber -> Doc #

pPrintList :: PrettyLevel -> [FieldNumber] -> Doc #

Pretty DotProtoReservedField Source # 
Instance details

Methods

pPrintPrec :: PrettyLevel -> Rational -> DotProtoReservedField -> Doc #

pPrint :: DotProtoReservedField -> Doc #

pPrintList :: PrettyLevel -> [DotProtoReservedField] -> Doc #

Pretty DotProtoServicePart Source # 
Instance details

Methods

pPrintPrec :: PrettyLevel -> Rational -> DotProtoServicePart -> Doc #

pPrint :: DotProtoServicePart -> Doc #

pPrintList :: PrettyLevel -> [DotProtoServicePart] -> Doc #

Pretty Streaming Source # 
Instance details

Methods

pPrintPrec :: PrettyLevel -> Rational -> Streaming -> Doc #

pPrint :: Streaming -> Doc #

pPrintList :: PrettyLevel -> [Streaming] -> Doc #

Pretty DotProtoType Source # 
Instance details

Methods

pPrintPrec :: PrettyLevel -> Rational -> DotProtoType -> Doc #

pPrint :: DotProtoType -> Doc #

pPrintList :: PrettyLevel -> [DotProtoType] -> Doc #

Pretty DotProtoPrimType Source # 
Instance details

Methods

pPrintPrec :: PrettyLevel -> Rational -> DotProtoPrimType -> Doc #

pPrint :: DotProtoPrimType -> Doc #

pPrintList :: PrettyLevel -> [DotProtoPrimType] -> Doc #

Pretty DotProtoValue Source # 
Instance details

Methods

pPrintPrec :: PrettyLevel -> Rational -> DotProtoValue -> Doc #

pPrint :: DotProtoValue -> Doc #

pPrintList :: PrettyLevel -> [DotProtoValue] -> Doc #

Pretty DotProtoOption Source # 
Instance details

Methods

pPrintPrec :: PrettyLevel -> Rational -> DotProtoOption -> Doc #

pPrint :: DotProtoOption -> Doc #

pPrintList :: PrettyLevel -> [DotProtoOption] -> Doc #

Pretty DotProtoPackageSpec Source # 
Instance details

Methods

pPrintPrec :: PrettyLevel -> Rational -> DotProtoPackageSpec -> Doc #

pPrint :: DotProtoPackageSpec -> Doc #

pPrintList :: PrettyLevel -> [DotProtoPackageSpec] -> Doc #

Pretty DotProtoImportQualifier Source # 
Instance details

Methods

pPrintPrec :: PrettyLevel -> Rational -> DotProtoImportQualifier -> Doc #

pPrint :: DotProtoImportQualifier -> Doc #

pPrintList :: PrettyLevel -> [DotProtoImportQualifier] -> Doc #

Pretty DotProtoImport Source # 
Instance details

Methods

pPrintPrec :: PrettyLevel -> Rational -> DotProtoImport -> Doc #

pPrint :: DotProtoImport -> Doc #

pPrintList :: PrettyLevel -> [DotProtoImport] -> Doc #

Pretty DotProtoIdentifier Source # 
Instance details

Methods

pPrintPrec :: PrettyLevel -> Rational -> DotProtoIdentifier -> Doc #

pPrint :: DotProtoIdentifier -> Doc #

pPrintList :: PrettyLevel -> [DotProtoIdentifier] -> Doc #