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"
35 #include "engine_interface.h"
38 #include "menuframe.h"
45 #include "render/render.h"
46 #include "render/theme.h"
47 #include "obt/display.h"
49 #include "obt/keyboard.h"
50 #include "obt/parse.h"
64 #ifdef HAVE_SYS_STAT_H
65 # include <sys/stat.h>
66 # include <sys/types.h>
68 #ifdef HAVE_SYS_WAIT_H
69 # include <sys/types.h>
70 # include <sys/wait.h>
77 #include <X11/cursorfont.h>
79 #include <X11/Xcursor/Xcursor.h>
83 #include <X11/keysym.h>
85 RrInstance *ob_rr_inst;
87 ObtMainLoop *ob_main_loop;
89 gboolean ob_replace_wm = FALSE;
90 gboolean ob_sm_use = TRUE;
91 gchar *ob_sm_id = NULL;
92 gchar *ob_sm_save_file = NULL;
93 gboolean ob_sm_restore = TRUE;
94 gboolean ob_debug_xinerama = FALSE;
95 ObFrameEngine * frame_engine = NULL;
98 static gboolean xsync = FALSE;
99 static gboolean reconfigure = FALSE;
100 static gboolean restart = FALSE;
101 static gchar *restart_path = NULL;
102 static Cursor cursors[OB_NUM_CURSORS];
103 static KeyCode keys[OB_NUM_KEYS];
104 static gint exitcode = 0;
105 static guint remote_control = 0;
106 static gboolean being_replaced = FALSE;
107 static gchar *config_file = NULL;
109 static void signal_handler(gint signal, gpointer data);
110 static void remove_args(gint *argc, gchar **argv, gint index, gint num);
111 static void parse_env();
112 static void parse_args(gint *argc, gchar **argv);
113 static Cursor load_cursor(const gchar *name, guint fontval);
115 gint main(gint argc, gchar **argv)
119 state = OB_STATE_STARTING;
123 /* initialize the locale */
124 if (!setlocale(LC_ALL, ""))
125 g_message("Couldn't set locale from environment.");
126 bindtextdomain(PACKAGE_NAME, LOCALEDIR);
127 bind_textdomain_codeset(PACKAGE_NAME, "UTF-8");
128 textdomain(PACKAGE_NAME);
130 /* parse the command line args, which can change the argv[0] */
131 parse_args(&argc, argv);
132 /* parse the environment variables */
135 program_name = g_path_get_basename(argv[0]);
136 g_set_prgname(program_name);
139 session_startup(argc, argv);
141 if (!obt_display_open(NULL))
142 ob_exit_with_error(_("Failed to open the display from the DISPLAY environment variable."));
144 if (remote_control) {
145 /* Send client message telling the OB process to:
146 * remote_control = 1 -> reconfigure
147 * remote_control = 2 -> restart */
148 OBT_PROP_MSG(ob_screen, obt_root(ob_screen),
149 OB_CONTROL, remote_control, 0, 0, 0, 0);
150 obt_display_close(obt_display);
154 ob_main_loop = obt_main_loop_new();
156 /* set up signal handler */
157 obt_main_loop_signal_add(ob_main_loop, SIGUSR1, signal_handler, NULL,NULL);
158 obt_main_loop_signal_add(ob_main_loop, SIGUSR2, signal_handler, NULL,NULL);
159 obt_main_loop_signal_add(ob_main_loop, SIGTERM, signal_handler, NULL,NULL);
160 obt_main_loop_signal_add(ob_main_loop, SIGINT, signal_handler, NULL,NULL);
161 obt_main_loop_signal_add(ob_main_loop, SIGHUP, signal_handler, NULL,NULL);
162 obt_main_loop_signal_add(ob_main_loop, SIGPIPE, signal_handler, NULL,NULL);
163 obt_main_loop_signal_add(ob_main_loop, SIGCHLD, signal_handler, NULL,NULL);
165 ob_screen = DefaultScreen(obt_display);
167 ob_rr_inst = RrInstanceNew(obt_display, ob_screen);
168 if (ob_rr_inst == NULL)
169 ob_exit_with_error(_("Failed to initialize the obrender library."));
171 XSynchronize(obt_display, xsync);
173 /* check for locale support */
174 if (!XSupportsLocale())
175 g_message(_("X server does not support locale."));
176 if (!XSetLocaleModifiers(""))
177 g_message(_("Cannot set locale modifiers for the X server."));
179 /* set the DISPLAY environment variable for any lauched children, to the
180 display we're using, so they open in the right place. */
181 setenv("DISPLAY", DisplayString(obt_display), TRUE);
183 /* create available cursors */
184 cursors[OB_CURSOR_NONE] = None;
185 cursors[OB_CURSOR_POINTER] = load_cursor("left_ptr", XC_left_ptr);
186 cursors[OB_CURSOR_BUSYPOINTER] = load_cursor("left_ptr_watch",XC_left_ptr);
187 cursors[OB_CURSOR_BUSY] = load_cursor("watch", XC_watch);
188 cursors[OB_CURSOR_MOVE] = load_cursor("fleur", XC_fleur);
189 cursors[OB_CURSOR_NORTH] = load_cursor("top_side", XC_top_side);
190 cursors[OB_CURSOR_NORTHEAST] = load_cursor("top_right_corner",
191 XC_top_right_corner);
192 cursors[OB_CURSOR_EAST] = load_cursor("right_side", XC_right_side);
193 cursors[OB_CURSOR_SOUTHEAST] = load_cursor("bottom_right_corner",
194 XC_bottom_right_corner);
195 cursors[OB_CURSOR_SOUTH] = load_cursor("bottom_side", XC_bottom_side);
196 cursors[OB_CURSOR_SOUTHWEST] = load_cursor("bottom_left_corner",
197 XC_bottom_left_corner);
198 cursors[OB_CURSOR_WEST] = load_cursor("left_side", XC_left_side);
199 cursors[OB_CURSOR_NORTHWEST] = load_cursor("top_left_corner",
202 if (screen_annex()) { /* it will be ours! */
204 if (reconfigure) obt_keyboard_reload();
206 /* get the keycodes for keys we use */
207 keys[OB_KEY_RETURN] = obt_keyboard_keysym_to_keycode(XK_Return);
208 keys[OB_KEY_ESCAPE] = obt_keyboard_keysym_to_keycode(XK_Escape);
209 keys[OB_KEY_LEFT] = obt_keyboard_keysym_to_keycode(XK_Left);
210 keys[OB_KEY_RIGHT] = obt_keyboard_keysym_to_keycode(XK_Right);
211 keys[OB_KEY_UP] = obt_keyboard_keysym_to_keycode(XK_Up);
212 keys[OB_KEY_DOWN] = obt_keyboard_keysym_to_keycode(XK_Down);
213 keys[OB_KEY_TAB] = obt_keyboard_keysym_to_keycode(XK_Tab);
214 keys[OB_KEY_SPACE] = obt_keyboard_keysym_to_keycode(XK_space);
219 /* startup the parsing so everything can register sections
221 i = obt_parse_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_parse_load_file(i, config_file, "openbox_config")) ||
231 obt_parse_load_config_file(i, "openbox", "rc.xml",
234 obt_parse_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_parse_instance_unref(i);
257 /* load the theme specified in the rc file */
259 ob_debug("Entering LoadThemeConfig");
260 frame_engine = init_frame_plugin (
261 config_theme, TRUE, config_font_activewindow,
262 config_font_inactivewindow, config_font_menutitle,
263 config_font_menuitem, config_font_osd);
264 ob_debug("Exiting LoadThemeConfig");
265 /* load the theme specified in the rc file */
267 if ((theme = RrThemeNew(ob_rr_inst, config_theme, TRUE,
268 config_font_activewindow,
269 config_font_inactivewindow,
270 config_font_menutitle,
271 config_font_menuitem,
274 RrThemeFree(ob_rr_theme);
277 if (ob_rr_theme == NULL)
278 ob_exit_with_error(_("Unable to load a theme."));
280 OBT_PROP_SETS(obt_root(ob_screen),
281 OB_THEME, utf8, ob_rr_theme->name);
287 /* update all existing windows for the new theme */
288 for (it = client_list; it; it = g_list_next(it)) {
289 ObClient *c = it->data;
290 frame_engine->frame_adjust_theme(c->frame);
293 event_startup(reconfigure);
294 /* focus_backup is used for stacking, so this needs to come before
295 anything that calls stacking_add */
296 sn_startup(reconfigure);
297 window_startup(reconfigure);
298 focus_startup(reconfigure);
299 focus_cycle_startup(reconfigure);
300 focus_cycle_indicator_startup(reconfigure);
301 focus_cycle_popup_startup(reconfigure);
302 screen_startup(reconfigure);
303 grab_startup(reconfigure);
304 group_startup(reconfigure);
305 ping_startup(reconfigure);
306 prompt_startup(reconfigure);
307 client_startup(reconfigure);
308 dock_startup(reconfigure);
309 moveresize_startup(reconfigure);
310 keyboard_startup(reconfigure);
311 mouse_startup(reconfigure);
312 menu_frame_startup(reconfigure);
313 menu_startup(reconfigure);
319 /* get all the existing windows */
323 /* focus what was focused if a wm was already running */
324 if (OBT_PROP_GET32(obt_root(ob_screen),
325 NET_ACTIVE_WINDOW, WINDOW, &xid) &&
326 (w = window_find(xid)) && WINDOW_IS_CLIENT(w))
328 client_focus(WINDOW_AS_CLIENT(w));
333 /* redecorate all existing windows */
334 for (it = client_list; it; it = g_list_next(it)) {
335 ObClient *c = it->data;
337 /* the new config can change the window's decorations */
338 client_setup_decor_and_functions(c, FALSE);
339 /* redraw the frames */
340 frame_engine->frame_update_layout (c->frame, c->area, FALSE, FALSE);
341 /* if this occurs while we are focus cycling, the indicator needs to
343 if (focus_cycle_target == c)
344 focus_cycle_draw_indicator(c);
345 /* the decor sizes may have changed, so the windows may
346 end up in new positions */
347 client_reconfigure(c, FALSE);
353 state = OB_STATE_RUNNING;
354 obt_main_loop_run(ob_main_loop);
355 state = OB_STATE_EXITING;
358 window_unmanage_all();
360 menu_shutdown(reconfigure);
361 menu_frame_shutdown(reconfigure);
362 mouse_shutdown(reconfigure);
363 keyboard_shutdown(reconfigure);
364 moveresize_shutdown(reconfigure);
365 dock_shutdown(reconfigure);
366 client_shutdown(reconfigure);
367 prompt_shutdown(reconfigure);
368 ping_shutdown(reconfigure);
369 group_shutdown(reconfigure);
370 grab_shutdown(reconfigure);
371 screen_shutdown(reconfigure);
372 focus_cycle_popup_shutdown(reconfigure);
373 focus_cycle_indicator_shutdown(reconfigure);
374 focus_cycle_shutdown(reconfigure);
375 focus_shutdown(reconfigure);
376 window_shutdown(reconfigure);
377 sn_shutdown(reconfigure);
378 event_shutdown(reconfigure);
380 actions_shutdown(reconfigure);
381 } while (reconfigure);
384 XSync(obt_display, FALSE);
388 //RrThemeFree(render_plugin->ob_rr_theme);
389 //RrInstanceFree(render_plugin->ob_rr_inst);
391 session_shutdown(being_replaced);
393 obt_display_close(obt_display);
396 if (restart_path != NULL) {
401 /* run other window manager */
402 if (g_shell_parse_argv(restart_path, &argcp, &argvp, &err)) {
403 execvp(argvp[0], argvp);
407 _("Restart failed to execute new executable '%s': %s"),
408 restart_path, err->message);
413 /* we remove the session arguments from argv, so put them back,
414 also don't restore the session on restart */
415 if (ob_sm_save_file != NULL || ob_sm_id != NULL) {
420 (ob_sm_save_file != NULL ? 2 : 0) +
421 (ob_sm_id != NULL ? 2 : 0);
422 nargv = g_new0(gchar*, l+1);
423 for (i = 0; i < argc; ++i)
426 if (ob_sm_save_file != NULL) {
427 nargv[i++] = g_strdup("--sm-save-file");
428 nargv[i++] = ob_sm_save_file;
430 if (ob_sm_id != NULL) {
431 nargv[i++] = g_strdup("--sm-client-id");
432 nargv[i++] = ob_sm_id;
434 nargv[i++] = g_strdup("--sm-no-load");
440 execvp(argv[0], argv); /* try how we were run */
441 execlp(argv[0], program_name, (gchar*)NULL); /* last resort */
444 /* free stuff passed in from the command line or environment */
445 g_free(ob_sm_save_file);
447 g_free(program_name);
454 static void signal_handler(gint signal, gpointer data)
458 ob_debug("Caught signal %d. Restarting.", signal);
462 ob_debug("Caught signal %d. Reconfiguring.", signal);
467 while (waitpid(-1, NULL, WNOHANG) > 0);
470 ob_debug("Caught signal %d. Exiting.", signal);
471 /* TERM and INT return a 0 code */
472 ob_exit(!(signal == SIGTERM || signal == SIGINT));
476 static void print_version()
478 g_print("Openbox %s\n", PACKAGE_VERSION);
479 g_print(_("Copyright (c)"));
480 g_print(" 2008 Mikael Magnusson\n");
481 g_print(_("Copyright (c)"));
482 g_print(" 2003-2006 Dana Jansens\n\n");
483 g_print("This program comes with ABSOLUTELY NO WARRANTY.\n");
484 g_print("This is free software, and you are welcome to redistribute it\n");
485 g_print("under certain conditions. See the file COPYING for details.\n\n");
488 static void print_help()
490 g_print(_("Syntax: openbox [options]\n"));
491 g_print(_("\nOptions:\n"));
492 g_print(_(" --help Display this help and exit\n"));
493 g_print(_(" --version Display the version and exit\n"));
494 g_print(_(" --replace Replace the currently running window manager\n"));
495 g_print(_(" --config-file FILE Specify the path to the config file to use\n"));
496 g_print(_(" --sm-disable Disable connection to the session manager\n"));
497 g_print(_("\nPassing messages to a running Openbox instance:\n"));
498 g_print(_(" --reconfigure Reload Openbox's configuration\n"));
499 g_print(_(" --restart Restart Openbox\n"));
500 g_print(_(" --exit Exit Openbox\n"));
501 g_print(_("\nDebugging options:\n"));
502 g_print(_(" --sync Run in synchronous mode\n"));
503 g_print(_(" --debug Display debugging output\n"));
504 g_print(_(" --debug-focus Display debugging output for focus handling\n"));
505 g_print(_(" --debug-session Display debugging output for session managment\n"));
506 g_print(_(" --debug-xinerama Split the display into fake xinerama screens\n"));
507 g_print(_("\nPlease report bugs at %s\n"), PACKAGE_BUGREPORT);
510 static void remove_args(gint *argc, gchar **argv, gint index, gint num)
514 for (i = index; i < *argc - num; ++i)
515 argv[i] = argv[i+num];
516 for (; i < *argc; ++i)
521 static void parse_env()
523 /* unset this so we don't pass it on unknowingly */
524 unsetenv("DESKTOP_STARTUP_ID");
527 static void parse_args(gint *argc, gchar **argv)
531 for (i = 1; i < *argc; ++i) {
532 if (!strcmp(argv[i], "--version")) {
536 else if (!strcmp(argv[i], "--help")) {
540 else if (!strcmp(argv[i], "--g-fatal-warnings")) {
541 g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL);
543 else if (!strcmp(argv[i], "--replace")) {
544 ob_replace_wm = TRUE;
545 remove_args(argc, argv, i, 1);
546 --i; /* this arg was removed so go back */
548 else if (!strcmp(argv[i], "--sync")) {
551 else if (!strcmp(argv[i], "--debug")) {
552 ob_debug_enable(OB_DEBUG_NORMAL, TRUE);
553 ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
555 else if (!strcmp(argv[i], "--debug-focus")) {
556 ob_debug_enable(OB_DEBUG_NORMAL, TRUE);
557 ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
558 ob_debug_enable(OB_DEBUG_FOCUS, TRUE);
560 else if (!strcmp(argv[i], "--debug-session")) {
561 ob_debug_enable(OB_DEBUG_NORMAL, TRUE);
562 ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
563 ob_debug_enable(OB_DEBUG_SM, TRUE);
565 else if (!strcmp(argv[i], "--debug-xinerama")) {
566 ob_debug_xinerama = TRUE;
568 else if (!strcmp(argv[i], "--reconfigure")) {
571 else if (!strcmp(argv[i], "--restart")) {
574 else if (!strcmp(argv[i], "--exit")) {
577 else if (!strcmp(argv[i], "--config-file")) {
578 if (i == *argc - 1) /* no args left */
579 g_printerr(_("--config-file requires an argument\n"));
581 /* this will be in the current locale encoding, which is
583 config_file = argv[i+1];
584 ++i; /* skip the argument */
585 ob_debug("--config-file %s\n", config_file);
588 else if (!strcmp(argv[i], "--sm-save-file")) {
589 if (i == *argc - 1) /* no args left */
590 /* not translated cuz it's sekret */
591 g_printerr("--sm-save-file requires an argument\n");
593 ob_sm_save_file = g_strdup(argv[i+1]);
594 remove_args(argc, argv, i, 2);
595 --i; /* this arg was removed so go back */
596 ob_debug_type(OB_DEBUG_SM, "--sm-save-file %s",
600 else if (!strcmp(argv[i], "--sm-client-id")) {
601 if (i == *argc - 1) /* no args left */
602 /* not translated cuz it's sekret */
603 g_printerr("--sm-client-id requires an argument\n");
605 ob_sm_id = g_strdup(argv[i+1]);
606 remove_args(argc, argv, i, 2);
607 --i; /* this arg was removed so go back */
608 ob_debug_type(OB_DEBUG_SM, "--sm-client-id %s", ob_sm_id);
611 else if (!strcmp(argv[i], "--sm-disable")) {
614 else if (!strcmp(argv[i], "--sm-no-load")) {
615 ob_sm_restore = FALSE;
616 remove_args(argc, argv, i, 1);
617 --i; /* this arg was removed so go back */
620 /* this is a memleak.. oh well.. heh */
621 gchar *err = g_strdup_printf
622 (_("Invalid command line argument '%s'\n"), argv[i]);
623 ob_exit_with_error(err);
628 static Cursor load_cursor(const gchar *name, guint fontval)
633 c = XcursorLibraryLoadCursor(obt_display, name);
636 c = XCreateFontCursor(obt_display, fontval);
640 void ob_exit_with_error(const gchar *msg)
643 session_shutdown(TRUE);
647 void ob_restart_other(const gchar *path)
649 restart_path = g_strdup(path);
659 void ob_reconfigure()
665 void ob_exit(gint code)
668 obt_main_loop_exit(ob_main_loop);
671 void ob_exit_replace()
674 being_replaced = TRUE;
675 obt_main_loop_exit(ob_main_loop);
678 Cursor ob_cursor(ObCursor cursor)
680 g_assert(cursor < OB_NUM_CURSORS);
681 return cursors[cursor];
684 KeyCode ob_keycode(ObKey key)
686 g_assert(key < OB_NUM_KEYS);