Data.Type.BitRecords.Enum

BitRecordFields containing enum-like types

data EnumOf enum where

Wrapper around a type that can be represented as a short number, indexing the clauses of the (sum) type.

Constructors

MkEnumOf :: IsAn (EnumField enum size) -> IsA (FieldValue label enum) -> BitRecord -> EnumOf enum

Instances

type Eval (EnumOf enum) (EnumParamAlt enum size label (FixedEnum enum size))

type Eval (EnumOf enum) (EnumParamAlt enum size label (FixedEnum enum size)) = TypeError (EnumOf enum) ((:<>:) (Text "Cannot assign an extension value to the FixedEnum ") (ShowType Type enum))

type Eval (EnumOf enum) (EnumParamAlt enum size label (ExtEnum rt k st len t enum size extInd extField))

type Eval (EnumOf enum) (EnumParamAlt enum size label (ExtEnum rt k st len t enum size extInd extField)) = MkEnumOf enum size label (ExtEnum rt k st len t enum size extInd extField) (StaticFieldValue enum label extInd) (BitRecordMember rt k st len t ((:~) label rt k st len t extField (RuntimeFieldValue k st label)))

type Eval (EnumOf enum) (EnumParam enum size label ei)

type Eval (EnumOf enum) (EnumParam enum size label ei) = MkEnumOf enum size label ei (RuntimeFieldValue Type enum label) EmptyBitRecord

type Eval (EnumOf enum) (SetEnum enum size l ei value)

type Eval (EnumOf enum) (SetEnum enum size l ei value) = MkEnumOf enum size l ei (StaticFieldValue enum l value) EmptyBitRecord

type Eval (EnumOf enum) (SetEnumAlt k enum size l (FixedEnum enum size) value)

type Eval (EnumOf enum) (SetEnumAlt k enum size l (FixedEnum enum size) value) = TypeError (EnumOf enum) ((:<>:) (Text "Cannot assign an 'extended' value to the 'FixedEnum' ") (ShowType Type enum))

type Eval (EnumOf enum) (SetEnumAlt st enum size l (ExtEnum rt * st len t enum size extInd extField) value)

type Eval (EnumOf enum) (SetEnumAlt st enum size l (ExtEnum rt * st len t enum size extInd extField) value) = MkEnumOf enum size l (ExtEnum rt * st len t enum size extInd extField) (StaticFieldValue enum l extInd) (BitRecordMember rt * st len t ((:=) rt len st t extField value))

type BitRecordOfEnum e = (RenderEnumOf (Eval e) :: BitRecord)

type family RenderEnumOf (e :: EnumOf enum) :: BitRecord where ...

Equations

RenderEnumOf (MkEnumOf mainField mainFieldVal extra) = (BitRecordFieldOfEnumField mainField :~ mainFieldVal) .+: extra

data EnumField enum size

Physical representation of an EnumOf, this is an abstract type

type BitRecordFieldOfEnumField x = MkField (MkFieldCustom :: BitField (EnumValue e) e s)

data FixedEnum enum size :: IsAn (EnumField enum size)

A fixed size EnumField

Instances

type Eval (EnumOf enum) (EnumParamAlt enum size label (FixedEnum enum size))

type Eval (EnumOf enum) (EnumParamAlt enum size label (FixedEnum enum size)) = TypeError (EnumOf enum) ((:<>:) (Text "Cannot assign an extension value to the FixedEnum ") (ShowType Type enum))

type Eval (EnumOf enum) (SetEnumAlt k enum size l (FixedEnum enum size) value)

type Eval (EnumOf enum) (SetEnumAlt k enum size l (FixedEnum enum size) value) = TypeError (EnumOf enum) ((:<>:) (Text "Cannot assign an 'extended' value to the 'FixedEnum' ") (ShowType Type enum))

data ExtEnum enum size extInd extField :: IsAn (EnumField enum size)

An enum that can be extended with an additional BitRecordField, following the regular enum field; the extension is optional, i.e. only if the regular field contains a special value (e.g. 0xff).

Instances

type Eval (EnumOf enum) (EnumParamAlt enum size label (ExtEnum rt k st len t enum size extInd extField))

