Pileus Git - ~andy/gtk/blob - gtk/gtkcssstyleproperty.c

   1 /*
   2  * Copyright © 2011 Red Hat Inc.
   3  *
   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.1 of the License, or (at your option) any later version.
   8  *
   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.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  16  *
  17  * Authors: Benjamin Otte <otte@gnome.org>
  18  */
  19
  20 #include "config.h"
  21
  22 #include "gtkcssstylepropertyprivate.h"
  23
  24 #include "gtkcssinheritvalueprivate.h"
  25 #include "gtkcssinitialvalueprivate.h"
  26 #include "gtkcssstylefuncsprivate.h"
  27 #include "gtkcsstypesprivate.h"
  28 #include "gtkintl.h"
  29 #include "gtkprivatetypebuiltins.h"
  30 #include "gtkstylepropertiesprivate.h"
  31
  32 /* this is in case round() is not provided by the compiler,
  33  * such as in the case of C89 compilers, like MSVC
  34  */
  35 #include "fallback-c89.c"
  36
  37 enum {
  38   PROP_0,
  39   PROP_ANIMATED,
  40   PROP_ID,
  41   PROP_INHERIT,
  42   PROP_INITIAL
  43 };
  44
  45 G_DEFINE_TYPE (GtkCssStyleProperty, _gtk_css_style_property, GTK_TYPE_STYLE_PROPERTY)
  46
  47 static void
  48 gtk_css_style_property_constructed (GObject *object)
  49 {
  50   GtkCssStyleProperty *property = GTK_CSS_STYLE_PROPERTY (object);
  51   GtkCssStylePropertyClass *klass = GTK_CSS_STYLE_PROPERTY_GET_CLASS (property);
  52
  53   property->id = klass->style_properties->len;
  54   g_ptr_array_add (klass->style_properties, property);
  55
  56   G_OBJECT_CLASS (_gtk_css_style_property_parent_class)->constructed (object);
  57 }
  58
  59 static void
  60 gtk_css_style_property_set_property (GObject      *object,
  61                                      guint         prop_id,
  62                                      const GValue *value,
  63                                      GParamSpec   *pspec)
  64 {
  65   GtkCssStyleProperty *property = GTK_CSS_STYLE_PROPERTY (object);
  66
  67   switch (prop_id)
  68     {
  69     case PROP_ANIMATED:
  70       property->animated = g_value_get_boolean (value);
  71       break;
  72     case PROP_INHERIT:
  73       property->inherit = g_value_get_boolean (value);
  74       break;
  75     case PROP_INITIAL:
  76       property->initial_value = g_value_dup_boxed (value);
  77       g_assert (property->initial_value != NULL);
  78       break;
  79     default:
  80       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
  81       break;
  82     }
  83 }
  84
  85 static void
  86 gtk_css_style_property_get_property (GObject    *object,
  87                                      guint       prop_id,
  88                                      GValue     *value,
  89                                      GParamSpec *pspec)
  90 {
  91   GtkCssStyleProperty *property = GTK_CSS_STYLE_PROPERTY (object);
  92
  93   switch (prop_id)
  94     {
  95     case PROP_ANIMATED:
  96       g_value_set_boolean (value, property->animated);
  97       break;
  98     case PROP_ID:
  99       g_value_set_boolean (value, property->id);
 100       break;
 101     case PROP_INHERIT:
 102       g_value_set_boolean (value, property->inherit);
 103       break;
 104     case PROP_INITIAL:
 105       g_value_set_boxed (value, property->initial_value);
 106       break;
 107     default:
 108       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 109       break;
 110     }
 111 }
 112
 113 static void
 114 _gtk_css_style_property_assign (GtkStyleProperty   *property,
 115                                 GtkStyleProperties *props,
 116                                 GtkStateFlags       state,
 117                                 const GValue       *value)
 118 {
 119   GtkCssStyleProperty *style;
 120   GtkCssValue *css_value;
 121
 122   style = GTK_CSS_STYLE_PROPERTY (property);
 123   css_value = style->assign_value (style, value);
 124
 125   _gtk_style_properties_set_property_by_property (props,
 126                                                   style,
 127                                                   state,
 128                                                   css_value);
 129   _gtk_css_value_unref (css_value);
 130 }
 131
 132 static void
 133 _gtk_css_style_property_query (GtkStyleProperty   *property,
 134                                GValue             *value,
 135                                GtkStyleQueryFunc   query_func,
 136                                gpointer            query_data)
 137 {
 138   GtkCssStyleProperty *style_property = GTK_CSS_STYLE_PROPERTY (property);
 139   GtkCssValue *css_value;
 140
 141   css_value = (* query_func) (GTK_CSS_STYLE_PROPERTY (property)->id, query_data);
 142   if (css_value == NULL)
 143     css_value =_gtk_css_style_property_get_initial_value (style_property);
 144
 145   style_property->query_value (style_property, css_value, value);
 146 }
 147
 148 static GtkCssValue *
 149 gtk_css_style_property_parse_value (GtkStyleProperty *property,
 150                                     GtkCssParser     *parser,
 151                                     GFile            *base)
 152 {
 153   GtkCssStyleProperty *style_property = GTK_CSS_STYLE_PROPERTY (property);
 154
 155   if (_gtk_css_parser_try (parser, "initial", TRUE))
 156     {
 157       /* the initial value can be explicitly specified with the
 158        * ‘initial’ keyword which all properties accept.
 159        */
 160       return _gtk_css_initial_value_new ();
 161     }
 162   else if (_gtk_css_parser_try (parser, "inherit", TRUE))
 163     {
 164       /* All properties accept the ‘inherit’ value which
 165        * explicitly specifies that the value will be determined
 166        * by inheritance. The ‘inherit’ value can be used to
 167        * strengthen inherited values in the cascade, and it can
 168        * also be used on properties that are not normally inherited.
 169        */
 170       return _gtk_css_inherit_value_new ();
 171     }
 172
 173   return (* style_property->parse_value) (style_property, parser, base);
 174 }
 175
 176 static void
 177 _gtk_css_style_property_class_init (GtkCssStylePropertyClass *klass)
 178 {
 179   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 180   GtkStylePropertyClass *property_class = GTK_STYLE_PROPERTY_CLASS (klass);
 181
 182   object_class->constructed = gtk_css_style_property_constructed;
 183   object_class->set_property = gtk_css_style_property_set_property;
 184   object_class->get_property = gtk_css_style_property_get_property;
 185
 186   g_object_class_install_property (object_class,
 187                                    PROP_ANIMATED,
 188                                    g_param_spec_boolean ("animated",
 189                                                          P_("Animated"),
 190                                                          P_("Set if the value can be animated"),
 191                                                          FALSE,
 192                                                          G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
 193   g_object_class_install_property (object_class,
 194                                    PROP_ID,
 195                                    g_param_spec_uint ("id",
 196                                                       P_("ID"),
 197                                                       P_("The numeric id for quick access"),
 198                                                       0, G_MAXUINT, 0,
 199                                                       G_PARAM_READABLE));
 200   g_object_class_install_property (object_class,
 201                                    PROP_INHERIT,
 202                                    g_param_spec_boolean ("inherit",
 203                                                          P_("Inherit"),
 204                                                          P_("Set if the value is inherited by default"),
 205                                                          FALSE,
 206                                                          G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
 207   g_object_class_install_property (object_class,
 208                                    PROP_INITIAL,
 209                                    g_param_spec_boxed ("initial-value",
 210                                                        P_("Initial value"),
 211                                                        P_("The initial specified value used for this property"),
 212                                                        GTK_TYPE_CSS_VALUE,
 213                                                        G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
 214
 215   property_class->assign = _gtk_css_style_property_assign;
 216   property_class->query = _gtk_css_style_property_query;
 217   property_class->parse_value = gtk_css_style_property_parse_value;
 218
 219   klass->style_properties = g_ptr_array_new ();
 220 }
 221
 222 static GtkCssValue *
 223 gtk_css_style_property_real_parse_value (GtkCssStyleProperty *property,
 224                                          GtkCssParser        *parser,
 225                                          GFile               *base)
 226 {
 227   g_assert_not_reached ();
 228   return NULL;
 229 }
 230
 231 static void
 232 gtk_css_style_property_real_print_value (GtkCssStyleProperty *property,
 233                                          const GtkCssValue   *value,
 234                                          GString             *string)
 235 {
 236   _gtk_css_value_print (value, string);
 237 }
 238
 239 static GtkCssValue *
 240 gtk_css_style_property_real_compute_value (GtkCssStyleProperty *property,
 241                                            GtkStyleContext     *context,
 242                                            GtkCssValue         *specified)
 243 {
 244   return _gtk_css_value_ref (specified);
 245 }
 246
 247 static gboolean
 248 gtk_css_style_property_real_equal (GtkCssStyleProperty *property,
 249                                    GtkCssValue         *value1,
 250                                    GtkCssValue         *value2)
 251 {
 252   return _gtk_css_value_equal (value1, value2);
 253 }
 254
 255 static void
 256 _gtk_css_style_property_init (GtkCssStyleProperty *property)
 257 {
 258   property->parse_value = gtk_css_style_property_real_parse_value;
 259   property->print_value = gtk_css_style_property_real_print_value;
 260   property->compute_value = gtk_css_style_property_real_compute_value;
 261   property->equal_func = gtk_css_style_property_real_equal;
 262 }
 263
 264 /**
 265  * _gtk_css_style_property_get_n_properties:
 266  *
 267  * Gets the number of style properties. This number can increase when new
 268  * theme engines are loaded. Shorthand properties are not included here.
 269  *
 270  * Returns: The number of style properties.
 271  **/
 272 guint
 273 _gtk_css_style_property_get_n_properties (void)
 274 {
 275   GtkCssStylePropertyClass *klass;
 276
 277   klass = g_type_class_peek (GTK_TYPE_CSS_STYLE_PROPERTY);
 278   if (G_UNLIKELY (klass == NULL))
 279     {
 280       _gtk_style_property_init_properties ();
 281       klass = g_type_class_peek (GTK_TYPE_CSS_STYLE_PROPERTY);
 282       g_assert (klass);
 283     }
 284
 285   return klass->style_properties->len;
 286 }
 287
 288 /**
 289  * _gtk_css_style_property_lookup_by_id:
 290  * @id: the id of the property
 291  *
 292  * Gets the style property with the given id. All style properties (but not
 293  * shorthand properties) are indexable by id so that it's easy to use arrays
 294  * when doing style lookups.
 295  *
 296  * Returns: (transfer none): The style property with the given id
 297  **/
 298 GtkCssStyleProperty *
 299 _gtk_css_style_property_lookup_by_id (guint id)
 300 {
 301   GtkCssStylePropertyClass *klass;
 302
 303   klass = g_type_class_peek (GTK_TYPE_CSS_STYLE_PROPERTY);
 304   if (G_UNLIKELY (klass == NULL))
 305     {
 306       _gtk_style_property_init_properties ();
 307       klass = g_type_class_peek (GTK_TYPE_CSS_STYLE_PROPERTY);
 308       g_assert (klass);
 309     }
 310   g_return_val_if_fail (id < klass->style_properties->len, NULL);
 311
 312   return g_ptr_array_index (klass->style_properties, id);
 313 }
 314
 315 /**
 316  * _gtk_css_style_property_is_inherit:
 317  * @property: the property
 318  *
 319  * Queries if the given @property is inherited. See
 320  * <ulink url="http://www.w3.org/TR/css3-cascade/#inheritance>
 321  * the CSS documentation</ulink> for an explanation of this concept.
 322  *
 323  * Returns: %TRUE if the property is inherited by default.
 324  **/
 325 gboolean
 326 _gtk_css_style_property_is_inherit (GtkCssStyleProperty *property)
 327 {
 328   g_return_val_if_fail (GTK_IS_CSS_STYLE_PROPERTY (property), FALSE);
 329
 330   return property->inherit;
 331 }
 332
 333 /**
 334  * _gtk_css_style_property_is_animated:
 335  * @property: the property
 336  *
 337  * Queries if the given @property can be is animated. See
 338  * <ulink url="http://www.w3.org/TR/css3-transitions/#animatable-css>
 339  * the CSS documentation</ulink> for animatable properties.
 340  *
 341  * Returns: %TRUE if the property can be animated.
 342  **/
 343 gboolean
 344 _gtk_css_style_property_is_animated (GtkCssStyleProperty *property)
 345 {
 346   g_return_val_if_fail (GTK_IS_CSS_STYLE_PROPERTY (property), FALSE);
 347
 348   return property->animated;
 349 }
 350
 351 /**
 352  * _gtk_css_style_property_get_id:
 353  * @property: the property
 354  *
 355  * Gets the id for the given property. IDs are used to allow using arrays
 356  * for style lookups.
 357  *
 358  * Returns: The id of the property
 359  **/
 360 guint
 361 _gtk_css_style_property_get_id (GtkCssStyleProperty *property)
 362 {
 363   g_return_val_if_fail (GTK_IS_CSS_STYLE_PROPERTY (property), 0);
 364
 365   return property->id;
 366 }
 367
 368 /**
 369  * _gtk_css_style_property_get_initial_value:
 370  * @property: the property
 371  *
 372  * Queries the initial value of the given @property. See
 373  * <ulink url="http://www.w3.org/TR/css3-cascade/#intial>
 374  * the CSS documentation</ulink> for an explanation of this concept.
 375  *
 376  * Returns: a reference to the initial value. The value will never change.
 377  **/
 378 GtkCssValue *
 379 _gtk_css_style_property_get_initial_value (GtkCssStyleProperty *property)
 380 {
 381   g_return_val_if_fail (GTK_IS_CSS_STYLE_PROPERTY (property), NULL);
 382
 383   return property->initial_value;
 384 }
 385
 386 /**
 387  * _gtk_css_style_property_compute_value:
 388  * @property: the property
 389  * @computed: (out): an uninitialized value to be filled with the result
 390  * @context: the context to use for resolving
 391  * @specified: the value to compute from
 392  *
 393  * Converts the @specified value into the @computed value using the
 394  * information in @context. This step is explained in detail in
 395  * <ulink url="http://www.w3.org/TR/css3-cascade/#computed>
 396  * the CSS documentation</ulink>.
 397  **/
 398 GtkCssValue *
 399 _gtk_css_style_property_compute_value (GtkCssStyleProperty *property,
 400                                        GtkStyleContext     *context,
 401                                        GtkCssValue         *specified)
 402 {
 403   g_return_val_if_fail (GTK_IS_CSS_STYLE_PROPERTY (property), NULL);
 404   g_return_val_if_fail (GTK_IS_STYLE_CONTEXT (context), NULL);
 405
 406   return property->compute_value (property, context, specified);
 407 }
 408
 409 /**
 410  * _gtk_css_style_property_print_value:
 411  * @property: the property
 412  * @value: the value to print
 413  * @string: the string to print to
 414  *
 415  * Prints @value to the given @string in CSS format. The @value must be a
 416  * valid specified value as parsed using the parse functions or as assigned
 417  * via _gtk_style_property_assign().
 418  **/
 419 void
 420 _gtk_css_style_property_print_value (GtkCssStyleProperty    *property,
 421                                      GtkCssValue            *value,
 422                                      GString                *string)
 423 {
 424   g_return_if_fail (GTK_IS_CSS_STYLE_PROPERTY (property));
 425   g_return_if_fail (value != NULL);
 426   g_return_if_fail (string != NULL);
 427
 428   if (_gtk_css_value_is_inherit (value) ||
 429       _gtk_css_value_is_initial (value))
 430     _gtk_css_value_print (value, string);
 431   else
 432     property->print_value (property, value, string);
 433 }
 434
 435 /**
 436  * _gtk_css_style_property_is_equal:
 437  * @property: the property
 438  * @value1: the first value to compare
 439  * @value2: the second value to compare
 440  *
 441  * Compares @value1 and @value2 for equality. Both values must be the
 442  * result of a call _gtk_css_style_property_compute_value().
 443  *
 444  * Returns: %TRUE if @value1 and @value2 are equal
 445  **/
 446 gboolean
 447 _gtk_css_style_property_is_equal (GtkCssStyleProperty *property,
 448                                   GtkCssValue         *value1,
 449                                   GtkCssValue         *value2)
 450 {
 451   g_return_val_if_fail (GTK_IS_CSS_STYLE_PROPERTY (property), FALSE);
 452   g_return_val_if_fail (value1 != NULL, FALSE);
 453   g_return_val_if_fail (value2 != NULL, FALSE);
 454
 455   return property->equal_func (property, value1, value2);
 456 }