reorganize --help. dont error if they use a --sm stuff and sm isn't enabled
[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 "propwin.h"
42 #include "config.h"
43 #include "mainloop.h"
44 #include "gettext.h"
45 #include "parser/parse.h"
46 #include "render/render.h"
47 #include "render/theme.h"
48
49 #ifdef HAVE_FCNTL_H
50 #  include <fcntl.h>
51 #endif
52 #ifdef HAVE_SIGNAL_H
53 #  include <signal.h>
54 #endif
55 #ifdef HAVE_STDLIB_H
56 #  include <stdlib.h>
57 #endif
58 #ifdef HAVE_LOCALE_H
59 #  include <locale.h>
60 #endif
61 #ifdef HAVE_SYS_STAT_H
62 #  include <sys/stat.h>
63 #  include <sys/types.h>
64 #endif
65 #ifdef HAVE_SYS_WAIT_H
66 #  include <sys/types.h>
67 #  include <sys/wait.h>
68 #endif
69 #ifdef HAVE_UNISTD_H
70 #  include <unistd.h>
71 #endif
72 #include <errno.h>
73
74 #include <X11/cursorfont.h>
75 #if USE_XCURSOR
76 #include <X11/Xcursor/Xcursor.h>
77 #endif
78
79 #include <X11/Xlib.h>
80 #include <X11/keysym.h>
81
82
83 RrInstance *ob_rr_inst;
84 RrTheme    *ob_rr_theme;
85 ObMainLoop *ob_main_loop;
86 Display    *ob_display;
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
93 static ObState   state;
94 static gboolean  xsync = FALSE;
95 static gboolean  reconfigure = FALSE;
96 static gboolean  restart = FALSE;
97 static gchar    *restart_path = NULL;
98 static Cursor    cursors[OB_NUM_CURSORS];
99 static KeyCode   keys[OB_NUM_KEYS];
100 static gint      exitcode = 0;
101 static guint     remote_control = 0;
102 static gboolean  being_replaced = FALSE;
103 static gchar    *config_type = NULL;
104
105 static void signal_handler(gint signal, gpointer data);
106 static void remove_args(gint *argc, gchar **argv, gint index, gint num);
107 static void parse_args(gint *argc, gchar **argv);
108 static Cursor load_cursor(const gchar *name, guint fontval);
109
110 gint main(gint argc, gchar **argv)
111 {
112     gchar *program_name;
113
114     state = OB_STATE_STARTING;
115
116     /* initialize the locale */
117     if (!setlocale(LC_ALL, ""))
118         g_message("Couldn't set locale from environment.");
119     bindtextdomain(PACKAGE_NAME, LOCALEDIR);
120     bind_textdomain_codeset(PACKAGE_NAME, "UTF-8");
121     textdomain(PACKAGE_NAME);
122
123     if (chdir(g_get_home_dir()) == -1)
124         g_message(_("Unable to change to home directory '%s': %s"),
125                   g_get_home_dir(), g_strerror(errno));
126      
127     /* parse the command line args, which can change the argv[0] */
128     parse_args(&argc, argv);
129
130     program_name = g_path_get_basename(argv[0]);
131     g_set_prgname(program_name);
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 from the DISPLAY environment variable."));
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
209     prop_startup(); /* get atoms values for the display */
210     extensions_query_all(); /* find which extensions are present */
211
212     if (screen_annex(program_name)) { /* it will be ours! */
213         do {
214             modkeys_startup(reconfigure);
215
216             /* get the keycodes for keys we use */
217             keys[OB_KEY_RETURN] = modkeys_sym_to_code(XK_Return);
218             keys[OB_KEY_ESCAPE] = modkeys_sym_to_code(XK_Escape);
219             keys[OB_KEY_LEFT] = modkeys_sym_to_code(XK_Left);
220             keys[OB_KEY_RIGHT] = modkeys_sym_to_code(XK_Right);
221             keys[OB_KEY_UP] = modkeys_sym_to_code(XK_Up);
222             keys[OB_KEY_DOWN] = modkeys_sym_to_code(XK_Down);
223
224             {
225                 ObParseInst *i;
226                 xmlDocPtr doc;
227                 xmlNodePtr node;
228
229                 /* startup the parsing so everything can register sections
230                    of the rc */
231                 i = parse_startup();
232
233                 /* start up config which sets up with the parser */
234                 config_startup(i);
235
236                 /* parse/load user options */
237                 if (parse_load_rc(config_type, &doc, &node)) {
238                     parse_tree(i, doc, node->xmlChildrenNode);
239                     parse_close(doc);
240                 } else
241                     g_message(_("Unable to find a valid config file, using some simple defaults"));
242
243                 if (config_type != NULL)
244                     PROP_SETS(RootWindow(ob_display, ob_screen),
245                               openbox_config, config_type);
246
247                 /* we're done with parsing now, kill it */
248                 parse_shutdown(i);
249             }
250
251             /* load the theme specified in the rc file */
252             {
253                 RrTheme *theme;
254                 if ((theme = RrThemeNew(ob_rr_inst, config_theme,
255                                         config_font_activewindow,
256                                         config_font_inactivewindow,
257                                         config_font_menutitle,
258                                         config_font_menuitem,
259                                         config_font_osd)))
260                 {
261                     RrThemeFree(ob_rr_theme);
262                     ob_rr_theme = theme;
263                 }
264                 if (ob_rr_theme == NULL)
265                     ob_exit_with_error(_("Unable to load a theme."));
266             }
267
268             if (reconfigure) {
269                 GList *it;
270
271                 /* update all existing windows for the new theme */
272                 for (it = client_list; it; it = g_list_next(it)) {
273                     ObClient *c = it->data;
274                     frame_adjust_theme(c->frame);
275                 }
276             }
277             event_startup(reconfigure);
278             /* focus_backup is used for stacking, so this needs to come before
279                anything that calls stacking_add */
280             focus_startup(reconfigure);
281             window_startup(reconfigure);
282             sn_startup(reconfigure);
283             screen_startup(reconfigure);
284             grab_startup(reconfigure);
285             propwin_startup(reconfigure);
286             group_startup(reconfigure);
287             client_startup(reconfigure);
288             dock_startup(reconfigure);
289             moveresize_startup(reconfigure);
290             keyboard_startup(reconfigure);
291             mouse_startup(reconfigure);
292             menu_startup(reconfigure);
293             menu_frame_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 (PROP_GET32(RootWindow(ob_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                     /* the new config can change the window's decorations */
318                     client_setup_decor_and_functions(c);
319                     /* redraw the frames */
320                     frame_adjust_area(c->frame, TRUE, TRUE, FALSE);
321                 }
322             }
323
324             reconfigure = FALSE;
325
326             state = OB_STATE_RUNNING;
327             ob_main_loop_run(ob_main_loop);
328             state = OB_STATE_EXITING;
329
330             if (!reconfigure) {
331                 dock_remove_all();
332                 client_unmanage_all();
333             }
334
335             menu_frame_shutdown(reconfigure);
336             menu_shutdown(reconfigure);
337             mouse_shutdown(reconfigure);
338             keyboard_shutdown(reconfigure);
339             moveresize_shutdown(reconfigure);
340             dock_shutdown(reconfigure);
341             client_shutdown(reconfigure);
342             group_shutdown(reconfigure);
343             propwin_shutdown(reconfigure);
344             grab_shutdown(reconfigure);
345             screen_shutdown(reconfigure);
346             focus_shutdown(reconfigure);
347             sn_shutdown(reconfigure);
348             window_shutdown(reconfigure);
349             event_shutdown(reconfigure);
350             config_shutdown();
351             modkeys_shutdown(reconfigure);
352         } while (reconfigure);
353     }
354
355     XSync(ob_display, FALSE);
356
357     RrThemeFree(ob_rr_theme);
358     RrInstanceFree(ob_rr_inst);
359
360     session_shutdown(being_replaced);
361
362     XCloseDisplay(ob_display);
363
364     parse_paths_shutdown();
365
366     if (restart) {
367         if (restart_path != NULL) {
368             gint argcp;
369             gchar **argvp;
370             GError *err = NULL;
371
372             /* run other window manager */
373             if (g_shell_parse_argv(restart_path, &argcp, &argvp, &err)) {
374                 execvp(argvp[0], argvp);
375                 g_strfreev(argvp);
376             } else {
377                 g_message(
378                     _("Restart failed to execute new executable '%s': %s"),
379                     restart_path, err->message);
380                 g_error_free(err);
381             }
382         }
383
384         /* we remove the session arguments from argv, so put them back */
385         if (ob_sm_save_file != NULL || ob_sm_id != NULL) {
386             gchar **nargv;
387             gint i, l;
388
389             l = argc +
390                 (ob_sm_save_file != NULL ? 2 : 0) +
391                 (ob_sm_id != NULL ? 2 : 0);
392             nargv = g_new0(gchar*, l+1);
393             for (i = 0; i < argc; ++i)
394                 nargv[i] = argv[i];
395
396             if (ob_sm_save_file != NULL) {
397                 nargv[i++] = g_strdup("--sm-save-file");
398                 nargv[i++] = ob_sm_save_file;
399             }
400             if (ob_sm_id != NULL) {
401                 nargv[i++] = g_strdup("--sm-client-id");
402                 nargv[i++] = ob_sm_id;
403             }
404             g_assert(i == l);
405             argv = nargv;
406         }
407
408         /* re-run me */
409         execvp(argv[0], argv); /* try how we were run */
410         execlp(argv[0], program_name, (gchar*)NULL); /* last resort */
411     }
412
413     /* free stuff passed in from the command line or environment */
414     g_free(ob_sm_save_file);
415     g_free(ob_sm_id);
416     g_free(config_type);
417     g_free(program_name);
418      
419     return exitcode;
420 }
421
422 static void signal_handler(gint signal, gpointer data)
423 {
424     switch (signal) {
425     case SIGUSR1:
426         ob_debug("Caught signal %d. Restarting.\n", signal);
427         ob_restart();
428         break;
429     case SIGUSR2:
430         ob_debug("Caught signal %d. Reconfiguring.\n", signal);
431         ob_reconfigure(); 
432         break;
433     case SIGCHLD:
434         /* reap children */
435         while (waitpid(-1, NULL, WNOHANG) > 0);
436         break;
437     default:
438         ob_debug("Caught signal %d. Exiting.\n", signal);
439         /* TERM and INT return a 0 code */
440         ob_exit(!(signal == SIGTERM || signal == SIGINT));
441     }
442 }
443
444 static void print_version()
445 {
446     g_print("Openbox %s\n", PACKAGE_VERSION);
447     g_print(_("Copyright (c)"));
448     g_print(" 2007        Mikael Magnusson\n");
449     g_print(_("Copyright (c)"));
450     g_print(" 2003-2007   Dana Jansens\n\n");
451     g_print("This program comes with ABSOLUTELY NO WARRANTY.\n");
452     g_print("This is free software, and you are welcome to redistribute it\n");
453     g_print("under certain conditions. See the file COPYING for details.\n\n");
454 }
455
456 static void print_help()
457 {
458     g_print(_("Syntax: openbox [options]\n"));
459     g_print(_("\nOptions:\n"));
460     g_print(_("  --help              Display this help and exit\n"));
461     g_print(_("  --version           Display the version and exit\n"));
462     g_print(_("  --replace           Replace the currently running window manager\n"));
463     g_print(_("  --sm-disable        Disable connection to the session manager\n"));
464     g_print(_("  --config TYPE       Specify the configuration profile to use\n"));
465     g_print(_("\nPassing messages to a running Openbox instance:\n"));
466     g_print(_("  --reconfigure       Reload Openbox's configuration\n"));
467     g_print(_("\nDebugging options:\n"));
468     g_print(_("  --sync              Run in synchronous mode\n"));
469     g_print(_("  --debug             Display debugging output\n"));
470     g_print(_("  --debug-focus       Display debugging output for focus handling\n"));
471     g_print(_("\nPlease report bugs at %s\n"), PACKAGE_BUGREPORT);
472 }
473
474 static void remove_args(gint *argc, gchar **argv, gint index, gint num)
475 {
476     gint i;
477
478     for (i = index; i < *argc - num; ++i)
479         argv[i] = argv[i+num];
480     for (; i < *argc; ++i)
481         argv[i] = NULL;
482     *argc -= num;
483 }
484
485 static void parse_args(gint *argc, gchar **argv)
486 {
487     gint i;
488
489     for (i = 1; i < *argc; ++i) {
490         if (!strcmp(argv[i], "--version")) {
491             print_version();
492             exit(0);
493         }
494         else if (!strcmp(argv[i], "--help")) {
495             print_help();
496             exit(0);
497         }
498         else if (!strcmp(argv[i], "--g-fatal-warnings")) {
499             g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL);
500         }
501         else if (!strcmp(argv[i], "--replace")) {
502             ob_replace_wm = TRUE;
503             remove_args(argc, argv, i, 1);
504             --i; /* this arg was removed so go back */
505         }
506         else if (!strcmp(argv[i], "--sync")) {
507             xsync = TRUE;
508         }
509         else if (!strcmp(argv[i], "--debug")) {
510             ob_debug_show_output(TRUE);
511             ob_debug_enable(OB_DEBUG_SM, TRUE);
512             ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
513         }
514         else if (!strcmp(argv[i], "--debug-focus")) {
515             ob_debug_show_output(TRUE);
516             ob_debug_enable(OB_DEBUG_SM, TRUE);
517             ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
518             ob_debug_enable(OB_DEBUG_FOCUS, TRUE);
519         }
520         else if (!strcmp(argv[i], "--reconfigure")) {
521             remote_control = 1;
522 /* don't make this do anything if it's not in --help ..
523         } else if (!strcmp(argv[i], "--restart")) {
524             remote_control = 2;
525 */
526         }
527         else if (!strcmp(argv[i], "--config")) {
528             if (i == *argc - 1) /* no args left */
529                 g_printerr(_("--config requires an argument\n"));
530             else {
531                 config_type = g_strdup(argv[i+1]);
532                 ++i;
533             }
534         }
535         else if (!strcmp(argv[i], "--sm-save-file")) {
536             if (i == *argc - 1) /* no args left */
537                 /* not translated cuz it's sekret */
538                 g_printerr("--sm-save-file requires an argument\n");
539             else {
540                 ob_sm_save_file = g_strdup(argv[i+1]);
541                 remove_args(argc, argv, i, 2);
542                 --i; /* this arg was removed so go back */
543                 ob_debug_type(OB_DEBUG_SM, "--sm-save-file %s\n",
544                               ob_sm_save_file);
545             }
546         }
547         else if (!strcmp(argv[i], "--sm-client-id")) {
548             if (i == *argc - 1) /* no args left */
549                 /* not translated cuz it's sekret */
550                 g_printerr("--sm-client-id requires an argument\n");
551             else {
552                 ob_sm_id = g_strdup(argv[i+1]);
553                 remove_args(argc, argv, i, 2);
554                 --i; /* this arg was removed so go back */
555                 ob_debug_type(OB_DEBUG_SM, "--sm-client-id %s\n", ob_sm_id);
556             }
557         }
558         else if (!strcmp(argv[i], "--sm-disable")) {
559             ob_sm_use = FALSE;
560         }
561         else {
562             /* this is a memleak.. oh well.. heh */
563             gchar *err = g_strdup_printf
564                 (_("Invalid command line argument '%s'\n"), argv[i]);
565             ob_exit_with_error(err);
566         }
567     }
568 }
569
570 static Cursor load_cursor(const gchar *name, guint fontval)
571 {
572     Cursor c = None;
573
574 #if USE_XCURSOR
575     c = XcursorLibraryLoadCursor(ob_display, name);
576 #endif
577     if (c == None)
578         c = XCreateFontCursor(ob_display, fontval);
579     return c;
580 }
581
582 void ob_exit_with_error(const gchar *msg)
583 {
584     g_message(msg);
585     session_shutdown(TRUE);
586     exit(EXIT_FAILURE);
587 }
588
589 void ob_restart_other(const gchar *path)
590 {
591     restart_path = g_strdup(path);
592     ob_restart();
593 }
594
595 void ob_restart()
596 {
597     restart = TRUE;
598     ob_exit(0);
599 }
600
601 void ob_reconfigure()
602 {
603     reconfigure = TRUE;
604     ob_exit(0);
605 }
606
607 void ob_exit(gint code)
608 {
609     exitcode = code;
610     ob_main_loop_exit(ob_main_loop);
611 }
612
613 void ob_exit_replace()
614 {
615     exitcode = 0;
616     being_replaced = TRUE;
617     ob_main_loop_exit(ob_main_loop);
618 }
619
620 Cursor ob_cursor(ObCursor cursor)
621 {
622     g_assert(cursor < OB_NUM_CURSORS);
623     return cursors[cursor];
624 }
625
626 KeyCode ob_keycode(ObKey key)
627 {
628     g_assert(key < OB_NUM_KEYS);
629     return keys[key];
630 }
631
632 ObState ob_state()
633 {
634     return state;
635 }