Data.ProtoLens.Compiler.Definitions

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).

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

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]

  The Haskell names for each field. This list corresponds 1-1 with "field" in messageDescriptor.

Instances

Functor MessageInfo

Methods

fmap :: (a -> b) -> MessageInfo a -> MessageInfo b

(<$) :: a -> MessageInfo b -> MessageInfo a

data FieldInfo

Information about a single field of a proto message.

Constructors

FieldInfo

Fields

• overloadedField :: String

  The Haskell overloaded name of this field; may be shared between two different message data types.

• recordFieldName :: Name

  The Haskell name of this internal record field. Unique within each module.

• fieldDescriptor :: FieldDescriptorProto

data EnumInfo n

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

Constructors

EnumInfo

Fields

• enumName :: n
• enumDescriptor :: EnumDescriptorProto
• enumValues :: [EnumValueInfo n]

Instances

Functor EnumInfo

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

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.

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

Look up the type definition for a given field.