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/bigreq.h>
  30 #include <xcb/randr.h>
  31 #include <xcb/xcb_event.h>
  32 #include <xcb/xinerama.h>
  33 #include <xcb/xtest.h>
  34
  35 #include "awesome.h"
  36 #include "spawn.h"
  37 #include "objects/client.h"
  38 #include "xwindow.h"
  39 #include "ewmh.h"
  40 #include "dbus.h"
  41 #include "systray.h"
  42 #include "event.h"
  43 #include "property.h"
  44 #include "screen.h"
  45 #include "luaa.h"
  46 #include "common/version.h"
  47 #include "common/atoms.h"
  48 #include "common/xcursor.h"
  49 #include "common/xutil.h"
  50 #include "common/backtrace.h"
  51
  52 awesome_t globalconf;
  53
  54 /** argv used to run awesome */
  55 static char *awesome_argv;
  56
  57 /** Call before exiting.
  58  */
  59 void
  60 awesome_atexit(void)
  61 {
  62     signal_object_emit(globalconf.L, &global_signals, "exit", 0);
  63
  64     a_dbus_cleanup();
  65
  66     systray_cleanup();
  67
  68     /* Close Lua */
  69     lua_close(globalconf.L);
  70
  71     xcb_flush(globalconf.connection);
  72
  73     /* Disconnect *after* closing lua */
  74     xcb_disconnect(globalconf.connection);
  75
  76     ev_default_destroy();
  77 }
  78
  79 /** Scan X to find windows to manage.
  80  */
  81 static void
  82 scan(void)
  83 {
  84     int i, tree_c_len;
  85     xcb_query_tree_cookie_t tree_c;
  86     xcb_query_tree_reply_t *tree_r;
  87     xcb_window_t *wins = NULL;
  88     xcb_get_window_attributes_reply_t *attr_r;
  89     xcb_get_geometry_reply_t *geom_r;
  90     long state;
  91
  92     /* Get the window tree associated to this screen */
  93     tree_c = xcb_query_tree_unchecked(globalconf.connection,
  94                                       globalconf.screen->root);
  95
  96     tree_r = xcb_query_tree_reply(globalconf.connection,
  97                                   tree_c,
  98                                   NULL);
  99
 100     if(!tree_r)
 101         return;
 102
 103     /* Get the tree of the children windows of the current root window */
 104     if(!(wins = xcb_query_tree_children(tree_r)))
 105         fatal("cannot get tree children");
 106
 107     tree_c_len = xcb_query_tree_children_length(tree_r);
 108     xcb_get_window_attributes_cookie_t attr_wins[tree_c_len];
 109     xcb_get_property_cookie_t state_wins[tree_c_len];
 110
 111     for(i = 0; i < tree_c_len; i++)
 112     {
 113         attr_wins[i] = xcb_get_window_attributes_unchecked(globalconf.connection,
 114                                                            wins[i]);
 115
 116         state_wins[i] = xwindow_get_state_unchecked(wins[i]);
 117     }
 118
 119     xcb_get_geometry_cookie_t *geom_wins[tree_c_len];
 120
 121     for(i = 0; i < tree_c_len; i++)
 122     {
 123         attr_r = xcb_get_window_attributes_reply(globalconf.connection,
 124                                                  attr_wins[i],
 125                                                  NULL);
 126
 127         state = xwindow_get_state_reply(state_wins[i]);
 128
 129         if(!attr_r || attr_r->override_redirect
 130            || attr_r->map_state == XCB_MAP_STATE_UNMAPPED
 131            || state == XCB_WM_STATE_WITHDRAWN)
 132         {
 133             geom_wins[i] = NULL;
 134             p_delete(&attr_r);
 135             continue;
 136         }
 137
 138         p_delete(&attr_r);
 139
 140         /* Get the geometry of the current window */
 141         geom_wins[i] = p_alloca(xcb_get_geometry_cookie_t, 1);
 142         *(geom_wins[i]) = xcb_get_geometry_unchecked(globalconf.connection, wins[i]);
 143     }
 144
 145     for(i = 0; i < tree_c_len; i++)
 146     {
 147         if(!geom_wins[i] || !(geom_r = xcb_get_geometry_reply(globalconf.connection,
 148                                                               *(geom_wins[i]), NULL)))
 149             continue;
 150
 151         client_manage(wins[i], geom_r, true);
 152
 153         p_delete(&geom_r);
 154     }
 155
 156     p_delete(&tree_r);
 157 }
 158
 159 static xcb_visualtype_t *
 160 a_default_visual(xcb_screen_t *s)
 161 {
 162     xcb_depth_iterator_t depth_iter = xcb_screen_allowed_depths_iterator(s);
 163
 164     if(depth_iter.data)
 165         for(; depth_iter.rem; xcb_depth_next (&depth_iter))
 166             for(xcb_visualtype_iterator_t visual_iter = xcb_depth_visuals_iterator(depth_iter.data);
 167                 visual_iter.rem; xcb_visualtype_next (&visual_iter))
 168                 if(s->root_visual == visual_iter.data->visual_id)
 169                     return visual_iter.data;
 170
 171     return NULL;
 172 }
 173
 174 static xcb_visualtype_t *
 175 a_argb_visual(xcb_screen_t *s)
 176 {
 177     xcb_depth_iterator_t depth_iter = xcb_screen_allowed_depths_iterator(s);
 178
 179     if(depth_iter.data)
 180         for(; depth_iter.rem; xcb_depth_next (&depth_iter))
 181             if(depth_iter.data->depth == 32)
 182                 for(xcb_visualtype_iterator_t visual_iter = xcb_depth_visuals_iterator(depth_iter.data);
 183                     visual_iter.rem; xcb_visualtype_next (&visual_iter))
 184                     return visual_iter.data;
 185
 186     return NULL;
 187 }
 188
 189 static uint8_t
 190 a_visual_depth(xcb_screen_t *s, xcb_visualid_t vis)
 191 {
 192     xcb_depth_iterator_t depth_iter = xcb_screen_allowed_depths_iterator(s);
 193
 194     if(depth_iter.data)
 195         for(; depth_iter.rem; xcb_depth_next (&depth_iter))
 196             for(xcb_visualtype_iterator_t visual_iter = xcb_depth_visuals_iterator(depth_iter.data);
 197                 visual_iter.rem; xcb_visualtype_next (&visual_iter))
 198                 if(vis == visual_iter.data->visual_id)
 199                     return depth_iter.data->depth;
 200
 201     fatal("Could not find a visual's depth");
 202 }
 203
 204 static void
 205 a_refresh_cb(EV_P_ ev_prepare *w, int revents)
 206 {
 207     awesome_refresh();
 208 }
 209
 210 static void
 211 a_xcb_check_cb(EV_P_ ev_check *w, int revents)
 212 {
 213     xcb_generic_event_t *mouse = NULL, *event;
 214
 215     while((event = xcb_poll_for_event(globalconf.connection)))
 216     {
 217         /* We will treat mouse events later.
 218          * We cannot afford to treat all mouse motion events,
 219          * because that would be too much CPU intensive, so we just
 220          * take the last we get after a bunch of events. */
 221         if(XCB_EVENT_RESPONSE_TYPE(event) == XCB_MOTION_NOTIFY)
 222         {
 223             p_delete(&mouse);
 224             mouse = event;
 225         }
 226         else
 227         {
 228             uint8_t type = XCB_EVENT_RESPONSE_TYPE(event);
 229             if((type == XCB_ENTER_NOTIFY || type == XCB_LEAVE_NOTIFY) && mouse)
 230             {
 231                 /* Make sure enter/motion/leave events are handled in the
 232                  * correct order */
 233                 event_handle(mouse);
 234                 p_delete(&mouse);
 235                 mouse = NULL;
 236             }
 237             event_handle(event);
 238             p_delete(&event);
 239         }
 240     }
 241
 242     if(mouse)
 243     {
 244         event_handle(mouse);
 245         p_delete(&mouse);
 246     }
 247 }
 248
 249 static void
 250 a_xcb_io_cb(EV_P_ ev_io *w, int revents)
 251 {
 252     /* empty */
 253 }
 254
 255 static void
 256 signal_fatal(int signum)
 257 {
 258     buffer_t buf;
 259     backtrace_get(&buf);
 260     fatal("dumping backtrace\n%s", buf.s);
 261 }
 262
 263 /** Function to exit on some signals.
 264  * \param w the signal received, unused
 265  * \param revents currently unused
 266  */
 267 static void
 268 exit_on_signal(EV_P_ ev_signal *w, int revents)
 269 {
 270     ev_unloop(EV_A_ 1);
 271 }
 272
 273 void
 274 awesome_restart(void)
 275 {
 276     awesome_atexit();
 277     a_exec(awesome_argv);
 278 }
 279
 280 /** Function to restart awesome on some signals.
 281  * \param w the signal received, unused
 282  * \param revents Currently unused
 283  */
 284 static void
 285 restart_on_signal(EV_P_ ev_signal *w, int revents)
 286 {
 287     awesome_restart();
 288 }
 289
 290 /** Print help and exit(2) with given exit_code.
 291  * \param exit_code The exit code.
 292  */
 293 static void __attribute__ ((noreturn))
 294 exit_help(int exit_code)
 295 {
 296     FILE *outfile = (exit_code == EXIT_SUCCESS) ? stdout : stderr;
 297     fprintf(outfile,
 298 "Usage: awesome [OPTION]\n\
 299   -h, --help             show help\n\
 300   -v, --version          show version\n\
 301   -c, --config FILE      configuration file to use\n\
 302   -k, --check            check configuration file syntax\n");
 303     exit(exit_code);
 304 }
 305
 306 /** Hello, this is main.
 307  * \param argc Who knows.
 308  * \param argv Who knows.
 309  * \return EXIT_SUCCESS I hope.
 310  */
 311 int
 312 main(int argc, char **argv)
 313 {
 314     char *confpath = NULL;
 315     int xfd, i, opt;
 316     ssize_t cmdlen = 1;
 317     xdgHandle xdg;
 318     bool no_argb = false;
 319     static struct option long_options[] =
 320     {
 321         { "help",    0, NULL, 'h' },
 322         { "version", 0, NULL, 'v' },
 323         { "config",  1, NULL, 'c' },
 324         { "check",   0, NULL, 'k' },
 325         { "no-argb", 0, NULL, 'a' },
 326         { NULL,      0, NULL, 0 }
 327     };
 328
 329     /* event loop watchers */
 330     ev_io xio    = { .fd = -1 };
 331     ev_check xcheck;
 332     ev_prepare a_refresh;
 333     ev_signal sigint;
 334     ev_signal sigterm;
 335     ev_signal sighup;
 336
 337     /* clear the globalconf structure */
 338     p_clear(&globalconf, 1);
 339     globalconf.keygrabber = LUA_REFNIL;
 340     globalconf.mousegrabber = LUA_REFNIL;
 341
 342     /* save argv */
 343     for(i = 0; i < argc; i++)
 344         cmdlen += a_strlen(argv[i]) + 1;
 345
 346     awesome_argv = p_new(char, cmdlen);
 347     a_strcpy(awesome_argv, cmdlen, argv[0]);
 348
 349     for(i = 1; i < argc; i++)
 350     {
 351         a_strcat(awesome_argv, cmdlen, " ");
 352         a_strcat(awesome_argv, cmdlen, argv[i]);
 353     }
 354
 355     /* Text won't be printed correctly otherwise */
 356     setlocale(LC_CTYPE, "");
 357
 358     /* Get XDG basedir data */
 359     xdgInitHandle(&xdg);
 360
 361     /* init lua */
 362     luaA_init(&xdg);
 363
 364     /* check args */
 365     while((opt = getopt_long(argc, argv, "vhkc:",
 366                              long_options, NULL)) != -1)
 367         switch(opt)
 368         {
 369           case 'v':
 370             eprint_version();
 371             break;
 372           case 'h':
 373             exit_help(EXIT_SUCCESS);
 374             break;
 375           case 'k':
 376             if(!luaA_parserc(&xdg, confpath, false))
 377             {
 378                 fprintf(stderr, "✘ Configuration file syntax error.\n");
 379                 return EXIT_FAILURE;
 380             }
 381             else
 382             {
 383                 fprintf(stderr, "✔ Configuration file syntax OK.\n");
 384                 return EXIT_SUCCESS;
 385             }
 386           case 'c':
 387             if(a_strlen(optarg))
 388                 confpath = a_strdup(optarg);
 389             else
 390                 fatal("-c option requires a file name");
 391             break;
 392           case 'a':
 393             no_argb = true;
 394             break;
 395         }
 396
 397     globalconf.loop = ev_default_loop(EVFLAG_NOSIGFD);
 398
 399     /* register function for signals */
 400     ev_signal_init(&sigint, exit_on_signal, SIGINT);
 401     ev_signal_init(&sigterm, exit_on_signal, SIGTERM);
 402     ev_signal_init(&sighup, restart_on_signal, SIGHUP);
 403     ev_signal_start(globalconf.loop, &sigint);
 404     ev_signal_start(globalconf.loop, &sigterm);
 405     ev_signal_start(globalconf.loop, &sighup);
 406     ev_unref(globalconf.loop);
 407     ev_unref(globalconf.loop);
 408     ev_unref(globalconf.loop);
 409
 410     struct sigaction sa = { .sa_handler = signal_fatal, .sa_flags = 0 };
 411     sigemptyset(&sa.sa_mask);
 412     sigaction(SIGSEGV, &sa, 0);
 413
 414     /* X stuff */
 415     globalconf.connection = xcb_connect(NULL, &globalconf.default_screen);
 416     if(xcb_connection_has_error(globalconf.connection))
 417         fatal("cannot open display");
 418
 419     globalconf.screen = xcb_aux_get_screen(globalconf.connection, globalconf.default_screen);
 420     /* FIXME The following two assignments were swapped on purpose */
 421     if(!no_argb)
 422         globalconf.visual = a_default_visual(globalconf.screen);
 423     if(!globalconf.visual)
 424         globalconf.visual = a_argb_visual(globalconf.screen);
 425     globalconf.default_depth = a_visual_depth(globalconf.screen, globalconf.visual->visual_id);
 426     globalconf.default_cmap = globalconf.screen->default_colormap;
 427     if(globalconf.default_depth != globalconf.screen->root_depth)
 428     {
 429         // We need our own color map if we aren't using the default depth
 430         globalconf.default_cmap = xcb_generate_id(globalconf.connection);
 431         xcb_create_colormap(globalconf.connection, XCB_COLORMAP_ALLOC_NONE,
 432                 globalconf.default_cmap, globalconf.screen->root,
 433                 globalconf.visual->visual_id);
 434     }
 435
 436     /* Prefetch all the extensions we might need */
 437     xcb_prefetch_extension_data(globalconf.connection, &xcb_big_requests_id);
 438     xcb_prefetch_extension_data(globalconf.connection, &xcb_test_id);
 439     xcb_prefetch_extension_data(globalconf.connection, &xcb_randr_id);
 440     xcb_prefetch_extension_data(globalconf.connection, &xcb_xinerama_id);
 441
 442     /* initialize dbus */
 443     a_dbus_init();
 444
 445     /* Grab server */
 446     xcb_grab_server(globalconf.connection);
 447     xcb_flush(globalconf.connection);
 448
 449     /* Get the file descriptor corresponding to the X connection */
 450     xfd = xcb_get_file_descriptor(globalconf.connection);
 451     ev_io_init(&xio, &a_xcb_io_cb, xfd, EV_READ);
 452     ev_io_start(globalconf.loop, &xio);
 453     ev_check_init(&xcheck, &a_xcb_check_cb);
 454     ev_check_start(globalconf.loop, &xcheck);
 455     ev_unref(globalconf.loop);
 456     ev_prepare_init(&a_refresh, &a_refresh_cb);
 457     ev_prepare_start(globalconf.loop, &a_refresh);
 458     ev_unref(globalconf.loop);
 459
 460     {
 461         const uint32_t select_input_val = XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT;
 462
 463         /* This causes an error if some other window manager is running */
 464         xcb_change_window_attributes(globalconf.connection,
 465                                      globalconf.screen->root,
 466                                      XCB_CW_EVENT_MASK, &select_input_val);
 467     }
 468
 469     /* Need to xcb_flush to validate error handler */
 470     xcb_aux_sync(globalconf.connection);
 471
 472     /* Process all errors in the queue if any. There can be no events yet, so if
 473      * this function returns something, it must be an error. */
 474     if (xcb_poll_for_event(globalconf.connection) != NULL)
 475         fatal("another window manager is already running");
 476
 477     /* Prefetch the maximum request length */
 478     xcb_prefetch_maximum_request_length(globalconf.connection);
 479
 480     /* check for xtest extension */
 481     const xcb_query_extension_reply_t *xtest_query;
 482     xtest_query = xcb_get_extension_data(globalconf.connection, &xcb_test_id);
 483     globalconf.have_xtest = xtest_query->present;
 484
 485     /* Allocate the key symbols */
 486     globalconf.keysyms = xcb_key_symbols_alloc(globalconf.connection);
 487     xcb_get_modifier_mapping_cookie_t xmapping_cookie =
 488         xcb_get_modifier_mapping_unchecked(globalconf.connection);
 489
 490     /* init atom cache */
 491     atoms_init(globalconf.connection);
 492
 493     /* init screens information */
 494     screen_scan();
 495
 496     xutil_lock_mask_get(globalconf.connection, xmapping_cookie,
 497                         globalconf.keysyms, &globalconf.numlockmask,
 498                         &globalconf.shiftlockmask, &globalconf.capslockmask,
 499                         &globalconf.modeswitchmask);
 500
 501     /* do this only for real screen */
 502     ewmh_init();
 503     systray_init();
 504
 505     /* init spawn (sn) */
 506     spawn_init();
 507
 508     /* The default GC is just a newly created associated with a window with
 509      * depth globalconf.default_depth */
 510     xcb_window_t tmp_win = xcb_generate_id(globalconf.connection);
 511     globalconf.gc = xcb_generate_id(globalconf.connection);
 512     xcb_create_window(globalconf.connection, globalconf.default_depth,
 513                       tmp_win, globalconf.screen->root,
 514                       -1, -1, 1, 1, 0,
 515                       XCB_COPY_FROM_PARENT, globalconf.visual->visual_id,
 516                       XCB_CW_BACK_PIXEL | XCB_CW_BORDER_PIXEL | XCB_CW_COLORMAP,
 517                       (const uint32_t [])
 518                       {
 519                           globalconf.screen->black_pixel,
 520                           globalconf.screen->black_pixel,
 521                           globalconf.default_cmap
 522                       });
 523     xcb_create_gc(globalconf.connection, globalconf.gc, tmp_win, XCB_GC_FOREGROUND | XCB_GC_BACKGROUND,
 524                   (const uint32_t[]) { globalconf.screen->black_pixel, globalconf.screen->white_pixel });
 525     xcb_destroy_window(globalconf.connection, tmp_win);
 526
 527     /* Parse and run configuration file */
 528     if (!luaA_parserc(&xdg, confpath, true))
 529         fatal("couldn't find any rc file");
 530
 531     p_delete(&confpath);
 532
 533     xdgWipeHandle(&xdg);
 534
 535     /* scan existing windows */
 536     scan();
 537
 538     {
 539         /* select for events */
 540         const uint32_t change_win_vals[] =
 541         {
 542             XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT | XCB_EVENT_MASK_SUBSTRUCTURE_NOTIFY
 543                 | XCB_EVENT_MASK_ENTER_WINDOW | XCB_EVENT_MASK_LEAVE_WINDOW
 544                 | XCB_EVENT_MASK_STRUCTURE_NOTIFY
 545                 | XCB_EVENT_MASK_BUTTON_PRESS
 546                 | XCB_EVENT_MASK_BUTTON_RELEASE
 547                 | XCB_EVENT_MASK_FOCUS_CHANGE
 548         };
 549
 550         xcb_change_window_attributes(globalconf.connection,
 551                                      globalconf.screen->root,
 552                                      XCB_CW_EVENT_MASK,
 553                                      change_win_vals);
 554     }
 555
 556     /* we will receive events, stop grabbing server */
 557     xcb_ungrab_server(globalconf.connection);
 558     xcb_flush(globalconf.connection);
 559
 560     /* main event loop */
 561     ev_loop(globalconf.loop, 0);
 562
 563     /* cleanup event loop */
 564     ev_ref(globalconf.loop);
 565     ev_check_stop(globalconf.loop, &xcheck);
 566     ev_ref(globalconf.loop);
 567     ev_prepare_stop(globalconf.loop, &a_refresh);
 568     ev_ref(globalconf.loop);
 569     ev_io_stop(globalconf.loop, &xio);
 570
 571     awesome_atexit();
 572
 573     return EXIT_SUCCESS;
 574 }
 575
 576 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80