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