nokogiri 1.9.1 → 1.15.3

data/ext/nokogiri/xml_document_fragment.c

@@ -1,4 +1,6 @@
-#include <xml_document_fragment.h>
+#include <nokogiri.h>
+
+VALUE cNokogiriXmlDocumentFragment;
 
 /*
  * call-seq:
@@ -6,7 +8,8 @@
  *
  * Create a new DocumentFragment element on the +document+
  */
-static VALUE new(int argc, VALUE *argv, VALUE klass)
+static VALUE
+new (int argc, VALUE *argv, VALUE klass)
 {
   xmlDocPtr xml_doc;
   xmlNodePtr node;
@@ -16,33 +19,26 @@ static VALUE new(int argc, VALUE *argv, VALUE klass)
 
   rb_scan_args(argc, argv, "1*", &document, &rest);
 
-  Data_Get_Struct(document, xmlDoc, xml_doc);
+  xml_doc = noko_xml_document_unwrap(document);
 
   node = xmlNewDocFragment(xml_doc->doc);
 
-  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);
-
   return rb_node;
 }
 
-VALUE cNokogiriXmlDocumentFragment;
-void init_xml_document_fragment()
+void
+noko_init_xml_document_fragment(void)
 {
-  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);
   /*
    * DocumentFragment represents a DocumentFragment node in an xml document.
    */
-  VALUE klass = rb_define_class_under(xml, "DocumentFragment", node);
-
-  cNokogiriXmlDocumentFragment = klass;
+  cNokogiriXmlDocumentFragment = rb_define_class_under(mNokogiriXml, "DocumentFragment", cNokogiriXmlNode);
 
-  rb_define_singleton_method(klass, "new", new, -1);
+  rb_define_singleton_method(cNokogiriXmlDocumentFragment, "new", new, -1);
 }

data/ext/nokogiri/xml_dtd.c

@@ -1,30 +1,35 @@
-#include <xml_dtd.h>
+#include <nokogiri.h>
 
-static void notation_copier(void *payload, void *data, const xmlChar *name)
+VALUE cNokogiriXmlDtd;
+
+static void
+notation_copier(void *c_notation_ptr, void *rb_hash_ptr, const xmlChar *name)
 {
-  VALUE hash = (VALUE)data;
-  VALUE klass = rb_const_get(mNokogiriXml, rb_intern("Notation"));
+  VALUE rb_hash = (VALUE)rb_hash_ptr;
+  xmlNotationPtr c_notation = (xmlNotationPtr)c_notation_ptr;
+  VALUE rb_notation;
+  VALUE cNokogiriXmlNotation;
+  VALUE rb_constructor_args[3];
 
-  xmlNotationPtr c_notation = (xmlNotationPtr)payload;
-  VALUE notation;
-  VALUE argv[3];
-  argv[0] = (c_notation->name ? NOKOGIRI_STR_NEW2(c_notation->name) : Qnil);
-  argv[1] = (c_notation->PublicID ? NOKOGIRI_STR_NEW2(c_notation->PublicID) : Qnil);
-  argv[2] = (c_notation->SystemID ? NOKOGIRI_STR_NEW2(c_notation->SystemID) : Qnil);
+  rb_constructor_args[0] = (c_notation->name ? NOKOGIRI_STR_NEW2(c_notation->name) : Qnil);
+  rb_constructor_args[1] = (c_notation->PublicID ? NOKOGIRI_STR_NEW2(c_notation->PublicID) : Qnil);
+  rb_constructor_args[2] = (c_notation->SystemID ? NOKOGIRI_STR_NEW2(c_notation->SystemID) : Qnil);
 
-  notation = rb_class_new_instance(3, argv, klass);
+  cNokogiriXmlNotation = rb_const_get_at(mNokogiriXml, rb_intern("Notation"));
+  rb_notation = rb_class_new_instance(3, rb_constructor_args, cNokogiriXmlNotation);
 
-  rb_hash_aset(hash, NOKOGIRI_STR_NEW2(name),notation);
+  rb_hash_aset(rb_hash, NOKOGIRI_STR_NEW2(name), rb_notation);
 }
 
