mirror of
https://gitea.wildfiregames.com/0ad/0ad
synced 2026-06-16 05:13:58 -07:00
ee0d204bf6
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.
358 lines
9.4 KiB
C++
358 lines
9.4 KiB
C++
/* Copyright (C) 2019 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 "gui/ObjectBases/IGUIObject.h"
|
|
#include "gui/SettingTypes/CGUIColor.h"
|
|
#include "gui/SettingTypes/CGUIList.h"
|
|
#include "gui/SettingTypes/CGUISeries.h"
|
|
#include "gui/SettingTypes/CGUISize.h"
|
|
#include "lib/external_libraries/libsdl.h"
|
|
#include "maths/Vector2D.h"
|
|
#include "ps/Hotkey.h"
|
|
#include "scriptinterface/ScriptConversions.h"
|
|
|
|
#include <string>
|
|
|
|
#define SET(obj, name, value) STMT(JS::RootedValue v_(rq.cx); AssignOrToJSVal(rq, &v_, (value)); JS_SetProperty(rq.cx, obj, (name), v_))
|
|
// ignore JS_SetProperty return value, because errors should be impossible
|
|
// and we can't do anything useful in the case of errors anyway
|
|
|
|
template<> void ScriptInterface::ToJSVal<SDL_Event_>(const Request& rq, JS::MutableHandleValue ret, SDL_Event_ const& val)
|
|
{
|
|
const char* typeName;
|
|
|
|
switch (val.ev.type)
|
|
{
|
|
case SDL_WINDOWEVENT: typeName = "windowevent"; break;
|
|
case SDL_KEYDOWN: typeName = "keydown"; break;
|
|
case SDL_KEYUP: typeName = "keyup"; break;
|
|
case SDL_MOUSEMOTION: typeName = "mousemotion"; break;
|
|
case SDL_MOUSEBUTTONDOWN: typeName = "mousebuttondown"; break;
|
|
case SDL_MOUSEBUTTONUP: typeName = "mousebuttonup"; break;
|
|
case SDL_QUIT: typeName = "quit"; break;
|
|
case SDL_HOTKEYDOWN: typeName = "hotkeydown"; break;
|
|
case SDL_HOTKEYUP: typeName = "hotkeyup"; break;
|
|
default: typeName = "(unknown)"; break;
|
|
}
|
|
|
|
JS::RootedObject obj(rq.cx, JS_NewPlainObject(rq.cx));
|
|
if (!obj)
|
|
{
|
|
ret.setUndefined();
|
|
return;
|
|
}
|
|
|
|
SET(obj, "type", typeName);
|
|
|
|
switch (val.ev.type)
|
|
{
|
|
case SDL_KEYDOWN:
|
|
case SDL_KEYUP:
|
|
{
|
|
// SET(obj, "which", (int)val.ev.key.which); // (not in wsdl.h)
|
|
// SET(obj, "state", (int)val.ev.key.state); // (not in wsdl.h)
|
|
|
|
JS::RootedObject keysym(rq.cx, JS_NewPlainObject(rq.cx));
|
|
if (!keysym)
|
|
{
|
|
ret.setUndefined();
|
|
return;
|
|
}
|
|
JS::RootedValue keysymVal(rq.cx, JS::ObjectValue(*keysym));
|
|
JS_SetProperty(rq.cx, obj, "keysym", keysymVal);
|
|
|
|
// SET(keysym, "scancode", (int)val.ev.key.keysym.scancode); // (not in wsdl.h)
|
|
SET(keysym, "sym", (int)val.ev.key.keysym.sym);
|
|
// SET(keysym, "mod", (int)val.ev.key.keysym.mod); // (not in wsdl.h)
|
|
{
|
|
SET(keysym, "unicode", JS::UndefinedHandleValue);
|
|
}
|
|
// TODO: scripts have no idea what all the key/mod enum values are;
|
|
// we should probably expose them as constants if we expect scripts to use them
|
|
|
|
break;
|
|
}
|
|
case SDL_MOUSEMOTION:
|
|
{
|
|
// SET(obj, "which", (int)val.ev.motion.which); // (not in wsdl.h)
|
|
// SET(obj, "state", (int)val.ev.motion.state); // (not in wsdl.h)
|
|
SET(obj, "x", (int)val.ev.motion.x);
|
|
SET(obj, "y", (int)val.ev.motion.y);
|
|
// SET(obj, "xrel", (int)val.ev.motion.xrel); // (not in wsdl.h)
|
|
// SET(obj, "yrel", (int)val.ev.motion.yrel); // (not in wsdl.h)
|
|
break;
|
|
}
|
|
case SDL_MOUSEBUTTONDOWN:
|
|
case SDL_MOUSEBUTTONUP:
|
|
{
|
|
// SET(obj, "which", (int)val.ev.button.which); // (not in wsdl.h)
|
|
SET(obj, "button", (int)val.ev.button.button);
|
|
SET(obj, "state", (int)val.ev.button.state);
|
|
SET(obj, "x", (int)val.ev.button.x);
|
|
SET(obj, "y", (int)val.ev.button.y);
|
|
SET(obj, "clicks", (int)val.ev.button.clicks);
|
|
break;
|
|
}
|
|
case SDL_HOTKEYDOWN:
|
|
case SDL_HOTKEYUP:
|
|
{
|
|
SET(obj, "hotkey", static_cast<const char*>(val.ev.user.data1));
|
|
break;
|
|
}
|
|
}
|
|
|
|
ret.setObject(*obj);
|
|
}
|
|
|
|
template<> void ScriptInterface::ToJSVal<IGUIObject*>(const Request& UNUSED(rq), JS::MutableHandleValue ret, IGUIObject* const& val)
|
|
{
|
|
if (val == nullptr)
|
|
ret.setNull();
|
|
else
|
|
ret.setObject(*val->GetJSObject());
|
|
}
|
|
|
|
template<> void ScriptInterface::ToJSVal<CGUIString>(const Request& rq, JS::MutableHandleValue ret, const CGUIString& val)
|
|
{
|
|
ScriptInterface::ToJSVal(rq, ret, val.GetOriginalString());
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<CGUIString>(const Request& rq, JS::HandleValue v, CGUIString& out)
|
|
{
|
|
std::wstring val;
|
|
if (!FromJSVal(rq, v, val))
|
|
return false;
|
|
out.SetValue(val);
|
|
return true;
|
|
}
|
|
|
|
JSVAL_VECTOR(CVector2D)
|
|
JSVAL_VECTOR(std::vector<CVector2D>)
|
|
JSVAL_VECTOR(CGUIString)
|
|
|
|
template<> void ScriptInterface::ToJSVal<CGUIColor>(const Request& rq, JS::MutableHandleValue ret, const CGUIColor& val)
|
|
{
|
|
ToJSVal<CColor>(rq, ret, val);
|
|
}
|
|
|
|
/**
|
|
* The color depends on the predefined color database stored in the current GUI page.
|
|
*/
|
|
template<> bool ScriptInterface::FromJSVal<CGUIColor>(const Request& rq, JS::HandleValue v, CGUIColor& out) = delete;
|
|
|
|
template<> void ScriptInterface::ToJSVal<CSize>(const Request& rq, JS::MutableHandleValue ret, const CSize& val)
|
|
{
|
|
CreateObject(rq, ret, "width", val.cx, "height", val.cy);
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<CSize>(const Request& rq, JS::HandleValue v, CSize& out)
|
|
{
|
|
if (!v.isObject())
|
|
{
|
|
JS_ReportError(rq.cx, "CSize value must be an object!");
|
|
return false;
|
|
}
|
|
|
|
if (!FromJSProperty(rq, v, "width", out.cx))
|
|
{
|
|
JS_ReportError(rq.cx, "Failed to get CSize.cx property");
|
|
return false;
|
|
}
|
|
|
|
if (!FromJSProperty(rq, v, "height", out.cy))
|
|
{
|
|
JS_ReportError(rq.cx, "Failed to get CSize.cy property");
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
template<> void ScriptInterface::ToJSVal<CPos>(const Request& rq, JS::MutableHandleValue ret, const CPos& val)
|
|
{
|
|
CreateObject(rq, ret, "x", val.x, "y", val.y);
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<CPos>(const Request& rq, JS::HandleValue v, CPos& out)
|
|
{
|
|
if (!v.isObject())
|
|
{
|
|
JS_ReportError(rq.cx, "CPos value must be an object!");
|
|
return false;
|
|
}
|
|
|
|
if (!FromJSProperty(rq, v, "x", out.x))
|
|
{
|
|
JS_ReportError(rq.cx, "Failed to get CPos.x property");
|
|
return false;
|
|
}
|
|
|
|
if (!FromJSProperty(rq, v, "y", out.y))
|
|
{
|
|
JS_ReportError(rq.cx, "Failed to get CPos.y property");
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
template<> void ScriptInterface::ToJSVal<CRect>(const Request& rq, JS::MutableHandleValue ret, const CRect& val)
|
|
{
|
|
CreateObject(
|
|
rq,
|
|
ret,
|
|
"left", val.left,
|
|
"right", val.right,
|
|
"top", val.top,
|
|
"bottom", val.bottom);
|
|
}
|
|
|
|
template<> void ScriptInterface::ToJSVal<CGUISize>(const Request& rq, JS::MutableHandleValue ret, const CGUISize& val)
|
|
{
|
|
val.ToJSVal(rq, ret);
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<CGUISize>(const Request& rq, JS::HandleValue v, CGUISize& out)
|
|
{
|
|
return out.FromJSVal(rq, v);
|
|
}
|
|
|
|
template<> void ScriptInterface::ToJSVal<CGUIList>(const Request& rq, JS::MutableHandleValue ret, const CGUIList& val)
|
|
{
|
|
ToJSVal(rq, ret, val.m_Items);
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<CGUIList>(const Request& rq, JS::HandleValue v, CGUIList& out)
|
|
{
|
|
return FromJSVal(rq, v, out.m_Items);
|
|
}
|
|
|
|
template<> void ScriptInterface::ToJSVal<CGUISeries>(const Request& rq, JS::MutableHandleValue ret, const CGUISeries& val)
|
|
{
|
|
ToJSVal(rq, ret, val.m_Series);
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<CGUISeries>(const Request& rq, JS::HandleValue v, CGUISeries& out)
|
|
{
|
|
return FromJSVal(rq, v, out.m_Series);
|
|
}
|
|
|
|
template<> void ScriptInterface::ToJSVal<EVAlign>(const Request& rq, JS::MutableHandleValue ret, const EVAlign& val)
|
|
{
|
|
std::string word;
|
|
switch (val)
|
|
{
|
|
case EVAlign_Top:
|
|
word = "top";
|
|
break;
|
|
|
|
case EVAlign_Bottom:
|
|
word = "bottom";
|
|
break;
|
|
|
|
case EVAlign_Center:
|
|
word = "center";
|
|
break;
|
|
|
|
default:
|
|
word = "error";
|
|
JS_ReportError(rq.cx, "Invalid EVAlign");
|
|
break;
|
|
}
|
|
ToJSVal(rq, ret, word);
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<EVAlign>(const Request& rq, JS::HandleValue v, EVAlign& out)
|
|
{
|
|
std::string word;
|
|
FromJSVal(rq, v, word);
|
|
|
|
if (word == "top")
|
|
out = EVAlign_Top;
|
|
else if (word == "bottom")
|
|
out = EVAlign_Bottom;
|
|
else if (word == "center")
|
|
out = EVAlign_Center;
|
|
else
|
|
{
|
|
out = EVAlign_Top;
|
|
JS_ReportError(rq.cx, "Invalid alignment (should be 'left', 'right' or 'center')");
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
template<> void ScriptInterface::ToJSVal<EAlign>(const Request& rq, JS::MutableHandleValue ret, const EAlign& val)
|
|
{
|
|
std::string word;
|
|
switch (val)
|
|
{
|
|
case EAlign_Left:
|
|
word = "left";
|
|
break;
|
|
case EAlign_Right:
|
|
word = "right";
|
|
break;
|
|
case EAlign_Center:
|
|
word = "center";
|
|
break;
|
|
default:
|
|
word = "error";
|
|
JS_ReportError(rq.cx, "Invalid alignment (should be 'left', 'right' or 'center')");
|
|
break;
|
|
}
|
|
ToJSVal(rq, ret, word);
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<EAlign>(const Request& rq, JS::HandleValue v, EAlign& out)
|
|
{
|
|
std::string word;
|
|
FromJSVal(rq, v, word);
|
|
|
|
if (word == "left")
|
|
out = EAlign_Left;
|
|
else if (word == "right")
|
|
out = EAlign_Right;
|
|
else if (word == "center")
|
|
out = EAlign_Center;
|
|
else
|
|
{
|
|
out = EAlign_Left;
|
|
JS_ReportError(rq.cx, "Invalid alignment (should be 'left', 'right' or 'center')");
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
template<> void ScriptInterface::ToJSVal<CGUISpriteInstance>(const Request& rq, JS::MutableHandleValue ret, const CGUISpriteInstance& val)
|
|
{
|
|
ToJSVal(rq, ret, val.GetName());
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<CGUISpriteInstance>(const Request& rq, JS::HandleValue v, CGUISpriteInstance& out)
|
|
{
|
|
std::string name;
|
|
if (!FromJSVal(rq, v, name))
|
|
return false;
|
|
|
|
out.SetName(name);
|
|
return true;
|
|
}
|
|
|
|
#undef SET
|