Proto3.Suite.DotProto.Generate

This module provides functions to generate Haskell declarations for protobuf messages

Documentation

data CompileError

Constructors

CircularImport FilePath

CompileParseError ParseError

InternalError String

InvalidPackageName DotProtoIdentifier

InvalidMethodName DotProtoIdentifier

InvalidModuleName String

InvalidTypeName String

InvalidMapKeyType String

NoPackageDeclaration

NoSuchType DotProtoIdentifier

NonzeroFirstEnumeration String DotProtoIdentifier Int32

EmptyEnumeration String

Unimplemented String

Instances

Eq CompileError

Defined in Proto3.Suite.DotProto.Internal

Methods

(==) :: CompileError -> CompileError -> Bool

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

Show CompileError

Defined in Proto3.Suite.DotProto.Internal

Methods

showsPrec :: Int -> CompileError -> ShowS

show :: CompileError -> String

showList :: [CompileError] -> ShowS

data StringType

Constructors

StringType String String

Qualified module name, then unqualified type name.

data RecordStyle

Constructors

RegularRecords

LargeRecords

Instances

Eq RecordStyle

Defined in Proto3.Suite.DotProto.Generate

Methods

(==) :: RecordStyle -> RecordStyle -> Bool

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

Read RecordStyle

Defined in Proto3.Suite.DotProto.Generate

Methods

readsPrec :: Int -> ReadS RecordStyle

readList :: ReadS [RecordStyle]

readPrec :: ReadPrec RecordStyle

readListPrec :: ReadPrec [RecordStyle]

Show RecordStyle

Defined in Proto3.Suite.DotProto.Generate

Methods

showsPrec :: Int -> RecordStyle -> ShowS

show :: RecordStyle -> String

showList :: [RecordStyle] -> ShowS

parseStringType :: String -> Either String StringType

type TypeContext = Map DotProtoIdentifier DotProtoTypeInfo

A mapping from .proto type identifiers to their type information

data CompileArgs

Constructors

CompileArgs

Fields

• includeDir :: [FilePath]
• extraInstanceFiles :: [FilePath]
• inputProto :: FilePath
• outputDir :: FilePath
• stringType :: StringType
• recordStyle :: RecordStyle

compileDotProtoFile :: CompileArgs -> IO (Either CompileError ())

Generate a Haskell module corresponding to a .proto file

compileDotProtoFileOrDie :: CompileArgs -> IO ()

Same as compileDotProtoFile, except terminates the program with an error message on failure.

renameProtoFile :: MonadError CompileError m => String -> m String

Renaming protobuf file names to valid Haskell module names.

By convention, protobuf filenames are snake case. rnProtoFile renames snake-cased protobuf filenames by:

• Replacing occurrences of one or more underscores followed by an alphabetical character with one less underscore.
• Capitalizing the first character following the string of underscores.

Examples

>>> renameProtoFile @(Either CompileError) "abc_xyz"
Right "AbcXyz"

>>> renameProtoFile @(Either CompileError) "abc_1bc"
Left (InvalidModuleName "abc_1bc")

>>> renameProtoFile @(Either CompileError) "_"
Left (InvalidModuleName "_")

hsModuleForDotProto

Arguments

:: MonadError CompileError m

=> StringType

the module and the type for string

-> RecordStyle

kind of records to generate

-> ([HsImportDecl], [HsDecl])

Extra user-define instances that override default generated instances

-> DotProto

-> TypeContext

-> m HsModule

Compile a Haskell module AST given a DotProto package AST. Instances given in eis override those otherwise generated.

renderHsModuleForDotProto :: MonadError CompileError m => StringType -> RecordStyle -> ([HsImportDecl], [HsDecl]) -> DotProto -> TypeContext -> m String

Compile a DotProto AST into a String representing the Haskell source of a module implementing types and instances for the .proto messages and enums.

readDotProtoWithContext :: (MonadError CompileError m, MonadIO m) => [FilePath] -> FilePath -> m (DotProto, TypeContext)

Parses the file at the given path and produces an AST along with a TypeContext representing all types from imported .proto files, using the first parameter as a list of paths to search for imported files. Terminates with exit code 1 when an included file cannot be found in the search path.