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