Safe Haskell	None
Language	Haskell2010

Data.ProtoLens.Compiler.Definitions

Description

This module takes care of collecting all the definitions in a .proto file and assigning Haskell names to all of the defined things (messages, enums and field names).

Synopsis

type Env n = Map Text (Definition n)
data Definition n
- = Message (MessageInfo n)
- | Enum (EnumInfo n)
data MessageInfo n = MessageInfo {
- messageName :: n
- messageDescriptor :: DescriptorProto
- messageFields :: [FieldInfo]
- messageOneofFields :: [OneofInfo]
- messageUnknownFields :: Name
}
data ServiceInfo = ServiceInfo {
- serviceName :: Text
- servicePackage :: Text
- serviceMethods :: [MethodInfo]
}
data MethodInfo = MethodInfo {
- methodName :: Text
- methodIdent :: Text
- methodInput :: Text
- methodOutput :: Text
- methodClientStreaming :: Bool
- methodServerStreaming :: Bool
}
data FieldInfo = FieldInfo {
- fieldDescriptor :: FieldDescriptorProto
- plainFieldName :: FieldName
}
data OneofInfo = OneofInfo {
- oneofFieldName :: FieldName
- oneofTypeName :: Name
- oneofCases :: [OneofCase]
}
data OneofCase = OneofCase {
- caseField :: FieldInfo
- caseConstructorName :: Name
- casePrismName :: Name
}
data FieldName = FieldName {
- overloadedName :: Symbol
- haskellRecordFieldName :: Name
}
data Symbol
nameFromSymbol :: Symbol -> Name
promoteSymbol :: Symbol -> Type
data EnumInfo n = EnumInfo {
- enumName :: n
- enumUnrecognizedName :: n
- enumUnrecognizedValueName :: n
- enumDescriptor :: EnumDescriptorProto
- enumValues :: [EnumValueInfo n]
}
data EnumValueInfo n = EnumValueInfo {
- enumValueName :: n
- enumValueDescriptor :: EnumValueDescriptorProto
- enumAliasOf :: Maybe Name
}
qualifyEnv :: ModuleName -> Env Name -> Env QName
unqualifyEnv :: Env Name -> Env QName
collectDefinitions :: FileDescriptorProto -> Env Name
collectServices :: FileDescriptorProto -> [ServiceInfo]
definedFieldType :: FieldDescriptorProto -> Env QName -> Definition QName
definedType :: Text -> Env QName -> Definition QName
camelCase :: Text -> Text

Documentation

type Env n = Map Text (Definition n) #

Env contains a mapping of proto names (as specified in the .proto file) to Haskell names. The keys are fully-qualified names, for example, ".package.Message.Submessage". (The protocol_compiler tool emits all message field types in this form, even if they refer to local definitions.)

The type n can be either a Name (when talking about definitions within the current file) or a (qualified) QName (when talking about definitions either from this or another file).

data Definition n #

Constructors

Message (MessageInfo n)
Enum (EnumInfo n)

Instances

Functor Definition #
Instance details Defined in Data.ProtoLens.Compiler.Definitions Methods fmap :: (a -> b) -> Definition a -> Definition b # (<$) :: a -> Definition b -> Definition a #

data MessageInfo n #

All the information needed to define or use a proto message type.

Constructors

MessageInfo
Fields messageName :: n Haskell type name messageDescriptor :: DescriptorProto messageFields :: [FieldInfo] Fields not belonging to a oneof. messageOneofFields :: [OneofInfo] The oneofs in this message, associated with the fields that belong to them. messageUnknownFields :: Name The name of the Haskell field in this message that holds the unknown fields.

Instances

Functor MessageInfo #
Instance details Defined in Data.ProtoLens.Compiler.Definitions Methods fmap :: (a -> b) -> MessageInfo a -> MessageInfo b # (<$) :: a -> MessageInfo b -> MessageInfo a #

data ServiceInfo #

Constructors

ServiceInfo
Fields serviceName :: Text servicePackage :: Text serviceMethods :: [MethodInfo]

data MethodInfo #

Constructors

MethodInfo
Fields methodName :: Text methodIdent :: Text methodInput :: Text methodOutput :: Text methodClientStreaming :: Bool methodServerStreaming :: Bool

data FieldInfo #

Information about a single field of a proto message.

Constructors

FieldInfo
Fields fieldDescriptor :: FieldDescriptorProto plainFieldName :: FieldName

data OneofInfo #

Constructors

