remove trailing whitespace
[dana/openbox.git] / 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()
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
116     prop_atoms.net_wm_moveresize_size_topleft = 0;
117     prop_atoms.net_wm_moveresize_size_top = 1;
118     prop_atoms.net_wm_moveresize_size_topright = 2;
119     prop_atoms.net_wm_moveresize_size_right = 3;
120     prop_atoms.net_wm_moveresize_size_bottomright = 4;
121     prop_atoms.net_wm_moveresize_size_bottom = 5;
122     prop_atoms.net_wm_moveresize_size_bottomleft = 6;
123     prop_atoms.net_wm_moveresize_size_left = 7;
124     prop_atoms.net_wm_moveresize_move = 8;
125     prop_atoms.net_wm_moveresize_size_keyboard = 9;
126     prop_atoms.net_wm_moveresize_move_keyboard = 10;
127     prop_atoms.net_wm_moveresize_cancel = 11;
128
129     CREATE(net_wm_action_move, "_NET_WM_ACTION_MOVE");
130     CREATE(net_wm_action_resize, "_NET_WM_ACTION_RESIZE");
131     CREATE(net_wm_action_minimize, "_NET_WM_ACTION_MINIMIZE");
132     CREATE(net_wm_action_shade, "_NET_WM_ACTION_SHADE");
133     CREATE(net_wm_action_maximize_horz, "_NET_WM_ACTION_MAXIMIZE_HORZ");
134     CREATE(net_wm_action_maximize_vert, "_NET_WM_ACTION_MAXIMIZE_VERT");
135     CREATE(net_wm_action_fullscreen, "_NET_WM_ACTION_FULLSCREEN");
136     CREATE(net_wm_action_change_desktop, "_NET_WM_ACTION_CHANGE_DESKTOP");
137     CREATE(net_wm_action_close, "_NET_WM_ACTION_CLOSE");
138     CREATE(net_wm_action_above, "_NET_WM_ACTION_ABOVE");
139     CREATE(net_wm_action_below, "_NET_WM_ACTION_BELOW");
140
141     CREATE(net_wm_state_modal, "_NET_WM_STATE_MODAL");
142 /*    CREATE(net_wm_state_sticky, "_NET_WM_STATE_STICKY");*/
143     CREATE(net_wm_state_maximized_vert, "_NET_WM_STATE_MAXIMIZED_VERT");
144     CREATE(net_wm_state_maximized_horz, "_NET_WM_STATE_MAXIMIZED_HORZ");
145     CREATE(net_wm_state_shaded, "_NET_WM_STATE_SHADED");
146     CREATE(net_wm_state_skip_taskbar, "_NET_WM_STATE_SKIP_TASKBAR");
147     CREATE(net_wm_state_skip_pager, "_NET_WM_STATE_SKIP_PAGER");
148     CREATE(net_wm_state_hidden, "_NET_WM_STATE_HIDDEN");
149     CREATE(net_wm_state_fullscreen, "_NET_WM_STATE_FULLSCREEN");
150     CREATE(net_wm_state_above, "_NET_WM_STATE_ABOVE");
151     CREATE(net_wm_state_below, "_NET_WM_STATE_BELOW");
152     CREATE(net_wm_state_demands_attention, "_NET_WM_STATE_DEMANDS_ATTENTION");
153
154     prop_atoms.net_wm_state_add = 1;
155     prop_atoms.net_wm_state_remove = 0;
156     prop_atoms.net_wm_state_toggle = 2;
157
158     prop_atoms.net_wm_orientation_horz = 0;
159     prop_atoms.net_wm_orientation_vert = 1;
160     prop_atoms.net_wm_topleft = 0;
161     prop_atoms.net_wm_topright = 1;
162     prop_atoms.net_wm_bottomright = 2;
163     prop_atoms.net_wm_bottomleft = 3;
164
165     CREATE(kde_wm_change_state, "_KDE_WM_CHANGE_STATE");
166     CREATE(kde_net_wm_window_type_override,"_KDE_NET_WM_WINDOW_TYPE_OVERRIDE");
167
168 /*
169     CREATE(rootpmapid, "_XROOTPMAP_ID");
170     CREATE(esetrootid, "ESETROOT_PMAP_ID");
171 */
172
173     CREATE(openbox_pid, "_OPENBOX_PID");
174     CREATE(ob_theme, "_OB_THEME");
175     CREATE(ob_wm_action_undecorate, "_OB_WM_ACTION_UNDECORATE");
176     CREATE(ob_wm_state_undecorated, "_OB_WM_STATE_UNDECORATED");
177     CREATE(ob_control, "_OB_CONTROL");
178 }
179
180 #include <X11/Xutil.h>
181 #include <glib.h>
182 #include <string.h>
183
184 /* this just isn't used... and it also breaks on 64bit, watch out
185 static gboolean get(Window win, Atom prop, Atom type, gint size,
186                     guchar **data, gulong num)
187 {
188     gboolean ret = FALSE;
189     gint res;
190     guchar *xdata = NULL;
191     Atom ret_type;
192     gint ret_size;
193     gulong ret_items, bytes_left;
194     glong num32 = 32 / size * num; /\* num in 32-bit elements *\/
195
196     res = XGetWindowProperty(display, win, prop, 0l, num32,
197                              FALSE, type, &ret_type, &ret_size,
198                              &ret_items, &bytes_left, &xdata);
199     if (res == Success && ret_items && xdata) {
200         if (ret_size == size && ret_items >= num) {
201             *data = g_memdup(xdata, num * (size / 8));
202             ret = TRUE;
203         }
204         XFree(xdata);
205     }
206     return ret;
207 }
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(ob_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(ob_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 static gboolean get_stringlist(Window win, Atom prop, gchar ***list, gint *nstr)
289 {
290     XTextProperty tprop;
291     gboolean ret = FALSE;
292
293     if (XGetTextProperty(ob_display, win, &tprop, prop) && tprop.nitems) {
294         if (XTextPropertyToStringList(&tprop, list, nstr))
295             ret = TRUE;
296         XFree(tprop.value);
297     }
298     return ret;
299 }
300
301 gboolean prop_get32(Window win, Atom prop, Atom type, guint32 *ret)
302 {
303     return get_prealloc(win, prop, type, 32, (guchar*)ret, 1);
304 }
305
306 gboolean prop_get_array32(Window win, Atom prop, Atom type, guint32 **ret,
307                           guint *nret)
308 {
309     return get_all(win, prop, type, 32, (guchar**)ret, nret);
310 }
311
312 gboolean prop_get_string_locale(Window win, Atom prop, gchar **ret)
313 {
314     gchar **list;
315     gint nstr;
316     gchar *s;
317
318     if (get_stringlist(win, prop, &list, &nstr) && nstr) {
319         s = g_locale_to_utf8(list[0], -1, NULL, NULL, NULL);
320         XFreeStringList(list);
321         if (s) {
322             *ret = s;
323             return TRUE;
324         }
325     }
326     return FALSE;
327 }
328
329 gboolean prop_get_strings_locale(Window win, Atom prop, gchar ***ret)
330 {
331     GSList *strs = NULL, *it;
332     gchar *raw, *p;
333     guint num, i, count = 0;
334
335     if (get_all(win, prop, prop_atoms.string, 8, (guchar**)&raw, &num)) {
336
337         p = raw;
338         while (p < raw + num) {
339             ++count;
340             strs = g_slist_append(strs, p);
341             p += strlen(p) + 1; /* next string */
342         }
343
344         *ret = g_new0(gchar*, count + 1);
345         (*ret)[count] = NULL; /* null terminated list */
346
347         for (i = 0, it = strs; it; ++i, it = g_slist_next(it)) {
348             (*ret)[i] = g_locale_to_utf8(it->data, -1, NULL, NULL, NULL);
349             /* make sure translation did not fail */
350             if (!(*ret)[i])
351                 (*ret)[i] = g_strdup("");
352         }
353         g_free(raw);
354         g_slist_free(strs);
355         return TRUE;
356     }
357     return FALSE;
358 }
359
360 gboolean prop_get_string_utf8(Window win, Atom prop, gchar **ret)
361 {
362     gchar *raw;
363     gchar *str;
364     guint num;
365
366     if (get_all(win, prop, prop_atoms.utf8, 8, (guchar**)&raw, &num)) {
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 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, prop_atoms.utf8, 8, (guchar**)&raw, &num)) {
385
386         p = raw;
387         while (p < raw + num) {
388             ++count;
389             strs = g_slist_append(strs, p);
390             p += strlen(p) + 1; /* next string */
391         }
392
393         *ret = g_new0(gchar*, count + 1);
394
395         for (i = 0, it = strs; it; ++i, it = g_slist_next(it)) {
396             if (g_utf8_validate(it->data, -1, NULL))
397                 (*ret)[i] = g_strdup(it->data);
398             else
399                 (*ret)[i] = g_strdup("");
400         }
401         g_free(raw);
402         g_slist_free(strs);
403         return TRUE;
404     }
405     return FALSE;
406 }
407
408 void prop_set32(Window win, Atom prop, Atom type, gulong val)
409 {
410     XChangeProperty(ob_display, win, prop, type, 32, PropModeReplace,
411                     (guchar*)&val, 1);
412 }
413
414 void prop_set_array32(Window win, Atom prop, Atom type, gulong *val,
415                       guint num)
416 {
417     XChangeProperty(ob_display, win, prop, type, 32, PropModeReplace,
418                     (guchar*)val, num);
419 }
420
421 void prop_set_string_utf8(Window win, Atom prop, const gchar *val)
422 {
423     XChangeProperty(ob_display, win, prop, prop_atoms.utf8, 8,
424                     PropModeReplace, (const guchar*)val, strlen(val));
425 }
426
427 void prop_set_strings_utf8(Window win, Atom prop, gchar **strs)
428 {
429     GString *str;
430     gchar **s;
431
432     str = g_string_sized_new(0);
433     for (s = strs; *s; ++s) {
434         str = g_string_append(str, *s);
435         str = g_string_append_c(str, '\0');
436     }
437     XChangeProperty(ob_display, win, prop, prop_atoms.utf8, 8,
438                     PropModeReplace, (guchar*)str->str, str->len);
439     g_string_free(str, TRUE);
440 }
441
442 void prop_erase(Window win, Atom prop)
443 {
444     XDeleteProperty(ob_display, win, prop);
445 }
446
447 void prop_message(Window about, Atom messagetype, glong data0, glong data1,
448                   glong data2, glong data3, glong mask)
449 {
450     XEvent ce;
451     ce.xclient.type = ClientMessage;
452     ce.xclient.message_type = messagetype;
453     ce.xclient.display = ob_display;
454     ce.xclient.window = about;
455     ce.xclient.format = 32;
456     ce.xclient.data.l[0] = data0;
457     ce.xclient.data.l[1] = data1;
458     ce.xclient.data.l[2] = data2;
459     ce.xclient.data.l[3] = data3;
460     ce.xclient.data.l[4] = 0;
461     XSendEvent(ob_display, RootWindow(ob_display, ob_screen), FALSE,
462                mask, &ce);
463 }