ed64682361f726d15ea9405cd5dfc8e8a1b441fb
[dana/openbox.git] / openbox / openbox.c
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    openbox.c for the Openbox window manager
4    Copyright (c) 2006        Mikael Magnusson
5    Copyright (c) 2003-2007   Dana Jansens
6
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.
11
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.
16
17    See the COPYING file for a copy of the GNU General Public License.
18 */
19
20 #include "debug.h"
21 #include "openbox.h"
22 #include "session.h"
23 #include "dock.h"
24 #include "event.h"
25 #include "menu.h"
26 #include "client.h"
27 #include "screen.h"
28 #include "actions.h"
29 #include "startupnotify.h"
30 #include "focus.h"
31 #include "focus_cycle.h"
32 #include "focus_cycle_indicator.h"
33 #include "focus_cycle_popup.h"
34 #include "moveresize.h"
35 #include "frame.h"
36 #include "keyboard.h"
37 #include "mouse.h"
38 #include "menuframe.h"
39 #include "grab.h"
40 #include "group.h"
41 #include "config.h"
42 #include "ping.h"
43 #include "gettext.h"
44 #include "render/render.h"
45 #include "render/theme.h"
46 #include "obt/display.h"
47 #include "obt/prop.h"
48 #include "obt/keyboard.h"
49 #include "obt/parse.h"
50
51 #ifdef HAVE_FCNTL_H
52 #  include <fcntl.h>
53 #endif
54 #ifdef HAVE_SIGNAL_H
55 #  include <signal.h>
56 #endif
57 #ifdef HAVE_STDLIB_H
58 #  include <stdlib.h>
59 #endif
60 #ifdef HAVE_LOCALE_H
61 #  include <locale.h>
62 #endif
63 #ifdef HAVE_SYS_STAT_H
64 #  include <sys/stat.h>
65 #  include <sys/types.h>
66 #endif
67 #ifdef HAVE_SYS_WAIT_H
68 #  include <sys/types.h>
69 #  include <sys/wait.h>
70 #endif
71 #ifdef HAVE_UNISTD_H
72 #  include <unistd.h>
73 #endif
74 #include <errno.h>
75
76 #include <X11/cursorfont.h>
77 #if USE_XCURSOR
78 #include <X11/Xcursor/Xcursor.h>
79 #endif
80
81 #include <X11/Xlib.h>
82 #include <X11/keysym.h>
83
84 RrInstance  *ob_rr_inst;
85 RrTheme     *ob_rr_theme;
86 ObtMainLoop *ob_main_loop;
87 gint         ob_screen;
88 gboolean     ob_replace_wm = FALSE;
89 gboolean     ob_sm_use = TRUE;
90 gchar       *ob_sm_id = NULL;
91 gchar       *ob_sm_save_file = NULL;
92 gboolean     ob_sm_restore = TRUE;
93 gboolean     ob_debug_xinerama = FALSE;
94
95 static ObState   state;
96 static gboolean  xsync = FALSE;
97 static gboolean  reconfigure = FALSE;
98 static gboolean  restart = FALSE;
99 static gchar    *restart_path = NULL;
100 static Cursor    cursors[OB_NUM_CURSORS];
101 static KeyCode   keys[OB_NUM_KEYS];
102 static gint      exitcode = 0;
103 static guint     remote_control = 0;
104 static gboolean  being_replaced = FALSE;
105
106 static void signal_handler(gint signal, gpointer data);
107 static void remove_args(gint *argc, gchar **argv, gint index, gint num);
108 static void parse_env();
109 static void parse_args(gint *argc, gchar **argv);
110 static Cursor load_cursor(const gchar *name, guint fontval);
111
112 gint main(gint argc, gchar **argv)
113 {
114     gchar *program_name;
115
116     state = OB_STATE_STARTING;
117
118     /* initialize the locale */
119     if (!setlocale(LC_ALL, ""))
120         g_message("Couldn't set locale from environment.");
121     bindtextdomain(PACKAGE_NAME, LOCALEDIR);
122     bind_textdomain_codeset(PACKAGE_NAME, "UTF-8");
123     textdomain(PACKAGE_NAME);
124
125     if (chdir(g_get_home_dir()) == -1)
126         g_message(_("Unable to change to home directory '%s': %s"),
127                   g_get_home_dir(), g_strerror(errno));
128
129     /* parse the command line args, which can change the argv[0] */
130     parse_args(&argc, argv);
131     /* parse the environment variables */
132     parse_env();
133
134     program_name = g_path_get_basename(argv[0]);
135     g_set_prgname(program_name);
136
137     if (!remote_control)
138         session_startup(argc, argv);
139
140     if (!obt_display_open(NULL))
141         ob_exit_with_error(_("Failed to open the display from the DISPLAY environment variable."));
142
143     if (remote_control) {
144         /* Send client message telling the OB process to:
145          * remote_control = 1 -> reconfigure
146          * remote_control = 2 -> restart */
147         OBT_PROP_MSG(ob_screen, RootWindow(obt_display, ob_screen),
148                      OB_CONTROL, remote_control, 0, 0, 0, 0);
149         obt_display_close(obt_display);
150         exit(EXIT_SUCCESS);
151     }
152
153     ob_main_loop = obt_main_loop_new();
154
155     /* set up signal handler */
156     obt_main_loop_signal_add(ob_main_loop, SIGUSR1, signal_handler, NULL,NULL);
157     obt_main_loop_signal_add(ob_main_loop, SIGUSR2, signal_handler, NULL,NULL);
158     obt_main_loop_signal_add(ob_main_loop, SIGTERM, signal_handler, NULL,NULL);
159     obt_main_loop_signal_add(ob_main_loop, SIGINT, signal_handler,  NULL,NULL);
160     obt_main_loop_signal_add(ob_main_loop, SIGHUP, signal_handler,  NULL,NULL);
161     obt_main_loop_signal_add(ob_main_loop, SIGPIPE, signal_handler, NULL,NULL);
162     obt_main_loop_signal_add(ob_main_loop, SIGCHLD, signal_handler, NULL,NULL);
163
164     ob_screen = DefaultScreen(obt_display);
165
166     ob_rr_inst = RrInstanceNew(obt_display, ob_screen);
167     if (ob_rr_inst == NULL)
168         ob_exit_with_error(_("Failed to initialize the obrender library."));
169
170     XSynchronize(obt_display, xsync);
171
172     /* check for locale support */
173     if (!XSupportsLocale())
174         g_message(_("X server does not support locale."));
175     if (!XSetLocaleModifiers(""))
176         g_message(_("Cannot set locale modifiers for the X server."));
177
178     /* set the DISPLAY environment variable for any lauched children, to the
179        display we're using, so they open in the right place. */
180     putenv(g_strdup_printf("DISPLAY=%s", DisplayString(obt_display)));
181
182     /* create available cursors */
183     cursors[OB_CURSOR_NONE] = None;
184     cursors[OB_CURSOR_POINTER] = load_cursor("left_ptr", XC_left_ptr);
185     cursors[OB_CURSOR_BUSYPOINTER] = load_cursor("left_ptr_watch",XC_left_ptr);
186     cursors[OB_CURSOR_BUSY] = load_cursor("watch", XC_watch);
187     cursors[OB_CURSOR_MOVE] = load_cursor("fleur", XC_fleur);
188     cursors[OB_CURSOR_NORTH] = load_cursor("top_side", XC_top_side);
189     cursors[OB_CURSOR_NORTHEAST] = load_cursor("top_right_corner",
190                                                XC_top_right_corner);
191     cursors[OB_CURSOR_EAST] = load_cursor("right_side", XC_right_side);
192     cursors[OB_CURSOR_SOUTHEAST] = load_cursor("bottom_right_corner",
193                                                XC_bottom_right_corner);
194     cursors[OB_CURSOR_SOUTH] = load_cursor("bottom_side", XC_bottom_side);
195     cursors[OB_CURSOR_SOUTHWEST] = load_cursor("bottom_left_corner",
196                                                XC_bottom_left_corner);
197     cursors[OB_CURSOR_WEST] = load_cursor("left_side", XC_left_side);
198     cursors[OB_CURSOR_NORTHWEST] = load_cursor("top_left_corner",
199                                                XC_top_left_corner);
200
201     if (screen_annex()) { /* it will be ours! */
202         do {
203             if (reconfigure) obt_keyboard_reload();
204
205             /* get the keycodes for keys we use */
206             keys[OB_KEY_RETURN] = obt_keyboard_keysym_to_keycode(XK_Return);
207             keys[OB_KEY_ESCAPE] = obt_keyboard_keysym_to_keycode(XK_Escape);
208             keys[OB_KEY_LEFT] = obt_keyboard_keysym_to_keycode(XK_Left);
209             keys[OB_KEY_RIGHT] = obt_keyboard_keysym_to_keycode(XK_Right);
210             keys[OB_KEY_UP] = obt_keyboard_keysym_to_keycode(XK_Up);
211             keys[OB_KEY_DOWN] = obt_keyboard_keysym_to_keycode(XK_Down);
212
213             {
214                 ObtParseInst *i;
215
216                 /* startup the parsing so everything can register sections
217                    of the rc */
218                 i = obt_parse_instance_new();
219
220                 /* register all the available actions */
221                 actions_startup(reconfigure);
222                 /* start up config which sets up with the parser */
223                 config_startup(i);
224
225                 /* parse/load user options */
226                 if (obt_parse_load_config_file(i, "openbox", "rc.xml",
227                                                "openbox_config"))
228                 {
229                     obt_parse_tree_from_root(i);
230                     obt_parse_close(i);
231                 } else
232                     g_message(_("Unable to find a valid config file, using some simple defaults"));
233
234 /*
235                 if (config_type != NULL)
236                     PROP_SETS(RootWindow(obt_display, ob_screen),
237                               ob_config, config_type);
238 */
239
240                 /* we're done with parsing now, kill it */
241                 obt_parse_instance_unref(i);
242             }
243
244             /* load the theme specified in the rc file */
245             {
246                 RrTheme *theme;
247                 if ((theme = RrThemeNew(ob_rr_inst, config_theme, TRUE,
248                                         config_font_activewindow,
249                                         config_font_inactivewindow,
250                                         config_font_menutitle,
251                                         config_font_menuitem,
252                                         config_font_osd)))
253                 {
254                     RrThemeFree(ob_rr_theme);
255                     ob_rr_theme = theme;
256                 }
257                 if (ob_rr_theme == NULL)
258                     ob_exit_with_error(_("Unable to load a theme."));
259
260                 OBT_PROP_SETS(RootWindow(obt_display, ob_screen),
261                               OB_THEME, utf8, ob_rr_theme->name);
262             }
263
264             if (reconfigure) {
265                 GList *it;
266
267                 /* update all existing windows for the new theme */
268                 for (it = client_list; it; it = g_list_next(it)) {
269                     ObClient *c = it->data;
270                     frame_adjust_theme(c->frame);
271                 }
272             }
273             event_startup(reconfigure);
274             /* focus_backup is used for stacking, so this needs to come before
275                anything that calls stacking_add */
276             sn_startup(reconfigure);
277             window_startup(reconfigure);
278             focus_startup(reconfigure);
279             focus_cycle_startup(reconfigure);
280             focus_cycle_indicator_startup(reconfigure);
281             focus_cycle_popup_startup(reconfigure);
282             screen_startup(reconfigure);
283             grab_startup(reconfigure);
284             group_startup(reconfigure);
285             ping_startup(reconfigure);
286             client_startup(reconfigure);
287             dock_startup(reconfigure);
288             moveresize_startup(reconfigure);
289             keyboard_startup(reconfigure);
290             mouse_startup(reconfigure);
291             menu_frame_startup(reconfigure);
292             menu_startup(reconfigure);
293
294             if (!reconfigure) {
295                 guint32 xid;
296                 ObWindow *w;
297
298                 /* get all the existing windows */
299                 client_manage_all();
300                 focus_nothing();
301
302                 /* focus what was focused if a wm was already running */
303                 if (OBT_PROP_GET32(RootWindow(obt_display, ob_screen),
304                                    NET_ACTIVE_WINDOW, WINDOW, &xid) &&
305                     (w = window_find(xid)) && WINDOW_IS_CLIENT(w))
306                 {
307                     client_focus(WINDOW_AS_CLIENT(w));
308                 }
309             } else {
310                 GList *it;
311
312                 /* redecorate all existing windows */
313                 for (it = client_list; it; it = g_list_next(it)) {
314                     ObClient *c = it->data;
315
316                     /* the new config can change the window's decorations */
317                     client_setup_decor_and_functions(c, FALSE);
318                     /* redraw the frames */
319                     frame_adjust_area(c->frame, TRUE, TRUE, FALSE);
320                     /* the decor sizes may have changed, so the windows may
321                        end up in new positions */
322                     client_reconfigure(c, FALSE);
323                 }
324             }
325
326             reconfigure = FALSE;
327
328             state = OB_STATE_RUNNING;
329             obt_main_loop_run(ob_main_loop);
330             state = OB_STATE_EXITING;
331
332             if (!reconfigure) {
333                 dock_remove_all();
334                 client_unmanage_all();
335             }
336
337             menu_shutdown(reconfigure);
338             menu_frame_shutdown(reconfigure);
339             mouse_shutdown(reconfigure);
340             keyboard_shutdown(reconfigure);
341             moveresize_shutdown(reconfigure);
342             dock_shutdown(reconfigure);
343             client_shutdown(reconfigure);
344             ping_shutdown(reconfigure);
345             group_shutdown(reconfigure);
346             grab_shutdown(reconfigure);
347             screen_shutdown(reconfigure);
348             focus_cycle_popup_shutdown(reconfigure);
349             focus_cycle_indicator_shutdown(reconfigure);
350             focus_cycle_shutdown(reconfigure);
351             focus_shutdown(reconfigure);
352             window_shutdown(reconfigure);
353             sn_shutdown(reconfigure);
354             event_shutdown(reconfigure);
355             config_shutdown();
356             actions_shutdown(reconfigure);
357         } while (reconfigure);
358     }
359
360     XSync(obt_display, FALSE);
361
362     RrThemeFree(ob_rr_theme);
363     RrInstanceFree(ob_rr_inst);
364
365     session_shutdown(being_replaced);
366
367     obt_display_close(obt_display);
368
369     if (restart) {
370         if (restart_path != NULL) {
371             gint argcp;
372             gchar **argvp;
373             GError *err = NULL;
374
375             /* run other window manager */
376             if (g_shell_parse_argv(restart_path, &argcp, &argvp, &err)) {
377                 execvp(argvp[0], argvp);
378                 g_strfreev(argvp);
379             } else {
380                 g_message(
381                     _("Restart failed to execute new executable '%s': %s"),
382                     restart_path, err->message);
383                 g_error_free(err);
384             }
385         }
386
387         /* we remove the session arguments from argv, so put them back,
388            also don't restore the session on restart */
389         if (ob_sm_save_file != NULL || ob_sm_id != NULL) {
390             gchar **nargv;
391             gint i, l;
392
393             l = argc + 1 +
394                 (ob_sm_save_file != NULL ? 2 : 0) +
395                 (ob_sm_id != NULL ? 2 : 0);
396             nargv = g_new0(gchar*, l+1);
397             for (i = 0; i < argc; ++i)
398                 nargv[i] = argv[i];
399
400             if (ob_sm_save_file != NULL) {
401                 nargv[i++] = g_strdup("--sm-save-file");
402                 nargv[i++] = ob_sm_save_file;
403             }
404             if (ob_sm_id != NULL) {
405                 nargv[i++] = g_strdup("--sm-client-id");
406                 nargv[i++] = ob_sm_id;
407             }
408             nargv[i++] = g_strdup("--sm-no-load");
409             g_assert(i == l);
410             argv = nargv;
411         }
412
413         /* re-run me */
414         execvp(argv[0], argv); /* try how we were run */
415         execlp(argv[0], program_name, (gchar*)NULL); /* last resort */
416     }
417
418     /* free stuff passed in from the command line or environment */
419     g_free(ob_sm_save_file);
420     g_free(ob_sm_id);
421     g_free(program_name);
422
423     return exitcode;
424 }
425
426 static void signal_handler(gint signal, gpointer data)
427 {
428     switch (signal) {
429     case SIGUSR1:
430         ob_debug("Caught signal %d. Restarting.\n", signal);
431         ob_restart();
432         break;
433     case SIGUSR2:
434         ob_debug("Caught signal %d. Reconfiguring.\n", signal);
435         ob_reconfigure();
436         break;
437     case SIGCHLD:
438         /* reap children */
439         while (waitpid(-1, NULL, WNOHANG) > 0);
440         break;
441     default:
442         ob_debug("Caught signal %d. Exiting.\n", signal);
443         /* TERM and INT return a 0 code */
444         ob_exit(!(signal == SIGTERM || signal == SIGINT));
445     }
446 }
447
448 static void print_version()
449 {
450     g_print("Openbox %s\n", PACKAGE_VERSION);
451     g_print(_("Copyright (c)"));
452     g_print(" 2008        Mikael Magnusson\n");
453     g_print(_("Copyright (c)"));
454     g_print(" 2003-2006   Dana Jansens\n\n");
455     g_print("This program comes with ABSOLUTELY NO WARRANTY.\n");
456     g_print("This is free software, and you are welcome to redistribute it\n");
457     g_print("under certain conditions. See the file COPYING for details.\n\n");
458 }
459
460 static void print_help()
461 {
462     g_print(_("Syntax: openbox [options]\n"));
463     g_print(_("\nOptions:\n"));
464     g_print(_("  --help              Display this help and exit\n"));
465     g_print(_("  --version           Display the version and exit\n"));
466     g_print(_("  --replace           Replace the currently running window manager\n"));
467     g_print(_("  --sm-disable        Disable connection to the session manager\n"));
468     g_print(_("\nPassing messages to a running Openbox instance:\n"));
469     g_print(_("  --reconfigure       Reload Openbox's configuration\n"));
470     g_print(_("  --restart           Restart Openbox\n"));
471     g_print(_("  --exit              Exit Openbox\n"));
472     g_print(_("\nDebugging options:\n"));
473     g_print(_("  --sync              Run in synchronous mode\n"));
474     g_print(_("  --debug             Display debugging output\n"));
475     g_print(_("  --debug-focus       Display debugging output for focus handling\n"));
476     g_print(_("  --debug-xinerama    Split the display into fake xinerama screens\n"));
477     g_print(_("\nPlease report bugs at %s\n"), PACKAGE_BUGREPORT);
478 }
479
480 static void remove_args(gint *argc, gchar **argv, gint index, gint num)
481 {
482     gint i;
483
484     for (i = index; i < *argc - num; ++i)
485         argv[i] = argv[i+num];
486     for (; i < *argc; ++i)
487         argv[i] = NULL;
488     *argc -= num;
489 }
490
491 static void parse_env()
492 {
493     /* unset this so we don't pass it on unknowingly */
494     gchar *s = g_strdup("DESKTOP_STARTUP_ID");
495     putenv(s);
496     g_free(s);
497 }
498
499 static void parse_args(gint *argc, gchar **argv)
500 {
501     gint i;
502
503     for (i = 1; i < *argc; ++i) {
504         if (!strcmp(argv[i], "--version")) {
505             print_version();
506             exit(0);
507         }
508         else if (!strcmp(argv[i], "--help")) {
509             print_help();
510             exit(0);
511         }
512         else if (!strcmp(argv[i], "--g-fatal-warnings")) {
513             g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL);
514         }
515         else if (!strcmp(argv[i], "--replace")) {
516             ob_replace_wm = TRUE;
517             remove_args(argc, argv, i, 1);
518             --i; /* this arg was removed so go back */
519         }
520         else if (!strcmp(argv[i], "--sync")) {
521             xsync = TRUE;
522         }
523         else if (!strcmp(argv[i], "--debug")) {
524             ob_debug_show_output(TRUE);
525             ob_debug_enable(OB_DEBUG_SM, TRUE);
526             ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
527         }
528         else if (!strcmp(argv[i], "--debug-focus")) {
529             ob_debug_show_output(TRUE);
530             ob_debug_enable(OB_DEBUG_SM, TRUE);
531             ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
532             ob_debug_enable(OB_DEBUG_FOCUS, TRUE);
533         }
534         else if (!strcmp(argv[i], "--debug-xinerama")) {
535             ob_debug_xinerama = TRUE;
536         }
537         else if (!strcmp(argv[i], "--reconfigure")) {
538             remote_control = 1;
539         }
540         else if (!strcmp(argv[i], "--restart")) {
541             remote_control = 2;
542         }
543         else if (!strcmp(argv[i], "--exit")) {
544             remote_control = 3;
545         }
546         else if (!strcmp(argv[i], "--sm-save-file")) {
547             if (i == *argc - 1) /* no args left */
548                 /* not translated cuz it's sekret */
549                 g_printerr("--sm-save-file requires an argument\n");
550             else {
551                 ob_sm_save_file = g_strdup(argv[i+1]);
552                 remove_args(argc, argv, i, 2);
553                 --i; /* this arg was removed so go back */
554                 ob_debug_type(OB_DEBUG_SM, "--sm-save-file %s\n",
555                               ob_sm_save_file);
556             }
557         }
558         else if (!strcmp(argv[i], "--sm-client-id")) {
559             if (i == *argc - 1) /* no args left */
560                 /* not translated cuz it's sekret */
561                 g_printerr("--sm-client-id requires an argument\n");
562             else {
563                 ob_sm_id = g_strdup(argv[i+1]);
564                 remove_args(argc, argv, i, 2);
565                 --i; /* this arg was removed so go back */
566                 ob_debug_type(OB_DEBUG_SM, "--sm-client-id %s\n", ob_sm_id);
567             }
568         }
569         else if (!strcmp(argv[i], "--sm-disable")) {
570             ob_sm_use = FALSE;
571         }
572         else if (!strcmp(argv[i], "--sm-no-load")) {
573             ob_sm_restore = FALSE;
574             remove_args(argc, argv, i, 1);
575             --i; /* this arg was removed so go back */
576         }
577         else {
578             /* this is a memleak.. oh well.. heh */
579             gchar *err = g_strdup_printf
580                 (_("Invalid command line argument '%s'\n"), argv[i]);
581             ob_exit_with_error(err);
582         }
583     }
584 }
585
586 static Cursor load_cursor(const gchar *name, guint fontval)
587 {
588     Cursor c = None;
589
590 #if USE_XCURSOR
591     c = XcursorLibraryLoadCursor(obt_display, name);
592 #endif
593     if (c == None)
594         c = XCreateFontCursor(obt_display, fontval);
595     return c;
596 }
597
598 void ob_exit_with_error(const gchar *msg)
599 {
600     g_message(msg);
601     session_shutdown(TRUE);
602     exit(EXIT_FAILURE);
603 }
604
605 void ob_restart_other(const gchar *path)
606 {
607     restart_path = g_strdup(path);
608     ob_restart();
609 }
610
611 void ob_restart()
612 {
613     restart = TRUE;
614     ob_exit(0);
615 }
616
617 void ob_reconfigure()
618 {
619     reconfigure = TRUE;
620     ob_exit(0);
621 }
622
623 void ob_exit(gint code)
624 {
625     exitcode = code;
626     obt_main_loop_exit(ob_main_loop);
627 }
628
629 void ob_exit_replace()
630 {
631     exitcode = 0;
632     being_replaced = TRUE;
633     obt_main_loop_exit(ob_main_loop);
634 }
635
636 Cursor ob_cursor(ObCursor cursor)
637 {
638     g_assert(cursor < OB_NUM_CURSORS);
639     return cursors[cursor];
640 }
641
642 KeyCode ob_keycode(ObKey key)
643 {
644     g_assert(key < OB_NUM_KEYS);
645     return keys[key];
646 }
647
648 ObState ob_state()
649 {
650     return state;
651 }