awesome.c

   1 /*
   2  * awesome.c - awesome main functions
   3  *
   4  * Copyright © 2007-2008 Julien Danjou <julien@danjou.info>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19  *
  20  */
  21
  22 #include <getopt.h>
  23
  24 #include <locale.h>
  25 #include <stdio.h>
  26 #include <unistd.h>
  27 #include <signal.h>
  28
  29 #include <xcb/xtest.h>
  30 #include <xcb/xcb_event.h>
  31
  32 #include "awesome.h"
  33 #include "spawn.h"
  34 #include "client.h"
  35 #include "window.h"
  36 #include "ewmh.h"
  37 #include "dbus.h"
  38 #include "systray.h"
  39 #include "event.h"
  40 #include "property.h"
  41 #include "screen.h"
  42 #include "titlebar.h"
  43 #include "luaa.h"
  44 #include "common/version.h"
  45 #include "common/atoms.h"
  46 #include "common/xcursor.h"
  47 #include "common/xutil.h"
  48 #include "common/backtrace.h"
  49
  50 awesome_t globalconf;
  51
  52 typedef struct
  53 {
  54     xcb_window_t id;
  55     xcb_query_tree_cookie_t tree_cookie;
  56 } root_win_t;
  57
  58 /** Call before exiting.
  59  */
  60 void
  61 awesome_atexit(void)
  62 {
  63     int screen_nbr, nscreens;
  64
  65     if(globalconf.hooks.exit != LUA_REFNIL)
  66         luaA_dofunction_from_registry(globalconf.L, globalconf.hooks.exit, 0, 0);
  67
  68     a_dbus_cleanup();
  69
  70     /* reparent systray windows, otherwise they may die with their master */
  71     for(int i = 0; i < globalconf.embedded.len; i++)
  72     {
  73         xcb_screen_t *s = xutil_screen_get(globalconf.connection,
  74                                            globalconf.embedded.tab[i].phys_screen);
  75         xembed_window_unembed(globalconf.connection, globalconf.embedded.tab[i].win, s->root);
  76     }
  77
  78     /* do this only for real screen */
  79     const xcb_setup_t *setup = xcb_get_setup(globalconf.connection);
  80     nscreens = setup ? xcb_setup_roots_length(setup) : -1;
  81     for(screen_nbr = 0;
  82         screen_nbr < nscreens;
  83         screen_nbr++)
  84         systray_cleanup(screen_nbr);
  85
  86     /* remap all clients since some WM won't handle them otherwise */
  87     foreach(c, globalconf.clients)
  88     {
  89         client_unban(*c);
  90         titlebar_client_detach(*c);
  91     }
  92
  93     xcb_flush(globalconf.connection);
  94
  95     xcb_disconnect(globalconf.connection);
  96 }
  97
  98 /** Scan X to find windows to manage.
  99  */
 100 static void
 101 scan(void)
 102 {
 103     int i, phys_screen, tree_c_len;
 104     const int screen_max = xcb_setup_roots_length(xcb_get_setup(globalconf.connection));
 105     root_win_t root_wins[screen_max];
 106     xcb_query_tree_reply_t *tree_r;
 107     xcb_window_t *wins = NULL;
 108     xcb_get_window_attributes_reply_t *attr_r;
 109     xcb_get_geometry_reply_t *geom_r;
 110     long state;
 111
 112     for(phys_screen = 0; phys_screen < screen_max; phys_screen++)
 113     {
 114         /* Get the root window ID associated to this screen */
 115         root_wins[phys_screen].id = xutil_screen_get(globalconf.connection, phys_screen)->root;
 116
 117         /* Get the window tree associated to this screen */
 118         root_wins[phys_screen].tree_cookie = xcb_query_tree_unchecked(globalconf.connection,
 119                                                                       root_wins[phys_screen].id);
 120     }
 121
 122     for(phys_screen = 0; phys_screen < screen_max; phys_screen++)
 123     {
 124         tree_r = xcb_query_tree_reply(globalconf.connection,
 125                                       root_wins[phys_screen].tree_cookie,
 126                                       NULL);
 127
 128         if(!tree_r)
 129             continue;
 130
 131         /* Get the tree of the children windows of the current root window */
 132         if(!(wins = xcb_query_tree_children(tree_r)))
 133             fatal("cannot get tree children");
 134
 135         tree_c_len = xcb_query_tree_children_length(tree_r);
 136         xcb_get_window_attributes_cookie_t attr_wins[tree_c_len];
 137         xcb_get_property_cookie_t state_wins[tree_c_len];
 138
 139         for(i = 0; i < tree_c_len; i++)
 140         {
 141             attr_wins[i] = xcb_get_window_attributes_unchecked(globalconf.connection,
 142                                                                wins[i]);
 143
 144             state_wins[i] = window_state_get_unchecked(wins[i]);
 145         }
 146
 147         xcb_get_geometry_cookie_t *geom_wins[tree_c_len];
 148
 149         for(i = 0; i < tree_c_len; i++)
 150         {
 151             attr_r = xcb_get_window_attributes_reply(globalconf.connection,
 152                                                      attr_wins[i],
 153                                                      NULL);
 154
 155             state = window_state_get_reply(state_wins[i]);
 156
 157             if(!attr_r || attr_r->override_redirect
 158                || attr_r->map_state == XCB_MAP_STATE_UNVIEWABLE
 159                || state == XCB_WM_STATE_WITHDRAWN)
 160             {
 161                 geom_wins[i] = NULL;
 162                 p_delete(&attr_r);
 163                 continue;
 164             }
 165
 166             p_delete(&attr_r);
 167
 168             /* Get the geometry of the current window */
 169             geom_wins[i] = p_alloca(xcb_get_geometry_cookie_t, 1);
 170             *(geom_wins[i]) = xcb_get_geometry_unchecked(globalconf.connection, wins[i]);
 171         }
 172
 173         for(i = 0; i < tree_c_len; i++)
 174         {
 175             if(!geom_wins[i] || !(geom_r = xcb_get_geometry_reply(globalconf.connection,
 176                                                                   *(geom_wins[i]), NULL)))
 177                 continue;
 178
 179             /* The window can be mapped, so force it to be undrawn for startup */
 180             xcb_unmap_window(globalconf.connection, wins[i]);
 181
 182             client_manage(wins[i], geom_r, phys_screen, true);
 183
 184             p_delete(&geom_r);
 185         }
 186
 187         p_delete(&tree_r);
 188     }
 189 }
 190
 191 static void
 192 a_refresh_cb(EV_P_ ev_prepare *w, int revents)
 193 {
 194     awesome_refresh();
 195 }
 196
 197 static void
 198 a_xcb_check_cb(EV_P_ ev_check *w, int revents)
 199 {
 200     xcb_generic_event_t *mouse = NULL, *event;
 201
 202     while((event = xcb_poll_for_event(globalconf.connection)))
 203     {
 204         /* We will treat mouse events later.
 205          * We cannot afford to treat all mouse motion events,
 206          * because that would be too much CPU intensive, so we just
 207          * take the last we get after a bunch of events. */
 208         if(XCB_EVENT_RESPONSE_TYPE(event) == XCB_MOTION_NOTIFY)
 209         {
 210             p_delete(&mouse);
 211             mouse = event;
 212         }
 213         else
 214         {
 215             xcb_event_handle(&globalconf.evenths, event);
 216             p_delete(&event);
 217         }
 218     }
 219
 220     if(mouse)
 221     {
 222         xcb_event_handle(&globalconf.evenths, mouse);
 223         p_delete(&mouse);
 224     }
 225 }
 226
 227 static void
 228 a_xcb_io_cb(EV_P_ ev_io *w, int revents)
 229 {
 230     /* empty */
 231 }
 232
 233 /** Startup Error handler to check if another window manager
 234  * is already running.
 235  * \param data Additional optional parameters data.
 236  * \param c X connection.
 237  * \param error Error event.
 238  */
 239 static int __attribute__ ((noreturn))
 240 xerrorstart(void * data __attribute__ ((unused)),
 241             xcb_connection_t * c  __attribute__ ((unused)),
 242             xcb_generic_error_t * error __attribute__ ((unused)))
 243 {
 244     fatal("another window manager is already running");
 245 }
 246
 247 static void
 248 signal_fatal(int signum)
 249 {
 250     buffer_t buf;
 251     backtrace_get(&buf);
 252     fatal("dumping backtrace\n%s", buf.s);
 253 }
 254
 255 /** Function to exit on some signals.
 256  * \param w the signal received, unused
 257  * \param revents currently unused
 258  */
 259 static void
 260 exit_on_signal(EV_P_ ev_signal *w, int revents)
 261 {
 262     ev_unloop(EV_A_ 1);
 263 }
 264
 265 void
 266 awesome_restart(void)
 267 {
 268     awesome_atexit();
 269     a_exec(globalconf.argv);
 270 }
 271
 272 /** Function to restart aweome on some signals.
 273  * \param w the signam received, unused
 274  * \param revents Currently unused
 275  */
 276 static void
 277 restart_on_signal(EV_P_ ev_signal *w, int revents)
 278 {
 279     awesome_restart();
 280 }
 281
 282 /** \brief awesome xerror function.
 283  * There's no way to check accesses to destroyed windows, thus those cases are
 284  * ignored (especially on UnmapNotify's).  Other types of errors call Xlibs
 285  * default error handler, which may call exit.
 286  * \param data Currently unused.
 287  * \param c The connectiont to the X server.
 288  * \param e The error event.
 289  * \return 0 if no error, or xerror's xlib return status.
 290  */
 291 static int
 292 xerror(void *data __attribute__ ((unused)),
 293        xcb_connection_t *c __attribute__ ((unused)),
 294        xcb_generic_error_t *e)
 295 {
 296     /* ignore this */
 297     if(e->error_code == XCB_EVENT_ERROR_BAD_WINDOW
 298        || (e->error_code == XCB_EVENT_ERROR_BAD_MATCH
 299            && XCB_EVENT_REQUEST_TYPE(e) == XCB_SET_INPUT_FOCUS)
 300        || (e->error_code == XCB_EVENT_ERROR_BAD_VALUE
 301            && XCB_EVENT_REQUEST_TYPE(e) == XCB_KILL_CLIENT)
 302        || (XCB_EVENT_REQUEST_TYPE(e) == XCB_CONFIGURE_WINDOW
 303            && e->error_code == XCB_EVENT_ERROR_BAD_MATCH))
 304         return 0;
 305
 306     warn("X error: request=%s, error=%s",
 307          xcb_event_get_request_label(XCB_EVENT_REQUEST_TYPE(e)),
 308          xcb_event_get_error_label(e->error_code));
 309
 310     return 0;
 311 }
 312
 313 /** Print help and exit(2) with given exit_code.
 314  * \param exit_code The exit code.
 315  */
 316 static void __attribute__ ((noreturn))
 317 exit_help(int exit_code)
 318 {
 319     FILE *outfile = (exit_code == EXIT_SUCCESS) ? stdout : stderr;
 320     fprintf(outfile,
 321 "Usage: awesome [OPTION]\n\
 322   -h, --help             show help\n\
 323   -v, --version          show version\n\
 324   -c, --config FILE      configuration file to use\n\
 325   -k, --check            check configuration file syntax\n");
 326     exit(exit_code);
 327 }
 328
 329 /** Hello, this is main.
 330  * \param argc Who knows.
 331  * \param argv Who knows.
 332  * \return EXIT_SUCCESS I hope.
 333  */
 334 int
 335 main(int argc, char **argv)
 336 {
 337     const char *confpath = NULL;
 338     int xfd, i, screen_nbr, opt, colors_nbr;
 339     xcolor_init_request_t colors_reqs[2];
 340     ssize_t cmdlen = 1;
 341     xdgHandle xdg;
 342     static struct option long_options[] =
 343     {
 344         { "help",    0, NULL, 'h' },
 345         { "version", 0, NULL, 'v' },
 346         { "config",  1, NULL, 'c' },
 347         { "check",   0, NULL, 'k' },
 348         { NULL,      0, NULL, 0 }
 349     };
 350
 351     /* event loop watchers */
 352     ev_io xio    = { .fd = -1 };
 353     ev_check xcheck;
 354     ev_prepare a_refresh;
 355     ev_signal sigint;
 356     ev_signal sigterm;
 357     ev_signal sighup;
 358
 359     /* clear the globalconf structure */
 360     p_clear(&globalconf, 1);
 361     globalconf.keygrabber = LUA_REFNIL;
 362     globalconf.mousegrabber = LUA_REFNIL;
 363
 364     /* save argv */
 365     for(i = 0; i < argc; i++)
 366         cmdlen += a_strlen(argv[i]) + 1;
 367
 368     globalconf.argv = p_new(char, cmdlen);
 369     a_strcpy(globalconf.argv, cmdlen, argv[0]);
 370
 371     for(i = 1; i < argc; i++)
 372     {
 373         a_strcat(globalconf.argv, cmdlen, " ");
 374         a_strcat(globalconf.argv, cmdlen, argv[i]);
 375     }
 376
 377     /* Text won't be printed correctly otherwise */
 378     setlocale(LC_CTYPE, "");
 379
 380     /* Get XDG basedir data */
 381     xdgInitHandle(&xdg);
 382
 383     /* init lua */
 384     luaA_init(&xdg);
 385
 386     /* check args */
 387     while((opt = getopt_long(argc, argv, "vhkc:",
 388                              long_options, NULL)) != -1)
 389         switch(opt)
 390         {
 391           case 'v':
 392             eprint_version();
 393             break;
 394           case 'h':
 395             exit_help(EXIT_SUCCESS);
 396             break;
 397           case 'k':
 398             if(!luaA_parserc(&xdg, confpath, false))
 399             {
 400                 fprintf(stderr, "✘ Configuration file syntax error.\n");
 401                 return EXIT_FAILURE;
 402             }
 403             else
 404             {
 405                 fprintf(stderr, "✔ Configuration file syntax OK.\n");
 406                 return EXIT_SUCCESS;
 407             }
 408           case 'c':
 409             if(a_strlen(optarg))
 410                 confpath = a_strdup(optarg);
 411             else
 412                 fatal("-c option requires a file name");
 413             break;
 414         }
 415
 416     globalconf.loop = ev_default_loop(0);
 417     ev_timer_init(&globalconf.timer, &luaA_on_timer, 0., 0.);
 418
 419     /* register function for signals */
 420     ev_signal_init(&sigint, exit_on_signal, SIGINT);
 421     ev_signal_init(&sigterm, exit_on_signal, SIGTERM);
 422     ev_signal_init(&sighup, restart_on_signal, SIGHUP);
 423     ev_signal_start(globalconf.loop, &sigint);
 424     ev_signal_start(globalconf.loop, &sigterm);
 425     ev_signal_start(globalconf.loop, &sighup);
 426     ev_unref(globalconf.loop);
 427     ev_unref(globalconf.loop);
 428     ev_unref(globalconf.loop);
 429
 430     struct sigaction sa = { .sa_handler = signal_fatal, .sa_flags = 0 };
 431     sigemptyset(&sa.sa_mask);
 432     sigaction(SIGSEGV, &sa, 0);
 433
 434     /* X stuff */
 435     globalconf.connection = xcb_connect(NULL, &globalconf.default_screen);
 436     if(xcb_connection_has_error(globalconf.connection))
 437         fatal("cannot open display");
 438
 439     /* check for xtest extension */
 440     const xcb_query_extension_reply_t *xtest_query;
 441     xtest_query = xcb_get_extension_data(globalconf.connection, &xcb_test_id);
 442     globalconf.have_xtest = xtest_query->present;
 443
 444     /* initiliaze dbus */
 445     a_dbus_init();
 446
 447     /* Grab server */
 448     xcb_grab_server(globalconf.connection);
 449     xcb_flush(globalconf.connection);
 450
 451     /* Get the file descriptor corresponding to the X connection */
 452     xfd = xcb_get_file_descriptor(globalconf.connection);
 453     ev_io_init(&xio, &a_xcb_io_cb, xfd, EV_READ);
 454     ev_io_start(globalconf.loop, &xio);
 455     ev_check_init(&xcheck, &a_xcb_check_cb);
 456     ev_check_start(globalconf.loop, &xcheck);
 457     ev_unref(globalconf.loop);
 458     ev_prepare_init(&a_refresh, &a_refresh_cb);
 459     ev_prepare_start(globalconf.loop, &a_refresh);
 460     ev_unref(globalconf.loop);
 461
 462     /* Allocate a handler which will holds all errors and events */
 463     xcb_event_handlers_init(globalconf.connection, &globalconf.evenths);
 464     xutil_error_handler_catch_all_set(&globalconf.evenths, xerrorstart, NULL);
 465
 466     for(screen_nbr = 0;
 467         screen_nbr < xcb_setup_roots_length(xcb_get_setup(globalconf.connection));
 468         screen_nbr++)
 469     {
 470         const uint32_t select_input_val = XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT;
 471
 472         /* This causes an error if some other window manager is running */
 473         xcb_change_window_attributes(globalconf.connection,
 474                                      xutil_screen_get(globalconf.connection, screen_nbr)->root,
 475                                      XCB_CW_EVENT_MASK, &select_input_val);
 476     }
 477
 478     /* Need to xcb_flush to validate error handler */
 479     xcb_aux_sync(globalconf.connection);
 480
 481     /* Process all errors in the queue if any */
 482     xcb_event_poll_for_event_loop(&globalconf.evenths);
 483
 484     /* Set the default xerror handler */
 485     xutil_error_handler_catch_all_set(&globalconf.evenths, xerror, NULL);
 486
 487     /* Allocate the key symbols */
 488     globalconf.keysyms = xcb_key_symbols_alloc(globalconf.connection);
 489     xcb_get_modifier_mapping_cookie_t xmapping_cookie =
 490         xcb_get_modifier_mapping_unchecked(globalconf.connection);
 491
 492     /* init atom cache */
 493     atoms_init(globalconf.connection);
 494
 495     /* init screens information */
 496     screen_scan();
 497
 498     /* init default font and colors */
 499     colors_reqs[0] = xcolor_init_unchecked(&globalconf.colors.fg,
 500                                            "black", sizeof("black") - 1);
 501
 502     colors_reqs[1] = xcolor_init_unchecked(&globalconf.colors.bg,
 503                                            "white", sizeof("white") - 1);
 504
 505     globalconf.font = draw_font_new("sans 8");
 506
 507     for(colors_nbr = 0; colors_nbr < 2; colors_nbr++)
 508         xcolor_init_reply(colors_reqs[colors_nbr]);
 509
 510     xutil_lock_mask_get(globalconf.connection, xmapping_cookie,
 511                         globalconf.keysyms, &globalconf.numlockmask,
 512                         &globalconf.shiftlockmask, &globalconf.capslockmask,
 513                         &globalconf.modeswitchmask);
 514
 515     /* do this only for real screen */
 516     for(screen_nbr = 0;
 517         screen_nbr < xcb_setup_roots_length(xcb_get_setup(globalconf.connection));
 518         screen_nbr++)
 519     {
 520         /* select for events */
 521         const uint32_t change_win_vals[] =
 522         {
 523             XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT | XCB_EVENT_MASK_SUBSTRUCTURE_NOTIFY
 524                 | XCB_EVENT_MASK_ENTER_WINDOW | XCB_EVENT_MASK_LEAVE_WINDOW
 525                 | XCB_EVENT_MASK_STRUCTURE_NOTIFY
 526                 | XCB_EVENT_MASK_PROPERTY_CHANGE
 527                 | XCB_EVENT_MASK_BUTTON_PRESS
 528                 | XCB_EVENT_MASK_BUTTON_RELEASE
 529                 | XCB_EVENT_MASK_FOCUS_CHANGE
 530         };
 531
 532         xcb_change_window_attributes(globalconf.connection,
 533                                      xutil_screen_get(globalconf.connection, screen_nbr)->root,
 534                                      XCB_CW_EVENT_MASK,
 535                                      change_win_vals);
 536         ewmh_init(screen_nbr);
 537         systray_init(screen_nbr);
 538     }
 539
 540     /* init spawn (sn) */
 541     spawn_init();
 542
 543     /* Parse and run configuration file */
 544     if (!luaA_parserc(&xdg, confpath, true))
 545         fatal("couldn't find any rc file");
 546
 547     xdgWipeHandle(&xdg);
 548
 549     /* scan existing windows */
 550     scan();
 551
 552     /* process all errors in the queue if any */
 553     xcb_event_poll_for_event_loop(&globalconf.evenths);
 554     a_xcb_set_event_handlers();
 555     a_xcb_set_property_handlers();
 556
 557     /* we will receive events, stop grabbing server */
 558     xcb_ungrab_server(globalconf.connection);
 559     xcb_flush(globalconf.connection);
 560
 561     /* main event loop */
 562     ev_loop(globalconf.loop, 0);
 563
 564     /* cleanup event loop */
 565     ev_ref(globalconf.loop);
 566     ev_check_stop(globalconf.loop, &xcheck);
 567     ev_ref(globalconf.loop);
 568     ev_prepare_stop(globalconf.loop, &a_refresh);
 569     ev_ref(globalconf.loop);
 570     ev_io_stop(globalconf.loop, &xio);
 571
 572     /* Close Lua */
 573     lua_close(globalconf.L);
 574
 575     awesome_atexit();
 576
 577     return EXIT_SUCCESS;
 578 }
 579
 580 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80