Fixed ReadFile() semantics when reading asynchronously on sockets.
[wine] / include / x11drv.h
1 /*
2  * X11 driver definitions
3  *
4  * Copyright 1996 Alexandre Julliard
5  * Copyright 1999 Patrik Stridvall
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20  */
21
22 #ifndef __WINE_X11DRV_H
23 #define __WINE_X11DRV_H
24
25 #ifndef __WINE_CONFIG_H 
26 # error You must include config.h to use this header 
27 #endif 
28
29 #include <X11/Xlib.h>
30 #include <X11/Xresource.h>
31 #include <X11/Xutil.h>
32 #include <X11/Xatom.h>
33 #ifdef HAVE_LIBXXSHM
34 # include <X11/extensions/XShm.h>
35 #endif /* defined(HAVE_LIBXXSHM) */
36
37 #include "windef.h"
38 #include "winbase.h"
39 #include "gdi.h"
40 #include "user.h"
41 #include "win.h"
42 #include "thread.h"
43
44 #define MAX_PIXELFORMATS 8
45
46 struct tagBITMAPOBJ;
47 struct tagCURSORICONINFO;
48 struct tagPALETTEOBJ;
49 struct tagWINDOWPOS;
50
51   /* X physical pen */
52 typedef struct
53 {
54     int          style;
55     int          endcap;
56     int          linejoin;
57     int          pixel;
58     int          width;
59     char *       dashes;
60     int          dash_len;
61     int          type;          /* GEOMETRIC || COSMETIC */
62 } X_PHYSPEN;
63
64   /* X physical brush */
65 typedef struct
66 {
67     int          style;
68     int          fillStyle;
69     int          pixel;
70     Pixmap       pixmap;
71 } X_PHYSBRUSH;
72
73   /* X physical font */
74 typedef UINT     X_PHYSFONT;
75
76 typedef struct tagXRENDERINFO *XRENDERINFO;
77
78   /* X physical device */
79 typedef struct
80 {
81     HDC           hdc;
82     DC           *dc;          /* direct pointer to DC, should go away */
83     GC            gc;          /* X Window GC */
84     Drawable      drawable;
85     X_PHYSFONT    font;
86     X_PHYSPEN     pen;
87     X_PHYSBRUSH   brush;
88     int           backgroundPixel;
89     int           textPixel;
90     int           exposures;   /* count of graphics exposures operations */
91     XVisualInfo  *visuals[MAX_PIXELFORMATS];
92     int           used_visuals;
93     int           current_pf;
94     XRENDERINFO   xrender;
95 } X11DRV_PDEVICE;
96
97
98   /* GCs used for B&W and color bitmap operations */
99 extern GC BITMAP_monoGC, BITMAP_colorGC;
100
101 #define BITMAP_GC(bmp) \
102   (((bmp)->bitmap.bmBitsPixel == 1) ? BITMAP_monoGC : BITMAP_colorGC)
103
104 extern unsigned int X11DRV_server_startticks;
105
106 /* Wine driver X11 functions */
107
108 extern BOOL X11DRV_BitBlt( X11DRV_PDEVICE *physDevDst, INT xDst, INT yDst,
109                              INT width, INT height, X11DRV_PDEVICE *physDevSrc,
110                              INT xSrc, INT ySrc, DWORD rop );
111 extern BOOL X11DRV_EnumDeviceFonts( X11DRV_PDEVICE *physDev, LPLOGFONTW plf,
112                                     DEVICEFONTENUMPROC dfeproc, LPARAM lp );
113 extern BOOL X11DRV_GetCharWidth( X11DRV_PDEVICE *physDev, UINT firstChar,
114                                    UINT lastChar, LPINT buffer );
115 extern BOOL X11DRV_GetDCOrgEx( X11DRV_PDEVICE *physDev, LPPOINT lpp );
116 extern BOOL X11DRV_GetTextExtentPoint( X11DRV_PDEVICE *physDev, LPCWSTR str,
117                                          INT count, LPSIZE size );
118 extern BOOL X11DRV_GetTextMetrics(X11DRV_PDEVICE *physDev, TEXTMETRICW *metrics);
119 extern BOOL X11DRV_PatBlt( X11DRV_PDEVICE *physDev, INT left, INT top,
120                              INT width, INT height, DWORD rop );
121 extern VOID   X11DRV_SetDeviceClipping(X11DRV_PDEVICE *physDev);
122 extern BOOL X11DRV_StretchBlt( X11DRV_PDEVICE *physDevDst, INT xDst, INT yDst,
123                                  INT widthDst, INT heightDst,
124                                  X11DRV_PDEVICE *physDevSrc, INT xSrc, INT ySrc,
125                                  INT widthSrc, INT heightSrc, DWORD rop );
126 extern BOOL X11DRV_LineTo( X11DRV_PDEVICE *physDev, INT x, INT y);
127 extern BOOL X11DRV_Arc( X11DRV_PDEVICE *physDev, INT left, INT top, INT right,
128                           INT bottom, INT xstart, INT ystart, INT xend,
129                           INT yend );
130 extern BOOL X11DRV_Pie( X11DRV_PDEVICE *physDev, INT left, INT top, INT right,
131                           INT bottom, INT xstart, INT ystart, INT xend,
132                           INT yend );
133 extern BOOL X11DRV_Chord( X11DRV_PDEVICE *physDev, INT left, INT top,
134                             INT right, INT bottom, INT xstart,
135                             INT ystart, INT xend, INT yend );
136 extern BOOL X11DRV_Ellipse( X11DRV_PDEVICE *physDev, INT left, INT top,
137                               INT right, INT bottom );
138 extern BOOL X11DRV_Rectangle(X11DRV_PDEVICE *physDev, INT left, INT top,
139                               INT right, INT bottom);
140 extern BOOL X11DRV_RoundRect( X11DRV_PDEVICE *physDev, INT left, INT top,
141                                 INT right, INT bottom, INT ell_width,
142                                 INT ell_height );
143 extern COLORREF X11DRV_SetPixel( X11DRV_PDEVICE *physDev, INT x, INT y,
144                                  COLORREF color );
145 extern COLORREF X11DRV_GetPixel( X11DRV_PDEVICE *physDev, INT x, INT y);
146 extern BOOL X11DRV_PaintRgn( X11DRV_PDEVICE *physDev, HRGN hrgn );
147 extern BOOL X11DRV_Polyline( X11DRV_PDEVICE *physDev,const POINT* pt,INT count);
148 extern BOOL X11DRV_Polygon( X11DRV_PDEVICE *physDev, const POINT* pt, INT count );
149 extern BOOL X11DRV_PolyPolygon( X11DRV_PDEVICE *physDev, const POINT* pt, 
150                                   const INT* counts, UINT polygons);
151 extern BOOL X11DRV_PolyPolyline( X11DRV_PDEVICE *physDev, const POINT* pt, 
152                                   const DWORD* counts, DWORD polylines);
153
154 extern COLORREF X11DRV_SetBkColor( X11DRV_PDEVICE *physDev, COLORREF color );
155 extern COLORREF X11DRV_SetTextColor( X11DRV_PDEVICE *physDev, COLORREF color );
156 extern BOOL X11DRV_ExtFloodFill( X11DRV_PDEVICE *physDev, INT x, INT y,
157                                    COLORREF color, UINT fillType );
158 extern BOOL X11DRV_ExtTextOut( X11DRV_PDEVICE *physDev, INT x, INT y,
159                                  UINT flags, const RECT *lprect,
160                                  LPCWSTR str, UINT count, const INT *lpDx );
161 extern BOOL X11DRV_CreateBitmap( HBITMAP hbitmap );
162 extern BOOL X11DRV_DeleteObject( HGDIOBJ handle );
163 extern LONG X11DRV_BitmapBits( HBITMAP hbitmap, void *bits, LONG count,
164                                WORD flags );
165 extern INT X11DRV_SetDIBitsToDevice( X11DRV_PDEVICE *physDev, INT xDest,
166                                        INT yDest, DWORD cx, DWORD cy,
167                                        INT xSrc, INT ySrc,
168                                        UINT startscan, UINT lines,
169                                        LPCVOID bits, const BITMAPINFO *info,
170                                        UINT coloruse );
171 extern INT X11DRV_DeviceBitmapBits( X11DRV_PDEVICE *physDev, HBITMAP hbitmap,
172                                       WORD fGet, UINT startscan,
173                                       UINT lines, LPSTR bits,
174                                       LPBITMAPINFO info, UINT coloruse );
175 extern BOOL X11DRV_GetDeviceGammaRamp( X11DRV_PDEVICE *physDev, LPVOID ramp );
176 extern BOOL X11DRV_SetDeviceGammaRamp( X11DRV_PDEVICE *physDev, LPVOID ramp );
177
178 /* OpenGL / X11 driver functions */
179 extern int X11DRV_ChoosePixelFormat(X11DRV_PDEVICE *physDev,
180                                       const PIXELFORMATDESCRIPTOR *pppfd);
181 extern int X11DRV_DescribePixelFormat(X11DRV_PDEVICE *physDev, 
182                                         int iPixelFormat, UINT nBytes,
183                                         PIXELFORMATDESCRIPTOR *ppfd);
184 extern int X11DRV_GetPixelFormat(X11DRV_PDEVICE *physDev);
185 extern BOOL X11DRV_SwapBuffers(X11DRV_PDEVICE *physDev);
186
187 /* X11 driver internal functions */
188
189 extern BOOL X11DRV_BITMAP_Init(void);
190 extern void X11DRV_FONT_Init( int *log_pixels_x, int *log_pixels_y );
191 extern BOOL X11DRV_BITMAP_DeleteObject( HBITMAP hbitmap );
192
193 struct tagBITMAPOBJ;
194 extern XImage *X11DRV_BITMAP_GetXImage( const struct tagBITMAPOBJ *bmp );
195 extern XImage *X11DRV_DIB_CreateXImage( int width, int height, int depth );
196 extern HBITMAP X11DRV_BITMAP_CreateBitmapHeaderFromPixmap(Pixmap pixmap);
197 extern HGLOBAL X11DRV_DIB_CreateDIBFromPixmap(Pixmap pixmap, HDC hdc, BOOL bDeletePixmap);
198 extern HBITMAP X11DRV_BITMAP_CreateBitmapFromPixmap(Pixmap pixmap, BOOL bDeletePixmap);
199 extern Pixmap X11DRV_DIB_CreatePixmapFromDIB( HGLOBAL hPackedDIB, HDC hdc );
200 extern Pixmap X11DRV_BITMAP_CreatePixmapFromBitmap( HBITMAP hBmp, HDC hdc );
201
202 extern void X11DRV_SetDrawable( HDC hdc, Drawable drawable, int mode, int org_x, int org_y );
203 extern void X11DRV_StartGraphicsExposures( HDC hdc );
204 extern void X11DRV_EndGraphicsExposures( HDC hdc, HRGN hrgn );
205
206 extern BOOL X11DRV_SetupGCForPatBlt( X11DRV_PDEVICE *physDev, GC gc, BOOL fMapColors );
207 extern BOOL X11DRV_SetupGCForBrush( X11DRV_PDEVICE *physDev );
208 extern BOOL X11DRV_SetupGCForPen( X11DRV_PDEVICE *physDev );
209 extern BOOL X11DRV_SetupGCForText( X11DRV_PDEVICE *physDev );
210
211 extern const int X11DRV_XROPfunction[];
212
213 extern void _XInitImageFuncPtrs(XImage *);
214
215 extern BOOL X11DRV_XRender_Installed;
216 extern void X11DRV_XRender_Init(void);
217 extern void X11DRV_XRender_Finalize(void);
218 extern BOOL X11DRV_XRender_SelectFont(X11DRV_PDEVICE*, HFONT);
219 extern void X11DRV_XRender_DeleteDC(X11DRV_PDEVICE*);
220 extern BOOL X11DRV_XRender_ExtTextOut(X11DRV_PDEVICE *physDev, INT x, INT y, UINT flags,
221                                       const RECT *lprect, LPCWSTR wstr,
222                                       UINT count, const INT *lpDx);
223 extern void X11DRV_XRender_UpdateDrawable(X11DRV_PDEVICE *physDev);
224
225 /* exported dib functions for now */
226
227 /* Additional info for DIB section objects */
228 typedef struct
229 {
230     /* Windows DIB section */
231     DIBSECTION  dibSection;
232
233     /* Mapping status */
234     int         status, p_status;
235
236     /* Color map info */
237     int         nColorMap;
238     int        *colorMap;
239
240     /* Cached XImage */
241     XImage     *image;
242
243 #ifdef HAVE_LIBXXSHM
244     /* Shared memory segment info */
245     XShmSegmentInfo shminfo;
246 #endif
247
248     /* Aux buffer access function */
249     void (*copy_aux)(void*ctx, int req);
250     void *aux_ctx;
251
252     /* GDI access lock */
253     CRITICAL_SECTION lock;
254
255 } X11DRV_DIBSECTION;
256
257 extern int *X11DRV_DIB_BuildColorMap( X11DRV_PDEVICE *physDev, WORD coloruse,
258                                       WORD depth, const BITMAPINFO *info,
259                                       int *nColors );
260 extern INT X11DRV_CoerceDIBSection(X11DRV_PDEVICE *physDev,INT,BOOL);
261 extern INT X11DRV_LockDIBSection(X11DRV_PDEVICE *physDev,INT,BOOL);
262 extern void X11DRV_UnlockDIBSection(X11DRV_PDEVICE *physDev,BOOL);
263 extern INT X11DRV_CoerceDIBSection2(HBITMAP bmp,INT,BOOL);
264 extern INT X11DRV_LockDIBSection2(HBITMAP bmp,INT,BOOL);
265 extern void X11DRV_UnlockDIBSection2(HBITMAP bmp,BOOL);
266
267 extern HBITMAP X11DRV_DIB_CreateDIBSection(X11DRV_PDEVICE *physDev, BITMAPINFO *bmi, UINT usage,
268                                            LPVOID *bits, HANDLE section, DWORD offset, DWORD ovr_pitch);
269 extern void X11DRV_DIB_DeleteDIBSection(struct tagBITMAPOBJ *bmp);
270 extern INT X11DRV_DIB_Coerce(struct tagBITMAPOBJ *,INT,BOOL);
271 extern INT X11DRV_DIB_Lock(struct tagBITMAPOBJ *,INT,BOOL);
272 extern void X11DRV_DIB_Unlock(struct tagBITMAPOBJ *,BOOL);
273 void X11DRV_DIB_CopyDIBSection(X11DRV_PDEVICE *physDevSrc, X11DRV_PDEVICE *physDevDst,
274                                DWORD xSrc, DWORD ySrc, DWORD xDest, DWORD yDest,
275                                DWORD width, DWORD height);
276 struct _DCICMD;
277 extern INT X11DRV_DCICommand(INT cbInput, const struct _DCICMD *lpCmd, LPVOID lpOutData);
278
279 /**************************************************************************
280  * X11 GDI driver
281  */
282
283 BOOL X11DRV_GDI_Initialize( Display *display );
284 void X11DRV_GDI_Finalize(void);
285
286 extern Display *gdi_display;  /* display to use for all GDI functions */
287
288 /* X11 GDI palette driver */
289
290 #define X11DRV_PALETTE_FIXED    0x0001 /* read-only colormap - have to use XAllocColor (if not virtual) */
291 #define X11DRV_PALETTE_VIRTUAL  0x0002 /* no mapping needed - pixel == pixel color */
292
293 #define X11DRV_PALETTE_PRIVATE  0x1000 /* private colormap, identity mapping */
294 #define X11DRV_PALETTE_WHITESET 0x2000
295
296 extern Colormap X11DRV_PALETTE_PaletteXColormap;
297 extern UINT16 X11DRV_PALETTE_PaletteFlags;
298
299 extern int *X11DRV_PALETTE_PaletteToXPixel;
300 extern int *X11DRV_PALETTE_XPixelToPalette;
301
302 extern int X11DRV_PALETTE_mapEGAPixel[16];
303
304 extern int X11DRV_PALETTE_Init(void);
305 extern void X11DRV_PALETTE_Cleanup(void);
306
307 extern COLORREF X11DRV_PALETTE_ToLogical(int pixel);
308 extern int X11DRV_PALETTE_ToPhysical(X11DRV_PDEVICE *physDev, COLORREF color);
309
310 extern struct tagPALETTE_DRIVER X11DRV_PALETTE_Driver;
311
312 extern int X11DRV_PALETTE_SetMapping(struct tagPALETTEOBJ *palPtr, UINT uStart, UINT uNum, BOOL mapOnly);
313 extern int X11DRV_PALETTE_UpdateMapping(struct tagPALETTEOBJ *palPtr);
314 extern BOOL X11DRV_PALETTE_IsDark(int pixel);
315
316 /* GDI escapes */
317
318 #define X11DRV_ESCAPE 6789
319 enum x11drv_escape_codes
320 {
321     X11DRV_GET_DISPLAY,   /* get X11 display for a DC */
322     X11DRV_GET_DRAWABLE,  /* get current drawable for a DC */
323     X11DRV_GET_FONT,      /* get current X font for a DC */
324 };
325
326 /**************************************************************************
327  * X11 USER driver
328  */
329
330 struct x11drv_thread_data
331 {
332     Display *display;
333     HANDLE   display_fd;
334     int      process_event_count;  /* recursion count for event processing */
335 };
336
337 extern struct x11drv_thread_data *x11drv_init_thread_data(void);
338
339 inline static struct x11drv_thread_data *x11drv_thread_data(void)
340 {
341     struct x11drv_thread_data *data = NtCurrentTeb()->driver_data;
342     if (!data) data = x11drv_init_thread_data();
343     return data;
344 }
345
346 inline static Display *thread_display(void) { return x11drv_thread_data()->display; }
347
348 extern Visual *visual;
349 extern Window root_window;
350 extern unsigned int screen_width;
351 extern unsigned int screen_height;
352 extern unsigned int screen_depth;
353 extern unsigned int text_caps;
354
355 extern Atom wmProtocols;
356 extern Atom wmDeleteWindow;
357 extern Atom wmTakeFocus;
358 extern Atom dndProtocol;
359 extern Atom dndSelection;
360 extern Atom wmChangeState;
361 extern Atom kwmDockWindow;
362 extern Atom _kde_net_wm_system_tray_window_for;
363
364 /* X11 clipboard driver */
365
366 extern void X11DRV_CLIPBOARD_FreeResources( Atom property );
367 extern BOOL X11DRV_CLIPBOARD_RegisterPixmapResource( Atom property, Pixmap pixmap );
368 extern BOOL X11DRV_CLIPBOARD_IsNativeProperty(Atom prop);
369 extern UINT X11DRV_CLIPBOARD_MapPropertyToFormat(char *itemFmtName);
370 extern Atom X11DRV_CLIPBOARD_MapFormatToProperty(UINT id);
371 extern void X11DRV_CLIPBOARD_ReleaseSelection(Atom selType, Window w, HWND hwnd);
372 extern BOOL X11DRV_IsSelectionOwner(void);
373 extern BOOL X11DRV_GetClipboardData(UINT wFormat);
374
375 /* X11 event driver */
376
377 typedef enum {
378   X11DRV_INPUT_RELATIVE,
379   X11DRV_INPUT_ABSOLUTE
380 } INPUT_TYPE;
381 extern INPUT_TYPE X11DRV_EVENT_SetInputMethod(INPUT_TYPE type);
382
383 #ifdef HAVE_LIBXXF86DGA2
384 void X11DRV_EVENT_SetDGAStatus(HWND hwnd, int event_base) ;
385 #endif
386
387 /* x11drv private window data */
388 struct x11drv_win_data
389 {
390     Window  whole_window;   /* X window for the complete window */
391     Window  client_window;  /* X window for the client area */
392     Window  icon_window;    /* X window for the icon */
393     RECT    whole_rect;     /* X window rectangle for the whole window relative to parent */
394     RECT    client_rect;    /* client area relative to whole window */
395     HBITMAP hWMIconBitmap;
396     HBITMAP hWMIconMask;
397 };
398
399 typedef struct x11drv_win_data X11DRV_WND_DATA;
400
401 extern Window X11DRV_get_client_window( HWND hwnd );
402 extern Window X11DRV_get_whole_window( HWND hwnd );
403
404 inline static Window get_client_window( WND *wnd )
405 {
406     struct x11drv_win_data *data = wnd->pDriverData;
407     return data->client_window;
408 }
409
410 inline static Window get_whole_window( WND *wnd )
411 {
412     struct x11drv_win_data *data = wnd->pDriverData;
413     return data->whole_window;
414 }
415
416 extern void X11DRV_SetFocus( HWND hwnd );
417 extern Cursor X11DRV_GetCursor( Display *display, struct tagCURSORICONINFO *ptr );
418
419 typedef int (*x11drv_error_callback)( Display *display, XErrorEvent *event, void *arg );
420
421 extern void X11DRV_expect_error( Display *display, x11drv_error_callback callback, void *arg );
422 extern int X11DRV_check_error(void);
423 extern void X11DRV_register_window( Display *display, HWND hwnd, struct x11drv_win_data *data );
424 extern void X11DRV_set_iconic_state( WND *win );
425 extern void X11DRV_window_to_X_rect( WND *win, RECT *rect );
426 extern void X11DRV_X_to_window_rect( WND *win, RECT *rect );
427 extern void X11DRV_create_desktop_thread(void);
428 extern Window X11DRV_create_desktop( XVisualInfo *desktop_vi, const char *geometry );
429 extern int X11DRV_sync_whole_window_position( Display *display, WND *win, int zorder );
430 extern int X11DRV_sync_client_window_position( Display *display, WND *win );
431
432 #endif  /* __WINE_X11DRV_H */