mirror of
https://gitea.wildfiregames.com/0ad/0ad
synced 2026-06-16 05:13:58 -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.
138 lines
4.3 KiB
C++
138 lines
4.3 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 "precompiled.h"
|
|
|
|
#include "JSInterface_Main.h"
|
|
|
|
#include "graphics/FontMetrics.h"
|
|
#include "graphics/MapReader.h"
|
|
#include "lib/sysdep/sysdep.h"
|
|
#include "lib/utf8.h"
|
|
#include "maths/MD5.h"
|
|
#include "ps/CStrIntern.h"
|
|
#include "ps/GUID.h"
|
|
#include "ps/GameSetup/Atlas.h"
|
|
#include "ps/Globals.h"
|
|
#include "ps/Hotkey.h"
|
|
#include "ps/Util.h"
|
|
#include "scriptinterface/ScriptInterface.h"
|
|
#include "tools/atlas/GameInterface/GameLoop.h"
|
|
|
|
extern void QuitEngine();
|
|
extern void StartAtlas();
|
|
|
|
void JSI_Main::QuitEngine(ScriptInterface::CxPrivate* UNUSED(pCxPrivate))
|
|
{
|
|
::QuitEngine();
|
|
}
|
|
|
|
void JSI_Main::StartAtlas(ScriptInterface::CxPrivate* UNUSED(pCxPrivate))
|
|
{
|
|
::StartAtlas();
|
|
}
|
|
|
|
bool JSI_Main::AtlasIsAvailable(ScriptInterface::CxPrivate* UNUSED(pCxPrivate))
|
|
{
|
|
return ATLAS_IsAvailable();
|
|
}
|
|
|
|
bool JSI_Main::IsAtlasRunning(ScriptInterface::CxPrivate* UNUSED(pCxPrivate))
|
|
{
|
|
return g_AtlasGameLoop && g_AtlasGameLoop->running;
|
|
}
|
|
|
|
void JSI_Main::OpenURL(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), const std::string& url)
|
|
{
|
|
sys_open_url(url);
|
|
}
|
|
|
|
std::wstring JSI_Main::GetSystemUsername(ScriptInterface::CxPrivate* UNUSED(pCxPrivate))
|
|
{
|
|
return sys_get_user_name();
|
|
}
|
|
|
|
std::wstring JSI_Main::GetMatchID(ScriptInterface::CxPrivate* UNUSED(pCxPrivate))
|
|
{
|
|
return ps_generate_guid().FromUTF8();
|
|
}
|
|
|
|
JS::Value JSI_Main::LoadMapSettings(ScriptInterface::CxPrivate* pCxPrivate, const VfsPath& pathname)
|
|
{
|
|
ScriptInterface::Request rq(pCxPrivate);
|
|
|
|
CMapSummaryReader reader;
|
|
|
|
if (reader.LoadMap(pathname) != PSRETURN_OK)
|
|
return JS::UndefinedValue();
|
|
|
|
JS::RootedValue settings(rq.cx);
|
|
reader.GetMapSettings(*(pCxPrivate->pScriptInterface), &settings);
|
|
return settings;
|
|
}
|
|
|
|
bool JSI_Main::HotkeyIsPressed_(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), const std::string& hotkeyName)
|
|
{
|
|
return HotkeyIsPressed(hotkeyName);
|
|
}
|
|
|
|
// This value is recalculated once a frame. We take special care to
|
|
// filter it, so it is both accurate and free of jitter.
|
|
int JSI_Main::GetFps(ScriptInterface::CxPrivate* UNUSED(pCxPrivate))
|
|
{
|
|
if (!g_frequencyFilter)
|
|
return 0;
|
|
|
|
return g_frequencyFilter->StableFrequency();
|
|
}
|
|
|
|
int JSI_Main::GetTextWidth(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), const std::string& fontName, const std::wstring& text)
|
|
{
|
|
int width = 0;
|
|
int height = 0;
|
|
CStrIntern _fontName(fontName);
|
|
CFontMetrics fontMetrics(_fontName);
|
|
fontMetrics.CalculateStringSize(text.c_str(), width, height);
|
|
return width;
|
|
}
|
|
|
|
std::string JSI_Main::CalculateMD5(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), const std::string& input)
|
|
{
|
|
u8 digest[MD5::DIGESTSIZE];
|
|
|
|
MD5 m;
|
|
m.Update((const u8*)input.c_str(), input.length());
|
|
m.Final(digest);
|
|
|
|
return Hexify(digest, MD5::DIGESTSIZE);
|
|
}
|
|
|
|
void JSI_Main::RegisterScriptFunctions(const ScriptInterface& scriptInterface)
|
|
{
|
|
scriptInterface.RegisterFunction<void, &QuitEngine>("Exit");
|
|
scriptInterface.RegisterFunction<void, &StartAtlas>("RestartInAtlas");
|
|
scriptInterface.RegisterFunction<bool, &AtlasIsAvailable>("AtlasIsAvailable");
|
|
scriptInterface.RegisterFunction<bool, &IsAtlasRunning>("IsAtlasRunning");
|
|
scriptInterface.RegisterFunction<void, std::string, &OpenURL>("OpenURL");
|
|
scriptInterface.RegisterFunction<std::wstring, &GetSystemUsername>("GetSystemUsername");
|
|
scriptInterface.RegisterFunction<std::wstring, &GetMatchID>("GetMatchID");
|
|
scriptInterface.RegisterFunction<JS::Value, VfsPath, &LoadMapSettings>("LoadMapSettings");
|
|
scriptInterface.RegisterFunction<bool, std::string, &HotkeyIsPressed_>("HotkeyIsPressed");
|
|
scriptInterface.RegisterFunction<int, &GetFps>("GetFPS");
|
|
scriptInterface.RegisterFunction<int, std::string, std::wstring, &GetTextWidth>("GetTextWidth");
|
|
scriptInterface.RegisterFunction<std::string, std::string, &CalculateMD5>("CalculateMD5");
|
|
}
|