Merge branch 'backport' into work
[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_NAME(UTF8, "UTF8_STRING");
49
50     CREATE(MANAGER);
51
52     CREATE(WM_COLORMAP_WINDOWS);
53     CREATE(WM_PROTOCOLS);
54     CREATE(WM_STATE);
55     CREATE(WM_CHANGE_STATE);
56     CREATE(WM_DELETE_WINDOW);
57     CREATE(WM_TAKE_FOCUS);
58     CREATE(WM_NAME);
59     CREATE(WM_ICON_NAME);
60     CREATE(WM_CLASS);
61     CREATE(WM_WINDOW_ROLE);
62     CREATE(WM_CLIENT_MACHINE);
63     CREATE(WM_COMMAND);
64     CREATE(WM_CLIENT_LEADER);
65     CREATE(WM_TRANSIENT_FOR);
66     CREATE_(MOTIF_WM_HINTS);
67     CREATE_(MOTIF_WM_INFO);
68
69     CREATE(SM_CLIENT_ID);
70
71     CREATE_(NET_WM_FULL_PLACEMENT);
72
73     CREATE_(NET_SUPPORTED);
74     CREATE_(NET_CLIENT_LIST);
75     CREATE_(NET_CLIENT_LIST_STACKING);
76     CREATE_(NET_NUMBER_OF_DESKTOPS);
77     CREATE_(NET_DESKTOP_GEOMETRY);
78     CREATE_(NET_DESKTOP_VIEWPORT);
79     CREATE_(NET_CURRENT_DESKTOP);
80     CREATE_(NET_DESKTOP_NAMES);
81     CREATE_(NET_ACTIVE_WINDOW);
82 /*    CREATE_(NET_RESTACK_WINDOW);*/
83     CREATE_(NET_WORKAREA);
84     CREATE_(NET_SUPPORTING_WM_CHECK);
85     CREATE_(NET_DESKTOP_LAYOUT);
86     CREATE_(NET_SHOWING_DESKTOP);
87
88     CREATE_(NET_CLOSE_WINDOW);
89     CREATE_(NET_WM_MOVERESIZE);
90     CREATE_(NET_MOVERESIZE_WINDOW);
91     CREATE_(NET_REQUEST_FRAME_EXTENTS);
92     CREATE_(NET_RESTACK_WINDOW);
93
94     CREATE_(NET_STARTUP_ID);
95
96     CREATE_(NET_WM_NAME);
97     CREATE_(NET_WM_VISIBLE_NAME);
98     CREATE_(NET_WM_ICON_NAME);
99     CREATE_(NET_WM_VISIBLE_ICON_NAME);
100     CREATE_(NET_WM_DESKTOP);
101     CREATE_(NET_WM_WINDOW_TYPE);
102     CREATE_(NET_WM_STATE);
103     CREATE_(NET_WM_STRUT);
104     CREATE_(NET_WM_STRUT_PARTIAL);
105     CREATE_(NET_WM_ICON);
106     CREATE_(NET_WM_ICON_GEOMETRY);
107     CREATE_(NET_WM_PID);
108     CREATE_(NET_WM_ALLOWED_ACTIONS);
109     CREATE_(NET_WM_USER_TIME);
110 /*  CREATE_(NET_WM_USER_TIME_WINDOW); */
111     CREATE_(KDE_NET_WM_FRAME_STRUT);
112     CREATE_(NET_FRAME_EXTENTS);
113
114     CREATE_(NET_WM_PING);
115 #ifdef SYNC
116     CREATE_(NET_WM_SYNC_REQUEST);
117     CREATE_(NET_WM_SYNC_REQUEST_COUNTER);
118 #endif
119
120     CREATE_(NET_WM_WINDOW_TYPE_DESKTOP);
121     CREATE_(NET_WM_WINDOW_TYPE_DOCK);
122     CREATE_(NET_WM_WINDOW_TYPE_TOOLBAR);
123     CREATE_(NET_WM_WINDOW_TYPE_MENU);
124     CREATE_(NET_WM_WINDOW_TYPE_UTILITY);
125     CREATE_(NET_WM_WINDOW_TYPE_SPLASH);
126     CREATE_(NET_WM_WINDOW_TYPE_DIALOG);
127     CREATE_(NET_WM_WINDOW_TYPE_NORMAL);
128     CREATE_(NET_WM_WINDOW_TYPE_POPUP_MENU);
129
130     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_TOPLEFT] = 0;
131     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_TOP] = 1;
132     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_TOPRIGHT] = 2;
133     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_RIGHT] = 3;
134     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_BOTTOMRIGHT] = 4;
135     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_BOTTOM] = 5;
136     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_BOTTOMLEFT] = 6;
137     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_LEFT] = 7;
138     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_MOVE] = 8;
139     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_SIZE_KEYBOARD] = 9;
140     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_MOVE_KEYBOARD] = 10;
141     prop_atoms[OBT_PROP_NET_WM_MOVERESIZE_CANCEL] = 11;
142
143     CREATE_(NET_WM_ACTION_MOVE);
144     CREATE_(NET_WM_ACTION_RESIZE);
145     CREATE_(NET_WM_ACTION_MINIMIZE);
146     CREATE_(NET_WM_ACTION_SHADE);
147     CREATE_(NET_WM_ACTION_MAXIMIZE_HORZ);
148     CREATE_(NET_WM_ACTION_MAXIMIZE_VERT);
149     CREATE_(NET_WM_ACTION_FULLSCREEN);
150     CREATE_(NET_WM_ACTION_CHANGE_DESKTOP);
151     CREATE_(NET_WM_ACTION_CLOSE);
152     CREATE_(NET_WM_ACTION_ABOVE);
153     CREATE_(NET_WM_ACTION_BELOW);
154
155     CREATE_(NET_WM_STATE_MODAL);
156 /*    CREATE_(NET_WM_STATE_STICKY);*/
157     CREATE_(NET_WM_STATE_MAXIMIZED_VERT);
158     CREATE_(NET_WM_STATE_MAXIMIZED_HORZ);
159     CREATE_(NET_WM_STATE_SHADED);
160     CREATE_(NET_WM_STATE_SKIP_TASKBAR);
161     CREATE_(NET_WM_STATE_SKIP_PAGER);
162     CREATE_(NET_WM_STATE_HIDDEN);
163     CREATE_(NET_WM_STATE_FULLSCREEN);
164     CREATE_(NET_WM_STATE_ABOVE);
165     CREATE_(NET_WM_STATE_BELOW);
166     CREATE_(NET_WM_STATE_DEMANDS_ATTENTION);
167
168     prop_atoms[OBT_PROP_NET_WM_STATE_ADD] = 1;
169     prop_atoms[OBT_PROP_NET_WM_STATE_REMOVE] = 0;
170     prop_atoms[OBT_PROP_NET_WM_STATE_TOGGLE] = 2;
171
172     prop_atoms[OBT_PROP_NET_WM_ORIENTATION_HORZ] = 0;
173     prop_atoms[OBT_PROP_NET_WM_ORIENTATION_VERT] = 1;
174     prop_atoms[OBT_PROP_NET_WM_TOPLEFT] = 0;
175     prop_atoms[OBT_PROP_NET_WM_TOPRIGHT] = 1;
176     prop_atoms[OBT_PROP_NET_WM_BOTTOMRIGHT] = 2;
177     prop_atoms[OBT_PROP_NET_WM_BOTTOMLEFT] = 3;
178
179     CREATE_(KDE_WM_CHANGE_STATE);
180     CREATE_(KDE_NET_WM_WINDOW_TYPE_OVERRIDE);
181
182 /*
183     CREATE_NAME(ROOTPMAPId, "_XROOTPMAP_ID");
184     CREATE_NAME(ESETROOTId, "ESETROOT_PMAP_ID");
185 */
186
187     CREATE_(OPENBOX_PID);
188     CREATE_(OB_THEME);
189     CREATE_(OB_CONFIG_FILE);
190     CREATE_(OB_WM_ACTION_UNDECORATE);
191     CREATE_(OB_WM_STATE_UNDECORATED);
192     CREATE_(OB_CONTROL);
193     CREATE_(OB_VERSION);
194     CREATE_(OB_APP_ROLE);
195     CREATE_(OB_APP_NAME);
196     CREATE_(OB_APP_CLASS);
197     CREATE_(OB_APP_TYPE);
198 }
199
200 Atom obt_prop_atom(ObtPropAtom a)
201 {
202     g_assert(prop_started);
203     g_assert(a < OBT_PROP_NUM_ATOMS);
204     return prop_atoms[a];
205 }
206
207 static gboolean get_prealloc(Window win, Atom prop, Atom type, gint size,
208                              guchar *data, gulong num)
209 {
210     gboolean ret = FALSE;
211     gint res;
212     guchar *xdata = NULL;
213     Atom ret_type;
214     gint ret_size;
215     gulong ret_items, bytes_left;
216     glong num32 = 32 / size * num; /* num in 32-bit elements */
217
218     res = XGetWindowProperty(obt_display, win, prop, 0l, num32,
219                              FALSE, type, &ret_type, &ret_size,
220                              &ret_items, &bytes_left, &xdata);
221     if (res == Success && ret_items && xdata) {
222         if (ret_size == size && ret_items >= num) {
223             guint i;
224             for (i = 0; i < num; ++i)
225                 switch (size) {
226                 case 8:
227                     data[i] = xdata[i];
228                     break;
229                 case 16:
230                     ((guint16*)data)[i] = ((gushort*)xdata)[i];
231                     break;
232                 case 32:
233                     ((guint32*)data)[i] = ((gulong*)xdata)[i];
234                     break;
235                 default:
236                     g_assert_not_reached(); /* unhandled size */
237                 }
238             ret = TRUE;
239         }
240         XFree(xdata);
241     }
242     return ret;
243 }
244
245 static gboolean get_all(Window win, Atom prop, Atom type, gint size,
246                         guchar **data, guint *num)
247 {
248     gboolean ret = FALSE;
249     gint res;
250     guchar *xdata = NULL;
251     Atom ret_type;
252     gint ret_size;
253     gulong ret_items, bytes_left;
254
255     res = XGetWindowProperty(obt_display, win, prop, 0l, G_MAXLONG,
256                              FALSE, type, &ret_type, &ret_size,
257                              &ret_items, &bytes_left, &xdata);
258     if (res == Success) {
259         if (ret_size == size && ret_items > 0) {
260             guint i;
261
262             *data = g_malloc(ret_items * (size / 8));
263             for (i = 0; i < ret_items; ++i)
264                 switch (size) {
265                 case 8:
266                     (*data)[i] = xdata[i];
267                     break;
268                 case 16:
269                     ((guint16*)*data)[i] = ((gushort*)xdata)[i];
270                     break;
271                 case 32:
272                     ((guint32*)*data)[i] = ((gulong*)xdata)[i];
273                     break;
274                 default:
275                     g_assert_not_reached(); /* unhandled size */
276                 }
277             *num = ret_items;
278             ret = TRUE;
279         }
280         XFree(xdata);
281     }
282     return ret;
283 }
284
285 static gboolean get_stringlist(Window win, Atom prop, gchar ***list, gint *nstr)
286 {
287     XTextProperty tprop;
288     gboolean ret = FALSE;
289
290     if (XGetTextProperty(obt_display, win, &tprop, prop) && tprop.nitems) {
291         if (XTextPropertyToStringList(&tprop, list, nstr))
292             ret = TRUE;
293         XFree(tprop.value);
294     }
295     return ret;
296 }
297
298 gboolean obt_prop_get32(Window win, Atom prop, Atom type, guint32 *ret)
299 {
300     return get_prealloc(win, prop, type, 32, (guchar*)ret, 1);
301 }
302
303 gboolean obt_prop_get_array32(Window win, Atom prop, Atom type, guint32 **ret,
304                               guint *nret)
305 {
306     return get_all(win, prop, type, 32, (guchar**)ret, nret);
307 }
308
309 gboolean obt_prop_get_string_locale(Window win, Atom prop, gchar **ret)
310 {
311     gchar **list;
312     gint nstr;
313     gchar *s;
314
315     if (get_stringlist(win, prop, &list, &nstr) && nstr) {
316         s = g_locale_to_utf8(list[0], -1, NULL, NULL, NULL);
317         XFreeStringList(list);
318         if (s) {
319             *ret = s;
320             return TRUE;
321         }
322     }
323     return FALSE;
324 }
325
326 gboolean obt_prop_get_strings_locale(Window win, Atom prop, gchar ***ret)
327 {
328     GSList *strs = NULL, *it;
329     gchar *raw, *p;
330     guint num, i, count = 0;
331
332     if (get_all(win, prop, OBT_PROP_ATOM(STRING), 8,
333                 (guchar**)&raw, &num))
334     {
335         p = raw;
336         while (p < raw + num) {
337             ++count;
338             strs = g_slist_append(strs, p);
339             p += strlen(p) + 1; /* next string */
340         }
341
342         *ret = g_new0(gchar*, count + 1);
343         (*ret)[count] = NULL; /* null terminated list */
344
345         for (i = 0, it = strs; it; ++i, it = g_slist_next(it)) {
346             (*ret)[i] = g_locale_to_utf8(it->data, -1, NULL, NULL, NULL);
347             /* make sure translation did not fail */
348             if (!(*ret)[i])
349                 (*ret)[i] = g_strdup("");
350         }
351         g_free(raw);
352         g_slist_free(strs);
353         return TRUE;
354     }
355     return FALSE;
356 }
357
358 gboolean obt_prop_get_string_utf8(Window win, Atom prop, gchar **ret)
359 {
360     gchar *raw;
361     gchar *str;
362     guint num;
363
364     if (get_all(win, prop, OBT_PROP_ATOM(UTF8), 8,
365                 (guchar**)&raw, &num))
366     {
367         str = g_strndup(raw, num); /* grab the first string from the list */
368         g_free(raw);
369         if (g_utf8_validate(str, -1, NULL)) {
370             *ret = str;
371             return TRUE;
372         }
373         g_free(str);
374     }
375     return FALSE;
376 }
377
378 gboolean obt_prop_get_strings_utf8(Window win, Atom prop, gchar ***ret)
379 {
380     GSList *strs = NULL, *it;
381     gchar *raw, *p;
382     guint num, i, count = 0;
383
384     if (get_all(win, prop, OBT_PROP_ATOM(UTF8), 8,
385                 (guchar**)&raw, &num))
386     {
387         p = raw;
388         while (p < raw + num) {
389             ++count;
390             strs = g_slist_append(strs, p);
391             p += strlen(p) + 1; /* next string */
392         }
393
394         *ret = g_new0(gchar*, count + 1);
395
396         for (i = 0, it = strs; it; ++i, it = g_slist_next(it)) {
397             if (g_utf8_validate(it->data, -1, NULL))
398                 (*ret)[i] = g_strdup(it->data);
399             else
400                 (*ret)[i] = g_strdup("");
401         }
402         g_free(raw);
403         g_slist_free(strs);
404         return TRUE;
405     }
406     return FALSE;
407 }
408
409 void obt_prop_set32(Window win, Atom prop, Atom type, gulong val)
410 {
411     XChangeProperty(obt_display, win, prop, type, 32, PropModeReplace,
412                     (guchar*)&val, 1);
413 }
414
415 void obt_prop_set_array32(Window win, Atom prop, Atom type, gulong *val,
416                       guint num)
417 {
418     XChangeProperty(obt_display, win, prop, type, 32, PropModeReplace,
419                     (guchar*)val, num);
420 }
421
422 void obt_prop_set_string_locale(Window win, Atom prop, const gchar *val)
423 {
424     gchar const *s[2] = { val, NULL };
425     obt_prop_set_strings_locale(win, prop, s);
426 }
427
428 void obt_prop_set_strings_locale(Window win, Atom prop, const gchar **strs)
429 {
430     gint i, count;
431     gchar **lstrs;
432     XTextProperty tprop;
433
434     /* count the strings in strs, and convert them to the locale format */
435     for (count = 0; strs[count]; ++count);
436     lstrs = g_new0(char*, count);
437     for (i = 0; i < count; ++i) {
438         lstrs[i] = g_locale_from_utf8(strs[i], -1, NULL, NULL, NULL);
439         if (!lstrs[i]) {
440             lstrs[i] = g_strdup(""); /* make it an empty string */
441             g_warning("Unable to translate string '%s' from UTF8 to locale "
442                       "format", strs[i]);
443         }
444     }
445
446
447     XStringListToTextProperty(lstrs, count, &tprop);
448     XSetTextProperty(obt_display, win, &tprop, prop);
449     XFree(tprop.value);
450 }
451
452 void obt_prop_set_string_utf8(Window win, Atom prop, const gchar *val)
453 {
454     XChangeProperty(obt_display, win, prop, OBT_PROP_ATOM(UTF8), 8,
455                     PropModeReplace, (const guchar*)val, strlen(val));
456 }
457
458 void obt_prop_set_strings_utf8(Window win, Atom prop, const gchar **strs)
459 {
460     GString *str;
461     gchar const **s;
462
463     str = g_string_sized_new(0);
464     for (s = strs; *s; ++s) {
465         str = g_string_append(str, *s);
466         str = g_string_append_c(str, '\0');
467     }
468     XChangeProperty(obt_display, win, prop, obt_prop_atom(OBT_PROP_UTF8), 8,
469                     PropModeReplace, (guchar*)str->str, str->len);
470     g_string_free(str, TRUE);
471 }
472
473 void obt_prop_erase(Window win, Atom prop)
474 {
475     XDeleteProperty(obt_display, win, prop);
476 }
477
478 void obt_prop_message(gint screen, Window about, Atom messagetype,
479                       glong data0, glong data1, glong data2, glong data3,
480                       glong data4, glong mask)
481 {
482     obt_prop_message_to(obt_root(screen), about, messagetype,
483                         data0, data1, data2, data3, data4, mask);
484 }
485
486 void obt_prop_message_to(Window to, Window about,
487                          Atom messagetype,
488                          glong data0, glong data1, glong data2, glong data3,
489                          glong data4, glong mask)
490 {
491     XEvent ce;
492     ce.xclient.type = ClientMessage;
493     ce.xclient.message_type = messagetype;
494     ce.xclient.display = obt_display;
495     ce.xclient.window = about;
496     ce.xclient.format = 32;
497     ce.xclient.data.l[0] = data0;
498     ce.xclient.data.l[1] = data1;
499     ce.xclient.data.l[2] = data2;
500     ce.xclient.data.l[3] = data3;
501     ce.xclient.data.l[4] = data4;
502     XSendEvent(obt_display, to, FALSE, mask, &ce);
503 }