Implemented syslink control.
[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 #include <X11/Xproto.h>
47 #undef BOOL
48 #undef BYTE
49 #undef INT8
50 #undef INT16
51 #undef INT32
52
53 #include "windef.h"
54 #include "winbase.h"
55 #include "wine/winbase16.h"
56 #include "winreg.h"
57
58 #include "user.h"
59 #include "win.h"
60 #include "x11drv.h"
61 #include "xvidmode.h"
62 #include "xrandr.h"
63 #include "dga2.h"
64 #include "wine/server.h"
65 #include "wine/debug.h"
66
67 WINE_DEFAULT_DEBUG_CHANNEL(x11drv);
68
69 static CRITICAL_SECTION X11DRV_CritSection;
70 static CRITICAL_SECTION_DEBUG critsect_debug =
71 {
72     0, 0, &X11DRV_CritSection,
73     { &critsect_debug.ProcessLocksList, &critsect_debug.ProcessLocksList },
74       0, 0, { 0, (DWORD)(__FILE__ ": X11DRV_CritSection") }
75 };
76 static CRITICAL_SECTION X11DRV_CritSection = { &critsect_debug, -1, 0, 0, 0, 0 };
77
78 Screen *screen;
79 Visual *visual;
80 unsigned int screen_width;
81 unsigned int screen_height;
82 unsigned int screen_depth;
83 Window root_window;
84 DWORD desktop_tid = 0;
85 int dxgrab = 0;
86 int usedga = 0;
87 int usexvidmode = 0;
88 int usexrandr = 1;
89 int use_xkb = 1;
90 int use_take_focus = 1;
91 int managed_mode = 1;
92 int client_side_with_core = 1;
93 int client_side_with_render = 1;
94 int client_side_antialias_with_core = 1;
95 int client_side_antialias_with_render = 1;
96 int using_wine_desktop = 0;
97
98 unsigned int X11DRV_server_startticks;
99
100 static BOOL synchronous;  /* run in synchronous mode? */
101 static BOOL desktop_dbl_buf;
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  *              get_server_startup
216  *
217  * Get the server startup time
218  * Won't be exact, but should be sufficient
219  */
220 static void get_server_startup(void)
221 {
222     struct timeval t;
223     gettimeofday( &t, NULL );
224     X11DRV_server_startticks = ((t.tv_sec * 1000) + (t.tv_usec / 1000)) - GetTickCount();
225 }
226
227
228 /***********************************************************************
229  *              get_config_key
230  *
231  * Get a config key from either the app-specific or the default config
232  */
233 inline static DWORD get_config_key( HKEY defkey, HKEY appkey, const char *name,
234                                     char *buffer, DWORD size )
235 {
236     if (appkey && !RegQueryValueExA( appkey, name, 0, NULL, buffer, &size )) return 0;
237     return RegQueryValueExA( defkey, name, 0, NULL, buffer, &size );
238 }
239
240
241 /***********************************************************************
242  *              setup_options
243  *
244  * Setup the x11drv options.
245  */
246 static void setup_options(void)
247 {
248     char buffer[MAX_PATH+16];
249     HKEY hkey, appkey = 0;
250     DWORD len;
251
252     if (RegCreateKeyExA( HKEY_LOCAL_MACHINE, "Software\\Wine\\Wine\\Config\\x11drv", 0, NULL,
253                          REG_OPTION_VOLATILE, KEY_ALL_ACCESS, NULL, &hkey, NULL ))
254     {
255         ERR("Cannot create config registry key\n" );
256         ExitProcess(1);
257     }
258
259     /* open the app-specific key */
260
261     len = (GetModuleFileNameA( 0, buffer, MAX_PATH ));
262     if (len && len < MAX_PATH)
263     {
264         HKEY tmpkey;
265         char *p, *appname = buffer;
266         if ((p = strrchr( appname, '/' ))) appname = p + 1;
267         if ((p = strrchr( appname, '\\' ))) appname = p + 1;
268         strcat( appname, "\\x11drv" );
269         if (!RegOpenKeyA( HKEY_LOCAL_MACHINE, "Software\\Wine\\Wine\\Config\\AppDefaults", &tmpkey ))
270         {
271             if (RegOpenKeyA( tmpkey, appname, &appkey )) appkey = 0;
272             RegCloseKey( tmpkey );
273         }
274     }
275
276     if (!get_config_key( hkey, appkey, "Desktop", buffer, sizeof(buffer) ))
277     {
278         /* Imperfect validation:  If Desktop=N, then we don't turn on
279         ** the --desktop option.  We should really validate for a correct
280         ** sizing entry */
281         if (!IS_OPTION_FALSE(buffer[0])) desktop_geometry = strdup(buffer);
282     }
283
284     if (!get_config_key( hkey, appkey, "Managed", buffer, sizeof(buffer) ))
285         managed_mode = IS_OPTION_TRUE( buffer[0] );
286
287     if (!get_config_key( hkey, appkey, "DXGrab", buffer, sizeof(buffer) ))
288         dxgrab = IS_OPTION_TRUE( buffer[0] );
289
290     if (!get_config_key( hkey, appkey, "UseDGA", buffer, sizeof(buffer) ))
291         usedga = IS_OPTION_TRUE( buffer[0] );
292
293     if (!get_config_key( hkey, appkey, "UseXVidMode", buffer, sizeof(buffer) ))
294         usexvidmode = IS_OPTION_TRUE( buffer[0] );
295
296     if (!get_config_key( hkey, appkey, "UseXRandR", buffer, sizeof(buffer) ))
297         usexrandr = IS_OPTION_TRUE( buffer[0] );
298
299     if (!get_config_key( hkey, appkey, "UseTakeFocus", buffer, sizeof(buffer) ))
300         use_take_focus = IS_OPTION_TRUE( buffer[0] );
301
302     screen_depth = 0;
303     if (!get_config_key( hkey, appkey, "ScreenDepth", buffer, sizeof(buffer) ))
304         screen_depth = atoi(buffer);
305
306     if (!get_config_key( hkey, appkey, "Synchronous", buffer, sizeof(buffer) ))
307         synchronous = IS_OPTION_TRUE( buffer[0] );
308
309     if (!get_config_key( hkey, appkey, "ClientSideWithCore", buffer, sizeof(buffer) ))
310         client_side_with_core = IS_OPTION_TRUE( buffer[0] );
311
312     if (!get_config_key( hkey, appkey, "ClientSideWithRender", buffer, sizeof(buffer) ))
313         client_side_with_render = IS_OPTION_TRUE( buffer[0] );
314
315     if (!get_config_key( hkey, appkey, "ClientSideAntiAliasWithCore", buffer, sizeof(buffer) ))
316         client_side_antialias_with_core = IS_OPTION_TRUE( buffer[0] );
317
318     if (!get_config_key( hkey, appkey, "ClientSideAntiAliasWithRender", buffer, sizeof(buffer) ))
319         client_side_antialias_with_render = IS_OPTION_TRUE( buffer[0] );
320
321     if (!get_config_key( hkey, appkey, "DesktopDoubleBuffered", buffer, sizeof(buffer) ))
322         desktop_dbl_buf = IS_OPTION_TRUE( buffer[0] );
323
324     if (!get_config_key( hkey, appkey, "UseXIM", buffer, sizeof(buffer) ))
325         use_xim = IS_OPTION_TRUE( buffer[0] );
326
327     get_config_key( hkey, appkey, "InputStyle", input_style, sizeof(input_style) );
328
329     if (appkey) RegCloseKey( appkey );
330     RegCloseKey( hkey );
331 }
332
333
334 /***********************************************************************
335  *           X11DRV process initialisation routine
336  */
337 static BOOL process_attach(void)
338 {
339     Display *display;
340
341     get_server_startup();
342     setup_options();
343
344     /* Open display */
345
346     if (!(display = XOpenDisplay( NULL ))) return FALSE;
347
348     fcntl( ConnectionNumber(display), F_SETFD, 1 ); /* set close on exec flag */
349     screen = DefaultScreenOfDisplay( display );
350     visual = DefaultVisual( display, DefaultScreen(display) );
351     root_window = DefaultRootWindow( display );
352     old_error_handler = XSetErrorHandler( error_handler );
353
354     /* Initialize screen depth */
355
356     if (screen_depth)  /* depth specified */
357     {
358         int depth_count, i;
359         int *depth_list = XListDepths(display, DefaultScreen(display), &depth_count);
360         for (i = 0; i < depth_count; i++)
361             if (depth_list[i] == screen_depth) break;
362         XFree( depth_list );
363         if (i >= depth_count)
364         {
365             WARN( "invalid depth %d, using default\n", screen_depth );
366             screen_depth = 0;
367         }
368     }
369     if (!screen_depth) screen_depth = DefaultDepthOfScreen( screen );
370
371     /* Initialize OpenGL */
372     X11DRV_OpenGL_Init(display);
373
374     /* If OpenGL is available, change the default visual, etc as necessary */
375     if (desktop_dbl_buf && (desktop_vi = X11DRV_setup_opengl_visual( display )))
376     {
377         visual       = desktop_vi->visual;
378         screen       = ScreenOfDisplay(display, desktop_vi->screen);
379         screen_depth = desktop_vi->depth;
380     }
381
382     if (synchronous) XSynchronize( display, True );
383
384     screen_width  = WidthOfScreen( screen );
385     screen_height = HeightOfScreen( screen );
386
387     X11DRV_Settings_Init();
388
389     if (desktop_geometry)
390     {
391         root_window = X11DRV_create_desktop( desktop_vi, desktop_geometry );
392         using_wine_desktop = 1;
393     }
394
395     /* initialize GDI */
396     X11DRV_GDI_Initialize( display );
397
398 #ifdef HAVE_LIBXXF86VM
399     /* initialize XVidMode */
400     X11DRV_XF86VM_Init();
401 #endif
402 #ifdef HAVE_LIBXRANDR
403     /* initialize XRandR */
404     X11DRV_XRandR_Init();
405 #endif
406 #ifdef HAVE_LIBXXF86DGA2
407     /* initialize DGA2 */
408     X11DRV_XF86DGA2_Init();
409 #endif
410
411     return TRUE;
412 }
413
414
415 /***********************************************************************
416  *           X11DRV thread termination routine
417  */
418 static void thread_detach(void)
419 {
420     struct x11drv_thread_data *data = NtCurrentTeb()->driver_data;
421
422     if (data)
423     {
424         CloseHandle( data->display_fd );
425         wine_tsx11_lock();
426         XCloseDisplay( data->display );
427         /* if (data->xim) XCloseIM( data->xim ); */ /* crashes Xlib */
428         wine_tsx11_unlock();
429         HeapFree( GetProcessHeap(), 0, data );
430     }
431 }
432
433
434 /***********************************************************************
435  *           X11DRV process termination routine
436  */
437 static void process_detach(void)
438 {
439 #ifdef HAVE_LIBXXF86DGA2
440     /* cleanup DGA2 */
441     X11DRV_XF86DGA2_Cleanup();
442 #endif
443 #ifdef HAVE_LIBXXF86VM
444     /* cleanup XVidMode */
445     X11DRV_XF86VM_Cleanup();
446 #endif
447     if(using_client_side_fonts)
448         X11DRV_XRender_Finalize();
449
450     /* cleanup GDI */
451     X11DRV_GDI_Finalize();
452
453     DeleteCriticalSection( &X11DRV_CritSection );
454 }
455
456
457 /***********************************************************************
458  *           X11DRV thread initialisation routine
459  */
460 struct x11drv_thread_data *x11drv_init_thread_data(void)
461 {
462     struct x11drv_thread_data *data;
463
464     if (!(data = HeapAlloc( GetProcessHeap(), 0, sizeof(*data) )))
465     {
466         ERR( "could not create data\n" );
467         ExitProcess(1);
468     }
469     wine_tsx11_lock();
470     if (!(data->display = XOpenDisplay(NULL)))
471     {
472         wine_tsx11_unlock();
473         MESSAGE( "x11drv: Can't open display: %s\n", XDisplayName(NULL) );
474         MESSAGE( "Please ensure that your X server is running and that $DISPLAY is set correctly.\n" );
475         ExitProcess(1);
476     }
477
478     fcntl( ConnectionNumber(data->display), F_SETFD, 1 ); /* set close on exec flag */
479
480 #ifdef HAVE_XKB
481     if (use_xkb)
482     {
483         use_xkb = XkbUseExtension( data->display, NULL, NULL );
484         if (use_xkb) XkbSetDetectableAutoRepeat( data->display, True, NULL );
485     }
486 #endif
487
488     if (synchronous) XSynchronize( data->display, True );
489     wine_tsx11_unlock();
490
491     if (use_xim && !(data->xim = X11DRV_SetupXIM( data->display, input_style )))
492         WARN("Input Method is not available\n");
493
494     if (wine_server_fd_to_handle( ConnectionNumber(data->display), GENERIC_READ | SYNCHRONIZE,
495                                   FALSE, &data->display_fd ))
496     {
497         MESSAGE( "x11drv: Can't allocate handle for display fd\n" );
498         ExitProcess(1);
499     }
500     data->process_event_count = 0;
501     data->cursor = None;
502     data->cursor_window = None;
503     data->last_focus = 0;
504     NtCurrentTeb()->driver_data = data;
505     if (desktop_tid) AttachThreadInput( GetCurrentThreadId(), desktop_tid, TRUE );
506     return data;
507 }
508
509
510 /***********************************************************************
511  *           X11DRV initialisation routine
512  */
513 BOOL WINAPI DllMain( HINSTANCE hinst, DWORD reason, LPVOID reserved )
514 {
515     BOOL ret = TRUE;
516
517     switch(reason)
518     {
519     case DLL_PROCESS_ATTACH:
520         ret = process_attach();
521         break;
522     case DLL_THREAD_DETACH:
523         thread_detach();
524         break;
525     case DLL_PROCESS_DETACH:
526         process_detach();
527         break;
528     }
529     return ret;
530 }
531
532 /***********************************************************************
533  *              GetScreenSaveActive (X11DRV.@)
534  *
535  * Returns the active status of the screen saver
536  */
537 BOOL X11DRV_GetScreenSaveActive(void)
538 {
539     int timeout, temp;
540     wine_tsx11_lock();
541     XGetScreenSaver(gdi_display, &timeout, &temp, &temp, &temp);
542     wine_tsx11_unlock();
543     return timeout != 0;
544 }
545
546 /***********************************************************************
547  *              SetScreenSaveActive (X11DRV.@)
548  *
549  * Activate/Deactivate the screen saver
550  */
551 void X11DRV_SetScreenSaveActive(BOOL bActivate)
552 {
553     int timeout, interval, prefer_blanking, allow_exposures;
554     static int last_timeout = 15 * 60;
555
556     wine_tsx11_lock();
557     XGetScreenSaver(gdi_display, &timeout, &interval, &prefer_blanking,
558                     &allow_exposures);
559     if (timeout) last_timeout = timeout;
560
561     timeout = bActivate ? last_timeout : 0;
562     XSetScreenSaver(gdi_display, timeout, interval, prefer_blanking,
563                     allow_exposures);
564     wine_tsx11_unlock();
565 }