Deprecate SAX classes in Qt XML

Deprecated the SAX classes and disabled or replaced their uses in
tests if applicable.

Removed the saxbookmarks example, no point in keeping examples for
the deprecated code.

[ChangeLog][QtXml] SAX classes are now deprecated. Use QXmlStreamReader,
QXmlStreamWriter in QtCore instead.

Task-number: QTBUG-76177
Change-Id: Ic171d62fa0527b0f36f94cf09a69586092269957
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Kai Koehne <kai.koehne@qt.io>

7 files changed, 97 insertions, 48 deletions

diff --git a/tests/auto/corelib/serialization/qxmlstream/tst_qxmlstream.cpp b/tests/auto/corelib/serialization/qxmlstream/tst_qxmlstream.cpp
index 92a0d8bbfa..12279133a2 100644
--- a/tests/auto/corelib/serialization/qxmlstream/tst_qxmlstream.cpp
+++ b/tests/auto/corelib/serialization/qxmlstream/tst_qxmlstream.cpp
@@ -221,7 +221,7 @@ static QString documentElement(const QByteArray &document)
  *
  * See \l {http://www.w3.org/XML/Test/} {Extensible Markup Language (XML) Conformance Test Suites}
  */
-class TestSuiteHandler : public QXmlDefaultHandler
+class TestSuiteHandler
 {
 public:
     /**
@@ -286,29 +286,33 @@ public:
         m_baseURI.push(baseURI);
     }
 
-    virtual bool characters(const QString &chars)
+    bool runTests(QFile *file)
     {
-        m_ch = chars;
-        return true;
+        QXmlStreamReader reader(file);
+        while (!reader.atEnd() && !reader.hasError()) {
+            reader.readNext();
+
+            if (reader.isStartElement() && !startElement(reader.attributes()))
+                return false;
+
+            if (reader.isEndElement() && !endElement(reader.name().toString()))
+                return false;
+        }
+        return !reader.hasError();
     }
 
-    virtual bool startElement(const QString &,
-                              const QString &,
-                              const QString &,
-                              const QXmlAttributes &atts)
+    bool startElement(const QXmlStreamAttributes &atts)
     {
         m_atts.push(atts);
-        const int i = atts.index(QLatin1String("xml:base"));
 
-        if(i != -1)
-            m_baseURI.push(m_baseURI.top().resolved(atts.value(i)));
+        const auto attr = atts.value(QLatin1String("xml:base"));
+        if (!attr.isEmpty())
+            m_baseURI.push(m_baseURI.top().resolved(attr.toString()));
 
         return true;
     }
 
-    virtual bool endElement(const QString &,
-                            const QString &localName,
-                            const QString &)
+    bool endElement(const QString &localName)
     {
         if(localName == QLatin1String("TEST"))
         {
@@ -329,19 +333,19 @@ public:
                 return true;
             }
 
-            const QString inputFilePath(m_baseURI.top().resolved(m_atts.top().value(QString(), QLatin1String("URI")))
-                                                                .toLocalFile());
-            const QString id(m_atts.top().value(QString(), QLatin1String("ID")));
-            const QString type(m_atts.top().value(QString(), QLatin1String("TYPE")));
+            const QString inputFilePath(
+                    m_baseURI.top()
+                            .resolved(
+                                    m_atts.top().value(QString(), QLatin1String("URI")).toString())
+                            .toLocalFile());
+            const QString id(m_atts.top().value(QString(), QLatin1String("ID")).toString());
+            const QString type(m_atts.top().value(QString(), QLatin1String("TYPE")).toString());
 
             QString expectedFilePath;
-            const int index = m_atts.top().index(QString(), QLatin1String("OUTPUT"));
 
-            if(index != -1)
-            {
-                expectedFilePath = m_baseURI.top().resolved(m_atts.top().value(QString(),
-                                                            QLatin1String("OUTPUT"))).toLocalFile();
-            }
+            const auto attr = m_atts.top().value(QString(), QLatin1String("OUTPUT"));
+            if (!attr.isEmpty())
+                expectedFilePath = m_baseURI.top().resolved(attr.toString()).toLocalFile();
 
             /* testcases.dtd: 'No parser should accept a "not-wf" testcase
              * unless it's a nonvalidating parser and the test contains
@@ -349,7 +353,7 @@ public:
              *
              * We also let this apply to "valid", "invalid" and "error" tests, although
              * I'm not fully sure this is correct. */
-            const QString ents(m_atts.top().value(QString(), QLatin1String("ENTITIES")));
+            const QString ents(m_atts.top().value(QString(), QLatin1String("ENTITIES")).toString());
             m_atts.pop();
 
             if(ents == QLatin1String("both") ||
@@ -455,8 +459,8 @@ public:
                 qFatal("The input catalog is invalid.");
                 return false;
             }
-        }
-        else if(localName == QLatin1String("TESTCASES") && m_atts.top().index(QLatin1String("xml:base")) != -1)
+        } else if (localName == QLatin1String("TESTCASES")
+                   && m_atts.top().hasAttribute(QLatin1String("xml:base")))
             m_baseURI.pop();
 
         m_atts.pop();
