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;
96 static gboolean xsync = FALSE;
97 static gboolean reconfigure = FALSE;
98 static gboolean restart = FALSE;
99 static gchar *restart_path = NULL;
100 static Cursor cursors[OB_NUM_CURSORS];
101 static gint exitcode = 0;
102 static guint remote_control = 0;
103 static gboolean being_replaced = FALSE;
104 static gchar *config_file = NULL;
105 static gchar *startup_cmd = NULL;
107 static void signal_handler(gint signal, gpointer data);
108 static void remove_args(gint *argc, gchar **argv, gint index, gint num);
109 static void parse_env();
110 static void parse_args(gint *argc, gchar **argv);
111 static Cursor load_cursor(const gchar *name, guint fontval);
112 static void run_startup_cmd(void);
114 gint main(gint argc, gchar **argv)
118 ob_set_state(OB_STATE_STARTING);
122 /* initialize the locale */
123 if (!setlocale(LC_ALL, ""))
124 g_message("Couldn't set locale from environment.");
125 bindtextdomain(PACKAGE_NAME, LOCALEDIR);
126 bind_textdomain_codeset(PACKAGE_NAME, "UTF-8");
127 textdomain(PACKAGE_NAME);
129 if (chdir(g_get_home_dir()) == -1)
130 g_message(_("Unable to change to home directory \"%s\": %s"),
131 g_get_home_dir(), g_strerror(errno));
133 /* parse the command line args, which can change the argv[0] */
134 parse_args(&argc, argv);
135 /* parse the environment variables */
138 program_name = g_path_get_basename(argv[0]);
139 g_set_prgname(program_name);
142 session_startup(argc, argv);
144 if (!obt_display_open(NULL))
145 ob_exit_with_error(_("Failed to open the display from the DISPLAY environment variable."));
147 if (remote_control) {
148 /* Send client message telling the OB process to:
149 * remote_control = 1 -> reconfigure
150 * remote_control = 2 -> restart */
151 OBT_PROP_MSG(ob_screen, obt_root(ob_screen),
152 OB_CONTROL, remote_control, 0, 0, 0, 0);
157 ob_main_loop = obt_main_loop_new();
159 /* set up signal handler */
160 obt_main_loop_signal_add(ob_main_loop, SIGUSR1, signal_handler, NULL,NULL);
161 obt_main_loop_signal_add(ob_main_loop, SIGUSR2, signal_handler, NULL,NULL);
162 obt_main_loop_signal_add(ob_main_loop, SIGTERM, signal_handler, NULL,NULL);
163 obt_main_loop_signal_add(ob_main_loop, SIGINT, signal_handler, NULL,NULL);
164 obt_main_loop_signal_add(ob_main_loop, SIGHUP, signal_handler, NULL,NULL);
165 obt_main_loop_signal_add(ob_main_loop, SIGPIPE, signal_handler, NULL,NULL);
166 obt_main_loop_signal_add(ob_main_loop, SIGCHLD, signal_handler, NULL,NULL);
167 obt_main_loop_signal_add(ob_main_loop, SIGTTIN, signal_handler, NULL,NULL);
168 obt_main_loop_signal_add(ob_main_loop, SIGTTOU, signal_handler, NULL,NULL);
170 ob_screen = DefaultScreen(obt_display);
172 ob_rr_inst = RrInstanceNew(obt_display, ob_screen);
173 if (ob_rr_inst == NULL)
174 ob_exit_with_error(_("Failed to initialize the obrender library."));
175 /* Saving 3 resizes of an RrImage makes a lot of sense for icons, as there
176 are generally 3 icon sizes needed: the titlebar icon, the menu icon,
179 ob_rr_icons = RrImageCacheNew(3);
181 XSynchronize(obt_display, xsync);
183 /* check for locale support */
184 if (!XSupportsLocale())
185 g_message(_("X server does not support locale."));
186 if (!XSetLocaleModifiers(""))
187 g_message(_("Cannot set locale modifiers for the X server."));
189 /* set the DISPLAY environment variable for any lauched children, to the
190 display we're using, so they open in the right place. */
191 setenv("DISPLAY", DisplayString(obt_display), TRUE);
193 /* create available cursors */
194 cursors[OB_CURSOR_NONE] = None;
195 cursors[OB_CURSOR_POINTER] = load_cursor("left_ptr", XC_left_ptr);
196 cursors[OB_CURSOR_BUSYPOINTER] = load_cursor("left_ptr_watch",XC_left_ptr);
197 cursors[OB_CURSOR_BUSY] = load_cursor("watch", XC_watch);
198 cursors[OB_CURSOR_MOVE] = load_cursor("fleur", XC_fleur);
199 cursors[OB_CURSOR_NORTH] = load_cursor("top_side", XC_top_side);
200 cursors[OB_CURSOR_NORTHEAST] = load_cursor("top_right_corner",
201 XC_top_right_corner);
202 cursors[OB_CURSOR_EAST] = load_cursor("right_side", XC_right_side);
203 cursors[OB_CURSOR_SOUTHEAST] = load_cursor("bottom_right_corner",
204 XC_bottom_right_corner);
205 cursors[OB_CURSOR_SOUTH] = load_cursor("bottom_side", XC_bottom_side);
206 cursors[OB_CURSOR_SOUTHWEST] = load_cursor("bottom_left_corner",
207 XC_bottom_left_corner);
208 cursors[OB_CURSOR_WEST] = load_cursor("left_side", XC_left_side);
209 cursors[OB_CURSOR_NORTHWEST] = load_cursor("top_left_corner",
212 if (screen_annex()) { /* it will be ours! */
214 ObPrompt *xmlprompt = NULL;
216 if (reconfigure) obt_keyboard_reload();
221 /* startup the parsing so everything can register sections
223 i = obt_xml_instance_new();
225 /* register all the available actions */
226 actions_startup(reconfigure);
227 /* start up config which sets up with the parser */
230 /* parse/load user options */
232 obt_xml_load_file(i, config_file, "openbox_config")) ||
233 obt_xml_load_config_file(i, "openbox", "rc.xml",
236 obt_xml_tree_from_root(i);
240 g_message(_("Unable to find a valid config file, using some simple defaults"));
245 gchar *p = g_filename_to_utf8(config_file, -1,
248 OBT_PROP_SETS(obt_root(ob_screen), OB_CONFIG_FILE,
253 OBT_PROP_ERASE(obt_root(ob_screen), OB_CONFIG_FILE);
255 /* we're done with parsing now, kill it */
256 obt_xml_instance_unref(i);
259 /* load the theme specified in the rc file */
262 if ((theme = RrThemeNew(ob_rr_inst, config_theme, TRUE,
263 config_font_activewindow,
264 config_font_inactivewindow,
265 config_font_menutitle,
266 config_font_menuitem,
267 config_font_activeosd,
268 config_font_inactiveosd)))
270 RrThemeFree(ob_rr_theme);
273 if (ob_rr_theme == NULL)
274 ob_exit_with_error(_("Unable to load a theme."));
276 OBT_PROP_SETS(obt_root(ob_screen),
277 OB_THEME, utf8, ob_rr_theme->name);
283 /* update all existing windows for the new theme */
284 for (it = client_list; it; it = g_list_next(it)) {
285 ObClient *c = it->data;
286 frame_adjust_theme(c->frame);
289 event_startup(reconfigure);
290 /* focus_backup is used for stacking, so this needs to come before
291 anything that calls stacking_add */
292 sn_startup(reconfigure);
293 window_startup(reconfigure);
294 focus_startup(reconfigure);
295 focus_cycle_startup(reconfigure);
296 focus_cycle_indicator_startup(reconfigure);
297 focus_cycle_popup_startup(reconfigure);
298 screen_startup(reconfigure);
299 grab_startup(reconfigure);
300 group_startup(reconfigure);
301 ping_startup(reconfigure);
302 client_startup(reconfigure);
303 dock_startup(reconfigure);
304 moveresize_startup(reconfigure);
305 keyboard_startup(reconfigure);
306 mouse_startup(reconfigure);
307 menu_frame_startup(reconfigure);
308 menu_startup(reconfigure);
309 prompt_startup(reconfigure);
315 /* get all the existing windows */
319 /* focus what was focused if a wm was already running */
320 if (OBT_PROP_GET32(obt_root(ob_screen),
321 NET_ACTIVE_WINDOW, WINDOW, &xid) &&
322 (w = window_find(xid)) && WINDOW_IS_CLIENT(w))
324 client_focus(WINDOW_AS_CLIENT(w));
329 /* redecorate all existing windows */
330 for (it = client_list; it; it = g_list_next(it)) {
331 ObClient *c = it->data;
333 /* the new config can change the window's decorations */
334 client_setup_decor_and_functions(c, FALSE);
335 /* redraw the frames */
336 frame_adjust_area(c->frame, TRUE, TRUE, FALSE);
337 /* the decor sizes may have changed, so the windows may
338 end up in new positions */
339 client_reconfigure(c, FALSE);
345 ob_set_state(OB_STATE_RUNNING);
347 if (startup_cmd) run_startup_cmd();
349 /* look for parsing errors */
351 xmlErrorPtr e = xmlGetLastError();
355 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);
357 prompt_show_message(m, _("Openbox Syntax Error"), _("Close"));
363 obt_main_loop_run(ob_main_loop);
364 ob_set_state(reconfigure ?
365 OB_STATE_RECONFIGURING : OB_STATE_EXITING);
368 prompt_unref(xmlprompt);
373 window_unmanage_all();
375 prompt_shutdown(reconfigure);
376 menu_shutdown(reconfigure);
377 menu_frame_shutdown(reconfigure);
378 mouse_shutdown(reconfigure);
379 keyboard_shutdown(reconfigure);
380 moveresize_shutdown(reconfigure);
381 dock_shutdown(reconfigure);
382 client_shutdown(reconfigure);
383 ping_shutdown(reconfigure);
384 group_shutdown(reconfigure);
385 grab_shutdown(reconfigure);
386 screen_shutdown(reconfigure);
387 focus_cycle_popup_shutdown(reconfigure);
388 focus_cycle_indicator_shutdown(reconfigure);
389 focus_cycle_shutdown(reconfigure);
390 focus_shutdown(reconfigure);
391 window_shutdown(reconfigure);
392 sn_shutdown(reconfigure);
393 event_shutdown(reconfigure);
395 actions_shutdown(reconfigure);
396 } while (reconfigure);
399 XSync(obt_display, FALSE);
401 RrThemeFree(ob_rr_theme);
402 RrImageCacheUnref(ob_rr_icons);
403 RrInstanceFree(ob_rr_inst);
405 session_shutdown(being_replaced);
411 if (restart_path != NULL) {
416 /* run other window manager */
417 if (g_shell_parse_argv(restart_path, &argcp, &argvp, &err)) {
418 execvp(argvp[0], argvp);
422 _("Restart failed to execute new executable \"%s\": %s"),
423 restart_path, err->message);
428 /* we remove the session arguments from argv, so put them back,
429 also don't restore the session on restart */
430 if (ob_sm_save_file != NULL || ob_sm_id != NULL) {
435 (ob_sm_save_file != NULL ? 2 : 0) +
436 (ob_sm_id != NULL ? 2 : 0);
437 nargv = g_new0(gchar*, l+1);
438 for (i = 0; i < argc; ++i)
441 if (ob_sm_save_file != NULL) {
442 nargv[i++] = g_strdup("--sm-save-file");
443 nargv[i++] = ob_sm_save_file;
445 if (ob_sm_id != NULL) {
446 nargv[i++] = g_strdup("--sm-client-id");
447 nargv[i++] = ob_sm_id;
449 nargv[i++] = g_strdup("--sm-no-load");
455 execvp(argv[0], argv); /* try how we were run */
456 execlp(argv[0], program_name, (gchar*)NULL); /* last resort */
459 /* free stuff passed in from the command line or environment */
460 g_free(ob_sm_save_file);
462 g_free(program_name);
470 static void signal_handler(gint signal, gpointer data)
474 ob_debug("Caught signal %d. Restarting.", signal);
478 ob_debug("Caught signal %d. Reconfiguring.", signal);
483 while (waitpid(-1, NULL, WNOHANG) > 0);
487 ob_debug("Caught signal %d. Ignoring.", signal);
490 ob_debug("Caught signal %d. Exiting.", signal);
491 /* TERM and INT return a 0 code */
492 ob_exit(!(signal == SIGTERM || signal == SIGINT));
496 static void print_version(void)
498 g_print("Openbox %s\n", PACKAGE_VERSION);
499 g_print(_("Copyright (c)"));
500 g_print(" 2008 Mikael Magnusson\n");
501 g_print(_("Copyright (c)"));
502 g_print(" 2003-2006 Dana Jansens\n\n");
503 g_print("This program comes with ABSOLUTELY NO WARRANTY.\n");
504 g_print("This is free software, and you are welcome to redistribute it\n");
505 g_print("under certain conditions. See the file COPYING for details.\n\n");
508 static void print_help(void)
510 g_print(_("Syntax: openbox [options]\n"));
511 g_print(_("\nOptions:\n"));
512 g_print(_(" --help Display this help and exit\n"));
513 g_print(_(" --version Display the version and exit\n"));
514 g_print(_(" --replace Replace the currently running window manager\n"));
515 /* TRANSLATORS: if you translate "FILE" here, make sure to keep the "Specify..."
516 aligned still, if you have to, make a new line with \n and 22 spaces. It's
517 fine to leave it as FILE though. */
518 g_print(_(" --config-file FILE Specify the path to the config file to use\n"));
519 g_print(_(" --sm-disable Disable connection to the session manager\n"));
520 g_print(_("\nPassing messages to a running Openbox instance:\n"));
521 g_print(_(" --reconfigure Reload Openbox's configuration\n"));
522 g_print(_(" --restart Restart Openbox\n"));
523 g_print(_(" --exit Exit Openbox\n"));
524 g_print(_("\nDebugging options:\n"));
525 g_print(_(" --sync Run in synchronous mode\n"));
526 g_print(_(" --startup CMD Run CMD after starting\n"));
527 g_print(_(" --debug Display debugging output\n"));
528 g_print(_(" --debug-focus Display debugging output for focus handling\n"));
529 g_print(_(" --debug-session Display debugging output for session management\n"));
530 g_print(_(" --debug-xinerama Split the display into fake xinerama screens\n"));
531 g_print(_("\nPlease report bugs at %s\n"), PACKAGE_BUGREPORT);
534 static void remove_args(gint *argc, gchar **argv, gint index, gint num)
538 for (i = index; i < *argc - num; ++i)
539 argv[i] = argv[i+num];
540 for (; i < *argc; ++i)
545 static void run_startup_cmd(void)
551 if (!g_shell_parse_argv(startup_cmd, NULL, &argv, &e)) {
552 g_message("Error parsing startup command: %s",
557 ok = g_spawn_async(NULL, argv, NULL,
558 G_SPAWN_SEARCH_PATH |
559 G_SPAWN_DO_NOT_REAP_CHILD,
560 NULL, NULL, NULL, &e);
561 if (!g_shell_parse_argv(startup_cmd, NULL, &argv, &e)) {
562 g_message("Error launching startup command: %s",
569 static void parse_env(void)
573 /* unset this so we don't pass it on unknowingly */
574 unsetenv("DESKTOP_STARTUP_ID");
576 /* this is how gnome-session passes in a session client id */
577 id = g_getenv("DESKTOP_AUTOSTART_ID");
579 unsetenv("DESKTOP_AUTOSTART_ID");
580 if (ob_sm_id) g_free(ob_sm_id);
581 ob_sm_id = g_strdup(id);
582 ob_debug_type(OB_DEBUG_SM,
583 "DESKTOP_AUTOSTART_ID %s supercedes --sm-client-id\n",
588 static void parse_args(gint *argc, gchar **argv)
592 for (i = 1; i < *argc; ++i) {
593 if (!strcmp(argv[i], "--version")) {
597 else if (!strcmp(argv[i], "--help")) {
601 else if (!strcmp(argv[i], "--g-fatal-warnings")) {
602 g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL);
604 else if (!strcmp(argv[i], "--replace")) {
605 ob_replace_wm = TRUE;
606 remove_args(argc, argv, i, 1);
607 --i; /* this arg was removed so go back */
609 else if (!strcmp(argv[i], "--sync")) {
612 else if (!strcmp(argv[i], "--startup")) {
613 if (i == *argc - 1) /* no args left */
614 g_printerr(_("--startup requires an argument\n"));
616 /* this will be in the current locale encoding, which is
618 startup_cmd = argv[i+1];
619 remove_args(argc, argv, i, 2);
620 --i; /* this arg was removed so go back */
621 ob_debug("--startup %s", startup_cmd);
624 else if (!strcmp(argv[i], "--debug")) {
625 ob_debug_enable(OB_DEBUG_NORMAL, TRUE);
626 ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
628 else if (!strcmp(argv[i], "--debug-focus")) {
629 ob_debug_enable(OB_DEBUG_FOCUS, TRUE);
631 else if (!strcmp(argv[i], "--debug-session")) {
632 ob_debug_enable(OB_DEBUG_SM, TRUE);
634 else if (!strcmp(argv[i], "--debug-xinerama")) {
635 ob_debug_xinerama = TRUE;
637 else if (!strcmp(argv[i], "--reconfigure")) {
640 else if (!strcmp(argv[i], "--restart")) {
643 else if (!strcmp(argv[i], "--exit")) {
646 else if (!strcmp(argv[i], "--config-file")) {
647 if (i == *argc - 1) /* no args left */
648 g_printerr(_("--config-file requires an argument\n"));
650 /* this will be in the current locale encoding, which is
652 config_file = argv[i+1];
653 ++i; /* skip the argument */
654 ob_debug("--config-file %s", config_file);
657 else if (!strcmp(argv[i], "--sm-save-file")) {
658 if (i == *argc - 1) /* no args left */
659 /* not translated cuz it's sekret */
660 g_printerr("--sm-save-file requires an argument\n");
662 ob_sm_save_file = g_strdup(argv[i+1]);
663 remove_args(argc, argv, i, 2);
664 --i; /* this arg was removed so go back */
665 ob_debug_type(OB_DEBUG_SM, "--sm-save-file %s",
669 else if (!strcmp(argv[i], "--sm-client-id")) {
670 if (i == *argc - 1) /* no args left */
671 /* not translated cuz it's sekret */
672 g_printerr("--sm-client-id requires an argument\n");
674 ob_sm_id = g_strdup(argv[i+1]);
675 remove_args(argc, argv, i, 2);
676 --i; /* this arg was removed so go back */
677 ob_debug_type(OB_DEBUG_SM, "--sm-client-id %s", ob_sm_id);
680 else if (!strcmp(argv[i], "--sm-disable")) {
683 else if (!strcmp(argv[i], "--sm-no-load")) {
684 ob_sm_restore = FALSE;
685 remove_args(argc, argv, i, 1);
686 --i; /* this arg was removed so go back */
689 /* this is a memleak.. oh well.. heh */
690 gchar *err = g_strdup_printf
691 (_("Invalid command line argument \"%s\"\n"), argv[i]);
692 ob_exit_with_error(err);
697 static Cursor load_cursor(const gchar *name, guint fontval)
702 c = XcursorLibraryLoadCursor(obt_display, name);
705 c = XCreateFontCursor(obt_display, fontval);
709 void ob_exit_with_error(const gchar *msg)
711 g_message("%s", msg);
712 session_shutdown(TRUE);
716 void ob_restart_other(const gchar *path)
718 restart_path = g_strdup(path);
722 void ob_restart(void)
728 void ob_reconfigure(void)
734 void ob_exit(gint code)
737 obt_main_loop_exit(ob_main_loop);
740 void ob_exit_replace(void)
743 being_replaced = TRUE;
744 obt_main_loop_exit(ob_main_loop);
747 Cursor ob_cursor(ObCursor cursor)
749 g_assert(cursor < OB_NUM_CURSORS);
750 return cursors[cursor];
753 ObState ob_state(void)
758 void ob_set_state(ObState s)