add .desktops for running Openbox, KDE/Openbox and GNOME/Openbox
[mikachu/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 "modkeys.h"
25 #include "event.h"
26 #include "menu.h"
27 #include "client.h"
28 #include "xerror.h"
29 #include "prop.h"
30 #include "screen.h"
31 #include "startupnotify.h"
32 #include "focus.h"
33 #include "moveresize.h"
34 #include "frame.h"
35 #include "keyboard.h"
36 #include "mouse.h"
37 #include "extensions.h"
38 #include "menuframe.h"
39 #include "grab.h"
40 #include "group.h"
41 #include "config.h"
42 #include "mainloop.h"
43 #include "gettext.h"
44 #include "parser/parse.h"
45 #include "render/render.h"
46 #include "render/theme.h"
47
48 #ifdef HAVE_FCNTL_H
49 #  include <fcntl.h>
50 #endif
51 #ifdef HAVE_SIGNAL_H
52 #  include <signal.h>
53 #endif
54 #ifdef HAVE_STDLIB_H
55 #  include <stdlib.h>
56 #endif
57 #ifdef HAVE_LOCALE_H
58 #  include <locale.h>
59 #endif
60 #ifdef HAVE_SYS_STAT_H
61 #  include <sys/stat.h>
62 #  include <sys/types.h>
63 #endif
64 #ifdef HAVE_SYS_WAIT_H
65 #  include <sys/types.h>
66 #  include <sys/wait.h>
67 #endif
68 #ifdef HAVE_UNISTD_H
69 #  include <unistd.h>
70 #endif
71 #include <errno.h>
72
73 #include <X11/cursorfont.h>
74 #if USE_XCURSOR
75 #include <X11/Xcursor/Xcursor.h>
76 #endif
77
78 RrInstance *ob_rr_inst;
79 RrTheme    *ob_rr_theme;
80 ObMainLoop *ob_main_loop;
81 Display    *ob_display;
82 gint        ob_screen;
83 gboolean    ob_replace_wm = FALSE;
84 gboolean    ob_sm_use = TRUE;
85 gchar      *ob_sm_id = NULL;
86 gchar      *ob_sm_save_file = NULL;
87
88 static ObState   state;
89 static gboolean  xsync = FALSE;
90 static gboolean  reconfigure = FALSE;
91 static gboolean  restart = FALSE;
92 static gchar    *restart_path = NULL;
93 static Cursor    cursors[OB_NUM_CURSORS];
94 static KeyCode   keys[OB_NUM_KEYS];
95 static gint      exitcode = 0;
96 static guint     remote_control = 0;
97 static gboolean  being_replaced = FALSE;
98 static gchar    *config_type = NULL;
99 static pid_t     reconfigure_notify = 0;
100
101 static void signal_handler(gint signal, gpointer data);
102 static void parse_env(char **argv0);
103 static void remove_args(gint *argc, gchar **argv, gint index, gint num);
104 static void parse_args(gint *argc, gchar **argv);
105 static Cursor load_cursor(const gchar *name, guint fontval);
106
107 gint main(gint argc, gchar **argv)
108 {
109     gchar *program_name;
110
111     state = OB_STATE_STARTING;
112
113     /* initialize the locale */
114     if (!setlocale(LC_ALL, ""))
115         g_message("Couldn't set locale from environment.");
116     bindtextdomain(PACKAGE_NAME, LOCALEDIR);
117     bind_textdomain_codeset(PACKAGE_NAME, "UTF-8");
118     textdomain(PACKAGE_NAME);
119
120     if (chdir(g_get_home_dir()) == -1)
121         g_message(_("Unable to change to home directory '%s': %s"),
122                   g_get_home_dir(), g_strerror(errno));
123      
124     /* parse the environment first, it can change the argv[0] */
125     parse_env(&argv[0]);
126
127     program_name = g_path_get_basename(argv[0]);
128     g_set_prgname(program_name);
129
130     /* parse the command line args */
131     parse_args(&argc, argv);
132
133     if (!remote_control) {
134         parse_paths_startup();
135
136         session_startup(argc, argv);
137     }
138
139
140     ob_display = XOpenDisplay(NULL);
141     if (ob_display == NULL)
142         ob_exit_with_error("Failed to open the display.");
143     if (fcntl(ConnectionNumber(ob_display), F_SETFD, 1) == -1)
144         ob_exit_with_error("Failed to set display as close-on-exec.");
145
146     if (remote_control) {
147         prop_startup();
148
149         /* Send client message telling the OB process to:
150          * remote_control = 1 -> reconfigure 
151          * remote_control = 2 -> restart */
152         PROP_MSG(RootWindow(ob_display, ob_screen),
153                  openbox_control, remote_control, 0, 0, 0);
154         XCloseDisplay(ob_display);
155         exit(EXIT_SUCCESS);
156     }
157
158     ob_main_loop = ob_main_loop_new(ob_display);
159
160     /* set up signal handler */
161     ob_main_loop_signal_add(ob_main_loop, SIGUSR1, signal_handler, NULL, NULL);
162     ob_main_loop_signal_add(ob_main_loop, SIGUSR2, signal_handler, NULL, NULL);
163     ob_main_loop_signal_add(ob_main_loop, SIGTERM, signal_handler, NULL, NULL);
164     ob_main_loop_signal_add(ob_main_loop, SIGINT, signal_handler, NULL, NULL);
165     ob_main_loop_signal_add(ob_main_loop, SIGHUP, signal_handler, NULL, NULL);
166     ob_main_loop_signal_add(ob_main_loop, SIGPIPE, signal_handler, NULL, NULL);
167     ob_main_loop_signal_add(ob_main_loop, SIGCHLD, signal_handler, NULL, NULL);
168
169     ob_screen = DefaultScreen(ob_display);
170
171     ob_rr_inst = RrInstanceNew(ob_display, ob_screen);
172     if (ob_rr_inst == NULL)
173         ob_exit_with_error("Failed to initialize the render library.");
174
175     XSynchronize(ob_display, xsync);
176
177     /* check for locale support */
178     if (!XSupportsLocale())
179         g_message(_("X server does not support locale."));
180     if (!XSetLocaleModifiers(""))
181         g_message(_("Cannot set locale modifiers for the X server."));
182
183     /* set our error handler */
184     XSetErrorHandler(xerror_handler);
185
186     /* set the DISPLAY environment variable for any lauched children, to the
187        display we're using, so they open in the right place. */
188     putenv(g_strdup_printf("DISPLAY=%s", DisplayString(ob_display)));
189
190     /* create available cursors */
191     cursors[OB_CURSOR_NONE] = None;
192     cursors[OB_CURSOR_POINTER] = load_cursor("left_ptr", XC_left_ptr);
193     cursors[OB_CURSOR_BUSY] = load_cursor("left_ptr_watch", XC_watch);
194     cursors[OB_CURSOR_MOVE] = load_cursor("fleur", XC_fleur);
195     cursors[OB_CURSOR_NORTH] = load_cursor("top_side", XC_top_side);
196     cursors[OB_CURSOR_NORTHEAST] = load_cursor("top_right_corner",
197                                                XC_top_right_corner);
198     cursors[OB_CURSOR_EAST] = load_cursor("right_side", XC_right_side);
199     cursors[OB_CURSOR_SOUTHEAST] = load_cursor("bottom_right_corner",
200                                                XC_bottom_right_corner);
201     cursors[OB_CURSOR_SOUTH] = load_cursor("bottom_side", XC_bottom_side);
202     cursors[OB_CURSOR_SOUTHWEST] = load_cursor("bottom_left_corner",
203                                                XC_bottom_left_corner);
204     cursors[OB_CURSOR_WEST] = load_cursor("left_side", XC_left_side);
205     cursors[OB_CURSOR_NORTHWEST] = load_cursor("top_left_corner",
206                                                XC_top_left_corner);
207
208     /* create available keycodes */
209     keys[OB_KEY_RETURN] =
210         XKeysymToKeycode(ob_display, XStringToKeysym("Return"));
211     keys[OB_KEY_ESCAPE] =
212         XKeysymToKeycode(ob_display, XStringToKeysym("Escape"));
213     keys[OB_KEY_LEFT] =
214         XKeysymToKeycode(ob_display, XStringToKeysym("Left"));
215     keys[OB_KEY_RIGHT] =
216         XKeysymToKeycode(ob_display, XStringToKeysym("Right"));
217     keys[OB_KEY_UP] =
218         XKeysymToKeycode(ob_display, XStringToKeysym("Up"));
219     keys[OB_KEY_DOWN] =
220         XKeysymToKeycode(ob_display, XStringToKeysym("Down"));
221
222     prop_startup(); /* get atoms values for the display */
223     extensions_query_all(); /* find which extensions are present */
224
225     if (screen_annex(program_name)) { /* it will be ours! */
226         do {
227             {
228                 ObParseInst *i;
229                 xmlDocPtr doc;
230                 xmlNodePtr node;
231
232                 modkeys_startup(reconfigure);
233
234                 /* startup the parsing so everything can register sections
235                    of the rc */
236                 i = parse_startup();
237
238                 /* start up config which sets up with the parser */
239                 config_startup(i);
240
241                 /* parse/load user options */
242                 if (parse_load_rc(config_type, &doc, &node)) {
243                     parse_tree(i, doc, node->xmlChildrenNode);
244                     parse_close(doc);
245                 } else
246                     g_message(_("Unable to find a valid config file, using some simple defaults"));
247
248                 if (config_type != NULL)
249                     PROP_SETS(RootWindow(ob_display, ob_screen),
250                               openbox_config, config_type);
251
252                 /* we're done with parsing now, kill it */
253                 parse_shutdown(i);
254             }
255
256             /* load the theme specified in the rc file */
257             {
258                 RrTheme *theme;
259                 if ((theme = RrThemeNew(ob_rr_inst, config_theme,
260                                         config_font_activewindow,
261                                         config_font_inactivewindow,
262                                         config_font_menutitle,
263                                         config_font_menuitem,
264                                         config_font_osd)))
265                 {
266                     RrThemeFree(ob_rr_theme);
267                     ob_rr_theme = theme;
268                 }
269                 if (ob_rr_theme == NULL)
270                     ob_exit_with_error("Unable to load a theme.");
271             }
272
273             if (reconfigure) {
274                 GList *it;
275
276                 /* update all existing windows for the new theme */
277                 for (it = client_list; it; it = g_list_next(it)) {
278                     ObClient *c = it->data;
279                     frame_adjust_theme(c->frame);
280                 }
281             }
282             event_startup(reconfigure);
283             /* focus_backup is used for stacking, so this needs to come before
284                anything that calls stacking_add */
285             focus_startup(reconfigure);
286             window_startup(reconfigure);
287             sn_startup(reconfigure);
288             screen_startup(reconfigure);
289             grab_startup(reconfigure);
290             group_startup(reconfigure);
291             client_startup(reconfigure);
292             dock_startup(reconfigure);
293             moveresize_startup(reconfigure);
294             keyboard_startup(reconfigure);
295             mouse_startup(reconfigure);
296             menu_startup(reconfigure);
297             menu_frame_startup(reconfigure);
298
299             if (!reconfigure) {
300                 guint32 xid;
301                 ObWindow *w;
302
303                 /* get all the existing windows */
304                 client_manage_all();
305                 focus_nothing();
306
307                 /* focus what was focused if a wm was already running */
308                 if (PROP_GET32(RootWindow(ob_display, ob_screen),
309                                net_active_window, window, &xid) &&
310                     (w = g_hash_table_lookup(window_map, &xid)) &&
311                     WINDOW_IS_CLIENT(w))
312                 {
313                     client_focus(WINDOW_AS_CLIENT(w));
314                 }
315             } else {
316                 GList *it;
317
318                 /* redecorate all existing windows */
319                 for (it = client_list; it; it = g_list_next(it)) {
320                     ObClient *c = it->data;
321                     /* the new config can change the window's decorations */
322                     client_setup_decor_and_functions(c);
323                     /* redraw the frames */
324                     frame_adjust_area(c->frame, TRUE, TRUE, FALSE);
325                 }
326             }
327
328             reconfigure = FALSE;
329
330             state = OB_STATE_RUNNING;
331             ob_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_frame_shutdown(reconfigure);
340             menu_shutdown(reconfigure);
341             mouse_shutdown(reconfigure);
342             keyboard_shutdown(reconfigure);
343             moveresize_shutdown(reconfigure);
344             dock_shutdown(reconfigure);
345             client_shutdown(reconfigure);
346             group_shutdown(reconfigure);
347             grab_shutdown(reconfigure);
348             screen_shutdown(reconfigure);
349             focus_shutdown(reconfigure);
350             sn_shutdown(reconfigure);
351             window_shutdown(reconfigure);
352             event_shutdown(reconfigure);
353             config_shutdown();
354             modkeys_shutdown(reconfigure);
355         } while (reconfigure);
356     }
357
358     XSync(ob_display, FALSE);
359
360     RrThemeFree(ob_rr_theme);
361     RrInstanceFree(ob_rr_inst);
362
363     session_shutdown(being_replaced);
364
365     XCloseDisplay(ob_display);
366
367     parse_paths_shutdown();
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         if (ob_sm_save_file != NULL || ob_sm_id != NULL) {
389             gchar **nargv;
390             gint i, l;
391
392             l = argc +
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             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(config_type);
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(" 2007        Mikael Magnusson\n");
452     g_print(_("Copyright (c)"));
453     g_print(" 2003-2007   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(_("  --config TYPE       Specify the configuration profile to use\n"));
464 #ifdef USE_SM
465     g_print(_("  --sm-disable        Disable connection to the session manager\n"));
466 #endif
467     g_print(_("  --replace           Replace the currently running window manager\n"));
468     g_print(_("  --help              Display this help and exit\n"));
469     g_print(_("  --version           Display the version and exit\n"));
470     g_print(_("\nPassing messages to a running Openbox instance:\n"));
471     g_print(_("  --reconfigure       Reload Openbox's configuration\n"));
472     g_print(_("\nOptions for internal use:\n"));
473     g_print(_("  --sm-save-file FILE Specify file to load a saved session from\n"));
474     g_print(_("  --sm-client-id ID   Specify session management ID\n"));
475     g_print(_("\nDebugging options:\n"));
476     g_print(_("  --sync              Run in synchronous mode\n"));
477     g_print(_("  --debug             Display debugging output\n"));
478     g_print(_("  --debug-focus       Display debugging output for focus handling\n"));
479     g_print(_("\nPlease report bugs at %s\n"), PACKAGE_BUGREPORT);
480 }
481
482 static void parse_env(gchar **argv0)
483 {
484     const char *c;
485
486     /* pretend we are this other application */
487     if ((c = getenv("OPENBOX_RESTART_BINARY")))
488         *argv0 = g_strdup(c);
489     unsetenv("OPENBOX_RESTART_BINARY");
490
491     /* notify this application when openbox reconfigures */
492     if ((c = getenv("OPENBOX_RECONFIGURE_NOTIFY_PID")))
493         reconfigure_notify = (pid_t) atol(c);
494 }
495
496 static void remove_args(gint *argc, gchar **argv, gint index, gint num)
497 {
498     gint i;
499
500     for (i = index; i < index + num; ++i)
501         argv[i] = argv[i+num];
502     for (; i < *argc; ++i)
503         argv[i] = NULL;
504     *argc -= num;
505 }
506
507 static void parse_args(gint *argc, gchar **argv)
508 {
509     gint i;
510
511     for (i = 1; i < *argc; ++i) {
512         if (!strcmp(argv[i], "--version")) {
513             print_version();
514             exit(0);
515         } else if (!strcmp(argv[i], "--help")) {
516             print_help();
517             exit(0);
518         } else if (!strcmp(argv[i], "--g-fatal-warnings")) {
519             g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL);
520         } else if (!strcmp(argv[i], "--replace")) {
521             ob_replace_wm = TRUE;
522         } else if (!strcmp(argv[i], "--sync")) {
523             xsync = TRUE;
524         } else if (!strcmp(argv[i], "--debug")) {
525             ob_debug_show_output(TRUE);
526             ob_debug_enable(OB_DEBUG_SM, TRUE);
527             ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
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         } else if (!strcmp(argv[i], "--reconfigure")) {
534             remote_control = 1;
535 /* don't make this do anything if it's not in --help ..
536         } else if (!strcmp(argv[i], "--restart")) {
537             remote_control = 2;
538 */
539         } else if (!strcmp(argv[i], "--config")) {
540             if (i == *argc - 1) /* no args left */
541                 g_printerr(_("--config requires an argument\n"));
542             else {
543                 config_type = g_strdup(argv[i+1]);
544                 ++i;
545             }
546         }
547 #ifdef USE_SM
548         else if (!strcmp(argv[i], "--sm-save-file")) {
549             if (i == *argc - 1) /* no args left */
550                 g_printerr(_("--sm-save-file requires an argument\n"));
551             else {
552                 ob_sm_save_file = g_strdup(argv[i+1]);
553                 remove_args(argc, argv, i, 2);
554                 --i; /* this arg was removed so go back */
555             }
556         } else if (!strcmp(argv[i], "--sm-client-id")) {
557             if (i == *argc - 1) /* no args left */
558                 g_printerr(_("--sm-client-id requires an argument\n"));
559             else {
560                 ob_sm_id = g_strdup(argv[i+1]);
561                 remove_args(argc, argv, i, 2);
562                 --i; /* this arg was removed so go back */
563             }
564         } else if (!strcmp(argv[i], "--sm-disable")) {
565             ob_sm_use = FALSE;
566         }
567 #endif
568         else {
569             /* this is a memleak.. oh well.. heh */
570             gchar *err = g_strdup_printf
571                 ("Invalid command line argument '%s'\n", argv[i]);
572             ob_exit_with_error(err);
573         }
574     }
575 }
576
577 static Cursor load_cursor(const gchar *name, guint fontval)
578 {
579     Cursor c = None;
580
581 #if USE_XCURSOR
582     c = XcursorLibraryLoadCursor(ob_display, name);
583 #endif
584     if (c == None)
585         c = XCreateFontCursor(ob_display, fontval);
586     return c;
587 }
588
589 void ob_exit_with_error(const gchar *msg)
590 {
591     g_critical(msg);
592     session_shutdown(TRUE);
593     exit(EXIT_FAILURE);
594 }
595
596 void ob_restart_other(const gchar *path)
597 {
598     restart_path = g_strdup(path);
599     ob_restart();
600 }
601
602 void ob_restart()
603 {
604     restart = TRUE;
605     ob_exit(0);
606 }
607
608 void ob_reconfigure()
609 {
610     if (reconfigure_notify)
611         kill(reconfigure_notify, SIGUSR2);
612
613     reconfigure = TRUE;
614     ob_exit(0);
615 }
616
617 void ob_exit(gint code)
618 {
619     exitcode = code;
620     ob_main_loop_exit(ob_main_loop);
621 }
622
623 void ob_exit_replace()
624 {
625     exitcode = 0;
626     being_replaced = TRUE;
627     ob_main_loop_exit(ob_main_loop);
628 }
629
630 Cursor ob_cursor(ObCursor cursor)
631 {
632     g_assert(cursor < OB_NUM_CURSORS);
633     return cursors[cursor];
634 }
635
636 KeyCode ob_keycode(ObKey key)
637 {
638     g_assert(key < OB_NUM_KEYS);
639     return keys[key];
640 }
641
642 ObState ob_state()
643 {
644     return state;
645 }