@@ -516,9 +520,8 @@ public:
     }
 
 private:
-    QStack<QXmlAttributes>  m_atts;
-    QString                 m_ch;
-    QStack<QUrl>            m_baseURI;
+    QStack<QXmlStreamAttributes> m_atts;
+    QStack<QUrl> m_baseURI;
 };
 QT_BEGIN_NAMESPACE
 Q_DECLARE_SHARED(TestSuiteHandler::MissedBaseline)
@@ -592,11 +595,7 @@ void tst_QXmlStream::initTestCase()
     QVERIFY2(file.open(QIODevice::ReadOnly),
              qPrintable(QString::fromLatin1("Failed to open the test suite catalog; %1").arg(file.fileName())));
 
-    QXmlInputSource source(&file);
-    QXmlSimpleReader reader;
-    reader.setContentHandler(&m_handler);
-
-    QVERIFY(reader.parse(&source, false));
+    QVERIFY(m_handler.runTests(&file));
 }
 
 void tst_QXmlStream::cleanupTestCase()
diff --git a/tests/auto/xml/dom/qdom/tst_qdom.cpp b/tests/auto/xml/dom/qdom/tst_qdom.cpp
index ab62307704..a2a5b22cad 100644
--- a/tests/auto/xml/dom/qdom/tst_qdom.cpp
+++ b/tests/auto/xml/dom/qdom/tst_qdom.cpp
@@ -173,7 +173,7 @@ void tst_QDom::setContent_data()
                                    "    </b3>\n"
                                    "</a1>\n");
 
-#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
+#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0) && QT_DEPRECATED_SINCE(5, 15)
     // These configurations cannot be supported by the QXmlStreamReader-based implementation
     QTest::newRow( "02" ) << doc01
                        << QString("http://trolltech.com/xml/features/report-whitespace-only-CharData").split(' ')
@@ -246,7 +246,9 @@ void tst_QDom::setContent()
     QFETCH( QString, doc );
 
     QDomDocument domDoc;
-#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
+#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0) && QT_DEPRECATED_SINCE(5, 15)
+QT_WARNING_PUSH
+QT_WARNING_DISABLE_DEPRECATED
     QXmlInputSource source;
     source.setData( doc );
 
@@ -264,6 +266,7 @@ void tst_QDom::setContent()
     }
 
     QVERIFY( domDoc.setContent( &source, &reader ) );
+QT_WARNING_POP
 #else
     QXmlStreamReader reader(doc);
     QVERIFY(domDoc.setContent(&reader, true));
