add --debug-xinerama
[mikachu/openbox.git] / openbox / openbox.c
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    openbox.c for the Openbox window manager
4    Copyright (c) 2006        Mikael Magnusson
5    Copyright (c) 2003-2007   Dana Jansens
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11
12    This program 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
15    GNU General Public License for more details.
16
17    See the COPYING file for a copy of the GNU General Public License.
18 */
19
20 #include "debug.h"
21 #include "openbox.h"
22 #include "session.h"
23 #include "dock.h"
24 #include "modkeys.h"
25 #include "event.h"
26 #include "menu.h"
27 #include "client.h"
28 #include "xerror.h"
29 #include "prop.h"
30 #include "screen.h"
31 #include "startupnotify.h"
32 #include "focus.h"
33 #include "moveresize.h"
34 #include "frame.h"
35 #include "keyboard.h"
36 #include "mouse.h"
37 #include "extensions.h"
38 #include "menuframe.h"
39 #include "grab.h"
40 #include "group.h"
41 #include "propwin.h"
42 #include "config.h"
43 #include "mainloop.h"
44 #include "gettext.h"
45 #include "parser/parse.h"
46 #include "render/render.h"
47 #include "render/theme.h"
48
49 #ifdef HAVE_FCNTL_H
50 #  include <fcntl.h>
51 #endif
52 #ifdef HAVE_SIGNAL_H
53 #  include <signal.h>
54 #endif
55 #ifdef HAVE_STDLIB_H
56 #  include <stdlib.h>
57 #endif
58 #ifdef HAVE_LOCALE_H
59 #  include <locale.h>
60 #endif
61 #ifdef HAVE_SYS_STAT_H
62 #  include <sys/stat.h>
63 #  include <sys/types.h>
64 #endif
65 #ifdef HAVE_SYS_WAIT_H
66 #  include <sys/types.h>
67 #  include <sys/wait.h>
68 #endif
69 #ifdef HAVE_UNISTD_H
70 #  include <unistd.h>
71 #endif
72 #include <errno.h>
73
74 #include <X11/cursorfont.h>
75 #if USE_XCURSOR
76 #include <X11/Xcursor/Xcursor.h>
77 #endif
78
79 #include <X11/Xlib.h>
80 #include <X11/keysym.h>
81
82
83 RrInstance *ob_rr_inst;
84 RrTheme    *ob_rr_theme;
85 ObMainLoop *ob_main_loop;
86 Display    *ob_display;
87 gint        ob_screen;
88 gboolean    ob_replace_wm = FALSE;
89 gboolean    ob_sm_use = TRUE;
90 gchar      *ob_sm_id = NULL;
91 gchar      *ob_sm_save_file = NULL;
92 gchar      *ob_config_type = NULL;
93 gboolean    ob_debug_xinerama = FALSE;
94
95 static ObState   state;
96 static gboolean  xsync = FALSE;
97 static gboolean  reconfigure = FALSE;
98 static gboolean  restart = FALSE;
99 static gchar    *restart_path = NULL;
100 static Cursor    cursors[OB_NUM_CURSORS];
101 static KeyCode   keys[OB_NUM_KEYS];
102 static gint      exitcode = 0;
103 static guint     remote_control = 0;
104 static gboolean  being_replaced = FALSE;
105
106 static void signal_handler(gint signal, gpointer data);
107 static void remove_args(gint *argc, gchar **argv, gint index, gint num);
108 static void parse_env();
109 static void parse_args(gint *argc, gchar **argv);
110 static Cursor load_cursor(const gchar *name, guint fontval);
111
112 gint main(gint argc, gchar **argv)
113 {
114     gchar *program_name;
115
116     state = OB_STATE_STARTING;
117
118     /* initialize the locale */
119     if (!setlocale(LC_ALL, ""))
120         g_message("Couldn't set locale from environment.");
121     bindtextdomain(PACKAGE_NAME, LOCALEDIR);
122     bind_textdomain_codeset(PACKAGE_NAME, "UTF-8");
123     textdomain(PACKAGE_NAME);
124
125     if (chdir(g_get_home_dir()) == -1)
126         g_message(_("Unable to change to home directory '%s': %s"),
127                   g_get_home_dir(), g_strerror(errno));
128      
129     /* parse the command line args, which can change the argv[0] */
130     parse_args(&argc, argv);
131     /* parse the environment variables */
132     parse_env();
133
134     program_name = g_path_get_basename(argv[0]);
135     g_set_prgname(program_name);
136
137     if (!remote_control) {
138         parse_paths_startup();
139
140         session_startup(argc, argv);
141     }
142
143
144     ob_display = XOpenDisplay(NULL);
145     if (ob_display == NULL)
146         ob_exit_with_error(_("Failed to open the display from the DISPLAY environment variable."));
147     if (fcntl(ConnectionNumber(ob_display), F_SETFD, 1) == -1)
148         ob_exit_with_error("Failed to set display as close-on-exec");
149
150     if (remote_control) {
151         prop_startup();
152
153         /* Send client message telling the OB process to:
154          * remote_control = 1 -> reconfigure 
155          * remote_control = 2 -> restart */
156         PROP_MSG(RootWindow(ob_display, ob_screen),
157                  ob_control, remote_control, 0, 0, 0);
158         XCloseDisplay(ob_display);
159         exit(EXIT_SUCCESS);
160     }
161
162     ob_main_loop = ob_main_loop_new(ob_display);
163
164     /* set up signal handler */
165     ob_main_loop_signal_add(ob_main_loop, SIGUSR1, signal_handler, NULL, NULL);
166     ob_main_loop_signal_add(ob_main_loop, SIGUSR2, signal_handler, NULL, NULL);
167     ob_main_loop_signal_add(ob_main_loop, SIGTERM, signal_handler, NULL, NULL);
168     ob_main_loop_signal_add(ob_main_loop, SIGINT, signal_handler, NULL, NULL);
169     ob_main_loop_signal_add(ob_main_loop, SIGHUP, signal_handler, NULL, NULL);
170     ob_main_loop_signal_add(ob_main_loop, SIGPIPE, signal_handler, NULL, NULL);
171     ob_main_loop_signal_add(ob_main_loop, SIGCHLD, signal_handler, NULL, NULL);
172
173     ob_screen = DefaultScreen(ob_display);
174
175     ob_rr_inst = RrInstanceNew(ob_display, ob_screen);
176     if (ob_rr_inst == NULL)
177         ob_exit_with_error(_("Failed to initialize the render library."));
178
179     XSynchronize(ob_display, xsync);
180
181     /* check for locale support */
182     if (!XSupportsLocale())
183         g_message(_("X server does not support locale."));
184     if (!XSetLocaleModifiers(""))
185         g_message(_("Cannot set locale modifiers for the X server."));
186
187     /* set our error handler */
188     XSetErrorHandler(xerror_handler);
189
190     /* set the DISPLAY environment variable for any lauched children, to the
191        display we're using, so they open in the right place. */
192     putenv(g_strdup_printf("DISPLAY=%s", DisplayString(ob_display)));
193
194     /* create available cursors */
195     cursors[OB_CURSOR_NONE] = None;
196     cursors[OB_CURSOR_POINTER] = load_cursor("left_ptr", XC_left_ptr);
197     cursors[OB_CURSOR_BUSY] = load_cursor("left_ptr_watch", XC_watch);
198     cursors[OB_CURSOR_MOVE] = load_cursor("fleur", XC_fleur);
199     cursors[OB_CURSOR_NORTH] = load_cursor("top_side", XC_top_side);
200     cursors[OB_CURSOR_NORTHEAST] = load_cursor("top_right_corner",
201                                                XC_top_right_corner);
202     cursors[OB_CURSOR_EAST] = load_cursor("right_side", XC_right_side);
203     cursors[OB_CURSOR_SOUTHEAST] = load_cursor("bottom_right_corner",
204                                                XC_bottom_right_corner);
205     cursors[OB_CURSOR_SOUTH] = load_cursor("bottom_side", XC_bottom_side);
206     cursors[OB_CURSOR_SOUTHWEST] = load_cursor("bottom_left_corner",
207                                                XC_bottom_left_corner);
208     cursors[OB_CURSOR_WEST] = load_cursor("left_side", XC_left_side);
209     cursors[OB_CURSOR_NORTHWEST] = load_cursor("top_left_corner",
210                                                XC_top_left_corner);
211
212
213     prop_startup(); /* get atoms values for the display */
214     extensions_query_all(); /* find which extensions are present */
215
216     if (screen_annex(program_name)) { /* it will be ours! */
217         do {
218             modkeys_startup(reconfigure);
219
220             /* get the keycodes for keys we use */
221             keys[OB_KEY_RETURN] = modkeys_sym_to_code(XK_Return);
222             keys[OB_KEY_ESCAPE] = modkeys_sym_to_code(XK_Escape);
223             keys[OB_KEY_LEFT] = modkeys_sym_to_code(XK_Left);
224             keys[OB_KEY_RIGHT] = modkeys_sym_to_code(XK_Right);
225             keys[OB_KEY_UP] = modkeys_sym_to_code(XK_Up);
226             keys[OB_KEY_DOWN] = modkeys_sym_to_code(XK_Down);
227
228             {
229                 ObParseInst *i;
230                 xmlDocPtr doc;
231                 xmlNodePtr node;
232
233                 /* startup the parsing so everything can register sections
234                    of the rc */
235                 i = parse_startup();
236
237                 /* start up config which sets up with the parser */
238                 config_startup(i);
239
240                 /* parse/load user options */
241                 if (parse_load_rc(ob_config_type, &doc, &node)) {
242                     parse_tree(i, doc, node->xmlChildrenNode);
243                     parse_close(doc);
244                 } else
245                     g_message(_("Unable to find a valid config file, using some simple defaults"));
246
247                 if (ob_config_type != NULL)
248                     PROP_SETS(RootWindow(ob_display, ob_screen),
249                               ob_config, ob_config_type);
250
251                 /* we're done with parsing now, kill it */
252                 parse_shutdown(i);
253             }
254
255             /* load the theme specified in the rc file */
256             {
257                 RrTheme *theme;
258                 if ((theme = RrThemeNew(ob_rr_inst, config_theme,
259                                         config_font_activewindow,
260                                         config_font_inactivewindow,
261                                         config_font_menutitle,
262                                         config_font_menuitem,
263                                         config_font_osd)))
264                 {
265                     RrThemeFree(ob_rr_theme);
266                     ob_rr_theme = theme;
267                 }
268                 if (ob_rr_theme == NULL)
269                     ob_exit_with_error(_("Unable to load a theme."));
270             }
271
272             if (reconfigure) {
273                 GList *it;
274
275                 /* update all existing windows for the new theme */
276                 for (it = client_list; it; it = g_list_next(it)) {
277                     ObClient *c = it->data;
278                     frame_adjust_theme(c->frame);
279                 }
280             }
281             event_startup(reconfigure);
282             /* focus_backup is used for stacking, so this needs to come before
283                anything that calls stacking_add */
284             focus_startup(reconfigure);
285             window_startup(reconfigure);
286             sn_startup(reconfigure);
287             screen_startup(reconfigure);
288             grab_startup(reconfigure);
289             propwin_startup(reconfigure);
290             group_startup(reconfigure);
291             client_startup(reconfigure);
292             dock_startup(reconfigure);
293             moveresize_startup(reconfigure);
294             keyboard_startup(reconfigure);
295             mouse_startup(reconfigure);
296             menu_startup(reconfigure);
297             menu_frame_startup(reconfigure);
298
299             if (!reconfigure) {
300                 guint32 xid;
301                 ObWindow *w;
302
303                 /* get all the existing windows */
304                 client_manage_all();
305                 focus_nothing();
306
307                 /* focus what was focused if a wm was already running */
308                 if (PROP_GET32(RootWindow(ob_display, ob_screen),
309                                net_active_window, window, &xid) &&
310                     (w = g_hash_table_lookup(window_map, &xid)) &&
311                     WINDOW_IS_CLIENT(w))
312                 {
313                     client_focus(WINDOW_AS_CLIENT(w));
314                 }
315             } else {
316                 GList *it;
317
318                 /* redecorate all existing windows */
319                 for (it = client_list; it; it = g_list_next(it)) {
320                     ObClient *c = it->data;
321                     /* the new config can change the window's decorations */
322                     client_setup_decor_and_functions(c);
323                     /* redraw the frames */
324                     frame_adjust_area(c->frame, TRUE, TRUE, FALSE);
325                 }
326             }
327
328             reconfigure = FALSE;
329
330             state = OB_STATE_RUNNING;
331             ob_main_loop_run(ob_main_loop);
332             state = OB_STATE_EXITING;
333
334             if (!reconfigure) {
335                 dock_remove_all();
336                 client_unmanage_all();
337             }
338
339             menu_frame_shutdown(reconfigure);
340             menu_shutdown(reconfigure);
341             mouse_shutdown(reconfigure);
342             keyboard_shutdown(reconfigure);
343             moveresize_shutdown(reconfigure);
344             dock_shutdown(reconfigure);
345             client_shutdown(reconfigure);
346             group_shutdown(reconfigure);
347             propwin_shutdown(reconfigure);
348             grab_shutdown(reconfigure);
349             screen_shutdown(reconfigure);
350             focus_shutdown(reconfigure);
351             sn_shutdown(reconfigure);
352             window_shutdown(reconfigure);
353             event_shutdown(reconfigure);
354             config_shutdown();
355             modkeys_shutdown(reconfigure);
356         } while (reconfigure);
357     }
358
359     XSync(ob_display, FALSE);
360
361     RrThemeFree(ob_rr_theme);
362     RrInstanceFree(ob_rr_inst);
363
364     session_shutdown(being_replaced);
365
366     XCloseDisplay(ob_display);
367
368     parse_paths_shutdown();
369
370     if (restart) {
371         if (restart_path != NULL) {
372             gint argcp;
373             gchar **argvp;
374             GError *err = NULL;
375
376             /* run other window manager */
377             if (g_shell_parse_argv(restart_path, &argcp, &argvp, &err)) {
378                 execvp(argvp[0], argvp);
379                 g_strfreev(argvp);
380             } else {
381                 g_message(
382                     _("Restart failed to execute new executable '%s': %s"),
383                     restart_path, err->message);
384                 g_error_free(err);
385             }
386         }
387
388         /* we remove the session arguments from argv, so put them back */
389         if (ob_sm_save_file != NULL || ob_sm_id != NULL) {
390             gchar **nargv;
391             gint i, l;
392
393             l = argc +
394                 (ob_sm_save_file != NULL ? 2 : 0) +
395                 (ob_sm_id != NULL ? 2 : 0);
396             nargv = g_new0(gchar*, l+1);
397             for (i = 0; i < argc; ++i)
398                 nargv[i] = argv[i];
399
400             if (ob_sm_save_file != NULL) {
401                 nargv[i++] = g_strdup("--sm-save-file");
402                 nargv[i++] = ob_sm_save_file;
403             }
404             if (ob_sm_id != NULL) {
405                 nargv[i++] = g_strdup("--sm-client-id");
406                 nargv[i++] = ob_sm_id;
407             }
408             g_assert(i == l);
409             argv = nargv;
410         }
411
412         /* we also remove some environment variables, so put them back */
413         if (ob_config_type)
414             setenv("OPENBOX_CONFIG_NAMESPACE", ob_config_type, 1);
415
416         /* re-run me */
417         execvp(argv[0], argv); /* try how we were run */
418         execlp(argv[0], program_name, (gchar*)NULL); /* last resort */
419     }
420
421     /* free stuff passed in from the command line or environment */
422     g_free(ob_sm_save_file);
423     g_free(ob_sm_id);
424     g_free(ob_config_type);
425     g_free(program_name);
426      
427     return exitcode;
428 }
429
430 static void signal_handler(gint signal, gpointer data)
431 {
432     switch (signal) {
433     case SIGUSR1:
434         ob_debug("Caught signal %d. Restarting.\n", signal);
435         ob_restart();
436         break;
437     case SIGUSR2:
438         ob_debug("Caught signal %d. Reconfiguring.\n", signal);
439         ob_reconfigure(); 
440         break;
441     case SIGCHLD:
442         /* reap children */
443         while (waitpid(-1, NULL, WNOHANG) > 0);
444         break;
445     default:
446         ob_debug("Caught signal %d. Exiting.\n", signal);
447         /* TERM and INT return a 0 code */
448         ob_exit(!(signal == SIGTERM || signal == SIGINT));
449     }
450 }
451
452 static void print_version()
453 {
454     g_print("Openbox %s\n", PACKAGE_VERSION);
455     g_print(_("Copyright (c)"));
456     g_print(" 2007        Mikael Magnusson\n");
457     g_print(_("Copyright (c)"));
458     g_print(" 2003-2007   Dana Jansens\n\n");
459     g_print("This program comes with ABSOLUTELY NO WARRANTY.\n");
460     g_print("This is free software, and you are welcome to redistribute it\n");
461     g_print("under certain conditions. See the file COPYING for details.\n\n");
462 }
463
464 static void print_help()
465 {
466     g_print(_("Syntax: openbox [options]\n"));
467     g_print(_("\nOptions:\n"));
468     g_print(_("  --help              Display this help and exit\n"));
469     g_print(_("  --version           Display the version and exit\n"));
470     g_print(_("  --replace           Replace the currently running window manager\n"));
471     g_print(_("  --sm-disable        Disable connection to the session manager\n"));
472     g_print(_("\nPassing messages to a running Openbox instance:\n"));
473     g_print(_("  --reconfigure       Reload Openbox's configuration\n"));
474     g_print(_("\nDebugging options:\n"));
475     g_print(_("  --sync              Run in synchronous mode\n"));
476     g_print(_("  --debug             Display debugging output\n"));
477     g_print(_("  --debug-focus       Display debugging output for focus handling\n"));
478     g_print(_("  --debug-xinerama    Split the display into fake xinerama screens\n"));
479     g_print(_("\nPlease report bugs at %s\n"), PACKAGE_BUGREPORT);
480 }
481
482 static void remove_args(gint *argc, gchar **argv, gint index, gint num)
483 {
484     gint i;
485
486     for (i = index; i < *argc - num; ++i)
487         argv[i] = argv[i+num];
488     for (; i < *argc; ++i)
489         argv[i] = NULL;
490     *argc -= num;
491 }
492
493 static void parse_env()
494 {
495     /* unset this so we don't pass it on unknowingly */
496     unsetenv("DESKTOP_STARTUP_ID");
497
498     if (getenv("OPENBOX_CONFIG_NAMESPACE"))
499         ob_config_type = g_strdup(getenv("OPENBOX_CONFIG_NAMESPACE"));
500 }
501
502 static void parse_args(gint *argc, gchar **argv)
503 {
504     gint i;
505
506     for (i = 1; i < *argc; ++i) {
507         if (!strcmp(argv[i], "--version")) {
508             print_version();
509             exit(0);
510         }
511         else if (!strcmp(argv[i], "--help")) {
512             print_help();
513             exit(0);
514         }
515         else if (!strcmp(argv[i], "--g-fatal-warnings")) {
516             g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL);
517         }
518         else if (!strcmp(argv[i], "--replace")) {
519             ob_replace_wm = TRUE;
520             remove_args(argc, argv, i, 1);
521             --i; /* this arg was removed so go back */
522         }
523         else if (!strcmp(argv[i], "--sync")) {
524             xsync = TRUE;
525         }
526         else if (!strcmp(argv[i], "--debug")) {
527             ob_debug_show_output(TRUE);
528             ob_debug_enable(OB_DEBUG_SM, TRUE);
529             ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
530         }
531         else if (!strcmp(argv[i], "--debug-focus")) {
532             ob_debug_show_output(TRUE);
533             ob_debug_enable(OB_DEBUG_SM, TRUE);
534             ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
535             ob_debug_enable(OB_DEBUG_FOCUS, TRUE);
536         }
537         else if (!strcmp(argv[i], "--debug-xinerama")) {
538             ob_debug_xinerama = TRUE;
539         }
540         else if (!strcmp(argv[i], "--reconfigure")) {
541             remote_control = 1;
542 /* don't make this do anything if it's not in --help ..
543         } else if (!strcmp(argv[i], "--restart")) {
544             remote_control = 2;
545 */
546         }
547         else if (!strcmp(argv[i], "--config-namespace")) {
548             if (i == *argc - 1) /* no args left */
549                 /* not translated cuz it's sekret */
550                 g_printerr("--config-namespace requires an argument\n");
551             else {
552                 ob_config_type = g_strdup(argv[i+1]);
553                 remove_args(argc, argv, i, 2);
554                 --i; /* this arg was removed so go back */
555                 ob_debug_type(OB_DEBUG_SM, "--config-namespace %s\n",
556                               ob_sm_save_file);
557             }
558         }
559         else if (!strcmp(argv[i], "--sm-save-file")) {
560             if (i == *argc - 1) /* no args left */
561                 /* not translated cuz it's sekret */
562                 g_printerr("--sm-save-file requires an argument\n");
563             else {
564                 ob_sm_save_file = g_strdup(argv[i+1]);
565                 remove_args(argc, argv, i, 2);
566                 --i; /* this arg was removed so go back */
567                 ob_debug_type(OB_DEBUG_SM, "--sm-save-file %s\n",
568                               ob_sm_save_file);
569             }
570         }
571         else if (!strcmp(argv[i], "--sm-client-id")) {
572             if (i == *argc - 1) /* no args left */
573                 /* not translated cuz it's sekret */
574                 g_printerr("--sm-client-id requires an argument\n");
575             else {
576                 ob_sm_id = g_strdup(argv[i+1]);
577                 remove_args(argc, argv, i, 2);
578                 --i; /* this arg was removed so go back */
579                 ob_debug_type(OB_DEBUG_SM, "--sm-client-id %s\n", ob_sm_id);
580             }
581         }
582         else if (!strcmp(argv[i], "--sm-disable")) {
583             ob_sm_use = FALSE;
584         }
585         else {
586             /* this is a memleak.. oh well.. heh */
587             gchar *err = g_strdup_printf
588                 (_("Invalid command line argument '%s'\n"), argv[i]);
589             ob_exit_with_error(err);
590         }
591     }
592 }
593
594 static Cursor load_cursor(const gchar *name, guint fontval)
595 {
596     Cursor c = None;
597
598 #if USE_XCURSOR
599     c = XcursorLibraryLoadCursor(ob_display, name);
600 #endif
601     if (c == None)
602         c = XCreateFontCursor(ob_display, fontval);
603     return c;
604 }
605
606 void ob_exit_with_error(const gchar *msg)
607 {
608     g_message(msg);
609     session_shutdown(TRUE);
610     exit(EXIT_FAILURE);
611 }
612
613 void ob_restart_other(const gchar *path)
614 {
615     restart_path = g_strdup(path);
616     ob_restart();
617 }
618
619 void ob_restart()
620 {
621     restart = TRUE;
622     ob_exit(0);
623 }
624
625 void ob_reconfigure()
626 {
627     reconfigure = TRUE;
628     ob_exit(0);
629 }
630
631 void ob_exit(gint code)
632 {
633     exitcode = code;
634     ob_main_loop_exit(ob_main_loop);
635 }
636
637 void ob_exit_replace()
638 {
639     exitcode = 0;
640     being_replaced = TRUE;
641     ob_main_loop_exit(ob_main_loop);
642 }
643
644 Cursor ob_cursor(ObCursor cursor)
645 {
646     g_assert(cursor < OB_NUM_CURSORS);
647     return cursors[cursor];
648 }
649
650 KeyCode ob_keycode(ObKey key)
651 {
652     g_assert(key < OB_NUM_KEYS);
653     return keys[key];
654 }
655
656 ObState ob_state()
657 {
658     return state;
659 }