Safe Haskell	None
Language	Haskell2010

Proto3.Suite.DotProto

Synopsis

class Pretty a where
- pPrintPrec :: PrettyLevel -> Rational -> a -> Doc
- pPrint :: a -> Doc
- pPrintList :: PrettyLevel -> [a] -> Doc
data DotProtoReservedField
- = SingleField Int
- | FieldRange Int Int
- | ReservedIdentifier String
data DotProtoField
- = DotProtoField {
  }
- | DotProtoEmptyField
data DotProtoMessagePart
- = DotProtoMessageField DotProtoField
- | DotProtoMessageOneOf DotProtoIdentifier [DotProtoField]
- | DotProtoMessageDefinition DotProtoDefinition
- | DotProtoMessageReserved [DotProtoReservedField]
- | DotProtoMessageOption DotProtoOption
data RPCMethod = RPCMethod {
- rpcMethodName :: DotProtoIdentifier
- rpcMethodRequestType :: DotProtoIdentifier
- rpcMethodRequestStreaming :: Streaming
- rpcMethodResponseType :: DotProtoIdentifier
- rpcMethodResponseStreaming :: Streaming
- rpcMethodOptions :: [DotProtoOption]
}
data DotProtoServicePart
- = DotProtoServiceRPCMethod RPCMethod
- | DotProtoServiceOption DotProtoOption
- | DotProtoServiceEmpty
data Streaming
- = Streaming
- | NonStreaming
data DotProtoEnumPart
- = DotProtoEnumField DotProtoIdentifier DotProtoEnumValue [DotProtoOption]
- | DotProtoEnumOption DotProtoOption
- | DotProtoEnumEmpty
type DotProtoEnumValue = Int32
data DotProtoType
- = Prim DotProtoPrimType
- | Repeated DotProtoPrimType
- | NestedRepeated DotProtoPrimType
- | Map DotProtoPrimType DotProtoPrimType
data Packing
- = PackedField
- | UnpackedField
data DotProtoPrimType
- = Int32
- | Int64
- | SInt32
- | SInt64
- | UInt32
- | UInt64
- | Fixed32
- | Fixed64
- | SFixed32
- | SFixed64
- | String
- | Bytes
- | Bool
- | Float
- | Double
- | Named DotProtoIdentifier
data DotProtoValue
- = Identifier DotProtoIdentifier
- | StringLit String
- | IntLit Int
- | FloatLit Double
- | BoolLit Bool
data DotProto = DotProto {
- protoImports :: [DotProtoImport]
- protoOptions :: [DotProtoOption]
- protoPackage :: DotProtoPackageSpec
- protoDefinitions :: [DotProtoDefinition]
- protoMeta :: DotProtoMeta
}
data DotProtoMeta = DotProtoMeta {
- metaModulePath :: Path
}
data DotProtoDefinition
- = DotProtoMessage String DotProtoIdentifier [DotProtoMessagePart]
- | DotProtoEnum String DotProtoIdentifier [DotProtoEnumPart]
- | DotProtoService String DotProtoIdentifier [DotProtoServicePart]
data DotProtoOption = DotProtoOption {
- dotProtoOptionIdentifier :: DotProtoIdentifier
- dotProtoOptionValue :: DotProtoValue
}
data DotProtoPackageSpec
- = DotProtoPackageSpec DotProtoIdentifier
- | DotProtoNoPackage
data DotProtoImportQualifier
- = DotProtoImportPublic
- | DotProtoImportWeak
- | DotProtoImportDefault
data DotProtoImport = DotProtoImport {
- dotProtoImportQualifier :: DotProtoImportQualifier
- dotProtoImportPath :: FilePath
}
data DotProtoIdentifier
- = Single String
- | Dots Path
- | Qualified DotProtoIdentifier DotProtoIdentifier
- | Anonymous
newtype Path = Path {
- components :: NonEmpty String
}
newtype PackageName = PackageName {
- getPackageName :: String
}
newtype FieldName = FieldName {
- getFieldName :: String
}
newtype MessageName = MessageName {
- getMessageName :: String
}
fakePath :: Path
parseProto :: Path -> String -> Either ParseError DotProto
parseProtoFile :: MonadIO m => Path -> FilePath -> m (Either ParseError DotProto)
typeLikeName :: MonadError CompileError m => String -> m String
fieldLikeName :: String -> String
prefixedEnumFieldName :: String -> String -> String
data RenderingOptions = RenderingOptions {
- roSelectorName :: DotProtoIdentifier -> DotProtoIdentifier -> FieldNumber -> Doc
- roEnumMemberName :: DotProtoIdentifier -> DotProtoIdentifier -> Doc
}
defRenderingOptions :: RenderingOptions
defSelectorName :: DotProtoIdentifier -> DotProtoIdentifier -> FieldNumber -> Doc
defEnumMemberName :: DotProtoIdentifier -> DotProtoIdentifier -> Doc
renderDotProto :: RenderingOptions -> DotProto -> Doc
toProtoFile :: RenderingOptions -> DotProto -> String
toProtoFileDef :: DotProto -> String
packageFromDefs :: String -> [DotProtoDefinition] -> DotProto

