obt/prop.c

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    obt/prop.c for the Openbox window manager
   4    Copyright (c) 2006        Mikael Magnusson
   5    Copyright (c) 2003-2007   Dana Jansens
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    See the COPYING file for a copy of the GNU General Public License.
  18 */
  19
  20 #include "obt/prop.h"
  21 #include "obt/display.h"
  22
  23 #include <X11/Xatom.h>
  24 #ifdef HAVE_STRING_H
  25 #  include <string.h>
  26 #endif
  27
  28 Atom prop_atoms[OBT_PROP_NUM_ATOMS];
  29 gboolean prop_started = FALSE;
  30
  31 #define CREATE_NAME(var, name) (prop_atoms[OBT_PROP_##var] = \
  32                                 XInternAtom((obt_display), (name), FALSE))
  33 #define CREATE(var) CREATE_NAME(var, #var)
  34 #define CREATE_(var) CREATE_NAME(var, "_" #var)
  35
  36 void obt_prop_startup(void)
  37 {
  38     if (prop_started) return;
  39     prop_started = TRUE;
  40
  41     g_assert(obt_display);
  42
  43     CREATE(CARDINAL);
  44     CREATE(WINDOW);
  45     CREATE(PIXMAP);
  46     CREATE(ATOM);
  47     CREATE(STRING);
  48     CREATE_NAME(UTF8, "UTF8_STRING");
  49
  50     CREATE(MANAGER);
  51
  52     CREATE(WM_COLORMAP_WINDOWS);
  53     CREATE(WM_PROTOCOLS);
  54     CREATE(WM_STATE);
  55     CREATE(WM_CHANGE_STATE);
  56     CREATE(WM_DELETE_WINDOW);
  57     CREATE(WM_TAKE_FOCUS);
  58     CREATE(WM_NAME);
  59     CREATE(WM_ICON_NAME);
  60     CREATE(WM_CLASS);
  61     CREATE(WM_WINDOW_ROLE);
  62     CREATE(WM_CLIENT_MACHINE);
  63     CREATE(WM_COMMAND);
  64     CREATE(WM_CLIENT_LEADER);
  65     CREATE(WM_TRANSIENT_FOR);
  66     CREATE_(MOTIF_WM_HINTS);
  67     CREATE_(MOTIF_WM_INFO);
  68
  69     CREATE(SM_CLIENT_ID);
  70
  71     CREATE_(NET_WM_FULL_PLACEMENT);
  72
  73     CREATE_(NET_SUPPORTED);
  74     CREATE_(NET_CLIENT_LIST);
  75     CREATE_(NET_CLIENT_LIST_STACKING);
  76     CREATE_(NET_NUMBER_OF_DESKTOPS);
  77     CREATE_(NET_DESKTOP_GEOMETRY);
  78     CREATE_(NET_DESKTOP_VIEWPORT);
  79     CREATE_(NET_CURRENT_DESKTOP);
  80     CREATE_(NET_DESKTOP_NAMES);
  81     CREATE_(NET_ACTIVE_WINDOW);
  82 /*    CREATE_(NET_RESTACK_WINDOW);*/
  83     CREATE_(NET_WORKAREA);
  84     CREATE_(NET_SUPPORTING_WM_CHECK);
  85     CREATE_(NET_DESKTOP_LAYOUT);
  86     CREATE_(NET_SHOWING_DESKTOP);
  87
  88     CREATE_(NET_CLOSE_WINDOW);
  89     CREATE_(NET_WM_MOVERESIZE);
  90     CREATE_(NET_MOVERESIZE_WINDOW);
  91     CREATE_(NET_REQUEST_FRAME_EXTENTS);
  92     CREATE_(NET_RESTACK_WINDOW);
  93
  94     CREATE_(NET_STARTUP_ID);
  95
  96     CREATE_(NET_WM_NAME);
  97     CREATE_(NET_WM_VISIBLE_NAME);
  98     CREATE_(NET_WM_ICON_NAME);
  99     CREATE_(NET_WM_VISIBLE_ICON_NAME);
 100     CREATE_(NET_WM_DESKTOP);
 101     CREATE_(NET_WM_WINDOW_TYPE);
 102     CREATE_(NET_WM_STATE);
 103     CREATE_(NET_WM_STRUT);
 104     CREATE_(NET_WM_STRUT_PARTIAL);
 105     CREATE_(NET_WM_ICON);
 106     CREATE_(NET_WM_ICON_GEOMETRY);
 107     CREATE_(NET_WM_PID);
 108     CREATE_(NET_WM_ALLOWED_ACTIONS);
 109     CREATE_(NET_WM_USER_TIME);
 110 /*  CREATE_(NET_WM_USER_TIME_WINDOW); */
 111     CREATE_(KDE_NET_WM_FRAME_STRUT);
 112     CREATE_(NET_FRAME_EXTENTS);
 113
 114     CREATE_(NET_WM_PING);
 115 #ifdef SYNC
 116     CREATE_(NET_WM_SYNC_REQUEST);
 117     CREATE_(NET_WM_SYNC_REQUEST_COUNTER);
 118 #endif
 119
 120     CREATE_(NET_WM_WINDOW_TYPE_DESKTOP);
 121     CREATE_(NET_WM_WINDOW_TYPE_DOCK);
 122     CREATE_(NET_WM_WINDOW_TYPE_TOOLBAR);
 123     CREATE_(NET_WM_WINDOW_TYPE_MENU);
 124     CREATE_(NET_WM_WINDOW_TYPE_UTILITY);
 125     CREATE_(NET_WM_WINDOW_TYPE_SPLASH);
 126     CREATE_(NET_WM_WINDOW_TYPE_DIALOG);
 127     CREATE_(NET_WM_WINDOW_TYPE_NORMAL);
 128     CREATE_(NET_WM_WINDOW_TYPE_POPUP_MENU);
 129
 130     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_TOPLEFT] = 0;
 131     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_TOP] = 1;
 132     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_TOPRIGHT] = 2;
 133     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_RIGHT] = 3;
 134     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_BOTTOMRIGHT] = 4;
 135     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_BOTTOM] = 5;
 136     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_BOTTOMLEFT] = 6;
 137     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_LEFT] = 7;
 138     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_MOVE] = 8;
 139     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_KEYBOARD] = 9;
 140     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_MOVE_KEYBOARD] = 10;
 141     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_CANCEL] = 11;
 142
 143     CREATE_(NET_WM_ACTION_MOVE);
 144     CREATE_(NET_WM_ACTION_RESIZE);
 145     CREATE_(NET_WM_ACTION_MINIMIZE);
 146     CREATE_(NET_WM_ACTION_SHADE);
 147     CREATE_(NET_WM_ACTION_MAXIMIZE_HORZ);
 148     CREATE_(NET_WM_ACTION_MAXIMIZE_VERT);
 149     CREATE_(NET_WM_ACTION_FULLSCREEN);
 150     CREATE_(NET_WM_ACTION_CHANGE_DESKTOP);
 151     CREATE_(NET_WM_ACTION_CLOSE);
 152     CREATE_(NET_WM_ACTION_ABOVE);
 153     CREATE_(NET_WM_ACTION_BELOW);
 154
 155     CREATE_(NET_WM_STATE_MODAL);
 156 /*    CREATE_(NET_WM_STATE_STICKY);*/
 157     CREATE_(NET_WM_STATE_MAXIMIZED_VERT);
 158     CREATE_(NET_WM_STATE_MAXIMIZED_HORZ);
 159     CREATE_(NET_WM_STATE_SHADED);
 160     CREATE_(NET_WM_STATE_SKIP_TASKBAR);
 161     CREATE_(NET_WM_STATE_SKIP_PAGER);
 162     CREATE_(NET_WM_STATE_HIDDEN);
 163     CREATE_(NET_WM_STATE_FULLSCREEN);
 164     CREATE_(NET_WM_STATE_ABOVE);
 165     CREATE_(NET_WM_STATE_BELOW);
 166     CREATE_(NET_WM_STATE_DEMANDS_ATTENTION);
 167
 168     prop_atoms[OBT_PROP_NET_WM_STATE_ADD] = 1;
 169     prop_atoms[OBT_PROP_NET_WM_STATE_REMOVE] = 0;
 170     prop_atoms[OBT_PROP_NET_WM_STATE_TOGGLE] = 2;
 171
 172     prop_atoms[OBT_PROP_NET_WM_ORIENTATION_HORZ] = 0;
 173     prop_atoms[OBT_PROP_NET_WM_ORIENTATION_VERT] = 1;
 174     prop_atoms[OBT_PROP_NET_WM_TOPLEFT] = 0;
 175     prop_atoms[OBT_PROP_NET_WM_TOPRIGHT] = 1;
 176     prop_atoms[OBT_PROP_NET_WM_BOTTOMRIGHT] = 2;
 177     prop_atoms[OBT_PROP_NET_WM_BOTTOMLEFT] = 3;
 178
 179     CREATE_(KDE_WM_CHANGE_STATE);
 180     CREATE_(KDE_NET_WM_WINDOW_TYPE_OVERRIDE);
 181
 182 /*
 183     CREATE_NAME(ROOTPMAPId, "_XROOTPMAP_ID");
 184     CREATE_NAME(ESETROOTId, "ESETROOT_PMAP_ID");
 185 */
 186
 187     CREATE_(OPENBOX_PID);
 188     CREATE_(OB_THEME);
 189     CREATE_(OB_CONFIG_FILE);
 190     CREATE_(OB_WM_ACTION_UNDECORATE);
 191     CREATE_(OB_WM_STATE_UNDECORATED);
 192     CREATE_(OB_WM_STATE_LOCKED);
 193     CREATE_(OB_CONTROL);
 194     CREATE_(OB_VERSION);
 195     CREATE_(OB_APP_ROLE);
 196     CREATE_(OB_APP_TITLE);
 197     CREATE_(OB_APP_NAME);
 198     CREATE_(OB_APP_CLASS);
 199     CREATE_(OB_APP_TYPE);
 200     CREATE_(OB_TARGET_WINDOW);
 201 }
 202
 203 Atom obt_prop_atom(ObtPropAtom a)
 204 {
 205     g_assert(prop_started);
 206     g_assert(a < OBT_PROP_NUM_ATOMS);
 207     return prop_atoms[a];
 208 }
 209
 210 static gboolean get_prealloc(Window win, Atom prop, Atom type, gint size,
 211                              guchar *data, gulong num)
 212 {
 213     gboolean ret = FALSE;
 214     gint res;
 215     guchar *xdata = NULL;
 216     Atom ret_type;
 217     gint ret_size;
 218     gulong ret_items, bytes_left;
 219     glong num32 = 32 / size * num; /* num in 32-bit elements */
 220
 221     res = XGetWindowProperty(obt_display, win, prop, 0l, num32,
 222                              FALSE, type, &ret_type, &ret_size,
 223                              &ret_items, &bytes_left, &xdata);
 224     if (res == Success && ret_items && xdata) {
 225         if (ret_size == size && ret_items >= num) {
 226             guint i;
 227             for (i = 0; i < num; ++i)
 228                 switch (size) {
 229                 case 8:
 230                     data[i] = xdata[i];
 231                     break;
 232                 case 16:
 233                     ((guint16*)data)[i] = ((gushort*)xdata)[i];
 234                     break;
 235                 case 32:
 236                     ((guint32*)data)[i] = ((gulong*)xdata)[i];
 237                     break;
 238                 default:
 239                     g_assert_not_reached(); /* unhandled size */
 240                 }
 241             ret = TRUE;
 242         }
 243         XFree(xdata);
 244     }
 245     return ret;
 246 }
 247
 248 static gboolean get_all(Window win, Atom prop, Atom type, gint size,
 249                         guchar **data, guint *num)
 250 {
 251     gboolean ret = FALSE;
 252     gint res;
 253     guchar *xdata = NULL;
 254     Atom ret_type;
 255     gint ret_size;
 256     gulong ret_items, bytes_left;
 257
 258     res = XGetWindowProperty(obt_display, win, prop, 0l, G_MAXLONG,
 259                              FALSE, type, &ret_type, &ret_size,
 260                              &ret_items, &bytes_left, &xdata);
 261     if (res == Success) {
 262         if (ret_size == size && ret_items > 0) {
 263             guint i;
 264
 265             *data = g_malloc(ret_items * (size / 8));
 266             for (i = 0; i < ret_items; ++i)
 267                 switch (size) {
 268                 case 8:
 269                     (*data)[i] = xdata[i];
 270                     break;
 271                 case 16:
 272                     ((guint16*)*data)[i] = ((gushort*)xdata)[i];
 273                     break;
 274                 case 32:
 275                     ((guint32*)*data)[i] = ((gulong*)xdata)[i];
 276                     break;
 277                 default:
 278                     g_assert_not_reached(); /* unhandled size */
 279                 }
 280             *num = ret_items;
 281             ret = TRUE;
 282         }
 283         XFree(xdata);
 284     }
 285     return ret;
 286 }
 287
 288 static gboolean get_stringlist(Window win, Atom prop, gchar ***list, gint *nstr)
 289 {
 290     XTextProperty tprop;
 291     gboolean ret = FALSE;
 292
 293     if (XGetTextProperty(obt_display, win, &tprop, prop) && tprop.nitems) {
 294         if (XTextPropertyToStringList(&tprop, list, nstr))
 295             ret = TRUE;
 296         XFree(tprop.value);
 297     }
 298     return ret;
 299 }
 300
 301 gboolean obt_prop_get32(Window win, Atom prop, Atom type, guint32 *ret)
 302 {
 303     return get_prealloc(win, prop, type, 32, (guchar*)ret, 1);
 304 }
 305
 306 gboolean obt_prop_get_array32(Window win, Atom prop, Atom type, guint32 **ret,
 307                               guint *nret)
 308 {
 309     return get_all(win, prop, type, 32, (guchar**)ret, nret);
 310 }
 311
 312 gboolean obt_prop_get_string_locale(Window win, Atom prop, gchar **ret)
 313 {
 314     gchar **list;
 315     gint nstr;
 316     gchar *s;
 317
 318     if (get_stringlist(win, prop, &list, &nstr) && nstr) {
 319         s = g_locale_to_utf8(list[0], -1, NULL, NULL, NULL);
 320         XFreeStringList(list);
 321         if (s) {
 322             *ret = s;
 323             return TRUE;
 324         }
 325     }
 326     return FALSE;
 327 }
 328
 329 gboolean obt_prop_get_strings_locale(Window win, Atom prop, gchar ***ret)
 330 {
 331     GSList *strs = NULL, *it;
 332     gchar *raw, *p;
 333     guint num, i, count = 0;
 334
 335     if (get_all(win, prop, OBT_PROP_ATOM(STRING), 8,
 336                 (guchar**)&raw, &num))
 337     {
 338         p = raw;
 339         while (p < raw + num) {
 340             ++count;
 341             strs = g_slist_append(strs, p);
 342             p += strlen(p) + 1; /* next string */
 343         }
 344
 345         *ret = g_new0(gchar*, count + 1);
 346         (*ret)[count] = NULL; /* null terminated list */
 347
 348         for (i = 0, it = strs; it; ++i, it = g_slist_next(it)) {
 349             (*ret)[i] = g_locale_to_utf8(it->data, -1, NULL, NULL, NULL);
 350             /* make sure translation did not fail */
 351             if (!(*ret)[i])
 352                 (*ret)[i] = g_strdup("");
 353         }
 354         g_free(raw);
 355         g_slist_free(strs);
 356         return TRUE;
 357     }
 358     return FALSE;
 359 }
 360
 361 gboolean obt_prop_get_string_utf8(Window win, Atom prop, gchar **ret)
 362 {
 363     gchar *raw;
 364     gchar *str;
 365     guint num;
 366
 367     if (get_all(win, prop, OBT_PROP_ATOM(UTF8), 8,
 368                 (guchar**)&raw, &num))
 369     {
 370         str = g_strndup(raw, num); /* grab the first string from the list */
 371         g_free(raw);
 372         if (g_utf8_validate(str, -1, NULL)) {
 373             *ret = str;
 374             return TRUE;
 375         }
 376         g_free(str);
 377     }
 378     return FALSE;
 379 }
 380
 381 gboolean obt_prop_get_strings_utf8(Window win, Atom prop, gchar ***ret)
 382 {
 383     GSList *strs = NULL, *it;
 384     gchar *raw, *p;
 385     guint num, i, count = 0;
 386
 387     if (get_all(win, prop, OBT_PROP_ATOM(UTF8), 8,
 388                 (guchar**)&raw, &num))
 389     {
 390         p = raw;
 391         while (p < raw + num) {
 392             ++count;
 393             strs = g_slist_append(strs, p);
 394             p += strlen(p) + 1; /* next string */
 395         }
 396
 397         *ret = g_new0(gchar*, count + 1);
 398
 399         for (i = 0, it = strs; it; ++i, it = g_slist_next(it)) {
 400             if (g_utf8_validate(it->data, -1, NULL))
 401                 (*ret)[i] = g_strdup(it->data);
 402             else
 403                 (*ret)[i] = g_strdup("");
 404         }
 405         g_free(raw);
 406         g_slist_free(strs);
 407         return TRUE;
 408     }
 409     return FALSE;
 410 }
 411
 412 void obt_prop_set32(Window win, Atom prop, Atom type, gulong val)
 413 {
 414     XChangeProperty(obt_display, win, prop, type, 32, PropModeReplace,
 415                     (guchar*)&val, 1);
 416 }
 417
 418 void obt_prop_set_array32(Window win, Atom prop, Atom type, gulong *val,
 419                       guint num)
 420 {
 421     XChangeProperty(obt_display, win, prop, type, 32, PropModeReplace,
 422                     (guchar*)val, num);
 423 }
 424
 425 void obt_prop_set_string_locale(Window win, Atom prop, const gchar *val)
 426 {
 427     gchar const *s[2] = { val, NULL };
 428     obt_prop_set_strings_locale(win, prop, s);
 429 }
 430
 431 void obt_prop_set_strings_locale(Window win, Atom prop,
 432                                  const gchar *const *strs)
 433 {
 434     gint i, count;
 435     gchar **lstrs;
 436     XTextProperty tprop;
 437
 438     /* count the strings in strs, and convert them to the locale format */
 439     for (count = 0; strs[count]; ++count);
 440     lstrs = g_new0(char*, count);
 441     for (i = 0; i < count; ++i) {
 442         lstrs[i] = g_locale_from_utf8(strs[i], -1, NULL, NULL, NULL);
 443         if (!lstrs[i]) {
 444             lstrs[i] = g_strdup(""); /* make it an empty string */
 445             g_warning("Unable to translate string '%s' from UTF8 to locale "
 446                       "format", strs[i]);
 447         }
 448     }
 449
 450
 451     XStringListToTextProperty(lstrs, count, &tprop);
 452     XSetTextProperty(obt_display, win, &tprop, prop);
 453     XFree(tprop.value);
 454 }
 455
 456 void obt_prop_set_string_utf8(Window win, Atom prop, const gchar *val)
 457 {
 458     XChangeProperty(obt_display, win, prop, OBT_PROP_ATOM(UTF8), 8,
 459                     PropModeReplace, (const guchar*)val, strlen(val));
 460 }
 461
 462 void obt_prop_set_strings_utf8(Window win, Atom prop,
 463                                const gchar *const *strs)
 464 {
 465     GString *str;
 466     gchar const *const *s;
 467
 468     str = g_string_sized_new(0);
 469     for (s = strs; *s; ++s) {
 470         str = g_string_append(str, *s);
 471         str = g_string_append_c(str, '\0');
 472     }
 473     XChangeProperty(obt_display, win, prop, obt_prop_atom(OBT_PROP_UTF8), 8,
 474                     PropModeReplace, (guchar*)str->str, str->len);
 475     g_string_free(str, TRUE);
 476 }
 477
 478 void obt_prop_erase(Window win, Atom prop)
 479 {
 480     XDeleteProperty(obt_display, win, prop);
 481 }
 482
 483 void obt_prop_message(gint screen, Window about, Atom messagetype,
 484                       glong data0, glong data1, glong data2, glong data3,
 485                       glong data4, glong mask)
 486 {
 487     obt_prop_message_to(obt_root(screen), about, messagetype,
 488                         data0, data1, data2, data3, data4, mask);
 489 }
 490
 491 void obt_prop_message_to(Window to, Window about,
 492                          Atom messagetype,
 493                          glong data0, glong data1, glong data2, glong data3,
 494                          glong data4, glong mask)
 495 {
 496     XEvent ce;
 497     ce.xclient.type = ClientMessage;
 498     ce.xclient.message_type = messagetype;
 499     ce.xclient.display = obt_display;
 500     ce.xclient.window = about;
 501     ce.xclient.format = 32;
 502     ce.xclient.data.l[0] = data0;
 503     ce.xclient.data.l[1] = data1;
 504     ce.xclient.data.l[2] = data2;
 505     ce.xclient.data.l[3] = data3;
 506     ce.xclient.data.l[4] = data4;
 507     XSendEvent(obt_display, to, FALSE, mask, &ce);
 508 }