nokogiri 1.10.9 → 1.18.3

data/ext/nokogiri/xml_relax_ng.c

@@ -1,44 +1,47 @@
-#include <xml_relax_ng.h>
+#include <nokogiri.h>
 
-static void dealloc(xmlRelaxNGPtr schema)
+VALUE cNokogiriXmlRelaxNG;
+
+static void
+_noko_xml_relax_ng_deallocate(void *data)
 {
-  NOKOGIRI_DEBUG_START(schema);
+  xmlRelaxNGPtr schema = data;
   xmlRelaxNGFree(schema);
-  NOKOGIRI_DEBUG_END(schema);
 }
 
-/*
- * call-seq:
- *  validate_document(document)
- *
- * Validate a Nokogiri::XML::Document against this RelaxNG schema.
- */
-static VALUE validate_document(VALUE self, VALUE document)
+static const rb_data_type_t xml_relax_ng_type = {
+  .wrap_struct_name = "xmlRelaxNG",
+  .function = {
+    .dfree = _noko_xml_relax_ng_deallocate,
+  },
+  .flags = RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED,
+};
+
+static VALUE
+noko_xml_relax_ng__validate_document(VALUE self, VALUE document)
 {
   xmlDocPtr doc;
   xmlRelaxNGPtr schema;
   VALUE errors;
   xmlRelaxNGValidCtxtPtr valid_ctxt;
 
-  Data_Get_Struct(self, xmlRelaxNG, schema);
-  Data_Get_Struct(document, xmlDoc, doc);
+  TypedData_Get_Struct(self, xmlRelaxNG, &xml_relax_ng_type, schema);
+  doc = noko_xml_document_unwrap(document);
 
   errors = rb_ary_new();
 
   valid_ctxt = xmlRelaxNGNewValidCtxt(schema);
 
-  if(NULL == valid_ctxt) {
+  if (NULL == valid_ctxt) {
     /* we have a problem */
     rb_raise(rb_eRuntimeError, "Could not create a validation context");
   }
 
-#ifdef HAVE_XMLRELAXNGSETVALIDSTRUCTUREDERRORS
   xmlRelaxNGSetValidStructuredErrors(
     valid_ctxt,
-    Nokogiri_error_array_pusher,
+    noko__error_array_pusher,
     (void *)errors
   );
-#endif
 
   xmlRelaxNGValidateDoc(valid_ctxt, doc);
 
@@ -47,115 +50,100 @@ static VALUE validate_document(VALUE self, VALUE document)
   return errors;
 }
 
-/*
- * call-seq:
- *  read_memory(string)
- *
- * Create a new RelaxNG from the contents of +string+
- */
-static VALUE read_memory(VALUE klass, VALUE content)
+static VALUE
+_noko_xml_relax_ng_parse_schema(
+  VALUE rb_class,
+  xmlRelaxNGParserCtxtPtr c_parser_context,
+  VALUE rb_parse_options
+)
 {
-  xmlRelaxNGParserCtxtPtr ctx = xmlRelaxNGNewMemParserCtxt(
-      (const char *)StringValuePtr(content),
-      (int)RSTRING_LEN(content)
-  );
-  xmlRelaxNGPtr schema;
-  VALUE errors = rb_ary_new();
+  VALUE rb_errors;
   VALUE rb_schema;
+  xmlRelaxNGPtr c_schema;
+  libxmlStructuredErrorHandlerState handler_state;
+
+  if (NIL_P(rb_parse_options)) {
+    rb_parse_options = rb_const_get_at(
+                         rb_const_get_at(mNokogiriXml, rb_intern("ParseOptions")),
+                         rb_intern("DEFAULT_SCHEMA")
+                       );
+  }
 
-  xmlSetStructuredErrorFunc((void *)errors, Nokogiri_error_array_pusher);
+  rb_errors = rb_ary_new();
 
-#ifdef HAVE_XMLRELAXNGSETPARSERSTRUCTUREDERRORS
+  noko__structured_error_func_save_and_set(&handler_state, (void *)rb_errors, noko__error_array_pusher);
   xmlRelaxNGSetParserStructuredErrors(
-    ctx,
-    Nokogiri_error_array_pusher,
-    (void *)errors
+    c_parser_context,
+    noko__error_array_pusher,
+    (void *)rb_errors
   );
-#endif
 
-  schema = xmlRelaxNGParse(ctx);
+  c_schema = xmlRelaxNGParse(c_parser_context);
 
-  xmlSetStructuredErrorFunc(NULL, NULL);
-  xmlRelaxNGFreeParserCtxt(ctx);
+  xmlRelaxNGFreeParserCtxt(c_parser_context);
+  noko__structured_error_func_restore(&handler_state);
 
-  if(NULL == schema) {
-    xmlErrorPtr error = xmlGetLastError();
-    if(error)
-      Nokogiri_error_raise(NULL, error);
-    else
-      rb_raise(rb_eRuntimeError, "Could not parse document");
+  if (NULL == c_schema) {
+    VALUE exception = rb_funcall(cNokogiriXmlSyntaxError, rb_intern("aggregate"), 1, rb_errors);
 
-    return Qnil;
+    if (RB_TEST(exception)) {
+      rb_exc_raise(exception);
+    } else {
+      rb_raise(rb_eRuntimeError, "Could not parse document");
+    }
   }
 
-  rb_schema = Data_Wrap_Struct(klass, 0, dealloc, schema);
-  rb_iv_set(rb_schema, "@errors", errors);
+  rb_schema = TypedData_Wrap_Struct(rb_class, &xml_relax_ng_type, c_schema);
+  rb_iv_set(rb_schema, "@errors", rb_errors);
+  rb_iv_set(rb_schema, "@parse_options", rb_parse_options);
 
   return rb_schema;
 }
 
 /*
- * call-seq:
- *  from_document(doc)
+ * :call-seq:
+ *   from_document(document) → Nokogiri::XML::RelaxNG
+ *   from_document(document, parse_options) → Nokogiri::XML::RelaxNG
  *
- * Create a new RelaxNG schema from the Nokogiri::XML::Document +doc+
+ * Parse a RELAX NG schema definition from a Document to create a new Nokogiri::XML::RelaxNG.
+ *
+ * [Parameters]
+ * - +document+ (XML::Document) A document containing the RELAX NG schema definition
+ * - +parse_options+ (Nokogiri::XML::ParseOptions)
+ *   Defaults to ParseOptions::DEFAULT_SCHEMA ⚠ Unused
+ *
+ * [Returns] Nokogiri::XML::RelaxNG
+ *
+ * ⚠ +parse_options+ is currently unused by this method and is present only as a placeholder for
+ * future functionality.
  */
-static VALUE from_document(VALUE klass, VALUE document)
+static VALUE
+noko_xml_relax_ng_s_from_document(int argc, VALUE *argv, VALUE rb_class)
 {
-  xmlDocPtr doc;
-  xmlRelaxNGParserCtxtPtr ctx;
-  xmlRelaxNGPtr schema;
-  VALUE errors;
-  VALUE rb_schema;
-
-  Data_Get_Struct(document, xmlDoc, doc);
-
-  /* In case someone passes us a node. ugh. */
-  doc = doc->doc;
-
-  ctx = xmlRelaxNGNewDocParserCtxt(doc);
-
-  errors = rb_ary_new();
-  xmlSetStructuredErrorFunc((void *)errors, Nokogiri_error_array_pusher);
-
-#ifdef HAVE_XMLRELAXNGSETPARSERSTRUCTUREDERRORS
-  xmlRelaxNGSetParserStructuredErrors(
-    ctx,
-    Nokogiri_error_array_pusher,
-    (void *)errors
-  );
-#endif
+  /* TODO: deprecate this method and put file-or-string logic into .new so that becomes the
+   * preferred entry point, and this can become a private method */
+  VALUE rb_document;
+  VALUE rb_parse_options;
+  xmlDocPtr c_document;
+  xmlRelaxNGParserCtxtPtr c_parser_context;
 
-  schema = xmlRelaxNGParse(ctx);
+  rb_scan_args(argc, argv, "11", &rb_document, &rb_parse_options);
 
-  xmlSetStructuredErrorFunc(NULL, NULL);
+  c_document = noko_xml_document_unwrap(rb_document);
+  c_document = c_document->doc; /* In case someone passes us a node. ugh. */
 
-  if(NULL == schema) {
-    xmlErrorPtr error = xmlGetLastError();
-    if(error)
-      Nokogiri_error_raise(NULL, error);
-    else
-      rb_raise(rb_eRuntimeError, "Could not parse document");
+  c_parser_context = xmlRelaxNGNewDocParserCtxt(c_document);
 
-    return Qnil;
-  }
-
-  rb_schema = Data_Wrap_Struct(klass, 0, dealloc, schema);
-  rb_iv_set(rb_schema, "@errors", errors);
-
-  return rb_schema;
+  return _noko_xml_relax_ng_parse_schema(rb_class, c_parser_context, rb_parse_options);
 }
 
-VALUE cNokogiriXmlRelaxNG;
-void init_xml_relax_ng()
+void
+noko_init_xml_relax_ng(void)
 {
-  VALUE nokogiri = rb_define_module("Nokogiri");
-  VALUE xml = rb_define_module_under(nokogiri, "XML");
-  VALUE klass = rb_define_class_under(xml, "RelaxNG", cNokogiriXmlSchema);
+  assert(cNokogiriXmlSchema);
+  cNokogiriXmlRelaxNG = rb_define_class_under(mNokogiriXml, "RelaxNG", cNokogiriXmlSchema);
 
-  cNokogiriXmlRelaxNG = klass;
+  rb_define_singleton_method(cNokogiriXmlRelaxNG, "from_document", noko_xml_relax_ng_s_from_document, -1);
 
-  rb_define_singleton_method(klass, "read_memory", read_memory, 1);
-  rb_define_singleton_method(klass, "from_document", from_document, 1);
-  rb_define_private_method(klass, "validate_document", validate_document, 1);
+  rb_define_private_method(cNokogiriXmlRelaxNG, "validate_document", noko_xml_relax_ng__validate_document, 1);
 }