Portability	portable
Stability	provisional
Maintainer	Antoine Latter <aslatter@gmail.com>
Safe Haskell	Safe-Inferred

Data.XCB.Types

Description

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

Synopsis

Documentation

type XHeader = GenXHeader Type Source

type XDecl = GenXDecl Type Source

type StructElem = GenStructElem Type Source

type XidUnionElem = GenXidUnionElem Type Source

type XReply = GenXReply Type Source

data GenXHeader typ Source

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 Source

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]
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 Source

Constructors

Pad Int
List Name typ (Maybe Expression) (Maybe (EnumVals typ))
SField Name typ (Maybe (EnumVals typ)) (Maybe (MaskVals typ))
ExprField Name typ Expression
ValueParam typ Name (Maybe MaskPadding) ListName

Instances

Functor GenStructElem
Show typ => Show (GenStructElem typ)
Pretty a => Pretty (GenStructElem a)

type GenXReply typ = [GenStructElem typ]Source

data GenXidUnionElem typ Source

Constructors

XidUnionElem typ

Instances

Functor GenXidUnionElem
Show typ => Show (GenXidUnionElem typ)
Pretty a => Pretty (GenXidUnionElem a)

data EnumElem Source

Constructors

EnumElem Name (Maybe Expression)

Instances

Show EnumElem
Pretty EnumElem

data Expression Source

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
Op Binop Expression Expression	A binary opeation

Instances

Show Expression
Pretty Expression

data Binop Source

Supported Binary operations.

Constructors

Add
Sub
Mult
Div
And
RShift

Instances

Show Binop
Pretty Binop

data Type Source

Types may include a reference to the containing module.

Constructors

UnQualType Name
QualType Name Name

Instances

Show Type
Pretty Type

type EnumVals typ = typSource

type MaskVals typ = typSource

type Name = String Source

type Ref = String Source

type MaskName = Name Source

type ListName = Name Source

type MaskPadding = Int Source