Documentation

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 #

data DotProtoReservedField Source #

Constructors

SingleField Int
FieldRange Int Int
ReservedIdentifier String

Instances

Instances details

Eq DotProtoReservedField Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods (==) :: DotProtoReservedField -> DotProtoReservedField -> Bool # (/=) :: DotProtoReservedField -> DotProtoReservedField -> Bool #
Show DotProtoReservedField Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods showsPrec :: Int -> DotProtoReservedField -> ShowS # show :: DotProtoReservedField -> String # showList :: [DotProtoReservedField] -> ShowS #
Arbitrary DotProtoReservedField Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods arbitrary :: Gen DotProtoReservedField # shrink :: DotProtoReservedField -> [DotProtoReservedField] #
Pretty DotProtoReservedField Source #
Instance details Defined in Proto3.Suite.DotProto.Rendering Methods pPrintPrec :: PrettyLevel -> Rational -> DotProtoReservedField -> Doc # pPrint :: DotProtoReservedField -> Doc # pPrintList :: PrettyLevel -> [DotProtoReservedField] -> Doc #

data DotProtoField Source #

Constructors

DotProtoField
Fields dotProtoFieldNumber :: FieldNumber dotProtoFieldType :: DotProtoType dotProtoFieldName :: DotProtoIdentifier dotProtoFieldOptions :: [DotProtoOption] dotProtoFieldComment :: String
DotProtoEmptyField

Instances

Instances details

Eq DotProtoField Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods (==) :: DotProtoField -> DotProtoField -> Bool # (/=) :: DotProtoField -> DotProtoField -> Bool #
Show DotProtoField Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods showsPrec :: Int -> DotProtoField -> ShowS # show :: DotProtoField -> String # showList :: [DotProtoField] -> ShowS #
Arbitrary DotProtoField Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods arbitrary :: Gen DotProtoField # shrink :: DotProtoField -> [DotProtoField] #

data DotProtoMessagePart Source #

Constructors

DotProtoMessageField DotProtoField
DotProtoMessageOneOf DotProtoIdentifier [DotProtoField]
DotProtoMessageDefinition DotProtoDefinition
DotProtoMessageReserved [DotProtoReservedField]
DotProtoMessageOption DotProtoOption

Instances

Instances details

Eq DotProtoMessagePart Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods (==) :: DotProtoMessagePart -> DotProtoMessagePart -> Bool # (/=) :: DotProtoMessagePart -> DotProtoMessagePart -> Bool #
Show DotProtoMessagePart Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods showsPrec :: Int -> DotProtoMessagePart -> ShowS # show :: DotProtoMessagePart -> String # showList :: [DotProtoMessagePart] -> ShowS #
Arbitrary DotProtoMessagePart Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods arbitrary :: Gen DotProtoMessagePart # shrink :: DotProtoMessagePart -> [DotProtoMessagePart] #

