gtkcsscustomproperty.c 8.3 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 88
  GValue value = G_VALUE_INIT;

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

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

  return _gtk_css_value_new_take_gvalue (&value);
115 116 117 118 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
}

/* 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)
{
164
  GtkCssCustomProperty *node;
165
  GtkCssValue *initial;
166 167 168 169 170 171 172
  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);
173 174 175 176 177 178 179 180 181

  /* 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;
    }
  
182
  initial = gtk_css_custom_property_create_initial_value (pspec);
183 184

  node = g_object_new (GTK_TYPE_CSS_CUSTOM_PROPERTY,
185
                       "initial-value", initial,
186
                       "name", name,
187
                       "computed-type", pspec->value_type,
188 189
                       "value-type", pspec->value_type,
                       NULL);
190
  node->pspec = pspec;
191 192
  node->property_parse_func = parse_func;

193
  _gtk_css_value_unref (initial);
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
  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)
{
213
  GtkCssCustomProperty *node;
214
  GtkCssValue *initial;
215 216 217

  g_return_if_fail (G_IS_PARAM_SPEC (pspec));

218 219 220 221 222 223 224
  /* 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;
    }
  
225
  initial = gtk_css_custom_property_create_initial_value (pspec);
226 227

  node = g_object_new (GTK_TYPE_CSS_CUSTOM_PROPERTY,
228
                       "initial-value", initial,
229
                       "name", pspec->name,
230
                       "computed-type", pspec->value_type,
231 232
                       "value-type", pspec->value_type,
                       NULL);
233
  node->pspec = pspec;
234 235
  node->property_parse_func = parse_func;

236
  _gtk_css_value_unref (initial);
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
}

/**
 * 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);

265
  if (GTK_IS_CSS_CUSTOM_PROPERTY (node))
266
    {
267 268
      GtkCssCustomProperty *custom = GTK_CSS_CUSTOM_PROPERTY (node);

269
      if (pspec)
270
        *pspec = custom->pspec;
271 272

      if (parse_func)
273
        *parse_func = custom->property_parse_func;
274 275 276 277 278 279 280

      found = TRUE;
    }

  return found;
}