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"
49 #include "obt/xqueue.h"
50 #include "obt/signal.h"
52 #include "obt/keyboard.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>
85 RrInstance *ob_rr_inst;
86 RrImageCache *ob_rr_icons;
88 GMainLoop *ob_main_loop;
90 gboolean ob_replace_wm = FALSE;
91 gboolean ob_sm_use = TRUE;
92 gchar *ob_sm_id = NULL;
93 gchar *ob_sm_save_file = NULL;
94 gboolean ob_sm_restore = TRUE;
95 gboolean ob_debug_xinerama = FALSE;
96 const gchar *ob_locale_msg = NULL;
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 gint exitcode = 0;
105 static guint remote_control = 0;
106 static gboolean being_replaced = FALSE;
107 static gchar *config_file = NULL;
108 static gchar *startup_cmd = 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);
115 static void run_startup_cmd(void);
117 gint main(gint argc, gchar **argv)
123 ob_set_state(OB_STATE_STARTING);
127 /* initialize the locale */
128 if (!(ob_locale_msg = setlocale(LC_MESSAGES, "")))
129 g_message("Couldn't set messages locale category from environment.");
130 if (!setlocale(LC_ALL, ""))
131 g_message("Couldn't set locale from environment.");
132 bindtextdomain(PACKAGE_NAME, LOCALEDIR);
133 bind_textdomain_codeset(PACKAGE_NAME, "UTF-8");
134 textdomain(PACKAGE_NAME);
136 if (chdir(g_get_home_dir()) == -1)
137 g_message(_("Unable to change to home directory \"%s\": %s"),
138 g_get_home_dir(), g_strerror(errno));
140 /* parse the command line args, which can change the argv[0] */
141 parse_args(&argc, argv);
142 /* parse the environment variables */
145 program_name = g_path_get_basename(argv[0]);
146 g_set_prgname(program_name);
149 session_startup(argc, argv);
151 if (!obt_display_open(NULL))
152 ob_exit_with_error(_("Failed to open the display from the DISPLAY environment variable."));
154 if (remote_control) {
155 /* Send client message telling the OB process to:
156 * remote_control = 1 -> reconfigure
157 * remote_control = 2 -> restart */
158 OBT_PROP_MSG(ob_screen, obt_root(ob_screen),
159 OB_CONTROL, remote_control, 0, 0, 0, 0);
164 ob_main_loop = g_main_loop_new(NULL, FALSE);
166 /* set up signal handlers, they are called from the mainloop
167 in the main program's thread */
168 obt_signal_add_callback(SIGUSR1, signal_handler, NULL);
169 obt_signal_add_callback(SIGUSR2, signal_handler, NULL);
170 obt_signal_add_callback(SIGTERM, signal_handler, NULL);
171 obt_signal_add_callback(SIGINT, signal_handler, NULL);
172 obt_signal_add_callback(SIGHUP, signal_handler, NULL);
173 obt_signal_add_callback(SIGPIPE, signal_handler, NULL);
174 obt_signal_add_callback(SIGCHLD, signal_handler, NULL);
175 obt_signal_add_callback(SIGTTIN, signal_handler, NULL);
176 obt_signal_add_callback(SIGTTOU, signal_handler, NULL);
178 ob_screen = DefaultScreen(obt_display);
180 ob_rr_inst = RrInstanceNew(obt_display, ob_screen);
181 if (ob_rr_inst == NULL)
182 ob_exit_with_error(_("Failed to initialize the obrender library."));
183 /* Saving 3 resizes of an RrImage makes a lot of sense for icons, as there
184 are generally 3 icon sizes needed: the titlebar icon, the menu icon,
187 ob_rr_icons = RrImageCacheNew(3);
189 XSynchronize(obt_display, xsync);
191 /* check for locale support */
192 if (!XSupportsLocale())
193 g_message(_("X server does not support locale."));
194 if (!XSetLocaleModifiers(""))
195 g_message(_("Cannot set locale modifiers for the X server."));
197 /* set the DISPLAY environment variable for any lauched children, to the
198 display we're using, so they open in the right place. */
199 g_setenv("DISPLAY", DisplayString(obt_display), TRUE);
201 /* create available cursors */
202 cursors[OB_CURSOR_NONE] = None;
203 cursors[OB_CURSOR_POINTER] = load_cursor("left_ptr", XC_left_ptr);
204 cursors[OB_CURSOR_BUSYPOINTER] = load_cursor("left_ptr_watch",XC_left_ptr);
205 cursors[OB_CURSOR_BUSY] = load_cursor("watch", XC_watch);
206 cursors[OB_CURSOR_MOVE] = load_cursor("fleur", XC_fleur);
207 cursors[OB_CURSOR_NORTH] = load_cursor("top_side", XC_top_side);
208 cursors[OB_CURSOR_NORTHEAST] = load_cursor("top_right_corner",
209 XC_top_right_corner);
210 cursors[OB_CURSOR_EAST] = load_cursor("right_side", XC_right_side);
211 cursors[OB_CURSOR_SOUTHEAST] = load_cursor("bottom_right_corner",
212 XC_bottom_right_corner);
213 cursors[OB_CURSOR_SOUTH] = load_cursor("bottom_side", XC_bottom_side);
214 cursors[OB_CURSOR_SOUTHWEST] = load_cursor("bottom_left_corner",
215 XC_bottom_left_corner);
216 cursors[OB_CURSOR_WEST] = load_cursor("left_side", XC_left_side);
217 cursors[OB_CURSOR_NORTHWEST] = load_cursor("top_left_corner",
220 if (screen_annex()) { /* it will be ours! */
222 /* get a timestamp from after taking over as the WM. if we use the
223 old timestamp to set focus it can fail when replacing another WM. */
227 ObPrompt *xmlprompt = NULL;
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 */
239 actions_startup(reconfigure);
240 /* start up config which sets up with the parser */
243 /* parse/load user options */
245 obt_xml_load_file(i, config_file, "openbox_config")) ||
246 obt_xml_load_config_file(i, "openbox", "rc.xml",
249 obt_xml_tree_from_root(i);
253 g_message(_("Unable to find a valid config file, using some simple defaults"));
258 gchar *p = g_filename_to_utf8(config_file, -1,
261 OBT_PROP_SETS(obt_root(ob_screen), OB_CONFIG_FILE, p);
265 OBT_PROP_ERASE(obt_root(ob_screen), OB_CONFIG_FILE);
267 /* we're done with parsing now, kill it */
268 obt_xml_instance_unref(i);
271 /* load the theme specified in the rc file */
274 if ((theme = RrThemeNew(ob_rr_inst, config_theme, TRUE,
275 config_font_activewindow,
276 config_font_inactivewindow,
277 config_font_menutitle,
278 config_font_menuitem,
279 config_font_activeosd,
280 config_font_inactiveosd)))
282 RrThemeFree(ob_rr_theme);
285 if (ob_rr_theme == NULL)
286 ob_exit_with_error(_("Unable to load a theme."));
288 OBT_PROP_SETS(obt_root(ob_screen), OB_THEME,
295 /* update all existing windows for the new theme */
296 for (it = client_list; it; it = g_list_next(it)) {
297 ObClient *c = it->data;
298 frame_adjust_theme(c->frame);
301 event_startup(reconfigure);
302 /* focus_backup is used for stacking, so this needs to come before
303 anything that calls stacking_add */
304 sn_startup(reconfigure);
305 window_startup(reconfigure);
306 focus_startup(reconfigure);
307 focus_cycle_startup(reconfigure);
308 focus_cycle_indicator_startup(reconfigure);
309 focus_cycle_popup_startup(reconfigure);
310 screen_startup(reconfigure);
311 grab_startup(reconfigure);
312 group_startup(reconfigure);
313 ping_startup(reconfigure);
314 client_startup(reconfigure);
315 dock_startup(reconfigure);
316 moveresize_startup(reconfigure);
317 keyboard_startup(reconfigure);
318 mouse_startup(reconfigure);
319 menu_frame_startup(reconfigure);
320 menu_startup(reconfigure);
321 prompt_startup(reconfigure);
323 /* do this after everything is started so no events will get
331 /* get all the existing windows */
334 /* focus what was focused if a wm was already running */
335 if (OBT_PROP_GET32(obt_root(ob_screen),
336 NET_ACTIVE_WINDOW, WINDOW, &xid) &&
337 (w = window_find(xid)) && WINDOW_IS_CLIENT(w))
339 client_focus(WINDOW_AS_CLIENT(w));
344 /* redecorate all existing windows */
345 for (it = client_list; it; it = g_list_next(it)) {
346 ObClient *c = it->data;
348 /* the new config can change the window's decorations */
349 client_setup_decor_and_functions(c, FALSE);
350 /* redraw the frames */
351 frame_adjust_area(c->frame, TRUE, TRUE, FALSE);
352 /* the decor sizes may have changed, so the windows may
353 end up in new positions */
354 client_reconfigure(c, FALSE);
358 ob_set_state(OB_STATE_RUNNING);
360 if (!reconfigure && startup_cmd) run_startup_cmd();
364 /* look for parsing errors */
366 xmlErrorPtr e = xmlGetLastError();
370 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);
372 prompt_show_message(m, _("Openbox Syntax Error"), _("Close"));
378 g_main_loop_run(ob_main_loop);
379 ob_set_state(reconfigure ?
380 OB_STATE_RECONFIGURING : OB_STATE_EXITING);
383 prompt_unref(xmlprompt);
388 window_unmanage_all();
390 prompt_shutdown(reconfigure);
391 menu_shutdown(reconfigure);
392 menu_frame_shutdown(reconfigure);
393 mouse_shutdown(reconfigure);
394 keyboard_shutdown(reconfigure);
395 moveresize_shutdown(reconfigure);
396 dock_shutdown(reconfigure);
397 client_shutdown(reconfigure);
398 ping_shutdown(reconfigure);
399 group_shutdown(reconfigure);
400 grab_shutdown(reconfigure);
401 screen_shutdown(reconfigure);
402 focus_cycle_popup_shutdown(reconfigure);
403 focus_cycle_indicator_shutdown(reconfigure);
404 focus_cycle_shutdown(reconfigure);
405 focus_shutdown(reconfigure);
406 window_shutdown(reconfigure);
407 sn_shutdown(reconfigure);
408 event_shutdown(reconfigure);
410 actions_shutdown(reconfigure);
411 } while (reconfigure);
414 XSync(obt_display, FALSE);
416 RrThemeFree(ob_rr_theme);
417 RrImageCacheUnref(ob_rr_icons);
418 RrInstanceFree(ob_rr_inst);
420 session_shutdown(being_replaced);
427 if (restart_path != NULL) {
432 /* run other window manager */
433 if (g_shell_parse_argv(restart_path, &argcp, &argvp, &err)) {
434 execvp(argvp[0], argvp);
438 _("Restart failed to execute new executable \"%s\": %s"),
439 restart_path, err->message);
444 /* we remove the session arguments from argv, so put them back,
445 also don't restore the session on restart */
446 if (ob_sm_save_file != NULL || ob_sm_id != NULL) {
451 (ob_sm_save_file != NULL ? 2 : 0) +
452 (ob_sm_id != NULL ? 2 : 0);
453 nargv = g_new0(gchar*, l+1);
454 for (i = 0; i < argc; ++i)
457 if (ob_sm_save_file != NULL) {
458 nargv[i++] = g_strdup("--sm-save-file");
459 nargv[i++] = ob_sm_save_file;
461 if (ob_sm_id != NULL) {
462 nargv[i++] = g_strdup("--sm-client-id");
463 nargv[i++] = ob_sm_id;
465 nargv[i++] = g_strdup("--sm-no-load");
471 execvp(argv[0], argv); /* try how we were run */
472 execlp(argv[0], program_name, (gchar*)NULL); /* last resort */
475 /* free stuff passed in from the command line or environment */
476 g_free(ob_sm_save_file);
478 g_free(program_name);
488 static void signal_handler(gint signal, gpointer data)
492 ob_debug("Caught signal %d. Restarting.", signal);
496 ob_debug("Caught signal %d. Reconfiguring.", signal);
501 while (waitpid(-1, NULL, WNOHANG) > 0);
505 ob_debug("Caught signal %d. Ignoring.", signal);
508 ob_debug("Caught signal %d. Exiting.", signal);
509 /* TERM and INT return a 0 code */
510 ob_exit(!(signal == SIGTERM || signal == SIGINT));
514 static void print_version(void)
516 g_print("Openbox %s\n", PACKAGE_VERSION);
517 g_print(_("Copyright (c)"));
518 g_print(" 2004 Mikael Magnusson\n");
519 g_print(_("Copyright (c)"));
520 g_print(" 2002 Dana Jansens\n\n");
521 g_print("This program comes with ABSOLUTELY NO WARRANTY.\n");
522 g_print("This is free software, and you are welcome to redistribute it\n");
523 g_print("under certain conditions. See the file COPYING for details.\n\n");
526 static void print_help(void)
528 g_print(_("Syntax: openbox [options]\n"));
529 g_print(_("\nOptions:\n"));
530 g_print(_(" --help Display this help and exit\n"));
531 g_print(_(" --version Display the version and exit\n"));
532 g_print(_(" --replace Replace the currently running window manager\n"));
533 /* TRANSLATORS: if you translate "FILE" here, make sure to keep the "Specify..."
534 aligned still, if you have to, make a new line with \n and 22 spaces. It's
535 fine to leave it as FILE though. */
536 g_print(_(" --config-file FILE Specify the path to the config file to use\n"));
537 g_print(_(" --sm-disable Disable connection to the session manager\n"));
538 g_print(_("\nPassing messages to a running Openbox instance:\n"));
539 g_print(_(" --reconfigure Reload Openbox's configuration\n"));
540 g_print(_(" --restart Restart Openbox\n"));
541 g_print(_(" --exit Exit Openbox\n"));
542 g_print(_("\nDebugging options:\n"));
543 g_print(_(" --sync Run in synchronous mode\n"));
544 g_print(_(" --startup CMD Run CMD after starting\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-session Display debugging output for session management\n"));
548 g_print(_(" --debug-xinerama Split the display into fake xinerama screens\n"));
549 g_print(_("\nPlease report bugs at %s\n"), PACKAGE_BUGREPORT);
552 static void remove_args(gint *argc, gchar **argv, gint index, gint num)
556 for (i = index; i < *argc - num; ++i)
557 argv[i] = argv[i+num];
558 for (; i < *argc; ++i)
563 static void run_startup_cmd(void)
569 if (!g_shell_parse_argv(startup_cmd, NULL, &argv, &e)) {
570 g_message("Error parsing startup command: %s",
575 ok = g_spawn_async(NULL, argv, NULL,
576 G_SPAWN_SEARCH_PATH |
577 G_SPAWN_DO_NOT_REAP_CHILD,
578 NULL, NULL, NULL, &e);
580 g_message("Error launching startup command: %s",
587 static void parse_env(void)
591 /* unset this so we don't pass it on unknowingly */
592 g_unsetenv("DESKTOP_STARTUP_ID");
594 /* this is how gnome-session passes in a session client id */
595 id = g_getenv("DESKTOP_AUTOSTART_ID");
597 g_unsetenv("DESKTOP_AUTOSTART_ID");
598 if (ob_sm_id) g_free(ob_sm_id);
599 ob_sm_id = g_strdup(id);
600 ob_debug_type(OB_DEBUG_SM,
601 "DESKTOP_AUTOSTART_ID %s supercedes --sm-client-id\n",
606 static void parse_args(gint *argc, gchar **argv)
610 for (i = 1; i < *argc; ++i) {
611 if (!strcmp(argv[i], "--version")) {
615 else if (!strcmp(argv[i], "--help")) {
619 else if (!strcmp(argv[i], "--g-fatal-warnings")) {
620 g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL);
622 else if (!strcmp(argv[i], "--replace")) {
623 ob_replace_wm = TRUE;
624 remove_args(argc, argv, i, 1);
625 --i; /* this arg was removed so go back */
627 else if (!strcmp(argv[i], "--sync")) {
630 else if (!strcmp(argv[i], "--startup")) {
631 if (i == *argc - 1) /* no args left */
632 g_printerr(_("%s requires an argument\n"), "--startup");
634 /* this will be in the current locale encoding, which is
636 startup_cmd = argv[i+1];
637 remove_args(argc, argv, i, 2);
638 --i; /* this arg was removed so go back */
639 ob_debug("--startup %s", startup_cmd);
642 else if (!strcmp(argv[i], "--debug")) {
643 ob_debug_enable(OB_DEBUG_NORMAL, TRUE);
644 ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
646 else if (!strcmp(argv[i], "--debug-focus")) {
647 ob_debug_enable(OB_DEBUG_FOCUS, TRUE);
649 else if (!strcmp(argv[i], "--debug-session")) {
650 ob_debug_enable(OB_DEBUG_SM, TRUE);
652 else if (!strcmp(argv[i], "--debug-xinerama")) {
653 ob_debug_xinerama = TRUE;
655 else if (!strcmp(argv[i], "--reconfigure")) {
658 else if (!strcmp(argv[i], "--restart")) {
661 else if (!strcmp(argv[i], "--exit")) {
664 else if (!strcmp(argv[i], "--config-file")) {
665 if (i == *argc - 1) /* no args left */
666 g_printerr(_("%s requires an argument\n"), "--config-file");
668 /* this will be in the current locale encoding, which is
670 config_file = argv[i+1];
671 ++i; /* skip the argument */
672 ob_debug("--config-file %s", config_file);
675 else if (!strcmp(argv[i], "--sm-save-file")) {
676 if (i == *argc - 1) /* no args left */
677 /* not translated cuz it's sekret */
678 g_printerr("--sm-save-file requires an argument\n");
680 ob_sm_save_file = g_strdup(argv[i+1]);
681 remove_args(argc, argv, i, 2);
682 --i; /* this arg was removed so go back */
683 ob_debug_type(OB_DEBUG_SM, "--sm-save-file %s",
687 else if (!strcmp(argv[i], "--sm-client-id")) {
688 if (i == *argc - 1) /* no args left */
689 /* not translated cuz it's sekret */
690 g_printerr("--sm-client-id requires an argument\n");
692 ob_sm_id = g_strdup(argv[i+1]);
693 remove_args(argc, argv, i, 2);
694 --i; /* this arg was removed so go back */
695 ob_debug_type(OB_DEBUG_SM, "--sm-client-id %s", ob_sm_id);
698 else if (!strcmp(argv[i], "--sm-disable")) {
701 else if (!strcmp(argv[i], "--sm-no-load")) {
702 ob_sm_restore = FALSE;
703 remove_args(argc, argv, i, 1);
704 --i; /* this arg was removed so go back */
707 /* this is a memleak.. oh well.. heh */
708 gchar *err = g_strdup_printf
709 (_("Invalid command line argument \"%s\"\n"), argv[i]);
710 ob_exit_with_error(err);
715 static Cursor load_cursor(const gchar *name, guint fontval)
720 c = XcursorLibraryLoadCursor(obt_display, name);
723 c = XCreateFontCursor(obt_display, fontval);
727 void ob_exit_with_error(const gchar *msg)
729 g_message("%s", msg);
730 session_shutdown(TRUE);
734 void ob_restart_other(const gchar *path)
736 restart_path = g_strdup(path);
740 void ob_restart(void)
746 void ob_reconfigure(void)
752 void ob_exit(gint code)
755 g_main_loop_quit(ob_main_loop);
758 void ob_exit_replace(void)
761 being_replaced = TRUE;
762 g_main_loop_quit(ob_main_loop);
765 Cursor ob_cursor(ObCursor cursor)
767 g_assert(cursor < OB_NUM_CURSORS);
768 return cursors[cursor];
771 ObState ob_state(void)
776 void ob_set_state(ObState s)