]> gitweb.michael.orlitzky.com - libsvgtiny.git/blobdiff - src/svgtiny_css.c
src/svgtiny.c: use case-sensitive comparisons for SVG element names
[libsvgtiny.git] / src / svgtiny_css.c
index 4e42888d59c83925d8ce3fa77eb30cb277525cdd..be2460279a1a18a46f3586880eb61c13016be7b0 100644 (file)
@@ -4,10 +4,13 @@
 #include "svgtiny.h"
 #include "svgtiny_internal.h"
 
+/* select handler callbacks */
 static css_error node_name(void *pw, void *node, css_qname *qname);
 static css_error node_classes(void *pw, void *node,
                lwc_string ***classes, uint32_t *n_classes);
 static css_error node_id(void *pw, void *node, lwc_string **id);
+static css_error named_ancestor_node(void *pw, void *node,
+               const css_qname *qname, void **ancestor);
 static css_error named_parent_node(void *pw, void *node,
                const css_qname *qname, void **parent);
 static css_error named_sibling_node(void *pw, void *node,
@@ -57,9 +60,47 @@ static css_error node_is_checked(void *pw, void *node, bool *is_checked);
 static css_error node_is_target(void *pw, void *node, bool *is_target);
 static css_error node_is_lang(void *pw, void *node,
                lwc_string *lang, bool *is_lang);
+static css_error node_presentational_hint(void *pw, void *node,
+               uint32_t *nhints, css_hint **hints);
 static css_error ua_default_for_property(void *pw, uint32_t property,
        css_hint *hint);
+static css_error set_libcss_node_data(void *pw, void *node,
+               void *libcss_node_data);
+static css_error get_libcss_node_data(void *pw, void *node,
+               void **libcss_node_data);
 
+/* select handler vtable */
+static struct css_select_handler svgtiny_select_handler;
+
+
+/* Every call to svgtiny_select_style() needs this, so let's only make
+ * one copy. */
+static const css_media media_all = {
+       .type = CSS_MEDIA_ALL,
+};
+
+/**
+ * Convenient wrapper around css_select_style()
+ *
+ * \param state         The current state of the libsvgtiny parser
+ * \param node          The node that we're getting styles for
+ * \param inline_sheet  The inline stylesheet for the given node
+ * \param result        Address at which to store the results array
+ */
+css_error svgtiny_select_style(struct svgtiny_parse_state *state,
+                               dom_element *node,
+                               const css_stylesheet *inline_sheet,
+                               css_select_results **result)
+{
+       return css_select_style(state->select_ctx,
+                       node,
+                       &state->unit_ctx,
+                       &media_all,
+                       inline_sheet,
+                       &svgtiny_select_handler,
+                       state,
+                       result);
+}
 
 /**
  * Resolve a relative URL to an absolute one by doing nothing. This is
@@ -234,6 +275,40 @@ css_error node_id(void *pw, void *node, lwc_string **id)
 }
 
 
+/**
+ * Find the first ancestor of the given element having the given name
+ *
+ * This function thinly wraps dom_element_named_ancestor_node(), which
+ * performs exactly the search we want.
+ *
+ * \param pw        Pointer to the current SVG parser state
+ * \param node      Libdom SVG node whose ancestor we want
+ * \param qname     Name of the ancestor node to search for
+ * \param ancestor  Address at which to store the ancestor node pointer
+ *
+ * \return Always returns CSS_OK
+ *
+ * \post If a suitable element is found, a pointer to it will be
+ *       stored at the address pointed to by \a ancestor; otherwise,
+ *       NULL will be stored at the address pointed to by \a ancestor
+ */
+css_error named_ancestor_node(void *pw, void *node,
+               const css_qname *qname, void **ancestor)
+{
+       UNUSED(pw);
+
+       /* It's OK if node isn't an element, libdom checks for it. */
+       dom_element_named_ancestor_node((dom_element *)node,
+                       qname->name,
+                       (struct dom_element **)ancestor);
+
+       /* A comment in named_parent_node() explains why we unref
+        * this here. */
+       dom_node_unref(*ancestor);
+
+       return CSS_OK;
+}
+
 
 /**
  * Find the first parent of the given element having the given name
@@ -1767,11 +1842,38 @@ static css_error node_is_lang(void *pw, void *node,
 }
 
 
+/**
+ * Return presentational hints for the given node
+ *
+ * Unless an SVG is being rendered from within an HTML document,
+ * there are no presentational hints. We always return an empty
+ * array (no hints).
+ *
+ * \param pw        Pointer to the current SVG parser state; unused
+ * \param node      Libdom SVG node whose hints we want; unused
+ * \param nhints    How many hints are returned (return by reference)
+ * \param hints     Array of css_hint structures (return by reference)
+ *
+ * \return Always returns CSS_OK
+ */
+css_error node_presentational_hint(void *pw, void *node,
+               uint32_t *nhints, css_hint **hints)
+{
+       UNUSED(pw);
+       UNUSED(node);
+       *nhints = 0;
+       *hints = NULL;
+       return CSS_OK;
+}
+
+
 /**
  * User-agent defaults for CSS properties
  *
- * For the moment, we provide no defaults, because libsvgtiny does not
- * yet support any CSS properties that might need them.
+ * Ideally we would provide _no_ defaults here, because we don't yet
+ * support any CSS properties that can use them. However, we run into
+ * libcss parent/child style composition issues unless these defaults
+ * are provided. And it's harmless to provide them, so let's do it.
  *
  * \param pw            Pointer to the current SVG parser state; unused
  * \param property      LibCSS property identifier; unused
@@ -1783,7 +1885,187 @@ css_error ua_default_for_property(void *pw, uint32_t property,
        css_hint *hint)
 {
        UNUSED(pw);
-       UNUSED(property);
-       UNUSED(hint);
-       return CSS_INVALID;
+       switch (property) {
+       case CSS_PROP_COLOR:
+               hint->data.color = 0xff000000;
+               hint->status = CSS_COLOR_COLOR;
+               break;
+       case CSS_PROP_FONT_FAMILY:
+               hint->data.strings = NULL;
+               hint->status = CSS_FONT_FAMILY_SANS_SERIF;
+               break;
+       case CSS_PROP_QUOTES:
+               hint->data.strings = NULL;
+               hint->status = CSS_QUOTES_NONE;
+               break;
+       case CSS_PROP_VOICE_FAMILY:
+               hint->data.strings = NULL;
+               hint->status = 0;
+               break;
+       default:
+               return CSS_INVALID;
+       }
+
+       return CSS_OK;
 }
+
+
+/**
+ * A "user handler" function that we pass to dom_node_set_user_data()
+ * in set_libcss_node_data(). The set_libcss_node_data() documentation
+ * says that if the node (on which data is set) is is deleted or
+ * cloned, or if its ancestors are modified, then we must call
+ * css_libcss_node_data_handler() on the user data. This function
+ * basically just checks to see which DOM event has happened and
+ * calls css_libcss_node_data_handler() when any of those criteria
+ * are met.
+ */
+static void svgtiny_dom_user_data_handler(dom_node_operation operation,
+       dom_string *key, void *data, struct dom_node *src,
+       struct dom_node *dst)
+{
+       /* We only care about the userdata that is identified by our
+        * userdata key. Unfortunately I see no obvious way to obtain
+        * the copy of the userdata key that is already interned in
+        * svgtiny_strings.h; so we duplicate it here (ugh). */
+       dom_string *str;
+       dom_string_create((const uint8_t *)"_libcss_user_data", 17, &str);
+       if (dom_string_isequal(str,key) == false || data == NULL) {
+               /* Wrong key, or no data */
+               return;
+       }
+
+       /* Check the DOM operation, and make the corresponding call to
+        * css_libcss_node_data_handler(). No error handling is done.
+        */
+       switch (operation) {
+               case DOM_NODE_CLONED:
+                       css_libcss_node_data_handler(&svgtiny_select_handler,
+                                               CSS_NODE_CLONED,
+                                               NULL, src, dst, data);
+                       break;
+               case DOM_NODE_RENAMED:
+                       css_libcss_node_data_handler(&svgtiny_select_handler,
+                                               CSS_NODE_MODIFIED,
+                                               NULL, src, NULL, data);
+                       break;
+               case DOM_NODE_IMPORTED:
+               case DOM_NODE_ADOPTED:
+               case DOM_NODE_DELETED:
+                       css_libcss_node_data_handler(&svgtiny_select_handler,
+                                               CSS_NODE_DELETED,
+                                               NULL, src, NULL, data);
+               default:
+                       /* Our list of cases should have been exhaustive */
+                       assert(false);
+       }
+}
+
+/**
+ * Store libcss data on a node
+ *
+ * This is part of the libcss select handler API that we need to
+ * implement. It is essentially a thin dom_node_set_user_data()
+ * wrapper.
+ *
+ * \param pw                 Pointer to the current SVG parser state
+ * \param node               Libdom SVG node on which to store the data
+ * \param libcss_node_data   Pointer to the data to store
+ *
+ * \return Always returns CSS_OK
+ */
+css_error set_libcss_node_data(void *pw, void *node,
+               void *libcss_node_data)
+{
+       struct svgtiny_parse_state *state;
+       void *old_data;
+
+       /* A unique "userdata key" (a string) is used to identify this
+        * data. */
+       state = (struct svgtiny_parse_state *)pw;
+       dom_node_set_user_data((dom_node *)node,
+                               state->interned_userdata_key,
+                               libcss_node_data,
+                               svgtiny_dom_user_data_handler,
+                               &old_data);
+
+       /* dom_node_set_user_data() always returns DOM_NO_ERR */
+       return CSS_OK;
+}
+
+
+/**
+ * Retrieve libcss data from a node
+ *
+ * This is part of the libcss select handler API that we need to
+ * implement. It is essentially a thin dom_node_get_user_data()
+ * wrapper.
+ *
+ * \param pw                 Pointer to the current SVG parser state
+ * \param node               Libdom SVG node from which to get the data
+ * \param libcss_node_data   Address at which to store a pointer to the data
+ *
+ * \return Always returns CSS_OK
+ */
+css_error get_libcss_node_data(void *pw, void *node,
+               void **libcss_node_data)
+{
+       struct svgtiny_parse_state *state;
+
+       /* A unique "userdata key" (a string) is used to identify this
+        * data. */
+       state = (struct svgtiny_parse_state *)pw;
+       dom_node_get_user_data((dom_node *)node,
+                               state->interned_userdata_key,
+                               libcss_node_data);
+
+       /* dom_node_get_user_data() always returns DOM_NO_ERR */
+       return CSS_OK;
+}
+
+
+/**
+ * The vtable of select handler callbacks passed by libsvgtiny to
+ * css_select_style().
+ */
+static css_select_handler svgtiny_select_handler = {
+       CSS_SELECT_HANDLER_VERSION_1,
+       node_name,
+       node_classes,
+       node_id,
+       named_ancestor_node,
+       named_parent_node,
+       named_sibling_node,
+       named_generic_sibling_node,
+       parent_node,
+       sibling_node,
+       node_has_name,
+       node_has_class,
+       node_has_id,
+       node_has_attribute,
+       node_has_attribute_equal,
+       node_has_attribute_dashmatch,
+       node_has_attribute_includes,
+       node_has_attribute_prefix,
+       node_has_attribute_suffix,
+       node_has_attribute_substring,
+       node_is_root,
+       node_count_siblings,
+       node_is_empty,
+       node_is_link,
+       node_is_visited,
+       node_is_hover,
+       node_is_active,
+       node_is_focus,
+       node_is_enabled,
+       node_is_disabled,
+       node_is_checked,
+       node_is_target,
+       node_is_lang,
+       node_presentational_hint,
+       ua_default_for_property,
+       set_libcss_node_data,
+       get_libcss_node_data,
+};
+
+