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) {
 112         add_choice(choice, client_monitor(focus_client));
 113         ob_debug("placement adding choice %d for 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 = 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             r = NULL; /* dont free it */
 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
 222         g_free(r);
 223     }
 224     g_slist_free(list);
 225     return result;
 226 }
 227
 228 enum {
 229     IGNORE_FULLSCREEN = 1,
 230     IGNORE_MAXIMIZED  = 2,
 231     IGNORE_MENUTOOL   = 3,
 232     /*IGNORE_SHADED     = 3,*/
 233     IGNORE_NONGROUP   = 4,
 234     IGNORE_BELOW      = 5,
 235     /*IGNORE_NONFOCUS   = 1 << 5,*/
 236     IGNORE_DOCK       = 6,
 237     IGNORE_END        = 7
 238 };
 239
 240 static gboolean place_nooverlap(ObClient *c, gint *x, gint *y)
 241 {
 242     Rect **areas;
 243     gint ignore;
 244     gboolean ret;
 245     gint maxsize;
 246     GSList *spaces = NULL, *sit, *maxit;
 247     guint i;
 248
 249     areas = pick_head(c);
 250     ret = FALSE;
 251     maxsize = 0;
 252     maxit = NULL;
 253
 254     /* try ignoring different things to find empty space */
 255     for (ignore = 0; ignore < IGNORE_END && !ret; ignore++) {
 256         guint i;
 257
 258         /* try all monitors in order of preference */
 259         for (i = 0; i < screen_num_monitors && !ret; ++i) {
 260             GList *it;
 261
 262             /* add the whole monitor */
 263             spaces = area_add(spaces, areas[i]);
 264
 265             /* go thru all the windows */
 266             for (it = client_list; it; it = g_list_next(it)) {
 267                 ObClient *test = it->data;
 268
 269                 /* should we ignore this client? */
 270                 if (screen_showing_desktop) continue;
 271                 if (c == test) continue;
 272                 if (test->iconic) continue;
 273                 if (c->desktop != DESKTOP_ALL) {
 274                     if (test->desktop != c->desktop &&
 275                         test->desktop != DESKTOP_ALL) continue;
 276                 } else {
 277                     if (test->desktop != screen_desktop &&
 278                         test->desktop != DESKTOP_ALL) continue;
 279                 }
 280                 if (test->type == OB_CLIENT_TYPE_SPLASH ||
 281                     test->type == OB_CLIENT_TYPE_DESKTOP) continue;
 282
 283
 284                 if ((ignore >= IGNORE_FULLSCREEN) &&
 285                     test->fullscreen) continue;
 286                 if ((ignore >= IGNORE_MAXIMIZED) &&
 287                     test->max_horz && test->max_vert) continue;
 288                 if ((ignore >= IGNORE_MENUTOOL) &&
 289                     (test->type == OB_CLIENT_TYPE_MENU ||
 290                      test->type == OB_CLIENT_TYPE_TOOLBAR) &&
 291                     client_has_parent(c)) continue;
 292                 /*
 293                 if ((ignore >= IGNORE_SHADED) &&
 294                     test->shaded) continue;
 295                 */
 296                 if ((ignore >= IGNORE_NONGROUP) &&
 297                     client_has_group_siblings(c) &&
 298                     test->group != c->group) continue;
 299                 if ((ignore >= IGNORE_BELOW) &&
 300                     test->layer < c->layer) continue;
 301                 /*
 302                 if ((ignore >= IGNORE_NONFOCUS) &&
 303                     focus_client != test) continue;
 304                 */
 305                 /* don't ignore this window, so remove it from the available
 306                    area */
 307                 spaces = area_remove(spaces, &test->frame->area);
 308             }
 309
 310             if (ignore < IGNORE_DOCK) {
 311                 Rect a;
 312                 dock_get_area(&a);
 313                 spaces = area_remove(spaces, &a);
 314             }
 315
 316             for (sit = spaces; sit; sit = g_slist_next(sit)) {
 317                 Rect *r = sit->data;
 318
 319                 if (r->width >= c->frame->area.width &&
 320                     r->height >= c->frame->area.height &&
 321                     r->width * r->height > maxsize)
 322                 {
 323                     maxsize = r->width * r->height;
 324                     maxit = sit;
 325                 }
 326             }
 327
 328             if (maxit) {
 329                 Rect *r = maxit->data;
 330
 331                 /* center it in the area */
 332                 *x = r->x;
 333                 *y = r->y;
 334                 if (config_place_center) {
 335                     *x += (r->width - c->frame->area.width) / 2;
 336                     *y += (r->height - c->frame->area.height) / 2;
 337                 }
 338                 ret = TRUE;
 339             }
 340
 341             while (spaces) {
 342                 g_free(spaces->data);
 343                 spaces = g_slist_delete_link(spaces, spaces);
 344             }
 345         }
 346     }
 347
 348     for (i = 0; i < screen_num_monitors; ++i)
 349         g_free(areas[i]);
 350     g_free(areas);
 351     return ret;
 352 }
 353
 354 static gboolean place_under_mouse(ObClient *client, gint *x, gint *y)
 355 {
 356     gint l, r, t, b;
 357     gint px, py;
 358     Rect *area;
 359
 360     if (!screen_pointer_pos(&px, &py))
 361         return FALSE;
 362     area = pick_pointer_head(client);
 363
 364     l = area->x;
 365     t = area->y;
 366     r = area->x + area->width - client->frame->area.width;
 367     b = area->y + area->height - client->frame->area.height;
 368
 369     *x = px - client->area.width / 2 - client->frame->size.left;
 370     *x = MIN(MAX(*x, l), r);
 371     *y = py - client->area.height / 2 - client->frame->size.top;
 372     *y = MIN(MAX(*y, t), b);
 373
 374     return TRUE;
 375 }
 376
 377 static gboolean place_per_app_setting(ObClient *client, gint *x, gint *y,
 378                                       ObAppSettings *settings)
 379 {
 380     Rect *screen = NULL;
 381
 382     if (!settings || (settings && !settings->pos_given))
 383         return FALSE;
 384
 385     /* Find which head the pointer is on */
 386     if (settings->monitor == 0)
 387         /* this can return NULL */
 388         screen = pick_pointer_head(client);
 389     else if (settings->monitor > 0 &&
 390              (guint)settings->monitor <= screen_num_monitors)
 391         screen = screen_area(client->desktop, (guint)settings->monitor - 1,
 392                              NULL);
 393
 394     /* if we have't found a screen yet.. */
 395     if (!screen) {
 396         Rect **areas;
 397         guint i;
 398
 399         areas = pick_head(client);
 400         screen = areas[0];
 401
 402         /* don't free the first one, it's being set as "screen" */
 403         for (i = 1; i < screen_num_monitors; ++i)
 404             g_free(areas[i]);
 405         g_free(areas);
 406     }
 407
 408     if (settings->center_x)
 409         *x = screen->x + screen->width / 2 - client->area.width / 2;
 410     else if (settings->opposite_x)
 411         *x = screen->x + screen->width - client->frame->area.width -
 412             settings->position.x;
 413     else
 414         *x = screen->x + settings->position.x;
 415
 416     if (settings->center_y)
 417         *y = screen->y + screen->height / 2 - client->area.height / 2;
 418     else if (settings->opposite_y)
 419         *y = screen->y + screen->height - client->frame->area.height -
 420             settings->position.y;
 421     else
 422         *y = screen->y + settings->position.y;
 423
 424     g_free(screen);
 425     return TRUE;
 426 }
 427
 428 static gboolean place_transient_splash(ObClient *client, gint *x, gint *y)
 429 {
 430     if (client->type == OB_CLIENT_TYPE_DIALOG) {
 431         GSList *it;
 432         gboolean first = TRUE;
 433         gint l, r, t, b;
 434         for (it = client->parents; it; it = g_slist_next(it)) {
 435             ObClient *m = it->data;
 436             if (!m->iconic) {
 437                 if (first) {
 438                     l = RECT_LEFT(m->frame->area);
 439                     t = RECT_TOP(m->frame->area);
 440                     r = RECT_RIGHT(m->frame->area);
 441                     b = RECT_BOTTOM(m->frame->area);
 442                     first = FALSE;
 443                 } else {
 444                     l = MIN(l, RECT_LEFT(m->frame->area));
 445                     t = MIN(t, RECT_TOP(m->frame->area));
 446                     r = MAX(r, RECT_RIGHT(m->frame->area));
 447                     b = MAX(b, RECT_BOTTOM(m->frame->area));
 448                 }
 449             }
 450             if (!first) {
 451                 *x = ((r + 1 - l) - client->frame->area.width) / 2 + l;
 452                 *y = ((b + 1 - t) - client->frame->area.height) / 2 + t;
 453                 return TRUE;
 454             }
 455         }
 456     }
 457
 458     if (client->type == OB_CLIENT_TYPE_DIALOG ||
 459         client->type == OB_CLIENT_TYPE_SPLASH)
 460     {
 461         Rect **areas;
 462         guint i;
 463
 464         areas = pick_head(client);
 465
 466         *x = (areas[0]->width - client->frame->area.width) / 2 + areas[0]->x;
 467         *y = (areas[0]->height - client->frame->area.height) / 2 + areas[0]->y;
 468
 469         for (i = 0; i < screen_num_monitors; ++i)
 470             g_free(areas[i]);
 471         g_free(areas);
 472         return TRUE;
 473     }
 474
 475     return FALSE;
 476 }
 477
 478 /* Return TRUE if we want client.c to enforce on-screen-keeping */
 479 gboolean place_client(ObClient *client, gint *x, gint *y,
 480                       ObAppSettings *settings)
 481 {
 482     gboolean ret;
 483     gboolean userplaced = FALSE;
 484
 485     /* per-app settings override program specified position
 486      * but not user specified */
 487     if ((client->positioned & USPosition) ||
 488         ((client->positioned & PPosition) &&
 489          !(settings && settings->pos_given)))
 490         return FALSE;
 491
 492     /* try a number of methods */
 493     ret = place_transient_splash(client, x, y) ||
 494         (userplaced = place_per_app_setting(client, x, y, settings)) ||
 495         (config_place_policy == OB_PLACE_POLICY_MOUSE &&
 496          place_under_mouse(client, x, y)) ||
 497         place_nooverlap(client, x, y) ||
 498         place_random(client, x, y);
 499     g_assert(ret);
 500
 501     /* get where the client should be */
 502     frame_frame_gravity(client->frame, x, y);
 503     return !userplaced;
 504 }