/* 	Xlib binding for D language
	Copyright 2007 TEISSIER Sylvere sligor(at)free.fr
	version 0.1 2007/08/29
	This binding is an alpha release and need to be more tested
	
	This file is free software, please read licence.txt for more informations
*/

module std.c.linux.X11.X;

const uint X_PROTOCOL=11;		/* current protocol version */
const uint X_PROTOCOL_REVISION=0;		/* current minor version */

/* Resources */
alias ulong XID;
alias ulong Mask;
alias ulong VisualID;
alias ulong Time;
alias XID Atom; //alias needed because of None invariant shared for Atom and XID
alias XID Window;
alias XID Drawable;
alias XID Font;
alias XID Pixmap;
alias XID Cursor;
alias XID Colormap;
alias XID GContext;
alias XID KeySym;
alias uint KeyCode;

/*****************************************************************
 * RESERVED RESOURCE AND CONSTANT DEFINITIONS
 *****************************************************************/
const XID None=0;/* universal null resource or null atom */
const uint ParentRelative=1;	/* border pixmap in CreateWindow and ChangeWindowAttributes special VisualID and special window class passed to CreateWindow */
const uint CopyFromParent=0;	/* background pixmap in CreateWindow and ChangeWindowAttributes */
const Window PointerWindow=0;	/* destination window in SendEvent */
const Window InputFocus=1;		/* destination window in SendEvent */
const Window PointerRoot=1;		/* focus window in SetInputFocus */
const Atom AnyPropertyType=0;	/* special Atom, passed to GetProperty */
const KeyCode AnyKey=0;			/* special Key Code, passed to GrabKey */
const uint AnyButton=0;			/* special Button Code, passed to GrabButton */
const XID AllTemporary=0;		/* special Resource ID passed to KillClient */
const Time CurrentTime=0;		/* special Time */
const KeySym NoSymbol=0;		/* special KeySym */

/***************************************************************** 
 * EVENT DEFINITIONS 
 *****************************************************************/
 
 /* Input Event Masks. Used as event-mask window attribute and as arguments
   to Grab requests.  Not to be confused with event names.  */
 
enum EventMask:long
{ 
	NoEventMask				=0,
	KeyPressMask			=1<<0,
	KeyReleaseMask			=1<<1, 
	ButtonPressMask			=1<<2,
	ButtonReleaseMask		=1<<3,
	EnterWindowMask			=1<<4,
	LeaveWindowMask			=1<<5,
	PointerMotionMask		=1<<6,
	PointerMotionHintMask	=1<<7,
	Button1MotionMask		=1<<8,
	Button2MotionMask		=1<<9,
	Button3MotionMask		=1<<10,
	Button4MotionMask		=1<<11,
	Button5MotionMask		=1<<12,
	ButtonMotionMask		=1<<13,
	KeymapStateMask		=1<<14,
	ExposureMask			=1<<15,
	VisibilityChangeMask	=1<<16,
	StructureNotifyMask		=1<<17,
	ResizeRedirectMask		=1<<18,
	SubstructureNotifyMask	=1<<19,
	SubstructureRedirectMask=1<<20,
	FocusChangeMask			=1<<21,
	PropertyChangeMask		=1<<22,
	ColormapChangeMask		=1<<23,
	OwnerGrabButtonMask		=1<<24
};

/* Event names.  Used in "type" field in XEvent structures.  Not to be
confused with event masks above.  They start from 2 because 0 and 1
are reserved in the protocol for errors and replies. */

enum EventType:int
{
	KeyPress			=2,
	KeyRelease			=3,
	ButtonPress			=4,
	ButtonRelease		=5,
	MotionNotify		=6,
	EnterNotify			=7,
	LeaveNotify			=8,
	FocusIn				=9,
	FocusOut			=10,
	KeymapNotify		=11,
	Expose				=12,
	GraphicsExpose		=13,
	NoExpose			=14,
	VisibilityNotify	=15,
	CreateNotify		=16,
	DestroyNotify		=17,
	UnmapNotify		=18,
	MapNotify			=19,
	MapRequest			=20,
	ReparentNotify		=21,
	ConfigureNotify		=22,
	ConfigureRequest	=23,
	GravityNotify		=24,
	ResizeRequest		=25,
	CirculateNotify		=26,
	CirculateRequest	=27,
	PropertyNotify		=28,
	SelectionClear		=29,
	SelectionRequest	=30,
	SelectionNotify		=31,
	ColormapNotify		=32,
	ClientMessage		=33,
	MappingNotify		=34,
	LASTEvent			=35	/* must be bigger than any event # */
};