OneofInfo
Fields oneofFieldName :: FieldName oneofTypeName :: Name The name of the sum type corresponding to this oneof. oneofCases :: [OneofCase] The individual fields that make up this oneof.

data OneofCase #

Constructors

OneofCase
Fields caseField :: FieldInfo caseConstructorName :: Name The constructor for building a `oneofTypeName` from the value in this field. casePrismName :: Name The name for building `Prism` definition.

data FieldName #

Constructors

FieldName

Fields

overloadedName :: Symbol
The overloaded name of lenses that access this field. For example, if the field is called "foo_bar" in the .proto then overloadedName == "fooBar" and we might generate fooBar and/or maybe'fooBar lenses to access the data.
May be shared between two different message data types in the same module.
haskellRecordFieldName :: Name
The Haskell name of this internal record field; for example, "_FooBarbaz. Unique within each module.

data Symbol #

A string that refers to the name (in Haskell) of a lens that accesses a field.

For example, in the signature of the overloaded lens

    foo :: HasLens "foo" ... => Lens ...

a Symbol is used to construct both the type-level argument to HasLens and the name of the function foo.

Instances

Eq Symbol #
Instance details Defined in Data.ProtoLens.Compiler.Definitions Methods (==) :: Symbol -> Symbol -> Bool # (/=) :: Symbol -> Symbol -> Bool #
Ord Symbol #
Instance details Defined in Data.ProtoLens.Compiler.Definitions Methods compare :: Symbol -> Symbol -> Ordering # (<) :: Symbol -> Symbol -> Bool # (<=) :: Symbol -> Symbol -> Bool # (>) :: Symbol -> Symbol -> Bool # (>=) :: Symbol -> Symbol -> Bool # max :: Symbol -> Symbol -> Symbol # min :: Symbol -> Symbol -> Symbol #
IsString Symbol #
Instance details Defined in Data.ProtoLens.Compiler.Definitions Methods fromString :: String -> Symbol #
Semigroup Symbol #
Instance details Defined in Data.ProtoLens.Compiler.Definitions Methods (<>) :: Symbol -> Symbol -> Symbol # sconcat :: NonEmpty Symbol -> Symbol # stimes :: Integral b => b -> Symbol -> Symbol #
Monoid Symbol #
Instance details Defined in Data.ProtoLens.Compiler.Definitions Methods mempty :: Symbol # mappend :: Symbol -> Symbol -> Symbol # mconcat :: [Symbol] -> Symbol #

nameFromSymbol :: Symbol -> Name #

promoteSymbol :: Symbol -> Type #

Construct a promoted, type-level string.

data EnumInfo n #

All the information needed to define or use a proto enum type.

Constructors

EnumInfo
Fields enumName :: n enumUnrecognizedName :: n enumUnrecognizedValueName :: n enumDescriptor :: EnumDescriptorProto enumValues :: [EnumValueInfo n]

Instances

Functor EnumInfo #
Instance details Defined in Data.ProtoLens.Compiler.Definitions Methods fmap :: (a -> b) -> EnumInfo a -> EnumInfo b # (<$) :: a -> EnumInfo b -> EnumInfo a #

data EnumValueInfo n #

Information about a single value case of a proto enum.

Constructors

EnumValueInfo
Fields enumValueName :: n enumValueDescriptor :: EnumValueDescriptorProto enumAliasOf :: Maybe Name If `Nothing`, we turn value into a normal constructor of the enum. If `Just n`, we're treating it as an alias of the constructor `n` (a PatternSynonym in Haskell). This mirrors the behavior of the Java API.

Instances

Functor EnumValueInfo #
Instance details Defined in Data.ProtoLens.Compiler.Definitions Methods fmap :: (a -> b) -> EnumValueInfo a -> EnumValueInfo b # (<$) :: a -> EnumValueInfo b -> EnumValueInfo a #

qualifyEnv :: ModuleName -> Env Name -> Env QName #

unqualifyEnv :: Env Name -> Env QName #

collectDefinitions :: FileDescriptorProto -> Env Name #

Collect all the definitions in the given file (including definitions nested in other messages), and assign Haskell names to them.

collectServices :: FileDescriptorProto -> [ServiceInfo] #

definedFieldType :: FieldDescriptorProto -> Env QName -> Definition QName #

Look up the Haskell name for the type of a given field (message or enum).

definedType :: Text -> Env QName -> Definition QName #

Look up the Haskell name for the type of a given type.

camelCase :: Text -> Text #