moving strut into its own .hh. adding OBClient class
[mikachu/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 <assert.h>
12 }
13
14 #include <algorithm>
15
16 namespace otk {
17
18 OBProperty::OBProperty()
19 {
20   assert(OBDisplay::display);
21
22   // make sure asserts fire if there is a problem
23   memset(_atoms, 0, sizeof(_atoms));
24
25   _atoms[Atom_Cardinal] = XA_CARDINAL;
26   _atoms[Atom_Window] = XA_WINDOW;
27   _atoms[Atom_Pixmap] = XA_PIXMAP;
28   _atoms[Atom_Atom] = XA_ATOM;
29   _atoms[Atom_String] = XA_STRING;
30   _atoms[Atom_Utf8] = create("UTF8_STRING");
31   
32 #ifdef    HAVE_GETPID
33   _atoms[blackbox_pid] = create("_BLACKBOX_PID");
34 #endif // HAVE_GETPID
35
36   _atoms[wm_colormap_windows] = create("WM_COLORMAP_WINDOWS");
37   _atoms[wm_protocols] = create("WM_PROTOCOLS");
38   _atoms[wm_state] = create("WM_STATE");
39   _atoms[wm_change_state] = create("WM_CHANGE_STATE");
40   _atoms[wm_delete_window] = create("WM_DELETE_WINDOW");
41   _atoms[wm_take_focus] = create("WM_TAKE_FOCUS");
42   _atoms[wm_name] = create("WM_NAME");
43   _atoms[wm_icon_name] = create("WM_ICON_NAME");
44   _atoms[wm_class] = create("WM_CLASS");
45   _atoms[motif_wm_hints] = create("_MOTIF_WM_HINTS");
46   _atoms[blackbox_hints] = create("_BLACKBOX_HINTS");
47   _atoms[blackbox_attributes] = create("_BLACKBOX_ATTRIBUTES");
48   _atoms[blackbox_change_attributes] = create("_BLACKBOX_CHANGE_ATTRIBUTES");
49   _atoms[blackbox_structure_messages] = create("_BLACKBOX_STRUCTURE_MESSAGES");
50   _atoms[blackbox_notify_startup] = create("_BLACKBOX_NOTIFY_STARTUP");
51   _atoms[blackbox_notify_window_add] = create("_BLACKBOX_NOTIFY_WINDOW_ADD");
52   _atoms[blackbox_notify_window_del] = create("_BLACKBOX_NOTIFY_WINDOW_DEL");
53   _atoms[blackbox_notify_current_workspace] = 
54     create("_BLACKBOX_NOTIFY_CURRENT_WORKSPACE");
55   _atoms[blackbox_notify_workspace_count] =
56     create("_BLACKBOX_NOTIFY_WORKSPACE_COUNT");
57   _atoms[blackbox_notify_window_focus] =
58     create("_BLACKBOX_NOTIFY_WINDOW_FOCUS");
59   _atoms[blackbox_notify_window_raise] =
60     create("_BLACKBOX_NOTIFY_WINDOW_RAISE");
61   _atoms[blackbox_notify_window_lower] =
62     create("_BLACKBOX_NOTIFY_WINDOW_LOWER");
63   
64   _atoms[blackbox_change_workspace] = create("_BLACKBOX_CHANGE_WORKSPACE");
65   _atoms[blackbox_change_window_focus] =
66     create("_BLACKBOX_CHANGE_WINDOW_FOCUS");
67   _atoms[blackbox_cycle_window_focus] = create("_BLACKBOX_CYCLE_WINDOW_FOCUS");
68
69   _atoms[openbox_show_root_menu] = create("_OPENBOX_SHOW_ROOT_MENU");
70   _atoms[openbox_show_workspace_menu] = create("_OPENBOX_SHOW_WORKSPACE_MENU");
71
72   _atoms[net_supported] = create("_NET_SUPPORTED");
73   _atoms[net_client_list] = create("_NET_CLIENT_LIST");
74   _atoms[net_client_list_stacking] = create("_NET_CLIENT_LIST_STACKING");
75   _atoms[net_number_of_desktops] = create("_NET_NUMBER_OF_DESKTOPS");
76   _atoms[net_desktop_geometry] = create("_NET_DESKTOP_GEOMETRY");
77   _atoms[net_desktop_viewport] = create("_NET_DESKTOP_VIEWPORT");
78   _atoms[net_current_desktop] = create("_NET_CURRENT_DESKTOP");
79   _atoms[net_desktop_names] = create("_NET_DESKTOP_NAMES");
80   _atoms[net_active_window] = create("_NET_ACTIVE_WINDOW");
81   _atoms[net_workarea] = create("_NET_WORKAREA");
82   _atoms[net_supporting_wm_check] = create("_NET_SUPPORTING_WM_CHECK");
83 //  _atoms[net_virtual_roots] = create("_NET_VIRTUAL_ROOTS");
84
85   _atoms[net_close_window] = create("_NET_CLOSE_WINDOW");
86   _atoms[net_wm_moveresize] = create("_NET_WM_MOVERESIZE");
87
88 //  _atoms[net_properties] = create("_NET_PROPERTIES");
89   _atoms[net_wm_name] = create("_NET_WM_NAME");
90   _atoms[net_wm_visible_name] = create("_NET_WM_VISIBLE_NAME");
91   _atoms[net_wm_icon_name] = create("_NET_WM_ICON_NAME");
92   _atoms[net_wm_visible_icon_name] = create("_NET_WM_VISIBLE_ICON_NAME");
93   _atoms[net_wm_desktop] = create("_NET_WM_DESKTOP");
94   _atoms[net_wm_window_type] = create("_NET_WM_WINDOW_TYPE");
95   _atoms[net_wm_state] = create("_NET_WM_STATE");
96   _atoms[net_wm_strut] = create("_NET_WM_STRUT");
97 //  _atoms[net_wm_icon_geometry] = create("_NET_WM_ICON_GEOMETRY");
98 //  _atoms[net_wm_icon] = create("_NET_WM_ICON");
99 //  _atoms[net_wm_pid] = create("_NET_WM_PID");
100 //  _atoms[net_wm_handled_icons] = create("_NET_WM_HANDLED_ICONS");
101   _atoms[net_wm_allowed_actions] = create("_NET_WM_ALLOWED_ACTIONS");
102
103 //  _atoms[net_wm_ping] = create("_NET_WM_PING");
104   
105   _atoms[net_wm_window_type_desktop] = create("_NET_WM_WINDOW_TYPE_DESKTOP");
106   _atoms[net_wm_window_type_dock] = create("_NET_WM_WINDOW_TYPE_DOCK");
107   _atoms[net_wm_window_type_toolbar] = create("_NET_WM_WINDOW_TYPE_TOOLBAR");
108   _atoms[net_wm_window_type_menu] = create("_NET_WM_WINDOW_TYPE_MENU");
109   _atoms[net_wm_window_type_utility] = create("_NET_WM_WINDOW_TYPE_UTILITY");
110   _atoms[net_wm_window_type_splash] = create("_NET_WM_WINDOW_TYPE_SPLASH");
111   _atoms[net_wm_window_type_dialog] = create("_NET_WM_WINDOW_TYPE_DIALOG");
112   _atoms[net_wm_window_type_normal] = create("_NET_WM_WINDOW_TYPE_NORMAL");
113
114   _atoms[net_wm_moveresize_size_topleft] =
115     create("_NET_WM_MOVERESIZE_SIZE_TOPLEFT");
116   _atoms[net_wm_moveresize_size_topright] =
117     create("_NET_WM_MOVERESIZE_SIZE_TOPRIGHT");
118   _atoms[net_wm_moveresize_size_bottomleft] =
119     create("_NET_WM_MOVERESIZE_SIZE_BOTTOMLEFT");
120   _atoms[net_wm_moveresize_size_bottomright] =
121     create("_NET_WM_MOVERESIZE_SIZE_BOTTOMRIGHT");
122   _atoms[net_wm_moveresize_move] =
123     create("_NET_WM_MOVERESIZE_MOVE");
124  
125   _atoms[net_wm_action_move] = create("_NET_WM_ACTION_MOVE");
126   _atoms[net_wm_action_resize] = create("_NET_WM_ACTION_RESIZE");
127   _atoms[net_wm_action_shade] = create("_NET_WM_ACTION_SHADE");
128   _atoms[net_wm_action_maximize_horz] = create("_NET_WM_ACTION_MAXIMIZE_HORZ");
129   _atoms[net_wm_action_maximize_vert] = create("_NET_WM_ACTION_MAXIMIZE_VERT");
130   _atoms[net_wm_action_change_desktop] =
131     create("_NET_WM_ACTION_CHANGE_DESKTOP");
132   _atoms[net_wm_action_close] = create("_NET_WM_ACTION_CLOSE");
133     
134   _atoms[net_wm_state_modal] = create("_NET_WM_STATE_MODAL");
135   _atoms[net_wm_state_maximized_vert] = create("_NET_WM_STATE_MAXIMIZED_VERT");
136   _atoms[net_wm_state_maximized_horz] = create("_NET_WM_STATE_MAXIMIZED_HORZ");
137   _atoms[net_wm_state_shaded] = create("_NET_WM_STATE_SHADED");
138   _atoms[net_wm_state_skip_taskbar] = create("_NET_WM_STATE_SKIP_TASKBAR");
139   _atoms[net_wm_state_skip_pager] = create("_NET_WM_STATE_SKIP_PAGER");
140   _atoms[net_wm_state_hidden] = create("_NET_WM_STATE_HIDDEN");
141   _atoms[net_wm_state_fullscreen] = create("_NET_WM_STATE_FULLSCREEN");
142   _atoms[net_wm_state_floating] = create("_NET_WM_STATE_FLOATING");
143   
144   _atoms[kde_net_system_tray_windows] = create("_KDE_NET_SYSTEM_TRAY_WINDOWS");
145   _atoms[kde_net_wm_system_tray_window_for] =
146     create("_KDE_NET_WM_SYSTEM_TRAY_WINDOW_FOR");
147   _atoms[kde_net_wm_window_type_override] =
148     create("_KDE_NET_WM_WINDOW_TYPE_OVERRIDE");
149 }
150
151
152 /*
153  * clean up the class' members
154  */
155 OBProperty::~OBProperty()
156 {
157 }
158
159
160 /*
161  * Returns an atom from the Xserver, creating it if necessary.
162  */
163 Atom OBProperty::create(const char *name) const
164 {
165   return XInternAtom(OBDisplay::display, name, False);
166 }
167
168
169 /*
170  * Internal set.
171  * Sets a window property on a window, optionally appending to the existing
172  * value.
173  */
174 void OBProperty::set(Window win, Atom atom, Atom type,
175                           unsigned char* data, int size, int nelements,
176                           bool append) const
177 {
178   assert(win != None); assert(atom != None); assert(type != None);
179   assert(nelements == 0 || (nelements > 0 && data != (unsigned char *) 0));
180   assert(size == 8 || size == 16 || size == 32);
181   XChangeProperty(OBDisplay::display, win, atom, type, size,
182                   (append ? PropModeAppend : PropModeReplace),
183                   data, nelements);
184 }
185
186
187 /*
188  * Set a 32-bit property value on a window.
189  */
190 void OBProperty::set(Window win, Atoms atom, Atoms type,
191                           unsigned long value) const
192 {
193   assert(atom >= 0 && atom < NUM_ATOMS);
194   assert(type >= 0 && type < NUM_ATOMS);
195   set(win, _atoms[atom], _atoms[type],
196            reinterpret_cast<unsigned char*>(&value), 32, 1, False);
197 }
198
199
200 /*
201  * Set an array of 32-bit properties value on a window.
202  */
203 void OBProperty::set(Window win, Atoms atom, Atoms type,
204                           unsigned long value[], int elements) const
205 {
206   assert(atom >= 0 && atom < NUM_ATOMS);
207   assert(type >= 0 && type < NUM_ATOMS);
208   set(win, _atoms[atom], _atoms[type],
209       reinterpret_cast<unsigned char*>(value), 32, elements, False);
210 }
211
212
213 /*
214  * Set an string property value on a window.
215  */
216 void OBProperty::set(Window win, Atoms atom, StringType type,
217                           const std::string &value) const
218 {
219   assert(atom >= 0 && atom < NUM_ATOMS);
220   assert(type >= 0 && type < NUM_STRING_TYPE);
221   
222   Atom t;
223   switch (type) {
224   case ascii: t = _atoms[Atom_String]; break;
225   case utf8:  t = _atoms[Atom_Utf8]; break;
226   default: assert(False); return; // unhandled StringType
227   }
228   set(win, _atoms[atom], t,
229       reinterpret_cast<unsigned char *>(const_cast<char *>(value.c_str())),
230       8, value.size() + 1, False); // add 1 to the size to include the null
231 }
232
233
234 /*
235  * Set an array of string property values on a window.
236  */
237 void OBProperty::set(Window win, Atoms atom, StringType type,
238                      const StringVect &strings) const
239 {
240   assert(atom >= 0 && atom < NUM_ATOMS);
241   assert(type >= 0 && type < NUM_STRING_TYPE);
242
243   Atom t;
244   switch (type) {
245   case ascii: t = _atoms[Atom_String]; break;
246   case utf8:  t = _atoms[Atom_Utf8]; break;
247   default: assert(False); return; // unhandled StringType
248   }
249
250   std::string value;
251
252   StringVect::const_iterator it = strings.begin();
253   const StringVect::const_iterator end = strings.end();
254   for (; it != end; ++it)
255       value += *it + '\0';
256
257   set(win, _atoms[atom], t,
258       reinterpret_cast<unsigned char *>(const_cast<char *>(value.c_str())),
259       8, value.size(), False);
260 }
261
262
263 /*
264  * Internal get function used by all of the typed get functions.
265  * Gets an property's value from a window.
266  * Returns True if the property was successfully retrieved; False if the
267  * property did not exist on the window, or has a different type/size format
268  * than the user tried to retrieve.
269  */
270 bool OBProperty::get(Window win, Atom atom, Atom type,
271                           unsigned long *nelements, unsigned char **value,
272                           int size) const
273 {
274   assert(win != None); assert(atom != None); assert(type != None);
275   assert(size == 8 || size == 16 || size == 32);
276   assert(*nelements > 0);
277   unsigned char *c_val = 0;        // value alloc'd in Xlib, must be XFree()d
278   Atom ret_type;
279   int ret_size;
280   unsigned long ret_bytes;
281   int result;
282   unsigned long maxread = *nelements;
283   bool ret = False;
284
285   // try get the first element
286   result = XGetWindowProperty(OBDisplay::display, win, atom, 0l, 1l,
287                               False, AnyPropertyType, &ret_type, &ret_size,
288                               nelements, &ret_bytes, &c_val);
289   ret = (result == Success && ret_type == type && ret_size == size &&
290          *nelements > 0);
291   if (ret) {
292     if (ret_bytes == 0 || maxread <= *nelements) {
293       // we got the whole property's value
294       *value = new unsigned char[*nelements * size/8 + 1];
295       memcpy(*value, c_val, *nelements * size/8 + 1);
296     } else {
297       // get the entire property since it is larger than one long
298       XFree(c_val);
299       // the number of longs that need to be retreived to get the property's
300       // entire value. The last + 1 is the first long that we retrieved above.
301       int remain = (ret_bytes - 1)/sizeof(long) + 1 + 1;
302       if (remain > size/8 * (signed)maxread) // dont get more than the max
303         remain = size/8 * (signed)maxread;
304       result = XGetWindowProperty(OBDisplay::display, win, atom, 0l,
305                                   remain, False, type, &ret_type, &ret_size,
306                                   nelements, &ret_bytes, &c_val);
307       ret = (result == Success && ret_type == type && ret_size == size &&
308              ret_bytes == 0);
309       /*
310         If the property has changed type/size, or has grown since our first
311         read of it, then stop here and try again. If it shrank, then this will
312         still work.
313       */
314       if (! ret)
315         return get(win, atom, type, &maxread, value, size);
316   
317       *value = new unsigned char[*nelements * size/8 + 1];
318       memcpy(*value, c_val, *nelements * size/8 + 1);
319     }    
320   }
321   if (c_val) XFree(c_val);
322   return ret;
323 }
324
325
326 /*
327  * Gets a 32-bit property's value from a window.
328  */
329 bool OBProperty::get(Window win, Atoms atom, Atoms type,
330                           unsigned long *nelements,
331                           unsigned long **value) const
332 {
333   assert(atom >= 0 && atom < NUM_ATOMS);
334   assert(type >= 0 && type < NUM_ATOMS);
335   return get(win, _atoms[atom], _atoms[type], nelements,
336                   reinterpret_cast<unsigned char **>(value), 32);
337 }
338
339
340 /*
341  * Gets a single 32-bit property's value from a window.
342  */
343 bool OBProperty::get(Window win, Atoms atom, Atoms type,
344                      unsigned long *value) const
345 {
346   assert(atom >= 0 && atom < NUM_ATOMS);
347   assert(type >= 0 && type < NUM_ATOMS);
348   unsigned long *temp;
349   unsigned long num = 1;
350   if (! get(win, _atoms[atom], _atoms[type], &num,
351                  reinterpret_cast<unsigned char **>(&temp), 32))
352     return False;
353   *value = temp[0];
354   delete [] temp;
355   return True;
356 }
357
358
359 /*
360  * Gets an string property's value from a window.
361  */
362 bool OBProperty::get(Window win, Atoms atom, StringType type,
363                      std::string *value) const
364 {
365   unsigned long n = 1;
366   StringVect s;
367   if (get(win, atom, type, &n, &s)) {
368     *value = s[0];
369     return True;
370   }
371   return False;
372 }
373
374
375 bool OBProperty::get(Window win, Atoms atom, StringType type,
376                      unsigned long *nelements, StringVect *strings) const
377 {
378   assert(atom >= 0 && atom < NUM_ATOMS);
379   assert(type >= 0 && type < NUM_STRING_TYPE);
380   assert(win != None); assert(_atoms[atom] != None);
381   assert(*nelements > 0);
382
383   Atom t;
384   switch (type) {
385   case ascii: t = _atoms[Atom_String]; break;
386   case utf8:  t = _atoms[Atom_Utf8]; break;
387   default: assert(False); return False; // unhandled StringType
388   }
389   
390   unsigned char *value;
391   unsigned long elements = (unsigned) -1;
392   if (!get(win, _atoms[atom], t, &elements, &value, 8) || elements < 1)
393     return False;
394
395   std::string s(reinterpret_cast<char *>(value), elements);
396   delete [] value;
397
398   std::string::const_iterator it = s.begin(), end = s.end();
399   unsigned long num = 0;
400   while(num < *nelements) {
401     std::string::const_iterator tmp = it; // current string.begin()
402     it = std::find(tmp, end, '\0');       // look for null between tmp and end
403     strings->push_back(std::string(tmp, it));   // s[tmp:it)
404     ++num;
405     if (it == end) break;
406     ++it;
407     if (it == end) break;
408   }
409
410   *nelements = num;
411
412   return True;
413 }
414
415
416 /*
417  * Removes a property entirely from a window.
418  */
419 void OBProperty::erase(Window win, Atoms atom) const
420 {
421   assert(atom >= 0 && atom < NUM_ATOMS);
422   XDeleteProperty(OBDisplay::display, win, _atoms[atom]);
423 }
424
425 }