type Eval (EnumOf enum) (EnumParamAlt enum size label (ExtEnum rt k st len t enum size extInd extField)) = MkEnumOf enum size label (ExtEnum rt k st len t enum size extInd extField) (StaticFieldValue enum label extInd) (BitRecordMember rt k st len t ((:~) label rt k st len t extField (RuntimeFieldValue k st label)))

type Eval (EnumOf enum) (SetEnumAlt st enum size l (ExtEnum rt * st len t enum size extInd extField) value)

type Eval (EnumOf enum) (SetEnumAlt st enum size l (ExtEnum rt * st len t enum size extInd extField) value) = MkEnumOf enum size l (ExtEnum rt * st len t enum size extInd extField) (StaticFieldValue enum l extInd) (BitRecordMember rt * st len t ((:=) rt len st t extField value))

data SetEnum l ef v :: IsAn (EnumOf enum)

Create an EnumOf that sets an enum to a static value.

Instances

type Eval (EnumOf enum) (SetEnum enum size l ei value)

type Eval (EnumOf enum) (SetEnum enum size l ei value) = MkEnumOf enum size l ei (StaticFieldValue enum l value) EmptyBitRecord

data EnumParam label ef :: IsAn (EnumOf enum)

Create an EnumOf that sets the enum to a runtime value.

Instances

type Eval (EnumOf enum) (EnumParam enum size label ei)

type Eval (EnumOf enum) (EnumParam enum size label ei) = MkEnumOf enum size label ei (RuntimeFieldValue Type enum label) EmptyBitRecord

data SetEnumAlt l ef v :: IsAn (EnumOf enum)

Create an EnumOf that sets an extended enum to an extended static value.

Instances

type Eval (EnumOf enum) (SetEnumAlt k enum size l (FixedEnum enum size) value)

type Eval (EnumOf enum) (SetEnumAlt k enum size l (FixedEnum enum size) value) = TypeError (EnumOf enum) ((:<>:) (Text "Cannot assign an 'extended' value to the 'FixedEnum' ") (ShowType Type enum))

type Eval (EnumOf enum) (SetEnumAlt st enum size l (ExtEnum rt * st len t enum size extInd extField) value)

type Eval (EnumOf enum) (SetEnumAlt st enum size l (ExtEnum rt * st len t enum size extInd extField) value) = MkEnumOf enum size l (ExtEnum rt * st len t enum size extInd extField) (StaticFieldValue enum l extInd) (BitRecordMember rt * st len t ((:=) rt len st t extField value))

data EnumParamAlt label ef :: IsAn (EnumOf enum)

Create an EnumOf that sets the extended enum to a runtime value.

Instances

type Eval (EnumOf enum) (EnumParamAlt enum size label (FixedEnum enum size))

type Eval (EnumOf enum) (EnumParamAlt enum size label (FixedEnum enum size)) = TypeError (EnumOf enum) ((:<>:) (Text "Cannot assign an extension value to the FixedEnum ") (ShowType Type enum))

type Eval (EnumOf enum) (EnumParamAlt enum size label (ExtEnum rt k st len t enum size extInd extField))

type Eval (EnumOf enum) (EnumParamAlt enum size label (ExtEnum rt k st len t enum size extInd extField)) = MkEnumOf enum size label (ExtEnum rt k st len t enum size extInd extField) (StaticFieldValue enum label extInd) (BitRecordMember rt k st len t ((:~) label rt k st len t extField (RuntimeFieldValue k st label)))

Composing BitRecords with enum fields

type family FromEnum enum (entry :: enum) :: Nat

Return the numeric index of an entry in a table. This emulates fromEnum a bit.

Instances

type FromEnum StreamType ObjectDescriptorStream

type FromEnum StreamType ObjectDescriptorStream = 1

type FromEnum StreamType ClockReferenceStream

type FromEnum StreamType ClockReferenceStream = 2

type FromEnum StreamType SceneDescriptionStream_Iso14496_11

type FromEnum StreamType SceneDescriptionStream_Iso14496_11 = 3

type FromEnum StreamType VisualStream

type FromEnum StreamType VisualStream = 4

