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;
106 static void signal_handler(gint signal, gpointer data);
107 static void remove_args(gint *argc, gchar **argv, gint index, gint num);
108 static void parse_env();
109 static void parse_args(gint *argc, gchar **argv);
110 static Cursor load_cursor(const gchar *name, guint fontval);
112 gint main(gint argc, gchar **argv)
116 ob_set_state(OB_STATE_STARTING);
120 /* initialize the locale */
121 if (!setlocale(LC_ALL, ""))
122 g_message("Couldn't set locale from environment.");
123 bindtextdomain(PACKAGE_NAME, LOCALEDIR);
124 bind_textdomain_codeset(PACKAGE_NAME, "UTF-8");
125 textdomain(PACKAGE_NAME);
127 if (chdir(g_get_home_dir()) == -1)
128 g_message(_("Unable to change to home directory \"%s\": %s"),
129 g_get_home_dir(), g_strerror(errno));
131 /* parse the command line args, which can change the argv[0] */
132 parse_args(&argc, argv);
133 /* parse the environment variables */
136 program_name = g_path_get_basename(argv[0]);
137 g_set_prgname(program_name);
140 session_startup(argc, argv);
142 if (!obt_display_open(NULL))
143 ob_exit_with_error(_("Failed to open the display from the DISPLAY environment variable."));
145 if (remote_control) {
146 /* Send client message telling the OB process to:
147 * remote_control = 1 -> reconfigure
148 * remote_control = 2 -> restart */
149 OBT_PROP_MSG(ob_screen, obt_root(ob_screen),
150 OB_CONTROL, remote_control, 0, 0, 0, 0);
155 ob_main_loop = obt_main_loop_new();
157 /* set up signal handler */
158 obt_main_loop_signal_add(ob_main_loop, SIGUSR1, signal_handler, NULL,NULL);
159 obt_main_loop_signal_add(ob_main_loop, SIGUSR2, signal_handler, NULL,NULL);
160 obt_main_loop_signal_add(ob_main_loop, SIGTERM, signal_handler, NULL,NULL);
161 obt_main_loop_signal_add(ob_main_loop, SIGINT, signal_handler, NULL,NULL);
162 obt_main_loop_signal_add(ob_main_loop, SIGHUP, signal_handler, NULL,NULL);
163 obt_main_loop_signal_add(ob_main_loop, SIGPIPE, signal_handler, NULL,NULL);
164 obt_main_loop_signal_add(ob_main_loop, SIGCHLD, signal_handler, NULL,NULL);
165 obt_main_loop_signal_add(ob_main_loop, SIGTTIN, signal_handler, NULL,NULL);
166 obt_main_loop_signal_add(ob_main_loop, SIGTTOU, signal_handler, NULL,NULL);
168 ob_screen = DefaultScreen(obt_display);
170 ob_rr_inst = RrInstanceNew(obt_display, ob_screen);
171 if (ob_rr_inst == NULL)
172 ob_exit_with_error(_("Failed to initialize the obrender library."));
173 /* Saving 3 resizes of an RrImage makes a lot of sense for icons, as there
174 are generally 3 icon sizes needed: the titlebar icon, the menu icon,
177 ob_rr_icons = RrImageCacheNew(3);
179 XSynchronize(obt_display, xsync);
181 /* check for locale support */
182 if (!XSupportsLocale())
183 g_message(_("X server does not support locale."));
184 if (!XSetLocaleModifiers(""))
185 g_message(_("Cannot set locale modifiers for the X server."));
187 /* set the DISPLAY environment variable for any lauched children, to the
188 display we're using, so they open in the right place. */
189 setenv("DISPLAY", DisplayString(obt_display), TRUE);
191 /* create available cursors */
192 cursors[OB_CURSOR_NONE] = None;
193 cursors[OB_CURSOR_POINTER] = load_cursor("left_ptr", XC_left_ptr);
194 cursors[OB_CURSOR_BUSYPOINTER] = load_cursor("left_ptr_watch",XC_left_ptr);
195 cursors[OB_CURSOR_BUSY] = load_cursor("watch", XC_watch);
196 cursors[OB_CURSOR_MOVE] = load_cursor("fleur", XC_fleur);
197 cursors[OB_CURSOR_NORTH] = load_cursor("top_side", XC_top_side);
198 cursors[OB_CURSOR_NORTHEAST] = load_cursor("top_right_corner",
199 XC_top_right_corner);
200 cursors[OB_CURSOR_EAST] = load_cursor("right_side", XC_right_side);
201 cursors[OB_CURSOR_SOUTHEAST] = load_cursor("bottom_right_corner",
202 XC_bottom_right_corner);
203 cursors[OB_CURSOR_SOUTH] = load_cursor("bottom_side", XC_bottom_side);
204 cursors[OB_CURSOR_SOUTHWEST] = load_cursor("bottom_left_corner",
205 XC_bottom_left_corner);
206 cursors[OB_CURSOR_WEST] = load_cursor("left_side", XC_left_side);
207 cursors[OB_CURSOR_NORTHWEST] = load_cursor("top_left_corner",
210 if (screen_annex()) { /* it will be ours! */
212 ObPrompt *xmlprompt = NULL;
214 if (reconfigure) obt_keyboard_reload();
219 /* startup the parsing so everything can register sections
221 i = obt_xml_instance_new();
223 /* register all the available actions */
224 actions_startup(reconfigure);
225 /* start up config which sets up with the parser */
228 /* parse/load user options */
230 obt_xml_load_file(i, config_file, "openbox_config")) ||
231 obt_xml_load_config_file(i, "openbox", "rc.xml",
234 obt_xml_tree_from_root(i);
238 g_message(_("Unable to find a valid config file, using some simple defaults"));
243 gchar *p = g_filename_to_utf8(config_file, -1,
246 OBT_PROP_SETS(obt_root(ob_screen), OB_CONFIG_FILE,
251 OBT_PROP_ERASE(obt_root(ob_screen), OB_CONFIG_FILE);
253 /* we're done with parsing now, kill it */
254 obt_xml_instance_unref(i);
257 /* load the theme specified in the rc file */
260 if ((theme = RrThemeNew(ob_rr_inst, config_theme, TRUE,
261 config_font_activewindow,
262 config_font_inactivewindow,
263 config_font_menutitle,
264 config_font_menuitem,
265 config_font_activeosd,
266 config_font_inactiveosd)))
268 RrThemeFree(ob_rr_theme);
271 if (ob_rr_theme == NULL)
272 ob_exit_with_error(_("Unable to load a theme."));
274 OBT_PROP_SETS(obt_root(ob_screen),
275 OB_THEME, utf8, ob_rr_theme->name);
281 /* update all existing windows for the new theme */
282 for (it = client_list; it; it = g_list_next(it)) {
283 ObClient *c = it->data;
284 frame_adjust_theme(c->frame);
287 event_startup(reconfigure);
288 /* focus_backup is used for stacking, so this needs to come before
289 anything that calls stacking_add */
290 sn_startup(reconfigure);
291 window_startup(reconfigure);
292 focus_startup(reconfigure);
293 focus_cycle_startup(reconfigure);
294 focus_cycle_indicator_startup(reconfigure);
295 focus_cycle_popup_startup(reconfigure);
296 screen_startup(reconfigure);
297 grab_startup(reconfigure);
298 group_startup(reconfigure);
299 ping_startup(reconfigure);
300 client_startup(reconfigure);
301 dock_startup(reconfigure);
302 moveresize_startup(reconfigure);
303 keyboard_startup(reconfigure);
304 mouse_startup(reconfigure);
305 menu_frame_startup(reconfigure);
306 menu_startup(reconfigure);
307 prompt_startup(reconfigure);
313 /* get all the existing windows */
317 /* focus what was focused if a wm was already running */
318 if (OBT_PROP_GET32(obt_root(ob_screen),
319 NET_ACTIVE_WINDOW, WINDOW, &xid) &&
320 (w = window_find(xid)) && WINDOW_IS_CLIENT(w))
322 client_focus(WINDOW_AS_CLIENT(w));
327 /* redecorate all existing windows */
328 for (it = client_list; it; it = g_list_next(it)) {
329 ObClient *c = it->data;
331 /* the new config can change the window's decorations */
332 client_setup_decor_and_functions(c, FALSE);
333 /* redraw the frames */
334 frame_adjust_area(c->frame, TRUE, TRUE, FALSE);
335 /* the decor sizes may have changed, so the windows may
336 end up in new positions */
337 client_reconfigure(c, FALSE);
343 ob_set_state(OB_STATE_RUNNING);
345 /* look for parsing errors */
347 xmlErrorPtr e = xmlGetLastError();
351 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);
353 prompt_show_message(m, _("Openbox Syntax Error"), _("Close"));
359 obt_main_loop_run(ob_main_loop);
360 ob_set_state(reconfigure ?
361 OB_STATE_RECONFIGURING : OB_STATE_EXITING);
364 prompt_unref(xmlprompt);
369 window_unmanage_all();
371 prompt_shutdown(reconfigure);
372 menu_shutdown(reconfigure);
373 menu_frame_shutdown(reconfigure);
374 mouse_shutdown(reconfigure);
375 keyboard_shutdown(reconfigure);
376 moveresize_shutdown(reconfigure);
377 dock_shutdown(reconfigure);
378 client_shutdown(reconfigure);
379 ping_shutdown(reconfigure);
380 group_shutdown(reconfigure);
381 grab_shutdown(reconfigure);
382 screen_shutdown(reconfigure);
383 focus_cycle_popup_shutdown(reconfigure);
384 focus_cycle_indicator_shutdown(reconfigure);
385 focus_cycle_shutdown(reconfigure);
386 focus_shutdown(reconfigure);
387 window_shutdown(reconfigure);
388 sn_shutdown(reconfigure);
389 event_shutdown(reconfigure);
391 actions_shutdown(reconfigure);
392 } while (reconfigure);
395 XSync(obt_display, FALSE);
397 RrThemeFree(ob_rr_theme);
398 RrImageCacheUnref(ob_rr_icons);
399 RrInstanceFree(ob_rr_inst);
401 session_shutdown(being_replaced);
407 if (restart_path != NULL) {
412 /* run other window manager */
413 if (g_shell_parse_argv(restart_path, &argcp, &argvp, &err)) {
414 execvp(argvp[0], argvp);
418 _("Restart failed to execute new executable \"%s\": %s"),
419 restart_path, err->message);
424 /* we remove the session arguments from argv, so put them back,
425 also don't restore the session on restart */
426 if (ob_sm_save_file != NULL || ob_sm_id != NULL) {
431 (ob_sm_save_file != NULL ? 2 : 0) +
432 (ob_sm_id != NULL ? 2 : 0);
433 nargv = g_new0(gchar*, l+1);
434 for (i = 0; i < argc; ++i)
437 if (ob_sm_save_file != NULL) {
438 nargv[i++] = g_strdup("--sm-save-file");
439 nargv[i++] = ob_sm_save_file;
441 if (ob_sm_id != NULL) {
442 nargv[i++] = g_strdup("--sm-client-id");
443 nargv[i++] = ob_sm_id;
445 nargv[i++] = g_strdup("--sm-no-load");
451 execvp(argv[0], argv); /* try how we were run */
452 execlp(argv[0], program_name, (gchar*)NULL); /* last resort */
455 /* free stuff passed in from the command line or environment */
456 g_free(ob_sm_save_file);
458 g_free(program_name);
466 static void signal_handler(gint signal, gpointer data)
470 ob_debug("Caught signal %d. Restarting.", signal);
474 ob_debug("Caught signal %d. Reconfiguring.", signal);
479 while (waitpid(-1, NULL, WNOHANG) > 0);
483 ob_debug("Caught signal %d. Ignoring.", signal);
486 ob_debug("Caught signal %d. Exiting.", signal);
487 /* TERM and INT return a 0 code */
488 ob_exit(!(signal == SIGTERM || signal == SIGINT));
492 static void print_version(void)
494 g_print("Openbox %s\n", PACKAGE_VERSION);
495 g_print(_("Copyright (c)"));
496 g_print(" 2008 Mikael Magnusson\n");
497 g_print(_("Copyright (c)"));
498 g_print(" 2003-2006 Dana Jansens\n\n");
499 g_print("This program comes with ABSOLUTELY NO WARRANTY.\n");
500 g_print("This is free software, and you are welcome to redistribute it\n");
501 g_print("under certain conditions. See the file COPYING for details.\n\n");
504 static void print_help(void)
506 g_print(_("Syntax: openbox [options]\n"));
507 g_print(_("\nOptions:\n"));
508 g_print(_(" --help Display this help and exit\n"));
509 g_print(_(" --version Display the version and exit\n"));
510 g_print(_(" --replace Replace the currently running window manager\n"));
511 /* TRANSLATORS: if you translate "FILE" here, make sure to keep the "Specify..."
512 aligned still, if you have to, make a new line with \n and 22 spaces. It's
513 fine to leave it as FILE though. */
514 g_print(_(" --config-file FILE Specify the path to the config file to use\n"));
515 g_print(_(" --sm-disable Disable connection to the session manager\n"));
516 g_print(_("\nPassing messages to a running Openbox instance:\n"));
517 g_print(_(" --reconfigure Reload Openbox's configuration\n"));
518 g_print(_(" --restart Restart Openbox\n"));
519 g_print(_(" --exit Exit Openbox\n"));
520 g_print(_("\nDebugging options:\n"));
521 g_print(_(" --sync Run in synchronous mode\n"));
522 g_print(_(" --debug Display debugging output\n"));
523 g_print(_(" --debug-focus Display debugging output for focus handling\n"));
524 g_print(_(" --debug-session Display debugging output for session management\n"));
525 g_print(_(" --debug-xinerama Split the display into fake xinerama screens\n"));
526 g_print(_("\nPlease report bugs at %s\n"), PACKAGE_BUGREPORT);
529 static void remove_args(gint *argc, gchar **argv, gint index, gint num)
533 for (i = index; i < *argc - num; ++i)
534 argv[i] = argv[i+num];
535 for (; i < *argc; ++i)
540 static void parse_env(void)
544 /* unset this so we don't pass it on unknowingly */
545 unsetenv("DESKTOP_STARTUP_ID");
547 /* this is how gnome-session passes in a session client id */
548 id = g_getenv("DESKTOP_AUTOSTART_ID");
550 unsetenv("DESKTOP_AUTOSTART_ID");
551 if (ob_sm_id) g_free(ob_sm_id);
552 ob_sm_id = g_strdup(id);
553 ob_debug_type(OB_DEBUG_SM,
554 "DESKTOP_AUTOSTART_ID %s supercedes --sm-client-id\n",
559 static void parse_args(gint *argc, gchar **argv)
563 for (i = 1; i < *argc; ++i) {
564 if (!strcmp(argv[i], "--version")) {
568 else if (!strcmp(argv[i], "--help")) {
572 else if (!strcmp(argv[i], "--g-fatal-warnings")) {
573 g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL);
575 else if (!strcmp(argv[i], "--replace")) {
576 ob_replace_wm = TRUE;
577 remove_args(argc, argv, i, 1);
578 --i; /* this arg was removed so go back */
580 else if (!strcmp(argv[i], "--sync")) {
583 else if (!strcmp(argv[i], "--debug")) {
584 ob_debug_enable(OB_DEBUG_NORMAL, TRUE);
585 ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
587 else if (!strcmp(argv[i], "--debug-focus")) {
588 ob_debug_enable(OB_DEBUG_FOCUS, TRUE);
590 else if (!strcmp(argv[i], "--debug-session")) {
591 ob_debug_enable(OB_DEBUG_SM, TRUE);
593 else if (!strcmp(argv[i], "--debug-xinerama")) {
594 ob_debug_xinerama = TRUE;
596 else if (!strcmp(argv[i], "--reconfigure")) {
599 else if (!strcmp(argv[i], "--restart")) {
602 else if (!strcmp(argv[i], "--exit")) {
605 else if (!strcmp(argv[i], "--config-file")) {
606 if (i == *argc - 1) /* no args left */
607 g_printerr(_("--config-file requires an argument\n"));
609 /* this will be in the current locale encoding, which is
611 config_file = argv[i+1];
612 ++i; /* skip the argument */
613 ob_debug("--config-file %s", config_file);
616 else if (!strcmp(argv[i], "--sm-save-file")) {
617 if (i == *argc - 1) /* no args left */
618 /* not translated cuz it's sekret */
619 g_printerr("--sm-save-file requires an argument\n");
621 ob_sm_save_file = g_strdup(argv[i+1]);
622 remove_args(argc, argv, i, 2);
623 --i; /* this arg was removed so go back */
624 ob_debug_type(OB_DEBUG_SM, "--sm-save-file %s",
628 else if (!strcmp(argv[i], "--sm-client-id")) {
629 if (i == *argc - 1) /* no args left */
630 /* not translated cuz it's sekret */
631 g_printerr("--sm-client-id requires an argument\n");
633 ob_sm_id = g_strdup(argv[i+1]);
634 remove_args(argc, argv, i, 2);
635 --i; /* this arg was removed so go back */
636 ob_debug_type(OB_DEBUG_SM, "--sm-client-id %s", ob_sm_id);
639 else if (!strcmp(argv[i], "--sm-disable")) {
642 else if (!strcmp(argv[i], "--sm-no-load")) {
643 ob_sm_restore = FALSE;
644 remove_args(argc, argv, i, 1);
645 --i; /* this arg was removed so go back */
648 /* this is a memleak.. oh well.. heh */
649 gchar *err = g_strdup_printf
650 (_("Invalid command line argument \"%s\"\n"), argv[i]);
651 ob_exit_with_error(err);
656 static Cursor load_cursor(const gchar *name, guint fontval)
661 c = XcursorLibraryLoadCursor(obt_display, name);
664 c = XCreateFontCursor(obt_display, fontval);
668 void ob_exit_with_error(const gchar *msg)
670 g_message("%s", msg);
671 session_shutdown(TRUE);
675 void ob_restart_other(const gchar *path)
677 restart_path = g_strdup(path);
681 void ob_restart(void)
687 void ob_reconfigure(void)
693 void ob_exit(gint code)
696 obt_main_loop_exit(ob_main_loop);
699 void ob_exit_replace(void)
702 being_replaced = TRUE;
703 obt_main_loop_exit(ob_main_loop);
706 Cursor ob_cursor(ObCursor cursor)
708 g_assert(cursor < OB_NUM_CURSORS);
709 return cursors[cursor];
712 ObState ob_state(void)
717 void ob_set_state(ObState s)