src/Workspace.cc

   1 // Workspace.cc for Openbox
   2 // Copyright (c) 2002 - 2002 Ben Jansens (ben@orodu.net)
   3 // Copyright (c) 2001 Sean 'Shaleh' Perry <shaleh@debian.org>
   4 // Copyright (c) 1997 - 2000 Brad Hughes (bhughes@tcac.net)
   5 //
   6 // Permission is hereby granted, free of charge, to any person obtaining a
   7 // copy of this software and associated documentation files (the "Software"),
   8 // to deal in the Software without restriction, including without limitation
   9 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10 // and/or sell copies of the Software, and to permit persons to whom the
  11 // Software is furnished to do so, subject to the following conditions:
  12 //
  13 // The above copyright notice and this permission notice shall be included in
  14 // all copies or substantial portions of the Software.
  15 //
  16 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  19 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  21 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  22 // DEALINGS IN THE SOFTWARE.
  23
  24 // stupid macros needed to access some functions in version 2 of the GNU C
  25 // library
  26 #ifndef   _GNU_SOURCE
  27 #define   _GNU_SOURCE
  28 #endif // _GNU_SOURCE
  29
  30 #ifdef    HAVE_CONFIG_H
  31 #  include "../config.h"
  32 #endif // HAVE_CONFIG_H
  33
  34 #include <X11/Xlib.h>
  35 #include <X11/Xatom.h>
  36
  37 #include "i18n.h"
  38 #include "openbox.h"
  39 #include "Clientmenu.h"
  40 #include "Screen.h"
  41 #include "Toolbar.h"
  42 #include "Window.h"
  43 #include "Workspace.h"
  44
  45 #include "Windowmenu.h"
  46 #include "Geometry.h"
  47 #include "Util.h"
  48
  49 #ifdef    HAVE_STDIO_H
  50 #  include <stdio.h>
  51 #endif // HAVE_STDIO_H
  52
  53 #ifdef    HAVE_STDLIB_H
  54 #  include <stdlib.h>
  55 #endif // HAVE_STDLIB_H
  56
  57 #ifdef    HAVE_STRING_H
  58 #  include <string.h>
  59 #endif // HAVE_STRING_H
  60
  61 #include <vector>
  62 typedef vector<Rect> rectList;
  63
  64 Workspace::Workspace(BScreen &scrn, int i) : screen(scrn) {
  65
  66   cascade_x = cascade_y = 32;
  67
  68   id = i;
  69
  70   stackingList = new LinkedList<OpenboxWindow>;
  71   windowList = new LinkedList<OpenboxWindow>;
  72   clientmenu = new Clientmenu(*this);
  73
  74   lastfocus = (OpenboxWindow *) 0;
  75
  76   name = (char *) 0;
  77   char *tmp = screen.getNameOfWorkspace(id);
  78   setName(tmp);
  79 }
  80
  81
  82 Workspace::~Workspace(void) {
  83   delete stackingList;
  84   delete windowList;
  85   delete clientmenu;
  86
  87   if (name)
  88     delete [] name;
  89 }
  90
  91
  92 const int Workspace::addWindow(OpenboxWindow *w, Bool place) {
  93   if (! w) return -1;
  94
  95   if (place) placeWindow(w);
  96
  97   w->setWorkspace(id);
  98   w->setWindowNumber(windowList->count());
  99
 100   stackingList->insert(w, 0);
 101   windowList->insert(w);
 102
 103   clientmenu->insert((const char **) w->getTitle());
 104   clientmenu->update();
 105
 106   screen.updateNetizenWindowAdd(w->getClientWindow(), id);
 107
 108   raiseWindow(w);
 109
 110   return w->getWindowNumber();
 111 }
 112
 113
 114 const int Workspace::removeWindow(OpenboxWindow *w) {
 115   if (! w) return -1;
 116
 117   stackingList->remove(w);
 118
 119   if (w->isFocused()) {
 120     if (w->isTransient() && w->getTransientFor() &&
 121         w->getTransientFor()->isVisible()) {
 122       w->getTransientFor()->setInputFocus();
 123     } else if (screen.isSloppyFocus()) {
 124       screen.getOpenbox().setFocusedWindow((OpenboxWindow *) 0);
 125     } else {
 126       OpenboxWindow *top = stackingList->first();
 127       if (! top || ! top->setInputFocus()) {
 128         screen.getOpenbox().setFocusedWindow((OpenboxWindow *) 0);
 129         XSetInputFocus(screen.getOpenbox().getXDisplay(),
 130                        screen.getToolbar()->getWindowID(),
 131                        RevertToParent, CurrentTime);
 132       }
 133     }
 134   }
 135
 136   if (lastfocus == w)
 137     lastfocus = (OpenboxWindow *) 0;
 138
 139   windowList->remove(w->getWindowNumber());
 140   clientmenu->remove(w->getWindowNumber());
 141   clientmenu->update();
 142
 143   screen.updateNetizenWindowDel(w->getClientWindow());
 144
 145   LinkedListIterator<OpenboxWindow> it(windowList);
 146   OpenboxWindow *bw = it.current();
 147   for (int i = 0; bw; it++, i++, bw = it.current())
 148     bw->setWindowNumber(i);
 149
 150   return windowList->count();
 151 }
 152
 153
 154 void Workspace::showAll(void) {
 155   LinkedListIterator<OpenboxWindow> it(stackingList);
 156   for (OpenboxWindow *bw = it.current(); bw; it++, bw = it.current())
 157     bw->deiconify(False, False);
 158 }
 159
 160
 161 void Workspace::hideAll(void) {
 162   LinkedList<OpenboxWindow> lst;
 163
 164   LinkedListIterator<OpenboxWindow> it(stackingList);
 165   for (OpenboxWindow *bw = it.current(); bw; it++, bw = it.current())
 166     lst.insert(bw, 0);
 167
 168   LinkedListIterator<OpenboxWindow> it2(&lst);
 169   for (OpenboxWindow *bw = it2.current(); bw; it2++, bw = it2.current())
 170     if (! bw->isStuck())
 171       bw->withdraw();
 172 }
 173
 174
 175 void Workspace::removeAll(void) {
 176   LinkedListIterator<OpenboxWindow> it(windowList);
 177   for (OpenboxWindow *bw = it.current(); bw; it++, bw = it.current())
 178     bw->iconify();
 179 }
 180
 181
 182 void Workspace::raiseWindow(OpenboxWindow *w) {
 183   OpenboxWindow *win = (OpenboxWindow *) 0, *bottom = w;
 184
 185   while (bottom->isTransient() && bottom->getTransientFor())
 186     bottom = bottom->getTransientFor();
 187
 188   int i = 1;
 189   win = bottom;
 190   while (win->hasTransient() && win->getTransient()) {
 191     win = win->getTransient();
 192
 193     i++;
 194   }
 195
 196   Window *nstack = new Window[i], *curr = nstack;
 197   Workspace *wkspc;
 198
 199   win = bottom;
 200   while (True) {
 201     *(curr++) = win->getFrameWindow();
 202     screen.updateNetizenWindowRaise(win->getClientWindow());
 203
 204     if (! win->isIconic()) {
 205       wkspc = screen.getWorkspace(win->getWorkspaceNumber());
 206       wkspc->stackingList->remove(win);
 207       wkspc->stackingList->insert(win, 0);
 208     }
 209
 210     if (! win->hasTransient() || ! win->getTransient())
 211       break;
 212
 213     win = win->getTransient();
 214   }
 215
 216   screen.raiseWindows(nstack, i);
 217
 218   delete [] nstack;
 219 }
 220
 221
 222 void Workspace::lowerWindow(OpenboxWindow *w) {
 223   OpenboxWindow *win = (OpenboxWindow *) 0, *bottom = w;
 224
 225   while (bottom->isTransient() && bottom->getTransientFor())
 226     bottom = bottom->getTransientFor();
 227
 228   int i = 1;
 229   win = bottom;
 230   while (win->hasTransient() && win->getTransient()) {
 231     win = win->getTransient();
 232
 233     i++;
 234   }
 235
 236   Window *nstack = new Window[i], *curr = nstack;
 237   Workspace *wkspc;
 238
 239   while (True) {
 240     *(curr++) = win->getFrameWindow();
 241     screen.updateNetizenWindowLower(win->getClientWindow());
 242
 243     if (! win->isIconic()) {
 244       wkspc = screen.getWorkspace(win->getWorkspaceNumber());
 245       wkspc->stackingList->remove(win);
 246       wkspc->stackingList->insert(win);
 247     }
 248
 249     if (! win->getTransientFor())
 250       break;
 251
 252     win = win->getTransientFor();
 253   }
 254
 255   screen.getOpenbox().grab();
 256
 257   XLowerWindow(screen.getBaseDisplay().getXDisplay(), *nstack);
 258   XRestackWindows(screen.getBaseDisplay().getXDisplay(), nstack, i);
 259
 260   screen.getOpenbox().ungrab();
 261
 262   delete [] nstack;
 263 }
 264
 265
 266 void Workspace::reconfigure(void) {
 267   clientmenu->reconfigure();
 268
 269   LinkedListIterator<OpenboxWindow> it(windowList);
 270   for (OpenboxWindow *bw = it.current(); bw; it++, bw = it.current()) {
 271     if (bw->validateClient())
 272       bw->reconfigure();
 273   }
 274 }
 275
 276
 277 OpenboxWindow *Workspace::getWindow(int index) {
 278   if ((index >= 0) && (index < windowList->count()))
 279     return windowList->find(index);
 280   else
 281     return 0;
 282 }
 283
 284
 285 const int Workspace::getCount(void) {
 286   return windowList->count();
 287 }
 288
 289
 290 void Workspace::update(void) {
 291   clientmenu->update();
 292   screen.getToolbar()->redrawWindowLabel(True);
 293 }
 294
 295
 296 Bool Workspace::isCurrent(void) {
 297   return (id == screen.getCurrentWorkspaceID());
 298 }
 299
 300
 301 Bool Workspace::isLastWindow(OpenboxWindow *w) {
 302   return (w == windowList->last());
 303 }
 304
 305 void Workspace::setCurrent(void) {
 306   screen.changeWorkspaceID(id);
 307 }
 308
 309
 310 void Workspace::setName(char *new_name) {
 311   if (name)
 312     delete [] name;
 313
 314   if (new_name) {
 315     name = bstrdup(new_name);
 316   } else {
 317     name = new char[128];
 318     sprintf(name, i18n->getMessage(WorkspaceSet, WorkspaceDefaultNameFormat,
 319                                    "Workspace %d"), id + 1);
 320   }
 321
 322   clientmenu->setLabel(name);
 323   clientmenu->update();
 324 }
 325
 326
 327 void Workspace::shutdown(void) {
 328   while (windowList->count()) {
 329     windowList->first()->restore();
 330     delete windowList->first();
 331   }
 332 }
 333
 334 static rectList calcSpace(const OpenboxWindow &win, const rectList &spaces) {
 335   rectList result;
 336   rectList::const_iterator siter;
 337   for(siter=spaces.begin(); siter!=spaces.end(); ++siter) {
 338     if(win.area().Intersect(*siter)) {
 339       //Check for space to the left of the window
 340       if(win.origin().x() > siter->x())
 341         result.push_back(Rect(siter->x(), siter->y(),
 342                               win.origin().x() - siter->x() - 1,
 343                               siter->h()));
 344       //Check for space above the window
 345       if(win.origin().y() > siter->y())
 346         result.push_back(Rect(siter->x(), siter->y(),
 347                               siter->w(),
 348                               win.origin().y() - siter->y() - 1));
 349       //Check for space to the right of the window
 350       if((win.origin().x()+win.size().w()) <
 351          (siter->x()+siter->w()))
 352         result.push_back(Rect(win.origin().x() + win.size().w() + 1,
 353                               siter->y(),
 354                               siter->x() + siter->w() -
 355                               win.origin().x() - win.size().w() - 1,
 356                               siter->h()));
 357       //Check for space below the window
 358       if((win.origin().y()+win.size().h()) <
 359          (siter->y()+siter->h()))
 360         result.push_back(Rect(siter->x(),
 361                               win.origin().y() + win.size().h() + 1,
 362                               siter->w(),
 363                               siter->y() + siter->h()-
 364                               win.origin().y() - win.size().h() - 1));
 365
 366     }
 367     else
 368       result.push_back(*siter);
 369   }
 370   return result;
 371 }
 372
 373 //BestFitPlacement finds the smallest free space that fits the window
 374 //to be placed. It currentl ignores whether placement is right to left or top
 375 //to bottom.
 376 Point *Workspace::bestFitPlacement(const Size &win_size, const Rect &space)
 377 {
 378   const Rect *best;
 379   rectList spaces;
 380   LinkedListIterator<OpenboxWindow> it(windowList);
 381   rectList::const_iterator siter;
 382   spaces.push_back(space); //initially the entire screen is free
 383   it.reset();
 384
 385   //Find Free Spaces
 386   for (OpenboxWindow *cur=it.current(); cur!=NULL; it++, cur=it.current())
 387      spaces = calcSpace(*cur, spaces);
 388
 389   //Find first space that fits the window
 390   best = NULL;
 391   for (siter=spaces.begin(); siter!=spaces.end(); ++siter) {
 392     if ((siter->w() >= win_size.w()) &&
 393         (siter->h() >= win_size.h()))
 394       best = siter;
 395   }
 396
 397   if (best != NULL)
 398     return new Point(best->origin());
 399   else
 400     return NULL; //fall back to cascade
 401 }
 402
 403 inline Point *Workspace::rowSmartPlacement(const Size &win_size,
 404                                            const Rect &space){
 405   bool placed=false;
 406   int test_x, test_y, place_x = 0, place_y = 0;
 407   int start_pos = 0;
 408   int change_y =
 409      ((screen.getColPlacementDirection() == BScreen::TopBottom) ? 1 : -1);
 410   int change_x =
 411      ((screen.getRowPlacementDirection() == BScreen::LeftRight) ? 1 : -1);
 412   int delta_x = 8, delta_y = 8;
 413   LinkedListIterator<OpenboxWindow> it(windowList);
 414
 415   test_y = (screen.getColPlacementDirection() == BScreen::TopBottom) ?
 416     start_pos : screen.size().h() - win_size.h() - start_pos;
 417
 418   while(!placed &&
 419         ((screen.getColPlacementDirection() == BScreen::BottomTop) ?
 420          test_y > 0 : test_y + win_size.h() < (signed) space.h())) {
 421     test_x = (screen.getRowPlacementDirection() == BScreen::LeftRight) ?
 422       start_pos : space.w() - win_size.w() - start_pos;
 423     while (!placed &&
 424            ((screen.getRowPlacementDirection() == BScreen::RightLeft) ?
 425             test_x > 0 : test_x + win_size.w() < (signed) space.w())) {
 426       placed = true;
 427
 428       it.reset();
 429       for (OpenboxWindow *curr = it.current(); placed && curr;
 430            it++, curr = it.current()) {
 431         int curr_w = curr->size().w() + (screen.getBorderWidth() * 4);
 432         int curr_h = curr->size().h() + (screen.getBorderWidth() * 4);
 433
 434         if (curr->origin().x() < test_x + win_size.w() &&
 435             curr->origin().x() + curr_w > test_x &&
 436             curr->origin().y() < test_y + win_size.h() &&
 437             curr->origin().y() + curr_h > test_y) {
 438           placed = false;
 439         }
 440       }
 441
 442       // Removed code for checking toolbar and slit
 443       // The space passed in should not include either
 444
 445       if (placed) {
 446         place_x = test_x;
 447         place_y = test_y;
 448
 449         break;
 450       }
 451
 452       test_x += (change_x * delta_x);
 453     }
 454
 455     test_y += (change_y * delta_y);
 456   }
 457   if (placed)
 458     return new Point(place_x, place_y);
 459   else
 460     return NULL; // fall back to cascade
 461 }
 462
 463 inline Point * Workspace::colSmartPlacement(const Size &win_size,
 464                                             const Rect &space){
 465   Point *pt;
 466   bool placed=false;
 467   int test_x, test_y;
 468   int start_pos = 0;
 469   int change_y =
 470     ((screen.getColPlacementDirection() == BScreen::TopBottom) ? 1 : -1);
 471   int change_x =
 472     ((screen.getRowPlacementDirection() == BScreen::LeftRight) ? 1 : -1);
 473   int delta_x = 8, delta_y = 8;
 474   LinkedListIterator<OpenboxWindow> it(windowList);
 475
 476   test_x = (screen.getRowPlacementDirection() == BScreen::LeftRight) ?
 477     start_pos : screen.size().w() - win_size.w() - start_pos;
 478
 479   while(!placed &&
 480         ((screen.getRowPlacementDirection() == BScreen::RightLeft) ?
 481          test_x > 0 : test_x + win_size.w() < (signed) space.w())) {
 482     test_y = (screen.getColPlacementDirection() == BScreen::TopBottom) ?
 483       start_pos : screen.size().h() - win_size.h() - start_pos;
 484
 485     while(!placed &&
 486           ((screen.getColPlacementDirection() == BScreen::BottomTop) ?
 487            test_y > 0 : test_y + win_size.h() < (signed) space.h())){
 488
 489       placed = true;
 490
 491       it.reset();
 492       for (OpenboxWindow *curr = it.current(); placed && curr;
 493            it++, curr = it.current()) {
 494         int curr_w = curr->size().w() + (screen.getBorderWidth() * 4);
 495         int curr_h = curr->size().h() + (screen.getBorderWidth() * 4);
 496
 497         if (curr->origin().x() < test_x + win_size.w() &&
 498             curr->origin().x() + curr_w > test_x &&
 499             curr->origin().y() < test_y + win_size.h() &&
 500             curr->origin().y() + curr_h > test_y) {
 501           placed = False;
 502         }
 503       }
 504
 505       // Removed code checking for intersection with Toolbar and Slit
 506       // The space passed to this method should not include either
 507
 508       if (placed) {
 509         pt= new Point(test_x,test_y);
 510
 511         break;
 512       }
 513
 514       test_y += (change_y * delta_y);
 515     }
 516
 517     test_x += (change_x * delta_x);
 518   }
 519   if (placed)
 520     return pt;
 521   else
 522     return NULL;
 523 }
 524
 525 Point *const Workspace::cascadePlacement(const OpenboxWindow *const win){
 526   if (((unsigned) cascade_x > (screen.size().w() / 2)) ||
 527       ((unsigned) cascade_y > (screen.size().h() / 2)))
 528     cascade_x = cascade_y = 32;
 529
 530   cascade_x += win->getTitleHeight();
 531   cascade_y += win->getTitleHeight();
 532
 533   return new Point(cascade_x, cascade_y);
 534 }
 535
 536
 537 void Workspace::placeWindow(OpenboxWindow *win) {
 538   ASSERT(win != NULL);
 539
 540   const int win_w = win->size().w() + (screen.getBorderWidth() * 4),
 541     win_h = win->size().h() + (screen.getBorderWidth() * 4),
 542 #ifdef    SLIT
 543     slit_x = screen.getSlit()->area().x() - screen.getBorderWidth(),
 544     slit_y = screen.getSlit()->area().y() - screen.getBorderWidth(),
 545     slit_w = screen.getSlit()->area().w() +
 546       (screen.getBorderWidth() * 4),
 547     slit_h = screen.getSlit()->area().h() +
 548       (screen.getBorderWidth() * 4),
 549 #endif // SLIT
 550     toolbar_x = screen.getToolbar()->getX() - screen.getBorderWidth(),
 551     toolbar_y = screen.getToolbar()->getY() - screen.getBorderWidth(),
 552     toolbar_w = screen.getToolbar()->getWidth() +
 553       (screen.getBorderWidth() * 4),
 554     toolbar_h = screen.getToolbar()->getHeight() +
 555       (screen.getBorderWidth() * 4),
 556     start_pos = 0,
 557     change_y =
 558       ((screen.getColPlacementDirection() == BScreen::TopBottom) ? 1 : -1),
 559     change_x =
 560       ((screen.getRowPlacementDirection() == BScreen::LeftRight) ? 1 : -1),
 561     delta_x = 8, delta_y = 8;
 562
 563   LinkedListIterator<OpenboxWindow> it(windowList);
 564
 565   Rect space(0, 0,
 566              screen.size().w(),
 567              screen.size().h()
 568             );
 569   Size window_size(win->size().w()+screen.getBorderWidth() * 4,
 570                    win->size().h()+screen.getBorderWidth() * 4);
 571   Point *place = NULL;
 572
 573   switch (screen.getPlacementPolicy()) {
 574   case BScreen::BestFitPlacement:
 575     place = bestFitPlacement(window_size, space);
 576     break;
 577   case BScreen::RowSmartPlacement:
 578     place = rowSmartPlacement(window_size, space);
 579     break;
 580   case BScreen::ColSmartPlacement:
 581     place = colSmartPlacement(window_size, space);
 582     break;
 583   } // switch
 584
 585   if (place == NULL)
 586     place = cascadePlacement(win);
 587
 588   ASSERT(place != NULL);
 589   if (place->x() + win_w > (signed) screen.size().w())
 590     place->setX(((signed) screen.size().w() - win_w) / 2);
 591   if (place->y() + win_h > (signed) screen.size().h())
 592     place->setY(((signed) screen.size().h() - win_h) / 2);
 593
 594   win->configure(place->x(), place->y(), win->size().w(), win->size().h());
 595   delete place;
 596 }