add support for _NET_WM_ACTION_ABOVE and _NET_WM_ACTION_BELOW which aren't in the...
[mikachu/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(openbox_config, "_OPENBOX_CONFIG");
175     CREATE(openbox_wm_state_undecorated, "_OB_WM_STATE_UNDECORATED");
176     CREATE(openbox_control, "_OPENBOX_CONTROL");
177 }
178
179 #include <X11/Xutil.h>
180 #include <glib.h>
181 #include <string.h>
182
183 /* this just isn't used... and it also breaks on 64bit, watch out
184 static gboolean get(Window win, Atom prop, Atom type, gint size,
185                     guchar **data, gulong num)
186 {
187     gboolean ret = FALSE;
188     gint res;
189     guchar *xdata = NULL;
190     Atom ret_type;
191     gint ret_size;
192     gulong ret_items, bytes_left;
193     glong num32 = 32 / size * num; /\* num in 32-bit elements *\/
194
195     res = XGetWindowProperty(display, win, prop, 0l, num32,
196                              FALSE, type, &ret_type, &ret_size,
197                              &ret_items, &bytes_left, &xdata);
198     if (res == Success && ret_items && xdata) {
199         if (ret_size == size && ret_items >= num) {
200             *data = g_memdup(xdata, num * (size / 8));
201             ret = TRUE;
202         }
203         XFree(xdata);
204     }
205     return ret;
206 }
207 */
208
209 static gboolean get_prealloc(Window win, Atom prop, Atom type, gint size,
210                              guchar *data, gulong num)
211 {
212     gboolean ret = FALSE;
213     gint res;
214     guchar *xdata = NULL;
215     Atom ret_type;
216     gint ret_size;
217     gulong ret_items, bytes_left;
218     glong num32 = 32 / size * num; /* num in 32-bit elements */
219
220     res = XGetWindowProperty(ob_display, win, prop, 0l, num32,
221                              FALSE, type, &ret_type, &ret_size,
222                              &ret_items, &bytes_left, &xdata);
223     if (res == Success && ret_items && xdata) {
224         if (ret_size == size && ret_items >= num) {
225             guint i;
226             for (i = 0; i < num; ++i)
227                 switch (size) {
228                 case 8:
229                     data[i] = xdata[i];
230                     break;
231                 case 16:
232                     ((guint16*)data)[i] = ((gushort*)xdata)[i];
233                     break;
234                 case 32:
235                     ((guint32*)data)[i] = ((gulong*)xdata)[i];
236                     break;
237                 default:
238                     g_assert_not_reached(); /* unhandled size */
239                 }
240             ret = TRUE;
241         }
242         XFree(xdata);
243     }
244     return ret;
245 }
246
247 static gboolean get_all(Window win, Atom prop, Atom type, gint size,
248                         guchar **data, guint *num)
249 {
250     gboolean ret = FALSE;
251     gint res;
252     guchar *xdata = NULL;
253     Atom ret_type;
254     gint ret_size;
255     gulong ret_items, bytes_left;
256
257     res = XGetWindowProperty(ob_display, win, prop, 0l, G_MAXLONG,
258                              FALSE, type, &ret_type, &ret_size,
259                              &ret_items, &bytes_left, &xdata);
260     if (res == Success) {
261         if (ret_size == size && ret_items > 0) {
262             guint i;
263
264             *data = g_malloc(ret_items * (size / 8));
265             for (i = 0; i < ret_items; ++i)
266                 switch (size) {
267                 case 8:
268                     (*data)[i] = xdata[i];
269                     break;
270                 case 16:
271                     ((guint16*)*data)[i] = ((gushort*)xdata)[i];
272                     break;
273                 case 32:
274                     ((guint32*)*data)[i] = ((gulong*)xdata)[i];
275                     break;
276                 default:
277                     g_assert_not_reached(); /* unhandled size */
278                 }
279             *num = ret_items;
280             ret = TRUE;
281         }
282         XFree(xdata);
283     }
284     return ret;
285 }
286
287 static gboolean get_stringlist(Window win, Atom prop, gchar ***list, gint *nstr)
288 {
289     XTextProperty tprop;
290     gboolean ret = FALSE;
291
292     if (XGetTextProperty(ob_display, win, &tprop, prop) && tprop.nitems) {
293         if (XTextPropertyToStringList(&tprop, list, nstr))
294             ret = TRUE;
295         XFree(tprop.value);
296     }
297     return ret;
298 }
299
300 gboolean prop_get32(Window win, Atom prop, Atom type, guint32 *ret)
301 {
302     return get_prealloc(win, prop, type, 32, (guchar*)ret, 1);
303 }
304
305 gboolean prop_get_array32(Window win, Atom prop, Atom type, guint32 **ret,
306                           guint *nret)
307 {
308     return get_all(win, prop, type, 32, (guchar**)ret, nret);
309 }
310
311 gboolean prop_get_string_locale(Window win, Atom prop, gchar **ret)
312 {
313     gchar **list;
314     gint nstr;
315     gchar *s;
316
317     if (get_stringlist(win, prop, &list, &nstr) && nstr) {
318         s = g_locale_to_utf8(list[0], -1, NULL, NULL, NULL);
319         XFreeStringList(list);
320         if (s) {
321             *ret = s;
322             return TRUE;
323         }
324     }
325     return FALSE;
326 }
327
328 gboolean prop_get_strings_locale(Window win, Atom prop, gchar ***ret)
329 {
330     GSList *strs = NULL, *it;
331     gchar *raw, *p;
332     guint num, i, count = 0;
333
334     if (get_all(win, prop, prop_atoms.string, 8, (guchar**)&raw, &num)) {
335
336         p = raw;
337         while (p < raw + num) {
338             ++count;
339             strs = g_slist_append(strs, p);
340             p += strlen(p) + 1; /* next string */
341         }
342
343         *ret = g_new0(gchar*, count + 1);
344         (*ret)[count] = NULL; /* null terminated list */
345
346         for (i = 0, it = strs; it; ++i, it = g_slist_next(it)) {
347             (*ret)[i] = g_locale_to_utf8(it->data, -1, NULL, NULL, NULL);
348             /* make sure translation did not fail */
349             if (!(*ret)[i])
350                 (*ret)[i] = g_strdup("");
351         }
352         g_free(raw);
353         g_slist_free(strs);
354         return TRUE;
355     }
356     return FALSE;
357 }
358
359 gboolean prop_get_string_utf8(Window win, Atom prop, gchar **ret)
360 {
361     gchar *raw;
362     gchar *str;
363     guint num;
364      
365     if (get_all(win, prop, prop_atoms.utf8, 8, (guchar**)&raw, &num)) {
366         str = g_strndup(raw, num); /* grab the first string from the list */
367         g_free(raw);
368         if (g_utf8_validate(str, -1, NULL)) {
369             *ret = str;
370             return TRUE;
371         }
372         g_free(str);
373     }
374     return FALSE;
375 }
376
377 gboolean prop_get_strings_utf8(Window win, Atom prop, gchar ***ret)
378 {
379     GSList *strs = NULL, *it;
380     gchar *raw, *p;
381     guint num, i, count = 0;
382
383     if (get_all(win, prop, prop_atoms.utf8, 8, (guchar**)&raw, &num)) {
384
385         p = raw;
386         while (p < raw + num) {
387             ++count;
388             strs = g_slist_append(strs, p);
389             p += strlen(p) + 1; /* next string */
390         }
391
392         *ret = g_new0(gchar*, count + 1);
393
394         for (i = 0, it = strs; it; ++i, it = g_slist_next(it)) {
395             if (g_utf8_validate(it->data, -1, NULL))
396                 (*ret)[i] = g_strdup(it->data);
397             else
398                 (*ret)[i] = g_strdup("");
399         }
400         g_free(raw);
401         g_slist_free(strs);
402         return TRUE;
403     }
404     return FALSE;
405 }
406
407 void prop_set32(Window win, Atom prop, Atom type, gulong val)
408 {
409     XChangeProperty(ob_display, win, prop, type, 32, PropModeReplace,
410                     (guchar*)&val, 1);
411 }
412
413 void prop_set_array32(Window win, Atom prop, Atom type, gulong *val,
414                       guint num)
415 {
416     XChangeProperty(ob_display, win, prop, type, 32, PropModeReplace,
417                     (guchar*)val, num);
418 }
419
420 void prop_set_string_utf8(Window win, Atom prop, const gchar *val)
421 {
422     XChangeProperty(ob_display, win, prop, prop_atoms.utf8, 8,
423                     PropModeReplace, (const guchar*)val, strlen(val));
424 }
425
426 void prop_set_strings_utf8(Window win, Atom prop, gchar **strs)
427 {
428     GString *str;
429     gchar **s;
430
431     str = g_string_sized_new(0);
432     for (s = strs; *s; ++s) {
433         str = g_string_append(str, *s);
434         str = g_string_append_c(str, '\0');
435     }
436     XChangeProperty(ob_display, win, prop, prop_atoms.utf8, 8,
437                     PropModeReplace, (guchar*)str->str, str->len);
438     g_string_free(str, TRUE);
439 }
440
441 void prop_erase(Window win, Atom prop)
442 {
443     XDeleteProperty(ob_display, win, prop);
444 }
445
446 void prop_message(Window about, Atom messagetype, glong data0, glong data1,
447                   glong data2, glong data3, glong mask)
448 {
449     XEvent ce;
450     ce.xclient.type = ClientMessage;
451     ce.xclient.message_type = messagetype;
452     ce.xclient.display = ob_display;
453     ce.xclient.window = about;
454     ce.xclient.format = 32;
455     ce.xclient.data.l[0] = data0;
456     ce.xclient.data.l[1] = data1;
457     ce.xclient.data.l[2] = data2;
458     ce.xclient.data.l[3] = data3;
459     ce.xclient.data.l[4] = 0;
460     XSendEvent(ob_display, RootWindow(ob_display, ob_screen), FALSE,
461                mask, &ce);
462 }