ewmh.c

   1 /*
   2  * ewmh.c - EWMH support 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 <sys/types.h>
  23 #include <unistd.h>
  24
  25 #include <xcb/xcb.h>
  26 #include <xcb/xcb_atom.h>
  27
  28 #include "ewmh.h"
  29 #include "tag.h"
  30 #include "screen.h"
  31 #include "client.h"
  32 #include "widget.h"
  33 #include "cnode.h"
  34 #include "titlebar.h"
  35 #include "common/atoms.h"
  36
  37 extern awesome_t globalconf;
  38
  39 #define _NET_WM_STATE_REMOVE 0
  40 #define _NET_WM_STATE_ADD 1
  41 #define _NET_WM_STATE_TOGGLE 2
  42
  43 void
  44 ewmh_init(int phys_screen)
  45 {
  46     xcb_window_t father;
  47     xcb_screen_t *xscreen = xutil_screen_get(globalconf.connection, phys_screen);
  48     xcb_atom_t atom[] =
  49     {
  50         _NET_SUPPORTED,
  51         _NET_SUPPORTING_WM_CHECK,
  52         _NET_CLIENT_LIST,
  53         _NET_CLIENT_LIST_STACKING,
  54         _NET_NUMBER_OF_DESKTOPS,
  55         _NET_CURRENT_DESKTOP,
  56         _NET_DESKTOP_NAMES,
  57         _NET_ACTIVE_WINDOW,
  58         _NET_WORKAREA,
  59         _NET_CLOSE_WINDOW,
  60         _NET_WM_NAME,
  61         _NET_WM_ICON_NAME,
  62         _NET_WM_VISIBLE_ICON_NAME,
  63         _NET_WM_DESKTOP,
  64         _NET_WM_WINDOW_TYPE,
  65         _NET_WM_WINDOW_TYPE_NORMAL,
  66         _NET_WM_WINDOW_TYPE_DESKTOP,
  67         _NET_WM_WINDOW_TYPE_DOCK,
  68         _NET_WM_WINDOW_TYPE_SPLASH,
  69         _NET_WM_WINDOW_TYPE_DIALOG,
  70         _NET_WM_ICON,
  71         _NET_WM_PID,
  72         _NET_WM_STATE,
  73         _NET_WM_STATE_STICKY,
  74         _NET_WM_STATE_SKIP_TASKBAR,
  75         _NET_WM_STATE_FULLSCREEN,
  76         _NET_WM_STATE_ABOVE,
  77         _NET_WM_STATE_BELOW,
  78         _NET_WM_STATE_MODAL,
  79         _NET_WM_STATE_HIDDEN,
  80         _NET_WM_STATE_DEMANDS_ATTENTION
  81     };
  82     int i;
  83
  84     xcb_change_property(globalconf.connection, XCB_PROP_MODE_REPLACE,
  85                         xscreen->root, _NET_SUPPORTED, ATOM, 32,
  86                         countof(atom), atom);
  87
  88     /* create our own window */
  89     father = xcb_generate_id(globalconf.connection);
  90     xcb_create_window(globalconf.connection, xscreen->root_depth,
  91                       father, xscreen->root, -1, -1, 1, 1, 0,
  92                       XCB_COPY_FROM_PARENT, xscreen->root_visual, 0, NULL);
  93
  94     xcb_change_property(globalconf.connection, XCB_PROP_MODE_REPLACE,
  95                         xscreen->root, _NET_SUPPORTING_WM_CHECK, WINDOW, 32,
  96                         1, &father);
  97
  98     xcb_change_property(globalconf.connection, XCB_PROP_MODE_REPLACE,
  99                         father, _NET_SUPPORTING_WM_CHECK, WINDOW, 32,
 100                         1, &father);
 101
 102     /* set the window manager name */
 103     xcb_change_property(globalconf.connection, XCB_PROP_MODE_REPLACE,
 104                         father, _NET_WM_NAME, UTF8_STRING, 8, 7, "awesome");
 105
 106     /* set the window manager PID */
 107     i = getpid();
 108     xcb_change_property(globalconf.connection, XCB_PROP_MODE_REPLACE,
 109                         father, _NET_WM_PID, CARDINAL, 32, 1, &i);
 110 }
 111
 112 void
 113 ewmh_update_net_client_list(int phys_screen)
 114 {
 115     xcb_window_t *wins;
 116     client_t *c;
 117     int n = 0;
 118
 119     for(c = globalconf.clients; c; c = c->next)
 120         n++;
 121
 122     wins = p_new(xcb_window_t, n);
 123
 124     for(n = 0, c = globalconf.clients; c; c = c->next, n++)
 125         if(c->phys_screen == phys_screen)
 126             wins[n] = c->win;
 127
 128     xcb_change_property(globalconf.connection, XCB_PROP_MODE_REPLACE,
 129                         xutil_screen_get(globalconf.connection, phys_screen)->root,
 130                         _NET_CLIENT_LIST, WINDOW, 32, n, wins);
 131
 132     p_delete(&wins);
 133 }
 134
 135 /** Set the client list in stacking order, bottom to top.
 136  * \param phys_screen The physical screen id.
 137  */
 138 void
 139 ewmh_update_net_client_list_stacking(int phys_screen)
 140 {
 141     xcb_window_t *wins;
 142     client_node_t *c;
 143     int n = 0;
 144
 145     for(c = globalconf.stack; c; c = c->next)
 146         n++;
 147
 148     wins = p_new(xcb_window_t, n);
 149
 150     for(n = 0, c = *client_node_list_last(&globalconf.stack); c; c = c->prev, n++)
 151         if(c->client->phys_screen == phys_screen)
 152             wins[n] = c->client->win;
 153
 154     xcb_change_property(globalconf.connection, XCB_PROP_MODE_REPLACE,
 155                         xutil_screen_get(globalconf.connection, phys_screen)->root,
 156                         _NET_CLIENT_LIST_STACKING, WINDOW, 32, n, wins);
 157
 158     p_delete(&wins);
 159 }
 160
 161 void
 162 ewmh_update_net_numbers_of_desktop(int phys_screen)
 163 {
 164     uint32_t count = globalconf.screens[phys_screen].tags.len;
 165
 166     xcb_change_property(globalconf.connection, XCB_PROP_MODE_REPLACE,
 167                         xutil_screen_get(globalconf.connection, phys_screen)->root,
 168                         _NET_NUMBER_OF_DESKTOPS, CARDINAL, 32, 1, &count);
 169 }
 170
 171 void
 172 ewmh_update_net_current_desktop(int phys_screen)
 173 {
 174     tag_array_t *tags = &globalconf.screens[phys_screen].tags;
 175     uint32_t count = 0;
 176     tag_t **curtags = tags_get_current(phys_screen);
 177
 178     for(count = 0; tags->tab[count] != curtags[0]; count++);
 179
 180     xcb_change_property(globalconf.connection, XCB_PROP_MODE_REPLACE,
 181                         xutil_screen_get(globalconf.connection, phys_screen)->root,
 182                         _NET_CURRENT_DESKTOP, CARDINAL, 32, 1, &count);
 183
 184     p_delete(&curtags);
 185 }
 186
 187 void
 188 ewmh_update_net_desktop_names(int phys_screen)
 189 {
 190     tag_array_t *tags = &globalconf.screens[phys_screen].tags;
 191     buffer_t buf;
 192
 193     buffer_inita(&buf, BUFSIZ);
 194
 195     for(int i = 0; i < tags->len; i++)
 196     {
 197         buffer_adds(&buf, tags->tab[i]->name);
 198         buffer_addc(&buf, '\0');
 199     }
 200
 201     xcb_change_property(globalconf.connection, XCB_PROP_MODE_REPLACE,
 202                         xutil_screen_get(globalconf.connection, phys_screen)->root,
 203                         _NET_DESKTOP_NAMES, UTF8_STRING, 8, buf.len, buf.s);
 204     buffer_wipe(&buf);
 205 }
 206
 207 /** Update the work area space for each physical screen and each desktop.
 208  * \param phys_screen The physical screen id.
 209  */
 210 void
 211 ewmh_update_workarea(int phys_screen)
 212 {
 213     tag_array_t *tags = &globalconf.screens[phys_screen].tags;
 214     uint32_t *area = p_alloca(uint32_t, tags->len * 4);
 215     area_t geom = screen_area_get(phys_screen,
 216                                   globalconf.screens[phys_screen].statusbar,
 217                                   &globalconf.screens[phys_screen].padding);
 218
 219
 220     for(int i = 0; i < tags->len; i++)
 221     {
 222         area[4 * i + 0] = geom.x;
 223         area[4 * i + 1] = geom.y;
 224         area[4 * i + 2] = geom.width;
 225         area[4 * i + 3] = geom.height;
 226     }
 227
 228     xcb_change_property(globalconf.connection, XCB_PROP_MODE_REPLACE,
 229                         xutil_screen_get(globalconf.connection, phys_screen)->root,
 230                         _NET_WORKAREA, CARDINAL, 32, tags->len * 4, area);
 231 }
 232
 233 void
 234 ewmh_update_net_active_window(int phys_screen)
 235 {
 236     xcb_window_t win;
 237
 238     if(globalconf.screen_focus->client_focus
 239        && globalconf.screen_focus->client_focus->phys_screen == phys_screen)
 240         win = globalconf.screen_focus->client_focus->win;
 241     else
 242         win = XCB_NONE;
 243
 244     xcb_change_property(globalconf.connection, XCB_PROP_MODE_REPLACE,
 245                         xutil_screen_get(globalconf.connection, phys_screen)->root,
 246                         _NET_ACTIVE_WINDOW, WINDOW, 32, 1, &win);
 247 }
 248
 249 static void
 250 ewmh_process_state_atom(client_t *c, xcb_atom_t state, int set)
 251 {
 252     if(state == _NET_WM_STATE_STICKY)
 253     {
 254         tag_array_t *tags = &globalconf.screens[c->screen].tags;
 255         for(int i = 0; i < tags->len; i++)
 256             tag_client(c, tags->tab[i]);
 257     }
 258     else if(state == _NET_WM_STATE_SKIP_TASKBAR)
 259     {
 260         if(set == _NET_WM_STATE_REMOVE)
 261         {
 262             c->skiptb = false;
 263             c->skip = false;
 264         }
 265         else if(set == _NET_WM_STATE_ADD)
 266         {
 267             c->skiptb = true;
 268             c->skip = true;
 269         }
 270     }
 271     else if(state == _NET_WM_STATE_FULLSCREEN)
 272     {
 273         area_t geometry = c->geometry;
 274         if(set == _NET_WM_STATE_REMOVE)
 275         {
 276             /* restore geometry */
 277             geometry = c->m_geometry;
 278             /* restore borders and titlebar */
 279             if(c->titlebar && c->titlebar->sw && (c->titlebar->position = c->titlebar->oldposition))
 280                 xcb_map_window(globalconf.connection, c->titlebar->sw->window);
 281             c->noborder = false;
 282             c->ismax = false;
 283             client_setlayer(c, c->oldlayer);
 284             client_setborder(c, c->oldborder);
 285             client_setfloating(c, c->wasfloating);
 286         }
 287         else if(set == _NET_WM_STATE_ADD)
 288         {
 289             geometry = screen_area_get(c->screen, NULL, &globalconf.screens[c->screen].padding);
 290             /* save geometry */
 291             c->m_geometry = c->geometry;
 292             c->wasfloating = c->isfloating;
 293             /* disable titlebar and borders */
 294             if(c->titlebar && c->titlebar->sw && (c->titlebar->oldposition = c->titlebar->position))
 295             {
 296                 xcb_unmap_window(globalconf.connection, c->titlebar->sw->window);
 297                 c->titlebar->position = Off;
 298             }
 299             c->ismax = true;
 300             c->oldborder = c->border;
 301             client_setborder(c, 0);
 302             c->noborder = true;
 303             c->oldlayer = c->layer;
 304             client_setlayer(c, LAYER_FULLSCREEN);
 305             client_setfloating(c, true);
 306         }
 307         widget_invalidate_cache(c->screen, WIDGET_CACHE_CLIENTS);
 308         client_resize(c, geometry, false);
 309     }
 310     else if(state == _NET_WM_STATE_ABOVE)
 311     {
 312         if(set == _NET_WM_STATE_REMOVE)
 313             client_setlayer(c, c->oldlayer);
 314         else if(set == _NET_WM_STATE_ADD)
 315         {
 316             c->oldlayer = c->layer;
 317             client_setlayer(c, LAYER_ABOVE);
 318         }
 319     }
 320     else if(state == _NET_WM_STATE_BELOW)
 321     {
 322         if(set == _NET_WM_STATE_REMOVE)
 323             client_setlayer(c, c->oldlayer);
 324         else if(set == _NET_WM_STATE_ADD)
 325         {
 326             c->oldlayer = c->layer;
 327             client_setlayer(c, LAYER_BELOW);
 328         }
 329     }
 330     else if(state == _NET_WM_STATE_MODAL)
 331     {
 332         if(set == _NET_WM_STATE_REMOVE)
 333             client_setlayer(c, c->oldlayer);
 334         else if(set == _NET_WM_STATE_ADD)
 335         {
 336             c->oldlayer = c->layer;
 337             client_setlayer(c, LAYER_MODAL);
 338         }
 339     }
 340     else if(state == _NET_WM_STATE_HIDDEN)
 341     {
 342         if(set == _NET_WM_STATE_REMOVE)
 343             c->ishidden = false;
 344         else if(set == _NET_WM_STATE_ADD)
 345             c->ishidden = true;
 346         globalconf.screens[c->screen].need_arrange = true;
 347     }
 348     else if(state == _NET_WM_STATE_DEMANDS_ATTENTION)
 349     {
 350         if(set == _NET_WM_STATE_REMOVE)
 351             c->isurgent = false;
 352         else if(set == _NET_WM_STATE_ADD)
 353         {
 354             c->isurgent = true;
 355             /* execute hook */
 356             luaA_client_userdata_new(globalconf.L, c);
 357             luaA_dofunction(globalconf.L, globalconf.hooks.urgent, 1, 0);
 358             widget_invalidate_cache(c->screen, WIDGET_CACHE_CLIENTS);
 359         }
 360     }
 361 }
 362
 363 static void
 364 ewmh_process_window_type_atom(client_t *c, xcb_atom_t state)
 365 {
 366     if(state == _NET_WM_WINDOW_TYPE_NORMAL)
 367     {
 368         /* do nothing. this is REALLY IMPORTANT */
 369     }
 370     else if(state == _NET_WM_WINDOW_TYPE_DOCK
 371             || state == _NET_WM_WINDOW_TYPE_SPLASH)
 372     {
 373         c->skip = true;
 374         c->isfixed = true;
 375         if(c->titlebar && c->titlebar->position && c->titlebar->sw)
 376         {
 377             xcb_unmap_window(globalconf.connection, c->titlebar->sw->window);
 378             c->titlebar->position = Off;
 379         }
 380         client_setborder(c, 0);
 381         c->noborder = true;
 382         client_setlayer(c, LAYER_ABOVE);
 383         client_setfloating(c, true);
 384     }
 385     else if(state == _NET_WM_WINDOW_TYPE_DIALOG)
 386     {
 387         client_setlayer(c, LAYER_MODAL);
 388         client_setfloating(c, true);
 389     }
 390     else if(state == _NET_WM_WINDOW_TYPE_DESKTOP)
 391     {
 392         tag_array_t *tags = &globalconf.screens[c->screen].tags;
 393         c->noborder = true;
 394         c->isfixed = true;
 395         c->skip = true;
 396         client_setlayer(c, LAYER_DESKTOP);
 397         for(int i = 0; i < tags->len; i++)
 398             tag_client(c, tags->tab[i]);
 399     }
 400 }
 401
 402 int
 403 ewmh_process_client_message(xcb_client_message_event_t *ev)
 404 {
 405     client_t *c;
 406     int screen;
 407
 408     if(ev->type == _NET_CURRENT_DESKTOP)
 409         for(screen = 0;
 410             screen < xcb_setup_roots_length(xcb_get_setup(globalconf.connection));
 411             screen++)
 412         {
 413             if(ev->window == xutil_screen_get(globalconf.connection, screen)->root)
 414                 tag_view_only_byindex(screen, ev->data.data32[0]);
 415         }
 416     else if(ev->type == _NET_CLOSE_WINDOW)
 417     {
 418         if((c = client_getbywin(ev->window)))
 419            client_kill(c);
 420     }
 421     else if(ev->type == _NET_WM_DESKTOP)
 422     {
 423         if((c = client_getbywin(ev->window)))
 424         {
 425             tag_array_t *tags = &globalconf.screens[c->screen].tags;
 426
 427             if(ev->data.data32[0] == 0xffffffff)
 428                 for(int i = 0; i < tags->len; i++)
 429                     tag_client(c, tags->tab[i]);
 430             else
 431                 for(int i = 0; i < tags->len; i++)
 432                     if((int)ev->data.data32[0] == i)
 433                         tag_client(c, tags->tab[i]);
 434                     else
 435                         untag_client(c, tags->tab[i]);
 436         }
 437     }
 438     else if(ev->type == _NET_WM_STATE)
 439     {
 440         if((c = client_getbywin(ev->window)))
 441         {
 442             ewmh_process_state_atom(c, (xcb_atom_t) ev->data.data32[1], ev->data.data32[0]);
 443             if(ev->data.data32[2])
 444                 ewmh_process_state_atom(c, (xcb_atom_t) ev->data.data32[2],
 445                                         ev->data.data32[0]);
 446         }
 447     }
 448
 449     return 0;
 450 }
 451
 452 void
 453 ewmh_check_client_hints(client_t *c)
 454 {
 455     xcb_atom_t *state;
 456     void *data = NULL;
 457     int desktop;
 458     xcb_get_property_cookie_t c0, c1, c2;
 459     xcb_get_property_reply_t *reply;
 460
 461     /* Send the GetProperty requests which will be processed later */
 462     c0 = xcb_get_property_unchecked(globalconf.connection, false, c->win,
 463                                     _NET_WM_DESKTOP, XCB_GET_PROPERTY_TYPE_ANY, 0, 1);
 464
 465     c1 = xcb_get_property_unchecked(globalconf.connection, false, c->win,
 466                                     _NET_WM_STATE, ATOM, 0, UINT32_MAX);
 467
 468     c2 = xcb_get_property_unchecked(globalconf.connection, false, c->win,
 469                                     _NET_WM_WINDOW_TYPE, ATOM, 0, UINT32_MAX);
 470
 471     reply = xcb_get_property_reply(globalconf.connection, c0, NULL);
 472     if(reply && reply->value_len && (data = xcb_get_property_value(reply)))
 473     {
 474         tag_array_t *tags = &globalconf.screens[c->screen].tags;
 475
 476         desktop = *(uint32_t *) data;
 477         if(desktop == -1)
 478             for(int i = 0; i < tags->len; i++)
 479                 tag_client(c, tags->tab[i]);
 480         else
 481             for(int i = 0; i < tags->len; i++)
 482                 if(desktop == i)
 483                     tag_client(c, tags->tab[i]);
 484                 else
 485                     untag_client(c, tags->tab[i]);
 486     }
 487
 488     p_delete(&reply);
 489
 490     reply = xcb_get_property_reply(globalconf.connection, c1, NULL);
 491     if(reply && (data = xcb_get_property_value(reply)))
 492     {
 493         state = (xcb_atom_t *) data;
 494         for(int i = 0; i < xcb_get_property_value_length(reply); i++)
 495             ewmh_process_state_atom(c, state[i], _NET_WM_STATE_ADD);
 496     }
 497
 498     p_delete(&reply);
 499
 500     reply = xcb_get_property_reply(globalconf.connection, c2, NULL);
 501     if(reply && (data = xcb_get_property_value(reply)))
 502     {
 503         state = (xcb_atom_t *) data;
 504         for(int i = 0; i < xcb_get_property_value_length(reply); i++)
 505             ewmh_process_window_type_atom(c, state[i]);
 506     }
 507
 508     p_delete(&reply);
 509 }
 510
 511 /** Get NET_WM_ICON.
 512  * \param w The window.
 513  * \return A netwm_icon_t structure which must be deleted after usage.
 514  */
 515 netwm_icon_t *
 516 ewmh_get_window_icon(xcb_window_t w)
 517 {
 518     double alpha;
 519     netwm_icon_t *icon;
 520     int size, i;
 521     uint32_t *data;
 522     unsigned char *imgdata;
 523     xcb_get_property_reply_t *r;
 524
 525     r = xcb_get_property_reply(globalconf.connection,
 526                                xcb_get_property_unchecked(globalconf.connection, false, w,
 527                                                           _NET_WM_ICON, CARDINAL, 0, UINT32_MAX),
 528                                NULL);
 529     if(!r || r->type != CARDINAL || r->format != 32 || r->length < 2 ||
 530        !(data = (uint32_t *) xcb_get_property_value(r)))
 531     {
 532         p_delete(&r);
 533         return NULL;
 534     }
 535
 536     icon = p_new(netwm_icon_t, 1);
 537
 538     icon->width = data[0];
 539     icon->height = data[1];
 540     size = icon->width * icon->height;
 541
 542     if(!size)
 543     {
 544         p_delete(&icon);
 545         p_delete(&r);
 546         return NULL;
 547     }
 548
 549     icon->image = p_new(unsigned char, size * 4);
 550     for(imgdata = icon->image, i = 2; i < size + 2; i++, imgdata += 4)
 551     {
 552         imgdata[3] = (data[i] >> 24) & 0xff;           /* A */
 553         alpha = imgdata[3] / 255.0;
 554         imgdata[2] = ((data[i] >> 16) & 0xff) * alpha; /* R */
 555         imgdata[1] = ((data[i] >>  8) & 0xff) * alpha; /* G */
 556         imgdata[0] = (data[i]         & 0xff) * alpha; /* B */
 557     }
 558
 559     p_delete(&r);
 560
 561     return icon;
 562 }
 563
 564 /**
 565  * Restart awesome.
 566  */
 567 void
 568 ewmh_restart(void)
 569 {
 570     client_t *c;
 571
 572     for(c = globalconf.clients; c; c = c->next)
 573         client_unban(c);
 574
 575     xcb_aux_sync(globalconf.connection);
 576     xcb_disconnect(globalconf.connection);
 577
 578     a_exec(globalconf.argv);
 579 }
 580
 581 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80