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