X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=src%2Fopenbox.hh;h=8145531fc4e64abb36105f8b78985947fab5b1c1;hb=7c32ac2b3f0bfd02a1efea1d67e5ad1c3c5be93f;hp=bb05fae81f8f4b544a14a076d4bbd3ec8e1f68e9;hpb=d363f720a6b0d1c361bc2022d0e5fcd5a75fd04d;p=chaz%2Fopenbox diff --git a/src/openbox.hh b/src/openbox.hh index bb05fae8..8145531f 100644 --- a/src/openbox.hh +++ b/src/openbox.hh @@ -1,4 +1,4 @@ -// -*- mode: C++; indent-tabs-mode: nil; -*- +// -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*- #ifndef __openbox_hh #define __openbox_hh @@ -14,15 +14,38 @@ extern "C" { #include #include +#include "otk/display.hh" #include "otk/screeninfo.hh" -#include "otk/timerqueuemanager.hh" -#include "otk/property.hh" -#include "xeventhandler.hh" -#include "client.hh" +#include "otk/eventdispatcher.hh" +#include "otk/eventhandler.hh" namespace ob { -//! The main class for the Openbox window manager. +class Screen; +class Client; +class Actions; +class Bindings; + +//! Mouse cursors used throughout Openbox +struct Cursors { + Cursor session; //!< The default mouse cursor + Cursor move; //!< For moving a window + Cursor ll_angle; //!< For resizing the bottom left corner of a window + Cursor lr_angle; //!< For resizing the bottom right corner of a window + Cursor ul_angle; //!< For resizing the top left corner of a window + Cursor ur_angle; //!< For resizing the right corner of a window +}; + +class Openbox; + +//! The single instance of the Openbox class for the application +/*! + Since this variable is globally available in the application, the Openbox + class does not need to be passed around to any of the other classes. +*/ +extern Openbox *openbox; + +//! The main class for the Openbox window manager /*! Only a single instance of the Openbox class may be used in the application. A pointer to this instance is held in the Openbox::instance static member @@ -32,16 +55,9 @@ namespace ob { not exit until the window manager is ready to be destroyed. Destruction of the Openbox class instance will shutdown the window manager. */ -class Openbox +class Openbox : public otk::EventDispatcher, public otk::EventHandler { public: - //! The single instance of the Openbox class for the application. - /*! - Since this variable is globally available in the application, the Openbox - class does not need to be passed around to any of the other classes. - */ - static Openbox *instance; - //! The posible running states of the window manager enum RunState { State_Starting, //!< The window manager is starting up (being created) @@ -50,9 +66,15 @@ public: }; //! A map for looking up a specific client class from the window id - typedef std::map ClientMap; + typedef std::map ClientMap; + + //! A list of Screen classes + typedef std::vector ScreenList; private: + //! The display on which Openbox is running + otk::Display _display; + // stuff that can be passed on the command line //! Path to the config file to use/in use /*! @@ -64,38 +86,62 @@ private: Defaults to $(HOME)/.openbox/menu3 */ std::string _menufilepath; + //! Path to the script file to execute on startup + /*! + Defaults to $(HOME)/.openbox/user.py + */ + std::string _scriptfilepath; //! The display requested by the user, or null to use the DISPLAY env var char *_displayreq; - //! The value of argv[0], i.e. how this application was executed - char *_argv0; + //! The value of argv, i.e. how this application was executed + char **_argv; + //! Run the application in synchronous mode? (for debugging) + bool _sync; + //! Should Openbox run on a single screen or on all available screens? + bool _single; //! A list of all managed clients ClientMap _clients; - //! Manages all timers for the application - /*! - Use of the otk::OBTimerQueueManager::fire funtion in this object ensures - that all timers fire when their times elapse. - */ - otk::OBTimerQueueManager _timermanager; - - //! The class which will handle raw XEvents - OBXEventHandler _xeventhandler; + //! A list of all the managed screens + ScreenList _screens; + + //! The action interface through which all user-available actions occur + Actions *_actions; - //! Cached atoms on the display - /*! - This is a pointer because the OBProperty class uses otk::OBDisplay::display - in its constructor, so, it needs to be initialized after the display - is initialized in this class' constructor. - */ - otk::OBProperty *_property; + //! The interface through which keys/buttons are grabbed and handled + Bindings *_bindings; //! The running state of the window manager RunState _state; + //! Mouse cursors used throughout Openbox + Cursors _cursors; + //! When set to true, the Openbox::eventLoop function will stop and return - bool _doshutdown; + bool _shutdown; + + //! When set to true, and Openbox is about to exit, it will spawn a new + //! process + bool _restart; + + //! If this contains anything, a restart will try to execute the program in + //! this variable, and will fallback to reexec'ing itself if that fails + std::string _restart_prog; + + //! The client with input focus + /*! + Updated by the clients themselves. + */ + Client *_focused_client; + //! The screen with input focus + /*! + Updated by the clients when they update the Openbox::focused_client + property. + */ + Screen *_focused_screen; + //! Parses the command line used when executing this application void parseCommandLine(int argv, char **argv); //! Displays the version string to stdout @@ -107,6 +153,7 @@ private: static void signalHandler(int signal); public: +#ifndef SWIG //! Openbox constructor. /*! \param argc Number of command line arguments, as received in main() @@ -115,19 +162,32 @@ public: Openbox(int argc, char **argv); //! Openbox destructor. virtual ~Openbox(); +#endif //! Returns the state of the window manager (starting, exiting, etc) inline RunState state() const { return _state; } - //! Returns the otk::OBTimerQueueManager for the application + //! Returns the Actions instance for the window manager + inline Actions *actions() const { return _actions; } + + //! Returns the Bindings instance for the window manager + inline Bindings *bindings() const { return _bindings; } + + //! Returns a managed screen or a null pointer /*! - All otk::OBTimer objects used in the application should be made to use this - otk::OBTimerQueueManager. + ALWAYS check the return value for a non-null, as any unmanaged screens + will return one. This includes screen(0) if the first managed screen is 1. */ - inline otk::OBTimerQueueManager *timerManager() { return &_timermanager; } + inline Screen *screen(int num) { + assert(num >= 0); assert(num < (signed)ScreenCount(**otk::display)); + if (num >= (signed)_screens.size()) return 0; + return _screens[num]; + } - inline const otk::OBProperty *property() const { return _property; } + //! Returns the mouse cursors used throughout Openbox + inline const Cursors &cursors() const { return _cursors; } +#ifndef SWIG //! The main function of the Openbox class /*! This function should be called after instantiating the Openbox class. @@ -135,22 +195,46 @@ public: The Openbox::shutdown method will cause this function to exit. */ void eventLoop(); +#endif - //! Adds an OBClient to the client list for lookups - void addClient(Window window, OBClient *client); + //! Adds an Client to the client list for lookups + void addClient(Window window, Client *client); - //! Removes an OBClient from the client list for lookups + //! Removes an Client from the client list for lookups void removeClient(Window window); - //! Finds an OBClient based on its window id - OBClient *findClient(Window window); + //! Finds an Client based on its window id + Client *findClient(Window window); + + //! The client with input focus + inline Client *focusedClient() { return _focused_client; } + + //! Change the client which has focus. + /*! + This is called by the clients themselves when their focus state changes. + */ + void setFocusedClient(Client *c); + //! The screen with input focus + inline Screen *focusedScreen() { return _focused_screen; } + //! Requests that the window manager exit /*! Causes the Openbox::eventLoop function to stop looping, so that the window manager can be destroyed. */ - inline void shutdown() { _doshutdown = true; } + inline void shutdown() { _shutdown = true; } + + inline void restart(const std::string &bin = "") { + _shutdown = true; _restart = true; _restart_prog = bin; + } + + //! True if Openbox should be restarted instead of exiting + inline bool doRestart() const { return _restart; } + + //! The command line requested to be executed in place of restarting + //! Openbox the way it was run previously. + inline const std::string &restartProgram() const { return _restart_prog; } }; }