X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=src%2Fopenbox.hh;h=bb05fae81f8f4b544a14a076d4bbd3ec8e1f68e9;hb=b0149ef3fd8eeafc6a7fc008468d36c3b86b9008;hp=76a7d973786d8d9095859eb5d29385dfaa27e39c;hpb=9259ec5732851dd66f7c598d629e3808ac7ab3d8;p=chaz%2Fopenbox diff --git a/src/openbox.hh b/src/openbox.hh index 76a7d973..bb05fae8 100644 --- a/src/openbox.hh +++ b/src/openbox.hh @@ -2,51 +2,108 @@ #ifndef __openbox_hh #define __openbox_hh +/*! @file openbox.hh + @brief The main class for the Openbox window manager +*/ + extern "C" { #include } #include #include +#include #include "otk/screeninfo.hh" -#include "otk/timer.hh" +#include "otk/timerqueuemanager.hh" +#include "otk/property.hh" +#include "xeventhandler.hh" +#include "client.hh" namespace ob { +//! 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 + variable. + Instantiation of this class begins the window manager. After instantiation, + the Openbox::eventLoop function should be called. The eventLoop method does + not exit until the window manager is ready to be destroyed. Destruction of + the Openbox class instance will shutdown the window manager. +*/ class Openbox { public: - static Openbox *instance; // there can only be ONE instance of this class in - // the program, and it is held in here - - typedef std::vector ScreenInfoList; + //! 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, - State_Normal, - State_Exiting + State_Starting, //!< The window manager is starting up (being created) + State_Normal, //!< The window manager is running in its normal state + State_Exiting //!< The window manager is exiting (being destroyed) }; + + //! A map for looking up a specific client class from the window id + typedef std::map ClientMap; private: // stuff that can be passed on the command line - std::string _rcfilepath; // path to the config file to use/in use - std::string _menufilepath; // path to the menu file to use/in use - char *_displayreq; // display requested by the user - char *_argv0; // argv[0], how the program was called + //! Path to the config file to use/in use + /*! + Defaults to $(HOME)/.openbox/rc3 + */ + std::string _rcfilepath; + //! Path to the menu file to use/in use + /*! + Defaults to $(HOME)/.openbox/menu3 + */ + std::string _menufilepath; + //! 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; - otk::OBTimerQueueManager _timermanager; // manages timers, so that they fire - // when their time elapses + //! A list of all managed clients + ClientMap _clients; - RunState _state; // the state of the window manager + //! 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; - ScreenInfoList _screenInfoList; // info for all screens on the display + //! The class which will handle raw XEvents + OBXEventHandler _xeventhandler; + //! 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 running state of the window manager + RunState _state; + + //! When set to true, the Openbox::eventLoop function will stop and return + bool _doshutdown; + + //! Parses the command line used when executing this application void parseCommandLine(int argv, char **argv); + //! Displays the version string to stdout void showVersion(); + //! Displays usage information and help to stdout void showHelp(); - static int xerrorHandler(Display *d, XErrorEvent *e); + //! Handles signal events for the application static void signalHandler(int signal); public: @@ -59,18 +116,41 @@ public: //! Openbox destructor. virtual ~Openbox(); - //! Returns the state of the window manager (starting, exiting, etc). + //! Returns the state of the window manager (starting, exiting, etc) inline RunState state() const { return _state; } + //! Returns the otk::OBTimerQueueManager for the application + /*! + All otk::OBTimer objects used in the application should be made to use this + otk::OBTimerQueueManager. + */ inline otk::OBTimerQueueManager *timerManager() { return &_timermanager; } + inline const otk::OBProperty *property() const { return _property; } + + //! The main function of the Openbox class + /*! + This function should be called after instantiating the Openbox class. + It loops indefinately while handling all events for the application. + The Openbox::shutdown method will cause this function to exit. + */ void eventLoop(); - // XXX: TEMPORARY!#!@%*!^#*!#!#! - virtual void process_event(XEvent *) = 0; + //! Adds an OBClient to the client list for lookups + void addClient(Window window, OBClient *client); + + //! Removes an OBClient from the client list for lookups + void removeClient(Window window); - //! Requests that the window manager exit. - inline void shutdown() { _state = State_Exiting; } + //! Finds an OBClient based on its window id + OBClient *findClient(Window window); + + //! 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; } }; }