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