data RPCMethod Source #

Constructors

RPCMethod
Fields rpcMethodName :: DotProtoIdentifier rpcMethodRequestType :: DotProtoIdentifier rpcMethodRequestStreaming :: Streaming rpcMethodResponseType :: DotProtoIdentifier rpcMethodResponseStreaming :: Streaming rpcMethodOptions :: [DotProtoOption]

Instances

Instances details

Eq RPCMethod Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods (==) :: RPCMethod -> RPCMethod -> Bool # (/=) :: RPCMethod -> RPCMethod -> Bool #
Show RPCMethod Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods showsPrec :: Int -> RPCMethod -> ShowS # show :: RPCMethod -> String # showList :: [RPCMethod] -> ShowS #
Arbitrary RPCMethod Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods arbitrary :: Gen RPCMethod # shrink :: RPCMethod -> [RPCMethod] #

data DotProtoServicePart Source #

Constructors

DotProtoServiceRPCMethod RPCMethod
DotProtoServiceOption DotProtoOption
DotProtoServiceEmpty

Instances

Instances details

Eq DotProtoServicePart Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods (==) :: DotProtoServicePart -> DotProtoServicePart -> Bool # (/=) :: DotProtoServicePart -> DotProtoServicePart -> Bool #
Show DotProtoServicePart Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods showsPrec :: Int -> DotProtoServicePart -> ShowS # show :: DotProtoServicePart -> String # showList :: [DotProtoServicePart] -> ShowS #
Arbitrary DotProtoServicePart Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods arbitrary :: Gen DotProtoServicePart # shrink :: DotProtoServicePart -> [DotProtoServicePart] #
Pretty DotProtoServicePart Source #
Instance details Defined in Proto3.Suite.DotProto.Rendering Methods pPrintPrec :: PrettyLevel -> Rational -> DotProtoServicePart -> Doc # pPrint :: DotProtoServicePart -> Doc # pPrintList :: PrettyLevel -> [DotProtoServicePart] -> Doc #

data Streaming Source #

Constructors

Streaming
NonStreaming

Instances

Instances details

Eq Streaming Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods (==) :: Streaming -> Streaming -> Bool # (/=) :: Streaming -> Streaming -> Bool #
Show Streaming Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods showsPrec :: Int -> Streaming -> ShowS # show :: Streaming -> String # showList :: [Streaming] -> ShowS #
Arbitrary Streaming Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods arbitrary :: Gen Streaming # shrink :: Streaming -> [Streaming] #
Pretty Streaming Source #
Instance details Defined in Proto3.Suite.DotProto.Rendering Methods pPrintPrec :: PrettyLevel -> Rational -> Streaming -> Doc # pPrint :: Streaming -> Doc # pPrintList :: PrettyLevel -> [Streaming] -> Doc #

data DotProtoEnumPart Source #

Constructors

DotProtoEnumField DotProtoIdentifier DotProtoEnumValue [DotProtoOption]
DotProtoEnumOption DotProtoOption
DotProtoEnumEmpty

Instances

Instances details

Eq DotProtoEnumPart Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods (==) :: DotProtoEnumPart -> DotProtoEnumPart -> Bool # (/=) :: DotProtoEnumPart -> DotProtoEnumPart -> Bool #
Show DotProtoEnumPart Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods showsPrec :: Int -> DotProtoEnumPart -> ShowS # show :: DotProtoEnumPart -> String # showList :: [DotProtoEnumPart] -> ShowS #
Arbitrary DotProtoEnumPart Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods arbitrary :: Gen DotProtoEnumPart # shrink :: DotProtoEnumPart -> [DotProtoEnumPart] #

type DotProtoEnumValue = Int32 Source #

data DotProtoType Source #

This type is an almagamation of the modifiers used in types. It corresponds to a syntax role but not a semantic role, not all modifiers are meaningful in every type context.

Constructors

