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_STDIO_H
  29 #  include <stdio.h>
  30 #endif // HAVE_STDIO_H
  31
  32 #ifdef    HAVE_UNISTD_H
  33 #  include <sys/types.h>
  34 #  include <unistd.h>
  35 #endif // HAVE_UNISTD_H
  36 }
  37
  38 #include <iostream>
  39 #include <string>
  40
  41 using std::cout;
  42 using std::endl;
  43 using std::hex;
  44 using std::dec;
  45 using std::string;
  46
  47 #include "../../src/BaseDisplay.hh"
  48 #include "../../src/XAtom.hh"
  49 #include "screen.hh"
  50 #include "epist.hh"
  51
  52
  53 screen::screen(epist *epist, int number) {
  54   _epist = epist;
  55   _xatom = _epist->xatom();
  56   _number = number;
  57   _active = _clients.end();
  58   _info = _epist->getScreenInfo(_number);
  59   _root = _info->getRootWindow();
  60
  61   // find a window manager supporting NETWM, waiting for it to load if we must
  62   int count = 20;  // try for 20 seconds
  63   _managed = false;
  64   while (! (_epist->doShutdown() || _managed || count <= 0)) {
  65     if (! (_managed = findSupportingWM()))
  66       usleep(1000);
  67     --count;
  68   }
  69   if (_managed)
  70     cout << "Found compatible window manager '" << _wm_name << "' for screen "
  71       << _number << ".\n";
  72   else {
  73     cout << "Unable to find a compatible window manager for screen " <<
  74       _number << ".\n";
  75     return;
  76   }
  77
  78   XSelectInput(_epist->getXDisplay(), _root, PropertyChangeMask);
  79
  80   updateNumDesktops();
  81   updateActiveDesktop();
  82   updateClientList();
  83   updateActiveWindow();
  84 }
  85
  86
  87 screen::~screen() {
  88   if (_managed)
  89     XSelectInput(_epist->getXDisplay(), _root, None);
  90 }
  91
  92
  93 bool screen::findSupportingWM() {
  94   Window support_win;
  95   if (! _xatom->getValue(_root, XAtom::net_supporting_wm_check, XAtom::window,
  96                          support_win) || support_win == None)
  97     return false;
  98
  99   string title;
 100   _xatom->getValue(support_win, XAtom::net_wm_name, XAtom::utf8, title);
 101   _wm_name = title;
 102   return true;
 103 }
 104
 105
 106 XWindow *screen::findWindow(const XEvent &e) const {
 107   assert(_managed);
 108
 109   WindowList::const_iterator it, end = _clients.end();
 110   for (it = _clients.begin(); it != end; ++it)
 111     if (**it == e.xany.window)
 112       break;
 113   if(it == end)
 114     return 0;
 115   return *it;
 116 }
 117
 118
 119 void screen::processEvent(const XEvent &e) {
 120   assert(_managed);
 121   assert(e.xany.window == _root);
 122
 123   XWindow *window = 0;
 124   if (e.xany.window != _root) {
 125     window = findWindow(e);  // find the window
 126     assert(window); // we caught an event for a window we don't know about!?
 127   }
 128
 129   switch (e.type) {
 130   case PropertyNotify:
 131     // root window
 132     if (e.xproperty.atom == _xatom->getAtom(XAtom::net_number_of_desktops))
 133       updateNumDesktops();
 134     if (e.xproperty.atom == _xatom->getAtom(XAtom::net_current_desktop))
 135       updateActiveDesktop();
 136     if (e.xproperty.atom == _xatom->getAtom(XAtom::net_active_window))
 137       updateActiveWindow();
 138     if (e.xproperty.atom == _xatom->getAtom(XAtom::net_client_list)) {
 139       // catch any window unmaps first
 140       XEvent ev;
 141       if (XCheckTypedWindowEvent(_epist->getXDisplay(), e.xany.window,
 142                                  DestroyNotify, &ev) ||
 143           XCheckTypedWindowEvent(_epist->getXDisplay(), e.xany.window,
 144                                  UnmapNotify, &ev)) {
 145         processEvent(ev);
 146       }
 147
 148       updateClientList();
 149     }
 150     break;
 151   case KeyPress:
 152     handleKeypress(e);
 153     break;
 154   }
 155 }
 156
 157 void screen::handleKeypress(const XEvent &e) {
 158   ActionList::const_iterator it = _epist->actions().begin();
 159   ActionList::const_iterator end = _epist->actions().end();
 160   for (; it != end; ++it) {
 161     if (e.xkey.keycode == it->keycode() &&
 162         e.xkey.state == it->modifierMask()) {
 163       switch (it->type()) {
 164       case Action::nextWorkspace:
 165         cycleWorkspace(true);
 166         return;
 167
 168       case Action::prevWorkspace:
 169         cycleWorkspace(false);
 170         return;
 171
 172       case Action::nextWindow:
 173         cycleWindow(true);
 174         return;
 175
 176       case Action::prevWindow:
 177         cycleWindow(false);
 178         return;
 179
 180       case Action::nextWindowOnAllWorkspaces:
 181         cycleWindow(true, true);
 182         return;
 183
 184       case Action::prevWindowOnAllWorkspaces:
 185         cycleWindow(false, true);
 186         return;
 187
 188       case Action::nextWindowOfClass:
 189         cycleWindow(true, false, true, it->string());
 190         return;
 191
 192       case Action::prevWindowOfClass:
 193         cycleWindow(false, false, true, it->string());
 194         return;
 195
 196       case Action::nextWindowOfClassOnAllWorkspaces:
 197         cycleWindow(true, true, true, it->string());
 198         return;
 199
 200       case Action::prevWindowOfClassOnAllWorkspaces:
 201         cycleWindow(false, true, true, it->string());
 202         return;
 203
 204       case Action::changeWorkspace:
 205         changeWorkspace(it->number());
 206         return;
 207
 208       case Action::execute:
 209         execCommand(it->string());
 210         return;
 211
 212       default:
 213         break;
 214       }
 215
 216       // these actions require an active window
 217       if (_active != _clients.end()) {
 218         XWindow *window = *_active;
 219
 220         switch (it->type()) {
 221         case Action::iconify:
 222           window->iconify();
 223           return;
 224
 225         case Action::close:
 226           window->close();
 227           return;
 228
 229         case Action::raise:
 230           window->raise();
 231           return;
 232
 233         case Action::lower:
 234           window->lower();
 235           return;
 236
 237         case Action::sendToWorkspace:
 238           window->sendTo(it->number());
 239           return;
 240
 241         case Action::toggleomnipresent:
 242           if (window->desktop() == 0xffffffff)
 243             window->sendTo(_active_desktop);
 244           else
 245             window->sendTo(0xffffffff);
 246           return;
 247
 248         case Action::toggleshade:
 249           window->shade(! window->shaded());
 250           return;
 251
 252         default:
 253           assert(false);  // unhandled action type!
 254           break;
 255         }
 256       }
 257     }
 258   }
 259 }
 260
 261 // do we want to add this window to our list?
 262 bool screen::doAddWindow(Window window) const {
 263   assert(_managed);
 264
 265   Atom type;
 266   if (! _xatom->getValue(window, XAtom::net_wm_window_type, XAtom::atom,
 267                          type))
 268     return True;
 269
 270   if (type == _xatom->getAtom(XAtom::net_wm_window_type_dock) ||
 271       type == _xatom->getAtom(XAtom::net_wm_window_type_menu))
 272     return False;
 273
 274   return True;
 275 }
 276
 277
 278 void screen::updateNumDesktops() {
 279   assert(_managed);
 280
 281   if (! _xatom->getValue(_root, XAtom::net_number_of_desktops, XAtom::cardinal,
 282                          (unsigned long)_num_desktops))
 283     _num_desktops = 1;  // assume that there is at least 1 desktop!
 284 }
 285
 286
 287 void screen::updateActiveDesktop() {
 288   assert(_managed);
 289
 290   if (! _xatom->getValue(_root, XAtom::net_current_desktop, XAtom::cardinal,
 291                          (unsigned long)_active_desktop))
 292     _active_desktop = 0;  // there must be at least one desktop, and it must
 293                           // be the current one
 294 }
 295
 296
 297 void screen::updateClientList() {
 298   assert(_managed);
 299
 300   WindowList::iterator insert_point = _active;
 301   if (insert_point != _clients.end())
 302     ++insert_point; // get to the item client the focused client
 303
 304   // get the client list from the root window
 305   Window *rootclients = 0;
 306   unsigned long num = (unsigned) -1;
 307   if (! _xatom->getValue(_root, XAtom::net_client_list, XAtom::window, num,
 308                          &rootclients)) {
 309     while (! _clients.empty()) {
 310       delete _clients.front();
 311       _clients.erase(_clients.begin());
 312     }
 313     if (rootclients) delete [] rootclients;
 314     return;
 315   }
 316
 317   WindowList::iterator it, end = _clients.end();
 318   unsigned long i;
 319
 320   // insert new clients after the active window
 321   for (i = 0; i < num; ++i) {
 322     for (it = _clients.begin(); it != end; ++it)
 323       if (**it == rootclients[i])
 324         break;
 325     if (it == end) {  // didn't already exist
 326       if (doAddWindow(rootclients[i])) {
 327         cout << "Added window: 0x" << hex << rootclients[i] << dec << endl;
 328         _clients.insert(insert_point, new XWindow(_epist, this,
 329                                                   rootclients[i]));
 330       }
 331     }
 332   }
 333
 334   // remove clients that no longer exist
 335   for (it = _clients.begin(); it != end;) {
 336     WindowList::iterator it2 = it++;
 337     for (i = 0; i < num; ++i)
 338       if (**it2 == rootclients[i])
 339         break;
 340     if (i == num)  { // no longer exists
 341       cout << "Removed window: 0x" << hex << (*it2)->window() << dec << endl;
 342       delete *it2;
 343       _clients.erase(it2);
 344     }
 345   }
 346
 347   if (rootclients) delete [] rootclients;
 348 }
 349
 350
 351 void screen::updateActiveWindow() {
 352   assert(_managed);
 353
 354   Window a = None;
 355   _xatom->getValue(_root, XAtom::net_active_window, XAtom::window, a);
 356
 357   WindowList::iterator it, end = _clients.end();
 358   for (it = _clients.begin(); it != end; ++it) {
 359     if (**it == a)
 360       break;
 361   }
 362   _active = it;
 363
 364   cout << "Active window is now: ";
 365   if (_active == _clients.end()) cout << "None\n";
 366   else cout << "0x" << hex << (*_active)->window() << dec << endl;
 367 }
 368
 369
 370 void screen::execCommand(const std::string &cmd) const {
 371   pid_t pid;
 372   if ((pid = fork()) == 0) {
 373     extern char **environ;
 374
 375     char *const argv[] = {
 376       "sh",
 377       "-c",
 378       const_cast<char *>(cmd.c_str()),
 379       0
 380     };
 381     // make the command run on the correct screen
 382     if (putenv(const_cast<char*>(_info->displayString().c_str()))) {
 383       cout << "warning: couldn't set environment variable 'DISPLAY'\n";
 384       perror("putenv()");
 385     }
 386     execve("/bin/sh", argv, environ);
 387     exit(127);
 388   } else if (pid == -1) {
 389     cout << _epist->getApplicationName() <<
 390       ": Could not fork a process for executing a command\n";
 391   }
 392 }
 393
 394
 395 void screen::cycleWindow(const bool forward, const bool alldesktops,
 396                          const bool sameclass, const string &cn) const {
 397   assert(_managed);
 398
 399   if (_clients.empty()) return;
 400
 401   WindowList::const_iterator target = _active;
 402
 403   string classname = cn;
 404   if (sameclass && classname.empty() && target != _clients.end())
 405     classname = (*target)->appClass();
 406
 407   if (target == _clients.end())
 408     target = _clients.begin();
 409
 410   do {
 411     if (forward) {
 412       ++target;
 413       if (target == _clients.end())
 414         target = _clients.begin();
 415     } else {
 416       if (target == _clients.begin())
 417         target = _clients.end();
 418       --target;
 419     }
 420   } while (target == _clients.end() ||
 421            (*target)->iconic() ||
 422            (! alldesktops && (*target)->desktop() != _active_desktop) ||
 423            (sameclass && ! classname.empty() &&
 424             (*target)->appClass() != classname));
 425
 426   if (target != _clients.end())
 427     (*target)->focus();
 428 }
 429
 430
 431 void screen::cycleWorkspace(const bool forward, const bool loop) const {
 432   assert(_managed);
 433
 434   unsigned int destination = _active_desktop;
 435
 436   if (forward) {
 437     if (destination < _num_desktops - 1)
 438       ++destination;
 439     else if (loop)
 440       destination = 0;
 441   } else {
 442     if (destination > 0)
 443       --destination;
 444     else if (loop)
 445       destination = _num_desktops - 1;
 446   }
 447
 448   if (destination != _active_desktop)
 449     changeWorkspace(destination);
 450 }
 451
 452
 453 void screen::changeWorkspace(const int num) const {
 454   assert(_managed);
 455
 456   _xatom->sendClientMessage(_root, XAtom::net_current_desktop, _root, num);
 457 }