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