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