Added support for libxml2 2.12

.codespellexclude

@@ -13,3 +13,5 @@
     if (index < pFunc()->mErrors.size()) {
         issue = pFunc()->mIssues.at(pFunc()->mErrors.at(index));
     return pFunc()->mErrors.size();
+identity and expression, level of experience, education, socio-economic status,
+        "W3C MathML DTD error: Element apply content does not follow the DTD, expecting (csymbol | ci | cn | apply | reln | lambda | condition | declare | sep | semantics | annotation | annotation-xml | integers | reals | rationals | naturalnumbers | complexes | primes | exponentiale | imaginaryi | notanumber | true | false | emptyset | pi | eulergamma | infinity | interval | list | matrix | matrixrow | set | vector | piecewise | lowlimit | uplimit | bvar | degree | logbase | momentabout | domainofapplication | inverse | ident | domain | codomain | image | abs | conjugate | exp | factorial | arg | real | imaginary | floor | ceiling | not | ln | sin | cos | tan | sec | csc | cot | sinh | cosh | tanh | sech | csch | coth | arcsin | arccos | arctan | arccosh | arccot | arccoth | arccsc | arccsch | arcsec | arcsech | arcsinh | arctanh | determinant | transpose | card | quotient | divide | power | rem | implies | vectorproduct | scalarproduct | outerproduct | setdiff | fn | compose | plus | times | max | min | gcd | lcm | and | or | xor | union | intersect | cartesianproduct | mean | sdev | variance | median | mode | selector | root | minus | log | int | diff | partialdiff | divergence | grad | curl | laplacian | sum | product | limit | moment | exists | forall | neq | factorof | in | notin | notsubset | notprsubset | tendsto | eq | leq | lt | geq | gt | equivalent | approx | subset | prsubset | mi | mn | mo | mtext | ms | mspace | mrow | mfrac | msqrt | mroot | menclose | mstyle | merror | mpadded | mphantom | mfenced | msub | msup | msubsup | munder | mover | munderover | mmultiscripts | mtable | mtr | mlabeledtr | mtd | maligngroup | malignmark | maction)*, got (CDATA bvar ).",

src/printer.cpp

@@ -140,7 +140,6 @@ std::string Printer::PrinterImpl::printMath(const std::string &math)
     static const std::regex xmlDeclaration(R"|(<\?xml[[:space:]]+version=.*\?>)|");
 
     XmlDocPtr xmlDoc = std::make_shared<XmlDoc>();
-    xmlKeepBlanksDefault(0);
     // Remove any XML declarations from the string.
     std::string normalisedMath = std::regex_replace(math, xmlDeclaration, "");
     xmlDoc->parse("<" + wrapElementName + ">" + normalisedMath + "</" + wrapElementName + ">");
@@ -592,7 +591,6 @@ std::string Printer::printModel(const ModelPtr &model, bool autoIds)
     // See http://www.xmlsoft.org/html/libxml-tree.html#xmlDocDumpFormatMemoryEnc
     // for details.
     XmlDocPtr xmlDoc = std::make_shared<XmlDoc>();
-    xmlKeepBlanksDefault(0);
     xmlDoc->parse(repr);
     return xmlDoc->prettyPrint();
 }

src/xmldoc.cpp

@@ -42,7 +42,13 @@ namespace libcellml {
  *
  * @param error The @c xmlErrorPtr to the error raised by libxml.
  */
-void structuredErrorCallback(void *userData, xmlErrorPtr error)
+#if LIBXML_VERSION >= 21200
+#    define XmlErrorPtr const xmlError *
+#else
+#    define XmlErrorPtr xmlErrorPtr
+#endif
+
+void structuredErrorCallback(void *userData, XmlErrorPtr error)
 {
     static const std::regex newLineRegex("\\n");
     // Swap libxml2 carriage return for a period.
@@ -89,7 +95,6 @@ void XmlDoc::parse(const std::string &input)
     xmlFreeParserCtxt(context);
     xmlSetStructuredErrorFunc(nullptr, nullptr);
     xmlCleanupParser();
-    xmlCleanupGlobals();
 }
 
 std::string decompressMathMLDTD()
@@ -129,7 +134,6 @@ void XmlDoc::parseMathML(const std::string &input)
     xmlFreeParserCtxt(context);
     xmlSetStructuredErrorFunc(nullptr, nullptr);
     xmlCleanupParser();
-    xmlCleanupGlobals();
 }
 
 std::string XmlDoc::prettyPrint() const

src/xmlnode.cpp

