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.
32 #include "startupnotify.h"
34 #include "focus_cycle.h"
35 #include "focus_cycle_indicator.h"
36 #include "focus_cycle_popup.h"
37 #include "moveresize.h"
39 #include "framerender.h"
42 #include "extensions.h"
43 #include "menuframe.h"
51 #include "parser/parse.h"
52 #include "render/render.h"
53 #include "render/theme.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>
86 #include <X11/keysym.h>
89 RrInstance *ob_rr_inst;
90 RrImageCache *ob_rr_icons;
92 ObMainLoop *ob_main_loop;
95 gboolean ob_replace_wm = FALSE;
96 gboolean ob_sm_use = TRUE;
97 gchar *ob_sm_id = NULL;
98 gchar *ob_sm_save_file = NULL;
99 gboolean ob_sm_restore = TRUE;
100 gboolean ob_debug_xinerama = FALSE;
102 static ObState state;
103 static gboolean xsync = FALSE;
104 static gboolean reconfigure = FALSE;
105 static gboolean restart = FALSE;
106 static gchar *restart_path = NULL;
107 static Cursor cursors[OB_NUM_CURSORS];
108 static KeyCode keys[OB_NUM_KEYS];
109 static gint exitcode = 0;
110 static guint remote_control = 0;
111 static gboolean being_replaced = FALSE;
112 static gchar *config_file = NULL;
114 static void signal_handler(gint signal, gpointer data);
115 static void remove_args(gint *argc, gchar **argv, gint index, gint num);
116 static void parse_env();
117 static void parse_args(gint *argc, gchar **argv);
118 static Cursor load_cursor(const gchar *name, guint fontval);
120 gint main(gint argc, gchar **argv)
124 ob_set_state(OB_STATE_STARTING);
126 /* initialize the locale */
127 if (!setlocale(LC_ALL, ""))
128 g_message("Couldn't set locale from environment.");
129 bindtextdomain(PACKAGE_NAME, LOCALEDIR);
130 bind_textdomain_codeset(PACKAGE_NAME, "UTF-8");
131 textdomain(PACKAGE_NAME);
133 if (chdir(g_get_home_dir()) == -1)
134 g_message(_("Unable to change to home directory \"%s\": %s"),
135 g_get_home_dir(), g_strerror(errno));
137 /* parse the command line args, which can change the argv[0] */
138 parse_args(&argc, argv);
139 /* parse the environment variables */
142 program_name = g_path_get_basename(argv[0]);
143 g_set_prgname(program_name);
145 if (!remote_control) {
146 parse_paths_startup();
148 session_startup(argc, argv);
152 ob_display = XOpenDisplay(NULL);
153 if (ob_display == NULL)
154 ob_exit_with_error(_("Failed to open the display from the DISPLAY environment variable."));
155 if (fcntl(ConnectionNumber(ob_display), F_SETFD, 1) == -1)
156 ob_exit_with_error("Failed to set display as close-on-exec");
158 if (remote_control) {
161 /* Send client message telling the OB process to:
162 * remote_control = 1 -> reconfigure
163 * remote_control = 2 -> restart */
164 PROP_MSG(RootWindow(ob_display, ob_screen),
165 ob_control, remote_control, 0, 0, 0);
166 XCloseDisplay(ob_display);
170 ob_main_loop = ob_main_loop_new(ob_display);
172 /* set up signal handler */
173 ob_main_loop_signal_add(ob_main_loop, SIGUSR1, signal_handler, NULL, NULL);
174 ob_main_loop_signal_add(ob_main_loop, SIGUSR2, signal_handler, NULL, NULL);
175 ob_main_loop_signal_add(ob_main_loop, SIGTERM, signal_handler, NULL, NULL);
176 ob_main_loop_signal_add(ob_main_loop, SIGINT, signal_handler, NULL, NULL);
177 ob_main_loop_signal_add(ob_main_loop, SIGHUP, signal_handler, NULL, NULL);
178 ob_main_loop_signal_add(ob_main_loop, SIGPIPE, signal_handler, NULL, NULL);
179 ob_main_loop_signal_add(ob_main_loop, SIGCHLD, signal_handler, NULL, NULL);
181 ob_screen = DefaultScreen(ob_display);
183 ob_rr_inst = RrInstanceNew(ob_display, ob_screen);
184 if (ob_rr_inst == NULL)
185 ob_exit_with_error(_("Failed to initialize the obrender library."));
186 /* Saving 3 resizes of an RrImage makes a lot of sense for icons, as there
187 are generally 3 icon sizes needed: the titlebar icon, the menu icon,
190 ob_rr_icons = RrImageCacheNew(3);
192 XSynchronize(ob_display, xsync);
194 /* check for locale support */
195 if (!XSupportsLocale())
196 g_message(_("X server does not support locale."));
197 if (!XSetLocaleModifiers(""))
198 g_message(_("Cannot set locale modifiers for the X server."));
200 /* set our error handler */
201 XSetErrorHandler(xerror_handler);
203 /* set the DISPLAY environment variable for any lauched children, to the
204 display we're using, so they open in the right place. */
205 setenv("DISPLAY", DisplayString(ob_display), TRUE);
207 /* create available cursors */
208 cursors[OB_CURSOR_NONE] = None;
209 cursors[OB_CURSOR_POINTER] = load_cursor("left_ptr", XC_left_ptr);
210 cursors[OB_CURSOR_BUSYPOINTER] = load_cursor("left_ptr_watch",XC_left_ptr);
211 cursors[OB_CURSOR_BUSY] = load_cursor("watch", XC_watch);
212 cursors[OB_CURSOR_MOVE] = load_cursor("fleur", XC_fleur);
213 cursors[OB_CURSOR_NORTH] = load_cursor("top_side", XC_top_side);
214 cursors[OB_CURSOR_NORTHEAST] = load_cursor("top_right_corner",
215 XC_top_right_corner);
216 cursors[OB_CURSOR_EAST] = load_cursor("right_side", XC_right_side);
217 cursors[OB_CURSOR_SOUTHEAST] = load_cursor("bottom_right_corner",
218 XC_bottom_right_corner);
219 cursors[OB_CURSOR_SOUTH] = load_cursor("bottom_side", XC_bottom_side);
220 cursors[OB_CURSOR_SOUTHWEST] = load_cursor("bottom_left_corner",
221 XC_bottom_left_corner);
222 cursors[OB_CURSOR_WEST] = load_cursor("left_side", XC_left_side);
223 cursors[OB_CURSOR_NORTHWEST] = load_cursor("top_left_corner",
227 prop_startup(); /* get atoms values for the display */
228 extensions_query_all(); /* find which extensions are present */
230 if (screen_annex()) { /* it will be ours! */
232 ObPrompt *xmlprompt = NULL;
234 modkeys_startup(reconfigure);
236 /* get the keycodes for keys we use */
237 keys[OB_KEY_RETURN] = modkeys_sym_to_code(XK_Return);
238 keys[OB_KEY_ESCAPE] = modkeys_sym_to_code(XK_Escape);
239 keys[OB_KEY_LEFT] = modkeys_sym_to_code(XK_Left);
240 keys[OB_KEY_RIGHT] = modkeys_sym_to_code(XK_Right);
241 keys[OB_KEY_UP] = modkeys_sym_to_code(XK_Up);
242 keys[OB_KEY_DOWN] = modkeys_sym_to_code(XK_Down);
243 keys[OB_KEY_TAB] = modkeys_sym_to_code(XK_Tab);
244 keys[OB_KEY_SPACE] = modkeys_sym_to_code(XK_space);
251 /* startup the parsing so everything can register sections
255 /* register all the available actions */
256 actions_startup(reconfigure);
257 /* start up config which sets up with the parser */
260 /* parse/load user options */
261 if (parse_load_rc(config_file, &doc, &node)) {
262 parse_tree(i, doc, node->xmlChildrenNode);
266 g_message(_("Unable to find a valid config file, using some simple defaults"));
271 gchar *p = g_filename_to_utf8(config_file, -1,
274 PROP_SETS(RootWindow(ob_display, ob_screen),
279 PROP_ERASE(RootWindow(ob_display, ob_screen),
282 /* we're done with parsing now, kill it */
286 /* load the theme specified in the rc file */
289 if ((theme = RrThemeNew(ob_rr_inst, config_theme, TRUE,
290 config_font_activewindow,
291 config_font_inactivewindow,
292 config_font_menutitle,
293 config_font_menuitem,
296 RrThemeFree(ob_rr_theme);
299 if (ob_rr_theme == NULL)
300 ob_exit_with_error(_("Unable to load a theme."));
302 PROP_SETS(RootWindow(ob_display, ob_screen),
303 ob_theme, ob_rr_theme->name);
309 /* update all existing windows for the new theme */
310 for (it = client_list; it; it = g_list_next(it)) {
311 ObClient *c = it->data;
312 frame_adjust_theme(c->frame);
315 event_startup(reconfigure);
316 /* focus_backup is used for stacking, so this needs to come before
317 anything that calls stacking_add */
318 sn_startup(reconfigure);
319 window_startup(reconfigure);
320 focus_startup(reconfigure);
321 focus_cycle_startup(reconfigure);
322 focus_cycle_indicator_startup(reconfigure);
323 focus_cycle_popup_startup(reconfigure);
324 screen_startup(reconfigure);
325 grab_startup(reconfigure);
326 group_startup(reconfigure);
327 ping_startup(reconfigure);
328 client_startup(reconfigure);
329 dock_startup(reconfigure);
330 moveresize_startup(reconfigure);
331 keyboard_startup(reconfigure);
332 mouse_startup(reconfigure);
333 menu_frame_startup(reconfigure);
334 menu_startup(reconfigure);
335 prompt_startup(reconfigure);
341 /* get all the existing windows */
345 /* focus what was focused if a wm was already running */
346 if (PROP_GET32(RootWindow(ob_display, ob_screen),
347 net_active_window, window, &xid) &&
348 (w = g_hash_table_lookup(window_map, &xid)) &&
351 client_focus(WINDOW_AS_CLIENT(w));
356 /* redecorate all existing windows */
357 for (it = client_list; it; it = g_list_next(it)) {
358 ObClient *c = it->data;
360 /* the new config can change the window's decorations */
361 client_setup_decor_and_functions(c, FALSE);
362 /* redraw the frames */
363 frame_adjust_area(c->frame, TRUE, TRUE, FALSE);
364 /* the decor sizes may have changed, so the windows may
365 end up in new positions */
366 client_reconfigure(c, FALSE);
372 ob_set_state(OB_STATE_RUNNING);
374 /* look for parsing errors */
376 xmlErrorPtr e = xmlGetLastError();
380 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);
382 prompt_show_message(m, _("Openbox Syntax Error"), _("Close"));
388 ob_main_loop_run(ob_main_loop);
389 ob_set_state(reconfigure ?
390 OB_STATE_RECONFIGURING : OB_STATE_EXITING);
393 prompt_unref(xmlprompt);
399 client_unmanage_all();
402 prompt_shutdown(reconfigure);
403 menu_shutdown(reconfigure);
404 menu_frame_shutdown(reconfigure);
405 mouse_shutdown(reconfigure);
406 keyboard_shutdown(reconfigure);
407 moveresize_shutdown(reconfigure);
408 dock_shutdown(reconfigure);
409 client_shutdown(reconfigure);
410 ping_shutdown(reconfigure);
411 group_shutdown(reconfigure);
412 grab_shutdown(reconfigure);
413 screen_shutdown(reconfigure);
414 focus_cycle_popup_shutdown(reconfigure);
415 focus_cycle_indicator_shutdown(reconfigure);
416 focus_cycle_shutdown(reconfigure);
417 focus_shutdown(reconfigure);
418 window_shutdown(reconfigure);
419 sn_shutdown(reconfigure);
420 event_shutdown(reconfigure);
422 actions_shutdown(reconfigure);
423 modkeys_shutdown(reconfigure);
424 } while (reconfigure);
427 XSync(ob_display, FALSE);
429 RrThemeFree(ob_rr_theme);
430 RrImageCacheUnref(ob_rr_icons);
431 RrInstanceFree(ob_rr_inst);
433 session_shutdown(being_replaced);
435 XCloseDisplay(ob_display);
437 parse_paths_shutdown();
440 if (restart_path != NULL) {
445 /* run other window manager */
446 if (g_shell_parse_argv(restart_path, &argcp, &argvp, &err)) {
447 execvp(argvp[0], argvp);
451 _("Restart failed to execute new executable \"%s\": %s"),
452 restart_path, err->message);
457 /* we remove the session arguments from argv, so put them back,
458 also don't restore the session on restart */
459 if (ob_sm_save_file != NULL || ob_sm_id != NULL) {
464 (ob_sm_save_file != NULL ? 2 : 0) +
465 (ob_sm_id != NULL ? 2 : 0);
466 nargv = g_new0(gchar*, l+1);
467 for (i = 0; i < argc; ++i)
470 if (ob_sm_save_file != NULL) {
471 nargv[i++] = g_strdup("--sm-save-file");
472 nargv[i++] = ob_sm_save_file;
474 if (ob_sm_id != NULL) {
475 nargv[i++] = g_strdup("--sm-client-id");
476 nargv[i++] = ob_sm_id;
478 nargv[i++] = g_strdup("--sm-no-load");
484 execvp(argv[0], argv); /* try how we were run */
485 execlp(argv[0], program_name, (gchar*)NULL); /* last resort */
488 /* free stuff passed in from the command line or environment */
489 g_free(ob_sm_save_file);
491 g_free(program_name);
496 static void signal_handler(gint signal, gpointer data)
500 ob_debug("Caught signal %d. Restarting.\n", signal);
504 ob_debug("Caught signal %d. Reconfiguring.\n", signal);
509 while (waitpid(-1, NULL, WNOHANG) > 0);
512 ob_debug("Caught signal %d. Exiting.\n", signal);
513 /* TERM and INT return a 0 code */
514 ob_exit(!(signal == SIGTERM || signal == SIGINT));
518 static void print_version()
520 g_print("Openbox %s\n", PACKAGE_VERSION);
521 g_print(_("Copyright (c)"));
522 g_print(" 2008 Mikael Magnusson\n");
523 g_print(_("Copyright (c)"));
524 g_print(" 2003-2006 Dana Jansens\n\n");
525 g_print("This program comes with ABSOLUTELY NO WARRANTY.\n");
526 g_print("This is free software, and you are welcome to redistribute it\n");
527 g_print("under certain conditions. See the file COPYING for details.\n\n");
530 static void print_help()
532 g_print(_("Syntax: openbox [options]\n"));
533 g_print(_("\nOptions:\n"));
534 g_print(_(" --help Display this help and exit\n"));
535 g_print(_(" --version Display the version and exit\n"));
536 g_print(_(" --replace Replace the currently running window manager\n"));
537 /* TRANSLATORS: if you translate "FILE" here, make sure to keep the "Specify..."
538 aligned still, if you have to, make a new line with \n and 22 spaces. It's
539 fine to leave it as FILE though. */
540 g_print(_(" --config-file FILE Specify the path to the config file to use\n"));
541 g_print(_(" --sm-disable Disable connection to the session manager\n"));
542 g_print(_("\nPassing messages to a running Openbox instance:\n"));
543 g_print(_(" --reconfigure Reload Openbox's configuration\n"));
544 g_print(_(" --restart Restart Openbox\n"));
545 g_print(_(" --exit Exit Openbox\n"));
546 g_print(_("\nDebugging options:\n"));
547 g_print(_(" --sync Run in synchronous mode\n"));
548 g_print(_(" --debug Display debugging output\n"));
549 g_print(_(" --debug-focus Display debugging output for focus handling\n"));
550 g_print(_(" --debug-xinerama Split the display into fake xinerama screens\n"));
551 g_print(_("\nPlease report bugs at %s\n"), PACKAGE_BUGREPORT);
554 static void remove_args(gint *argc, gchar **argv, gint index, gint num)
558 for (i = index; i < *argc - num; ++i)
559 argv[i] = argv[i+num];
560 for (; i < *argc; ++i)
565 static void parse_env()
567 /* unset this so we don't pass it on unknowingly */
568 unsetenv("DESKTOP_STARTUP_ID");
571 static void parse_args(gint *argc, gchar **argv)
575 for (i = 1; i < *argc; ++i) {
576 if (!strcmp(argv[i], "--version")) {
580 else if (!strcmp(argv[i], "--help")) {
584 else if (!strcmp(argv[i], "--g-fatal-warnings")) {
585 g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL);
587 else if (!strcmp(argv[i], "--replace")) {
588 ob_replace_wm = TRUE;
589 remove_args(argc, argv, i, 1);
590 --i; /* this arg was removed so go back */
592 else if (!strcmp(argv[i], "--sync")) {
595 else if (!strcmp(argv[i], "--debug")) {
596 ob_debug_show_output(TRUE);
597 ob_debug_enable(OB_DEBUG_SM, TRUE);
598 ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
600 else if (!strcmp(argv[i], "--debug-focus")) {
601 ob_debug_show_output(TRUE);
602 ob_debug_enable(OB_DEBUG_SM, TRUE);
603 ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
604 ob_debug_enable(OB_DEBUG_FOCUS, TRUE);
606 else if (!strcmp(argv[i], "--debug-xinerama")) {
607 ob_debug_xinerama = TRUE;
609 else if (!strcmp(argv[i], "--reconfigure")) {
612 else if (!strcmp(argv[i], "--restart")) {
615 else if (!strcmp(argv[i], "--exit")) {
618 else if (!strcmp(argv[i], "--config-file")) {
619 if (i == *argc - 1) /* no args left */
620 g_printerr(_("--config-file requires an argument\n"));
622 /* this will be in the current locale encoding, which is
624 config_file = argv[i+1];
625 ++i; /* skip the argument */
626 ob_debug("--config-file %s\n", config_file);
629 else if (!strcmp(argv[i], "--sm-save-file")) {
630 if (i == *argc - 1) /* no args left */
631 /* not translated cuz it's sekret */
632 g_printerr("--sm-save-file requires an argument\n");
634 ob_sm_save_file = g_strdup(argv[i+1]);
635 remove_args(argc, argv, i, 2);
636 --i; /* this arg was removed so go back */
637 ob_debug_type(OB_DEBUG_SM, "--sm-save-file %s\n",
641 else if (!strcmp(argv[i], "--sm-client-id")) {
642 if (i == *argc - 1) /* no args left */
643 /* not translated cuz it's sekret */
644 g_printerr("--sm-client-id requires an argument\n");
646 ob_sm_id = g_strdup(argv[i+1]);
647 remove_args(argc, argv, i, 2);
648 --i; /* this arg was removed so go back */
649 ob_debug_type(OB_DEBUG_SM, "--sm-client-id %s\n", ob_sm_id);
652 else if (!strcmp(argv[i], "--sm-disable")) {
655 else if (!strcmp(argv[i], "--sm-no-load")) {
656 ob_sm_restore = FALSE;
657 remove_args(argc, argv, i, 1);
658 --i; /* this arg was removed so go back */
661 /* this is a memleak.. oh well.. heh */
662 gchar *err = g_strdup_printf
663 (_("Invalid command line argument \"%s\"\n"), argv[i]);
664 ob_exit_with_error(err);
669 static Cursor load_cursor(const gchar *name, guint fontval)
674 c = XcursorLibraryLoadCursor(ob_display, name);
677 c = XCreateFontCursor(ob_display, fontval);
681 void ob_exit_with_error(const gchar *msg)
684 session_shutdown(TRUE);
688 void ob_restart_other(const gchar *path)
690 restart_path = g_strdup(path);
700 void ob_reconfigure()
706 void ob_exit(gint code)
709 ob_main_loop_exit(ob_main_loop);
712 void ob_exit_replace()
715 being_replaced = TRUE;
716 ob_main_loop_exit(ob_main_loop);
719 Cursor ob_cursor(ObCursor cursor)
721 g_assert(cursor < OB_NUM_CURSORS);
722 return cursors[cursor];
725 KeyCode ob_keycode(ObKey key)
727 g_assert(key < OB_NUM_KEYS);
736 void ob_set_state(ObState s)