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