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.
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"
48 #include "render/render.h"
49 #include "render/theme.h"
50 #include "obt/display.h"
52 #include "obt/keyboard.h"
53 #include "obt/parse.h"
67 #ifdef HAVE_SYS_STAT_H
68 # include <sys/stat.h>
69 # include <sys/types.h>
71 #ifdef HAVE_SYS_WAIT_H
72 # include <sys/types.h>
73 # include <sys/wait.h>
80 #include <X11/cursorfont.h>
82 #include <X11/Xcursor/Xcursor.h>
86 #include <X11/keysym.h>
88 RrInstance *ob_rr_inst;
89 RrImageCache *ob_rr_icons;
91 ObtMainLoop *ob_main_loop;
93 gboolean ob_replace_wm = FALSE;
94 gboolean ob_sm_use = TRUE;
95 gchar *ob_sm_id = NULL;
96 gchar *ob_sm_save_file = NULL;
97 gboolean ob_sm_restore = TRUE;
98 gboolean ob_debug_xinerama = FALSE;
100 static ObState state;
101 static gboolean xsync = FALSE;
102 static gboolean reconfigure = FALSE;
103 static gboolean restart = FALSE;
104 static gchar *restart_path = NULL;
105 static Cursor cursors[OB_NUM_CURSORS];
106 static KeyCode keys[OB_NUM_KEYS];
107 static gint exitcode = 0;
108 static guint remote_control = 0;
109 static gboolean being_replaced = FALSE;
110 static gchar *config_file = NULL;
112 static void signal_handler(gint signal, gpointer data);
113 static void remove_args(gint *argc, gchar **argv, gint index, gint num);
114 static void parse_env();
115 static void parse_args(gint *argc, gchar **argv);
116 static Cursor load_cursor(const gchar *name, guint fontval);
118 gint main(gint argc, gchar **argv)
122 ob_set_state(OB_STATE_STARTING);
126 /* initialize the locale */
127 if (!setlocale(LC_ALL, ""))
128 g_message("Couldn't set locale from environment.");
129 bindtextdomain(PACKAGE_NAME, LOCALEDIR);
130 bind_textdomain_codeset(PACKAGE_NAME, "UTF-8");
131 textdomain(PACKAGE_NAME);
133 if (chdir(g_get_home_dir()) == -1)
134 g_message(_("Unable to change to home directory \"%s\": %s"),
135 g_get_home_dir(), g_strerror(errno));
137 /* parse the command line args, which can change the argv[0] */
138 parse_args(&argc, argv);
139 /* parse the environment variables */
142 program_name = g_path_get_basename(argv[0]);
143 g_set_prgname(program_name);
146 session_startup(argc, argv);
148 if (!obt_display_open(NULL))
149 ob_exit_with_error(_("Failed to open the display from the DISPLAY environment variable."));
151 if (remote_control) {
152 /* Send client message telling the OB process to:
153 * remote_control = 1 -> reconfigure
154 * remote_control = 2 -> restart */
155 OBT_PROP_MSG(ob_screen, obt_root(ob_screen),
156 OB_CONTROL, remote_control, 0, 0, 0, 0);
161 ob_main_loop = obt_main_loop_new();
163 /* set up signal handler */
164 obt_main_loop_signal_add(ob_main_loop, SIGUSR1, signal_handler, NULL,NULL);
165 obt_main_loop_signal_add(ob_main_loop, SIGUSR2, signal_handler, NULL,NULL);
166 obt_main_loop_signal_add(ob_main_loop, SIGTERM, signal_handler, NULL,NULL);
167 obt_main_loop_signal_add(ob_main_loop, SIGINT, signal_handler, NULL,NULL);
168 obt_main_loop_signal_add(ob_main_loop, SIGHUP, signal_handler, NULL,NULL);
169 obt_main_loop_signal_add(ob_main_loop, SIGPIPE, signal_handler, NULL,NULL);
170 obt_main_loop_signal_add(ob_main_loop, SIGCHLD, signal_handler, NULL,NULL);
172 ob_screen = DefaultScreen(obt_display);
174 ob_rr_inst = RrInstanceNew(obt_display, ob_screen);
175 if (ob_rr_inst == NULL)
176 ob_exit_with_error(_("Failed to initialize the obrender library."));
177 /* Saving 3 resizes of an RrImage makes a lot of sense for icons, as there
178 are generally 3 icon sizes needed: the titlebar icon, the menu icon,
181 ob_rr_icons = RrImageCacheNew(3);
183 XSynchronize(obt_display, xsync);
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."));
191 /* set the DISPLAY environment variable for any lauched children, to the
192 display we're using, so they open in the right place. */
193 setenv("DISPLAY", DisplayString(obt_display), TRUE);
195 /* create available cursors */
196 cursors[OB_CURSOR_NONE] = None;
197 cursors[OB_CURSOR_POINTER] = load_cursor("left_ptr", XC_left_ptr);
198 cursors[OB_CURSOR_BUSYPOINTER] = load_cursor("left_ptr_watch",XC_left_ptr);
199 cursors[OB_CURSOR_BUSY] = load_cursor("watch", XC_watch);
200 cursors[OB_CURSOR_MOVE] = load_cursor("fleur", XC_fleur);
201 cursors[OB_CURSOR_NORTH] = load_cursor("top_side", XC_top_side);
202 cursors[OB_CURSOR_NORTHEAST] = load_cursor("top_right_corner",
203 XC_top_right_corner);
204 cursors[OB_CURSOR_EAST] = load_cursor("right_side", XC_right_side);
205 cursors[OB_CURSOR_SOUTHEAST] = load_cursor("bottom_right_corner",
206 XC_bottom_right_corner);
207 cursors[OB_CURSOR_SOUTH] = load_cursor("bottom_side", XC_bottom_side);
208 cursors[OB_CURSOR_SOUTHWEST] = load_cursor("bottom_left_corner",
209 XC_bottom_left_corner);
210 cursors[OB_CURSOR_WEST] = load_cursor("left_side", XC_left_side);
211 cursors[OB_CURSOR_NORTHWEST] = load_cursor("top_left_corner",
214 if (screen_annex()) { /* it will be ours! */
216 ObPrompt *xmlprompt = NULL;
218 if (reconfigure) obt_keyboard_reload();
220 /* get the keycodes for keys we use */
221 keys[OB_KEY_RETURN] = obt_keyboard_keysym_to_keycode(XK_Return);
222 keys[OB_KEY_ESCAPE] = obt_keyboard_keysym_to_keycode(XK_Escape);
223 keys[OB_KEY_LEFT] = obt_keyboard_keysym_to_keycode(XK_Left);
224 keys[OB_KEY_RIGHT] = obt_keyboard_keysym_to_keycode(XK_Right);
225 keys[OB_KEY_UP] = obt_keyboard_keysym_to_keycode(XK_Up);
226 keys[OB_KEY_DOWN] = obt_keyboard_keysym_to_keycode(XK_Down);
227 keys[OB_KEY_TAB] = obt_keyboard_keysym_to_keycode(XK_Tab);
228 keys[OB_KEY_SPACE] = obt_keyboard_keysym_to_keycode(XK_space);
233 /* startup the parsing so everything can register sections
235 i = obt_parse_instance_new();
237 /* register all the available actions */
238 actions_startup(reconfigure);
239 hooks_startup(reconfigure);
240 /* start up config which sets up with the parser */
243 /* parse/load user options */
245 obt_parse_load_file(i, config_file, "openbox_config")) ||
246 obt_parse_load_config_file(i, "openbox", "rc.xml",
249 obt_parse_tree_from_root(i);
253 g_message(_("Unable to find a valid config file, using some simple defaults"));
258 gchar *p = g_filename_to_utf8(config_file, -1,
261 OBT_PROP_SETS(obt_root(ob_screen), OB_CONFIG_FILE,
266 OBT_PROP_ERASE(obt_root(ob_screen), OB_CONFIG_FILE);
268 /* we're done with parsing now, kill it */
269 obt_parse_instance_unref(i);
272 /* load the theme specified in the rc file */
275 if ((theme = RrThemeNew(ob_rr_inst, config_theme, TRUE,
276 config_font_activewindow,
277 config_font_inactivewindow,
278 config_font_menutitle,
279 config_font_menuitem,
282 RrThemeFree(ob_rr_theme);
285 if (ob_rr_theme == NULL)
286 ob_exit_with_error(_("Unable to load a theme."));
288 OBT_PROP_SETS(obt_root(ob_screen),
289 OB_THEME, utf8, ob_rr_theme->name);
295 /* update all existing windows for the new theme */
296 for (it = client_list; it; it = g_list_next(it)) {
297 ObClient *c = it->data;
298 frame_adjust_theme(c->frame);
301 event_startup(reconfigure);
302 /* focus_backup is used for stacking, so this needs to come before
303 anything that calls stacking_add */
304 sn_startup(reconfigure);
305 window_startup(reconfigure);
306 focus_startup(reconfigure);
307 focus_cycle_startup(reconfigure);
308 focus_cycle_indicator_startup(reconfigure);
309 focus_cycle_popup_startup(reconfigure);
310 screen_startup(reconfigure);
311 grab_startup(reconfigure);
312 group_startup(reconfigure);
313 ping_startup(reconfigure);
314 client_startup(reconfigure);
315 dock_startup(reconfigure);
316 moveresize_startup(reconfigure);
317 keyboard_startup(reconfigure);
318 mouse_startup(reconfigure);
319 menu_frame_startup(reconfigure);
320 menu_startup(reconfigure);
321 edges_startup(reconfigure);
322 prompt_startup(reconfigure);
328 /* get all the existing windows */
332 /* focus what was focused if a wm was already running */
333 if (OBT_PROP_GET32(obt_root(ob_screen),
334 NET_ACTIVE_WINDOW, WINDOW, &xid) &&
335 (w = window_find(xid)) && WINDOW_IS_CLIENT(w))
337 client_focus(WINDOW_AS_CLIENT(w));
342 /* redecorate all existing windows */
343 for (it = client_list; it; it = g_list_next(it)) {
344 ObClient *c = it->data;
346 /* the new config can change the window's decorations */
347 client_setup_decor_and_functions(c, FALSE);
348 /* redraw the frames */
349 frame_adjust_area(c->frame, TRUE, TRUE, FALSE);
350 /* the decor sizes may have changed, so the windows may
351 end up in new positions */
352 client_reconfigure(c, FALSE);
358 ob_set_state(OB_STATE_RUNNING);
360 /* look for parsing errors */
362 xmlErrorPtr e = xmlGetLastError();
366 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);
368 prompt_show_message(m, _("Openbox Syntax Error"), _("Close"));
374 obt_main_loop_run(ob_main_loop);
375 ob_set_state(reconfigure ?
376 OB_STATE_RECONFIGURING : OB_STATE_EXITING);
379 prompt_unref(xmlprompt);
384 window_unmanage_all();
386 prompt_shutdown(reconfigure);
387 edges_shutdown(reconfigure);
388 menu_shutdown(reconfigure);
389 menu_frame_shutdown(reconfigure);
390 mouse_shutdown(reconfigure);
391 keyboard_shutdown(reconfigure);
392 moveresize_shutdown(reconfigure);
393 dock_shutdown(reconfigure);
394 client_shutdown(reconfigure);
395 ping_shutdown(reconfigure);
396 group_shutdown(reconfigure);
397 grab_shutdown(reconfigure);
398 screen_shutdown(reconfigure);
399 focus_cycle_popup_shutdown(reconfigure);
400 focus_cycle_indicator_shutdown(reconfigure);
401 focus_cycle_shutdown(reconfigure);
402 focus_shutdown(reconfigure);
403 window_shutdown(reconfigure);
404 sn_shutdown(reconfigure);
405 event_shutdown(reconfigure);
407 hooks_shutdown(reconfigure);
408 actions_shutdown(reconfigure);
409 } while (reconfigure);
412 XSync(obt_display, FALSE);
414 RrThemeFree(ob_rr_theme);
415 RrImageCacheUnref(ob_rr_icons);
416 RrInstanceFree(ob_rr_inst);
418 session_shutdown(being_replaced);
423 if (restart_path != NULL) {
428 /* run other window manager */
429 if (g_shell_parse_argv(restart_path, &argcp, &argvp, &err)) {
430 execvp(argvp[0], argvp);
434 _("Restart failed to execute new executable \"%s\": %s"),
435 restart_path, err->message);
440 /* we remove the session arguments from argv, so put them back,
441 also don't restore the session on restart */
442 if (ob_sm_save_file != NULL || ob_sm_id != NULL) {
447 (ob_sm_save_file != NULL ? 2 : 0) +
448 (ob_sm_id != NULL ? 2 : 0);
449 nargv = g_new0(gchar*, l+1);
450 for (i = 0; i < argc; ++i)
453 if (ob_sm_save_file != NULL) {
454 nargv[i++] = g_strdup("--sm-save-file");
455 nargv[i++] = ob_sm_save_file;
457 if (ob_sm_id != NULL) {
458 nargv[i++] = g_strdup("--sm-client-id");
459 nargv[i++] = ob_sm_id;
461 nargv[i++] = g_strdup("--sm-no-load");
467 execvp(argv[0], argv); /* try how we were run */
468 execlp(argv[0], program_name, (gchar*)NULL); /* last resort */
471 /* free stuff passed in from the command line or environment */
472 g_free(ob_sm_save_file);
474 g_free(program_name);
481 static void signal_handler(gint signal, gpointer data)
485 ob_debug("Caught signal %d. Restarting.", signal);
489 ob_debug("Caught signal %d. Reconfiguring.", signal);
494 while (waitpid(-1, NULL, WNOHANG) > 0);
497 ob_debug("Caught signal %d. Exiting.", signal);
498 /* TERM and INT return a 0 code */
499 ob_exit(!(signal == SIGTERM || signal == SIGINT));
503 static void print_version(void)
505 g_print("Openbox %s\n", PACKAGE_VERSION);
506 g_print(_("Copyright (c)"));
507 g_print(" 2008 Mikael Magnusson\n");
508 g_print(_("Copyright (c)"));
509 g_print(" 2003-2006 Dana Jansens\n\n");
510 g_print("This program comes with ABSOLUTELY NO WARRANTY.\n");
511 g_print("This is free software, and you are welcome to redistribute it\n");
512 g_print("under certain conditions. See the file COPYING for details.\n\n");
515 static void print_help(void)
517 g_print(_("Syntax: openbox [options]\n"));
518 g_print(_("\nOptions:\n"));
519 g_print(_(" --help Display this help and exit\n"));
520 g_print(_(" --version Display the version and exit\n"));
521 g_print(_(" --replace Replace the currently running window manager\n"));
522 /* TRANSLATORS: if you translate "FILE" here, make sure to keep the "Specify..."
523 aligned still, if you have to, make a new line with \n and 22 spaces. It's
524 fine to leave it as FILE though. */
525 g_print(_(" --config-file FILE Specify the path to the config file to use\n"));
526 g_print(_(" --sm-disable Disable connection to the session manager\n"));
527 g_print(_("\nPassing messages to a running Openbox instance:\n"));
528 g_print(_(" --reconfigure Reload Openbox's configuration\n"));
529 g_print(_(" --restart Restart Openbox\n"));
530 g_print(_(" --exit Exit Openbox\n"));
531 g_print(_("\nDebugging options:\n"));
532 g_print(_(" --sync Run in synchronous mode\n"));
533 g_print(_(" --debug Display debugging output\n"));
534 g_print(_(" --debug-focus Display debugging output for focus handling\n"));
535 g_print(_(" --debug-session Display debugging output for session management\n"));
536 g_print(_(" --debug-xinerama Split the display into fake xinerama screens\n"));
537 g_print(_("\nPlease report bugs at %s\n"), PACKAGE_BUGREPORT);
540 static void remove_args(gint *argc, gchar **argv, gint index, gint num)
544 for (i = index; i < *argc - num; ++i)
545 argv[i] = argv[i+num];
546 for (; i < *argc; ++i)
551 static void parse_env(void)
553 /* unset this so we don't pass it on unknowingly */
554 unsetenv("DESKTOP_STARTUP_ID");
557 static void parse_args(gint *argc, gchar **argv)
561 for (i = 1; i < *argc; ++i) {
562 if (!strcmp(argv[i], "--version")) {
566 else if (!strcmp(argv[i], "--help")) {
570 else if (!strcmp(argv[i], "--g-fatal-warnings")) {
571 g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL);
573 else if (!strcmp(argv[i], "--replace")) {
574 ob_replace_wm = TRUE;
575 remove_args(argc, argv, i, 1);
576 --i; /* this arg was removed so go back */
578 else if (!strcmp(argv[i], "--sync")) {
581 else if (!strcmp(argv[i], "--debug")) {
582 ob_debug_enable(OB_DEBUG_NORMAL, TRUE);
583 ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
585 else if (!strcmp(argv[i], "--debug-focus")) {
586 ob_debug_enable(OB_DEBUG_FOCUS, TRUE);
588 else if (!strcmp(argv[i], "--debug-session")) {
589 ob_debug_enable(OB_DEBUG_SM, TRUE);
591 else if (!strcmp(argv[i], "--debug-xinerama")) {
592 ob_debug_xinerama = TRUE;
594 else if (!strcmp(argv[i], "--reconfigure")) {
597 else if (!strcmp(argv[i], "--restart")) {
600 else if (!strcmp(argv[i], "--exit")) {
603 else if (!strcmp(argv[i], "--config-file")) {
604 if (i == *argc - 1) /* no args left */
605 g_printerr(_("--config-file requires an argument\n"));
607 /* this will be in the current locale encoding, which is
609 config_file = argv[i+1];
610 ++i; /* skip the argument */
611 ob_debug("--config-file %s", config_file);
614 else if (!strcmp(argv[i], "--sm-save-file")) {
615 if (i == *argc - 1) /* no args left */
616 /* not translated cuz it's sekret */
617 g_printerr("--sm-save-file requires an argument\n");
619 ob_sm_save_file = g_strdup(argv[i+1]);
620 remove_args(argc, argv, i, 2);
621 --i; /* this arg was removed so go back */
622 ob_debug_type(OB_DEBUG_SM, "--sm-save-file %s",
626 else if (!strcmp(argv[i], "--sm-client-id")) {
627 if (i == *argc - 1) /* no args left */
628 /* not translated cuz it's sekret */
629 g_printerr("--sm-client-id requires an argument\n");
631 ob_sm_id = g_strdup(argv[i+1]);
632 remove_args(argc, argv, i, 2);
633 --i; /* this arg was removed so go back */
634 ob_debug_type(OB_DEBUG_SM, "--sm-client-id %s", ob_sm_id);
637 else if (!strcmp(argv[i], "--sm-disable")) {
640 else if (!strcmp(argv[i], "--sm-no-load")) {
641 ob_sm_restore = FALSE;
642 remove_args(argc, argv, i, 1);
643 --i; /* this arg was removed so go back */
646 /* this is a memleak.. oh well.. heh */
647 gchar *err = g_strdup_printf
648 (_("Invalid command line argument \"%s\"\n"), argv[i]);
649 ob_exit_with_error(err);
654 static Cursor load_cursor(const gchar *name, guint fontval)
659 c = XcursorLibraryLoadCursor(obt_display, name);
662 c = XCreateFontCursor(obt_display, fontval);
666 void ob_exit_with_error(const gchar *msg)
669 session_shutdown(TRUE);
673 void ob_restart_other(const gchar *path)
675 restart_path = g_strdup(path);
679 void ob_restart(void)
685 void ob_reconfigure(void)
691 void ob_exit(gint code)
694 obt_main_loop_exit(ob_main_loop);
697 void ob_exit_replace(void)
700 being_replaced = TRUE;
701 obt_main_loop_exit(ob_main_loop);
704 Cursor ob_cursor(ObCursor cursor)
706 g_assert(cursor < OB_NUM_CURSORS);
707 return cursors[cursor];
710 KeyCode ob_keycode(ObKey key)
712 g_assert(key < OB_NUM_KEYS);
716 ObState ob_state(void)
721 void ob_set_state(ObState s)