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>
88 RrInstance *ob_rr_inst;
89 RrImageCache *ob_rr_icons;
91 ObMainLoop *ob_main_loop;
94 gboolean ob_replace_wm = FALSE;
95 gboolean ob_sm_use = TRUE;
96 gchar *ob_sm_id = NULL;
97 gchar *ob_sm_save_file = NULL;
98 gboolean ob_sm_restore = TRUE;
99 gboolean ob_debug_xinerama = FALSE;
101 static ObState state;
102 static gboolean xsync = FALSE;
103 static gboolean reconfigure = FALSE;
104 static gboolean restart = FALSE;
105 static gchar *restart_path = NULL;
106 static Cursor cursors[OB_NUM_CURSORS];
107 static KeyCode *keys[OB_NUM_KEYS];
108 static gint exitcode = 0;
109 static guint remote_control = 0;
110 static gboolean being_replaced = FALSE;
111 static gchar *config_file = NULL;
113 static void signal_handler(gint signal, gpointer data);
114 static void remove_args(gint *argc, gchar **argv, gint index, gint num);
115 static void parse_env();
116 static void parse_args(gint *argc, gchar **argv);
117 static Cursor load_cursor(const gchar *name, guint fontval);
119 gint main(gint argc, gchar **argv)
123 ob_set_state(OB_STATE_STARTING);
125 /* initialize the locale */
126 if (!setlocale(LC_ALL, ""))
127 g_message("Couldn't set locale from environment.");
128 bindtextdomain(PACKAGE_NAME, LOCALEDIR);
129 bind_textdomain_codeset(PACKAGE_NAME, "UTF-8");
130 textdomain(PACKAGE_NAME);
132 if (chdir(g_get_home_dir()) == -1)
133 g_message(_("Unable to change to home directory \"%s\": %s"),
134 g_get_home_dir(), g_strerror(errno));
136 /* parse the command line args, which can change the argv[0] */
137 parse_args(&argc, argv);
138 /* parse the environment variables */
141 program_name = g_path_get_basename(argv[0]);
142 g_set_prgname(program_name);
144 if (!remote_control) {
145 parse_paths_startup();
147 session_startup(argc, argv);
150 ob_display = XOpenDisplay(NULL);
151 if (ob_display == NULL)
152 ob_exit_with_error(_("Failed to open the display from the DISPLAY environment variable."));
153 if (fcntl(ConnectionNumber(ob_display), F_SETFD, 1) == -1)
154 ob_exit_with_error("Failed to set display as close-on-exec");
156 if (remote_control) {
159 /* Send client message telling the OB process to:
160 * remote_control = 1 -> reconfigure
161 * remote_control = 2 -> restart */
162 PROP_MSG(RootWindow(ob_display, ob_screen),
163 ob_control, remote_control, 0, 0, 0);
164 XCloseDisplay(ob_display);
168 ob_main_loop = ob_main_loop_new(ob_display);
170 /* set up signal handler */
171 ob_main_loop_signal_add(ob_main_loop, SIGUSR1, signal_handler, NULL, NULL);
172 ob_main_loop_signal_add(ob_main_loop, SIGUSR2, signal_handler, NULL, NULL);
173 ob_main_loop_signal_add(ob_main_loop, SIGTERM, signal_handler, NULL, NULL);
174 ob_main_loop_signal_add(ob_main_loop, SIGINT, signal_handler, NULL, NULL);
175 ob_main_loop_signal_add(ob_main_loop, SIGHUP, signal_handler, NULL, NULL);
176 ob_main_loop_signal_add(ob_main_loop, SIGPIPE, signal_handler, NULL, NULL);
177 ob_main_loop_signal_add(ob_main_loop, SIGCHLD, signal_handler, NULL, NULL);
178 ob_main_loop_signal_add(ob_main_loop, SIGTTIN, signal_handler, NULL,NULL);
179 ob_main_loop_signal_add(ob_main_loop, SIGTTOU, 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",
226 prop_startup(); /* get atoms values for the display */
227 extensions_query_all(); /* find which extensions are present */
229 if (screen_annex()) { /* it will be ours! */
231 ObPrompt *xmlprompt = NULL;
233 modkeys_startup(reconfigure);
235 /* get the keycodes for keys we use */
236 keys[OB_KEY_RETURN] = modkeys_sym_to_code(XK_Return);
237 keys[OB_KEY_ESCAPE] = modkeys_sym_to_code(XK_Escape);
238 keys[OB_KEY_LEFT] = modkeys_sym_to_code(XK_Left);
239 keys[OB_KEY_RIGHT] = modkeys_sym_to_code(XK_Right);
240 keys[OB_KEY_UP] = modkeys_sym_to_code(XK_Up);
241 keys[OB_KEY_DOWN] = modkeys_sym_to_code(XK_Down);
242 keys[OB_KEY_TAB] = modkeys_sym_to_code(XK_Tab);
243 keys[OB_KEY_SPACE] = modkeys_sym_to_code(XK_space);
244 keys[OB_KEY_HOME] = modkeys_sym_to_code(XK_Home);
245 keys[OB_KEY_END] = modkeys_sym_to_code(XK_End);
252 /* startup the parsing so everything can register sections
256 /* register all the available actions */
257 actions_startup(reconfigure);
258 /* start up config which sets up with the parser */
261 /* parse/load user options */
262 if (parse_load_rc(config_file, &doc, &node)) {
263 parse_tree(i, doc, node->xmlChildrenNode);
267 g_message(_("Unable to find a valid config file, using some simple defaults"));
272 gchar *p = g_filename_to_utf8(config_file, -1,
275 PROP_SETS(RootWindow(ob_display, ob_screen),
280 PROP_ERASE(RootWindow(ob_display, ob_screen),
283 /* we're done with parsing now, kill it */
287 /* load the theme specified in the rc file */
290 if ((theme = RrThemeNew(ob_rr_inst, config_theme, TRUE,
291 config_font_activewindow,
292 config_font_inactivewindow,
293 config_font_menutitle,
294 config_font_menuitem,
297 RrThemeFree(ob_rr_theme);
300 if (ob_rr_theme == NULL)
301 ob_exit_with_error(_("Unable to load a theme."));
303 PROP_SETS(RootWindow(ob_display, ob_screen),
304 ob_theme, ob_rr_theme->name);
310 /* update all existing windows for the new theme */
311 for (it = client_list; it; it = g_list_next(it)) {
312 ObClient *c = it->data;
313 frame_adjust_theme(c->frame);
316 event_startup(reconfigure);
317 /* focus_backup is used for stacking, so this needs to come before
318 anything that calls stacking_add */
319 sn_startup(reconfigure);
320 window_startup(reconfigure);
321 focus_startup(reconfigure);
322 focus_cycle_startup(reconfigure);
323 focus_cycle_indicator_startup(reconfigure);
324 focus_cycle_popup_startup(reconfigure);
325 screen_startup(reconfigure);
326 grab_startup(reconfigure);
327 group_startup(reconfigure);
328 ping_startup(reconfigure);
329 client_startup(reconfigure);
330 dock_startup(reconfigure);
331 moveresize_startup(reconfigure);
332 keyboard_startup(reconfigure);
333 mouse_startup(reconfigure);
334 menu_frame_startup(reconfigure);
335 menu_startup(reconfigure);
336 prompt_startup(reconfigure);
342 /* get all the existing windows */
346 /* focus what was focused if a wm was already running */
347 if (PROP_GET32(RootWindow(ob_display, ob_screen),
348 net_active_window, window, &xid) &&
349 (w = g_hash_table_lookup(window_map, &xid)) &&
352 client_focus(WINDOW_AS_CLIENT(w));
357 /* redecorate all existing windows */
358 for (it = client_list; it; it = g_list_next(it)) {
359 ObClient *c = it->data;
361 /* the new config can change the window's decorations */
362 client_setup_decor_and_functions(c, FALSE);
363 /* redraw the frames */
364 frame_adjust_area(c->frame, TRUE, TRUE, FALSE);
365 /* the decor sizes may have changed, so the windows may
366 end up in new positions */
367 client_reconfigure(c, FALSE);
373 ob_set_state(OB_STATE_RUNNING);
375 /* look for parsing errors */
377 xmlErrorPtr e = xmlGetLastError();
381 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);
383 prompt_show_message(m, _("Openbox Syntax Error"), _("Close"));
389 ob_main_loop_run(ob_main_loop);
390 ob_set_state(reconfigure ?
391 OB_STATE_RECONFIGURING : OB_STATE_EXITING);
394 prompt_unref(xmlprompt);
400 client_unmanage_all();
403 prompt_shutdown(reconfigure);
404 menu_shutdown(reconfigure);
405 menu_frame_shutdown(reconfigure);
406 mouse_shutdown(reconfigure);
407 keyboard_shutdown(reconfigure);
408 moveresize_shutdown(reconfigure);
409 dock_shutdown(reconfigure);
410 client_shutdown(reconfigure);
411 ping_shutdown(reconfigure);
412 group_shutdown(reconfigure);
413 grab_shutdown(reconfigure);
414 screen_shutdown(reconfigure);
415 focus_cycle_popup_shutdown(reconfigure);
416 focus_cycle_indicator_shutdown(reconfigure);
417 focus_cycle_shutdown(reconfigure);
418 focus_shutdown(reconfigure);
419 window_shutdown(reconfigure);
420 sn_shutdown(reconfigure);
421 event_shutdown(reconfigure);
423 actions_shutdown(reconfigure);
425 /* Free the key codes for built in keys */
426 g_free(keys[OB_KEY_RETURN]);
427 g_free(keys[OB_KEY_ESCAPE]);
428 g_free(keys[OB_KEY_LEFT]);
429 g_free(keys[OB_KEY_RIGHT]);
430 g_free(keys[OB_KEY_UP]);
431 g_free(keys[OB_KEY_DOWN]);
432 g_free(keys[OB_KEY_TAB]);
433 g_free(keys[OB_KEY_SPACE]);
434 g_free(keys[OB_KEY_HOME]);
435 g_free(keys[OB_KEY_END]);
437 modkeys_shutdown(reconfigure);
438 } while (reconfigure);
441 XSync(ob_display, FALSE);
443 RrThemeFree(ob_rr_theme);
444 RrImageCacheUnref(ob_rr_icons);
445 RrInstanceFree(ob_rr_inst);
447 session_shutdown(being_replaced);
449 XCloseDisplay(ob_display);
451 parse_paths_shutdown();
454 if (restart_path != NULL) {
459 /* run other window manager */
460 if (g_shell_parse_argv(restart_path, &argcp, &argvp, &err)) {
461 execvp(argvp[0], argvp);
465 _("Restart failed to execute new executable \"%s\": %s"),
466 restart_path, err->message);
471 /* we remove the session arguments from argv, so put them back,
472 also don't restore the session on restart */
473 if (ob_sm_save_file != NULL || ob_sm_id != NULL) {
478 (ob_sm_save_file != NULL ? 2 : 0) +
479 (ob_sm_id != NULL ? 2 : 0);
480 nargv = g_new0(gchar*, l+1);
481 for (i = 0; i < argc; ++i)
484 if (ob_sm_save_file != NULL) {
485 nargv[i++] = g_strdup("--sm-save-file");
486 nargv[i++] = ob_sm_save_file;
488 if (ob_sm_id != NULL) {
489 nargv[i++] = g_strdup("--sm-client-id");
490 nargv[i++] = ob_sm_id;
492 nargv[i++] = g_strdup("--sm-no-load");
498 execvp(argv[0], argv); /* try how we were run */
499 execlp(argv[0], program_name, (gchar*)NULL); /* last resort */
502 /* free stuff passed in from the command line or environment */
503 g_free(ob_sm_save_file);
505 g_free(program_name);
510 static void signal_handler(gint signal, gpointer data)
514 ob_debug("Caught signal %d. Restarting.\n", signal);
518 ob_debug("Caught signal %d. Reconfiguring.\n", signal);
523 while (waitpid(-1, NULL, WNOHANG) > 0);
527 ob_debug("Caught signal %d. Ignoring.", signal);
530 ob_debug("Caught signal %d. Exiting.\n", signal);
531 /* TERM and INT return a 0 code */
532 ob_exit(!(signal == SIGTERM || signal == SIGINT));
536 static void print_version(void)
538 g_print("Openbox %s\n", PACKAGE_VERSION);
539 g_print(_("Copyright (c)"));
540 g_print(" 2008 Mikael Magnusson\n");
541 g_print(_("Copyright (c)"));
542 g_print(" 2003-2006 Dana Jansens\n\n");
543 g_print("This program comes with ABSOLUTELY NO WARRANTY.\n");
544 g_print("This is free software, and you are welcome to redistribute it\n");
545 g_print("under certain conditions. See the file COPYING for details.\n\n");
548 static void print_help(void)
550 g_print(_("Syntax: openbox [options]\n"));
551 g_print(_("\nOptions:\n"));
552 g_print(_(" --help Display this help and exit\n"));
553 g_print(_(" --version Display the version and exit\n"));
554 g_print(_(" --replace Replace the currently running window manager\n"));
555 /* TRANSLATORS: if you translate "FILE" here, make sure to keep the "Specify..."
556 aligned still, if you have to, make a new line with \n and 22 spaces. It's
557 fine to leave it as FILE though. */
558 g_print(_(" --config-file FILE Specify the path to the config file to use\n"));
559 g_print(_(" --sm-disable Disable connection to the session manager\n"));
560 g_print(_("\nPassing messages to a running Openbox instance:\n"));
561 g_print(_(" --reconfigure Reload Openbox's configuration\n"));
562 g_print(_(" --restart Restart Openbox\n"));
563 g_print(_(" --exit Exit Openbox\n"));
564 g_print(_("\nDebugging options:\n"));
565 g_print(_(" --sync Run in synchronous mode\n"));
566 g_print(_(" --debug Display debugging output\n"));
567 g_print(_(" --debug-focus Display debugging output for focus handling\n"));
568 g_print(_(" --debug-xinerama Split the display into fake xinerama screens\n"));
569 g_print(_("\nPlease report bugs at %s\n"), PACKAGE_BUGREPORT);
572 static void remove_args(gint *argc, gchar **argv, gint index, gint num)
576 for (i = index; i < *argc - num; ++i)
577 argv[i] = argv[i+num];
578 for (; i < *argc; ++i)
583 static void parse_env(void)
587 /* unset this so we don't pass it on unknowingly */
588 unsetenv("DESKTOP_STARTUP_ID");
590 /* this is how gnome-session passes in a session client id */
591 id = g_getenv("DESKTOP_AUTOSTART_ID");
593 unsetenv("DESKTOP_AUTOSTART_ID");
594 if (ob_sm_id) g_free(ob_sm_id);
595 ob_sm_id = g_strdup(id);
596 ob_debug_type(OB_DEBUG_SM,
597 "DESKTOP_AUTOSTART_ID %s supercedes --sm-client-id\n",
602 static void parse_args(gint *argc, gchar **argv)
606 for (i = 1; i < *argc; ++i) {
607 if (!strcmp(argv[i], "--version")) {
611 else if (!strcmp(argv[i], "--help")) {
615 else if (!strcmp(argv[i], "--g-fatal-warnings")) {
616 g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL);
618 else if (!strcmp(argv[i], "--replace")) {
619 ob_replace_wm = TRUE;
620 remove_args(argc, argv, i, 1);
621 --i; /* this arg was removed so go back */
623 else if (!strcmp(argv[i], "--sync")) {
626 else if (!strcmp(argv[i], "--debug")) {
627 ob_debug_show_output(TRUE);
628 ob_debug_enable(OB_DEBUG_SM, TRUE);
629 ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
631 else if (!strcmp(argv[i], "--debug-focus")) {
632 ob_debug_show_output(TRUE);
633 ob_debug_enable(OB_DEBUG_SM, TRUE);
634 ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
635 ob_debug_enable(OB_DEBUG_FOCUS, TRUE);
637 else if (!strcmp(argv[i], "--debug-xinerama")) {
638 ob_debug_xinerama = TRUE;
640 else if (!strcmp(argv[i], "--reconfigure")) {
643 else if (!strcmp(argv[i], "--restart")) {
646 else if (!strcmp(argv[i], "--exit")) {
649 else if (!strcmp(argv[i], "--config-file")) {
650 if (i == *argc - 1) /* no args left */
651 g_printerr(_("--config-file requires an argument\n"));
653 /* this will be in the current locale encoding, which is
655 config_file = argv[i+1];
656 ++i; /* skip the argument */
657 ob_debug("--config-file %s\n", config_file);
660 else if (!strcmp(argv[i], "--sm-save-file")) {
661 if (i == *argc - 1) /* no args left */
662 /* not translated cuz it's sekret */
663 g_printerr("--sm-save-file requires an argument\n");
665 ob_sm_save_file = g_strdup(argv[i+1]);
666 remove_args(argc, argv, i, 2);
667 --i; /* this arg was removed so go back */
668 ob_debug_type(OB_DEBUG_SM, "--sm-save-file %s\n",
672 else if (!strcmp(argv[i], "--sm-client-id")) {
673 if (i == *argc - 1) /* no args left */
674 /* not translated cuz it's sekret */
675 g_printerr("--sm-client-id requires an argument\n");
677 ob_sm_id = g_strdup(argv[i+1]);
678 remove_args(argc, argv, i, 2);
679 --i; /* this arg was removed so go back */
680 ob_debug_type(OB_DEBUG_SM, "--sm-client-id %s\n", ob_sm_id);
683 else if (!strcmp(argv[i], "--sm-disable")) {
686 else if (!strcmp(argv[i], "--sm-no-load")) {
687 ob_sm_restore = FALSE;
688 remove_args(argc, argv, i, 1);
689 --i; /* this arg was removed so go back */
692 /* this is a memleak.. oh well.. heh */
693 gchar *err = g_strdup_printf
694 (_("Invalid command line argument \"%s\"\n"), argv[i]);
695 ob_exit_with_error(err);
700 static Cursor load_cursor(const gchar *name, guint fontval)
705 c = XcursorLibraryLoadCursor(ob_display, name);
708 c = XCreateFontCursor(ob_display, fontval);
712 void ob_exit_with_error(const gchar *msg)
714 g_message("%s", msg);
715 session_shutdown(TRUE);
719 void ob_restart_other(const gchar *path)
721 restart_path = g_strdup(path);
725 void ob_restart(void)
731 void ob_reconfigure(void)
737 void ob_exit(gint code)
740 ob_main_loop_exit(ob_main_loop);
743 void ob_exit_replace(void)
746 being_replaced = TRUE;
747 ob_main_loop_exit(ob_main_loop);
750 Cursor ob_cursor(ObCursor cursor)
752 g_assert(cursor < OB_NUM_CURSORS);
753 return cursors[cursor];
756 gboolean ob_keycode_match(KeyCode code, ObKey key)
760 g_assert(key < OB_NUM_KEYS);
761 for (k = keys[key]; *k; ++k)
762 if (*k == code) return TRUE;
766 ObState ob_state(void)
771 void ob_set_state(ObState s)