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 "action_filter.h"
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"
47 #include "obrender/render.h"
48 #include "obrender/theme.h"
49 #include "obt/display.h"
50 #include "obt/xqueue.h"
51 #include "obt/signal.h"
53 #include "obt/keyboard.h"
68 #ifdef HAVE_SYS_STAT_H
69 # include <sys/stat.h>
70 # include <sys/types.h>
72 #ifdef HAVE_SYS_WAIT_H
73 # include <sys/types.h>
74 # include <sys/wait.h>
81 #include <X11/cursorfont.h>
83 #include <X11/Xcursor/Xcursor.h>
86 RrInstance *ob_rr_inst;
87 RrImageCache *ob_rr_icons;
89 GMainLoop *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;
97 const gchar *ob_locale_msg = NULL;
100 static gboolean xsync = FALSE;
101 static gboolean reconfigure = FALSE;
102 static gboolean restart = FALSE;
103 static gchar *restart_path = NULL;
104 static Cursor cursors[OB_NUM_CURSORS];
105 static gint exitcode = 0;
106 static guint remote_control = 0;
107 static gboolean being_replaced = FALSE;
108 static gchar *config_file = NULL;
109 static gchar *startup_cmd = NULL;
111 static void signal_handler(gint signal, gpointer data);
112 static void remove_args(gint *argc, gchar **argv, gint index, gint num);
113 static void parse_env();
114 static void parse_args(gint *argc, gchar **argv);
115 static Cursor load_cursor(const gchar *name, guint fontval);
116 static void run_startup_cmd(void);
118 gint main(gint argc, gchar **argv)
124 ob_set_state(OB_STATE_STARTING);
128 /* initialize the locale */
129 if (!(ob_locale_msg = setlocale(LC_MESSAGES, "")))
130 g_message("Couldn't set messages locale category from environment.");
131 if (!setlocale(LC_ALL, ""))
132 g_message("Couldn't set locale from environment.");
133 bindtextdomain(PACKAGE_NAME, LOCALEDIR);
134 bind_textdomain_codeset(PACKAGE_NAME, "UTF-8");
135 textdomain(PACKAGE_NAME);
137 if (chdir(g_get_home_dir()) == -1)
138 g_message(_("Unable to change to home directory \"%s\": %s"),
139 g_get_home_dir(), g_strerror(errno));
141 /* parse the command line args, which can change the argv[0] */
142 parse_args(&argc, argv);
143 /* parse the environment variables */
146 program_name = g_path_get_basename(argv[0]);
147 g_set_prgname(program_name);
150 session_startup(argc, argv);
152 if (!obt_display_open(NULL))
153 ob_exit_with_error(_("Failed to open the display from the DISPLAY environment variable."));
155 if (remote_control) {
156 /* Send client message telling the OB process to:
157 * remote_control = 1 -> reconfigure
158 * remote_control = 2 -> restart */
159 OBT_PROP_MSG(ob_screen, obt_root(ob_screen),
160 OB_CONTROL, remote_control, 0, 0, 0, 0);
165 ob_main_loop = g_main_loop_new(NULL, FALSE);
167 /* set up signal handlers, they are called from the mainloop
168 in the main program's thread */
169 obt_signal_add_callback(SIGUSR1, signal_handler, NULL);
170 obt_signal_add_callback(SIGUSR2, signal_handler, NULL);
171 obt_signal_add_callback(SIGTERM, signal_handler, NULL);
172 obt_signal_add_callback(SIGINT, signal_handler, NULL);
173 obt_signal_add_callback(SIGHUP, signal_handler, NULL);
174 obt_signal_add_callback(SIGPIPE, signal_handler, NULL);
175 obt_signal_add_callback(SIGCHLD, signal_handler, NULL);
176 obt_signal_add_callback(SIGTTIN, signal_handler, NULL);
177 obt_signal_add_callback(SIGTTOU, signal_handler, NULL);
179 ob_screen = DefaultScreen(obt_display);
181 ob_rr_inst = RrInstanceNew(obt_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(obt_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 the DISPLAY environment variable for any lauched children, to the
199 display we're using, so they open in the right place. */
200 g_setenv("DISPLAY", DisplayString(obt_display), TRUE);
202 /* create available cursors */
203 cursors[OB_CURSOR_NONE] = None;
204 cursors[OB_CURSOR_POINTER] = load_cursor("left_ptr", XC_left_ptr);
205 cursors[OB_CURSOR_BUSYPOINTER] = load_cursor("left_ptr_watch",XC_left_ptr);
206 cursors[OB_CURSOR_BUSY] = load_cursor("watch", XC_watch);
207 cursors[OB_CURSOR_MOVE] = load_cursor("fleur", XC_fleur);
208 cursors[OB_CURSOR_NORTH] = load_cursor("top_side", XC_top_side);
209 cursors[OB_CURSOR_NORTHEAST] = load_cursor("top_right_corner",
210 XC_top_right_corner);
211 cursors[OB_CURSOR_EAST] = load_cursor("right_side", XC_right_side);
212 cursors[OB_CURSOR_SOUTHEAST] = load_cursor("bottom_right_corner",
213 XC_bottom_right_corner);
214 cursors[OB_CURSOR_SOUTH] = load_cursor("bottom_side", XC_bottom_side);
215 cursors[OB_CURSOR_SOUTHWEST] = load_cursor("bottom_left_corner",
216 XC_bottom_left_corner);
217 cursors[OB_CURSOR_WEST] = load_cursor("left_side", XC_left_side);
218 cursors[OB_CURSOR_NORTHWEST] = load_cursor("top_left_corner",
221 if (screen_annex()) { /* it will be ours! */
223 /* get a timestamp from after taking over as the WM. if we use the
224 old timestamp to set focus it can fail when replacing another WM. */
228 ObPrompt *xmlprompt = NULL;
230 if (reconfigure) obt_keyboard_reload();
235 /* startup the parsing so everything can register sections
237 i = obt_xml_instance_new();
239 /* register all the available actions and filters */
240 action_startup(reconfigure);
241 action_filter_startup(reconfigure);
242 /* start up config which sets up with the parser */
245 /* parse/load user options */
247 obt_xml_load_file(i, config_file, "openbox_config")) ||
248 obt_xml_load_config_file(i, "openbox", "rc",
251 obt_xml_tree_from_root(i);
255 g_message(_("Unable to find a valid config file, using some simple defaults"));
260 gchar *p = g_filename_to_utf8(config_file, -1,
263 OBT_PROP_SETS(obt_root(ob_screen), OB_CONFIG_FILE, p);
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), OB_THEME,
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);
325 /* do this after everything is started so no events will get
333 /* get all the existing windows */
336 /* focus what was focused if a wm was already running */
337 if (OBT_PROP_GET32(obt_root(ob_screen),
338 NET_ACTIVE_WINDOW, WINDOW, &xid) &&
339 (w = window_find(xid)) && WINDOW_IS_CLIENT(w))
341 client_focus(WINDOW_AS_CLIENT(w));
346 /* redecorate all existing windows */
347 for (it = client_list; it; it = g_list_next(it)) {
348 ObClient *c = it->data;
350 /* the new config can change the window's decorations */
351 client_setup_decor_and_functions(c, FALSE);
352 /* redraw the frames */
353 frame_adjust_area(c->frame, TRUE, TRUE, FALSE);
354 /* the decor sizes may have changed, so the windows may
355 end up in new positions */
356 client_reconfigure(c, FALSE);
360 ob_set_state(OB_STATE_RUNNING);
362 if (!reconfigure && startup_cmd) run_startup_cmd();
366 /* look for parsing errors */
368 xmlErrorPtr e = xmlGetLastError();
372 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);
374 prompt_show_message(m, _("Openbox Syntax Error"), _("Close"));
380 g_main_loop_run(ob_main_loop);
381 ob_set_state(reconfigure ?
382 OB_STATE_RECONFIGURING : OB_STATE_EXITING);
385 prompt_unref(xmlprompt);
390 window_unmanage_all();
392 prompt_shutdown(reconfigure);
393 menu_shutdown(reconfigure);
394 menu_frame_shutdown(reconfigure);
395 mouse_shutdown(reconfigure);
396 keyboard_shutdown(reconfigure);
397 moveresize_shutdown(reconfigure);
398 dock_shutdown(reconfigure);
399 client_shutdown(reconfigure);
400 ping_shutdown(reconfigure);
401 group_shutdown(reconfigure);
402 grab_shutdown(reconfigure);
403 screen_shutdown(reconfigure);
404 focus_cycle_popup_shutdown(reconfigure);
405 focus_cycle_indicator_shutdown(reconfigure);
406 focus_cycle_shutdown(reconfigure);
407 focus_shutdown(reconfigure);
408 window_shutdown(reconfigure);
409 sn_shutdown(reconfigure);
410 event_shutdown(reconfigure);
412 action_filter_shutdown(reconfigure);
413 action_shutdown(reconfigure);
414 } while (reconfigure);
417 XSync(obt_display, FALSE);
419 RrThemeFree(ob_rr_theme);
420 RrImageCacheUnref(ob_rr_icons);
421 RrInstanceFree(ob_rr_inst);
423 session_shutdown(being_replaced);
430 if (restart_path != NULL) {
435 /* run other window manager */
436 if (g_shell_parse_argv(restart_path, &argcp, &argvp, &err)) {
437 execvp(argvp[0], argvp);
441 _("Restart failed to execute new executable \"%s\": %s"),
442 restart_path, err->message);
447 /* we remove the session arguments from argv, so put them back,
448 also don't restore the session on restart */
449 if (ob_sm_save_file != NULL || ob_sm_id != NULL) {
454 (ob_sm_save_file != NULL ? 2 : 0) +
455 (ob_sm_id != NULL ? 2 : 0);
456 nargv = g_new0(gchar*, l+1);
457 for (i = 0; i < argc; ++i)
460 if (ob_sm_save_file != NULL) {
461 nargv[i++] = g_strdup("--sm-save-file");
462 nargv[i++] = ob_sm_save_file;
464 if (ob_sm_id != NULL) {
465 nargv[i++] = g_strdup("--sm-client-id");
466 nargv[i++] = ob_sm_id;
468 nargv[i++] = g_strdup("--sm-no-load");
474 execvp(argv[0], argv); /* try how we were run */
475 execlp(argv[0], program_name, (gchar*)NULL); /* last resort */
478 /* free stuff passed in from the command line or environment */
479 g_free(ob_sm_save_file);
481 g_free(program_name);
491 static void signal_handler(gint signal, gpointer data)
495 ob_debug("Caught signal %d. Restarting.", signal);
499 ob_debug("Caught signal %d. Reconfiguring.", signal);
504 while (waitpid(-1, NULL, WNOHANG) > 0);
508 ob_debug("Caught signal %d. Ignoring.", signal);
511 ob_debug("Caught signal %d. Exiting.", signal);
512 /* TERM and INT return a 0 code */
513 ob_exit(!(signal == SIGTERM || signal == SIGINT));
517 static void print_version(void)
519 g_print("Openbox %s\n", PACKAGE_VERSION);
520 g_print(_("Copyright (c)"));
521 g_print(" 2008-2011 Mikael Magnusson\n");
522 g_print(_("Copyright (c)"));
523 g_print(" 2003-2011 Dana Jansens\n\n");
524 g_print("This program comes with ABSOLUTELY NO WARRANTY.\n");
525 g_print("This is free software, and you are welcome to redistribute it\n");
526 g_print("under certain conditions. See the file COPYING for details.\n\n");
529 static void print_help(void)
531 g_print(_("Syntax: openbox [options]\n"));
532 g_print(_("\nOptions:\n"));
533 g_print(_(" --help Display this help and exit\n"));
534 g_print(_(" --version Display the version and exit\n"));
535 g_print(_(" --replace Replace the currently running window manager\n"));
536 /* TRANSLATORS: if you translate "FILE" here, make sure to keep the "Specify..."
537 aligned still, if you have to, make a new line with \n and 22 spaces. It's
538 fine to leave it as FILE though. */
539 g_print(_(" --config-file FILE Specify the path to the config file to use\n"));
540 g_print(_(" --sm-disable Disable connection to the session manager\n"));
541 g_print(_("\nPassing messages to a running Openbox instance:\n"));
542 g_print(_(" --reconfigure Reload Openbox's configuration\n"));
543 g_print(_(" --restart Restart Openbox\n"));
544 g_print(_(" --exit Exit Openbox\n"));
545 g_print(_("\nDebugging options:\n"));
546 g_print(_(" --sync Run in synchronous mode\n"));
547 g_print(_(" --startup CMD Run CMD after starting\n"));
548 g_print(_(" --debug Display debugging output\n"));
549 g_print(_(" --debug-focus Display debugging output for focus handling\n"));
550 g_print(_(" --debug-session Display debugging output for session management\n"));
551 g_print(_(" --debug-xinerama Split the display into fake xinerama screens\n"));
552 g_print(_("\nPlease report bugs at %s\n"), PACKAGE_BUGREPORT);
555 static void remove_args(gint *argc, gchar **argv, gint index, gint num)
559 for (i = index; i < *argc - num; ++i)
560 argv[i] = argv[i+num];
561 for (; i < *argc; ++i)
566 static void run_startup_cmd(void)
572 if (!g_shell_parse_argv(startup_cmd, NULL, &argv, &e)) {
573 g_message("Error parsing startup command: %s",
578 ok = g_spawn_async(NULL, argv, NULL,
579 G_SPAWN_SEARCH_PATH |
580 G_SPAWN_DO_NOT_REAP_CHILD,
581 NULL, NULL, NULL, &e);
583 g_message("Error launching startup command: %s",
590 static void parse_env(void)
594 /* unset this so we don't pass it on unknowingly */
595 g_unsetenv("DESKTOP_STARTUP_ID");
597 /* this is how gnome-session passes in a session client id */
598 id = g_getenv("DESKTOP_AUTOSTART_ID");
600 g_unsetenv("DESKTOP_AUTOSTART_ID");
601 if (ob_sm_id) g_free(ob_sm_id);
602 ob_sm_id = g_strdup(id);
603 ob_debug_type(OB_DEBUG_SM,
604 "DESKTOP_AUTOSTART_ID %s supercedes --sm-client-id\n",
609 static void parse_args(gint *argc, gchar **argv)
613 for (i = 1; i < *argc; ++i) {
614 if (!strcmp(argv[i], "--version")) {
618 else if (!strcmp(argv[i], "--help")) {
622 else if (!strcmp(argv[i], "--g-fatal-warnings")) {
623 g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL);
625 else if (!strcmp(argv[i], "--replace")) {
626 ob_replace_wm = TRUE;
627 remove_args(argc, argv, i, 1);
628 --i; /* this arg was removed so go back */
630 else if (!strcmp(argv[i], "--sync")) {
633 else if (!strcmp(argv[i], "--startup")) {
634 if (i == *argc - 1) /* no args left */
635 g_printerr(_("%s requires an argument\n"), "--startup");
637 /* this will be in the current locale encoding, which is
639 startup_cmd = argv[i+1];
640 remove_args(argc, argv, i, 2);
641 --i; /* this arg was removed so go back */
642 ob_debug("--startup %s", startup_cmd);
645 else if (!strcmp(argv[i], "--debug")) {
646 ob_debug_enable(OB_DEBUG_NORMAL, TRUE);
647 ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
649 else if (!strcmp(argv[i], "--debug-focus")) {
650 ob_debug_enable(OB_DEBUG_FOCUS, TRUE);
652 else if (!strcmp(argv[i], "--debug-session")) {
653 ob_debug_enable(OB_DEBUG_SM, TRUE);
655 else if (!strcmp(argv[i], "--debug-xinerama")) {
656 ob_debug_xinerama = TRUE;
658 else if (!strcmp(argv[i], "--reconfigure")) {
661 else if (!strcmp(argv[i], "--restart")) {
664 else if (!strcmp(argv[i], "--exit")) {
667 else if (!strcmp(argv[i], "--config-file")) {
668 if (i == *argc - 1) /* no args left */
669 g_printerr(_("%s requires an argument\n"), "--config-file");
671 /* this will be in the current locale encoding, which is
673 config_file = argv[i+1];
674 ++i; /* skip the argument */
675 ob_debug("--config-file %s", config_file);
678 else if (!strcmp(argv[i], "--sm-save-file")) {
679 if (i == *argc - 1) /* no args left */
680 /* not translated cuz it's sekret */
681 g_printerr("--sm-save-file requires an argument\n");
683 ob_sm_save_file = g_strdup(argv[i+1]);
684 remove_args(argc, argv, i, 2);
685 --i; /* this arg was removed so go back */
686 ob_debug_type(OB_DEBUG_SM, "--sm-save-file %s",
690 else if (!strcmp(argv[i], "--sm-client-id")) {
691 if (i == *argc - 1) /* no args left */
692 /* not translated cuz it's sekret */
693 g_printerr("--sm-client-id requires an argument\n");
695 ob_sm_id = g_strdup(argv[i+1]);
696 remove_args(argc, argv, i, 2);
697 --i; /* this arg was removed so go back */
698 ob_debug_type(OB_DEBUG_SM, "--sm-client-id %s", ob_sm_id);
701 else if (!strcmp(argv[i], "--sm-disable")) {
704 else if (!strcmp(argv[i], "--sm-no-load")) {
705 ob_sm_restore = FALSE;
706 remove_args(argc, argv, i, 1);
707 --i; /* this arg was removed so go back */
710 /* this is a memleak.. oh well.. heh */
711 gchar *err = g_strdup_printf
712 (_("Invalid command line argument \"%s\"\n"), argv[i]);
713 ob_exit_with_error(err);
718 static Cursor load_cursor(const gchar *name, guint fontval)
723 c = XcursorLibraryLoadCursor(obt_display, name);
726 c = XCreateFontCursor(obt_display, fontval);
730 void ob_exit_with_error(const gchar *msg)
732 g_message("%s", msg);
733 session_shutdown(TRUE);
737 void ob_restart_other(const gchar *path)
739 restart_path = g_strdup(path);
743 void ob_restart(void)
749 void ob_reconfigure(void)
755 void ob_exit(gint code)
758 g_main_loop_quit(ob_main_loop);
761 void ob_exit_replace(void)
764 being_replaced = TRUE;
765 g_main_loop_quit(ob_main_loop);
768 Cursor ob_cursor(ObCursor cursor)
770 g_assert(cursor < OB_NUM_CURSORS);
771 return cursors[cursor];
774 ObState ob_state(void)
779 void ob_set_state(ObState s)