src/openbox.h

   1 // openbox.h for Openbox
   2 // Copyright (c) 2001 Sean 'Shaleh' Perry <shaleh@debian.org>
   3 // Copyright (c) 1997 - 2000 Brad Hughes (bhughes@tcac.net)
   4 //
   5 // Permission is hereby granted, free of charge, to any person obtaining a
   6 // copy of this software and associated documentation files (the "Software"),
   7 // to deal in the Software without restriction, including without limitation
   8 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9 // and/or sell copies of the Software, and to permit persons to whom the
  10 // Software is furnished to do so, subject to the following conditions:
  11 //
  12 // The above copyright notice and this permission notice shall be included in
  13 // all copies or substantial portions of the Software.
  14 //
  15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21 // DEALINGS IN THE SOFTWARE.
  22
  23 #ifndef   __openbox_hh
  24 #define   __openbox_hh
  25
  26 #include <X11/Xlib.h>
  27 #include <X11/Xresource.h>
  28
  29 #ifdef    HAVE_STDIO_H
  30 # include <stdio.h>
  31 #endif // HAVE_STDIO_H
  32
  33 #ifdef    TIME_WITH_SYS_TIME
  34 #  include <sys/time.h>
  35 #  include <time.h>
  36 #else // !TIME_WITH_SYS_TIME
  37 #  ifdef    HAVE_SYS_TIME_H
  38 #    include <sys/time.h>
  39 #  else // !HAVE_SYS_TIME_H
  40 #    include <time.h>
  41 #  endif // HAVE_SYS_TIME_H
  42 #endif // TIME_WITH_SYS_TIME
  43
  44 #include "Resource.h"
  45 #include "LinkedList.h"
  46 #include "BaseDisplay.h"
  47 #include "Timer.h"
  48
  49 //forward declaration
  50 class BScreen;
  51 class Openbox;
  52 class BImageControl;
  53 class OpenboxWindow;
  54 class Basemenu;
  55 class Toolbar;
  56 #ifdef    SLIT
  57 class Slit;
  58 #endif // SLIT
  59
  60 template <class Z>
  61 class DataSearch {
  62 private:
  63   Window window;
  64   Z *data;
  65
  66 public:
  67   DataSearch(Window w, Z *d): window(w), data(d) {}
  68
  69   inline const Window &getWindow(void) const { return window; }
  70   inline Z *getData(void) { return data; }
  71 };
  72
  73
  74 class Openbox : public BaseDisplay, public TimeoutHandler {
  75 private:
  76   typedef struct MenuTimestamp {
  77     char *filename;
  78     time_t timestamp;
  79   } MenuTimestamp;
  80
  81   struct resource {
  82     Time double_click_interval;
  83
  84     char *menu_file, *style_file;
  85     char *titlebar_layout;
  86     int colors_per_channel;
  87     timeval auto_raise_delay;
  88     unsigned long cache_life, cache_max;
  89   } resource;
  90
  91   typedef DataSearch<OpenboxWindow> WindowSearch;
  92   LinkedList<WindowSearch> *windowSearchList, *groupSearchList;
  93   typedef DataSearch<Basemenu> MenuSearch;
  94   LinkedList<MenuSearch> *menuSearchList;
  95   typedef DataSearch<Toolbar> ToolbarSearch;
  96   LinkedList<ToolbarSearch> *toolbarSearchList;
  97
  98 #ifdef    SLIT
  99   typedef DataSearch<Slit> SlitSearch;
 100   LinkedList<SlitSearch> *slitSearchList;
 101 #endif // SLIT
 102
 103   LinkedList<MenuTimestamp> *menuTimestamps;
 104   LinkedList<BScreen> *screenList;
 105
 106   OpenboxWindow *focused_window, *masked_window;
 107   BTimer *timer;
 108
 109 #ifdef    HAVE_GETPID
 110   Atom openbox_pid;
 111 #endif // HAVE_GETPID
 112
 113   Bool no_focus, reconfigure_wait, reread_menu_wait;
 114   Time last_time;
 115   Window masked;
 116   char *rc_file, **argv;
 117   int argc;
 118   Resource config;
 119
 120
 121 protected:
 122   void load_rc(void);
 123   void save_rc(void);
 124   void reload_rc(void);
 125   void real_rereadMenu(void);
 126   void real_reconfigure(void);
 127
 128   virtual void process_event(XEvent *);
 129
 130
 131 public:
 132   Openbox(int, char **, char * = 0, char * = 0);
 133   virtual ~Openbox(void);
 134
 135 #ifdef    HAVE_GETPID
 136   inline const Atom &getOpenboxPidAtom(void) const { return openbox_pid; }
 137 #endif // HAVE_GETPID
 138
 139   Basemenu *searchMenu(Window);
 140
 141   OpenboxWindow *searchGroup(Window, OpenboxWindow *);
 142   OpenboxWindow *searchWindow(Window);
 143   inline OpenboxWindow *getFocusedWindow(void) { return focused_window; }
 144
 145   BScreen *getScreen(int);
 146   BScreen *searchScreen(Window);
 147
 148   inline Resource &getConfig() {
 149     return config;
 150   }
 151   inline const Time &getDoubleClickInterval(void) const
 152     { return resource.double_click_interval; }
 153   inline const Time &getLastTime(void) const { return last_time; }
 154
 155   Toolbar *searchToolbar(Window);
 156
 157   inline const char *getStyleFilename(void) const
 158     { return resource.style_file; }
 159   inline const char *getMenuFilename(void) const
 160     { return resource.menu_file; }
 161
 162   inline const int &getColorsPerChannel(void) const
 163     { return resource.colors_per_channel; }
 164
 165   inline const timeval &getAutoRaiseDelay(void) const
 166     { return resource.auto_raise_delay; }
 167
 168   inline const char *getTitleBarLayout(void) const
 169     { return resource.titlebar_layout; }
 170
 171   inline const unsigned long &getCacheLife(void) const
 172     { return resource.cache_life; }
 173   inline const unsigned long &getCacheMax(void) const
 174     { return resource.cache_max; }
 175
 176   inline void maskWindowEvents(Window w, OpenboxWindow *bw)
 177     { masked = w; masked_window = bw; }
 178   inline void setNoFocus(Bool f) { no_focus = f; }
 179
 180   void setFocusedWindow(OpenboxWindow *w);
 181   void shutdown(void);
 182   void load_rc(BScreen *);
 183   void saveStyleFilename(const char *);
 184   void saveMenuFilename(const char *);
 185   void saveMenuSearch(Window, Basemenu *);
 186   void saveWindowSearch(Window, OpenboxWindow *);
 187   void saveToolbarSearch(Window, Toolbar *);
 188   void saveGroupSearch(Window, OpenboxWindow *);
 189   void removeMenuSearch(Window);
 190   void removeWindowSearch(Window);
 191   void removeToolbarSearch(Window);
 192   void removeGroupSearch(Window);
 193   void restart(const char * = 0);
 194   void reconfigure(void);
 195   void rereadMenu(void);
 196   void checkMenu(void);
 197
 198   virtual Bool handleSignal(int);
 199
 200   virtual void timeout(void);
 201
 202 #ifdef    SLIT
 203   Slit *searchSlit(Window);
 204
 205   void saveSlitSearch(Window, Slit *);
 206   void removeSlitSearch(Window);
 207 #endif // SLIT
 208
 209 #ifndef   HAVE_STRFTIME
 210
 211   enum { B_AmericanDate = 1, B_EuropeanDate };
 212 #endif // HAVE_STRFTIME
 213 };
 214
 215
 216 #endif // __openbox_hh