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