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/display.hh"
  18 #include "otk/screeninfo.hh"
  19 #include "otk/eventdispatcher.hh"
  20 #include "otk/eventhandler.hh"
  21
  22 namespace ob {
  23
  24 class Screen;
  25 class Client;
  26 class Actions;
  27 class Bindings;
  28
  29 //! Mouse cursors used throughout Openbox
  30 struct Cursors {
  31   Cursor session;  //!< The default mouse cursor
  32   Cursor move;     //!< For moving a window
  33   Cursor ll_angle; //!< For resizing the bottom left corner of a window
  34   Cursor lr_angle; //!< For resizing the bottom right corner of a window
  35   Cursor ul_angle; //!< For resizing the top left corner of a window
  36   Cursor ur_angle; //!< For resizing the right corner of a window
  37 };
  38
  39 class Openbox;
  40
  41 //! The single instance of the Openbox class for the application
  42 /*!
  43   Since this variable is globally available in the application, the Openbox
  44   class does not need to be passed around to any of the other classes.
  45 */
  46 extern Openbox *openbox;
  47
  48 //! The main class for the Openbox window manager
  49 /*!
  50   Only a single instance of the Openbox class may be used in the application. A
  51   pointer to this instance is held in the Openbox::instance static member
  52   variable.
  53   Instantiation of this class begins the window manager. After instantiation,
  54   the Openbox::eventLoop function should be called. The eventLoop method does
  55   not exit until the window manager is ready to be destroyed. Destruction of
  56   the Openbox class instance will shutdown the window manager.
  57 */
  58 class Openbox : public otk::EventDispatcher, public otk::EventHandler
  59 {
  60 public:
  61   //! The posible running states of the window manager
  62   enum RunState {
  63     State_Starting, //!< The window manager is starting up (being created)
  64     State_Normal,   //!< The window manager is running in its normal state
  65     State_Exiting   //!< The window manager is exiting (being destroyed)
  66   };
  67
  68   //! A map for looking up a specific client class from the window id
  69   typedef std::map<Window, Client *> ClientMap;
  70
  71   //! A list of Screen classes
  72   typedef std::vector<Screen *> 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   //! Path to the script file to execute on startup
  87   /*!
  88     Defaults to $(HOME)/.openbox/user.py
  89   */
  90   std::string _scriptfilepath;
  91   //! The value of argv, i.e. how this application was executed
  92   char **_argv;
  93   //! Run the application in synchronous mode? (for debugging)
  94   bool _sync;
  95   //! Should Openbox run on a single screen or on all available screens?
  96   bool _single;
  97   //! Optimize for a remote/low-bandwidth connection to the display?
  98   bool _remote;
  99
 100   //! A list of all managed clients
 101   ClientMap _clients;
 102
 103   //! A list of all the managed screens
 104   ScreenList _screens;
 105
 106   //! The action interface through which all user-available actions occur
 107   Actions *_actions;
 108
 109   //! The interface through which keys/buttons are grabbed and handled
 110   Bindings *_bindings;
 111
 112   //! The running state of the window manager
 113   RunState _state;
 114
 115   //! Mouse cursors used throughout Openbox
 116   Cursors _cursors;
 117
 118   //! When set to true, the Openbox::eventLoop function will stop and return
 119   bool _shutdown;
 120
 121   //! When set to true, and Openbox is about to exit, it will spawn a new
 122   //! process
 123   bool _restart;
 124
 125   //! If this contains anything, a restart will try to execute the program in
 126   //! this variable, and will fallback to reexec'ing itself if that fails
 127   std::string _restart_prog;
 128
 129   //! The client with input focus
 130   /*!
 131     Updated by the clients themselves.
 132   */
 133   Client *_focused_client;
 134
 135   //! The screen with input focus
 136   /*!
 137     Updated by the clients when they update the Openbox::focused_client
 138     property.
 139   */
 140   Screen *_focused_screen;
 141
 142   //! Parses the command line used when executing this application
 143   void parseCommandLine(int argv, char **argv);
 144   //! Displays the version string to stdout
 145   void showVersion();
 146   //! Displays usage information and help to stdout
 147   void showHelp();
 148
 149   //! Handles signal events for the application
 150   static void signalHandler(int signal);
 151
 152 public:
 153   //! Openbox constructor.
 154   /*!
 155     \param argc Number of command line arguments, as received in main()
 156     \param argv The command line arguments, as received in main()
 157   */
 158   Openbox(int argc, char **argv);
 159   //! Openbox destructor.
 160   virtual ~Openbox();
 161
 162   //! Returns the state of the window manager (starting, exiting, etc)
 163   inline RunState state() const { return _state; }
 164
 165   //! Returns the Actions instance for the window manager
 166   inline Actions *actions() const { return _actions; }
 167
 168   //! Returns the Bindings instance for the window manager
 169   inline Bindings *bindings() const { return _bindings; }
 170
 171   //! Returns a managed screen or a null pointer
 172   /*!
 173     ALWAYS check the return value for a non-null, as any unmanaged screens
 174     will return one. This includes screen(0) if the first managed screen is 1.
 175   */
 176   inline Screen *screen(int num) {
 177     assert(num >= 0); assert(num < (signed)ScreenCount(**otk::display));
 178     if (num >= (signed)_screens.size()) return 0;
 179     return _screens[num];
 180   }
 181
 182   //! Returns the mouse cursors used throughout Openbox
 183   inline const Cursors &cursors() const { return _cursors; }
 184
 185   //! The main function of the Openbox class
 186   /*!
 187     This function should be called after instantiating the Openbox class.
 188     It loops indefinately while handling all events for the application.
 189     The Openbox::shutdown method will cause this function to exit.
 190   */
 191   void eventLoop();
 192
 193   //! Adds an Client to the client list for lookups
 194   void addClient(Window window, Client *client);
 195
 196   //! Removes an Client from the client list for lookups
 197   void removeClient(Window window);
 198
 199   //! Finds an Client based on its window id
 200   Client *findClient(Window window);
 201
 202   //! The client with input focus
 203   inline Client *focusedClient() { return _focused_client; }
 204
 205   //! Change the client which has focus.
 206   /*!
 207     This is called by the clients themselves when their focus state changes.
 208   */
 209   void setFocusedClient(Client *c);
 210
 211   //! The screen with input focus
 212   inline Screen *focusedScreen() { return _focused_screen; }
 213
 214   //! Requests that the window manager exit
 215   /*!
 216     Causes the Openbox::eventLoop function to stop looping, so that the window
 217     manager can be destroyed.
 218   */
 219   inline void shutdown() { _shutdown = true; }
 220
 221   inline void restart(const std::string &bin = "") {
 222     _shutdown = true; _restart = true; _restart_prog = bin;
 223   }
 224
 225   //! True if Openbox should be restarted instead of exiting
 226   inline bool doRestart() const { return _restart; }
 227
 228   //! The command line requested to be executed in place of restarting
 229   //! Openbox the way it was run previously.
 230   inline const std::string &restartProgram() const { return _restart_prog; }
 231 };
 232
 233 }
 234
 235 #endif // __openbox_hh