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