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, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #include <config.h>
  23
  24 #include "gtksizerequest.h"
  25
  26 #include "gtkdebug.h"
  27 #include "gtkintl.h"
  28 #include "gtkprivate.h"
  29 #include "gtksizegroup-private.h"
  30 #include "gtkwidgetprivate.h"
  31 #include "deprecated/gtkstyle.h"
  32
  33
  34 #ifndef G_DISABLE_CHECKS
  35 static GQuark recursion_check_quark = 0;
  36 #endif /* G_DISABLE_CHECKS */
  37
  38 static void
  39 push_recursion_check (GtkWidget       *widget,
  40                       GtkSizeGroupMode orientation,
  41                       gint             for_size)
  42 {
  43 #ifndef G_DISABLE_CHECKS
  44   const char *previous_method;
  45   const char *method;
  46
  47   if (recursion_check_quark == 0)
  48     recursion_check_quark = g_quark_from_static_string ("gtk-size-request-in-progress");
  49
  50   previous_method = g_object_get_qdata (G_OBJECT (widget), recursion_check_quark);
  51
  52   if (orientation == GTK_SIZE_GROUP_HORIZONTAL)
  53     {
  54       method = for_size < 0 ? "get_width" : "get_width_for_height";
  55     }
  56   else
  57     {
  58       method = for_size < 0 ? "get_height" : "get_height_for_width";
  59     }
  60
  61   if (previous_method != NULL)
  62     {
  63       g_warning ("%s %p: widget tried to gtk_widget_%s inside "
  64                  " GtkWidget     ::%s implementation. "
  65                  "Should just invoke GTK_WIDGET_GET_CLASS(widget)->%s "
  66                  "directly rather than using gtk_widget_%s",
  67                  G_OBJECT_TYPE_NAME (widget), widget,
  68                  method, previous_method,
  69                  method, method);
  70     }
  71
  72   g_object_set_qdata (G_OBJECT (widget), recursion_check_quark, (char*) method);
  73 #endif /* G_DISABLE_CHECKS */
  74 }
  75
  76 static void
  77 pop_recursion_check (GtkWidget       *widget,
  78                      GtkSizeGroupMode orientation)
  79 {
  80 #ifndef G_DISABLE_CHECKS
  81   g_object_set_qdata (G_OBJECT (widget), recursion_check_quark, NULL);
  82 #endif
  83 }
  84
  85
  86 static void
  87 clear_cache (SizeRequestCache   *cache,
  88              GtkSizeGroupMode    orientation)
  89 {
  90   SizeRequest **sizes;
  91   gint          i;
  92
  93   if (orientation == GTK_SIZE_GROUP_HORIZONTAL)
  94     {
  95       sizes = cache->widths;
  96
  97       cache->widths            = NULL;
  98       cache->cached_widths     = 0;
  99       cache->last_cached_width = 0;
 100       cache->cached_base_width = FALSE;
 101     }
 102   else
 103     {
 104       sizes = cache->heights;
 105
 106       cache->heights            = NULL;
 107       cache->cached_heights     = 0;
 108       cache->last_cached_height = 0;
 109       cache->cached_base_height = FALSE;
 110    }
 111
 112   if (sizes)
 113     {
 114       for (i = 0; i < GTK_SIZE_REQUEST_CACHED_SIZES && sizes[i] != NULL; i++)
 115         g_slice_free (SizeRequest, sizes[i]);
 116
 117       g_slice_free1 (sizeof (SizeRequest *) * GTK_SIZE_REQUEST_CACHED_SIZES, sizes);
 118     }
 119 }
 120
 121 void
 122 _gtk_widget_free_cached_sizes (GtkWidget *widget)
 123 {
 124   SizeRequestCache   *cache;
 125
 126   cache = _gtk_widget_peek_request_cache (widget);
 127
 128   clear_cache (cache, GTK_SIZE_GROUP_HORIZONTAL);
 129   clear_cache (cache, GTK_SIZE_GROUP_VERTICAL);
 130 }
 131
 132 /* This function checks if 'request_needed' flag is present
 133  * and resets the cache state if a request is needed for
 134  * a given orientation.
 135  */
 136 static SizeRequestCache *
 137 init_cache (GtkWidget        *widget)
 138 {
 139   SizeRequestCache *cache;
 140
 141   cache = _gtk_widget_peek_request_cache (widget);
 142
 143   if (_gtk_widget_get_width_request_needed (widget))
 144     clear_cache (cache, GTK_SIZE_GROUP_HORIZONTAL);
 145
 146   if (_gtk_widget_get_height_request_needed (widget))
 147     clear_cache (cache, GTK_SIZE_GROUP_VERTICAL);
 148
 149   return cache;
 150 }
 151
 152 /* looks for a cached size request for this for_size. If not
 153  * found, returns the oldest entry so it can be overwritten
 154  *
 155  * Note that this caching code was originally derived from
 156  * the Clutter toolkit but has evolved for other GTK+ requirements.
 157  */
 158 static gboolean
 159 get_cached_size (GtkWidget         *widget,
 160                  GtkSizeGroupMode   orientation,
 161                  gint               for_size,
 162                  CachedSize       **result)
 163 {
 164   SizeRequestCache  *cache;
 165   SizeRequest      **cached_sizes;
 166   guint              i, n_sizes;
 167
 168   cache = init_cache (widget);
 169
 170   if (for_size < 0)
 171     {
 172       if (orientation == GTK_SIZE_GROUP_HORIZONTAL)
 173         {
 174           *result = &cache->cached_width;
 175           return cache->cached_base_width;
 176         }
 177       else
 178         {
 179           *result = &cache->cached_height;
 180           return cache->cached_base_height;
 181         }
 182     }
 183
 184   if (orientation == GTK_SIZE_GROUP_HORIZONTAL)
 185     {
 186       cached_sizes = cache->widths;
 187       n_sizes      = cache->cached_widths;
 188     }
 189   else
 190     {
 191       cached_sizes = cache->heights;
 192       n_sizes      = cache->cached_heights;
 193     }
 194
 195   /* Search for an already cached size */
 196   for (i = 0; i < n_sizes; i++)
 197     {
 198       if (cached_sizes[i]->lower_for_size <= for_size &&
 199           cached_sizes[i]->upper_for_size >= for_size)
 200         {
 201           *result = &cached_sizes[i]->cached_size;
 202           return TRUE;
 203         }
 204     }
 205
 206   return FALSE;
 207 }
 208
 209 static void
 210 commit_cached_size (GtkWidget         *widget,
 211                     GtkSizeGroupMode   orientation,
 212                     gint               for_size,
 213                     gint               minimum_size,
 214                     gint               natural_size)
 215 {
 216   SizeRequestCache  *cache;
 217   SizeRequest      **cached_sizes;
 218   guint              i, n_sizes;
 219
 220   cache = _gtk_widget_peek_request_cache (widget);
 221
 222   /* First handle caching of the base requests */
 223   if (for_size < 0)
 224     {
 225       if (orientation == GTK_SIZE_GROUP_HORIZONTAL)
 226         {
 227           cache->cached_width.minimum_size = minimum_size;
 228           cache->cached_width.natural_size = natural_size;
 229           cache->cached_base_width = TRUE;
 230         }
 231       else
 232         {
 233           cache->cached_height.minimum_size = minimum_size;
 234           cache->cached_height.natural_size = natural_size;
 235           cache->cached_base_height = TRUE;
 236         }
 237       return;
 238     }
 239
 240   /* Check if the minimum_size and natural_size is already
 241    * in the cache and if this result can be used to extend
 242    * that cache entry
 243    */
 244   if (orientation == GTK_SIZE_GROUP_HORIZONTAL)
 245     {
 246       cached_sizes = cache->widths;
 247       n_sizes = cache->cached_widths;
 248     }
 249   else
 250     {
 251       cached_sizes = cache->heights;
 252       n_sizes = cache->cached_heights;
 253     }
 254
 255   for (i = 0; i < n_sizes; i++)
 256     {
 257       if (cached_sizes[i]->cached_size.minimum_size == minimum_size &&
 258           cached_sizes[i]->cached_size.natural_size == natural_size)
 259         {
 260           cached_sizes[i]->lower_for_size = MIN (cached_sizes[i]->lower_for_size, for_size);
 261           cached_sizes[i]->upper_for_size = MAX (cached_sizes[i]->upper_for_size, for_size);
 262           return;
 263         }
 264     }
 265
 266   /* If not found, pull a new size from the cache, the returned size cache
 267    * will immediately be used to cache the new computed size so we go ahead
 268    * and increment the last_cached_width/height right away */
 269   if (orientation == GTK_SIZE_GROUP_HORIZONTAL)
 270     {
 271       if (cache->cached_widths < GTK_SIZE_REQUEST_CACHED_SIZES)
 272         {
 273           cache->cached_widths++;
 274           cache->last_cached_width = cache->cached_widths - 1;
 275         }
 276       else
 277         {
 278           if (++cache->last_cached_width == GTK_SIZE_REQUEST_CACHED_SIZES)
 279             cache->last_cached_width = 0;
 280         }
 281
 282       if (!cache->widths)
 283         cache->widths = g_slice_alloc0 (sizeof (SizeRequest *) * GTK_SIZE_REQUEST_CACHED_SIZES);
 284
 285       if (!cache->widths[cache->last_cached_width])
 286         cache->widths[cache->last_cached_width] = g_slice_new (SizeRequest);
 287
 288       cache->widths[cache->last_cached_width]->lower_for_size = for_size;
 289       cache->widths[cache->last_cached_width]->upper_for_size = for_size;
 290       cache->widths[cache->last_cached_width]->cached_size.minimum_size = minimum_size;
 291       cache->widths[cache->last_cached_width]->cached_size.natural_size = natural_size;
 292     }
 293   else /* GTK_SIZE_GROUP_VERTICAL */
 294     {
 295       if (cache->cached_heights < GTK_SIZE_REQUEST_CACHED_SIZES)
 296         {
 297           cache->cached_heights++;
 298           cache->last_cached_height = cache->cached_heights - 1;
 299         }
 300       else
 301         {
 302           if (++cache->last_cached_height == GTK_SIZE_REQUEST_CACHED_SIZES)
 303             cache->last_cached_height = 0;
 304         }
 305
 306       if (!cache->heights)
 307         cache->heights = g_slice_alloc0 (sizeof (SizeRequest *) * GTK_SIZE_REQUEST_CACHED_SIZES);
 308
 309       if (!cache->heights[cache->last_cached_height])
 310         cache->heights[cache->last_cached_height] = g_slice_new (SizeRequest);
 311
 312       cache->heights[cache->last_cached_height]->lower_for_size = for_size;
 313       cache->heights[cache->last_cached_height]->upper_for_size = for_size;
 314       cache->heights[cache->last_cached_height]->cached_size.minimum_size = minimum_size;
 315       cache->heights[cache->last_cached_height]->cached_size.natural_size = natural_size;
 316     }
 317 }
 318
 319 static const char *
 320 get_vfunc_name (GtkSizeGroupMode orientation,
 321                 gint             for_size)
 322 {
 323   if (orientation == GTK_SIZE_GROUP_HORIZONTAL)
 324     return for_size < 0 ? "get_preferred_width" : "get_preferred_width_for_height";
 325   else
 326     return for_size < 0 ? "get_preferred_height" : "get_preferred_height_for_width";
 327 }
 328
 329 /* This is the main function that checks for a cached size and
 330  * possibly queries the widget class to compute the size if it's
 331  * not cached. If the for_size here is -1, then get_preferred_width()
 332  * or get_preferred_height() will be used.
 333  */
 334 void
 335 _gtk_widget_compute_size_for_orientation (GtkWidget         *widget,
 336                                           GtkSizeGroupMode   orientation,
 337                                           gboolean           ignore_size_groups,
 338                                           gint               for_size,
 339                                           gint              *minimum_size,
 340                                           gint              *natural_size)
 341 {
 342   CachedSize       *cached_size;
 343   gboolean          found_in_cache = FALSE;
 344   gint              min_size = 0;
 345   gint              nat_size = 0;
 346
 347   found_in_cache = get_cached_size (widget, orientation, for_size, &cached_size);
 348
 349   if (!found_in_cache)
 350     {
 351       gint adjusted_min, adjusted_natural, adjusted_for_size = for_size;
 352
 353       gtk_widget_ensure_style (widget);
 354
 355       if (orientation == GTK_SIZE_GROUP_HORIZONTAL)
 356         {
 357           if (for_size < 0 || gtk_widget_get_request_mode (widget) == GTK_SIZE_REQUEST_CONSTANT_SIZE)
 358             {
 359               push_recursion_check (widget, orientation, for_size);
 360               GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, &min_size, &nat_size);
 361               pop_recursion_check (widget, orientation);
 362             }
 363           else
 364             {
 365               gint ignored_position = 0;
 366               gint minimum_height;
 367               gint natural_height;
 368
 369               /* Pull the base natural height from the cache as it's needed to adjust
 370                * the proposed 'for_size' */
 371               gtk_widget_get_preferred_height (widget, &minimum_height, &natural_height);
 372
 373               /* convert for_size to unadjusted height (for_size is a proposed allocation) */
 374               GTK_WIDGET_GET_CLASS (widget)->adjust_size_allocation (widget,
 375                                                                      GTK_ORIENTATION_VERTICAL,
 376                                                                      &minimum_height,
 377                                                                      &natural_height,
 378                                                                      &ignored_position,
 379                                                                      &adjusted_for_size);
 380
 381               push_recursion_check (widget, orientation, for_size);
 382               GTK_WIDGET_GET_CLASS (widget)->get_preferred_width_for_height (widget,
 383                                                                              MAX (adjusted_for_size, minimum_height),
 384                                                                              &min_size, &nat_size);
 385               pop_recursion_check (widget, orientation);
 386             }
 387         }
 388       else
 389         {
 390           if (for_size < 0 || gtk_widget_get_request_mode (widget) == GTK_SIZE_REQUEST_CONSTANT_SIZE)
 391             {
 392               push_recursion_check (widget, orientation, for_size);
 393               GTK_WIDGET_GET_CLASS (widget)->get_preferred_height (widget, &min_size, &nat_size);
 394               pop_recursion_check (widget, orientation);
 395             }
 396           else
 397             {
 398               gint ignored_position = 0;
 399               gint minimum_width;
 400               gint natural_width;
 401
 402               /* Pull the base natural width from the cache as it's needed to adjust
 403                * the proposed 'for_size' */
 404               gtk_widget_get_preferred_width (widget, &minimum_width, &natural_width);
 405
 406               /* convert for_size to unadjusted width (for_size is a proposed allocation) */
 407               GTK_WIDGET_GET_CLASS (widget)->adjust_size_allocation (widget,
 408                                                                      GTK_ORIENTATION_HORIZONTAL,
 409                                                                      &minimum_width,
 410                                                                      &natural_width,
 411                                                                      &ignored_position,
 412                                                                      &adjusted_for_size);
 413
 414               push_recursion_check (widget, orientation, for_size);
 415               GTK_WIDGET_GET_CLASS (widget)->get_preferred_height_for_width (widget,
 416                                                                              MAX (adjusted_for_size, minimum_width),
 417                                                                              &min_size, &nat_size);
 418               pop_recursion_check (widget, orientation);
 419             }
 420         }
 421
 422       if (min_size > nat_size)
 423         {
 424           g_warning ("%s %p reported min size %d and natural size %d in %s(); natural size must be >= min size",
 425                      G_OBJECT_TYPE_NAME (widget), widget, min_size, nat_size, get_vfunc_name (orientation, for_size));
 426         }
 427
 428       if (orientation == GTK_SIZE_GROUP_HORIZONTAL)
 429           _gtk_widget_set_width_request_needed (widget, FALSE);
 430       else
 431           _gtk_widget_set_height_request_needed (widget, FALSE);
 432
 433       adjusted_min     = min_size;
 434       adjusted_natural = nat_size;
 435       GTK_WIDGET_GET_CLASS (widget)->adjust_size_request (widget,
 436                                                           orientation == GTK_SIZE_GROUP_HORIZONTAL ?
 437                                                           GTK_ORIENTATION_HORIZONTAL :
 438                                                           GTK_ORIENTATION_VERTICAL,
 439                                                           &adjusted_min,
 440                                                           &adjusted_natural);
 441
 442       if (adjusted_min < min_size ||
 443           adjusted_natural < nat_size)
 444         {
 445           g_warning ("%s %p adjusted size %s min %d natural %d must not decrease below min %d natural %d",
 446                      G_OBJECT_TYPE_NAME (widget), widget,
 447                      orientation == GTK_SIZE_GROUP_VERTICAL ? "vertical" : "horizontal",
 448                      adjusted_min, adjusted_natural,
 449                      min_size, nat_size);
 450           /* don't use the adjustment */
 451         }
 452       else if (adjusted_min > adjusted_natural)
 453         {
 454           g_warning ("%s %p adjusted size %s min %d natural %d original min %d natural %d has min greater than natural",
 455                      G_OBJECT_TYPE_NAME (widget), widget,
 456                      orientation == GTK_SIZE_GROUP_VERTICAL ? "vertical" : "horizontal",
 457                      adjusted_min, adjusted_natural,
 458                      min_size, nat_size);
 459           /* don't use the adjustment */
 460         }
 461       else
 462         {
 463           /* adjustment looks good */
 464           min_size = adjusted_min;
 465           nat_size = adjusted_natural;
 466         }
 467
 468       commit_cached_size (widget, orientation, for_size, min_size, nat_size);
 469     }
 470   else
 471     {
 472       min_size = cached_size->minimum_size;
 473       nat_size = cached_size->natural_size;
 474     }
 475
 476   if (!ignore_size_groups)
 477     _gtk_size_group_bump_requisition (widget,
 478                                       orientation,
 479                                       for_size,
 480                                       &min_size,
 481                                       &nat_size);
 482
 483   if (minimum_size)
 484     *minimum_size = min_size;
 485
 486   if (natural_size)
 487     *natural_size = nat_size;
 488
 489   g_assert (min_size <= nat_size);
 490
 491   GTK_NOTE (SIZE_REQUEST,
 492             g_print ("[%p] %s\t%s: %d is minimum %d and natural: %d (hit cache: %s, ignore size groups: %s)\n",
 493                      widget, G_OBJECT_TYPE_NAME (widget),
 494                      orientation == GTK_SIZE_GROUP_HORIZONTAL ?
 495                      "width for height" : "height for width" ,
 496                      for_size, min_size, nat_size,
 497                      found_in_cache ? "yes" : "no",
 498                      ignore_size_groups ? "yes" : "no"));
 499
 500 }
 501
 502 /**
 503  * gtk_widget_get_request_mode:
 504  * @widget: a #GtkWidget instance
 505  *
 506  * Gets whether the widget prefers a height-for-width layout
 507  * or a width-for-height layout.
 508  *
 509  * <note><para>#GtkBin widgets generally propagate the preference of
 510  * their child, container widgets need to request something either in
 511  * context of their children or in context of their allocation
 512  * capabilities.</para></note>
 513  *
 514  * Returns: The #GtkSizeRequestMode preferred by @widget.
 515  *
 516  * Since: 3.0
 517  */
 518 GtkSizeRequestMode
 519 gtk_widget_get_request_mode (GtkWidget *widget)
 520 {
 521   g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_SIZE_REQUEST_CONSTANT_SIZE);
 522
 523   return GTK_WIDGET_GET_CLASS (widget)->get_request_mode (widget);
 524 }
 525
 526 /**
 527  * gtk_widget_get_preferred_width:
 528  * @widget: a #GtkWidget instance
 529  * @minimum_width: (out) (allow-none): location to store the minimum width, or %NULL
 530  * @natural_width: (out) (allow-none): location to store the natural width, or %NULL
 531  *
 532  * Retrieves a widget's initial minimum and natural width.
 533  *
 534  * <note><para>This call is specific to height-for-width
 535  * requests.</para></note>
 536  *
 537  * The returned request will be modified by the
 538  * GtkWidgetClass::adjust_size_request virtual method and by any
 539  * #GtkSizeGroup<!-- -->s that have been applied. That is, the returned request
 540  * is the one that should be used for layout, not necessarily the one
 541  * returned by the widget itself.
 542  *
 543  * Since: 3.0
 544  */
 545 void
 546 gtk_widget_get_preferred_width (GtkWidget *widget,
 547                                 gint      *minimum_width,
 548                                 gint      *natural_width)
 549 {
 550   g_return_if_fail (GTK_IS_WIDGET (widget));
 551   g_return_if_fail (minimum_width != NULL || natural_width != NULL);
 552
 553   _gtk_widget_compute_size_for_orientation (widget,
 554                                             GTK_SIZE_GROUP_HORIZONTAL,
 555                                             FALSE,
 556                                             -1,
 557                                             minimum_width,
 558                                             natural_width);
 559 }
 560
 561
 562 /**
 563  * gtk_widget_get_preferred_height:
 564  * @widget: a #GtkWidget instance
 565  * @minimum_height: (out) (allow-none): location to store the minimum height, or %NULL
 566  * @natural_height: (out) (allow-none): location to store the natural height, or %NULL
 567  *
 568  * Retrieves a widget's initial minimum and natural height.
 569  *
 570  * <note><para>This call is specific to width-for-height requests.</para></note>
 571  *
 572  * The returned request will be modified by the
 573  * GtkWidgetClass::adjust_size_request virtual method and by any
 574  * #GtkSizeGroup<!-- -->s that have been applied. That is, the returned request
 575  * is the one that should be used for layout, not necessarily the one
 576  * returned by the widget itself.
 577  *
 578  * Since: 3.0
 579  */
 580 void
 581 gtk_widget_get_preferred_height (GtkWidget *widget,
 582                                  gint      *minimum_height,
 583                                  gint      *natural_height)
 584 {
 585   g_return_if_fail (GTK_IS_WIDGET (widget));
 586   g_return_if_fail (minimum_height != NULL || natural_height != NULL);
 587
 588   _gtk_widget_compute_size_for_orientation (widget,
 589                                             GTK_SIZE_GROUP_VERTICAL,
 590                                             FALSE,
 591                                             -1,
 592                                             minimum_height,
 593                                             natural_height);
 594 }
 595
 596
 597
 598 /**
 599  * gtk_widget_get_preferred_width_for_height:
 600  * @widget: a #GtkWidget instance
 601  * @height: the height which is available for allocation
 602  * @minimum_width: (out) (allow-none): location for storing the minimum width, or %NULL
 603  * @natural_width: (out) (allow-none): location for storing the natural width, or %NULL
 604  *
 605  * Retrieves a widget's minimum and natural width if it would be given
 606  * the specified @height.
 607  *
 608  * The returned request will be modified by the
 609  * GtkWidgetClass::adjust_size_request virtual method and by any
 610  * #GtkSizeGroup<!-- -->s that have been applied. That is, the returned request
 611  * is the one that should be used for layout, not necessarily the one
 612  * returned by the widget itself.
 613  *
 614  * Since: 3.0
 615  */
 616 void
 617 gtk_widget_get_preferred_width_for_height (GtkWidget *widget,
 618                                            gint       height,
 619                                            gint      *minimum_width,
 620                                            gint      *natural_width)
 621 {
 622   g_return_if_fail (GTK_IS_WIDGET (widget));
 623   g_return_if_fail (minimum_width != NULL || natural_width != NULL);
 624   g_return_if_fail (height >= 0);
 625
 626   _gtk_widget_compute_size_for_orientation (widget,
 627                                             GTK_SIZE_GROUP_HORIZONTAL,
 628                                             FALSE,
 629                                             height,
 630                                             minimum_width,
 631                                             natural_width);
 632 }
 633
 634 /**
 635  * gtk_widget_get_preferred_height_for_width:
 636  * @widget: a #GtkWidget instance
 637  * @width: the width which is available for allocation
 638  * @minimum_height: (out) (allow-none): location for storing the minimum height, or %NULL
 639  * @natural_height: (out) (allow-none): location for storing the natural height, or %NULL
 640  *
 641  * Retrieves a widget's minimum and natural height if it would be given
 642  * the specified @width.
 643  *
 644  * The returned request will be modified by the
 645  * GtkWidgetClass::adjust_size_request virtual method and by any
 646  * #GtkSizeGroup<!-- -->s that have been applied. That is, the returned request
 647  * is the one that should be used for layout, not necessarily the one
 648  * returned by the widget itself.
 649  *
 650  * Since: 3.0
 651  */
 652 void
 653 gtk_widget_get_preferred_height_for_width (GtkWidget *widget,
 654                                            gint       width,
 655                                            gint      *minimum_height,
 656                                            gint      *natural_height)
 657 {
 658   g_return_if_fail (GTK_IS_WIDGET (widget));
 659   g_return_if_fail (minimum_height != NULL || natural_height != NULL);
 660   g_return_if_fail (width >= 0);
 661
 662   _gtk_widget_compute_size_for_orientation (widget,
 663                                             GTK_SIZE_GROUP_VERTICAL,
 664                                             FALSE,
 665                                             width,
 666                                             minimum_height,
 667                                             natural_height);
 668 }
 669
 670 /**
 671  * gtk_widget_get_preferred_size:
 672  * @widget: a #GtkWidget instance
 673  * @minimum_size: (out) (allow-none): location for storing the minimum size, or %NULL
 674  * @natural_size: (out) (allow-none): location for storing the natural size, or %NULL
 675  *
 676  * Retrieves the minimum and natural size of a widget, taking
 677  * into account the widget's preference for height-for-width management.
 678  *
 679  * This is used to retrieve a suitable size by container widgets which do
 680  * not impose any restrictions on the child placement. It can be used
 681  * to deduce toplevel window and menu sizes as well as child widgets in
 682  * free-form containers such as GtkLayout.
 683  *
 684  * <note><para>Handle with care. Note that the natural height of a height-for-width
 685  * widget will generally be a smaller size than the minimum height, since the required
 686  * height for the natural width is generally smaller than the required height for
 687  * the minimum width.</para></note>
 688  *
 689  * Since: 3.0
 690  */
 691 void
 692 gtk_widget_get_preferred_size (GtkWidget      *widget,
 693                                GtkRequisition *minimum_size,
 694                                GtkRequisition *natural_size)
 695 {
 696   gint min_width, nat_width;
 697   gint min_height, nat_height;
 698
 699   g_return_if_fail (GTK_IS_WIDGET (widget));
 700
 701   if (gtk_widget_get_request_mode (widget) == GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH)
 702     {
 703       gtk_widget_get_preferred_width (widget, &min_width, &nat_width);
 704
 705       if (minimum_size)
 706         {
 707           minimum_size->width = min_width;
 708           gtk_widget_get_preferred_height_for_width (widget, min_width,
 709                                                      &minimum_size->height, NULL);
 710         }
 711
 712       if (natural_size)
 713         {
 714           natural_size->width = nat_width;
 715           gtk_widget_get_preferred_height_for_width (widget, nat_width,
 716                                                      NULL, &natural_size->height);
 717         }
 718     }
 719   else /* GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT or CONSTANT_SIZE */
 720     {
 721       gtk_widget_get_preferred_height (widget, &min_height, &nat_height);
 722
 723       if (minimum_size)
 724         {
 725           minimum_size->height = min_height;
 726           gtk_widget_get_preferred_width_for_height (widget, min_height,
 727                                                      &minimum_size->width, NULL);
 728         }
 729
 730       if (natural_size)
 731         {
 732           natural_size->height = nat_height;
 733           gtk_widget_get_preferred_width_for_height (widget, nat_height,
 734                                                      NULL, &natural_size->width);
 735         }
 736     }
 737 }
 738
 739
 740 static gint
 741 compare_gap (gconstpointer p1,
 742              gconstpointer p2,
 743              gpointer      data)
 744 {
 745   GtkRequestedSize *sizes = data;
 746   const guint *c1 = p1;
 747   const guint *c2 = p2;
 748
 749   const gint d1 = MAX (sizes[*c1].natural_size -
 750                        sizes[*c1].minimum_size,
 751                        0);
 752   const gint d2 = MAX (sizes[*c2].natural_size -
 753                        sizes[*c2].minimum_size,
 754                        0);
 755
 756   gint delta = (d2 - d1);
 757
 758   if (0 == delta)
 759     delta = (*c2 - *c1);
 760
 761   return delta;
 762 }
 763
 764 /**
 765  * gtk_distribute_natural_allocation:
 766  * @extra_space: Extra space to redistribute among children after subtracting
 767  *               minimum sizes and any child padding from the overall allocation
 768  * @n_requested_sizes: Number of requests to fit into the allocation
 769  * @sizes: An array of structs with a client pointer and a minimum/natural size
 770  *         in the orientation of the allocation.
 771  *
 772  * Distributes @extra_space to child @sizes by bringing smaller
 773  * children up to natural size first.
 774  *
 775  * The remaining space will be added to the @minimum_size member of the
 776  * GtkRequestedSize struct. If all sizes reach their natural size then
 777  * the remaining space is returned.
 778  *
 779  * Returns: The remainder of @extra_space after redistributing space
 780  * to @sizes.
 781  */
 782 gint
 783 gtk_distribute_natural_allocation (gint              extra_space,
 784                                    guint             n_requested_sizes,
 785                                    GtkRequestedSize *sizes)
 786 {
 787   guint *spreading;
 788   gint   i;
 789
 790   g_return_val_if_fail (extra_space >= 0, 0);
 791
 792   spreading = g_newa (guint, n_requested_sizes);
 793
 794   for (i = 0; i < n_requested_sizes; i++)
 795     spreading[i] = i;
 796
 797   /* Distribute the container's extra space c_gap. We want to assign
 798    * this space such that the sum of extra space assigned to children
 799    * (c^i_gap) is equal to c_cap. The case that there's not enough
 800    * space for all children to take their natural size needs some
 801    * attention. The goals we want to achieve are:
 802    *
 803    *   a) Maximize number of children taking their natural size.
 804    *   b) The allocated size of children should be a continuous
 805    *   function of c_gap.  That is, increasing the container size by
 806    *   one pixel should never make drastic changes in the distribution.
 807    *   c) If child i takes its natural size and child j doesn't,
 808    *   child j should have received at least as much gap as child i.
 809    *
 810    * The following code distributes the additional space by following
 811    * these rules.
 812    */
 813
 814   /* Sort descending by gap and position. */
 815   g_qsort_with_data (spreading,
 816                      n_requested_sizes, sizeof (guint),
 817                      compare_gap, sizes);
 818
 819   /* Distribute available space.
 820    * This master piece of a loop was conceived by Behdad Esfahbod.
 821    */
 822   for (i = n_requested_sizes - 1; extra_space > 0 && i >= 0; --i)
 823     {
 824       /* Divide remaining space by number of remaining children.
 825        * Sort order and reducing remaining space by assigned space
 826        * ensures that space is distributed equally.
 827        */
 828       gint glue = (extra_space + i) / (i + 1);
 829       gint gap = sizes[(spreading[i])].natural_size
 830         - sizes[(spreading[i])].minimum_size;
 831
 832       gint extra = MIN (glue, gap);
 833
 834       sizes[spreading[i]].minimum_size += extra;
 835
 836       extra_space -= extra;
 837     }
 838
 839   return extra_space;
 840 }