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[0], i.e. how this application was executed
  95   char *_argv0;
  96
  97   //! A list of all managed clients
  98   ClientMap _clients;
  99
 100   //! A list of all the managed screens
 101   ScreenList _screens;
 102
 103   //! Manages all timers for the application
 104   /*!
 105     Use of the otk::OBTimerQueueManager::fire funtion in this object ensures
 106     that all timers fire when their times elapse.
 107   */
 108   otk::OBTimerQueueManager _timermanager;
 109
 110   //! Cached atoms on the display
 111   /*!
 112     This is a pointer because the OBProperty class uses otk::OBDisplay::display
 113     in its constructor, so, it needs to be initialized <b>after</b> the display
 114     is initialized in this class' constructor.
 115   */
 116   otk::OBProperty *_property;
 117
 118   //! The action interface through which all user-available actions occur
 119   OBActions *_actions;
 120
 121   //! The interface through which keys/buttons are grabbed and handled
 122   OBBindings *_bindings;
 123
 124   //! Run the application in synchronous mode? (for debugging)
 125   bool _sync;
 126
 127   //! The running state of the window manager
 128   RunState _state;
 129
 130   //! Mouse cursors used throughout Openbox
 131   Cursors _cursors;
 132
 133   //! When set to true, the Openbox::eventLoop function will stop and return
 134   bool _doshutdown;
 135
 136   //! The client with input focus
 137   /*!
 138     Updated by the clients themselves.
 139   */
 140   OBClient *_focused_client;
 141
 142   //! The screen with input focus
 143   /*!
 144     Updated by the clients when they update the Openbox::focused_client
 145     property.
 146   */
 147   OBScreen *_focused_screen;
 148
 149   //! Parses the command line used when executing this application
 150   void parseCommandLine(int argv, char **argv);
 151   //! Displays the version string to stdout
 152   void showVersion();
 153   //! Displays usage information and help to stdout
 154   void showHelp();
 155
 156   //! Handles signal events for the application
 157   static void signalHandler(int signal);
 158
 159 public:
 160 #ifndef SWIG
 161   //! Openbox constructor.
 162   /*!
 163     \param argc Number of command line arguments, as received in main()
 164     \param argv The command line arguments, as received in main()
 165   */
 166   Openbox(int argc, char **argv);
 167   //! Openbox destructor.
 168   virtual ~Openbox();
 169 #endif
 170
 171   //! Returns the state of the window manager (starting, exiting, etc)
 172   inline RunState state() const { return _state; }
 173
 174   //! Returns the otk::OBTimerQueueManager for the application
 175   /*!
 176     All otk::OBTimer objects used in the application should be made to use this
 177     otk::OBTimerQueueManager.
 178   */
 179   inline otk::OBTimerQueueManager *timerManager() { return &_timermanager; }
 180
 181   //! Returns the otk::OBProperty instance for the window manager
 182   inline const otk::OBProperty *property() const { return _property; }
 183
 184   //! Returns the OBActions instance for the window manager
 185   inline OBActions *actions() const { return _actions; }
 186
 187   //! Returns the OBBindings instance for the window manager
 188   inline OBBindings *bindings() const { return _bindings; }
 189
 190   //! Returns a managed screen
 191   inline OBScreen *screen(int num) {
 192     assert(num >= 0); assert(num < (signed)_screens.size());
 193     if (num >= screenCount())
 194       return NULL;
 195     return _screens[num];
 196   }
 197
 198   //! Returns the number of managed screens
 199   inline int screenCount() const {
 200     return (signed)_screens.size();
 201   }
 202
 203   //! Returns the mouse cursors used throughout Openbox
 204   inline const Cursors &cursors() const { return _cursors; }
 205
 206 #ifndef SWIG
 207   //! The main function of the Openbox class
 208   /*!
 209     This function should be called after instantiating the Openbox class.
 210     It loops indefinately while handling all events for the application.
 211     The Openbox::shutdown method will cause this function to exit.
 212   */
 213   void eventLoop();
 214 #endif
 215
 216   //! Adds an OBClient to the client list for lookups
 217   void addClient(Window window, OBClient *client);
 218
 219   //! Removes an OBClient from the client list for lookups
 220   void removeClient(Window window);
 221
 222   //! Finds an OBClient based on its window id
 223   OBClient *findClient(Window window);
 224
 225   //! The client with input focus
 226   inline OBClient *focusedClient() { return _focused_client; }
 227
 228   //! Change the client which has focus.
 229   /*!
 230     This is called by the clients themselves when their focus state changes.
 231   */
 232   void setFocusedClient(OBClient *c);
 233
 234   //! The screen with input focus
 235   inline OBScreen *focusedScreen() { return _focused_screen; }
 236
 237   //! Requests that the window manager exit
 238   /*!
 239     Causes the Openbox::eventLoop function to stop looping, so that the window
 240     manager can be destroyed.
 241   */
 242   inline void shutdown() { _doshutdown = true; }
 243 };
 244
 245 }
 246
 247 #endif // __openbox_hh