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