changed external window interface to only have an area(), no size() and origin()...
[mikachu/openbox.git] / 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 #include <algorithm>
63 typedef vector<Rect> rectList;
64
65 Workspace::Workspace(BScreen &scrn, int i) : screen(scrn) {
66
67   cascade_x = cascade_y = 32;
68
69   id = i;
70
71   stackingList = new LinkedList<OpenboxWindow>;
72   windowList = new LinkedList<OpenboxWindow>;
73   clientmenu = new Clientmenu(*this);
74
75   lastfocus = (OpenboxWindow *) 0;
76
77   name = (char *) 0;
78   char *tmp = screen.getNameOfWorkspace(id);
79   setName(tmp);
80 }
81
82
83 Workspace::~Workspace(void) {
84   delete stackingList;
85   delete windowList;
86   delete clientmenu;
87
88   if (name)
89     delete [] name;
90 }
91
92
93 const int Workspace::addWindow(OpenboxWindow *w, Bool place) {
94   if (! w) return -1;
95
96   if (place) placeWindow(w);
97
98   w->setWorkspace(id);
99   w->setWindowNumber(windowList->count());
100
101   stackingList->insert(w, 0);
102   windowList->insert(w);
103
104   clientmenu->insert((const char **) w->getTitle());
105   clientmenu->update();
106
107   screen.updateNetizenWindowAdd(w->getClientWindow(), id);
108
109   raiseWindow(w);
110
111   return w->getWindowNumber();
112 }
113
114
115 const int Workspace::removeWindow(OpenboxWindow *w) {
116   if (! w) return -1;
117
118   stackingList->remove(w);
119
120   if (w->isFocused()) {
121     if (w->isTransient() && w->getTransientFor() &&
122         w->getTransientFor()->isVisible()) {
123       w->getTransientFor()->setInputFocus();
124     } else if (screen.sloppyFocus()) {
125       screen.getOpenbox().setFocusedWindow((OpenboxWindow *) 0);
126     } else {
127       OpenboxWindow *top = stackingList->first();
128       if (! top || ! top->setInputFocus()) {
129         screen.getOpenbox().setFocusedWindow((OpenboxWindow *) 0);
130         XSetInputFocus(screen.getOpenbox().getXDisplay(),
131                        screen.getToolbar()->getWindowID(),
132                        RevertToParent, CurrentTime);
133       }
134     }
135   }
136   
137   if (lastfocus == w)
138     lastfocus = (OpenboxWindow *) 0;
139
140   windowList->remove(w->getWindowNumber());
141   clientmenu->remove(w->getWindowNumber());
142   clientmenu->update();
143
144   screen.updateNetizenWindowDel(w->getClientWindow());
145
146   LinkedListIterator<OpenboxWindow> it(windowList);
147   OpenboxWindow *bw = it.current();
148   for (int i = 0; bw; it++, i++, bw = it.current())
149     bw->setWindowNumber(i);
150
151   return windowList->count();
152 }
153
154
155 void Workspace::showAll(void) {
156   LinkedListIterator<OpenboxWindow> it(stackingList);
157   for (OpenboxWindow *bw = it.current(); bw; it++, bw = it.current())
158     bw->deiconify(False, False);
159 }
160
161
162 void Workspace::hideAll(void) {
163   LinkedList<OpenboxWindow> lst;
164
165   LinkedListIterator<OpenboxWindow> it(stackingList);
166   for (OpenboxWindow *bw = it.current(); bw; it++, bw = it.current())
167     lst.insert(bw, 0);
168
169   LinkedListIterator<OpenboxWindow> it2(&lst);
170   for (OpenboxWindow *bw = it2.current(); bw; it2++, bw = it2.current())
171     if (! bw->isStuck())
172       bw->withdraw();
173 }
174
175
176 void Workspace::removeAll(void) {
177   LinkedListIterator<OpenboxWindow> it(windowList);
178   for (OpenboxWindow *bw = it.current(); bw; it++, bw = it.current())
179     bw->iconify();
180 }
181
182
183 void Workspace::raiseWindow(OpenboxWindow *w) {
184   OpenboxWindow *win = (OpenboxWindow *) 0, *bottom = w;
185
186   while (bottom->isTransient() && bottom->getTransientFor())
187     bottom = bottom->getTransientFor();
188
189   int i = 1;
190   win = bottom;
191   while (win->hasTransient() && win->getTransient()) {
192     win = win->getTransient();
193
194     i++;
195   }
196
197   Window *nstack = new Window[i], *curr = nstack;
198   Workspace *wkspc;
199
200   win = bottom;
201   while (True) {
202     *(curr++) = win->getFrameWindow();
203     screen.updateNetizenWindowRaise(win->getClientWindow());
204
205     if (! win->isIconic()) {
206       wkspc = screen.getWorkspace(win->getWorkspaceNumber());
207       wkspc->stackingList->remove(win);
208       wkspc->stackingList->insert(win, 0);
209     }
210
211     if (! win->hasTransient() || ! win->getTransient())
212       break;
213
214     win = win->getTransient();
215   }
216
217   screen.raiseWindows(nstack, i);
218
219   delete [] nstack;
220 }
221
222
223 void Workspace::lowerWindow(OpenboxWindow *w) {
224   OpenboxWindow *win = (OpenboxWindow *) 0, *bottom = w;
225
226   while (bottom->isTransient() && bottom->getTransientFor())
227     bottom = bottom->getTransientFor();
228
229   int i = 1;
230   win = bottom;
231   while (win->hasTransient() && win->getTransient()) {
232     win = win->getTransient();
233
234     i++;
235   }
236
237   Window *nstack = new Window[i], *curr = nstack;
238   Workspace *wkspc;
239
240   while (True) {
241     *(curr++) = win->getFrameWindow();
242     screen.updateNetizenWindowLower(win->getClientWindow());
243
244     if (! win->isIconic()) {
245       wkspc = screen.getWorkspace(win->getWorkspaceNumber());
246       wkspc->stackingList->remove(win);
247       wkspc->stackingList->insert(win);
248     }
249
250     if (! win->getTransientFor())
251       break;
252
253     win = win->getTransientFor();
254   }
255
256   screen.getOpenbox().grab();
257
258   XLowerWindow(screen.getBaseDisplay().getXDisplay(), *nstack);
259   XRestackWindows(screen.getBaseDisplay().getXDisplay(), nstack, i);
260
261   screen.getOpenbox().ungrab();
262
263   delete [] nstack;
264 }
265
266
267 void Workspace::reconfigure(void) {
268   clientmenu->reconfigure();
269
270   LinkedListIterator<OpenboxWindow> it(windowList);
271   for (OpenboxWindow *bw = it.current(); bw; it++, bw = it.current()) {
272     if (bw->validateClient())
273       bw->reconfigure();
274   }
275 }
276
277
278 OpenboxWindow *Workspace::getWindow(int index) {
279   if ((index >= 0) && (index < windowList->count()))
280     return windowList->find(index);
281   else
282     return 0;
283 }
284
285
286 const int Workspace::getCount(void) {
287   return windowList->count();
288 }
289
290
291 void Workspace::update(void) {
292   clientmenu->update();
293   screen.getToolbar()->redrawWindowLabel(True);
294 }
295
296
297 Bool Workspace::isCurrent(void) {
298   return (id == screen.getCurrentWorkspaceID());
299 }
300
301
302 Bool Workspace::isLastWindow(OpenboxWindow *w) {
303   return (w == windowList->last());
304 }
305
306 void Workspace::setCurrent(void) {
307   screen.changeWorkspaceID(id);
308 }
309
310
311 void Workspace::setName(char *new_name) {
312   if (name)
313     delete [] name;
314
315   if (new_name) {
316     name = bstrdup(new_name);
317   } else {
318     name = new char[128];
319     sprintf(name, i18n->getMessage(WorkspaceSet, WorkspaceDefaultNameFormat,
320                                    "Workspace %d"), id + 1);
321   }
322   
323   clientmenu->setLabel(name);
324   clientmenu->update();
325   screen.saveWorkspaceNames();
326 }
327
328
329 void Workspace::shutdown(void) {
330   while (windowList->count()) {
331     windowList->first()->restore();
332     delete windowList->first();
333   }
334 }
335
336 static rectList calcSpace(const Rect &win, const rectList &spaces) {
337   rectList result;
338   rectList::const_iterator siter;
339   for(siter=spaces.begin(); siter!=spaces.end(); ++siter) {
340     if(win.Intersect(*siter)) {
341       //Check for space to the left of the window
342       if(win.origin().x() > siter->x())
343         result.push_back(Rect(siter->x(), siter->y(),
344                               win.origin().x() - siter->x() - 1,
345                               siter->h()));
346       //Check for space above the window
347       if(win.origin().y() > siter->y())
348         result.push_back(Rect(siter->x(), siter->y(),
349                               siter->w(),
350                               win.origin().y() - siter->y() - 1));
351       //Check for space to the right of the window
352       if((win.origin().x()+win.size().w()) <
353          (siter->x()+siter->w()))
354         result.push_back(Rect(win.origin().x() + win.size().w() + 1,
355                               siter->y(),
356                               siter->x() + siter->w() -
357                               win.origin().x() - win.size().w() - 1,
358                               siter->h()));
359       //Check for space below the window
360       if((win.origin().y()+win.size().h()) <
361          (siter->y()+siter->h()))
362         result.push_back(Rect(siter->x(),
363                               win.origin().y() + win.size().h() + 1,
364                               siter->w(),
365                               siter->y() + siter->h()-
366                               win.origin().y() - win.size().h() - 1));
367
368     }
369     else
370       result.push_back(*siter);
371   }
372   return result;
373 }
374
375
376 bool incWidth(const Rect &first, const Rect &second) {
377   return first.x() < second.x();
378 }
379
380
381 bool decWidth(const Rect &first, const Rect &second) {
382   if (second.x() == first.x())
383      return second.w() < first.w();
384   return second.x() < first.x();
385 }
386
387
388 bool incHeight(const Rect &first, const Rect &second) {
389   return first.y() < second.y();
390 }
391
392
393 bool decHeight(const Rect &first, const Rect &second) {
394   if (second.y() == first.y())
395      return second.h() < first.h();
396   return second.y() < first.y();
397 }
398
399
400 //BestFitPlacement finds the smallest free space that fits the window
401 //to be placed. It currentl ignores whether placement is right to left or top
402 //to bottom.
403 Point *Workspace::bestFitPlacement(const Size &win_size, const Rect &space) {
404   const Rect *best;
405   rectList spaces;
406   LinkedListIterator<OpenboxWindow> it(windowList);
407   rectList::const_iterator siter;
408   spaces.push_back(space); //initially the entire screen is free
409   it.reset();
410   
411   //Find Free Spaces
412   for (OpenboxWindow *cur=it.current(); cur!=NULL; it++, cur=it.current())
413      spaces = calcSpace(cur->area().Inflate(screen.getBorderWidth() * 4),
414                         spaces);
415   
416   //Sort the spaces by placement choice
417   if (screen.rowPlacementDirection() == BScreen::TopBottom)
418      sort(spaces.begin(), spaces.end(), decHeight);
419   else
420      sort(spaces.begin(), spaces.end(), incHeight);
421   if (screen.colPlacementDirection() == BScreen::TopBottom)
422      stable_sort(spaces.begin(), spaces.end(), incHeight);
423   else
424      stable_sort(spaces.begin(), spaces.end(), decHeight);
425
426   //Find first space that fits the window
427   best = NULL;
428   for (siter=spaces.begin(); siter!=spaces.end(); ++siter) {
429     if ((siter->w() >= win_size.w()) && (siter->h() >= win_size.h())) {
430       if (best==NULL)
431         best = siter;
432       else if(siter->w()*siter->h()<best->h()*best->w())
433         best = siter;
434     }
435   }
436   if (best != NULL) {
437     Point *pt = new Point(best->origin());
438     if (screen.colPlacementDirection() != BScreen::TopBottom)
439       pt->setY(pt->y() + (best->h() - win_size.h()));
440     if (screen.rowPlacementDirection() != BScreen::LeftRight)
441       pt->setX(pt->x() + (best->w() - win_size.w()));
442     return pt;
443   } else
444     return NULL; //fall back to cascade
445 }
446
447
448 Point *Workspace::rowSmartPlacement(const Size &win_size, const Rect &space) {
449   const Rect *best;
450   rectList spaces;
451   LinkedListIterator<OpenboxWindow> it(windowList);
452   rectList::const_iterator siter;
453   spaces.push_back(space); //initially the entire screen is free
454   it.reset();
455   
456   //Find Free Spaces
457   for (OpenboxWindow *cur=it.current(); cur!=NULL; it++, cur=it.current())
458      spaces = calcSpace(cur->area().Inflate(screen.getBorderWidth() * 4),
459                         spaces);
460   
461   //Sort the spaces by placement choice
462   if (screen.colPlacementDirection() == BScreen::LeftRight)
463      sort(spaces.begin(), spaces.end(), incWidth);
464   else
465      sort(spaces.begin(), spaces.end(), decWidth);
466   if (screen.rowPlacementDirection() == BScreen::TopBottom)
467      stable_sort(spaces.begin(), spaces.end(), incHeight);
468   else
469      stable_sort(spaces.begin(), spaces.end(), decHeight);
470
471   //Find first space that fits the window
472   best = NULL;
473   for (siter=spaces.begin(); siter!=spaces.end(); ++siter)
474     if ((siter->w() >= win_size.w()) && (siter->h() >= win_size.h())) {
475       best = siter;
476       break;
477     }
478
479   if (best != NULL) {
480     Point *pt = new Point(best->origin());
481     if (screen.colPlacementDirection() != BScreen::TopBottom)
482       pt->setY(pt->y() + (best->h() - win_size.h()));
483     if (screen.rowPlacementDirection() != BScreen::LeftRight)
484       pt->setX(pt->x() + (best->w() - win_size.w()));
485     return pt;
486   } else
487     return NULL; //fall back to cascade
488 }
489
490 Point *Workspace::colSmartPlacement(const Size &win_size, const Rect &space) {
491   const Rect *best;
492   rectList spaces;
493   LinkedListIterator<OpenboxWindow> it(windowList);
494   rectList::const_iterator siter;
495   spaces.push_back(space); //initially the entire screen is free
496   it.reset();
497   
498   //Find Free Spaces
499   for (OpenboxWindow *cur=it.current(); cur!=NULL; it++, cur=it.current())
500      spaces = calcSpace(cur->area().Inflate(screen.getBorderWidth() * 4),
501                         spaces);
502   
503   //Sort the spaces by placement choice
504   if (screen.rowPlacementDirection() == BScreen::LeftRight)
505      sort(spaces.begin(),spaces.end(),incWidth);
506   else
507      sort(spaces.begin(),spaces.end(),decWidth);
508
509   //Find first space that fits the window
510   best = NULL;
511   for (siter=spaces.begin(); siter!=spaces.end(); ++siter)
512     if ((siter->w() >= win_size.w()) && (siter->h() >= win_size.h())) {
513       best = siter;
514       break;
515     }
516
517   if (best != NULL) {
518     Point *pt = new Point(best->origin());
519     if (screen.colPlacementDirection() != BScreen::TopBottom)
520       pt->setY(pt->y() + (best->h() - win_size.h()));
521     if (screen.rowPlacementDirection() != BScreen::LeftRight)
522       pt->setX(pt->x() + (best->w() - win_size.w()));
523     return pt;
524   } else
525     return NULL; //fall back to cascade
526 }
527
528
529 Point *const Workspace::cascadePlacement(const OpenboxWindow *const win){
530   if (((unsigned) cascade_x > (screen.size().w() / 2)) ||
531       ((unsigned) cascade_y > (screen.size().h() / 2)))
532     cascade_x = cascade_y = 32;
533
534   cascade_x += win->getTitleHeight();
535   cascade_y += win->getTitleHeight();
536
537   return new Point(cascade_x, cascade_y);
538 }
539
540
541 void Workspace::placeWindow(OpenboxWindow *win) {
542   ASSERT(win != NULL);
543
544   // the following code is temporary and will be taken care of by Screen in the
545   // future (with the NETWM 'strut')
546   Rect space(0, 0, screen.size().w(), screen.size().h());
547
548 #ifdef    SLIT
549   Slit *slit = screen.getSlit();
550   Toolbar *toolbar = screen.getToolbar();
551   int tbarh = screen.hideToolbar() ? 0 :
552     toolbar->getExposedHeight() + screen.getBorderWidth() * 2;
553   bool tbartop;
554   switch (toolbar->placement()) {
555   case Toolbar::TopLeft:
556   case Toolbar::TopCenter:
557   case Toolbar::TopRight:
558     tbartop = true;
559     break;
560   case Toolbar::BottomLeft:
561   case Toolbar::BottomCenter:
562   case Toolbar::BottomRight:
563     tbartop = false;
564     break;
565   default:
566     ASSERT(false);      // unhandled placement
567   }
568   if ((slit->direction() == Slit::Horizontal &&
569        (slit->placement() == Slit::TopLeft ||
570         slit->placement() == Slit::TopRight)) ||
571       slit->placement() == Slit::TopCenter) {
572     // exclude top
573     if (tbartop) {
574       space.setY(slit->area().y());
575       space.setH(space.h() - space.y());
576     } else
577       space.setH(space.h() - tbarh);
578     space.setY(space.y() + slit->area().h() + screen.getBorderWidth() * 2);
579     space.setH(space.h() - (slit->area().h() + screen.getBorderWidth() * 2));
580   } else if ((slit->direction() == Slit::Vertical &&
581               (slit->placement() == Slit::TopRight ||
582                slit->placement() == Slit::BottomRight)) ||
583              slit->placement() == Slit::CenterRight) {
584     // exclude right
585     space.setW(space.w() - (slit->area().w() + screen.getBorderWidth() * 2));
586     if (tbartop)
587       space.setY(space.y() + tbarh);
588     space.setH(space.h() - tbarh);
589   } else if ((slit->direction() == Slit::Horizontal &&
590               (slit->placement() == Slit::BottomLeft ||
591                slit->placement() == Slit::BottomRight)) ||
592              slit->placement() == Slit::BottomCenter) {
593     // exclude bottom
594     space.setH(space.h() - (screen.size().h() - slit->area().y()));
595   } else {// if ((slit->direction() == Slit::Vertical &&
596     //      (slit->placement() == Slit::TopLeft ||
597     //       slit->placement() == Slit::BottomLeft)) ||
598     //     slit->placement() == Slit::CenterLeft)
599     // exclude left
600     space.setX(slit->area().w() + screen.getBorderWidth() * 2);
601     space.setW(space.w() - (slit->area().w() + screen.getBorderWidth() * 2));
602     if (tbartop)
603       space.setY(space.y() + tbarh);
604     space.setH(space.h() - tbarh);
605   }
606 #else // !SLIT
607   Toolbar *toolbar = screen.getToolbar();
608   int tbarh = screen.hideToolbar() ? 0 :
609     toolbar->getExposedHeight() + screen.getBorderWidth() * 2;
610   switch (toolbar->placement()) {
611   case Toolbar::TopLeft:
612   case Toolbar::TopCenter:
613   case Toolbar::TopRight:
614     space.setY(toolbar->getExposedHeight());
615     space.setH(space.h() - toolbar->getExposedHeight());
616     break;
617   case Toolbar::BottomLeft:
618   case Toolbar::BottomCenter:
619   case Toolbar::BottomRight:
620     space.setH(space.h() - tbarh);
621     break;
622   default:
623     ASSERT(false);      // unhandled placement
624   }
625 #endif // SLIT
626
627   const Size window_size(win->area().w()+screen.getBorderWidth() * 4,
628                          win->area().h()+screen.getBorderWidth() * 4);
629   Point *place = NULL;
630   LinkedListIterator<OpenboxWindow> it(windowList);
631
632   switch (screen.placementPolicy()) {
633   case BScreen::BestFitPlacement:
634     place = bestFitPlacement(window_size, space);
635     break;
636   case BScreen::RowSmartPlacement:
637     place = rowSmartPlacement(window_size, space);
638     break;
639   case BScreen::ColSmartPlacement:
640     place = colSmartPlacement(window_size, space);
641     break;
642   } // switch
643
644   if (place == NULL)
645     place = cascadePlacement(win);
646  
647   ASSERT(place != NULL);  
648   if (place->x() + window_size.w() > (signed) screen.size().w())
649     place->setX(((signed) screen.size().w() - window_size.w()) / 2);
650   if (place->y() + window_size.h() > (signed) screen.size().h())
651     place->setY(((signed) screen.size().h() - window_size.h()) / 2);
652
653   win->configure(place->x(), place->y(), win->area().w(), win->area().h());
654   delete place;
655 }