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