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) 2003        Ben Jansens
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    See the COPYING file for a copy of the GNU General Public License.
  17 */
  18
  19 #include "prop.h"
  20 #include "openbox.h"
  21
  22 #include <X11/Xatom.h>
  23
  24 Atoms prop_atoms;
  25
  26 #define CREATE(var, name) (prop_atoms.var = \
  27                            XInternAtom(ob_display, name, FALSE))
  28
  29 void prop_startup()
  30 {
  31     CREATE(cardinal, "CARDINAL");
  32     CREATE(window, "WINDOW");
  33     CREATE(pixmap, "PIXMAP");
  34     CREATE(atom, "ATOM");
  35     CREATE(string, "STRING");
  36     CREATE(utf8, "UTF8_STRING");
  37
  38     CREATE(manager, "MANAGER");
  39
  40     CREATE(wm_colormap_windows, "WM_COLORMAP_WINDOWS");
  41     CREATE(wm_protocols, "WM_PROTOCOLS");
  42     CREATE(wm_state, "WM_STATE");
  43     CREATE(wm_change_state, "WM_CHANGE_STATE");
  44     CREATE(wm_delete_window, "WM_DELETE_WINDOW");
  45     CREATE(wm_take_focus, "WM_TAKE_FOCUS");
  46     CREATE(wm_name, "WM_NAME");
  47     CREATE(wm_icon_name, "WM_ICON_NAME");
  48     CREATE(wm_class, "WM_CLASS");
  49     CREATE(wm_window_role, "WM_WINDOW_ROLE");
  50     CREATE(motif_wm_hints, "_MOTIF_WM_HINTS");
  51
  52     CREATE(sm_client_id, "SM_CLIENT_ID");
  53
  54     CREATE(net_supported, "_NET_SUPPORTED");
  55     CREATE(net_client_list, "_NET_CLIENT_LIST");
  56     CREATE(net_client_list_stacking, "_NET_CLIENT_LIST_STACKING");
  57     CREATE(net_number_of_desktops, "_NET_NUMBER_OF_DESKTOPS");
  58     CREATE(net_desktop_geometry, "_NET_DESKTOP_GEOMETRY");
  59     CREATE(net_desktop_viewport, "_NET_DESKTOP_VIEWPORT");
  60     CREATE(net_current_desktop, "_NET_CURRENT_DESKTOP");
  61     CREATE(net_desktop_names, "_NET_DESKTOP_NAMES");
  62     CREATE(net_active_window, "_NET_ACTIVE_WINDOW");
  63     CREATE(net_workarea, "_NET_WORKAREA");
  64     CREATE(net_supporting_wm_check, "_NET_SUPPORTING_WM_CHECK");
  65     CREATE(net_desktop_layout, "_NET_DESKTOP_LAYOUT");
  66     CREATE(net_showing_desktop, "_NET_SHOWING_DESKTOP");
  67
  68     CREATE(net_close_window, "_NET_CLOSE_WINDOW");
  69     CREATE(net_wm_moveresize, "_NET_WM_MOVERESIZE");
  70     CREATE(net_moveresize_window, "_NET_MOVERESIZE_WINDOW");
  71
  72     CREATE(net_startup_id, "_NET_STARTUP_ID");
  73
  74     CREATE(net_wm_name, "_NET_WM_NAME");
  75     CREATE(net_wm_visible_name, "_NET_WM_VISIBLE_NAME");
  76     CREATE(net_wm_icon_name, "_NET_WM_ICON_NAME");
  77     CREATE(net_wm_visible_icon_name, "_NET_WM_VISIBLE_ICON_NAME");
  78     CREATE(net_wm_desktop, "_NET_WM_DESKTOP");
  79     CREATE(net_wm_window_type, "_NET_WM_WINDOW_TYPE");
  80     CREATE(net_wm_state, "_NET_WM_STATE");
  81     CREATE(net_wm_strut, "_NET_WM_STRUT");
  82     CREATE(net_wm_strut_partial, "_NET_WM_STRUT_PARTIAL");
  83     CREATE(net_wm_icon, "_NET_WM_ICON");
  84 /*   CREATE(net_wm_pid, "_NET_WM_PID"); */
  85     CREATE(net_wm_allowed_actions, "_NET_WM_ALLOWED_ACTIONS");
  86
  87 /*   CREATE(net_wm_ping, "_NET_WM_PING"); */
  88
  89     CREATE(net_wm_window_type_desktop, "_NET_WM_WINDOW_TYPE_DESKTOP");
  90     CREATE(net_wm_window_type_dock, "_NET_WM_WINDOW_TYPE_DOCK");
  91     CREATE(net_wm_window_type_toolbar, "_NET_WM_WINDOW_TYPE_TOOLBAR");
  92     CREATE(net_wm_window_type_menu, "_NET_WM_WINDOW_TYPE_MENU");
  93     CREATE(net_wm_window_type_utility, "_NET_WM_WINDOW_TYPE_UTILITY");
  94     CREATE(net_wm_window_type_splash, "_NET_WM_WINDOW_TYPE_SPLASH");
  95     CREATE(net_wm_window_type_dialog, "_NET_WM_WINDOW_TYPE_DIALOG");
  96     CREATE(net_wm_window_type_normal, "_NET_WM_WINDOW_TYPE_NORMAL");
  97
  98     prop_atoms.net_wm_moveresize_size_topleft = 0;
  99     prop_atoms.net_wm_moveresize_size_top = 1;
 100     prop_atoms.net_wm_moveresize_size_topright = 2;
 101     prop_atoms.net_wm_moveresize_size_right = 3;
 102     prop_atoms.net_wm_moveresize_size_bottomright = 4;
 103     prop_atoms.net_wm_moveresize_size_bottom = 5;
 104     prop_atoms.net_wm_moveresize_size_bottomleft = 6;
 105     prop_atoms.net_wm_moveresize_size_left = 7;
 106     prop_atoms.net_wm_moveresize_move = 8;
 107     prop_atoms.net_wm_moveresize_size_keyboard = 9;
 108     prop_atoms.net_wm_moveresize_move_keyboard = 10;
 109
 110     CREATE(net_wm_action_move, "_NET_WM_ACTION_MOVE");
 111     CREATE(net_wm_action_resize, "_NET_WM_ACTION_RESIZE");
 112     CREATE(net_wm_action_minimize, "_NET_WM_ACTION_MINIMIZE");
 113     CREATE(net_wm_action_shade, "_NET_WM_ACTION_SHADE");
 114     CREATE(net_wm_action_stick, "_NET_WM_ACTION_STICK");
 115     CREATE(net_wm_action_maximize_horz, "_NET_WM_ACTION_MAXIMIZE_HORZ");
 116     CREATE(net_wm_action_maximize_vert, "_NET_WM_ACTION_MAXIMIZE_VERT");
 117     CREATE(net_wm_action_fullscreen, "_NET_WM_ACTION_FULLSCREEN");
 118     CREATE(net_wm_action_change_desktop, "_NET_WM_ACTION_CHANGE_DESKTOP");
 119     CREATE(net_wm_action_close, "_NET_WM_ACTION_CLOSE");
 120     CREATE(net_wm_state_modal, "_NET_WM_STATE_MODAL");
 121     CREATE(net_wm_state_sticky, "_NET_WM_STATE_STICKY");
 122     CREATE(net_wm_state_maximized_vert, "_NET_WM_STATE_MAXIMIZED_VERT");
 123     CREATE(net_wm_state_maximized_horz, "_NET_WM_STATE_MAXIMIZED_HORZ");
 124     CREATE(net_wm_state_shaded, "_NET_WM_STATE_SHADED");
 125     CREATE(net_wm_state_skip_taskbar, "_NET_WM_STATE_SKIP_TASKBAR");
 126     CREATE(net_wm_state_skip_pager, "_NET_WM_STATE_SKIP_PAGER");
 127     CREATE(net_wm_state_hidden, "_NET_WM_STATE_HIDDEN");
 128     CREATE(net_wm_state_fullscreen, "_NET_WM_STATE_FULLSCREEN");
 129     CREATE(net_wm_state_above, "_NET_WM_STATE_ABOVE");
 130     CREATE(net_wm_state_below, "_NET_WM_STATE_BELOW");
 131
 132     prop_atoms.net_wm_state_add = 1;
 133     prop_atoms.net_wm_state_remove = 0;
 134     prop_atoms.net_wm_state_toggle = 2;
 135
 136     prop_atoms.net_wm_orientation_horz = 0;
 137     prop_atoms.net_wm_orientation_vert = 1;
 138     prop_atoms.net_wm_topleft = 0;
 139     prop_atoms.net_wm_topright = 1;
 140     prop_atoms.net_wm_bottomright = 2;
 141     prop_atoms.net_wm_bottomleft = 3;
 142
 143     CREATE(kde_net_system_tray_windows, "_KDE_NET_SYSTEM_TRAY_WINDOWS");
 144     CREATE(kde_net_wm_system_tray_window_for,
 145            "_KDE_NET_WM_SYSTEM_TRAY_WINDOW_FOR");
 146     CREATE(kde_net_wm_window_type_override,
 147            "_KDE_NET_WM_WINDOW_TYPE_OVERRIDE");
 148
 149     CREATE(kwm_win_icon, "KWM_WIN_ICON");
 150
 151     CREATE(rootpmapid, "_XROOTPMAP_ID");
 152     CREATE(esetrootid, "ESETROOT_PMAP_ID");
 153
 154     CREATE(openbox_pid, "_OPENBOX_PID");
 155     CREATE(openbox_premax, "_OPENBOX_PREMAX");
 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, int size,
 164                     guchar **data, gulong num)
 165 {
 166     gboolean ret = FALSE;
 167     int res;
 168     guchar *xdata = NULL;
 169     Atom ret_type;
 170     int ret_size;
 171     gulong ret_items, bytes_left;
 172     long 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, int size,
 189                              guchar *data, gulong num)
 190 {
 191     gboolean ret = FALSE;
 192     int res;
 193     guchar *xdata = NULL;
 194     Atom ret_type;
 195     int ret_size;
 196     gulong ret_items, bytes_left;
 197     long 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] = ((guint16*)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, int size,
 227                         guchar **data, guint *num)
 228 {
 229     gboolean ret = FALSE;
 230     int res;
 231     guchar *xdata = NULL;
 232     Atom ret_type;
 233     int 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] = ((guint16*)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, char ***list, int *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, char **ret)
 291 {
 292     char **list;
 293     int nstr;
 294
 295     if (get_stringlist(win, prop, &list, &nstr) && nstr) {
 296         *ret = g_convert(list[0], strlen(list[0]), "UTF-8", "ISO-8859-1",
 297                          NULL, NULL, NULL);
 298         XFreeStringList(list);
 299         if (*ret) return TRUE;
 300     }
 301     return FALSE;
 302 }
 303
 304 gboolean prop_get_strings_locale(Window win, Atom prop, char ***ret)
 305 {
 306     GSList *strs = NULL, *it;
 307     char *raw, *p;
 308     guint num, i, count = 0;
 309
 310     if (get_all(win, prop, prop_atoms.string, 8, (guchar**)&raw, &num)) {
 311
 312         p = raw;
 313         while (p < raw + num - 1) {
 314             ++count;
 315             strs = g_slist_append(strs, p);
 316             p += strlen(p) + 1; /* next string */
 317         }
 318
 319         *ret = g_new0(char*, count + 1);
 320         (*ret)[count] = NULL; /* null terminated list */
 321
 322         for (i = 0, it = strs; it; ++i, it = g_slist_next(it)) {
 323             (*ret)[i] = g_convert(it->data, -1, "UTF-8", "ISO-8859-1",
 324                                   NULL, NULL, NULL);
 325             /* make sure translation did not fail */
 326             if (!(*ret)[i])
 327                 (*ret)[i] = g_strdup("");
 328         }
 329         g_free(raw);
 330         g_slist_free(strs);
 331         return TRUE;
 332     }
 333     return FALSE;
 334 }
 335
 336 gboolean prop_get_string_utf8(Window win, Atom prop, char **ret)
 337 {
 338     char *raw;
 339     char *str;
 340     guint num;
 341
 342     if (get_all(win, prop, prop_atoms.utf8, 8, (guchar**)&raw, &num)) {
 343         str = g_strndup(raw, num); /* grab the first string from the list */
 344         g_free(raw);
 345         if (g_utf8_validate(str, -1, NULL)) {
 346             *ret = str;
 347             return TRUE;
 348         }
 349         g_free(str);
 350     }
 351     return FALSE;
 352 }
 353
 354 gboolean prop_get_strings_utf8(Window win, Atom prop, char ***ret)
 355 {
 356     GSList *strs = NULL, *it;
 357     char *raw, *p;
 358     guint num, i, count = 0;
 359
 360     if (get_all(win, prop, prop_atoms.utf8, 8, (guchar**)&raw, &num)) {
 361
 362         p = raw;
 363         while (p < raw + num - 1) {
 364             ++count;
 365             strs = g_slist_append(strs, p);
 366             p += strlen(p) + 1; /* next string */
 367         }
 368
 369         *ret = g_new0(char*, count + 1);
 370
 371         for (i = 0, it = strs; it; ++i, it = g_slist_next(it)) {
 372             if (g_utf8_validate(it->data, -1, NULL))
 373                 (*ret)[i] = g_strdup(it->data);
 374             else
 375                 (*ret)[i] = g_strdup("");
 376         }
 377         g_free(raw);
 378         g_slist_free(strs);
 379         return TRUE;
 380     }
 381     return FALSE;
 382 }
 383
 384 void prop_set32(Window win, Atom prop, Atom type, guint32 val)
 385 {
 386     XChangeProperty(ob_display, win, prop, type, 32, PropModeReplace,
 387                     (guchar*)&val, 1);
 388 }
 389
 390 void prop_set_array32(Window win, Atom prop, Atom type, guint32 *val,
 391                       guint num)
 392 {
 393     XChangeProperty(ob_display, win, prop, type, 32, PropModeReplace,
 394                     (guchar*)val, num);
 395 }
 396
 397 void prop_set_string_utf8(Window win, Atom prop, char *val)
 398 {
 399     XChangeProperty(ob_display, win, prop, prop_atoms.utf8, 8,
 400                     PropModeReplace, (guchar*)val, strlen(val));
 401 }
 402
 403 void prop_set_strings_utf8(Window win, Atom prop, char **strs)
 404 {
 405     GString *str;
 406     char **s;
 407
 408     str = g_string_sized_new(0);
 409     for (s = strs; *s; ++s) {
 410         str = g_string_append(str, *s);
 411         str = g_string_append_c(str, '\0');
 412     }
 413     XChangeProperty(ob_display, win, prop, prop_atoms.utf8, 8,
 414                     PropModeReplace, (guchar*)str->str, str->len);
 415     g_string_free(str, TRUE);
 416 }
 417
 418 void prop_erase(Window win, Atom prop)
 419 {
 420     XDeleteProperty(ob_display, win, prop);
 421 }
 422
 423 void prop_message(Window about, Atom messagetype, long data0, long data1,
 424                   long data2, long data3, long mask)
 425 {
 426     XEvent ce;
 427     ce.xclient.type = ClientMessage;
 428     ce.xclient.message_type = messagetype;
 429     ce.xclient.display = ob_display;
 430     ce.xclient.window = about;
 431     ce.xclient.format = 32;
 432     ce.xclient.data.l[0] = data0;
 433     ce.xclient.data.l[1] = data1;
 434     ce.xclient.data.l[2] = data2;
 435     ce.xclient.data.l[3] = data3;
 436     XSendEvent(ob_display, RootWindow(ob_display, ob_screen), FALSE,
 437                mask, &ce);
 438 }