Prim DotProtoPrimType
Repeated DotProtoPrimType
NestedRepeated DotProtoPrimType
Map DotProtoPrimType DotProtoPrimType

Instances

Instances details

Eq DotProtoType Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods (==) :: DotProtoType -> DotProtoType -> Bool # (/=) :: DotProtoType -> DotProtoType -> Bool #
Show DotProtoType Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods showsPrec :: Int -> DotProtoType -> ShowS # show :: DotProtoType -> String # showList :: [DotProtoType] -> ShowS #
Arbitrary DotProtoType Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods arbitrary :: Gen DotProtoType # shrink :: DotProtoType -> [DotProtoType] #
Pretty DotProtoType Source #
Instance details Defined in Proto3.Suite.DotProto.Rendering Methods pPrintPrec :: PrettyLevel -> Rational -> DotProtoType -> Doc # pPrint :: DotProtoType -> Doc # pPrintList :: PrettyLevel -> [DotProtoType] -> Doc #

data Packing Source #

Constructors

PackedField
UnpackedField

Instances

Instances details

Eq Packing Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods (==) :: Packing -> Packing -> Bool # (/=) :: Packing -> Packing -> Bool #
Show Packing Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods showsPrec :: Int -> Packing -> ShowS # show :: Packing -> String # showList :: [Packing] -> ShowS #
Arbitrary Packing Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods arbitrary :: Gen Packing # shrink :: Packing -> [Packing] #

data DotProtoPrimType Source #

Constructors

Int32
Int64
SInt32
SInt64
UInt32
UInt64
Fixed32
Fixed64
SFixed32
SFixed64
String
Bytes
Bool
Float
Double
Named DotProtoIdentifier	A named type, referring to another message or enum defined in the same file

Instances

Instances details

Eq DotProtoPrimType Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods (==) :: DotProtoPrimType -> DotProtoPrimType -> Bool # (/=) :: DotProtoPrimType -> DotProtoPrimType -> Bool #
Show DotProtoPrimType Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods showsPrec :: Int -> DotProtoPrimType -> ShowS # show :: DotProtoPrimType -> String # showList :: [DotProtoPrimType] -> ShowS #
Arbitrary DotProtoPrimType Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods arbitrary :: Gen DotProtoPrimType # shrink :: DotProtoPrimType -> [DotProtoPrimType] #
Pretty DotProtoPrimType Source #
Instance details Defined in Proto3.Suite.DotProto.Rendering Methods pPrintPrec :: PrettyLevel -> Rational -> DotProtoPrimType -> Doc # pPrint :: DotProtoPrimType -> Doc # pPrintList :: PrettyLevel -> [DotProtoPrimType] -> Doc #

data DotProtoValue Source #

Matches the definition of constant in the proto3 language spec These are only used as rvalues

Constructors

Identifier DotProtoIdentifier
StringLit String
IntLit Int
FloatLit Double
BoolLit Bool

Instances

Instances details

Eq DotProtoValue Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods (==) :: DotProtoValue -> DotProtoValue -> Bool # (/=) :: DotProtoValue -> DotProtoValue -> Bool #
Ord DotProtoValue Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods compare :: DotProtoValue -> DotProtoValue -> Ordering # (<) :: DotProtoValue -> DotProtoValue -> Bool # (<=) :: DotProtoValue -> DotProtoValue -> Bool # (>) :: DotProtoValue -> DotProtoValue -> Bool # (>=) :: DotProtoValue -> DotProtoValue -> Bool # max :: DotProtoValue -> DotProtoValue -> DotProtoValue # min :: DotProtoValue -> DotProtoValue -> DotProtoValue #
Show DotProtoValue Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods showsPrec :: Int -> DotProtoValue -> ShowS # show :: DotProtoValue -> String # showList :: [DotProtoValue] -> ShowS #
Arbitrary DotProtoValue Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods arbitrary :: Gen DotProtoValue # shrink :: DotProtoValue -> [DotProtoValue] #
Pretty DotProtoValue Source #
Instance details Defined in Proto3.Suite.DotProto.Rendering Methods pPrintPrec :: PrettyLevel -> Rational -> DotProtoValue -> Doc # pPrint :: DotProtoValue -> Doc # pPrintList :: PrettyLevel -> [DotProtoValue] -> Doc #

