Merge pull request OpenEnroth#1543 from captainurist/macos_fixes_485

Test for OpenEnroth#1535
pskelton · Mar 15, 2024 · a2e1764 · a2e1764
2 parents 00d125f + 9304566
commit a2e1764
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 15 deletions.
diff --git a/src/Engine/Spells/CastSpellInfo.cpp b/src/Engine/Spells/CastSpellInfo.cpp
@@ -2987,12 +2987,6 @@ void CastSpellInfoHelpers::cancelSpellCastInProgress() {
     }
 }
 
-void CastSpellInfoHelpers::clearSpellQueue() {
-    for (CastSpellInfo& spellInfo : pCastSpellInfo) {  // cycle through spell queue
-        spellInfo = CastSpellInfo();
-    }
-}
-
 void pushSpellOrRangedAttack(SpellId spell,
                              int casterIndex,
                              CombinedSkillValue skill_value,

diff --git a/src/Engine/Spells/CastSpellInfo.h b/src/Engine/Spells/CastSpellInfo.h
@@ -25,11 +25,6 @@ namespace CastSpellInfoHelpers {
      * @offset 0x00427D48
      */
     void cancelSpellCastInProgress();
-
-    /**
-     * Clear queue
-     */
-    void clearSpellQueue();
 };  // namespace CastSpellInfoHelpers
 
 class GUIWindow;

diff --git a/src/GUI/GUIMessageQueue.cpp b/src/GUI/GUIMessageQueue.cpp
@@ -7,6 +7,12 @@ void GUIFrameMessageQueue::clear() {
 }
 
 void GUIFrameMessageQueue::popMessage(UIMessageType *msg, int *param, int *param2) {
+    peekMessage(msg, param, param2);
+    if (!messageQueue.empty())
+        messageQueue.pop();
+}
+
+void GUIFrameMessageQueue::peekMessage(UIMessageType *msg, int *param, int *param2) {
     assert(msg != nullptr);
 
     *msg = UIMSG_Invalid;
@@ -21,8 +27,7 @@ void GUIFrameMessageQueue::popMessage(UIMessageType *msg, int *param, int *param
         return;
     }
 
-    GUIMessage message = messageQueue.front();
-    messageQueue.pop();
+    const GUIMessage &message = messageQueue.front();
 
     *msg = message.type;
     if (param) {

diff --git a/src/GUI/GUIMessageQueue.h b/src/GUI/GUIMessageQueue.h
@@ -18,6 +18,7 @@ struct GUIFrameMessageQueue {
     void clear();
     bool empty() { return messageQueue.empty(); }
     void popMessage(UIMessageType *msg, int *param, int *param2);
+    void peekMessage(UIMessageType *msg, int *param, int *param2);
     void addGUIMessage(UIMessageType msg, int param, int param2);
 
     std::queue<GUIMessage> messageQueue;
@@ -57,6 +58,10 @@ class GUIMessageQueue {
         _currentFrameQueue.popMessage(msg, param, param2);
     }
 
+    void peekMessage(UIMessageType *msg, int *param, int *param2) {
+        _currentFrameQueue.peekMessage(msg, param, param2);
+    }
+
  private:
     GUIFrameMessageQueue _currentFrameQueue;
     GUIFrameMessageQueue _nextFrameQueue;

diff --git a/test/Bin/GameTest/GameTests_1500.cpp b/test/Bin/GameTest/GameTests_1500.cpp
@@ -2,6 +2,7 @@
 
 #include "Testing/Game/GameTest.h"
 
+#include "Engine/Engine.h"
 #include "Engine/mm7_data.h"
 #include "Engine/Party.h"
 #include "GUI/GUIWindow.h"
@@ -24,3 +25,27 @@ GAME_TEST(Issues, Issue1510) {
     EXPECT_LT(partyHealth.back(), partyHealth.front());
     EXPECT_LE(actorDistTape.max(), meleeRange);
 }
+
+GAME_TEST(Issues, Issue1535) {
+    // Queued messages stay in the event queue and roll over between tests.
+    game.startNewGame();
+    engine->config->debug.AllMagic.setValue(true);
+
+    game.pressGuiButton("Game_CastSpell");
+    game.tick(1);
+    game.pressGuiButton("SpellBook_Spell8"); // 8 is meteor shower.
+    game.tick(1);
+    game.pressGuiButton("SpellBook_Spell8"); // Confirm.
+    game.tick(1);
+
+    // Should have put the spell cast message to queue.
+    UIMessageType message = UIMSG_Invalid;
+    int spell = 0;
+    engine->_messageQueue->peekMessage(&message, &spell, nullptr);
+    EXPECT_EQ(message, UIMSG_CastSpellFromBook);
+    EXPECT_EQ(spell, std::to_underlying(SPELL_FIRE_METEOR_SHOWER));
+
+    // Then we start a new test.
+    test.prepareForNextTest(); // This call used to assert.
+    EXPECT_FALSE(engine->_messageQueue->haveMessages()); // Please don't roll over the messages between tests!
+}
diff --git a/test/Testing/Game/TestController.cpp b/test/Testing/Game/TestController.cpp
@@ -133,9 +133,8 @@ void TestController::prepareForNextTestInternal() {
     ::application->component<GameKeyboardController>()->reset();
     ::application->component<EngineDeterministicComponent>()->restart(frameTimeMs, rngType);
 
-    // Clear the spell/message queue, otherwise spells can roll over between test runs.
+    // Clear the message queue, otherwise spells can roll over between test runs.
     // TODO(captainurist): this should really happen somewhere in the main loop. When new game is started, or a save is loaded.
-    CastSpellInfoHelpers::clearSpellQueue();
     engine->_messageQueue->clear();
 
     _controller->goToMainMenu();