---

ob::Openbox Class Reference

#include <openbox.hh>

Inheritance diagram for ob::Openbox:

[legend]Collaboration diagram for ob::Openbox:

[legend]List of all members.

---

Detailed Description

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.

Definition at line 58 of file openbox.hh.

Public Types
typedef std::map< Window, Client * >	ClientMap
	A map for looking up a specific client class from the window id.
typedef std::vector< Screen * >	ScreenList
	A list of Screen classes.
enum	RunState { State_Starting, State_Normal, State_Exiting }
	The posible running states of the window manager. More...
Public Methods
	Openbox (int argc, char **argv)
	Openbox constructor.
virtual	~Openbox ()
	Openbox destructor.
RunState	state () const
	Returns the state of the window manager (starting, exiting, etc).
Actions *	actions () const
	Returns the Actions instance for the window manager.
Bindings *	bindings () const
	Returns the Bindings instance for the window manager.
Screen *	screen (int num)
	Returns a managed screen or a null pointer.
const Cursors &	cursors () const
	Returns the mouse cursors used throughout Openbox.
void	eventLoop ()
	The main function of the Openbox class.
void	addClient (Window window, Client *client)
	Adds an Client to the client list for lookups.
void	removeClient (Window window)
	Removes an Client from the client list for lookups.
Client *	findClient (Window window)
	Finds an Client based on its window id.
Client *	focusedClient ()
	The client with input focus.
void	setFocusedClient (Client *c)
	Change the client which has focus.
Screen *	focusedScreen ()
	The screen with input focus.
void	shutdown ()
	Requests that the window manager exit.
void	restart (const std::string &bin="")
bool	doRestart () const
	True if Openbox should be restarted instead of exiting.
const std::string &	restartProgram () const
	The command line requested to be executed in place of restarting Openbox the way it was run previously.
Private Methods
void	parseCommandLine (int argv, char **argv)
	Parses the command line used when executing this application.
void	showVersion ()
	Displays the version string to stdout.
void	showHelp ()
	Displays usage information and help to stdout.
Static Private Methods
void	signalHandler (int signal)
	Handles signal events for the application.
Private Attributes
otk::Display	_display
	The display on which Openbox is running.
std::string	_rcfilepath
	Path to the config file to use/in use.
std::string	_menufilepath
	Path to the menu file to use/in use.
std::string	_scriptfilepath
	Path to the script file to execute on startup.
char *	_displayreq
	The display requested by the user, or null to use the DISPLAY env var.
char **	_argv
	The value of argv, i.e. how this application was executed.
bool	_sync
	Run the application in synchronous mode? (for debugging).
bool	_single
	Should Openbox run on a single screen or on all available screens?
ClientMap	_clients
	A list of all managed clients.
ScreenList	_screens
	A list of all the managed screens.
Actions *	_actions
	The action interface through which all user-available actions occur.
Bindings *	_bindings
	The interface through which keys/buttons are grabbed and handled.
RunState	_state
	The running state of the window manager.
Cursors	_cursors
	Mouse cursors used throughout Openbox.
bool	_shutdown
	When set to true, the Openbox::eventLoop function will stop and return.
bool	_restart
	When set to true, and Openbox is about to exit, it will spawn a new process.
std::string	_restart_prog
	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.
Client *	_focused_client
	The client with input focus.
Screen *	_focused_screen
	The screen with input focus.

---

Member Typedef Documentation

typedef std::map<Window, Client *> ob::Openbox::ClientMap

A map for looking up a specific client class from the window id. Definition at line 69 of file openbox.hh.

typedef std::vector<Screen *> ob::Openbox::ScreenList

A list of Screen classes. Definition at line 72 of file openbox.hh.

---

Member Enumeration Documentation

enum ob::Openbox::RunState

The posible running states of the window manager. Enumeration values: 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). Definition at line 62 of file openbox.hh. Referenced by state(). { 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) };