/* Key masks. Used as modifiers to GrabButton and GrabKey, results of QueryPointer,
   state in various key-, mouse-, and button-related events. */
enum KeyMask:uint
{
	ShiftMask	=1<<0,
	LockMask	=1<<1,
	ControlMask	=1<<2,
	Mod1Mask	=1<<3,
	Mod2Mask	=1<<4,
	Mod3Mask	=1<<5,
	Mod4Mask	=1<<6,
	Mod5Mask	=1<<7,
	AnyModifier	=1<<15/* used in GrabButton, GrabKey */
};

/* modifier names.  Used to build a SetModifierMapping request or
   to read a GetModifierMapping request.  These correspond to the
   masks defined above. */
enum ModifierName:int
{
	ShiftMapIndex	=0,
	LockMapIndex	=1,
	ControlMapIndex	=2,
	Mod1MapIndex	=3,
	Mod2MapIndex	=4,
	Mod3MapIndex	=5,
	Mod4MapIndex	=6,
	Mod5MapIndex	=7
};

enum ButtonMask:int
{
	Button1Mask	=1<<8,
	Button2Mask	=1<<9,
	Button3Mask	=1<<10,
	Button4Mask	=1<<11,
	Button5Mask	=1<<12,
	AnyModifier	=1<<15/* used in GrabButton, GrabKey */
};

enum KeyOrButtonMask:uint
{
	ShiftMask	=1<<0,
	LockMask	=1<<1,
	ControlMask	=1<<2,
	Mod1Mask	=1<<3,
	Mod2Mask	=1<<4,
	Mod3Mask	=1<<5,
	Mod4Mask	=1<<6,
	Mod5Mask	=1<<7,
	Button1Mask	=1<<8,
	Button2Mask	=1<<9,
	Button3Mask	=1<<10,
	Button4Mask	=1<<11,
	Button5Mask	=1<<12,
	AnyModifier	=1<<15/* used in GrabButton, GrabKey */
};


/* button names. Used as arguments to GrabButton and as detail in ButtonPress
   and ButtonRelease events.  Not to be confused with button masks above.
   Note that 0 is already defined above as "AnyButton".  */

enum ButtonName:int
{
	Button1	=1,
	Button2	=2,
	Button3	=3,
	Button4	=4,
	Button5	=5
};

/* Notify modes */
enum NotifyModes:int
{
	NotifyNormal		=0,
	NotifyGrab			=1,
	NotifyUngrab		=2,
	NotifyWhileGrabbed	=3
};
const int NotifyHint	=1;	/* for MotionNotify events */
		       
/* Notify detail */
enum NotifyDetail:int
{
	NotifyAncestor			=0,
	NotifyVirtual			=1,
	NotifyInferior			=2,
	NotifyNonlinear			=3,
	NotifyNonlinearVirtual	=4,
	NotifyPointer			=5,
	NotifyPointerRoot		=6,
	NotifyDetailNone		=7
};

/* Visibility notify */

enum VisibilityNotify:int
{
VisibilityUnobscured		=0,
VisibilityPartiallyObscured	=1,
VisibilityFullyObscured		=2
};

/* Circulation request */
enum CirculationRequest:int
{
	PlaceOnTop		=0,
	PlaceOnBottom	=1
};
/* protocol families */
enum ProtocolFamlily:int
{
	FamilyInternet	=0,	/* IPv4 */
	FamilyDECnet	=1,
	FamilyChaos	=2,
	FamilyServerInterpreted =5, /* authentication families not tied to a specific protocol */
	FamilyInternet6 =6	/* IPv6 */
};

/* Property notification */

enum PropertyNotification:int
{
	PropertyNewValue	=0,
	PropertyDelete		=1
};

/* Color Map notification */
enum ColorMapNotification:int
{
	ColormapUninstalled	=0,
	ColormapInstalled		=1
};

/* GrabPointer, GrabButton, GrabKeyboard, GrabKey Modes */
enum GrabMode:int
{
	GrabModeSync	=0,
	GrabModeAsync	=1
};

