phosit
f9114a87f2
When calling `Engine.PushGuiPage` a promise is returned. The promise is
settled when the "child" page is closed. That allows to `await` it
inside `async` functions.
Previously the callback was run right inside the call to
`Engine.PopGuiPage`. Now the continuation of the promise is called at
the end of the "tick".
This won't help performance. It will more likely make things worse.
Since gui pages aren't opened or closed that frequently, it doesn't
matter that much.
Refs: 86c151ebaa
For the engine side:
The promise is stored in the `CGUIManager::SGUIPage` (like previously
the callback). When the promise is fulfilled it enqueues a callback in
the `JobQueue` of the `JSContext`.
Original patch by: @wraitii
Comments by: @wraitii, @Stan, @Polakrity, @lyv, @elexis, @vladislavbelov
Differential Revision: https://code.wildfiregames.com/D3807
This was SVN commit r28145.
237 lines
8.2 KiB
C++
237 lines
8.2 KiB
C++
/* Copyright (C) 2024 Wildfire Games.
|
|
* This file is part of 0 A.D.
|
|
*
|
|
* 0 A.D. is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* 0 A.D. is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#include "lib/self_test.h"
|
|
|
|
#include "gui/GUIManager.h"
|
|
|
|
#include "gui/CGUI.h"
|
|
#include "lib/external_libraries/libsdl.h"
|
|
#include "ps/ConfigDB.h"
|
|
#include "ps/Filesystem.h"
|
|
#include "ps/GameSetup/GameSetup.h"
|
|
#include "ps/Hotkey.h"
|
|
#include "ps/XML/Xeromyces.h"
|
|
#include "scriptinterface/ScriptContext.h"
|
|
#include "scriptinterface/ScriptRequest.h"
|
|
#include "scriptinterface/ScriptInterface.h"
|
|
#include "scriptinterface/StructuredClone.h"
|
|
#include "scriptinterface/Object.h"
|
|
|
|
#include <memory>
|
|
#include <optional>
|
|
|
|
class TestGuiManager : public CxxTest::TestSuite
|
|
{
|
|
std::unique_ptr<CConfigDB> configDB;
|
|
std::optional<ScriptInterface> scriptInterface;
|
|
public:
|
|
|
|
void setUp()
|
|
{
|
|
g_VFS = CreateVfs();
|
|
TS_ASSERT_OK(g_VFS->Mount(L"", DataDir() / "mods" / "_test.gui" / "", VFS_MOUNT_MUST_EXIST));
|
|
TS_ASSERT_OK(g_VFS->Mount(L"cache", DataDir() / "_testcache" / "", 0, VFS_MAX_PRIORITY));
|
|
|
|
configDB = std::make_unique<CConfigDB>();
|
|
|
|
CXeromyces::Startup();
|
|
|
|
scriptInterface.emplace("Engine", "GUIManager", *g_ScriptContext);
|
|
g_GUI = new CGUIManager{*g_ScriptContext, *scriptInterface};
|
|
}
|
|
|
|
void tearDown()
|
|
{
|
|
delete g_GUI;
|
|
scriptInterface.reset();
|
|
CXeromyces::Terminate();
|
|
configDB.reset();
|
|
g_VFS.reset();
|
|
DeleteDirectory(DataDir()/"_testcache");
|
|
}
|
|
|
|
void test_EventObject()
|
|
{
|
|
// Load up a test page.
|
|
ScriptRequest rq{g_GUI->GetScriptInterface()};
|
|
JS::RootedValue val(rq.cx);
|
|
Script::CreateObject(rq, &val);
|
|
|
|
Script::StructuredClone data = Script::WriteStructuredClone(rq, JS::NullHandleValue);
|
|
g_GUI->PushPage(L"event/page_event.xml", data);
|
|
|
|
const ScriptInterface& pageScriptInterface = *(g_GUI->GetActiveGUI()->GetScriptInterface());
|
|
ScriptRequest prq(pageScriptInterface);
|
|
JS::RootedValue global(prq.cx, prq.globalValue());
|
|
|
|
int called_value = 0;
|
|
JS::RootedValue js_called_value(prq.cx);
|
|
|
|
// Ticking will call the onTick handlers of all object. The second
|
|
// onTick is configured to disable the onTick handlers of the first and
|
|
// third and enable the fourth. So ticking once will only call the
|
|
// first and second object. We don't want the fourth object to be
|
|
// called, to avoid infinite additions of objects.
|
|
g_GUI->TickObjects();
|
|
Script::GetProperty(prq, global, "called1", &js_called_value);
|
|
Script::FromJSVal(prq, js_called_value, called_value);
|
|
TS_ASSERT_EQUALS(called_value, 1);
|
|
|
|
Script::GetProperty(prq, global, "called2", &js_called_value);
|
|
Script::FromJSVal(prq, js_called_value, called_value);
|
|
TS_ASSERT_EQUALS(called_value, 1);
|
|
|
|
Script::GetProperty(prq, global, "called3", &js_called_value);
|
|
Script::FromJSVal(prq, js_called_value, called_value);
|
|
TS_ASSERT_EQUALS(called_value, 0);
|
|
|
|
Script::GetProperty(prq, global, "called4", &js_called_value);
|
|
Script::FromJSVal(prq, js_called_value, called_value);
|
|
TS_ASSERT_EQUALS(called_value, 0);
|
|
|
|
// Ticking again will still call the second object, but also the fourth.
|
|
g_GUI->TickObjects();
|
|
Script::GetProperty(prq, global, "called1", &js_called_value);
|
|
Script::FromJSVal(prq, js_called_value, called_value);
|
|
TS_ASSERT_EQUALS(called_value, 1);
|
|
|
|
Script::GetProperty(prq, global, "called2", &js_called_value);
|
|
Script::FromJSVal(prq, js_called_value, called_value);
|
|
TS_ASSERT_EQUALS(called_value, 2);
|
|
|
|
Script::GetProperty(prq, global, "called3", &js_called_value);
|
|
Script::FromJSVal(prq, js_called_value, called_value);
|
|
TS_ASSERT_EQUALS(called_value, 0);
|
|
|
|
Script::GetProperty(prq, global, "called4", &js_called_value);
|
|
Script::FromJSVal(prq, js_called_value, called_value);
|
|
TS_ASSERT_EQUALS(called_value, 1);
|
|
}
|
|
|
|
void test_hotkeysState()
|
|
{
|
|
// Load up a fake test hotkey when pressing 'a'.
|
|
const char* test_hotkey_name = "hotkey.test";
|
|
configDB->SetValueString(CFG_SYSTEM, test_hotkey_name, "A");
|
|
LoadHotkeys(*configDB);
|
|
|
|
// Load up a test page.
|
|
ScriptRequest rq{g_GUI->GetScriptInterface()};
|
|
JS::RootedValue val(rq.cx);
|
|
Script::CreateObject(rq, &val);
|
|
|
|
Script::StructuredClone data = Script::WriteStructuredClone(rq, JS::NullHandleValue);
|
|
g_GUI->PushPage(L"hotkey/page_hotkey.xml", data);
|
|
|
|
// Press 'a'.
|
|
SDL_Event_ hotkeyNotification;
|
|
hotkeyNotification.ev.type = SDL_KEYDOWN;
|
|
hotkeyNotification.ev.key.keysym.scancode = SDL_SCANCODE_A;
|
|
hotkeyNotification.ev.key.repeat = 0;
|
|
|
|
// Init input and poll the event.
|
|
InitInput();
|
|
in_push_priority_event(&hotkeyNotification);
|
|
SDL_Event_ ev;
|
|
while (in_poll_event(&ev))
|
|
in_dispatch_event(&ev);
|
|
|
|
const ScriptInterface& pageScriptInterface = *(g_GUI->GetActiveGUI()->GetScriptInterface());
|
|
ScriptRequest prq(pageScriptInterface);
|
|
JS::RootedValue global(prq.cx, prq.globalValue());
|
|
|
|
// Ensure that our hotkey state was synchronised with the event itself.
|
|
bool hotkey_pressed_value = false;
|
|
JS::RootedValue js_hotkey_pressed_value(prq.cx);
|
|
|
|
Script::GetProperty(prq, global, "state_before", &js_hotkey_pressed_value);
|
|
Script::FromJSVal(prq, js_hotkey_pressed_value, hotkey_pressed_value);
|
|
TS_ASSERT_EQUALS(hotkey_pressed_value, true);
|
|
|
|
hotkey_pressed_value = false;
|
|
Script::GetProperty(prq, global, "state_after", &js_hotkey_pressed_value);
|
|
Script::FromJSVal(prq, js_hotkey_pressed_value, hotkey_pressed_value);
|
|
TS_ASSERT_EQUALS(hotkey_pressed_value, true);
|
|
|
|
// We are listening to KeyDown events, so repeat shouldn't matter.
|
|
hotkeyNotification.ev.key.repeat = 1;
|
|
in_push_priority_event(&hotkeyNotification);
|
|
while (in_poll_event(&ev))
|
|
in_dispatch_event(&ev);
|
|
|
|
hotkey_pressed_value = false;
|
|
Script::GetProperty(prq, global, "state_before", &js_hotkey_pressed_value);
|
|
Script::FromJSVal(prq, js_hotkey_pressed_value, hotkey_pressed_value);
|
|
TS_ASSERT_EQUALS(hotkey_pressed_value, true);
|
|
|
|
hotkey_pressed_value = false;
|
|
Script::GetProperty(prq, global, "state_after", &js_hotkey_pressed_value);
|
|
Script::FromJSVal(prq, js_hotkey_pressed_value, hotkey_pressed_value);
|
|
TS_ASSERT_EQUALS(hotkey_pressed_value, true);
|
|
|
|
hotkeyNotification.ev.type = SDL_KEYUP;
|
|
in_push_priority_event(&hotkeyNotification);
|
|
while (in_poll_event(&ev))
|
|
in_dispatch_event(&ev);
|
|
|
|
hotkey_pressed_value = true;
|
|
Script::GetProperty(prq, global, "state_before", &js_hotkey_pressed_value);
|
|
Script::FromJSVal(prq, js_hotkey_pressed_value, hotkey_pressed_value);
|
|
TS_ASSERT_EQUALS(hotkey_pressed_value, false);
|
|
|
|
hotkey_pressed_value = true;
|
|
Script::GetProperty(prq, global, "state_after", &js_hotkey_pressed_value);
|
|
Script::FromJSVal(prq, js_hotkey_pressed_value, hotkey_pressed_value);
|
|
TS_ASSERT_EQUALS(hotkey_pressed_value, false);
|
|
|
|
UnloadHotkeys();
|
|
}
|
|
|
|
void test_PageRegainedFocusEvent()
|
|
{
|
|
// Load up a test page.
|
|
ScriptRequest rq{g_GUI->GetScriptInterface()};
|
|
JS::RootedValue val(rq.cx);
|
|
Script::CreateObject(rq, &val);
|
|
|
|
TS_ASSERT_EQUALS(g_GUI->GetPageCount(), 0);
|
|
Script::StructuredClone data = Script::WriteStructuredClone(rq, JS::NullHandleValue);
|
|
g_GUI->PushPage(L"regainFocus/page_emptyPage.xml", data);
|
|
|
|
const ScriptInterface& pageScriptInterface = *(g_GUI->GetActiveGUI()->GetScriptInterface());
|
|
ScriptRequest prq(pageScriptInterface);
|
|
JS::RootedValue global(prq.cx, prq.globalValue());
|
|
|
|
TS_ASSERT_EQUALS(g_GUI->GetPageCount(), 1);
|
|
g_GUI->PushPage(L"regainFocus/page_emptyPage.xml", data);
|
|
TS_ASSERT_EQUALS(g_GUI->GetPageCount(), 2);
|
|
g_GUI->PopPage(data);
|
|
TS_ASSERT_EQUALS(g_GUI->GetPageCount(), 1);
|
|
|
|
// This page instantly pushes an empty page with a callback that pops another page again.
|
|
g_GUI->PushPage(L"regainFocus/page_pushWithPopOnInit.xml", data);
|
|
TS_ASSERT_EQUALS(g_GUI->GetPageCount(), 3);
|
|
|
|
// Pop the empty page
|
|
g_GUI->PopPage(data);
|
|
TS_ASSERT_EQUALS(g_GUI->GetPageCount(), 2);
|
|
scriptInterface->GetContext().RunJobs();
|
|
TS_ASSERT_EQUALS(g_GUI->GetPageCount(), 1);
|
|
}
|
|
};
|