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 "gtkcssshorthandpropertyprivate.h"
35 #include "gtkcsstypesprivate.h"
36 #include "gtkborderimageprivate.h"
38 #include "gtkprivatetypebuiltins.h"
39 #include "gtkstylepropertyprivate.h"
40 #include "gtkstyleproviderprivate.h"
43 #include "gtkwin32themeprivate.h"
46 * SECTION:gtkstyleproperties
47 * @Short_description: Store for style property information
48 * @Title: GtkStyleProperties
50 * GtkStyleProperties provides the storage for style information
51 * that is used by #GtkStyleContext and other #GtkStyleProvider
54 * Before style properties can be stored in GtkStyleProperties, they
55 * must be registered with gtk_style_properties_register_property().
57 * Unless you are writing a #GtkStyleProvider implementation, you
58 * are unlikely to use this API directly, as gtk_style_context_get()
59 * and its variants are the preferred way to access styling information
60 * from widget implementations and theming engine implementations
61 * should use the APIs provided by #GtkThemingEngine instead.
64 typedef struct PropertyData PropertyData;
65 typedef struct ValueData ValueData;
78 struct _GtkStylePropertiesPrivate
80 GHashTable *color_map;
81 GHashTable *properties;
82 GtkSymbolicColorLookupFunc color_lookup_func;
83 gpointer color_lookup_data;
86 static void gtk_style_properties_provider_init (GtkStyleProviderIface *iface);
87 static void gtk_style_properties_provider_private_init (GtkStyleProviderPrivateInterface *iface);
88 static void gtk_style_properties_finalize (GObject *object);
91 G_DEFINE_TYPE_EXTENDED (GtkStyleProperties, gtk_style_properties, G_TYPE_OBJECT, 0,
92 G_IMPLEMENT_INTERFACE (GTK_TYPE_STYLE_PROVIDER,
93 gtk_style_properties_provider_init)
94 G_IMPLEMENT_INTERFACE (GTK_TYPE_STYLE_PROVIDER_PRIVATE,
95 gtk_style_properties_provider_private_init));
98 gtk_style_properties_class_init (GtkStylePropertiesClass *klass)
100 GObjectClass *object_class = G_OBJECT_CLASS (klass);
102 object_class->finalize = gtk_style_properties_finalize;
104 g_type_class_add_private (object_class, sizeof (GtkStylePropertiesPrivate));
107 static PropertyData *
108 property_data_new (void)
112 data = g_slice_new0 (PropertyData);
113 data->values = g_array_new (FALSE, FALSE, sizeof (ValueData));
119 property_data_remove_values (PropertyData *data)
123 for (i = 0; i < data->values->len; i++)
125 ValueData *value_data;
127 value_data = &g_array_index (data->values, ValueData, i);
129 if (G_IS_VALUE (&value_data->value))
130 g_value_unset (&value_data->value);
133 if (data->values->len > 0)
134 g_array_remove_range (data->values, 0, data->values->len);
138 property_data_free (PropertyData *data)
140 property_data_remove_values (data);
141 g_array_free (data->values, TRUE);
142 g_slice_free (PropertyData, data);
146 property_data_find_position (PropertyData *data,
151 gboolean found = FALSE;
157 if (data->values->len == 0)
160 /* Find position for the given state, or the position where
161 * it would be if not found, the array is ordered by the
165 max = data->values->len - 1;
169 ValueData *value_data;
171 mid = (min + max) / 2;
172 value_data = &g_array_index (data->values, ValueData, mid);
174 if (value_data->state == state)
179 else if (value_data->state < state)
180 position = min = mid + 1;
187 while (!found && min <= max);
196 property_data_get_value (PropertyData *data,
202 if (!property_data_find_position (data, state, &pos))
204 ValueData new = { 0 };
207 g_array_insert_val (data->values, pos, new);
210 val_data = &g_array_index (data->values, ValueData, pos);
212 return &val_data->value;
216 property_data_match_state (PropertyData *data,
222 if (property_data_find_position (data, state, &pos))
227 val_data = &g_array_index (data->values, ValueData, pos);
228 return &val_data->value;
231 if (pos >= data->values->len)
232 pos = data->values->len - 1;
234 /* No exact match, go downwards the list to find
235 * the closest match to the given state flags, as
236 * a side effect, there is an implicit precedence
237 * of higher flags over the smaller ones.
239 for (i = pos; i >= 0; i--)
243 val_data = &g_array_index (data->values, ValueData, i);
245 /* Check whether any of the requested
246 * flags are set, and no other flags are.
248 * Also, no flags acts as a wildcard, such
249 * value should be always in the first position
250 * in the array (if present) anyways.
252 if (val_data->state == 0 ||
253 ((val_data->state & state) != 0 &&
254 (val_data->state & ~state) == 0))
255 return &val_data->value;
262 gtk_style_properties_init (GtkStyleProperties *props)
264 GtkStylePropertiesPrivate *priv;
266 priv = props->priv = G_TYPE_INSTANCE_GET_PRIVATE (props,
267 GTK_TYPE_STYLE_PROPERTIES,
268 GtkStylePropertiesPrivate);
270 priv->properties = g_hash_table_new_full (NULL, NULL, NULL,
271 (GDestroyNotify) property_data_free);
275 gtk_style_properties_finalize (GObject *object)
277 GtkStylePropertiesPrivate *priv;
278 GtkStyleProperties *props;
280 props = GTK_STYLE_PROPERTIES (object);
282 g_hash_table_destroy (priv->properties);
285 g_hash_table_destroy (priv->color_map);
287 G_OBJECT_CLASS (gtk_style_properties_parent_class)->finalize (object);
291 gtk_style_properties_get_style (GtkStyleProvider *provider,
294 /* Return style set itself */
295 return g_object_ref (provider);
299 gtk_style_properties_provider_init (GtkStyleProviderIface *iface)
301 iface->get_style = gtk_style_properties_get_style;
304 static GtkSymbolicColor *
305 gtk_style_properties_provider_get_color (GtkStyleProviderPrivate *provider,
308 return gtk_style_properties_lookup_color (GTK_STYLE_PROPERTIES (provider), name);
312 gtk_style_properties_provider_lookup (GtkStyleProviderPrivate *provider,
315 GtkCssLookup *lookup)
317 GtkStyleProperties *props;
318 GtkStylePropertiesPrivate *priv;
322 props = GTK_STYLE_PROPERTIES (provider);
325 /* Merge symbolic style properties */
326 g_hash_table_iter_init (&iter, priv->properties);
328 while (g_hash_table_iter_next (&iter, &key, &value))
330 GtkStyleProperty *prop = key;
331 PropertyData *data = value;
335 id = _gtk_style_property_get_id (prop);
337 if (!_gtk_css_lookup_is_missing (lookup, id))
340 value = property_data_match_state (data, state);
344 _gtk_css_lookup_set (lookup, id, value);
349 gtk_style_properties_provider_private_init (GtkStyleProviderPrivateInterface *iface)
351 iface->get_color = gtk_style_properties_provider_get_color;
352 iface->lookup = gtk_style_properties_provider_lookup;
355 /* Property registration functions */
358 * gtk_style_properties_register_property: (skip)
359 * @parse_func: parsing function to use, or %NULL
360 * @pspec: the #GParamSpec for the new property
362 * Registers a property so it can be used in the CSS file format.
363 * This function is the low-level equivalent of
364 * gtk_theming_engine_register_property(), if you are implementing
365 * a theming engine, you want to use that function instead.
370 gtk_style_properties_register_property (GtkStylePropertyParser parse_func,
373 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
375 _gtk_style_property_register (pspec,
384 * gtk_style_properties_lookup_property: (skip)
385 * @property_name: property name to look up
386 * @parse_func: (out): return location for the parse function
387 * @pspec: (out) (transfer none): return location for the #GParamSpec
389 * Returns %TRUE if a property has been registered, if @pspec or
390 * @parse_func are not %NULL, the #GParamSpec and parsing function
391 * will be respectively returned.
393 * Returns: %TRUE if the property is registered, %FALSE otherwise
398 gtk_style_properties_lookup_property (const gchar *property_name,
399 GtkStylePropertyParser *parse_func,
402 const GtkStyleProperty *node;
403 gboolean found = FALSE;
405 g_return_val_if_fail (property_name != NULL, FALSE);
407 node = _gtk_style_property_lookup (property_name);
412 *pspec = node->pspec;
415 *parse_func = node->property_parse_func;
423 /* GtkStyleProperties methods */
426 * gtk_style_properties_new:
428 * Returns a newly created #GtkStyleProperties
430 * Returns: a new #GtkStyleProperties
433 gtk_style_properties_new (void)
435 return g_object_new (GTK_TYPE_STYLE_PROPERTIES, NULL);
439 _gtk_style_properties_set_color_lookup_func (GtkStyleProperties *props,
440 GtkSymbolicColorLookupFunc func,
443 GtkStylePropertiesPrivate *priv;
445 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
446 g_return_if_fail (func != NULL);
449 g_return_if_fail (priv->color_map == NULL);
451 priv->color_lookup_func = func;
452 priv->color_lookup_data = data;
456 * gtk_style_properties_map_color:
457 * @props: a #GtkStyleProperties
459 * @color: #GtkSymbolicColor to map @name to
461 * Maps @color so it can be referenced by @name. See
462 * gtk_style_properties_lookup_color()
467 gtk_style_properties_map_color (GtkStyleProperties *props,
469 GtkSymbolicColor *color)
471 GtkStylePropertiesPrivate *priv;
473 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
474 g_return_if_fail (name != NULL);
475 g_return_if_fail (color != NULL);
478 g_return_if_fail (priv->color_lookup_func == NULL);
480 if (G_UNLIKELY (!priv->color_map))
481 priv->color_map = g_hash_table_new_full (g_str_hash,
483 (GDestroyNotify) g_free,
484 (GDestroyNotify) gtk_symbolic_color_unref);
486 g_hash_table_replace (priv->color_map,
488 gtk_symbolic_color_ref (color));
492 * gtk_style_properties_lookup_color:
493 * @props: a #GtkStyleProperties
494 * @name: color name to lookup
496 * Returns the symbolic color that is mapped
499 * Returns: (transfer none): The mapped color
504 gtk_style_properties_lookup_color (GtkStyleProperties *props,
507 GtkStylePropertiesPrivate *priv;
509 g_return_val_if_fail (GTK_IS_STYLE_PROPERTIES (props), NULL);
510 g_return_val_if_fail (name != NULL, NULL);
514 if (priv->color_lookup_func)
515 return priv->color_lookup_func (priv->color_lookup_data, name);
517 if (!priv->color_map)
520 return g_hash_table_lookup (priv->color_map, name);
524 _gtk_style_properties_set_property_by_property (GtkStyleProperties *props,
525 const GtkStyleProperty *style_prop,
529 GtkStylePropertiesPrivate *priv;
534 value_type = G_VALUE_TYPE (value);
536 if (style_prop->pspec->value_type == GDK_TYPE_RGBA ||
537 style_prop->pspec->value_type == GDK_TYPE_COLOR)
539 /* Allow GtkSymbolicColor and special values as well */
540 g_return_if_fail (value_type == GDK_TYPE_RGBA ||
541 value_type == GDK_TYPE_COLOR ||
542 value_type == GTK_TYPE_CSS_SPECIAL_VALUE ||
543 value_type == GTK_TYPE_SYMBOLIC_COLOR);
545 else if (style_prop->pspec->value_type == CAIRO_GOBJECT_TYPE_PATTERN)
547 /* Allow GtkGradient and theme part as a substitute */
548 g_return_if_fail (value_type == CAIRO_GOBJECT_TYPE_PATTERN ||
549 value_type == GTK_TYPE_GRADIENT ||
550 value_type == GTK_TYPE_WIN32_THEME_PART);
552 else if (style_prop->pspec->value_type == G_TYPE_INT)
554 g_return_if_fail (value_type == G_TYPE_INT ||
555 value_type == GTK_TYPE_CSS_BORDER_RADIUS);
558 g_return_if_fail (style_prop->pspec->value_type == value_type);
560 if (GTK_IS_CSS_SHORTHAND_PROPERTY (style_prop))
562 GParameter *parameters;
563 guint i, n_parameters;
565 parameters = _gtk_style_property_unpack (style_prop, value, &n_parameters);
567 for (i = 0; i < n_parameters; i++)
569 gtk_style_properties_set_property (props,
572 ¶meters[i].value);
573 g_value_unset (¶meters[i].value);
580 prop = g_hash_table_lookup (priv->properties, style_prop);
584 prop = property_data_new ();
585 g_hash_table_insert (priv->properties, (gpointer) style_prop, prop);
588 val = property_data_get_value (prop, state);
590 if (G_VALUE_TYPE (val) == value_type)
594 if (G_IS_VALUE (val))
597 g_value_init (val, value_type);
600 g_value_copy (value, val);
601 if (style_prop->pspec->value_type == value_type)
602 g_param_value_validate (style_prop->pspec, val);
606 * gtk_style_properties_set_property:
607 * @props: a #GtkStyleProperties
608 * @property: styling property to set
609 * @state: state to set the value for
610 * @value: new value for the property
612 * Sets a styling property in @props.
617 gtk_style_properties_set_property (GtkStyleProperties *props,
618 const gchar *property,
622 const GtkStyleProperty *node;
624 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
625 g_return_if_fail (property != NULL);
626 g_return_if_fail (value != NULL);
628 node = _gtk_style_property_lookup (property);
632 g_warning ("Style property \"%s\" is not registered", property);
636 _gtk_style_properties_set_property_by_property (props,
643 * gtk_style_properties_set_valist:
644 * @props: a #GtkStyleProperties
645 * @state: state to set the values for
646 * @args: va_list of property name/value pairs, followed by %NULL
648 * Sets several style properties on @props.
653 gtk_style_properties_set_valist (GtkStyleProperties *props,
657 const gchar *property_name;
659 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
661 property_name = va_arg (args, const gchar *);
663 while (property_name)
665 const GtkStyleProperty *node;
667 GValue val = G_VALUE_INIT;
669 node = _gtk_style_property_lookup (property_name);
673 g_warning ("Style property \"%s\" is not registered", property_name);
677 G_VALUE_COLLECT_INIT (&val, node->pspec->value_type,
681 g_warning ("Could not set style property \"%s\": %s", property_name, error);
682 g_value_unset (&val);
687 _gtk_style_properties_set_property_by_property (props, node, state, &val);
688 g_value_unset (&val);
690 property_name = va_arg (args, const gchar *);
695 * gtk_style_properties_set:
696 * @props: a #GtkStyleProperties
697 * @state: state to set the values for
698 * @...: property name/value pairs, followed by %NULL
700 * Sets several style properties on @props.
705 gtk_style_properties_set (GtkStyleProperties *props,
711 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
713 va_start (args, state);
714 gtk_style_properties_set_valist (props, state, args);
719 _gtk_style_properties_peek_property (GtkStyleProperties *props,
720 const GtkStyleProperty *property,
723 GtkStylePropertiesPrivate *priv;
726 g_return_val_if_fail (GTK_IS_STYLE_PROPERTIES (props), FALSE);
727 g_return_val_if_fail (property != NULL, FALSE);
730 prop = g_hash_table_lookup (priv->properties, property);
734 return property_data_match_state (prop, state);
738 _gtk_style_properties_get_property (GtkStyleProperties *props,
739 const gchar *property,
741 GtkStylePropertyContext *context,
744 const GtkStyleProperty *node;
746 g_return_val_if_fail (GTK_IS_STYLE_PROPERTIES (props), FALSE);
747 g_return_val_if_fail (property != NULL, FALSE);
748 g_return_val_if_fail (value != NULL, FALSE);
750 node = _gtk_style_property_lookup (property);
753 g_warning ("Style property \"%s\" is not registered", property);
757 _gtk_style_property_query (node, props, state, context, value);
762 * gtk_style_properties_get_property:
763 * @props: a #GtkStyleProperties
764 * @property: style property name
765 * @state: state to retrieve the property value for
766 * @value: (out) (transfer full): return location for the style property value.
768 * Gets a style property from @props for the given state. When done with @value,
769 * g_value_unset() needs to be called to free any allocated memory.
771 * Returns: %TRUE if the property exists in @props, %FALSE otherwise
776 gtk_style_properties_get_property (GtkStyleProperties *props,
777 const gchar *property,
781 GtkStylePropertyContext context = { 100, 100};
783 g_return_val_if_fail (GTK_IS_STYLE_PROPERTIES (props), FALSE);
784 g_return_val_if_fail (property != NULL, FALSE);
785 g_return_val_if_fail (value != NULL, FALSE);
787 return _gtk_style_properties_get_property (props,
789 state, &context, value);
793 _gtk_style_properties_get_valist (GtkStyleProperties *props,
795 GtkStylePropertyContext *context,
798 const gchar *property_name;
800 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
802 property_name = va_arg (args, const gchar *);
804 while (property_name)
807 GValue value = G_VALUE_INIT;
809 if (!_gtk_style_properties_get_property (props,
816 G_VALUE_LCOPY (&value, args, 0, &error);
817 g_value_unset (&value);
821 g_warning ("Could not get style property \"%s\": %s", property_name, error);
826 property_name = va_arg (args, const gchar *);
831 * gtk_style_properties_get_valist:
832 * @props: a #GtkStyleProperties
833 * @state: state to retrieve the property values for
834 * @args: va_list of property name/return location pairs, followed by %NULL
836 * Retrieves several style property values from @props for a given state.
841 gtk_style_properties_get_valist (GtkStyleProperties *props,
845 GtkStylePropertyContext context = { 100, 100};
847 return _gtk_style_properties_get_valist (props, state, &context, args);
851 _gtk_style_properties_get (GtkStyleProperties *props,
853 GtkStylePropertyContext *context,
858 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
860 va_start (args, context);
861 _gtk_style_properties_get_valist (props, state, context, args);
866 * gtk_style_properties_get:
867 * @props: a #GtkStyleProperties
868 * @state: state to retrieve the property values for
869 * @...: property name /return value pairs, followed by %NULL
871 * Retrieves several style property values from @props for a
877 gtk_style_properties_get (GtkStyleProperties *props,
883 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
885 va_start (args, state);
886 gtk_style_properties_get_valist (props, state, args);
891 * gtk_style_properties_unset_property:
892 * @props: a #GtkStyleProperties
893 * @property: property to unset
894 * @state: state to unset
896 * Unsets a style property in @props.
901 gtk_style_properties_unset_property (GtkStyleProperties *props,
902 const gchar *property,
905 GtkStylePropertiesPrivate *priv;
906 const GtkStyleProperty *node;
910 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
911 g_return_if_fail (property != NULL);
913 node = _gtk_style_property_lookup (property);
917 g_warning ("Style property \"%s\" is not registered", property);
921 if (node->unset_func)
923 node->unset_func (props, state);
928 prop = g_hash_table_lookup (priv->properties, node);
933 if (property_data_find_position (prop, state, &pos))
937 data = &g_array_index (prop->values, ValueData, pos);
939 if (G_IS_VALUE (&data->value))
940 g_value_unset (&data->value);
942 g_array_remove_index (prop->values, pos);
947 * gtk_style_properties_clear:
948 * @props: a #GtkStyleProperties
950 * Clears all style information from @props.
953 gtk_style_properties_clear (GtkStyleProperties *props)
955 GtkStylePropertiesPrivate *priv;
957 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
960 g_hash_table_remove_all (priv->properties);
964 * gtk_style_properties_merge:
965 * @props: a #GtkStyleProperties
966 * @props_to_merge: a second #GtkStyleProperties
967 * @replace: whether to replace values or not
969 * Merges into @props all the style information contained
970 * in @props_to_merge. If @replace is %TRUE, the values
971 * will be overwritten, if it is %FALSE, the older values
977 gtk_style_properties_merge (GtkStyleProperties *props,
978 const GtkStyleProperties *props_to_merge,
981 GtkStylePropertiesPrivate *priv, *priv_to_merge;
985 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props));
986 g_return_if_fail (GTK_IS_STYLE_PROPERTIES (props_to_merge));
989 priv_to_merge = props_to_merge->priv;
991 /* Merge symbolic color map */
992 if (priv_to_merge->color_map)
994 g_hash_table_iter_init (&iter, priv_to_merge->color_map);
996 while (g_hash_table_iter_next (&iter, &key, &value))
999 GtkSymbolicColor *color;
1005 g_hash_table_lookup (priv->color_map, name))
1008 gtk_style_properties_map_color (props, name, color);
1012 /* Merge symbolic style properties */
1013 g_hash_table_iter_init (&iter, priv_to_merge->properties);
1015 while (g_hash_table_iter_next (&iter, &key, &value))
1017 PropertyData *prop_to_merge = value;
1021 prop = g_hash_table_lookup (priv->properties, key);
1025 prop = property_data_new ();
1026 g_hash_table_insert (priv->properties, key, prop);
1029 for (i = 0; i < prop_to_merge->values->len; i++)
1034 data = &g_array_index (prop_to_merge->values, ValueData, i);
1036 if (replace && data->state == GTK_STATE_FLAG_NORMAL &&
1037 G_VALUE_TYPE (&data->value) != PANGO_TYPE_FONT_DESCRIPTION)
1039 /* Let normal state override all states
1040 * previously set in the original set
1042 property_data_remove_values (prop);
1045 value = property_data_get_value (prop, data->state);
1047 if (G_VALUE_TYPE (&data->value) == PANGO_TYPE_FONT_DESCRIPTION &&
1050 PangoFontDescription *font_desc;
1051 PangoFontDescription *font_desc_to_merge;
1053 /* Handle merging of font descriptions */
1054 font_desc = g_value_get_boxed (value);
1055 font_desc_to_merge = g_value_get_boxed (&data->value);
1057 pango_font_description_merge (font_desc, font_desc_to_merge, replace);
1059 else if (G_VALUE_TYPE (&data->value) == G_TYPE_PTR_ARRAY &&
1062 GPtrArray *array, *array_to_merge;
1065 /* Append the array, mainly thought
1066 * for the gtk-key-bindings property
1068 array = g_value_get_boxed (value);
1069 array_to_merge = g_value_get_boxed (&data->value);
1071 for (i = 0; i < array_to_merge->len; i++)
1072 g_ptr_array_add (array, g_ptr_array_index (array_to_merge, i));
1074 else if (replace || !G_IS_VALUE (value))
1076 if (!G_IS_VALUE (value))
1077 g_value_init (value, G_VALUE_TYPE (&data->value));
1078 else if (G_VALUE_TYPE (value) != G_VALUE_TYPE (&data->value))
1080 g_value_unset (value);
1081 g_value_init (value, G_VALUE_TYPE (&data->value));
1084 g_value_copy (&data->value, value);