type FromEnum StreamType AudioStream

type FromEnum StreamType AudioStream = 5

type FromEnum StreamType Mpeg7Stream

type FromEnum StreamType Mpeg7Stream = 6

type FromEnum StreamType IpmpStream

type FromEnum StreamType IpmpStream = 7

type FromEnum StreamType ObjectContentInfoStream

type FromEnum StreamType ObjectContentInfoStream = 8

type FromEnum StreamType MpegJStream

type FromEnum StreamType MpegJStream = 9

type FromEnum StreamType InteractionStream

type FromEnum StreamType InteractionStream = 10

type FromEnum StreamType IpmpToolStream_Iso14496_13

type FromEnum StreamType IpmpToolStream_Iso14496_13 = 11

type FromEnum ObjectTypeIndication SystemsIso14496_1_a

type FromEnum ObjectTypeIndication SystemsIso14496_1_a = 1

type FromEnum ObjectTypeIndication SystemsIso14496_1_b

type FromEnum ObjectTypeIndication SystemsIso14496_1_b = 2

type FromEnum ObjectTypeIndication InteractionStreamObjInd

type FromEnum ObjectTypeIndication InteractionStreamObjInd = 3

type FromEnum ObjectTypeIndication SystemsIso14496_1_ExtendedBifs

type FromEnum ObjectTypeIndication SystemsIso14496_1_ExtendedBifs = 4

type FromEnum ObjectTypeIndication SystemsIso14496_1_Afx

type FromEnum ObjectTypeIndication SystemsIso14496_1_Afx = 5

type FromEnum ObjectTypeIndication FontDataStream

type FromEnum ObjectTypeIndication FontDataStream = 6

type FromEnum ObjectTypeIndication SynthesizedTextureStream

type FromEnum ObjectTypeIndication SynthesizedTextureStream = 7

type FromEnum ObjectTypeIndication StreamingTextStream

type FromEnum ObjectTypeIndication StreamingTextStream = 8

type FromEnum ObjectTypeIndication VisualIso14496_2

type FromEnum ObjectTypeIndication VisualIso14496_2 = 32

type FromEnum ObjectTypeIndication VisualH264

type FromEnum ObjectTypeIndication VisualH264 = 33

type FromEnum ObjectTypeIndication VisualH264ParameterSets

type FromEnum ObjectTypeIndication VisualH264ParameterSets = 34

type FromEnum ObjectTypeIndication AudioIso14496_3

type FromEnum ObjectTypeIndication AudioIso14496_3 = 64

type FromEnum ObjectTypeIndication VisualIso13818_2_SimpleProfile

type FromEnum ObjectTypeIndication VisualIso13818_2_SimpleProfile = 96

type FromEnum ObjectTypeIndication VisualIso13818_2_MainProfile

type FromEnum ObjectTypeIndication VisualIso13818_2_MainProfile = 97

type FromEnum ObjectTypeIndication VisualIso13818_2_SnrProfile

type FromEnum ObjectTypeIndication VisualIso13818_2_SnrProfile = 98

type FromEnum ObjectTypeIndication VisualIso13818_2_SpatialProfile

type FromEnum ObjectTypeIndication VisualIso13818_2_SpatialProfile = 99

type FromEnum ObjectTypeIndication VisualIso13818_2_HighProfile

type FromEnum ObjectTypeIndication VisualIso13818_2_HighProfile = 100

type FromEnum ObjectTypeIndication VisualIso13818_2_422Profile

type FromEnum ObjectTypeIndication VisualIso13818_2_422Profile = 101

type FromEnum ObjectTypeIndication AudioIso13818_7_MainProfile

type FromEnum ObjectTypeIndication AudioIso13818_7_MainProfile = 102

type FromEnum ObjectTypeIndication AudioIso13818_7_LowComplexityProfile

type FromEnum ObjectTypeIndication AudioIso13818_7_LowComplexityProfile = 103

type FromEnum ObjectTypeIndication AudioIso13818_7_ScalableSamplingRateProfile

type FromEnum ObjectTypeIndication AudioIso13818_7_ScalableSamplingRateProfile = 104

