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