@@ -1483,7 +1486,7 @@ void tst_QDom::normalizeAttributes() const
     QDomDocument doc;
     QVERIFY(doc.setContent(&buffer, true));
 
-#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
+#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0) && QT_DEPRECATED_SINCE(5, 15)
     QEXPECT_FAIL("", "The parser doesn't perform Attribute Value Normalization. Fixing that would change behavior.", Continue);
 #endif
     QCOMPARE(doc.documentElement().attribute(QLatin1String("attribute")), QString::fromLatin1("a a"));
@@ -1528,7 +1531,10 @@ void tst_QDom::serializeNamespaces() const
 
     QDomDocument doc;
     QByteArray ba(input);
-#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
+#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0) && QT_DEPRECATED_SINCE(5, 15)
+QT_WARNING_PUSH
+QT_WARNING_DISABLE_DEPRECATED
+
     QBuffer buffer(&ba);
     QVERIFY(buffer.open(QIODevice::ReadOnly));
 
@@ -1538,6 +1544,7 @@ void tst_QDom::serializeNamespaces() const
     reader.setFeature("http://xml.org/sax/features/namespace-prefixes", false);
 
     QVERIFY(doc.setContent(&source, &reader));
+QT_WARNING_POP
 #else
     QXmlStreamReader streamReader(input);
     QVERIFY(doc.setContent(&streamReader, true));
@@ -1565,7 +1572,7 @@ void tst_QDom::flagInvalidNamespaces() const
 
     QDomDocument doc;
     QVERIFY(!doc.setContent(QString::fromLatin1(input, true)));
-#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
+#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0) && QT_DEPRECATED_SINCE(5, 15)
     QEXPECT_FAIL("", "The parser doesn't flag identical qualified attribute names. Fixing this would change behavior.", Continue);
 #endif
     QVERIFY(!doc.setContent(QString::fromLatin1(input)));
@@ -1580,7 +1587,9 @@ void tst_QDom::flagUndeclaredNamespace() const
 
     QDomDocument doc;
     QByteArray ba(input);
-#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
+#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0) && QT_DEPRECATED_SINCE(5, 15)
+QT_WARNING_PUSH
+QT_WARNING_DISABLE_DEPRECATED
     QBuffer buffer(&ba);
 
     QVERIFY(buffer.open(QIODevice::ReadOnly));
@@ -1592,6 +1601,7 @@ void tst_QDom::flagUndeclaredNamespace() const
 
     QEXPECT_FAIL("", "The parser doesn't flag not declared prefixes. Fixing this would change behavior.", Continue);
     QVERIFY(!doc.setContent(&source, &reader));
+QT_WARNING_POP
 #else
     QXmlStreamReader streamReader(ba);
     QVERIFY(!doc.setContent(&streamReader, true));
@@ -1662,7 +1672,7 @@ void tst_QDom::reportDuplicateAttributes() const
     QDomDocument dd;
     bool isSuccess = dd.setContent(QLatin1String("<test x=\"1\" x=\"2\"/>"));
 
-#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
+#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0) && QT_DEPRECATED_SINCE(5, 15)
     QEXPECT_FAIL("", "The parser doesn't flag duplicate attributes. Fixing this would change behavior.", Continue);
 #endif
     QVERIFY2(!isSuccess, "Duplicate attributes are well-formedness errors, and should be reported as such.");
@@ -1864,11 +1874,14 @@ void tst_QDom::doubleNamespaceDeclarations() const
     QFile file(testFile);
     QVERIFY(file.open(QIODevice::ReadOnly));
 
-#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
+#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0) && QT_DEPRECATED_SINCE(5, 15)
+QT_WARNING_PUSH
+QT_WARNING_DISABLE_DEPRECATED
     QXmlSimpleReader reader;
 
     QXmlInputSource source(&file);
     QVERIFY(doc.setContent(&source, &reader));
+QT_WARNING_POP
 #else
     QXmlStreamReader streamReader(&file);
     QVERIFY(doc.setContent(&streamReader, true));