data DotProto Source #

This data structure represents a .proto file The actual source order of protobuf statements isn't meaningful so statements are sorted by type during parsing. A .proto file with more than one package declaration is considered invalid.

Constructors

DotProto
Fields protoImports :: [DotProtoImport] protoOptions :: [DotProtoOption] protoPackage :: DotProtoPackageSpec protoDefinitions :: [DotProtoDefinition] protoMeta :: DotProtoMeta

Instances

Instances details

Eq DotProto Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods (==) :: DotProto -> DotProto -> Bool # (/=) :: DotProto -> DotProto -> Bool #
Show DotProto Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods showsPrec :: Int -> DotProto -> ShowS # show :: DotProto -> String # showList :: [DotProto] -> ShowS #
Arbitrary DotProto Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods arbitrary :: Gen DotProto # shrink :: DotProto -> [DotProto] #

data DotProtoMeta Source #

Tracks misc metadata about the AST

Constructors

DotProtoMeta
Fields metaModulePath :: Path The "module path" associated with the .proto file from which this AST was parsed. The "module path" is derived from the `--includeDir`-relative .proto filename passed to `parseProtoFile`. See `toModulePath` for details on how module path values are constructed. See `modulePathModName` to see how it is used during code generation.

Instances

Instances details

Eq DotProtoMeta Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods (==) :: DotProtoMeta -> DotProtoMeta -> Bool # (/=) :: DotProtoMeta -> DotProtoMeta -> Bool #
Show DotProtoMeta Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods showsPrec :: Int -> DotProtoMeta -> ShowS # show :: DotProtoMeta -> String # showList :: [DotProtoMeta] -> ShowS #
Arbitrary DotProtoMeta Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods arbitrary :: Gen DotProtoMeta # shrink :: DotProtoMeta -> [DotProtoMeta] #

data DotProtoDefinition Source #

Top-level protocol definitions

Constructors

DotProtoMessage String DotProtoIdentifier [DotProtoMessagePart]
DotProtoEnum String DotProtoIdentifier [DotProtoEnumPart]
DotProtoService String DotProtoIdentifier [DotProtoServicePart]

Instances

Instances details

Eq DotProtoDefinition Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods (==) :: DotProtoDefinition -> DotProtoDefinition -> Bool # (/=) :: DotProtoDefinition -> DotProtoDefinition -> Bool #
Show DotProtoDefinition Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods showsPrec :: Int -> DotProtoDefinition -> ShowS # show :: DotProtoDefinition -> String # showList :: [DotProtoDefinition] -> ShowS #
Arbitrary DotProtoDefinition Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods arbitrary :: Gen DotProtoDefinition # shrink :: DotProtoDefinition -> [DotProtoDefinition] #

data DotProtoOption Source #

An option id/value pair, can be attached to many types of statements

Constructors

DotProtoOption
Fields dotProtoOptionIdentifier :: DotProtoIdentifier dotProtoOptionValue :: DotProtoValue

Instances

Instances details

Eq DotProtoOption Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods (==) :: DotProtoOption -> DotProtoOption -> Bool # (/=) :: DotProtoOption -> DotProtoOption -> Bool #
Ord DotProtoOption Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods compare :: DotProtoOption -> DotProtoOption -> Ordering # (<) :: DotProtoOption -> DotProtoOption -> Bool # (<=) :: DotProtoOption -> DotProtoOption -> Bool # (>) :: DotProtoOption -> DotProtoOption -> Bool # (>=) :: DotProtoOption -> DotProtoOption -> Bool # max :: DotProtoOption -> DotProtoOption -> DotProtoOption # min :: DotProtoOption -> DotProtoOption -> DotProtoOption #
Show DotProtoOption Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods showsPrec :: Int -> DotProtoOption -> ShowS # show :: DotProtoOption -> String # showList :: [DotProtoOption] -> ShowS #
Arbitrary DotProtoOption Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods arbitrary :: Gen DotProtoOption # shrink :: DotProtoOption -> [DotProtoOption] #
Pretty DotProtoOption Source #
Instance details Defined in Proto3.Suite.DotProto.Rendering Methods pPrintPrec :: PrettyLevel -> Rational -> DotProtoOption -> Doc # pPrint :: DotProtoOption -> Doc # pPrintList :: PrettyLevel -> [DotProtoOption] -> Doc #

data DotProtoPackageSpec Source #

The namespace declaration

Constructors

DotProtoPackageSpec DotProtoIdentifier
DotProtoNoPackage

Instances

Instances details

Eq DotProtoPackageSpec Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods (==) :: DotProtoPackageSpec -> DotProtoPackageSpec -> Bool # (/=) :: DotProtoPackageSpec -> DotProtoPackageSpec -> Bool #
Show DotProtoPackageSpec Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods showsPrec :: Int -> DotProtoPackageSpec -> ShowS # show :: DotProtoPackageSpec -> String # showList :: [DotProtoPackageSpec] -> ShowS #
Arbitrary DotProtoPackageSpec Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods arbitrary :: Gen DotProtoPackageSpec # shrink :: DotProtoPackageSpec -> [DotProtoPackageSpec] #
Pretty DotProtoPackageSpec Source #
Instance details Defined in Proto3.Suite.DotProto.Rendering Methods pPrintPrec :: PrettyLevel -> Rational -> DotProtoPackageSpec -> Doc # pPrint :: DotProtoPackageSpec -> Doc # pPrintList :: PrettyLevel -> [DotProtoPackageSpec] -> Doc #

data DotProtoImportQualifier Source #

Constructors

DotProtoImportPublic
DotProtoImportWeak
DotProtoImportDefault

Instances

Instances details

Eq DotProtoImportQualifier Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods (==) :: DotProtoImportQualifier -> DotProtoImportQualifier -> Bool # (/=) :: DotProtoImportQualifier -> DotProtoImportQualifier -> Bool #
Ord DotProtoImportQualifier Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods compare :: DotProtoImportQualifier -> DotProtoImportQualifier -> Ordering # (<) :: DotProtoImportQualifier -> DotProtoImportQualifier -> Bool # (<=) :: DotProtoImportQualifier -> DotProtoImportQualifier -> Bool # (>) :: DotProtoImportQualifier -> DotProtoImportQualifier -> Bool # (>=) :: DotProtoImportQualifier -> DotProtoImportQualifier -> Bool # max :: DotProtoImportQualifier -> DotProtoImportQualifier -> DotProtoImportQualifier # min :: DotProtoImportQualifier -> DotProtoImportQualifier -> DotProtoImportQualifier #
Show DotProtoImportQualifier Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods showsPrec :: Int -> DotProtoImportQualifier -> ShowS # show :: DotProtoImportQualifier -> String # showList :: [DotProtoImportQualifier] -> ShowS #
Arbitrary DotProtoImportQualifier Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods arbitrary :: Gen DotProtoImportQualifier # shrink :: DotProtoImportQualifier -> [DotProtoImportQualifier] #
Pretty DotProtoImportQualifier Source #
Instance details Defined in Proto3.Suite.DotProto.Rendering Methods pPrintPrec :: PrettyLevel -> Rational -> DotProtoImportQualifier -> Doc # pPrint :: DotProtoImportQualifier -> Doc # pPrintList :: PrettyLevel -> [DotProtoImportQualifier] -> Doc #

data DotProtoImport Source #

Top-level import declaration

Constructors

DotProtoImport
Fields dotProtoImportQualifier :: DotProtoImportQualifier dotProtoImportPath :: FilePath

Instances

Instances details

