gtk2/gtk/gtkcsslookup.c

/* GTK - The GIMP Toolkit
 * Copyright (C) 2011 Benjamin Otte <otte@gnome.org>
 *
 * 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 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
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#include "config.h"

#include "gtkcsslookupprivate.h"

#include "gtkcsstypesprivate.h"
#include "gtkprivatetypebuiltins.h"
#include "gtkcssstylepropertyprivate.h"
#include "gtkstylepropertiesprivate.h"

typedef struct {
  GtkCssSection     *section;
  const GValue      *value;
} GtkCssLookupValue;

struct _GtkCssLookup {
  GtkBitmask        *missing;
  GtkCssLookupValue  values[1];
};

GtkCssLookup *
_gtk_css_lookup_new (void)
{
  GtkCssLookup *lookup;
  guint n = _gtk_css_style_property_get_n_properties ();

  lookup = g_malloc0 (sizeof (GtkCssLookup) + sizeof (GtkCssLookupValue) * n);
  lookup->missing = _gtk_bitmask_new ();
  _gtk_bitmask_invert_range (lookup->missing, 0, n);

  return lookup;
}

void
_gtk_css_lookup_free (GtkCssLookup *lookup)
{
  g_return_if_fail (lookup != NULL);

  _gtk_bitmask_free (lookup->missing);
  g_free (lookup);
}

const GtkBitmask *
_gtk_css_lookup_get_missing (const GtkCssLookup *lookup)
{
  g_return_val_if_fail (lookup != NULL, NULL);

  return lookup->missing;
}

gboolean
_gtk_css_lookup_is_missing (const GtkCssLookup *lookup,
                            guint               id)
{
  g_return_val_if_fail (lookup != NULL, FALSE);

  return lookup->values[id].value == NULL;
}

/**
 * _gtk_css_lookup_set:
 * @lookup: the lookup
 * @id: id of the property to set, see _gtk_style_property_get_id()
 * @section: (allow-none): The @section the value was defined in or %NULL
 * @value: the "cascading value" to use
 *
 * Sets the @value for a given @id. No value may have been set for @id
 * before. See _gtk_css_lookup_is_missing(). This function is used to
 * set the "winning declaration" of a lookup. Note that for performance
 * reasons @value and @section are not copied. It is your responsibility
 * to ensure they are kept alive until _gtk_css_lookup_free() is called.
 **/
void
_gtk_css_lookup_set (GtkCssLookup  *lookup,
                     guint          id,
                     GtkCssSection *section,
                     const GValue  *value)
{
  g_return_if_fail (lookup != NULL);
  g_return_if_fail (_gtk_bitmask_get (lookup->missing, id));
  g_return_if_fail (value != NULL);

  _gtk_bitmask_set (lookup->missing, id, FALSE);
  lookup->values[id].value = value;
  lookup->values[id].section = section;
}

/**
 * _gtk_css_lookup_resolve:
 * @lookup: the lookup
 * @parent: the parent properties to look up inherited values from or %NULL
 *     if none
 *
 * Resolves the current lookup into a styleproperties object. This is done
 * by converting from the "winning declaration" to the "computed value".
 *
 * XXX: This bypasses the notion of "specified value". If this ever becomes
 * an issue, go fix it.
 *
 * Returns: a new #GtkStyleProperties
 **/
GtkStyleProperties *
_gtk_css_lookup_resolve (GtkCssLookup    *lookup,
                         GtkStyleContext *parent)
{
  GtkStyleProperties *props;
  guint i, n;

  g_return_val_if_fail (lookup != NULL, NULL);
  g_return_val_if_fail (parent == NULL || GTK_IS_STYLE_CONTEXT (parent), NULL);

  n = _gtk_css_style_property_get_n_properties ();
  props = gtk_style_properties_new ();

  for (i = 0; i < n; i++)
    {
      GtkCssStyleProperty *prop = _gtk_css_style_property_lookup_by_id (i);
      const GValue *result;

      /* http://www.w3.org/TR/css3-cascade/#cascade
       * Then, for every element, the value for each property can be found
       * by following this pseudo-algorithm:
       * 1) Identify all declarations that apply to the element
       */
      if (lookup->values[i].value != NULL)
        {
          /* 2) If the cascading process (described below) yields a winning
           * declaration and the value of the winning declaration is not
           * ‘initial’ or ‘inherit’, the value of the winning declaration
           * becomes the specified value.
           */
          if (!G_VALUE_HOLDS (lookup->values[i].value, GTK_TYPE_CSS_SPECIAL_VALUE))
            {
              result = lookup->values[i].value;
            }
          else
            {
              switch (g_value_get_enum (lookup->values[i].value))
                {
                case GTK_CSS_INHERIT:
                  /* 3) if the value of the winning declaration is ‘inherit’,
                   * the inherited value (see below) becomes the specified value.
                   */
                  result = NULL;
                  break;
                case GTK_CSS_INITIAL:
                  /* if the value of the winning declaration is ‘initial’,
                   * the initial value (see below) becomes the specified value.
                   */
                  result = _gtk_css_style_property_get_initial_value (prop);
                  break;
                default:
                  /* This is part of (2) above */
                  result = lookup->values[i].value;
                  break;
                }
            }
        }
      else
        {
          if (_gtk_css_style_property_is_inherit (prop))
            {
              /* 4) if the property is inherited, the inherited value becomes
               * the specified value.
               */
              result = NULL;
            }
          else
            {
              /* 5) Otherwise, the initial value becomes the specified value.
               */
              result = _gtk_css_style_property_get_initial_value (prop);
            }
        }

      if (result)
        {
          _gtk_style_properties_set_property_by_property (props,
                                                          prop,
                                                          0,
                                                          result);
        }
      else if (parent == NULL)
        {
          /* If the ‘inherit’ value is set on the root element, the property is
           * assigned its initial value. */
          _gtk_style_properties_set_property_by_property (props,
                                                          prop,
                                                          0,
                                                          _gtk_css_style_property_get_initial_value (prop));
        }
      else
        {
          GValue value = { 0, };
          /* Set NULL here and do the inheritance upon lookup? */
          gtk_style_context_get_property (parent,
                                          _gtk_style_property_get_name (GTK_STYLE_PROPERTY (prop)),
                                          gtk_style_context_get_state (parent),
                                          &value);
          _gtk_style_properties_set_property_by_property (props,
                                                          prop,
                                                          0,
                                                          &value);
          g_value_unset (&value);
        }
    }

  return props;
}