make an obt_root() macro
[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, obt_root(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(obt_root(ob_screen), ob_config, config_type);
237 */
238
239                 /* we're done with parsing now, kill it */
240                 obt_parse_instance_unref(i);
241             }
242
243             /* load the theme specified in the rc file */
244             {
245                 RrTheme *theme;
246                 if ((theme = RrThemeNew(ob_rr_inst, config_theme, TRUE,
247                                         config_font_activewindow,
248                                         config_font_inactivewindow,
249                                         config_font_menutitle,
250                                         config_font_menuitem,
251                                         config_font_osd)))
252                 {
253                     RrThemeFree(ob_rr_theme);
254                     ob_rr_theme = theme;
255                 }
256                 if (ob_rr_theme == NULL)
257                     ob_exit_with_error(_("Unable to load a theme."));
258
259                 OBT_PROP_SETS(obt_root(ob_screen),
260                               OB_THEME, utf8, ob_rr_theme->name);
261             }
262
263             if (reconfigure) {
264                 GList *it;
265
266                 /* update all existing windows for the new theme */
267                 for (it = client_list; it; it = g_list_next(it)) {
268                     ObClient *c = it->data;
269                     frame_adjust_theme(c->frame);
270                 }
271             }
272             event_startup(reconfigure);
273             /* focus_backup is used for stacking, so this needs to come before
274                anything that calls stacking_add */
275             sn_startup(reconfigure);
276             window_startup(reconfigure);
277             focus_startup(reconfigure);
278             focus_cycle_startup(reconfigure);
279             focus_cycle_indicator_startup(reconfigure);
280             focus_cycle_popup_startup(reconfigure);
281             screen_startup(reconfigure);
282             grab_startup(reconfigure);
283             group_startup(reconfigure);
284             ping_startup(reconfigure);
285             client_startup(reconfigure);
286             dock_startup(reconfigure);
287             moveresize_startup(reconfigure);
288             keyboard_startup(reconfigure);
289             mouse_startup(reconfigure);
290             menu_frame_startup(reconfigure);
291             menu_startup(reconfigure);
292
293             if (!reconfigure) {
294                 guint32 xid;
295                 ObWindow *w;
296
297                 /* get all the existing windows */
298                 client_manage_all();
299                 focus_nothing();
300
301                 /* focus what was focused if a wm was already running */
302                 if (OBT_PROP_GET32(obt_root(ob_screen),
303                                    NET_ACTIVE_WINDOW, WINDOW, &xid) &&
304                     (w = window_find(xid)) && WINDOW_IS_CLIENT(w))
305                 {
306                     client_focus(WINDOW_AS_CLIENT(w));
307                 }
308             } else {
309                 GList *it;
310
311                 /* redecorate all existing windows */
312                 for (it = client_list; it; it = g_list_next(it)) {
313                     ObClient *c = it->data;
314
315                     /* the new config can change the window's decorations */
316                     client_setup_decor_and_functions(c, FALSE);
317                     /* redraw the frames */
318                     frame_adjust_area(c->frame, TRUE, TRUE, FALSE);
319                     /* the decor sizes may have changed, so the windows may
320                        end up in new positions */
321                     client_reconfigure(c, FALSE);
322                 }
323             }
324
325             reconfigure = FALSE;
326
327             state = OB_STATE_RUNNING;
328             obt_main_loop_run(ob_main_loop);
329             state = OB_STATE_EXITING;
330
331             if (!reconfigure) {
332                 dock_remove_all();
333                 client_unmanage_all();
334             }
335
336             menu_shutdown(reconfigure);
337             menu_frame_shutdown(reconfigure);
338             mouse_shutdown(reconfigure);
339             keyboard_shutdown(reconfigure);
340             moveresize_shutdown(reconfigure);
341             dock_shutdown(reconfigure);
342             client_shutdown(reconfigure);
343             ping_shutdown(reconfigure);
344             group_shutdown(reconfigure);
345             grab_shutdown(reconfigure);
346             screen_shutdown(reconfigure);
347             focus_cycle_popup_shutdown(reconfigure);
348             focus_cycle_indicator_shutdown(reconfigure);
349             focus_cycle_shutdown(reconfigure);
350             focus_shutdown(reconfigure);
351             window_shutdown(reconfigure);
352             sn_shutdown(reconfigure);
353             event_shutdown(reconfigure);
354             config_shutdown();
355             actions_shutdown(reconfigure);
356         } while (reconfigure);
357     }
358
359     XSync(obt_display, FALSE);
360
361     RrThemeFree(ob_rr_theme);
362     RrInstanceFree(ob_rr_inst);
363
364     session_shutdown(being_replaced);
365
366     obt_display_close(obt_display);
367
368     if (restart) {
369         if (restart_path != NULL) {
370             gint argcp;
371             gchar **argvp;
372             GError *err = NULL;
373
374             /* run other window manager */
375             if (g_shell_parse_argv(restart_path, &argcp, &argvp, &err)) {
376                 execvp(argvp[0], argvp);
377                 g_strfreev(argvp);
378             } else {
379                 g_message(
380                     _("Restart failed to execute new executable '%s': %s"),
381                     restart_path, err->message);
382                 g_error_free(err);
383             }
384         }
385
386         /* we remove the session arguments from argv, so put them back,
387            also don't restore the session on restart */
388         if (ob_sm_save_file != NULL || ob_sm_id != NULL) {
389             gchar **nargv;
390             gint i, l;
391
392             l = argc + 1 +
393                 (ob_sm_save_file != NULL ? 2 : 0) +
394                 (ob_sm_id != NULL ? 2 : 0);
395             nargv = g_new0(gchar*, l+1);
396             for (i = 0; i < argc; ++i)
397                 nargv[i] = argv[i];
398
399             if (ob_sm_save_file != NULL) {
400                 nargv[i++] = g_strdup("--sm-save-file");
401                 nargv[i++] = ob_sm_save_file;
402             }
403             if (ob_sm_id != NULL) {
404                 nargv[i++] = g_strdup("--sm-client-id");
405                 nargv[i++] = ob_sm_id;
406             }
407             nargv[i++] = g_strdup("--sm-no-load");
408             g_assert(i == l);
409             argv = nargv;
410         }
411
412         /* re-run me */
413         execvp(argv[0], argv); /* try how we were run */
414         execlp(argv[0], program_name, (gchar*)NULL); /* last resort */
415     }
416
417     /* free stuff passed in from the command line or environment */
418     g_free(ob_sm_save_file);
419     g_free(ob_sm_id);
420     g_free(program_name);
421
422     return exitcode;
423 }
424
425 static void signal_handler(gint signal, gpointer data)
426 {
427     switch (signal) {
428     case SIGUSR1:
429         ob_debug("Caught signal %d. Restarting.\n", signal);
430         ob_restart();
431         break;
432     case SIGUSR2:
433         ob_debug("Caught signal %d. Reconfiguring.\n", signal);
434         ob_reconfigure();
435         break;
436     case SIGCHLD:
437         /* reap children */
438         while (waitpid(-1, NULL, WNOHANG) > 0);
439         break;
440     default:
441         ob_debug("Caught signal %d. Exiting.\n", signal);
442         /* TERM and INT return a 0 code */
443         ob_exit(!(signal == SIGTERM || signal == SIGINT));
444     }
445 }
446
447 static void print_version()
448 {
449     g_print("Openbox %s\n", PACKAGE_VERSION);
450     g_print(_("Copyright (c)"));
451     g_print(" 2008        Mikael Magnusson\n");
452     g_print(_("Copyright (c)"));
453     g_print(" 2003-2006   Dana Jansens\n\n");
454     g_print("This program comes with ABSOLUTELY NO WARRANTY.\n");
455     g_print("This is free software, and you are welcome to redistribute it\n");
456     g_print("under certain conditions. See the file COPYING for details.\n\n");
457 }
458
459 static void print_help()
460 {
461     g_print(_("Syntax: openbox [options]\n"));
462     g_print(_("\nOptions:\n"));
463     g_print(_("  --help              Display this help and exit\n"));
464     g_print(_("  --version           Display the version and exit\n"));
465     g_print(_("  --replace           Replace the currently running window manager\n"));
466     g_print(_("  --sm-disable        Disable connection to the session manager\n"));
467     g_print(_("\nPassing messages to a running Openbox instance:\n"));
468     g_print(_("  --reconfigure       Reload Openbox's configuration\n"));
469     g_print(_("  --restart           Restart Openbox\n"));
470     g_print(_("  --exit              Exit Openbox\n"));
471     g_print(_("\nDebugging options:\n"));
472     g_print(_("  --sync              Run in synchronous mode\n"));
473     g_print(_("  --debug             Display debugging output\n"));
474     g_print(_("  --debug-focus       Display debugging output for focus handling\n"));
475     g_print(_("  --debug-xinerama    Split the display into fake xinerama screens\n"));
476     g_print(_("\nPlease report bugs at %s\n"), PACKAGE_BUGREPORT);
477 }
478
479 static void remove_args(gint *argc, gchar **argv, gint index, gint num)
480 {
481     gint i;
482
483     for (i = index; i < *argc - num; ++i)
484         argv[i] = argv[i+num];
485     for (; i < *argc; ++i)
486         argv[i] = NULL;
487     *argc -= num;
488 }
489
490 static void parse_env()
491 {
492     /* unset this so we don't pass it on unknowingly */
493     gchar *s = g_strdup("DESKTOP_STARTUP_ID");
494     putenv(s);
495     g_free(s);
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_show_output(TRUE);
524             ob_debug_enable(OB_DEBUG_SM, TRUE);
525             ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
526         }
527         else if (!strcmp(argv[i], "--debug-focus")) {
528             ob_debug_show_output(TRUE);
529             ob_debug_enable(OB_DEBUG_SM, TRUE);
530             ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
531             ob_debug_enable(OB_DEBUG_FOCUS, TRUE);
532         }
533         else if (!strcmp(argv[i], "--debug-xinerama")) {
534             ob_debug_xinerama = TRUE;
535         }
536         else if (!strcmp(argv[i], "--reconfigure")) {
537             remote_control = 1;
538         }
539         else if (!strcmp(argv[i], "--restart")) {
540             remote_control = 2;
541         }
542         else if (!strcmp(argv[i], "--exit")) {
543             remote_control = 3;
544         }
545         else if (!strcmp(argv[i], "--sm-save-file")) {
546             if (i == *argc - 1) /* no args left */
547                 /* not translated cuz it's sekret */
548                 g_printerr("--sm-save-file requires an argument\n");
549             else {
550                 ob_sm_save_file = g_strdup(argv[i+1]);
551                 remove_args(argc, argv, i, 2);
552                 --i; /* this arg was removed so go back */
553                 ob_debug_type(OB_DEBUG_SM, "--sm-save-file %s\n",
554                               ob_sm_save_file);
555             }
556         }
557         else if (!strcmp(argv[i], "--sm-client-id")) {
558             if (i == *argc - 1) /* no args left */
559                 /* not translated cuz it's sekret */
560                 g_printerr("--sm-client-id requires an argument\n");
561             else {
562                 ob_sm_id = g_strdup(argv[i+1]);
563                 remove_args(argc, argv, i, 2);
564                 --i; /* this arg was removed so go back */
565                 ob_debug_type(OB_DEBUG_SM, "--sm-client-id %s\n", ob_sm_id);
566             }
567         }
568         else if (!strcmp(argv[i], "--sm-disable")) {
569             ob_sm_use = FALSE;
570         }
571         else if (!strcmp(argv[i], "--sm-no-load")) {
572             ob_sm_restore = FALSE;
573             remove_args(argc, argv, i, 1);
574             --i; /* this arg was removed so go back */
575         }
576         else {
577             /* this is a memleak.. oh well.. heh */
578             gchar *err = g_strdup_printf
579                 (_("Invalid command line argument '%s'\n"), argv[i]);
580             ob_exit_with_error(err);
581         }
582     }
583 }
584
585 static Cursor load_cursor(const gchar *name, guint fontval)
586 {
587     Cursor c = None;
588
589 #if USE_XCURSOR
590     c = XcursorLibraryLoadCursor(obt_display, name);
591 #endif
592     if (c == None)
593         c = XCreateFontCursor(obt_display, fontval);
594     return c;
595 }
596
597 void ob_exit_with_error(const gchar *msg)
598 {
599     g_message(msg);
600     session_shutdown(TRUE);
601     exit(EXIT_FAILURE);
602 }
603
604 void ob_restart_other(const gchar *path)
605 {
606     restart_path = g_strdup(path);
607     ob_restart();
608 }
609
610 void ob_restart()
611 {
612     restart = TRUE;
613     ob_exit(0);
614 }
615
616 void ob_reconfigure()
617 {
618     reconfigure = TRUE;
619     ob_exit(0);
620 }
621
622 void ob_exit(gint code)
623 {
624     exitcode = code;
625     obt_main_loop_exit(ob_main_loop);
626 }
627
628 void ob_exit_replace()
629 {
630     exitcode = 0;
631     being_replaced = TRUE;
632     obt_main_loop_exit(ob_main_loop);
633 }
634
635 Cursor ob_cursor(ObCursor cursor)
636 {
637     g_assert(cursor < OB_NUM_CURSORS);
638     return cursors[cursor];
639 }
640
641 KeyCode ob_keycode(ObKey key)
642 {
643     g_assert(key < OB_NUM_KEYS);
644     return keys[key];
645 }
646
647 ObState ob_state()
648 {
649     return state;
650 }