nokogiri 1.11.0.rc4 → 1.11.3

data/ext/nokogiri/xml_entity_reference.c

@@ -1,4 +1,6 @@
-#include <xml_entity_reference.h>
+#include <nokogiri.h>
+
+VALUE cNokogiriXmlEntityReference;
 
 /*
  * call-seq:
@@ -6,7 +8,8 @@
  *
  * Create a new EntityReference element on the +document+ with +name+
  */
-static VALUE new(int argc, VALUE *argv, VALUE klass)
+static VALUE
+new (int argc, VALUE *argv, VALUE klass)
 {
   xmlDocPtr xml_doc;
   xmlNodePtr node;
@@ -20,33 +23,28 @@ static VALUE new(int argc, VALUE *argv, VALUE klass)
   Data_Get_Struct(document, xmlDoc, xml_doc);
 
   node = xmlNewReference(
-      xml_doc,
-      (const xmlChar *)StringValueCStr(name)
-  );
+           xml_doc,
+           (const xmlChar *)StringValueCStr(name)
+         );
 
-  nokogiri_root_node(node);
+  noko_xml_document_pin_node(node);
 
-  rb_node = Nokogiri_wrap_xml_node(klass, node);
+  rb_node = noko_xml_node_wrap(klass, node);
   rb_obj_call_init(rb_node, argc, argv);
 
-  if(rb_block_given_p()) rb_yield(rb_node);
+  if (rb_block_given_p()) { rb_yield(rb_node); }
 
   return rb_node;
 }
 
-VALUE cNokogiriXmlEntityReference;
-void init_xml_entity_reference()
+void
+noko_init_xml_entity_reference()
 {
-  VALUE nokogiri = rb_define_module("Nokogiri");
-  VALUE xml = rb_define_module_under(nokogiri, "XML");
-  VALUE node = rb_define_class_under(xml, "Node", rb_cObject);
-
+  assert(cNokogiriXmlNode);
   /*
    * EntityReference represents an EntityReference node in an xml document.
    */
-  VALUE klass = rb_define_class_under(xml, "EntityReference", node);
-
-  cNokogiriXmlEntityReference = klass;
+  cNokogiriXmlEntityReference = rb_define_class_under(mNokogiriXml, "EntityReference", cNokogiriXmlNode);
 
-  rb_define_singleton_method(klass, "new", new, -1);
+  rb_define_singleton_method(cNokogiriXmlEntityReference, "new", new, -1);
 }

data/ext/nokogiri/xml_namespace.c

@@ -1,16 +1,35 @@
-#include <xml_namespace.h>
+#include <nokogiri.h>
+
+/*
+ *  The lifecycle of a Namespace node is more complicated than other Nodes, for two reasons:
+ *
+ *  1. the underlying C structure has a different layout than all the other node structs, with the
+ *     `_private` member where we store a pointer to Ruby object data not being in first position.
+ *  2. xmlNs structures returned in an xmlNodeset from an XPath query are copies of the document's
+ *     namespaces, and so do not share the same memory lifecycle as everything else in a document.
+ *
+ *  As a result of 1, you may see special handling of XML_NAMESPACE_DECL node types throughout the
+ *  Nokogiri C code, though I intend to wrap up that logic in ruby_object_{get,set} functions
+ *  shortly.
+ *
+ *  As a result of 2, you will see we have special handling in this file and in xml_node_set.c to
+ *  carefully manage the memory lifecycle of xmlNs structs to match the Ruby object's GC
+ *  lifecycle. In xml_node_set.c we have local versions of xmlXPathNodeSetDel() and
+ *  xmlXPathFreeNodeSet() that avoid freeing xmlNs structs in the node set. In this file, we decide
+ *  whether or not to call dealloc_namespace() depending on whether the xmlNs struct appears to be
+ *  in an xmlNodeSet (and thus the result of an XPath query) or not.
+ *
+ *  Yes, this is madness.
+ */
 
 VALUE cNokogiriXmlNamespace ;
 
