src/openbox.hh

   1 // -*- mode: C++; indent-tabs-mode: nil; -*-
   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 /*
  10   cuz girls look soooo goood.. on the end of my DICK
  11 */
  12
  13 extern "C" {
  14 #include <X11/Xlib.h>
  15 }
  16
  17 #include <string>
  18 #include <vector>
  19
  20 #include "python.hh"
  21 #include "otk/screeninfo.hh"
  22 #include "otk/timerqueuemanager.hh"
  23 #include "otk/property.hh"
  24 #include "otk/configuration.hh"
  25 #include "otk/eventdispatcher.hh"
  26 #include "otk/eventhandler.hh"
  27
  28 namespace ob {
  29
  30 class OBScreen;
  31 class OBClient;
  32 class OBActions;
  33
  34 //! The main class for the Openbox window manager
  35 /*!
  36   Only a single instance of the Openbox class may be used in the application. A
  37   pointer to this instance is held in the Openbox::instance static member
  38   variable.
  39   Instantiation of this class begins the window manager. After instantiation,
  40   the Openbox::eventLoop function should be called. The eventLoop method does
  41   not exit until the window manager is ready to be destroyed. Destruction of
  42   the Openbox class instance will shutdown the window manager.
  43 */
  44 class Openbox : public otk::OtkEventDispatcher, public otk::OtkEventHandler
  45 {
  46 public:
  47   //! The single instance of the Openbox class for the application
  48   /*!
  49     Since this variable is globally available in the application, the Openbox
  50     class does not need to be passed around to any of the other classes.
  51   */
  52   static Openbox *instance;
  53
  54   //! The posible running states of the window manager
  55   enum RunState {
  56     State_Starting, //!< The window manager is starting up (being created)
  57     State_Normal,   //!< The window manager is running in its normal state
  58     State_Exiting   //!< The window manager is exiting (being destroyed)
  59   };
  60
  61   //! Mouse cursors used throughout Openbox
  62   struct Cursors {
  63     Cursor session;  //!< The default mouse cursor
  64     Cursor move;     //!< For moving a window
  65     Cursor ll_angle; //!< For resizing the bottom left corner of a window
  66     Cursor lr_angle; //!< For resizing the bottom right corner of a window
  67     Cursor ul_angle; //!< For resizing the top left corner of a window
  68     Cursor ur_angle; //!< For resizing the right corner of a window
  69   };
  70
  71   //! A list of OBScreen classes
  72   typedef std::vector<OBScreen *> ScreenList;
  73
  74 private:
  75   // stuff that can be passed on the command line
  76   //! Path to the config file to use/in use
  77   /*!
  78     Defaults to $(HOME)/.openbox/rc3
  79   */
  80   std::string _rcfilepath;
  81   //! Path to the menu file to use/in use
  82   /*!
  83     Defaults to $(HOME)/.openbox/menu3
  84   */
  85   std::string _menufilepath;
  86   //! The display requested by the user, or null to use the DISPLAY env var
  87   char *_displayreq;
  88   //! The value of argv[0], i.e. how this application was executed
  89   char *_argv0;
  90
  91   //! A list of all managed clients
  92   PyDictObject *_clients;
  93
  94   //! A list of all the managed screens
  95   ScreenList _screens;
  96
  97   //! Manages all timers for the application
  98   /*!
  99     Use of the otk::OBTimerQueueManager::fire funtion in this object ensures
 100     that all timers fire when their times elapse.
 101   */
 102   otk::OBTimerQueueManager _timermanager;
 103
 104   //! Cached atoms on the display
 105   /*!
 106     This is a pointer because the OBProperty class uses otk::OBDisplay::display
 107     in its constructor, so, it needs to be initialized <b>after</b> the display
 108     is initialized in this class' constructor.
 109   */
 110   otk::OBProperty *_property;
 111
 112   //! The action interface through which all user-available actions occur
 113   OBActions *_actions;
 114
 115   //! The running state of the window manager
 116   RunState _state;
 117
 118   //! Mouse cursors used throughout Openbox
 119   Cursors _cursors;
 120
 121   //! When set to true, the Openbox::eventLoop function will stop and return
 122   bool _doshutdown;
 123
 124   //! The configuration of the application. TEMPORARY
 125   otk::Configuration _config;
 126
 127   //! Parses the command line used when executing this application
 128   void parseCommandLine(int argv, char **argv);
 129   //! Displays the version string to stdout
 130   void showVersion();
 131   //! Displays usage information and help to stdout
 132   void showHelp();
 133
 134   //! Handles signal events for the application
 135   static void signalHandler(int signal);
 136
 137 public:
 138   //! Openbox constructor.
 139   /*!
 140     \param argc Number of command line arguments, as received in main()
 141     \param argv The command line arguments, as received in main()
 142   */
 143   Openbox(int argc, char **argv);
 144   //! Openbox destructor.
 145   virtual ~Openbox();
 146
 147   //! Returns the state of the window manager (starting, exiting, etc)
 148   inline RunState state() const { return _state; }
 149
 150   //! Returns the otk::OBTimerQueueManager for the application
 151   /*!
 152     All otk::OBTimer objects used in the application should be made to use this
 153     otk::OBTimerQueueManager.
 154   */
 155   inline otk::OBTimerQueueManager *timerManager() { return &_timermanager; }
 156
 157   //! Returns the otk::OBProperty instance for the window manager
 158   inline const otk::OBProperty *property() const { return _property; }
 159
 160   //! Returns a managed screen
 161   inline OBScreen *screen(int num) {
 162     assert(num >= 0); assert(num < (signed)_screens.size());
 163     return _screens[num];
 164   }
 165
 166   //! Returns the mouse cursors used throughout Openbox
 167   inline const Cursors &cursors() const { return _cursors; }
 168
 169   inline PyDictObject *clients() const { return _clients; }
 170
 171   //! The main function of the Openbox class
 172   /*!
 173     This function should be called after instantiating the Openbox class.
 174     It loops indefinately while handling all events for the application.
 175     The Openbox::shutdown method will cause this function to exit.
 176   */
 177   void eventLoop();
 178
 179   //! Adds an OBClient to the client list for lookups
 180   void addClient(Window window, OBClient *client);
 181
 182   //! Removes an OBClient from the client list for lookups
 183   void removeClient(Window window);
 184
 185   //! Finds an OBClient based on its window id
 186   OBClient *findClient(Window window);
 187
 188   //! Requests that the window manager exit
 189   /*!
 190     Causes the Openbox::eventLoop function to stop looping, so that the window
 191     manager can be destroyed.
 192   */
 193   inline void shutdown() { _doshutdown = true; }
 194 };
 195
 196 }
 197
 198 #endif // __openbox_hh