@@ -1889,11 +1902,14 @@ void tst_QDom::setContentQXmlReaderOverload() const
 {
     QDomDocument doc;
 
-#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
+#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0) && QT_DEPRECATED_SINCE(5, 15)
+QT_WARNING_PUSH
+QT_WARNING_DISABLE_DEPRECATED
     QXmlSimpleReader reader;
     QXmlInputSource data;
     data.setData(QByteArray("<e/>"));
     doc.setContent(&data, true);
+QT_WARNING_POP
 #else
     QXmlStreamReader streamReader(QByteArray("<e/>"));
     doc.setContent(&streamReader, true);
@@ -1995,7 +2011,7 @@ void tst_QDom::taskQTBUG4595_dontAssertWhenDocumentSpecifiesUnknownEncoding() co
     // QXmlStreamReader fails to read XML documents with unknown encoding. It
     // needs to be modified if we want to support this case with the QXmlStreamReader-based
     // implementation.
-#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
+#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0) && QT_DEPRECATED_SINCE(5, 15)
     QString xmlWithUnknownEncoding("<?xml version='1.0' encoding='unknown-encoding'?>"
                                    "<foo>"
                                    " <bar>How will this sentence be handled?</bar>"
diff --git a/tests/auto/xml/sax/qxml/tst_qxml.cpp b/tests/auto/xml/sax/qxml/tst_qxml.cpp
index 1cdb9701fa..db6584edda 100644
--- a/tests/auto/xml/sax/qxml/tst_qxml.cpp
+++ b/tests/auto/xml/sax/qxml/tst_qxml.cpp
@@ -26,7 +26,6 @@
 **
 ****************************************************************************/
 
-
 #include <QtTest/QtTest>
 
 #include <qcoreapplication.h>
@@ -38,13 +37,17 @@ class tst_QXml : public QObject
 Q_OBJECT
 
 private slots:
+#if QT_DEPRECATED_SINCE(5, 15)
     void getSetCheck();
     void interpretedAs0D() const;
 #ifndef QT_NO_EXCEPTIONS
     void exception();
 #endif
+#endif // QT_DEPRECATED_SINCE(5, 15)
 };
 
+#if QT_DEPRECATED_SINCE(5, 15)
+
 class MyXmlEntityResolver : public QXmlEntityResolver
 {
 public:
@@ -225,5 +228,7 @@ void tst_QXml::exception()
 }
 #endif
 
+#endif // QT_DEPRECATED_SINCE(5, 15)
+
 QTEST_MAIN(tst_QXml)
 #include "tst_qxml.moc"
diff --git a/tests/auto/xml/sax/qxmlinputsource/tst_qxmlinputsource.cpp b/tests/auto/xml/sax/qxmlinputsource/tst_qxmlinputsource.cpp
index d40c8c2fd6..afdcc825d8 100644
--- a/tests/auto/xml/sax/qxmlinputsource/tst_qxmlinputsource.cpp
+++ b/tests/auto/xml/sax/qxmlinputsource/tst_qxmlinputsource.cpp
@@ -45,13 +45,18 @@ class tst_QXmlInputSource : public QObject
 {
     Q_OBJECT
 
+#if QT_DEPRECATED_SINCE(5, 15)
 private slots:
     void reset() const;
     void resetSimplified() const;
     void waitForReadyIODevice() const;
     void inputFromSlowDevice() const;
+#endif // QT_DEPRECATED_SINCE(5, 15)
 };
 
+#if QT_DEPRECATED_SINCE(5, 15)
+QT_WARNING_PUSH
+QT_WARNING_DISABLE_DEPRECATED
 /*!
   \internal
   \since 4.4
@@ -292,5 +297,8 @@ void tst_QXmlInputSource::inputFromSlowDevice() const
     QCOMPARE(data, expectedData);
 }
 
+QT_WARNING_POP
+#endif // QT_DEPRECATED_SINCE(5, 15)
+
 QTEST_MAIN(tst_QXmlInputSource)
 #include "tst_qxmlinputsource.moc"
diff --git a/tests/auto/xml/sax/qxmlsimplereader/parser/parser.cpp b/tests/auto/xml/sax/qxmlsimplereader/parser/parser.cpp
index 556603a681..44f8101955 100644
--- a/tests/auto/xml/sax/qxmlsimplereader/parser/parser.cpp
+++ b/tests/auto/xml/sax/qxmlsimplereader/parser/parser.cpp
@@ -26,12 +26,15 @@
 **
 ****************************************************************************/
 
+#include "parser.h"
+
+#if QT_DEPRECATED_SINCE(5, 15)
 
 #include <qxml.h>
 #include <qregularexpression.h>
 
-#include "parser.h"
-
+QT_WARNING_PUSH
+QT_WARNING_DISABLE_DEPRECATED
 class ContentHandler : public QXmlDefaultHandler
 {
 public:
@@ -440,3 +443,6 @@ QString Parser::errorMsg() const
 {
     return handler->errorMsg();
 }
+
+QT_WARNING_POP
+#endif // QT_DEPRECATED_SINCE(5, 15)
diff --git a/tests/auto/xml/sax/qxmlsimplereader/parser/parser.h b/tests/auto/xml/sax/qxmlsimplereader/parser/parser.h
index 604678f06b..9c51cdf095 100644
--- a/tests/auto/xml/sax/qxmlsimplereader/parser/parser.h
+++ b/tests/auto/xml/sax/qxmlsimplereader/parser/parser.h
@@ -28,6 +28,10 @@
 #ifndef PARSER_H
 #define PARSER_H
 
+#include <qglobal.h>
+
+#if QT_DEPRECATED_SINCE(5, 15)
+
 #include <qfile.h>
 #include <qstring.h>
 #include <qxml.h>
@@ -48,4 +52,6 @@ private:
     ContentHandler *handler;
 };
 
+#endif // QT_DEPRECATED_SINCE(5, 15)
+
 #endif
diff --git a/tests/auto/xml/sax/qxmlsimplereader/tst_qxmlsimplereader.cpp b/tests/auto/xml/sax/qxmlsimplereader/tst_qxmlsimplereader.cpp
index 8c4c6c7179..cea4e3c8b8 100644
--- a/tests/auto/xml/sax/qxmlsimplereader/tst_qxmlsimplereader.cpp
+++ b/tests/auto/xml/sax/qxmlsimplereader/tst_qxmlsimplereader.cpp
@@ -127,6 +127,7 @@ class tst_QXmlSimpleReader : public QObject
 {
     Q_OBJECT
 
+#if QT_DEPRECATED_SINCE(5, 15)
     public:
         tst_QXmlSimpleReader();
         ~tst_QXmlSimpleReader();
@@ -157,8 +158,13 @@ class tst_QXmlSimpleReader : public QObject
         static QDomDocument fromByteArray(const QString &title, const QByteArray &ba, bool *ok);
         XmlServer *server;
         QString prefix;
+#endif // QT_DEPRECATED_SINCE(5, 15)
 };
 
+#if QT_DEPRECATED_SINCE(5, 15)
+QT_WARNING_PUSH
+QT_WARNING_DISABLE_DEPRECATED
+
 tst_QXmlSimpleReader::tst_QXmlSimpleReader() : server(new XmlServer(this))
 {
     server->start();
@@ -820,5 +826,8 @@ void tst_QXmlSimpleReader::dtdRecursionLimit()
     }
 }
 
+QT_WARNING_POP
+#endif // QT_DEPRECATED_SINCE(5, 15)
+
 QTEST_MAIN(tst_QXmlSimpleReader)
 #include "tst_qxmlsimplereader.moc"