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.sloppyFocus()) {
 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   screen.saveWorkspaceNames();
 325 }
 326
 327
 328 void Workspace::shutdown(void) {
 329   while (windowList->count()) {
 330     windowList->first()->restore();
 331     delete windowList->first();
 332   }
 333 }
 334
 335 static rectList calcSpace(const Rect &win, const rectList &spaces) {
 336   rectList result;
 337   rectList::const_iterator siter;
 338   for(siter=spaces.begin(); siter!=spaces.end(); ++siter) {
 339     if(win.Intersect(*siter)) {
 340       //Check for space to the left of the window
 341       if(win.origin().x() > siter->x())
 342         result.push_back(Rect(siter->x(), siter->y(),
 343                               win.origin().x() - siter->x() - 1,
 344                               siter->h()));
 345       //Check for space above the window
 346       if(win.origin().y() > siter->y())
 347         result.push_back(Rect(siter->x(), siter->y(),
 348                               siter->w(),
 349                               win.origin().y() - siter->y() - 1));
 350       //Check for space to the right of the window
 351       if((win.origin().x()+win.size().w()) <
 352          (siter->x()+siter->w()))
 353         result.push_back(Rect(win.origin().x() + win.size().w() + 1,
 354                               siter->y(),
 355                               siter->x() + siter->w() -
 356                               win.origin().x() - win.size().w() - 1,
 357                               siter->h()));
 358       //Check for space below the window
 359       if((win.origin().y()+win.size().h()) <
 360          (siter->y()+siter->h()))
 361         result.push_back(Rect(siter->x(),
 362                               win.origin().y() + win.size().h() + 1,
 363                               siter->w(),
 364                               siter->y() + siter->h()-
 365                               win.origin().y() - win.size().h() - 1));
 366
 367     }
 368     else
 369       result.push_back(*siter);
 370   }
 371   return result;
 372 }
 373
 374 //BestFitPlacement finds the smallest free space that fits the window
 375 //to be placed. It currentl ignores whether placement is right to left or top
 376 //to bottom.
 377 Point *Workspace::bestFitPlacement(const Size &win_size, const Rect &space)
 378 {
 379   const Rect *best;
 380   rectList spaces;
 381   LinkedListIterator<OpenboxWindow> it(windowList);
 382   rectList::const_iterator siter;
 383   spaces.push_back(space); //initially the entire screen is free
 384   it.reset();
 385
 386   //Find Free Spaces
 387   for (OpenboxWindow *cur=it.current(); cur!=NULL; it++, cur=it.current())
 388      spaces = calcSpace(cur->area().Inflate(screen.getBorderWidth() * 4),
 389                         spaces);
 390
 391   //Find first space that fits the window
 392   best = NULL;
 393   for (siter=spaces.begin(); siter!=spaces.end(); ++siter) {
 394     if ((siter->w() >= win_size.w()) &&
 395         (siter->h() >= win_size.h()))
 396       best = siter;
 397   }
 398
 399   if (best != NULL)
 400     return new Point(best->origin());
 401   else
 402     return NULL; //fall back to cascade
 403 }
 404
 405 inline Point *Workspace::rowSmartPlacement(const Size &win_size,
 406                                            const Rect &space){
 407   bool placed=false;
 408   int test_x, test_y, place_x = 0, place_y = 0;
 409   int start_pos = 0;
 410   int change_y =
 411      ((screen.colPlacementDirection() == BScreen::TopBottom) ? 1 : -1);
 412   int change_x =
 413      ((screen.rowPlacementDirection() == BScreen::LeftRight) ? 1 : -1);
 414   int delta_x = 8, delta_y = 8;
 415   LinkedListIterator<OpenboxWindow> it(windowList);
 416
 417   test_y = (screen.colPlacementDirection() == BScreen::TopBottom) ?
 418     start_pos : screen.size().h() - win_size.h() - start_pos;
 419
 420   while(!placed &&
 421         ((screen.colPlacementDirection() == BScreen::BottomTop) ?
 422          test_y > 0 : test_y + win_size.h() < (signed) space.h())) {
 423     test_x = (screen.rowPlacementDirection() == BScreen::LeftRight) ?
 424       start_pos : space.w() - win_size.w() - start_pos;
 425     while (!placed &&
 426            ((screen.rowPlacementDirection() == BScreen::RightLeft) ?
 427             test_x > 0 : test_x + win_size.w() < (signed) space.w())) {
 428       placed = true;
 429
 430       it.reset();
 431       for (OpenboxWindow *curr = it.current(); placed && curr;
 432            it++, curr = it.current()) {
 433         int curr_w = curr->size().w() + (screen.getBorderWidth() * 4);
 434         int curr_h = curr->size().h() + (screen.getBorderWidth() * 4);
 435
 436         if (curr->origin().x() < test_x + win_size.w() &&
 437             curr->origin().x() + curr_w > test_x &&
 438             curr->origin().y() < test_y + win_size.h() &&
 439             curr->origin().y() + curr_h > test_y) {
 440           placed = false;
 441         }
 442       }
 443
 444       // Removed code for checking toolbar and slit
 445       // The space passed in should not include either
 446
 447       if (placed) {
 448         place_x = test_x;
 449         place_y = test_y;
 450
 451         break;
 452       }
 453
 454       test_x += (change_x * delta_x);
 455     }
 456
 457     test_y += (change_y * delta_y);
 458   }
 459   if (placed)
 460     return new Point(place_x, place_y);
 461   else
 462     return NULL; // fall back to cascade
 463 }
 464
 465 inline Point * Workspace::colSmartPlacement(const Size &win_size,
 466                                             const Rect &space){
 467   Point *pt;
 468   bool placed=false;
 469   int test_x, test_y;
 470   int start_pos = 0;
 471   int change_y =
 472     ((screen.colPlacementDirection() == BScreen::TopBottom) ? 1 : -1);
 473   int change_x =
 474     ((screen.rowPlacementDirection() == BScreen::LeftRight) ? 1 : -1);
 475   int delta_x = 8, delta_y = 8;
 476   LinkedListIterator<OpenboxWindow> it(windowList);
 477
 478   test_x = (screen.rowPlacementDirection() == BScreen::LeftRight) ?
 479     start_pos : screen.size().w() - win_size.w() - start_pos;
 480
 481   while(!placed &&
 482         ((screen.rowPlacementDirection() == BScreen::RightLeft) ?
 483          test_x > 0 : test_x + win_size.w() < (signed) space.w())) {
 484     test_y = (screen.colPlacementDirection() == BScreen::TopBottom) ?
 485       start_pos : screen.size().h() - win_size.h() - start_pos;
 486
 487     while(!placed &&
 488           ((screen.colPlacementDirection() == BScreen::BottomTop) ?
 489            test_y > 0 : test_y + win_size.h() < (signed) space.h())){
 490
 491       placed = true;
 492
 493       it.reset();
 494       for (OpenboxWindow *curr = it.current(); placed && curr;
 495            it++, curr = it.current()) {
 496         int curr_w = curr->size().w() + (screen.getBorderWidth() * 4);
 497         int curr_h = curr->size().h() + (screen.getBorderWidth() * 4);
 498
 499         if (curr->origin().x() < test_x + win_size.w() &&
 500             curr->origin().x() + curr_w > test_x &&
 501             curr->origin().y() < test_y + win_size.h() &&
 502             curr->origin().y() + curr_h > test_y) {
 503           placed = False;
 504         }
 505       }
 506
 507       // Removed code checking for intersection with Toolbar and Slit
 508       // The space passed to this method should not include either
 509
 510       if (placed) {
 511         pt= new Point(test_x,test_y);
 512
 513         break;
 514       }
 515
 516       test_y += (change_y * delta_y);
 517     }
 518
 519     test_x += (change_x * delta_x);
 520   }
 521   if (placed)
 522     return pt;
 523   else
 524     return NULL;
 525 }
 526
 527 Point *const Workspace::cascadePlacement(const OpenboxWindow *const win){
 528   if (((unsigned) cascade_x > (screen.size().w() / 2)) ||
 529       ((unsigned) cascade_y > (screen.size().h() / 2)))
 530     cascade_x = cascade_y = 32;
 531
 532   cascade_x += win->getTitleHeight();
 533   cascade_y += win->getTitleHeight();
 534
 535   return new Point(cascade_x, cascade_y);
 536 }
 537
 538
 539 void Workspace::placeWindow(OpenboxWindow *win) {
 540   ASSERT(win != NULL);
 541
 542   // the following code is temporary and will be taken care of by Screen in the
 543   // future (with the NETWM 'strut')
 544   Rect space(0, 0, screen.size().w(), screen.size().h());
 545
 546 #ifdef    SLIT
 547   Slit *slit = screen.getSlit();
 548   int remove;   // 0 - top/2 - right/2 - bottom/3 - left
 549   if ((slit->direction() == Slit::Horizontal &&
 550        (slit->placement() == Slit::TopLeft ||
 551         slit->placement() == Slit::TopRight)) ||
 552       slit->placement() == Slit::TopCenter)
 553     // exclude top
 554     space.setY(slit->area().h() + screen.getBorderWidth() * 2);
 555   else if ((slit->direction() == Slit::Vertical &&
 556             (slit->placement() == Slit::TopRight ||
 557              slit->placement() == Slit::BottomRight)) ||
 558            slit->placement() == Slit::CenterRight)
 559     // exclude right
 560     space.setW(screen.size().w() -
 561                (slit->area().w() + screen.getBorderWidth() * 2));
 562   else if ((slit->direction() == Slit::Horizontal &&
 563             (slit->placement() == Slit::BottomLeft ||
 564              slit->placement() == Slit::BottomRight)) ||
 565            slit->placement() == Slit::TopCenter)
 566     // exclude bottom
 567     space.setH(screen.size().h() -
 568                (slit->area().h() + screen.getBorderWidth() * 2));
 569   else// if ((slit->direction() == Slit::Vertical &&
 570       //      (slit->placement() == Slit::TopLeft ||
 571       //       slit->placement() == Slit::BottomLeft)) ||
 572       //     slit->placement() == Slit::CenterLeft)
 573     // exclude left
 574     space.setX(slit->area().w() + screen.getBorderWidth() * 2);
 575 #endif
 576
 577   Toolbar *toolbar = screen.getToolbar();
 578   int tbarh = screen.hideToolbar() ? 0 :
 579     toolbar->getExposedHeight() + screen.getBorderWidth() * 2;
 580   switch (toolbar->placement()) {
 581   case Toolbar::TopLeft:
 582   case Toolbar::TopCenter:
 583   case Toolbar::TopRight:
 584     if (tbarh > space.y())
 585       space.setY(toolbar->getExposedHeight());
 586     break;
 587   case Toolbar::BottomLeft:
 588   case Toolbar::BottomCenter:
 589   case Toolbar::BottomRight:
 590     if (screen.size().h() - tbarh < space.h())
 591       space.setH(screen.size().h() - tbarh);
 592     break;
 593   default:
 594     ASSERT(false);      // unhandled placement
 595   }
 596
 597   const int win_w = win->size().w() + (screen.getBorderWidth() * 4),
 598     win_h = win->size().h() + (screen.getBorderWidth() * 4),
 599     start_pos = 0,
 600     change_y =
 601       ((screen.colPlacementDirection() == BScreen::TopBottom) ? 1 : -1),
 602     change_x =
 603       ((screen.rowPlacementDirection() == BScreen::LeftRight) ? 1 : -1),
 604     delta_x = 8, delta_y = 8;
 605
 606   LinkedListIterator<OpenboxWindow> it(windowList);
 607
 608   Size window_size(win->size().w()+screen.getBorderWidth() * 4,
 609                    win->size().h()+screen.getBorderWidth() * 4);
 610   Point *place = NULL;
 611
 612   switch (screen.placementPolicy()) {
 613   case BScreen::BestFitPlacement:
 614     place = bestFitPlacement(window_size, space);
 615     break;
 616   case BScreen::RowSmartPlacement:
 617     place = rowSmartPlacement(window_size, space);
 618     break;
 619   case BScreen::ColSmartPlacement:
 620     place = colSmartPlacement(window_size, space);
 621     break;
 622   } // switch
 623
 624   if (place == NULL)
 625     place = cascadePlacement(win);
 626
 627   ASSERT(place != NULL);
 628   if (place->x() + win_w > (signed) screen.size().w())
 629     place->setX(((signed) screen.size().w() - win_w) / 2);
 630   if (place->y() + win_h > (signed) screen.size().h())
 631     place->setY(((signed) screen.size().h() - win_h) / 2);
 632
 633   win->configure(place->x(), place->y(), win->size().w(), win->size().h());
 634   delete place;
 635 }