redo otk::Property. make it static.
[dana/openbox.git] / otk / property.cc
1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
2
3 #ifdef    HAVE_CONFIG_H
4 #  include "../config.h"
5 #endif // HAVE_CONFIG_H
6
7 #include "property.hh"
8 #include "display.hh"
9
10 extern "C" {
11 #include <X11/Xatom.h>
12
13 #include <assert.h>
14 }
15
16 #include <algorithm>
17
18 namespace otk {
19
20 Atoms Property::atoms;
21
22 static Atom create(char *name) { return XInternAtom(**display, name, false); }
23
24 void Property::initialize()
25 {
26   assert(display);
27
28   // make sure asserts fire if there is a problem
29   memset(&atoms, 0, sizeof(Atoms));
30
31   atoms.cardinal = XA_CARDINAL;
32   atoms.window = XA_WINDOW;
33   atoms.pixmap = XA_PIXMAP;
34   atoms.atom = XA_ATOM;
35   atoms.string = XA_STRING;
36   atoms.utf8 = create("UTF8_STRING");
37   
38   atoms.openbox_pid = create("_OPENBOX_PID");
39
40   atoms.wm_colormap_windows = create("WM_COLORMAP_WINDOWS");
41   atoms.wm_protocols = create("WM_PROTOCOLS");
42   atoms.wm_state = create("WM_STATE");
43   atoms.wm_change_state = create("WM_CHANGE_STATE");
44   atoms.wm_delete_window = create("WM_DELETE_WINDOW");
45   atoms.wm_take_focus = create("WM_TAKE_FOCUS");
46   atoms.wm_name = create("WM_NAME");
47   atoms.wm_icon_name = create("WM_ICON_NAME");
48   atoms.wm_class = create("WM_CLASS");
49   atoms.wm_window_role = create("WM_WINDOW_ROLE");
50   atoms.motif_wm_hints = create("_MOTIF_WM_HINTS");
51
52   atoms.openbox_show_root_menu = create("_OPENBOX_SHOW_ROOT_MENU");
53   atoms.openbox_show_workspace_menu = create("_OPENBOX_SHOW_WORKSPACE_MENU");
54
55   atoms.net_supported = create("_NET_SUPPORTED");
56   atoms.net_client_list = create("_NET_CLIENT_LIST");
57   atoms.net_client_list_stacking = create("_NET_CLIENT_LIST_STACKING");
58   atoms.net_number_of_desktops = create("_NET_NUMBER_OF_DESKTOPS");
59   atoms.net_desktop_geometry = create("_NET_DESKTOP_GEOMETRY");
60   atoms.net_desktop_viewport = create("_NET_DESKTOP_VIEWPORT");
61   atoms.net_current_desktop = create("_NET_CURRENT_DESKTOP");
62   atoms.net_desktop_names = create("_NET_DESKTOP_NAMES");
63   atoms.net_active_window = create("_NET_ACTIVE_WINDOW");
64   atoms.net_workarea = create("_NET_WORKAREA");
65   atoms.net_supporting_wm_check = create("_NET_SUPPORTING_WM_CHECK");
66 //  atoms.net_virtual_roots = create("_NET_VIRTUAL_ROOTS");
67
68   atoms.net_close_window = create("_NET_CLOSE_WINDOW");
69   atoms.net_wm_moveresize = create("_NET_WM_MOVERESIZE");
70
71 //  atoms.net_properties = create("_NET_PROPERTIES");
72   atoms.net_wm_name = create("_NET_WM_NAME");
73   atoms.net_wm_visible_name = create("_NET_WM_VISIBLE_NAME");
74   atoms.net_wm_icon_name = create("_NET_WM_ICON_NAME");
75   atoms.net_wm_visible_icon_name = create("_NET_WM_VISIBLE_ICON_NAME");
76   atoms.net_wm_desktop = create("_NET_WM_DESKTOP");
77   atoms.net_wm_window_type = create("_NET_WM_WINDOW_TYPE");
78   atoms.net_wm_state = create("_NET_WM_STATE");
79   atoms.net_wm_strut = create("_NET_WM_STRUT");
80 //  atoms.net_wm_icon_geometry = create("_NET_WM_ICON_GEOMETRY");
81 //  atoms.net_wm_icon = create("_NET_WM_ICON");
82 //  atoms.net_wm_pid = create("_NET_WM_PID");
83 //  atoms.net_wm_handled_icons = create("_NET_WM_HANDLED_ICONS");
84   atoms.net_wm_allowed_actions = create("_NET_WM_ALLOWED_ACTIONS");
85
86 //  atoms.net_wm_ping = create("_NET_WM_PING");
87   
88   atoms.net_wm_window_type_desktop = create("_NET_WM_WINDOW_TYPE_DESKTOP");
89   atoms.net_wm_window_type_dock = create("_NET_WM_WINDOW_TYPE_DOCK");
90   atoms.net_wm_window_type_toolbar = create("_NET_WM_WINDOW_TYPE_TOOLBAR");
91   atoms.net_wm_window_type_menu = create("_NET_WM_WINDOW_TYPE_MENU");
92   atoms.net_wm_window_type_utility = create("_NET_WM_WINDOW_TYPE_UTILITY");
93   atoms.net_wm_window_type_splash = create("_NET_WM_WINDOW_TYPE_SPLASH");
94   atoms.net_wm_window_type_dialog = create("_NET_WM_WINDOW_TYPE_DIALOG");
95   atoms.net_wm_window_type_normal = create("_NET_WM_WINDOW_TYPE_NORMAL");
96
97   atoms.net_wm_moveresize_size_topleft =
98     create("_NET_WM_MOVERESIZE_SIZE_TOPLEFT");
99   atoms.net_wm_moveresize_size_topright =
100     create("_NET_WM_MOVERESIZE_SIZE_TOPRIGHT");
101   atoms.net_wm_moveresize_size_bottomleft =
102     create("_NET_WM_MOVERESIZE_SIZE_BOTTOMLEFT");
103   atoms.net_wm_moveresize_size_bottomright =
104     create("_NET_WM_MOVERESIZE_SIZE_BOTTOMRIGHT");
105   atoms.net_wm_moveresize_move =
106     create("_NET_WM_MOVERESIZE_MOVE");
107  
108   atoms.net_wm_action_move = create("_NET_WM_ACTION_MOVE");
109   atoms.net_wm_action_resize = create("_NET_WM_ACTION_RESIZE");
110   atoms.net_wm_action_shade = create("_NET_WM_ACTION_SHADE");
111   atoms.net_wm_action_maximize_horz = create("_NET_WM_ACTION_MAXIMIZE_HORZ");
112   atoms.net_wm_action_maximize_vert = create("_NET_WM_ACTION_MAXIMIZE_VERT");
113   atoms.net_wm_action_change_desktop =
114     create("_NET_WM_ACTION_CHANGE_DESKTOP");
115   atoms.net_wm_action_close = create("_NET_WM_ACTION_CLOSE");
116     
117   atoms.net_wm_state_modal = create("_NET_WM_STATE_MODAL");
118   atoms.net_wm_state_sticky = create("_NET_WM_STATE_STICKY");
119   atoms.net_wm_state_maximized_vert = create("_NET_WM_STATE_MAXIMIZED_VERT");
120   atoms.net_wm_state_maximized_horz = create("_NET_WM_STATE_MAXIMIZED_HORZ");
121   atoms.net_wm_state_shaded = create("_NET_WM_STATE_SHADED");
122   atoms.net_wm_state_skip_taskbar = create("_NET_WM_STATE_SKIP_TASKBAR");
123   atoms.net_wm_state_skip_pager = create("_NET_WM_STATE_SKIP_PAGER");
124   atoms.net_wm_state_hidden = create("_NET_WM_STATE_HIDDEN");
125   atoms.net_wm_state_fullscreen = create("_NET_WM_STATE_FULLSCREEN");
126   atoms.net_wm_state_above = create("_NET_WM_STATE_ABOVE");
127   atoms.net_wm_state_below = create("_NET_WM_STATE_BELOW");
128   
129   atoms.kde_net_system_tray_windows = create("_KDE_NET_SYSTEM_TRAY_WINDOWS");
130   atoms.kde_net_wm_system_tray_window_for =
131     create("_KDE_NET_WM_SYSTEM_TRAY_WINDOW_FOR");
132   atoms.kde_net_wm_window_type_override =
133     create("_KDE_NET_WM_WINDOW_TYPE_OVERRIDE");
134 }
135
136 void Property::set(Window win, Atom atom, Atom type, unsigned char* data,
137                    int size, int nelements, bool append)
138 {
139   assert(win != None); assert(atom != None); assert(type != None);
140   assert(nelements == 0 || (nelements > 0 && data != (unsigned char *) 0));
141   assert(size == 8 || size == 16 || size == 32);
142   XChangeProperty(**display, win, atom, type, size,
143                   (append ? PropModeAppend : PropModeReplace),
144                   data, nelements);
145 }
146
147 void Property::set(Window win, Atom atom, Atom type, unsigned long value)
148 {
149   set(win, atom, type, (unsigned char*) &value, 32, 1, false);
150 }
151
152 void Property::set(Window win, Atom atom, Atom type, unsigned long value[],
153                    int elements)
154 {
155   set(win, atom, type, (unsigned char*) value, 32, elements, false);
156 }
157
158 void Property::set(Window win, Atom atom, StringType type,
159                    const ustring &value)
160 {
161   Atom t;
162   switch (type) {
163   case ascii: t = atoms.string; assert(!value.utf8()); break;
164   case utf8:  t = atoms.utf8;   assert(value.utf8());  break;
165   default: assert(false); return; // unhandled StringType
166   }
167
168   // add 1 to the size to include the trailing null
169   set(win, atom, t, (unsigned char*) value.c_str(), 8, value.bytes() + 1,
170       false);
171 }
172
173 void Property::set(Window win, Atom atom, StringType type,
174                      const StringVect &strings)
175 {
176   Atom t;
177   bool u; // utf8 encoded?
178   switch (type) {
179   case ascii: t = atoms.string; u = false; break;
180   case utf8:  t = atoms.utf8;   u = true;  break;
181   default: assert(false); return; // unhandled StringType
182   }
183
184   ustring value(u);
185
186   StringVect::const_iterator it = strings.begin();
187   const StringVect::const_iterator end = strings.end();
188   for (; it != end; ++it) {
189     assert(it->utf8() == u); // the ustring is encoded correctly?
190     value += *it;
191     value += '\0';
192   }
193
194   // add 1 to the size to include the trailing null
195   set(win, atom, t, (unsigned char*)value.c_str(), 8,
196       value.bytes() + 1, false);
197 }
198
199 bool Property::get(Window win, Atom atom, Atom type, unsigned long *nelements,
200                    unsigned char **value, int size)
201 {
202   assert(win != None); assert(atom != None); assert(type != None);
203   assert(size == 8 || size == 16 || size == 32);
204   assert(*nelements > 0);
205   unsigned char *c_val = 0;        // value alloc'd in Xlib, must be XFree()d
206   Atom ret_type;
207   int ret_size;
208   unsigned long ret_bytes;
209   int result;
210   unsigned long maxread = *nelements;
211   bool ret = false;
212
213   // try get the first element
214   result = XGetWindowProperty(**display, win, atom, 0l, 1l,
215                               false, AnyPropertyType, &ret_type, &ret_size,
216                               nelements, &ret_bytes, &c_val);
217   ret = (result == Success && ret_type == type && ret_size == size &&
218          *nelements > 0);
219   if (ret) {
220     if (ret_bytes == 0 || maxread <= *nelements) {
221       // we got the whole property's value
222       *value = new unsigned char[*nelements * size/8 + 1];
223       memcpy(*value, c_val, *nelements * size/8 + 1);
224     } else {
225       // get the entire property since it is larger than one long
226       XFree(c_val);
227       // the number of longs that need to be retreived to get the property's
228       // entire value. The last + 1 is the first long that we retrieved above.
229       int remain = (ret_bytes - 1)/sizeof(long) + 1 + 1;
230       if (remain > size/8 * (signed)maxread) // dont get more than the max
231         remain = size/8 * (signed)maxread;
232       result = XGetWindowProperty(**display, win, atom, 0l,
233                                   remain, false, type, &ret_type, &ret_size,
234                                   nelements, &ret_bytes, &c_val);
235       ret = (result == Success && ret_type == type && ret_size == size &&
236              ret_bytes == 0);
237       /*
238         If the property has changed type/size, or has grown since our first
239         read of it, then stop here and try again. If it shrank, then this will
240         still work.
241       */
242       if (! ret)
243         return get(win, atom, type, &maxread, value, size);
244   
245       *value = new unsigned char[*nelements * size/8 + 1];
246       memcpy(*value, c_val, *nelements * size/8 + 1);
247     }    
248   }
249   if (c_val) XFree(c_val);
250   return ret;
251 }
252
253 bool Property::get(Window win, Atom atom, Atom type, unsigned long *nelements,
254                    unsigned long **value)
255 {
256   return get(win, atom, type, nelements, (unsigned char**) value, 32);
257 }
258
259 bool Property::get(Window win, Atom atom, Atom type, unsigned long *value)
260 {
261   unsigned long *temp;
262   unsigned long num = 1;
263   if (! get(win, atom, type, &num, (unsigned char **) &temp, 32))
264     return false;
265   *value = temp[0];
266   delete [] temp;
267   return true;
268 }
269
270 bool Property::get(Window win, Atom atom, StringType type, ustring *value)
271 {
272   unsigned long n = 1;
273   StringVect s;
274
275   if (get(win, atom, type, &n, &s)) {
276     *value = s[0];
277     return true;
278   }
279   return false;
280 }
281
282 bool Property::get(Window win, Atom atom, StringType type,
283                    unsigned long *nelements, StringVect *strings)
284 {
285   assert(*nelements > 0);
286
287   Atom t;
288   bool u; // utf8 encoded?
289   switch (type) {
290   case ascii: t = atoms.string; u = false; break;
291   case utf8:  t = atoms.utf8;   u = true;  break;
292   default: assert(false); return false; // unhandled StringType
293   }
294   
295   unsigned char *value;
296   unsigned long elements = (unsigned) -1;
297   if (!get(win, atom, t, &elements, &value, 8) || elements < 1)
298     return false;
299
300   std::string s((char*)value, elements);
301   delete [] value;
302
303   std::string::const_iterator it = s.begin(), end = s.end();
304   unsigned long num = 0;
305   while(num < *nelements) {
306     std::string::const_iterator tmp = it; // current string.begin()
307     it = std::find(tmp, end, '\0');       // look for null between tmp and end
308     strings->push_back(std::string(tmp, it));   // s[tmp:it)
309     strings->back().setUtf8(u);
310     ++num;
311     if (it == end) break;
312     ++it;
313     if (it == end) break;
314   }
315
316   *nelements = num;
317
318   return true;
319 }
320
321
322 /*
323  * Removes a property entirely from a window.
324  */
325 void Property::erase(Window win, Atom atom)
326 {
327   XDeleteProperty(**display, win, atom);
328 }
329
330 }