-static void element_copier(void *_payload, void *data, const xmlChar *name)
+static void
+element_copier(void *c_node_ptr, void *rb_hash_ptr, const xmlChar *c_name)
 {
-  VALUE hash = (VALUE)data;
-  xmlNodePtr payload = (xmlNodePtr)_payload;
+  VALUE rb_hash = (VALUE)rb_hash_ptr;
+  xmlNodePtr c_node = (xmlNodePtr)c_node_ptr;
 
-  VALUE element = Nokogiri_wrap_xml_node(Qnil, payload);
+  VALUE rb_node = noko_xml_node_wrap(Qnil, c_node);
 
-  rb_hash_aset(hash, NOKOGIRI_STR_NEW2(name), element);
+  rb_hash_aset(rb_hash, NOKOGIRI_STR_NEW2(c_name), rb_node);
 }
 
 /*
@@ -33,14 +38,15 @@ static void element_copier(void *_payload, void *data, const xmlChar *name)
  *
  * Get a hash of the elements for this DTD.
  */
-static VALUE entities(VALUE self)
+static VALUE
+entities(VALUE self)
 {
   xmlDtdPtr dtd;
   VALUE hash;
 
-  Data_Get_Struct(self, xmlDtd, dtd);
+  Noko_Node_Get_Struct(self, xmlDtd, dtd);
 
-  if(!dtd->entities) return Qnil;
+  if (!dtd->entities) { return Qnil; }
 
   hash = rb_hash_new();
 
@@ -51,18 +57,19 @@ static VALUE entities(VALUE self)
 
 /*
  * call-seq:
- *   notations
+ *   notations() → Hash<name(String)⇒Notation>
  *
- * Get a hash of the notations for this DTD.
+ * [Returns] All the notations for this DTD in a Hash of Notation +name+ to Notation.
  */
-static VALUE notations(VALUE self)
+static VALUE
+notations(VALUE self)
 {
   xmlDtdPtr dtd;
   VALUE hash;
 
-  Data_Get_Struct(self, xmlDtd, dtd);
+  Noko_Node_Get_Struct(self, xmlDtd, dtd);
 
-  if(!dtd->notations) return Qnil;
+  if (!dtd->notations) { return Qnil; }
 
   hash = rb_hash_new();
 
@@ -77,16 +84,17 @@ static VALUE notations(VALUE self)
  *
  * Get a hash of the attributes for this DTD.
  */
-static VALUE attributes(VALUE self)
+static VALUE
+attributes(VALUE self)
 {
   xmlDtdPtr dtd;
   VALUE hash;
 
-  Data_Get_Struct(self, xmlDtd, dtd);
+  Noko_Node_Get_Struct(self, xmlDtd, dtd);
 
   hash = rb_hash_new();
 
-  if(!dtd->attributes) return hash;
+  if (!dtd->attributes) { return hash; }
 
   xmlHashScan((xmlHashTablePtr)dtd->attributes, element_copier, (void *)hash);
 
@@ -99,14 +107,15 @@ static VALUE attributes(VALUE self)
  *
  * Get a hash of the elements for this DTD.
  */
-static VALUE elements(VALUE self)
+static VALUE
+elements(VALUE self)
 {
   xmlDtdPtr dtd;
   VALUE hash;
 
-  Data_Get_Struct(self, xmlDtd, dtd);
+  Noko_Node_Get_Struct(self, xmlDtd, dtd);
 
-  if(!dtd->elements) return Qnil;
+  if (!dtd->elements) { return Qnil; }
 
   hash = rb_hash_new();
 
@@ -121,15 +130,16 @@ static VALUE elements(VALUE self)
  *
  * Validate +document+ returning a list of errors
  */
-static VALUE validate(VALUE self, VALUE document)
+static VALUE
+validate(VALUE self, VALUE document)
 {
   xmlDocPtr doc;
   xmlDtdPtr dtd;
   xmlValidCtxtPtr ctxt;
   VALUE error_list;
 
-  Data_Get_Struct(self, xmlDtd, dtd);
-  Data_Get_Struct(document, xmlDoc, doc);
+  Noko_Node_Get_Struct(self, xmlDtd, dtd);
+  doc = noko_xml_document_unwrap(document);
   error_list = rb_ary_new();
 
   ctxt = xmlNewValidCtxt();
@@ -151,12 +161,13 @@ static VALUE validate(VALUE self, VALUE document)
  *
  * Get the System ID for this DTD
  */
-static VALUE system_id(VALUE self)
+static VALUE
+system_id(VALUE self)
 {
   xmlDtdPtr dtd;
-  Data_Get_Struct(self, xmlDtd, dtd);
+  Noko_Node_Get_Struct(self, xmlDtd, dtd);
 
-  if(!dtd->SystemID) return Qnil;
+  if (!dtd->SystemID) { return Qnil; }
 
   return NOKOGIRI_STR_NEW2(dtd->SystemID);
 }
@@ -167,36 +178,31 @@ static VALUE system_id(VALUE self)
  *
  * Get the External ID for this DTD
  */
-static VALUE external_id(VALUE self)
+static VALUE
+external_id(VALUE self)
 {
   xmlDtdPtr dtd;
-  Data_Get_Struct(self, xmlDtd, dtd);
+  Noko_Node_Get_Struct(self, xmlDtd, dtd);
 
-  if(!dtd->ExternalID) return Qnil;
+  if (!dtd->ExternalID) { return Qnil; }
 
   return NOKOGIRI_STR_NEW2(dtd->ExternalID);
 }
 
-VALUE cNokogiriXmlDtd;
-
-void init_xml_dtd()
+void
+noko_init_xml_dtd(void)
 {
-  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);
   /*
    * Nokogiri::XML::DTD wraps DTD nodes in an XML document
    */
-  VALUE klass = rb_define_class_under(xml, "DTD", node);
-
-  cNokogiriXmlDtd = klass;
-
-  rb_define_method(klass, "notations", notations, 0);
-  rb_define_method(klass, "elements", elements, 0);
-  rb_define_method(klass, "entities", entities, 0);
-  rb_define_method(klass, "validate", validate, 1);
-  rb_define_method(klass, "attributes", attributes, 0);
-  rb_define_method(klass, "system_id", system_id, 0);
-  rb_define_method(klass, "external_id", external_id, 0);
+  cNokogiriXmlDtd = rb_define_class_under(mNokogiriXml, "DTD", cNokogiriXmlNode);
+
+  rb_define_method(cNokogiriXmlDtd, "notations", notations, 0);
+  rb_define_method(cNokogiriXmlDtd, "elements", elements, 0);
+  rb_define_method(cNokogiriXmlDtd, "entities", entities, 0);
+  rb_define_method(cNokogiriXmlDtd, "validate", validate, 1);
+  rb_define_method(cNokogiriXmlDtd, "attributes", attributes, 0);
+  rb_define_method(cNokogiriXmlDtd, "system_id", system_id, 0);
+  rb_define_method(cNokogiriXmlDtd, "external_id", external_id, 0);
 }

data/ext/nokogiri/xml_element_content.c

@@ -1,123 +1,131 @@
-#include <xml_element_content.h>
+#include <nokogiri.h>
 
 VALUE cNokogiriXmlElementContent;
 
+static const rb_data_type_t element_content_data_type = {
+  .wrap_struct_name = "Nokogiri::XML::ElementContent",
+  .flags = RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED,
+};
+
 /*
  * call-seq:
- *  name
+ *   name → String
  *
- * Get the require element +name+
+ * [Returns] The content element's +name+
  */
-static VALUE get_name(VALUE self)
+static VALUE
+get_name(VALUE self)
 {
   xmlElementContentPtr elem;
-  Data_Get_Struct(self, xmlElementContent, elem);
+  TypedData_Get_Struct(self, xmlElementContent, &element_content_data_type, elem);
 
-  if(!elem->name) return Qnil;
+  if (!elem->name) { return Qnil; }
   return NOKOGIRI_STR_NEW2(elem->name);
 }
 
 /*
  * call-seq:
- *  type
+ *   type → Integer
  *
- * Get the element content +type+.  Possible values are PCDATA, ELEMENT, SEQ,
- * or OR.
+ * [Returns] The content element's +type+. Possible values are +PCDATA+, +ELEMENT+, +SEQ+, or +OR+.
  */
-static VALUE get_type(VALUE self)
+static VALUE
+get_type(VALUE self)
 {
   xmlElementContentPtr elem;
-  Data_Get_Struct(self, xmlElementContent, elem);
+  TypedData_Get_Struct(self, xmlElementContent, &element_content_data_type, elem);
 
-  return INT2NUM((long)elem->type);
+  return INT2NUM(elem->type);
 }
 
 /*
- * call-seq:
- *  c1
- *
  * Get the first child.
  */
-static VALUE get_c1(VALUE self)
+static VALUE
+get_c1(VALUE self)
 {
   xmlElementContentPtr elem;
-  Data_Get_Struct(self, xmlElementContent, elem);
+  TypedData_Get_Struct(self, xmlElementContent, &element_content_data_type, elem);
 
-  if(!elem->c1) return Qnil;
-  return Nokogiri_wrap_element_content(rb_iv_get(self, "@document"), elem->c1);
+  if (!elem->c1) { return Qnil; }
+  return noko_xml_element_content_wrap(rb_iv_get(self, "@document"), elem->c1);
 }
 
 /*
- * call-seq:
- *  c2
- *
- * Get the first child.
+ * Get the second child.
  */
-static VALUE get_c2(VALUE self)
+static VALUE
+get_c2(VALUE self)
 {
   xmlElementContentPtr elem;
-  Data_Get_Struct(self, xmlElementContent, elem);
+  TypedData_Get_Struct(self, xmlElementContent, &element_content_data_type, elem);
 
-  if(!elem->c2) return Qnil;
-  return Nokogiri_wrap_element_content(rb_iv_get(self, "@document"), elem->c2);
+  if (!elem->c2) { return Qnil; }
+  return noko_xml_element_content_wrap(rb_iv_get(self, "@document"), elem->c2);
 }
 
 /*
  * call-seq:
- *  occur
+ *   occur → Integer
  *
- * Get the element content +occur+ flag.  Possible values are ONCE, OPT, MULT
- * or PLUS.
+ * [Returns] The content element's +occur+ flag. Possible values are +ONCE+, +OPT+, +MULT+ or +PLUS+.
  */
-static VALUE get_occur(VALUE self)
+static VALUE
+get_occur(VALUE self)
 {
   xmlElementContentPtr elem;
-  Data_Get_Struct(self, xmlElementContent, elem);
+  TypedData_Get_Struct(self, xmlElementContent, &element_content_data_type, elem);
 
-  return INT2NUM((long)elem->ocur);
+  return INT2NUM(elem->ocur);
 }
 
 /*
  * call-seq:
- *  prefix
+ *   prefix → String
  *
- * Get the element content namespace +prefix+.
+ * [Returns] The content element's namespace +prefix+.
  */
-static VALUE get_prefix(VALUE self)
+static VALUE
+get_prefix(VALUE self)
 {
   xmlElementContentPtr elem;
-  Data_Get_Struct(self, xmlElementContent, elem);
+  TypedData_Get_Struct(self, xmlElementContent, &element_content_data_type, elem);
 
-  if(!elem->prefix) return Qnil;
+  if (!elem->prefix) { return Qnil; }
 
   return NOKOGIRI_STR_NEW2(elem->prefix);
 }
 
-VALUE Nokogiri_wrap_element_content(VALUE doc, xmlElementContentPtr element)
+/*
+ *  create a Nokogiri::XML::ElementContent object around an +element+.
+ */
+VALUE
+noko_xml_element_content_wrap(VALUE rb_document, xmlElementContentPtr c_element_content)
 {
-  VALUE elem = Data_Wrap_Struct(cNokogiriXmlElementContent, 0, 0, element);
+  VALUE elem = TypedData_Wrap_Struct(
+                 cNokogiriXmlElementContent,
+                 &element_content_data_type,
+                 c_element_content
+               );
 
-  /* Setting the document is necessary so that this does not get GC'd until */
-  /* the document is GC'd */
-  rb_iv_set(elem, "@document", doc);
+  /* keep a handle on the document for GC marking */
+  rb_iv_set(elem, "@document", rb_document);
 
   return elem;
 }
 
-void init_xml_element_content()
+void
+noko_init_xml_element_content(void)
 {
-  VALUE nokogiri = rb_define_module("Nokogiri");
-  VALUE xml = rb_define_module_under(nokogiri, "XML");
-
-  VALUE klass = rb_define_class_under(xml, "ElementContent", rb_cObject);
+  cNokogiriXmlElementContent = rb_define_class_under(mNokogiriXml, "ElementContent", rb_cObject);
 
-  cNokogiriXmlElementContent = klass;
+  rb_undef_alloc_func(cNokogiriXmlElementContent);
 
-  rb_define_method(klass, "name", get_name, 0);
-  rb_define_method(klass, "type", get_type, 0);
-  rb_define_method(klass, "occur", get_occur, 0);
-  rb_define_method(klass, "prefix", get_prefix, 0);
+  rb_define_method(cNokogiriXmlElementContent, "name", get_name, 0);
+  rb_define_method(cNokogiriXmlElementContent, "type", get_type, 0);
+  rb_define_method(cNokogiriXmlElementContent, "occur", get_occur, 0);
+  rb_define_method(cNokogiriXmlElementContent, "prefix", get_prefix, 0);
 
-  rb_define_private_method(klass, "c1", get_c1, 0);
-  rb_define_private_method(klass, "c2", get_c2, 0);
+  rb_define_private_method(cNokogiriXmlElementContent, "c1", get_c1, 0);
+  rb_define_private_method(cNokogiriXmlElementContent, "c2", get_c2, 0);
 }

data/ext/nokogiri/xml_element_decl.c

@@ -1,69 +1,69 @@
-#include <xml_element_decl.h>
+#include <nokogiri.h>
+
+VALUE cNokogiriXmlElementDecl;
 
 static ID id_document;
 
 /*
  * call-seq:
- *  element_type
+ *   element_type → Integer
  *
  * The element_type
  */
-static VALUE element_type(VALUE self)
+static VALUE
+element_type(VALUE self)
 {
   xmlElementPtr node;
-  Data_Get_Struct(self, xmlElement, node);
-  return INT2NUM((long)node->etype);
+  Noko_Node_Get_Struct(self, xmlElement, node);
+  return INT2NUM(node->etype);
 }
 
 /*
  * call-seq:
- *  content
+ *   content → Nokogiri::XML::ElementContent
  *
- * The allowed content for this ElementDecl
+ * [Returns] The root of this element declaration's content tree.
  */
-static VALUE content(VALUE self)
+static VALUE
+content(VALUE self)
 {
   xmlElementPtr node;
-  Data_Get_Struct(self, xmlElement, node);
+  Noko_Node_Get_Struct(self, xmlElement, node);
 
-  if(!node->content) return Qnil;
+  if (!node->content) { return Qnil; }
 
-  return Nokogiri_wrap_element_content(
-      rb_funcall(self, id_document, 0),
-      node->content
-  );
+  return noko_xml_element_content_wrap(
+           rb_funcall(self, id_document, 0),
+           node->content
+         );
 }
 
 /*
  * call-seq:
- *  prefix
+ *   prefix → String
  *
- * The namespace prefix for this ElementDecl
+ * [Returns] The namespace +prefix+ for this element declaration.
  */
-static VALUE prefix(VALUE self)
+static VALUE
+prefix(VALUE self)
 {
   xmlElementPtr node;
-  Data_Get_Struct(self, xmlElement, node);
+  Noko_Node_Get_Struct(self, xmlElement, node);
 
-  if(!node->prefix) return Qnil;
+  if (!node->prefix) { return Qnil; }
 
   return NOKOGIRI_STR_NEW2(node->prefix);
 }
 
-VALUE cNokogiriXmlElementDecl;
-
-void init_xml_element_decl()
+void
+noko_init_xml_element_decl(void)
 {
-  VALUE nokogiri = rb_define_module("Nokogiri");
-  VALUE xml = rb_define_module_under(nokogiri, "XML");
-  VALUE node = rb_define_class_under(xml, "Node", rb_cObject);
-  VALUE klass = rb_define_class_under(xml, "ElementDecl", node);
-
-  cNokogiriXmlElementDecl = klass;
+  assert(cNokogiriXmlNode);
+  cNokogiriXmlElementDecl = rb_define_class_under(mNokogiriXml, "ElementDecl", cNokogiriXmlNode);
 
-  rb_define_method(klass, "element_type", element_type, 0);
-  rb_define_method(klass, "content", content, 0);
-  rb_define_method(klass, "prefix", prefix, 0);
+  rb_define_method(cNokogiriXmlElementDecl, "element_type", element_type, 0);
+  rb_define_method(cNokogiriXmlElementDecl, "content", content, 0);
+  rb_define_method(cNokogiriXmlElementDecl, "prefix", prefix, 0);
 
   id_document = rb_intern("document");
 }