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 "render/render.h"
47 #include "render/theme.h"
48 #include "obt/display.h"
50 #include "obt/keyboard.h"
51 #include "obt/parse.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>
84 #include <X11/keysym.h>
86 RrInstance *ob_rr_inst;
87 RrImageCache *ob_rr_icons;
89 ObtMainLoop *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;
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 KeyCode keys[OB_NUM_KEYS];
105 static gint exitcode = 0;
106 static guint remote_control = 0;
107 static gboolean being_replaced = FALSE;
108 static gchar *config_file = 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);
116 gint main(gint argc, gchar **argv)
120 state = OB_STATE_STARTING;
124 /* initialize the locale */
125 if (!setlocale(LC_ALL, ""))
126 g_message("Couldn't set locale from environment.");
127 bindtextdomain(PACKAGE_NAME, LOCALEDIR);
128 bind_textdomain_codeset(PACKAGE_NAME, "UTF-8");
129 textdomain(PACKAGE_NAME);
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);
151 obt_display_close(obt_display);
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);
166 ob_screen = DefaultScreen(obt_display);
168 ob_rr_inst = RrInstanceNew(obt_display, ob_screen);
169 if (ob_rr_inst == NULL)
170 ob_exit_with_error(_("Failed to initialize the obrender library."));
171 ob_rr_icons = RrImageCacheNew();
173 XSynchronize(obt_display, xsync);
175 /* check for locale support */
176 if (!XSupportsLocale())
177 g_message(_("X server does not support locale."));
178 if (!XSetLocaleModifiers(""))
179 g_message(_("Cannot set locale modifiers for the X server."));
181 /* set the DISPLAY environment variable for any lauched children, to the
182 display we're using, so they open in the right place. */
183 setenv("DISPLAY", DisplayString(obt_display), TRUE);
185 /* create available cursors */
186 cursors[OB_CURSOR_NONE] = None;
187 cursors[OB_CURSOR_POINTER] = load_cursor("left_ptr", XC_left_ptr);
188 cursors[OB_CURSOR_BUSYPOINTER] = load_cursor("left_ptr_watch",XC_left_ptr);
189 cursors[OB_CURSOR_BUSY] = load_cursor("watch", XC_watch);
190 cursors[OB_CURSOR_MOVE] = load_cursor("fleur", XC_fleur);
191 cursors[OB_CURSOR_NORTH] = load_cursor("top_side", XC_top_side);
192 cursors[OB_CURSOR_NORTHEAST] = load_cursor("top_right_corner",
193 XC_top_right_corner);
194 cursors[OB_CURSOR_EAST] = load_cursor("right_side", XC_right_side);
195 cursors[OB_CURSOR_SOUTHEAST] = load_cursor("bottom_right_corner",
196 XC_bottom_right_corner);
197 cursors[OB_CURSOR_SOUTH] = load_cursor("bottom_side", XC_bottom_side);
198 cursors[OB_CURSOR_SOUTHWEST] = load_cursor("bottom_left_corner",
199 XC_bottom_left_corner);
200 cursors[OB_CURSOR_WEST] = load_cursor("left_side", XC_left_side);
201 cursors[OB_CURSOR_NORTHWEST] = load_cursor("top_left_corner",
204 if (screen_annex()) { /* it will be ours! */
206 if (reconfigure) obt_keyboard_reload();
208 /* get the keycodes for keys we use */
209 keys[OB_KEY_RETURN] = obt_keyboard_keysym_to_keycode(XK_Return);
210 keys[OB_KEY_ESCAPE] = obt_keyboard_keysym_to_keycode(XK_Escape);
211 keys[OB_KEY_LEFT] = obt_keyboard_keysym_to_keycode(XK_Left);
212 keys[OB_KEY_RIGHT] = obt_keyboard_keysym_to_keycode(XK_Right);
213 keys[OB_KEY_UP] = obt_keyboard_keysym_to_keycode(XK_Up);
214 keys[OB_KEY_DOWN] = obt_keyboard_keysym_to_keycode(XK_Down);
215 keys[OB_KEY_TAB] = obt_keyboard_keysym_to_keycode(XK_Tab);
216 keys[OB_KEY_SPACE] = obt_keyboard_keysym_to_keycode(XK_space);
221 /* startup the parsing so everything can register sections
223 i = obt_parse_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_parse_load_file(i, config_file, "openbox_config")) ||
233 obt_parse_load_config_file(i, "openbox", "rc.xml",
236 obt_parse_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_parse_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,
269 RrThemeFree(ob_rr_theme);
272 if (ob_rr_theme == NULL)
273 ob_exit_with_error(_("Unable to load a theme."));
275 OBT_PROP_SETS(obt_root(ob_screen),
276 OB_THEME, utf8, ob_rr_theme->name);
282 /* update all existing windows for the new theme */
283 for (it = client_list; it; it = g_list_next(it)) {
284 ObClient *c = it->data;
285 frame_adjust_theme(c->frame);
288 event_startup(reconfigure);
289 /* focus_backup is used for stacking, so this needs to come before
290 anything that calls stacking_add */
291 sn_startup(reconfigure);
292 window_startup(reconfigure);
293 focus_startup(reconfigure);
294 focus_cycle_startup(reconfigure);
295 focus_cycle_indicator_startup(reconfigure);
296 focus_cycle_popup_startup(reconfigure);
297 screen_startup(reconfigure);
298 grab_startup(reconfigure);
299 group_startup(reconfigure);
300 ping_startup(reconfigure);
301 prompt_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);
314 /* get all the existing windows */
318 /* focus what was focused if a wm was already running */
319 if (OBT_PROP_GET32(obt_root(ob_screen),
320 NET_ACTIVE_WINDOW, WINDOW, &xid) &&
321 (w = window_find(xid)) && WINDOW_IS_CLIENT(w))
323 client_focus(WINDOW_AS_CLIENT(w));
328 /* redecorate all existing windows */
329 for (it = client_list; it; it = g_list_next(it)) {
330 ObClient *c = it->data;
332 /* the new config can change the window's decorations */
333 client_setup_decor_and_functions(c, FALSE);
334 /* redraw the frames */
335 frame_adjust_area(c->frame, TRUE, TRUE, FALSE);
336 /* the decor sizes may have changed, so the windows may
337 end up in new positions */
338 client_reconfigure(c, FALSE);
344 state = OB_STATE_RUNNING;
345 obt_main_loop_run(ob_main_loop);
346 state = OB_STATE_EXITING;
349 window_unmanage_all();
351 menu_shutdown(reconfigure);
352 menu_frame_shutdown(reconfigure);
353 mouse_shutdown(reconfigure);
354 keyboard_shutdown(reconfigure);
355 moveresize_shutdown(reconfigure);
356 dock_shutdown(reconfigure);
357 client_shutdown(reconfigure);
358 prompt_shutdown(reconfigure);
359 ping_shutdown(reconfigure);
360 group_shutdown(reconfigure);
361 grab_shutdown(reconfigure);
362 screen_shutdown(reconfigure);
363 focus_cycle_popup_shutdown(reconfigure);
364 focus_cycle_indicator_shutdown(reconfigure);
365 focus_cycle_shutdown(reconfigure);
366 focus_shutdown(reconfigure);
367 window_shutdown(reconfigure);
368 sn_shutdown(reconfigure);
369 event_shutdown(reconfigure);
371 actions_shutdown(reconfigure);
372 } while (reconfigure);
375 XSync(obt_display, FALSE);
377 RrThemeFree(ob_rr_theme);
378 RrImageCacheUnref(ob_rr_icons);
379 RrInstanceFree(ob_rr_inst);
381 session_shutdown(being_replaced);
383 obt_display_close(obt_display);
386 if (restart_path != NULL) {
391 /* run other window manager */
392 if (g_shell_parse_argv(restart_path, &argcp, &argvp, &err)) {
393 execvp(argvp[0], argvp);
397 _("Restart failed to execute new executable '%s': %s"),
398 restart_path, err->message);
403 /* we remove the session arguments from argv, so put them back,
404 also don't restore the session on restart */
405 if (ob_sm_save_file != NULL || ob_sm_id != NULL) {
410 (ob_sm_save_file != NULL ? 2 : 0) +
411 (ob_sm_id != NULL ? 2 : 0);
412 nargv = g_new0(gchar*, l+1);
413 for (i = 0; i < argc; ++i)
416 if (ob_sm_save_file != NULL) {
417 nargv[i++] = g_strdup("--sm-save-file");
418 nargv[i++] = ob_sm_save_file;
420 if (ob_sm_id != NULL) {
421 nargv[i++] = g_strdup("--sm-client-id");
422 nargv[i++] = ob_sm_id;
424 nargv[i++] = g_strdup("--sm-no-load");
430 execvp(argv[0], argv); /* try how we were run */
431 execlp(argv[0], program_name, (gchar*)NULL); /* last resort */
434 /* free stuff passed in from the command line or environment */
435 g_free(ob_sm_save_file);
437 g_free(program_name);
444 static void signal_handler(gint signal, gpointer data)
448 ob_debug("Caught signal %d. Restarting.", signal);
452 ob_debug("Caught signal %d. Reconfiguring.", signal);
457 while (waitpid(-1, NULL, WNOHANG) > 0);
460 ob_debug("Caught signal %d. Exiting.", signal);
461 /* TERM and INT return a 0 code */
462 ob_exit(!(signal == SIGTERM || signal == SIGINT));
466 static void print_version()
468 g_print("Openbox %s\n", PACKAGE_VERSION);
469 g_print(_("Copyright (c)"));
470 g_print(" 2008 Mikael Magnusson\n");
471 g_print(_("Copyright (c)"));
472 g_print(" 2003-2006 Dana Jansens\n\n");
473 g_print("This program comes with ABSOLUTELY NO WARRANTY.\n");
474 g_print("This is free software, and you are welcome to redistribute it\n");
475 g_print("under certain conditions. See the file COPYING for details.\n\n");
478 static void print_help()
480 g_print(_("Syntax: openbox [options]\n"));
481 g_print(_("\nOptions:\n"));
482 g_print(_(" --help Display this help and exit\n"));
483 g_print(_(" --version Display the version and exit\n"));
484 g_print(_(" --replace Replace the currently running window manager\n"));
485 g_print(_(" --config-file FILE Specify the path to the config file to use\n"));
486 g_print(_(" --sm-disable Disable connection to the session manager\n"));
487 g_print(_("\nPassing messages to a running Openbox instance:\n"));
488 g_print(_(" --reconfigure Reload Openbox's configuration\n"));
489 g_print(_(" --restart Restart Openbox\n"));
490 g_print(_(" --exit Exit Openbox\n"));
491 g_print(_("\nDebugging options:\n"));
492 g_print(_(" --sync Run in synchronous mode\n"));
493 g_print(_(" --debug Display debugging output\n"));
494 g_print(_(" --debug-focus Display debugging output for focus handling\n"));
495 g_print(_(" --debug-session Display debugging output for session managment\n"));
496 g_print(_(" --debug-xinerama Split the display into fake xinerama screens\n"));
497 g_print(_("\nPlease report bugs at %s\n"), PACKAGE_BUGREPORT);
500 static void remove_args(gint *argc, gchar **argv, gint index, gint num)
504 for (i = index; i < *argc - num; ++i)
505 argv[i] = argv[i+num];
506 for (; i < *argc; ++i)
511 static void parse_env()
513 /* unset this so we don't pass it on unknowingly */
514 unsetenv("DESKTOP_STARTUP_ID");
517 static void parse_args(gint *argc, gchar **argv)
521 for (i = 1; i < *argc; ++i) {
522 if (!strcmp(argv[i], "--version")) {
526 else if (!strcmp(argv[i], "--help")) {
530 else if (!strcmp(argv[i], "--g-fatal-warnings")) {
531 g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL);
533 else if (!strcmp(argv[i], "--replace")) {
534 ob_replace_wm = TRUE;
535 remove_args(argc, argv, i, 1);
536 --i; /* this arg was removed so go back */
538 else if (!strcmp(argv[i], "--sync")) {
541 else if (!strcmp(argv[i], "--debug")) {
542 ob_debug_enable(OB_DEBUG_NORMAL, TRUE);
543 ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
545 else if (!strcmp(argv[i], "--debug-focus")) {
546 ob_debug_enable(OB_DEBUG_NORMAL, TRUE);
547 ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
548 ob_debug_enable(OB_DEBUG_FOCUS, TRUE);
550 else if (!strcmp(argv[i], "--debug-session")) {
551 ob_debug_enable(OB_DEBUG_NORMAL, TRUE);
552 ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
553 ob_debug_enable(OB_DEBUG_SM, TRUE);
555 else if (!strcmp(argv[i], "--debug-xinerama")) {
556 ob_debug_xinerama = TRUE;
558 else if (!strcmp(argv[i], "--reconfigure")) {
561 else if (!strcmp(argv[i], "--restart")) {
564 else if (!strcmp(argv[i], "--exit")) {
567 else if (!strcmp(argv[i], "--config-file")) {
568 if (i == *argc - 1) /* no args left */
569 g_printerr(_("--config-file requires an argument\n"));
571 /* this will be in the current locale encoding, which is
573 config_file = argv[i+1];
574 ++i; /* skip the argument */
575 ob_debug("--config-file %s\n", config_file);
578 else if (!strcmp(argv[i], "--sm-save-file")) {
579 if (i == *argc - 1) /* no args left */
580 /* not translated cuz it's sekret */
581 g_printerr("--sm-save-file requires an argument\n");
583 ob_sm_save_file = g_strdup(argv[i+1]);
584 remove_args(argc, argv, i, 2);
585 --i; /* this arg was removed so go back */
586 ob_debug_type(OB_DEBUG_SM, "--sm-save-file %s",
590 else if (!strcmp(argv[i], "--sm-client-id")) {
591 if (i == *argc - 1) /* no args left */
592 /* not translated cuz it's sekret */
593 g_printerr("--sm-client-id requires an argument\n");
595 ob_sm_id = g_strdup(argv[i+1]);
596 remove_args(argc, argv, i, 2);
597 --i; /* this arg was removed so go back */
598 ob_debug_type(OB_DEBUG_SM, "--sm-client-id %s", ob_sm_id);
601 else if (!strcmp(argv[i], "--sm-disable")) {
604 else if (!strcmp(argv[i], "--sm-no-load")) {
605 ob_sm_restore = FALSE;
606 remove_args(argc, argv, i, 1);
607 --i; /* this arg was removed so go back */
610 /* this is a memleak.. oh well.. heh */
611 gchar *err = g_strdup_printf
612 (_("Invalid command line argument '%s'\n"), argv[i]);
613 ob_exit_with_error(err);
618 static Cursor load_cursor(const gchar *name, guint fontval)
623 c = XcursorLibraryLoadCursor(obt_display, name);
626 c = XCreateFontCursor(obt_display, fontval);
630 void ob_exit_with_error(const gchar *msg)
633 session_shutdown(TRUE);
637 void ob_restart_other(const gchar *path)
639 restart_path = g_strdup(path);
649 void ob_reconfigure()
655 void ob_exit(gint code)
658 obt_main_loop_exit(ob_main_loop);
661 void ob_exit_replace()
664 being_replaced = TRUE;
665 obt_main_loop_exit(ob_main_loop);
668 Cursor ob_cursor(ObCursor cursor)
670 g_assert(cursor < OB_NUM_CURSORS);
671 return cursors[cursor];
674 KeyCode ob_keycode(ObKey key)
676 g_assert(key < OB_NUM_KEYS);