/* GrabPointer, GrabKeyboard reply status */
enum GrabReplyStatus:int
{
GrabSuccess			=0,
AlreadyGrabbed		=1,
GrabInvalidTime	=2,
GrabNotViewable		=3,
GrabFrozen			=4
};

/* AllowEvents modes */

enum AllowEventMode:int
{
AsyncPointer	=0,
SyncPointer		=1,
ReplayPointer	=2,
AsyncKeyboard	=3,
SyncKeyboard	=4,
ReplayKeyboard	=5,
AsyncBoth		=6,
SyncBoth		=7
};

/* Used in SetInputFocus, GetInputFocus */
enum InputFocusRevertTo:int
{
RevertToNone		=None,
RevertToPointerRoot	=PointerRoot,
RevertToParent		=2
};

/*****************************************************************
 * ERROR CODES 
 *****************************************************************/

enum XErrorCode:int
{
	Success		   	=0,		/* everything's okay */
	BadRequest	   	=1,		/* bad request code */
	BadValue	   	=2,		/* int parameter out of range */
	BadWindow	   	=3,		/* parameter not a Window */
	BadPixmap	   	=4,		/* parameter not a Pixmap */
	BadAtom		=5,		/* parameter not an Atom */
	BadCursor	   	=6,		/* parameter not a Cursor */
	BadFont		   	=7,		/* parameter not a Font */
	BadMatch	   	=8,		/* parameter mismatch */
	BadDrawable	   	=9,		/* parameter not a Pixmap or Window */
	BadAccess	  	=10,	/* depending on context:
				 			- key/button already grabbed
				 			- attempt to free an illegal 
				   				cmap entry 
							- attempt to store into a read-only 
				   				color map entry.
 							- attempt to modify the access control
				   				list from other than the local host.
							*/
	BadAlloc	  	=11,	/* insufficient resources */
	BadColor	  	=12,	/* no such colormap */
	BadGC		  	=13,	/* parameter not a GC */
	BadIDChoice	  	=14,	/* choice not in range or already used */
	BadName		=15,	/* font or color name doesn't exist */
	BadLength	  	=16,	/* Request length incorrect */
	BadImplementation =17,	/* server is defective */

	FirstExtensionError	=128,
	LastExtensionError	=255
};

/*****************************************************************
 * WINDOW DEFINITIONS 
 *****************************************************************/

/* Window classes used by CreateWindow */
/* Note that CopyFromParent is already defined as 0 above */
enum WindowClass:int
{
	CopyFromParent	=0,
	InputOutput		=1,
	InputOnly		=2
};

/* Window attributes for CreateWindow and ChangeWindowAttributes */

enum WindowAttribute:ulong
{
	CWBackPixmap		=1<<0,
	CWBackPixel			=1<<1,
	CWBorderPixmap		=1<<2,
	CWBorderPixel		=1<<3,
	CWBitGravity		=1<<4,
	CWWinGravity		=1<<5,
	CWBackingStore		=1<<6,
	CWBackingPlanes		=1<<7,
	CWBackingPixel		=1<<8,
	CWOverrideRedirect	=1<<9,
	CWSaveUnder			=1<<10,
	CWEventMask			=1<<11,
	CWDontPropagate		=1<<12,
	CWColormap			=1<<13,
	CWCursor			=1<<14
};
/* ConfigureWindow structure */
enum ConfigureWindowStruct:int
{
	CWX				=1<<0,
	CWY				=1<<1,
	CWWidth			=1<<2,
	CWHeight		=1<<3,
	CWBorderWidth	=1<<4,
	CWSibling		=1<<5,
	CWStackMode		=1<<6
};

/* Bit Gravity */
enum BitGravity:int
{
	ForgetGravity		=0,
	NorthWestGravity	=1,
	NorthGravity		=2,
	NorthEastGravity	=3,
	WestGravity			=4,
	CenterGravity		=5,
	EastGravity			=6,
	SouthWestGravity	=7,
	SouthGravity		=8,
	SouthEastGravity	=9,
	StaticGravity		=10
};

/* Window gravity + bit gravity above */

const uint UnmapGravity=0;

