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     CREATE(ob_control, "_OB_CONTROL");
 156 }
 157
 158 #include <X11/Xutil.h>
 159 #include <glib.h>
 160 #include <string.h>
 161
 162 /* this just isn't used... and it also breaks on 64bit, watch out
 163 static gboolean get(Window win, Atom prop, Atom type, gint size,
 164                     guchar **data, gulong num)
 165 {
 166     gboolean ret = FALSE;
 167     gint res;
 168     guchar *xdata = NULL;
 169     Atom ret_type;
 170     gint ret_size;
 171     gulong ret_items, bytes_left;
 172     glong num32 = 32 / size * num; /\* num in 32-bit elements *\/
 173
 174     res = XGetWindowProperty(display, win, prop, 0l, num32,
 175                              FALSE, type, &ret_type, &ret_size,
 176                              &ret_items, &bytes_left, &xdata);
 177     if (res == Success && ret_items && xdata) {
 178         if (ret_size == size && ret_items >= num) {
 179             *data = g_memdup(xdata, num * (size / 8));
 180             ret = TRUE;
 181         }
 182         XFree(xdata);
 183     }
 184     return ret;
 185 }
 186 */
 187
 188 static gboolean get_prealloc(Window win, Atom prop, Atom type, gint size,
 189                              guchar *data, gulong num)
 190 {
 191     gboolean ret = FALSE;
 192     gint res;
 193     guchar *xdata = NULL;
 194     Atom ret_type;
 195     gint ret_size;
 196     gulong ret_items, bytes_left;
 197     glong num32 = 32 / size * num; /* num in 32-bit elements */
 198
 199     res = XGetWindowProperty(ob_display, win, prop, 0l, num32,
 200                              FALSE, type, &ret_type, &ret_size,
 201                              &ret_items, &bytes_left, &xdata);
 202     if (res == Success && ret_items && xdata) {
 203         if (ret_size == size && ret_items >= num) {
 204             guint i;
 205             for (i = 0; i < num; ++i)
 206                 switch (size) {
 207                 case 8:
 208                     data[i] = xdata[i];
 209                     break;
 210                 case 16:
 211                     ((guint16*)data)[i] = ((gushort*)xdata)[i];
 212                     break;
 213                 case 32:
 214                     ((guint32*)data)[i] = ((gulong*)xdata)[i];
 215                     break;
 216                 default:
 217                     g_assert_not_reached(); /* unhandled size */
 218                 }
 219             ret = TRUE;
 220         }
 221         XFree(xdata);
 222     }
 223     return ret;
 224 }
 225
 226 static gboolean get_all(Window win, Atom prop, Atom type, gint size,
 227                         guchar **data, guint *num)
 228 {
 229     gboolean ret = FALSE;
 230     gint res;
 231     guchar *xdata = NULL;
 232     Atom ret_type;
 233     gint ret_size;
 234     gulong ret_items, bytes_left;
 235
 236     res = XGetWindowProperty(ob_display, win, prop, 0l, G_MAXLONG,
 237                              FALSE, type, &ret_type, &ret_size,
 238                              &ret_items, &bytes_left, &xdata);
 239     if (res == Success) {
 240         if (ret_size == size && ret_items > 0) {
 241             guint i;
 242
 243             *data = g_malloc(ret_items * (size / 8));
 244             for (i = 0; i < ret_items; ++i)
 245                 switch (size) {
 246                 case 8:
 247                     (*data)[i] = xdata[i];
 248                     break;
 249                 case 16:
 250                     ((guint16*)*data)[i] = ((gushort*)xdata)[i];
 251                     break;
 252                 case 32:
 253                     ((guint32*)*data)[i] = ((gulong*)xdata)[i];
 254                     break;
 255                 default:
 256                     g_assert_not_reached(); /* unhandled size */
 257                 }
 258             *num = ret_items;
 259             ret = TRUE;
 260         }
 261         XFree(xdata);
 262     }
 263     return ret;
 264 }
 265
 266 static gboolean get_stringlist(Window win, Atom prop, gchar ***list, gint *nstr)
 267 {
 268     XTextProperty tprop;
 269     gboolean ret = FALSE;
 270
 271     if (XGetTextProperty(ob_display, win, &tprop, prop) && tprop.nitems) {
 272         if (XTextPropertyToStringList(&tprop, list, nstr))
 273             ret = TRUE;
 274         XFree(tprop.value);
 275     }
 276     return ret;
 277 }
 278
 279 gboolean prop_get32(Window win, Atom prop, Atom type, guint32 *ret)
 280 {
 281     return get_prealloc(win, prop, type, 32, (guchar*)ret, 1);
 282 }
 283
 284 gboolean prop_get_array32(Window win, Atom prop, Atom type, guint32 **ret,
 285                           guint *nret)
 286 {
 287     return get_all(win, prop, type, 32, (guchar**)ret, nret);
 288 }
 289
 290 gboolean prop_get_string_locale(Window win, Atom prop, gchar **ret)
 291 {
 292     gchar **list;
 293     gint nstr;
 294     gchar *s;
 295
 296     if (get_stringlist(win, prop, &list, &nstr) && nstr) {
 297         s = g_convert(list[0], strlen(list[0]), "UTF-8", "ISO-8859-1",
 298                       NULL, NULL, NULL);
 299         XFreeStringList(list);
 300         if (s) {
 301             *ret = s;
 302             return TRUE;
 303         }
 304     }
 305     return FALSE;
 306 }
 307
 308 gboolean prop_get_strings_locale(Window win, Atom prop, gchar ***ret)
 309 {
 310     GSList *strs = NULL, *it;
 311     gchar *raw, *p;
 312     guint num, i, count = 0;
 313
 314     if (get_all(win, prop, prop_atoms.string, 8, (guchar**)&raw, &num)) {
 315
 316         p = raw;
 317         while (p < raw + num - 1) {
 318             ++count;
 319             strs = g_slist_append(strs, p);
 320             p += strlen(p) + 1; /* next string */
 321         }
 322
 323         *ret = g_new0(gchar*, count + 1);
 324         (*ret)[count] = NULL; /* null terminated list */
 325
 326         for (i = 0, it = strs; it; ++i, it = g_slist_next(it)) {
 327             (*ret)[i] = g_convert(it->data, -1, "UTF-8", "ISO-8859-1",
 328                                   NULL, NULL, NULL);
 329             /* make sure translation did not fail */
 330             if (!(*ret)[i])
 331                 (*ret)[i] = g_strdup("");
 332         }
 333         g_free(raw);
 334         g_slist_free(strs);
 335         return TRUE;
 336     }
 337     return FALSE;
 338 }
 339
 340 gboolean prop_get_string_utf8(Window win, Atom prop, gchar **ret)
 341 {
 342     gchar *raw;
 343     gchar *str;
 344     guint num;
 345
 346     if (get_all(win, prop, prop_atoms.utf8, 8, (guchar**)&raw, &num)) {
 347         str = g_strndup(raw, num); /* grab the first string from the list */
 348         g_free(raw);
 349         if (g_utf8_validate(str, -1, NULL)) {
 350             *ret = str;
 351             return TRUE;
 352         }
 353         g_free(str);
 354     }
 355     return FALSE;
 356 }
 357
 358 gboolean prop_get_strings_utf8(Window win, Atom prop, gchar ***ret)
 359 {
 360     GSList *strs = NULL, *it;
 361     gchar *raw, *p;
 362     guint num, i, count = 0;
 363
 364     if (get_all(win, prop, prop_atoms.utf8, 8, (guchar**)&raw, &num)) {
 365
 366         p = raw;
 367         while (p < raw + num - 1) {
 368             ++count;
 369             strs = g_slist_append(strs, p);
 370             p += strlen(p) + 1; /* next string */
 371         }
 372
 373         *ret = g_new0(gchar*, count + 1);
 374
 375         for (i = 0, it = strs; it; ++i, it = g_slist_next(it)) {
 376             if (g_utf8_validate(it->data, -1, NULL))
 377                 (*ret)[i] = g_strdup(it->data);
 378             else
 379                 (*ret)[i] = g_strdup("");
 380         }
 381         g_free(raw);
 382         g_slist_free(strs);
 383         return TRUE;
 384     }
 385     return FALSE;
 386 }
 387
 388 void prop_set32(Window win, Atom prop, Atom type, gulong val)
 389 {
 390     XChangeProperty(ob_display, win, prop, type, 32, PropModeReplace,
 391                     (guchar*)&val, 1);
 392 }
 393
 394 void prop_set_array32(Window win, Atom prop, Atom type, gulong *val,
 395                       guint num)
 396 {
 397     XChangeProperty(ob_display, win, prop, type, 32, PropModeReplace,
 398                     (guchar*)val, num);
 399 }
 400
 401 void prop_set_string_utf8(Window win, Atom prop, gchar *val)
 402 {
 403     XChangeProperty(ob_display, win, prop, prop_atoms.utf8, 8,
 404                     PropModeReplace, (guchar*)val, strlen(val));
 405 }
 406
 407 void prop_set_strings_utf8(Window win, Atom prop, gchar **strs)
 408 {
 409     GString *str;
 410     gchar **s;
 411
 412     str = g_string_sized_new(0);
 413     for (s = strs; *s; ++s) {
 414         str = g_string_append(str, *s);
 415         str = g_string_append_c(str, '\0');
 416     }
 417     XChangeProperty(ob_display, win, prop, prop_atoms.utf8, 8,
 418                     PropModeReplace, (guchar*)str->str, str->len);
 419     g_string_free(str, TRUE);
 420 }
 421
 422 void prop_erase(Window win, Atom prop)
 423 {
 424     XDeleteProperty(ob_display, win, prop);
 425 }
 426
 427 void prop_message(Window about, Atom messagetype, glong data0, glong data1,
 428                   glong data2, glong data3, glong mask)
 429 {
 430     XEvent ce;
 431     ce.xclient.type = ClientMessage;
 432     ce.xclient.message_type = messagetype;
 433     ce.xclient.display = ob_display;
 434     ce.xclient.window = about;
 435     ce.xclient.format = 32;
 436     ce.xclient.data.l[0] = data0;
 437     ce.xclient.data.l[1] = data1;
 438     ce.xclient.data.l[2] = data2;
 439     ce.xclient.data.l[3] = data3;
 440     XSendEvent(ob_display, RootWindow(ob_display, ob_screen), FALSE,
 441                mask, &ce);
 442 }