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.
20 #include "action_parser.h"
30 #include "action_filter.h"
31 #include "startupnotify.h"
33 #include "focus_cycle.h"
34 #include "focus_cycle_indicator.h"
35 #include "focus_cycle_popup.h"
36 #include "moveresize.h"
38 #include "framerender.h"
41 #include "menuframe.h"
48 #include "obrender/render.h"
49 #include "obrender/theme.h"
50 #include "obt/display.h"
51 #include "obt/xqueue.h"
52 #include "obt/signal.h"
54 #include "obt/keyboard.h"
69 #ifdef HAVE_SYS_STAT_H
70 # include <sys/stat.h>
71 # include <sys/types.h>
73 #ifdef HAVE_SYS_WAIT_H
74 # include <sys/types.h>
75 # include <sys/wait.h>
82 #include <X11/cursorfont.h>
84 #include <X11/Xcursor/Xcursor.h>
87 RrInstance *ob_rr_inst;
88 RrImageCache *ob_rr_icons;
90 GMainLoop *ob_main_loop;
92 gboolean ob_replace_wm = FALSE;
93 gboolean ob_sm_use = TRUE;
94 gchar *ob_sm_id = NULL;
95 gchar *ob_sm_save_file = NULL;
96 gboolean ob_sm_restore = TRUE;
97 gboolean ob_debug_xinerama = FALSE;
98 const gchar *ob_locale_msg = NULL;
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 gint exitcode = 0;
107 static guint remote_control = 0;
108 static gboolean being_replaced = FALSE;
109 static gchar *config_file = NULL;
110 static gchar *startup_cmd = 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);
117 static void run_startup_cmd(void);
119 gint main(gint argc, gchar **argv)
125 ob_set_state(OB_STATE_STARTING);
129 /* initialize the locale */
130 if (!(ob_locale_msg = setlocale(LC_MESSAGES, "")))
131 g_message("Couldn't set messages locale category from environment.");
132 if (!setlocale(LC_ALL, ""))
133 g_message("Couldn't set locale from environment.");
134 bindtextdomain(PACKAGE_NAME, LOCALEDIR);
135 bind_textdomain_codeset(PACKAGE_NAME, "UTF-8");
136 textdomain(PACKAGE_NAME);
138 if (chdir(g_get_home_dir()) == -1)
139 g_message(_("Unable to change to home directory \"%s\": %s"),
140 g_get_home_dir(), g_strerror(errno));
142 /* parse the command line args, which can change the argv[0] */
143 parse_args(&argc, argv);
144 /* parse the environment variables */
147 program_name = g_path_get_basename(argv[0]);
148 g_set_prgname(program_name);
151 session_startup(argc, argv);
153 if (!obt_display_open(NULL))
154 ob_exit_with_error(_("Failed to open the display from the DISPLAY environment variable."));
156 if (remote_control) {
157 /* Send client message telling the OB process to:
158 * remote_control = 1 -> reconfigure
159 * remote_control = 2 -> restart */
160 OBT_PROP_MSG(ob_screen, obt_root(ob_screen),
161 OB_CONTROL, remote_control, 0, 0, 0, 0);
166 ob_main_loop = g_main_loop_new(NULL, FALSE);
168 /* set up signal handlers, they are called from the mainloop
169 in the main program's thread */
170 obt_signal_add_callback(SIGUSR1, signal_handler, NULL);
171 obt_signal_add_callback(SIGUSR2, signal_handler, NULL);
172 obt_signal_add_callback(SIGTERM, signal_handler, NULL);
173 obt_signal_add_callback(SIGINT, signal_handler, NULL);
174 obt_signal_add_callback(SIGHUP, signal_handler, NULL);
175 obt_signal_add_callback(SIGPIPE, signal_handler, NULL);
176 obt_signal_add_callback(SIGCHLD, signal_handler, NULL);
177 obt_signal_add_callback(SIGTTIN, signal_handler, NULL);
178 obt_signal_add_callback(SIGTTOU, signal_handler, NULL);
180 ob_screen = DefaultScreen(obt_display);
182 ob_rr_inst = RrInstanceNew(obt_display, ob_screen);
183 if (ob_rr_inst == NULL)
184 ob_exit_with_error(_("Failed to initialize the obrender library."));
185 /* Saving 3 resizes of an RrImage makes a lot of sense for icons, as there
186 are generally 3 icon sizes needed: the titlebar icon, the menu icon,
189 ob_rr_icons = RrImageCacheNew(3);
191 XSynchronize(obt_display, xsync);
193 /* check for locale support */
194 if (!XSupportsLocale())
195 g_message(_("X server does not support locale."));
196 if (!XSetLocaleModifiers(""))
197 g_message(_("Cannot set locale modifiers for the X server."));
199 /* set the DISPLAY environment variable for any lauched children, to the
200 display we're using, so they open in the right place. */
201 g_setenv("DISPLAY", DisplayString(obt_display), TRUE);
203 /* create available cursors */
204 cursors[OB_CURSOR_NONE] = None;
205 cursors[OB_CURSOR_POINTER] = load_cursor("left_ptr", XC_left_ptr);
206 cursors[OB_CURSOR_BUSYPOINTER] = load_cursor("left_ptr_watch",XC_left_ptr);
207 cursors[OB_CURSOR_BUSY] = load_cursor("watch", XC_watch);
208 cursors[OB_CURSOR_MOVE] = load_cursor("fleur", XC_fleur);
209 cursors[OB_CURSOR_NORTH] = load_cursor("top_side", XC_top_side);
210 cursors[OB_CURSOR_NORTHEAST] = load_cursor("top_right_corner",
211 XC_top_right_corner);
212 cursors[OB_CURSOR_EAST] = load_cursor("right_side", XC_right_side);
213 cursors[OB_CURSOR_SOUTHEAST] = load_cursor("bottom_right_corner",
214 XC_bottom_right_corner);
215 cursors[OB_CURSOR_SOUTH] = load_cursor("bottom_side", XC_bottom_side);
216 cursors[OB_CURSOR_SOUTHWEST] = load_cursor("bottom_left_corner",
217 XC_bottom_left_corner);
218 cursors[OB_CURSOR_WEST] = load_cursor("left_side", XC_left_side);
219 cursors[OB_CURSOR_NORTHWEST] = load_cursor("top_left_corner",
222 if (screen_annex()) { /* it will be ours! */
224 /* get a timestamp from after taking over as the WM. if we use the
225 old timestamp to set focus it can fail when replacing another WM. */
229 if (reconfigure) obt_keyboard_reload();
234 /* startup the parsing so everything can register sections
236 i = obt_xml_instance_new();
238 /* register all the available actions and filters */
239 action_startup(reconfigure);
240 action_filter_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",
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, p);
266 OBT_PROP_ERASE(obt_root(ob_screen), OB_CONFIG_FILE);
268 /* we're done with parsing now, kill it */
269 obt_xml_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,
280 config_font_activeosd,
281 config_font_inactiveosd)))
283 RrThemeFree(ob_rr_theme);
286 if (ob_rr_theme == NULL)
287 ob_exit_with_error(_("Unable to load a theme."));
289 OBT_PROP_SETS(obt_root(ob_screen), OB_THEME,
296 /* update all existing windows for the new theme */
297 for (it = client_list; it; it = g_list_next(it)) {
298 ObClient *c = it->data;
299 frame_adjust_theme(c->frame);
302 event_startup(reconfigure);
303 /* focus_backup is used for stacking, so this needs to come before
304 anything that calls stacking_add */
305 sn_startup(reconfigure);
306 window_startup(reconfigure);
307 focus_startup(reconfigure);
308 focus_cycle_startup(reconfigure);
309 focus_cycle_indicator_startup(reconfigure);
310 focus_cycle_popup_startup(reconfigure);
311 screen_startup(reconfigure);
312 grab_startup(reconfigure);
313 group_startup(reconfigure);
314 ping_startup(reconfigure);
315 client_startup(reconfigure);
316 dock_startup(reconfigure);
317 moveresize_startup(reconfigure);
318 keyboard_startup(reconfigure);
319 mouse_startup(reconfigure);
320 menu_frame_startup(reconfigure);
321 menu_startup(reconfigure);
322 prompt_startup(reconfigure);
324 /* do this after everything is started so no events will get
332 /* get all the existing windows */
335 /* focus what was focused if a wm was already running */
336 if (OBT_PROP_GET32(obt_root(ob_screen),
337 NET_ACTIVE_WINDOW, WINDOW, &xid) &&
338 (w = window_find(xid)) && WINDOW_IS_CLIENT(w))
340 client_focus(WINDOW_AS_CLIENT(w));
345 /* redecorate all existing windows */
346 for (it = client_list; it; it = g_list_next(it)) {
347 ObClient *c = it->data;
349 /* the new config can change the window's decorations */
350 client_setup_decor_and_functions(c, FALSE);
351 /* redraw the frames */
352 frame_adjust_area(c->frame, TRUE, TRUE, FALSE);
353 /* the decor sizes may have changed, so the windows may
354 end up in new positions */
355 client_reconfigure(c, FALSE);
359 ob_set_state(OB_STATE_RUNNING);
361 if (!reconfigure && startup_cmd) run_startup_cmd();
365 /* look for parsing errors */
367 xmlErrorPtr xe = NULL;
368 const ObActionParserError *ae = NULL;
370 xe = xmlGetLastError();
371 if (!xe) ae = action_parser_get_last_error();
376 _("One or more 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"),
377 (xe ? xe->file : ae->source),
378 (xe ? xe->line : (signed)ae->line),
379 (xe ? xe->message : ae->message));
380 prompt_show_message(m, _("Openbox Syntax Error"),
383 if (xe) xmlResetError(xe);
384 else action_parser_reset_last_error();
388 g_main_loop_run(ob_main_loop);
389 ob_set_state(reconfigure ?
390 OB_STATE_RECONFIGURING : OB_STATE_EXITING);
393 window_unmanage_all();
395 prompt_shutdown(reconfigure);
396 menu_shutdown(reconfigure);
397 menu_frame_shutdown(reconfigure);
398 mouse_shutdown(reconfigure);
399 keyboard_shutdown(reconfigure);
400 moveresize_shutdown(reconfigure);
401 dock_shutdown(reconfigure);
402 client_shutdown(reconfigure);
403 ping_shutdown(reconfigure);
404 group_shutdown(reconfigure);
405 grab_shutdown(reconfigure);
406 screen_shutdown(reconfigure);
407 focus_cycle_popup_shutdown(reconfigure);
408 focus_cycle_indicator_shutdown(reconfigure);
409 focus_cycle_shutdown(reconfigure);
410 focus_shutdown(reconfigure);
411 window_shutdown(reconfigure);
412 sn_shutdown(reconfigure);
413 event_shutdown(reconfigure);
415 action_filter_shutdown(reconfigure);
416 action_shutdown(reconfigure);
417 } while (reconfigure);
420 XSync(obt_display, FALSE);
422 RrThemeFree(ob_rr_theme);
423 RrImageCacheUnref(ob_rr_icons);
424 RrInstanceFree(ob_rr_inst);
426 session_shutdown(being_replaced);
433 if (restart_path != NULL) {
438 /* run other window manager */
439 if (g_shell_parse_argv(restart_path, &argcp, &argvp, &err)) {
440 execvp(argvp[0], argvp);
444 _("Restart failed to execute new executable \"%s\": %s"),
445 restart_path, err->message);
450 /* we remove the session arguments from argv, so put them back,
451 also don't restore the session on restart */
452 if (ob_sm_save_file != NULL || ob_sm_id != NULL) {
457 (ob_sm_save_file != NULL ? 2 : 0) +
458 (ob_sm_id != NULL ? 2 : 0);
459 nargv = g_new0(gchar*, l+1);
460 for (i = 0; i < argc; ++i)
463 if (ob_sm_save_file != NULL) {
464 nargv[i++] = g_strdup("--sm-save-file");
465 nargv[i++] = ob_sm_save_file;
467 if (ob_sm_id != NULL) {
468 nargv[i++] = g_strdup("--sm-client-id");
469 nargv[i++] = ob_sm_id;
471 nargv[i++] = g_strdup("--sm-no-load");
477 execvp(argv[0], argv); /* try how we were run */
478 execlp(argv[0], program_name, (gchar*)NULL); /* last resort */
481 /* free stuff passed in from the command line or environment */
482 g_free(ob_sm_save_file);
484 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-2011 Mikael Magnusson\n");
525 g_print(_("Copyright (c)"));
526 g_print(" 2003-2011 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(_(" --startup CMD Run CMD after starting\n"));
551 g_print(_(" --debug Display debugging output\n"));
552 g_print(_(" --debug-focus Display debugging output for focus handling\n"));
553 g_print(_(" --debug-session Display debugging output for session management\n"));
554 g_print(_(" --debug-xinerama Split the display into fake xinerama screens\n"));
555 g_print(_("\nPlease report bugs at %s\n"), PACKAGE_BUGREPORT);
558 static void remove_args(gint *argc, gchar **argv, gint index, gint num)
562 for (i = index; i < *argc - num; ++i)
563 argv[i] = argv[i+num];
564 for (; i < *argc; ++i)
569 static void run_startup_cmd(void)
575 if (!g_shell_parse_argv(startup_cmd, NULL, &argv, &e)) {
576 g_message("Error parsing startup command: %s",
581 ok = g_spawn_async(NULL, argv, NULL,
582 G_SPAWN_SEARCH_PATH |
583 G_SPAWN_DO_NOT_REAP_CHILD,
584 NULL, NULL, NULL, &e);
586 g_message("Error launching startup command: %s",
593 static void parse_env(void)
597 /* unset this so we don't pass it on unknowingly */
598 g_unsetenv("DESKTOP_STARTUP_ID");
600 /* this is how gnome-session passes in a session client id */
601 id = g_getenv("DESKTOP_AUTOSTART_ID");
603 g_unsetenv("DESKTOP_AUTOSTART_ID");
604 if (ob_sm_id) g_free(ob_sm_id);
605 ob_sm_id = g_strdup(id);
606 ob_debug_type(OB_DEBUG_SM,
607 "DESKTOP_AUTOSTART_ID %s supercedes --sm-client-id\n",
612 static void parse_args(gint *argc, gchar **argv)
616 for (i = 1; i < *argc; ++i) {
617 if (!strcmp(argv[i], "--version")) {
621 else if (!strcmp(argv[i], "--help")) {
625 else if (!strcmp(argv[i], "--g-fatal-warnings")) {
626 g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL);
628 else if (!strcmp(argv[i], "--replace")) {
629 ob_replace_wm = TRUE;
630 remove_args(argc, argv, i, 1);
631 --i; /* this arg was removed so go back */
633 else if (!strcmp(argv[i], "--sync")) {
636 else if (!strcmp(argv[i], "--startup")) {
637 if (i == *argc - 1) /* no args left */
638 g_printerr(_("%s requires an argument\n"), "--startup");
640 /* this will be in the current locale encoding, which is
642 startup_cmd = argv[i+1];
643 remove_args(argc, argv, i, 2);
644 --i; /* this arg was removed so go back */
645 ob_debug("--startup %s", startup_cmd);
648 else if (!strcmp(argv[i], "--debug")) {
649 ob_debug_enable(OB_DEBUG_NORMAL, TRUE);
650 ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
652 else if (!strcmp(argv[i], "--debug-focus")) {
653 ob_debug_enable(OB_DEBUG_FOCUS, TRUE);
655 else if (!strcmp(argv[i], "--debug-session")) {
656 ob_debug_enable(OB_DEBUG_SM, TRUE);
658 else if (!strcmp(argv[i], "--debug-xinerama")) {
659 ob_debug_xinerama = TRUE;
661 else if (!strcmp(argv[i], "--reconfigure")) {
664 else if (!strcmp(argv[i], "--restart")) {
667 else if (!strcmp(argv[i], "--exit")) {
670 else if (!strcmp(argv[i], "--config-file")) {
671 if (i == *argc - 1) /* no args left */
672 g_printerr(_("%s requires an argument\n"), "--config-file");
674 /* this will be in the current locale encoding, which is
676 config_file = argv[i+1];
677 ++i; /* skip the argument */
678 ob_debug("--config-file %s", config_file);
681 else if (!strcmp(argv[i], "--sm-save-file")) {
682 if (i == *argc - 1) /* no args left */
683 /* not translated cuz it's sekret */
684 g_printerr("--sm-save-file requires an argument\n");
686 ob_sm_save_file = g_strdup(argv[i+1]);
687 remove_args(argc, argv, i, 2);
688 --i; /* this arg was removed so go back */
689 ob_debug_type(OB_DEBUG_SM, "--sm-save-file %s",
693 else if (!strcmp(argv[i], "--sm-client-id")) {
694 if (i == *argc - 1) /* no args left */
695 /* not translated cuz it's sekret */
696 g_printerr("--sm-client-id requires an argument\n");
698 ob_sm_id = g_strdup(argv[i+1]);
699 remove_args(argc, argv, i, 2);
700 --i; /* this arg was removed so go back */
701 ob_debug_type(OB_DEBUG_SM, "--sm-client-id %s", ob_sm_id);
704 else if (!strcmp(argv[i], "--sm-disable")) {
707 else if (!strcmp(argv[i], "--sm-no-load")) {
708 ob_sm_restore = FALSE;
709 remove_args(argc, argv, i, 1);
710 --i; /* this arg was removed so go back */
713 /* this is a memleak.. oh well.. heh */
714 gchar *err = g_strdup_printf
715 (_("Invalid command line argument \"%s\"\n"), argv[i]);
716 ob_exit_with_error(err);
721 static Cursor load_cursor(const gchar *name, guint fontval)
726 c = XcursorLibraryLoadCursor(obt_display, name);
729 c = XCreateFontCursor(obt_display, fontval);
733 void ob_exit_with_error(const gchar *msg)
735 g_message("%s", msg);
736 session_shutdown(TRUE);
740 void ob_restart_other(const gchar *path)
742 restart_path = g_strdup(path);
746 void ob_restart(void)
752 void ob_reconfigure(void)
758 void ob_exit(gint code)
761 g_main_loop_quit(ob_main_loop);
764 void ob_exit_replace(void)
767 being_replaced = TRUE;
768 g_main_loop_quit(ob_main_loop);
771 Cursor ob_cursor(ObCursor cursor)
773 g_assert(cursor < OB_NUM_CURSORS);
774 return cursors[cursor];
777 ObState ob_state(void)
782 void ob_set_state(ObState s)