1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
2 // screen.cc for Epistrophy - a key handler for NETWM/EWMH window managers.
3 // Copyright (c) 2002 - 2002 Ben Jansens <ben at orodu.net>
5 // Permission is hereby granted, free of charge, to any person obtaining a
6 // copy of this software and associated documentation files (the "Software"),
7 // to deal in the Software without restriction, including without limitation
8 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 // and/or sell copies of the Software, and to permit persons to whom the
10 // Software is furnished to do so, subject to the following conditions:
12 // The above copyright notice and this permission notice shall be included in
13 // all copies or substantial portions of the Software.
15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 // DEALINGS IN THE SOFTWARE.
24 # include "../../config.h"
25 #endif // HAVE_CONFIG_H
30 #endif // HAVE_STDIO_H
33 # include <sys/types.h>
35 #endif // HAVE_UNISTD_H
47 #include "../../src/BaseDisplay.hh"
48 #include "../../src/XAtom.hh"
53 screen::screen(epist *epist, int number)
54 : _clients(epist->clientsList()),
55 _active(epist->activeWindow()) {
57 _xatom = _epist->xatom();
58 _last_active = _clients.end();
60 _info = _epist->getScreenInfo(_number);
61 _root = _info->getRootWindow();
63 // find a window manager supporting NETWM, waiting for it to load if we must
64 int count = 20; // try for 20 seconds
66 while (! (_epist->doShutdown() || _managed || count <= 0)) {
67 if (! (_managed = findSupportingWM()))
72 cout << "Found compatible window manager '" << _wm_name << "' for screen "
75 cout << "Unable to find a compatible window manager for screen " <<
80 XSelectInput(_epist->getXDisplay(), _root, PropertyChangeMask);
85 XSelectInput(_epist->getXDisplay(), _root, None);
89 bool screen::findSupportingWM() {
91 if (! _xatom->getValue(_root, XAtom::net_supporting_wm_check, XAtom::window,
92 support_win) || support_win == None)
96 _xatom->getValue(support_win, XAtom::net_wm_name, XAtom::utf8, title);
102 XWindow *screen::findWindow(const XEvent &e) const {
105 WindowList::const_iterator it, end = _clients.end();
106 for (it = _clients.begin(); it != end; ++it)
107 if (**it == e.xany.window)
115 void screen::processEvent(const XEvent &e) {
117 assert(e.xany.window == _root);
122 if (e.xproperty.atom == _xatom->getAtom(XAtom::net_number_of_desktops))
124 else if (e.xproperty.atom == _xatom->getAtom(XAtom::net_current_desktop))
125 updateActiveDesktop();
126 else if (e.xproperty.atom == _xatom->getAtom(XAtom::net_active_window))
127 updateActiveWindow();
128 else if (e.xproperty.atom == _xatom->getAtom(XAtom::net_client_list)) {
129 // catch any window unmaps first
131 if (XCheckTypedWindowEvent(_epist->getXDisplay(), e.xany.window,
132 DestroyNotify, &ev) ||
133 XCheckTypedWindowEvent(_epist->getXDisplay(), e.xany.window,
147 void screen::handleKeypress(const XEvent &e) {
148 int scrolllockMask, numlockMask;
149 _epist->getLockModifiers(numlockMask, scrolllockMask);
151 // Mask out the lock modifiers. We want our keys to always work
152 // This should be made an option
153 unsigned int state = e.xkey.state & ~(LockMask|scrolllockMask|numlockMask);
154 const Action *it = _epist->getKeyTree().getAction(e, state, this);
159 switch (it->type()) {
160 case Action::nextScreen:
161 _epist->cycleScreen(_number, true);
164 case Action::prevScreen:
165 _epist->cycleScreen(_number, false);
168 case Action::nextWorkspace:
169 cycleWorkspace(true, it->number() != 0 ? it->number(): 1);
172 case Action::prevWorkspace:
173 cycleWorkspace(false, it->number() != 0 ? it->number(): 1);
176 case Action::nextWindow:
178 cycleWindow(true, it->number() != 0 ? it->number(): 1);
181 case Action::prevWindow:
182 cycleWindow(false, it->number() != 0 ? it->number(): 1);
185 case Action::nextWindowOnAllWorkspaces:
186 cycleWindow(true, it->number() != 0 ? it->number(): 1, false, true);
189 case Action::prevWindowOnAllWorkspaces:
190 cycleWindow(false, it->number() != 0 ? it->number(): 1, false, true);
193 case Action::nextWindowOnAllScreens:
194 cycleWindow(true, it->number() != 0 ? it->number(): 1, true);
197 case Action::prevWindowOnAllScreens:
198 cycleWindow(false, it->number() != 0 ? it->number(): 1, true);
201 case Action::nextWindowOfClass:
202 cycleWindow(true, it->number() != 0 ? it->number(): 1,
203 false, false, true, it->string());
206 case Action::prevWindowOfClass:
207 cycleWindow(false, it->number() != 0 ? it->number(): 1,
208 false, false, true, it->string());
211 case Action::nextWindowOfClassOnAllWorkspaces:
212 cycleWindow(true, it->number() != 0 ? it->number(): 1,
213 false, true, true, it->string());
216 case Action::prevWindowOfClassOnAllWorkspaces:
217 cycleWindow(false, it->number() != 0 ? it->number(): 1,
218 false, true, true, it->string());
221 case Action::changeWorkspace:
222 changeWorkspace(it->number());
225 case Action::upWorkspace:
226 changeWorkspaceVert(-1);
229 case Action::downWorkspace:
230 changeWorkspaceVert(1);
233 case Action::leftWorkspace:
234 changeWorkspaceHorz(-1);
237 case Action::rightWorkspace:
238 changeWorkspaceHorz(1);
241 case Action::execute:
242 execCommand(it->string());
245 case Action::showRootMenu:
246 _xatom->sendClientMessage(rootWindow(), XAtom::openbox_show_root_menu,
250 case Action::showWorkspaceMenu:
251 _xatom->sendClientMessage(rootWindow(), XAtom::openbox_show_workspace_menu,
259 // these actions require an active window
260 if (_active != _clients.end()) {
261 XWindow *window = *_active;
263 switch (it->type()) {
264 case Action::iconify:
280 case Action::sendToWorkspace:
281 window->sendTo(it->number());
284 case Action::toggleomnipresent:
285 if (window->desktop() == 0xffffffff)
286 window->sendTo(_active_desktop);
288 window->sendTo(0xffffffff);
291 case Action::moveWindowUp:
292 window->move(window->x(), window->y() -
293 (it->number() != 0 ? it->number(): 1));
296 case Action::moveWindowDown:
297 window->move(window->x(), window->y() +
298 (it->number() != 0 ? it->number(): 1));
301 case Action::moveWindowLeft:
302 window->move(window->x() - (it->number() != 0 ? it->number(): 1),
306 case Action::moveWindowRight:
307 window->move(window->x() + (it->number() != 0 ? it->number(): 1),
311 case Action::resizeWindowWidth:
312 window->resizeRel(it->number(), 0);
315 case Action::resizeWindowHeight:
316 window->resizeRel(0, it->number());
319 case Action::toggleshade:
320 window->shade(! window->shaded());
323 case Action::toggleMaximizeHorizontal:
324 window->toggleMaximize(XWindow::Max_Horz);
327 case Action::toggleMaximizeVertical:
328 window->toggleMaximize(XWindow::Max_Vert);
331 case Action::toggleMaximizeFull:
332 window->toggleMaximize(XWindow::Max_Full);
335 case Action::toggleDecorations:
336 window->decorate(! window->decorated());
340 assert(false); // unhandled action type!
346 // do we want to add this window to our list?
347 bool screen::doAddWindow(Window window) const {
351 if (! _xatom->getValue(window, XAtom::net_wm_window_type, XAtom::atom,
355 if (type == _xatom->getAtom(XAtom::net_wm_window_type_dock) ||
356 type == _xatom->getAtom(XAtom::net_wm_window_type_menu))
363 void screen::updateEverything() {
365 updateActiveDesktop();
367 updateActiveWindow();
371 void screen::updateNumDesktops() {
374 if (! _xatom->getValue(_root, XAtom::net_number_of_desktops, XAtom::cardinal,
375 (unsigned long)_num_desktops))
376 _num_desktops = 1; // assume that there is at least 1 desktop!
380 void screen::updateActiveDesktop() {
383 if (! _xatom->getValue(_root, XAtom::net_current_desktop, XAtom::cardinal,
384 (unsigned long)_active_desktop))
385 _active_desktop = 0; // there must be at least one desktop, and it must
386 // be the current one
390 void screen::updateClientList() {
393 WindowList::iterator insert_point = _active;
394 if (insert_point != _clients.end())
395 ++insert_point; // get to the item client the focused client
397 // get the client list from the root window
398 Window *rootclients = 0;
399 unsigned long num = (unsigned) -1;
400 if (! _xatom->getValue(_root, XAtom::net_client_list, XAtom::window, num,
404 WindowList::iterator it;
405 const WindowList::iterator end = _clients.end();
408 // insert new clients after the active window
409 for (i = 0; i < num; ++i) {
410 for (it = _clients.begin(); it != end; ++it)
411 if (**it == rootclients[i])
413 if (it == end) { // didn't already exist
414 if (doAddWindow(rootclients[i])) {
415 // cout << "Added window: 0x" << hex << rootclients[i] << dec << endl;
416 _clients.insert(insert_point, new XWindow(_epist, this,
422 // remove clients that no longer exist (that belong to this screen)
423 for (it = _clients.begin(); it != end;) {
424 WindowList::iterator it2 = it;
427 // is on another screen?
428 if ((*it2)->getScreen() != this)
431 for (i = 0; i < num; ++i)
432 if (**it2 == rootclients[i])
434 if (i == num) { // no longer exists
435 // cout << "Removed window: 0x" << hex << (*it2)->window() << dec << endl;
436 // watch for the active and last-active window
438 _active = _clients.end();
439 if (it2 == _last_active)
440 _last_active = _clients.end();
446 if (rootclients) delete [] rootclients;
450 const XWindow *screen::lastActiveWindow() const {
451 if (_last_active != _clients.end())
452 return *_last_active;
454 // find a window if one exists
455 WindowList::const_iterator it, end = _clients.end();
456 for (it = _clients.begin(); it != end; ++it)
457 if ((*it)->getScreen() == this && ! (*it)->iconic() &&
458 ((*it)->desktop() == 0xffffffff || (*it)->desktop() == _active_desktop))
461 // no windows on this screen
466 void screen::updateActiveWindow() {
470 _xatom->getValue(_root, XAtom::net_active_window, XAtom::window, a);
472 WindowList::iterator it, end = _clients.end();
473 for (it = _clients.begin(); it != end; ++it) {
475 if ((*it)->getScreen() != this)
484 /* cout << "Active window is now: ";
485 if (_active == _clients.end()) cout << "None\n";
486 else cout << "0x" << hex << (*_active)->window() << dec << endl;
491 void screen::execCommand(const string &cmd) const {
493 if ((pid = fork()) == 0) {
494 // make the command run on the correct screen
495 if (putenv(const_cast<char*>(_info->displayString().c_str()))) {
496 cout << "warning: couldn't set environment variable 'DISPLAY'\n";
499 execl("/bin/sh", "sh", "-c", cmd.c_str(), NULL);
501 } else if (pid == -1) {
502 cout << _epist->getApplicationName() <<
503 ": Could not fork a process for executing a command\n";
508 void screen::cycleWindow(const bool forward, const int increment,
509 const bool allscreens, const bool alldesktops,
510 const bool sameclass, const string &cn) const {
512 assert(increment > 0);
514 if (_clients.empty()) return;
516 string classname(cn);
517 if (sameclass && classname.empty() && _active != _clients.end())
518 classname = (*_active)->appClass();
520 WindowList::const_iterator target = _active,
521 begin = _clients.begin(),
522 end = _clients.end();
524 const XWindow *t = 0;
526 for (int x = 0; x < increment; ++x) {
540 // must be no window to focus
541 if (target == _active)
544 // start back at the beginning of the loop
548 // determine if this window is invalid for cycling to
550 if (t->iconic()) continue;
551 if (! allscreens && t->getScreen() != this) continue;
552 if (! alldesktops && ! (t->desktop() == _active_desktop ||
553 t->desktop() == 0xffffffff)) continue;
554 if (sameclass && ! classname.empty() &&
555 t->appClass() != classname) continue;
556 if (! t->canFocus()) continue;
558 // found a good window so break out of the while, and perhaps continue
564 // phew. we found the window, so focus it.
569 void screen::cycleWorkspace(const bool forward, const int increment,
570 const bool loop) const {
572 assert(increment > 0);
574 unsigned int destination = _active_desktop;
576 for (int x = 0; x < increment; ++x) {
578 if (destination < _num_desktops - 1)
586 destination = _num_desktops - 1;
590 if (destination != _active_desktop)
591 changeWorkspace(destination);
595 void screen::changeWorkspace(const int num) const {
598 _xatom->sendClientMessage(_root, XAtom::net_current_desktop, _root, num);
601 void screen::changeWorkspaceVert(const int num) const {
603 const Config *conf = _epist->getConfig();
604 int width = conf->getNumberValue(Config::workspaceColumns);
605 int num_desktops = (signed)_num_desktops;
606 int active_desktop = (signed)_active_desktop;
609 if (width > num_desktops || width <= 0)
612 // a cookie to the person that makes this pretty
614 wnum = active_desktop - width;
616 wnum = num_desktops/width * width + active_desktop;
617 if (wnum >= num_desktops)
618 wnum = num_desktops - 1;
622 wnum = active_desktop + width;
623 if (wnum >= num_desktops) {
624 wnum = (active_desktop + width) % num_desktops - 1;
629 changeWorkspace(wnum);
632 void screen::changeWorkspaceHorz(const int num) const {
634 const Config *conf = _epist->getConfig();
635 int width = conf->getNumberValue(Config::workspaceColumns);
636 int num_desktops = (signed)_num_desktops;
637 int active_desktop = (signed)_active_desktop;
640 if (width > num_desktops || width <= 0)
644 if (active_desktop % width != 0)
645 changeWorkspace(active_desktop - 1);
647 wnum = active_desktop + width - 1;
648 if (wnum >= num_desktops)
649 wnum = num_desktops - 1;
653 if (active_desktop % width != width - 1) {
654 wnum = active_desktop + 1;
655 if (wnum >= num_desktops)
656 wnum = num_desktops / width * width;
659 wnum = active_desktop - width + 1;
661 changeWorkspace(wnum);
664 void screen::grabKey(const KeyCode keyCode, const int modifierMask) const {
666 Display *display = _epist->getXDisplay();
667 int numlockMask, scrolllockMask;
669 _epist->getLockModifiers(numlockMask, scrolllockMask);
671 XGrabKey(display, keyCode, modifierMask,
672 _root, True, GrabModeAsync, GrabModeAsync);
673 XGrabKey(display, keyCode,
674 modifierMask|LockMask,
675 _root, True, GrabModeAsync, GrabModeAsync);
676 XGrabKey(display, keyCode,
677 modifierMask|scrolllockMask,
678 _root, True, GrabModeAsync, GrabModeAsync);
679 XGrabKey(display, keyCode,
680 modifierMask|numlockMask,
681 _root, True, GrabModeAsync, GrabModeAsync);
683 XGrabKey(display, keyCode,
684 modifierMask|LockMask|scrolllockMask,
685 _root, True, GrabModeAsync, GrabModeAsync);
686 XGrabKey(display, keyCode,
687 modifierMask|scrolllockMask|numlockMask,
688 _root, True, GrabModeAsync, GrabModeAsync);
689 XGrabKey(display, keyCode,
690 modifierMask|numlockMask|LockMask,
691 _root, True, GrabModeAsync, GrabModeAsync);
693 XGrabKey(display, keyCode,
694 modifierMask|numlockMask|LockMask|scrolllockMask,
695 _root, True, GrabModeAsync, GrabModeAsync);
698 void screen::ungrabKey(const KeyCode keyCode, const int modifierMask) const {
700 Display *display = _epist->getXDisplay();
701 int numlockMask, scrolllockMask;
703 _epist->getLockModifiers(numlockMask, scrolllockMask);
705 XUngrabKey(display, keyCode, modifierMask, _root);
706 XUngrabKey(display, keyCode, modifierMask|LockMask, _root);
707 XUngrabKey(display, keyCode, modifierMask|scrolllockMask, _root);
708 XUngrabKey(display, keyCode, modifierMask|numlockMask, _root);
709 XUngrabKey(display, keyCode, modifierMask|LockMask|scrolllockMask, _root);
710 XUngrabKey(display, keyCode, modifierMask|scrolllockMask|numlockMask, _root);
711 XUngrabKey(display, keyCode, modifierMask|numlockMask|LockMask, _root);
712 XUngrabKey(display, keyCode, modifierMask|numlockMask|LockMask|
713 scrolllockMask, _root);