type FromEnum ObjectTypeIndication AudioIso13818_3

type FromEnum ObjectTypeIndication AudioIso13818_3 = 105

type FromEnum ObjectTypeIndication VisualIso11172_2

type FromEnum ObjectTypeIndication VisualIso11172_2 = 106

type FromEnum ObjectTypeIndication AudioIso11172_3

type FromEnum ObjectTypeIndication AudioIso11172_3 = 107

type FromEnum ObjectTypeIndication VisualIso10918_1

type FromEnum ObjectTypeIndication VisualIso10918_1 = 108

type FromEnum ObjectTypeIndication VisualIso15444_1

type FromEnum ObjectTypeIndication VisualIso15444_1 = 110

type FromEnum ObjectTypeIndication NoObjectTypeSpecified

type FromEnum ObjectTypeIndication NoObjectTypeSpecified = 255

type FromEnum ChannelConfigTable GasChannelConfig

type FromEnum ChannelConfigTable GasChannelConfig = 0

type FromEnum ChannelConfigTable SingleChannel

type FromEnum ChannelConfigTable SingleChannel = 1

type FromEnum ChannelConfigTable ChannelPair

type FromEnum ChannelConfigTable ChannelPair = 2

type FromEnum ChannelConfigTable SinglePair

type FromEnum ChannelConfigTable SinglePair = 3

type FromEnum ChannelConfigTable SinglePairSingle

type FromEnum ChannelConfigTable SinglePairSingle = 4

type FromEnum ChannelConfigTable SinglePairPair

type FromEnum ChannelConfigTable SinglePairPair = 5

type FromEnum ChannelConfigTable SinglePairPairLfe

type FromEnum ChannelConfigTable SinglePairPairLfe = 6

type FromEnum ChannelConfigTable SinglePairPairPairLfe

type FromEnum ChannelConfigTable SinglePairPairPairLfe = 7

type FromEnum SamplingFreqTable SF96000

type FromEnum SamplingFreqTable SF96000 = 0

type FromEnum SamplingFreqTable SF88200

type FromEnum SamplingFreqTable SF88200 = 1

type FromEnum SamplingFreqTable SF64000

type FromEnum SamplingFreqTable SF64000 = 2

type FromEnum SamplingFreqTable SF48000

type FromEnum SamplingFreqTable SF48000 = 3

type FromEnum SamplingFreqTable SF44100

type FromEnum SamplingFreqTable SF44100 = 4

type FromEnum SamplingFreqTable SF32000

type FromEnum SamplingFreqTable SF32000 = 5

type FromEnum SamplingFreqTable SF24000

type FromEnum SamplingFreqTable SF24000 = 6

type FromEnum SamplingFreqTable SF22050

type FromEnum SamplingFreqTable SF22050 = 7

type FromEnum SamplingFreqTable SF16000

type FromEnum SamplingFreqTable SF16000 = 8

type FromEnum SamplingFreqTable SF12000

type FromEnum SamplingFreqTable SF12000 = 9

type FromEnum SamplingFreqTable SF11025

type FromEnum SamplingFreqTable SF11025 = 10

type FromEnum SamplingFreqTable SF8000

type FromEnum SamplingFreqTable SF8000 = 11

type FromEnum SamplingFreqTable SF7350

type FromEnum SamplingFreqTable SF7350 = 12

type FromEnum SamplingFreqTable SFReserved1

type FromEnum SamplingFreqTable SFReserved1 = 13

type FromEnum SamplingFreqTable SFReserved2

type FromEnum SamplingFreqTable SFReserved2 = 14

type FromEnum SamplingFreqTable SFCustom

type FromEnum SamplingFreqTable SFCustom = 15

type FromEnum AudioObjectTypeId AacMain

type FromEnum AudioObjectTypeId AacMain = 1

type FromEnum AudioObjectTypeId AacLc

type FromEnum AudioObjectTypeId AacLc = 2

type FromEnum AudioObjectTypeId AacSsr

type FromEnum AudioObjectTypeId AacSsr = 3

type FromEnum AudioObjectTypeId AacLtp

type FromEnum AudioObjectTypeId AacLtp = 4

