Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.SerDoc.Info

Contents

Documentation annotation types
FieldInfo and related types
Field sizes

Synopsis

newtype Description = Description {
- descriptionParagraphs :: [String]
}
data FieldInfo codec
- = AnnField !String !(FieldInfo codec)
- | BasicField !BasicFieldInfo
- | EnumField !EnumFieldInfo
- | CompoundField !(CompoundFieldInfo codec)
- | ChoiceField !(ChoiceFieldInfo codec)
- | ListField !(ListFieldInfo codec)
- | AliasField !(AliasFieldInfo codec)
- | SumField !(SumFieldInfo codec)
data BasicFieldInfo = BasicFieldInfo {
- basicFieldType :: !String
- basicFieldSize :: !FieldSize
}
data EnumFieldInfo = EnumFieldInfo {
- enumFieldType :: !String
- enumFieldSize :: !FieldSize
- enumFieldValues :: ![(Int, String)]
}
data AliasFieldInfo codec = AliasFieldInfo {
- aliasFieldName :: !String
- aliasFieldTarget :: !(FieldInfo codec)
}
data CompoundFieldInfo codec = CompoundFieldInfo {
- compoundFieldType :: !String
- compoundFieldSubfields :: ![SubfieldInfo codec]
}
data SumFieldInfo codec = SumFieldInfo {
- sumFieldType :: !String
- sumFieldAlternatives :: ![(String, FieldInfo codec)]
}
data ListFieldInfo codec = ListFieldInfo {
- listSize :: !FieldSize
- listElemInfo :: !(FieldInfo codec)
}
data SubfieldInfo codec = SubfieldInfo {
- subfieldName :: !String
- subfieldInfo :: !(FieldInfo codec)
}
data ChoiceCondition
- = IndexField !String
- | IndexFlag !String Word32
data ChoiceFieldInfo codec = ChoiceFieldInfo {
- choiceCondition :: !ChoiceCondition
- choiceFieldAlternatives :: ![FieldInfo codec]
}
annField :: String -> FieldInfo codec -> FieldInfo codec
basicField :: String -> FieldSize -> FieldInfo codec
enumField :: String -> FieldSize -> [(Int, String)] -> FieldInfo codec
enumField_ :: String -> [String] -> FieldInfo codec
aliasField :: String -> FieldInfo codec -> FieldInfo codec
compoundField :: String -> [(String, FieldInfo codec)] -> FieldInfo codec
choiceField :: ChoiceCondition -> [FieldInfo codec] -> FieldInfo codec
sumField :: String -> [(String, FieldInfo codec)] -> FieldInfo codec
listField :: FieldSize -> FieldInfo codec -> FieldInfo codec
data FieldSize
- = FixedSize !Int
- | EnumSize
- | VarSize !String
- | BinopSize !FieldSizeBinop !FieldSize !FieldSize
- | RangeSize !FieldSize !FieldSize
- | UnknownSize
knownSize :: FieldSize -> Maybe Int
data FieldSizeBinop
- = FSPlus
- | FSMul
- | FSMax
- | FSMin

Documentation annotation types

newtype Description Source #

Used to add descriptions via ANN pragmas. This is necessary because Template Haskell cannot find Haddock comments attached to constructors inside associated types, but it can find annotations on those same constructors.

Constructors

Description
Fields descriptionParagraphs :: [String]

Instances

Instances details

Data Description Source #
Instance details Defined in Data.SerDoc.Info Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Description -> c Description # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Description # toConstr :: Description -> Constr # dataTypeOf :: Description -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Description) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Description) # gmapT :: (forall b. Data b => b -> b) -> Description -> Description # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Description -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Description -> r # gmapQ :: (forall d. Data d => d -> u) -> Description -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Description -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Description -> m Description # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Description -> m Description # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Description -> m Description #
Monoid Description Source #
Instance details Defined in Data.SerDoc.Info Methods mempty :: Description # mappend :: Description -> Description -> Description # mconcat :: [Description] -> Description #
Semigroup Description Source #
Instance details Defined in Data.SerDoc.Info Methods (<>) :: Description -> Description -> Description # sconcat :: NonEmpty Description -> Description # stimes :: Integral b => b -> Description -> Description #
Read Description Source #
Instance details Defined in Data.SerDoc.Info Methods readsPrec :: Int -> ReadS Description # readList :: ReadS [Description] # readPrec :: ReadPrec Description # readListPrec :: ReadPrec [Description] #
Show Description Source #
Instance details Defined in Data.SerDoc.Info Methods showsPrec :: Int -> Description -> ShowS # show :: Description -> String # showList :: [Description] -> ShowS #
Eq Description Source #
Instance details Defined in Data.SerDoc.Info Methods (==) :: Description -> Description -> Bool # (/=) :: Description -> Description -> Bool #
Lift Description Source #
Instance details Defined in Data.SerDoc.Info Methods lift :: Quote m => Description -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => Description -> Code m Description #

`FieldInfo` and related types

data FieldInfo codec Source #

Describes the serialization format of a field.

Constructors

