]> gitweb.michael.orlitzky.com - libsvgtiny.git/blobdiff - src/svgtiny_css.c
src/svgtiny_css.c: implement set_libcss_node_data() select handler
[libsvgtiny.git] / src / svgtiny_css.c
index cbb9a93194c4d8955537b7c22362da15a11a8700..ce31ef2763a83d43ff2e6ece8fd938e9a6125456 100644 (file)
@@ -47,11 +47,20 @@ static css_error node_count_siblings(void *pw, void *node,
                bool same_name, bool after, int32_t *count);
 static css_error node_is_empty(void *pw, void *node, bool *is_empty);
 static css_error node_is_link(void *pw, void *node, bool *is_link);
+static css_error node_is_visited(void *pw, void *node, bool *is_visited);
 static css_error node_is_hover(void *pw, void *node, bool *is_hover);
 static css_error node_is_active(void *pw, void *node, bool *is_active);
 static css_error node_is_focus(void *pw, void *node, bool *is_focus);
 static css_error node_is_enabled(void *pw, void *node, bool *is_enabled);
 static css_error node_is_disabled(void *pw, void *node, bool *is_disabled);
+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 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);
 
 
 /**
@@ -1109,29 +1118,16 @@ css_error node_has_attribute_suffix(void *pw, void *node,
 
 
 /**
- * Test the given node for an attribute whose value contains the
- * given substring
- *
- * This will return true (via the "match" pointer) if the libdom node
- * has an attribute with the given name and whose value contains the
- * given substring. The comparison is case-sensitive. This corresponds
- * to [attr*=value] in CSS.
- *
- * \param pw          Pointer to the current SVG parser state
- * \param node        Libdom SVG node to test
- * \param qname       Attribute name to check for
- * \param substring   Value substring to check for
- * \param match       Pointer to the test result
- *
- * \return Returns CSS_OK if successful and CSS_NOMEM if we cannot
- *         intern the attribute name (which usually indicates memory
- *         exhaustion)
+ * Implement node_has_attribute_substring() with optional case-
+ * insensitivity. This corresponds to [attr*=value i] in CSS and is
+ * not supported by libcss yet, but it allows us to factor out some
+ * common code.
  */