/* Used in CreateWindow for backing-store hint */
enum BackingStoreHint:int
{
	NotUseful	=0,
	WhenMapped	=1,
	Always		=2
};
/* Used in GetWindowAttributes reply */
enum MapState:int
{
	IsUnmapped		=0,
	IsUnviewable	=1,
	IsViewable		=2
};
/* Used in ChangeSaveSet */
enum ChangeMode:int
{
	SetModeInsert	=0,
	SetModeDelete	=1
};
/* Used in ChangeCloseDownMode */
enum CloseDownMode:int
{
	DestroyAll			=0,
	RetainPermanent	=1,
	RetainTemporary	=2
};

/* Window stacking method (in configureWindow) */
enum WindowStackingMethod:int
{
	Above		=0,
	Below		=1,
	TopIf		=2,
	BottomIf	=3,
	Opposite	=4
};

/* Circulation direction */
enum CircularDirection:int
{
RaiseLowest		=0,
LowerHighest	=1
};

/* Property modes */
enum PropertyMode:int
{
PropModeReplace	=0,
PropModePrepend	=1,
PropModeAppend	=2
};

/*****************************************************************
 * GRAPHICS DEFINITIONS
 *****************************************************************/

/* graphics functions, as in GC.alu */
enum GraphicFunction:int
{
	GXclear			=0x0,		/* 0 */
	GXand			=0x1,		/* src AND dst */
	GXandReverse	=0x2,		/* src AND NOT dst */
	GXcopy			=0x3,		/* src */
	GXandInverted	=0x4,		/* NOT src AND dst */
	GXnoop			=0x5,		/* dst */
	GXxor			=0x6,		/* src XOR dst */
	GXor			=0x7,		/* src OR dst */
	GXnor			=0x8,		/* NOT src AND NOT dst */
	GXequiv			=0x9,		/* NOT src XOR dst */
	GXinvert		=0xa,		/* NOT dst */
	GXorReverse		=0xb,		/* src OR NOT dst */
	GXcopyInverted	=0xc,		/* NOT src */
	GXorInverted	=0xd,		/* NOT src OR dst */
	GXnand			=0xe,		/* NOT src OR NOT dst */
	GXset			=0xf		/* 1 */
};

/* LineStyle */
enum LineStyle:int
{
	LineSolid		=0,
	LineOnOffDash	=1,
	LineDoubleDash	=2
};
/* capStyle */
enum CapStyle:int
{
	CapNotLast		=0,
	CapButt			=1,
	CapRound		=2,
	CapProjecting	=3
};
/* joinStyle */
enum JoinStyle:int
{
	JoinMiter		=0,
	JoinRound		=1,
	JoinBevel		=2
};
/* fillStyle */
enum FillStyle:int
{
	FillSolid		=0,
	FillTiled		=1,
	FillStippled	=2,
	FillOpaqueStippled	=3
};
/* fillRule */
enum FillRule:int
{
	EvenOddRule		=0,
	WindingRule		=1
};
/* subwindow mode */
enum SubwindowMode:int
{
	ClipByChildren		=0,
	IncludeInferiors	=1
};
/* SetClipRectangles ordering */
enum ClipRectanglesOrdering:int
{
	Unsorted		=0,
	YSorted			=1,
	YXSorted		=2,
	YXBanded		=3
};
/* CoordinateMode for drawing routines */
enum CoordinateMode:int
{
	CoordModeOrigin		=0,	/* relative to the origin */
	CoordModePrevious	=1	/* relative to previous point */
};
/* Polygon shapes */
enum PolygonShape:int
{
	Complex		=0,	/* paths may intersect */
	Nonconvex		=1,	/* no paths intersect, but not convex */
	Convex			=2	/* wholly convex */
};

/* Arc modes for PolyFillArc */
enum ArcMode:int
{
	ArcChord		=0,	/* join endpoints of arc */
	ArcPieSlice		=1	/* join endpoints to center of arc */
};
/* GC components: masks used in CreateGC, CopyGC, ChangeGC, OR'ed into
   GC.stateChanges */
enum GCMask:ulong
{
	GCFunction			=1<<0,
	GCPlaneMask			=1<<1,
	GCForeground		=1<<2,
	GCBackground		=1<<3,
	GCLineWidth			=1<<4,
	GCLineStyle			=1<<5,
	GCCapStyle			=1<<6,
	GCJoinStyle			=1<<7,
	GCFillStyle			=1<<8,
	GCFillRule			=1<<9,
	GCTile				=1<<10,
	GCStipple			=1<<11,
	GCTileStipXOrigin	=1<<12,
	GCTileStipYOrigin	=1<<13,
	GCFont 				=1<<14,
	GCSubwindowMode		=1<<15,
	GCGraphicsExposures	=1<<16,
	GCClipXOrigin		=1<<17,
	GCClipYOrigin		=1<<18,
	GCClipMask			=1<<19,
	GCDashOffset		=1<<20,
	GCDashList			=1<<21,
	GCArcMode			=1<<22,
};
const uint GCLastBit=22;
/*****************************************************************
 * FONTS 
 *****************************************************************/

