summaryrefslogtreecommitdiffstats
path: root/tests/auto
diff options
context:
space:
mode:
authorShawn Rutledge <shawn.rutledge@qt.io>2022-02-18 21:58:35 +0100
committerShawn Rutledge <shawn.rutledge@qt.io>2022-05-19 14:43:39 +0200
commit04a60bb033f57099b048b0d6f99f68a08dcd1483 (patch)
treea0edf200b7f289f7c33d58aabdd0f144c3482e43 /tests/auto
parent53604df833c3cb99375763dfd7a068ac61ef8eb2 (diff)
Convert <pre> to Markdown ``` and vice-versa with nonBreakableLines
The HTML parser calls QTextBlockFormat::setNonBreakableLines(true) when it sees a <pre> tag; so for symmetry, the markdown reader now does the same when it sees a fenced code block, and the markdown writer honors the nonBreakableLines property by writing a fenced code block. This preserves the meaning better when reading HTML and writing markdown or vice-versa, without modifying HTML reading or writing code. Added a test tst_QTextMarkdownImporter::fencedCodeBlocks() which unfortunately also highlights a known bug in the markdown reader: each fenced code block ends with an extra empty block. That can be fixed separately. tst_QTextMarkdownWriter::fromHtml(preformats with embedded backticks) that we re-enabled in 1abaf9d5d6ea9c6554362e851903ddd214a6f659 was not a very useful test: ``` with a space and some words but no newline is not a fence: it's just like a `monospace` span. We have had trouble with those in CI because of missing monospace fonts, or inconsistency when a supposedly mono font's QFontInfo::fixedPitch() returns false. So just test proper <pre>/fence conversion for now. Pick-to: 6.3 Fixes: QTBUG-100515 Fixes: QTBUG-100981 Task-number: QTBUG-101031 Change-Id: I88f0ede0810d8a9480b30eb0cd780e1af67cc5f2 Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
Diffstat (limited to 'tests/auto')
-rw-r--r--tests/auto/gui/text/qtextmarkdownimporter/tst_qtextmarkdownimporter.cpp75
-rw-r--r--tests/auto/gui/text/qtextmarkdownwriter/tst_qtextmarkdownwriter.cpp4
2 files changed, 77 insertions, 2 deletions
diff --git a/tests/auto/gui/text/qtextmarkdownimporter/tst_qtextmarkdownimporter.cpp b/tests/auto/gui/text/qtextmarkdownimporter/tst_qtextmarkdownimporter.cpp
index 87a8f4aa89..b8d53ca194 100644
--- a/tests/auto/gui/text/qtextmarkdownimporter/tst_qtextmarkdownimporter.cpp
+++ b/tests/auto/gui/text/qtextmarkdownimporter/tst_qtextmarkdownimporter.cpp
@@ -41,6 +41,8 @@ private slots:
void fragmentsAndProperties();
void pathological_data();
void pathological();
+ void fencedCodeBlocks_data();
+ void fencedCodeBlocks();
private:
bool isMainFontFixed();
@@ -490,5 +492,78 @@ void tst_QTextMarkdownImporter::pathological() // avoid crashing on crazy input
QTextDocument().setMarkdown(f.readAll());
}
+void tst_QTextMarkdownImporter::fencedCodeBlocks_data()
+{
+ QTest::addColumn<QString>("input");
+ QTest::addColumn<int>("expectedCodeBlockCount");
+ QTest::addColumn<int>("expectedPlainBlockCount");
+ QTest::addColumn<QString>("expectedLanguage");
+ QTest::addColumn<QString>("expectedFenceChar");
+ QTest::addColumn<QString>("rewrite");
+
+ // TODO shouldn't add empty blocks: QTBUG-101031
+ QTest::newRow("backtick fence with language")
+ << "```pseudocode\nprint('hello world\\n')\n```\n"
+ << 2 << 0 << "pseudocode" << "`"
+ << "```pseudocode\nprint('hello world\\n')\n```\n\n";
+ QTest::newRow("tilde fence with language")
+ << "~~~pseudocode\nprint('hello world\\n')\n~~~\n"
+ << 2 << 0 << "pseudocode" << "~"
+ << "~~~pseudocode\nprint('hello world\\n')\n~~~\n\n";
+ QTest::newRow("embedded backticks")
+ << "```\nnone `one` ``two``\n```\nplain\n```\n```three``` ````four````\n```\nplain\n"
+ << 4 << 2 << QString() << "`"
+ << "```\nnone `one` ``two``\n```\nplain\n\n```\n```three``` ````four````\n```\nplain\n\n";
+}
+
+void tst_QTextMarkdownImporter::fencedCodeBlocks()
+{
+ QFETCH(QString, input);
+ QFETCH(int, expectedCodeBlockCount);
+ QFETCH(int, expectedPlainBlockCount);
+ QFETCH(QString, expectedLanguage);
+ QFETCH(QString, expectedFenceChar);
+ QFETCH(QString, rewrite);
+
+ QTextDocument doc;
+ doc.setMarkdown(input);
+
+#ifdef DEBUG_WRITE_HTML
+ {
+ QFile out("/tmp/" + QLatin1String(QTest::currentDataTag()) + ".html");
+ out.open(QFile::WriteOnly);
+ out.write(doc.toHtml().toLatin1());
+ out.close();
+ }
+#endif
+
+ QTextFrame::iterator iterator = doc.rootFrame()->begin();
+ QTextFrame *currentFrame = iterator.currentFrame();
+ int codeBlockCount = 0;
+ int plainBlockCount = 0;
+ while (!iterator.atEnd()) {
+ // There are no child frames
+ QCOMPARE(iterator.currentFrame(), currentFrame);
+ // Check whether the block is code or plain
+ QTextBlock block = iterator.currentBlock();
+ const bool codeBlock = block.blockFormat().hasProperty(QTextFormat::BlockCodeFence);
+ QCOMPARE(block.blockFormat().nonBreakableLines(), codeBlock);
+ QCOMPARE(block.blockFormat().stringProperty(QTextFormat::BlockCodeLanguage), codeBlock ? expectedLanguage : QString());
+ if (codeBlock) {
+ QCOMPARE(block.blockFormat().stringProperty(QTextFormat::BlockCodeFence), expectedFenceChar);
+ ++codeBlockCount;
+ } else {
+ ++plainBlockCount;
+ }
+ qCDebug(lcTests) << (codeBlock ? "code" : "text") << block.text() << block.charFormat().fontFamilies();
+ ++iterator;
+ }
+ QCOMPARE(codeBlockCount, expectedCodeBlockCount);
+ QCOMPARE(plainBlockCount, expectedPlainBlockCount);
+ if (doc.toMarkdown() != rewrite && isMainFontFixed())
+ QEXPECT_FAIL("", "fixed-pitch main font (QTBUG-103484)", Continue);
+ QCOMPARE(doc.toMarkdown(), rewrite);
+}
+
QTEST_MAIN(tst_QTextMarkdownImporter)
#include "tst_qtextmarkdownimporter.moc"
diff --git a/tests/auto/gui/text/qtextmarkdownwriter/tst_qtextmarkdownwriter.cpp b/tests/auto/gui/text/qtextmarkdownwriter/tst_qtextmarkdownwriter.cpp
index b9230be465..c5e4829533 100644
--- a/tests/auto/gui/text/qtextmarkdownwriter/tst_qtextmarkdownwriter.cpp
+++ b/tests/auto/gui/text/qtextmarkdownwriter/tst_qtextmarkdownwriter.cpp
@@ -500,8 +500,8 @@ void tst_QTextMarkdownWriter::fromHtml_data()
// "<p>(The first sentence of this paragraph is a line, the next paragraph has a number</p>13) but that's not part of an ordered list" <<
// "(The first sentence of this paragraph is a line, the next paragraph has a number\n\n13\\) but that's not part of an ordered list\n\n";
QTest::newRow("preformats with embedded backticks") <<
- "<pre>none `one` ``two``</pre><pre>```three``` ````four````</pre>plain" <<
- "``` none `one` ``two`` ```\n\n````` ```three``` ````four```` `````\n\nplain\n\n";
+ "<pre>none `one` ``two``</pre>plain<pre>```three``` ````four````</pre>plain" <<
+ "```\nnone `one` ``two``\n\n```\nplain\n\n```\n```three``` ````four````\n\n```\nplain\n\n";
}
void tst_QTextMarkdownWriter::fromHtml()