openbox/prop.c

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    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 "prop.h"
  21 #include "openbox.h"
  22
  23 #include <X11/Xatom.h>
  24
  25 Atoms prop_atoms;
  26
  27 #define CREATE(var, name) (prop_atoms.var = \
  28                            XInternAtom(ob_display, name, FALSE))
  29
  30 void prop_startup()
  31 {
  32     CREATE(cardinal, "CARDINAL");
  33     CREATE(window, "WINDOW");
  34     CREATE(pixmap, "PIXMAP");
  35     CREATE(atom, "ATOM");
  36     CREATE(string, "STRING");
  37     CREATE(utf8, "UTF8_STRING");
  38
  39     CREATE(manager, "MANAGER");
  40
  41     CREATE(wm_colormap_windows, "WM_COLORMAP_WINDOWS");
  42     CREATE(wm_protocols, "WM_PROTOCOLS");
  43     CREATE(wm_state, "WM_STATE");
  44     CREATE(wm_change_state, "WM_CHANGE_STATE");
  45     CREATE(wm_delete_window, "WM_DELETE_WINDOW");
  46     CREATE(wm_take_focus, "WM_TAKE_FOCUS");
  47     CREATE(wm_name, "WM_NAME");
  48     CREATE(wm_icon_name, "WM_ICON_NAME");
  49     CREATE(wm_class, "WM_CLASS");
  50     CREATE(wm_window_role, "WM_WINDOW_ROLE");
  51     CREATE(motif_wm_hints, "_MOTIF_WM_HINTS");
  52
  53     CREATE(sm_client_id, "SM_CLIENT_ID");
  54
  55     CREATE(net_wm_full_placement, "_NET_WM_FULL_PLACEMENT");
  56
  57     CREATE(net_supported, "_NET_SUPPORTED");
  58     CREATE(net_client_list, "_NET_CLIENT_LIST");
  59     CREATE(net_client_list_stacking, "_NET_CLIENT_LIST_STACKING");
  60     CREATE(net_number_of_desktops, "_NET_NUMBER_OF_DESKTOPS");
  61     CREATE(net_desktop_geometry, "_NET_DESKTOP_GEOMETRY");
  62     CREATE(net_desktop_viewport, "_NET_DESKTOP_VIEWPORT");
  63     CREATE(net_current_desktop, "_NET_CURRENT_DESKTOP");
  64     CREATE(net_desktop_names, "_NET_DESKTOP_NAMES");
  65     CREATE(net_active_window, "_NET_ACTIVE_WINDOW");
  66     CREATE(net_workarea, "_NET_WORKAREA");
  67     CREATE(net_supporting_wm_check, "_NET_SUPPORTING_WM_CHECK");
  68     CREATE(net_desktop_layout, "_NET_DESKTOP_LAYOUT");
  69     CREATE(net_showing_desktop, "_NET_SHOWING_DESKTOP");
  70
  71     CREATE(net_close_window, "_NET_CLOSE_WINDOW");
  72     CREATE(net_wm_moveresize, "_NET_WM_MOVERESIZE");
  73     CREATE(net_moveresize_window, "_NET_MOVERESIZE_WINDOW");
  74
  75     CREATE(net_startup_id, "_NET_STARTUP_ID");
  76
  77     CREATE(net_wm_name, "_NET_WM_NAME");
  78     CREATE(net_wm_visible_name, "_NET_WM_VISIBLE_NAME");
  79     CREATE(net_wm_icon_name, "_NET_WM_ICON_NAME");
  80     CREATE(net_wm_visible_icon_name, "_NET_WM_VISIBLE_ICON_NAME");
  81     CREATE(net_wm_desktop, "_NET_WM_DESKTOP");
  82     CREATE(net_wm_window_type, "_NET_WM_WINDOW_TYPE");
  83     CREATE(net_wm_state, "_NET_WM_STATE");
  84     CREATE(net_wm_strut, "_NET_WM_STRUT");
  85     CREATE(net_wm_strut_partial, "_NET_WM_STRUT_PARTIAL");
  86     CREATE(net_wm_icon, "_NET_WM_ICON");
  87 /*   CREATE(net_wm_pid, "_NET_WM_PID"); */
  88     CREATE(net_wm_allowed_actions, "_NET_WM_ALLOWED_ACTIONS");
  89     CREATE(net_wm_user_time, "_NET_WM_USER_TIME");
  90     CREATE(net_frame_extents, "_NET_FRAME_EXTENTS");
  91
  92 /*   CREATE(net_wm_ping, "_NET_WM_PING"); */
  93
  94     CREATE(net_wm_window_type_desktop, "_NET_WM_WINDOW_TYPE_DESKTOP");
  95     CREATE(net_wm_window_type_dock, "_NET_WM_WINDOW_TYPE_DOCK");
  96     CREATE(net_wm_window_type_toolbar, "_NET_WM_WINDOW_TYPE_TOOLBAR");
  97     CREATE(net_wm_window_type_menu, "_NET_WM_WINDOW_TYPE_MENU");
  98     CREATE(net_wm_window_type_utility, "_NET_WM_WINDOW_TYPE_UTILITY");
  99     CREATE(net_wm_window_type_splash, "_NET_WM_WINDOW_TYPE_SPLASH");
 100     CREATE(net_wm_window_type_dialog, "_NET_WM_WINDOW_TYPE_DIALOG");
 101     CREATE(net_wm_window_type_normal, "_NET_WM_WINDOW_TYPE_NORMAL");
 102
 103     prop_atoms.net_wm_moveresize_size_topleft = 0;
 104     prop_atoms.net_wm_moveresize_size_top = 1;
 105     prop_atoms.net_wm_moveresize_size_topright = 2;
 106     prop_atoms.net_wm_moveresize_size_right = 3;
 107     prop_atoms.net_wm_moveresize_size_bottomright = 4;
 108     prop_atoms.net_wm_moveresize_size_bottom = 5;
 109     prop_atoms.net_wm_moveresize_size_bottomleft = 6;
 110     prop_atoms.net_wm_moveresize_size_left = 7;
 111     prop_atoms.net_wm_moveresize_move = 8;
 112     prop_atoms.net_wm_moveresize_size_keyboard = 9;
 113     prop_atoms.net_wm_moveresize_move_keyboard = 10;
 114     prop_atoms.net_wm_moveresize_cancel = 11;
 115
 116     CREATE(net_wm_action_move, "_NET_WM_ACTION_MOVE");
 117     CREATE(net_wm_action_resize, "_NET_WM_ACTION_RESIZE");
 118     CREATE(net_wm_action_minimize, "_NET_WM_ACTION_MINIMIZE");
 119     CREATE(net_wm_action_shade, "_NET_WM_ACTION_SHADE");
 120     CREATE(net_wm_action_stick, "_NET_WM_ACTION_STICK");
 121     CREATE(net_wm_action_maximize_horz, "_NET_WM_ACTION_MAXIMIZE_HORZ");
 122     CREATE(net_wm_action_maximize_vert, "_NET_WM_ACTION_MAXIMIZE_VERT");
 123     CREATE(net_wm_action_fullscreen, "_NET_WM_ACTION_FULLSCREEN");
 124     CREATE(net_wm_action_change_desktop, "_NET_WM_ACTION_CHANGE_DESKTOP");
 125     CREATE(net_wm_action_close, "_NET_WM_ACTION_CLOSE");
 126     CREATE(net_wm_state_modal, "_NET_WM_STATE_MODAL");
 127     CREATE(net_wm_state_sticky, "_NET_WM_STATE_STICKY");
 128     CREATE(net_wm_state_maximized_vert, "_NET_WM_STATE_MAXIMIZED_VERT");
 129     CREATE(net_wm_state_maximized_horz, "_NET_WM_STATE_MAXIMIZED_HORZ");
 130     CREATE(net_wm_state_shaded, "_NET_WM_STATE_SHADED");
 131     CREATE(net_wm_state_skip_taskbar, "_NET_WM_STATE_SKIP_TASKBAR");
 132     CREATE(net_wm_state_skip_pager, "_NET_WM_STATE_SKIP_PAGER");
 133     CREATE(net_wm_state_hidden, "_NET_WM_STATE_HIDDEN");
 134     CREATE(net_wm_state_fullscreen, "_NET_WM_STATE_FULLSCREEN");
 135     CREATE(net_wm_state_above, "_NET_WM_STATE_ABOVE");
 136     CREATE(net_wm_state_below, "_NET_WM_STATE_BELOW");
 137     CREATE(net_wm_state_demands_attention, "_NET_WM_STATE_DEMANDS_ATTENTION");
 138
 139     prop_atoms.net_wm_state_add = 1;
 140     prop_atoms.net_wm_state_remove = 0;
 141     prop_atoms.net_wm_state_toggle = 2;
 142
 143     prop_atoms.net_wm_orientation_horz = 0;
 144     prop_atoms.net_wm_orientation_vert = 1;
 145     prop_atoms.net_wm_topleft = 0;
 146     prop_atoms.net_wm_topright = 1;
 147     prop_atoms.net_wm_bottomright = 2;
 148     prop_atoms.net_wm_bottomleft = 3;
 149
 150     CREATE(kde_wm_change_state, "_KDE_WM_CHANGE_STATE");
 151     CREATE(kde_net_wm_window_type_override,"_KDE_NET_WM_WINDOW_TYPE_OVERRIDE");
 152
 153     CREATE(rootpmapid, "_XROOTPMAP_ID");
 154     CREATE(esetrootid, "ESETROOT_PMAP_ID");
 155
 156     CREATE(openbox_pid, "_OPENBOX_PID");
 157     CREATE(openbox_rc, "_OPENBOX_RC");
 158     CREATE(ob_wm_state_undecorated, "_OB_WM_STATE_UNDECORATED");
 159     CREATE(ob_control, "_OB_CONTROL");
 160 }
 161
 162 #include <X11/Xutil.h>
 163 #include <glib.h>
 164 #include <string.h>
 165
 166 /* this just isn't used... and it also breaks on 64bit, watch out
 167 static gboolean get(Window win, Atom prop, Atom type, gint size,
 168                     guchar **data, gulong num)
 169 {
 170     gboolean ret = FALSE;
 171     gint res;
 172     guchar *xdata = NULL;
 173     Atom ret_type;
 174     gint ret_size;
 175     gulong ret_items, bytes_left;
 176     glong num32 = 32 / size * num; /\* num in 32-bit elements *\/
 177
 178     res = XGetWindowProperty(display, win, prop, 0l, num32,
 179                              FALSE, type, &ret_type, &ret_size,
 180                              &ret_items, &bytes_left, &xdata);
 181     if (res == Success && ret_items && xdata) {
 182         if (ret_size == size && ret_items >= num) {
 183             *data = g_memdup(xdata, num * (size / 8));
 184             ret = TRUE;
 185         }
 186         XFree(xdata);
 187     }
 188     return ret;
 189 }
 190 */
 191
 192 static gboolean get_prealloc(Window win, Atom prop, Atom type, gint size,
 193                              guchar *data, gulong num)
 194 {
 195     gboolean ret = FALSE;
 196     gint res;
 197     guchar *xdata = NULL;
 198     Atom ret_type;
 199     gint ret_size;
 200     gulong ret_items, bytes_left;
 201     glong num32 = 32 / size * num; /* num in 32-bit elements */
 202
 203     res = XGetWindowProperty(ob_display, win, prop, 0l, num32,
 204                              FALSE, type, &ret_type, &ret_size,
 205                              &ret_items, &bytes_left, &xdata);
 206     if (res == Success && ret_items && xdata) {
 207         if (ret_size == size && ret_items >= num) {
 208             guint i;
 209             for (i = 0; i < num; ++i)
 210                 switch (size) {
 211                 case 8:
 212                     data[i] = xdata[i];
 213                     break;
 214                 case 16:
 215                     ((guint16*)data)[i] = ((gushort*)xdata)[i];
 216                     break;
 217                 case 32:
 218                     ((guint32*)data)[i] = ((gulong*)xdata)[i];
 219                     break;
 220                 default:
 221                     g_assert_not_reached(); /* unhandled size */
 222                 }
 223             ret = TRUE;
 224         }
 225         XFree(xdata);
 226     }
 227     return ret;
 228 }
 229
 230 static gboolean get_all(Window win, Atom prop, Atom type, gint size,
 231                         guchar **data, guint *num)
 232 {
 233     gboolean ret = FALSE;
 234     gint res;
 235     guchar *xdata = NULL;
 236     Atom ret_type;
 237     gint ret_size;
 238     gulong ret_items, bytes_left;
 239
 240     res = XGetWindowProperty(ob_display, win, prop, 0l, G_MAXLONG,
 241                              FALSE, type, &ret_type, &ret_size,
 242                              &ret_items, &bytes_left, &xdata);
 243     if (res == Success) {
 244         if (ret_size == size && ret_items > 0) {
 245             guint i;
 246
 247             *data = g_malloc(ret_items * (size / 8));
 248             for (i = 0; i < ret_items; ++i)
 249                 switch (size) {
 250                 case 8:
 251                     (*data)[i] = xdata[i];
 252                     break;
 253                 case 16:
 254                     ((guint16*)*data)[i] = ((gushort*)xdata)[i];
 255                     break;
 256                 case 32:
 257                     ((guint32*)*data)[i] = ((gulong*)xdata)[i];
 258                     break;
 259                 default:
 260                     g_assert_not_reached(); /* unhandled size */
 261                 }
 262             *num = ret_items;
 263             ret = TRUE;
 264         }
 265         XFree(xdata);
 266     }
 267     return ret;
 268 }
 269
 270 static gboolean get_stringlist(Window win, Atom prop, gchar ***list, gint *nstr)
 271 {
 272     XTextProperty tprop;
 273     gboolean ret = FALSE;
 274
 275     if (XGetTextProperty(ob_display, win, &tprop, prop) && tprop.nitems) {
 276         if (XTextPropertyToStringList(&tprop, list, nstr))
 277             ret = TRUE;
 278         XFree(tprop.value);
 279     }
 280     return ret;
 281 }
 282
 283 gboolean prop_get32(Window win, Atom prop, Atom type, guint32 *ret)
 284 {
 285     return get_prealloc(win, prop, type, 32, (guchar*)ret, 1);
 286 }
 287
 288 gboolean prop_get_array32(Window win, Atom prop, Atom type, guint32 **ret,
 289                           guint *nret)
 290 {
 291     return get_all(win, prop, type, 32, (guchar**)ret, nret);
 292 }
 293
 294 gboolean prop_get_string_locale(Window win, Atom prop, gchar **ret)
 295 {
 296     gchar **list;
 297     gint nstr;
 298     gchar *s;
 299
 300     if (get_stringlist(win, prop, &list, &nstr) && nstr) {
 301         s = g_convert(list[0], strlen(list[0]), "UTF-8", "ISO-8859-1",
 302                       NULL, NULL, NULL);
 303         XFreeStringList(list);
 304         if (s) {
 305             *ret = s;
 306             return TRUE;
 307         }
 308     }
 309     return FALSE;
 310 }
 311
 312 gboolean prop_get_strings_locale(Window win, Atom prop, gchar ***ret)
 313 {
 314     GSList *strs = NULL, *it;
 315     gchar *raw, *p;
 316     guint num, i, count = 0;
 317
 318     if (get_all(win, prop, prop_atoms.string, 8, (guchar**)&raw, &num)) {
 319
 320         p = raw;
 321         while (p < raw + num - 1) {
 322             ++count;
 323             strs = g_slist_append(strs, p);
 324             p += strlen(p) + 1; /* next string */
 325         }
 326
 327         *ret = g_new0(gchar*, count + 1);
 328         (*ret)[count] = NULL; /* null terminated list */
 329
 330         for (i = 0, it = strs; it; ++i, it = g_slist_next(it)) {
 331             (*ret)[i] = g_convert(it->data, -1, "UTF-8", "ISO-8859-1",
 332                                   NULL, NULL, NULL);
 333             /* make sure translation did not fail */
 334             if (!(*ret)[i])
 335                 (*ret)[i] = g_strdup("");
 336         }
 337         g_free(raw);
 338         g_slist_free(strs);
 339         return TRUE;
 340     }
 341     return FALSE;
 342 }
 343
 344 gboolean prop_get_string_utf8(Window win, Atom prop, gchar **ret)
 345 {
 346     gchar *raw;
 347     gchar *str;
 348     guint num;
 349
 350     if (get_all(win, prop, prop_atoms.utf8, 8, (guchar**)&raw, &num)) {
 351         str = g_strndup(raw, num); /* grab the first string from the list */
 352         g_free(raw);
 353         if (g_utf8_validate(str, -1, NULL)) {
 354             *ret = str;
 355             return TRUE;
 356         }
 357         g_free(str);
 358     }
 359     return FALSE;
 360 }
 361
 362 gboolean prop_get_strings_utf8(Window win, Atom prop, gchar ***ret)
 363 {
 364     GSList *strs = NULL, *it;
 365     gchar *raw, *p;
 366     guint num, i, count = 0;
 367
 368     if (get_all(win, prop, prop_atoms.utf8, 8, (guchar**)&raw, &num)) {
 369
 370         p = raw;
 371         while (p < raw + num - 1) {
 372             ++count;
 373             strs = g_slist_append(strs, p);
 374             p += strlen(p) + 1; /* next string */
 375         }
 376
 377         *ret = g_new0(gchar*, count + 1);
 378
 379         for (i = 0, it = strs; it; ++i, it = g_slist_next(it)) {
 380             if (g_utf8_validate(it->data, -1, NULL))
 381                 (*ret)[i] = g_strdup(it->data);
 382             else
 383                 (*ret)[i] = g_strdup("");
 384         }
 385         g_free(raw);
 386         g_slist_free(strs);
 387         return TRUE;
 388     }
 389     return FALSE;
 390 }
 391
 392 void prop_set32(Window win, Atom prop, Atom type, gulong val)
 393 {
 394     XChangeProperty(ob_display, win, prop, type, 32, PropModeReplace,
 395                     (guchar*)&val, 1);
 396 }
 397
 398 void prop_set_array32(Window win, Atom prop, Atom type, gulong *val,
 399                       guint num)
 400 {
 401     XChangeProperty(ob_display, win, prop, type, 32, PropModeReplace,
 402                     (guchar*)val, num);
 403 }
 404
 405 void prop_set_string_utf8(Window win, Atom prop, const gchar *val)
 406 {
 407     XChangeProperty(ob_display, win, prop, prop_atoms.utf8, 8,
 408                     PropModeReplace, (guchar*)val, strlen(val));
 409 }
 410
 411 void prop_set_strings_utf8(Window win, Atom prop, gchar **strs)
 412 {
 413     GString *str;
 414     gchar **s;
 415
 416     str = g_string_sized_new(0);
 417     for (s = strs; *s; ++s) {
 418         str = g_string_append(str, *s);
 419         str = g_string_append_c(str, '\0');
 420     }
 421     XChangeProperty(ob_display, win, prop, prop_atoms.utf8, 8,
 422                     PropModeReplace, (guchar*)str->str, str->len);
 423     g_string_free(str, TRUE);
 424 }
 425
 426 void prop_erase(Window win, Atom prop)
 427 {
 428     XDeleteProperty(ob_display, win, prop);
 429 }
 430
 431 void prop_message(Window about, Atom messagetype, glong data0, glong data1,
 432                   glong data2, glong data3, glong mask)
 433 {
 434     XEvent ce;
 435     ce.xclient.type = ClientMessage;
 436     ce.xclient.message_type = messagetype;
 437     ce.xclient.display = ob_display;
 438     ce.xclient.window = about;
 439     ce.xclient.format = 32;
 440     ce.xclient.data.l[0] = data0;
 441     ce.xclient.data.l[1] = data1;
 442     ce.xclient.data.l[2] = data2;
 443     ce.xclient.data.l[3] = data3;
 444     XSendEvent(ob_display, RootWindow(ob_display, ob_screen), FALSE,
 445                mask, &ce);
 446 }