move the xdg path stuff into obt/paths.[ch], and make render and openbox use it
[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 "mainloop.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     /* initialize the locale */
120     if (!setlocale(LC_ALL, ""))
121         g_message("Couldn't set locale from environment.");
122     bindtextdomain(PACKAGE_NAME, LOCALEDIR);
123     bind_textdomain_codeset(PACKAGE_NAME, "UTF-8");
124     textdomain(PACKAGE_NAME);
125
126     if (chdir(g_get_home_dir()) == -1)
127         g_message(_("Unable to change to home directory '%s': %s"),
128                   g_get_home_dir(), g_strerror(errno));
129
130     /* parse the command line args, which can change the argv[0] */
131     parse_args(&argc, argv);
132     /* parse the environment variables */
133     parse_env();
134
135     program_name = g_path_get_basename(argv[0]);
136     g_set_prgname(program_name);
137
138     if (!remote_control)
139         session_startup(argc, argv);
140
141     if (!obt_display_open(NULL))
142         ob_exit_with_error(_("Failed to open the display from the DISPLAY environment variable."));
143
144     if (remote_control) {
145         /* Send client message telling the OB process to:
146          * remote_control = 1 -> reconfigure
147          * remote_control = 2 -> restart */
148         OBT_PROP_MSG(ob_screen, RootWindow(obt_display, ob_screen),
149                      OB_CONTROL, remote_control, 0, 0, 0, 0);
150         obt_display_close(obt_display);
151         exit(EXIT_SUCCESS);
152     }
153
154     ob_main_loop = obt_main_loop_new(obt_display);
155
156     /* set up signal handler */
157     obt_main_loop_signal_add(ob_main_loop, SIGUSR1, signal_handler, NULL,NULL);
158     obt_main_loop_signal_add(ob_main_loop, SIGUSR2, signal_handler, NULL,NULL);
159     obt_main_loop_signal_add(ob_main_loop, SIGTERM, signal_handler, NULL,NULL);
160     obt_main_loop_signal_add(ob_main_loop, SIGINT, signal_handler,  NULL,NULL);
161     obt_main_loop_signal_add(ob_main_loop, SIGHUP, signal_handler,  NULL,NULL);
162     obt_main_loop_signal_add(ob_main_loop, SIGPIPE, signal_handler, NULL,NULL);
163     obt_main_loop_signal_add(ob_main_loop, SIGCHLD, signal_handler, NULL,NULL);
164
165     ob_screen = DefaultScreen(obt_display);
166
167     ob_rr_inst = RrInstanceNew(obt_display, ob_screen);
168     if (ob_rr_inst == NULL)
169         ob_exit_with_error(_("Failed to initialize the obrender library."));
170
171     XSynchronize(obt_display, xsync);
172
173     /* check for locale support */
174     if (!XSupportsLocale())
175         g_message(_("X server does not support locale."));
176     if (!XSetLocaleModifiers(""))
177         g_message(_("Cannot set locale modifiers for the X server."));
178
179     /* set the DISPLAY environment variable for any lauched children, to the
180        display we're using, so they open in the right place. */
181     putenv(g_strdup_printf("DISPLAY=%s", DisplayString(obt_display)));
182
183     /* create available cursors */
184     cursors[OB_CURSOR_NONE] = None;
185     cursors[OB_CURSOR_POINTER] = load_cursor("left_ptr", XC_left_ptr);
186     cursors[OB_CURSOR_BUSYPOINTER] = load_cursor("left_ptr_watch",XC_left_ptr);
187     cursors[OB_CURSOR_BUSY] = load_cursor("watch", XC_watch);
188     cursors[OB_CURSOR_MOVE] = load_cursor("fleur", XC_fleur);
189     cursors[OB_CURSOR_NORTH] = load_cursor("top_side", XC_top_side);
190     cursors[OB_CURSOR_NORTHEAST] = load_cursor("top_right_corner",
191                                                XC_top_right_corner);
192     cursors[OB_CURSOR_EAST] = load_cursor("right_side", XC_right_side);
193     cursors[OB_CURSOR_SOUTHEAST] = load_cursor("bottom_right_corner",
194                                                XC_bottom_right_corner);
195     cursors[OB_CURSOR_SOUTH] = load_cursor("bottom_side", XC_bottom_side);
196     cursors[OB_CURSOR_SOUTHWEST] = load_cursor("bottom_left_corner",
197                                                XC_bottom_left_corner);
198     cursors[OB_CURSOR_WEST] = load_cursor("left_side", XC_left_side);
199     cursors[OB_CURSOR_NORTHWEST] = load_cursor("top_left_corner",
200                                                XC_top_left_corner);
201
202     if (screen_annex()) { /* it will be ours! */
203         do {
204             if (reconfigure) obt_keyboard_reload();
205
206             /* get the keycodes for keys we use */
207             keys[OB_KEY_RETURN] = obt_keyboard_keysym_to_keycode(XK_Return);
208             keys[OB_KEY_ESCAPE] = obt_keyboard_keysym_to_keycode(XK_Escape);
209             keys[OB_KEY_LEFT] = obt_keyboard_keysym_to_keycode(XK_Left);
210             keys[OB_KEY_RIGHT] = obt_keyboard_keysym_to_keycode(XK_Right);
211             keys[OB_KEY_UP] = obt_keyboard_keysym_to_keycode(XK_Up);
212             keys[OB_KEY_DOWN] = obt_keyboard_keysym_to_keycode(XK_Down);
213
214             {
215                 ObtParseInst *i;
216
217                 /* startup the parsing so everything can register sections
218                    of the rc */
219                 i = obt_parse_instance_new();
220
221                 /* register all the available actions */
222                 actions_startup(reconfigure);
223                 /* start up config which sets up with the parser */
224                 config_startup(i);
225
226                 /* parse/load user options */
227                 if (obt_parse_load_config_file(i, "openbox", "rc.xml",
228                                                "openbox_config"))
229                 {
230                     obt_parse_tree_from_root(i);
231                     obt_parse_close(i);
232                 } else
233                     g_message(_("Unable to find a valid config file, using some simple defaults"));
234
235 /*
236                 if (config_type != NULL)
237                     PROP_SETS(RootWindow(obt_display, ob_screen),
238                               ob_config, config_type);
239 */
240
241                 /* we're done with parsing now, kill it */
242                 obt_parse_instance_unref(i);
243             }
244
245             /* load the theme specified in the rc file */
246             {
247                 RrTheme *theme;
248                 if ((theme = RrThemeNew(ob_rr_inst, config_theme, TRUE,
249                                         config_font_activewindow,
250                                         config_font_inactivewindow,
251                                         config_font_menutitle,
252                                         config_font_menuitem,
253                                         config_font_osd)))
254                 {
255                     RrThemeFree(ob_rr_theme);
256                     ob_rr_theme = theme;
257                 }
258                 if (ob_rr_theme == NULL)
259                     ob_exit_with_error(_("Unable to load a theme."));
260
261                 OBT_PROP_SETS(RootWindow(obt_display, ob_screen),
262                               OB_THEME, utf8, ob_rr_theme->name);
263             }
264
265             if (reconfigure) {
266                 GList *it;
267
268                 /* update all existing windows for the new theme */
269                 for (it = client_list; it; it = g_list_next(it)) {
270                     ObClient *c = it->data;
271                     frame_adjust_theme(c->frame);
272                 }
273             }
274             event_startup(reconfigure);
275             /* focus_backup is used for stacking, so this needs to come before
276                anything that calls stacking_add */
277             sn_startup(reconfigure);
278             window_startup(reconfigure);
279             focus_startup(reconfigure);
280             focus_cycle_startup(reconfigure);
281             focus_cycle_indicator_startup(reconfigure);
282             focus_cycle_popup_startup(reconfigure);
283             screen_startup(reconfigure);
284             grab_startup(reconfigure);
285             group_startup(reconfigure);
286             ping_startup(reconfigure);
287             client_startup(reconfigure);
288             dock_startup(reconfigure);
289             moveresize_startup(reconfigure);
290             keyboard_startup(reconfigure);
291             mouse_startup(reconfigure);
292             menu_frame_startup(reconfigure);
293             menu_startup(reconfigure);
294
295             if (!reconfigure) {
296                 guint32 xid;
297                 ObWindow *w;
298
299                 /* get all the existing windows */
300                 client_manage_all();
301                 focus_nothing();
302
303                 /* focus what was focused if a wm was already running */
304                 if (OBT_PROP_GET32(RootWindow(obt_display, ob_screen),
305                                    NET_ACTIVE_WINDOW, WINDOW, &xid) &&
306                     (w = g_hash_table_lookup(window_map, &xid)) &&
307                     WINDOW_IS_CLIENT(w))
308                 {
309                     client_focus(WINDOW_AS_CLIENT(w));
310                 }
311             } else {
312                 GList *it;
313
314                 /* redecorate all existing windows */
315                 for (it = client_list; it; it = g_list_next(it)) {
316                     ObClient *c = it->data;
317
318                     /* the new config can change the window's decorations */
319                     client_setup_decor_and_functions(c, FALSE);
320                     /* redraw the frames */
321                     frame_adjust_area(c->frame, TRUE, TRUE, FALSE);
322                     /* the decor sizes may have changed, so the windows may
323                        end up in new positions */
324                     client_reconfigure(c, FALSE);
325                 }
326             }
327
328             reconfigure = FALSE;
329
330             state = OB_STATE_RUNNING;
331             obt_main_loop_run(ob_main_loop);
332             state = OB_STATE_EXITING;
333
334             if (!reconfigure) {
335                 dock_remove_all();
336                 client_unmanage_all();
337             }
338
339             menu_shutdown(reconfigure);
340             menu_frame_shutdown(reconfigure);
341             mouse_shutdown(reconfigure);
342             keyboard_shutdown(reconfigure);
343             moveresize_shutdown(reconfigure);
344             dock_shutdown(reconfigure);
345             client_shutdown(reconfigure);
346             ping_shutdown(reconfigure);
347             group_shutdown(reconfigure);
348             grab_shutdown(reconfigure);
349             screen_shutdown(reconfigure);
350             focus_cycle_popup_shutdown(reconfigure);
351             focus_cycle_indicator_shutdown(reconfigure);
352             focus_cycle_shutdown(reconfigure);
353             focus_shutdown(reconfigure);
354             window_shutdown(reconfigure);
355             sn_shutdown(reconfigure);
356             event_shutdown(reconfigure);
357             config_shutdown();
358             actions_shutdown(reconfigure);
359         } while (reconfigure);
360     }
361
362     XSync(obt_display, FALSE);
363
364     RrThemeFree(ob_rr_theme);
365     RrInstanceFree(ob_rr_inst);
366
367     session_shutdown(being_replaced);
368
369     obt_display_close(obt_display);
370
371     if (restart) {
372         if (restart_path != NULL) {
373             gint argcp;
374             gchar **argvp;
375             GError *err = NULL;
376
377             /* run other window manager */
378             if (g_shell_parse_argv(restart_path, &argcp, &argvp, &err)) {
379                 execvp(argvp[0], argvp);
380                 g_strfreev(argvp);
381             } else {
382                 g_message(
383                     _("Restart failed to execute new executable '%s': %s"),
384                     restart_path, err->message);
385                 g_error_free(err);
386             }
387         }
388
389         /* we remove the session arguments from argv, so put them back,
390            also don't restore the session on restart */
391         if (ob_sm_save_file != NULL || ob_sm_id != NULL) {
392             gchar **nargv;
393             gint i, l;
394
395             l = argc + 1 +
396                 (ob_sm_save_file != NULL ? 2 : 0) +
397                 (ob_sm_id != NULL ? 2 : 0);
398             nargv = g_new0(gchar*, l+1);
399             for (i = 0; i < argc; ++i)
400                 nargv[i] = argv[i];
401
402             if (ob_sm_save_file != NULL) {
403                 nargv[i++] = g_strdup("--sm-save-file");
404                 nargv[i++] = ob_sm_save_file;
405             }
406             if (ob_sm_id != NULL) {
407                 nargv[i++] = g_strdup("--sm-client-id");
408                 nargv[i++] = ob_sm_id;
409             }
410             nargv[i++] = g_strdup("--sm-no-load");
411             g_assert(i == l);
412             argv = nargv;
413         }
414
415         /* re-run me */
416         execvp(argv[0], argv); /* try how we were run */
417         execlp(argv[0], program_name, (gchar*)NULL); /* last resort */
418     }
419
420     /* free stuff passed in from the command line or environment */
421     g_free(ob_sm_save_file);
422     g_free(ob_sm_id);
423     g_free(program_name);
424
425     return exitcode;
426 }
427
428 static void signal_handler(gint signal, gpointer data)
429 {
430     switch (signal) {
431     case SIGUSR1:
432         ob_debug("Caught signal %d. Restarting.\n", signal);
433         ob_restart();
434         break;
435     case SIGUSR2:
436         ob_debug("Caught signal %d. Reconfiguring.\n", signal);
437         ob_reconfigure();
438         break;
439     case SIGCHLD:
440         /* reap children */
441         while (waitpid(-1, NULL, WNOHANG) > 0);
442         break;
443     default:
444         ob_debug("Caught signal %d. Exiting.\n", signal);
445         /* TERM and INT return a 0 code */
446         ob_exit(!(signal == SIGTERM || signal == SIGINT));
447     }
448 }
449
450 static void print_version()
451 {
452     g_print("Openbox %s\n", PACKAGE_VERSION);
453     g_print(_("Copyright (c)"));
454     g_print(" 2008        Mikael Magnusson\n");
455     g_print(_("Copyright (c)"));
456     g_print(" 2003-2006   Dana Jansens\n\n");
457     g_print("This program comes with ABSOLUTELY NO WARRANTY.\n");
458     g_print("This is free software, and you are welcome to redistribute it\n");
459     g_print("under certain conditions. See the file COPYING for details.\n\n");
460 }
461
462 static void print_help()
463 {
464     g_print(_("Syntax: openbox [options]\n"));
465     g_print(_("\nOptions:\n"));
466     g_print(_("  --help              Display this help and exit\n"));
467     g_print(_("  --version           Display the version and exit\n"));
468     g_print(_("  --replace           Replace the currently running window manager\n"));
469     g_print(_("  --sm-disable        Disable connection to the session manager\n"));
470     g_print(_("\nPassing messages to a running Openbox instance:\n"));
471     g_print(_("  --reconfigure       Reload Openbox's configuration\n"));
472     g_print(_("  --restart           Restart Openbox\n"));
473     g_print(_("  --exit              Exit Openbox\n"));
474     g_print(_("\nDebugging options:\n"));
475     g_print(_("  --sync              Run in synchronous mode\n"));
476     g_print(_("  --debug             Display debugging output\n"));
477     g_print(_("  --debug-focus       Display debugging output for focus handling\n"));
478     g_print(_("  --debug-xinerama    Split the display into fake xinerama screens\n"));
479     g_print(_("\nPlease report bugs at %s\n"), PACKAGE_BUGREPORT);
480 }
481
482 static void remove_args(gint *argc, gchar **argv, gint index, gint num)
483 {
484     gint i;
485
486     for (i = index; i < *argc - num; ++i)
487         argv[i] = argv[i+num];
488     for (; i < *argc; ++i)
489         argv[i] = NULL;
490     *argc -= num;
491 }
492
493 static void parse_env()
494 {
495     /* unset this so we don't pass it on unknowingly */
496     gchar *s = g_strdup("DESKTOP_STARTUP_ID");
497     putenv(s);
498     g_free(s);
499 }
500
501 static void parse_args(gint *argc, gchar **argv)
502 {
503     gint i;
504
505     for (i = 1; i < *argc; ++i) {
506         if (!strcmp(argv[i], "--version")) {
507             print_version();
508             exit(0);
509         }
510         else if (!strcmp(argv[i], "--help")) {
511             print_help();
512             exit(0);
513         }
514         else if (!strcmp(argv[i], "--g-fatal-warnings")) {
515             g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL);
516         }
517         else if (!strcmp(argv[i], "--replace")) {
518             ob_replace_wm = TRUE;
519             remove_args(argc, argv, i, 1);
520             --i; /* this arg was removed so go back */
521         }
522         else if (!strcmp(argv[i], "--sync")) {
523             xsync = TRUE;
524         }
525         else if (!strcmp(argv[i], "--debug")) {
526             ob_debug_show_output(TRUE);
527             ob_debug_enable(OB_DEBUG_SM, TRUE);
528             ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
529         }
530         else if (!strcmp(argv[i], "--debug-focus")) {
531             ob_debug_show_output(TRUE);
532             ob_debug_enable(OB_DEBUG_SM, TRUE);
533             ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
534             ob_debug_enable(OB_DEBUG_FOCUS, 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\n",
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\n", 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 }