Avoid most references to the internals of the WND structure by passing
[wine] / dlls / x11drv / x11drv_main.c
1 /*
2  * X11DRV initialization code
3  *
4  * Copyright 1998 Patrik Stridvall
5  * Copyright 2000 Alexandre Julliard
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 #include "config.h"
23
24 #include <fcntl.h>
25 #include <stdarg.h>
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #ifdef HAVE_SYS_TIME_H
30 # include <sys/time.h>
31 #endif
32 #ifdef HAVE_UNISTD_H
33 # include <unistd.h>
34 #endif
35 #include <X11/cursorfont.h>
36 #include <X11/Xlib.h>
37 #ifdef HAVE_XKB
38 #include <X11/XKBlib.h>
39 #endif
40
41 #define BOOL X_BOOL
42 #define BYTE X_BYTE
43 #define INT8 X_INT8
44 #define INT16 X_INT16
45 #define INT32 X_INT32
46 #define INT64 X_INT64
47 #define LONG64 X_LONG64
48 #include <X11/Xproto.h>
49 #undef BOOL
50 #undef BYTE
51 #undef INT8
52 #undef INT16
53 #undef INT32
54 #undef INT64
55 #undef LONG64
56
57 #include "windef.h"
58 #include "winbase.h"
59 #include "wine/winbase16.h"
60 #include "winreg.h"
61
62 #include "x11drv.h"
63 #include "xvidmode.h"
64 #include "xrandr.h"
65 #include "dga2.h"
66 #include "wine/server.h"
67 #include "wine/debug.h"
68
69 WINE_DEFAULT_DEBUG_CHANNEL(x11drv);
70
71 static CRITICAL_SECTION X11DRV_CritSection;
72 static CRITICAL_SECTION_DEBUG critsect_debug =
73 {
74     0, 0, &X11DRV_CritSection,
75     { &critsect_debug.ProcessLocksList, &critsect_debug.ProcessLocksList },
76       0, 0, { 0, (DWORD)(__FILE__ ": X11DRV_CritSection") }
77 };
78 static CRITICAL_SECTION X11DRV_CritSection = { &critsect_debug, -1, 0, 0, 0, 0 };
79
80 Screen *screen;
81 Visual *visual;
82 unsigned int screen_width;
83 unsigned int screen_height;
84 unsigned int screen_depth;
85 Window root_window;
86 DWORD desktop_tid = 0;
87 int dxgrab = 0;
88 int usedga = 0;
89 int usexvidmode = 0;
90 int usexrandr = 1;
91 int use_xkb = 1;
92 int use_take_focus = 1;
93 int managed_mode = 1;
94 int client_side_with_core = 1;
95 int client_side_with_render = 1;
96 int client_side_antialias_with_core = 1;
97 int client_side_antialias_with_render = 1;
98 int using_wine_desktop = 0;
99
100 static BOOL synchronous;  /* run in synchronous mode? */
101 static BOOL desktop_dbl_buf = TRUE;
102 static char *desktop_geometry;
103 static XVisualInfo *desktop_vi;
104
105 static x11drv_error_callback err_callback;   /* current callback for error */
106 static Display *err_callback_display;        /* display callback is set for */
107 static void *err_callback_arg;               /* error callback argument */
108 static int err_callback_result;              /* error callback result */
109 static unsigned long err_serial;             /* serial number of first request */
110 static int (*old_error_handler)( Display *, XErrorEvent * );
111 static int use_xim = 1;
112 static char input_style[20];
113
114 #define IS_OPTION_TRUE(ch) \
115     ((ch) == 'y' || (ch) == 'Y' || (ch) == 't' || (ch) == 'T' || (ch) == '1')
116 #define IS_OPTION_FALSE(ch) \
117     ((ch) == 'n' || (ch) == 'N' || (ch) == 'f' || (ch) == 'F' || (ch) == '0')
118
119 /***********************************************************************
120  *              ignore_error
121  *
122  * Check if the X error is one we can ignore.
123  */
124 static inline BOOL ignore_error( Display *display, XErrorEvent *event )
125 {
126     if (event->request_code == X_SetInputFocus && event->error_code == BadMatch) return TRUE;
127     return FALSE;
128 }
129
130
131 /***********************************************************************
132  *              X11DRV_expect_error
133  *
134  * Setup a callback function that will be called on an X error.  The
135  * callback must return non-zero if the error is the one it expected.
136  * This function acquires the x11 lock; X11DRV_check_error must be
137  * called in all cases to release it.
138  */
139 void X11DRV_expect_error( Display *display, x11drv_error_callback callback, void *arg )
140 {
141     wine_tsx11_lock();
142     err_callback         = callback;
143     err_callback_display = display;
144     err_callback_arg     = arg;
145     err_callback_result  = 0;
146     err_serial           = NextRequest(display);
147 }
148
149
150 /***********************************************************************
151  *              X11DRV_check_error
152  *
153  * Check if an expected X11 error occurred; return non-zero if yes.
154  * Also release the x11 lock obtained in X11DRV_expect_error.
155  * The caller is responsible for calling XSync first if necessary.
156  */
157 int X11DRV_check_error(void)
158 {
159     int ret;
160     err_callback = NULL;
161     ret = err_callback_result;
162     wine_tsx11_unlock();
163     return ret;
164 }
165
166
167 /***********************************************************************
168  *              error_handler
169  */
170 static int error_handler( Display *display, XErrorEvent *error_evt )
171 {
172     if (err_callback && display == err_callback_display &&
173         (long)(error_evt->serial - err_serial) >= 0)
174     {
175         if ((err_callback_result = err_callback( display, error_evt, err_callback_arg )))
176         {
177             TRACE( "got expected error %d req %d\n",
178                    error_evt->error_code, error_evt->request_code );
179             return 0;
180         }
181     }
182     if (ignore_error( display, error_evt ))
183     {
184         TRACE( "got ignored error %d req %d\n",
185                error_evt->error_code, error_evt->request_code );
186         return 0;
187     }
188     if (synchronous)
189     {
190         ERR( "X protocol error: serial=%ld, request_code=%d - breaking into debugger\n",
191              error_evt->serial, error_evt->request_code );
192         DebugBreak();  /* force an entry in the debugger */
193     }
194     old_error_handler( display, error_evt );
195     return 0;
196 }
197
198 /***********************************************************************
199  *              wine_tsx11_lock   (X11DRV.@)
200  */
201 void wine_tsx11_lock(void)
202 {
203     EnterCriticalSection( &X11DRV_CritSection );
204 }
205
206 /***********************************************************************
207  *              wine_tsx11_unlock   (X11DRV.@)
208  */
209 void wine_tsx11_unlock(void)
210 {
211     LeaveCriticalSection( &X11DRV_CritSection );
212 }
213
214
215 /***********************************************************************
216  *              get_config_key
217  *
218  * Get a config key from either the app-specific or the default config
219  */
220 inline static DWORD get_config_key( HKEY defkey, HKEY appkey, const char *name,
221                                     char *buffer, DWORD size )
222 {
223     if (appkey && !RegQueryValueExA( appkey, name, 0, NULL, buffer, &size )) return 0;
224     return RegQueryValueExA( defkey, name, 0, NULL, buffer, &size );
225 }
226
227
228 /***********************************************************************
229  *              setup_options
230  *
231  * Setup the x11drv options.
232  */
233 static void setup_options(void)
234 {
235     char buffer[MAX_PATH+16];
236     HKEY hkey, appkey = 0;
237     DWORD len;
238
239     if (RegCreateKeyExA( HKEY_LOCAL_MACHINE, "Software\\Wine\\Wine\\Config\\x11drv", 0, NULL,
240                          REG_OPTION_VOLATILE, KEY_ALL_ACCESS, NULL, &hkey, NULL ))
241     {
242         ERR("Cannot create config registry key\n" );
243         ExitProcess(1);
244     }
245
246     /* open the app-specific key */
247
248     len = (GetModuleFileNameA( 0, buffer, MAX_PATH ));
249     if (len && len < MAX_PATH)
250     {
251         HKEY tmpkey;
252         char *p, *appname = buffer;
253         if ((p = strrchr( appname, '/' ))) appname = p + 1;
254         if ((p = strrchr( appname, '\\' ))) appname = p + 1;
255         strcat( appname, "\\x11drv" );
256         if (!RegOpenKeyA( HKEY_LOCAL_MACHINE, "Software\\Wine\\Wine\\Config\\AppDefaults", &tmpkey ))
257         {
258             if (RegOpenKeyA( tmpkey, appname, &appkey )) appkey = 0;
259             RegCloseKey( tmpkey );
260         }
261     }
262
263     if (!get_config_key( hkey, appkey, "Desktop", buffer, sizeof(buffer) ))
264     {
265         /* Imperfect validation:  If Desktop=N, then we don't turn on
266         ** the --desktop option.  We should really validate for a correct
267         ** sizing entry */
268         if (!IS_OPTION_FALSE(buffer[0])) desktop_geometry = strdup(buffer);
269     }
270
271     if (!get_config_key( hkey, appkey, "Managed", buffer, sizeof(buffer) ))
272         managed_mode = IS_OPTION_TRUE( buffer[0] );
273
274     if (!get_config_key( hkey, appkey, "DXGrab", buffer, sizeof(buffer) ))
275         dxgrab = IS_OPTION_TRUE( buffer[0] );
276
277     if (!get_config_key( hkey, appkey, "UseDGA", buffer, sizeof(buffer) ))
278         usedga = IS_OPTION_TRUE( buffer[0] );
279
280     if (!get_config_key( hkey, appkey, "UseXVidMode", buffer, sizeof(buffer) ))
281         usexvidmode = IS_OPTION_TRUE( buffer[0] );
282
283     if (!get_config_key( hkey, appkey, "UseXRandR", buffer, sizeof(buffer) ))
284         usexrandr = IS_OPTION_TRUE( buffer[0] );
285
286     if (!get_config_key( hkey, appkey, "UseTakeFocus", buffer, sizeof(buffer) ))
287         use_take_focus = IS_OPTION_TRUE( buffer[0] );
288
289     screen_depth = 0;
290     if (!get_config_key( hkey, appkey, "ScreenDepth", buffer, sizeof(buffer) ))
291         screen_depth = atoi(buffer);
292
293     if (!get_config_key( hkey, appkey, "Synchronous", buffer, sizeof(buffer) ))
294         synchronous = IS_OPTION_TRUE( buffer[0] );
295
296     if (!get_config_key( hkey, appkey, "ClientSideWithCore", buffer, sizeof(buffer) ))
297         client_side_with_core = IS_OPTION_TRUE( buffer[0] );
298
299     if (!get_config_key( hkey, appkey, "ClientSideWithRender", buffer, sizeof(buffer) ))
300         client_side_with_render = IS_OPTION_TRUE( buffer[0] );
301
302     if (!get_config_key( hkey, appkey, "ClientSideAntiAliasWithCore", buffer, sizeof(buffer) ))
303         client_side_antialias_with_core = IS_OPTION_TRUE( buffer[0] );
304
305     if (!get_config_key( hkey, appkey, "ClientSideAntiAliasWithRender", buffer, sizeof(buffer) ))
306         client_side_antialias_with_render = IS_OPTION_TRUE( buffer[0] );
307
308     if (!get_config_key( hkey, appkey, "DesktopDoubleBuffered", buffer, sizeof(buffer) ))
309         desktop_dbl_buf = IS_OPTION_TRUE( buffer[0] );
310
311     if (!get_config_key( hkey, appkey, "UseXIM", buffer, sizeof(buffer) ))
312         use_xim = IS_OPTION_TRUE( buffer[0] );
313
314     get_config_key( hkey, appkey, "InputStyle", input_style, sizeof(input_style) );
315
316     if (appkey) RegCloseKey( appkey );
317     RegCloseKey( hkey );
318 }
319
320
321 /***********************************************************************
322  *           X11DRV process initialisation routine
323  */
324 static BOOL process_attach(void)
325 {
326     Display *display;
327
328     setup_options();
329
330     /* Open display */
331
332     if (!(display = XOpenDisplay( NULL ))) return FALSE;
333
334     fcntl( ConnectionNumber(display), F_SETFD, 1 ); /* set close on exec flag */
335     screen = DefaultScreenOfDisplay( display );
336     visual = DefaultVisual( display, DefaultScreen(display) );
337     root_window = DefaultRootWindow( display );
338     old_error_handler = XSetErrorHandler( error_handler );
339
340     /* Initialize screen depth */
341
342     if (screen_depth)  /* depth specified */
343     {
344         int depth_count, i;
345         int *depth_list = XListDepths(display, DefaultScreen(display), &depth_count);
346         for (i = 0; i < depth_count; i++)
347             if (depth_list[i] == screen_depth) break;
348         XFree( depth_list );
349         if (i >= depth_count)
350         {
351             WARN( "invalid depth %d, using default\n", screen_depth );
352             screen_depth = 0;
353         }
354     }
355     if (!screen_depth) screen_depth = DefaultDepthOfScreen( screen );
356
357     /* Initialize OpenGL */
358     X11DRV_OpenGL_Init(display);
359
360     /* If OpenGL is available, change the default visual, etc as necessary */
361     if (desktop_dbl_buf && (desktop_vi = X11DRV_setup_opengl_visual( display )))
362     {
363         visual       = desktop_vi->visual;
364         screen       = ScreenOfDisplay(display, desktop_vi->screen);
365         screen_depth = desktop_vi->depth;
366     }
367
368     if (synchronous) XSynchronize( display, True );
369
370     screen_width  = WidthOfScreen( screen );
371     screen_height = HeightOfScreen( screen );
372
373     X11DRV_Settings_Init();
374
375     if (desktop_geometry)
376     {
377         root_window = X11DRV_create_desktop( desktop_vi, desktop_geometry );
378         using_wine_desktop = 1;
379     }
380
381     /* initialize GDI */
382     X11DRV_GDI_Initialize( display );
383
384 #ifdef HAVE_LIBXXF86VM
385     /* initialize XVidMode */
386     X11DRV_XF86VM_Init();
387 #endif
388 #ifdef HAVE_LIBXRANDR
389     /* initialize XRandR */
390     X11DRV_XRandR_Init();
391 #endif
392 #ifdef HAVE_LIBXXF86DGA2
393     /* initialize DGA2 */
394     X11DRV_XF86DGA2_Init();
395 #endif
396
397     return TRUE;
398 }
399
400
401 /***********************************************************************
402  *           X11DRV thread termination routine
403  */
404 static void thread_detach(void)
405 {
406     struct x11drv_thread_data *data = NtCurrentTeb()->driver_data;
407
408     if (data)
409     {
410         CloseHandle( data->display_fd );
411         wine_tsx11_lock();
412         XCloseDisplay( data->display );
413         /* if (data->xim) XCloseIM( data->xim ); */ /* crashes Xlib */
414         wine_tsx11_unlock();
415         HeapFree( GetProcessHeap(), 0, data );
416     }
417 }
418
419
420 /***********************************************************************
421  *           X11DRV process termination routine
422  */
423 static void process_detach(void)
424 {
425 #ifdef HAVE_LIBXXF86DGA2
426     /* cleanup DGA2 */
427     X11DRV_XF86DGA2_Cleanup();
428 #endif
429 #ifdef HAVE_LIBXXF86VM
430     /* cleanup XVidMode */
431     X11DRV_XF86VM_Cleanup();
432 #endif
433     if(using_client_side_fonts)
434         X11DRV_XRender_Finalize();
435
436     /* cleanup GDI */
437     X11DRV_GDI_Finalize();
438
439     DeleteCriticalSection( &X11DRV_CritSection );
440 }
441
442
443 /***********************************************************************
444  *           X11DRV thread initialisation routine
445  */
446 struct x11drv_thread_data *x11drv_init_thread_data(void)
447 {
448     struct x11drv_thread_data *data;
449
450     if (!(data = HeapAlloc( GetProcessHeap(), 0, sizeof(*data) )))
451     {
452         ERR( "could not create data\n" );
453         ExitProcess(1);
454     }
455     wine_tsx11_lock();
456     if (!(data->display = XOpenDisplay(NULL)))
457     {
458         wine_tsx11_unlock();
459         MESSAGE( "x11drv: Can't open display: %s\n", XDisplayName(NULL) );
460         MESSAGE( "Please ensure that your X server is running and that $DISPLAY is set correctly.\n" );
461         ExitProcess(1);
462     }
463
464     fcntl( ConnectionNumber(data->display), F_SETFD, 1 ); /* set close on exec flag */
465
466 #ifdef HAVE_XKB
467     if (use_xkb)
468     {
469         use_xkb = XkbUseExtension( data->display, NULL, NULL );
470         if (use_xkb) XkbSetDetectableAutoRepeat( data->display, True, NULL );
471     }
472 #endif
473
474     if (synchronous) XSynchronize( data->display, True );
475     wine_tsx11_unlock();
476
477     if (use_xim && !(data->xim = X11DRV_SetupXIM( data->display, input_style )))
478         WARN("Input Method is not available\n");
479
480     if (wine_server_fd_to_handle( ConnectionNumber(data->display), GENERIC_READ | SYNCHRONIZE,
481                                   FALSE, &data->display_fd ))
482     {
483         MESSAGE( "x11drv: Can't allocate handle for display fd\n" );
484         ExitProcess(1);
485     }
486     data->process_event_count = 0;
487     data->cursor = None;
488     data->cursor_window = None;
489     data->last_focus = 0;
490     NtCurrentTeb()->driver_data = data;
491     if (desktop_tid) AttachThreadInput( GetCurrentThreadId(), desktop_tid, TRUE );
492     return data;
493 }
494
495
496 /***********************************************************************
497  *           X11DRV initialisation routine
498  */
499 BOOL WINAPI DllMain( HINSTANCE hinst, DWORD reason, LPVOID reserved )
500 {
501     BOOL ret = TRUE;
502
503     switch(reason)
504     {
505     case DLL_PROCESS_ATTACH:
506         ret = process_attach();
507         break;
508     case DLL_THREAD_DETACH:
509         thread_detach();
510         break;
511     case DLL_PROCESS_DETACH:
512         process_detach();
513         break;
514     }
515     return ret;
516 }
517
518 /***********************************************************************
519  *              GetScreenSaveActive (X11DRV.@)
520  *
521  * Returns the active status of the screen saver
522  */
523 BOOL X11DRV_GetScreenSaveActive(void)
524 {
525     int timeout, temp;
526     wine_tsx11_lock();
527     XGetScreenSaver(gdi_display, &timeout, &temp, &temp, &temp);
528     wine_tsx11_unlock();
529     return timeout != 0;
530 }
531
532 /***********************************************************************
533  *              SetScreenSaveActive (X11DRV.@)
534  *
535  * Activate/Deactivate the screen saver
536  */
537 void X11DRV_SetScreenSaveActive(BOOL bActivate)
538 {
539     int timeout, interval, prefer_blanking, allow_exposures;
540     static int last_timeout = 15 * 60;
541
542     wine_tsx11_lock();
543     XGetScreenSaver(gdi_display, &timeout, &interval, &prefer_blanking,
544                     &allow_exposures);
545     if (timeout) last_timeout = timeout;
546
547     timeout = bActivate ? last_timeout : 0;
548     XSetScreenSaver(gdi_display, timeout, interval, prefer_blanking,
549                     allow_exposures);
550     wine_tsx11_unlock();
551 }