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   updateNumDesktops();
  75   updateActiveDesktop();
  76   updateClientList();
  77   updateActiveWindow();
  78 }
  79
  80
  81 screen::~screen() {
  82   if (_managed)
  83     XSelectInput(_epist->getXDisplay(), _root, None);
  84 }
  85
  86
  87 bool screen::findSupportingWM() {
  88   Window support_win;
  89   if (! _xatom->getValue(_root, XAtom::net_supporting_wm_check, XAtom::window,
  90                          support_win) || support_win == None)
  91     return false;
  92
  93   string title;
  94   _xatom->getValue(support_win, XAtom::net_wm_name, XAtom::utf8, title);
  95   _wm_name = title;
  96   return true;
  97 }
  98
  99
 100 XWindow *screen::findWindow(const XEvent &e) const {
 101   assert(_managed);
 102
 103   WindowList::const_iterator it, end = _clients.end();
 104   for (it = _clients.begin(); it != end; ++it)
 105     if (**it == e.xany.window)
 106       break;
 107   if(it == end)
 108     return 0;
 109   return *it;
 110 }
 111
 112
 113 void screen::processEvent(const XEvent &e) {
 114   assert(_managed);
 115   assert(e.xany.window == _root);
 116
 117   XWindow *window = 0;
 118   if (e.xany.window != _root) {
 119     window = findWindow(e);  // find the window
 120     assert(window); // we caught an event for a window we don't know about!?
 121   }
 122
 123   switch (e.type) {
 124   case PropertyNotify:
 125     // root window
 126     if (e.xproperty.atom == _xatom->getAtom(XAtom::net_number_of_desktops))
 127       updateNumDesktops();
 128     if (e.xproperty.atom == _xatom->getAtom(XAtom::net_current_desktop))
 129       updateActiveDesktop();
 130     if (e.xproperty.atom == _xatom->getAtom(XAtom::net_active_window))
 131       updateActiveWindow();
 132     if (e.xproperty.atom == _xatom->getAtom(XAtom::net_client_list)) {
 133       // catch any window unmaps first
 134       XEvent ev;
 135       if (XCheckTypedWindowEvent(_epist->getXDisplay(), e.xany.window,
 136                                  DestroyNotify, &ev) ||
 137           XCheckTypedWindowEvent(_epist->getXDisplay(), e.xany.window,
 138                                  UnmapNotify, &ev)) {
 139         processEvent(ev);
 140       }
 141
 142       updateClientList();
 143     }
 144     break;
 145   case KeyPress:
 146     handleKeypress(e);
 147     break;
 148   }
 149 }
 150
 151 void screen::handleKeypress(const XEvent &e) {
 152   ActionList::const_iterator it = _epist->actions().begin();
 153   ActionList::const_iterator end = _epist->actions().end();
 154   for (; it != end; ++it) {
 155     if (e.xkey.keycode == it->keycode() &&
 156         e.xkey.state == it->modifierMask()) {
 157       switch (it->type()) {
 158       case Action::nextWorkspace:
 159         cycleWorkspace(true);
 160         return;
 161
 162       case Action::prevWorkspace:
 163         cycleWorkspace(false);
 164         return;
 165
 166       case Action::nextWindow:
 167         cycleWindow(true);
 168         return;
 169
 170       case Action::prevWindow:
 171         cycleWindow(false);
 172         return;
 173
 174       case Action::nextWindowOnAllWorkspaces:
 175         cycleWindow(true, true);
 176         return;
 177
 178       case Action::prevWindowOnAllWorkspaces:
 179         cycleWindow(false, true);
 180         return;
 181
 182       case Action::nextWindowOfClass:
 183         cycleWindow(true, false, true);
 184         return;
 185
 186       case Action::prevWindowOfClass:
 187         cycleWindow(false, false, true);
 188         return;
 189
 190       case Action::nextWindowOfClassOnAllWorkspaces:
 191         cycleWindow(true, true, true);
 192         return;
 193
 194       case Action::prevWindowOfClassOnAllWorkspaces:
 195         cycleWindow(false, true, true);
 196         return;
 197
 198       case Action::changeWorkspace:
 199         changeWorkspace(it->number());
 200         return;
 201       }
 202
 203       // these actions require an active window
 204       if (_active != _clients.end()) {
 205         XWindow *window = *_active;
 206
 207         switch (it->type()) {
 208         case Action::iconify:
 209           window->iconify();
 210           return;
 211
 212         case Action::close:
 213           window->close();
 214           return;
 215
 216         case Action::raise:
 217           window->raise();
 218           return;
 219
 220         case Action::lower:
 221           window->lower();
 222           return;
 223
 224         case Action::toggleshade:
 225           window->shade(! window->shaded());
 226           return;
 227         }
 228       }
 229     }
 230   }
 231 }
 232
 233 // do we want to add this window to our list?
 234 bool screen::doAddWindow(Window window) const {
 235   assert(_managed);
 236
 237   Atom type;
 238   if (! _xatom->getValue(window, XAtom::net_wm_window_type, XAtom::atom,
 239                          type))
 240     return True;
 241
 242   if (type == _xatom->getAtom(XAtom::net_wm_window_type_dock) ||
 243       type == _xatom->getAtom(XAtom::net_wm_window_type_menu))
 244     return False;
 245
 246   return True;
 247 }
 248
 249
 250 void screen::updateNumDesktops() {
 251   assert(_managed);
 252
 253   if (! _xatom->getValue(_root, XAtom::net_number_of_desktops, XAtom::cardinal,
 254                          (unsigned long)_num_desktops))
 255     _num_desktops = 1;  // assume that there is at least 1 desktop!
 256 }
 257
 258
 259 void screen::updateActiveDesktop() {
 260   assert(_managed);
 261
 262   if (! _xatom->getValue(_root, XAtom::net_current_desktop, XAtom::cardinal,
 263                          (unsigned long)_active_desktop))
 264     _active_desktop = 0;  // there must be at least one desktop, and it must
 265                           // be the current one
 266 }
 267
 268
 269 void screen::updateClientList() {
 270   assert(_managed);
 271
 272   WindowList::iterator insert_point = _active;
 273   if (insert_point != _clients.end())
 274     ++insert_point; // get to the item client the focused client
 275
 276   // get the client list from the root window
 277   Window *rootclients = 0;
 278   unsigned long num = (unsigned) -1;
 279   if (! _xatom->getValue(_root, XAtom::net_client_list, XAtom::window, num,
 280                          &rootclients)) {
 281     while (! _clients.empty()) {
 282       delete _clients.front();
 283       _clients.erase(_clients.begin());
 284     }
 285     if (rootclients) delete [] rootclients;
 286     return;
 287   }
 288
 289   WindowList::iterator it, end = _clients.end();
 290   unsigned long i;
 291
 292   // insert new clients after the active window
 293   for (i = 0; i < num; ++i) {
 294     for (it = _clients.begin(); it != end; ++it)
 295       if (**it == rootclients[i])
 296         break;
 297     if (it == end) {  // didn't already exist
 298       if (doAddWindow(rootclients[i])) {
 299         cout << "Added window: 0x" << hex << rootclients[i] << dec << endl;
 300         _clients.insert(insert_point, new XWindow(_epist, this,
 301                                                   rootclients[i]));
 302       }
 303     }
 304   }
 305
 306   // remove clients that no longer exist
 307   for (it = _clients.begin(); it != end;) {
 308     WindowList::iterator it2 = it++;
 309     for (i = 0; i < num; ++i)
 310       if (**it2 == rootclients[i])
 311         break;
 312     if (i == num)  { // no longer exists
 313       cout << "Removed window: 0x" << hex << (*it2)->window() << dec << endl;
 314       delete *it2;
 315       _clients.erase(it2);
 316     }
 317   }
 318
 319   if (rootclients) delete [] rootclients;
 320 }
 321
 322
 323 void screen::updateActiveWindow() {
 324   assert(_managed);
 325
 326   Window a = None;
 327   _xatom->getValue(_root, XAtom::net_active_window, XAtom::window, a);
 328
 329   WindowList::iterator it, end = _clients.end();
 330   for (it = _clients.begin(); it != end; ++it) {
 331     if (**it == a)
 332       break;
 333   }
 334   _active = it;
 335
 336   cout << "Active window is now: ";
 337   if (_active == _clients.end()) cout << "None\n";
 338   else cout << "0x" << hex << (*_active)->window() << dec << endl;
 339 }
 340
 341 /*
 342  * use this when execing a command to have it on the right screen
 343       string dtmp = (string)"DISPLAY=" + display_name;
 344       if (putenv(const_cast<char*>(dtmp.c_str()))) {
 345         cout << "warning: couldn't set environment variable 'DISPLAY'\n";
 346         perror("putenv()");
 347       }
 348  */
 349
 350
 351 void screen::cycleWindow(const bool forward, const bool alldesktops,
 352                          const bool sameclass) const {
 353   assert(_managed);
 354
 355   if (_clients.empty()) return;
 356
 357   WindowList::const_iterator target = _active;
 358
 359   if (target == _clients.end())
 360     target = _clients.begin();
 361
 362   do {
 363     if (forward) {
 364       ++target;
 365       if (target == _clients.end())
 366         target = _clients.begin();
 367     } else {
 368       if (target == _clients.begin())
 369         target = _clients.end();
 370       --target;
 371     }
 372   } while (target == _clients.end() ||
 373            (*target)->iconic() ||
 374            (! alldesktops && (*target)->desktop() != _active_desktop) ||
 375            (sameclass && _active != _clients.end() &&
 376             (*target)->appClass() != (*_active)->appClass()));
 377
 378   if (target != _clients.end())
 379     (*target)->focus();
 380 }
 381
 382
 383 void screen::cycleWorkspace(const bool forward, const bool loop) const {
 384   assert(_managed);
 385
 386   unsigned int destination = _active_desktop;
 387
 388   if (forward) {
 389     if (destination < _num_desktops - 1)
 390       ++destination;
 391     else if (loop)
 392       destination = 0;
 393   } else {
 394     if (destination > 0)
 395       --destination;
 396     else if (loop)
 397       destination = _num_desktops - 1;
 398   }
 399
 400   if (destination != _active_desktop)
 401     changeWorkspace(destination);
 402 }
 403
 404
 405 void screen::changeWorkspace(const int num) const {
 406   assert(_managed);
 407
 408   _xatom->sendClientMessage(_root, XAtom::net_current_desktop, _root, num);
 409 }