1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
3 openbox.c for the Openbox window manager
4 Copyright (c) 2006 Mikael Magnusson
5 Copyright (c) 2003-2007 Dana Jansens
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.
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.
17 See the COPYING file for a copy of the GNU General Public License.
29 #include "action_filter.h"
30 #include "startupnotify.h"
32 #include "focus_cycle.h"
33 #include "focus_cycle_indicator.h"
34 #include "focus_cycle_popup.h"
35 #include "moveresize.h"
37 #include "framerender.h"
40 #include "menuframe.h"
47 #include "obrender/render.h"
48 #include "obrender/theme.h"
49 #include "obt/display.h"
50 #include "obt/xqueue.h"
51 #include "obt/signal.h"
53 #include "obt/keyboard.h"
68 #ifdef HAVE_SYS_STAT_H
69 # include <sys/stat.h>
70 # include <sys/types.h>
72 #ifdef HAVE_SYS_WAIT_H
73 # include <sys/types.h>
74 # include <sys/wait.h>
81 #include <X11/cursorfont.h>
83 #include <X11/Xcursor/Xcursor.h>
86 RrInstance *ob_rr_inst;
87 RrImageCache *ob_rr_icons;
89 GMainLoop *ob_main_loop;
91 gboolean ob_replace_wm = FALSE;
92 gboolean ob_sm_use = TRUE;
93 gchar *ob_sm_id = NULL;
94 gchar *ob_sm_save_file = NULL;
95 gboolean ob_sm_restore = TRUE;
96 gboolean ob_debug_xinerama = FALSE;
97 const gchar *ob_locale_msg = NULL;
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 gint exitcode = 0;
106 static guint remote_control = 0;
107 static gboolean being_replaced = FALSE;
108 static gchar *startup_cmd = NULL;
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 static void run_startup_cmd(void);
117 gint main(gint argc, gchar **argv)
123 ob_set_state(OB_STATE_STARTING);
127 /* initialize the locale */
128 if (!(ob_locale_msg = setlocale(LC_MESSAGES, "")))
129 g_message("Couldn't set messages locale category from environment.");
130 if (!setlocale(LC_ALL, ""))
131 g_message("Couldn't set locale from environment.");
132 bindtextdomain(PACKAGE_NAME, LOCALEDIR);
133 bind_textdomain_codeset(PACKAGE_NAME, "UTF-8");
134 textdomain(PACKAGE_NAME);
136 if (chdir(g_get_home_dir()) == -1)
137 g_message(_("Unable to change to home directory \"%s\": %s"),
138 g_get_home_dir(), g_strerror(errno));
140 /* parse the command line args, which can change the argv[0] */
141 parse_args(&argc, argv);
142 /* parse the environment variables */
145 program_name = g_path_get_basename(argv[0]);
146 g_set_prgname(program_name);
149 session_startup(argc, argv);
151 if (!obt_display_open(NULL))
152 ob_exit_with_error(_("Failed to open the display from the DISPLAY environment variable."));
154 if (remote_control) {
155 /* Send client message telling the OB process to:
156 * remote_control = 1 -> reconfigure
157 * remote_control = 2 -> restart */
158 OBT_PROP_MSG(ob_screen, obt_root(ob_screen),
159 OB_CONTROL, remote_control, 0, 0, 0, 0);
164 ob_main_loop = g_main_loop_new(NULL, FALSE);
166 /* set up signal handlers, they are called from the mainloop
167 in the main program's thread */
168 obt_signal_add_callback(SIGUSR1, signal_handler, NULL);
169 obt_signal_add_callback(SIGUSR2, signal_handler, NULL);
170 obt_signal_add_callback(SIGTERM, signal_handler, NULL);
171 obt_signal_add_callback(SIGINT, signal_handler, NULL);
172 obt_signal_add_callback(SIGHUP, signal_handler, NULL);
173 obt_signal_add_callback(SIGPIPE, signal_handler, NULL);
174 obt_signal_add_callback(SIGCHLD, signal_handler, NULL);
175 obt_signal_add_callback(SIGTTIN, signal_handler, NULL);
176 obt_signal_add_callback(SIGTTOU, signal_handler, NULL);
178 ob_screen = DefaultScreen(obt_display);
180 ob_rr_inst = RrInstanceNew(obt_display, ob_screen);
181 if (ob_rr_inst == NULL)
182 ob_exit_with_error(_("Failed to initialize the obrender library."));
183 /* Saving 3 resizes of an RrImage makes a lot of sense for icons, as there
184 are generally 3 icon sizes needed: the titlebar icon, the menu icon,
187 ob_rr_icons = RrImageCacheNew(3);
189 XSynchronize(obt_display, xsync);
191 /* check for locale support */
192 if (!XSupportsLocale())
193 g_message(_("X server does not support locale."));
194 if (!XSetLocaleModifiers(""))
195 g_message(_("Cannot set locale modifiers for the X server."));
197 /* set the DISPLAY environment variable for any lauched children, to the
198 display we're using, so they open in the right place. */
199 g_setenv("DISPLAY", DisplayString(obt_display), TRUE);
201 /* create available cursors */
202 cursors[OB_CURSOR_NONE] = None;
203 cursors[OB_CURSOR_POINTER] = load_cursor("left_ptr", XC_left_ptr);
204 cursors[OB_CURSOR_BUSYPOINTER] = load_cursor("left_ptr_watch",XC_left_ptr);
205 cursors[OB_CURSOR_BUSY] = load_cursor("watch", XC_watch);
206 cursors[OB_CURSOR_MOVE] = load_cursor("fleur", XC_fleur);
207 cursors[OB_CURSOR_NORTH] = load_cursor("top_side", XC_top_side);
208 cursors[OB_CURSOR_NORTHEAST] = load_cursor("top_right_corner",
209 XC_top_right_corner);
210 cursors[OB_CURSOR_EAST] = load_cursor("right_side", XC_right_side);
211 cursors[OB_CURSOR_SOUTHEAST] = load_cursor("bottom_right_corner",
212 XC_bottom_right_corner);
213 cursors[OB_CURSOR_SOUTH] = load_cursor("bottom_side", XC_bottom_side);
214 cursors[OB_CURSOR_SOUTHWEST] = load_cursor("bottom_left_corner",
215 XC_bottom_left_corner);
216 cursors[OB_CURSOR_WEST] = load_cursor("left_side", XC_left_side);
217 cursors[OB_CURSOR_NORTHWEST] = load_cursor("top_left_corner",
220 if (screen_annex()) { /* it will be ours! */
222 /* get a timestamp from after taking over as the WM. if we use the
223 old timestamp to set focus it can fail when replacing another WM. */
227 ObPrompt *xmlprompt = NULL;
229 if (reconfigure) obt_keyboard_reload();
234 /* register all the available actions and filters */
235 action_startup(reconfigure);
236 action_filter_startup(reconfigure);
238 /* set up the various file loaders */
239 config_load_config();
240 if (!config_load_keys())
241 g_message(_("Unable to find a valid \"%s\" file, using some simple defaults"), "keys");
242 if (!config_load_mouse())
243 g_message(_("Unable to find a valid \"%s\" file, using some simple defaults"), "mouse");
244 if (!config_load_windows())
245 g_message(_("No \"%s\" file found, not using any rules"),
249 /* load the theme specified in the rc file */
252 if ((theme = RrThemeNew(ob_rr_inst, config_theme, TRUE,
253 config_font_activewindow,
254 config_font_inactivewindow,
255 config_font_menutitle,
256 config_font_menuitem,
257 config_font_activeosd,
258 config_font_inactiveosd)))
260 RrThemeFree(ob_rr_theme);
263 if (ob_rr_theme == NULL)
264 ob_exit_with_error(_("Unable to load a theme."));
266 OBT_PROP_SETS(obt_root(ob_screen), OB_THEME,
273 /* update all existing windows for the new theme */
274 for (it = client_list; it; it = g_list_next(it)) {
275 ObClient *c = it->data;
276 frame_adjust_theme(c->frame);
279 event_startup(reconfigure);
280 /* focus_backup is used for stacking, so this needs to come before
281 anything that calls stacking_add */
282 sn_startup(reconfigure);
283 window_startup(reconfigure);
284 focus_startup(reconfigure);
285 focus_cycle_startup(reconfigure);
286 focus_cycle_indicator_startup(reconfigure);
287 focus_cycle_popup_startup(reconfigure);
288 screen_startup(reconfigure);
289 grab_startup(reconfigure);
290 group_startup(reconfigure);
291 ping_startup(reconfigure);
292 client_startup(reconfigure);
293 dock_startup(reconfigure);
294 moveresize_startup(reconfigure);
295 keyboard_startup(reconfigure);
296 mouse_startup(reconfigure);
297 menu_frame_startup(reconfigure);
298 menu_startup(reconfigure);
299 prompt_startup(reconfigure);
301 /* do this after everything is started so no events will get
309 /* get all the existing windows */
312 /* focus what was focused if a wm was already running */
313 if (OBT_PROP_GET32(obt_root(ob_screen),
314 NET_ACTIVE_WINDOW, WINDOW, &xid) &&
315 (w = window_find(xid)) && WINDOW_IS_CLIENT(w))
317 client_focus(WINDOW_AS_CLIENT(w));
322 /* redecorate all existing windows */
323 for (it = client_list; it; it = g_list_next(it)) {
324 ObClient *c = it->data;
326 /* the new config can change the window's decorations */
327 client_setup_decor_and_functions(c, FALSE);
328 /* redraw the frames */
329 frame_adjust_area(c->frame, TRUE, TRUE, FALSE);
330 /* the decor sizes may have changed, so the windows may
331 end up in new positions */
332 client_reconfigure(c, FALSE);
336 ob_set_state(OB_STATE_RUNNING);
338 if (!reconfigure && startup_cmd) run_startup_cmd();
342 /* look for parsing errors */
344 xmlErrorPtr e = xmlGetLastError();
348 m = g_strdup_printf(_("One or more XML syntax errors were found while parsing the Openbox configuration files. See stdout for more information. The last error seen was in file \"%s\" line %d, with message: %s"), e->file, e->line, e->message);
350 prompt_show_message(m, _("Openbox Syntax Error"), _("Close"));
356 g_main_loop_run(ob_main_loop);
357 ob_set_state(reconfigure ?
358 OB_STATE_RECONFIGURING : OB_STATE_EXITING);
361 prompt_unref(xmlprompt);
366 window_unmanage_all();
368 prompt_shutdown(reconfigure);
369 menu_shutdown(reconfigure);
370 menu_frame_shutdown(reconfigure);
371 mouse_shutdown(reconfigure);
372 keyboard_shutdown(reconfigure);
373 moveresize_shutdown(reconfigure);
374 dock_shutdown(reconfigure);
375 client_shutdown(reconfigure);
376 ping_shutdown(reconfigure);
377 group_shutdown(reconfigure);
378 grab_shutdown(reconfigure);
379 screen_shutdown(reconfigure);
380 focus_cycle_popup_shutdown(reconfigure);
381 focus_cycle_indicator_shutdown(reconfigure);
382 focus_cycle_shutdown(reconfigure);
383 focus_shutdown(reconfigure);
384 window_shutdown(reconfigure);
385 sn_shutdown(reconfigure);
386 event_shutdown(reconfigure);
388 action_filter_shutdown(reconfigure);
389 action_shutdown(reconfigure);
390 } while (reconfigure);
393 XSync(obt_display, FALSE);
395 RrThemeFree(ob_rr_theme);
396 RrImageCacheUnref(ob_rr_icons);
397 RrInstanceFree(ob_rr_inst);
399 session_shutdown(being_replaced);
406 if (restart_path != NULL) {
411 /* run other window manager */
412 if (g_shell_parse_argv(restart_path, &argcp, &argvp, &err)) {
413 execvp(argvp[0], argvp);
417 _("Restart failed to execute new executable \"%s\": %s"),
418 restart_path, err->message);
423 /* we remove the session arguments from argv, so put them back,
424 also don't restore the session on restart */
425 if (ob_sm_save_file != NULL || ob_sm_id != NULL) {
430 (ob_sm_save_file != NULL ? 2 : 0) +
431 (ob_sm_id != NULL ? 2 : 0);
432 nargv = g_new0(gchar*, l+1);
433 for (i = 0; i < argc; ++i)
436 if (ob_sm_save_file != NULL) {
437 nargv[i++] = g_strdup("--sm-save-file");
438 nargv[i++] = ob_sm_save_file;
440 if (ob_sm_id != NULL) {
441 nargv[i++] = g_strdup("--sm-client-id");
442 nargv[i++] = ob_sm_id;
444 nargv[i++] = g_strdup("--sm-no-load");
450 execvp(argv[0], argv); /* try how we were run */
451 execlp(argv[0], program_name, (gchar*)NULL); /* last resort */
454 /* free stuff passed in from the command line or environment */
455 g_free(ob_sm_save_file);
457 g_free(program_name);
467 static void signal_handler(gint signal, gpointer data)
471 ob_debug("Caught signal %d. Restarting.", signal);
475 ob_debug("Caught signal %d. Reconfiguring.", signal);
480 while (waitpid(-1, NULL, WNOHANG) > 0);
484 ob_debug("Caught signal %d. Ignoring.", signal);
487 ob_debug("Caught signal %d. Exiting.", signal);
488 /* TERM and INT return a 0 code */
489 ob_exit(!(signal == SIGTERM || signal == SIGINT));
493 static void print_version(void)
495 g_print("Openbox %s\n", PACKAGE_VERSION);
496 g_print(_("Copyright (c)"));
497 g_print(" 2008 Mikael Magnusson\n");
498 g_print(_("Copyright (c)"));
499 g_print(" 2003-2006 Dana Jansens\n\n");
500 g_print("This program comes with ABSOLUTELY NO WARRANTY.\n");
501 g_print("This is free software, and you are welcome to redistribute it\n");
502 g_print("under certain conditions. See the file COPYING for details.\n\n");
505 static void print_help(void)
507 g_print(_("Syntax: openbox [options]\n"));
508 g_print(_("\nOptions:\n"));
509 g_print(_(" --help Display this help and exit\n"));
510 g_print(_(" --version Display the version and exit\n"));
511 g_print(_(" --replace Replace the currently running window manager\n"));
512 g_print(_(" --sm-disable Disable connection to the session manager\n"));
513 g_print(_("\nPassing messages to a running Openbox instance:\n"));
514 g_print(_(" --reconfigure Reload Openbox's configuration\n"));
515 g_print(_(" --restart Restart Openbox\n"));
516 g_print(_(" --exit Exit Openbox\n"));
517 g_print(_("\nDebugging options:\n"));
518 g_print(_(" --sync Run in synchronous mode\n"));
519 g_print(_(" --startup CMD Run CMD after starting\n"));
520 g_print(_(" --debug Display debugging output\n"));
521 g_print(_(" --debug-focus Display debugging output for focus handling\n"));
522 g_print(_(" --debug-session Display debugging output for session management\n"));
523 g_print(_(" --debug-xinerama Split the display into fake xinerama screens\n"));
524 g_print(_("\nPlease report bugs at %s\n"), PACKAGE_BUGREPORT);
527 static void remove_args(gint *argc, gchar **argv, gint index, gint num)
531 for (i = index; i < *argc - num; ++i)
532 argv[i] = argv[i+num];
533 for (; i < *argc; ++i)
538 static void run_startup_cmd(void)
544 if (!g_shell_parse_argv(startup_cmd, NULL, &argv, &e)) {
545 g_message("Error parsing startup command: %s",
550 ok = g_spawn_async(NULL, argv, NULL,
551 G_SPAWN_SEARCH_PATH |
552 G_SPAWN_DO_NOT_REAP_CHILD,
553 NULL, NULL, NULL, &e);
554 if (!g_shell_parse_argv(startup_cmd, NULL, &argv, &e)) {
555 g_message("Error launching startup command: %s",
562 static void parse_env(void)
566 /* unset this so we don't pass it on unknowingly */
567 g_unsetenv("DESKTOP_STARTUP_ID");
569 /* this is how gnome-session passes in a session client id */
570 id = g_getenv("DESKTOP_AUTOSTART_ID");
572 g_unsetenv("DESKTOP_AUTOSTART_ID");
573 if (ob_sm_id) g_free(ob_sm_id);
574 ob_sm_id = g_strdup(id);
575 ob_debug_type(OB_DEBUG_SM,
576 "DESKTOP_AUTOSTART_ID %s supercedes --sm-client-id\n",
581 static void parse_args(gint *argc, gchar **argv)
585 for (i = 1; i < *argc; ++i) {
586 if (!strcmp(argv[i], "--version")) {
590 else if (!strcmp(argv[i], "--help")) {
594 else if (!strcmp(argv[i], "--g-fatal-warnings")) {
595 g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL);
597 else if (!strcmp(argv[i], "--replace")) {
598 ob_replace_wm = TRUE;
599 remove_args(argc, argv, i, 1);
600 --i; /* this arg was removed so go back */
602 else if (!strcmp(argv[i], "--sync")) {
605 else if (!strcmp(argv[i], "--startup")) {
606 if (i == *argc - 1) /* no args left */
607 g_printerr(_("%s requires an argument\n"), "--startup");
609 /* this will be in the current locale encoding, which is
611 startup_cmd = argv[i+1];
612 remove_args(argc, argv, i, 2);
613 --i; /* this arg was removed so go back */
614 ob_debug("--startup %s", startup_cmd);
617 else if (!strcmp(argv[i], "--debug")) {
618 ob_debug_enable(OB_DEBUG_NORMAL, TRUE);
619 ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
621 else if (!strcmp(argv[i], "--debug-focus")) {
622 ob_debug_enable(OB_DEBUG_FOCUS, TRUE);
624 else if (!strcmp(argv[i], "--debug-session")) {
625 ob_debug_enable(OB_DEBUG_SM, TRUE);
627 else if (!strcmp(argv[i], "--debug-xinerama")) {
628 ob_debug_xinerama = TRUE;
630 else if (!strcmp(argv[i], "--reconfigure")) {
633 else if (!strcmp(argv[i], "--restart")) {
636 else if (!strcmp(argv[i], "--exit")) {
639 else if (!strcmp(argv[i], "--sm-save-file")) {
640 if (i == *argc - 1) /* no args left */
641 /* not translated cuz it's sekret */
642 g_printerr("--sm-save-file requires an argument\n");
644 ob_sm_save_file = g_strdup(argv[i+1]);
645 remove_args(argc, argv, i, 2);
646 --i; /* this arg was removed so go back */
647 ob_debug_type(OB_DEBUG_SM, "--sm-save-file %s",
651 else if (!strcmp(argv[i], "--sm-client-id")) {
652 if (i == *argc - 1) /* no args left */
653 /* not translated cuz it's sekret */
654 g_printerr("--sm-client-id requires an argument\n");
656 ob_sm_id = g_strdup(argv[i+1]);
657 remove_args(argc, argv, i, 2);
658 --i; /* this arg was removed so go back */
659 ob_debug_type(OB_DEBUG_SM, "--sm-client-id %s", ob_sm_id);
662 else if (!strcmp(argv[i], "--sm-disable")) {
665 else if (!strcmp(argv[i], "--sm-no-load")) {
666 ob_sm_restore = FALSE;
667 remove_args(argc, argv, i, 1);
668 --i; /* this arg was removed so go back */
671 /* this is a memleak.. oh well.. heh */
672 gchar *err = g_strdup_printf
673 (_("Invalid command line argument \"%s\"\n"), argv[i]);
674 ob_exit_with_error(err);
679 static Cursor load_cursor(const gchar *name, guint fontval)
684 c = XcursorLibraryLoadCursor(obt_display, name);
687 c = XCreateFontCursor(obt_display, fontval);
691 void ob_exit_with_error(const gchar *msg)
693 g_message("%s", msg);
694 session_shutdown(TRUE);
698 void ob_restart_other(const gchar *path)
700 restart_path = g_strdup(path);
704 void ob_restart(void)
710 void ob_reconfigure(void)
716 void ob_exit(gint code)
719 g_main_loop_quit(ob_main_loop);
722 void ob_exit_replace(void)
725 being_replaced = TRUE;
726 g_main_loop_quit(ob_main_loop);
729 Cursor ob_cursor(ObCursor cursor)
731 g_assert(cursor < OB_NUM_CURSORS);
732 return cursors[cursor];
735 ObState ob_state(void)
740 void ob_set_state(ObState s)