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 /* This is the main function that checks for a cached size and
 320  * possibly queries the widget class to compute the size if it's
 321  * not cached. If the for_size here is -1, then get_preferred_width()
 322  * or get_preferred_height() will be used.
 323  */
 324 static void
 325 compute_size_for_orientation (GtkWidget         *widget,
 326                               GtkSizeGroupMode   orientation,
 327                               gint               for_size,
 328                               gint              *minimum_size,
 329                               gint              *natural_size)
 330 {
 331   CachedSize       *cached_size;
 332   gboolean          found_in_cache = FALSE;
 333   gint              min_size = 0;
 334   gint              nat_size = 0;
 335
 336   found_in_cache = get_cached_size (widget, orientation, for_size, &cached_size);
 337
 338   if (!found_in_cache)
 339     {
 340       gint adjusted_min, adjusted_natural, adjusted_for_size = for_size;
 341
 342       gtk_widget_ensure_style (widget);
 343
 344       if (orientation == GTK_SIZE_GROUP_HORIZONTAL)
 345         {
 346           if (for_size < 0)
 347             {
 348               push_recursion_check (widget, orientation, for_size);
 349               GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, &min_size, &nat_size);
 350               pop_recursion_check (widget, orientation);
 351             }
 352           else
 353             {
 354               gint ignored_position = 0;
 355               gint minimum_height;
 356               gint natural_height;
 357
 358               /* Pull the base natural height from the cache as it's needed to adjust
 359                * the proposed 'for_size' */
 360               gtk_widget_get_preferred_height (widget, &minimum_height, &natural_height);
 361
 362               /* convert for_size to unadjusted height (for_size is a proposed allocation) */
 363               GTK_WIDGET_GET_CLASS (widget)->adjust_size_allocation (widget,
 364                                                                      GTK_ORIENTATION_VERTICAL,
 365                                                                      &minimum_height,
 366                                                                      &natural_height,
 367                                                                      &ignored_position,
 368                                                                      &adjusted_for_size);
 369
 370               push_recursion_check (widget, orientation, for_size);
 371               GTK_WIDGET_GET_CLASS (widget)->get_preferred_width_for_height (widget,
 372                                                                              MAX (adjusted_for_size, minimum_height),
 373                                                                              &min_size, &nat_size);
 374               pop_recursion_check (widget, orientation);
 375             }
 376         }
 377       else
 378         {
 379           if (for_size < 0)
 380             {
 381               push_recursion_check (widget, orientation, for_size);
 382               GTK_WIDGET_GET_CLASS (widget)->get_preferred_height (widget, &min_size, &nat_size);
 383               pop_recursion_check (widget, orientation);
 384             }
 385           else
 386             {
 387               gint ignored_position = 0;
 388               gint minimum_width;
 389               gint natural_width;
 390
 391               /* Pull the base natural width from the cache as it's needed to adjust
 392                * the proposed 'for_size' */
 393               gtk_widget_get_preferred_width (widget, &minimum_width, &natural_width);
 394
 395               /* convert for_size to unadjusted width (for_size is a proposed allocation) */
 396               GTK_WIDGET_GET_CLASS (widget)->adjust_size_allocation (widget,
 397                                                                      GTK_ORIENTATION_HORIZONTAL,
 398                                                                      &minimum_width,
 399                                                                      &natural_width,
 400                                                                      &ignored_position,
 401                                                                      &adjusted_for_size);
 402
 403               push_recursion_check (widget, orientation, for_size);
 404               GTK_WIDGET_GET_CLASS (widget)->get_preferred_height_for_width (widget,
 405                                                                              MAX (adjusted_for_size, minimum_width),
 406                                                                              &min_size, &nat_size);
 407               pop_recursion_check (widget, orientation);
 408             }
 409         }
 410
 411       if (min_size > nat_size)
 412         {
 413           g_warning ("%s %p reported min size %d and natural size %d; natural size must be >= min size",
 414                      G_OBJECT_TYPE_NAME (widget), widget, min_size, nat_size);
 415         }
 416
 417       if (orientation == GTK_SIZE_GROUP_HORIZONTAL)
 418           _gtk_widget_set_width_request_needed (widget, FALSE);
 419       else
 420           _gtk_widget_set_height_request_needed (widget, FALSE);
 421
 422       adjusted_min     = min_size;
 423       adjusted_natural = nat_size;
 424       GTK_WIDGET_GET_CLASS (widget)->adjust_size_request (widget,
 425                                                           orientation == GTK_SIZE_GROUP_HORIZONTAL ?
 426                                                           GTK_ORIENTATION_HORIZONTAL :
 427                                                           GTK_ORIENTATION_VERTICAL,
 428                                                           &adjusted_min,
 429                                                           &adjusted_natural);
 430
 431       if (adjusted_min < min_size ||
 432           adjusted_natural < nat_size)
 433         {
 434           g_warning ("%s %p adjusted size %s min %d natural %d must not decrease below min %d natural %d",
 435                      G_OBJECT_TYPE_NAME (widget), widget,
 436                      orientation == GTK_SIZE_GROUP_VERTICAL ? "vertical" : "horizontal",
 437                      adjusted_min, adjusted_natural,
 438                      min_size, nat_size);
 439           /* don't use the adjustment */
 440         }
 441       else if (adjusted_min > adjusted_natural)
 442         {
 443           g_warning ("%s %p adjusted size %s min %d natural %d original min %d natural %d has min greater than natural",
 444                      G_OBJECT_TYPE_NAME (widget), widget,
 445                      orientation == GTK_SIZE_GROUP_VERTICAL ? "vertical" : "horizontal",
 446                      adjusted_min, adjusted_natural,
 447                      min_size, nat_size);
 448           /* don't use the adjustment */
 449         }
 450       else
 451         {
 452           /* adjustment looks good */
 453           min_size = adjusted_min;
 454           nat_size = adjusted_natural;
 455         }
 456
 457       /* Update size-groups with our request and update our cached requests
 458        * with the size-group values in a single pass.
 459        */
 460       _gtk_size_group_bump_requisition (widget,
 461                                         orientation,
 462                                         &min_size,
 463                                         &nat_size);
 464
 465       commit_cached_size (widget, orientation, for_size, min_size, nat_size);
 466     }
 467   else
 468     {
 469       min_size = cached_size->minimum_size;
 470       nat_size = cached_size->natural_size;
 471     }
 472
 473   if (minimum_size)
 474     *minimum_size = min_size;
 475
 476   if (natural_size)
 477     *natural_size = nat_size;
 478
 479   g_assert (min_size <= nat_size);
 480
 481   GTK_NOTE (SIZE_REQUEST,
 482             g_print ("[%p] %s\t%s: %d is minimum %d and natural: %d (hit cache: %s)\n",
 483                      widget, G_OBJECT_TYPE_NAME (widget),
 484                      orientation == GTK_SIZE_GROUP_HORIZONTAL ?
 485                      "width for height" : "height for width" ,
 486                      for_size, min_size, nat_size,
 487                      found_in_cache ? "yes" : "no"));
 488
 489 }
 490
 491 /**
 492  * gtk_widget_get_request_mode:
 493  * @widget: a #GtkWidget instance
 494  *
 495  * Gets whether the widget prefers a height-for-width layout
 496  * or a width-for-height layout.
 497  *
 498  * <note><para>#GtkBin widgets generally propagate the preference of
 499  * their child, container widgets need to request something either in
 500  * context of their children or in context of their allocation
 501  * capabilities.</para></note>
 502  *
 503  * Returns: The #GtkSizeRequestMode preferred by @widget.
 504  *
 505  * Since: 3.0
 506  */
 507 GtkSizeRequestMode
 508 gtk_widget_get_request_mode (GtkWidget *widget)
 509 {
 510   g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_SIZE_REQUEST_CONSTANT_SIZE);
 511
 512   return GTK_WIDGET_GET_CLASS (widget)->get_request_mode (widget);
 513 }
 514
 515 /**
 516  * gtk_widget_get_preferred_width:
 517  * @widget: a #GtkWidget instance
 518  * @minimum_width: (out) (allow-none): location to store the minimum width, or %NULL
 519  * @natural_width: (out) (allow-none): location to store the natural width, or %NULL
 520  *
 521  * Retrieves a widget's initial minimum and natural width.
 522  *
 523  * <note><para>This call is specific to height-for-width
 524  * requests.</para></note>
 525  *
 526  * The returned request will be modified by the
 527  * GtkWidgetClass::adjust_size_request virtual method and by any
 528  * #GtkSizeGroup<!-- -->s that have been applied. That is, the returned request
 529  * is the one that should be used for layout, not necessarily the one
 530  * returned by the widget itself.
 531  *
 532  * Since: 3.0
 533  */
 534 void
 535 gtk_widget_get_preferred_width (GtkWidget *widget,
 536                                 gint      *minimum_width,
 537                                 gint      *natural_width)
 538 {
 539   g_return_if_fail (GTK_IS_WIDGET (widget));
 540   g_return_if_fail (minimum_width != NULL || natural_width != NULL);
 541
 542   compute_size_for_orientation (widget, GTK_SIZE_GROUP_HORIZONTAL,
 543                                 -1, minimum_width, natural_width);
 544 }
 545
 546
 547 /**
 548  * gtk_widget_get_preferred_height:
 549  * @widget: a #GtkWidget instance
 550  * @minimum_height: (out) (allow-none): location to store the minimum height, or %NULL
 551  * @natural_height: (out) (allow-none): location to store the natural height, or %NULL
 552  *
 553  * Retrieves a widget's initial minimum and natural height.
 554  *
 555  * <note><para>This call is specific to width-for-height requests.</para></note>
 556  *
 557  * The returned request will be modified by the
 558  * GtkWidgetClass::adjust_size_request virtual method and by any
 559  * #GtkSizeGroup<!-- -->s that have been applied. That is, the returned request
 560  * is the one that should be used for layout, not necessarily the one
 561  * returned by the widget itself.
 562  *
 563  * Since: 3.0
 564  */
 565 void
 566 gtk_widget_get_preferred_height (GtkWidget *widget,
 567                                  gint      *minimum_height,
 568                                  gint      *natural_height)
 569 {
 570   g_return_if_fail (GTK_IS_WIDGET (widget));
 571   g_return_if_fail (minimum_height != NULL || natural_height != NULL);
 572
 573   compute_size_for_orientation (widget, GTK_SIZE_GROUP_VERTICAL,
 574                                 -1, minimum_height, natural_height);
 575 }
 576
 577
 578
 579 /**
 580  * gtk_widget_get_preferred_width_for_height:
 581  * @widget: a #GtkWidget instance
 582  * @height: the height which is available for allocation
 583  * @minimum_width: (out) (allow-none): location for storing the minimum width, or %NULL
 584  * @natural_width: (out) (allow-none): location for storing the natural width, or %NULL
 585  *
 586  * Retrieves a widget's minimum and natural width if it would be given
 587  * the specified @height.
 588  *
 589  * The returned request will be modified by the
 590  * GtkWidgetClass::adjust_size_request virtual method and by any
 591  * #GtkSizeGroup<!-- -->s that have been applied. That is, the returned request
 592  * is the one that should be used for layout, not necessarily the one
 593  * returned by the widget itself.
 594  *
 595  * Since: 3.0
 596  */
 597 void
 598 gtk_widget_get_preferred_width_for_height (GtkWidget *widget,
 599                                            gint       height,
 600                                            gint      *minimum_width,
 601                                            gint      *natural_width)
 602 {
 603   g_return_if_fail (GTK_IS_WIDGET (widget));
 604   g_return_if_fail (minimum_width != NULL || natural_width != NULL);
 605   g_return_if_fail (height >= 0);
 606
 607   if (GTK_WIDGET_GET_CLASS (widget)->get_request_mode (widget) == GTK_SIZE_REQUEST_CONSTANT_SIZE)
 608     compute_size_for_orientation (widget, GTK_SIZE_GROUP_HORIZONTAL,
 609                                   -1, minimum_width, natural_width);
 610   else
 611     compute_size_for_orientation (widget, GTK_SIZE_GROUP_HORIZONTAL,
 612                                   height, minimum_width, natural_width);
 613 }
 614
 615 /**
 616  * gtk_widget_get_preferred_height_for_width:
 617  * @widget: a #GtkWidget instance
 618  * @width: the width which is available for allocation
 619  * @minimum_height: (out) (allow-none): location for storing the minimum height, or %NULL
 620  * @natural_height: (out) (allow-none): location for storing the natural height, or %NULL
 621  *
 622  * Retrieves a widget's minimum and natural height if it would be given
 623  * the specified @width.
 624  *
 625  * The returned request will be modified by the
 626  * GtkWidgetClass::adjust_size_request virtual method and by any
 627  * #GtkSizeGroup<!-- -->s that have been applied. That is, the returned request
 628  * is the one that should be used for layout, not necessarily the one
 629  * returned by the widget itself.
 630  *
 631  * Since: 3.0
 632  */
 633 void
 634 gtk_widget_get_preferred_height_for_width (GtkWidget *widget,
 635                                            gint       width,
 636                                            gint      *minimum_height,
 637                                            gint      *natural_height)
 638 {
 639   g_return_if_fail (GTK_IS_WIDGET (widget));
 640   g_return_if_fail (minimum_height != NULL || natural_height != NULL);
 641   g_return_if_fail (width >= 0);
 642
 643   if (GTK_WIDGET_GET_CLASS (widget)->get_request_mode (widget) == GTK_SIZE_REQUEST_CONSTANT_SIZE)
 644     compute_size_for_orientation (widget, GTK_SIZE_GROUP_VERTICAL,
 645                                   -1, minimum_height, natural_height);
 646   else
 647     compute_size_for_orientation (widget, GTK_SIZE_GROUP_VERTICAL,
 648                                   width, minimum_height, natural_height);
 649 }
 650
 651 /**
 652  * gtk_widget_get_preferred_size:
 653  * @widget: a #GtkWidget instance
 654  * @minimum_size: (out) (allow-none): location for storing the minimum size, or %NULL
 655  * @natural_size: (out) (allow-none): location for storing the natural size, or %NULL
 656  *
 657  * Retrieves the minimum and natural size of a widget, taking
 658  * into account the widget's preference for height-for-width management.
 659  *
 660  * This is used to retrieve a suitable size by container widgets which do
 661  * not impose any restrictions on the child placement. It can be used
 662  * to deduce toplevel window and menu sizes as well as child widgets in
 663  * free-form containers such as GtkLayout.
 664  *
 665  * <note><para>Handle with care. Note that the natural height of a height-for-width
 666  * widget will generally be a smaller size than the minimum height, since the required
 667  * height for the natural width is generally smaller than the required height for
 668  * the minimum width.</para></note>
 669  *
 670  * Since: 3.0
 671  */
 672 void
 673 gtk_widget_get_preferred_size (GtkWidget      *widget,
 674                                GtkRequisition *minimum_size,
 675                                GtkRequisition *natural_size)
 676 {
 677   gint min_width, nat_width;
 678   gint min_height, nat_height;
 679
 680   g_return_if_fail (GTK_IS_WIDGET (widget));
 681
 682   if (gtk_widget_get_request_mode (widget) == GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH)
 683     {
 684       gtk_widget_get_preferred_width (widget, &min_width, &nat_width);
 685
 686       if (minimum_size)
 687         {
 688           minimum_size->width = min_width;
 689           gtk_widget_get_preferred_height_for_width (widget, min_width,
 690                                                      &minimum_size->height, NULL);
 691         }
 692
 693       if (natural_size)
 694         {
 695           natural_size->width = nat_width;
 696           gtk_widget_get_preferred_height_for_width (widget, nat_width,
 697                                                      NULL, &natural_size->height);
 698         }
 699     }
 700   else /* GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT or CONSTANT_SIZE */
 701     {
 702       gtk_widget_get_preferred_height (widget, &min_height, &nat_height);
 703
 704       if (minimum_size)
 705         {
 706           minimum_size->height = min_height;
 707           gtk_widget_get_preferred_width_for_height (widget, min_height,
 708                                                      &minimum_size->width, NULL);
 709         }
 710
 711       if (natural_size)
 712         {
 713           natural_size->height = nat_height;
 714           gtk_widget_get_preferred_width_for_height (widget, nat_height,
 715                                                      NULL, &natural_size->width);
 716         }
 717     }
 718 }
 719
 720
 721 static gint
 722 compare_gap (gconstpointer p1,
 723              gconstpointer p2,
 724              gpointer      data)
 725 {
 726   GtkRequestedSize *sizes = data;
 727   const guint *c1 = p1;
 728   const guint *c2 = p2;
 729
 730   const gint d1 = MAX (sizes[*c1].natural_size -
 731                        sizes[*c1].minimum_size,
 732                        0);
 733   const gint d2 = MAX (sizes[*c2].natural_size -
 734                        sizes[*c2].minimum_size,
 735                        0);
 736
 737   gint delta = (d2 - d1);
 738
 739   if (0 == delta)
 740     delta = (*c2 - *c1);
 741
 742   return delta;
 743 }
 744
 745 /**
 746  * gtk_distribute_natural_allocation:
 747  * @extra_space: Extra space to redistribute among children after subtracting
 748  *               minimum sizes and any child padding from the overall allocation
 749  * @n_requested_sizes: Number of requests to fit into the allocation
 750  * @sizes: An array of structs with a client pointer and a minimum/natural size
 751  *         in the orientation of the allocation.
 752  *
 753  * Distributes @extra_space to child @sizes by bringing smaller
 754  * children up to natural size first.
 755  *
 756  * The remaining space will be added to the @minimum_size member of the
 757  * GtkRequestedSize struct. If all sizes reach their natural size then
 758  * the remaining space is returned.
 759  *
 760  * Returns: The remainder of @extra_space after redistributing space
 761  * to @sizes.
 762  */
 763 gint
 764 gtk_distribute_natural_allocation (gint              extra_space,
 765                                    guint             n_requested_sizes,
 766                                    GtkRequestedSize *sizes)
 767 {
 768   guint *spreading;
 769   gint   i;
 770
 771   g_return_val_if_fail (extra_space >= 0, 0);
 772
 773   spreading = g_newa (guint, n_requested_sizes);
 774
 775   for (i = 0; i < n_requested_sizes; i++)
 776     spreading[i] = i;
 777
 778   /* Distribute the container's extra space c_gap. We want to assign
 779    * this space such that the sum of extra space assigned to children
 780    * (c^i_gap) is equal to c_cap. The case that there's not enough
 781    * space for all children to take their natural size needs some
 782    * attention. The goals we want to achieve are:
 783    *
 784    *   a) Maximize number of children taking their natural size.
 785    *   b) The allocated size of children should be a continuous
 786    *   function of c_gap.  That is, increasing the container size by
 787    *   one pixel should never make drastic changes in the distribution.
 788    *   c) If child i takes its natural size and child j doesn't,
 789    *   child j should have received at least as much gap as child i.
 790    *
 791    * The following code distributes the additional space by following
 792    * these rules.
 793    */
 794
 795   /* Sort descending by gap and position. */
 796   g_qsort_with_data (spreading,
 797                      n_requested_sizes, sizeof (guint),
 798                      compare_gap, sizes);
 799
 800   /* Distribute available space.
 801    * This master piece of a loop was conceived by Behdad Esfahbod.
 802    */
 803   for (i = n_requested_sizes - 1; extra_space > 0 && i >= 0; --i)
 804     {
 805       /* Divide remaining space by number of remaining children.
 806        * Sort order and reducing remaining space by assigned space
 807        * ensures that space is distributed equally.
 808        */
 809       gint glue = (extra_space + i) / (i + 1);
 810       gint gap = sizes[(spreading[i])].natural_size
 811         - sizes[(spreading[i])].minimum_size;
 812
 813       gint extra = MIN (glue, gap);
 814
 815       sizes[spreading[i]].minimum_size += extra;
 816
 817       extra_space -= extra;
 818     }
 819
 820   return extra_space;
 821 }