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