property.c

   1 /*
   2  * property.c - property handlers
   3  *
   4  * Copyright © 2008-2009 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 <xcb/xcb_atom.h>
  23
  24 #include "screen.h"
  25 #include "property.h"
  26 #include "objects/client.h"
  27 #include "ewmh.h"
  28 #include "objects/drawin.h"
  29 #include "xwindow.h"
  30 #include "luaa.h"
  31 #include "common/atoms.h"
  32 #include "common/xutil.h"
  33
  34 #define HANDLE_TEXT_PROPERTY(funcname, atom, setfunc) \
  35     xcb_get_property_cookie_t \
  36     property_get_##funcname(client_t *c) \
  37     { \
  38         return xcb_get_property(globalconf.connection, \
  39                                 false, \
  40                                 c->window, \
  41                                 atom, \
  42                                 XCB_GET_PROPERTY_TYPE_ANY, \
  43                                 0, \
  44                                 UINT_MAX); \
  45     } \
  46     void \
  47     property_update_##funcname(client_t *c, xcb_get_property_cookie_t cookie) \
  48     { \
  49         xcb_get_property_reply_t * reply = \
  50                     xcb_get_property_reply(globalconf.connection, cookie, NULL); \
  51         luaA_object_push(globalconf.L, c); \
  52         setfunc(globalconf.L, -1, xutil_get_text_property_from_reply(reply)); \
  53         lua_pop(globalconf.L, 1); \
  54         p_delete(&reply); \
  55     } \
  56     static int \
  57     property_handle_##funcname(uint8_t state, \
  58                                xcb_window_t window) \
  59     { \
  60         client_t *c = client_getbywin(window); \
  61         if(c) \
  62             property_update_##funcname(c, property_get_##funcname(c));\
  63         return 0; \
  64     }
  65
  66
  67 HANDLE_TEXT_PROPERTY(wm_name, XCB_ATOM_WM_NAME, client_set_alt_name)
  68 HANDLE_TEXT_PROPERTY(net_wm_name, _NET_WM_NAME, client_set_name)
  69 HANDLE_TEXT_PROPERTY(wm_icon_name, XCB_ATOM_WM_ICON_NAME, client_set_alt_icon_name)
  70 HANDLE_TEXT_PROPERTY(net_wm_icon_name, _NET_WM_ICON_NAME, client_set_icon_name)
  71 HANDLE_TEXT_PROPERTY(wm_client_machine, XCB_ATOM_WM_CLIENT_MACHINE, client_set_machine)
  72 HANDLE_TEXT_PROPERTY(wm_window_role, WM_WINDOW_ROLE, client_set_role)
  73
  74 #undef HANDLE_TEXT_PROPERTY
  75
  76 #define HANDLE_PROPERTY(name) \
  77     static int \
  78     property_handle_##name(uint8_t state, \
  79                            xcb_window_t window) \
  80     { \
  81         client_t *c = client_getbywin(window); \
  82         if(c) \
  83             property_update_##name(c, property_get_##name(c));\
  84         return 0; \
  85     }
  86
  87 HANDLE_PROPERTY(wm_protocols)
  88 HANDLE_PROPERTY(wm_transient_for)
  89 HANDLE_PROPERTY(wm_client_leader)
  90 HANDLE_PROPERTY(wm_normal_hints)
  91 HANDLE_PROPERTY(wm_hints)
  92 HANDLE_PROPERTY(wm_class)
  93 HANDLE_PROPERTY(net_wm_icon)
  94 HANDLE_PROPERTY(net_wm_pid)
  95
  96 #undef HANDLE_PROPERTY
  97
  98 xcb_get_property_cookie_t
  99 property_get_wm_transient_for(client_t *c)
 100 {
 101     return xcb_icccm_get_wm_transient_for_unchecked(globalconf.connection, c->window);
 102 }
 103
 104 void
 105 property_update_wm_transient_for(client_t *c, xcb_get_property_cookie_t cookie)
 106 {
 107     xcb_window_t trans;
 108     int counter;
 109     client_t *tc, *tmp;
 110
 111     if(!xcb_icccm_get_wm_transient_for_reply(globalconf.connection,
 112                                              cookie,
 113                                              &trans, NULL))
 114             return;
 115
 116     tmp = tc = client_getbywin(trans);
 117
 118     luaA_object_push(globalconf.L, c);
 119     client_set_type(globalconf.L, -1, WINDOW_TYPE_DIALOG);
 120     client_set_above(globalconf.L, -1, false);
 121
 122     /* Verify that there are no loops in the transient_for relation after we are done */
 123     for(counter = 0; tmp != NULL && counter <= globalconf.stack.len; counter++)
 124     {
 125         if (tmp == c)
 126             /* We arrived back at the client we started from, so there is a loop */
 127             counter = globalconf.stack.len+1;
 128         tmp = tmp->transient_for;
 129     }
 130     if (counter <= globalconf.stack.len)
 131         client_set_transient_for(globalconf.L, -1, tc);
 132
 133     lua_pop(globalconf.L, 1);
 134 }
 135
 136 xcb_get_property_cookie_t
 137 property_get_wm_client_leader(client_t *c)
 138 {
 139     return xcb_get_property_unchecked(globalconf.connection, false, c->window,
 140                                       WM_CLIENT_LEADER, XCB_ATOM_WINDOW, 0, 32);
 141 }
 142
 143 /** Update leader hint of a client.
 144  * \param c The client.
 145  * \param cookie Cookie returned by property_get_wm_client_leader.
 146  */
 147 void
 148 property_update_wm_client_leader(client_t *c, xcb_get_property_cookie_t cookie)
 149 {
 150     xcb_get_property_reply_t *reply;
 151     void *data;
 152
 153     reply = xcb_get_property_reply(globalconf.connection, cookie, NULL);
 154
 155     if(reply && reply->value_len && (data = xcb_get_property_value(reply)))
 156         c->leader_window = *(xcb_window_t *) data;
 157
 158     p_delete(&reply);
 159 }
 160
 161 xcb_get_property_cookie_t
 162 property_get_wm_normal_hints(client_t *c)
 163 {
 164     return xcb_icccm_get_wm_normal_hints_unchecked(globalconf.connection, c->window);
 165 }
 166
 167 /** Update the size hints of a client.
 168  * \param c The client.
 169  * \param cookie Cookie returned by property_get_wm_normal_hints.
 170  */
 171 void
 172 property_update_wm_normal_hints(client_t *c, xcb_get_property_cookie_t cookie)
 173 {
 174     xcb_icccm_get_wm_normal_hints_reply(globalconf.connection,
 175                                         cookie,
 176                                         &c->size_hints, NULL);
 177 }
 178
 179 xcb_get_property_cookie_t
 180 property_get_wm_hints(client_t *c)
 181 {
 182     return xcb_icccm_get_wm_hints_unchecked(globalconf.connection, c->window);
 183 }
 184
 185 /** Update the WM hints of a client.
 186  * \param c The client.
 187  * \param cookie Cookie returned by property_get_wm_hints.
 188  */
 189 void
 190 property_update_wm_hints(client_t *c, xcb_get_property_cookie_t cookie)
 191 {
 192     xcb_icccm_wm_hints_t wmh;
 193
 194     if(!xcb_icccm_get_wm_hints_reply(globalconf.connection,
 195                                      cookie,
 196                                      &wmh, NULL))
 197         return;
 198
 199     luaA_object_push(globalconf.L, c);
 200     client_set_urgent(globalconf.L, -1, xcb_icccm_wm_hints_get_urgency(&wmh));
 201
 202     if(wmh.flags & XCB_ICCCM_WM_HINT_INPUT)
 203         c->nofocus = !wmh.input;
 204
 205     if(wmh.flags & XCB_ICCCM_WM_HINT_WINDOW_GROUP)
 206         client_set_group_window(globalconf.L, -1, wmh.window_group);
 207
 208     lua_pop(globalconf.L, 1);
 209 }
 210
 211 xcb_get_property_cookie_t
 212 property_get_wm_class(client_t *c)
 213 {
 214     return xcb_icccm_get_wm_class_unchecked(globalconf.connection, c->window);
 215 }
 216
 217 /** Update WM_CLASS of a client.
 218  * \param c The client.
 219  * \param cookie Cookie returned by property_get_wm_class.
 220  */
 221 void
 222 property_update_wm_class(client_t *c, xcb_get_property_cookie_t cookie)
 223 {
 224     xcb_icccm_get_wm_class_reply_t hint;
 225
 226     if(!xcb_icccm_get_wm_class_reply(globalconf.connection,
 227                                      cookie,
 228                                      &hint, NULL))
 229         return;
 230
 231     luaA_object_push(globalconf.L, c);
 232     client_set_class_instance(globalconf.L, -1, hint.class_name, hint.instance_name);
 233     lua_pop(globalconf.L, 1);
 234
 235     xcb_icccm_get_wm_class_reply_wipe(&hint);
 236 }
 237
 238 static int
 239 property_handle_net_wm_strut_partial(uint8_t state,
 240                                      xcb_window_t window)
 241 {
 242     client_t *c = client_getbywin(window);
 243
 244     if(c)
 245         ewmh_process_client_strut(c);
 246
 247     return 0;
 248 }
 249
 250 xcb_get_property_cookie_t
 251 property_get_net_wm_icon(client_t *c)
 252 {
 253     return ewmh_window_icon_get_unchecked(c->window);
 254 }
 255
 256 void
 257 property_update_net_wm_icon(client_t *c, xcb_get_property_cookie_t cookie)
 258 {
 259     cairo_surface_t *surface = ewmh_window_icon_get_reply(cookie);
 260
 261     if(!surface)
 262         return;
 263
 264     client_set_icon(c, surface);
 265     cairo_surface_destroy(surface);
 266 }
 267
 268 xcb_get_property_cookie_t
 269 property_get_net_wm_pid(client_t *c)
 270 {
 271     return xcb_get_property_unchecked(globalconf.connection, false, c->window, _NET_WM_PID, XCB_ATOM_CARDINAL, 0L, 1L);
 272 }
 273
 274 void
 275 property_update_net_wm_pid(client_t *c, xcb_get_property_cookie_t cookie)
 276 {
 277     xcb_get_property_reply_t *reply;
 278
 279     reply = xcb_get_property_reply(globalconf.connection, cookie, NULL);
 280
 281     if(reply && reply->value_len)
 282     {
 283         uint32_t *rdata = xcb_get_property_value(reply);
 284         if(rdata)
 285         {
 286             luaA_object_push(globalconf.L, c);
 287             client_set_pid(globalconf.L, -1, *rdata);
 288             lua_pop(globalconf.L, 1);
 289         }
 290     }
 291
 292     p_delete(&reply);
 293 }
 294
 295 xcb_get_property_cookie_t
 296 property_get_wm_protocols(client_t *c)
 297 {
 298     return xcb_icccm_get_wm_protocols_unchecked(globalconf.connection,
 299                                                 c->window, WM_PROTOCOLS);
 300 }
 301
 302 /** Update the list of supported protocols for a client.
 303  * \param c The client.
 304  * \param cookie Cookie from property_get_wm_protocols.
 305  */
 306 void
 307 property_update_wm_protocols(client_t *c, xcb_get_property_cookie_t cookie)
 308 {
 309     xcb_icccm_get_wm_protocols_reply_t protocols;
 310
 311     /* If this fails for any reason, we still got the old value */
 312     if(!xcb_icccm_get_wm_protocols_reply(globalconf.connection,
 313                                          cookie,
 314                                          &protocols, NULL))
 315         return;
 316
 317     xcb_icccm_get_wm_protocols_reply_wipe(&c->protocols);
 318     memcpy(&c->protocols, &protocols, sizeof(protocols));
 319 }
 320
 321 /** The property notify event handler.
 322  * \param state currently unused
 323  * \param window The window to obtain update the property with.
 324  * \param name The protocol atom, currently unused.
 325  * \param reply (Optional) An existing reply.
 326  */
 327 static int
 328 property_handle_xembed_info(uint8_t state,
 329                             xcb_window_t window)
 330 {
 331     xembed_window_t *emwin = xembed_getbywin(&globalconf.embedded, window);
 332
 333     if(emwin)
 334     {
 335         xcb_get_property_cookie_t cookie =
 336             xcb_get_property(globalconf.connection, 0, window, _XEMBED_INFO,
 337                              XCB_GET_PROPERTY_TYPE_ANY, 0, 3);
 338         xcb_get_property_reply_t *propr =
 339             xcb_get_property_reply(globalconf.connection, cookie, 0);
 340         xembed_property_update(globalconf.connection, emwin, propr);
 341         p_delete(&propr);
 342     }
 343
 344     return 0;
 345 }
 346
 347 static int
 348 property_handle_net_wm_opacity(uint8_t state,
 349                                xcb_window_t window)
 350 {
 351     drawin_t *drawin = drawin_getbywin(window);
 352
 353     if(drawin)
 354     {
 355         luaA_object_push(globalconf.L, drawin);
 356         window_set_opacity(globalconf.L, -1, xwindow_get_opacity(drawin->window));
 357         lua_pop(globalconf.L, -1);
 358     }
 359     else
 360     {
 361         client_t *c = client_getbywin(window);
 362         if(c)
 363         {
 364             luaA_object_push(globalconf.L, c);
 365             window_set_opacity(globalconf.L, -1, xwindow_get_opacity(c->window));
 366             lua_pop(globalconf.L, 1);
 367         }
 368     }
 369
 370     return 0;
 371 }
 372
 373 static int
 374 property_handle_xrootpmap_id(uint8_t state,
 375                              xcb_window_t window)
 376 {
 377     signal_object_emit(globalconf.L, &global_signals, "wallpaper_changed", 0);
 378     return 0;
 379 }
 380
 381 /** The property notify event handler handling xproperties.
 382  * \param ev The event.
 383  */
 384 static void
 385 property_handle_propertynotify_xproperty(xcb_property_notify_event_t *ev)
 386 {
 387     xproperty_t *prop;
 388     xproperty_t lookup = { .atom = ev->atom };
 389     buffer_t buf;
 390     void *obj;
 391
 392     prop = xproperty_array_lookup(&globalconf.xproperties, &lookup);
 393     if(!prop)
 394         /* Property is not registered */
 395         return;
 396
 397     obj = client_getbywin(ev->window);
 398     if(!obj)
 399         obj = drawin_getbywin(ev->window);
 400     if(!obj)
 401         return;
 402
 403     /* Get us the name of the property */
 404     buffer_inita(&buf, a_strlen(prop->name) + a_strlen("xproperty::") + 1);
 405     buffer_addf(&buf, "xproperty::%s", prop->name);
 406
 407     /* And emit the right signal */
 408     luaA_object_push(globalconf.L, obj);
 409     luaA_object_emit_signal(globalconf.L, -1, buf.s, 0);
 410     lua_pop(globalconf.L, 1);
 411     buffer_wipe(&buf);
 412 }
 413
 414 /** The property notify event handler.
 415  * \param ev The event.
 416  */
 417 void
 418 property_handle_propertynotify(xcb_property_notify_event_t *ev)
 419 {
 420     int (*handler)(uint8_t state,
 421                    xcb_window_t window) = NULL;
 422
 423     globalconf.timestamp = ev->time;
 424
 425     property_handle_propertynotify_xproperty(ev);
 426
 427     /* Find the correct event handler */
 428 #define HANDLE(atom_, cb) \
 429     if (ev->atom == atom_) \
 430     { \
 431         handler = cb; \
 432     } else
 433 #define END return
 434
 435     /* Xembed stuff */
 436     HANDLE(_XEMBED_INFO, property_handle_xembed_info)
 437
 438     /* ICCCM stuff */
 439     HANDLE(XCB_ATOM_WM_TRANSIENT_FOR, property_handle_wm_transient_for)
 440     HANDLE(WM_CLIENT_LEADER, property_handle_wm_client_leader)
 441     HANDLE(XCB_ATOM_WM_NORMAL_HINTS, property_handle_wm_normal_hints)
 442     HANDLE(XCB_ATOM_WM_HINTS, property_handle_wm_hints)
 443     HANDLE(XCB_ATOM_WM_NAME, property_handle_wm_name)
 444     HANDLE(XCB_ATOM_WM_ICON_NAME, property_handle_wm_icon_name)
 445     HANDLE(XCB_ATOM_WM_CLASS, property_handle_wm_class)
 446     HANDLE(WM_PROTOCOLS, property_handle_wm_protocols)
 447     HANDLE(XCB_ATOM_WM_CLIENT_MACHINE, property_handle_wm_client_machine)
 448     HANDLE(WM_WINDOW_ROLE, property_handle_wm_window_role)
 449
 450     /* EWMH stuff */
 451     HANDLE(_NET_WM_NAME, property_handle_net_wm_name)
 452     HANDLE(_NET_WM_ICON_NAME, property_handle_net_wm_icon_name)
 453     HANDLE(_NET_WM_STRUT_PARTIAL, property_handle_net_wm_strut_partial)
 454     HANDLE(_NET_WM_ICON, property_handle_net_wm_icon)
 455     HANDLE(_NET_WM_PID, property_handle_net_wm_pid)
 456     HANDLE(_NET_WM_WINDOW_OPACITY, property_handle_net_wm_opacity)
 457
 458     /* background change */
 459     HANDLE(_XROOTPMAP_ID, property_handle_xrootpmap_id)
 460
 461     /* If nothing was found, return */
 462     END;
 463
 464 #undef HANDLE
 465 #undef END
 466
 467     (*handler)(ev->state, ev->window);
 468 }
 469
 470 /** Register a new xproperty.
 471  * \param L The Lua VM state.
 472  * \return The number of elements pushed on stack.
 473  * \luastack
 474  * \lparam The name of the X11 property
 475  * \lparam One of "string", "number" or "boolean"
 476  */
 477 int
 478 luaA_register_xproperty(lua_State *L)
 479 {
 480     const char *name;
 481     struct xproperty property;
 482     struct xproperty *found;
 483     const char *const args[] = { "string", "number", "boolean" };
 484     xcb_intern_atom_reply_t *atom_r;
 485     int type;
 486
 487     name = luaL_checkstring(L, 1);
 488     type = luaL_checkoption(L, 2, NULL, args);
 489     if (type == 0)
 490         property.type = PROP_STRING;
 491     else if (type == 1)
 492         property.type = PROP_NUMBER;
 493     else
 494         property.type = PROP_BOOLEAN;
 495
 496     atom_r = xcb_intern_atom_reply(globalconf.connection,
 497                                    xcb_intern_atom_unchecked(globalconf.connection, false,
 498                                                              a_strlen(name), name),
 499                                    NULL);
 500     if(!atom_r)
 501         return 0;
 502
 503     property.atom = atom_r->atom;
 504     p_delete(&atom_r);
 505
 506     found = xproperty_array_lookup(&globalconf.xproperties, &property);
 507     if(found)
 508     {
 509         /* Property already registered */
 510         if(found->type != property.type)
 511             return luaL_error(L, "xproperty '%s' already registered with different type", name);
 512     }
 513     else
 514     {
 515         buffer_t buf;
 516         buffer_inita(&buf, a_strlen(name) + a_strlen("xproperty::") + 1);
 517         buffer_addf(&buf, "xproperty::%s", name);
 518
 519         property.name = a_strdup(name);
 520         xproperty_array_insert(&globalconf.xproperties, property);
 521         signal_add(&window_class.signals, buf.s);
 522         buffer_wipe(&buf);
 523     }
 524
 525     return 0;
 526 }
 527
 528 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80