util/epist/screen.cc

   1 // -*- mode: C++; indent-tabs-mode: nil; -*-
   2 // screen.cc for Epistophy - a key handler for NETWM/EWMH window managers.
   3 // Copyright (c) 2002 - 2002 Ben Jansens <ben at orodu.net>
   4 //
   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:
  11 //
  12 // The above copyright notice and this permission notice shall be included in
  13 // all copies or substantial portions of the Software.
  14 //
  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.
  22
  23 #ifdef    HAVE_CONFIG_H
  24 #  include "../../config.h"
  25 #endif // HAVE_CONFIG_H
  26
  27 extern "C" {
  28 #ifdef    HAVE_UNISTD_H
  29 #  include <sys/types.h>
  30 #  include <unistd.h>
  31 #endif // HAVE_UNISTD_H
  32 }
  33
  34 #include <iostream>
  35 #include <string>
  36
  37 using std::cout;
  38 using std::endl;
  39 using std::hex;
  40 using std::dec;
  41 using std::string;
  42
  43 #include "../../src/XAtom.hh"
  44 #include "screen.hh"
  45 #include "epist.hh"
  46
  47
  48 screen::screen(epist *epist, int number) {
  49   _epist = epist;
  50   _xatom = _epist->xatom();
  51   _number = number;
  52   _active = _clients.end();
  53   _root = RootWindow(_epist->getXDisplay(), _number);
  54
  55   // find a window manager supporting NETWM, waiting for it to load if we must
  56   int count = 20;  // try for 20 seconds
  57   _managed = false;
  58   while (! (_epist->doShutdown() || _managed || count <= 0)) {
  59     if (! (_managed = findSupportingWM()))
  60       usleep(1000);
  61     --count;
  62   }
  63   if (_managed)
  64     cout << "Found compatible window manager '" << _wm_name << "' for screen "
  65       << _number << ".\n";
  66   else {
  67     cout << "Unable to find a compatible window manager for screen " <<
  68       _number << ".\n";
  69     return;
  70   }
  71
  72   XSelectInput(_epist->getXDisplay(), _root, PropertyChangeMask);
  73
  74   updateClientList();
  75   updateActiveWindow();
  76 }
  77
  78
  79 screen::~screen() {
  80   if (_managed)
  81     XSelectInput(_epist->getXDisplay(), _root, None);
  82 }
  83
  84
  85 bool screen::findSupportingWM() {
  86   Window support_win;
  87   if (! _xatom->getValue(_root, XAtom::net_supporting_wm_check, XAtom::window,
  88                          support_win) || support_win == None)
  89     return false;
  90
  91   string title;
  92   _xatom->getValue(support_win, XAtom::net_wm_name, XAtom::utf8, title);
  93   _wm_name = title;
  94   return true;
  95 }
  96
  97
  98 XWindow *screen::findWindow(const XEvent &e) const {
  99   assert(_managed);
 100
 101   WindowList::const_iterator it, end = _clients.end();
 102   for (it = _clients.begin(); it != end; ++it)
 103     if (**it == e.xany.window)
 104       break;
 105   if(it == end)
 106     return 0;
 107   return *it;
 108 }
 109
 110
 111 void screen::processEvent(const XEvent &e) {
 112   assert(_managed);
 113   assert(e.xany.window == _root);
 114
 115   XWindow *window = 0;
 116   if (e.xany.window != _root) {
 117     window = findWindow(e);  // find the window
 118     assert(window); // we caught an event for a window we don't know about!?
 119   }
 120
 121   switch (e.type) {
 122   case PropertyNotify:
 123     // root window
 124     if (e.xproperty.atom == _xatom->getAtom(XAtom::net_active_window))
 125       updateActiveWindow();
 126     if (e.xproperty.atom == _xatom->getAtom(XAtom::net_client_list)) {
 127       // catch any window unmaps first
 128       XEvent ev;
 129       if (XCheckTypedWindowEvent(_epist->getXDisplay(), e.xany.window,
 130                                  DestroyNotify, &ev) ||
 131           XCheckTypedWindowEvent(_epist->getXDisplay(), e.xany.window,
 132                                  UnmapNotify, &ev)) {
 133         processEvent(ev);
 134       }
 135
 136       updateClientList();
 137     }
 138     break;
 139   case KeyPress:
 140     handleKeypress(e);
 141     break;
 142   }
 143 }
 144
 145 void screen::handleKeypress(const XEvent &e) {
 146   ActionList::const_iterator it = _epist->actions().begin();
 147   ActionList::const_iterator end = _epist->actions().end();
 148   for (; it != end; ++it) {
 149     if (e.xkey.keycode == it->keycode() &&
 150         e.xkey.state == it->modifierMask()) {
 151       switch (it->type()) {
 152       case Action::nextWorkspace:
 153         cycleWorkspace(true);
 154         return;
 155
 156       case Action::prevWorkspace:
 157         cycleWorkspace(false);
 158         return;
 159
 160       case Action::nextWindow:
 161         cycleWindow(true);
 162         return;
 163
 164       case Action::prevWindow:
 165         cycleWindow(false);
 166         return;
 167
 168       case Action::changeWorkspace:
 169         changeWorkspace(it->number());
 170         return;
 171       }
 172
 173       // these actions require an active window
 174       if (_active != _clients.end()) {
 175         XWindow *window = *_active;
 176
 177         switch (it->type()) {
 178         case Action::close:
 179           window->close();
 180           return;
 181
 182         case Action::raise:
 183           window->raise();
 184           return;
 185
 186         case Action::lower:
 187           window->lower();
 188           return;
 189
 190         case Action::toggleshade:
 191           window->shade(! window->shaded());
 192           return;
 193         }
 194       }
 195     }
 196   }
 197 }
 198
 199 // do we want to add this window to our list?
 200 bool screen::doAddWindow(Window window) const {
 201   assert(_managed);
 202
 203   Atom type;
 204   if (! _xatom->getValue(window, XAtom::net_wm_window_type, XAtom::atom,
 205                          type))
 206     return True;
 207
 208   if (type == _xatom->getAtom(XAtom::net_wm_window_type_dock) ||
 209       type == _xatom->getAtom(XAtom::net_wm_window_type_menu))
 210     return False;
 211
 212   return True;
 213 }
 214
 215
 216 void screen::updateClientList() {
 217   assert(_managed);
 218
 219   WindowList::iterator insert_point = _active;
 220   if (insert_point != _clients.end())
 221     ++insert_point; // get to the item client the focused client
 222
 223   // get the client list from the root window
 224   Window *rootclients = 0;
 225   unsigned long num = (unsigned) -1;
 226   if (! _xatom->getValue(_root, XAtom::net_client_list, XAtom::window, num,
 227                          &rootclients)) {
 228     while (! _clients.empty()) {
 229       delete _clients.front();
 230       _clients.erase(_clients.begin());
 231     }
 232     if (rootclients) delete [] rootclients;
 233     return;
 234   }
 235
 236   WindowList::iterator it, end = _clients.end();
 237   unsigned long i;
 238
 239   // insert new clients after the active window
 240   for (i = 0; i < num; ++i) {
 241     for (it = _clients.begin(); it != end; ++it)
 242       if (**it == rootclients[i])
 243         break;
 244     if (it == end) {  // didn't already exist
 245       if (doAddWindow(rootclients[i])) {
 246         cout << "Added window: 0x" << hex << rootclients[i] << dec << endl;
 247         _clients.insert(insert_point, new XWindow(_epist, this,
 248                                                   rootclients[i]));
 249       }
 250     }
 251   }
 252
 253   // remove clients that no longer exist
 254   for (it = _clients.begin(); it != end;) {
 255     WindowList::iterator it2 = it++;
 256     for (i = 0; i < num; ++i)
 257       if (**it2 == rootclients[i])
 258         break;
 259     if (i == num)  { // no longer exists
 260       cout << "Removed window: 0x" << hex << (*it2)->window() << dec << endl;
 261       delete *it2;
 262       _clients.erase(it2);
 263     }
 264   }
 265
 266   if (rootclients) delete [] rootclients;
 267 }
 268
 269
 270 void screen::updateActiveWindow() {
 271   assert(_managed);
 272
 273   Window a = None;
 274   _xatom->getValue(_root, XAtom::net_active_window, XAtom::window, a);
 275
 276   WindowList::iterator it, end = _clients.end();
 277   for (it = _clients.begin(); it != end; ++it) {
 278     if (**it == a)
 279       break;
 280   }
 281   _active = it;
 282
 283   cout << "Active window is now: ";
 284   if (_active == _clients.end()) cout << "None\n";
 285   else cout << "0x" << hex << (*_active)->window() << dec << endl;
 286 }
 287
 288 /*
 289  * use this when execing a command to have it on the right screen
 290       string dtmp = (string)"DISPLAY=" + display_name;
 291       if (putenv(const_cast<char*>(dtmp.c_str()))) {
 292         cout << "warning: couldn't set environment variable 'DISPLAY'\n";
 293         perror("putenv()");
 294       }
 295  */
 296
 297
 298 void screen::cycleWindow(const bool forward) const {
 299   if (_clients.empty()) return;
 300
 301   WindowList::const_iterator target = _active;
 302
 303   if (target == _clients.end())
 304     target = _clients.begin();
 305
 306   do {
 307     if (forward) {
 308       ++target;
 309       if (target == _clients.end())
 310         target = _clients.begin();
 311     } else {
 312       if (target == _clients.begin())
 313         target = _clients.end();
 314       --target;
 315     }
 316   } while (target == _clients.end() || (*target)->iconic());
 317
 318   if (target != _clients.end()) {
 319     // we dont send an ACTIVE_WINDOW client message because that would also
 320     // unshade the window if it was shaded
 321     XSetInputFocus(_epist->getXDisplay(), (*target)->window(), RevertToNone,
 322                    CurrentTime);
 323     XRaiseWindow(_epist->getXDisplay(), (*target)->window());
 324   }
 325 }
 326
 327
 328 void screen::cycleWorkspace(const bool forward) const {
 329   unsigned long currentDesktop = 0;
 330   unsigned long numDesktops = 0;
 331
 332   if (_xatom->getValue(_root, XAtom::net_current_desktop, XAtom::cardinal,
 333                        currentDesktop)) {
 334     if (forward)
 335       ++currentDesktop;
 336     else
 337       --currentDesktop;
 338
 339     _xatom->getValue(_root, XAtom::net_number_of_desktops, XAtom::cardinal,
 340                      numDesktops);
 341
 342     if ( ( (signed)currentDesktop) == -1)
 343       currentDesktop = numDesktops - 1;
 344     else if (currentDesktop >= numDesktops)
 345       currentDesktop = 0;
 346
 347     changeWorkspace(currentDesktop);
 348   }
 349 }
 350
 351
 352 void screen::changeWorkspace(const int num) const {
 353   _xatom->sendClientMessage(_root, XAtom::net_current_desktop, _root, num);
 354 }