Added LGPL standard comment, and copyright notices where necessary.
[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 #ifdef NO_REENTRANT_X11
25 /* Get pointers to the static errno and h_errno variables used by Xlib. This
26    must be done before including <errno.h> makes the variables invisible.  */
27 extern int errno;
28 static int *perrno = &errno;
29 extern int h_errno;
30 static int *ph_errno = &h_errno;
31 #endif  /* NO_REENTRANT_X11 */
32
33 #include <fcntl.h>
34 #include <stdio.h>
35 #include <stdlib.h>
36 #include <string.h>
37 #include <sys/time.h>
38 #include <unistd.h>
39 #include <X11/cursorfont.h>
40 #include "ts_xlib.h"
41 #include "ts_xutil.h"
42 #include "ts_shape.h"
43
44 #include "winbase.h"
45 #include "wine/winbase16.h"
46 #include "winreg.h"
47
48 #include "wine/debug.h"
49 #include "gdi.h"
50 #include "file.h"
51 #include "options.h"
52 #include "user.h"
53 #include "win.h"
54 #include "wine_gl.h"
55 #include "x11drv.h"
56 #include "xvidmode.h"
57 #include "dga2.h"
58
59 WINE_DEFAULT_DEBUG_CHANNEL(x11drv);
60
61 static void (*old_tsx11_lock)(void);
62 static void (*old_tsx11_unlock)(void);
63
64 static CRITICAL_SECTION X11DRV_CritSection = CRITICAL_SECTION_INIT("X11DRV_CritSection");
65
66 Screen *screen;
67 Visual *visual;
68 unsigned int screen_width;
69 unsigned int screen_height;
70 unsigned int screen_depth;
71 Window root_window;
72 int dxgrab, usedga, usexvidmode;
73
74 unsigned int X11DRV_server_startticks;
75
76 static BOOL synchronous;  /* run in synchronous mode? */
77 static char *desktop_geometry;
78 static XVisualInfo *desktop_vi;
79
80 #define IS_OPTION_TRUE(ch) \
81     ((ch) == 'y' || (ch) == 'Y' || (ch) == 't' || (ch) == 'T' || (ch) == '1')
82 #define IS_OPTION_FALSE(ch) \
83     ((ch) == 'n' || (ch) == 'N' || (ch) == 'f' || (ch) == 'F' || (ch) == '0')
84
85 #ifdef NO_REENTRANT_X11
86 static int* (*old_errno_location)(void);
87 static int* (*old_h_errno_location)(void);
88
89 /***********************************************************************
90  *           x11_errno_location
91  *
92  * Get the per-thread errno location.
93  */
94 static int *x11_errno_location(void)
95 {
96     /* Use static libc errno while running in Xlib. */
97     if (X11DRV_CritSection.OwningThread == GetCurrentThreadId()) return perrno;
98     return old_errno_location();
99 }
100
101 /***********************************************************************
102  *           x11_h_errno_location
103  *
104  * Get the per-thread h_errno location.
105  */
106 static int *x11_h_errno_location(void)
107 {
108     /* Use static libc h_errno while running in Xlib. */
109     if (X11DRV_CritSection.OwningThread == GetCurrentThreadId()) return ph_errno;
110     return old_h_errno_location();
111 }
112 #endif /* NO_REENTRANT_X11 */
113
114 /***********************************************************************
115  *              error_handler
116  */
117 static int error_handler(Display *display, XErrorEvent *error_evt)
118 {
119     DebugBreak();  /* force an entry in the debugger */
120     return 0;
121 }
122
123 /***********************************************************************
124  *              lock_tsx11
125  */
126 static void lock_tsx11(void)
127 {
128     RtlEnterCriticalSection( &X11DRV_CritSection );
129 }
130
131 /***********************************************************************
132  *              unlock_tsx11
133  */
134 static void unlock_tsx11(void)
135 {
136     RtlLeaveCriticalSection( &X11DRV_CritSection );
137 }
138
139 /***********************************************************************
140  *              get_server_startup
141  *
142  * Get the server startup time 
143  * Won't be exact, but should be sufficient
144  */
145 static void get_server_startup(void)
146 {
147     struct timeval t;
148     gettimeofday( &t, NULL );
149     X11DRV_server_startticks = ((t.tv_sec * 1000) + (t.tv_usec / 1000)) - GetTickCount();
150 }
151
152
153 /***********************************************************************
154  *              get_config_key
155  *
156  * Get a config key from either the app-specific or the default config
157  */
158 inline static DWORD get_config_key( HKEY defkey, HKEY appkey, const char *name,
159                                     char *buffer, DWORD size )
160 {
161     if (appkey && !RegQueryValueExA( appkey, name, 0, NULL, buffer, &size )) return 0;
162     return RegQueryValueExA( defkey, name, 0, NULL, buffer, &size );
163 }
164
165
166 /***********************************************************************
167  *              setup_options
168  *
169  * Setup the x11drv options.
170  */
171 static void setup_options(void)
172 {
173     char buffer[MAX_PATH+16];
174     HKEY hkey, appkey = 0;
175     DWORD count;
176
177     if (RegCreateKeyExA( HKEY_LOCAL_MACHINE, "Software\\Wine\\Wine\\Config\\x11drv", 0, NULL,
178                          REG_OPTION_VOLATILE, KEY_ALL_ACCESS, NULL, &hkey, NULL ))
179     {
180         ERR("Cannot create config registry key\n" );
181         ExitProcess(1);
182     }
183
184     /* open the app-specific key */
185
186     if (GetModuleFileName16( GetCurrentTask(), buffer, MAX_PATH ) ||
187         GetModuleFileNameA( 0, buffer, MAX_PATH ))
188     {
189         HKEY tmpkey;
190         char *p, *appname = buffer;
191         if ((p = strrchr( appname, '/' ))) appname = p + 1;
192         if ((p = strrchr( appname, '\\' ))) appname = p + 1;
193         strcat( appname, "\\x11drv" );
194         if (!RegOpenKeyA( HKEY_LOCAL_MACHINE, "Software\\Wine\\Wine\\Config\\AppDefaults", &tmpkey ))
195         {
196             if (RegOpenKeyA( tmpkey, appname, &appkey )) appkey = 0;
197             RegCloseKey( tmpkey );
198         }
199     }
200
201     /* get the display name */
202
203     strcpy( buffer, "DISPLAY=" );
204     count = sizeof(buffer) - 8;
205     if (!RegQueryValueExA( hkey, "display", 0, NULL, buffer + 8, &count ))
206     {
207         const char *display_name = getenv( "DISPLAY" );
208         if (display_name && strcmp( buffer, display_name ))
209             MESSAGE( "x11drv: Warning: $DISPLAY variable ignored, using '%s' specified in config file\n",
210                      buffer + 8 );
211         putenv( strdup(buffer) );
212     }
213
214     /* check --managed option in wine config file if it was not set on command line */
215
216     if (!Options.managed)
217     {
218         if (!get_config_key( hkey, appkey, "Managed", buffer, sizeof(buffer) ))
219             Options.managed = IS_OPTION_TRUE( buffer[0] );
220     }
221
222     if (!get_config_key( hkey, appkey, "Desktop", buffer, sizeof(buffer) ))
223     {
224         /* Imperfect validation:  If Desktop=N, then we don't turn on
225         ** the --desktop option.  We should really validate for a correct
226         ** sizing entry */
227         if (!IS_OPTION_FALSE(buffer[0])) desktop_geometry = strdup(buffer);
228     }
229
230     if (!get_config_key( hkey, appkey, "DXGrab", buffer, sizeof(buffer) ))
231         dxgrab = IS_OPTION_TRUE( buffer[0] );
232
233     if (!get_config_key( hkey, appkey, "UseDGA", buffer, sizeof(buffer) ))
234         usedga = IS_OPTION_TRUE( buffer[0] );
235
236     if (!get_config_key( hkey, appkey, "UseXVidMode", buffer, sizeof(buffer) ))
237         usexvidmode = IS_OPTION_TRUE( buffer[0] );
238
239     screen_depth = 0;
240     if (!get_config_key( hkey, appkey, "ScreenDepth", buffer, sizeof(buffer) ))
241         screen_depth = atoi(buffer);
242
243     if (!get_config_key( hkey, appkey, "Synchronous", buffer, sizeof(buffer) ))
244         synchronous = IS_OPTION_TRUE( buffer[0] );
245
246     if (appkey) RegCloseKey( appkey );
247     RegCloseKey( hkey );
248 }
249
250
251 /***********************************************************************
252  *              setup_opengl_visual
253  *
254  * Setup the default visual used for OpenGL and Direct3D, and the desktop
255  * window (if it exists).  If OpenGL isn't available, the visual is simply 
256  * set to the default visual for the display
257  */
258 #ifdef HAVE_OPENGL
259 static void setup_opengl_visual( Display *display )
260 {
261     int err_base, evt_base;
262
263     /* In order to support OpenGL or D3D, we require a double-buffered 
264      * visual */
265     if (glXQueryExtension(display, &err_base, &evt_base) == True) {
266           int dblBuf[]={GLX_RGBA,GLX_DEPTH_SIZE,16,GLX_DOUBLEBUFFER,None};
267         
268           ENTER_GL();
269           desktop_vi = glXChooseVisual(display, DefaultScreen(display), dblBuf);
270           LEAVE_GL();
271     }
272
273     if (desktop_vi != NULL) {
274       visual       = desktop_vi->visual;
275       screen       = ScreenOfDisplay(display, desktop_vi->screen);
276       screen_depth = desktop_vi->depth;
277     }
278 }
279 #endif /* HAVE_OPENGL */    
280
281 /***********************************************************************
282  *           X11DRV process initialisation routine
283  */
284 static void process_attach(void)
285 {
286     Display *display;
287
288     get_server_startup();
289     setup_options();
290
291     /* setup TSX11 locking */
292 #ifdef NO_REENTRANT_X11
293     old_errno_location = InterlockedExchangePointer( &wine_errno_location,
294                                                      x11_errno_location );
295     old_h_errno_location = InterlockedExchangePointer( &wine_h_errno_location,
296                                                        x11_h_errno_location );
297 #endif /* NO_REENTRANT_X11 */
298     old_tsx11_lock    = wine_tsx11_lock;
299     old_tsx11_unlock  = wine_tsx11_unlock;
300     wine_tsx11_lock   = lock_tsx11;
301     wine_tsx11_unlock = unlock_tsx11;
302
303     /* Open display */
304
305     if (!(display = TSXOpenDisplay( NULL )))
306     {
307         MESSAGE( "x11drv: Can't open display: %s\n", XDisplayName(NULL) );
308         ExitProcess(1);
309     }
310     fcntl( ConnectionNumber(display), F_SETFD, 1 ); /* set close on exec flag */
311     screen = DefaultScreenOfDisplay( display );
312     visual = DefaultVisual( display, DefaultScreen(display) );
313     root_window = DefaultRootWindow( display );
314
315     /* Initialize screen depth */
316
317     if (screen_depth)  /* depth specified */
318     {
319         int depth_count, i;
320         int *depth_list = TSXListDepths(display, DefaultScreen(display), &depth_count);
321         for (i = 0; i < depth_count; i++)
322             if (depth_list[i] == screen_depth) break;
323         TSXFree( depth_list );
324         if (i >= depth_count)
325         {
326             MESSAGE( "x11drv: Depth %d not supported on this screen.\n", screen_depth );
327             ExitProcess(1);
328         }
329     }
330     else screen_depth = DefaultDepthOfScreen( screen );
331
332     /* If OpenGL is available, change the default visual, etc as necessary */
333 #ifdef HAVE_OPENGL
334     setup_opengl_visual( display );
335 #endif /* HAVE_OPENGL */
336
337     /* tell the libX11 that we will do input method handling ourselves
338      * that keep libX11 from doing anything whith dead keys, allowing Wine
339      * to have total control over dead keys, that is this line allows
340      * them to work in Wine, even whith a libX11 including the dead key
341      * patches from Th.Quinot (http://Web.FdN.FR/~tquinot/dead-keys.en.html)
342      */
343     TSXOpenIM( display, NULL, NULL, NULL);
344
345     if (synchronous)
346     {
347         XSetErrorHandler( error_handler );
348         XSynchronize( display, True );
349     }
350
351     screen_width  = WidthOfScreen( screen );
352     screen_height = HeightOfScreen( screen );
353
354     if (desktop_geometry)
355     {
356         Options.managed = FALSE;
357         root_window = X11DRV_create_desktop( desktop_vi, desktop_geometry );
358     }
359
360     /* initialize GDI */
361     if(!X11DRV_GDI_Initialize( display ))
362     {
363         ERR( "Couldn't Initialize GDI.\n" );
364         ExitProcess(1);
365     }
366
367 #ifdef HAVE_LIBXXF86VM
368     /* initialize XVidMode */
369     X11DRV_XF86VM_Init();
370 #endif
371 #ifdef HAVE_LIBXXF86DGA2
372     /* initialize DGA2 */
373     X11DRV_XF86DGA2_Init();
374 #endif
375 #ifdef HAVE_OPENGL
376     /* initialize GLX */
377     /*X11DRV_GLX_Init();*/
378 #endif
379
380     /* load display.dll */
381     LoadLibrary16( "display" );
382 }
383
384
385 /***********************************************************************
386  *           X11DRV thread termination routine
387  */
388 static void thread_detach(void)
389 {
390     struct x11drv_thread_data *data = NtCurrentTeb()->driver_data;
391
392     if (data)
393     {
394         CloseHandle( data->display_fd );
395         wine_tsx11_lock();
396         XCloseDisplay( data->display );
397         wine_tsx11_unlock();
398         HeapFree( GetProcessHeap(), 0, data );
399     }
400 }
401
402
403 /***********************************************************************
404  *           X11DRV process termination routine
405  */
406 static void process_detach(void)
407 {
408 #ifdef HAVE_OPENGL
409     /* cleanup GLX */
410     /*X11DRV_GLX_Cleanup();*/
411 #endif
412 #ifdef HAVE_LIBXXF86DGA2
413     /* cleanup DGA2 */
414     X11DRV_XF86DGA2_Cleanup();
415 #endif
416 #ifdef HAVE_LIBXXF86VM
417     /* cleanup XVidMode */
418     X11DRV_XF86VM_Cleanup();
419 #endif
420
421     /* FIXME: should detach all threads */
422     thread_detach();
423
424     /* cleanup GDI */
425     X11DRV_GDI_Finalize();
426
427     /* restore TSX11 locking */
428     wine_tsx11_lock = old_tsx11_lock;
429     wine_tsx11_unlock = old_tsx11_unlock;
430 #ifdef NO_REENTRANT_X11
431     wine_errno_location = old_errno_location;
432     wine_h_errno_location = old_h_errno_location;
433 #endif /* NO_REENTRANT_X11 */
434     RtlDeleteCriticalSection( &X11DRV_CritSection );
435 }
436
437
438 /***********************************************************************
439  *           X11DRV thread initialisation routine
440  */
441 struct x11drv_thread_data *x11drv_init_thread_data(void)
442 {
443     struct x11drv_thread_data *data;
444
445     if (!(data = HeapAlloc( GetProcessHeap(), 0, sizeof(*data) )))
446     {
447         ERR( "could not create data\n" );
448         ExitProcess(1);
449     }
450     wine_tsx11_lock();
451     if (!(data->display = XOpenDisplay(NULL)))
452     {
453         wine_tsx11_unlock();
454         MESSAGE( "x11drv: Can't open display: %s\n", XDisplayName(NULL) );
455         ExitProcess(1);
456     }
457     fcntl( ConnectionNumber(data->display), F_SETFD, 1 ); /* set close on exec flag */
458     if (synchronous) XSynchronize( data->display, True );
459     wine_tsx11_unlock();
460     data->display_fd = FILE_DupUnixHandle( ConnectionNumber(data->display),
461                                            GENERIC_READ | SYNCHRONIZE, FALSE );
462     data->process_event_count = 0;
463     NtCurrentTeb()->driver_data = data;
464     return data;
465 }
466
467
468 /***********************************************************************
469  *           X11DRV initialisation routine
470  */
471 BOOL WINAPI X11DRV_Init( HINSTANCE hinst, DWORD reason, LPVOID reserved )
472 {
473     switch(reason)
474     {
475     case DLL_PROCESS_ATTACH:
476         process_attach();
477         break;
478     case DLL_THREAD_DETACH:
479         thread_detach();
480         break;
481     case DLL_PROCESS_DETACH:
482         process_detach();
483         break;
484     }
485     return TRUE;
486 }
487
488 /***********************************************************************
489  *              GetScreenSaveActive (X11DRV.@)
490  *
491  * Returns the active status of the screen saver
492  */
493 BOOL X11DRV_GetScreenSaveActive(void)
494 {
495     int timeout, temp;
496     TSXGetScreenSaver(gdi_display, &timeout, &temp, &temp, &temp);
497     return timeout != 0;
498 }
499
500 /***********************************************************************
501  *              SetScreenSaveActive (X11DRV.@)
502  *
503  * Activate/Deactivate the screen saver
504  */
505 void X11DRV_SetScreenSaveActive(BOOL bActivate)
506 {
507     int timeout, interval, prefer_blanking, allow_exposures;
508     static int last_timeout = 15 * 60;
509
510     TSXGetScreenSaver(gdi_display, &timeout, &interval, &prefer_blanking,
511                       &allow_exposures);
512     if (timeout) last_timeout = timeout;
513
514     timeout = bActivate ? last_timeout : 0;
515     TSXSetScreenSaver(gdi_display, timeout, interval, prefer_blanking,
516                       allow_exposures);
517 }