@@ -310,7 +310,6 @@ XmlNodePtr XmlNode::parent() const
 
 std::string XmlNode::convertToString() const
 {
-    xmlKeepBlanksDefault(1);
     xmlBufferPtr buffer = xmlBufferCreate();
     xmlNodeDump(buffer, mPimpl->mXmlNodePtr->doc, mPimpl->mXmlNodePtr, 0, 0);
     std::string contentString = std::string(reinterpret_cast<const char *>(buffer->content));

tests/CMakeLists.txt

@@ -55,6 +55,8 @@ set(TEST_UTILS_HDR ${CMAKE_CURRENT_SOURCE_DIR}/test_utils.h)
 
 if(NOT DEFINED LIBXML2_VERSION_STRING)
   set(LIBXML2_VERSION_STRING "2.9.10")
+elseif(LIBXML2_VERSION_STRING VERSION_GREATER_EQUAL "2.12")
+  set(LIBXML2_VERSION_STRING "2.12")
 elseif(LIBXML2_VERSION_STRING VERSION_GREATER_EQUAL "2.9.13")
   set(LIBXML2_VERSION_STRING "2.9.13")
 elseif(LIBXML2_VERSION_STRING VERSION_GREATER_EQUAL "2.9.11")

tests/libxml2issues.2.12.h

@@ -0,0 +1,12 @@
+#pragma once
+
+#include "string"
+#include "vector"
+
+// Version 2.12(.7) of LibXml2 reports the following errors,
+// used on Windows CI machines.
+const std::vector<std::string> expectedLibXml2Issues = {
+    "LibXml2 error: Opening and ending tag mismatch: ci line 6 and apply.",
+    "LibXml2 error: Opening and ending tag mismatch: ci line 6 and math.",
+    "LibXml2 error: Opening and ending tag mismatch: apply line 3 and math_wrap_as_single_root_element.",
+};

tests/parser/libxml_user.cpp

@@ -24,7 +24,13 @@ limitations under the License.
 
 #include <libxml/parser.h>
 
-void structuredErrorCallback(void *userData, xmlErrorPtr error)
+#if LIBXML_VERSION >= 21200
+#    define XmlErrorPtr const xmlError *
+#else
+#    define XmlErrorPtr xmlErrorPtr
+#endif
+
+void structuredErrorCallback(void *userData, XmlErrorPtr error)
 {
     if (userData != nullptr && error != nullptr) {
         // Suppress any error messages raised from using LibXml2.
@@ -54,7 +60,6 @@ TEST(Parser, parseValidXmlDirectlyUsingLibxml)
     xmlFreeDoc(doc);
     xmlSetStructuredErrorFunc(nullptr, nullptr);
     xmlCleanupParser();
-    xmlCleanupGlobals();
 }
 
 TEST(Parser, parseInvalidXmlDirectlyUsingLibxml)
@@ -76,7 +81,6 @@ TEST(Parser, parseInvalidXmlDirectlyUsingLibxml)
     xmlFreeParserCtxt(context);
     xmlSetStructuredErrorFunc(nullptr, nullptr);
     xmlCleanupParser();
-    xmlCleanupGlobals();
 
     EXPECT_EQ(nullptr, doc);
 }

tests/parser/parser.cpp

@@ -53,15 +53,27 @@ TEST(Parser, invalidXMLElements)
         "LibXml2 error: EndTag: '</' not found.",
         "Could not get a valid XML root node from the provided input.",
     };
+    const std::vector<std::string> expectedIssues_2_12 = {
+        "LibXml2 error: Specification mandates value for attribute bearded.",
+        "LibXml2 error: Opening and ending tag mismatch: Dwarf line 3 and ShortGuy.",
+        "LibXml2 error: Opening and ending tag mismatch: Hobbit line 4 and EvenShorterGuy.",
+        "LibXml2 error: Opening and ending tag mismatch: Wizard line 5 and SomeGuyWithAStaff.",
+        "LibXml2 error: Opening and ending tag mismatch: Elf line 6 and fellows.",
+        "Could not get a valid XML root node from the provided input.",
+    };
 
     libcellml::ParserPtr p = libcellml::Parser::create();
     p->parseModel(in);
 
-    EXPECT_EQ(expectedIssues_2_2.size(), p->issueCount());
+    EXPECT_TRUE((expectedIssues_2_2.size() == p->issueCount())
+                || (expectedIssues_2_9_10.size() == p->issueCount())
+                || (expectedIssues_2_12.size() == p->issueCount()));
 
     for (size_t i = 0; i < p->issueCount(); ++i) {
         auto message = p->issue(i)->description();
-        EXPECT_TRUE((expectedIssues_2_2.at(i) == message) || (expectedIssues_2_9_10.at(i) == message));
+        EXPECT_TRUE((expectedIssues_2_2.at(i) == message)
+                    || (expectedIssues_2_9_10.at(i) == message)
+                    || (expectedIssues_2_12.at(i) == message));
     }
 }
 
@@ -1861,13 +1873,17 @@ TEST(Parser, parseResets)
     EXPECT_EQ("variable2", v2->name());
 
     std::string testValueString = r->testValue();
-    std::string t =
-        "<math xmlns=\"http://www.w3.org/1998/Math/MathML\"><apply/></math>\n";
+    const std::string t =
+        "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">\n"
+        "          <apply/>\n"
+        "        </math>\n";
     EXPECT_EQ(t, testValueString);
 
     std::string resetValueString = r->resetValue();
-    std::string rt =
-        "<math xmlns=\"http://www.w3.org/1998/Math/MathML\"><apply/></math>\n";
+    const std::string rt =
+        "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">\n"
+        "          <apply/>\n"
+        "        </math>\n";
     EXPECT_EQ(rt, resetValueString);
 }