Scripting: qet.currentFolio(), and one undo step per script run in the editor

A script started from the editor had no way to know which folio is on screen, and each qet.* call was its own undo step, so a script that adds twenty items needed twenty Ctrl+Z to take back. qet.currentFolio() returns the folio shown in the editor; through --run, which has no view, the first folio, or -1 when there is none. A run from the editor is now one undo macro, named after the script. A run that changed nothing leaves no empty entry behind. qet.undo() and qet.redo() inside a grouped run say why they cannot work (QUndoStack ignores them inside a macro) instead of failing silently. --run is unchanged: one step per call, so scripts that call qet.undo() keep working. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-03 09:14:12 +02:00 · 2026-10-02 08:47:23 +13:00
parent b6495b51a6
commit 1c1f9db3eb
6 changed files with 192 additions and 2 deletions
@@ -0,0 +1,109 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+#include <QtTest>
+
+#include <QFile>
+#include <QJsonDocument>
+#include <QJsonObject>
+#include <QProcess>
+#include <QProcessEnvironment>
+#include <QTemporaryDir>
+
+// qet.currentFolio() is the folio on screen in the editor. Through --run
+// there is none, so it stands in with the first folio, or -1 when the
+// project has no folio. --run also keeps one undo step per call: only a run
+// started from the editor is grouped into one, and a headless script that
+// calls qet.undo() itself must go on working.
+class tst_scriptcurrentfolio : public QObject
+{
+	Q_OBJECT
+
+	QTemporaryDir m_dir;
+
+	// Run @p script on @p project in a sandbox of its own and return the
+	// JSON object it logged.
+	QJsonObject run(const QString &script, const QString &project)
+	{
+		const QString path = m_dir.filePath(QStringLiteral("probe.js"));
+		const QString home = m_dir.filePath(QStringLiteral("home"));
+		QDir().mkpath(home);
+		QFile f(path);
+		if (!f.open(QIODevice::WriteOnly)) return {};
+		f.write(script.toUtf8());
+		f.close();
+
+		QProcessEnvironment env = QProcessEnvironment::systemEnvironment();
+		env.insert(QStringLiteral("QT_QPA_PLATFORM"), QStringLiteral("offscreen"));
+		env.insert(QStringLiteral("QET_ENABLE_SCRIPTING"), QStringLiteral("1"));
+		env.insert(QStringLiteral("HOME"), home);
+		env.insert(QStringLiteral("XDG_CONFIG_HOME"), home + QStringLiteral("/config"));
+		env.insert(QStringLiteral("XDG_DATA_HOME"), home + QStringLiteral("/data"));
+		env.insert(QStringLiteral("TMPDIR"), m_dir.path());
+		QProcess proc;
+		proc.setProcessEnvironment(env);
+		proc.start(QStringLiteral(QET_TEST_BINARY_PATH),
+				   {QStringLiteral("--run"), path, project});
+		if (!proc.waitForFinished(120000)) return {};
+		const QString out = QString::fromUtf8(proc.readAllStandardOutput()
+											  + proc.readAllStandardError());
+		const QString mark = QStringLiteral("PROBE ");
+		for (const QString &line : out.split(QLatin1Char('\n'))) {
+			const int i = line.indexOf(mark);
+			if (i >= 0)
+				return QJsonDocument::fromJson(line.mid(i + mark.size()).toUtf8()).object();
+		}
+		return {};
+	}
+
+private slots:
+	void initTestCase()
+	{
+		QVERIFY(m_dir.isValid());
+		QVERIFY(QFile::exists(QStringLiteral(QET_TEST_BINARY_PATH)));
+	}
+
+	void firstFolioWithoutAView()
+	{
+		const QJsonObject r = run(QStringLiteral(
+			"qet.log('PROBE ' + JSON.stringify({current: qet.currentFolio(),\n"
+			"  folios: qet.folioCount()}));\n"),
+			QStringLiteral(QET_EXAMPLES_DIR "/perceuse.qet"));
+		QVERIFY2(!r.isEmpty(), "the script logged nothing");
+		QVERIFY(r.value(QStringLiteral("folios")).toInt() > 1);
+		QCOMPARE(r.value(QStringLiteral("current")).toInt(), 0);
+	}
+
+	void noFolioIsMinusOne()
+	{
+		const QString project = m_dir.filePath(QStringLiteral("empty.qet"));
+		QFile out(project);
+		QVERIFY(out.open(QIODevice::WriteOnly));
+		out.write("<project version=\"0.100.0\" title=\"empty\">\n</project>\n");
+		out.close();
+
+		const QJsonObject r = run(QStringLiteral(
+			"qet.log('PROBE ' + JSON.stringify({current: qet.currentFolio(),\n"
+			"  folios: qet.folioCount()}));\n"), project);
+		QVERIFY2(!r.isEmpty(), "the script logged nothing");
+		QCOMPARE(r.value(QStringLiteral("folios")).toInt(), 0);
+		QCOMPARE(r.value(QStringLiteral("current")).toInt(), -1);
+	}
+
+	void headlessUndoStaysPerCall()
+	{
+		const QJsonObject r = run(QStringLiteral(
+			"var f = qet.currentFolio();\n"
+			"var before = qet.texts(f).length;\n"
+			"qet.addText(f, 'one', 40, 40);\n"
+			"qet.addText(f, 'two', 40, 80);\n"
+			"var undone = qet.undo();\n"
+			"qet.log('PROBE ' + JSON.stringify({undone: undone,\n"
+			"  added: qet.texts(f).length - before}));\n"),
+			QStringLiteral(QET_EXAMPLES_DIR "/perceuse.qet"));
+		QVERIFY2(!r.isEmpty(), "the script logged nothing");
+		QCOMPARE(r.value(QStringLiteral("undone")).toBool(), true);
+		QCOMPARE(r.value(QStringLiteral("added")).toInt(), 1);
+	}
+};
+
+QTEST_MAIN(tst_scriptcurrentfolio)
+#include "tst_scriptcurrentfolio.moc"