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