proto3-suite-0.7.0: A higher-level API to the proto3-wire library
Safe HaskellNone
LanguageHaskell2010

Proto3.Suite.DotProto.Generate

Description

This module provides functions to generate Haskell declarations for protobuf messages

Synopsis

Documentation

data StringType Source #

Constructors

StringType String String

Qualified module name, then unqualified type name.

type TypeContext = Map DotProtoIdentifier DotProtoTypeInfo Source #

A mapping from .proto type identifiers to their type information

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

Generate a Haskell module corresponding to a .proto file

compileDotProtoFileOrDie :: CompileArgs -> IO () Source #

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

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

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

Expand
>>> renameProtoFile @(Either CompileError) "abc_xyz"
Right "AbcXyz"
>>> renameProtoFile @(Either CompileError) "abc_1bc"
Left (InvalidModuleName "abc_1bc")
>>> renameProtoFile @(Either CompileError) "_"
Left (InvalidModuleName "_")

hsModuleForDotProto Source #

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 Source #

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) Source #

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.