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