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