openbox/src/openbox.hh

// -*- mode: C++; indent-tabs-mode: nil; -*-
#ifndef   __openbox_hh
#define   __openbox_hh

extern "C" {
#include <X11/Xlib.h>
}

#include <string>
#include <vector>

#include "otk/screeninfo.hh"
#include "otk/timerqueuemanager.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:
  //! 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 {
    //! The window manager is starting up (being created)
    State_Starting,
    //! The window manager is running in its normal state
    State_Normal,
    //! The window manager is exiting (being destroyed)
    State_Exiting
  };
  
private:
  // stuff that can be passed on the command line
  //! 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;

  //! 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 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();

  //! Handles signal events for the application
  static void signalHandler(int signal);

public:
  //! Openbox constructor.
  /*!
    \param argc Number of command line arguments, as received in main()
    \param argv The command line arguments, as received in main()
  */
  Openbox(int argc, char **argv);
  //! Openbox destructor.
  virtual ~Openbox();

  //! 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; }

  //! The main function of the Openbox class
  /*!
    This function should be called after instantiating the Openbox class.
    Loops indefinately while handling all events in the application.
    The Openbox::shutdown method will cause this function to exit.
  */
  void eventLoop();

  // XXX: TEMPORARY!#!@%*!^#*!#!#!
  virtual void process_event(XEvent *) = 0;

  //! 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; }
};

}

#endif // __openbox_hh