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