Eq DotProtoImport Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods (==) :: DotProtoImport -> DotProtoImport -> Bool # (/=) :: DotProtoImport -> DotProtoImport -> Bool #
Ord DotProtoImport Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods compare :: DotProtoImport -> DotProtoImport -> Ordering # (<) :: DotProtoImport -> DotProtoImport -> Bool # (<=) :: DotProtoImport -> DotProtoImport -> Bool # (>) :: DotProtoImport -> DotProtoImport -> Bool # (>=) :: DotProtoImport -> DotProtoImport -> Bool # max :: DotProtoImport -> DotProtoImport -> DotProtoImport # min :: DotProtoImport -> DotProtoImport -> DotProtoImport #
Show DotProtoImport Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods showsPrec :: Int -> DotProtoImport -> ShowS # show :: DotProtoImport -> String # showList :: [DotProtoImport] -> ShowS #
Arbitrary DotProtoImport Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods arbitrary :: Gen DotProtoImport # shrink :: DotProtoImport -> [DotProtoImport] #
Pretty DotProtoImport Source #
Instance details Defined in Proto3.Suite.DotProto.Rendering Methods pPrintPrec :: PrettyLevel -> Rational -> DotProtoImport -> Doc # pPrint :: DotProtoImport -> Doc # pPrintList :: PrettyLevel -> [DotProtoImport] -> Doc #

data DotProtoIdentifier Source #

Constructors

Single String
Dots Path
Qualified DotProtoIdentifier DotProtoIdentifier
Anonymous

Instances

Instances details

Eq DotProtoIdentifier Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods (==) :: DotProtoIdentifier -> DotProtoIdentifier -> Bool # (/=) :: DotProtoIdentifier -> DotProtoIdentifier -> Bool #
Ord DotProtoIdentifier Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods compare :: DotProtoIdentifier -> DotProtoIdentifier -> Ordering # (<) :: DotProtoIdentifier -> DotProtoIdentifier -> Bool # (<=) :: DotProtoIdentifier -> DotProtoIdentifier -> Bool # (>) :: DotProtoIdentifier -> DotProtoIdentifier -> Bool # (>=) :: DotProtoIdentifier -> DotProtoIdentifier -> Bool # max :: DotProtoIdentifier -> DotProtoIdentifier -> DotProtoIdentifier # min :: DotProtoIdentifier -> DotProtoIdentifier -> DotProtoIdentifier #
Show DotProtoIdentifier Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods showsPrec :: Int -> DotProtoIdentifier -> ShowS # show :: DotProtoIdentifier -> String # showList :: [DotProtoIdentifier] -> ShowS #
Pretty DotProtoIdentifier Source #
Instance details Defined in Proto3.Suite.DotProto.Rendering Methods pPrintPrec :: PrettyLevel -> Rational -> DotProtoIdentifier -> Doc # pPrint :: DotProtoIdentifier -> Doc # pPrintList :: PrettyLevel -> [DotProtoIdentifier] -> Doc #

newtype Path Source #

Constructors

Path
Fields components :: NonEmpty String

Instances

Instances details

Eq Path Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods (==) :: Path -> Path -> Bool # (/=) :: Path -> Path -> Bool #
Ord Path Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods compare :: Path -> Path -> Ordering # (<) :: Path -> Path -> Bool # (<=) :: Path -> Path -> Bool # (>) :: Path -> Path -> Bool # (>=) :: Path -> Path -> Bool # max :: Path -> Path -> Path # min :: Path -> Path -> Path #
Show Path Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods showsPrec :: Int -> Path -> ShowS # show :: Path -> String # showList :: [Path] -> ShowS #

newtype PackageName Source #

The name of the package

Constructors

PackageName
Fields getPackageName :: String

Instances

Instances details

