From b149f5d77a3c362af1e82e95ddf0ae13954d2538 Mon Sep 17 00:00:00 2001
From: Shawn Rutledge <shawn.rutledge@qt.io>
Date: Sat, 25 May 2019 12:09:53 +0200
Subject: Overload QTextBrowser::setSource() to add optional type argument

Now that it's trying to guess whether the type is markdown based on
the file extension, there needs to be a way to override it. For example
it might be arranged that directory listings will be generated in
markdown format instead of HTML; then when loading a source URL that
is a directory, the application may override the type. The type for
the single-argument setSource(url) is UnknownResource to preserve
the existing behavior, but the user can override the guessing by
setting a specific type.

Change-Id: Id111efd24de7d8fd18c47b16a2d58f5b09d77891
Reviewed-by: Gatis Paeglis <gatis.paeglis@qt.io>
---
 .../auto/widgets/widgets/qtextbrowser/heading.html |  2 +
 .../widgets/widgets/qtextbrowser/markdown.really   |  2 +
 .../widgets/widgets/qtextbrowser/qtextbrowser.pro  |  2 +-
 .../widgets/qtextbrowser/tst_qtextbrowser.cpp      | 45 +++++++++++++++++-----
 4 files changed, 41 insertions(+), 10 deletions(-)
 create mode 100644 tests/auto/widgets/widgets/qtextbrowser/heading.html
 create mode 100644 tests/auto/widgets/widgets/qtextbrowser/markdown.really

(limited to 'tests')

diff --git a/tests/auto/widgets/widgets/qtextbrowser/heading.html b/tests/auto/widgets/widgets/qtextbrowser/heading.html
new file mode 100644
index 0000000000..8b23807f65
--- /dev/null
+++ b/tests/auto/widgets/widgets/qtextbrowser/heading.html
@@ -0,0 +1,2 @@
+<h3>this is a heading</h3>
+<p>this is a paragraph</p>
diff --git a/tests/auto/widgets/widgets/qtextbrowser/markdown.really b/tests/auto/widgets/widgets/qtextbrowser/markdown.really
new file mode 100644
index 0000000000..be56aef234
--- /dev/null
+++ b/tests/auto/widgets/widgets/qtextbrowser/markdown.really
@@ -0,0 +1,2 @@
+### this is a heading
+this is a paragraph
diff --git a/tests/auto/widgets/widgets/qtextbrowser/qtextbrowser.pro b/tests/auto/widgets/widgets/qtextbrowser/qtextbrowser.pro
index 05c156bf59..dfdcf26497 100644
--- a/tests/auto/widgets/widgets/qtextbrowser/qtextbrowser.pro
+++ b/tests/auto/widgets/widgets/qtextbrowser/qtextbrowser.pro
@@ -4,6 +4,6 @@ SOURCES += tst_qtextbrowser.cpp
 
 QT += widgets testlib
 
-TESTDATA += *.html *.md subdir/*
+TESTDATA += *.html *.md markdown.really subdir/*
 
 builtin_testdata: DEFINES += BUILTIN_TESTDATA
diff --git a/tests/auto/widgets/widgets/qtextbrowser/tst_qtextbrowser.cpp b/tests/auto/widgets/widgets/qtextbrowser/tst_qtextbrowser.cpp
index 22cd3b46c6..083e297941 100644
--- a/tests/auto/widgets/widgets/qtextbrowser/tst_qtextbrowser.cpp
+++ b/tests/auto/widgets/widgets/qtextbrowser/tst_qtextbrowser.cpp
@@ -92,7 +92,8 @@ private slots:
     void focusIndicator();
     void focusHistory();
     void urlEncoding();
-    void markdown();
+    void sourceType_data();
+    void sourceType();
 
 private:
     TestBrowser *browser;
@@ -679,19 +680,45 @@ void tst_QTextBrowser::urlEncoding()
     delete browser;
 }
 
-void tst_QTextBrowser::markdown()
+void tst_QTextBrowser::sourceType_data()
 {
-    browser->setSource(QUrl::fromLocalFile(QFINDTESTDATA("markdown.md")));
+    QTest::addColumn<QString>("sourceFile");
+    QTest::addColumn<QTextDocument::ResourceType>("sourceType");
+    QTest::addColumn<int>("expectedMaxHeadingLevel");
+    QTest::addColumn<QTextDocument::ResourceType>("expectedSourceType");
+
+#if QT_CONFIG(textmarkdownreader)
+    const int maxMdHeadingLevel = 3;
+    const QTextDocument::ResourceType mdExpectedType = QTextDocument::MarkdownResource;
+#else
+    // If Qt doesn't support markdown, and we read a MD document anyway, it won't have any H3's.
+    const int maxMdHeadingLevel = 0;
+    const QTextDocument::ResourceType mdExpectedType = QTextDocument::HtmlResource;
+#endif
+    QTest::newRow("markdown detected") << "markdown.md" << QTextDocument::UnknownResource << maxMdHeadingLevel << mdExpectedType;
+    QTest::newRow("markdown specified") << "markdown.really" << QTextDocument::MarkdownResource << maxMdHeadingLevel << mdExpectedType;
+    QTest::newRow("markdown not identified") << "markdown.really" << QTextDocument::UnknownResource << 0 << QTextDocument::HtmlResource;
+    QTest::newRow("html detected") << "heading.html" << QTextDocument::UnknownResource << 3 << QTextDocument::HtmlResource;
+    QTest::newRow("html specified") << "heading.html" << QTextDocument::HtmlResource << 3 << QTextDocument::HtmlResource;
+}
+
+void tst_QTextBrowser::sourceType()
+{
+    QFETCH(QString, sourceFile);
+    QFETCH(QTextDocument::ResourceType, sourceType);
+    QFETCH(int, expectedMaxHeadingLevel);
+    QFETCH(QTextDocument::ResourceType, expectedSourceType);
+    if (sourceType == QTextDocument::UnknownResource)
+        // verify that the property setter works, with its default parameter for sourceType
+        browser->setProperty("source", QUrl::fromLocalFile(QFINDTESTDATA(sourceFile)));
+    else
+        browser->setSource(QUrl::fromLocalFile(QFINDTESTDATA(sourceFile)), sourceType);
+    QCOMPARE(browser->sourceType(), expectedSourceType);
     QTextFrame::iterator iterator = browser->document()->rootFrame()->begin();
     int maxHeadingLevel = -1;
     while (!iterator.atEnd())
         maxHeadingLevel = qMax(iterator++.currentBlock().blockFormat().intProperty(QTextFormat::HeadingLevel), maxHeadingLevel);
-#if QT_CONFIG(textmarkdownreader)
-    QCOMPARE(maxHeadingLevel, 3);
-#else
-    // If Qt doesn't support markdown, this document will be misidentified as HTML, so it won't have any H3's.
-    QCOMPARE(maxHeadingLevel, 0);
-#endif
+    QCOMPARE(maxHeadingLevel, expectedMaxHeadingLevel);
 }
 
 QTEST_MAIN(tst_QTextBrowser)
-- 
cgit v1.2.3