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