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
);
179 ob_screen
= DefaultScreen(ob_display
);
181 ob_rr_inst
= RrInstanceNew(ob_display
, ob_screen
);
182 if (ob_rr_inst
== NULL
)
183 ob_exit_with_error(_("Failed to initialize the obrender library."));
184 /* Saving 3 resizes of an RrImage makes a lot of sense for icons, as there
185 are generally 3 icon sizes needed: the titlebar icon, the menu icon,
188 ob_rr_icons
= RrImageCacheNew(3);
190 XSynchronize(ob_display
, xsync
);
192 /* check for locale support */
193 if (!XSupportsLocale())
194 g_message(_("X server does not support locale."));
195 if (!XSetLocaleModifiers(""))
196 g_message(_("Cannot set locale modifiers for the X server."));
198 /* set our error handler */
199 XSetErrorHandler(xerror_handler
);
201 /* set the DISPLAY environment variable for any lauched children, to the
202 display we're using, so they open in the right place. */
203 setenv("DISPLAY", DisplayString(ob_display
), TRUE
);
205 /* create available cursors */
206 cursors
[OB_CURSOR_NONE
] = None
;
207 cursors
[OB_CURSOR_POINTER
] = load_cursor("left_ptr", XC_left_ptr
);
208 cursors
[OB_CURSOR_BUSYPOINTER
] = load_cursor("left_ptr_watch",XC_left_ptr
);
209 cursors
[OB_CURSOR_BUSY
] = load_cursor("watch", XC_watch
);
210 cursors
[OB_CURSOR_MOVE
] = load_cursor("fleur", XC_fleur
);
211 cursors
[OB_CURSOR_NORTH
] = load_cursor("top_side", XC_top_side
);
212 cursors
[OB_CURSOR_NORTHEAST
] = load_cursor("top_right_corner",
213 XC_top_right_corner
);
214 cursors
[OB_CURSOR_EAST
] = load_cursor("right_side", XC_right_side
);
215 cursors
[OB_CURSOR_SOUTHEAST
] = load_cursor("bottom_right_corner",
216 XC_bottom_right_corner
);
217 cursors
[OB_CURSOR_SOUTH
] = load_cursor("bottom_side", XC_bottom_side
);
218 cursors
[OB_CURSOR_SOUTHWEST
] = load_cursor("bottom_left_corner",
219 XC_bottom_left_corner
);
220 cursors
[OB_CURSOR_WEST
] = load_cursor("left_side", XC_left_side
);
221 cursors
[OB_CURSOR_NORTHWEST
] = load_cursor("top_left_corner",
224 prop_startup(); /* get atoms values for the display */
225 extensions_query_all(); /* find which extensions are present */
227 if (screen_annex()) { /* it will be ours! */
229 ObPrompt
*xmlprompt
= NULL
;
231 modkeys_startup(reconfigure
);
233 /* get the keycodes for keys we use */
234 keys
[OB_KEY_RETURN
] = modkeys_sym_to_code(XK_Return
);
235 keys
[OB_KEY_ESCAPE
] = modkeys_sym_to_code(XK_Escape
);
236 keys
[OB_KEY_LEFT
] = modkeys_sym_to_code(XK_Left
);
237 keys
[OB_KEY_RIGHT
] = modkeys_sym_to_code(XK_Right
);
238 keys
[OB_KEY_UP
] = modkeys_sym_to_code(XK_Up
);
239 keys
[OB_KEY_DOWN
] = modkeys_sym_to_code(XK_Down
);
240 keys
[OB_KEY_TAB
] = modkeys_sym_to_code(XK_Tab
);
241 keys
[OB_KEY_SPACE
] = modkeys_sym_to_code(XK_space
);
248 /* startup the parsing so everything can register sections
252 /* register all the available actions */
253 actions_startup(reconfigure
);
254 /* start up config which sets up with the parser */
257 /* parse/load user options */
258 if (parse_load_rc(config_file
, &doc
, &node
)) {
259 parse_tree(i
, doc
, node
->xmlChildrenNode
);
263 g_message(_("Unable to find a valid config file, using some simple defaults"));
268 gchar
*p
= g_filename_to_utf8(config_file
, -1,
271 PROP_SETS(RootWindow(ob_display
, ob_screen
),
276 PROP_ERASE(RootWindow(ob_display
, ob_screen
),
279 /* we're done with parsing now, kill it */
283 /* load the theme specified in the rc file */
286 if ((theme
= RrThemeNew(ob_rr_inst
, config_theme
, TRUE
,
287 config_font_activewindow
,
288 config_font_inactivewindow
,
289 config_font_menutitle
,
290 config_font_menuitem
,
293 RrThemeFree(ob_rr_theme
);
296 if (ob_rr_theme
== NULL
)
297 ob_exit_with_error(_("Unable to load a theme."));
299 PROP_SETS(RootWindow(ob_display
, ob_screen
),
300 ob_theme
, ob_rr_theme
->name
);
306 /* update all existing windows for the new theme */
307 for (it
= client_list
; it
; it
= g_list_next(it
)) {
308 ObClient
*c
= it
->data
;
309 frame_adjust_theme(c
->frame
);
312 event_startup(reconfigure
);
313 /* focus_backup is used for stacking, so this needs to come before
314 anything that calls stacking_add */
315 sn_startup(reconfigure
);
316 window_startup(reconfigure
);
317 focus_startup(reconfigure
);
318 focus_cycle_startup(reconfigure
);
319 focus_cycle_indicator_startup(reconfigure
);
320 focus_cycle_popup_startup(reconfigure
);
321 screen_startup(reconfigure
);
322 grab_startup(reconfigure
);
323 group_startup(reconfigure
);
324 ping_startup(reconfigure
);
325 client_startup(reconfigure
);
326 dock_startup(reconfigure
);
327 moveresize_startup(reconfigure
);
328 keyboard_startup(reconfigure
);
329 mouse_startup(reconfigure
);
330 menu_frame_startup(reconfigure
);
331 menu_startup(reconfigure
);
332 prompt_startup(reconfigure
);
338 /* get all the existing windows */
342 /* focus what was focused if a wm was already running */
343 if (PROP_GET32(RootWindow(ob_display
, ob_screen
),
344 net_active_window
, window
, &xid
) &&
345 (w
= g_hash_table_lookup(window_map
, &xid
)) &&
348 client_focus(WINDOW_AS_CLIENT(w
));
353 /* redecorate all existing windows */
354 for (it
= client_list
; it
; it
= g_list_next(it
)) {
355 ObClient
*c
= it
->data
;
357 /* the new config can change the window's decorations */
358 client_setup_decor_and_functions(c
, FALSE
);
359 /* redraw the frames */
360 frame_adjust_area(c
->frame
, TRUE
, TRUE
, FALSE
);
361 /* the decor sizes may have changed, so the windows may
362 end up in new positions */
363 client_reconfigure(c
, FALSE
);
369 ob_set_state(OB_STATE_RUNNING
);
371 /* look for parsing errors */
373 xmlErrorPtr e
= xmlGetLastError();
377 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
);
379 prompt_show_message(m
, _("Openbox Syntax Error"), _("Close"));
385 ob_main_loop_run(ob_main_loop
);
386 ob_set_state(reconfigure
?
387 OB_STATE_RECONFIGURING
: OB_STATE_EXITING
);
390 prompt_unref(xmlprompt
);
396 client_unmanage_all();
399 prompt_shutdown(reconfigure
);
400 menu_shutdown(reconfigure
);
401 menu_frame_shutdown(reconfigure
);
402 mouse_shutdown(reconfigure
);
403 keyboard_shutdown(reconfigure
);
404 moveresize_shutdown(reconfigure
);
405 dock_shutdown(reconfigure
);
406 client_shutdown(reconfigure
);
407 ping_shutdown(reconfigure
);
408 group_shutdown(reconfigure
);
409 grab_shutdown(reconfigure
);
410 screen_shutdown(reconfigure
);
411 focus_cycle_popup_shutdown(reconfigure
);
412 focus_cycle_indicator_shutdown(reconfigure
);
413 focus_cycle_shutdown(reconfigure
);
414 focus_shutdown(reconfigure
);
415 window_shutdown(reconfigure
);
416 sn_shutdown(reconfigure
);
417 event_shutdown(reconfigure
);
419 actions_shutdown(reconfigure
);
421 /* Free the key codes for built in keys */
422 g_free(keys
[OB_KEY_RETURN
]);
423 g_free(keys
[OB_KEY_ESCAPE
]);
424 g_free(keys
[OB_KEY_LEFT
]);
425 g_free(keys
[OB_KEY_RIGHT
]);
426 g_free(keys
[OB_KEY_UP
]);
427 g_free(keys
[OB_KEY_DOWN
]);
428 g_free(keys
[OB_KEY_TAB
]);
429 g_free(keys
[OB_KEY_SPACE
]);
431 modkeys_shutdown(reconfigure
);
432 } while (reconfigure
);
435 XSync(ob_display
, FALSE
);
437 RrThemeFree(ob_rr_theme
);
438 RrImageCacheUnref(ob_rr_icons
);
439 RrInstanceFree(ob_rr_inst
);
441 session_shutdown(being_replaced
);
443 XCloseDisplay(ob_display
);
445 parse_paths_shutdown();
448 if (restart_path
!= NULL
) {
453 /* run other window manager */
454 if (g_shell_parse_argv(restart_path
, &argcp
, &argvp
, &err
)) {
455 execvp(argvp
[0], argvp
);
459 _("Restart failed to execute new executable \"%s\": %s"),
460 restart_path
, err
->message
);
465 /* we remove the session arguments from argv, so put them back,
466 also don't restore the session on restart */
467 if (ob_sm_save_file
!= NULL
|| ob_sm_id
!= NULL
) {
472 (ob_sm_save_file
!= NULL
? 2 : 0) +
473 (ob_sm_id
!= NULL
? 2 : 0);
474 nargv
= g_new0(gchar
*, l
+1);
475 for (i
= 0; i
< argc
; ++i
)
478 if (ob_sm_save_file
!= NULL
) {
479 nargv
[i
++] = g_strdup("--sm-save-file");
480 nargv
[i
++] = ob_sm_save_file
;
482 if (ob_sm_id
!= NULL
) {
483 nargv
[i
++] = g_strdup("--sm-client-id");
484 nargv
[i
++] = ob_sm_id
;
486 nargv
[i
++] = g_strdup("--sm-no-load");
492 execvp(argv
[0], argv
); /* try how we were run */
493 execlp(argv
[0], program_name
, (gchar
*)NULL
); /* last resort */
496 /* free stuff passed in from the command line or environment */
497 g_free(ob_sm_save_file
);
499 g_free(program_name
);
504 static void signal_handler(gint signal
, gpointer data
)
508 ob_debug("Caught signal %d. Restarting.\n", signal
);
512 ob_debug("Caught signal %d. Reconfiguring.\n", signal
);
517 while (waitpid(-1, NULL
, WNOHANG
) > 0);
520 ob_debug("Caught signal %d. Exiting.\n", signal
);
521 /* TERM and INT return a 0 code */
522 ob_exit(!(signal
== SIGTERM
|| signal
== SIGINT
));
526 static void print_version()
528 g_print("Openbox %s\n", PACKAGE_VERSION
);
529 g_print(_("Copyright (c)"));
530 g_print(" 2008 Mikael Magnusson\n");
531 g_print(_("Copyright (c)"));
532 g_print(" 2003-2006 Dana Jansens\n\n");
533 g_print("This program comes with ABSOLUTELY NO WARRANTY.\n");
534 g_print("This is free software, and you are welcome to redistribute it\n");
535 g_print("under certain conditions. See the file COPYING for details.\n\n");
538 static void print_help()
540 g_print(_("Syntax: openbox [options]\n"));
541 g_print(_("\nOptions:\n"));
542 g_print(_(" --help Display this help and exit\n"));
543 g_print(_(" --version Display the version and exit\n"));
544 g_print(_(" --replace Replace the currently running window manager\n"));
545 /* TRANSLATORS: if you translate "FILE" here, make sure to keep the "Specify..."
546 aligned still, if you have to, make a new line with \n and 22 spaces. It's
547 fine to leave it as FILE though. */
548 g_print(_(" --config-file FILE Specify the path to the config file to use\n"));
549 g_print(_(" --sm-disable Disable connection to the session manager\n"));
550 g_print(_("\nPassing messages to a running Openbox instance:\n"));
551 g_print(_(" --reconfigure Reload Openbox's configuration\n"));
552 g_print(_(" --restart Restart Openbox\n"));
553 g_print(_(" --exit Exit Openbox\n"));
554 g_print(_("\nDebugging options:\n"));
555 g_print(_(" --sync Run in synchronous mode\n"));
556 g_print(_(" --debug Display debugging output\n"));
557 g_print(_(" --debug-focus Display debugging output for focus handling\n"));
558 g_print(_(" --debug-xinerama Split the display into fake xinerama screens\n"));
559 g_print(_("\nPlease report bugs at %s\n"), PACKAGE_BUGREPORT
);
562 static void remove_args(gint
*argc
, gchar
**argv
, gint index
, gint num
)
566 for (i
= index
; i
< *argc
- num
; ++i
)
567 argv
[i
] = argv
[i
+num
];
568 for (; i
< *argc
; ++i
)
573 static void parse_env()
577 /* unset this so we don't pass it on unknowingly */
578 unsetenv("DESKTOP_STARTUP_ID");
580 /* this is how gnome-session passes in a session client id */
581 id
= g_getenv("DESKTOP_AUTOSTART_ID");
583 unsetenv("DESKTOP_AUTOSTART_ID");
584 if (ob_sm_id
) g_free(ob_sm_id
);
585 ob_sm_id
= g_strdup(id
);
586 ob_debug_type(OB_DEBUG_SM
,
587 "DESKTOP_AUTOSTART_ID %s supercedes --sm-client-id\n",
592 static void parse_args(gint
*argc
, gchar
**argv
)
596 for (i
= 1; i
< *argc
; ++i
) {
597 if (!strcmp(argv
[i
], "--version")) {
601 else if (!strcmp(argv
[i
], "--help")) {
605 else if (!strcmp(argv
[i
], "--g-fatal-warnings")) {
606 g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL
);
608 else if (!strcmp(argv
[i
], "--replace")) {
609 ob_replace_wm
= TRUE
;
610 remove_args(argc
, argv
, i
, 1);
611 --i
; /* this arg was removed so go back */
613 else if (!strcmp(argv
[i
], "--sync")) {
616 else if (!strcmp(argv
[i
], "--debug")) {
617 ob_debug_show_output(TRUE
);
618 ob_debug_enable(OB_DEBUG_SM
, TRUE
);
619 ob_debug_enable(OB_DEBUG_APP_BUGS
, TRUE
);
621 else if (!strcmp(argv
[i
], "--debug-focus")) {
622 ob_debug_show_output(TRUE
);
623 ob_debug_enable(OB_DEBUG_SM
, TRUE
);
624 ob_debug_enable(OB_DEBUG_APP_BUGS
, TRUE
);
625 ob_debug_enable(OB_DEBUG_FOCUS
, TRUE
);
627 else if (!strcmp(argv
[i
], "--debug-xinerama")) {
628 ob_debug_xinerama
= TRUE
;
630 else if (!strcmp(argv
[i
], "--reconfigure")) {
633 else if (!strcmp(argv
[i
], "--restart")) {
636 else if (!strcmp(argv
[i
], "--exit")) {
639 else if (!strcmp(argv
[i
], "--config-file")) {
640 if (i
== *argc
- 1) /* no args left */
641 g_printerr(_("--config-file requires an argument\n"));
643 /* this will be in the current locale encoding, which is
645 config_file
= argv
[i
+1];
646 ++i
; /* skip the argument */
647 ob_debug("--config-file %s\n", config_file
);
650 else if (!strcmp(argv
[i
], "--sm-save-file")) {
651 if (i
== *argc
- 1) /* no args left */
652 /* not translated cuz it's sekret */
653 g_printerr("--sm-save-file requires an argument\n");
655 ob_sm_save_file
= g_strdup(argv
[i
+1]);
656 remove_args(argc
, argv
, i
, 2);
657 --i
; /* this arg was removed so go back */
658 ob_debug_type(OB_DEBUG_SM
, "--sm-save-file %s\n",
662 else if (!strcmp(argv
[i
], "--sm-client-id")) {
663 if (i
== *argc
- 1) /* no args left */
664 /* not translated cuz it's sekret */
665 g_printerr("--sm-client-id requires an argument\n");
667 ob_sm_id
= g_strdup(argv
[i
+1]);
668 remove_args(argc
, argv
, i
, 2);
669 --i
; /* this arg was removed so go back */
670 ob_debug_type(OB_DEBUG_SM
, "--sm-client-id %s\n", ob_sm_id
);
673 else if (!strcmp(argv
[i
], "--sm-disable")) {
676 else if (!strcmp(argv
[i
], "--sm-no-load")) {
677 ob_sm_restore
= FALSE
;
678 remove_args(argc
, argv
, i
, 1);
679 --i
; /* this arg was removed so go back */
682 /* this is a memleak.. oh well.. heh */
683 gchar
*err
= g_strdup_printf
684 (_("Invalid command line argument \"%s\"\n"), argv
[i
]);
685 ob_exit_with_error(err
);
690 static Cursor
load_cursor(const gchar
*name
, guint fontval
)
695 c
= XcursorLibraryLoadCursor(ob_display
, name
);
698 c
= XCreateFontCursor(ob_display
, fontval
);
702 void ob_exit_with_error(const gchar
*msg
)
705 session_shutdown(TRUE
);
709 void ob_restart_other(const gchar
*path
)
711 restart_path
= g_strdup(path
);
721 void ob_reconfigure()
727 void ob_exit(gint code
)
730 ob_main_loop_exit(ob_main_loop
);
733 void ob_exit_replace()
736 being_replaced
= TRUE
;
737 ob_main_loop_exit(ob_main_loop
);
740 Cursor
ob_cursor(ObCursor cursor
)
742 g_assert(cursor
< OB_NUM_CURSORS
);
743 return cursors
[cursor
];
746 gboolean
ob_keycode_match(KeyCode code
, ObKey key
)
750 g_assert(key
< OB_NUM_KEYS
);
751 for (k
= keys
[key
]; *k
; ++k
)
752 if (*k
== code
) return TRUE
;
761 void ob_set_state(ObState s
)