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 "obrender/render.h"
47 #include "obrender/theme.h"
48 #include "obt/display.h"
50 #include "obt/keyboard.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);
169 obt_main_loop_signal_add(ob_main_loop, SIGTTIN, signal_handler, NULL,NULL);
170 obt_main_loop_signal_add(ob_main_loop, SIGTTOU, 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);
229 keys[OB_KEY_HOME] = obt_keyboard_keysym_to_keycode(XK_Home);
230 keys[OB_KEY_END] = obt_keyboard_keysym_to_keycode(XK_End);
235 /* startup the parsing so everything can register sections
237 i = obt_xml_instance_new();
239 /* register all the available actions */
240 actions_startup(reconfigure);
241 /* start up config which sets up with the parser */
244 /* parse/load user options */
246 obt_xml_load_file(i, config_file, "openbox_config")) ||
247 obt_xml_load_config_file(i, "openbox", "rc.xml",
250 obt_xml_tree_from_root(i);
254 g_message(_("Unable to find a valid config file, using some simple defaults"));
259 gchar *p = g_filename_to_utf8(config_file, -1,
262 OBT_PROP_SETS(obt_root(ob_screen), OB_CONFIG_FILE,
267 OBT_PROP_ERASE(obt_root(ob_screen), OB_CONFIG_FILE);
269 /* we're done with parsing now, kill it */
270 obt_xml_instance_unref(i);
273 /* load the theme specified in the rc file */
276 if ((theme = RrThemeNew(ob_rr_inst, config_theme, TRUE,
277 config_font_activewindow,
278 config_font_inactivewindow,
279 config_font_menutitle,
280 config_font_menuitem,
281 config_font_activeosd,
282 config_font_inactiveosd)))
284 RrThemeFree(ob_rr_theme);
287 if (ob_rr_theme == NULL)
288 ob_exit_with_error(_("Unable to load a theme."));
290 OBT_PROP_SETS(obt_root(ob_screen),
291 OB_THEME, utf8, ob_rr_theme->name);
297 /* update all existing windows for the new theme */
298 for (it = client_list; it; it = g_list_next(it)) {
299 ObClient *c = it->data;
300 frame_adjust_theme(c->frame);
303 event_startup(reconfigure);
304 /* focus_backup is used for stacking, so this needs to come before
305 anything that calls stacking_add */
306 sn_startup(reconfigure);
307 window_startup(reconfigure);
308 focus_startup(reconfigure);
309 focus_cycle_startup(reconfigure);
310 focus_cycle_indicator_startup(reconfigure);
311 focus_cycle_popup_startup(reconfigure);
312 screen_startup(reconfigure);
313 grab_startup(reconfigure);
314 group_startup(reconfigure);
315 ping_startup(reconfigure);
316 client_startup(reconfigure);
317 dock_startup(reconfigure);
318 moveresize_startup(reconfigure);
319 keyboard_startup(reconfigure);
320 mouse_startup(reconfigure);
321 menu_frame_startup(reconfigure);
322 menu_startup(reconfigure);
323 prompt_startup(reconfigure);
329 /* get all the existing windows */
333 /* focus what was focused if a wm was already running */
334 if (OBT_PROP_GET32(obt_root(ob_screen),
335 NET_ACTIVE_WINDOW, WINDOW, &xid) &&
336 (w = window_find(xid)) && WINDOW_IS_CLIENT(w))
338 client_focus(WINDOW_AS_CLIENT(w));
343 /* redecorate all existing windows */
344 for (it = client_list; it; it = g_list_next(it)) {
345 ObClient *c = it->data;
347 /* the new config can change the window's decorations */
348 client_setup_decor_and_functions(c, FALSE);
349 /* redraw the frames */
350 frame_adjust_area(c->frame, TRUE, TRUE, FALSE);
351 /* the decor sizes may have changed, so the windows may
352 end up in new positions */
353 client_reconfigure(c, FALSE);
359 ob_set_state(OB_STATE_RUNNING);
361 /* look for parsing errors */
363 xmlErrorPtr e = xmlGetLastError();
367 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);
369 prompt_show_message(m, _("Openbox Syntax Error"), _("Close"));
375 obt_main_loop_run(ob_main_loop);
376 ob_set_state(reconfigure ?
377 OB_STATE_RECONFIGURING : OB_STATE_EXITING);
380 prompt_unref(xmlprompt);
385 window_unmanage_all();
387 prompt_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 actions_shutdown(reconfigure);
409 /* Free the key codes for built in keys */
410 g_free(keys[OB_KEY_RETURN]);
411 g_free(keys[OB_KEY_ESCAPE]);
412 g_free(keys[OB_KEY_LEFT]);
413 g_free(keys[OB_KEY_RIGHT]);
414 g_free(keys[OB_KEY_UP]);
415 g_free(keys[OB_KEY_DOWN]);
416 g_free(keys[OB_KEY_TAB]);
417 g_free(keys[OB_KEY_SPACE]);
418 g_free(keys[OB_KEY_HOME]);
419 g_free(keys[OB_KEY_END]);
420 } while (reconfigure);
423 XSync(obt_display, FALSE);
425 RrThemeFree(ob_rr_theme);
426 RrImageCacheUnref(ob_rr_icons);
427 RrInstanceFree(ob_rr_inst);
429 session_shutdown(being_replaced);
435 if (restart_path != NULL) {
440 /* run other window manager */
441 if (g_shell_parse_argv(restart_path, &argcp, &argvp, &err)) {
442 execvp(argvp[0], argvp);
446 _("Restart failed to execute new executable \"%s\": %s"),
447 restart_path, err->message);
452 /* we remove the session arguments from argv, so put them back,
453 also don't restore the session on restart */
454 if (ob_sm_save_file != NULL || ob_sm_id != NULL) {
459 (ob_sm_save_file != NULL ? 2 : 0) +
460 (ob_sm_id != NULL ? 2 : 0);
461 nargv = g_new0(gchar*, l+1);
462 for (i = 0; i < argc; ++i)
465 if (ob_sm_save_file != NULL) {
466 nargv[i++] = g_strdup("--sm-save-file");
467 nargv[i++] = ob_sm_save_file;
469 if (ob_sm_id != NULL) {
470 nargv[i++] = g_strdup("--sm-client-id");
471 nargv[i++] = ob_sm_id;
473 nargv[i++] = g_strdup("--sm-no-load");
479 execvp(argv[0], argv); /* try how we were run */
480 execlp(argv[0], program_name, (gchar*)NULL); /* last resort */
483 /* free stuff passed in from the command line or environment */
484 g_free(ob_sm_save_file);
486 g_free(program_name);
494 static void signal_handler(gint signal, gpointer data)
498 ob_debug("Caught signal %d. Restarting.", signal);
502 ob_debug("Caught signal %d. Reconfiguring.", signal);
507 while (waitpid(-1, NULL, WNOHANG) > 0);
511 ob_debug("Caught signal %d. Ignoring.", signal);
514 ob_debug("Caught signal %d. Exiting.", signal);
515 /* TERM and INT return a 0 code */
516 ob_exit(!(signal == SIGTERM || signal == SIGINT));
520 static void print_version(void)
522 g_print("Openbox %s\n", PACKAGE_VERSION);
523 g_print(_("Copyright (c)"));
524 g_print(" 2008 Mikael Magnusson\n");
525 g_print(_("Copyright (c)"));
526 g_print(" 2003-2006 Dana Jansens\n\n");
527 g_print("This program comes with ABSOLUTELY NO WARRANTY.\n");
528 g_print("This is free software, and you are welcome to redistribute it\n");
529 g_print("under certain conditions. See the file COPYING for details.\n\n");
532 static void print_help(void)
534 g_print(_("Syntax: openbox [options]\n"));
535 g_print(_("\nOptions:\n"));
536 g_print(_(" --help Display this help and exit\n"));
537 g_print(_(" --version Display the version and exit\n"));
538 g_print(_(" --replace Replace the currently running window manager\n"));
539 /* TRANSLATORS: if you translate "FILE" here, make sure to keep the "Specify..."
540 aligned still, if you have to, make a new line with \n and 22 spaces. It's
541 fine to leave it as FILE though. */
542 g_print(_(" --config-file FILE Specify the path to the config file to use\n"));
543 g_print(_(" --sm-disable Disable connection to the session manager\n"));
544 g_print(_("\nPassing messages to a running Openbox instance:\n"));
545 g_print(_(" --reconfigure Reload Openbox's configuration\n"));
546 g_print(_(" --restart Restart Openbox\n"));
547 g_print(_(" --exit Exit Openbox\n"));
548 g_print(_("\nDebugging options:\n"));
549 g_print(_(" --sync Run in synchronous mode\n"));
550 g_print(_(" --debug Display debugging output\n"));
551 g_print(_(" --debug-focus Display debugging output for focus handling\n"));
552 g_print(_(" --debug-session Display debugging output for session management\n"));
553 g_print(_(" --debug-xinerama Split the display into fake xinerama screens\n"));
554 g_print(_("\nPlease report bugs at %s\n"), PACKAGE_BUGREPORT);
557 static void remove_args(gint *argc, gchar **argv, gint index, gint num)
561 for (i = index; i < *argc - num; ++i)
562 argv[i] = argv[i+num];
563 for (; i < *argc; ++i)
568 static void parse_env(void)
572 /* unset this so we don't pass it on unknowingly */
573 unsetenv("DESKTOP_STARTUP_ID");
575 /* this is how gnome-session passes in a session client id */
576 id = g_getenv("DESKTOP_AUTOSTART_ID");
578 unsetenv("DESKTOP_AUTOSTART_ID");
579 if (ob_sm_id) g_free(ob_sm_id);
580 ob_sm_id = g_strdup(id);
581 ob_debug_type(OB_DEBUG_SM,
582 "DESKTOP_AUTOSTART_ID %s supercedes --sm-client-id\n",
587 static void parse_args(gint *argc, gchar **argv)
591 for (i = 1; i < *argc; ++i) {
592 if (!strcmp(argv[i], "--version")) {
596 else if (!strcmp(argv[i], "--help")) {
600 else if (!strcmp(argv[i], "--g-fatal-warnings")) {
601 g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL);
603 else if (!strcmp(argv[i], "--replace")) {
604 ob_replace_wm = TRUE;
605 remove_args(argc, argv, i, 1);
606 --i; /* this arg was removed so go back */
608 else if (!strcmp(argv[i], "--sync")) {
611 else if (!strcmp(argv[i], "--debug")) {
612 ob_debug_enable(OB_DEBUG_NORMAL, TRUE);
613 ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
615 else if (!strcmp(argv[i], "--debug-focus")) {
616 ob_debug_enable(OB_DEBUG_FOCUS, TRUE);
618 else if (!strcmp(argv[i], "--debug-session")) {
619 ob_debug_enable(OB_DEBUG_SM, TRUE);
621 else if (!strcmp(argv[i], "--debug-xinerama")) {
622 ob_debug_xinerama = TRUE;
624 else if (!strcmp(argv[i], "--reconfigure")) {
627 else if (!strcmp(argv[i], "--restart")) {
630 else if (!strcmp(argv[i], "--exit")) {
633 else if (!strcmp(argv[i], "--config-file")) {
634 if (i == *argc - 1) /* no args left */
635 g_printerr(_("--config-file requires an argument\n"));
637 /* this will be in the current locale encoding, which is
639 config_file = argv[i+1];
640 ++i; /* skip the argument */
641 ob_debug("--config-file %s", config_file);
644 else if (!strcmp(argv[i], "--sm-save-file")) {
645 if (i == *argc - 1) /* no args left */
646 /* not translated cuz it's sekret */
647 g_printerr("--sm-save-file requires an argument\n");
649 ob_sm_save_file = g_strdup(argv[i+1]);
650 remove_args(argc, argv, i, 2);
651 --i; /* this arg was removed so go back */
652 ob_debug_type(OB_DEBUG_SM, "--sm-save-file %s",
656 else if (!strcmp(argv[i], "--sm-client-id")) {
657 if (i == *argc - 1) /* no args left */
658 /* not translated cuz it's sekret */
659 g_printerr("--sm-client-id requires an argument\n");
661 ob_sm_id = g_strdup(argv[i+1]);
662 remove_args(argc, argv, i, 2);
663 --i; /* this arg was removed so go back */
664 ob_debug_type(OB_DEBUG_SM, "--sm-client-id %s", ob_sm_id);
667 else if (!strcmp(argv[i], "--sm-disable")) {
670 else if (!strcmp(argv[i], "--sm-no-load")) {
671 ob_sm_restore = FALSE;
672 remove_args(argc, argv, i, 1);
673 --i; /* this arg was removed so go back */
676 /* this is a memleak.. oh well.. heh */
677 gchar *err = g_strdup_printf
678 (_("Invalid command line argument \"%s\"\n"), argv[i]);
679 ob_exit_with_error(err);
684 static Cursor load_cursor(const gchar *name, guint fontval)
689 c = XcursorLibraryLoadCursor(obt_display, name);
692 c = XCreateFontCursor(obt_display, fontval);
696 void ob_exit_with_error(const gchar *msg)
698 g_message("%s", msg);
699 session_shutdown(TRUE);
703 void ob_restart_other(const gchar *path)
705 restart_path = g_strdup(path);
709 void ob_restart(void)
715 void ob_reconfigure(void)
721 void ob_exit(gint code)
724 obt_main_loop_exit(ob_main_loop);
727 void ob_exit_replace(void)
730 being_replaced = TRUE;
731 obt_main_loop_exit(ob_main_loop);
734 Cursor ob_cursor(ObCursor cursor)
736 g_assert(cursor < OB_NUM_CURSORS);
737 return cursors[cursor];
740 gboolean ob_keycode_match(KeyCode code, ObKey key)
744 g_assert(key < OB_NUM_KEYS);
745 for (k = keys[key]; *k; ++k)
746 if (*k == code) return TRUE;
750 ObState ob_state(void)
755 void ob_set_state(ObState s)