From 7205b15e0c2cb4faf1ba41716a21187a0a2fc184 Mon Sep 17 00:00:00 2001
From: Neil <nyamatongwe@gmail.com>
Date: Mon, 29 Jan 2024 19:57:31 +1100
Subject: Add tests for container undo actions, checking that they coalesce
 when required.

---
 test/unit/testCellBuffer.cxx | 69 +++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 68 insertions(+), 1 deletion(-)

(limited to 'test')

diff --git a/test/unit/testCellBuffer.cxx b/test/unit/testCellBuffer.cxx
index 510a1c097..8e9711843 100644
--- a/test/unit/testCellBuffer.cxx
+++ b/test/unit/testCellBuffer.cxx
@@ -211,7 +211,8 @@ TEST_CASE("CellBuffer") {
 }
 
 bool Equal(const Action &a, ActionType at, Sci::Position position, std::string_view value) noexcept {
-	// Currently ignores mayCoalesce
+	// Currently ignores mayCoalesce since this is not set consistently when following
+	// start action implies it.
 	if (a.at != at)
 		return false;
 	if (a.position != position)
@@ -223,6 +224,19 @@ bool Equal(const Action &a, ActionType at, Sci::Position position, std::string_v
 	return true;
 }
 
+bool EqualContainerAction(const Action &a, Sci::Position token) noexcept {
+	// Currently ignores mayCoalesce
+	if (a.at != ActionType::container)
+		return false;
+	if (a.position != token)
+		return false;
+	if (a.lenData != 0)
+		return false;
+	if (a.data)
+		return false;
+	return true;
+}
+
 void TentativeUndo(UndoHistory &uh) {
 	const int steps = uh.TentativeSteps();
 	for (int step = 0; step < steps; step++) {
@@ -337,6 +351,59 @@ TEST_CASE("UndoHistory") {
 
 	}
 
+	SECTION("CoalesceContainer") {
+		bool startSequence = false;
+		const char *val = uh.AppendAction(ActionType::insert, 0, "ab", 2, startSequence, true);
+		REQUIRE(memcmp(val, "ab", 2) == 0);
+		REQUIRE(startSequence);
+		val = uh.AppendAction(ActionType::container, 1000, nullptr, 0, startSequence, true);
+		REQUIRE(!startSequence);
+		// container actions do not have text data, just the token store in position
+		REQUIRE(!val);
+		val = uh.AppendAction(ActionType::container, 1001, nullptr, 0, startSequence, true);
+		REQUIRE(!startSequence);
+		// This is a coalescible change since the container actions are skipped to determine compatibility
+		val = uh.AppendAction(ActionType::insert, 2, "cd", 2, startSequence, true);
+		REQUIRE(memcmp(val, "cd", 2) == 0);
+		REQUIRE(!startSequence);
+		// Break the sequence with a non-coalescible container action
+		val = uh.AppendAction(ActionType::container, 1002, nullptr, 0, startSequence, false);
+		REQUIRE(startSequence);
+
+		{
+			const int steps = uh.StartUndo();
+			REQUIRE(steps == 1);
+			const Action &actionContainer = uh.GetUndoStep();
+			REQUIRE(EqualContainerAction(actionContainer, 1002));
+			REQUIRE(actionContainer.mayCoalesce == false);
+			uh.CompletedUndoStep();
+		}
+		{
+			const int steps = uh.StartUndo();
+			REQUIRE(steps == 4);
+			const Action &actionInsert = uh.GetUndoStep();
+			REQUIRE(Equal(actionInsert, ActionType::insert, 2, "cd"));
+			uh.CompletedUndoStep();
+			{
+				const Action &actionContainer = uh.GetUndoStep();
+				REQUIRE(EqualContainerAction(actionContainer, 1001));
+				uh.CompletedUndoStep();
+			}
+			{
+				const Action &actionContainer = uh.GetUndoStep();
+				REQUIRE(EqualContainerAction(actionContainer, 1000));
+				uh.CompletedUndoStep();
+			}
+			{
+				const Action &actionInsert1 = uh.GetUndoStep();
+				REQUIRE(Equal(actionInsert1, ActionType::insert, 0, "ab"));
+				uh.CompletedUndoStep();
+			}
+		}
+		// Reached beginning
+		REQUIRE(!uh.CanUndo());
+	}
+
 	SECTION("Grouping") {
 
 		uh.BeginUndoAction();
-- 
cgit v1.2.3