-static void dealloc_namespace(xmlNsPtr ns)
+static void
+dealloc_namespace(xmlNsPtr ns)
 {
   /*
-   *
    * this deallocator is only used for namespace nodes that are part of an xpath
-   * node set.
-   *
-   * see Nokogiri_wrap_xml_namespace() for more details.
-   *
+   * node set. see noko_xml_namespace_wrap().
    */
   NOKOGIRI_DEBUG_START(ns) ;
   if (ns->href) {
@@ -30,12 +49,13 @@ static void dealloc_namespace(xmlNsPtr ns)
  *
  * Get the prefix for this namespace.  Returns +nil+ if there is no prefix.
  */
-static VALUE prefix(VALUE self)
+static VALUE
+prefix(VALUE self)
 {
   xmlNsPtr ns;
 
   Data_Get_Struct(self, xmlNs, ns);
-  if(!ns->prefix) return Qnil;
+  if (!ns->prefix) { return Qnil; }
 
   return NOKOGIRI_STR_NEW2(ns->prefix);
 }
@@ -46,66 +66,53 @@ static VALUE prefix(VALUE self)
  *
  * Get the href for this namespace
  */
-static VALUE href(VALUE self)
+static VALUE
+href(VALUE self)
 {
   xmlNsPtr ns;
 
   Data_Get_Struct(self, xmlNs, ns);
-  if(!ns->href) return Qnil;
+  if (!ns->href) { return Qnil; }
 
   return NOKOGIRI_STR_NEW2(ns->href);
 }
 
-static int part_of_an_xpath_node_set_eh(xmlNsPtr node)
-{
-  return (node->next && ! NOKOGIRI_NAMESPACE_EH(node->next));
-}
-
-VALUE Nokogiri_wrap_xml_namespace(xmlDocPtr doc, xmlNsPtr node)
+VALUE
+noko_xml_namespace_wrap(xmlNsPtr c_namespace, xmlDocPtr c_document)
 {
-  VALUE ns = 0, document, node_cache;
-
-  assert(doc->type == XML_DOCUMENT_NODE || doc->type == XML_HTML_DOCUMENT_NODE);
-
-  if (node->_private) return (VALUE)node->_private;
+  VALUE rb_namespace;
 
-  if (doc->type == XML_DOCUMENT_FRAG_NODE) doc = doc->doc;
+  if (c_namespace->_private) {
+    return (VALUE)c_namespace->_private;
+  }
 
-  if (DOC_RUBY_OBJECT_TEST(doc)) {
-    document = DOC_RUBY_OBJECT(doc);
+  if (c_document) {
+    rb_namespace = Data_Wrap_Struct(cNokogiriXmlNamespace, 0, 0, c_namespace);
 
-    if (part_of_an_xpath_node_set_eh(node)) {
-      /*
-       *  this is a duplicate returned as part of an xpath query node set, and so
-       *  we need to make sure we manage this memory.
-       *
-       *  see comments in xml_node_set.c for more details.
-       */
-      ns = Data_Wrap_Struct(cNokogiriXmlNamespace, 0, dealloc_namespace, node);
-    } else {
-      ns = Data_Wrap_Struct(cNokogiriXmlNamespace, 0, 0, node);
-      node_cache = rb_iv_get(document, "@node_cache");
-      rb_ary_push(node_cache, ns);
+    if (DOC_RUBY_OBJECT_TEST(c_document)) {
+      rb_iv_set(rb_namespace, "@document", DOC_RUBY_OBJECT(c_document));
+      rb_ary_push(DOC_NODE_CACHE(c_document), rb_namespace);
     }
-
-    rb_iv_set(ns, "@document", document);
   } else {
-    ns = Data_Wrap_Struct(cNokogiriXmlNamespace, 0, 0, node);
+    rb_namespace = Data_Wrap_Struct(cNokogiriXmlNamespace, 0, dealloc_namespace, c_namespace);
   }
 
-  node->_private = (void *)ns;
+  c_namespace->_private = (void *)rb_namespace;
 
-  return ns;
+  return rb_namespace;
 }
 
-void init_xml_namespace()
+VALUE
+noko_xml_namespace_wrap_xpath_copy(xmlNsPtr c_namespace)
 {
-  VALUE nokogiri  = rb_define_module("Nokogiri");
-  VALUE xml       = rb_define_module_under(nokogiri, "XML");
-  VALUE klass     = rb_define_class_under(xml, "Namespace", rb_cObject);
+  return noko_xml_namespace_wrap(c_namespace, NULL);
+}
 
-  cNokogiriXmlNamespace = klass;
+void
+noko_init_xml_namespace()
+{
+  cNokogiriXmlNamespace = rb_define_class_under(mNokogiriXml, "Namespace", rb_cObject);
 
-  rb_define_method(klass, "prefix", prefix, 0);
-  rb_define_method(klass, "href", href, 0);
+  rb_define_method(cNokogiriXmlNamespace, "prefix", prefix, 0);
+  rb_define_method(cNokogiriXmlNamespace, "href", href, 0);
 }