Data.XCB.Types

Defines types inteneded to be equivalent to the schema used by the XCB project in their XML protocol description.

Documentation

type XHeader = GenXHeader Type

type XDecl = GenXDecl Type

type StructElem = GenStructElem Type

type XEnumElem = EnumElem Type

type BitCase = GenBitCase Type

type XidUnionElem = GenXidUnionElem Type

type XReply = GenXReply Type

type XExpression = Expression Type

data GenXHeader typ

This is what a single XML file maps to. It contains some meta-data then declarations.

Constructors

XHeader

Fields

xheader_header :: Name

Name of module. Used in the other modules as a reference.

xheader_xname :: Maybe Name

Name used to indentify extensions between the X client and server.

xheader_name :: Maybe Name

InterCaps name.

xheader_multiword :: Maybe Bool

xheader_major_version :: Maybe Int

xheader_minor_version :: Maybe Int

xheader_decls :: [GenXDecl typ]

Declarations contained in this module.

Instances

Functor GenXHeader

Show typ => Show (GenXHeader typ)

Pretty a => Pretty (GenXHeader a)

data GenXDecl typ

The different types of declarations which can be made in one of the XML files.

Constructors

XStruct Name [GenStructElem typ]

XTypeDef Name typ

XEvent Name Int [GenStructElem typ] (Maybe Bool)

The boolean indicates if the event includes a sequence number.

XRequest Name Int [GenStructElem typ] (Maybe (GenXReply typ))

XidType Name

XidUnion Name [GenXidUnionElem typ]

XEnum Name [EnumElem typ]

XUnion Name [GenStructElem typ]

XImport Name

XError Name Int [GenStructElem typ]

Instances

Functor GenXDecl

Show typ => Show (GenXDecl typ)

Pretty a => Pretty (GenXDecl a)

data GenStructElem typ

Constructors

Pad Int

List Name typ (Maybe (Expression typ)) (Maybe (EnumVals typ))

SField Name typ (Maybe (EnumVals typ)) (Maybe (MaskVals typ))

ExprField Name typ (Expression typ)

ValueParam typ Name (Maybe MaskPadding) ListName

Switch Name (Expression typ) [GenBitCase typ]

Doc (Maybe String) (Map Name String) [(String, String)]

Fd String

Instances

Functor GenStructElem

Show typ => Show (GenStructElem typ)

Pretty a => Pretty (GenStructElem a)

data GenBitCase typ

Constructors

BitCase (Maybe Name) (Expression typ) [GenStructElem typ]

Instances

Functor GenBitCase

Show typ => Show (GenBitCase typ)

Pretty a => Pretty (GenBitCase a)

type GenXReply typ = [GenStructElem typ]

data GenXidUnionElem typ

Constructors

XidUnionElem typ

Instances

Functor GenXidUnionElem

Show typ => Show (GenXidUnionElem typ)

Pretty a => Pretty (GenXidUnionElem a)

data EnumElem typ

Constructors

EnumElem Name (Maybe (Expression typ))

Instances

Functor EnumElem

Show typ => Show (EnumElem typ)

Pretty a => Pretty (EnumElem a)

data Expression typ

Declarations may contain expressions from this small language

Constructors

Value Int

A literal value

Bit Int

A log-base-2 literal value

FieldRef Name

A reference to a field in the same declaration

EnumRef typ Name

A reference to a member of an enum.

PopCount (Expression typ)

Calculate the number of set bits in the argument

SumOf Name

Note sure. The argument should be a reference to a list

Op Binop (Expression typ) (Expression typ)

A binary opeation

Unop Unop (Expression typ)

A unary operation

Instances

Functor Expression

Show typ => Show (Expression typ)

Pretty a => Pretty (Expression a)

data Binop

Supported Binary operations.

Constructors

Add

Sub

Mult

Div

And

RShift

Instances

Show Binop

Pretty Binop

data Unop

Constructors

Complement

Instances

Show Unop

Pretty Unop

data Type

Types may include a reference to the containing module.

Constructors

UnQualType Name

QualType Name Name

Instances

Eq Type

Ord Type

Show Type

Pretty Type

type EnumVals typ = typ

type MaskVals typ = typ

type Name = String

type Ref = String

type MaskName = Name

type ListName = Name

type MaskPadding = Int