Pileus Git - ~andy/gtk/blob - gtk/gtksizerequest.c

   1 /* gtksizerequest.c
   2  * Copyright (C) 2007-2010 Openismus GmbH
   3  *
   4  * Authors:
   5  *      Mathias Hasselmann <mathias@openismus.com>
   6  *      Tristan Van Berkom <tristan.van.berkom@gmail.com>
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24
  25 /**
  26  * SECTION:gtksizerequest
  27  * @Short_Description: Height-for-width geometry management
  28  * @Title: GtkSizeRequest
  29  *
  30  * The GtkSizeRequest interface is GTK+'s height-for-width (and width-for-height)
  31  * geometry management system. Height-for-width means that a widget can
  32  * change how much vertical space it needs, depending on the amount
  33  * of horizontal space that it is given (and similar for width-for-height).
  34  * The most common example is a label that reflows to fill up the available
  35  * width, wraps to fewer lines, and therefore needs less height.
  36  *
  37  * GTK+'s traditional two-pass <link linkend="size-allocation">size-allocation</link>
  38  * algorithm does not allow this flexibility. #GtkWidget provides a default
  39  * implementation of the #GtkSizeRequest interface for existing widgets,
  40  * which always requests the same height, regardless of the available width.
  41  *
  42  * <refsect2>
  43  * <title>Implementing GtkSizeRequest</title>
  44  * <para>
  45  * Some important things to keep in mind when implementing
  46  * the GtkSizeRequest interface and when using it in container
  47  * implementations.
  48  *
  49  * The geometry management system will query a logical hierarchy in
  50  * only one orientation at a time. When widgets are initially queried
  51  * for their minimum sizes it is generally done in a dual pass
  52  * in the direction chosen by the toplevel.
  53  *
  54  * For instance when queried in the normal height-for-width mode:
  55  * First the default minimum and natural width for each widget
  56  * in the interface will computed and collectively returned to
  57  * the toplevel by way of gtk_size_request_get_width().
  58  * Next, the toplevel will use the minimum width to query for the
  59  * minimum height contextual to that width using
  60  * gtk_size_request_get_height_for_width(), which will also be a
  61  * highly recursive operation. This minimum-for-minimum size can be
  62  * used to set the minimum size constraint on the toplevel.
  63  *
  64  * When allocating, each container can use the minimum and natural
  65  * sizes reported by their children to allocate natural sizes and
  66  * expose as much content as possible with the given allocation.
  67  *
  68  * That means that the request operation at allocation time will
  69  * usually fire again in contexts of different allocated sizes than
  70  * the ones originally queried for. #GtkSizeRequest caches a
  71  * small number of results to avoid re-querying for the same
  72  * allocated size in one allocation cycle.
  73  *
  74  * A widget that does not actually do height-for-width
  75  * or width-for-height size negotiations only has to implement
  76  * get_width() and get_height().
  77  *
  78  * If a widget does move content around to smartly use up the
  79  * allocated size, then it must support the request properly in
  80  * both orientations; even if the request only makes sense in
  81  * one orientation.
  82  *
  83  * For instance, a GtkLabel that does height-for-width word wrapping
  84  * will not expect to have get_height() called because that
  85  * call is specific to a width-for-height request, in this case the
  86  * label must return the heights contextual to its minimum possible
  87  * width. By following this rule any widget that handles height-for-width
  88  * or width-for-height requests will always be allocated at least
  89  * enough space to fit its own content.
  90  * </para>
  91  * </refsect2>
  92  */
  93
  94
  95 #include <config.h>
  96 #include "gtksizerequest.h"
  97 #include "gtksizegroup.h"
  98 #include "gtkprivate.h"
  99 #include "gtkintl.h"
 100
 101 typedef GtkSizeRequestIface GtkSizeRequestInterface;
 102 G_DEFINE_INTERFACE (GtkSizeRequest,
 103                     gtk_size_request,
 104                     GTK_TYPE_WIDGET);
 105
 106
 107 static void
 108 gtk_size_request_default_init (GtkSizeRequestInterface *iface)
 109 {
 110 }
 111
 112
 113 /* looks for a cached size request for this for_size. If not
 114  * found, returns the oldest entry so it can be overwritten
 115  *
 116  * Note that this caching code was directly derived from
 117  * the Clutter toolkit.
 118  */
 119 static gboolean
 120 get_cached_size (gint           for_size,
 121                  SizeRequest   *cached_sizes,
 122                  SizeRequest  **result)
 123 {
 124   guint i;
 125
 126   *result = &cached_sizes[0];
 127
 128   for (i = 0; i < GTK_SIZE_REQUEST_CACHED_SIZES; i++)
 129     {
 130       SizeRequest *cs;
 131
 132       cs = &cached_sizes[i];
 133
 134       if (cs->age > 0 && cs->for_size == for_size)
 135         {
 136           *result = cs;
 137           return TRUE;
 138         }
 139       else if (cs->age < (*result)->age)
 140         {
 141           *result = cs;
 142         }
 143     }
 144
 145   return FALSE;
 146 }
 147
 148 static void
 149 do_size_request (GtkWidget      *widget,
 150                  GtkRequisition *requisition)
 151 {
 152   /* Now we dont bother caching the deprecated "size-request" returns,
 153    * just unconditionally invoke here just in case we run into legacy stuff */
 154   gtk_widget_ensure_style (widget);
 155   g_signal_emit_by_name (widget, "size-request", requisition);
 156 }
 157
 158 #ifndef G_DISABLE_CHECKS
 159 static GQuark recursion_check_quark = 0;
 160 #endif /* G_DISABLE_CHECKS */
 161
 162 static void
 163 push_recursion_check (GtkSizeRequest  *request,
 164                       GtkSizeGroupMode orientation,
 165                       gint             for_size)
 166 {
 167 #ifndef G_DISABLE_CHECKS
 168   const char *previous_method;
 169   const char *method;
 170
 171   if (recursion_check_quark == 0)
 172     recursion_check_quark = g_quark_from_static_string ("gtk-size-request-in-progress");
 173
 174   previous_method = g_object_get_qdata (G_OBJECT (request), recursion_check_quark);
 175
 176   if (orientation == GTK_SIZE_GROUP_HORIZONTAL)
 177     {
 178       method = for_size < 0 ? "get_width" : "get_width_for_height";
 179     }
 180   else
 181     {
 182       method = for_size < 0 ? "get_height" : "get_height_for_width";
 183     }
 184
 185   if (previous_method != NULL)
 186     {
 187       g_warning ("%s %p: widget tried to gtk_size_request_%s inside "
 188                  " GtkSizeRequest::%s implementation. "
 189                  "Should just invoke GTK_SIZE_REQUEST_GET_IFACE(widget)->%s "
 190                  "directly rather than using gtk_size_request_%s",
 191                  G_OBJECT_TYPE_NAME (request), request,
 192                  method, previous_method,
 193                  method, method);
 194     }
 195
 196   g_object_set_qdata (G_OBJECT (request), recursion_check_quark, (char*) method);
 197 #endif /* G_DISABLE_CHECKS */
 198 }
 199
 200 static void
 201 pop_recursion_check (GtkSizeRequest  *request,
 202                      GtkSizeGroupMode orientation)
 203 {
 204 #ifndef G_DISABLE_CHECKS
 205   g_object_set_qdata (G_OBJECT (request), recursion_check_quark, NULL);
 206 #endif
 207 }
 208
 209 static void
 210 compute_size_for_orientation (GtkSizeRequest    *request,
 211                               GtkSizeGroupMode   orientation,
 212                               gint               for_size,
 213                               gint              *minimum_size,
 214                               gint              *natural_size)
 215 {
 216   SizeRequestCache *cache;
 217   SizeRequest      *cached_size;
 218   GtkWidget        *widget;
 219   gboolean          found_in_cache = FALSE;
 220
 221   g_return_if_fail (GTK_IS_SIZE_REQUEST (request));
 222   g_return_if_fail (minimum_size != NULL || natural_size != NULL);
 223
 224   widget = GTK_WIDGET (request);
 225   cache  = _gtk_widget_peek_request_cache (widget);
 226
 227   if (orientation == GTK_SIZE_GROUP_HORIZONTAL)
 228     {
 229       cached_size = &cache->widths[0];
 230
 231       if (!GTK_WIDGET_WIDTH_REQUEST_NEEDED (request))
 232         found_in_cache = get_cached_size (for_size, cache->widths, &cached_size);
 233       else
 234         {
 235           memset (cache->widths, 0, GTK_SIZE_REQUEST_CACHED_SIZES * sizeof (SizeRequest));
 236           cache->cached_width_age = 1;
 237         }
 238     }
 239   else
 240     {
 241       cached_size = &cache->heights[0];
 242
 243       if (!GTK_WIDGET_HEIGHT_REQUEST_NEEDED (request))
 244         found_in_cache = get_cached_size (for_size, cache->heights, &cached_size);
 245       else
 246         {
 247           memset (cache->heights, 0, GTK_SIZE_REQUEST_CACHED_SIZES * sizeof (SizeRequest));
 248           cache->cached_height_age = 1;
 249         }
 250     }
 251
 252   if (!found_in_cache)
 253     {
 254       GtkRequisition requisition = { 0, 0 };
 255       gint min_size = 0, nat_size = 0;
 256       gint group_size, requisition_size;
 257
 258       /* Unconditional size request runs but is often unhandled. */
 259       do_size_request (widget, &requisition);
 260
 261       push_recursion_check (request, orientation, for_size);
 262       if (orientation == GTK_SIZE_GROUP_HORIZONTAL)
 263         {
 264           requisition_size = requisition.width;
 265
 266           if (for_size < 0)
 267             GTK_SIZE_REQUEST_GET_IFACE (request)->get_width (request, &min_size, &nat_size);
 268           else
 269             GTK_SIZE_REQUEST_GET_IFACE (request)->get_width_for_height (request, for_size,
 270                                                                         &min_size, &nat_size);
 271         }
 272       else
 273         {
 274           requisition_size = requisition.height;
 275
 276           if (for_size < 0)
 277             GTK_SIZE_REQUEST_GET_IFACE (request)->get_height (request, &min_size, &nat_size);
 278           else
 279             GTK_SIZE_REQUEST_GET_IFACE (request)->get_height_for_width (request, for_size,
 280                                                                         &min_size, &nat_size);
 281         }
 282       pop_recursion_check (request, orientation);
 283
 284       if (min_size > nat_size)
 285         {
 286           g_warning ("%s %p reported min size %d and natural size %d; natural size must be >= min size",
 287                      G_OBJECT_TYPE_NAME (request), request, min_size, nat_size);
 288         }
 289
 290       /* Support for dangling "size-request" signal implementations on
 291        * legacy widgets
 292        */
 293       min_size = MAX (min_size, requisition_size);
 294       nat_size = MAX (nat_size, requisition_size);
 295
 296       cached_size->minimum_size = min_size;
 297       cached_size->natural_size = nat_size;
 298       cached_size->for_size     = for_size;
 299
 300       if (orientation == GTK_SIZE_GROUP_HORIZONTAL)
 301         {
 302           cached_size->age = cache->cached_width_age;
 303           cache->cached_width_age++;
 304
 305           GTK_PRIVATE_UNSET_FLAG (request, GTK_WIDTH_REQUEST_NEEDED);
 306         }
 307       else
 308         {
 309           cached_size->age = cache->cached_height_age;
 310           cache->cached_height_age++;
 311
 312           GTK_PRIVATE_UNSET_FLAG (request, GTK_HEIGHT_REQUEST_NEEDED);
 313         }
 314
 315       /* Get size groups to compute the base requisition once one
 316        * of the values have been cached, then go ahead and update
 317        * the cache with the sizegroup computed value.
 318        *
 319        * Note this is also where values from gtk_widget_set_size_request()
 320        * are considered.
 321        */
 322       group_size =
 323         _gtk_size_group_bump_requisition (GTK_WIDGET (request),
 324                                           orientation, cached_size->minimum_size);
 325
 326       cached_size->minimum_size = MAX (cached_size->minimum_size, group_size);
 327       cached_size->natural_size = MAX (cached_size->natural_size, group_size);
 328     }
 329
 330   if (minimum_size)
 331     *minimum_size = cached_size->minimum_size;
 332
 333   if (natural_size)
 334     *natural_size = cached_size->natural_size;
 335
 336   g_assert (cached_size->minimum_size <= cached_size->natural_size);
 337
 338   GTK_NOTE (SIZE_REQUEST,
 339             g_print ("[%p] %s\t%s: %d is minimum %d and natural: %d (hit cache: %s)\n",
 340                      request, G_OBJECT_TYPE_NAME (request),
 341                      orientation == GTK_SIZE_GROUP_HORIZONTAL ?
 342                      "width for height" : "height for width" ,
 343                      for_size,
 344                      cached_size->minimum_size,
 345                      cached_size->natural_size,
 346                      found_in_cache ? "yes" : "no"));
 347
 348 }
 349
 350 /**
 351  * gtk_size_request_get_request_mode:
 352  * @widget: a #GtkSizeRequest instance
 353  *
 354  * Gets whether the widget prefers a height-for-width layout
 355  * or a width-for-height layout.
 356  *
 357  * <note><para>#GtkBin widgets generally propagate the preference of
 358  * their child, container widgets need to request something either in
 359  * context of their children or in context of their allocation
 360  * capabilities.</para></note>
 361  *
 362  * Returns: The #GtkSizeRequestMode preferred by @widget.
 363  *
 364  * Since: 3.0
 365  */
 366 GtkSizeRequestMode
 367 gtk_size_request_get_request_mode (GtkSizeRequest *widget)
 368 {
 369   GtkSizeRequestIface *iface;
 370
 371   g_return_val_if_fail (GTK_IS_SIZE_REQUEST (widget), GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH);
 372
 373   iface = GTK_SIZE_REQUEST_GET_IFACE (widget);
 374   if (iface->get_request_mode)
 375     return iface->get_request_mode (widget);
 376
 377   /* By default widgets are height-for-width. */
 378   return GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH;
 379 }
 380
 381 /**
 382  * gtk_size_request_get_width:
 383  * @widget: a #GtkSizeRequest instance
 384  * @minimum_width: (out) (allow-none): location to store the minimum width, or %NULL
 385  * @natural_width: (out) (allow-none): location to store the natural width, or %NULL
 386  *
 387  * Retrieves a widget's initial minimum and natural width.
 388  *
 389  * <note><para>This call is specific to height-for-width
 390  * requests.</para></note>
 391  *
 392  * Since: 3.0
 393  */
 394 void
 395 gtk_size_request_get_width (GtkSizeRequest *widget,
 396                             gint           *minimum_width,
 397                             gint           *natural_width)
 398 {
 399   compute_size_for_orientation (widget, GTK_SIZE_GROUP_HORIZONTAL,
 400                                 -1, minimum_width, natural_width);
 401 }
 402
 403
 404 /**
 405  * gtk_size_request_get_height:
 406  * @widget: a #GtkSizeRequest instance
 407  * @minimum_height: (out) (allow-none): location to store the minimum height, or %NULL
 408  * @natural_height: (out) (allow-none): location to store the natural height, or %NULL
 409  *
 410  * Retrieves a widget's initial minimum and natural height.
 411  *
 412  * <note><para>This call is specific to width-for-height requests.</para></note>
 413  *
 414  * Since: 3.0
 415  */
 416 void
 417 gtk_size_request_get_height (GtkSizeRequest *widget,
 418                              gint           *minimum_height,
 419                              gint           *natural_height)
 420 {
 421   compute_size_for_orientation (widget, GTK_SIZE_GROUP_VERTICAL,
 422                                 -1, minimum_height, natural_height);
 423 }
 424
 425
 426
 427 /**
 428  * gtk_size_request_get_width_for_height:
 429  * @widget: a #GtkSizeRequest instance
 430  * @height: the height which is available for allocation
 431  * @minimum_width: (out) (allow-none): location for storing the minimum width, or %NULL
 432  * @natural_width: (out) (allow-none): location for storing the natural width, or %NULL
 433  *
 434  * Retrieves a widget's minimum and natural width if it would be given
 435  * the specified @height.
 436  *
 437  * Since: 3.0
 438  */
 439 void
 440 gtk_size_request_get_width_for_height (GtkSizeRequest *widget,
 441                                        gint            height,
 442                                        gint           *minimum_width,
 443                                        gint           *natural_width)
 444 {
 445   compute_size_for_orientation (widget, GTK_SIZE_GROUP_HORIZONTAL,
 446                                 height, minimum_width, natural_width);
 447 }
 448
 449 /**
 450  * gtk_size_request_get_height_for_width:
 451  * @widget: a #GtkSizeRequest instance
 452  * @width: the width which is available for allocation
 453  * @minimum_height: (out) (allow-none): location for storing the minimum height, or %NULL
 454  * @natural_height: (out) (allow-none): location for storing the natural height, or %NULL
 455  *
 456  * Retrieves a widget's minimum and natural height if it would be given
 457  * the specified @width.
 458  *
 459  * Since: 3.0
 460  */
 461 void
 462 gtk_size_request_get_height_for_width (GtkSizeRequest *widget,
 463                                        gint            width,
 464                                        gint           *minimum_height,
 465                                        gint           *natural_height)
 466 {
 467   compute_size_for_orientation (widget, GTK_SIZE_GROUP_VERTICAL,
 468                                 width, minimum_height, natural_height);
 469 }
 470
 471 /**
 472  * gtk_size_request_get_size:
 473  * @widget: a #GtkSizeRequest instance
 474  * @minimum_size: (out) (allow-none): location for storing the minimum size, or %NULL
 475  * @natural_size: (out) (allow-none): location for storing the natural size, or %NULL
 476  *
 477  * Retrieves the minimum and natural size of a widget taking
 478  * into account the widget's preference for height-for-width management.
 479  *
 480  * This is used to retrieve a suitable size by container widgets which do
 481  * not impose any restrictions on the child placement.
 482  *
 483  * Since: 3.0
 484  */
 485 void
 486 gtk_size_request_get_size (GtkSizeRequest    *widget,
 487                            GtkRequisition    *minimum_size,
 488                            GtkRequisition    *natural_size)
 489 {
 490   gint min_width, nat_width;
 491   gint min_height, nat_height;
 492
 493   g_return_if_fail (GTK_IS_SIZE_REQUEST (widget));
 494
 495   if (gtk_size_request_get_request_mode (widget) == GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH)
 496     {
 497       gtk_size_request_get_width (widget, &min_width, &nat_width);
 498
 499       if (minimum_size)
 500         {
 501           minimum_size->width = min_width;
 502           gtk_size_request_get_height_for_width (widget, min_width,
 503                                                  &minimum_size->height, NULL);
 504         }
 505
 506       if (natural_size)
 507         {
 508           natural_size->width = nat_width;
 509           gtk_size_request_get_height_for_width (widget, nat_width,
 510                                                  NULL, &natural_size->height);
 511         }
 512     }
 513   else /* GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT */
 514     {
 515       gtk_size_request_get_height (widget, &min_height, &nat_height);
 516
 517       if (minimum_size)
 518         {
 519           minimum_size->height = min_height;
 520           gtk_size_request_get_width_for_height (widget, min_height,
 521                                                  &minimum_size->width, NULL);
 522         }
 523
 524       if (natural_size)
 525         {
 526           natural_size->height = nat_height;
 527           gtk_size_request_get_width_for_height (widget, nat_height,
 528                                                  NULL, &natural_size->width);
 529         }
 530     }
 531 }
 532
 533
 534 static gint
 535 compare_gap (gconstpointer p1,
 536              gconstpointer p2,
 537              gpointer      data)
 538 {
 539   GtkRequestedSize *sizes = data;
 540   const guint *c1 = p1;
 541   const guint *c2 = p2;
 542
 543   const gint d1 = MAX (sizes[*c1].natural_size -
 544                        sizes[*c1].minimum_size,
 545                        0);
 546   const gint d2 = MAX (sizes[*c2].natural_size -
 547                        sizes[*c2].minimum_size,
 548                        0);
 549
 550   gint delta = (d2 - d1);
 551
 552   if (0 == delta)
 553     delta = (*c2 - *c1);
 554
 555   return delta;
 556 }
 557
 558 /**
 559  * gtk_distribute_natural_allocation:
 560  * @extra_space: Extra space to redistribute among children after subtracting
 561  *               minimum sizes and any child padding from the overall allocation
 562  * @n_requested_sizes: Number of requests to fit into the allocation
 563  * @sizes: An array of structs with a client pointer and a minimum/natural size
 564  *         in the orientation of the allocation.
 565  *
 566  * Distributes @extra_space to child @sizes by bringing up smaller
 567  * children up to natural size first.
 568  *
 569  * The remaining space will be added to the @minimum_size member of the
 570  * GtkRequestedSize struct. If all sizes reach their natural size then
 571  * the remaining space is returned.
 572  *
 573  * Returns: The remainder of @extra_space after redistributing space
 574  * to @sizes.
 575  */
 576 gint
 577 gtk_distribute_natural_allocation (gint              extra_space,
 578                                    guint             n_requested_sizes,
 579                                    GtkRequestedSize *sizes)
 580 {
 581   guint *spreading = g_newa (guint, n_requested_sizes);
 582   gint   i;
 583
 584   g_return_val_if_fail (extra_space >= 0, 0);
 585
 586   for (i = 0; i < n_requested_sizes; i++)
 587     spreading[i] = i;
 588
 589   /* Distribute the container's extra space c_gap. We want to assign
 590    * this space such that the sum of extra space assigned to children
 591    * (c^i_gap) is equal to c_cap. The case that there's not enough
 592    * space for all children to take their natural size needs some
 593    * attention. The goals we want to achieve are:
 594    *
 595    *   a) Maximize number of children taking their natural size.
 596    *   b) The allocated size of children should be a continuous
 597    *   function of c_gap.  That is, increasing the container size by
 598    *   one pixel should never make drastic changes in the distribution.
 599    *   c) If child i takes its natural size and child j doesn't,
 600    *   child j should have received at least as much gap as child i.
 601    *
 602    * The following code distributes the additional space by following
 603    * these rules.
 604    */
 605
 606   /* Sort descending by gap and position. */
 607   g_qsort_with_data (spreading,
 608                      n_requested_sizes, sizeof (guint),
 609                      compare_gap, sizes);
 610
 611   /* Distribute available space.
 612    * This master piece of a loop was conceived by Behdad Esfahbod.
 613    */
 614   for (i = n_requested_sizes - 1; extra_space > 0 && i >= 0; --i)
 615     {
 616       /* Divide remaining space by number of remaining children.
 617        * Sort order and reducing remaining space by assigned space
 618        * ensures that space is distributed equally.
 619        */
 620       gint glue = (extra_space + i) / (i + 1);
 621       gint gap = sizes[(spreading[i])].natural_size
 622         - sizes[(spreading[i])].minimum_size;
 623
 624       gint extra = MIN (glue, gap);
 625
 626       sizes[spreading[i]].minimum_size += extra;
 627
 628       extra_space -= extra;
 629     }
 630
 631   return extra_space;
 632 }
 633