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