1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 2010 Carlos Garnacho <carlosg@gnome.org>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
22 #include "gtkstylepropertiesprivate.h"
25 #include <gobject/gvaluecollector.h>
26 #include <cairo-gobject.h>
28 #include "gtkstyleprovider.h"
29 #include "gtksymboliccolor.h"
30 #include "gtkthemingengine.h"
31 #include "gtkanimationdescription.h"
32 #include "gtkgradient.h"
33 #include "gtkshadowprivate.h"
34 #include "gtkcsstypesprivate.h"
36 #include "gtkstylepropertyprivate.h"
40 * SECTION:gtkstyleproperties
41 * @Short_description: Store for style property information
42 * @Title: GtkStyleProperties
44 * GtkStyleProperties provides the storage for style information
45 * that is used by #GtkStyleContext and other #GtkStyleProvider
48 * Before style properties can be stored in GtkStyleProperties, they
49 * must be registered with gtk_style_properties_register_property().
51 * Unless you are writing a #GtkStyleProvider implementation, you
52 * are unlikely to use this API directly, as gtk_style_context_get()
53 * and its variants are the preferred way to access styling information
54 * from widget implementations and theming engine implementations
55 * should use the APIs provided by #GtkThemingEngine instead.
58 typedef struct GtkStylePropertiesPrivate GtkStylePropertiesPrivate;
59 typedef struct PropertyData PropertyData;
60 typedef struct ValueData ValueData;
73 struct GtkStylePropertiesPrivate
75 GHashTable *color_map;
76 GHashTable *properties;
79 static void gtk_style_properties_provider_init (GtkStyleProviderIface *iface);
80 static void gtk_style_properties_finalize (GObject *object);
83 G_DEFINE_TYPE_EXTENDED (GtkStyleProperties, gtk_style_properties, G_TYPE_OBJECT, 0,
84 G_IMPLEMENT_INTERFACE (GTK_TYPE_STYLE_PROVIDER,
85 gtk_style_properties_provider_init));
88 gtk_style_properties_class_init (GtkStylePropertiesClass *klass)
90 GObjectClass *object_class = G_OBJECT_CLASS (klass);
92 object_class->finalize = gtk_style_properties_finalize;
94 g_type_class_add_private (object_class, sizeof (GtkStylePropertiesPrivate));
98 property_data_new (void)
102 data = g_slice_new0 (PropertyData);
103 data->values = g_array_new (FALSE, FALSE, sizeof (ValueData));
109 property_data_remove_values (PropertyData *data)
113 for (i = 0; i < data->values->len; i++)
115 ValueData *value_data;
117 value_data = &g_array_index (data->values, ValueData, i);
119 if (G_IS_VALUE (&value_data->value))
120 g_value_unset (&value_data->value);
123 if (data->values->len > 0)
124 g_array_remove_range (data->values, 0, data->values->len);
128 property_data_free (PropertyData *data)
130 property_data_remove_values (data);
131 g_array_free (data->values, TRUE);
132 g_slice_free (PropertyData, data);
136 property_data_find_position (PropertyData *data,
141 gboolean found = FALSE;
147 if (data->values->len == 0)
150 /* Find position for the given state, or the position where
151 * it would be if not found, the array is ordered by the
155 max = data->values->len - 1;
159 ValueData *value_data;
161 mid = (min + max) / 2;
162 value_data = &g_array_index (data->values, ValueData, mid);
164 if (value_data->state == state)
169 else if (value_data->state < state)
170 position = min = mid + 1;
177 while (!found && min <= max);
186 property_data_get_value (PropertyData *data,
192 if (!property_data_find_position (data, state, &pos))
194 ValueData new = { 0 };
197 g_array_insert_val (data->values, pos, new);
200 val_data = &g_array_index (data->values, ValueData, pos);
202 return &val_data->value;
206 property_data_match_state (PropertyData *data,
212 if (property_data_find_position (data, state, &pos))
217 val_data = &g_array_index (data->values, ValueData, pos);
218 return &val_data->value;
221 if (pos >= data->values->len)
222 pos = data->values->len - 1;
224 /* No exact match, go downwards the list to find
225 * the closest match to the given state flags, as
226 * a side effect, there is an implicit precedence
227 * of higher flags over the smaller ones.
229 for (i = pos; i >= 0; i--)
233 val_data = &g_array_index (data->values, ValueData, i);
235 /* Check whether any of the requested
236 * flags are set, and no other flags are.
238 * Also, no flags acts as a wildcard, such
239 * value should be always in the first position
240 * in the array (if present) anyways.
242 if (val_data->state == 0 ||
243 ((val_data->state & state) != 0 &&
244 (val_data->state & ~state) == 0))
245 return &val_data->value;
252 gtk_style_properties_init (GtkStyleProperties *props)
254 GtkStylePropertiesPrivate *priv;
256 priv = props->priv = G_TYPE_INSTANCE_GET_PRIVATE (props,
257 GTK_TYPE_STYLE_PROPERTIES,
258 GtkStylePropertiesPrivate);
260 priv->properties = g_hash_table_new_full (NULL, NULL, NULL,
261 (GDestroyNotify) property_data_free);
265 gtk_style_properties_finalize (GObject *object)
267 GtkStylePropertiesPrivate *priv;
268 GtkStyleProperties *props;
270 props = GTK_STYLE_PROPERTIES (object);
272 g_hash_table_destroy (priv->properties);
275 g_hash_table_destroy (priv->color_map);
277 G_OBJECT_CLASS (gtk_style_properties_parent_class)->finalize (object);
281 gtk_style_properties_get_style (GtkStyleProvider *provider,
284 /* Return style set itself */
285 return g_object_ref (provider);
289 gtk_style_properties_provider_init (GtkStyleProviderIface *iface)
291 iface->get_style = gtk_style_properties_get_style;
294 /* Property registration functions */
297 * gtk_style_properties_register_property: (skip)
298 * @parse_func: parsing function to use, or %NULL
299 * @pspec: the #GParamSpec for the new property
301 * Registers a property so it can be used in the CSS file format.
302 * This function is the low-level equivalent of
303 * gtk_theming_engine_register_property(), if you are implementing
304 * a theming engine, you want to use that function instead.
309 gtk_style_properties_register_property (GtkStylePropertyParser parse_func,
312 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
314 _gtk_style_property_register (pspec,
325 * gtk_style_properties_lookup_property: (skip)
326 * @property_name: property name to look up
327 * @parse_func: (out): return location for the parse function
328 * @pspec: (out) (transfer none): return location for the #GParamSpec
330 * Returns %TRUE if a property has been registered, if @pspec or
331 * @parse_func are not %NULL, the #GParamSpec and parsing function
332 * will be respectively returned.
334 * Returns: %TRUE if the property is registered, %FALSE otherwise
339 gtk_style_properties_lookup_property (const gchar *property_name,
340 GtkStylePropertyParser *parse_func,
343 const GtkStyleProperty *node;
344 gboolean found = FALSE;
346 g_return_val_if_fail (property_name != NULL, FALSE);
348 node = _gtk_style_property_lookup (property_name);
353 *pspec = node->pspec;
356 *parse_func = node->property_parse_func;
364 /* GtkStyleProperties methods */
367 * gtk_style_properties_new:
369 * Returns a newly created #GtkStyleProperties
371 * Returns: a new #GtkStyleProperties
374 gtk_style_properties_new (void)
376 return g_object_new (GTK_TYPE_STYLE_PROPERTIES, NULL);
380 * gtk_style_properties_map_color:
381 * @props: a #GtkStyleProperties
383 * @color: #GtkSymbolicColor to map @name to
385 * Maps @color so it can be referenced by @name. See
386 * gtk_style_properties_lookup_color()
391 gtk_style_properties_map_color (GtkStyleProperties *props,
393 GtkSymbolicColor *color)
395 GtkStylePropertiesPrivate *priv;
397 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
398 g_return_if_fail (name != NULL);
399 g_return_if_fail (color != NULL);
403 if (G_UNLIKELY (!priv->color_map))
404 priv->color_map = g_hash_table_new_full (g_str_hash,
406 (GDestroyNotify) g_free,
407 (GDestroyNotify) gtk_symbolic_color_unref);
409 g_hash_table_replace (priv->color_map,
411 gtk_symbolic_color_ref (color));
415 * gtk_style_properties_lookup_color:
416 * @props: a #GtkStyleProperties
417 * @name: color name to lookup
419 * Returns the symbolic color that is mapped
422 * Returns: (transfer none): The mapped color
427 gtk_style_properties_lookup_color (GtkStyleProperties *props,
430 GtkStylePropertiesPrivate *priv;
432 g_return_val_if_fail (GTK_IS_STYLE_PROPERTIES (props), NULL);
433 g_return_val_if_fail (name != NULL, NULL);
437 if (!priv->color_map)
440 return g_hash_table_lookup (priv->color_map, name);
444 _gtk_style_properties_set_property_by_property (GtkStyleProperties *props,
445 const GtkStyleProperty *style_prop,
449 GtkStylePropertiesPrivate *priv;
454 value_type = G_VALUE_TYPE (value);
456 if (style_prop->pspec->value_type == GDK_TYPE_RGBA ||
457 style_prop->pspec->value_type == GDK_TYPE_COLOR)
459 /* Allow GtkSymbolicColor as well */
460 g_return_if_fail (value_type == GDK_TYPE_RGBA ||
461 value_type == GDK_TYPE_COLOR ||
462 value_type == GTK_TYPE_SYMBOLIC_COLOR);
464 else if (style_prop->pspec->value_type == CAIRO_GOBJECT_TYPE_PATTERN)
466 /* Allow GtkGradient as a substitute */
467 g_return_if_fail (value_type == CAIRO_GOBJECT_TYPE_PATTERN ||
468 value_type == GTK_TYPE_GRADIENT);
470 else if (style_prop->pspec->value_type == G_TYPE_INT)
472 g_return_if_fail (value_type == G_TYPE_INT ||
473 value_type == GTK_TYPE_CSS_BORDER_RADIUS);
476 g_return_if_fail (style_prop->pspec->value_type == value_type);
478 if (_gtk_style_property_is_shorthand (style_prop))
480 GParameter *parameters;
481 guint i, n_parameters;
483 parameters = _gtk_style_property_unpack (style_prop, value, &n_parameters);
485 for (i = 0; i < n_parameters; i++)
487 gtk_style_properties_set_property (props,
490 ¶meters[i].value);
491 g_value_unset (¶meters[i].value);
498 prop = g_hash_table_lookup (priv->properties, style_prop);
502 prop = property_data_new ();
503 g_hash_table_insert (priv->properties, (gpointer) style_prop, prop);
506 val = property_data_get_value (prop, state);
508 if (G_VALUE_TYPE (val) == value_type)
512 if (G_IS_VALUE (val))
515 g_value_init (val, value_type);
518 g_value_copy (value, val);
519 if (style_prop->pspec->value_type == value_type)
520 g_param_value_validate (style_prop->pspec, val);
524 * gtk_style_properties_set_property:
525 * @props: a #GtkStyleProperties
526 * @property: styling property to set
527 * @state: state to set the value for
528 * @value: new value for the property
530 * Sets a styling property in @props.
535 gtk_style_properties_set_property (GtkStyleProperties *props,
536 const gchar *property,
540 const GtkStyleProperty *node;
542 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
543 g_return_if_fail (property != NULL);
544 g_return_if_fail (value != NULL);
546 node = _gtk_style_property_lookup (property);
550 g_warning ("Style property \"%s\" is not registered", property);
554 _gtk_style_properties_set_property_by_property (props,
561 * gtk_style_properties_set_valist:
562 * @props: a #GtkStyleProperties
563 * @state: state to set the values for
564 * @args: va_list of property name/value pairs, followed by %NULL
566 * Sets several style properties on @props.
571 gtk_style_properties_set_valist (GtkStyleProperties *props,
575 const gchar *property_name;
577 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
579 property_name = va_arg (args, const gchar *);
581 while (property_name)
583 const GtkStyleProperty *node;
587 node = _gtk_style_property_lookup (property_name);
591 g_warning ("Style property \"%s\" is not registered", property_name);
595 G_VALUE_COLLECT_INIT (&val, node->pspec->value_type,
599 g_warning ("Could not set style property \"%s\": %s", property_name, error);
600 g_value_unset (&val);
605 _gtk_style_properties_set_property_by_property (props, node, state, &val);
606 g_value_unset (&val);
608 property_name = va_arg (args, const gchar *);
613 * gtk_style_properties_set:
614 * @props: a #GtkStyleProperties
615 * @state: state to set the values for
616 * @...: property name/value pairs, followed by %NULL
618 * Sets several style properties on @props.
623 gtk_style_properties_set (GtkStyleProperties *props,
629 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
631 va_start (args, state);
632 gtk_style_properties_set_valist (props, state, args);
636 /* NB: Will return NULL for shorthands */
638 _gtk_style_properties_peek_property (GtkStyleProperties *props,
639 const gchar *prop_name,
641 const GtkStyleProperty **property)
643 GtkStylePropertiesPrivate *priv;
644 const GtkStyleProperty *node;
648 g_return_val_if_fail (GTK_IS_STYLE_PROPERTIES (props), NULL);
649 g_return_val_if_fail (prop_name != NULL, NULL);
651 node = _gtk_style_property_lookup (prop_name);
657 g_warning ("Style property \"%s\" is not registered", prop_name);
662 prop = g_hash_table_lookup (priv->properties, node);
667 val = property_data_match_state (prop, state);
671 _gtk_style_property_resolve (node, props, val);
677 * gtk_style_properties_get_property:
678 * @props: a #GtkStyleProperties
679 * @property: style property name
680 * @state: state to retrieve the property value for
681 * @value: (out) (transfer full): return location for the style property value.
683 * Gets a style property from @props for the given state. When done with @value,
684 * g_value_unset() needs to be called to free any allocated memory.
686 * Returns: %TRUE if the property exists in @props, %FALSE otherwise
691 gtk_style_properties_get_property (GtkStyleProperties *props,
692 const gchar *property,
696 const GtkStyleProperty *node;
699 g_return_val_if_fail (GTK_IS_STYLE_PROPERTIES (props), FALSE);
700 g_return_val_if_fail (property != NULL, FALSE);
701 g_return_val_if_fail (value != NULL, FALSE);
703 val = _gtk_style_properties_peek_property (props, property, state, &node);
708 g_value_init (value, node->pspec->value_type);
711 g_value_copy (val, value);
712 else if (_gtk_style_property_is_shorthand (node))
713 _gtk_style_property_pack (node, props, state, value);
715 _gtk_style_property_default_value (node, props, value);
721 * gtk_style_properties_get_valist:
722 * @props: a #GtkStyleProperties
723 * @state: state to retrieve the property values for
724 * @args: va_list of property name/return location pairs, followed by %NULL
726 * Retrieves several style property values from @props for a given state.
731 gtk_style_properties_get_valist (GtkStyleProperties *props,
735 const gchar *property_name;
737 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
739 property_name = va_arg (args, const gchar *);
741 while (property_name)
743 const GtkStyleProperty *node;
747 val = _gtk_style_properties_peek_property (props, property_name, state, &node);
753 G_VALUE_LCOPY (val, args, 0, &error);
755 else if (_gtk_style_property_is_shorthand (node))
757 GValue packed = { 0 };
759 g_value_init (&packed, node->pspec->value_type);
760 _gtk_style_property_pack (node, props, state, &packed);
761 G_VALUE_LCOPY (&packed, args, 0, &error);
762 g_value_unset (&packed);
766 GValue default_value = { 0 };
768 g_value_init (&default_value, node->pspec->value_type);
769 _gtk_style_property_default_value (node, props, &default_value);
770 G_VALUE_LCOPY (&default_value, args, 0, &error);
771 g_value_unset (&default_value);
776 g_warning ("Could not get style property \"%s\": %s", property_name, error);
781 property_name = va_arg (args, const gchar *);
786 * gtk_style_properties_get:
787 * @props: a #GtkStyleProperties
788 * @state: state to retrieve the property values for
789 * @...: property name /return value pairs, followed by %NULL
791 * Retrieves several style property values from @props for a
797 gtk_style_properties_get (GtkStyleProperties *props,
803 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
805 va_start (args, state);
806 gtk_style_properties_get_valist (props, state, args);
811 * gtk_style_properties_unset_property:
812 * @props: a #GtkStyleProperties
813 * @property: property to unset
814 * @state: state to unset
816 * Unsets a style property in @props.
821 gtk_style_properties_unset_property (GtkStyleProperties *props,
822 const gchar *property,
825 GtkStylePropertiesPrivate *priv;
826 const GtkStyleProperty *node;
830 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
831 g_return_if_fail (property != NULL);
833 node = _gtk_style_property_lookup (property);
837 g_warning ("Style property \"%s\" is not registered", property);
842 prop = g_hash_table_lookup (priv->properties, node);
847 if (property_data_find_position (prop, state, &pos))
851 data = &g_array_index (prop->values, ValueData, pos);
853 if (G_IS_VALUE (&data->value))
854 g_value_unset (&data->value);
856 g_array_remove_index (prop->values, pos);
861 * gtk_style_properties_clear:
862 * @props: a #GtkStyleProperties
864 * Clears all style information from @props.
867 gtk_style_properties_clear (GtkStyleProperties *props)
869 GtkStylePropertiesPrivate *priv;
871 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
874 g_hash_table_remove_all (priv->properties);
878 * gtk_style_properties_merge:
879 * @props: a #GtkStyleProperties
880 * @props_to_merge: a second #GtkStyleProperties
881 * @replace: whether to replace values or not
883 * Merges into @props all the style information contained
884 * in @props_to_merge. If @replace is %TRUE, the values
885 * will be overwritten, if it is %FALSE, the older values
891 gtk_style_properties_merge (GtkStyleProperties *props,
892 const GtkStyleProperties *props_to_merge,
895 GtkStylePropertiesPrivate *priv, *priv_to_merge;
899 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
900 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props_to_merge));
903 priv_to_merge = props_to_merge->priv;
905 /* Merge symbolic color map */
906 if (priv_to_merge->color_map)
908 g_hash_table_iter_init (&iter, priv_to_merge->color_map);
910 while (g_hash_table_iter_next (&iter, &key, &value))
913 GtkSymbolicColor *color;
919 g_hash_table_lookup (priv->color_map, name))
922 gtk_style_properties_map_color (props, name, color);
926 /* Merge symbolic style properties */
927 g_hash_table_iter_init (&iter, priv_to_merge->properties);
929 while (g_hash_table_iter_next (&iter, &key, &value))
931 PropertyData *prop_to_merge = value;
935 prop = g_hash_table_lookup (priv->properties, key);
939 prop = property_data_new ();
940 g_hash_table_insert (priv->properties, key, prop);
943 for (i = 0; i < prop_to_merge->values->len; i++)
948 data = &g_array_index (prop_to_merge->values, ValueData, i);
950 if (replace && data->state == GTK_STATE_FLAG_NORMAL &&
951 G_VALUE_TYPE (&data->value) != PANGO_TYPE_FONT_DESCRIPTION)
953 /* Let normal state override all states
954 * previously set in the original set
956 property_data_remove_values (prop);
959 value = property_data_get_value (prop, data->state);
961 if (G_VALUE_TYPE (&data->value) == PANGO_TYPE_FONT_DESCRIPTION &&
964 PangoFontDescription *font_desc;
965 PangoFontDescription *font_desc_to_merge;
967 /* Handle merging of font descriptions */
968 font_desc = g_value_get_boxed (value);
969 font_desc_to_merge = g_value_get_boxed (&data->value);
971 pango_font_description_merge (font_desc, font_desc_to_merge, replace);
973 else if (G_VALUE_TYPE (&data->value) == G_TYPE_PTR_ARRAY &&
976 GPtrArray *array, *array_to_merge;
979 /* Append the array, mainly thought
980 * for the gtk-key-bindings property
982 array = g_value_get_boxed (value);
983 array_to_merge = g_value_get_boxed (&data->value);
985 for (i = 0; i < array_to_merge->len; i++)
986 g_ptr_array_add (array, g_ptr_array_index (array_to_merge, i));
988 else if (replace || !G_IS_VALUE (value))
990 if (!G_IS_VALUE (value))
991 g_value_init (value, G_VALUE_TYPE (&data->value));
992 else if (G_VALUE_TYPE (value) != G_VALUE_TYPE (&data->value))
994 g_value_unset (value);
995 g_value_init (value, G_VALUE_TYPE (&data->value));
998 g_value_copy (&data->value, value);