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>
83 RrInstance *ob_rr_inst;
84 RrImageCache *ob_rr_icons;
86 ObtMainLoop *ob_main_loop;
88 gboolean ob_replace_wm = FALSE;
89 gboolean ob_sm_use = TRUE;
90 gchar *ob_sm_id = NULL;
91 gchar *ob_sm_save_file = NULL;
92 gboolean ob_sm_restore = TRUE;
93 gboolean ob_debug_xinerama = FALSE;
94 const gchar *ob_locale_msg = NULL;
97 static gboolean xsync = FALSE;
98 static gboolean reconfigure = FALSE;
99 static gboolean restart = FALSE;
100 static gchar *restart_path = NULL;
101 static Cursor cursors[OB_NUM_CURSORS];
102 static gint exitcode = 0;
103 static guint remote_control = 0;
104 static gboolean being_replaced = FALSE;
105 static gchar *config_file = NULL;
106 static gchar *startup_cmd = NULL;
108 static void signal_handler(gint signal, gpointer data);
109 static void remove_args(gint *argc, gchar **argv, gint index, gint num);
110 static void parse_env();
111 static void parse_args(gint *argc, gchar **argv);
112 static Cursor load_cursor(const gchar *name, guint fontval);
113 static void run_startup_cmd(void);
115 gint main(gint argc, gchar **argv)
119 ob_set_state(OB_STATE_STARTING);
123 /* initialize the locale */
124 if (!(ob_locale_msg = setlocale(LC_MESSAGES, "")))
125 g_message("Couldn't set messages locale category from environment.");
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);
145 session_startup(argc, argv);
147 if (!obt_display_open(NULL))
148 ob_exit_with_error(_("Failed to open the display from the DISPLAY environment variable."));
150 if (remote_control) {
151 /* Send client message telling the OB process to:
152 * remote_control = 1 -> reconfigure
153 * remote_control = 2 -> restart */
154 OBT_PROP_MSG(ob_screen, obt_root(ob_screen),
155 OB_CONTROL, remote_control, 0, 0, 0, 0);
160 ob_main_loop = obt_main_loop_new();
162 /* set up signal handler */
163 obt_main_loop_signal_add(ob_main_loop, SIGUSR1, signal_handler, NULL,NULL);
164 obt_main_loop_signal_add(ob_main_loop, SIGUSR2, signal_handler, NULL,NULL);
165 obt_main_loop_signal_add(ob_main_loop, SIGTERM, signal_handler, NULL,NULL);
166 obt_main_loop_signal_add(ob_main_loop, SIGINT, signal_handler, NULL,NULL);
167 obt_main_loop_signal_add(ob_main_loop, SIGHUP, signal_handler, NULL,NULL);
168 obt_main_loop_signal_add(ob_main_loop, SIGPIPE, signal_handler, NULL,NULL);
169 obt_main_loop_signal_add(ob_main_loop, SIGCHLD, signal_handler, NULL,NULL);
170 obt_main_loop_signal_add(ob_main_loop, SIGTTIN, signal_handler, NULL,NULL);
171 obt_main_loop_signal_add(ob_main_loop, SIGTTOU, signal_handler, NULL,NULL);
173 ob_screen = DefaultScreen(obt_display);
175 ob_rr_inst = RrInstanceNew(obt_display, ob_screen);
176 if (ob_rr_inst == NULL)
177 ob_exit_with_error(_("Failed to initialize the obrender library."));
178 /* Saving 3 resizes of an RrImage makes a lot of sense for icons, as there
179 are generally 3 icon sizes needed: the titlebar icon, the menu icon,
182 ob_rr_icons = RrImageCacheNew(3);
184 XSynchronize(obt_display, xsync);
186 /* check for locale support */
187 if (!XSupportsLocale())
188 g_message(_("X server does not support locale."));
189 if (!XSetLocaleModifiers(""))
190 g_message(_("Cannot set locale modifiers for the X server."));
192 /* set the DISPLAY environment variable for any lauched children, to the
193 display we're using, so they open in the right place. */
194 setenv("DISPLAY", DisplayString(obt_display), TRUE);
196 /* create available cursors */
197 cursors[OB_CURSOR_NONE] = None;
198 cursors[OB_CURSOR_POINTER] = load_cursor("left_ptr", XC_left_ptr);
199 cursors[OB_CURSOR_BUSYPOINTER] = load_cursor("left_ptr_watch",XC_left_ptr);
200 cursors[OB_CURSOR_BUSY] = load_cursor("watch", XC_watch);
201 cursors[OB_CURSOR_MOVE] = load_cursor("fleur", XC_fleur);
202 cursors[OB_CURSOR_NORTH] = load_cursor("top_side", XC_top_side);
203 cursors[OB_CURSOR_NORTHEAST] = load_cursor("top_right_corner",
204 XC_top_right_corner);
205 cursors[OB_CURSOR_EAST] = load_cursor("right_side", XC_right_side);
206 cursors[OB_CURSOR_SOUTHEAST] = load_cursor("bottom_right_corner",
207 XC_bottom_right_corner);
208 cursors[OB_CURSOR_SOUTH] = load_cursor("bottom_side", XC_bottom_side);
209 cursors[OB_CURSOR_SOUTHWEST] = load_cursor("bottom_left_corner",
210 XC_bottom_left_corner);
211 cursors[OB_CURSOR_WEST] = load_cursor("left_side", XC_left_side);
212 cursors[OB_CURSOR_NORTHWEST] = load_cursor("top_left_corner",
215 if (screen_annex()) { /* it will be ours! */
217 /* get a timestamp from after taking over as the WM. if we use the
218 old timestamp to set focus it can fail when replacing another WM. */
222 ObPrompt *xmlprompt = NULL;
224 if (reconfigure) obt_keyboard_reload();
229 /* startup the parsing so everything can register sections
231 i = obt_xml_instance_new();
233 /* register all the available actions */
234 actions_startup(reconfigure);
235 /* start up config which sets up with the parser */
238 /* parse/load user options */
240 obt_xml_load_file(i, config_file, "openbox_config")) ||
241 obt_xml_load_config_file(i, "openbox", "rc.xml",
244 obt_xml_tree_from_root(i);
248 g_message(_("Unable to find a valid config file, using some simple defaults"));
253 gchar *p = g_filename_to_utf8(config_file, -1,
256 OBT_PROP_SETS(obt_root(ob_screen), OB_CONFIG_FILE,
261 OBT_PROP_ERASE(obt_root(ob_screen), OB_CONFIG_FILE);
263 /* we're done with parsing now, kill it */
264 obt_xml_instance_unref(i);
267 /* load the theme specified in the rc file */
270 if ((theme = RrThemeNew(ob_rr_inst, config_theme, TRUE,
271 config_font_activewindow,
272 config_font_inactivewindow,
273 config_font_menutitle,
274 config_font_menuitem,
275 config_font_activeosd,
276 config_font_inactiveosd)))
278 RrThemeFree(ob_rr_theme);
281 if (ob_rr_theme == NULL)
282 ob_exit_with_error(_("Unable to load a theme."));
284 OBT_PROP_SETS(obt_root(ob_screen),
285 OB_THEME, utf8, ob_rr_theme->name);
291 /* update all existing windows for the new theme */
292 for (it = client_list; it; it = g_list_next(it)) {
293 ObClient *c = it->data;
294 frame_adjust_theme(c->frame);
297 event_startup(reconfigure);
298 /* focus_backup is used for stacking, so this needs to come before
299 anything that calls stacking_add */
300 sn_startup(reconfigure);
301 window_startup(reconfigure);
302 focus_startup(reconfigure);
303 focus_cycle_startup(reconfigure);
304 focus_cycle_indicator_startup(reconfigure);
305 focus_cycle_popup_startup(reconfigure);
306 screen_startup(reconfigure);
307 grab_startup(reconfigure);
308 group_startup(reconfigure);
309 ping_startup(reconfigure);
310 client_startup(reconfigure);
311 dock_startup(reconfigure);
312 moveresize_startup(reconfigure);
313 keyboard_startup(reconfigure);
314 mouse_startup(reconfigure);
315 menu_frame_startup(reconfigure);
316 menu_startup(reconfigure);
317 prompt_startup(reconfigure);
323 /* get all the existing windows */
326 /* focus what was focused if a wm was already running */
327 if (OBT_PROP_GET32(obt_root(ob_screen),
328 NET_ACTIVE_WINDOW, WINDOW, &xid) &&
329 (w = window_find(xid)) && WINDOW_IS_CLIENT(w))
331 client_focus(WINDOW_AS_CLIENT(w));
336 /* redecorate all existing windows */
337 for (it = client_list; it; it = g_list_next(it)) {
338 ObClient *c = it->data;
340 /* the new config can change the window's decorations */
341 client_setup_decor_and_functions(c, FALSE);
342 /* redraw the frames */
343 frame_adjust_area(c->frame, TRUE, TRUE, FALSE);
344 /* the decor sizes may have changed, so the windows may
345 end up in new positions */
346 client_reconfigure(c, FALSE);
352 ob_set_state(OB_STATE_RUNNING);
354 if (startup_cmd) run_startup_cmd();
356 /* look for parsing errors */
358 xmlErrorPtr e = xmlGetLastError();
362 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);
364 prompt_show_message(m, _("Openbox Syntax Error"), _("Close"));
370 obt_main_loop_run(ob_main_loop);
371 ob_set_state(reconfigure ?
372 OB_STATE_RECONFIGURING : OB_STATE_EXITING);
375 prompt_unref(xmlprompt);
380 window_unmanage_all();
382 prompt_shutdown(reconfigure);
383 menu_shutdown(reconfigure);
384 menu_frame_shutdown(reconfigure);
385 mouse_shutdown(reconfigure);
386 keyboard_shutdown(reconfigure);
387 moveresize_shutdown(reconfigure);
388 dock_shutdown(reconfigure);
389 client_shutdown(reconfigure);
390 ping_shutdown(reconfigure);
391 group_shutdown(reconfigure);
392 grab_shutdown(reconfigure);
393 screen_shutdown(reconfigure);
394 focus_cycle_popup_shutdown(reconfigure);
395 focus_cycle_indicator_shutdown(reconfigure);
396 focus_cycle_shutdown(reconfigure);
397 focus_shutdown(reconfigure);
398 window_shutdown(reconfigure);
399 sn_shutdown(reconfigure);
400 event_shutdown(reconfigure);
402 actions_shutdown(reconfigure);
403 } while (reconfigure);
406 XSync(obt_display, FALSE);
408 RrThemeFree(ob_rr_theme);
409 RrImageCacheUnref(ob_rr_icons);
410 RrInstanceFree(ob_rr_inst);
412 session_shutdown(being_replaced);
418 if (restart_path != NULL) {
423 /* run other window manager */
424 if (g_shell_parse_argv(restart_path, &argcp, &argvp, &err)) {
425 execvp(argvp[0], argvp);
429 _("Restart failed to execute new executable \"%s\": %s"),
430 restart_path, err->message);
435 /* we remove the session arguments from argv, so put them back,
436 also don't restore the session on restart */
437 if (ob_sm_save_file != NULL || ob_sm_id != NULL) {
442 (ob_sm_save_file != NULL ? 2 : 0) +
443 (ob_sm_id != NULL ? 2 : 0);
444 nargv = g_new0(gchar*, l+1);
445 for (i = 0; i < argc; ++i)
448 if (ob_sm_save_file != NULL) {
449 nargv[i++] = g_strdup("--sm-save-file");
450 nargv[i++] = ob_sm_save_file;
452 if (ob_sm_id != NULL) {
453 nargv[i++] = g_strdup("--sm-client-id");
454 nargv[i++] = ob_sm_id;
456 nargv[i++] = g_strdup("--sm-no-load");
462 execvp(argv[0], argv); /* try how we were run */
463 execlp(argv[0], program_name, (gchar*)NULL); /* last resort */
466 /* free stuff passed in from the command line or environment */
467 g_free(ob_sm_save_file);
469 g_free(program_name);
477 static void signal_handler(gint signal, gpointer data)
481 ob_debug("Caught signal %d. Restarting.", signal);
485 ob_debug("Caught signal %d. Reconfiguring.", signal);
490 while (waitpid(-1, NULL, WNOHANG) > 0);
494 ob_debug("Caught signal %d. Ignoring.", signal);
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(_(" --startup CMD Run CMD after starting\n"));
534 g_print(_(" --debug Display debugging output\n"));
535 g_print(_(" --debug-focus Display debugging output for focus handling\n"));
536 g_print(_(" --debug-session Display debugging output for session management\n"));
537 g_print(_(" --debug-xinerama Split the display into fake xinerama screens\n"));
538 g_print(_("\nPlease report bugs at %s\n"), PACKAGE_BUGREPORT);
541 static void remove_args(gint *argc, gchar **argv, gint index, gint num)
545 for (i = index; i < *argc - num; ++i)
546 argv[i] = argv[i+num];
547 for (; i < *argc; ++i)
552 static void run_startup_cmd(void)
558 if (!g_shell_parse_argv(startup_cmd, NULL, &argv, &e)) {
559 g_message("Error parsing startup command: %s",
564 ok = g_spawn_async(NULL, argv, NULL,
565 G_SPAWN_SEARCH_PATH |
566 G_SPAWN_DO_NOT_REAP_CHILD,
567 NULL, NULL, NULL, &e);
568 if (!g_shell_parse_argv(startup_cmd, NULL, &argv, &e)) {
569 g_message("Error launching startup command: %s",
576 static void parse_env(void)
580 /* unset this so we don't pass it on unknowingly */
581 unsetenv("DESKTOP_STARTUP_ID");
583 /* this is how gnome-session passes in a session client id */
584 id = g_getenv("DESKTOP_AUTOSTART_ID");
586 unsetenv("DESKTOP_AUTOSTART_ID");
587 if (ob_sm_id) g_free(ob_sm_id);
588 ob_sm_id = g_strdup(id);
589 ob_debug_type(OB_DEBUG_SM,
590 "DESKTOP_AUTOSTART_ID %s supercedes --sm-client-id\n",
595 static void parse_args(gint *argc, gchar **argv)
599 for (i = 1; i < *argc; ++i) {
600 if (!strcmp(argv[i], "--version")) {
604 else if (!strcmp(argv[i], "--help")) {
608 else if (!strcmp(argv[i], "--g-fatal-warnings")) {
609 g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL);
611 else if (!strcmp(argv[i], "--replace")) {
612 ob_replace_wm = TRUE;
613 remove_args(argc, argv, i, 1);
614 --i; /* this arg was removed so go back */
616 else if (!strcmp(argv[i], "--sync")) {
619 else if (!strcmp(argv[i], "--startup")) {
620 if (i == *argc - 1) /* no args left */
621 g_printerr(_("--startup requires an argument\n"));
623 /* this will be in the current locale encoding, which is
625 startup_cmd = argv[i+1];
626 remove_args(argc, argv, i, 2);
627 --i; /* this arg was removed so go back */
628 ob_debug("--startup %s", startup_cmd);
631 else if (!strcmp(argv[i], "--debug")) {
632 ob_debug_enable(OB_DEBUG_NORMAL, TRUE);
633 ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
635 else if (!strcmp(argv[i], "--debug-focus")) {
636 ob_debug_enable(OB_DEBUG_FOCUS, TRUE);
638 else if (!strcmp(argv[i], "--debug-session")) {
639 ob_debug_enable(OB_DEBUG_SM, TRUE);
641 else if (!strcmp(argv[i], "--debug-xinerama")) {
642 ob_debug_xinerama = TRUE;
644 else if (!strcmp(argv[i], "--reconfigure")) {
647 else if (!strcmp(argv[i], "--restart")) {
650 else if (!strcmp(argv[i], "--exit")) {
653 else if (!strcmp(argv[i], "--config-file")) {
654 if (i == *argc - 1) /* no args left */
655 g_printerr(_("--config-file requires an argument\n"));
657 /* this will be in the current locale encoding, which is
659 config_file = argv[i+1];
660 ++i; /* skip the argument */
661 ob_debug("--config-file %s", config_file);
664 else if (!strcmp(argv[i], "--sm-save-file")) {
665 if (i == *argc - 1) /* no args left */
666 /* not translated cuz it's sekret */
667 g_printerr("--sm-save-file requires an argument\n");
669 ob_sm_save_file = g_strdup(argv[i+1]);
670 remove_args(argc, argv, i, 2);
671 --i; /* this arg was removed so go back */
672 ob_debug_type(OB_DEBUG_SM, "--sm-save-file %s",
676 else if (!strcmp(argv[i], "--sm-client-id")) {
677 if (i == *argc - 1) /* no args left */
678 /* not translated cuz it's sekret */
679 g_printerr("--sm-client-id requires an argument\n");
681 ob_sm_id = g_strdup(argv[i+1]);
682 remove_args(argc, argv, i, 2);
683 --i; /* this arg was removed so go back */
684 ob_debug_type(OB_DEBUG_SM, "--sm-client-id %s", ob_sm_id);
687 else if (!strcmp(argv[i], "--sm-disable")) {
690 else if (!strcmp(argv[i], "--sm-no-load")) {
691 ob_sm_restore = FALSE;
692 remove_args(argc, argv, i, 1);
693 --i; /* this arg was removed so go back */
696 /* this is a memleak.. oh well.. heh */
697 gchar *err = g_strdup_printf
698 (_("Invalid command line argument \"%s\"\n"), argv[i]);
699 ob_exit_with_error(err);
704 static Cursor load_cursor(const gchar *name, guint fontval)
709 c = XcursorLibraryLoadCursor(obt_display, name);
712 c = XCreateFontCursor(obt_display, fontval);
716 void ob_exit_with_error(const gchar *msg)
718 g_message("%s", msg);
719 session_shutdown(TRUE);
723 void ob_restart_other(const gchar *path)
725 restart_path = g_strdup(path);
729 void ob_restart(void)
735 void ob_reconfigure(void)
741 void ob_exit(gint code)
744 obt_main_loop_exit(ob_main_loop);
747 void ob_exit_replace(void)
750 being_replaced = TRUE;
751 obt_main_loop_exit(ob_main_loop);
754 Cursor ob_cursor(ObCursor cursor)
756 g_assert(cursor < OB_NUM_CURSORS);
757 return cursors[cursor];
760 ObState ob_state(void)
765 void ob_set_state(ObState s)