Eq PackageName Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods (==) :: PackageName -> PackageName -> Bool # (/=) :: PackageName -> PackageName -> Bool #
Ord PackageName Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods compare :: PackageName -> PackageName -> Ordering # (<) :: PackageName -> PackageName -> Bool # (<=) :: PackageName -> PackageName -> Bool # (>) :: PackageName -> PackageName -> Bool # (>=) :: PackageName -> PackageName -> Bool # max :: PackageName -> PackageName -> PackageName # min :: PackageName -> PackageName -> PackageName #
Show PackageName Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods showsPrec :: Int -> PackageName -> ShowS # show :: PackageName -> String # showList :: [PackageName] -> ShowS #
IsString PackageName Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods fromString :: String -> PackageName #

newtype FieldName Source #

The name of some field

Constructors

FieldName
Fields getFieldName :: String

Instances

Instances details

Eq FieldName Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods (==) :: FieldName -> FieldName -> Bool # (/=) :: FieldName -> FieldName -> Bool #
Ord FieldName Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods compare :: FieldName -> FieldName -> Ordering # (<) :: FieldName -> FieldName -> Bool # (<=) :: FieldName -> FieldName -> Bool # (>) :: FieldName -> FieldName -> Bool # (>=) :: FieldName -> FieldName -> Bool # max :: FieldName -> FieldName -> FieldName # min :: FieldName -> FieldName -> FieldName #
Show FieldName Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods showsPrec :: Int -> FieldName -> ShowS # show :: FieldName -> String # showList :: [FieldName] -> ShowS #
IsString FieldName Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods fromString :: String -> FieldName #

newtype MessageName Source #

The name of a message

Constructors

MessageName
Fields getMessageName :: String

Instances

Instances details

Eq MessageName Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods (==) :: MessageName -> MessageName -> Bool # (/=) :: MessageName -> MessageName -> Bool #
Ord MessageName Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods compare :: MessageName -> MessageName -> Ordering # (<) :: MessageName -> MessageName -> Bool # (<=) :: MessageName -> MessageName -> Bool # (>) :: MessageName -> MessageName -> Bool # (>=) :: MessageName -> MessageName -> Bool # max :: MessageName -> MessageName -> MessageName # min :: MessageName -> MessageName -> MessageName #
Show MessageName Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods showsPrec :: Int -> MessageName -> ShowS # show :: MessageName -> String # showList :: [MessageName] -> ShowS #
IsString MessageName Source #
Instance details Defined in Proto3.Suite.DotProto.AST Methods fromString :: String -> MessageName #

fakePath :: Path Source #

parseProto :: Path -> String -> Either ParseError DotProto Source #

parseProto mp inp attempts to parse inp as a DotProto. mp is the module path to be injected into the AST as part of DotProtoMeta metadata on a successful parse.

parseProtoFile :: MonadIO m => Path -> FilePath -> m (Either ParseError DotProto) Source #

parseProtoFile mp fp reads and parses the .proto file found at fp. mp is used downstream during code generation when we need to generate names which are a function of the source .proto file's filename and its path relative to some --includeDir.

typeLikeName :: MonadError CompileError m => String -> m String Source #

typeLikeName xs produces either the pascal-cased version of the string xs if it begins with an alphabetical character or underscore - which is replaced with X. A CompileError is emitted if the starting character is non-alphabetic or if xs == "".

fieldLikeName :: String -> String Source #

fieldLikeName field is the casing transformation used to produce record selectors from message fields. If field is prefixed by a span of uppercase characters then that prefix will be lowercased while the remaining string is left unchanged.

prefixedEnumFieldName :: String -> String -> String Source #

data RenderingOptions Source #

Options for rendering a .proto file.

Constructors

RenderingOptions

Fields

roSelectorName :: DotProtoIdentifier -> DotProtoIdentifier -> FieldNumber -> Doc
This function will be applied to each record selector name to turn it into a protobuf field name (default: uses the selector name, unchanged).
roEnumMemberName :: DotProtoIdentifier -> DotProtoIdentifier -> Doc
This function will be applied to each enum member name to turn it into a protobuf field name (default: uses the field name, unchanged).

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

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

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

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.

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