/* used in QueryFont -- draw direction */
enum FontDrawDirection:int
{
	FontLeftToRight		=0,
	FontRightToLeft		=1,
	FontChange			=255
}
/*****************************************************************
 *  IMAGING 
 *****************************************************************/

/* ImageFormat -- PutImage, GetImage */
enum ImageFormat:int
{
	XYBitmap	=0,	/* depth 1, XYFormat */
	XYPixmap	=1,	/* depth == drawable depth */
	ZPixmap	=2	/* depth == drawable depth */
};

/*****************************************************************
 *  COLOR MAP STUFF 
 *****************************************************************/

/* For CreateColormap */
enum AllocType:int
{
	AllocNone	=0,	/* create map with no entries */
	AllocAll	=1	/* allocate entire map writeable */
};

/* Flags used in StoreNamedColor, StoreColors */
enum StoreColor:int
{
	DoRed	=1<<0,
	DoGreen	=1<<1,
	DoBlue	=1<<2
};

/*****************************************************************
 * CURSOR STUFF
 *****************************************************************/

/* QueryBestSize Class */
enum QueryBestSizeClass:int
{
	CursorShape		=0,	/* largest size that can be displayed */
	TileShape		=1,	/* size tiled fastest */
	StippleShape	=2	/* size stippled fastest */
};

/***************************************************************** 
 * KEYBOARD/POINTER STUFF
 *****************************************************************/

enum AutoRepeatMode:int
{
	AutoRepeatModeOff		=0,
	AutoRepeatModeOn		=1,
	AutoRepeatModeDefault	=2
};

enum LedMode:int
{
	LedModeOff		=0,
	LedModeOn		=1
};
/* masks for ChangeKeyboardControl */

enum KBMask:ulong
{
	KBKeyClickPercent	=1<<0,
	KBBellPercent		=1<<1,
	KBBellPitch			=1<<2,
	KBBellDuration		=1<<3,
	KBLed				=1<<4,
	KBLedMode			=1<<5,
	KBKey				=1<<6,
	KBAutoRepeatMode	=1<<7
};

enum MappingErrorCode:int
{
	MappingSuccess     	=0,
	MappingBusy        	=1,
	MappingFailed		=2
};

enum MappingType:int
{
	MappingModifier		=0,
	MappingKeyboard		=1,
	MappingPointer		=2
};

/*****************************************************************
 * SCREEN SAVER STUFF 
 *****************************************************************/

enum ScreenSaverBlancking:int
{
	DontPreferBlanking	=0,
	PreferBlanking		=1,
	DefaultBlanking		=2
};

enum ScreenSaverDisable:int
{
	DisableScreenSaver		=0,
	DisableScreenInterval	=0
};

enum ScreenSaverExposure:int
{
	DontAllowExposures	=0,
	AllowExposures		=1,
	DefaultExposures	=2
};

/* for ForceScreenSaver */

enum ScreenSaverMode:int
{
	ScreenSaverReset 	=0,
	ScreenSaverActive 	=1
};

/*****************************************************************
 * HOSTS AND CONNECTIONS
 *****************************************************************/

/* for ChangeHosts */

enum HostChange:int
{
	HostInsert		=0,
	HostDelete		=1
};

/* for ChangeAccessControl */

enum HostAccess:int
{
	EnableAccess	=1,     
	DisableAccess	=0
};

/* Display classes  used in opening the connection 
 * Note that the statically allocated ones are even numbered and the
 * dynamically changeable ones are odd numbered */

enum DisplayClass:int
{
	StaticGray		=0,
	GrayScale		=1,
	StaticColor		=2,
	PseudoColor		=3,
	TrueColor		=4,
	DirectColor		=5
};

/* Byte order  used in imageByteOrder and bitmapBitOrder */

enum ByteOrder:int
{
	LSBFirst		=0,
	MSBFirst		=1
};