-css_error node_has_attribute_substring(void *pw, void *node,
+static css_error _node_has_attribute_substring(void *pw, void *node,
                const css_qname *qname, lwc_string *substring,
-               bool *match)
+               bool *match, bool insensitive)
 {
-       UNUSED(pw);
+       UNUSED(pw);
        dom_string *name;
        dom_string *attr_val;
        dom_exception err;
@@ -1172,7 +1168,13 @@ css_error node_has_attribute_substring(void *pw, void *node,
         * and the first thing we want to do is check to see if the
         * whole thing matches the substring. */
        dom_string_unref(name);
-       *match = dom_string_lwc_isequal(attr_val, substring);
+
+       if (insensitive) {
+               *match = dom_string_caseless_lwc_isequal(attr_val, substring);
+       }
+       else {
+               *match = dom_string_lwc_isequal(attr_val, substring);
+       }
 
        /* If not, check to see if an, uh, substring matches the
         * substring */
@@ -1200,6 +1202,33 @@ css_error node_has_attribute_substring(void *pw, void *node,
        return CSS_OK;
 }
 
+/**
+ * Test the given node for an attribute whose value contains the
+ * given substring
+ *
+ * This will return true (via the "match" pointer) if the libdom node
+ * has an attribute with the given name and whose value contains the
+ * given substring. The comparison is case-sensitive. This corresponds
+ * to [attr*=value] in CSS.
+ *
+ * \param pw          Pointer to the current SVG parser state
+ * \param node        Libdom SVG node to test
+ * \param qname       Attribute name to check for
+ * \param substring   Value substring to check for
+ * \param match       Pointer to the test result
+ *
+ * \return Returns CSS_OK if successful and CSS_NOMEM if we cannot
+ *         intern the attribute name (which usually indicates memory
+ *         exhaustion)
+ */
+css_error node_has_attribute_substring(void *pw, void *node,
+               const css_qname *qname, lwc_string *substring,
+               bool *match)
+{
+       return _node_has_attribute_substring(pw, node, qname, substring,
+                       match, false);
+}
+
 
 /**
  * Test whether or not the given node is the document's root element
@@ -1488,6 +1517,26 @@ css_error node_is_link(void *pw, void *node, bool *is_link)
        return CSS_OK;
 }
 
+/**
+ * Check if the given node is a link that has been visited already
+ *
+ * This check always fails because the SVG DOM does not have the
+ * necessary information (it's a UI property).
+ *
+ * \param pw           Pointer to the current SVG parser state; unused
+ * \param node         Libdom SVG node to check; unused
+ * \param is_visited   Pointer to the boolean return value
+ *
+ * \return Always returns CSS_OK
+ */
+css_error node_is_visited(void *pw, void *node, bool *is_visited)
+{
+       UNUSED(pw);
+       UNUSED(node);
+       *is_visited = false;
+       return CSS_OK;
+}
+
 
 /**
  * Check if the given node is being "hovered" over
@@ -1593,3 +1642,186 @@ css_error node_is_disabled(void *pw, void *node, bool *is_disabled)
        *is_disabled = false;
        return CSS_OK;
 }
+
+
+/**
+ * Test whether or not the given node is "checked"
+ *
+ * This test always fails because the SVG DOM does not have the
+ * necessary information (it's a UI property).
+ *
+ * \param pw            Pointer to the current SVG parser state; unused
+ * \param node          Libdom SVG node to check; unused
+ * \param is_checked    Pointer to the boolean return value
+ *
+ * \return Always returns CSS_OK
+ */
+css_error node_is_checked(void *pw, void *node, bool *is_checked)
+{
+       UNUSED(pw);
+       UNUSED(node);
+       *is_checked = false;
+       return CSS_OK;
+}
+
+
+/**
+ * Check if the given node is the "target" of the document URL
+ *
+ * This test always fails because the SVG DOM does not have the
+ * necessary information (it's a UI property).
+ *
+ * \param pw            Pointer to the current SVG parser state; unused
+ * \param node          Libdom SVG node to check; unused
+ * \param is_target     Pointer to the boolean return value
+ *
+ * \return Always returns CSS_OK
+ */
+css_error node_is_target(void *pw, void *node, bool *is_target)
+{
+       UNUSED(pw);
+       UNUSED(node);
+       *is_target = false;
+       return CSS_OK;
+}
+
+
+/**
+ * Check if the given node is the given language
+ *
+ * This test is corresponds to the CSS :lang() selector and is not
+ * fully implemented yet: it looks only for "lang" attributes on the
+ * given element and its parents, and performs a simple substring
+ * check. This results in a partial implementation of CSS Level 3 for
+ * SVG 2.0. In particular, it ignores all "xml:lang" attributes in
+ * favor of the "lang" attribute that is defined only in SVG 2.0.
+ *
+ * \param pw            Pointer to the current SVG parser state; unused
+ * \param node          Libdom SVG node to check
+ * \param lang          The language to match
+ * \param is_lang       Pointer to the boolean return value
+ *
+ * \return CSS_OK on success, or CSS_NOMEM if anything goes wrong
+ */
+static css_error node_is_lang(void *pw, void *node,
+               lwc_string *lang, bool *is_lang)
+{
+       UNUSED(pw);
+       /* SVG2 elements support both "lang" and "xml:lang"
+        * attributes; earlier versions have only the XML
+        * attribute. It would not be too hard to add support for
+        * xml:lang" here. The main difficulty standing in the way of
+        * a full Level 4 implementation is the complexity of the
+        * :lang() selector:
+        *
+        *   https://www.w3.org/TR/selectors-4/#the-lang-pseudo
+        *
+        */
+
+       css_error c_err;
+       dom_exception d_err;
+       dom_node *n; /* current node */
+       dom_node *p; /* parent node */
+       bool match;  /* retval from node_has_attribute_substring() */
+
+       /* Define the attribute name "lang" that we're looking for.
+        * We only use a css_qname here because that's what the
+        * node_has_attribute_substring() takes; the namespace
+        * portion of it is irrelevant. */
+       css_qname attr;
+       attr.ns = NULL;
+
+       if (lwc_intern_string("lang", 4, &attr.name) != lwc_error_ok) {
+               return CSS_NOMEM;
+       }
+
+       *is_lang = false; /* default to no match */
+       n = (dom_node *)node;
+
+       /* Loop through all parents of the given node looking for a
+        * substring match */
+       while (n != NULL) {
+               c_err = _node_has_attribute_substring(pw, (void *)n, &attr,
+                                               lang, &match, true);
+               if (c_err != CSS_OK) {
+                       lwc_string_destroy(attr.name);
+                       return c_err;
+               }
+               if (match) {
+                       /* matched this element; we're done */
+                       lwc_string_destroy(attr.name);
+                       *is_lang = true;
+                       return CSS_OK;
+               }
+
+               /* no match on this element, try its parent */
+               d_err = dom_node_get_parent_node(n, &p);
+               if (d_err != DOM_NO_ERR) {
+                       lwc_string_destroy(attr.name);
+                       return CSS_NOMEM;
+               }
+               n = p;
+       }
+
+       /* If we never find a match we may wind up here */
+       lwc_string_destroy(attr.name);
+       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.
+ *
+ * \param pw            Pointer to the current SVG parser state; unused
+ * \param property      LibCSS property identifier; unused
+ * \param hint          Pointer to hint object (a return value); unused
+ *
+ * \return Always returns CSS_INVALID
+ */
+css_error ua_default_for_property(void *pw, uint32_t property,
+       css_hint *hint)
+{
+       UNUSED(pw);
+       UNUSED(property);
+       UNUSED(hint);
+       return CSS_INVALID;
+}
+
+
+/**
+ * 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. The fourth parameter (NULL) is a "user handler
+        * function." We will eventually have one, but for now we set
+        * it to NULL to avoid a circular reference mess that would
+        * break the build temporarily. */
+       state = (struct svgtiny_parse_state *)pw;
+       dom_node_set_user_data((dom_node *)node,
+                               state->interned_userdata_key,
+                               libcss_node_data,
+                               NULL,
+                               &old_data);
+
+       /* dom_node_set_user_data() always returns DOM_NO_ERR */
+       return CSS_OK;
+}