gtkcsscustomproperty.c 8.37 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/*
 * Copyright © 2011 Red Hat Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
16 17 18 19 20 21 22 23 24 25
 *
 * Authors: Benjamin Otte <otte@gnome.org>
 */

#include "config.h"

#include "gtkcsscustompropertyprivate.h"

#include <string.h>

26
#include "gtkcssstylefuncsprivate.h"
27 28 29 30
#include "gtkthemingengine.h"

G_DEFINE_TYPE (GtkCssCustomProperty, _gtk_css_custom_property, GTK_TYPE_CSS_STYLE_PROPERTY)

31 32 33 34 35 36
static gboolean
gtk_css_custom_property_parse_value (GtkStyleProperty *property,
                                     GValue           *value,
                                     GtkCssParser     *parser,
                                     GFile            *base)
{
37
  GtkCssCustomProperty *custom = GTK_CSS_CUSTOM_PROPERTY (property);
38 39
  gboolean success;

40
  if (custom->property_parse_func)
41 42 43 44
    {
      GError *error = NULL;
      char *value_str;
      
45 46
      g_value_init (value, _gtk_style_property_get_value_type (property));

47 48 49
      value_str = _gtk_css_parser_read_value (parser);
      if (value_str != NULL)
        {
50
          success = (* custom->property_parse_func) (value_str, value, &error);
51 52 53 54 55 56
          g_free (value_str);
        }
      else
        success = FALSE;
    }
  else
57 58 59 60 61 62
    {
      GtkCssStyleProperty *style = GTK_CSS_STYLE_PROPERTY (property);
      g_value_init (value, _gtk_css_style_property_get_specified_type (style));

      success = _gtk_css_style_parse_value (value, parser, base);
    }
63 64 65 66 67 68 69

  if (!success)
    g_value_unset (value);

  return success;
}

70 71 72
static void
_gtk_css_custom_property_class_init (GtkCssCustomPropertyClass *klass)
{
73 74 75
  GtkStylePropertyClass *property_class = GTK_STYLE_PROPERTY_CLASS (klass);

  property_class->parse_value = gtk_css_custom_property_parse_value;
76 77 78 79 80 81 82 83
}


static void
_gtk_css_custom_property_init (GtkCssCustomProperty *custom_property)
{
}

84 85
static GtkCssValue *
gtk_css_custom_property_create_initial_value (GParamSpec *pspec)
86
{
87
  GValue value = G_VALUE_INIT;
88
  GtkCssValue *result;
89

90
  g_value_init (&value, pspec->value_type);
91 92

  if (pspec->value_type == GTK_TYPE_THEMING_ENGINE)
93
    g_value_set_object (&value, gtk_theming_engine_load (NULL));
94
  else if (pspec->value_type == PANGO_TYPE_FONT_DESCRIPTION)
95
    g_value_take_boxed (&value, pango_font_description_from_string ("Sans 10"));
96
  else if (pspec->value_type == GDK_TYPE_RGBA)
97 98 99
    {
      GdkRGBA color;
      gdk_rgba_parse (&color, "pink");
100
      g_value_set_boxed (&value, &color);
101 102 103 104 105
    }
  else if (pspec->value_type == GDK_TYPE_COLOR)
    {
      GdkColor color;
      gdk_color_parse ("pink", &color);
106
      g_value_set_boxed (&value, &color);
107 108 109
    }
  else if (pspec->value_type == GTK_TYPE_BORDER)
    {
110
      g_value_take_boxed (&value, gtk_border_new ());
111 112
    }
  else
113 114
    g_param_value_set_default (pspec, &value);

115 116 117 118
  result = _gtk_css_value_new_from_gvalue (&value);
  g_value_unset (&value);

  return result;
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
}

/* Property registration functions */

/**
 * gtk_theming_engine_register_property: (skip)
 * @name_space: namespace for the property name
 * @parse_func: parsing function to use, or %NULL
 * @pspec: the #GParamSpec for the new property
 *
 * Registers a property so it can be used in the CSS file format,
 * on the CSS file the property will look like
 * "-${@name_space}-${property_name}". being
 * ${property_name} the given to @pspec. @name_space will usually
 * be the theme engine name.
 *
 * For any type a @parse_func may be provided, being this function
 * used for turning any property value (between ':' and ';') in
 * CSS to the #GValue needed. For basic types there is already
 * builtin parsing support, so %NULL may be provided for these
 * cases.
 *
 * <note>
 * Engines must ensure property registration happens exactly once,
 * usually GTK+ deals with theming engines as singletons, so this
 * should be guaranteed to happen once, but bear this in mind
 * when creating #GtkThemeEngine<!-- -->s yourself.
 * </note>
 *
 * <note>
 * In order to make use of the custom registered properties in
 * the CSS file, make sure the engine is loaded first by specifying
 * the engine property, either in a previous rule or within the same
 * one.
 * <programlisting>
 * &ast; {
 *     engine: someengine;
 *     -SomeEngine-custom-property: 2;
 * }
 * </programlisting>
 * </note>
 *
 * Since: 3.0
 **/
