openbox/place.c

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    place.c for the Openbox window manager
   4    Copyright (c) 2006        Mikael Magnusson
   5    Copyright (c) 2003-2007   Dana Jansens
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    See the COPYING file for a copy of the GNU General Public License.
  18 */
  19
  20 #include "client.h"
  21 #include "group.h"
  22 #include "screen.h"
  23 #include "frame.h"
  24 #include "focus.h"
  25 #include "config.h"
  26 #include "debug.h"
  27
  28 static void add_choice(guint *choice, guint mychoice)
  29 {
  30     guint i;
  31     for (i = 0; i < screen_num_monitors; ++i) {
  32         if (choice[i] == mychoice)
  33             return;
  34         else if (choice[i] == screen_num_monitors) {
  35             choice[i] = mychoice;
  36             return;
  37         }
  38     }
  39 }
  40
  41 static Rect *pick_pointer_head(ObClient *c)
  42 {
  43     guint i;
  44     gint px, py;
  45
  46     screen_pointer_pos(&px, &py);
  47
  48     for (i = 0; i < screen_num_monitors; ++i) {
  49         if (RECT_CONTAINS(*screen_physical_area_monitor(i), px, py)) {
  50             return screen_area_monitor(c->desktop, i);
  51         }
  52     }
  53     g_assert_not_reached();
  54 }
  55
  56 /*! Pick a monitor to place a window on.
  57   The returned array value should be freed with g_free. The areas within the
  58   array should not be freed. */
  59 static Rect **pick_head(ObClient *c)
  60 {
  61     Rect **area;
  62     guint *choice;
  63     guint i;
  64     gint px, py;
  65     ObClient *p;
  66
  67     area = g_new(Rect*, screen_num_monitors);
  68     choice = g_new(guint, screen_num_monitors);
  69     for (i = 0; i < screen_num_monitors; ++i)
  70         choice[i] = screen_num_monitors; /* make them all invalid to start */
  71
  72     /* try direct parent first */
  73     if ((p = client_direct_parent(c))) {
  74         add_choice(choice, client_monitor(p));
  75         ob_debug("placement adding choice %d for parent\n",
  76                  client_monitor(p));
  77     }
  78
  79     /* more than one window in its group (more than just this window) */
  80     if (client_has_group_siblings(c)) {
  81         GSList *it;
  82
  83         /* try on the client's desktop */
  84         for (it = c->group->members; it; it = g_slist_next(it)) {
  85             ObClient *itc = it->data;
  86             if (itc != c &&
  87                 (itc->desktop == c->desktop ||
  88                  itc->desktop == DESKTOP_ALL || c->desktop == DESKTOP_ALL))
  89             {
  90                 add_choice(choice, client_monitor(it->data));
  91                 ob_debug("placement adding choice %d for group sibling\n",
  92                          client_monitor(it->data));
  93             }
  94         }
  95
  96         /* try on all desktops */
  97         for (it = c->group->members; it; it = g_slist_next(it)) {
  98             ObClient *itc = it->data;
  99             if (itc != c) {
 100                 add_choice(choice, client_monitor(it->data));
 101                 ob_debug("placement adding choice %d for group sibling on "
 102                          "another desktop\n", client_monitor(it->data));
 103             }
 104         }
 105     }
 106
 107     if (focus_client) {
 108         add_choice(choice, client_monitor(focus_client));
 109         ob_debug("placement adding choice %d for focused window\n",
 110                  client_monitor(focus_client));
 111     }
 112
 113     screen_pointer_pos(&px, &py);
 114
 115     for (i = 0; i < screen_num_monitors; i++)
 116         if (RECT_CONTAINS(*screen_physical_area_monitor(i), px, py)) {
 117             add_choice(choice, i);
 118             ob_debug("placement adding choice %d for mouse pointer\n", i);
 119             break;
 120         }
 121
 122     /* add any leftover choices */
 123     for (i = 0; i < screen_num_monitors; ++i)
 124         add_choice(choice, i);
 125
 126     for (i = 0; i < screen_num_monitors; ++i)
 127         area[i] = screen_area_monitor(c->desktop, choice[i]);
 128
 129     return area;
 130 }
 131
 132 static gboolean place_random(ObClient *client, gint *x, gint *y)
 133 {
 134     gint l, r, t, b;
 135     Rect **areas;
 136     guint i;
 137
 138     areas = pick_head(client);
 139     i = g_random_int_range(0, screen_num_monitors);
 140
 141     l = areas[i]->x;
 142     t = areas[i]->y;
 143     r = areas[i]->x + areas[i]->width - client->frame->area.width;
 144     b = areas[i]->y + areas[i]->height - client->frame->area.height;
 145
 146     if (r > l) *x = g_random_int_range(l, r + 1);
 147     else       *x = areas[i]->x;
 148     if (b > t) *y = g_random_int_range(t, b + 1);
 149     else       *y = areas[i]->y;
 150
 151     g_free(areas);
 152
 153     return TRUE;
 154 }
 155
 156 static GSList* area_add(GSList *list, Rect *a)
 157 {
 158     Rect *r = g_new(Rect, 1);
 159     *r = *a;
 160     return g_slist_prepend(list, r);
 161 }
 162
 163 static GSList* area_remove(GSList *list, Rect *a)
 164 {
 165     GSList *sit;
 166     GSList *result = NULL;
 167
 168     for (sit = list; sit; sit = g_slist_next(sit)) {
 169         Rect *r = sit->data;
 170
 171         if (!RECT_INTERSECTS_RECT(*r, *a)) {
 172             result = g_slist_prepend(result, r);
 173             r = NULL; /* dont free it */
 174         } else {
 175             Rect isect, extra;
 176
 177             /* Use an intersection of a and r to determine the space
 178                around r that we can use.
 179
 180                NOTE: the spaces calculated can overlap.
 181             */
 182
 183             RECT_SET_INTERSECTION(isect, *r, *a);
 184
 185             if (RECT_LEFT(isect) > RECT_LEFT(*r)) {
 186                 RECT_SET(extra, r->x, r->y,
 187                          RECT_LEFT(isect) - r->x, r->height);
 188                 result = area_add(result, &extra);
 189             }
 190
 191             if (RECT_TOP(isect) > RECT_TOP(*r)) {
 192                 RECT_SET(extra, r->x, r->y,
 193                          r->width, RECT_TOP(isect) - r->y + 1);
 194                 result = area_add(result, &extra);
 195             }
 196
 197             if (RECT_RIGHT(isect) < RECT_RIGHT(*r)) {
 198                 RECT_SET(extra, RECT_RIGHT(isect) + 1, r->y,
 199                          RECT_RIGHT(*r) - RECT_RIGHT(isect), r->height);
 200                 result = area_add(result, &extra);
 201             }
 202
 203             if (RECT_BOTTOM(isect) < RECT_BOTTOM(*r)) {
 204                 RECT_SET(extra, r->x, RECT_BOTTOM(isect) + 1,
 205                          r->width, RECT_BOTTOM(*r) - RECT_BOTTOM(isect));
 206                 result = area_add(result, &extra);
 207             }
 208         }
 209
 210         g_free(r);
 211     }
 212     g_slist_free(list);
 213     return result;
 214 }
 215
 216 enum {
 217     IGNORE_FULLSCREEN = 1 << 0,
 218     IGNORE_MAXIMIZED  = 1 << 1,
 219     IGNORE_MENUTOOL   = 1 << 2,
 220     IGNORE_SHADED     = 1 << 3,
 221     IGNORE_NONGROUP   = 1 << 4,
 222     IGNORE_BELOW      = 1 << 5,
 223     IGNORE_END        = 1 << 6
 224 };
 225
 226 static gboolean place_nooverlap(ObClient *c, gint *x, gint *y)
 227 {
 228     Rect **areas;
 229     gint ignore;
 230     gboolean ret;
 231     gint maxsize;
 232     GSList *spaces = NULL, *sit, *maxit;
 233
 234     areas = pick_head(c);
 235     ret = FALSE;
 236     maxsize = 0;
 237     maxit = NULL;
 238
 239     /* try ignoring different things to find empty space */
 240     for (ignore = 0; ignore < IGNORE_END && !ret; ignore = (ignore << 1) + 1) {
 241         guint i;
 242
 243         /* try all monitors in order of preference */
 244         for (i = 0; i < screen_num_monitors && !ret; ++i) {
 245             /* add the whole monitor */
 246             spaces = area_add(spaces, areas[i]);
 247
 248             /* go thru all the windows */
 249             for (sit = client_list; sit; sit = g_slist_next(sit)) {
 250                 ObClient *test = sit->data;
 251
 252                 /* should we ignore this client? */
 253                 if (screen_showing_desktop) continue;
 254                 if (c == test) continue;
 255                 if (test->iconic) continue;
 256                 if (c->desktop != DESKTOP_ALL) {
 257                     if (test->desktop != c->desktop &&
 258                         test->desktop != DESKTOP_ALL) continue;
 259                 } else {
 260                     if (test->desktop != screen_desktop &&
 261                         test->desktop != DESKTOP_ALL) continue;
 262                 }
 263                 if (test->type == OB_CLIENT_TYPE_SPLASH ||
 264                     test->type == OB_CLIENT_TYPE_DESKTOP) continue;
 265
 266
 267                 if ((ignore & IGNORE_FULLSCREEN) &&
 268                     test->fullscreen) continue;
 269                 if ((ignore & IGNORE_MAXIMIZED) &&
 270                     test->max_horz && test->max_vert) continue;
 271                 if ((ignore & IGNORE_MENUTOOL) &&
 272                     (test->type == OB_CLIENT_TYPE_MENU ||
 273                      test->type == OB_CLIENT_TYPE_TOOLBAR) &&
 274                     client_has_parent(c)) continue;
 275                 if ((ignore & IGNORE_SHADED) &&
 276                     test->shaded) continue;
 277                 if ((ignore & IGNORE_NONGROUP) &&
 278                     client_has_group_siblings(test) &&
 279                     test->group != c->group) continue;
 280                 if ((ignore & IGNORE_BELOW) &&
 281                     test->layer < c->layer) continue;
 282
 283                 /* don't ignore this window, so remove it from the available
 284                    area */
 285                 spaces = area_remove(spaces, &test->frame->area);
 286             }
 287
 288             for (sit = spaces; sit; sit = g_slist_next(sit)) {
 289                 Rect *r = sit->data;
 290
 291                 if (r->width >= c->frame->area.width &&
 292                     r->height >= c->frame->area.height &&
 293                     r->width > maxsize)
 294                 {
 295                     maxsize = r->width;
 296                     maxit = sit;
 297                 }
 298             }
 299
 300             if (maxit) {
 301                 Rect *r = maxit->data;
 302
 303                 /* center it in the area */
 304                 *x = r->x + (r->width - c->frame->area.width) / 2;
 305                 *y = r->y + (r->height - c->frame->area.height) / 2;
 306                 ret = TRUE;
 307             }
 308
 309             while (spaces) {
 310                 g_free(spaces->data);
 311                 spaces = g_slist_delete_link(spaces, spaces);
 312             }
 313         }
 314     }
 315
 316     g_free(areas);
 317     return ret;
 318 }
 319
 320 static gboolean place_under_mouse(ObClient *client, gint *x, gint *y)
 321 {
 322     gint l, r, t, b;
 323     gint px, py;
 324     Rect *area;
 325
 326     area = pick_pointer_head(client);
 327     screen_pointer_pos(&px, &py);
 328
 329     l = area->x;
 330     t = area->y;
 331     r = area->x + area->width - client->frame->area.width;
 332     b = area->y + area->height - client->frame->area.height;
 333
 334     *x = px - client->area.width / 2 - client->frame->size.left;
 335     *x = MIN(MAX(*x, l), r);
 336     *y = py - client->area.height / 2 - client->frame->size.top;
 337     *y = MIN(MAX(*y, t), b);
 338
 339     return TRUE;
 340 }
 341
 342 static gboolean place_per_app_setting(ObClient *client, gint *x, gint *y,
 343                                       ObAppSettings *settings)
 344 {
 345     Rect *screen = NULL;
 346
 347     if (!settings || (settings && !settings->pos_given))
 348         return FALSE;
 349
 350     /* Find which head the pointer is on */
 351     if (settings->monitor == 0)
 352         screen = pick_pointer_head(client);
 353     else if (settings->monitor > 0 &&
 354              (guint)settings->monitor <= screen_num_monitors)
 355         screen = screen_area_monitor(client->desktop,
 356                                      (guint)settings->monitor - 1);
 357     else {
 358         Rect **all = NULL;
 359         all = pick_head(client);
 360         screen = all[0];
 361         g_free(all); /* the areas themselves don't need to be freed */
 362     }
 363
 364     if (settings->center_x)
 365         *x = screen->x + screen->width / 2 - client->area.width / 2;
 366     else if (settings->opposite_x)
 367         *x = screen->x + screen->width - client->frame->area.width -
 368             settings->position.x;
 369     else
 370         *x = screen->x + settings->position.x;
 371
 372     if (settings->center_y)
 373         *y = screen->y + screen->height / 2 - client->area.height / 2;
 374     else if (settings->opposite_y)
 375         *y = screen->y + screen->height - client->frame->area.height -
 376             settings->position.y;
 377     else
 378         *y = screen->y + settings->position.y;
 379
 380     return TRUE;
 381 }
 382
 383 static gboolean place_transient_splash(ObClient *client, gint *x, gint *y)
 384 {
 385     if (client->type == OB_CLIENT_TYPE_DIALOG) {
 386         GSList *it;
 387         gboolean first = TRUE;
 388         gint l, r, t, b;
 389         for (it = client->parents; it; it = g_slist_next(it)) {
 390             ObClient *m = it->data;
 391             if (!m->iconic) {
 392                 if (first) {
 393                     l = RECT_LEFT(m->frame->area);
 394                     t = RECT_TOP(m->frame->area);
 395                     r = RECT_RIGHT(m->frame->area);
 396                     b = RECT_BOTTOM(m->frame->area);
 397                     first = FALSE;
 398                 } else {
 399                     l = MIN(l, RECT_LEFT(m->frame->area));
 400                     t = MIN(t, RECT_TOP(m->frame->area));
 401                     r = MAX(r, RECT_RIGHT(m->frame->area));
 402                     b = MAX(b, RECT_BOTTOM(m->frame->area));
 403                 }
 404             }
 405             if (!first) {
 406                 *x = ((r + 1 - l) - client->frame->area.width) / 2 + l;
 407                 *y = ((b + 1 - t) - client->frame->area.height) / 2 + t;
 408                 return TRUE;
 409             }
 410         }
 411     }
 412
 413     if (client->type == OB_CLIENT_TYPE_DIALOG ||
 414         client->type == OB_CLIENT_TYPE_SPLASH)
 415     {
 416         Rect **areas;
 417
 418         areas = pick_head(client);
 419
 420         *x = (areas[0]->width - client->frame->area.width) / 2 + areas[0]->x;
 421         *y = (areas[0]->height - client->frame->area.height) / 2 + areas[0]->y;
 422
 423         g_free(areas);
 424         return TRUE;
 425     }
 426
 427     return FALSE;
 428 }
 429
 430 /* Return TRUE if we want client.c to enforce on-screen-keeping */
 431 gboolean place_client(ObClient *client, gint *x, gint *y,
 432                       ObAppSettings *settings)
 433 {
 434     gboolean ret;
 435
 436     if (client->positioned)
 437         return FALSE;
 438
 439     /* try a number of methods */
 440     ret = place_transient_splash(client, x, y) ||
 441         place_per_app_setting(client, x, y, settings) ||
 442         (config_place_policy == OB_PLACE_POLICY_MOUSE &&
 443          place_under_mouse(client, x, y)) ||
 444         place_nooverlap(client, x, y) ||
 445         place_random(client, x, y);
 446     g_assert(ret);
 447
 448     /* get where the client should be */
 449     frame_frame_gravity(client->frame, x, y,
 450                         client->area.width, client->area.height);
 451     return ret;
 452 }