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