void
gtk_theming_engine_register_property (const gchar            *name_space,
                                      GtkStylePropertyParser  parse_func,
                                      GParamSpec             *pspec)
{
168
  GtkCssCustomProperty *node;
169
  GtkCssValue *initial;
170 171 172 173 174 175 176
  gchar *name;

  g_return_if_fail (name_space != NULL);
  g_return_if_fail (strchr (name_space, ' ') == NULL);
  g_return_if_fail (G_IS_PARAM_SPEC (pspec));

  name = g_strdup_printf ("-%s-%s", name_space, pspec->name);
177 178 179 180 181 182 183 184 185

  /* This also initializes the default properties */
  if (_gtk_style_property_lookup (pspec->name))
    {
      g_warning ("a property with name '%s' already exists", name);
      g_free (name);
      return;
    }
  
186
  initial = gtk_css_custom_property_create_initial_value (pspec);
187 188

  node = g_object_new (GTK_TYPE_CSS_CUSTOM_PROPERTY,
189
                       "initial-value", initial,
190
                       "name", name,
191
                       "computed-type", pspec->value_type,
192 193
                       "value-type", pspec->value_type,
                       NULL);
194
  node->pspec = pspec;
195 196
  node->property_parse_func = parse_func;

197
  _gtk_css_value_unref (initial);
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
  g_free (name);
}

/**
 * gtk_style_properties_register_property: (skip)
 * @parse_func: parsing function to use, or %NULL
 * @pspec: the #GParamSpec for the new property
 *
 * Registers a property so it can be used in the CSS file format.
 * This function is the low-level equivalent of
 * gtk_theming_engine_register_property(), if you are implementing
 * a theming engine, you want to use that function instead.
 *
 * Since: 3.0
 **/
void
gtk_style_properties_register_property (GtkStylePropertyParser  parse_func,
                                        GParamSpec             *pspec)
{
217
  GtkCssCustomProperty *node;
218
  GtkCssValue *initial;
219 220 221

  g_return_if_fail (G_IS_PARAM_SPEC (pspec));

222 223 224 225 226 227 228
  /* This also initializes the default properties */
  if (_gtk_style_property_lookup (pspec->name))
    {
      g_warning ("a property with name '%s' already exists", pspec->name);
      return;
    }
  
229
  initial = gtk_css_custom_property_create_initial_value (pspec);
230 231

  node = g_object_new (GTK_TYPE_CSS_CUSTOM_PROPERTY,
232
                       "initial-value", initial,
233
                       "name", pspec->name,
234
                       "computed-type", pspec->value_type,
235 236
                       "value-type", pspec->value_type,
                       NULL);
237
  node->pspec = pspec;
238 239
  node->property_parse_func = parse_func;

240
  _gtk_css_value_unref (initial);
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
}

/**
 * gtk_style_properties_lookup_property: (skip)
 * @property_name: property name to look up
 * @parse_func: (out): return location for the parse function
 * @pspec: (out) (transfer none): return location for the #GParamSpec
 *
 * Returns %TRUE if a property has been registered, if @pspec or
 * @parse_func are not %NULL, the #GParamSpec and parsing function
 * will be respectively returned.
 *
 * Returns: %TRUE if the property is registered, %FALSE otherwise
 *
 * Since: 3.0
 **/
gboolean
gtk_style_properties_lookup_property (const gchar             *property_name,
                                      GtkStylePropertyParser  *parse_func,
                                      GParamSpec             **pspec)
{
  GtkStyleProperty *node;
  gboolean found = FALSE;

  g_return_val_if_fail (property_name != NULL, FALSE);

  node = _gtk_style_property_lookup (property_name);

269
  if (GTK_IS_CSS_CUSTOM_PROPERTY (node))
270
    {
271 272
      GtkCssCustomProperty *custom = GTK_CSS_CUSTOM_PROPERTY (node);

273
      if (pspec)
274
        *pspec = custom->pspec;
275 276

      if (parse_func)
277
        *parse_func = custom->property_parse_func;
278 279 280 281 282 283 284

      found = TRUE;
    }

  return found;
}