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