---

Constructor & Destructor Documentation

ob::Openbox::Openbox (  int    argc, char **    argv )

Openbox constructor. Parameters: argc  Number of command line arguments, as received in main() argv  The command line arguments, as received in main() Definition at line 81 of file openbox.cc. References _, _actions, _argv, _bindings, _cursors, _displayreq, _focused_client, _focused_screen, _rcfilepath, _restart, _screens, _scriptfilepath, _shutdown, _single, _state, _sync, otk::expandTilde(), ob::Bindings::grabKeys(), otk::Property::initialize(), otk::Timer::initialize(), otk::RenderColor::initialize(), ob::Cursors::ll_angle, ob::Cursors::lr_angle, ob::Screen::managed(), ob::Cursors::move, ob::openbox, parseCommandLine(), ob::python_exec(), ob::python_init(), screen(), ob::Cursors::session, setFocusedClient(), otk::EventDispatcher::setMasterHandler(), State_Normal, State_Starting, ob::Cursors::ul_angle, and ob::Cursors::ur_angle. : otk::EventDispatcher(), otk::EventHandler(), _display() { struct sigaction action; _state = State_Starting; // initializing everything openbox = this; _displayreq = (char*) 0; _argv = argv; _shutdown = false; _restart = false; _rcfilepath = otk::expandTilde("~/.openbox/rc3"); _scriptfilepath = otk::expandTilde("~/.openbox/user.py"); _focused_client = 0; _sync = false; _single = false; parseCommandLine(argc, argv); XSynchronize(**otk::display, _sync); // set up the signal handler action.sa_handler = Openbox::signalHandler; action.sa_mask = sigset_t(); action.sa_flags = SA_NOCLDSTOP | SA_NODEFER; sigaction(SIGUSR1, &action, (struct sigaction *) 0); sigaction(SIGPIPE, &action, (struct sigaction *) 0); sigaction(SIGSEGV, &action, (struct sigaction *) 0); sigaction(SIGFPE, &action, (struct sigaction *) 0); sigaction(SIGTERM, &action, (struct sigaction *) 0); sigaction(SIGINT, &action, (struct sigaction *) 0); sigaction(SIGHUP, &action, (struct sigaction *) 0); sigaction(SIGCHLD, &action, (struct sigaction *) 0); // anything that died while we were restarting won't give us a SIGCHLD while (waitpid(-1, NULL, WNOHANG) > 0); otk::RenderColor::initialize(); otk::Timer::initialize(); otk::Property::initialize(); _actions = new Actions(); _bindings = new Bindings(); setMasterHandler(_actions); // set as the master event handler // create the mouse cursors we'll use _cursors.session = XCreateFontCursor(**otk::display, XC_left_ptr); _cursors.move = XCreateFontCursor(**otk::display, XC_fleur); _cursors.ll_angle = XCreateFontCursor(**otk::display, XC_ll_angle); _cursors.lr_angle = XCreateFontCursor(**otk::display, XC_lr_angle); _cursors.ul_angle = XCreateFontCursor(**otk::display, XC_ul_angle); _cursors.ur_angle = XCreateFontCursor(**otk::display, XC_ur_angle); // initialize scripting python_init(argv[0]); // load config values //python_exec(SCRIPTDIR"/config.py"); // load openbox config values // run all of the python scripts //python_exec(SCRIPTDIR"/builtins.py"); // builtin callbacks //python_exec(SCRIPTDIR"/focus.py"); // focus helpers // run the user's script or the system defaults if that fails if (!python_exec(_scriptfilepath.c_str())) python_exec(SCRIPTDIR"/defaults.py"); // system default bahaviors // initialize all the screens _focused_screen = 0; for (int i = 0, max = ScreenCount(**otk::display); i < max; ++i) { Screen *screen; // in single mode skip the screens we don't want to manage if (_single && i != DefaultScreen(**otk::display)) { _screens.push_back(0); continue; } // try manage the screen screen = new Screen(i); if (screen->managed()) { _screens.push_back(screen); if (!_focused_screen) // set this to the first screen managed _focused_screen = screen; } else { delete screen; _screens.push_back(0); } } assert(_focused_screen); if (_screens.empty()) { printf(_("No screens were found without a window manager. Exiting.\n")); ::exit(1); } ScreenList::iterator it, end = _screens.end(); for (it = _screens.begin(); it != end; ++it) { (*it)->manageExisting(); } // grab any keys set up before the screens existed _bindings->grabKeys(true); // set up input focus setFocusedClient(0); _state = State_Normal; // done starting }

ob::Openbox::~Openbox (    )  [virtual]

Openbox destructor. Definition at line 194 of file openbox.cc. References _actions, _bindings, _screens, _state, otk::RenderColor::destroy(), otk::Timer::destroy(), ob::python_destroy(), and State_Exiting. { _state = State_Exiting; // time to kill everything std::for_each(_screens.begin(), _screens.end(), otk::PointerAssassin()); delete _bindings; delete _actions; python_destroy(); XSetInputFocus(**otk::display, PointerRoot, RevertToNone, CurrentTime); XSync(**otk::display, false); // this tends to block.. i honestly am not sure why. causing an x error in // the shutdown process unblocks it. blackbox simply did a ::exit(0), so // all im gunna do is the same. //delete _display; otk::Timer::destroy(); otk::RenderColor::destroy(); }

---

Member Function Documentation

Actions* ob::Openbox::actions (    )  const [inline]

Returns the Actions instance for the window manager. Definition at line 171 of file openbox.hh. { return _actions; }

void ob::Openbox::addClient (  Window    window, Client *    client )

Adds an Client to the client list for lookups. Definition at line 334 of file openbox.cc. References _clients. Referenced by ob::Screen::manageWindow(). { _clients[window] = client; }

Bindings* ob::Openbox::bindings (    )  const [inline]

Returns the Bindings instance for the window manager. Definition at line 174 of file openbox.hh. Referenced by ob::Actions::buttonPressHandler(), ob::Actions::buttonReleaseHandler(), ob::Actions::enterHandler(), ob::Client::fireUrgent(), ob::Actions::keyPressHandler(), ob::Actions::keyReleaseHandler(), ob::Actions::leaveHandler(), ob::Screen::manageWindow(), ob::Actions::motionHandler(), ob::Screen::Screen(), ob::Screen::unmanageWindow(), and ob::Screen::~Screen(). { return _bindings; }

const Cursors& ob::Openbox::cursors (    )  const [inline]

Returns the mouse cursors used throughout Openbox. Definition at line 188 of file openbox.hh. Referenced by ob::Frame::Frame(), and ob::Screen::Screen(). { return _cursors; }

bool ob::Openbox::doRestart (    )  const [inline]

True if Openbox should be restarted instead of exiting. Definition at line 233 of file openbox.hh. { return _restart; }

void ob::Openbox::eventLoop (    )

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. Definition at line 322 of file openbox.cc. References otk::EventDispatcher::dispatchEvents(), and otk::Timer::dispatchTimers(). { while (true) { dispatchEvents(); // from otk::EventDispatcher XFlush(**otk::display); // flush here before we go wait for timers // don't wait if we're to shutdown if (_shutdown) break; otk::Timer::dispatchTimers(!_sync); // wait if not in sync mode } }

Client * ob::Openbox::findClient (  Window    window )

Finds an Client based on its window id. Definition at line 346 of file openbox.cc. References _clients. Referenced by ob::Actions::buttonPressHandler(), ob::Actions::buttonReleaseHandler(), ob::Actions::enterHandler(), ob::Actions::insertPress(), ob::Actions::leaveHandler(), ob::Screen::mapRequestHandler(), ob::Actions::motionHandler(), and ob::Client::updateTransientFor(). { /* NOTE: we dont use _clients[] to find the value because that will insert a new null into the hash, which really sucks when we want to clean up the hash at shutdown! */ ClientMap::iterator it = _clients.find(window); if (it != _clients.end()) return it->second; else return (Client*) 0; }

Client* ob::Openbox::focusedClient (    )  [inline]

The client with input focus. Definition at line 210 of file openbox.hh. Referenced by ob::Screen::changeDesktop(), ob::Bindings::fireKey(), ob::Client::unfocus(), and ob::Client::unfocusHandler(). { return _focused_client; }

Screen* ob::Openbox::focusedScreen (    )  [inline]

The screen with input focus. Definition at line 219 of file openbox.hh. { return _focused_screen; }

void ob::Openbox::parseCommandLine (  int    argv, char **    argv )  [private]

Parses the command line used when executing this application. Definition at line 219 of file openbox.cc. References _displayreq, _menufilepath, _rcfilepath, _scriptfilepath, _single, _sync, showHelp(), and showVersion(). Referenced by Openbox(). { bool err = false; for (int i = 1; i < argc; ++i) { std::string arg(argv[i]); if (arg == "-display") { if (++i >= argc) err = true; else _displayreq = argv[i]; } else if (arg == "-rc") { if (++i >= argc) err = true; else _rcfilepath = argv[i]; } else if (arg == "-menu") { if (++i >= argc) err = true; else _menufilepath = argv[i]; } else if (arg == "-script") { if (++i >= argc) err = true; else _scriptfilepath = argv[i]; } else if (arg == "-sync") { _sync = true; } else if (arg == "-single") { _single = true; } else if (arg == "-version") { showVersion(); ::exit(0); } else if (arg == "-help") { showHelp(); ::exit(0); } else err = true; if (err) { showHelp(); exit(1); } } }

void ob::Openbox::removeClient (  Window    window )

Removes an Client from the client list for lookups. Definition at line 340 of file openbox.cc. References _clients. Referenced by ob::Screen::unmanageWindow(). { _clients.erase(window); }

void ob::Openbox::restart (  const std::string &    bin = "" )  [inline]

Definition at line 228 of file openbox.hh. Referenced by signalHandler(). { _shutdown = true; _restart = true; _restart_prog = bin; }

const std::string& ob::Openbox::restartProgram (    )  const [inline]

The command line requested to be executed in place of restarting Openbox the way it was run previously. Definition at line 237 of file openbox.hh. { return _restart_prog; }

Screen* ob::Openbox::screen (  int    num )  [inline]

Returns a managed screen or a null pointer. 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. Definition at line 181 of file openbox.hh. Referenced by ob::Bindings::addButton(), ob::Client::calcLayer(), ob::Client::clientMessageHandler(), ob::Client::configureRequestHandler(), ob::Client::destroyHandler(), ob::Client::fullscreen(), ob::Client::getDesktop(), ob::Bindings::grabKeyboard(), ob::Bindings::grabKeys(), ob::Bindings::grabPointer(), ob::Client::mapRequestHandler(), ob::Client::maximize(), Openbox(), ob::Bindings::removeAllButtons(), ob::Client::reparentHandler(), ob::Client::setDesktop(), ob::Client::setWMState(), ob::Client::unmapHandler(), and ob::Client::updateStrut(). { assert(num >= 0); assert(num < (signed)ScreenCount(**otk::display)); if (num >= (signed)_screens.size()) return 0; return _screens[num]; }

void ob::Openbox::setFocusedClient (  Client *    c )

Change the client which has focus. This is called by the clients themselves when their focus state changes. Definition at line 361 of file openbox.cc. References _bindings, _focused_client, _focused_screen, _screens, ob::Bindings::fireEvent(), ob::Screen::focuswindow(), ob::Screen::installColormap(), ob::Client::installColormap(), ob::Screen::number(), and otk::Property::set(). Referenced by ob::Screen::changeDesktop(), ob::Client::focusHandler(), Openbox(), ob::Client::unfocus(), and ob::Client::unfocusHandler(). { // sometimes this is called with the already-focused window, this is // important for the python scripts to work (eg, c = 0 twice). don't just // return if _focused_client == c assert(_focused_screen); // uninstall the old colormap if (_focused_client) _focused_client->installColormap(false); else _focused_screen->installColormap(false); _focused_client = c; if (c) { _focused_screen = _screens[c->screen()]; // install the client's colormap c->installColormap(true); } else { XSetInputFocus(**otk::display, _focused_screen->focuswindow(), RevertToNone, CurrentTime); // install the root window colormap _focused_screen->installColormap(true); } // set the NET_ACTIVE_WINDOW hint for all screens ScreenList::iterator it, end = _screens.end(); for (it = _screens.begin(); it != end; ++it) { int num = (*it)->number(); Window root = otk::display->screenInfo(num)->rootWindow(); otk::Property::set(root, otk::Property::atoms.net_active_window, otk::Property::atoms.window, (c && _focused_screen == *it) ? c->window() : None); } // call the python Focus callbacks EventData data(_focused_screen->number(), c, EventAction::Focus, 0); _bindings->fireEvent(&data); }

void ob::Openbox::showHelp (    )  [private]

Displays usage information and help to stdout. Definition at line 274 of file openbox.cc. References _, and showVersion(). Referenced by parseCommandLine(). { showVersion(); // show the version string and copyright // print program usage and command line options printf(_("Usage: %s [OPTIONS...]\n\ Options:\n\ -display <string> use display connection.\n\ -single run on a single screen (default is to run every one).\n\ -rc <string> use alternate resource file.\n\ -menu <string> use alternate menu file.\n\ -script <string> use alternate startup script file.\n\ -sync run in synchronous mode (for debugging X errors).\n\ -version display version and exit.\n\ -help display this help text and exit.\n\n"), _argv[0]); printf(_("Compile time options:\n\ Debugging: %s\n\ Shape: %s\n\ Xinerama: %s\n\ Xkb: %s\n"), #ifdef DEBUG _("yes"), #else // !DEBUG _("no"), #endif // DEBUG #ifdef SHAPE _("yes"), #else // !SHAPE _("no"), #endif // SHAPE #ifdef XINERAMA _("yes"), #else // !XINERAMA _("no"), #endif // XINERAMA #ifdef XKB _("yes") #else // !XKB _("no") #endif // XKB ); }

void ob::Openbox::showVersion (    )  [private]

Displays the version string to stdout. Definition at line 267 of file openbox.cc. References _. Referenced by parseCommandLine(), and showHelp(). { printf(_("Openbox - version %s\n"), VERSION); printf(" (c) 2002 - 2002 Ben Jansens\n\n"); }

void ob::Openbox::shutdown (    )  [inline]

Requests that the window manager exit. Causes the Openbox::eventLoop function to stop looping, so that the window manager can be destroyed. Definition at line 226 of file openbox.hh. Referenced by signalHandler(). { _shutdown = true; }

void ob::Openbox::signalHandler (  int    signal )  [static, private]

Handles signal events for the application. Definition at line 53 of file openbox.cc. References ob::openbox, restart(), and shutdown(). { switch (signal) { case SIGUSR1: printf("Caught SIGUSR1 signal. Restarting.\n"); openbox->restart(); break; case SIGCHLD: wait(NULL); break; case SIGHUP: case SIGINT: case SIGTERM: case SIGPIPE: printf("Caught signal %d. Exiting.\n", signal); openbox->shutdown(); break; case SIGFPE: case SIGSEGV: printf("Caught signal %d. Aborting and dumping core.\n", signal); abort(); } }

RunState ob::Openbox::state (    )  const [inline]

Returns the state of the window manager (starting, exiting, etc). Definition at line 168 of file openbox.hh. References RunState. Referenced by ob::Client::Client(), ob::Frame::grabClient(), ob::Screen::manageWindow(), and ob::Client::~Client(). { return _state; }

---

Member Data Documentation

Actions* ob::Openbox::_actions [private]

The action interface through which all user-available actions occur. Definition at line 110 of file openbox.hh. Referenced by Openbox(), and ~Openbox().

char** ob::Openbox::_argv [private]

The value of argv, i.e. how this application was executed. Definition at line 97 of file openbox.hh. Referenced by Openbox().

Bindings* ob::Openbox::_bindings [private]

The interface through which keys/buttons are grabbed and handled. Definition at line 113 of file openbox.hh. Referenced by Openbox(), setFocusedClient(), and ~Openbox().

ClientMap ob::Openbox::_clients [private]

A list of all managed clients. Definition at line 104 of file openbox.hh. Referenced by addClient(), findClient(), and removeClient().

Cursors ob::Openbox::_cursors [private]

Mouse cursors used throughout Openbox. Definition at line 119 of file openbox.hh. Referenced by Openbox().

otk::Display ob::Openbox::_display [private]

The display on which Openbox is running. Definition at line 76 of file openbox.hh.

char* ob::Openbox::_displayreq [private]

The display requested by the user, or null to use the DISPLAY env var. Definition at line 95 of file openbox.hh. Referenced by Openbox(), and parseCommandLine().

Client* ob::Openbox::_focused_client [private]

The client with input focus. Updated by the clients themselves. Definition at line 136 of file openbox.hh. Referenced by Openbox(), and setFocusedClient().

Screen* ob::Openbox::_focused_screen [private]

The screen with input focus. Updated by the clients when they update the Openbox::focused_client property. Definition at line 143 of file openbox.hh. Referenced by Openbox(), and setFocusedClient().

std::string ob::Openbox::_menufilepath [private]

Path to the menu file to use/in use. Defaults to /home/xor/.openbox/menu3 Definition at line 88 of file openbox.hh. Referenced by parseCommandLine().

std::string ob::Openbox::_rcfilepath [private]

Path to the config file to use/in use. Defaults to /home/xor/.openbox/rc3 Definition at line 83 of file openbox.hh. Referenced by Openbox(), and parseCommandLine().

bool ob::Openbox::_restart [private]

When set to true, and Openbox is about to exit, it will spawn a new process. Definition at line 126 of file openbox.hh. Referenced by Openbox().

std::string ob::Openbox::_restart_prog [private]

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. Definition at line 130 of file openbox.hh.

ScreenList ob::Openbox::_screens [private]

A list of all the managed screens. Definition at line 107 of file openbox.hh. Referenced by Openbox(), setFocusedClient(), and ~Openbox().

std::string ob::Openbox::_scriptfilepath [private]

Path to the script file to execute on startup. Defaults to /home/xor/.openbox/user.py Definition at line 93 of file openbox.hh. Referenced by Openbox(), and parseCommandLine().

bool ob::Openbox::_shutdown [private]

When set to true, the Openbox::eventLoop function will stop and return. Definition at line 122 of file openbox.hh. Referenced by Openbox().

bool ob::Openbox::_single [private]

Should Openbox run on a single screen or on all available screens? Definition at line 101 of file openbox.hh. Referenced by Openbox(), and parseCommandLine().

RunState ob::Openbox::_state [private]

The running state of the window manager. Definition at line 116 of file openbox.hh. Referenced by Openbox(), and ~Openbox().

bool ob::Openbox::_sync [private]

Run the application in synchronous mode? (for debugging). Definition at line 99 of file openbox.hh. Referenced by Openbox(), and parseCommandLine().

---

The documentation for this class was generated from the following files:

• /src/openbox.hh
• /src/openbox.cc

---