merge from netwm-merge2 to netwm-merge3. Basically, all of netwm that we intend to...
[mikachu/openbox.git] / src / blackbox.hh
1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
2 // blackbox.hh for Blackbox - an X11 Window manager
3 // Copyright (c) 2001 - 2002 Sean 'Shaleh' Perry <shaleh@debian.org>
4 // Copyright (c) 1997 - 2000 Brad Hughes (bhughes@tcac.net)
5 //
6 // Permission is hereby granted, free of charge, to any person obtaining a
7 // copy of this software and associated documentation files (the "Software"),
8 // to deal in the Software without restriction, including without limitation
9 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 // and/or sell copies of the Software, and to permit persons to whom the
11 // Software is furnished to do so, subject to the following conditions:
12 //
13 // The above copyright notice and this permission notice shall be included in
14 // all copies or substantial portions of the Software.
15 //
16 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
19 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 // DEALINGS IN THE SOFTWARE.
23
24 #ifndef   __blackbox_hh
25 #define   __blackbox_hh
26
27 extern "C" {
28 #include <X11/Xlib.h>
29
30 #ifdef    HAVE_STDIO_H
31 # include <stdio.h>
32 #endif // HAVE_STDIO_H
33
34 #ifdef    TIME_WITH_SYS_TIME
35 #  include <sys/time.h>
36 #  include <time.h>
37 #else // !TIME_WITH_SYS_TIME
38 #  ifdef    HAVE_SYS_TIME_H
39 #    include <sys/time.h>
40 #  else // !HAVE_SYS_TIME_H
41 #    include <time.h>
42 #  endif // HAVE_SYS_TIME_H
43 #endif // TIME_WITH_SYS_TIME
44 }
45
46 #include <list>
47 #include <map>
48 #include <string>
49
50 #include "i18n.hh"
51 #include "BaseDisplay.hh"
52 #include "Configuration.hh"
53 #include "Timer.hh"
54 #include "XAtom.hh"
55
56 #define AttribShaded      (1l << 0)
57 #define AttribMaxHoriz    (1l << 1)
58 #define AttribMaxVert     (1l << 2)
59 #define AttribOmnipresent (1l << 3)
60 #define AttribWorkspace   (1l << 4)
61 #define AttribStack       (1l << 5)
62 #define AttribDecoration  (1l << 6)
63
64 #define StackTop          (0)
65 #define StackNormal       (1)
66 #define StackBottom       (2)
67
68 #define DecorNone         (0)
69 #define DecorNormal       (1)
70 #define DecorTiny         (2)
71 #define DecorTool         (3)
72
73 struct BlackboxHints {
74   unsigned long flags, attrib, workspace, stack, decoration;
75 };
76
77 struct BlackboxAttributes {
78   unsigned long flags, attrib, workspace, stack, decoration;
79   int premax_x, premax_y;
80   unsigned int premax_w, premax_h;
81 };
82
83 #define PropBlackboxHintsElements      (5)
84 #define PropBlackboxAttributesElements (9)
85
86
87 //forward declaration
88 class BScreen;
89 class Blackbox;
90 class BlackboxWindow;
91 class BWindowGroup;
92 class Basemenu;
93 class Toolbar;
94 class Slit;
95
96 extern I18n i18n;
97
98 class Blackbox : public BaseDisplay, public TimeoutHandler {
99 private:
100   struct BCursor {
101     Cursor session, move, ll_angle, lr_angle, ul_angle, ur_angle;
102   };
103   BCursor cursor;
104
105   struct MenuTimestamp {
106     std::string filename;
107     time_t timestamp;
108   };
109
110   struct BResource {
111     Time double_click_interval;
112
113     std::string style_file;
114     int colors_per_channel;
115     timeval auto_raise_delay;
116     unsigned long cache_life, cache_max;
117     std::string titlebar_layout;
118   } resource;
119
120   typedef std::map<Window, BlackboxWindow*> WindowLookup;
121   typedef WindowLookup::value_type WindowLookupPair;
122   WindowLookup windowSearchList;
123
124   typedef std::map<Window, BScreen*> WindowScreenLookup;
125   typedef WindowScreenLookup::value_type WindowScreenLookupPair;
126   WindowScreenLookup systraySearchList, desktopSearchList;
127
128   typedef std::map<Window, BWindowGroup*> GroupLookup;
129   typedef GroupLookup::value_type GroupLookupPair;
130   GroupLookup groupSearchList;
131
132   typedef std::map<Window, Basemenu*> MenuLookup;
133   typedef MenuLookup::value_type MenuLookupPair;
134   MenuLookup menuSearchList;
135
136   typedef std::map<Window, Toolbar*> ToolbarLookup;
137   typedef ToolbarLookup::value_type ToolbarLookupPair;
138   ToolbarLookup toolbarSearchList;
139
140   typedef std::map<Window, Slit*> SlitLookup;
141   typedef SlitLookup::value_type SlitLookupPair;
142   SlitLookup slitSearchList;
143
144   typedef std::list<MenuTimestamp*> MenuTimestampList;
145   MenuTimestampList menuTimestamps;
146
147   typedef std::list<BScreen*> ScreenList;
148   ScreenList screenList;
149
150   BScreen *active_screen;
151   BlackboxWindow *focused_window, *changing_window;
152   BTimer *timer;
153   Configuration config;
154   XAtom *xatom;
155
156   bool no_focus, reconfigure_wait, reread_menu_wait;
157   Time last_time;
158   char **argv;
159   std::string menu_file, rc_file;
160
161   Blackbox(const Blackbox&);
162   Blackbox& operator=(const Blackbox&);
163
164   void load_rc(void);
165   void save_rc(void);
166   void real_rereadMenu(void);
167   void real_reconfigure(void);
168
169   virtual void process_event(XEvent *);
170
171
172 public:
173   Blackbox(char **m_argv, char *dpy_name = 0, char *rc = 0, char *menu = 0);
174   virtual ~Blackbox(void);
175
176   Basemenu *searchMenu(Window window);
177   BWindowGroup *searchGroup(Window window);
178   BScreen *searchDesktopWindow(Window window);
179   BScreen *searchSystrayWindow(Window window);
180   BlackboxWindow *searchWindow(Window window);
181   BScreen *searchScreen(Window window);
182   Toolbar *searchToolbar(Window);
183   Slit *searchSlit(Window);
184
185   void saveMenuSearch(Window window, Basemenu *data);
186   void saveDesktopWindowSearch(Window window, BScreen *screen);
187   void saveSystrayWindowSearch(Window window, BScreen *screen);
188   void saveWindowSearch(Window window, BlackboxWindow *data);
189   void saveGroupSearch(Window window, BWindowGroup *data);
190   void saveToolbarSearch(Window window, Toolbar *data);
191   void saveSlitSearch(Window window, Slit *data);
192   void removeMenuSearch(Window window);
193   void removeDesktopWindowSearch(Window window);
194   void removeSystrayWindowSearch(Window window);
195   void removeWindowSearch(Window window);
196   void removeGroupSearch(Window window);
197   void removeToolbarSearch(Window window);
198   void removeSlitSearch(Window window);
199
200   inline XAtom *getXAtom(void) { return xatom; }
201   
202   inline BlackboxWindow *getFocusedWindow(void) { return focused_window; }
203   inline BlackboxWindow *getChangingWindow(void) { return changing_window; }
204
205   inline Configuration *getConfig() { return &config; }
206   inline const Time &getDoubleClickInterval(void) const
207   { return resource.double_click_interval; }
208   inline const Time &getLastTime(void) const { return last_time; }
209
210   inline const char *getStyleFilename(void) const
211     { return resource.style_file.c_str(); }
212   inline const char *getMenuFilename(void) const
213     { return menu_file.c_str(); }
214
215   inline int getColorsPerChannel(void) const
216     { return resource.colors_per_channel; }
217
218   inline std::string getTitlebarLayout(void) const
219     { return resource.titlebar_layout; }
220
221   inline const timeval &getAutoRaiseDelay(void) const
222     { return resource.auto_raise_delay; }
223
224   inline unsigned long getCacheLife(void) const
225     { return resource.cache_life; }
226   inline unsigned long getCacheMax(void) const
227     { return resource.cache_max; }
228
229   inline void setNoFocus(bool f) { no_focus = f; }
230
231   inline Cursor getSessionCursor(void) const
232     { return cursor.session; }
233   inline Cursor getMoveCursor(void) const
234     { return cursor.move; }
235   inline Cursor getLowerLeftAngleCursor(void) const
236     { return cursor.ll_angle; }
237   inline Cursor getLowerRightAngleCursor(void) const
238     { return cursor.lr_angle; }
239   inline Cursor getUpperLeftAngleCursor(void) const
240     { return cursor.ul_angle; }
241   inline Cursor getUpperRightAngleCursor(void) const
242     { return cursor.ur_angle; }
243
244   void setFocusedWindow(BlackboxWindow *win);
245   void setChangingWindow(BlackboxWindow *win);
246   void shutdown(void);
247   void saveStyleFilename(const std::string& filename);
248   void addMenuTimestamp(const std::string& filename);
249   void restart(const char *prog = 0);
250   void reconfigure(void);
251   void rereadMenu(void);
252   void checkMenu(void);
253
254   bool validateWindow(Window window);
255
256   virtual bool handleSignal(int sig);
257
258   virtual void timeout(void);
259
260 #ifndef   HAVE_STRFTIME
261   enum { B_AmericanDate = 1, B_EuropeanDate };
262 #endif // HAVE_STRFTIME
263 };
264
265
266 #endif // __blackbox_hh