1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
3 prop.c for the Openbox window manager
4 Copyright (c) 2006 Mikael Magnusson
5 Copyright (c) 2003-2007 Dana Jansens
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.
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.
17 See the COPYING file for a copy of the GNU General Public License.
23 #include <X11/Xatom.h>
27 #define CREATE(var, name) (prop_atoms.var = \
28 XInternAtom(ob_display, name, FALSE))
32 CREATE(cardinal, "CARDINAL");
33 CREATE(window, "WINDOW");
34 CREATE(pixmap, "PIXMAP");
36 CREATE(string, "STRING");
37 CREATE(utf8, "UTF8_STRING");
39 CREATE(manager, "MANAGER");
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");
56 CREATE(sm_client_id, "SM_CLIENT_ID");
58 CREATE(net_wm_full_placement, "_NET_WM_FULL_PLACEMENT");
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");
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");
81 CREATE(net_startup_id, "_NET_STARTUP_ID");
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");
101 /* CREATE(net_wm_ping, "_NET_WM_PING"); */
103 CREATE(net_wm_sync_request, "_NET_WM_SYNC_REQUEST");
104 CREATE(net_wm_sync_request_counter, "_NET_WM_SYNC_REQUEST_COUNTER");
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");
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;
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_state_modal, "_NET_WM_STATE_MODAL");
139 /* CREATE(net_wm_state_sticky, "_NET_WM_STATE_STICKY");*/
140 CREATE(net_wm_state_maximized_vert, "_NET_WM_STATE_MAXIMIZED_VERT");
141 CREATE(net_wm_state_maximized_horz, "_NET_WM_STATE_MAXIMIZED_HORZ");
142 CREATE(net_wm_state_shaded, "_NET_WM_STATE_SHADED");
143 CREATE(net_wm_state_skip_taskbar, "_NET_WM_STATE_SKIP_TASKBAR");
144 CREATE(net_wm_state_skip_pager, "_NET_WM_STATE_SKIP_PAGER");
145 CREATE(net_wm_state_hidden, "_NET_WM_STATE_HIDDEN");
146 CREATE(net_wm_state_fullscreen, "_NET_WM_STATE_FULLSCREEN");
147 CREATE(net_wm_state_above, "_NET_WM_STATE_ABOVE");
148 CREATE(net_wm_state_below, "_NET_WM_STATE_BELOW");
149 CREATE(net_wm_state_demands_attention, "_NET_WM_STATE_DEMANDS_ATTENTION");
151 prop_atoms.net_wm_state_add = 1;
152 prop_atoms.net_wm_state_remove = 0;
153 prop_atoms.net_wm_state_toggle = 2;
155 prop_atoms.net_wm_orientation_horz = 0;
156 prop_atoms.net_wm_orientation_vert = 1;
157 prop_atoms.net_wm_topleft = 0;
158 prop_atoms.net_wm_topright = 1;
159 prop_atoms.net_wm_bottomright = 2;
160 prop_atoms.net_wm_bottomleft = 3;
162 CREATE(kde_wm_change_state, "_KDE_WM_CHANGE_STATE");
163 CREATE(kde_net_wm_window_type_override,"_KDE_NET_WM_WINDOW_TYPE_OVERRIDE");
166 CREATE(rootpmapid, "_XROOTPMAP_ID");
167 CREATE(esetrootid, "ESETROOT_PMAP_ID");
170 CREATE(openbox_pid, "_OPENBOX_PID");
171 CREATE(openbox_config, "_OPENBOX_CONFIG");
172 CREATE(openbox_wm_state_undecorated, "_OB_WM_STATE_UNDECORATED");
173 CREATE(openbox_control, "_OPENBOX_CONTROL");
176 #include <X11/Xutil.h>
180 /* this just isn't used... and it also breaks on 64bit, watch out
181 static gboolean get(Window win, Atom prop, Atom type, gint size,
182 guchar **data, gulong num)
184 gboolean ret = FALSE;
186 guchar *xdata = NULL;
189 gulong ret_items, bytes_left;
190 glong num32 = 32 / size * num; /\* num in 32-bit elements *\/
192 res = XGetWindowProperty(display, win, prop, 0l, num32,
193 FALSE, type, &ret_type, &ret_size,
194 &ret_items, &bytes_left, &xdata);
195 if (res == Success && ret_items && xdata) {
196 if (ret_size == size && ret_items >= num) {
197 *data = g_memdup(xdata, num * (size / 8));
206 static gboolean get_prealloc(Window win, Atom prop, Atom type, gint size,
207 guchar *data, gulong num)
209 gboolean ret = FALSE;
211 guchar *xdata = NULL;
214 gulong ret_items, bytes_left;
215 glong num32 = 32 / size * num; /* num in 32-bit elements */
217 res = XGetWindowProperty(ob_display, win, prop, 0l, num32,
218 FALSE, type, &ret_type, &ret_size,
219 &ret_items, &bytes_left, &xdata);
220 if (res == Success && ret_items && xdata) {
221 if (ret_size == size && ret_items >= num) {
223 for (i = 0; i < num; ++i)
229 ((guint16*)data)[i] = ((gushort*)xdata)[i];
232 ((guint32*)data)[i] = ((gulong*)xdata)[i];
235 g_assert_not_reached(); /* unhandled size */
244 static gboolean get_all(Window win, Atom prop, Atom type, gint size,
245 guchar **data, guint *num)
247 gboolean ret = FALSE;
249 guchar *xdata = NULL;
252 gulong ret_items, bytes_left;
254 res = XGetWindowProperty(ob_display, win, prop, 0l, G_MAXLONG,
255 FALSE, type, &ret_type, &ret_size,
256 &ret_items, &bytes_left, &xdata);
257 if (res == Success) {
258 if (ret_size == size && ret_items > 0) {
261 *data = g_malloc(ret_items * (size / 8));
262 for (i = 0; i < ret_items; ++i)
265 (*data)[i] = xdata[i];
268 ((guint16*)*data)[i] = ((gushort*)xdata)[i];
271 ((guint32*)*data)[i] = ((gulong*)xdata)[i];
274 g_assert_not_reached(); /* unhandled size */
284 static gboolean get_stringlist(Window win, Atom prop, gchar ***list, gint *nstr)
287 gboolean ret = FALSE;
289 if (XGetTextProperty(ob_display, win, &tprop, prop) && tprop.nitems) {
290 if (XTextPropertyToStringList(&tprop, list, nstr))
297 gboolean prop_get32(Window win, Atom prop, Atom type, guint32 *ret)
299 return get_prealloc(win, prop, type, 32, (guchar*)ret, 1);
302 gboolean prop_get_array32(Window win, Atom prop, Atom type, guint32 **ret,
305 return get_all(win, prop, type, 32, (guchar**)ret, nret);
308 gboolean prop_get_string_locale(Window win, Atom prop, gchar **ret)
314 if (get_stringlist(win, prop, &list, &nstr) && nstr) {
315 s = g_locale_to_utf8(list[0], -1, NULL, NULL, NULL);
316 XFreeStringList(list);
325 gboolean prop_get_strings_locale(Window win, Atom prop, gchar ***ret)
327 GSList *strs = NULL, *it;
329 guint num, i, count = 0;
331 if (get_all(win, prop, prop_atoms.string, 8, (guchar**)&raw, &num)) {
334 while (p < raw + num) {
336 strs = g_slist_append(strs, p);
337 p += strlen(p) + 1; /* next string */
340 *ret = g_new0(gchar*, count + 1);
341 (*ret)[count] = NULL; /* null terminated list */
343 for (i = 0, it = strs; it; ++i, it = g_slist_next(it)) {
344 (*ret)[i] = g_locale_to_utf8(it->data, -1, NULL, NULL, NULL);
345 /* make sure translation did not fail */
347 (*ret)[i] = g_strdup("");
356 gboolean prop_get_string_utf8(Window win, Atom prop, gchar **ret)
362 if (get_all(win, prop, prop_atoms.utf8, 8, (guchar**)&raw, &num)) {
363 str = g_strndup(raw, num); /* grab the first string from the list */
365 if (g_utf8_validate(str, -1, NULL)) {
374 gboolean prop_get_strings_utf8(Window win, Atom prop, gchar ***ret)
376 GSList *strs = NULL, *it;
378 guint num, i, count = 0;
380 if (get_all(win, prop, prop_atoms.utf8, 8, (guchar**)&raw, &num)) {
383 while (p < raw + num) {
385 strs = g_slist_append(strs, p);
386 p += strlen(p) + 1; /* next string */
389 *ret = g_new0(gchar*, count + 1);
391 for (i = 0, it = strs; it; ++i, it = g_slist_next(it)) {
392 if (g_utf8_validate(it->data, -1, NULL))
393 (*ret)[i] = g_strdup(it->data);
395 (*ret)[i] = g_strdup("");
404 void prop_set32(Window win, Atom prop, Atom type, gulong val)
406 XChangeProperty(ob_display, win, prop, type, 32, PropModeReplace,
410 void prop_set_array32(Window win, Atom prop, Atom type, gulong *val,
413 XChangeProperty(ob_display, win, prop, type, 32, PropModeReplace,
417 void prop_set_string_utf8(Window win, Atom prop, const gchar *val)
419 XChangeProperty(ob_display, win, prop, prop_atoms.utf8, 8,
420 PropModeReplace, (const guchar*)val, strlen(val));
423 void prop_set_strings_utf8(Window win, Atom prop, gchar **strs)
428 str = g_string_sized_new(0);
429 for (s = strs; *s; ++s) {
430 str = g_string_append(str, *s);
431 str = g_string_append_c(str, '\0');
433 XChangeProperty(ob_display, win, prop, prop_atoms.utf8, 8,
434 PropModeReplace, (guchar*)str->str, str->len);
435 g_string_free(str, TRUE);
438 void prop_erase(Window win, Atom prop)
440 XDeleteProperty(ob_display, win, prop);
443 void prop_message(Window about, Atom messagetype, glong data0, glong data1,
444 glong data2, glong data3, glong mask)
447 ce.xclient.type = ClientMessage;
448 ce.xclient.message_type = messagetype;
449 ce.xclient.display = ob_display;
450 ce.xclient.window = about;
451 ce.xclient.format = 32;
452 ce.xclient.data.l[0] = data0;
453 ce.xclient.data.l[1] = data1;
454 ce.xclient.data.l[2] = data2;
455 ce.xclient.data.l[3] = data3;
456 ce.xclient.data.l[4] = 0;
457 XSendEvent(ob_display, RootWindow(ob_display, ob_screen), FALSE,