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()
  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_(MOTIF_WM_HINTS);
  66
  67     CREATE(SM_CLIENT_ID);
  68
  69     CREATE_(NET_WM_FULL_PLACEMENT);
  70
  71     CREATE_(NET_SUPPORTED);
  72     CREATE_(NET_CLIENT_LIST);
  73     CREATE_(NET_CLIENT_LIST_STACKING);
  74     CREATE_(NET_NUMBER_OF_DESKTOPS);
  75     CREATE_(NET_DESKTOP_GEOMETRY);
  76     CREATE_(NET_DESKTOP_VIEWPORT);
  77     CREATE_(NET_CURRENT_DESKTOP);
  78     CREATE_(NET_DESKTOP_NAMES);
  79     CREATE_(NET_ACTIVE_WINDOW);
  80 /*    CREATE_(NET_RESTACK_WINDOW);*/
  81     CREATE_(NET_WORKAREA);
  82     CREATE_(NET_SUPPORTING_WM_CHECK);
  83     CREATE_(NET_DESKTOP_LAYOUT);
  84     CREATE_(NET_SHOWING_DESKTOP);
  85
  86     CREATE_(NET_CLOSE_WINDOW);
  87     CREATE_(NET_WM_MOVERESIZE);
  88     CREATE_(NET_MOVERESIZE_WINDOW);
  89     CREATE_(NET_REQUEST_FRAME_EXTENTS);
  90     CREATE_(NET_RESTACK_WINDOW);
  91
  92     CREATE_(NET_STARTUP_ID);
  93
  94     CREATE_(NET_WM_NAME);
  95     CREATE_(NET_WM_VISIBLE_NAME);
  96     CREATE_(NET_WM_ICON_NAME);
  97     CREATE_(NET_WM_VISIBLE_ICON_NAME);
  98     CREATE_(NET_WM_DESKTOP);
  99     CREATE_(NET_WM_WINDOW_TYPE);
 100     CREATE_(NET_WM_STATE);
 101     CREATE_(NET_WM_STRUT);
 102     CREATE_(NET_WM_STRUT_PARTIAL);
 103     CREATE_(NET_WM_ICON);
 104     CREATE_(NET_WM_ICON_GEOMETRY);
 105     CREATE_(NET_WM_PID);
 106     CREATE_(NET_WM_ALLOWED_ACTIONS);
 107     CREATE_(NET_WM_USER_TIME);
 108 /*  CREATE_(NET_WM_USER_TIME_WINDOW); */
 109     CREATE_(KDE_NET_WM_FRAME_STRUT);
 110     CREATE_(NET_FRAME_EXTENTS);
 111
 112     CREATE_(NET_WM_PING);
 113 #ifdef SYNC
 114     CREATE_(NET_WM_SYNC_REQUEST);
 115     CREATE_(NET_WM_SYNC_REQUEST_COUNTER);
 116 #endif
 117
 118     CREATE_(NET_WM_WINDOW_TYPE_DESKTOP);
 119     CREATE_(NET_WM_WINDOW_TYPE_DOCK);
 120     CREATE_(NET_WM_WINDOW_TYPE_TOOLBAR);
 121     CREATE_(NET_WM_WINDOW_TYPE_MENU);
 122     CREATE_(NET_WM_WINDOW_TYPE_UTILITY);
 123     CREATE_(NET_WM_WINDOW_TYPE_SPLASH);
 124     CREATE_(NET_WM_WINDOW_TYPE_DIALOG);
 125     CREATE_(NET_WM_WINDOW_TYPE_NORMAL);
 126
 127     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_TOPLEFT] = 0;
 128     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_TOP] = 1;
 129     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_TOPRIGHT] = 2;
 130     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_RIGHT] = 3;
 131     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_BOTTOMRIGHT] = 4;
 132     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_BOTTOM] = 5;
 133     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_BOTTOMLEFT] = 6;
 134     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_LEFT] = 7;
 135     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_MOVE] = 8;
 136     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_KEYBOARD] = 9;
 137     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_MOVE_KEYBOARD] = 10;
 138     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_CANCEL] = 11;
 139
 140     CREATE_(NET_WM_ACTION_MOVE);
 141     CREATE_(NET_WM_ACTION_RESIZE);
 142     CREATE_(NET_WM_ACTION_MINIMIZE);
 143     CREATE_(NET_WM_ACTION_SHADE);
 144     CREATE_(NET_WM_ACTION_MAXIMIZE_HORZ);
 145     CREATE_(NET_WM_ACTION_MAXIMIZE_VERT);
 146     CREATE_(NET_WM_ACTION_FULLSCREEN);
 147     CREATE_(NET_WM_ACTION_CHANGE_DESKTOP);
 148     CREATE_(NET_WM_ACTION_CLOSE);
 149     CREATE_(NET_WM_ACTION_ABOVE);
 150     CREATE_(NET_WM_ACTION_BELOW);
 151
 152     CREATE_(NET_WM_STATE_MODAL);
 153 /*    CREATE_(NET_WM_STATE_STICKY);*/
 154     CREATE_(NET_WM_STATE_MAXIMIZED_VERT);
 155     CREATE_(NET_WM_STATE_MAXIMIZED_HORZ);
 156     CREATE_(NET_WM_STATE_SHADED);
 157     CREATE_(NET_WM_STATE_SKIP_TASKBAR);
 158     CREATE_(NET_WM_STATE_SKIP_PAGER);
 159     CREATE_(NET_WM_STATE_HIDDEN);
 160     CREATE_(NET_WM_STATE_FULLSCREEN);
 161     CREATE_(NET_WM_STATE_ABOVE);
 162     CREATE_(NET_WM_STATE_BELOW);
 163     CREATE_(NET_WM_STATE_DEMANDS_ATTENTION);
 164
 165     prop_atoms[OBT_PROP_NET_WM_STATE_ADD] = 1;
 166     prop_atoms[OBT_PROP_NET_WM_STATE_REMOVE] = 0;
 167     prop_atoms[OBT_PROP_NET_WM_STATE_TOGGLE] = 2;
 168
 169     prop_atoms[OBT_PROP_NET_WM_ORIENTATION_HORZ] = 0;
 170     prop_atoms[OBT_PROP_NET_WM_ORIENTATION_VERT] = 1;
 171     prop_atoms[OBT_PROP_NET_WM_TOPLEFT] = 0;
 172     prop_atoms[OBT_PROP_NET_WM_TOPRIGHT] = 1;
 173     prop_atoms[OBT_PROP_NET_WM_BOTTOMRIGHT] = 2;
 174     prop_atoms[OBT_PROP_NET_WM_BOTTOMLEFT] = 3;
 175
 176     CREATE_(KDE_WM_CHANGE_STATE);
 177     CREATE_(KDE_NET_WM_WINDOW_TYPE_OVERRIDE);
 178
 179 /*
 180     CREATE_NAME(ROOTPMAPId, "_XROOTPMAP_ID");
 181     CREATE_NAME(ESETROOTId, "ESETROOT_PMAP_ID");
 182 */
 183
 184     CREATE_(OPENBOX_PID);
 185     CREATE_(OB_THEME);
 186     CREATE_(OB_WM_ACTION_UNDECORATE);
 187     CREATE_(OB_WM_STATE_UNDECORATED);
 188     CREATE_(OB_CONTROL);
 189 }
 190
 191 Atom obt_prop_atom(ObtPropAtom a)
 192 {
 193     g_assert(prop_started);
 194     g_assert(a < OBT_PROP_NUM_ATOMS);
 195     return prop_atoms[a];
 196 }
 197
 198 static gboolean get_prealloc(Window win, Atom prop, Atom type, gint size,
 199                              guchar *data, gulong num)
 200 {
 201     gboolean ret = FALSE;
 202     gint res;
 203     guchar *xdata = NULL;
 204     Atom ret_type;
 205     gint ret_size;
 206     gulong ret_items, bytes_left;
 207     glong num32 = 32 / size * num; /* num in 32-bit elements */
 208
 209     res = XGetWindowProperty(obt_display, win, prop, 0l, num32,
 210                              FALSE, type, &ret_type, &ret_size,
 211                              &ret_items, &bytes_left, &xdata);
 212     if (res == Success && ret_items && xdata) {
 213         if (ret_size == size && ret_items >= num) {
 214             guint i;
 215             for (i = 0; i < num; ++i)
 216                 switch (size) {
 217                 case 8:
 218                     data[i] = xdata[i];
 219                     break;
 220                 case 16:
 221                     ((guint16*)data)[i] = ((gushort*)xdata)[i];
 222                     break;
 223                 case 32:
 224                     ((guint32*)data)[i] = ((gulong*)xdata)[i];
 225                     break;
 226                 default:
 227                     g_assert_not_reached(); /* unhandled size */
 228                 }
 229             ret = TRUE;
 230         }
 231         XFree(xdata);
 232     }
 233     return ret;
 234 }
 235
 236 static gboolean get_all(Window win, Atom prop, Atom type, gint size,
 237                         guchar **data, guint *num)
 238 {
 239     gboolean ret = FALSE;
 240     gint res;
 241     guchar *xdata = NULL;
 242     Atom ret_type;
 243     gint ret_size;
 244     gulong ret_items, bytes_left;
 245
 246     res = XGetWindowProperty(obt_display, win, prop, 0l, G_MAXLONG,
 247                              FALSE, type, &ret_type, &ret_size,
 248                              &ret_items, &bytes_left, &xdata);
 249     if (res == Success) {
 250         if (ret_size == size && ret_items > 0) {
 251             guint i;
 252
 253             *data = g_malloc(ret_items * (size / 8));
 254             for (i = 0; i < ret_items; ++i)
 255                 switch (size) {
 256                 case 8:
 257                     (*data)[i] = xdata[i];
 258                     break;
 259                 case 16:
 260                     ((guint16*)*data)[i] = ((gushort*)xdata)[i];
 261                     break;
 262                 case 32:
 263                     ((guint32*)*data)[i] = ((gulong*)xdata)[i];
 264                     break;
 265                 default:
 266                     g_assert_not_reached(); /* unhandled size */
 267                 }
 268             *num = ret_items;
 269             ret = TRUE;
 270         }
 271         XFree(xdata);
 272     }
 273     return ret;
 274 }
 275
 276 static gboolean get_stringlist(Window win, Atom prop, gchar ***list, gint *nstr)
 277 {
 278     XTextProperty tprop;
 279     gboolean ret = FALSE;
 280
 281     if (XGetTextProperty(obt_display, win, &tprop, prop) && tprop.nitems) {
 282         if (XTextPropertyToStringList(&tprop, list, nstr))
 283             ret = TRUE;
 284         XFree(tprop.value);
 285     }
 286     return ret;
 287 }
 288
 289 gboolean obt_prop_get32(Window win, Atom prop, Atom type, guint32 *ret)
 290 {
 291     return get_prealloc(win, prop, type, 32, (guchar*)ret, 1);
 292 }
 293
 294 gboolean obt_prop_get_array32(Window win, Atom prop, Atom type, guint32 **ret,
 295                               guint *nret)
 296 {
 297     return get_all(win, prop, type, 32, (guchar**)ret, nret);
 298 }
 299
 300 gboolean obt_prop_get_string_locale(Window win, Atom prop, gchar **ret)
 301 {
 302     gchar **list;
 303     gint nstr;
 304     gchar *s;
 305
 306     if (get_stringlist(win, prop, &list, &nstr) && nstr) {
 307         s = g_locale_to_utf8(list[0], -1, NULL, NULL, NULL);
 308         XFreeStringList(list);
 309         if (s) {
 310             *ret = s;
 311             return TRUE;
 312         }
 313     }
 314     return FALSE;
 315 }
 316
 317 gboolean obt_prop_get_strings_locale(Window win, Atom prop, gchar ***ret)
 318 {
 319     GSList *strs = NULL, *it;
 320     gchar *raw, *p;
 321     guint num, i, count = 0;
 322
 323     if (get_all(win, prop, OBT_PROP_ATOM(STRING), 8,
 324                 (guchar**)&raw, &num))
 325     {
 326         p = raw;
 327         while (p < raw + num) {
 328             ++count;
 329             strs = g_slist_append(strs, p);
 330             p += strlen(p) + 1; /* next string */
 331         }
 332
 333         *ret = g_new0(gchar*, count + 1);
 334         (*ret)[count] = NULL; /* null terminated list */
 335
 336         for (i = 0, it = strs; it; ++i, it = g_slist_next(it)) {
 337             (*ret)[i] = g_locale_to_utf8(it->data, -1, NULL, NULL, NULL);
 338             /* make sure translation did not fail */
 339             if (!(*ret)[i])
 340                 (*ret)[i] = g_strdup("");
 341         }
 342         g_free(raw);
 343         g_slist_free(strs);
 344         return TRUE;
 345     }
 346     return FALSE;
 347 }
 348
 349 gboolean obt_prop_get_string_utf8(Window win, Atom prop, gchar **ret)
 350 {
 351     gchar *raw;
 352     gchar *str;
 353     guint num;
 354
 355     if (get_all(win, prop, OBT_PROP_ATOM(UTF8), 8,
 356                 (guchar**)&raw, &num))
 357     {
 358         str = g_strndup(raw, num); /* grab the first string from the list */
 359         g_free(raw);
 360         if (g_utf8_validate(str, -1, NULL)) {
 361             *ret = str;
 362             return TRUE;
 363         }
 364         g_free(str);
 365     }
 366     return FALSE;
 367 }
 368
 369 gboolean obt_prop_get_strings_utf8(Window win, Atom prop, gchar ***ret)
 370 {
 371     GSList *strs = NULL, *it;
 372     gchar *raw, *p;
 373     guint num, i, count = 0;
 374
 375     if (get_all(win, prop, OBT_PROP_ATOM(UTF8), 8,
 376                 (guchar**)&raw, &num))
 377     {
 378         p = raw;
 379         while (p < raw + num) {
 380             ++count;
 381             strs = g_slist_append(strs, p);
 382             p += strlen(p) + 1; /* next string */
 383         }
 384
 385         *ret = g_new0(gchar*, count + 1);
 386
 387         for (i = 0, it = strs; it; ++i, it = g_slist_next(it)) {
 388             if (g_utf8_validate(it->data, -1, NULL))
 389                 (*ret)[i] = g_strdup(it->data);
 390             else
 391                 (*ret)[i] = g_strdup("");
 392         }
 393         g_free(raw);
 394         g_slist_free(strs);
 395         return TRUE;
 396     }
 397     return FALSE;
 398 }
 399
 400 void obt_prop_set32(Window win, Atom prop, Atom type, gulong val)
 401 {
 402     XChangeProperty(obt_display, win, prop, type, 32, PropModeReplace,
 403                     (guchar*)&val, 1);
 404 }
 405
 406 void obt_prop_set_array32(Window win, Atom prop, Atom type, gulong *val,
 407                       guint num)
 408 {
 409     XChangeProperty(obt_display, win, prop, type, 32, PropModeReplace,
 410                     (guchar*)val, num);
 411 }
 412
 413 void obt_prop_set_string_locale(Window win, Atom prop, const gchar *val)
 414 {
 415     gchar const *s[2] = { val, NULL };
 416     obt_prop_set_strings_locale(win, prop, s);
 417 }
 418
 419 void obt_prop_set_strings_locale(Window win, Atom prop, const gchar **strs)
 420 {
 421     gint i, count;
 422     gchar **lstrs;
 423     XTextProperty tprop;
 424
 425     /* count the strings in strs, and convert them to the locale format */
 426     for (count = 0; strs[count]; ++count);
 427     lstrs = g_new0(char*, count);
 428     for (i = 0; i < count; ++i) {
 429         lstrs[i] = g_locale_from_utf8(strs[i], -1, NULL, NULL, NULL);
 430         if (!lstrs[i]) {
 431             lstrs[i] = g_strdup(""); /* make it an empty string */
 432             g_warning("Unable to translate string '%s' from UTF8 to locale "
 433                       "format", strs[i]);
 434         }
 435     }
 436
 437
 438     XStringListToTextProperty(lstrs, count, &tprop);
 439     XSetTextProperty(obt_display, win, &tprop, prop);
 440     XFree(tprop.value);
 441 }
 442
 443 void obt_prop_set_string_utf8(Window win, Atom prop, const gchar *val)
 444 {
 445     XChangeProperty(obt_display, win, prop, OBT_PROP_ATOM(UTF8), 8,
 446                     PropModeReplace, (const guchar*)val, strlen(val));
 447 }
 448
 449 void obt_prop_set_strings_utf8(Window win, Atom prop, const gchar **strs)
 450 {
 451     GString *str;
 452     gchar const **s;
 453
 454     str = g_string_sized_new(0);
 455     for (s = strs; *s; ++s) {
 456         str = g_string_append(str, *s);
 457         str = g_string_append_c(str, '\0');
 458     }
 459     XChangeProperty(obt_display, win, prop, obt_prop_atom(OBT_PROP_UTF8), 8,
 460                     PropModeReplace, (guchar*)str->str, str->len);
 461     g_string_free(str, TRUE);
 462 }
 463
 464 void obt_prop_erase(Window win, Atom prop)
 465 {
 466     XDeleteProperty(obt_display, win, prop);
 467 }
 468
 469 void obt_prop_message(gint screen, Window about, Atom messagetype,
 470                       glong data0, glong data1, glong data2, glong data3,
 471                       glong data4, glong mask)
 472 {
 473     obt_prop_message_to(obt_root(screen), about, messagetype,
 474                         data0, data1, data2, data3, data4, mask);
 475 }
 476
 477 void obt_prop_message_to(Window to, Window about,
 478                          Atom messagetype,
 479                          glong data0, glong data1, glong data2, glong data3,
 480                          glong data4, glong mask)
 481 {
 482     XEvent ce;
 483     ce.xclient.type = ClientMessage;
 484     ce.xclient.message_type = messagetype;
 485     ce.xclient.display = obt_display;
 486     ce.xclient.window = about;
 487     ce.xclient.format = 32;
 488     ce.xclient.data.l[0] = data0;
 489     ce.xclient.data.l[1] = data1;
 490     ce.xclient.data.l[2] = data2;
 491     ce.xclient.data.l[3] = data3;
 492     ce.xclient.data.l[4] = data4;
 493     XSendEvent(obt_display, to, FALSE, mask, &ce);
 494 }