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>
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 ob_set_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 if (chdir(g_get_home_dir()) == -1)
132 g_message(_("Unable to change to home directory \"%s\": %s"),
133 g_get_home_dir(), g_strerror(errno
));
135 /* parse the command line args, which can change the argv[0] */
136 parse_args(&argc
, argv
);
137 /* parse the environment variables */
140 program_name
= g_path_get_basename(argv
[0]);
141 g_set_prgname(program_name
);
144 session_startup(argc
, argv
);
146 if (!obt_display_open(NULL
))
147 ob_exit_with_error(_("Failed to open the display from the DISPLAY environment variable."));
149 if (remote_control
) {
150 /* Send client message telling the OB process to:
151 * remote_control = 1 -> reconfigure
152 * remote_control = 2 -> restart */
153 OBT_PROP_MSG(ob_screen
, obt_root(ob_screen
),
154 OB_CONTROL
, remote_control
, 0, 0, 0, 0);
159 ob_main_loop
= obt_main_loop_new();
161 /* set up signal handler */
162 obt_main_loop_signal_add(ob_main_loop
, SIGUSR1
, signal_handler
, NULL
,NULL
);
163 obt_main_loop_signal_add(ob_main_loop
, SIGUSR2
, signal_handler
, NULL
,NULL
);
164 obt_main_loop_signal_add(ob_main_loop
, SIGTERM
, signal_handler
, NULL
,NULL
);
165 obt_main_loop_signal_add(ob_main_loop
, SIGINT
, signal_handler
, NULL
,NULL
);
166 obt_main_loop_signal_add(ob_main_loop
, SIGHUP
, signal_handler
, NULL
,NULL
);
167 obt_main_loop_signal_add(ob_main_loop
, SIGPIPE
, signal_handler
, NULL
,NULL
);
168 obt_main_loop_signal_add(ob_main_loop
, SIGCHLD
, signal_handler
, NULL
,NULL
);
170 ob_screen
= DefaultScreen(obt_display
);
172 ob_rr_inst
= RrInstanceNew(obt_display
, ob_screen
);
173 if (ob_rr_inst
== NULL
)
174 ob_exit_with_error(_("Failed to initialize the obrender library."));
175 /* Saving 3 resizes of an RrImage makes a lot of sense for icons, as there
176 are generally 3 icon sizes needed: the titlebar icon, the menu icon,
179 ob_rr_icons
= RrImageCacheNew(3);
181 XSynchronize(obt_display
, xsync
);
183 /* check for locale support */
184 if (!XSupportsLocale())
185 g_message(_("X server does not support locale."));
186 if (!XSetLocaleModifiers(""))
187 g_message(_("Cannot set locale modifiers for the X server."));
189 /* set the DISPLAY environment variable for any lauched children, to the
190 display we're using, so they open in the right place. */
191 setenv("DISPLAY", DisplayString(obt_display
), TRUE
);
193 /* create available cursors */
194 cursors
[OB_CURSOR_NONE
] = None
;
195 cursors
[OB_CURSOR_POINTER
] = load_cursor("left_ptr", XC_left_ptr
);
196 cursors
[OB_CURSOR_BUSYPOINTER
] = load_cursor("left_ptr_watch",XC_left_ptr
);
197 cursors
[OB_CURSOR_BUSY
] = load_cursor("watch", XC_watch
);
198 cursors
[OB_CURSOR_MOVE
] = load_cursor("fleur", XC_fleur
);
199 cursors
[OB_CURSOR_NORTH
] = load_cursor("top_side", XC_top_side
);
200 cursors
[OB_CURSOR_NORTHEAST
] = load_cursor("top_right_corner",
201 XC_top_right_corner
);
202 cursors
[OB_CURSOR_EAST
] = load_cursor("right_side", XC_right_side
);
203 cursors
[OB_CURSOR_SOUTHEAST
] = load_cursor("bottom_right_corner",
204 XC_bottom_right_corner
);
205 cursors
[OB_CURSOR_SOUTH
] = load_cursor("bottom_side", XC_bottom_side
);
206 cursors
[OB_CURSOR_SOUTHWEST
] = load_cursor("bottom_left_corner",
207 XC_bottom_left_corner
);
208 cursors
[OB_CURSOR_WEST
] = load_cursor("left_side", XC_left_side
);
209 cursors
[OB_CURSOR_NORTHWEST
] = load_cursor("top_left_corner",
212 if (screen_annex()) { /* it will be ours! */
214 ObPrompt
*xmlprompt
= NULL
;
216 if (reconfigure
) obt_keyboard_reload();
218 /* get the keycodes for keys we use */
219 keys
[OB_KEY_RETURN
] = obt_keyboard_keysym_to_keycode(XK_Return
);
220 keys
[OB_KEY_ESCAPE
] = obt_keyboard_keysym_to_keycode(XK_Escape
);
221 keys
[OB_KEY_LEFT
] = obt_keyboard_keysym_to_keycode(XK_Left
);
222 keys
[OB_KEY_RIGHT
] = obt_keyboard_keysym_to_keycode(XK_Right
);
223 keys
[OB_KEY_UP
] = obt_keyboard_keysym_to_keycode(XK_Up
);
224 keys
[OB_KEY_DOWN
] = obt_keyboard_keysym_to_keycode(XK_Down
);
225 keys
[OB_KEY_TAB
] = obt_keyboard_keysym_to_keycode(XK_Tab
);
226 keys
[OB_KEY_SPACE
] = obt_keyboard_keysym_to_keycode(XK_space
);
231 /* startup the parsing so everything can register sections
233 i
= obt_xml_instance_new();
235 /* register all the available actions */
236 actions_startup(reconfigure
);
237 /* start up config which sets up with the parser */
240 /* parse/load user options */
242 obt_xml_load_file(i
, config_file
, "openbox_config")) ||
243 obt_xml_load_config_file(i
, "openbox", "rc.xml",
246 obt_xml_tree_from_root(i
);
250 g_message(_("Unable to find a valid config file, using some simple defaults"));
255 gchar
*p
= g_filename_to_utf8(config_file
, -1,
258 OBT_PROP_SETS(obt_root(ob_screen
), OB_CONFIG_FILE
,
263 OBT_PROP_ERASE(obt_root(ob_screen
), OB_CONFIG_FILE
);
265 /* we're done with parsing now, kill it */
266 obt_xml_instance_unref(i
);
269 /* load the theme specified in the rc file */
272 if ((theme
= RrThemeNew(ob_rr_inst
, config_theme
, TRUE
,
273 config_font_activewindow
,
274 config_font_inactivewindow
,
275 config_font_menutitle
,
276 config_font_menuitem
,
277 config_font_activeosd
,
278 config_font_inactiveosd
)))
280 RrThemeFree(ob_rr_theme
);
283 if (ob_rr_theme
== NULL
)
284 ob_exit_with_error(_("Unable to load a theme."));
286 OBT_PROP_SETS(obt_root(ob_screen
),
287 OB_THEME
, utf8
, ob_rr_theme
->name
);
293 /* update all existing windows for the new theme */
294 for (it
= client_list
; it
; it
= g_list_next(it
)) {
295 ObClient
*c
= it
->data
;
296 frame_adjust_theme(c
->frame
);
299 event_startup(reconfigure
);
300 /* focus_backup is used for stacking, so this needs to come before
301 anything that calls stacking_add */
302 sn_startup(reconfigure
);
303 window_startup(reconfigure
);
304 focus_startup(reconfigure
);
305 focus_cycle_startup(reconfigure
);
306 focus_cycle_indicator_startup(reconfigure
);
307 focus_cycle_popup_startup(reconfigure
);
308 screen_startup(reconfigure
);
309 grab_startup(reconfigure
);
310 group_startup(reconfigure
);
311 ping_startup(reconfigure
);
312 client_startup(reconfigure
);
313 dock_startup(reconfigure
);
314 moveresize_startup(reconfigure
);
315 keyboard_startup(reconfigure
);
316 mouse_startup(reconfigure
);
317 menu_frame_startup(reconfigure
);
318 menu_startup(reconfigure
);
319 prompt_startup(reconfigure
);
325 /* get all the existing windows */
329 /* focus what was focused if a wm was already running */
330 if (OBT_PROP_GET32(obt_root(ob_screen
),
331 NET_ACTIVE_WINDOW
, WINDOW
, &xid
) &&
332 (w
= window_find(xid
)) && WINDOW_IS_CLIENT(w
))
334 client_focus(WINDOW_AS_CLIENT(w
));
339 /* redecorate all existing windows */
340 for (it
= client_list
; it
; it
= g_list_next(it
)) {
341 ObClient
*c
= it
->data
;
343 /* the new config can change the window's decorations */
344 client_setup_decor_and_functions(c
, FALSE
);
345 /* redraw the frames */
346 frame_adjust_area(c
->frame
, TRUE
, TRUE
, FALSE
);
347 /* the decor sizes may have changed, so the windows may
348 end up in new positions */
349 client_reconfigure(c
, FALSE
);
355 ob_set_state(OB_STATE_RUNNING
);
357 /* look for parsing errors */
359 xmlErrorPtr e
= xmlGetLastError();
363 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
);
365 prompt_show_message(m
, _("Openbox Syntax Error"), _("Close"));
371 obt_main_loop_run(ob_main_loop
);
372 ob_set_state(reconfigure
?
373 OB_STATE_RECONFIGURING
: OB_STATE_EXITING
);
376 prompt_unref(xmlprompt
);
381 window_unmanage_all();
383 prompt_shutdown(reconfigure
);
384 menu_shutdown(reconfigure
);
385 menu_frame_shutdown(reconfigure
);
386 mouse_shutdown(reconfigure
);
387 keyboard_shutdown(reconfigure
);
388 moveresize_shutdown(reconfigure
);
389 dock_shutdown(reconfigure
);
390 client_shutdown(reconfigure
);
391 ping_shutdown(reconfigure
);
392 group_shutdown(reconfigure
);
393 grab_shutdown(reconfigure
);
394 screen_shutdown(reconfigure
);
395 focus_cycle_popup_shutdown(reconfigure
);
396 focus_cycle_indicator_shutdown(reconfigure
);
397 focus_cycle_shutdown(reconfigure
);
398 focus_shutdown(reconfigure
);
399 window_shutdown(reconfigure
);
400 sn_shutdown(reconfigure
);
401 event_shutdown(reconfigure
);
403 actions_shutdown(reconfigure
);
405 /* Free the key codes for built in keys */
406 g_free(keys
[OB_KEY_RETURN
]);
407 g_free(keys
[OB_KEY_ESCAPE
]);
408 g_free(keys
[OB_KEY_LEFT
]);
409 g_free(keys
[OB_KEY_RIGHT
]);
410 g_free(keys
[OB_KEY_UP
]);
411 g_free(keys
[OB_KEY_DOWN
]);
412 g_free(keys
[OB_KEY_TAB
]);
413 g_free(keys
[OB_KEY_SPACE
]);
414 } while (reconfigure
);
417 XSync(obt_display
, FALSE
);
419 RrThemeFree(ob_rr_theme
);
420 RrImageCacheUnref(ob_rr_icons
);
421 RrInstanceFree(ob_rr_inst
);
423 session_shutdown(being_replaced
);
429 if (restart_path
!= NULL
) {
434 /* run other window manager */
435 if (g_shell_parse_argv(restart_path
, &argcp
, &argvp
, &err
)) {
436 execvp(argvp
[0], argvp
);
440 _("Restart failed to execute new executable \"%s\": %s"),
441 restart_path
, err
->message
);
446 /* we remove the session arguments from argv, so put them back,
447 also don't restore the session on restart */
448 if (ob_sm_save_file
!= NULL
|| ob_sm_id
!= NULL
) {
453 (ob_sm_save_file
!= NULL
? 2 : 0) +
454 (ob_sm_id
!= NULL
? 2 : 0);
455 nargv
= g_new0(gchar
*, l
+1);
456 for (i
= 0; i
< argc
; ++i
)
459 if (ob_sm_save_file
!= NULL
) {
460 nargv
[i
++] = g_strdup("--sm-save-file");
461 nargv
[i
++] = ob_sm_save_file
;
463 if (ob_sm_id
!= NULL
) {
464 nargv
[i
++] = g_strdup("--sm-client-id");
465 nargv
[i
++] = ob_sm_id
;
467 nargv
[i
++] = g_strdup("--sm-no-load");
473 execvp(argv
[0], argv
); /* try how we were run */
474 execlp(argv
[0], program_name
, (gchar
*)NULL
); /* last resort */
477 /* free stuff passed in from the command line or environment */
478 g_free(ob_sm_save_file
);
480 g_free(program_name
);
488 static void signal_handler(gint signal
, gpointer data
)
492 ob_debug("Caught signal %d. Restarting.", signal
);
496 ob_debug("Caught signal %d. Reconfiguring.", signal
);
501 while (waitpid(-1, NULL
, WNOHANG
) > 0);
504 ob_debug("Caught signal %d. Exiting.", signal
);
505 /* TERM and INT return a 0 code */
506 ob_exit(!(signal
== SIGTERM
|| signal
== SIGINT
));
510 static void print_version(void)
512 g_print("Openbox %s\n", PACKAGE_VERSION
);
513 g_print(_("Copyright (c)"));
514 g_print(" 2008 Mikael Magnusson\n");
515 g_print(_("Copyright (c)"));
516 g_print(" 2003-2006 Dana Jansens\n\n");
517 g_print("This program comes with ABSOLUTELY NO WARRANTY.\n");
518 g_print("This is free software, and you are welcome to redistribute it\n");
519 g_print("under certain conditions. See the file COPYING for details.\n\n");
522 static void print_help(void)
524 g_print(_("Syntax: openbox [options]\n"));
525 g_print(_("\nOptions:\n"));
526 g_print(_(" --help Display this help and exit\n"));
527 g_print(_(" --version Display the version and exit\n"));
528 g_print(_(" --replace Replace the currently running window manager\n"));
529 /* TRANSLATORS: if you translate "FILE" here, make sure to keep the "Specify..."
530 aligned still, if you have to, make a new line with \n and 22 spaces. It's
531 fine to leave it as FILE though. */
532 g_print(_(" --config-file FILE Specify the path to the config file to use\n"));
533 g_print(_(" --sm-disable Disable connection to the session manager\n"));
534 g_print(_("\nPassing messages to a running Openbox instance:\n"));
535 g_print(_(" --reconfigure Reload Openbox's configuration\n"));
536 g_print(_(" --restart Restart Openbox\n"));
537 g_print(_(" --exit Exit Openbox\n"));
538 g_print(_("\nDebugging options:\n"));
539 g_print(_(" --sync Run in synchronous mode\n"));
540 g_print(_(" --debug Display debugging output\n"));
541 g_print(_(" --debug-focus Display debugging output for focus handling\n"));
542 g_print(_(" --debug-session Display debugging output for session management\n"));
543 g_print(_(" --debug-xinerama Split the display into fake xinerama screens\n"));
544 g_print(_("\nPlease report bugs at %s\n"), PACKAGE_BUGREPORT
);
547 static void remove_args(gint
*argc
, gchar
**argv
, gint index
, gint num
)
551 for (i
= index
; i
< *argc
- num
; ++i
)
552 argv
[i
] = argv
[i
+num
];
553 for (; i
< *argc
; ++i
)
558 static void parse_env(void)
562 /* unset this so we don't pass it on unknowingly */
563 unsetenv("DESKTOP_STARTUP_ID");
565 /* this is how gnome-session passes in a session client id */
566 id
= g_getenv("DESKTOP_AUTOSTART_ID");
568 unsetenv("DESKTOP_AUTOSTART_ID");
569 if (ob_sm_id
) g_free(ob_sm_id
);
570 ob_sm_id
= g_strdup(id
);
571 ob_debug_type(OB_DEBUG_SM
,
572 "DESKTOP_AUTOSTART_ID %s supercedes --sm-client-id\n",
577 static void parse_args(gint
*argc
, gchar
**argv
)
581 for (i
= 1; i
< *argc
; ++i
) {
582 if (!strcmp(argv
[i
], "--version")) {
586 else if (!strcmp(argv
[i
], "--help")) {
590 else if (!strcmp(argv
[i
], "--g-fatal-warnings")) {
591 g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL
);
593 else if (!strcmp(argv
[i
], "--replace")) {
594 ob_replace_wm
= TRUE
;
595 remove_args(argc
, argv
, i
, 1);
596 --i
; /* this arg was removed so go back */
598 else if (!strcmp(argv
[i
], "--sync")) {
601 else if (!strcmp(argv
[i
], "--debug")) {
602 ob_debug_enable(OB_DEBUG_NORMAL
, TRUE
);
603 ob_debug_enable(OB_DEBUG_APP_BUGS
, TRUE
);
605 else if (!strcmp(argv
[i
], "--debug-focus")) {
606 ob_debug_enable(OB_DEBUG_FOCUS
, TRUE
);
608 else if (!strcmp(argv
[i
], "--debug-session")) {
609 ob_debug_enable(OB_DEBUG_SM
, TRUE
);
611 else if (!strcmp(argv
[i
], "--debug-xinerama")) {
612 ob_debug_xinerama
= TRUE
;
614 else if (!strcmp(argv
[i
], "--reconfigure")) {
617 else if (!strcmp(argv
[i
], "--restart")) {
620 else if (!strcmp(argv
[i
], "--exit")) {
623 else if (!strcmp(argv
[i
], "--config-file")) {
624 if (i
== *argc
- 1) /* no args left */
625 g_printerr(_("--config-file requires an argument\n"));
627 /* this will be in the current locale encoding, which is
629 config_file
= argv
[i
+1];
630 ++i
; /* skip the argument */
631 ob_debug("--config-file %s", config_file
);
634 else if (!strcmp(argv
[i
], "--sm-save-file")) {
635 if (i
== *argc
- 1) /* no args left */
636 /* not translated cuz it's sekret */
637 g_printerr("--sm-save-file requires an argument\n");
639 ob_sm_save_file
= g_strdup(argv
[i
+1]);
640 remove_args(argc
, argv
, i
, 2);
641 --i
; /* this arg was removed so go back */
642 ob_debug_type(OB_DEBUG_SM
, "--sm-save-file %s",
646 else if (!strcmp(argv
[i
], "--sm-client-id")) {
647 if (i
== *argc
- 1) /* no args left */
648 /* not translated cuz it's sekret */
649 g_printerr("--sm-client-id requires an argument\n");
651 ob_sm_id
= g_strdup(argv
[i
+1]);
652 remove_args(argc
, argv
, i
, 2);
653 --i
; /* this arg was removed so go back */
654 ob_debug_type(OB_DEBUG_SM
, "--sm-client-id %s", ob_sm_id
);
657 else if (!strcmp(argv
[i
], "--sm-disable")) {
660 else if (!strcmp(argv
[i
], "--sm-no-load")) {
661 ob_sm_restore
= FALSE
;
662 remove_args(argc
, argv
, i
, 1);
663 --i
; /* this arg was removed so go back */
666 /* this is a memleak.. oh well.. heh */
667 gchar
*err
= g_strdup_printf
668 (_("Invalid command line argument \"%s\"\n"), argv
[i
]);
669 ob_exit_with_error(err
);
674 static Cursor
load_cursor(const gchar
*name
, guint fontval
)
679 c
= XcursorLibraryLoadCursor(obt_display
, name
);
682 c
= XCreateFontCursor(obt_display
, fontval
);
686 void ob_exit_with_error(const gchar
*msg
)
688 g_message("%s", msg
);
689 session_shutdown(TRUE
);
693 void ob_restart_other(const gchar
*path
)
695 restart_path
= g_strdup(path
);
699 void ob_restart(void)
705 void ob_reconfigure(void)
711 void ob_exit(gint code
)
714 obt_main_loop_exit(ob_main_loop
);
717 void ob_exit_replace(void)
720 being_replaced
= TRUE
;
721 obt_main_loop_exit(ob_main_loop
);
724 Cursor
ob_cursor(ObCursor cursor
)
726 g_assert(cursor
< OB_NUM_CURSORS
);
727 return cursors
[cursor
];
730 gboolean
ob_keycode_match(KeyCode code
, ObKey key
)
734 g_assert(key
< OB_NUM_KEYS
);
735 for (k
= keys
[key
]; *k
; ++k
)
736 if (*k
== code
) return TRUE
;
740 ObState
ob_state(void)
745 void ob_set_state(ObState s
)