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.
32 #include "startupnotify.h"
34 #include "focus_cycle.h"
35 #include "focus_cycle_indicator.h"
36 #include "focus_cycle_popup.h"
37 #include "moveresize.h"
39 #include "framerender.h"
42 #include "extensions.h"
43 #include "menuframe.h"
51 #include "parser/parse.h"
52 #include "render/render.h"
53 #include "render/theme.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 ObMainLoop *ob_main_loop;
94 gboolean ob_replace_wm = FALSE;
95 gboolean ob_sm_use = TRUE;
96 gchar *ob_sm_id = NULL;
97 gchar *ob_sm_save_file = NULL;
98 gboolean ob_sm_restore = TRUE;
99 gboolean ob_debug_xinerama = FALSE;
101 static ObState state;
102 static gboolean xsync = FALSE;
103 static gboolean reconfigure = FALSE;
104 static gboolean restart = FALSE;
105 static gchar *restart_path = NULL;
106 static Cursor cursors[OB_NUM_CURSORS];
107 static KeyCode keys[OB_NUM_KEYS];
108 static gint exitcode = 0;
109 static guint remote_control = 0;
110 static gboolean being_replaced = FALSE;
111 static gchar *config_file = NULL;
113 static void signal_handler(gint signal, gpointer data);
114 static void remove_args(gint *argc, gchar **argv, gint index, gint num);
115 static void parse_env();
116 static void parse_args(gint *argc, gchar **argv);
117 static Cursor load_cursor(const gchar *name, guint fontval);
119 gint main(gint argc, gchar **argv)
123 ob_set_state(OB_STATE_STARTING);
125 /* initialize the locale */
126 if (!setlocale(LC_ALL, ""))
127 g_message("Couldn't set locale from environment.");
128 bindtextdomain(PACKAGE_NAME, LOCALEDIR);
129 bind_textdomain_codeset(PACKAGE_NAME, "UTF-8");
130 textdomain(PACKAGE_NAME);
132 if (chdir(g_get_home_dir()) == -1)
133 g_message(_("Unable to change to home directory \"%s\": %s"),
134 g_get_home_dir(), g_strerror(errno));
136 /* parse the command line args, which can change the argv[0] */
137 parse_args(&argc, argv);
138 /* parse the environment variables */
141 program_name = g_path_get_basename(argv[0]);
142 g_set_prgname(program_name);
144 if (!remote_control) {
145 parse_paths_startup();
147 session_startup(argc, argv);
150 ob_display = XOpenDisplay(NULL);
151 if (ob_display == NULL)
152 ob_exit_with_error(_("Failed to open the display from the DISPLAY environment variable."));
153 if (fcntl(ConnectionNumber(ob_display), F_SETFD, 1) == -1)
154 ob_exit_with_error("Failed to set display as close-on-exec");
156 if (remote_control) {
159 /* Send client message telling the OB process to:
160 * remote_control = 1 -> reconfigure
161 * remote_control = 2 -> restart */
162 PROP_MSG(RootWindow(ob_display, ob_screen),
163 ob_control, remote_control, 0, 0, 0);
164 XCloseDisplay(ob_display);
168 ob_main_loop = ob_main_loop_new(ob_display);
170 /* set up signal handler */
171 ob_main_loop_signal_add(ob_main_loop, SIGUSR1, signal_handler, NULL, NULL);
172 ob_main_loop_signal_add(ob_main_loop, SIGUSR2, signal_handler, NULL, NULL);
173 ob_main_loop_signal_add(ob_main_loop, SIGTERM, signal_handler, NULL, NULL);
174 ob_main_loop_signal_add(ob_main_loop, SIGINT, signal_handler, NULL, NULL);
175 ob_main_loop_signal_add(ob_main_loop, SIGHUP, signal_handler, NULL, NULL);
176 ob_main_loop_signal_add(ob_main_loop, SIGPIPE, signal_handler, NULL, NULL);
177 ob_main_loop_signal_add(ob_main_loop, SIGCHLD, signal_handler, NULL, NULL);
179 ob_screen = DefaultScreen(ob_display);
181 ob_rr_inst = RrInstanceNew(ob_display, ob_screen);
182 if (ob_rr_inst == NULL)
183 ob_exit_with_error(_("Failed to initialize the obrender library."));
184 /* Saving 3 resizes of an RrImage makes a lot of sense for icons, as there
185 are generally 3 icon sizes needed: the titlebar icon, the menu icon,
188 ob_rr_icons = RrImageCacheNew(3);
190 XSynchronize(ob_display, xsync);
192 /* check for locale support */
193 if (!XSupportsLocale())
194 g_message(_("X server does not support locale."));
195 if (!XSetLocaleModifiers(""))
196 g_message(_("Cannot set locale modifiers for the X server."));
198 /* set our error handler */
199 XSetErrorHandler(xerror_handler);
201 /* set the DISPLAY environment variable for any lauched children, to the
202 display we're using, so they open in the right place. */
203 setenv("DISPLAY", DisplayString(ob_display), TRUE);
205 /* create available cursors */
206 cursors[OB_CURSOR_NONE] = None;
207 cursors[OB_CURSOR_POINTER] = load_cursor("left_ptr", XC_left_ptr);
208 cursors[OB_CURSOR_BUSYPOINTER] = load_cursor("left_ptr_watch",XC_left_ptr);
209 cursors[OB_CURSOR_BUSY] = load_cursor("watch", XC_watch);
210 cursors[OB_CURSOR_MOVE] = load_cursor("fleur", XC_fleur);
211 cursors[OB_CURSOR_NORTH] = load_cursor("top_side", XC_top_side);
212 cursors[OB_CURSOR_NORTHEAST] = load_cursor("top_right_corner",
213 XC_top_right_corner);
214 cursors[OB_CURSOR_EAST] = load_cursor("right_side", XC_right_side);
215 cursors[OB_CURSOR_SOUTHEAST] = load_cursor("bottom_right_corner",
216 XC_bottom_right_corner);
217 cursors[OB_CURSOR_SOUTH] = load_cursor("bottom_side", XC_bottom_side);
218 cursors[OB_CURSOR_SOUTHWEST] = load_cursor("bottom_left_corner",
219 XC_bottom_left_corner);
220 cursors[OB_CURSOR_WEST] = load_cursor("left_side", XC_left_side);
221 cursors[OB_CURSOR_NORTHWEST] = load_cursor("top_left_corner",
224 prop_startup(); /* get atoms values for the display */
225 extensions_query_all(); /* find which extensions are present */
227 if (screen_annex()) { /* it will be ours! */
229 ObPrompt *xmlprompt = NULL;
231 modkeys_startup(reconfigure);
233 /* get the keycodes for keys we use */
234 keys[OB_KEY_RETURN] = modkeys_sym_to_code(XK_Return);
235 keys[OB_KEY_ESCAPE] = modkeys_sym_to_code(XK_Escape);
236 keys[OB_KEY_LEFT] = modkeys_sym_to_code(XK_Left);
237 keys[OB_KEY_RIGHT] = modkeys_sym_to_code(XK_Right);
238 keys[OB_KEY_UP] = modkeys_sym_to_code(XK_Up);
239 keys[OB_KEY_DOWN] = modkeys_sym_to_code(XK_Down);
240 keys[OB_KEY_TAB] = modkeys_sym_to_code(XK_Tab);
241 keys[OB_KEY_SPACE] = modkeys_sym_to_code(XK_space);
248 /* startup the parsing so everything can register sections
252 /* register all the available actions */
253 actions_startup(reconfigure);
254 /* start up config which sets up with the parser */
257 /* parse/load user options */
258 if (parse_load_rc(config_file, &doc, &node)) {
259 parse_tree(i, doc, node->xmlChildrenNode);
263 g_message(_("Unable to find a valid config file, using some simple defaults"));
268 gchar *p = g_filename_to_utf8(config_file, -1,
271 PROP_SETS(RootWindow(ob_display, ob_screen),
276 PROP_ERASE(RootWindow(ob_display, ob_screen),
279 /* we're done with parsing now, kill it */
283 /* load the theme specified in the rc file */
286 if ((theme = RrThemeNew(ob_rr_inst, config_theme, TRUE,
287 config_font_activewindow,
288 config_font_inactivewindow,
289 config_font_menutitle,
290 config_font_menuitem,
293 RrThemeFree(ob_rr_theme);
296 if (ob_rr_theme == NULL)
297 ob_exit_with_error(_("Unable to load a theme."));
299 PROP_SETS(RootWindow(ob_display, ob_screen),
300 ob_theme, ob_rr_theme->name);
306 /* update all existing windows for the new theme */
307 for (it = client_list; it; it = g_list_next(it)) {
308 ObClient *c = it->data;
309 frame_adjust_theme(c->frame);
312 event_startup(reconfigure);
313 /* focus_backup is used for stacking, so this needs to come before
314 anything that calls stacking_add */
315 sn_startup(reconfigure);
316 window_startup(reconfigure);
317 focus_startup(reconfigure);
318 focus_cycle_startup(reconfigure);
319 focus_cycle_indicator_startup(reconfigure);
320 focus_cycle_popup_startup(reconfigure);
321 screen_startup(reconfigure);
322 grab_startup(reconfigure);
323 group_startup(reconfigure);
324 ping_startup(reconfigure);
325 client_startup(reconfigure);
326 dock_startup(reconfigure);
327 moveresize_startup(reconfigure);
328 keyboard_startup(reconfigure);
329 mouse_startup(reconfigure);
330 menu_frame_startup(reconfigure);
331 menu_startup(reconfigure);
332 prompt_startup(reconfigure);
338 /* get all the existing windows */
342 /* focus what was focused if a wm was already running */
343 if (PROP_GET32(RootWindow(ob_display, ob_screen),
344 net_active_window, window, &xid) &&
345 (w = g_hash_table_lookup(window_map, &xid)) &&
348 client_focus(WINDOW_AS_CLIENT(w));
353 /* redecorate all existing windows */
354 for (it = client_list; it; it = g_list_next(it)) {
355 ObClient *c = it->data;
357 /* the new config can change the window's decorations */
358 client_setup_decor_and_functions(c, FALSE);
359 /* redraw the frames */
360 frame_adjust_area(c->frame, TRUE, TRUE, FALSE);
361 /* the decor sizes may have changed, so the windows may
362 end up in new positions */
363 client_reconfigure(c, FALSE);
369 ob_set_state(OB_STATE_RUNNING);
371 /* look for parsing errors */
373 xmlErrorPtr e = xmlGetLastError();
377 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);
379 prompt_show_message(m, _("Openbox Syntax Error"), _("Close"));
385 ob_main_loop_run(ob_main_loop);
386 ob_set_state(reconfigure ?
387 OB_STATE_RECONFIGURING : OB_STATE_EXITING);
390 prompt_unref(xmlprompt);
396 client_unmanage_all();
399 prompt_shutdown(reconfigure);
400 menu_shutdown(reconfigure);
401 menu_frame_shutdown(reconfigure);
402 mouse_shutdown(reconfigure);
403 keyboard_shutdown(reconfigure);
404 moveresize_shutdown(reconfigure);
405 dock_shutdown(reconfigure);
406 client_shutdown(reconfigure);
407 ping_shutdown(reconfigure);
408 group_shutdown(reconfigure);
409 grab_shutdown(reconfigure);
410 screen_shutdown(reconfigure);
411 focus_cycle_popup_shutdown(reconfigure);
412 focus_cycle_indicator_shutdown(reconfigure);
413 focus_cycle_shutdown(reconfigure);
414 focus_shutdown(reconfigure);
415 window_shutdown(reconfigure);
416 sn_shutdown(reconfigure);
417 event_shutdown(reconfigure);
419 actions_shutdown(reconfigure);
420 modkeys_shutdown(reconfigure);
421 } while (reconfigure);
424 XSync(ob_display, FALSE);
426 RrThemeFree(ob_rr_theme);
427 RrImageCacheUnref(ob_rr_icons);
428 RrInstanceFree(ob_rr_inst);
430 session_shutdown(being_replaced);
432 XCloseDisplay(ob_display);
434 parse_paths_shutdown();
437 if (restart_path != NULL) {
442 /* run other window manager */
443 if (g_shell_parse_argv(restart_path, &argcp, &argvp, &err)) {
444 execvp(argvp[0], argvp);
448 _("Restart failed to execute new executable \"%s\": %s"),
449 restart_path, err->message);
454 /* we remove the session arguments from argv, so put them back,
455 also don't restore the session on restart */
456 if (ob_sm_save_file != NULL || ob_sm_id != NULL) {
461 (ob_sm_save_file != NULL ? 2 : 0) +
462 (ob_sm_id != NULL ? 2 : 0);
463 nargv = g_new0(gchar*, l+1);
464 for (i = 0; i < argc; ++i)
467 if (ob_sm_save_file != NULL) {
468 nargv[i++] = g_strdup("--sm-save-file");
469 nargv[i++] = ob_sm_save_file;
471 if (ob_sm_id != NULL) {
472 nargv[i++] = g_strdup("--sm-client-id");
473 nargv[i++] = ob_sm_id;
475 nargv[i++] = g_strdup("--sm-no-load");
481 execvp(argv[0], argv); /* try how we were run */
482 execlp(argv[0], program_name, (gchar*)NULL); /* last resort */
485 /* free stuff passed in from the command line or environment */
486 g_free(ob_sm_save_file);
488 g_free(program_name);
493 static void signal_handler(gint signal, gpointer data)
497 ob_debug("Caught signal %d. Restarting.\n", signal);
501 ob_debug("Caught signal %d. Reconfiguring.\n", signal);
506 while (waitpid(-1, NULL, WNOHANG) > 0);
509 ob_debug("Caught signal %d. Exiting.\n", signal);
510 /* TERM and INT return a 0 code */
511 ob_exit(!(signal == SIGTERM || signal == SIGINT));
515 static void print_version(void)
517 g_print("Openbox %s\n", PACKAGE_VERSION);
518 g_print(_("Copyright (c)"));
519 g_print(" 2008 Mikael Magnusson\n");
520 g_print(_("Copyright (c)"));
521 g_print(" 2003-2006 Dana Jansens\n\n");
522 g_print("This program comes with ABSOLUTELY NO WARRANTY.\n");
523 g_print("This is free software, and you are welcome to redistribute it\n");
524 g_print("under certain conditions. See the file COPYING for details.\n\n");
527 static void print_help(void)
529 g_print(_("Syntax: openbox [options]\n"));
530 g_print(_("\nOptions:\n"));
531 g_print(_(" --help Display this help and exit\n"));
532 g_print(_(" --version Display the version and exit\n"));
533 g_print(_(" --replace Replace the currently running window manager\n"));
534 /* TRANSLATORS: if you translate "FILE" here, make sure to keep the "Specify..."
535 aligned still, if you have to, make a new line with \n and 22 spaces. It's
536 fine to leave it as FILE though. */
537 g_print(_(" --config-file FILE Specify the path to the config file to use\n"));
538 g_print(_(" --sm-disable Disable connection to the session manager\n"));
539 g_print(_("\nPassing messages to a running Openbox instance:\n"));
540 g_print(_(" --reconfigure Reload Openbox's configuration\n"));
541 g_print(_(" --restart Restart Openbox\n"));
542 g_print(_(" --exit Exit Openbox\n"));
543 g_print(_("\nDebugging options:\n"));
544 g_print(_(" --sync Run in synchronous mode\n"));
545 g_print(_(" --debug Display debugging output\n"));
546 g_print(_(" --debug-focus Display debugging output for focus handling\n"));
547 g_print(_(" --debug-xinerama Split the display into fake xinerama screens\n"));
548 g_print(_("\nPlease report bugs at %s\n"), PACKAGE_BUGREPORT);
551 static void remove_args(gint *argc, gchar **argv, gint index, gint num)
555 for (i = index; i < *argc - num; ++i)
556 argv[i] = argv[i+num];
557 for (; i < *argc; ++i)
562 static void parse_env(void)
564 /* unset this so we don't pass it on unknowingly */
565 unsetenv("DESKTOP_STARTUP_ID");
568 static void parse_args(gint *argc, gchar **argv)
572 for (i = 1; i < *argc; ++i) {
573 if (!strcmp(argv[i], "--version")) {
577 else if (!strcmp(argv[i], "--help")) {
581 else if (!strcmp(argv[i], "--g-fatal-warnings")) {
582 g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL);
584 else if (!strcmp(argv[i], "--replace")) {
585 ob_replace_wm = TRUE;
586 remove_args(argc, argv, i, 1);
587 --i; /* this arg was removed so go back */
589 else if (!strcmp(argv[i], "--sync")) {
592 else if (!strcmp(argv[i], "--debug")) {
593 ob_debug_show_output(TRUE);
594 ob_debug_enable(OB_DEBUG_SM, TRUE);
595 ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
597 else if (!strcmp(argv[i], "--debug-focus")) {
598 ob_debug_show_output(TRUE);
599 ob_debug_enable(OB_DEBUG_SM, TRUE);
600 ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
601 ob_debug_enable(OB_DEBUG_FOCUS, TRUE);
603 else if (!strcmp(argv[i], "--debug-xinerama")) {
604 ob_debug_xinerama = TRUE;
606 else if (!strcmp(argv[i], "--reconfigure")) {
609 else if (!strcmp(argv[i], "--restart")) {
612 else if (!strcmp(argv[i], "--exit")) {
615 else if (!strcmp(argv[i], "--config-file")) {
616 if (i == *argc - 1) /* no args left */
617 g_printerr(_("--config-file requires an argument\n"));
619 /* this will be in the current locale encoding, which is
621 config_file = argv[i+1];
622 ++i; /* skip the argument */
623 ob_debug("--config-file %s\n", config_file);
626 else if (!strcmp(argv[i], "--sm-save-file")) {
627 if (i == *argc - 1) /* no args left */
628 /* not translated cuz it's sekret */
629 g_printerr("--sm-save-file requires an argument\n");
631 ob_sm_save_file = 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-save-file %s\n",
638 else if (!strcmp(argv[i], "--sm-client-id")) {
639 if (i == *argc - 1) /* no args left */
640 /* not translated cuz it's sekret */
641 g_printerr("--sm-client-id requires an argument\n");
643 ob_sm_id = g_strdup(argv[i+1]);
644 remove_args(argc, argv, i, 2);
645 --i; /* this arg was removed so go back */
646 ob_debug_type(OB_DEBUG_SM, "--sm-client-id %s\n", ob_sm_id);
649 else if (!strcmp(argv[i], "--sm-disable")) {
652 else if (!strcmp(argv[i], "--sm-no-load")) {
653 ob_sm_restore = FALSE;
654 remove_args(argc, argv, i, 1);
655 --i; /* this arg was removed so go back */
658 /* this is a memleak.. oh well.. heh */
659 gchar *err = g_strdup_printf
660 (_("Invalid command line argument \"%s\"\n"), argv[i]);
661 ob_exit_with_error(err);
666 static Cursor load_cursor(const gchar *name, guint fontval)
671 c = XcursorLibraryLoadCursor(ob_display, name);
674 c = XCreateFontCursor(ob_display, fontval);
678 void ob_exit_with_error(const gchar *msg)
681 session_shutdown(TRUE);
685 void ob_restart_other(const gchar *path)
687 restart_path = g_strdup(path);
691 void ob_restart(void)
697 void ob_reconfigure(void)
703 void ob_exit(gint code)
706 ob_main_loop_exit(ob_main_loop);
709 void ob_exit_replace(void)
712 being_replaced = TRUE;
713 ob_main_loop_exit(ob_main_loop);
716 Cursor ob_cursor(ObCursor cursor)
718 g_assert(cursor < OB_NUM_CURSORS);
719 return cursors[cursor];
722 KeyCode ob_keycode(ObKey key)
724 g_assert(key < OB_NUM_KEYS);
728 ObState ob_state(void)
733 void ob_set_state(ObState s)