1 files changed, 114 insertions, 0 deletions
diff --git a/include/test/xmltesttools.hxx b/include/test/xmltesttools.hxx
new file mode 100644
index 0000000000..d18b5d51e8
--- /dev/null
+++ b/include/test/xmltesttools.hxx
@@ -0,0 +1,114 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+#ifndef INCLUDED_TEST_XMLTESTTOOLS_HXX
+#define INCLUDED_TEST_XMLTESTTOOLS_HXX
+
+#include <sal/config.h>
+#include <test/testdllapi.hxx>
+
+#include <libxml/xmlwriter.h>
+#include <libxml/tree.h>
+#include <libxml/xpath.h>
+#include <libxml/xpathInternals.h>
+#include <libxml/parserInternals.h>
+
+#include <rtl/string.hxx>
+#include <rtl/ustring.hxx>
+#include <unotools/tempfile.hxx>
+#include <vcl/mtfxmldump.hxx>
+#include <test/xmldocptr.hxx>
+
+#include <cppunit/TestAssert.h>
+
+#include <string_view>
+#include <vector>
+
+class OOO_DLLPUBLIC_TEST XmlTestTools
+{
+public:
+    /// Return xmlDocPtr representation of the XML stream read from pStream.
+    static xmlDocUniquePtr parseXmlStream(SvStream* pStream);
+
+    static xmlDocUniquePtr dumpAndParse(MetafileXmlDump& rDumper, const GDIMetaFile& rGDIMetaFile);
+
+protected:
+    XmlTestTools();
+    virtual ~XmlTestTools();
+
+    static xmlDocUniquePtr parseXml(utl::TempFileNamed const & aTempFile);
+
+    virtual void registerNamespaces(xmlXPathContextPtr& pXmlXpathCtx);
+
+    // Caller must call xmlXPathFreeObject:
+    xmlXPathObjectPtr getXPathNode(const xmlDocUniquePtr& pXmlDoc, const OString& rXPath);
+    /**
+     * Same as the assertXPath(), but don't assert: return the string instead.
+     */
+    OUString      getXPath(const xmlDocUniquePtr& pXmlDoc, const OString& rXPath, const OString& rAttribute);
+    /**
+     * Same as the assertXPathContent(), but don't assert: return the string instead.
+     */
+    OUString      getXPathContent(const xmlDocUniquePtr& pXmlDoc, const OString& rXPath);
+    /**
+     * Get the position of the child named rName of the parent node specified by rXPath.
+     * Useful for checking relative order of elements.
+     */
+    int           getXPathPosition(const xmlDocUniquePtr& pXmlDoc, const OString& rXPath, std::string_view rChildName);
+    /**
+     * Get the number of the nodes returned by the rXPath.
+     */
+    int           countXPathNodes(const xmlDocUniquePtr& pXmlDoc, const OString& rXPath);
+    /**
+     * Assert that rXPath exists, returns exactly one node, and the rXPath's attribute's value
+     * equals to the rExpected value.
+     */
+    void          assertXPath(const xmlDocUniquePtr& pXmlDoc, const OString& rXPath, const OString& rAttribute,
+                              const OUString& rExpectedValue);
+    void          assertXPathAttrs(const xmlDocUniquePtr& pXmlDoc, const OString& rXPath,
+                          const std::vector<std::pair<OString, OUString>>& aPairVector);
+
+    /**
+     * Given a double for the rExpected value, assert that rXPath exists, returns exactly one node,
+     * and the rXPath's attribute's value matches the rExpected value within tolerance provided
+     * by delta. This is used to account for HiDPI scaling.
+     */
+    void          assertXPathDoubleValue(const xmlDocUniquePtr& pXmlDoc, const OString& rXPath, const OString& rAttribute,
+                              double expectedValue, double delta);
+    /**
+     * Assert that rXPath exists, and returns exactly nNumberOfNodes nodes (1 by default).
+     * Also useful for checking that we do _not_ export some node (nNumberOfNodes == 0).
+     */
+    void          assertXPath(const xmlDocUniquePtr& pXmlDoc, const OString& rXPath, int nNumberOfNodes = 1);
+    /**
+     * Assert that rXPath exists, and its content equals rContent.
+     */
+    void          assertXPathContent(const xmlDocUniquePtr& pXmlDoc, const OString& rXPath, const OUString& rContent);
+    /**
+     * Assert that rXPath exists and it has an rNSPrefix=rNSHref namespace definition.
+     */
+    void          assertXPathNSDef(const xmlDocUniquePtr& pXmlDoc, const OString& rXPath, std::u16string_view rNSPrefix,
+                          std::u16string_view rNSHref);
+    /**
+     * Assert that rXPath exists, and has exactly nNumberOfChildNodes child nodes.
+     * Useful for checking that we do have a no child nodes to a specific node (nNumberOfChildNodes == 0).
+     */
+    void          assertXPathChildren(const xmlDocUniquePtr& pXmlDoc, const OString& rXPath, int nNumberOfChildNodes);
+    /**
+     * Assert that rXPath exists, has exactly 1 result set nodes and does *not* have an attribute named rAttribute.
+     */
+    void          assertXPathNoAttribute(const xmlDocUniquePtr& pXmlDoc, const OString& rXPath, const OString& rAttribute);
+
+    static void registerODFNamespaces(xmlXPathContextPtr& pXmlXpathCtx);
+    static void registerOOXMLNamespaces(xmlXPathContextPtr& pXmlXpathCtx);
+};
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */