mirror of
https://gitea.wildfiregames.com/0ad/0ad
synced 2026-06-17 05:44:08 -07:00
JSAutoRequest is required before calling into most JSAPI methods, for GC reasons. Calling it is required and fragile as one must not forget. Further, SM52 and later make manipulating JSContext* dangerous as that can cross Compartment(Realm in SM68) barriers (and ScriptInterface now matches a Compartment). The solution to both problems is to avoid using JSContext* in 0 A.D. itself. To achieve this, a Request class is introduced, and must be used to access a JSContext* from a scriptInterface. Further, Request is passed to other ScriptInterface functions isntead of JSContext*, making it obvious that the caller has already called it, reducing errors and redundant JSAutoRequest calls. Only JSNative functions now get a naked JSContext* without protection, but the likelihood of forgetting a request is lower since many ScriptInterface functions now expect it. JSContext* is directly passed to JSAPI functions only. Part of the SM52 migration, stage: SM45 compatible Based on a patch by: Itms Tested By: Freagarach Refs #4893 Differential Revision: https://code.wildfiregames.com/D3088 This was SVN commit r24176.
74 lines
2 KiB
C++
74 lines
2 KiB
C++
/* Copyright (C) 2020 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 "simulation2/system/ComponentTest.h"
|
|
|
|
#include "simulation2/components/ICmpCommandQueue.h"
|
|
|
|
class TestCmpCommandQueue : public CxxTest::TestSuite
|
|
{
|
|
public:
|
|
void setUp()
|
|
{
|
|
CXeromyces::Startup();
|
|
}
|
|
|
|
void tearDown()
|
|
{
|
|
CXeromyces::Terminate();
|
|
}
|
|
|
|
void test_basic()
|
|
{
|
|
ComponentTestHelper test(g_ScriptRuntime);
|
|
ScriptInterface::Request rq(test.GetScriptInterface());
|
|
|
|
std::vector<SimulationCommand> empty;
|
|
|
|
ICmpCommandQueue* cmp = test.Add<ICmpCommandQueue>(CID_CommandQueue, "", SYSTEM_ENTITY);
|
|
|
|
TS_ASSERT(test.GetScriptInterface().Eval("var cmds = []; function ProcessCommand(player, cmd) { cmds.push([player, cmd]); }"));
|
|
|
|
JS::RootedValue cmd(rq.cx);
|
|
|
|
TS_ASSERT(test.GetScriptInterface().Eval("([1,2,3])", &cmd));
|
|
cmp->PushLocalCommand(1, cmd);
|
|
|
|
TS_ASSERT(test.GetScriptInterface().Eval("({\"x\":4})", &cmd));
|
|
cmp->PushLocalCommand(-1, cmd);
|
|
|
|
test.Roundtrip();
|
|
|
|
// Process the first two commands
|
|
cmp->FlushTurn(empty);
|
|
|
|
TS_ASSERT(test.GetScriptInterface().Eval("({\"y\":5})", &cmd));
|
|
cmp->PushLocalCommand(10, cmd);
|
|
|
|
// Process the next command
|
|
cmp->FlushTurn(empty);
|
|
|
|
// Process no commands
|
|
cmp->FlushTurn(empty);
|
|
|
|
test.Roundtrip();
|
|
|
|
std::string output;
|
|
TS_ASSERT(test.GetScriptInterface().Eval("JSON.stringify(cmds)", output));
|
|
TS_ASSERT_STR_EQUALS(output, "[[1,[1,2,3]],[-1,{\"x\":4}],[10,{\"y\":5}]]");
|
|
}
|
|
};
|