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 {
 152   GtkCssStyleProperty *style_property = GTK_CSS_STYLE_PROPERTY (property);
 153
 154   if (_gtk_css_parser_try (parser, "initial", TRUE))
 155     {
 156       /* the initial value can be explicitly specified with the
 157        * ‘initial’ keyword which all properties accept.
 158        */
 159       return _gtk_css_initial_value_new ();
 160     }
 161   else if (_gtk_css_parser_try (parser, "inherit", TRUE))
 162     {
 163       /* All properties accept the ‘inherit’ value which
 164        * explicitly specifies that the value will be determined
 165        * by inheritance. The ‘inherit’ value can be used to
 166        * strengthen inherited values in the cascade, and it can
 167        * also be used on properties that are not normally inherited.
 168        */
 169       return _gtk_css_inherit_value_new ();
 170     }
 171
 172   return (* style_property->parse_value) (style_property, parser);
 173 }
 174
 175 static void
 176 _gtk_css_style_property_class_init (GtkCssStylePropertyClass *klass)
 177 {
 178   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 179   GtkStylePropertyClass *property_class = GTK_STYLE_PROPERTY_CLASS (klass);
 180
 181   object_class->constructed = gtk_css_style_property_constructed;
 182   object_class->set_property = gtk_css_style_property_set_property;
 183   object_class->get_property = gtk_css_style_property_get_property;
 184
 185   g_object_class_install_property (object_class,
 186                                    PROP_ANIMATED,
 187                                    g_param_spec_boolean ("animated",
 188                                                          P_("Animated"),
 189                                                          P_("Set if the value can be animated"),
 190                                                          FALSE,
 191                                                          G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
 192   g_object_class_install_property (object_class,
 193                                    PROP_ID,
 194                                    g_param_spec_uint ("id",
 195                                                       P_("ID"),
 196                                                       P_("The numeric id for quick access"),
 197                                                       0, G_MAXUINT, 0,
 198                                                       G_PARAM_READABLE));
 199   g_object_class_install_property (object_class,
 200                                    PROP_INHERIT,
 201                                    g_param_spec_boolean ("inherit",
 202                                                          P_("Inherit"),
 203                                                          P_("Set if the value is inherited by default"),
 204                                                          FALSE,
 205                                                          G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
 206   g_object_class_install_property (object_class,
 207                                    PROP_INITIAL,
 208                                    g_param_spec_boxed ("initial-value",
 209                                                        P_("Initial value"),
 210                                                        P_("The initial specified value used for this property"),
 211                                                        GTK_TYPE_CSS_VALUE,
 212                                                        G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
 213
 214   property_class->assign = _gtk_css_style_property_assign;
 215   property_class->query = _gtk_css_style_property_query;
 216   property_class->parse_value = gtk_css_style_property_parse_value;
 217
 218   klass->style_properties = g_ptr_array_new ();
 219 }
 220
 221 static GtkCssValue *
 222 gtk_css_style_property_real_parse_value (GtkCssStyleProperty *property,
 223                                          GtkCssParser        *parser)
 224 {
 225   g_assert_not_reached ();
 226   return NULL;
 227 }
 228
 229 static void
 230 gtk_css_style_property_real_print_value (GtkCssStyleProperty *property,
 231                                          const GtkCssValue   *value,
 232                                          GString             *string)
 233 {
 234   _gtk_css_value_print (value, string);
 235 }
 236
 237 static GtkCssValue *
 238 gtk_css_style_property_real_compute_value (GtkCssStyleProperty *property,
 239                                            GtkStyleContext     *context,
 240                                            GtkCssValue         *specified)
 241 {
 242   return _gtk_css_value_ref (specified);
 243 }
 244
 245 static void
 246 _gtk_css_style_property_init (GtkCssStyleProperty *property)
 247 {
 248   property->parse_value = gtk_css_style_property_real_parse_value;
 249   property->print_value = gtk_css_style_property_real_print_value;
 250   property->compute_value = gtk_css_style_property_real_compute_value;
 251 }
 252
 253 /**
 254  * _gtk_css_style_property_get_n_properties:
 255  *
 256  * Gets the number of style properties. This number can increase when new
 257  * theme engines are loaded. Shorthand properties are not included here.
 258  *
 259  * Returns: The number of style properties.
 260  **/
 261 guint
 262 _gtk_css_style_property_get_n_properties (void)
 263 {
 264   GtkCssStylePropertyClass *klass;
 265
 266   klass = g_type_class_peek (GTK_TYPE_CSS_STYLE_PROPERTY);
 267   if (G_UNLIKELY (klass == NULL))
 268     {
 269       _gtk_style_property_init_properties ();
 270       klass = g_type_class_peek (GTK_TYPE_CSS_STYLE_PROPERTY);
 271       g_assert (klass);
 272     }
 273
 274   return klass->style_properties->len;
 275 }
 276
 277 /**
 278  * _gtk_css_style_property_lookup_by_id:
 279  * @id: the id of the property
 280  *
 281  * Gets the style property with the given id. All style properties (but not
 282  * shorthand properties) are indexable by id so that it's easy to use arrays
 283  * when doing style lookups.
 284  *
 285  * Returns: (transfer none): The style property with the given id
 286  **/
 287 GtkCssStyleProperty *
 288 _gtk_css_style_property_lookup_by_id (guint id)
 289 {
 290   GtkCssStylePropertyClass *klass;
 291
 292   klass = g_type_class_peek (GTK_TYPE_CSS_STYLE_PROPERTY);
 293   if (G_UNLIKELY (klass == NULL))
 294     {
 295       _gtk_style_property_init_properties ();
 296       klass = g_type_class_peek (GTK_TYPE_CSS_STYLE_PROPERTY);
 297       g_assert (klass);
 298     }
 299   g_return_val_if_fail (id < klass->style_properties->len, NULL);
 300
 301   return g_ptr_array_index (klass->style_properties, id);
 302 }
 303
 304 /**
 305  * _gtk_css_style_property_is_inherit:
 306  * @property: the property
 307  *
 308  * Queries if the given @property is inherited. See
 309  * <ulink url="http://www.w3.org/TR/css3-cascade/#inheritance>
 310  * the CSS documentation</ulink> for an explanation of this concept.
 311  *
 312  * Returns: %TRUE if the property is inherited by default.
 313  **/
 314 gboolean
 315 _gtk_css_style_property_is_inherit (GtkCssStyleProperty *property)
 316 {
 317   g_return_val_if_fail (GTK_IS_CSS_STYLE_PROPERTY (property), FALSE);
 318
 319   return property->inherit;
 320 }
 321
 322 /**
 323  * _gtk_css_style_property_is_animated:
 324  * @property: the property
 325  *
 326  * Queries if the given @property can be is animated. See
 327  * <ulink url="http://www.w3.org/TR/css3-transitions/#animatable-css>
 328  * the CSS documentation</ulink> for animatable properties.
 329  *
 330  * Returns: %TRUE if the property can be animated.
 331  **/
 332 gboolean
 333 _gtk_css_style_property_is_animated (GtkCssStyleProperty *property)
 334 {
 335   g_return_val_if_fail (GTK_IS_CSS_STYLE_PROPERTY (property), FALSE);
 336
 337   return property->animated;
 338 }
 339
 340 /**
 341  * _gtk_css_style_property_get_id:
 342  * @property: the property
 343  *
 344  * Gets the id for the given property. IDs are used to allow using arrays
 345  * for style lookups.
 346  *
 347  * Returns: The id of the property
 348  **/
 349 guint
 350 _gtk_css_style_property_get_id (GtkCssStyleProperty *property)
 351 {
 352   g_return_val_if_fail (GTK_IS_CSS_STYLE_PROPERTY (property), 0);
 353
 354   return property->id;
 355 }
 356
 357 /**
 358  * _gtk_css_style_property_get_initial_value:
 359  * @property: the property
 360  *
 361  * Queries the initial value of the given @property. See
 362  * <ulink url="http://www.w3.org/TR/css3-cascade/#intial>
 363  * the CSS documentation</ulink> for an explanation of this concept.
 364  *
 365  * Returns: a reference to the initial value. The value will never change.
 366  **/
 367 GtkCssValue *
 368 _gtk_css_style_property_get_initial_value (GtkCssStyleProperty *property)
 369 {
 370   g_return_val_if_fail (GTK_IS_CSS_STYLE_PROPERTY (property), NULL);
 371
 372   return property->initial_value;
 373 }
 374
 375 /**
 376  * _gtk_css_style_property_compute_value:
 377  * @property: the property
 378  * @computed: (out): an uninitialized value to be filled with the result
 379  * @context: the context to use for resolving
 380  * @specified: the value to compute from
 381  *
 382  * Converts the @specified value into the @computed value using the
 383  * information in @context. This step is explained in detail in
 384  * <ulink url="http://www.w3.org/TR/css3-cascade/#computed>
 385  * the CSS documentation</ulink>.
 386  **/
 387 GtkCssValue *
 388 _gtk_css_style_property_compute_value (GtkCssStyleProperty *property,
 389                                        GtkStyleContext     *context,
 390                                        GtkCssValue         *specified)
 391 {
 392   g_return_val_if_fail (GTK_IS_CSS_STYLE_PROPERTY (property), NULL);
 393   g_return_val_if_fail (GTK_IS_STYLE_CONTEXT (context), NULL);
 394
 395   return property->compute_value (property, context, specified);
 396 }
 397
 398 /**
 399  * _gtk_css_style_property_print_value:
 400  * @property: the property
 401  * @value: the value to print
 402  * @string: the string to print to
 403  *
 404  * Prints @value to the given @string in CSS format. The @value must be a
 405  * valid specified value as parsed using the parse functions or as assigned
 406  * via _gtk_style_property_assign().
 407  **/
 408 void
 409 _gtk_css_style_property_print_value (GtkCssStyleProperty    *property,
 410                                      GtkCssValue            *value,
 411                                      GString                *string)
 412 {
 413   g_return_if_fail (GTK_IS_CSS_STYLE_PROPERTY (property));
 414   g_return_if_fail (value != NULL);
 415   g_return_if_fail (string != NULL);
 416
 417   if (_gtk_css_value_is_inherit (value) ||
 418       _gtk_css_value_is_initial (value))
 419     _gtk_css_value_print (value, string);
 420   else
 421     property->print_value (property, value, string);
 422 }