type FromEnum AudioObjectTypeId Sbr

type FromEnum AudioObjectTypeId Sbr = 5

type FromEnum AudioObjectTypeId AacScalable

type FromEnum AudioObjectTypeId AacScalable = 6

type FromEnum AudioObjectTypeId TwinVq

type FromEnum AudioObjectTypeId TwinVq = 7

type FromEnum AudioObjectTypeId Celp

type FromEnum AudioObjectTypeId Celp = 8

type FromEnum AudioObjectTypeId Hvxc

type FromEnum AudioObjectTypeId Hvxc = 9

type FromEnum AudioObjectTypeId AoReserved1

type FromEnum AudioObjectTypeId AoReserved1 = 10

type FromEnum AudioObjectTypeId AoReserved2

type FromEnum AudioObjectTypeId AoReserved2 = 11

type FromEnum AudioObjectTypeId Ttsi

type FromEnum AudioObjectTypeId Ttsi = 12

type FromEnum AudioObjectTypeId MainSunthetic

type FromEnum AudioObjectTypeId MainSunthetic = 13

type FromEnum AudioObjectTypeId WavetableSynthesis

type FromEnum AudioObjectTypeId WavetableSynthesis = 14

type FromEnum AudioObjectTypeId GeneralMidi

type FromEnum AudioObjectTypeId GeneralMidi = 15

type FromEnum AudioObjectTypeId AlgorithmicSynthesisAndAudioFx

type FromEnum AudioObjectTypeId AlgorithmicSynthesisAndAudioFx = 16

type FromEnum AudioObjectTypeId ErAacLc

type FromEnum AudioObjectTypeId ErAacLc = 17

type FromEnum AudioObjectTypeId AoReserved3

type FromEnum AudioObjectTypeId AoReserved3 = 18

type FromEnum AudioObjectTypeId ErAacLtp

type FromEnum AudioObjectTypeId ErAacLtp = 19

type FromEnum AudioObjectTypeId ErAacScalable

type FromEnum AudioObjectTypeId ErAacScalable = 20

type FromEnum AudioObjectTypeId ErTwinVq

type FromEnum AudioObjectTypeId ErTwinVq = 21

type FromEnum AudioObjectTypeId ErBsac

type FromEnum AudioObjectTypeId ErBsac = 22

type FromEnum AudioObjectTypeId ErAacLd

type FromEnum AudioObjectTypeId ErAacLd = 23

type FromEnum AudioObjectTypeId ErCelp

type FromEnum AudioObjectTypeId ErCelp = 24

type FromEnum AudioObjectTypeId ErHvxc

type FromEnum AudioObjectTypeId ErHvxc = 25

type FromEnum AudioObjectTypeId ErHiln

type FromEnum AudioObjectTypeId ErHiln = 26

type FromEnum AudioObjectTypeId ErParametric

type FromEnum AudioObjectTypeId ErParametric = 27

type FromEnum AudioObjectTypeId Ssc

type FromEnum AudioObjectTypeId Ssc = 28

type FromEnum AudioObjectTypeId AoReserved4

type FromEnum AudioObjectTypeId AoReserved4 = 29

type FromEnum AudioObjectTypeId AoReserved5

type FromEnum AudioObjectTypeId AoReserved5 = 30

type FromEnum AudioObjectTypeId AoCustom

type FromEnum AudioObjectTypeId AoCustom = 31

type FromEnum AudioObjectTypeId AoLayer1

type FromEnum AudioObjectTypeId AoLayer1 = 32

type FromEnum AudioObjectTypeId AoLayer2

type FromEnum AudioObjectTypeId AoLayer2 = 33

type FromEnum AudioObjectTypeId AoLayer3

type FromEnum AudioObjectTypeId AoLayer3 = 34

type FromEnum AudioObjectTypeId AoDst

type FromEnum AudioObjectTypeId AoDst = 35

type FromEnum AudioObjectTypeId AotInvalid

type FromEnum AudioObjectTypeId AotInvalid = 0

data EnumValue e where

An enum value supplied at runtime.

Constructors

MkEnumValue :: KnownNat (FromEnum e v) => Proxy (v :: e) -> EnumValue e

