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