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        Ben 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 "xerror.h"
  28 #include "prop.h"
  29 #include "screen.h"
  30 #include "startupnotify.h"
  31 #include "focus.h"
  32 #include "moveresize.h"
  33 #include "frame.h"
  34 #include "keyboard.h"
  35 #include "mouse.h"
  36 #include "extensions.h"
  37 #include "menuframe.h"
  38 #include "grab.h"
  39 #include "group.h"
  40 #include "config.h"
  41 #include "mainloop.h"
  42 #include "gettext.h"
  43 #include "parser/parse.h"
  44 #include "render/render.h"
  45 #include "render/theme.h"
  46
  47 #ifdef HAVE_FCNTL_H
  48 #  include <fcntl.h>
  49 #endif
  50 #ifdef HAVE_SIGNAL_H
  51 #  include <signal.h>
  52 #endif
  53 #ifdef HAVE_STDLIB_H
  54 #  include <stdlib.h>
  55 #endif
  56 #ifdef HAVE_LOCALE_H
  57 #  include <locale.h>
  58 #endif
  59 #ifdef HAVE_SYS_STAT_H
  60 #  include <sys/stat.h>
  61 #  include <sys/types.h>
  62 #endif
  63 #ifdef HAVE_SYS_WAIT_H
  64 #  include <sys/types.h>
  65 #  include <sys/wait.h>
  66 #endif
  67 #ifdef HAVE_UNISTD_H
  68 #  include <unistd.h>
  69 #endif
  70 #include <errno.h>
  71
  72 #include <X11/cursorfont.h>
  73 #if USE_XCURSOR
  74 #include <X11/Xcursor/Xcursor.h>
  75 #endif
  76
  77 RrInstance *ob_rr_inst;
  78 RrTheme    *ob_rr_theme;
  79 ObMainLoop *ob_main_loop;
  80 Display    *ob_display;
  81 gint        ob_screen;
  82 gboolean    ob_replace_wm = FALSE;
  83
  84 static ObState   state;
  85 static gboolean  xsync = FALSE;
  86 static gboolean  reconfigure = FALSE;
  87 static gboolean  restart = FALSE;
  88 static gchar    *restart_path = NULL;
  89 static Cursor    cursors[OB_NUM_CURSORS];
  90 static KeyCode   keys[OB_NUM_KEYS];
  91 static gint      exitcode = 0;
  92 static guint     remote_control = 0;
  93 static gboolean  being_replaced = FALSE;
  94 static gchar    *config_file = NULL;
  95
  96 static void signal_handler(gint signal, gpointer data);
  97 static void parse_args(gint argc, gchar **argv);
  98 static Cursor load_cursor(const gchar *name, guint fontval);
  99
 100 gint main(gint argc, gchar **argv)
 101 {
 102     state = OB_STATE_STARTING;
 103
 104     /* initialize the locale */
 105     if (!setlocale(LC_ALL, ""))
 106         g_warning("Couldn't set locale from environment.");
 107     bindtextdomain(PACKAGE_NAME, LOCALEDIR);
 108     bind_textdomain_codeset(PACKAGE_NAME, "UTF-8");
 109     textdomain(PACKAGE_NAME);
 110
 111     g_set_prgname(argv[0]);
 112
 113     if (chdir(g_get_home_dir()) == -1)
 114         g_warning("Unable to change to home directory (%s): %s",
 115                   g_get_home_dir(), g_strerror(errno));
 116
 117     /* parse out command line args */
 118     parse_args(argc, argv);
 119
 120     if (!remote_control) {
 121         parse_paths_startup();
 122
 123         session_startup(argc, argv);
 124     }
 125
 126     ob_display = XOpenDisplay(NULL);
 127     if (ob_display == NULL)
 128         ob_exit_with_error("Failed to open the display.");
 129     if (fcntl(ConnectionNumber(ob_display), F_SETFD, 1) == -1)
 130         ob_exit_with_error("Failed to set display as close-on-exec.");
 131
 132     if (remote_control) {
 133         prop_startup();
 134
 135         /* Send client message telling the OB process to:
 136          * remote_control = 1 -> reconfigure
 137          * remote_control = 2 -> restart */
 138         PROP_MSG(RootWindow(ob_display, ob_screen),
 139                  ob_control, remote_control, 0, 0, 0);
 140         XCloseDisplay(ob_display);
 141         exit(EXIT_SUCCESS);
 142     }
 143
 144     ob_main_loop = ob_main_loop_new(ob_display);
 145
 146     /* set up signal handler */
 147     ob_main_loop_signal_add(ob_main_loop, SIGUSR1, signal_handler, NULL, NULL);
 148     ob_main_loop_signal_add(ob_main_loop, SIGUSR2, signal_handler, NULL, NULL);
 149     ob_main_loop_signal_add(ob_main_loop, SIGTERM, signal_handler, NULL, NULL);
 150     ob_main_loop_signal_add(ob_main_loop, SIGINT, signal_handler, NULL, NULL);
 151     ob_main_loop_signal_add(ob_main_loop, SIGHUP, signal_handler, NULL, NULL);
 152     ob_main_loop_signal_add(ob_main_loop, SIGPIPE, signal_handler, NULL, NULL);
 153     ob_main_loop_signal_add(ob_main_loop, SIGCHLD, signal_handler, NULL, NULL);
 154
 155     ob_screen = DefaultScreen(ob_display);
 156
 157     ob_rr_inst = RrInstanceNew(ob_display, ob_screen);
 158     if (ob_rr_inst == NULL)
 159         ob_exit_with_error("Failed to initialize the render library.");
 160
 161     XSynchronize(ob_display, xsync);
 162
 163     /* check for locale support */
 164     if (!XSupportsLocale())
 165         g_warning("X server does not support locale.");
 166     if (!XSetLocaleModifiers(""))
 167         g_warning("Cannot set locale modifiers for the X server.");
 168
 169     /* set our error handler */
 170     XSetErrorHandler(xerror_handler);
 171
 172     /* set the DISPLAY environment variable for any lauched children, to the
 173        display we're using, so they open in the right place. */
 174     putenv(g_strdup_printf("DISPLAY=%s", DisplayString(ob_display)));
 175
 176     /* create available cursors */
 177     cursors[OB_CURSOR_NONE] = None;
 178     cursors[OB_CURSOR_POINTER] = load_cursor("left_ptr", XC_left_ptr);
 179     cursors[OB_CURSOR_BUSY] = load_cursor("left_ptr_watch", XC_watch);
 180     cursors[OB_CURSOR_MOVE] = load_cursor("fleur", XC_fleur);
 181     cursors[OB_CURSOR_NORTH] = load_cursor("top_side", XC_top_side);
 182     cursors[OB_CURSOR_NORTHEAST] = load_cursor("top_right_corner",
 183                                                XC_top_right_corner);
 184     cursors[OB_CURSOR_EAST] = load_cursor("right_side", XC_right_side);
 185     cursors[OB_CURSOR_SOUTHEAST] = load_cursor("bottom_right_corner",
 186                                                XC_bottom_right_corner);
 187     cursors[OB_CURSOR_SOUTH] = load_cursor("bottom_side", XC_bottom_side);
 188     cursors[OB_CURSOR_SOUTHWEST] = load_cursor("bottom_left_corner",
 189                                                XC_bottom_left_corner);
 190     cursors[OB_CURSOR_WEST] = load_cursor("left_side", XC_left_side);
 191     cursors[OB_CURSOR_NORTHWEST] = load_cursor("top_left_corner",
 192                                                XC_top_left_corner);
 193
 194     /* create available keycodes */
 195     keys[OB_KEY_RETURN] =
 196         XKeysymToKeycode(ob_display, XStringToKeysym("Return"));
 197     keys[OB_KEY_ESCAPE] =
 198         XKeysymToKeycode(ob_display, XStringToKeysym("Escape"));
 199     keys[OB_KEY_LEFT] =
 200         XKeysymToKeycode(ob_display, XStringToKeysym("Left"));
 201     keys[OB_KEY_RIGHT] =
 202         XKeysymToKeycode(ob_display, XStringToKeysym("Right"));
 203     keys[OB_KEY_UP] =
 204         XKeysymToKeycode(ob_display, XStringToKeysym("Up"));
 205     keys[OB_KEY_DOWN] =
 206         XKeysymToKeycode(ob_display, XStringToKeysym("Down"));
 207
 208     prop_startup(); /* get atoms values for the display */
 209     extensions_query_all(); /* find which extensions are present */
 210
 211     if (screen_annex()) { /* it will be ours! */
 212         do {
 213             {
 214                 ObParseInst *i;
 215                 xmlDocPtr doc;
 216                 xmlNodePtr node;
 217
 218                 /* startup the parsing so everything can register sections
 219                    of the rc */
 220                 i = parse_startup();
 221
 222                 config_startup(i);
 223                 /* parse/load user options */
 224                 if (parse_load_rc(config_file, &doc, &node, &config_file)) {
 225                     PROP_SETS(RootWindow(ob_display, ob_screen),
 226                               openbox_rc, config_file);
 227                     parse_tree(i, doc, node->xmlChildrenNode);
 228                 } else
 229                     PROP_ERASE(RootWindow(ob_display, ob_screen), openbox_rc);
 230                 /* we're done with parsing now, kill it */
 231                 parse_close(doc);
 232                 parse_shutdown(i);
 233             }
 234
 235             /* load the theme specified in the rc file */
 236             {
 237                 RrTheme *theme;
 238                 if ((theme = RrThemeNew(ob_rr_inst, config_theme,
 239                                         config_font_activewindow,
 240                                         config_font_inactivewindow,
 241                                         config_font_menutitle,
 242                                         config_font_menuitem)))
 243                 {
 244                     RrThemeFree(ob_rr_theme);
 245                     ob_rr_theme = theme;
 246                 }
 247                 if (ob_rr_theme == NULL)
 248                     ob_exit_with_error("Unable to load a theme.");
 249             }
 250
 251             if (reconfigure) {
 252                 GList *it;
 253
 254                 /* update all existing windows for the new theme */
 255                 for (it = client_list; it; it = g_list_next(it)) {
 256                     ObClient *c = it->data;
 257                     frame_adjust_theme(c->frame);
 258                 }
 259             }
 260             event_startup(reconfigure);
 261             /* focus_backup is used for stacking, so this needs to come before
 262                anything that calls stacking_add */
 263             focus_startup(reconfigure);
 264             window_startup(reconfigure);
 265             sn_startup(reconfigure);
 266             screen_startup(reconfigure);
 267             grab_startup(reconfigure);
 268             group_startup(reconfigure);
 269             client_startup(reconfigure);
 270             dock_startup(reconfigure);
 271             moveresize_startup(reconfigure);
 272             keyboard_startup(reconfigure);
 273             mouse_startup(reconfigure);
 274             menu_startup(reconfigure);
 275             menu_frame_startup(reconfigure);
 276
 277             if (!reconfigure) {
 278                 /* get all the existing windows */
 279                 client_manage_all();
 280                 focus_fallback(TRUE);
 281             } else {
 282                 GList *it;
 283
 284                 /* redecorate all existing windows */
 285                 for (it = client_list; it; it = g_list_next(it)) {
 286                     ObClient *c = it->data;
 287                     /* the new config can change the window's decorations */
 288                     client_setup_decor_and_functions(c);
 289                     /* redraw the frames */
 290                     frame_adjust_area(c->frame, TRUE, TRUE, FALSE);
 291                 }
 292             }
 293
 294             reconfigure = FALSE;
 295
 296             state = OB_STATE_RUNNING;
 297             ob_main_loop_run(ob_main_loop);
 298             state = OB_STATE_EXITING;
 299
 300             if (!reconfigure) {
 301                 dock_remove_all();
 302                 client_unmanage_all();
 303             }
 304
 305             menu_frame_shutdown(reconfigure);
 306             menu_shutdown(reconfigure);
 307             mouse_shutdown(reconfigure);
 308             keyboard_shutdown(reconfigure);
 309             moveresize_shutdown(reconfigure);
 310             dock_shutdown(reconfigure);
 311             client_shutdown(reconfigure);
 312             group_shutdown(reconfigure);
 313             grab_shutdown(reconfigure);
 314             screen_shutdown(reconfigure);
 315             focus_shutdown(reconfigure);
 316             sn_shutdown(reconfigure);
 317             window_shutdown(reconfigure);
 318             event_shutdown(reconfigure);
 319             config_shutdown();
 320         } while (reconfigure);
 321     }
 322
 323     XSync(ob_display, FALSE);
 324
 325     g_free(config_file); /* this is set by parse_load_rc */
 326     RrThemeFree(ob_rr_theme);
 327     RrInstanceFree(ob_rr_inst);
 328
 329     session_shutdown(being_replaced);
 330
 331     XCloseDisplay(ob_display);
 332
 333     parse_paths_shutdown();
 334
 335     if (restart) {
 336         if (restart_path != NULL) {
 337             gint argcp;
 338             gchar **argvp;
 339             GError *err = NULL;
 340
 341             /* run other window manager */
 342             if (g_shell_parse_argv(restart_path, &argcp, &argvp, &err)) {
 343                 execvp(argvp[0], argvp);
 344                 g_strfreev(argvp);
 345             } else {
 346                 g_warning("failed to execute '%s': %s", restart_path,
 347                           err->message);
 348                 g_error_free(err);
 349             }
 350         }
 351
 352         /* re-run me */
 353         execvp(argv[0], argv); /* try how we were run */
 354         execlp(argv[0], g_path_get_basename(argv[0]),
 355                (char *)NULL); /* last resort */
 356     }
 357
 358     return exitcode;
 359 }
 360
 361 static void signal_handler(gint signal, gpointer data)
 362 {
 363     switch (signal) {
 364     case SIGUSR1:
 365         ob_debug("Caught signal %d. Restarting.\n", signal);
 366         ob_restart();
 367         break;
 368     case SIGUSR2:
 369         ob_debug("Caught signal %d. Reconfiguring.\n", signal);
 370         ob_reconfigure();
 371         break;
 372     case SIGCHLD:
 373         /* reap children */
 374         while (waitpid(-1, NULL, WNOHANG) > 0);
 375         break;
 376     default:
 377         ob_debug("Caught signal %d. Exiting.\n", signal);
 378         /* TERM and INT return a 0 code */
 379         ob_exit(!(signal == SIGTERM || signal == SIGINT));
 380     }
 381 }
 382
 383 static void print_version()
 384 {
 385     g_print("Openbox %s\n", PACKAGE_VERSION);
 386     g_print("Copyright (c) 2007 Mikael Magnusson\n");
 387     g_print("Copyright (c) 2003-2007 Dana Jansens\n\n");
 388     g_print("This program comes with ABSOLUTELY NO WARRANTY.\n");
 389     g_print("This is free software, and you are welcome to redistribute it\n");
 390     g_print("under certain conditions. See the file COPYING for details.\n\n");
 391 }
 392
 393 static void print_help()
 394 {
 395     g_print("Syntax: openbox [options]\n\n");
 396     g_print("Options:\n\n");
 397     g_print("  --reconfigure       Tell the currently running instance of "
 398             "Openbox to\n"
 399             "                      reconfigure (and then exit immediately)\n");
 400     g_print("  --config-file FILE  Specify the file to load for the config "
 401             "file\n");
 402 #ifdef USE_SM
 403     g_print("  --sm-disable        Disable connection to session manager\n");
 404     g_print("  --sm-client-id ID   Specify session management ID\n");
 405     g_print("  --sm-save-file FILE Specify file to load a saved session"
 406             "from\n");
 407 #endif
 408     g_print("  --replace           Replace the currently running window "
 409             "manager\n");
 410     g_print("  --help              Display this help and exit\n");
 411     g_print("  --version           Display the version and exit\n");
 412     g_print("  --sync              Run in synchronous mode (this is slow and "
 413             "meant for\n"
 414             "                      debugging X routines)\n");
 415     g_print("  --debug             Display debugging output\n");
 416     g_print("  --debug-focus       Display debugging output\n");
 417     g_print("\nPlease report bugs at %s\n\n", PACKAGE_BUGREPORT);
 418 }
 419
 420 static void parse_args(gint argc, gchar **argv)
 421 {
 422     gint i;
 423
 424     for (i = 1; i < argc; ++i) {
 425         if (!strcmp(argv[i], "--version")) {
 426             print_version();
 427             exit(0);
 428         } else if (!strcmp(argv[i], "--help")) {
 429             print_help();
 430             exit(0);
 431         } else if (!strcmp(argv[i], "--g-fatal-warnings")) {
 432             g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL);
 433         } else if (!strcmp(argv[i], "--replace")) {
 434             ob_replace_wm = TRUE;
 435         } else if (!strcmp(argv[i], "--sync")) {
 436             xsync = TRUE;
 437         } else if (!strcmp(argv[i], "--debug")) {
 438             ob_debug_show_output(TRUE);
 439         } else if (!strcmp(argv[i], "--debug-focus")) {
 440             ob_debug_show_output(TRUE);
 441             ob_debug_enable(OB_DEBUG_FOCUS, TRUE);
 442         } else if (!strcmp(argv[i], "--reconfigure")) {
 443             remote_control = 1;
 444         } else if (!strcmp(argv[i], "--restart")) {
 445             remote_control = 2;
 446         } else if (!strcmp(argv[i], "--config-file")) {
 447             if (i == argc - 1) /* no args left */
 448                 g_printerr(_("--config-file requires an argument\n"));
 449             else {
 450                 config_file = g_strdup(argv[i+1]);
 451                 ++i;
 452             }
 453         }
 454     }
 455 }
 456
 457 static Cursor load_cursor(const gchar *name, guint fontval)
 458 {
 459     Cursor c = None;
 460
 461 #if USE_XCURSOR
 462     c = XcursorLibraryLoadCursor(ob_display, name);
 463 #endif
 464     if (c == None)
 465         c = XCreateFontCursor(ob_display, fontval);
 466     return c;
 467 }
 468
 469 void ob_exit_with_error(const gchar *msg)
 470 {
 471     g_critical(msg);
 472     session_shutdown(TRUE);
 473     exit(EXIT_FAILURE);
 474 }
 475
 476 void ob_restart_other(const gchar *path)
 477 {
 478     restart_path = g_strdup(path);
 479     ob_restart();
 480 }
 481
 482 void ob_restart()
 483 {
 484     restart = TRUE;
 485     ob_exit(0);
 486 }
 487
 488 void ob_reconfigure()
 489 {
 490     reconfigure = TRUE;
 491     ob_exit(0);
 492 }
 493
 494 void ob_exit(gint code)
 495 {
 496     exitcode = code;
 497     ob_main_loop_exit(ob_main_loop);
 498 }
 499
 500 void ob_exit_replace()
 501 {
 502     exitcode = 0;
 503     being_replaced = TRUE;
 504     ob_main_loop_exit(ob_main_loop);
 505 }
 506
 507 Cursor ob_cursor(ObCursor cursor)
 508 {
 509     g_assert(cursor < OB_NUM_CURSORS);
 510     return cursors[cursor];
 511 }
 512
 513 KeyCode ob_keycode(ObKey key)
 514 {
 515     g_assert(key < OB_NUM_KEYS);
 516     return keys[key];
 517 }
 518
 519 ObState ob_state()
 520 {
 521     return state;
 522 }