forked from mirrors/0ad
wraitii
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.
363 lines
10 KiB
C++
363 lines
10 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 "ScriptConversions.h"
|
|
|
|
#include "graphics/Entity.h"
|
|
#include "maths/Vector2D.h"
|
|
#include "ps/utf16string.h"
|
|
#include "ps/CStr.h"
|
|
|
|
#define FAIL(msg) STMT(JS_ReportError(rq.cx, msg); return false)
|
|
|
|
// Implicit type conversions often hide bugs, so warn about them
|
|
#define WARN_IF_NOT(c, v) STMT(if (!(c)) { JS_ReportWarning(rq.cx, "Script value conversion check failed: %s (got type %s)", #c, InformalValueTypeName(v)); })
|
|
|
|
// TODO: SpiderMonkey: Follow upstream progresses about JS_InformalValueTypeName in the API
|
|
// https://bugzilla.mozilla.org/show_bug.cgi?id=1285917
|
|
static const char* InformalValueTypeName(const JS::Value& v)
|
|
{
|
|
if (v.isObject())
|
|
return "object";
|
|
if (v.isString())
|
|
return "string";
|
|
if (v.isSymbol())
|
|
return "symbol";
|
|
if (v.isNumber())
|
|
return "number";
|
|
if (v.isBoolean())
|
|
return "boolean";
|
|
if (v.isNull())
|
|
return "null";
|
|
if (v.isUndefined())
|
|
return "undefined";
|
|
return "value";
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<bool>(const Request& rq, JS::HandleValue v, bool& out)
|
|
{
|
|
WARN_IF_NOT(v.isBoolean(), v);
|
|
out = JS::ToBoolean(v);
|
|
return true;
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<float>(const Request& rq, JS::HandleValue v, float& out)
|
|
{
|
|
double tmp;
|
|
WARN_IF_NOT(v.isNumber(), v);
|
|
if (!JS::ToNumber(rq.cx, v, &tmp))
|
|
return false;
|
|
out = tmp;
|
|
return true;
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<double>(const Request& rq, JS::HandleValue v, double& out)
|
|
{
|
|
WARN_IF_NOT(v.isNumber(), v);
|
|
if (!JS::ToNumber(rq.cx, v, &out))
|
|
return false;
|
|
return true;
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<i32>(const Request& rq, JS::HandleValue v, i32& out)
|
|
{
|
|
WARN_IF_NOT(v.isNumber(), v);
|
|
if (!JS::ToInt32(rq.cx, v, &out))
|
|
return false;
|
|
return true;
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<u32>(const Request& rq, JS::HandleValue v, u32& out)
|
|
{
|
|
WARN_IF_NOT(v.isNumber(), v);
|
|
if (!JS::ToUint32(rq.cx, v, &out))
|
|
return false;
|
|
return true;
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<u16>(const Request& rq, JS::HandleValue v, u16& out)
|
|
{
|
|
WARN_IF_NOT(v.isNumber(), v);
|
|
if (!JS::ToUint16(rq.cx, v, &out))
|
|
return false;
|
|
return true;
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<u8>(const Request& rq, JS::HandleValue v, u8& out)
|
|
{
|
|
u16 tmp;
|
|
WARN_IF_NOT(v.isNumber(), v);
|
|
if (!JS::ToUint16(rq.cx, v, &tmp))
|
|
return false;
|
|
out = (u8)tmp;
|
|
return true;
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<std::wstring>(const Request& rq, JS::HandleValue v, std::wstring& out)
|
|
{
|
|
WARN_IF_NOT(v.isString() || v.isNumber(), v); // allow implicit number conversions
|
|
JS::RootedString str(rq.cx, JS::ToString(rq.cx, v));
|
|
if (!str)
|
|
FAIL("Argument must be convertible to a string");
|
|
|
|
if (JS_StringHasLatin1Chars(str))
|
|
{
|
|
size_t length;
|
|
JS::AutoCheckCannotGC nogc;
|
|
const JS::Latin1Char* ch = JS_GetLatin1StringCharsAndLength(rq.cx, nogc, str, &length);
|
|
if (!ch)
|
|
FAIL("JS_GetLatin1StringCharsAndLength failed");
|
|
|
|
out.assign(ch, ch + length);
|
|
}
|
|
else
|
|
{
|
|
size_t length;
|
|
JS::AutoCheckCannotGC nogc;
|
|
const char16_t* ch = JS_GetTwoByteStringCharsAndLength(rq.cx, nogc, str, &length);
|
|
if (!ch)
|
|
FAIL("JS_GetTwoByteStringsCharsAndLength failed"); // out of memory
|
|
|
|
out.assign(ch, ch + length);
|
|
}
|
|
return true;
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<Path>(const Request& rq, JS::HandleValue v, Path& out)
|
|
{
|
|
std::wstring string;
|
|
if (!FromJSVal(rq, v, string))
|
|
return false;
|
|
out = string;
|
|
return true;
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<std::string>(const Request& rq, JS::HandleValue v, std::string& out)
|
|
{
|
|
std::wstring wideout;
|
|
if (!FromJSVal(rq, v, wideout))
|
|
return false;
|
|
out = CStrW(wideout).ToUTF8();
|
|
return true;
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<CStr8>(const Request& rq, JS::HandleValue v, CStr8& out)
|
|
{
|
|
return ScriptInterface::FromJSVal(rq, v, static_cast<std::string&>(out));
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<CStrW>(const Request& rq, JS::HandleValue v, CStrW& out)
|
|
{
|
|
return ScriptInterface::FromJSVal(rq, v, static_cast<std::wstring&>(out));
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<Entity>(const Request& rq, JS::HandleValue v, Entity& out)
|
|
{
|
|
if (!v.isObject())
|
|
FAIL("Argument must be an object");
|
|
|
|
JS::RootedObject obj(rq.cx, &v.toObject());
|
|
JS::RootedValue templateName(rq.cx);
|
|
JS::RootedValue id(rq.cx);
|
|
JS::RootedValue player(rq.cx);
|
|
JS::RootedValue position(rq.cx);
|
|
JS::RootedValue rotation(rq.cx);
|
|
|
|
// TODO: Report type errors
|
|
if (!JS_GetProperty(rq.cx, obj, "player", &player) || !FromJSVal(rq, player, out.playerID))
|
|
FAIL("Failed to read Entity.player property");
|
|
if (!JS_GetProperty(rq.cx, obj, "templateName", &templateName) || !FromJSVal(rq, templateName, out.templateName))
|
|
FAIL("Failed to read Entity.templateName property");
|
|
if (!JS_GetProperty(rq.cx, obj, "id", &id) || !FromJSVal(rq, id, out.entityID))
|
|
FAIL("Failed to read Entity.id property");
|
|
if (!JS_GetProperty(rq.cx, obj, "position", &position) || !FromJSVal(rq, position, out.position))
|
|
FAIL("Failed to read Entity.position property");
|
|
if (!JS_GetProperty(rq.cx, obj, "rotation", &rotation) || !FromJSVal(rq, rotation, out.rotation))
|
|
FAIL("Failed to read Entity.rotation property");
|
|
|
|
return true;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////
|
|
// Primitive types:
|
|
|
|
template<> void ScriptInterface::ToJSVal<bool>(const Request& UNUSED(rq), JS::MutableHandleValue ret, const bool& val)
|
|
{
|
|
ret.setBoolean(val);
|
|
}
|
|
|
|
template<> void ScriptInterface::ToJSVal<float>(const Request& UNUSED(rq), JS::MutableHandleValue ret, const float& val)
|
|
{
|
|
ret.set(JS::NumberValue(val));
|
|
}
|
|
|
|
template<> void ScriptInterface::ToJSVal<double>(const Request& UNUSED(rq), JS::MutableHandleValue ret, const double& val)
|
|
{
|
|
ret.set(JS::NumberValue(val));
|
|
}
|
|
|
|
template<> void ScriptInterface::ToJSVal<i32>(const Request& UNUSED(rq), JS::MutableHandleValue ret, const i32& val)
|
|
{
|
|
ret.set(JS::NumberValue(val));
|
|
}
|
|
|
|
template<> void ScriptInterface::ToJSVal<u16>(const Request& UNUSED(rq), JS::MutableHandleValue ret, const u16& val)
|
|
{
|
|
ret.set(JS::NumberValue(val));
|
|
}
|
|
|
|
template<> void ScriptInterface::ToJSVal<u8>(const Request& UNUSED(rq), JS::MutableHandleValue ret, const u8& val)
|
|
{
|
|
ret.set(JS::NumberValue(val));
|
|
}
|
|
|
|
template<> void ScriptInterface::ToJSVal<u32>(const Request& UNUSED(rq), JS::MutableHandleValue ret, const u32& val)
|
|
{
|
|
ret.set(JS::NumberValue(val));
|
|
}
|
|
|
|
template<> void ScriptInterface::ToJSVal<std::wstring>(const Request& rq, JS::MutableHandleValue ret, const std::wstring& val)
|
|
{
|
|
utf16string utf16(val.begin(), val.end());
|
|
JS::RootedString str(rq.cx, JS_NewUCStringCopyN(rq.cx, reinterpret_cast<const char16_t*> (utf16.c_str()), utf16.length()));
|
|
if (str)
|
|
ret.setString(str);
|
|
else
|
|
ret.setUndefined();
|
|
}
|
|
|
|
template<> void ScriptInterface::ToJSVal<Path>(const Request& rq, JS::MutableHandleValue ret, const Path& val)
|
|
{
|
|
ToJSVal(rq, ret, val.string());
|
|
}
|
|
|
|
template<> void ScriptInterface::ToJSVal<std::string>(const Request& rq, JS::MutableHandleValue ret, const std::string& val)
|
|
{
|
|
ToJSVal(rq, ret, static_cast<const std::wstring>(CStr(val).FromUTF8()));
|
|
}
|
|
|
|
template<> void ScriptInterface::ToJSVal<const wchar_t*>(const Request& rq, JS::MutableHandleValue ret, const wchar_t* const& val)
|
|
{
|
|
ToJSVal(rq, ret, std::wstring(val));
|
|
}
|
|
|
|
template<> void ScriptInterface::ToJSVal<const char*>(const Request& rq, JS::MutableHandleValue ret, const char* const& val)
|
|
{
|
|
JS::RootedString str(rq.cx, JS_NewStringCopyZ(rq.cx, val));
|
|
if (str)
|
|
ret.setString(str);
|
|
else
|
|
ret.setUndefined();
|
|
}
|
|
|
|
#define TOJSVAL_CHAR(N) \
|
|
template<> void ScriptInterface::ToJSVal<wchar_t[N]>(const Request& rq, JS::MutableHandleValue ret, const wchar_t (&val)[N]) \
|
|
{ \
|
|
ToJSVal(rq, ret, static_cast<const wchar_t*>(val)); \
|
|
} \
|
|
template<> void ScriptInterface::ToJSVal<char[N]>(const Request& rq, JS::MutableHandleValue ret, const char (&val)[N]) \
|
|
{ \
|
|
ToJSVal(rq, ret, static_cast<const char*>(val)); \
|
|
}
|
|
|
|
TOJSVAL_CHAR(3)
|
|
TOJSVAL_CHAR(5)
|
|
TOJSVAL_CHAR(6)
|
|
TOJSVAL_CHAR(7)
|
|
TOJSVAL_CHAR(8)
|
|
TOJSVAL_CHAR(9)
|
|
TOJSVAL_CHAR(10)
|
|
TOJSVAL_CHAR(11)
|
|
TOJSVAL_CHAR(12)
|
|
TOJSVAL_CHAR(13)
|
|
TOJSVAL_CHAR(14)
|
|
TOJSVAL_CHAR(15)
|
|
TOJSVAL_CHAR(16)
|
|
TOJSVAL_CHAR(17)
|
|
TOJSVAL_CHAR(18)
|
|
TOJSVAL_CHAR(19)
|
|
TOJSVAL_CHAR(20)
|
|
TOJSVAL_CHAR(24)
|
|
TOJSVAL_CHAR(29)
|
|
TOJSVAL_CHAR(33)
|
|
TOJSVAL_CHAR(35)
|
|
TOJSVAL_CHAR(256)
|
|
#undef TOJSVAL_CHAR
|
|
|
|
template<> void ScriptInterface::ToJSVal<CStrW>(const Request& rq, JS::MutableHandleValue ret, const CStrW& val)
|
|
{
|
|
ToJSVal(rq, ret, static_cast<const std::wstring&>(val));
|
|
}
|
|
|
|
template<> void ScriptInterface::ToJSVal<CStr8>(const Request& rq, JS::MutableHandleValue ret, const CStr8& val)
|
|
{
|
|
ToJSVal(rq, ret, static_cast<const std::string&>(val));
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////
|
|
// Compound types
|
|
// Instantiate various vector types:
|
|
|
|
JSVAL_VECTOR(int)
|
|
JSVAL_VECTOR(u32)
|
|
JSVAL_VECTOR(u16)
|
|
JSVAL_VECTOR(std::string)
|
|
JSVAL_VECTOR(std::wstring)
|
|
JSVAL_VECTOR(std::vector<std::wstring>)
|
|
JSVAL_VECTOR(CStr8)
|
|
JSVAL_VECTOR(std::vector<CStr8>)
|
|
JSVAL_VECTOR(std::vector<std::string>)
|
|
|
|
|
|
class IComponent;
|
|
template<> void ScriptInterface::ToJSVal<std::vector<IComponent*> >(const Request& rq, JS::MutableHandleValue ret, const std::vector<IComponent*>& val)
|
|
{
|
|
ToJSVal_vector(rq, ret, val);
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<std::vector<Entity> >(const Request& rq, JS::HandleValue v, std::vector<Entity>& out)
|
|
{
|
|
return FromJSVal_vector(rq, v, out);
|
|
}
|
|
|
|
template<> void ScriptInterface::ToJSVal<CVector2D>(const Request& rq, JS::MutableHandleValue ret, const CVector2D& val)
|
|
{
|
|
std::vector<float> vec = {val.X, val.Y};
|
|
ToJSVal_vector(rq, ret, vec);
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<CVector2D>(const Request& rq, JS::HandleValue v, CVector2D& out)
|
|
{
|
|
std::vector<float> vec;
|
|
|
|
if (!FromJSVal_vector(rq, v, vec))
|
|
return false;
|
|
|
|
if (vec.size() != 2)
|
|
return false;
|
|
|
|
out.X = vec[0];
|
|
out.Y = vec[1];
|
|
|
|
return true;
|
|
}
|
|
|
|
#undef FAIL
|
|
#undef WARN_IF_NOT
|