src/openbox.hh

   1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
   2 #ifndef   __openbox_hh
   3 #define   __openbox_hh
   4
   5 /*! @file openbox.hh
   6   @brief The main class for the Openbox window manager
   7 */
   8
   9 extern "C" {
  10 #include <X11/Xlib.h>
  11 }
  12
  13 #include <string>
  14 #include <vector>
  15 #include <map>
  16
  17 #include "otk/screeninfo.hh"
  18 #include "otk/timerqueuemanager.hh"
  19 #include "otk/property.hh"
  20 #include "otk/configuration.hh"
  21 #include "otk/eventdispatcher.hh"
  22 #include "otk/eventhandler.hh"
  23
  24 namespace ob {
  25
  26 class OBScreen;
  27 class OBClient;
  28 class OBActions;
  29 class OBBindings;
  30
  31 //! Mouse cursors used throughout Openbox
  32 struct Cursors {
  33   Cursor session;  //!< The default mouse cursor
  34   Cursor move;     //!< For moving a window
  35   Cursor ll_angle; //!< For resizing the bottom left corner of a window
  36   Cursor lr_angle; //!< For resizing the bottom right corner of a window
  37   Cursor ul_angle; //!< For resizing the top left corner of a window
  38   Cursor ur_angle; //!< For resizing the right corner of a window
  39 };
  40
  41
  42 //! The main class for the Openbox window manager
  43 /*!
  44   Only a single instance of the Openbox class may be used in the application. A
  45   pointer to this instance is held in the Openbox::instance static member
  46   variable.
  47   Instantiation of this class begins the window manager. After instantiation,
  48   the Openbox::eventLoop function should be called. The eventLoop method does
  49   not exit until the window manager is ready to be destroyed. Destruction of
  50   the Openbox class instance will shutdown the window manager.
  51 */
  52 class Openbox : public otk::OtkEventDispatcher, public otk::OtkEventHandler
  53 {
  54 public:
  55   //! The single instance of the Openbox class for the application
  56   /*!
  57     Since this variable is globally available in the application, the Openbox
  58     class does not need to be passed around to any of the other classes.
  59   */
  60   static Openbox *instance;
  61
  62   //! The posible running states of the window manager
  63   enum RunState {
  64     State_Starting, //!< The window manager is starting up (being created)
  65     State_Normal,   //!< The window manager is running in its normal state
  66     State_Exiting   //!< The window manager is exiting (being destroyed)
  67   };
  68
  69   //! A map for looking up a specific client class from the window id
  70   typedef std::map<Window, OBClient *> ClientMap;
  71
  72   //! A list of OBScreen classes
  73   typedef std::vector<OBScreen *> ScreenList;
  74
  75 private:
  76   // stuff that can be passed on the command line
  77   //! Path to the config file to use/in use
  78   /*!
  79     Defaults to $(HOME)/.openbox/rc3
  80   */
  81   std::string _rcfilepath;
  82   //! Path to the menu file to use/in use
  83   /*!
  84     Defaults to $(HOME)/.openbox/menu3
  85   */
  86   std::string _menufilepath;
  87   //! Path to the script file to execute on startup
  88   /*!
  89     Defaults to $(HOME)/.openbox/user.py
  90   */
  91   std::string _scriptfilepath;
  92   //! The display requested by the user, or null to use the DISPLAY env var
  93   char *_displayreq;
  94   //! The value of argv, i.e. how this application was executed
  95   char **_argv;
  96   //! Run the application in synchronous mode? (for debugging)
  97   bool _sync;
  98   //! Should Openbox run on a single screen or on all available screens?
  99   bool _single;
 100
 101   //! A list of all managed clients
 102   ClientMap _clients;
 103
 104   //! A list of all the managed screens
 105   ScreenList _screens;
 106
 107   //! Manages all timers for the application
 108   /*!
 109     Use of the otk::OBTimerQueueManager::fire funtion in this object ensures
 110     that all timers fire when their times elapse.
 111   */
 112   otk::OBTimerQueueManager _timermanager;
 113
 114   //! Cached atoms on the display
 115   /*!
 116     This is a pointer because the OBProperty class uses otk::OBDisplay::display
 117     in its constructor, so, it needs to be initialized <b>after</b> the display
 118     is initialized in this class' constructor.
 119   */
 120   otk::OBProperty *_property;
 121
 122   //! The action interface through which all user-available actions occur
 123   OBActions *_actions;
 124
 125   //! The interface through which keys/buttons are grabbed and handled
 126   OBBindings *_bindings;
 127
 128   //! The running state of the window manager
 129   RunState _state;
 130
 131   //! Mouse cursors used throughout Openbox
 132   Cursors _cursors;
 133
 134   //! When set to true, the Openbox::eventLoop function will stop and return
 135   bool _shutdown;
 136
 137   //! When set to true, and Openbox is about to exit, it will spawn a new
 138   //! process
 139   bool _restart;
 140
 141   //! If this contains anything, a restart will try to execute the program in
 142   //! this variable, and will fallback to reexec'ing itself if that fails
 143   std::string _restart_prog;
 144
 145   //! The client with input focus
 146   /*!
 147     Updated by the clients themselves.
 148   */
 149   OBClient *_focused_client;
 150
 151   //! The screen with input focus
 152   /*!
 153     Updated by the clients when they update the Openbox::focused_client
 154     property.
 155   */
 156   OBScreen *_focused_screen;
 157
 158   //! Parses the command line used when executing this application
 159   void parseCommandLine(int argv, char **argv);
 160   //! Displays the version string to stdout
 161   void showVersion();
 162   //! Displays usage information and help to stdout
 163   void showHelp();
 164
 165   //! Handles signal events for the application
 166   static void signalHandler(int signal);
 167
 168 public:
 169 #ifndef SWIG
 170   //! Openbox constructor.
 171   /*!
 172     \param argc Number of command line arguments, as received in main()
 173     \param argv The command line arguments, as received in main()
 174   */
 175   Openbox(int argc, char **argv);
 176   //! Openbox destructor.
 177   virtual ~Openbox();
 178 #endif
 179
 180   //! Returns the state of the window manager (starting, exiting, etc)
 181   inline RunState state() const { return _state; }
 182
 183   //! Returns the otk::OBTimerQueueManager for the application
 184   /*!
 185     All otk::OBTimer objects used in the application should be made to use this
 186     otk::OBTimerQueueManager.
 187   */
 188   inline otk::OBTimerQueueManager *timerManager() { return &_timermanager; }
 189
 190   //! Returns the otk::OBProperty instance for the window manager
 191   inline const otk::OBProperty *property() const { return _property; }
 192
 193   //! Returns the OBActions instance for the window manager
 194   inline OBActions *actions() const { return _actions; }
 195
 196   //! Returns the OBBindings instance for the window manager
 197   inline OBBindings *bindings() const { return _bindings; }
 198
 199   //! Returns a managed screen
 200   inline OBScreen *screen(int num) {
 201     assert(num >= 0); assert(num < (signed)_screens.size());
 202     if (num >= screenCount())
 203       return NULL;
 204     return _screens[num];
 205   }
 206
 207   //! Returns the number of managed screens
 208   inline int screenCount() const {
 209     return (signed)_screens.size();
 210   }
 211
 212   //! Returns the mouse cursors used throughout Openbox
 213   inline const Cursors &cursors() const { return _cursors; }
 214
 215 #ifndef SWIG
 216   //! The main function of the Openbox class
 217   /*!
 218     This function should be called after instantiating the Openbox class.
 219     It loops indefinately while handling all events for the application.
 220     The Openbox::shutdown method will cause this function to exit.
 221   */
 222   void eventLoop();
 223 #endif
 224
 225   //! Adds an OBClient to the client list for lookups
 226   void addClient(Window window, OBClient *client);
 227
 228   //! Removes an OBClient from the client list for lookups
 229   void removeClient(Window window);
 230
 231   //! Finds an OBClient based on its window id
 232   OBClient *findClient(Window window);
 233
 234   //! The client with input focus
 235   inline OBClient *focusedClient() { return _focused_client; }
 236
 237   //! Change the client which has focus.
 238   /*!
 239     This is called by the clients themselves when their focus state changes.
 240   */
 241   void setFocusedClient(OBClient *c);
 242
 243   //! The screen with input focus
 244   inline OBScreen *focusedScreen() { return _focused_screen; }
 245
 246   //! Requests that the window manager exit
 247   /*!
 248     Causes the Openbox::eventLoop function to stop looping, so that the window
 249     manager can be destroyed.
 250   */
 251   inline void shutdown() { _shutdown = true; }
 252
 253   inline void restart(const std::string &bin = "") {
 254     _shutdown = true; _restart = true; _restart_prog = bin;
 255   }
 256
 257   //! Executes a command on a screen
 258   void execute(int screen, const std::string &bin);
 259 };
 260
 261 }
 262
 263 #endif // __openbox_hh