Instances

KnownChunkSize size => BitStringBuilderHoley (Proxy (A Type (BitRecordField (EnumValue e) * e size (MkFieldCustom * (EnumValue e) e size)) -> Type) (MkField (EnumValue e) * e size (MkFieldCustom * (EnumValue e) e size))) r

Associated Types

type ToBitStringBuilder (Proxy (A Type (BitRecordField (EnumValue e) * e size (MkFieldCustom * (EnumValue e) e size)) -> Type) (MkField (EnumValue e) * e size (MkFieldCustom * (EnumValue e) e size))) r :: *

Methods

bitStringBuilderHoley :: Proxy (A Type (BitRecordField (EnumValue e) * e size (MkFieldCustom * (EnumValue e) e size)) -> Type) (MkField (EnumValue e) * e size (MkFieldCustom * (EnumValue e) e size)) -> Holey BitStringBuilder r (ToBitStringBuilder (Proxy (A Type (BitRecordField (EnumValue e) * e size (MkFieldCustom * (EnumValue e) e size)) -> Type) (MkField (EnumValue e) * e size (MkFieldCustom * (EnumValue e) e size))) r)

(KnownNat (FromEnum e v), KnownChunkSize size) => BitStringBuilderHoley (Proxy (A Type (BitRecordField (EnumValue e) * e size (MkFieldCustom * (EnumValue e) e size)) -> Type) ((:=) (EnumValue e) size e (MkFieldCustom * (EnumValue e) e size) f v)) r

Associated Types

type ToBitStringBuilder (Proxy (A Type (BitRecordField (EnumValue e) * e size (MkFieldCustom * (EnumValue e) e size)) -> Type) ((:=) (EnumValue e) size e (MkFieldCustom * (EnumValue e) e size) f v)) r :: *

Methods

bitStringBuilderHoley :: Proxy (A Type (BitRecordField (EnumValue e) * e size (MkFieldCustom * (EnumValue e) e size)) -> Type) ((EnumValue e := size) e (MkFieldCustom * (EnumValue e) e size) f v) -> Holey BitStringBuilder r (ToBitStringBuilder (Proxy (A Type (BitRecordField (EnumValue e) * e size (MkFieldCustom * (EnumValue e) e size)) -> Type) ((EnumValue e := size) e (MkFieldCustom * (EnumValue e) e size) f v)) r)

type PrettyCustomFieldValue (EnumValue e) e size v

type PrettyCustomFieldValue (EnumValue e) e size v = (<+>) ((<+>) (PutNat (FromEnum e v)) ((<:>) "hex" (PutHex (FromEnum e v)))) ((<:>) "bin" (PutBits (FromEnum e v)))

type ToPretty * (EnumValue e)

type ToPretty * (EnumValue e) = PutStr "<<enum>>"

type ToBitStringBuilder (Proxy (A Type (BitRecordField (EnumValue e) * e size (MkFieldCustom * (EnumValue e) e size)) -> Type) (MkField (EnumValue e) * e size (MkFieldCustom * (EnumValue e) e size))) r

type ToBitStringBuilder (Proxy (A Type (BitRecordField (EnumValue e) * e size (MkFieldCustom * (EnumValue e) e size)) -> Type) (MkField (EnumValue e) * e size (MkFieldCustom * (EnumValue e) e size))) r = EnumValue e -> r

type ToBitStringBuilder (Proxy (A Type (BitRecordField (EnumValue e) * e size (MkFieldCustom * (EnumValue e) e size)) -> Type) ((:=) (EnumValue e) size e (MkFieldCustom * (EnumValue e) e size) f v)) r

type ToBitStringBuilder (Proxy (A Type (BitRecordField (EnumValue e) * e size (MkFieldCustom * (EnumValue e) e size)) -> Type) ((:=) (EnumValue e) size e (MkFieldCustom * (EnumValue e) e size) f v)) r = r

enumValueProxy :: KnownNat (FromEnum e v) => Proxy (v :: e) -> EnumValue e

Create an EnumValue from a Proxy. TODO remove?

fromEnumValue :: EnumValue e -> Word64