Remove unused variable
[dana/openbox.git] / obt / prop.c
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    obt/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 "obt/prop.h"
21 #include "obt/display.h"
22
23 #include <X11/Xatom.h>
24 #ifdef HAVE_STRING_H
25 #  include <string.h>
26 #endif
27
28 Atom prop_atoms[OBT_PROP_NUM_ATOMS];
29 gboolean prop_started = FALSE;
30
31 #define CREATE_NAME(var, name) (prop_atoms[OBT_PROP_##var] = \
32                                 XInternAtom((obt_display), (name), FALSE))
33 #define CREATE(var) CREATE_NAME(var, #var)
34 #define CREATE_(var) CREATE_NAME(var, "_" #var)
35
36 void obt_prop_startup(void)
37 {
38     if (prop_started) return;
39     prop_started = TRUE;
40
41     g_assert(obt_display);
42
43     CREATE(CARDINAL);
44     CREATE(WINDOW);
45     CREATE(PIXMAP);
46     CREATE(ATOM);
47     CREATE(STRING);
48     CREATE(COMPOUND_TEXT);
49     CREATE(UTF8_STRING);
50
51     CREATE(MANAGER);
52
53     CREATE(WM_COLORMAP_WINDOWS);
54     CREATE(WM_PROTOCOLS);
55     CREATE(WM_STATE);
56     CREATE(WM_CHANGE_STATE);
57     CREATE(WM_DELETE_WINDOW);
58     CREATE(WM_TAKE_FOCUS);
59     CREATE(WM_NAME);
60     CREATE(WM_ICON_NAME);
61     CREATE(WM_CLASS);
62     CREATE(WM_WINDOW_ROLE);
63     CREATE(WM_CLIENT_MACHINE);
64     CREATE(WM_COMMAND);
65     CREATE(WM_CLIENT_LEADER);
66     CREATE(WM_TRANSIENT_FOR);
67     CREATE_(MOTIF_WM_HINTS);
68     CREATE_(MOTIF_WM_INFO);
69
70     CREATE(SM_CLIENT_ID);
71
72     CREATE_(NET_WM_FULL_PLACEMENT);
73
74     CREATE_(NET_SUPPORTED);
75     CREATE_(NET_CLIENT_LIST);
76     CREATE_(NET_CLIENT_LIST_STACKING);
77     CREATE_(NET_NUMBER_OF_DESKTOPS);
78     CREATE_(NET_DESKTOP_GEOMETRY);
79     CREATE_(NET_DESKTOP_VIEWPORT);
80     CREATE_(NET_CURRENT_DESKTOP);
81     CREATE_(NET_DESKTOP_NAMES);
82     CREATE_(NET_ACTIVE_WINDOW);
83 /*    CREATE_(NET_RESTACK_WINDOW);*/
84     CREATE_(NET_WORKAREA);
85     CREATE_(NET_SUPPORTING_WM_CHECK);
86     CREATE_(NET_DESKTOP_LAYOUT);
87     CREATE_(NET_SHOWING_DESKTOP);
88
89     CREATE_(NET_CLOSE_WINDOW);
90     CREATE_(NET_WM_MOVERESIZE);
91     CREATE_(NET_MOVERESIZE_WINDOW);
92     CREATE_(NET_REQUEST_FRAME_EXTENTS);
93     CREATE_(NET_RESTACK_WINDOW);
94
95     CREATE_(NET_STARTUP_ID);
96
97     CREATE_(NET_WM_NAME);
98     CREATE_(NET_WM_VISIBLE_NAME);
99     CREATE_(NET_WM_ICON_NAME);
100     CREATE_(NET_WM_VISIBLE_ICON_NAME);
101     CREATE_(NET_WM_DESKTOP);
102     CREATE_(NET_WM_WINDOW_TYPE);
103     CREATE_(NET_WM_STATE);
104     CREATE_(NET_WM_STRUT);
105     CREATE_(NET_WM_STRUT_PARTIAL);
106     CREATE_(NET_WM_ICON);
107     CREATE_(NET_WM_ICON_GEOMETRY);
108     CREATE_(NET_WM_PID);
109     CREATE_(NET_WM_ALLOWED_ACTIONS);
110     CREATE_(NET_WM_WINDOW_OPACITY);
111     CREATE_(NET_WM_USER_TIME);
112 /*  CREATE_(NET_WM_USER_TIME_WINDOW); */
113     CREATE_(KDE_NET_WM_FRAME_STRUT);
114     CREATE_(NET_FRAME_EXTENTS);
115
116     CREATE_(NET_WM_PING);
117 #ifdef SYNC
118     CREATE_(NET_WM_SYNC_REQUEST);
119     CREATE_(NET_WM_SYNC_REQUEST_COUNTER);
120 #endif
121
122     CREATE_(NET_WM_WINDOW_TYPE_DESKTOP);
123     CREATE_(NET_WM_WINDOW_TYPE_DOCK);
124     CREATE_(NET_WM_WINDOW_TYPE_TOOLBAR);
125     CREATE_(NET_WM_WINDOW_TYPE_MENU);
126     CREATE_(NET_WM_WINDOW_TYPE_UTILITY);
127     CREATE_(NET_WM_WINDOW_TYPE_SPLASH);
128     CREATE_(NET_WM_WINDOW_TYPE_DIALOG);
129     CREATE_(NET_WM_WINDOW_TYPE_NORMAL);
130     CREATE_(NET_WM_WINDOW_TYPE_POPUP_MENU);
131
132     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_TOPLEFT] = 0;
133     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_TOP] = 1;
134     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_TOPRIGHT] = 2;
135     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_RIGHT] = 3;
136     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_BOTTOMRIGHT] = 4;
137     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_BOTTOM] = 5;
138     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_BOTTOMLEFT] = 6;
139     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_LEFT] = 7;
140     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_MOVE] = 8;
141     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_KEYBOARD] = 9;
142     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_MOVE_KEYBOARD] = 10;
143     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_CANCEL] = 11;
144
145     CREATE_(NET_WM_ACTION_MOVE);
146     CREATE_(NET_WM_ACTION_RESIZE);
147     CREATE_(NET_WM_ACTION_MINIMIZE);
148     CREATE_(NET_WM_ACTION_SHADE);
149     CREATE_(NET_WM_ACTION_MAXIMIZE_HORZ);
150     CREATE_(NET_WM_ACTION_MAXIMIZE_VERT);
151     CREATE_(NET_WM_ACTION_FULLSCREEN);
152     CREATE_(NET_WM_ACTION_CHANGE_DESKTOP);
153     CREATE_(NET_WM_ACTION_CLOSE);
154     CREATE_(NET_WM_ACTION_ABOVE);
155     CREATE_(NET_WM_ACTION_BELOW);
156
157     CREATE_(NET_WM_STATE_MODAL);
158 /*    CREATE_(NET_WM_STATE_STICKY);*/
159     CREATE_(NET_WM_STATE_MAXIMIZED_VERT);
160     CREATE_(NET_WM_STATE_MAXIMIZED_HORZ);
161     CREATE_(NET_WM_STATE_SHADED);
162     CREATE_(NET_WM_STATE_SKIP_TASKBAR);
163     CREATE_(NET_WM_STATE_SKIP_PAGER);
164     CREATE_(NET_WM_STATE_HIDDEN);
165     CREATE_(NET_WM_STATE_FULLSCREEN);
166     CREATE_(NET_WM_STATE_ABOVE);
167     CREATE_(NET_WM_STATE_BELOW);
168     CREATE_(NET_WM_STATE_DEMANDS_ATTENTION);
169
170     prop_atoms[OBT_PROP_NET_WM_STATE_ADD] = 1;
171     prop_atoms[OBT_PROP_NET_WM_STATE_REMOVE] = 0;
172     prop_atoms[OBT_PROP_NET_WM_STATE_TOGGLE] = 2;
173
174     prop_atoms[OBT_PROP_NET_WM_ORIENTATION_HORZ] = 0;
175     prop_atoms[OBT_PROP_NET_WM_ORIENTATION_VERT] = 1;
176     prop_atoms[OBT_PROP_NET_WM_TOPLEFT] = 0;
177     prop_atoms[OBT_PROP_NET_WM_TOPRIGHT] = 1;
178     prop_atoms[OBT_PROP_NET_WM_BOTTOMRIGHT] = 2;
179     prop_atoms[OBT_PROP_NET_WM_BOTTOMLEFT] = 3;
180
181     CREATE_(KDE_WM_CHANGE_STATE);
182     CREATE_(KDE_NET_WM_WINDOW_TYPE_OVERRIDE);
183
184 /*
185     CREATE_NAME(ROOTPMAPId, "_XROOTPMAP_ID");
186     CREATE_NAME(ESETROOTId, "ESETROOT_PMAP_ID");
187 */
188
189     CREATE_(OPENBOX_PID);
190     CREATE_(OB_THEME);
191     CREATE_(OB_CONFIG_FILE);
192     CREATE_(OB_WM_ACTION_UNDECORATE);
193     CREATE_(OB_WM_STATE_UNDECORATED);
194     CREATE_(OB_CONTROL);
195     CREATE_(OB_VERSION);
196     CREATE_(OB_APP_ROLE);
197     CREATE_(OB_APP_TITLE);
198     CREATE_(OB_APP_NAME);
199     CREATE_(OB_APP_CLASS);
200     CREATE_(OB_APP_TYPE);
201 }
202
203 Atom obt_prop_atom(ObtPropAtom a)
204 {
205     g_assert(prop_started);
206     g_assert(a < OBT_PROP_NUM_ATOMS);
207     return prop_atoms[a];
208 }
209
210 static gboolean get_prealloc(Window win, Atom prop, Atom type, gint size,
211                              guchar *data, gulong num)
212 {
213     gboolean ret = FALSE;
214     gint res;
215     guchar *xdata = NULL;
216     Atom ret_type;
217     gint ret_size;
218     gulong ret_items, bytes_left;
219     glong num32 = 32 / size * num; /* num in 32-bit elements */
220
221     res = XGetWindowProperty(obt_display, win, prop, 0l, num32,
222                              FALSE, type, &ret_type, &ret_size,
223                              &ret_items, &bytes_left, &xdata);
224     if (res == Success && ret_items && xdata) {
225         if (ret_size == size && ret_items >= num) {
226             guint i;
227             for (i = 0; i < num; ++i)
228                 switch (size) {
229                 case 8:
230                     data[i] = xdata[i];
231                     break;
232                 case 16:
233                     ((guint16*)data)[i] = ((gushort*)xdata)[i];
234                     break;
235                 case 32:
236                     ((guint32*)data)[i] = ((gulong*)xdata)[i];
237                     break;
238                 default:
239                     g_assert_not_reached(); /* unhandled size */
240                 }
241             ret = TRUE;
242         }
243         XFree(xdata);
244     }
245     return ret;
246 }
247
248 static gboolean get_all(Window win, Atom prop, Atom type, gint size,
249                         guchar **data, guint *num)
250 {
251     gboolean ret = FALSE;
252     gint res;
253     guchar *xdata = NULL;
254     Atom ret_type;
255     gint ret_size;
256     gulong ret_items, bytes_left;
257
258     res = XGetWindowProperty(obt_display, win, prop, 0l, G_MAXLONG,
259                              FALSE, type, &ret_type, &ret_size,
260                              &ret_items, &bytes_left, &xdata);
261     if (res == Success) {
262         if (ret_size == size && ret_items > 0) {
263             guint i;
264
265             *data = g_malloc(ret_items * (size / 8));
266             for (i = 0; i < ret_items; ++i)
267                 switch (size) {
268                 case 8:
269                     (*data)[i] = xdata[i];
270                     break;
271                 case 16:
272                     ((guint16*)*data)[i] = ((gushort*)xdata)[i];
273                     break;
274                 case 32:
275                     ((guint32*)*data)[i] = ((gulong*)xdata)[i];
276                     break;
277                 default:
278                     g_assert_not_reached(); /* unhandled size */
279                 }
280             *num = ret_items;
281             ret = TRUE;
282         }
283         XFree(xdata);
284     }
285     return ret;
286 }
287
288 /*! Get a text property from a window, and fill out the XTextProperty with it.
289   @param win The window to read the property from.
290   @param prop The atom of the property to read off the window.
291   @param tprop The XTextProperty to fill out.
292   @param type 0 to get text of any type, or a value from
293     ObtPropTextType to restrict the value to a specific type.
294   @return TRUE if the text was read and validated against the @type, and FALSE
295     otherwise.
296 */
297 static gboolean get_text_property(Window win, Atom prop,
298                                   XTextProperty *tprop, ObtPropTextType type)
299 {
300     if (!(XGetTextProperty(obt_display, win, tprop, prop) && tprop->nitems))
301         return FALSE;
302     if (!type)
303         return TRUE; /* no type checking */
304     switch (type) {
305     case OBT_PROP_TEXT_STRING:
306     case OBT_PROP_TEXT_STRING_XPCS:
307     case OBT_PROP_TEXT_STRING_NO_CC:
308         return tprop->encoding == OBT_PROP_ATOM(STRING);
309     case OBT_PROP_TEXT_COMPOUND_TEXT:
310         return tprop->encoding == OBT_PROP_ATOM(COMPOUND_TEXT);
311     case OBT_PROP_TEXT_UTF8_STRING:
312         return tprop->encoding == OBT_PROP_ATOM(UTF8_STRING);
313     default:
314         g_assert_not_reached();
315     }
316 }
317
318 /*! Returns one or more UTF-8 encoded strings from the text property.
319   @param tprop The XTextProperty to convert into UTF-8 string(s).
320   @param type The type which specifies the format that the text must meet, or
321     0 to allow any valid characters that can be converted to UTF-8 through.
322   @param max The maximum number of strings to return.  -1 to return them all.
323   @return If max is 1, then this returns a gchar* with the single string.
324     Otherwise, this returns a gchar** of no more than max strings (or all
325     strings read, if max is negative). If an error occurs, NULL is returned.
326  */
327 static void* convert_text_property(XTextProperty *tprop,
328                                    ObtPropTextType type, gint max)
329 {
330     enum {
331         LATIN1,
332         UTF8,
333         LOCALE
334     } encoding;
335     const gboolean return_single = (max == 1);
336     gboolean ok = FALSE;
337     gchar **strlist = NULL;
338     gchar *single[1] = { NULL };
339     gchar **retlist = single; /* single is used when max == 1 */
340     gint i, n_strs;
341
342     /* Read each string in the text property and store a pointer to it in
343        retlist.  These pointers point into the X data structures directly.
344
345        Then we will convert them to UTF-8, and replace the retlist pointer with
346        a new one.
347     */
348     if (tprop->encoding == OBT_PROP_ATOM(COMPOUND_TEXT))
349     {
350         encoding = LOCALE;
351         ok = (XmbTextPropertyToTextList(
352                    obt_display, tprop, &strlist, &n_strs) == Success);
353         if (ok) {
354             if (max >= 0)
355                 n_strs = MIN(max, n_strs);
356             if (!return_single)
357                 retlist = g_new0(gchar*, n_strs+1);
358             if (retlist)
359                 for (i = 0; i < n_strs; ++i)
360                     retlist[i] = strlist[i];
361         }
362     }
363     else if (tprop->encoding == OBT_PROP_ATOM(UTF8_STRING) ||
364              tprop->encoding == OBT_PROP_ATOM(STRING))
365     {
366         gchar *p; /* iterator */
367
368         if (tprop->encoding == OBT_PROP_ATOM(STRING))
369             encoding = LATIN1;
370         else
371             encoding = UTF8;
372         ok = TRUE;
373
374         /* First, count the number of strings. Then make a structure for them
375            and copy pointers to them into it. */
376         p = (gchar*)tprop->value;
377         n_strs = 0;
378         while (p < (gchar*)tprop->value + tprop->nitems) {
379             p += strlen(p) + 1; /* next string */
380             ++n_strs;
381         }
382
383         if (max >= 0)
384             n_strs = MIN(max, n_strs);
385         if (!return_single)
386             retlist = g_new0(gchar*, n_strs+1);
387         if (retlist) {
388             p = (gchar*)tprop->value;
389             for (i = 0; i < n_strs; ++i) {
390                 retlist[i] = p;
391                 p += strlen(p) + 1; /* next string */
392             }
393         }
394     }
395
396     if (!(ok && retlist)) {
397         if (strlist) XFreeStringList(strlist);
398         return NULL;
399     }
400
401     /* convert each element in retlist to UTF-8, and replace it. */
402     for (i = 0; i < n_strs; ++i) {
403         if (encoding == UTF8) {
404             const gchar *end; /* the first byte past the valid data */
405
406             g_utf8_validate(retlist[i], -1, &end);
407             retlist[i] = g_strndup(retlist[i], end-retlist[i]);
408         }
409         else if (encoding == LOCALE) {
410             gsize nvalid; /* the number of valid bytes at the front of the
411                              string */
412             gchar *utf; /* the string converted into utf8 */
413
414             utf = g_locale_to_utf8(retlist[i], -1, &nvalid, NULL, NULL);
415             if (!utf)
416                 utf = g_locale_to_utf8(retlist[i], nvalid, NULL, NULL, NULL);
417             g_assert(utf);
418             retlist[i] = utf;
419         }
420         else { /* encoding == LATIN1 */
421             gsize nvalid; /* the number of valid bytes at the front of the
422                              string */
423             gchar *utf; /* the string converted into utf8 */
424             gchar *p; /* iterator */
425
426             /* look for invalid characters */
427             for (p = retlist[i], nvalid = 0; *p; ++p, ++nvalid) {
428                 /* The only valid control characters are TAB(HT)=9 and
429                    NEWLINE(LF)=10.
430                    This is defined in ICCCM section 2:
431                      http://tronche.com/gui/x/icccm/sec-2.html.
432                    See a definition of the latin1 codepage here:
433                      http://en.wikipedia.org/wiki/ISO/IEC_8859-1.
434                    The above page includes control characters in the table,
435                    which we must explicitly exclude, as the g_convert function
436                    will happily take them.
437                 */
438                 const register guchar c = (guchar)*p; /* unsigned value at p */
439                 if ((c < 32 && c != 9 && c != 10) || (c >= 127 && c <= 160))
440                     break; /* found a control character that isn't allowed */
441
442                 if (type == OBT_PROP_TEXT_STRING_NO_CC && c < 32)
443                     break; /* absolutely no control characters are allowed */
444
445                 if (type == OBT_PROP_TEXT_STRING_XPCS) {
446                     const gboolean valid = (
447                         (c >= 32 && c < 128) || c == 9 || c == 10);
448                     if (!valid)
449                         break; /* strict whitelisting for XPCS */
450                 }
451             }
452             /* look for invalid latin1 characters */
453             utf = g_convert(retlist[i], nvalid, "utf-8", "iso-8859-1",
454                             &nvalid, NULL, NULL);
455             if (!utf)
456                 utf = g_convert(retlist[i], nvalid, "utf-8", "iso-8859-1",
457                                 NULL, NULL, NULL);
458             g_assert(utf);
459             retlist[i] = utf;
460         }
461     }
462
463     if (strlist) XFreeStringList(strlist);
464     if (return_single)
465         return retlist[0];
466     else
467         return retlist;
468 }
469
470 gboolean obt_prop_get32(Window win, Atom prop, Atom type, guint32 *ret)
471 {
472     return get_prealloc(win, prop, type, 32, (guchar*)ret, 1);
473 }
474
475 gboolean obt_prop_get_array32(Window win, Atom prop, Atom type, guint32 **ret,
476                               guint *nret)
477 {
478     return get_all(win, prop, type, 32, (guchar**)ret, nret);
479 }
480
481 gboolean obt_prop_get_text(Window win, Atom prop, ObtPropTextType type,
482                            gchar **ret_string)
483 {
484     XTextProperty tprop;
485     gchar *str;
486     gboolean ret = FALSE;
487
488     if (get_text_property(win, prop, &tprop, type)) {
489         str = (gchar*)convert_text_property(&tprop, type, 1);
490
491         if (str) {
492             *ret_string = str;
493             ret = TRUE;
494         }
495     }
496     XFree(tprop.value);
497     return ret;
498 }
499
500 gboolean obt_prop_get_array_text(Window win, Atom prop,
501                                  ObtPropTextType type,
502                                  gchar ***ret_strings)
503 {
504     XTextProperty tprop;
505     gchar **strs;
506     gboolean ret = FALSE;
507
508     if (get_text_property(win, prop, &tprop, type)) {
509         strs = (gchar**)convert_text_property(&tprop, type, -1);
510
511         if (strs) {
512             *ret_strings = strs;
513             ret = TRUE;
514         }
515     }
516     XFree(tprop.value);
517     return ret;
518 }
519
520 void obt_prop_set32(Window win, Atom prop, Atom type, gulong val)
521 {
522     XChangeProperty(obt_display, win, prop, type, 32, PropModeReplace,
523                     (guchar*)&val, 1);
524 }
525
526 void obt_prop_set_array32(Window win, Atom prop, Atom type, gulong *val,
527                       guint num)
528 {
529     XChangeProperty(obt_display, win, prop, type, 32, PropModeReplace,
530                     (guchar*)val, num);
531 }
532
533 void obt_prop_set_text(Window win, Atom prop, const gchar *val)
534 {
535     XChangeProperty(obt_display, win, prop, OBT_PROP_ATOM(UTF8_STRING), 8,
536                     PropModeReplace, (const guchar*)val, strlen(val));
537 }
538
539 void obt_prop_set_array_text(Window win, Atom prop, const gchar *const *strs)
540 {
541     GString *str;
542     gchar const *const *s;
543
544     str = g_string_sized_new(0);
545     for (s = strs; *s; ++s) {
546         str = g_string_append(str, *s);
547         str = g_string_append_c(str, '\0');
548     }
549     XChangeProperty(obt_display, win, prop, OBT_PROP_ATOM(UTF8_STRING), 8,
550                     PropModeReplace, (guchar*)str->str, str->len);
551     g_string_free(str, TRUE);
552 }
553
554 void obt_prop_erase(Window win, Atom prop)
555 {
556     XDeleteProperty(obt_display, win, prop);
557 }
558
559 void obt_prop_message(gint screen, Window about, Atom messagetype,
560                       glong data0, glong data1, glong data2, glong data3,
561                       glong data4, glong mask)
562 {
563     obt_prop_message_to(obt_root(screen), about, messagetype,
564                         data0, data1, data2, data3, data4, mask);
565 }
566
567 void obt_prop_message_to(Window to, Window about,
568                          Atom messagetype,
569                          glong data0, glong data1, glong data2, glong data3,
570                          glong data4, glong mask)
571 {
572     XEvent ce;
573     ce.xclient.type = ClientMessage;
574     ce.xclient.message_type = messagetype;
575     ce.xclient.display = obt_display;
576     ce.xclient.window = about;
577     ce.xclient.format = 32;
578     ce.xclient.data.l[0] = data0;
579     ce.xclient.data.l[1] = data1;
580     ce.xclient.data.l[2] = data2;
581     ce.xclient.data.l[3] = data3;
582     ce.xclient.data.l[4] = data4;
583     XSendEvent(obt_display, to, FALSE, mask, &ce);
584 }