]> Pileus Git - ~andy/gtk/blob - gtk/gtksizerequest.c
Add default class implementation of gtk_widget_get_request_mode().
[~andy/gtk] / gtk / gtksizerequest.c
1 /* gtksizerequest.c
2  * Copyright (C) 2007-2010 Openismus GmbH
3  *
4  * Authors:
5  *      Mathias Hasselmann <mathias@openismus.com>
6  *      Tristan Van Berkom <tristan.van.berkom@gmail.com>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public
19  * License along with this library; if not, write to the
20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23
24 #include <config.h>
25
26 #include "gtksizerequest.h"
27
28 #include "gtkdebug.h"
29 #include "gtkintl.h"
30 #include "gtkprivate.h"
31 #include "gtksizegroup-private.h"
32 #include "gtkwidgetprivate.h"
33
34 /* looks for a cached size request for this for_size. If not
35  * found, returns the oldest entry so it can be overwritten
36  *
37  * Note that this caching code was directly derived from
38  * the Clutter toolkit.
39  */
40 static gboolean
41 get_cached_size (SizeRequestCache  *cache,
42                  GtkSizeGroupMode   orientation,
43                  gint               for_size,
44                  SizeRequest      **result)
45 {
46   guint i, n_sizes;
47   SizeRequest  *cached_sizes;
48
49   if (orientation == GTK_SIZE_GROUP_HORIZONTAL)
50     {
51       cached_sizes = cache->widths;
52       n_sizes = cache->cached_widths;
53     }
54   else
55     {
56       cached_sizes = cache->heights;
57       n_sizes = cache->cached_widths;
58     }
59
60   /* Search for an already cached size */
61   for (i = 0; i < n_sizes; i++)
62     {
63       if (cached_sizes[i].for_size == for_size)
64         {
65           *result = &cached_sizes[i];
66           return TRUE;
67         }
68     }
69
70   /* If not found, pull a new size from the cache, the returned size cache
71    * will immediately be used to cache the new computed size so we go ahead
72    * and increment the last_cached_width/height right away */
73   if (orientation == GTK_SIZE_GROUP_HORIZONTAL)
74     {
75       if (cache->cached_widths < GTK_SIZE_REQUEST_CACHED_SIZES)
76         {
77           cache->cached_widths++;
78           cache->last_cached_width = cache->cached_widths - 1;
79         }
80       else
81         {
82           if (++cache->last_cached_width == GTK_SIZE_REQUEST_CACHED_SIZES)
83             cache->last_cached_width = 0;
84         }
85
86       *result = &cache->widths[cache->last_cached_width];
87     }
88   else /* GTK_SIZE_GROUP_VERTICAL */
89     {
90       if (cache->cached_heights < GTK_SIZE_REQUEST_CACHED_SIZES)
91         {
92           cache->cached_heights++;
93           cache->last_cached_height = cache->cached_heights - 1;
94         }
95       else
96         {
97           if (++cache->last_cached_height == GTK_SIZE_REQUEST_CACHED_SIZES)
98             cache->last_cached_height = 0;
99         }
100
101       *result = &cache->heights[cache->last_cached_height];
102     }
103
104   return FALSE;
105 }
106
107
108 #ifndef G_DISABLE_CHECKS
109 static GQuark recursion_check_quark = 0;
110 #endif /* G_DISABLE_CHECKS */
111
112 static void
113 push_recursion_check (GtkWidget       *widget,
114                       GtkSizeGroupMode orientation,
115                       gint             for_size)
116 {
117 #ifndef G_DISABLE_CHECKS
118   const char *previous_method;
119   const char *method;
120
121   if (recursion_check_quark == 0)
122     recursion_check_quark = g_quark_from_static_string ("gtk-size-request-in-progress");
123
124   previous_method = g_object_get_qdata (G_OBJECT (widget), recursion_check_quark);
125
126   if (orientation == GTK_SIZE_GROUP_HORIZONTAL)
127     {
128       method = for_size < 0 ? "get_width" : "get_width_for_height";
129     }
130   else
131     {
132       method = for_size < 0 ? "get_height" : "get_height_for_width";
133     }
134
135   if (previous_method != NULL)
136     {
137       g_warning ("%s %p: widget tried to gtk_widget_%s inside "
138                  " GtkWidget     ::%s implementation. "
139                  "Should just invoke GTK_WIDGET_GET_CLASS(widget)->%s "
140                  "directly rather than using gtk_widget_%s",
141                  G_OBJECT_TYPE_NAME (widget), widget,
142                  method, previous_method,
143                  method, method);
144     }
145
146   g_object_set_qdata (G_OBJECT (widget), recursion_check_quark, (char*) method);
147 #endif /* G_DISABLE_CHECKS */
148 }
149
150 static void
151 pop_recursion_check (GtkWidget       *widget,
152                      GtkSizeGroupMode orientation)
153 {
154 #ifndef G_DISABLE_CHECKS
155   g_object_set_qdata (G_OBJECT (widget), recursion_check_quark, NULL);
156 #endif
157 }
158
159 static void
160 compute_size_for_orientation (GtkWidget         *widget,
161                               GtkSizeGroupMode   orientation,
162                               gint               for_size,
163                               gint              *minimum_size,
164                               gint              *natural_size)
165 {
166   SizeRequestCache *cache;
167   SizeRequest      *cached_size;
168   gboolean          found_in_cache = FALSE;
169   int adjusted_min, adjusted_natural;
170
171   g_return_if_fail (GTK_IS_WIDGET (widget));
172   g_return_if_fail (minimum_size != NULL || natural_size != NULL);
173
174   cache  = _gtk_widget_peek_request_cache (widget);
175
176   if (orientation == GTK_SIZE_GROUP_HORIZONTAL)
177     {
178       cached_size = &cache->widths[0];
179
180       if (!_gtk_widget_get_width_request_needed (widget))
181         found_in_cache = get_cached_size (cache, orientation, for_size, &cached_size);
182       else
183         {
184           memset (cache->widths, 0, GTK_SIZE_REQUEST_CACHED_SIZES * sizeof (SizeRequest));
185           cache->cached_widths = 1;
186           cache->last_cached_width = 0;
187         }
188     }
189   else
190     {
191       cached_size = &cache->heights[0];
192
193       if (!_gtk_widget_get_height_request_needed (widget))
194         found_in_cache = get_cached_size (cache, orientation, for_size, &cached_size);
195       else
196         {
197           memset (cache->heights, 0, GTK_SIZE_REQUEST_CACHED_SIZES * sizeof (SizeRequest));
198           cache->cached_heights = 1;
199           cache->last_cached_height = 0;
200         }
201     }
202
203   if (!found_in_cache)
204     {
205       gint min_size = 0;
206       gint nat_size = 0;
207
208       if (orientation == GTK_SIZE_GROUP_HORIZONTAL)
209         {
210           if (for_size < 0)
211             {
212               push_recursion_check (widget, orientation, for_size);
213               GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, &min_size, &nat_size);
214               pop_recursion_check (widget, orientation);
215             }
216           else
217             {
218               gint ignored_position = 0;
219               gint minimum_height;
220               gint natural_height;
221
222               /* Pull the base natural height from the cache as it's needed to adjust
223                * the proposed 'for_size' */
224               gtk_widget_get_preferred_height (widget, &minimum_height, &natural_height);
225
226               /* convert for_size to unadjusted height (for_size is a proposed allocation) */
227               GTK_WIDGET_GET_CLASS (widget)->adjust_size_allocation (widget,
228                                                                      GTK_ORIENTATION_VERTICAL,
229                                                                      &minimum_height,
230                                                                      &natural_height,
231                                                                      &ignored_position,
232                                                                      &for_size);
233
234               push_recursion_check (widget, orientation, for_size);
235               GTK_WIDGET_GET_CLASS (widget)->get_preferred_width_for_height (widget, 
236                                                                              MAX (for_size, minimum_height),
237                                                                              &min_size, &nat_size);
238               pop_recursion_check (widget, orientation);
239             }
240         }
241       else
242         {
243           if (for_size < 0)
244             {
245               push_recursion_check (widget, orientation, for_size);
246               GTK_WIDGET_GET_CLASS (widget)->get_preferred_height (widget, &min_size, &nat_size);
247               pop_recursion_check (widget, orientation);
248             }
249           else
250             {
251               int ignored_position = 0;
252               int minimum_width;
253               int natural_width;
254
255               /* Pull the base natural width from the cache as it's needed to adjust
256                * the proposed 'for_size' */
257               gtk_widget_get_preferred_width (widget, &minimum_width, &natural_width);
258
259               /* convert for_size to unadjusted width (for_size is a proposed allocation) */
260               GTK_WIDGET_GET_CLASS (widget)->adjust_size_allocation (widget,
261                                                                      GTK_ORIENTATION_HORIZONTAL,
262                                                                      &minimum_width,
263                                                                      &natural_width,
264                                                                      &ignored_position,
265                                                                      &for_size);
266
267               push_recursion_check (widget, orientation, for_size);
268               GTK_WIDGET_GET_CLASS (widget)->get_preferred_height_for_width (widget, 
269                                                                              MAX (for_size, minimum_width),
270                                                                              &min_size, &nat_size);
271               pop_recursion_check (widget, orientation);
272             }
273         }
274
275       if (min_size > nat_size)
276         {
277           g_warning ("%s %p reported min size %d and natural size %d; natural size must be >= min size",
278                      G_OBJECT_TYPE_NAME (widget), widget, min_size, nat_size);
279         }
280
281       cached_size->minimum_size = min_size;
282       cached_size->natural_size = nat_size;
283       cached_size->for_size     = for_size;
284
285       if (orientation == GTK_SIZE_GROUP_HORIZONTAL)
286           _gtk_widget_set_width_request_needed (widget, FALSE);
287       else
288           _gtk_widget_set_height_request_needed (widget, FALSE);
289
290       adjusted_min = cached_size->minimum_size;
291       adjusted_natural = cached_size->natural_size;
292       GTK_WIDGET_GET_CLASS (widget)->adjust_size_request (widget,
293                                                           orientation == GTK_SIZE_GROUP_HORIZONTAL ?
294                                                           GTK_ORIENTATION_HORIZONTAL :
295                                                           GTK_ORIENTATION_VERTICAL,
296                                                           &adjusted_min,
297                                                           &adjusted_natural);
298
299       if (adjusted_min < cached_size->minimum_size ||
300           adjusted_natural < cached_size->natural_size)
301         {
302           g_warning ("%s %p adjusted size %s min %d natural %d must not decrease below min %d natural %d",
303                      G_OBJECT_TYPE_NAME (widget), widget,
304                      orientation == GTK_SIZE_GROUP_VERTICAL ? "vertical" : "horizontal",
305                      adjusted_min, adjusted_natural,
306                      cached_size->minimum_size, cached_size->natural_size);
307           /* don't use the adjustment */
308         }
309       else if (adjusted_min > adjusted_natural)
310         {
311           g_warning ("%s %p adjusted size %s min %d natural %d original min %d natural %d has min greater than natural",
312                      G_OBJECT_TYPE_NAME (widget), widget,
313                      orientation == GTK_SIZE_GROUP_VERTICAL ? "vertical" : "horizontal",
314                      adjusted_min, adjusted_natural,
315                      cached_size->minimum_size, cached_size->natural_size);
316           /* don't use the adjustment */
317         }
318       else
319         {
320           /* adjustment looks good */
321           cached_size->minimum_size = adjusted_min;
322           cached_size->natural_size = adjusted_natural;
323         }
324
325       /* Update size-groups with our request and update our cached requests
326        * with the size-group values in a single pass.
327        */
328       _gtk_size_group_bump_requisition (widget,
329                                         orientation,
330                                         &cached_size->minimum_size,
331                                         &cached_size->natural_size);
332     }
333
334   if (minimum_size)
335     *minimum_size = cached_size->minimum_size;
336
337   if (natural_size)
338     *natural_size = cached_size->natural_size;
339
340   g_assert (cached_size->minimum_size <= cached_size->natural_size);
341
342   GTK_NOTE (SIZE_REQUEST,
343             g_print ("[%p] %s\t%s: %d is minimum %d and natural: %d (hit cache: %s)\n",
344                      widget, G_OBJECT_TYPE_NAME (widget),
345                      orientation == GTK_SIZE_GROUP_HORIZONTAL ?
346                      "width for height" : "height for width" ,
347                      for_size,
348                      cached_size->minimum_size,
349                      cached_size->natural_size,
350                      found_in_cache ? "yes" : "no"));
351
352 }
353
354 /**
355  * gtk_widget_get_request_mode:
356  * @widget: a #GtkWidget instance
357  *
358  * Gets whether the widget prefers a height-for-width layout
359  * or a width-for-height layout.
360  *
361  * <note><para>#GtkBin widgets generally propagate the preference of
362  * their child, container widgets need to request something either in
363  * context of their children or in context of their allocation
364  * capabilities.</para></note>
365  *
366  * Returns: The #GtkSizeRequestMode preferred by @widget.
367  *
368  * Since: 3.0
369  */
370 GtkSizeRequestMode
371 gtk_widget_get_request_mode (GtkWidget *widget)
372 {
373   g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH);
374
375   return GTK_WIDGET_GET_CLASS (widget)->get_request_mode (widget);
376 }
377
378 /**
379  * gtk_widget_get_preferred_width:
380  * @widget: a #GtkWidget instance
381  * @minimum_width: (out) (allow-none): location to store the minimum width, or %NULL
382  * @natural_width: (out) (allow-none): location to store the natural width, or %NULL
383  *
384  * Retrieves a widget's initial minimum and natural width.
385  *
386  * <note><para>This call is specific to height-for-width
387  * requests.</para></note>
388  *
389  * The returned request will be modified by the
390  * GtkWidgetClass::adjust_size_request virtual method and by any
391  * #GtkSizeGroup<!-- -->s that have been applied. That is, the returned request
392  * is the one that should be used for layout, not necessarily the one
393  * returned by the widget itself.
394  *
395  * Since: 3.0
396  */
397 void
398 gtk_widget_get_preferred_width (GtkWidget *widget,
399                                 gint      *minimum_width,
400                                 gint      *natural_width)
401 {
402   compute_size_for_orientation (widget, GTK_SIZE_GROUP_HORIZONTAL,
403                                 -1, minimum_width, natural_width);
404 }
405
406
407 /**
408  * gtk_widget_get_preferred_height:
409  * @widget: a #GtkWidget instance
410  * @minimum_height: (out) (allow-none): location to store the minimum height, or %NULL
411  * @natural_height: (out) (allow-none): location to store the natural height, or %NULL
412  *
413  * Retrieves a widget's initial minimum and natural height.
414  *
415  * <note><para>This call is specific to width-for-height requests.</para></note>
416  *
417  * The returned request will be modified by the
418  * GtkWidgetClass::adjust_size_request virtual method and by any
419  * #GtkSizeGroup<!-- -->s that have been applied. That is, the returned request
420  * is the one that should be used for layout, not necessarily the one
421  * returned by the widget itself.
422  *
423  * Since: 3.0
424  */
425 void
426 gtk_widget_get_preferred_height (GtkWidget *widget,
427                                  gint      *minimum_height,
428                                  gint      *natural_height)
429 {
430   compute_size_for_orientation (widget, GTK_SIZE_GROUP_VERTICAL,
431                                 -1, minimum_height, natural_height);
432 }
433
434
435
436 /**
437  * gtk_widget_get_preferred_width_for_height:
438  * @widget: a #GtkWidget instance
439  * @height: the height which is available for allocation
440  * @minimum_width: (out) (allow-none): location for storing the minimum width, or %NULL
441  * @natural_width: (out) (allow-none): location for storing the natural width, or %NULL
442  *
443  * Retrieves a widget's minimum and natural width if it would be given
444  * the specified @height.
445  *
446  * The returned request will be modified by the
447  * GtkWidgetClass::adjust_size_request virtual method and by any
448  * #GtkSizeGroup<!-- -->s that have been applied. That is, the returned request
449  * is the one that should be used for layout, not necessarily the one
450  * returned by the widget itself.
451  *
452  * Since: 3.0
453  */
454 void
455 gtk_widget_get_preferred_width_for_height (GtkWidget *widget,
456                                            gint       height,
457                                            gint      *minimum_width,
458                                            gint      *natural_width)
459 {
460   compute_size_for_orientation (widget, GTK_SIZE_GROUP_HORIZONTAL,
461                                 height, minimum_width, natural_width);
462 }
463
464 /**
465  * gtk_widget_get_preferred_height_for_width:
466  * @widget: a #GtkWidget instance
467  * @width: the width which is available for allocation
468  * @minimum_height: (out) (allow-none): location for storing the minimum height, or %NULL
469  * @natural_height: (out) (allow-none): location for storing the natural height, or %NULL
470  *
471  * Retrieves a widget's minimum and natural height if it would be given
472  * the specified @width.
473  *
474  * The returned request will be modified by the
475  * GtkWidgetClass::adjust_size_request virtual method and by any
476  * #GtkSizeGroup<!-- -->s that have been applied. That is, the returned request
477  * is the one that should be used for layout, not necessarily the one
478  * returned by the widget itself.
479  *
480  * Since: 3.0
481  */
482 void
483 gtk_widget_get_preferred_height_for_width (GtkWidget *widget,
484                                            gint       width,
485                                            gint      *minimum_height,
486                                            gint      *natural_height)
487 {
488   compute_size_for_orientation (widget, GTK_SIZE_GROUP_VERTICAL,
489                                 width, minimum_height, natural_height);
490 }
491
492 /**
493  * gtk_widget_get_preferred_size:
494  * @widget: a #GtkWidget instance
495  * @minimum_size: (out) (allow-none): location for storing the minimum size, or %NULL
496  * @natural_size: (out) (allow-none): location for storing the natural size, or %NULL
497  *
498  * Retrieves the minimum and natural size of a widget, taking
499  * into account the widget's preference for height-for-width management.
500  *
501  * This is used to retrieve a suitable size by container widgets which do
502  * not impose any restrictions on the child placement. It can be used
503  * to deduce toplevel window and menu sizes as well as child widgets in
504  * free-form containers such as GtkLayout.
505  *
506  * <note><para>Handle with care. Note that the natural height of a height-for-width
507  * widget will generally be a smaller size than the minimum height, since the required
508  * height for the natural width is generally smaller than the required height for
509  * the minimum width.</para></note>
510  *
511  * Since: 3.0
512  */
513 void
514 gtk_widget_get_preferred_size (GtkWidget      *widget,
515                                GtkRequisition *minimum_size,
516                                GtkRequisition *natural_size)
517 {
518   gint min_width, nat_width;
519   gint min_height, nat_height;
520
521   g_return_if_fail (GTK_IS_WIDGET (widget));
522
523   if (gtk_widget_get_request_mode (widget) == GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH)
524     {
525       gtk_widget_get_preferred_width (widget, &min_width, &nat_width);
526
527       if (minimum_size)
528         {
529           minimum_size->width = min_width;
530           gtk_widget_get_preferred_height_for_width (widget, min_width,
531                                                      &minimum_size->height, NULL);
532         }
533
534       if (natural_size)
535         {
536           natural_size->width = nat_width;
537           gtk_widget_get_preferred_height_for_width (widget, nat_width,
538                                                      NULL, &natural_size->height);
539         }
540     }
541   else /* GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT */
542     {
543       gtk_widget_get_preferred_height (widget, &min_height, &nat_height);
544
545       if (minimum_size)
546         {
547           minimum_size->height = min_height;
548           gtk_widget_get_preferred_width_for_height (widget, min_height,
549                                                      &minimum_size->width, NULL);
550         }
551
552       if (natural_size)
553         {
554           natural_size->height = nat_height;
555           gtk_widget_get_preferred_width_for_height (widget, nat_height,
556                                                      NULL, &natural_size->width);
557         }
558     }
559 }
560
561
562 static gint
563 compare_gap (gconstpointer p1,
564              gconstpointer p2,
565              gpointer      data)
566 {
567   GtkRequestedSize *sizes = data;
568   const guint *c1 = p1;
569   const guint *c2 = p2;
570
571   const gint d1 = MAX (sizes[*c1].natural_size -
572                        sizes[*c1].minimum_size,
573                        0);
574   const gint d2 = MAX (sizes[*c2].natural_size -
575                        sizes[*c2].minimum_size,
576                        0);
577
578   gint delta = (d2 - d1);
579
580   if (0 == delta)
581     delta = (*c2 - *c1);
582
583   return delta;
584 }
585
586 /**
587  * gtk_distribute_natural_allocation:
588  * @extra_space: Extra space to redistribute among children after subtracting
589  *               minimum sizes and any child padding from the overall allocation
590  * @n_requested_sizes: Number of requests to fit into the allocation
591  * @sizes: An array of structs with a client pointer and a minimum/natural size
592  *         in the orientation of the allocation.
593  *
594  * Distributes @extra_space to child @sizes by bringing smaller
595  * children up to natural size first.
596  *
597  * The remaining space will be added to the @minimum_size member of the
598  * GtkRequestedSize struct. If all sizes reach their natural size then
599  * the remaining space is returned.
600  *
601  * Returns: The remainder of @extra_space after redistributing space
602  * to @sizes.
603  */
604 gint
605 gtk_distribute_natural_allocation (gint              extra_space,
606                                    guint             n_requested_sizes,
607                                    GtkRequestedSize *sizes)
608 {
609   guint *spreading;
610   gint   i;
611
612   g_return_val_if_fail (extra_space >= 0, 0);
613
614   spreading = g_newa (guint, n_requested_sizes);
615
616   for (i = 0; i < n_requested_sizes; i++)
617     spreading[i] = i;
618
619   /* Distribute the container's extra space c_gap. We want to assign
620    * this space such that the sum of extra space assigned to children
621    * (c^i_gap) is equal to c_cap. The case that there's not enough
622    * space for all children to take their natural size needs some
623    * attention. The goals we want to achieve are:
624    *
625    *   a) Maximize number of children taking their natural size.
626    *   b) The allocated size of children should be a continuous
627    *   function of c_gap.  That is, increasing the container size by
628    *   one pixel should never make drastic changes in the distribution.
629    *   c) If child i takes its natural size and child j doesn't,
630    *   child j should have received at least as much gap as child i.
631    *
632    * The following code distributes the additional space by following
633    * these rules.
634    */
635
636   /* Sort descending by gap and position. */
637   g_qsort_with_data (spreading,
638                      n_requested_sizes, sizeof (guint),
639                      compare_gap, sizes);
640
641   /* Distribute available space.
642    * This master piece of a loop was conceived by Behdad Esfahbod.
643    */
644   for (i = n_requested_sizes - 1; extra_space > 0 && i >= 0; --i)
645     {
646       /* Divide remaining space by number of remaining children.
647        * Sort order and reducing remaining space by assigned space
648        * ensures that space is distributed equally.
649        */
650       gint glue = (extra_space + i) / (i + 1);
651       gint gap = sizes[(spreading[i])].natural_size
652         - sizes[(spreading[i])].minimum_size;
653
654       gint extra = MIN (glue, gap);
655
656       sizes[spreading[i]].minimum_size += extra;
657
658       extra_space -= extra;
659     }
660
661   return extra_space;
662 }