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 "startupnotify.h"
31 #include "focus_cycle.h"
32 #include "focus_cycle_indicator.h"
33 #include "focus_cycle_popup.h"
34 #include "moveresize.h"
36 #include "framerender.h"
39 #include "menuframe.h"
46 #include "render/render.h"
47 #include "render/theme.h"
48 #include "obt/display.h"
50 #include "obt/keyboard.h"
51 #include "obt/parse.h"
65 #ifdef HAVE_SYS_STAT_H
66 # include <sys/stat.h>
67 # include <sys/types.h>
69 #ifdef HAVE_SYS_WAIT_H
70 # include <sys/types.h>
71 # include <sys/wait.h>
78 #include <X11/cursorfont.h>
80 #include <X11/Xcursor/Xcursor.h>
84 #include <X11/keysym.h>
86 RrInstance *ob_rr_inst;
87 RrImageCache *ob_rr_icons;
89 ObtMainLoop *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;
99 static gboolean xsync = FALSE;
100 static gboolean reconfigure = FALSE;
101 static gboolean restart = FALSE;
102 static gchar *restart_path = NULL;
103 static Cursor cursors[OB_NUM_CURSORS];
104 static KeyCode *keys[OB_NUM_KEYS];
105 static gint exitcode = 0;
106 static guint remote_control = 0;
107 static gboolean being_replaced = FALSE;
108 static gchar *config_file = 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);
116 gint main(gint argc, gchar **argv)
120 ob_set_state(OB_STATE_STARTING);
124 /* initialize the locale */
125 if (!setlocale(LC_ALL, ""))
126 g_message("Couldn't set locale from environment.");
127 bindtextdomain(PACKAGE_NAME, LOCALEDIR);
128 bind_textdomain_codeset(PACKAGE_NAME, "UTF-8");
129 textdomain(PACKAGE_NAME);
131 if (chdir(g_get_home_dir()) == -1)
132 g_message(_("Unable to change to home directory \"%s\": %s"),
133 g_get_home_dir(), g_strerror(errno));
135 /* parse the command line args, which can change the argv[0] */
136 parse_args(&argc, argv);
137 /* parse the environment variables */
140 program_name = g_path_get_basename(argv[0]);
141 g_set_prgname(program_name);
144 session_startup(argc, argv);
146 if (!obt_display_open(NULL))
147 ob_exit_with_error(_("Failed to open the display from the DISPLAY environment variable."));
149 if (remote_control) {
150 /* Send client message telling the OB process to:
151 * remote_control = 1 -> reconfigure
152 * remote_control = 2 -> restart */
153 OBT_PROP_MSG(ob_screen, obt_root(ob_screen),
154 OB_CONTROL, remote_control, 0, 0, 0, 0);
159 ob_main_loop = obt_main_loop_new();
161 /* set up signal handler */
162 obt_main_loop_signal_add(ob_main_loop, SIGUSR1, signal_handler, NULL,NULL);
163 obt_main_loop_signal_add(ob_main_loop, SIGUSR2, signal_handler, NULL,NULL);
164 obt_main_loop_signal_add(ob_main_loop, SIGTERM, signal_handler, NULL,NULL);
165 obt_main_loop_signal_add(ob_main_loop, SIGINT, signal_handler, NULL,NULL);
166 obt_main_loop_signal_add(ob_main_loop, SIGHUP, signal_handler, NULL,NULL);
167 obt_main_loop_signal_add(ob_main_loop, SIGPIPE, signal_handler, NULL,NULL);
168 obt_main_loop_signal_add(ob_main_loop, SIGCHLD, signal_handler, NULL,NULL);
170 ob_screen = DefaultScreen(obt_display);
172 ob_rr_inst = RrInstanceNew(obt_display, ob_screen);
173 if (ob_rr_inst == NULL)
174 ob_exit_with_error(_("Failed to initialize the obrender library."));
175 /* Saving 3 resizes of an RrImage makes a lot of sense for icons, as there
176 are generally 3 icon sizes needed: the titlebar icon, the menu icon,
179 ob_rr_icons = RrImageCacheNew(3);
181 XSynchronize(obt_display, xsync);
183 /* check for locale support */
184 if (!XSupportsLocale())
185 g_message(_("X server does not support locale."));
186 if (!XSetLocaleModifiers(""))
187 g_message(_("Cannot set locale modifiers for the X server."));
189 /* set the DISPLAY environment variable for any lauched children, to the
190 display we're using, so they open in the right place. */
191 setenv("DISPLAY", DisplayString(obt_display), TRUE);
193 /* create available cursors */
194 cursors[OB_CURSOR_NONE] = None;
195 cursors[OB_CURSOR_POINTER] = load_cursor("left_ptr", XC_left_ptr);
196 cursors[OB_CURSOR_BUSYPOINTER] = load_cursor("left_ptr_watch",XC_left_ptr);
197 cursors[OB_CURSOR_BUSY] = load_cursor("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",
212 if (screen_annex()) { /* it will be ours! */
214 ObPrompt *xmlprompt = NULL;
216 if (reconfigure) obt_keyboard_reload();
218 /* get the keycodes for keys we use */
219 keys[OB_KEY_RETURN] = obt_keyboard_keysym_to_keycode(XK_Return);
220 keys[OB_KEY_ESCAPE] = obt_keyboard_keysym_to_keycode(XK_Escape);
221 keys[OB_KEY_LEFT] = obt_keyboard_keysym_to_keycode(XK_Left);
222 keys[OB_KEY_RIGHT] = obt_keyboard_keysym_to_keycode(XK_Right);
223 keys[OB_KEY_UP] = obt_keyboard_keysym_to_keycode(XK_Up);
224 keys[OB_KEY_DOWN] = obt_keyboard_keysym_to_keycode(XK_Down);
225 keys[OB_KEY_TAB] = obt_keyboard_keysym_to_keycode(XK_Tab);
226 keys[OB_KEY_SPACE] = obt_keyboard_keysym_to_keycode(XK_space);
231 /* startup the parsing so everything can register sections
233 i = obt_parse_instance_new();
235 /* register all the available actions */
236 actions_startup(reconfigure);
237 /* start up config which sets up with the parser */
240 /* parse/load user options */
242 obt_parse_load_file(i, config_file, "openbox_config")) ||
243 obt_parse_load_config_file(i, "openbox", "rc.xml",
246 obt_parse_tree_from_root(i);
250 g_message(_("Unable to find a valid config file, using some simple defaults"));
255 gchar *p = g_filename_to_utf8(config_file, -1,
258 OBT_PROP_SETS(obt_root(ob_screen), OB_CONFIG_FILE,
263 OBT_PROP_ERASE(obt_root(ob_screen), OB_CONFIG_FILE);
265 /* we're done with parsing now, kill it */
266 obt_parse_instance_unref(i);
269 /* load the theme specified in the rc file */
272 if ((theme = RrThemeNew(ob_rr_inst, config_theme, TRUE,
273 config_font_activewindow,
274 config_font_inactivewindow,
275 config_font_menutitle,
276 config_font_menuitem,
279 RrThemeFree(ob_rr_theme);
282 if (ob_rr_theme == NULL)
283 ob_exit_with_error(_("Unable to load a theme."));
285 OBT_PROP_SETS(obt_root(ob_screen),
286 OB_THEME, utf8, ob_rr_theme->name);
292 /* update all existing windows for the new theme */
293 for (it = client_list; it; it = g_list_next(it)) {
294 ObClient *c = it->data;
295 frame_adjust_theme(c->frame);
298 event_startup(reconfigure);
299 /* focus_backup is used for stacking, so this needs to come before
300 anything that calls stacking_add */
301 sn_startup(reconfigure);
302 window_startup(reconfigure);
303 focus_startup(reconfigure);
304 focus_cycle_startup(reconfigure);
305 focus_cycle_indicator_startup(reconfigure);
306 focus_cycle_popup_startup(reconfigure);
307 screen_startup(reconfigure);
308 grab_startup(reconfigure);
309 group_startup(reconfigure);
310 ping_startup(reconfigure);
311 client_startup(reconfigure);
312 dock_startup(reconfigure);
313 moveresize_startup(reconfigure);
314 keyboard_startup(reconfigure);
315 mouse_startup(reconfigure);
316 menu_frame_startup(reconfigure);
317 menu_startup(reconfigure);
318 prompt_startup(reconfigure);
324 /* get all the existing windows */
328 /* focus what was focused if a wm was already running */
329 if (OBT_PROP_GET32(obt_root(ob_screen),
330 NET_ACTIVE_WINDOW, WINDOW, &xid) &&
331 (w = window_find(xid)) && WINDOW_IS_CLIENT(w))
333 client_focus(WINDOW_AS_CLIENT(w));
338 /* redecorate all existing windows */
339 for (it = client_list; it; it = g_list_next(it)) {
340 ObClient *c = it->data;
342 /* the new config can change the window's decorations */
343 client_setup_decor_and_functions(c, FALSE);
344 /* redraw the frames */
345 frame_adjust_area(c->frame, TRUE, TRUE, FALSE);
346 /* the decor sizes may have changed, so the windows may
347 end up in new positions */
348 client_reconfigure(c, FALSE);
354 ob_set_state(OB_STATE_RUNNING);
356 /* look for parsing errors */
358 xmlErrorPtr e = xmlGetLastError();
362 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);
364 prompt_show_message(m, _("Openbox Syntax Error"), _("Close"));
370 obt_main_loop_run(ob_main_loop);
371 ob_set_state(reconfigure ?
372 OB_STATE_RECONFIGURING : OB_STATE_EXITING);
375 prompt_unref(xmlprompt);
380 window_unmanage_all();
382 prompt_shutdown(reconfigure);
383 menu_shutdown(reconfigure);
384 menu_frame_shutdown(reconfigure);
385 mouse_shutdown(reconfigure);
386 keyboard_shutdown(reconfigure);
387 moveresize_shutdown(reconfigure);
388 dock_shutdown(reconfigure);
389 client_shutdown(reconfigure);
390 ping_shutdown(reconfigure);
391 group_shutdown(reconfigure);
392 grab_shutdown(reconfigure);
393 screen_shutdown(reconfigure);
394 focus_cycle_popup_shutdown(reconfigure);
395 focus_cycle_indicator_shutdown(reconfigure);
396 focus_cycle_shutdown(reconfigure);
397 focus_shutdown(reconfigure);
398 window_shutdown(reconfigure);
399 sn_shutdown(reconfigure);
400 event_shutdown(reconfigure);
402 actions_shutdown(reconfigure);
404 /* Free the key codes for built in keys */
405 g_free(keys[OB_KEY_RETURN]);
406 g_free(keys[OB_KEY_ESCAPE]);
407 g_free(keys[OB_KEY_LEFT]);
408 g_free(keys[OB_KEY_RIGHT]);
409 g_free(keys[OB_KEY_UP]);
410 g_free(keys[OB_KEY_DOWN]);
411 g_free(keys[OB_KEY_TAB]);
412 g_free(keys[OB_KEY_SPACE]);
413 } while (reconfigure);
416 XSync(obt_display, FALSE);
418 RrThemeFree(ob_rr_theme);
419 RrImageCacheUnref(ob_rr_icons);
420 RrInstanceFree(ob_rr_inst);
422 session_shutdown(being_replaced);
428 if (restart_path != NULL) {
433 /* run other window manager */
434 if (g_shell_parse_argv(restart_path, &argcp, &argvp, &err)) {
435 execvp(argvp[0], argvp);
439 _("Restart failed to execute new executable \"%s\": %s"),
440 restart_path, err->message);
445 /* we remove the session arguments from argv, so put them back,
446 also don't restore the session on restart */
447 if (ob_sm_save_file != NULL || ob_sm_id != NULL) {
452 (ob_sm_save_file != NULL ? 2 : 0) +
453 (ob_sm_id != NULL ? 2 : 0);
454 nargv = g_new0(gchar*, l+1);
455 for (i = 0; i < argc; ++i)
458 if (ob_sm_save_file != NULL) {
459 nargv[i++] = g_strdup("--sm-save-file");
460 nargv[i++] = ob_sm_save_file;
462 if (ob_sm_id != NULL) {
463 nargv[i++] = g_strdup("--sm-client-id");
464 nargv[i++] = ob_sm_id;
466 nargv[i++] = g_strdup("--sm-no-load");
472 execvp(argv[0], argv); /* try how we were run */
473 execlp(argv[0], program_name, (gchar*)NULL); /* last resort */
476 /* free stuff passed in from the command line or environment */
477 g_free(ob_sm_save_file);
479 g_free(program_name);
487 static void signal_handler(gint signal, gpointer data)
491 ob_debug("Caught signal %d. Restarting.", signal);
495 ob_debug("Caught signal %d. Reconfiguring.", signal);
500 while (waitpid(-1, NULL, WNOHANG) > 0);
503 ob_debug("Caught signal %d. Exiting.", signal);
504 /* TERM and INT return a 0 code */
505 ob_exit(!(signal == SIGTERM || signal == SIGINT));
509 static void print_version(void)
511 g_print("Openbox %s\n", PACKAGE_VERSION);
512 g_print(_("Copyright (c)"));
513 g_print(" 2008 Mikael Magnusson\n");
514 g_print(_("Copyright (c)"));
515 g_print(" 2003-2006 Dana Jansens\n\n");
516 g_print("This program comes with ABSOLUTELY NO WARRANTY.\n");
517 g_print("This is free software, and you are welcome to redistribute it\n");
518 g_print("under certain conditions. See the file COPYING for details.\n\n");
521 static void print_help(void)
523 g_print(_("Syntax: openbox [options]\n"));
524 g_print(_("\nOptions:\n"));
525 g_print(_(" --help Display this help and exit\n"));
526 g_print(_(" --version Display the version and exit\n"));
527 g_print(_(" --replace Replace the currently running window manager\n"));
528 /* TRANSLATORS: if you translate "FILE" here, make sure to keep the "Specify..."
529 aligned still, if you have to, make a new line with \n and 22 spaces. It's
530 fine to leave it as FILE though. */
531 g_print(_(" --config-file FILE Specify the path to the config file to use\n"));
532 g_print(_(" --sm-disable Disable connection to the session manager\n"));
533 g_print(_("\nPassing messages to a running Openbox instance:\n"));
534 g_print(_(" --reconfigure Reload Openbox's configuration\n"));
535 g_print(_(" --restart Restart Openbox\n"));
536 g_print(_(" --exit Exit Openbox\n"));
537 g_print(_("\nDebugging options:\n"));
538 g_print(_(" --sync Run in synchronous mode\n"));
539 g_print(_(" --debug Display debugging output\n"));
540 g_print(_(" --debug-focus Display debugging output for focus handling\n"));
541 g_print(_(" --debug-session Display debugging output for session management\n"));
542 g_print(_(" --debug-xinerama Split the display into fake xinerama screens\n"));
543 g_print(_("\nPlease report bugs at %s\n"), PACKAGE_BUGREPORT);
546 static void remove_args(gint *argc, gchar **argv, gint index, gint num)
550 for (i = index; i < *argc - num; ++i)
551 argv[i] = argv[i+num];
552 for (; i < *argc; ++i)
557 static void parse_env(void)
561 /* unset this so we don't pass it on unknowingly */
562 unsetenv("DESKTOP_STARTUP_ID");
564 /* this is how gnome-session passes in a session client id */
565 id = g_getenv("DESKTOP_AUTOSTART_ID");
567 unsetenv("DESKTOP_AUTOSTART_ID");
568 if (ob_sm_id) g_free(ob_sm_id);
569 ob_sm_id = g_strdup(id);
570 ob_debug_type(OB_DEBUG_SM,
571 "DESKTOP_AUTOSTART_ID %s supercedes --sm-client-id\n",
576 static void parse_args(gint *argc, gchar **argv)
580 for (i = 1; i < *argc; ++i) {
581 if (!strcmp(argv[i], "--version")) {
585 else if (!strcmp(argv[i], "--help")) {
589 else if (!strcmp(argv[i], "--g-fatal-warnings")) {
590 g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL);
592 else if (!strcmp(argv[i], "--replace")) {
593 ob_replace_wm = TRUE;
594 remove_args(argc, argv, i, 1);
595 --i; /* this arg was removed so go back */
597 else if (!strcmp(argv[i], "--sync")) {
600 else if (!strcmp(argv[i], "--debug")) {
601 ob_debug_enable(OB_DEBUG_NORMAL, TRUE);
602 ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
604 else if (!strcmp(argv[i], "--debug-focus")) {
605 ob_debug_enable(OB_DEBUG_FOCUS, TRUE);
607 else if (!strcmp(argv[i], "--debug-session")) {
608 ob_debug_enable(OB_DEBUG_SM, TRUE);
610 else if (!strcmp(argv[i], "--debug-xinerama")) {
611 ob_debug_xinerama = TRUE;
613 else if (!strcmp(argv[i], "--reconfigure")) {
616 else if (!strcmp(argv[i], "--restart")) {
619 else if (!strcmp(argv[i], "--exit")) {
622 else if (!strcmp(argv[i], "--config-file")) {
623 if (i == *argc - 1) /* no args left */
624 g_printerr(_("--config-file requires an argument\n"));
626 /* this will be in the current locale encoding, which is
628 config_file = argv[i+1];
629 ++i; /* skip the argument */
630 ob_debug("--config-file %s", config_file);
633 else if (!strcmp(argv[i], "--sm-save-file")) {
634 if (i == *argc - 1) /* no args left */
635 /* not translated cuz it's sekret */
636 g_printerr("--sm-save-file requires an argument\n");
638 ob_sm_save_file = g_strdup(argv[i+1]);
639 remove_args(argc, argv, i, 2);
640 --i; /* this arg was removed so go back */
641 ob_debug_type(OB_DEBUG_SM, "--sm-save-file %s",
645 else if (!strcmp(argv[i], "--sm-client-id")) {
646 if (i == *argc - 1) /* no args left */
647 /* not translated cuz it's sekret */
648 g_printerr("--sm-client-id requires an argument\n");
650 ob_sm_id = g_strdup(argv[i+1]);
651 remove_args(argc, argv, i, 2);
652 --i; /* this arg was removed so go back */
653 ob_debug_type(OB_DEBUG_SM, "--sm-client-id %s", ob_sm_id);
656 else if (!strcmp(argv[i], "--sm-disable")) {
659 else if (!strcmp(argv[i], "--sm-no-load")) {
660 ob_sm_restore = FALSE;
661 remove_args(argc, argv, i, 1);
662 --i; /* this arg was removed so go back */
665 /* this is a memleak.. oh well.. heh */
666 gchar *err = g_strdup_printf
667 (_("Invalid command line argument \"%s\"\n"), argv[i]);
668 ob_exit_with_error(err);
673 static Cursor load_cursor(const gchar *name, guint fontval)
678 c = XcursorLibraryLoadCursor(obt_display, name);
681 c = XCreateFontCursor(obt_display, fontval);
685 void ob_exit_with_error(const gchar *msg)
687 g_message("%s", msg);
688 session_shutdown(TRUE);
692 void ob_restart_other(const gchar *path)
694 restart_path = g_strdup(path);
698 void ob_restart(void)
704 void ob_reconfigure(void)
710 void ob_exit(gint code)
713 obt_main_loop_exit(ob_main_loop);
716 void ob_exit_replace(void)
719 being_replaced = TRUE;
720 obt_main_loop_exit(ob_main_loop);
723 Cursor ob_cursor(ObCursor cursor)
725 g_assert(cursor < OB_NUM_CURSORS);
726 return cursors[cursor];
729 gboolean ob_keycode_match(KeyCode code, ObKey key)
733 g_assert(key < OB_NUM_KEYS);
734 for (k = keys[key]; *k; ++k)
735 if (*k == code) return TRUE;
739 ObState ob_state(void)
744 void ob_set_state(ObState s)