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 "dock.h"
  27 #include "debug.h"
  28
  29 extern ObDock *dock;
  30
  31 static void add_choice(guint *choice, guint mychoice)
  32 {
  33     guint i;
  34     for (i = 0; i < screen_num_monitors; ++i) {
  35         if (choice[i] == mychoice)
  36             return;
  37         else if (choice[i] == screen_num_monitors) {
  38             choice[i] = mychoice;
  39             return;
  40         }
  41     }
  42 }
  43
  44 static Rect *pick_pointer_head(ObClient *c)
  45 {
  46     guint i;
  47     gint px, py;
  48
  49     if (screen_pointer_pos(&px, &py)) {
  50         for (i = 0; i < screen_num_monitors; ++i) {
  51             Rect *monitor = screen_physical_area_monitor(i);
  52             gboolean contain = RECT_CONTAINS(*monitor, px, py);
  53             g_free(monitor);
  54             if (contain)
  55                 return screen_area(c->desktop, i, NULL);
  56         }
  57         g_assert_not_reached();
  58     } else
  59         return NULL;
  60 }
  61
  62 /*! Pick a monitor to place a window on. */
  63 static Rect **pick_head(ObClient *c)
  64 {
  65     Rect **area;
  66     guint *choice;
  67     guint i;
  68     gint px, py;
  69     ObClient *p;
  70
  71     area = g_new(Rect*, screen_num_monitors);
  72     choice = g_new(guint, screen_num_monitors);
  73     for (i = 0; i < screen_num_monitors; ++i)
  74         choice[i] = screen_num_monitors; /* make them all invalid to start */
  75
  76     /* try direct parent first */
  77     if ((p = client_direct_parent(c))) {
  78         add_choice(choice, client_monitor(p));
  79         ob_debug("placement adding choice %d for parent\n",
  80                  client_monitor(p));
  81     }
  82
  83     /* more than one window in its group (more than just this window) */
  84     if (client_has_group_siblings(c)) {
  85         GSList *it;
  86
  87         /* try on the client's desktop */
  88         for (it = c->group->members; it; it = g_slist_next(it)) {
  89             ObClient *itc = it->data;
  90             if (itc != c &&
  91                 (itc->desktop == c->desktop ||
  92                  itc->desktop == DESKTOP_ALL || c->desktop == DESKTOP_ALL))
  93             {
  94                 add_choice(choice, client_monitor(it->data));
  95                 ob_debug("placement adding choice %d for group sibling\n",
  96                          client_monitor(it->data));
  97             }
  98         }
  99
 100         /* try on all desktops */
 101         for (it = c->group->members; it; it = g_slist_next(it)) {
 102             ObClient *itc = it->data;
 103             if (itc != c) {
 104                 add_choice(choice, client_monitor(it->data));
 105                 ob_debug("placement adding choice %d for group sibling on "
 106                          "another desktop\n", client_monitor(it->data));
 107             }
 108         }
 109     }
 110
 111     if (focus_client && client_normal(focus_client)) {
 112         add_choice(choice, client_monitor(focus_client));
 113         ob_debug("placement adding choice %d for normal focused window\n",
 114                  client_monitor(focus_client));
 115     }
 116
 117     screen_pointer_pos(&px, &py);
 118
 119     for (i = 0; i < screen_num_monitors; i++) {
 120         Rect *monitor = screen_physical_area_monitor(i);
 121         gboolean contain = RECT_CONTAINS(*monitor, px, py);
 122         g_free(monitor);
 123         if (contain) {
 124             add_choice(choice, i);
 125             ob_debug("placement adding choice %d for mouse pointer\n", i);
 126             break;
 127         }
 128     }
 129
 130     /* add any leftover choices */
 131     for (i = 0; i < screen_num_monitors; ++i)
 132         add_choice(choice, i);
 133
 134     for (i = 0; i < screen_num_monitors; ++i)
 135         area[i] = screen_area(c->desktop, choice[i], NULL);
 136
 137     g_free(choice);
 138
 139     return area;
 140 }
 141
 142 static gboolean place_random(ObClient *client, gint *x, gint *y)
 143 {
 144     gint l, r, t, b;
 145     Rect **areas;
 146     guint i;
 147
 148     areas = pick_head(client);
 149     i = config_place_active ? 0 : g_random_int_range(0, screen_num_monitors);
 150
 151     l = areas[i]->x;
 152     t = areas[i]->y;
 153     r = areas[i]->x + areas[i]->width - client->frame->area.width;
 154     b = areas[i]->y + areas[i]->height - client->frame->area.height;
 155
 156     if (r > l) *x = g_random_int_range(l, r + 1);
 157     else       *x = areas[i]->x;
 158     if (b > t) *y = g_random_int_range(t, b + 1);
 159     else       *y = areas[i]->y;
 160
 161     for (i = 0; i < screen_num_monitors; ++i)
 162         g_free(areas[i]);
 163     g_free(areas);
 164
 165     return TRUE;
 166 }
 167
 168 static GSList* area_add(GSList *list, Rect *a)
 169 {
 170     Rect *r = g_new(Rect, 1);
 171     *r = *a;
 172     return g_slist_prepend(list, r);
 173 }
 174
 175 static GSList* area_remove(GSList *list, Rect *a)
 176 {
 177     GSList *sit;
 178     GSList *result = NULL;
 179
 180     for (sit = list; sit; sit = g_slist_next(sit)) {
 181         Rect *r = sit->data;
 182
 183         if (!RECT_INTERSECTS_RECT(*r, *a)) {
 184             result = g_slist_prepend(result, r);
 185             /* dont free r, it's moved to the result list */
 186         } else {
 187             Rect isect, extra;
 188
 189             /* Use an intersection of a and r to determine the space
 190                around r that we can use.
 191
 192                NOTE: the spaces calculated can overlap.
 193             */
 194
 195             RECT_SET_INTERSECTION(isect, *r, *a);
 196
 197             if (RECT_LEFT(isect) > RECT_LEFT(*r)) {
 198                 RECT_SET(extra, r->x, r->y,
 199                          RECT_LEFT(isect) - r->x, r->height);
 200                 result = area_add(result, &extra);
 201             }
 202
 203             if (RECT_TOP(isect) > RECT_TOP(*r)) {
 204                 RECT_SET(extra, r->x, r->y,
 205                          r->width, RECT_TOP(isect) - r->y + 1);
 206                 result = area_add(result, &extra);
 207             }
 208
 209             if (RECT_RIGHT(isect) < RECT_RIGHT(*r)) {
 210                 RECT_SET(extra, RECT_RIGHT(isect) + 1, r->y,
 211                          RECT_RIGHT(*r) - RECT_RIGHT(isect), r->height);
 212                 result = area_add(result, &extra);
 213             }
 214
 215             if (RECT_BOTTOM(isect) < RECT_BOTTOM(*r)) {
 216                 RECT_SET(extra, r->x, RECT_BOTTOM(isect) + 1,
 217                          r->width, RECT_BOTTOM(*r) - RECT_BOTTOM(isect));
 218                 result = area_add(result, &extra);
 219             }
 220
 221             /* 'r' is not being added to the result list, so free it */
 222             g_free(r);
 223         }
 224     }
 225     g_slist_free(list);
 226     return result;
 227 }
 228
 229 enum {
 230     IGNORE_FULLSCREEN = 1,
 231     IGNORE_MAXIMIZED  = 2,
 232     IGNORE_MENUTOOL   = 3,
 233     /*IGNORE_SHADED     = 3,*/
 234     IGNORE_NONGROUP   = 4,
 235     IGNORE_BELOW      = 5,
 236     /*IGNORE_NONFOCUS   = 1 << 5,*/
 237     IGNORE_DOCK       = 6,
 238     IGNORE_END        = 7
 239 };
 240
 241 static gboolean place_nooverlap(ObClient *c, gint *x, gint *y)
 242 {
 243     Rect **areas;
 244     gint ignore;
 245     gboolean ret;
 246     gint maxsize;
 247     GSList *spaces = NULL, *sit, *maxit;
 248     guint i;
 249
 250     areas = pick_head(c);
 251     ret = FALSE;
 252     maxsize = 0;
 253     maxit = NULL;
 254
 255     /* try ignoring different things to find empty space */
 256     for (ignore = 0; ignore < IGNORE_END && !ret; ignore++) {
 257         /* try all monitors in order of preference, but only the first one
 258            if config_place_active is true */
 259         for (i = 0; (i < (config_place_active ? 1 : screen_num_monitors) &&
 260                      !ret); ++i)
 261         {
 262             GList *it;
 263
 264             /* add the whole monitor */
 265             spaces = area_add(spaces, areas[i]);
 266
 267             /* go thru all the windows */
 268             for (it = client_list; it; it = g_list_next(it)) {
 269                 ObClient *test = it->data;
 270
 271                 /* should we ignore this client? */
 272                 if (screen_showing_desktop) continue;
 273                 if (c == test) continue;
 274                 if (test->iconic) continue;
 275                 if (c->desktop != DESKTOP_ALL) {
 276                     if (test->desktop != c->desktop &&
 277                         test->desktop != DESKTOP_ALL) continue;
 278                 } else {
 279                     if (test->desktop != screen_desktop &&
 280                         test->desktop != DESKTOP_ALL) continue;
 281                 }
 282                 if (test->type == OB_CLIENT_TYPE_SPLASH ||
 283                     test->type == OB_CLIENT_TYPE_DESKTOP) continue;
 284
 285
 286                 if ((ignore >= IGNORE_FULLSCREEN) &&
 287                     test->fullscreen) continue;
 288                 if ((ignore >= IGNORE_MAXIMIZED) &&
 289                     test->max_horz && test->max_vert) continue;
 290                 if ((ignore >= IGNORE_MENUTOOL) &&
 291                     (test->type == OB_CLIENT_TYPE_MENU ||
 292                      test->type == OB_CLIENT_TYPE_TOOLBAR) &&
 293                     client_has_parent(c)) continue;
 294                 /*
 295                 if ((ignore >= IGNORE_SHADED) &&
 296                     test->shaded) continue;
 297                 */
 298                 if ((ignore >= IGNORE_NONGROUP) &&
 299                     client_has_group_siblings(c) &&
 300                     test->group != c->group) continue;
 301                 if ((ignore >= IGNORE_BELOW) &&
 302                     test->layer < c->layer) continue;
 303                 /*
 304                 if ((ignore >= IGNORE_NONFOCUS) &&
 305                     focus_client != test) continue;
 306                 */
 307                 /* don't ignore this window, so remove it from the available
 308                    area */
 309                 spaces = area_remove(spaces, &test->frame->area);
 310             }
 311
 312             if (ignore < IGNORE_DOCK) {
 313                 Rect a;
 314                 dock_get_area(&a);
 315                 spaces = area_remove(spaces, &a);
 316             }
 317
 318             for (sit = spaces; sit; sit = g_slist_next(sit)) {
 319                 Rect *r = sit->data;
 320
 321                 if (r->width >= c->frame->area.width &&
 322                     r->height >= c->frame->area.height &&
 323                     r->width * r->height > maxsize)
 324                 {
 325                     maxsize = r->width * r->height;
 326                     maxit = sit;
 327                 }
 328             }
 329
 330             if (maxit) {
 331                 Rect *r = maxit->data;
 332
 333                 /* center it in the area */
 334                 *x = r->x;
 335                 *y = r->y;
 336                 if (config_place_center) {
 337                     *x += (r->width - c->frame->area.width) / 2;
 338                     *y += (r->height - c->frame->area.height) / 2;
 339                 }
 340                 ret = TRUE;
 341             }
 342
 343             while (spaces) {
 344                 g_free(spaces->data);
 345                 spaces = g_slist_delete_link(spaces, spaces);
 346             }
 347         }
 348     }
 349
 350     for (i = 0; i < screen_num_monitors; ++i)
 351         g_free(areas[i]);
 352     g_free(areas);
 353     return ret;
 354 }
 355
 356 static gboolean place_under_mouse(ObClient *client, gint *x, gint *y)
 357 {
 358     gint l, r, t, b;
 359     gint px, py;
 360     Rect *area;
 361
 362     if (!screen_pointer_pos(&px, &py))
 363         return FALSE;
 364     area = pick_pointer_head(client);
 365
 366     l = area->x;
 367     t = area->y;
 368     r = area->x + area->width - client->frame->area.width;
 369     b = area->y + area->height - client->frame->area.height;
 370
 371     *x = px - client->area.width / 2 - client->frame->size.left;
 372     *x = MIN(MAX(*x, l), r);
 373     *y = py - client->area.height / 2 - client->frame->size.top;
 374     *y = MIN(MAX(*y, t), b);
 375
 376     return TRUE;
 377 }
 378
 379 static gboolean place_per_app_setting(ObClient *client, gint *x, gint *y,
 380                                       ObAppSettings *settings)
 381 {
 382     Rect *screen = NULL;
 383
 384     if (!settings || (settings && !settings->pos_given))
 385         return FALSE;
 386
 387     /* Find which head the pointer is on */
 388     if (settings->monitor == 0)
 389         /* this can return NULL */
 390         screen = pick_pointer_head(client);
 391     else if (settings->monitor > 0 &&
 392              (guint)settings->monitor <= screen_num_monitors)
 393         screen = screen_area(client->desktop, (guint)settings->monitor - 1,
 394                              NULL);
 395
 396     /* if we have't found a screen yet.. */
 397     if (!screen) {
 398         Rect **areas;
 399         guint i;
 400
 401         areas = pick_head(client);
 402         screen = areas[0];
 403
 404         /* don't free the first one, it's being set as "screen" */
 405         for (i = 1; i < screen_num_monitors; ++i)
 406             g_free(areas[i]);
 407         g_free(areas);
 408     }
 409
 410     if (settings->position.x.center)
 411         *x = screen->x + screen->width / 2 - client->area.width / 2;
 412     else if (settings->position.x.opposite)
 413         *x = screen->x + screen->width - client->frame->area.width -
 414             settings->position.x.pos;
 415     else
 416         *x = screen->x + settings->position.x.pos;
 417
 418     if (settings->position.y.center)
 419         *y = screen->y + screen->height / 2 - client->area.height / 2;
 420     else if (settings->position.y.opposite)
 421         *y = screen->y + screen->height - client->frame->area.height -
 422             settings->position.y.pos;
 423     else
 424         *y = screen->y + settings->position.y.pos;
 425
 426     g_free(screen);
 427     return TRUE;
 428 }
 429
 430 static gboolean place_transient_splash(ObClient *client, gint *x, gint *y)
 431 {
 432     if (client->type == OB_CLIENT_TYPE_DIALOG) {
 433         GSList *it;
 434         gboolean first = TRUE;
 435         gint l, r, t, b;
 436         for (it = client->parents; it; it = g_slist_next(it)) {
 437             ObClient *m = it->data;
 438             if (!m->iconic) {
 439                 if (first) {
 440                     l = RECT_LEFT(m->frame->area);
 441                     t = RECT_TOP(m->frame->area);
 442                     r = RECT_RIGHT(m->frame->area);
 443                     b = RECT_BOTTOM(m->frame->area);
 444                     first = FALSE;
 445                 } else {
 446                     l = MIN(l, RECT_LEFT(m->frame->area));
 447                     t = MIN(t, RECT_TOP(m->frame->area));
 448                     r = MAX(r, RECT_RIGHT(m->frame->area));
 449                     b = MAX(b, RECT_BOTTOM(m->frame->area));
 450                 }
 451             }
 452             if (!first) {
 453                 *x = ((r + 1 - l) - client->frame->area.width) / 2 + l;
 454                 *y = ((b + 1 - t) - client->frame->area.height) / 2 + t;
 455                 return TRUE;
 456             }
 457         }
 458     }
 459
 460     if (client->type == OB_CLIENT_TYPE_DIALOG ||
 461         client->type == OB_CLIENT_TYPE_SPLASH)
 462     {
 463         Rect **areas;
 464         guint i;
 465
 466         areas = pick_head(client);
 467
 468         *x = (areas[0]->width - client->frame->area.width) / 2 + areas[0]->x;
 469         *y = (areas[0]->height - client->frame->area.height) / 2 + areas[0]->y;
 470
 471         for (i = 0; i < screen_num_monitors; ++i)
 472             g_free(areas[i]);
 473         g_free(areas);
 474         return TRUE;
 475     }
 476
 477     return FALSE;
 478 }
 479
 480 /* Return TRUE if we want client.c to enforce on-screen-keeping */
 481 gboolean place_client(ObClient *client, gint *x, gint *y,
 482                       ObAppSettings *settings)
 483 {
 484     gboolean ret;
 485     gboolean userplaced = FALSE;
 486
 487     /* per-app settings override program specified position
 488      * but not user specified */
 489     if ((client->positioned & USPosition) ||
 490         ((client->positioned & PPosition) &&
 491          !(settings && settings->pos_given)))
 492         return FALSE;
 493
 494     /* try a number of methods */
 495     ret = place_transient_splash(client, x, y) ||
 496         (userplaced = place_per_app_setting(client, x, y, settings)) ||
 497         (config_place_policy == OB_PLACE_POLICY_MOUSE &&
 498          place_under_mouse(client, x, y)) ||
 499         place_nooverlap(client, x, y) ||
 500         place_random(client, x, y);
 501     g_assert(ret);
 502
 503     /* get where the client should be */
 504     frame_frame_gravity(client->frame, x, y);
 505     return !userplaced;
 506 }