AnnField !String !(FieldInfo codec)	Adds an annotation to a field.
BasicField !BasicFieldInfo	A simple field, with a named type and a size.
EnumField !EnumFieldInfo	An enum field, which reports labels and values for the possible values.
CompoundField !(CompoundFieldInfo codec)	A field that is composed out of multiple sub-fields, encoded sequentially.
ChoiceField !(ChoiceFieldInfo codec)	A list of alternatives, to be picked based on a given choice condition.
ListField !(ListFieldInfo codec)	A list of values, encoded sequentially. The length must be encoded separately, and can be referenced from a length expression.
AliasField !(AliasFieldInfo codec)	Adds an alternative name (alias) to a field type.
SumField !(SumFieldInfo codec)	A list of named alternatives. TODO: this is probably redundant and may not actually work.

Instances

Instances details

Show (FieldInfo codec) Source #
Instance details Defined in Data.SerDoc.Info Methods showsPrec :: Int -> FieldInfo codec -> ShowS # show :: FieldInfo codec -> String # showList :: [FieldInfo codec] -> ShowS #
Eq (FieldInfo codec) Source #
Instance details Defined in Data.SerDoc.Info Methods (==) :: FieldInfo codec -> FieldInfo codec -> Bool # (/=) :: FieldInfo codec -> FieldInfo codec -> Bool #

data BasicFieldInfo Source #

Constructors

BasicFieldInfo
Fields basicFieldType :: !String basicFieldSize :: !FieldSize

Instances

Instances details

Show BasicFieldInfo Source #
Instance details Defined in Data.SerDoc.Info Methods showsPrec :: Int -> BasicFieldInfo -> ShowS # show :: BasicFieldInfo -> String # showList :: [BasicFieldInfo] -> ShowS #
Eq BasicFieldInfo Source #
Instance details Defined in Data.SerDoc.Info Methods (==) :: BasicFieldInfo -> BasicFieldInfo -> Bool # (/=) :: BasicFieldInfo -> BasicFieldInfo -> Bool #

data EnumFieldInfo Source #

Constructors

EnumFieldInfo
Fields enumFieldType :: !String enumFieldSize :: !FieldSize enumFieldValues :: ![(Int, String)]

Instances

Instances details

Show EnumFieldInfo Source #
Instance details Defined in Data.SerDoc.Info Methods showsPrec :: Int -> EnumFieldInfo -> ShowS # show :: EnumFieldInfo -> String # showList :: [EnumFieldInfo] -> ShowS #
Eq EnumFieldInfo Source #
Instance details Defined in Data.SerDoc.Info Methods (==) :: EnumFieldInfo -> EnumFieldInfo -> Bool # (/=) :: EnumFieldInfo -> EnumFieldInfo -> Bool #

data AliasFieldInfo codec Source #

Constructors

AliasFieldInfo
Fields aliasFieldName :: !String aliasFieldTarget :: !(FieldInfo codec)

Instances

Instances details

Show (AliasFieldInfo codec) Source #
Instance details Defined in Data.SerDoc.Info Methods showsPrec :: Int -> AliasFieldInfo codec -> ShowS # show :: AliasFieldInfo codec -> String # showList :: [AliasFieldInfo codec] -> ShowS #
Eq (AliasFieldInfo codec) Source #
Instance details Defined in Data.SerDoc.Info Methods (==) :: AliasFieldInfo codec -> AliasFieldInfo codec -> Bool # (/=) :: AliasFieldInfo codec -> AliasFieldInfo codec -> Bool #

data CompoundFieldInfo codec Source #

Constructors

CompoundFieldInfo
Fields compoundFieldType :: !String compoundFieldSubfields :: ![SubfieldInfo codec]

Instances

Instances details

Show (CompoundFieldInfo codec) Source #
Instance details Defined in Data.SerDoc.Info Methods showsPrec :: Int -> CompoundFieldInfo codec -> ShowS # show :: CompoundFieldInfo codec -> String # showList :: [CompoundFieldInfo codec] -> ShowS #
Eq (CompoundFieldInfo codec) Source #
Instance details Defined in Data.SerDoc.Info Methods (==) :: CompoundFieldInfo codec -> CompoundFieldInfo codec -> Bool # (/=) :: CompoundFieldInfo codec -> CompoundFieldInfo codec -> Bool #

data SumFieldInfo codec Source #

Constructors

SumFieldInfo
Fields sumFieldType :: !String sumFieldAlternatives :: ![(String, FieldInfo codec)]

Instances

Instances details

Show (SumFieldInfo codec) Source #
Instance details Defined in Data.SerDoc.Info Methods showsPrec :: Int -> SumFieldInfo codec -> ShowS # show :: SumFieldInfo codec -> String # showList :: [SumFieldInfo codec] -> ShowS #
Eq (SumFieldInfo codec) Source #
Instance details Defined in Data.SerDoc.Info Methods (==) :: SumFieldInfo codec -> SumFieldInfo codec -> Bool # (/=) :: SumFieldInfo codec -> SumFieldInfo codec -> Bool #

data ListFieldInfo codec Source #

Constructors

ListFieldInfo
Fields listSize :: !FieldSize listElemInfo :: !(FieldInfo codec)

