Authors: Ove Kaaven <ovek@transgaming.com>, Andrew Lewycky <andrew@transgaming.com...
[wine] / include / x11drv.h
1 /*
2  * X11 driver definitions
3  */
4
5 #ifndef __WINE_X11DRV_H
6 #define __WINE_X11DRV_H
7
8 #include "config.h"
9
10 #include <X11/Xlib.h>
11 #include <X11/Xresource.h>
12 #include <X11/Xutil.h>
13 #include <X11/Xatom.h>
14 #ifdef HAVE_LIBXXSHM
15 # include <X11/extensions/XShm.h>
16 #endif /* defined(HAVE_LIBXXSHM) */
17
18 #include "windef.h"
19 #include "winbase.h"
20 #include "gdi.h"
21 #include "user.h"
22
23 #define MAX_PIXELFORMATS 8
24
25 struct tagBITMAPOBJ;
26 struct tagCLASS;
27 struct tagCREATESTRUCTA;
28 struct tagCURSORICONINFO;
29 struct tagDC;
30 struct tagDeviceCaps;
31 struct tagPALETTEOBJ;
32 struct tagWND;
33 struct tagWINDOWPOS;
34 struct tagKEYBOARD_CONFIG;
35 struct DIDEVICEOBJECTDATA;
36
37   /* X physical pen */
38 typedef struct
39 {
40     int          style;
41     int          endcap;
42     int          linejoin;
43     int          pixel;
44     int          width;
45     char *       dashes;
46     int          dash_len;
47     int          type;          /* GEOMETRIC || COSMETIC */
48 } X_PHYSPEN;
49
50   /* X physical brush */
51 typedef struct
52 {
53     int          style;
54     int          fillStyle;
55     int          pixel;
56     Pixmap       pixmap;
57 } X_PHYSBRUSH;
58
59   /* X physical font */
60 typedef UINT     X_PHYSFONT;
61
62   /* X physical device */
63 typedef struct
64 {
65     GC            gc;          /* X Window GC */
66     Drawable      drawable;
67     X_PHYSFONT    font;
68     X_PHYSPEN     pen;
69     X_PHYSBRUSH   brush;
70     int           backgroundPixel;
71     int           textPixel;
72     XVisualInfo  *visuals[MAX_PIXELFORMATS];
73     int           used_visuals;
74     int           current_pf;
75 } X11DRV_PDEVICE;
76
77
78   /* GCs used for B&W and color bitmap operations */
79 extern GC BITMAP_monoGC, BITMAP_colorGC;
80
81 #define BITMAP_GC(bmp) \
82   (((bmp)->bitmap.bmBitsPixel == 1) ? BITMAP_monoGC : BITMAP_colorGC)
83
84 extern DeviceCaps X11DRV_DevCaps;
85
86 extern unsigned int X11DRV_server_startticks;
87
88 /* Wine driver X11 functions */
89
90 extern const DC_FUNCTIONS X11DRV_DC_Funcs;
91
92 extern BOOL X11DRV_BitBlt( struct tagDC *dcDst, INT xDst, INT yDst,
93                              INT width, INT height, struct tagDC *dcSrc,
94                              INT xSrc, INT ySrc, DWORD rop );
95 extern BOOL X11DRV_EnumDeviceFonts( HDC hdc, LPLOGFONT16 plf,
96                                       DEVICEFONTENUMPROC dfeproc, LPARAM lp );
97 extern BOOL X11DRV_GetCharWidth( struct tagDC *dc, UINT firstChar,
98                                    UINT lastChar, LPINT buffer );
99 extern BOOL X11DRV_GetDCOrgEx( struct tagDC *dc, LPPOINT lpp );
100 extern BOOL X11DRV_GetTextExtentPoint( struct tagDC *dc, LPCWSTR str,
101                                          INT count, LPSIZE size );
102 extern BOOL X11DRV_GetTextMetrics(struct tagDC *dc, TEXTMETRICA *metrics);
103 extern BOOL X11DRV_PatBlt( struct tagDC *dc, INT left, INT top,
104                              INT width, INT height, DWORD rop );
105 extern VOID   X11DRV_SetDeviceClipping(struct tagDC *dc);
106 extern BOOL X11DRV_StretchBlt( struct tagDC *dcDst, INT xDst, INT yDst,
107                                  INT widthDst, INT heightDst,
108                                  struct tagDC *dcSrc, INT xSrc, INT ySrc,
109                                  INT widthSrc, INT heightSrc, DWORD rop );
110 extern BOOL X11DRV_LineTo( struct tagDC *dc, INT x, INT y);
111 extern BOOL X11DRV_Arc( struct tagDC *dc, INT left, INT top, INT right,
112                           INT bottom, INT xstart, INT ystart, INT xend,
113                           INT yend );
114 extern BOOL X11DRV_Pie( struct tagDC *dc, INT left, INT top, INT right,
115                           INT bottom, INT xstart, INT ystart, INT xend,
116                           INT yend );
117 extern BOOL X11DRV_Chord( struct tagDC *dc, INT left, INT top,
118                             INT right, INT bottom, INT xstart,
119                             INT ystart, INT xend, INT yend );
120 extern BOOL X11DRV_Ellipse( struct tagDC *dc, INT left, INT top,
121                               INT right, INT bottom );
122 extern BOOL X11DRV_Rectangle(struct tagDC *dc, INT left, INT top,
123                               INT right, INT bottom);
124 extern BOOL X11DRV_RoundRect( struct tagDC *dc, INT left, INT top,
125                                 INT right, INT bottom, INT ell_width,
126                                 INT ell_height );
127 extern COLORREF X11DRV_SetPixel( struct tagDC *dc, INT x, INT y,
128                                  COLORREF color );
129 extern COLORREF X11DRV_GetPixel( struct tagDC *dc, INT x, INT y);
130 extern BOOL X11DRV_PaintRgn( struct tagDC *dc, HRGN hrgn );
131 extern BOOL X11DRV_Polyline( struct tagDC *dc,const POINT* pt,INT count);
132 extern BOOL X11DRV_Polygon( struct tagDC *dc, const POINT* pt, INT count );
133 extern BOOL X11DRV_PolyPolygon( struct tagDC *dc, const POINT* pt, 
134                                   const INT* counts, UINT polygons);
135 extern BOOL X11DRV_PolyPolyline( struct tagDC *dc, const POINT* pt, 
136                                   const DWORD* counts, DWORD polylines);
137
138 extern HGDIOBJ X11DRV_SelectObject( struct tagDC *dc, HGDIOBJ handle );
139
140 extern COLORREF X11DRV_SetBkColor( struct tagDC *dc, COLORREF color );
141 extern COLORREF X11DRV_SetTextColor( struct tagDC *dc, COLORREF color );
142 extern BOOL X11DRV_ExtFloodFill( struct tagDC *dc, INT x, INT y,
143                                    COLORREF color, UINT fillType );
144 extern BOOL X11DRV_ExtTextOut( struct tagDC *dc, INT x, INT y,
145                                  UINT flags, const RECT *lprect,
146                                  LPCWSTR str, UINT count, const INT *lpDx );
147 extern BOOL X11DRV_CreateBitmap( HBITMAP hbitmap );
148 extern BOOL X11DRV_DeleteObject( HGDIOBJ handle );
149 extern LONG X11DRV_BitmapBits( HBITMAP hbitmap, void *bits, LONG count,
150                                WORD flags );
151 extern INT X11DRV_SetDIBitsToDevice( struct tagDC *dc, INT xDest,
152                                        INT yDest, DWORD cx, DWORD cy,
153                                        INT xSrc, INT ySrc,
154                                        UINT startscan, UINT lines,
155                                        LPCVOID bits, const BITMAPINFO *info,
156                                        UINT coloruse );
157 extern INT X11DRV_DeviceBitmapBits( struct tagDC *dc, HBITMAP hbitmap,
158                                       WORD fGet, UINT startscan,
159                                       UINT lines, LPSTR bits,
160                                       LPBITMAPINFO info, UINT coloruse );
161
162 /* OpenGL / X11 driver functions */
163 extern int X11DRV_ChoosePixelFormat(DC *dc, const PIXELFORMATDESCRIPTOR *pppfd) ;
164 extern int X11DRV_DescribePixelFormat(DC *dc, int iPixelFormat, UINT nBytes, PIXELFORMATDESCRIPTOR *ppfd) ;
165 extern int X11DRV_GetPixelFormat(DC *dc) ;
166 extern BOOL X11DRV_SetPixelFormat(DC *dc, int iPixelFormat, const PIXELFORMATDESCRIPTOR *ppfd) ;
167 extern BOOL X11DRV_SwapBuffers(DC *dc) ;
168
169 /* X11 driver internal functions */
170
171 extern BOOL X11DRV_BITMAP_Init(void);
172 extern BOOL X11DRV_BRUSH_Init(void);
173 extern BOOL X11DRV_DIB_Init(void);
174 extern BOOL X11DRV_FONT_Init( struct tagDeviceCaps* );
175 extern BOOL X11DRV_OBM_Init(void);
176
177 struct tagBITMAPOBJ;
178 extern XImage *X11DRV_BITMAP_GetXImage( const struct tagBITMAPOBJ *bmp );
179 extern int X11DRV_DIB_GetXImageWidthBytes( int width, int depth );
180 extern HBITMAP X11DRV_BITMAP_CreateBitmapHeaderFromPixmap(Pixmap pixmap);
181 extern HGLOBAL X11DRV_DIB_CreateDIBFromPixmap(Pixmap pixmap, HDC hdc, BOOL bDeletePixmap);
182 extern HBITMAP X11DRV_BITMAP_CreateBitmapFromPixmap(Pixmap pixmap, BOOL bDeletePixmap);
183 extern Pixmap X11DRV_DIB_CreatePixmapFromDIB( HGLOBAL hPackedDIB, HDC hdc );
184 extern Pixmap X11DRV_BITMAP_CreatePixmapFromBitmap( HBITMAP hBmp, HDC hdc );
185
186 extern BOOL X11DRV_SetupGCForPatBlt( struct tagDC *dc, GC gc,
187                                        BOOL fMapColors );
188 extern BOOL X11DRV_SetupGCForBrush( struct tagDC *dc );
189 extern BOOL X11DRV_SetupGCForPen( struct tagDC *dc );
190 extern BOOL X11DRV_SetupGCForText( struct tagDC *dc );
191
192 extern const int X11DRV_XROPfunction[];
193
194 /* Xlib critical section */
195
196 extern CRITICAL_SECTION X11DRV_CritSection;
197
198 extern void _XInitImageFuncPtrs(XImage *);
199
200 #define XCREATEIMAGE(image,width,height,bpp) \
201 { \
202     int width_bytes = X11DRV_DIB_GetXImageWidthBytes( (width), (bpp) ); \
203     (image) = TSXCreateImage(display, X11DRV_GetVisual(), \
204                            (bpp), ZPixmap, 0, calloc( (height), width_bytes ),\
205                            (width), (height), 32, width_bytes ); \
206 }
207
208 /* exported dib functions for now */
209
210 /* Additional info for DIB section objects */
211 typedef struct
212 {
213     /* Windows DIB section */
214     DIBSECTION  dibSection;
215
216     /* Mapping status */
217     int         status, p_status;
218
219     /* Color map info */
220     int         nColorMap;
221     int        *colorMap;
222
223     /* Cached XImage */
224     XImage     *image;
225
226     /* Selector for 16-bit access to bits */
227     WORD selector;
228
229 #ifdef HAVE_LIBXXSHM
230     /* Shared memory segment info */
231     XShmSegmentInfo shminfo;
232 #endif
233
234     /* Aux buffer access function */
235     void (*copy_aux)(void*ctx, int req);
236     void *aux_ctx;
237
238     /* GDI access lock */
239     CRITICAL_SECTION lock;
240
241 } X11DRV_DIBSECTION;
242
243 /* This structure holds the arguments for DIB_SetImageBits() */
244 typedef struct
245 {
246     struct tagDC     *dc;
247     LPCVOID           bits;
248     XImage           *image;
249     PALETTEENTRY     *palentry;
250     int               lines;
251     DWORD             infoWidth;
252     WORD              depth;
253     WORD              infoBpp;
254     WORD              compression;
255     RGBQUAD          *colorMap;
256     int               nColorMap;
257     Drawable          drawable;
258     GC                gc;
259     int               xSrc;
260     int               ySrc;
261     int               xDest;
262     int               yDest;
263     int               width;
264     int               height;
265     DWORD             rMask;
266     DWORD             gMask;
267     DWORD             bMask;
268     BOOL        useShm;
269     int               dibpitch;
270
271 } X11DRV_DIB_IMAGEBITS_DESCR;
272
273 extern int *X11DRV_DIB_BuildColorMap( struct tagDC *dc, WORD coloruse,
274                                       WORD depth, const BITMAPINFO *info,
275                                       int *nColors );
276 extern INT X11DRV_CoerceDIBSection(struct tagDC *dc,INT,BOOL);
277 extern INT X11DRV_LockDIBSection(struct tagDC *dc,INT,BOOL);
278 extern void X11DRV_UnlockDIBSection(struct tagDC *dc,BOOL);
279 extern INT X11DRV_LockDIBSection2(HBITMAP bmp,INT,BOOL);
280 extern void X11DRV_UnlockDIBSection2(HBITMAP bmp,BOOL);
281
282 extern HBITMAP X11DRV_DIB_CreateDIBSection(struct tagDC *dc, BITMAPINFO *bmi, UINT usage,
283                                            LPVOID *bits, HANDLE section, DWORD offset, DWORD ovr_pitch);
284 extern HBITMAP16 X11DRV_DIB_CreateDIBSection16(struct tagDC *dc, BITMAPINFO *bmi, UINT16 usage,
285                                                SEGPTR *bits, HANDLE section, DWORD offset, DWORD ovr_pitch);
286
287 extern struct tagBITMAP_DRIVER X11DRV_BITMAP_Driver;
288
289 extern INT X11DRV_DIB_SetDIBits(struct tagBITMAPOBJ *bmp, struct tagDC *dc, UINT startscan,
290                                 UINT lines, LPCVOID bits, const BITMAPINFO *info,
291                                 UINT coloruse, HBITMAP hbitmap);
292 extern INT X11DRV_DIB_GetDIBits(struct tagBITMAPOBJ *bmp, struct tagDC *dc, UINT startscan,
293                                 UINT lines, LPVOID bits, BITMAPINFO *info,
294                                 UINT coloruse, HBITMAP hbitmap);
295 extern void X11DRV_DIB_DeleteDIBSection(struct tagBITMAPOBJ *bmp);
296 extern UINT X11DRV_DIB_SetDIBColorTable(struct tagBITMAPOBJ *,struct tagDC*,UINT,UINT,const RGBQUAD *);
297 extern UINT X11DRV_DIB_GetDIBColorTable(struct tagBITMAPOBJ *,struct tagDC*,UINT,UINT,RGBQUAD *);
298 extern INT X11DRV_DIB_Coerce(struct tagBITMAPOBJ *,INT,BOOL);
299 extern INT X11DRV_DIB_Lock(struct tagBITMAPOBJ *,INT,BOOL);
300 extern void X11DRV_DIB_Unlock(struct tagBITMAPOBJ *,BOOL);
301
302 /**************************************************************************
303  * X11 GDI driver
304  */
305
306 BOOL X11DRV_GDI_Initialize(void);
307 void X11DRV_GDI_Finalize(void);
308
309 /* X11 GDI palette driver */
310
311 #define X11DRV_PALETTE_FIXED    0x0001 /* read-only colormap - have to use XAllocColor (if not virtual) */
312 #define X11DRV_PALETTE_VIRTUAL  0x0002 /* no mapping needed - pixel == pixel color */
313
314 #define X11DRV_PALETTE_PRIVATE  0x1000 /* private colormap, identity mapping */
315 #define X11DRV_PALETTE_WHITESET 0x2000
316
317 extern Colormap X11DRV_PALETTE_PaletteXColormap;
318 extern UINT16 X11DRV_PALETTE_PaletteFlags;
319
320 extern int *X11DRV_PALETTE_PaletteToXPixel;
321 extern int *X11DRV_PALETTE_XPixelToPalette;
322
323 extern int X11DRV_PALETTE_mapEGAPixel[16];
324
325 extern BOOL X11DRV_PALETTE_Init(void);
326 extern void X11DRV_PALETTE_Cleanup(void);
327
328 extern COLORREF X11DRV_PALETTE_ToLogical(int pixel);
329 extern int X11DRV_PALETTE_ToPhysical(struct tagDC *dc, COLORREF color);
330
331 extern struct tagPALETTE_DRIVER X11DRV_PALETTE_Driver;
332
333 extern int X11DRV_PALETTE_SetMapping(struct tagPALETTEOBJ *palPtr, UINT uStart, UINT uNum, BOOL mapOnly);
334 extern int X11DRV_PALETTE_UpdateMapping(struct tagPALETTEOBJ *palPtr);
335 extern BOOL X11DRV_PALETTE_IsDark(int pixel);
336
337 /**************************************************************************
338  * X11 USER driver
339  */
340
341 extern Display *display;
342 extern Screen *screen;
343 extern Visual *visual;
344 extern Window root_window;
345 extern unsigned int screen_width;
346 extern unsigned int screen_height;
347 extern unsigned int screen_depth;
348
349 static inline Screen *X11DRV_GetXScreen(void)    { return screen; }
350 static inline Visual *X11DRV_GetVisual(void)     { return visual; }
351 static inline Window X11DRV_GetXRootWindow(void) { return root_window; }
352 static inline unsigned int X11DRV_GetDepth(void) { return screen_depth; }
353
354 /* X11 clipboard driver */
355
356 extern void X11DRV_CLIPBOARD_FreeResources( Atom property );
357 extern BOOL X11DRV_CLIPBOARD_RegisterPixmapResource( Atom property, Pixmap pixmap );
358 extern BOOL X11DRV_CLIPBOARD_IsNativeProperty(Atom prop);
359 extern UINT X11DRV_CLIPBOARD_MapPropertyToFormat(char *itemFmtName);
360 extern Atom X11DRV_CLIPBOARD_MapFormatToProperty(UINT id);
361 extern void X11DRV_CLIPBOARD_ReleaseSelection(Atom selType, Window w, HWND hwnd);
362 extern BOOL X11DRV_IsSelectionOwner(void);
363 extern BOOL X11DRV_GetClipboardData(UINT wFormat);
364
365 /* X11 event driver */
366
367 extern WORD X11DRV_EVENT_XStateToKeyState( int state ) ;
368
369 extern BOOL X11DRV_EVENT_Init(void);
370 extern void X11DRV_Synchronize( void );
371
372 typedef enum {
373   X11DRV_INPUT_RELATIVE,
374   X11DRV_INPUT_ABSOLUTE
375 } INPUT_TYPE;
376 extern INPUT_TYPE X11DRV_EVENT_SetInputMethod(INPUT_TYPE type);
377
378 #ifdef HAVE_LIBXXF86DGA2
379 void X11DRV_EVENT_SetDGAStatus(HWND hwnd, int event_base) ;
380 #endif
381
382
383 /* X11 keyboard driver */
384
385 extern void X11DRV_InitKeyboard(void);
386 extern WORD X11DRV_VkKeyScan(CHAR cChar);
387 extern UINT16 X11DRV_MapVirtualKey(UINT16 wCode, UINT16 wMapType);
388 extern INT16 X11DRV_GetKeyNameText(LONG lParam, LPSTR lpBuffer, INT16 nSize);
389 extern BOOL X11DRV_GetDIState(DWORD len, LPVOID ptr);
390 extern BOOL X11DRV_GetDIData(BYTE *keystate, DWORD dodsize, struct DIDEVICEOBJECTDATA *dod, LPDWORD entries, DWORD flags);
391 extern void X11DRV_GetKeyboardConfig(struct tagKEYBOARD_CONFIG *cfg);
392 extern void X11DRV_SetKeyboardConfig(struct tagKEYBOARD_CONFIG *cfg, DWORD mask);
393
394 extern void X11DRV_HandleEvent(struct tagWND *pWnd, XKeyEvent *event);
395
396 /* X11 mouse driver */
397
398 extern void X11DRV_InitMouse(LPMOUSE_EVENT_PROC);
399 extern void X11DRV_SetCursor(struct tagCURSORICONINFO *lpCursor);
400 extern void X11DRV_MoveCursor(WORD wAbsX, WORD wAbsY);
401 extern void X11DRV_SendEvent( DWORD mouseStatus, DWORD posX, DWORD posY,
402                                     DWORD keyState, DWORD time, HWND hWnd );
403
404 /* X11 windows driver */
405
406 extern struct tagWND_DRIVER X11DRV_WND_Driver;
407
408 typedef struct _X11DRV_WND_DATA {
409   Window window;
410   HBITMAP hWMIconBitmap;
411   HBITMAP hWMIconMask;
412   int bit_gravity;
413 } X11DRV_WND_DATA;
414
415 extern Window X11DRV_WND_GetXWindow(struct tagWND *wndPtr);
416 extern Window X11DRV_WND_FindXWindow(struct tagWND *wndPtr);
417
418 extern void X11DRV_WND_Initialize(struct tagWND *wndPtr);
419 extern void X11DRV_WND_Finalize(struct tagWND *wndPtr);
420 extern BOOL X11DRV_WND_CreateDesktopWindow(struct tagWND *wndPtr, struct tagCLASS *classPtr, BOOL bUnicode);
421 extern BOOL X11DRV_WND_CreateWindow(struct tagWND *wndPtr, struct tagCLASS *classPtr, struct tagCREATESTRUCTA *cs, BOOL bUnicode);
422 extern BOOL X11DRV_WND_DestroyWindow(struct tagWND *pWnd);
423 extern struct tagWND *X11DRV_WND_SetParent(struct tagWND *wndPtr, struct tagWND *pWndParent);
424 extern void X11DRV_WND_ForceWindowRaise(struct tagWND *pWnd);
425 extern void X11DRV_WND_SetWindowPos(struct tagWND *wndPtr, const struct tagWINDOWPOS *winpos, BOOL bSMC_SETXPOS);
426 extern void X11DRV_WND_SetText(struct tagWND *wndPtr, LPCWSTR text);
427 extern void X11DRV_WND_SetFocus(struct tagWND *wndPtr);
428 extern void X11DRV_WND_PreSizeMove(struct tagWND *wndPtr);
429 extern void X11DRV_WND_PostSizeMove(struct tagWND *wndPtr);
430 extern void X11DRV_WND_SurfaceCopy(struct tagWND *wndPtr, HDC hdc, INT dx, INT dy, const RECT *clipRect, BOOL bUpdate);
431 extern void X11DRV_WND_SetDrawable(struct tagWND *wndPtr, HDC hdc, WORD flags, BOOL bSetClipOrigin);
432 extern BOOL X11DRV_WND_SetHostAttr(struct tagWND *wndPtr, INT haKey, INT value);
433 extern BOOL X11DRV_WND_IsSelfClipping(struct tagWND *wndPtr);
434 extern void X11DRV_WND_DockWindow(struct tagWND *wndPtr);
435 extern void X11DRV_WND_SetWindowRgn(struct tagWND *wndPtr, HRGN hrgnWnd); 
436
437 extern int X11DRV_EVENT_PrepareShmCompletion( Drawable dw );
438 extern void X11DRV_EVENT_WaitShmCompletion( int compl );
439 extern void X11DRV_EVENT_WaitShmCompletions( Drawable dw );
440 extern void X11DRV_EVENT_WaitReplaceShmCompletion( int *compl, Drawable dw );
441
442 #endif  /* __WINE_X11DRV_H */