Instances

Instances details

Show (ListFieldInfo codec) Source #
Instance details Defined in Data.SerDoc.Info Methods showsPrec :: Int -> ListFieldInfo codec -> ShowS # show :: ListFieldInfo codec -> String # showList :: [ListFieldInfo codec] -> ShowS #
Eq (ListFieldInfo codec) Source #
Instance details Defined in Data.SerDoc.Info Methods (==) :: ListFieldInfo codec -> ListFieldInfo codec -> Bool # (/=) :: ListFieldInfo codec -> ListFieldInfo codec -> Bool #

data SubfieldInfo codec Source #

Constructors

SubfieldInfo
Fields subfieldName :: !String subfieldInfo :: !(FieldInfo codec)

Instances

Instances details

Show (SubfieldInfo codec) Source #
Instance details Defined in Data.SerDoc.Info Methods showsPrec :: Int -> SubfieldInfo codec -> ShowS # show :: SubfieldInfo codec -> String # showList :: [SubfieldInfo codec] -> ShowS #
Eq (SubfieldInfo codec) Source #
Instance details Defined in Data.SerDoc.Info Methods (==) :: SubfieldInfo codec -> SubfieldInfo codec -> Bool # (/=) :: SubfieldInfo codec -> SubfieldInfo codec -> Bool #

data ChoiceCondition Source #

Constructors

IndexField !String
IndexFlag !String Word32

Instances

Instances details

Show ChoiceCondition Source #
Instance details Defined in Data.SerDoc.Info Methods showsPrec :: Int -> ChoiceCondition -> ShowS # show :: ChoiceCondition -> String # showList :: [ChoiceCondition] -> ShowS #
Eq ChoiceCondition Source #
Instance details Defined in Data.SerDoc.Info Methods (==) :: ChoiceCondition -> ChoiceCondition -> Bool # (/=) :: ChoiceCondition -> ChoiceCondition -> Bool #

data ChoiceFieldInfo codec Source #

Constructors

ChoiceFieldInfo
Fields choiceCondition :: !ChoiceCondition choiceFieldAlternatives :: ![FieldInfo codec]

Instances

Instances details

Show (ChoiceFieldInfo codec) Source #
Instance details Defined in Data.SerDoc.Info Methods showsPrec :: Int -> ChoiceFieldInfo codec -> ShowS # show :: ChoiceFieldInfo codec -> String # showList :: [ChoiceFieldInfo codec] -> ShowS #
Eq (ChoiceFieldInfo codec) Source #
Instance details Defined in Data.SerDoc.Info Methods (==) :: ChoiceFieldInfo codec -> ChoiceFieldInfo codec -> Bool # (/=) :: ChoiceFieldInfo codec -> ChoiceFieldInfo codec -> Bool #

annField :: String -> FieldInfo codec -> FieldInfo codec Source #

basicField :: String -> FieldSize -> FieldInfo codec Source #

enumField :: String -> FieldSize -> [(Int, String)] -> FieldInfo codec Source #

enumField_ :: String -> [String] -> FieldInfo codec Source #

aliasField :: String -> FieldInfo codec -> FieldInfo codec Source #

compoundField :: String -> [(String, FieldInfo codec)] -> FieldInfo codec Source #

choiceField :: ChoiceCondition -> [FieldInfo codec] -> FieldInfo codec Source #

sumField :: String -> [(String, FieldInfo codec)] -> FieldInfo codec Source #

listField :: FieldSize -> FieldInfo codec -> FieldInfo codec Source #

Field sizes

data FieldSize Source #

Constructors

FixedSize !Int	Exactly this size
EnumSize	The default enum size for the codec
VarSize !String	Size given by a named variable from the context
BinopSize !FieldSizeBinop !FieldSize !FieldSize	Binary operation
RangeSize !FieldSize !FieldSize	Min/max range
UnknownSize	Size is entirely unknown

Instances

Instances details

Show FieldSize Source #
Instance details Defined in Data.SerDoc.Info Methods showsPrec :: Int -> FieldSize -> ShowS # show :: FieldSize -> String # showList :: [FieldSize] -> ShowS #
Eq FieldSize Source #
Instance details Defined in Data.SerDoc.Info Methods (==) :: FieldSize -> FieldSize -> Bool # (/=) :: FieldSize -> FieldSize -> Bool #

knownSize :: FieldSize -> Maybe Int Source #

data FieldSizeBinop Source #

Constructors

FSPlus
FSMul
FSMax
FSMin

Instances

Instances details

Show FieldSizeBinop Source #
Instance details Defined in Data.SerDoc.Info Methods showsPrec :: Int -> FieldSizeBinop -> ShowS # show :: FieldSizeBinop -> String # showList :: [FieldSizeBinop] -> ShowS #
Eq FieldSizeBinop Source #
Instance details Defined in Data.SerDoc.Info Methods (==) :: FieldSizeBinop -> FieldSizeBinop -> Bool # (/=) :: FieldSizeBinop -> FieldSizeBinop -> Bool #

Documentation annotation types

Instances

FieldInfo and related types

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Field sizes

Instances

Instances

`FieldInfo` and related types