forked from 0ad/0ad
Yves
20ed5b118c
Because it was historically grown, we have some duplicated code for converting script types to native types. This patch removes the file JSConversions.cpp and moves some code to ScriptConversions.cpp. The places using JSConversions.cpp are changed to use the ScriptInterface's conversion functions in ScriptConversions.cpp. I also removed JSInterface_Vector3D because it had additional requirements to the conversion code that no other code has and because it's currently not used. I think it doesn't make sense to maintain code just because it could possibly be used again later. Closes #2213 Refs #1886 This was SVN commit r14036.
429 lines
12 KiB
C++
429 lines
12 KiB
C++
/* Copyright (C) 2013 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 "ScriptInterface.h"
|
|
|
|
#include "graphics/Entity.h"
|
|
#include "ps/utf16string.h"
|
|
#include "ps/CLogger.h"
|
|
#include "ps/CStr.h"
|
|
#include "scriptinterface/ScriptExtraHeaders.h" // for typed arrays
|
|
|
|
#define FAIL(msg) STMT(JS_ReportError(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(cx, "Script value conversion check failed: %s (got type %s)", #c, JS_GetTypeName(cx, JS_TypeOfValue(cx, v))); })
|
|
|
|
template<> bool ScriptInterface::FromJSVal<bool>(JSContext* cx, jsval v, bool& out)
|
|
{
|
|
JSBool ret;
|
|
WARN_IF_NOT(JSVAL_IS_BOOLEAN(v), v);
|
|
if (!JS_ValueToBoolean(cx, v, &ret))
|
|
return false;
|
|
out = (ret ? true : false);
|
|
return true;
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<float>(JSContext* cx, jsval v, float& out)
|
|
{
|
|
jsdouble ret;
|
|
WARN_IF_NOT(JSVAL_IS_NUMBER(v), v);
|
|
if (!JS_ValueToNumber(cx, v, &ret))
|
|
return false;
|
|
out = ret;
|
|
return true;
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<double>(JSContext* cx, jsval v, double& out)
|
|
{
|
|
jsdouble ret;
|
|
WARN_IF_NOT(JSVAL_IS_NUMBER(v), v);
|
|
if (!JS_ValueToNumber(cx, v, &ret))
|
|
return false;
|
|
out = ret;
|
|
return true;
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<i32>(JSContext* cx, jsval v, i32& out)
|
|
{
|
|
int32 ret;
|
|
WARN_IF_NOT(JSVAL_IS_NUMBER(v), v);
|
|
if (!JS_ValueToECMAInt32(cx, v, &ret))
|
|
return false;
|
|
out = ret;
|
|
return true;
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<u32>(JSContext* cx, jsval v, u32& out)
|
|
{
|
|
uint32 ret;
|
|
WARN_IF_NOT(JSVAL_IS_NUMBER(v), v);
|
|
if (!JS_ValueToECMAUint32(cx, v, &ret))
|
|
return false;
|
|
out = ret;
|
|
return true;
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<u16>(JSContext* cx, jsval v, u16& out)
|
|
{
|
|
uint16 ret;
|
|
WARN_IF_NOT(JSVAL_IS_NUMBER(v), v);
|
|
if (!JS_ValueToUint16(cx, v, &ret))
|
|
return false;
|
|
out = ret;
|
|
return true;
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<u8>(JSContext* cx, jsval v, u8& out)
|
|
{
|
|
uint16 ret;
|
|
WARN_IF_NOT(JSVAL_IS_NUMBER(v), v);
|
|
if (!JS_ValueToUint16(cx, v, &ret))
|
|
return false;
|
|
out = (u8)ret;
|
|
return true;
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<long>(JSContext* cx, jsval v, long& out)
|
|
{
|
|
int32 tmp;
|
|
JSBool ok = JS_ValueToInt32(cx, v, &tmp);
|
|
out = (long)tmp;
|
|
return ok == JS_TRUE;
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<unsigned long>(JSContext* cx, jsval v, unsigned long& out)
|
|
{
|
|
int32 tmp;
|
|
JSBool ok = JS_ValueToInt32(cx, v, &tmp);
|
|
out = (unsigned long)tmp;
|
|
return ok == JS_TRUE;
|
|
}
|
|
|
|
// see comment below (where the same preprocessor condition is used)
|
|
#if MSC_VERSION && ARCH_AMD64
|
|
|
|
template<> bool ScriptInterface::FromJSVal<size_t>(JSContext* cx, jsval v, size_t& out)
|
|
{
|
|
int temp;
|
|
if(!FromJSVal<int>(cx, v, temp))
|
|
return false;
|
|
if(temp < 0)
|
|
return false;
|
|
out = (size_t)temp;
|
|
return true;
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<ssize_t>(JSContext* cx, jsval v, ssize_t& out)
|
|
{
|
|
int temp;
|
|
if(!FromJSVal<int>(cx, v, temp))
|
|
return false;
|
|
if(temp < 0)
|
|
return false;
|
|
out = (ssize_t)temp;
|
|
return true;
|
|
}
|
|
|
|
#endif
|
|
|
|
// NOTE: we can't define a jsval specialisation, because that conflicts with integer types
|
|
template<> bool ScriptInterface::FromJSVal<CScriptVal>(JSContext* UNUSED(cx), jsval v, CScriptVal& out)
|
|
{
|
|
out = v;
|
|
return true;
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<CScriptValRooted>(JSContext* cx, jsval v, CScriptValRooted& out)
|
|
{
|
|
out = CScriptValRooted(cx, v);
|
|
return true;
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<std::wstring>(JSContext* cx, jsval v, std::wstring& out)
|
|
{
|
|
WARN_IF_NOT(JSVAL_IS_STRING(v) || JSVAL_IS_NUMBER(v), v); // allow implicit number conversions
|
|
JSString* ret = JS_ValueToString(cx, v);
|
|
if (!ret)
|
|
FAIL("Argument must be convertible to a string");
|
|
size_t length;
|
|
const jschar* ch = JS_GetStringCharsAndLength(cx, ret, &length);
|
|
if (!ch)
|
|
FAIL("JS_GetStringsCharsAndLength failed"); // out of memory
|
|
out = std::wstring(ch, ch + length);
|
|
return true;
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<Path>(JSContext* cx, jsval v, Path& out)
|
|
{
|
|
std::wstring string;
|
|
if (!FromJSVal(cx, v, string))
|
|
return false;
|
|
out = string;
|
|
return true;
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<std::string>(JSContext* cx, jsval v, std::string& out)
|
|
{
|
|
WARN_IF_NOT(JSVAL_IS_STRING(v) || JSVAL_IS_NUMBER(v), v); // allow implicit number conversions
|
|
JSString* ret = JS_ValueToString(cx, v);
|
|
if (!ret)
|
|
FAIL("Argument must be convertible to a string");
|
|
char* ch = JS_EncodeString(cx, ret); // chops off high byte of each jschar
|
|
if (!ch)
|
|
FAIL("JS_EncodeString failed"); // out of memory
|
|
out = std::string(ch, ch + JS_GetStringLength(ret));
|
|
JS_free(cx, ch);
|
|
return true;
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<CStr8>(JSContext* cx, jsval v, CStr8& out)
|
|
{
|
|
return ScriptInterface::FromJSVal(cx, v, static_cast<std::string&>(out));
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<CStrW>(JSContext* cx, jsval v, CStrW& out)
|
|
{
|
|
return ScriptInterface::FromJSVal(cx, v, static_cast<std::wstring&>(out));
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<Entity>(JSContext* cx, jsval v, Entity& out)
|
|
{
|
|
JSObject* obj;
|
|
if (!JS_ValueToObject(cx, v, &obj) || obj == NULL)
|
|
FAIL("Argument must be an object");
|
|
|
|
jsval templateName, id, player, position, rotation;
|
|
|
|
// TODO: Report type errors
|
|
if(!JS_GetProperty(cx, obj, "player", &player) || !FromJSVal(cx, player, out.playerID))
|
|
FAIL("Failed to read Entity.player property");
|
|
if (!JS_GetProperty(cx, obj, "templateName", &templateName) || !FromJSVal(cx, templateName, out.templateName))
|
|
FAIL("Failed to read Entity.templateName property");
|
|
if (!JS_GetProperty(cx, obj, "id", &id) || !FromJSVal(cx, id, out.entityID))
|
|
FAIL("Failed to read Entity.id property");
|
|
if (!JS_GetProperty(cx, obj, "position", &position) || !FromJSVal(cx, position, out.position))
|
|
FAIL("Failed to read Entity.position property");
|
|
if (!JS_GetProperty(cx, obj, "rotation", &rotation) || !FromJSVal(cx, rotation, out.rotation))
|
|
FAIL("Failed to read Entity.rotation property");
|
|
|
|
return true;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////
|
|
// Primitive types:
|
|
|
|
template<> jsval ScriptInterface::ToJSVal<bool>(JSContext* UNUSED(cx), const bool& val)
|
|
{
|
|
return val ? JSVAL_TRUE : JSVAL_FALSE;
|
|
}
|
|
|
|
template<> jsval ScriptInterface::ToJSVal<float>(JSContext* cx, const float& val)
|
|
{
|
|
jsval rval = JSVAL_VOID;
|
|
JS_NewNumberValue(cx, val, &rval); // ignore return value
|
|
return rval;
|
|
}
|
|
|
|
template<> jsval ScriptInterface::ToJSVal<double>(JSContext* cx, const double& val)
|
|
{
|
|
jsval rval = JSVAL_VOID;
|
|
JS_NewNumberValue(cx, val, &rval); // ignore return value
|
|
return rval;
|
|
}
|
|
|
|
template<> jsval ScriptInterface::ToJSVal<i32>(JSContext* UNUSED(cx), const i32& val)
|
|
{
|
|
cassert(JSVAL_INT_BITS == 32);
|
|
return INT_TO_JSVAL(val);
|
|
}
|
|
|
|
template<> jsval ScriptInterface::ToJSVal<u16>(JSContext* UNUSED(cx), const u16& val)
|
|
{
|
|
return INT_TO_JSVAL(val);
|
|
}
|
|
|
|
template<> jsval ScriptInterface::ToJSVal<u8>(JSContext* UNUSED(cx), const u8& val)
|
|
{
|
|
return INT_TO_JSVAL(val);
|
|
}
|
|
|
|
template<> jsval ScriptInterface::ToJSVal<u32>(JSContext* cx, const u32& val)
|
|
{
|
|
if (val <= JSVAL_INT_MAX)
|
|
return INT_TO_JSVAL(val);
|
|
jsval rval = JSVAL_VOID;
|
|
JS_NewNumberValue(cx, val, &rval); // ignore return value
|
|
return rval;
|
|
}
|
|
|
|
template<> jsval ScriptInterface::ToJSVal<long>(JSContext* UNUSED(cx), const long& val)
|
|
{
|
|
return INT_TO_JSVAL((int)val);
|
|
}
|
|
|
|
template<> jsval ScriptInterface::ToJSVal<unsigned long>(JSContext* UNUSED(cx), const unsigned long& val)
|
|
{
|
|
return INT_TO_JSVAL((int)val);
|
|
}
|
|
|
|
// (s)size_t are considered to be identical to (unsigned) int by GCC and
|
|
// their specializations would cause conflicts there. On x86_64 GCC, s/size_t
|
|
// is equivalent to (unsigned) long, but the same solution applies; use the
|
|
// long and unsigned long specializations instead of s/size_t.
|
|
// for some reason, x64 MSC treats size_t as distinct from unsigned long:
|
|
#if MSC_VERSION && ARCH_AMD64
|
|
|
|
template<> jsval ScriptInterface::ToJSVal<size_t>(JSContext* UNUSED(cx), const size_t& val)
|
|
{
|
|
return INT_TO_JSVAL((int)val);
|
|
}
|
|
|
|
template<> jsval ScriptInterface::ToJSVal<ssize_t>(JSContext* UNUSED(cx), const ssize_t& val)
|
|
{
|
|
return INT_TO_JSVAL((int)val);
|
|
}
|
|
|
|
#endif
|
|
|
|
// NOTE: we can't define a jsval specialisation, because that conflicts with integer types
|
|
template<> jsval ScriptInterface::ToJSVal<CScriptVal>(JSContext* UNUSED(cx), const CScriptVal& val)
|
|
{
|
|
return val.get();
|
|
}
|
|
|
|
template<> jsval ScriptInterface::ToJSVal<CScriptValRooted>(JSContext* UNUSED(cx), const CScriptValRooted& val)
|
|
{
|
|
return val.get();
|
|
}
|
|
|
|
template<> jsval ScriptInterface::ToJSVal<std::wstring>(JSContext* cx, const std::wstring& val)
|
|
{
|
|
utf16string utf16(val.begin(), val.end());
|
|
JSString* str = JS_NewUCStringCopyN(cx, reinterpret_cast<const jschar*> (utf16.c_str()), utf16.length());
|
|
if (str)
|
|
return STRING_TO_JSVAL(str);
|
|
return JSVAL_VOID;
|
|
}
|
|
|
|
template<> jsval ScriptInterface::ToJSVal<Path>(JSContext* cx, const Path& val)
|
|
{
|
|
return ToJSVal(cx, val.string());
|
|
}
|
|
|
|
template<> jsval ScriptInterface::ToJSVal<std::string>(JSContext* cx, const std::string& val)
|
|
{
|
|
JSString* str = JS_NewStringCopyN(cx, val.c_str(), val.length());
|
|
if (str)
|
|
return STRING_TO_JSVAL(str);
|
|
return JSVAL_VOID;
|
|
}
|
|
|
|
template<> jsval ScriptInterface::ToJSVal<const wchar_t*>(JSContext* cx, const wchar_t* const& val)
|
|
{
|
|
return ToJSVal(cx, std::wstring(val));
|
|
}
|
|
|
|
template<> jsval ScriptInterface::ToJSVal<const char*>(JSContext* cx, const char* const& val)
|
|
{
|
|
JSString* str = JS_NewStringCopyZ(cx, val);
|
|
if (str)
|
|
return STRING_TO_JSVAL(str);
|
|
return JSVAL_VOID;
|
|
}
|
|
|
|
template<> jsval ScriptInterface::ToJSVal<CStrW>(JSContext* cx, const CStrW& val)
|
|
{
|
|
return ToJSVal(cx, static_cast<const std::wstring&>(val));
|
|
}
|
|
|
|
template<> jsval ScriptInterface::ToJSVal<CStr8>(JSContext* cx, const CStr8& val)
|
|
{
|
|
return ToJSVal(cx, static_cast<const std::string&>(val));
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////
|
|
// Compound types:
|
|
|
|
template<typename T> static jsval ToJSVal_vector(JSContext* cx, const std::vector<T>& val)
|
|
{
|
|
JSObject* obj = JS_NewArrayObject(cx, (jsint)val.size(), NULL);
|
|
if (!obj)
|
|
return JSVAL_VOID;
|
|
for (size_t i = 0; i < val.size(); ++i)
|
|
{
|
|
jsval el = ScriptInterface::ToJSVal<T>(cx, val[i]);
|
|
JS_SetElement(cx, obj, (jsint)i, &el);
|
|
}
|
|
return OBJECT_TO_JSVAL(obj);
|
|
}
|
|
|
|
template<typename T> static bool FromJSVal_vector(JSContext* cx, jsval v, std::vector<T>& out)
|
|
{
|
|
JSObject* obj;
|
|
if (!JS_ValueToObject(cx, v, &obj) || obj == NULL || !(JS_IsArrayObject(cx, obj) || js_IsTypedArray(obj)))
|
|
FAIL("Argument must be an array");
|
|
jsuint length;
|
|
if (!JS_GetArrayLength(cx, obj, &length))
|
|
FAIL("Failed to get array length");
|
|
out.reserve(length);
|
|
for (jsuint i = 0; i < length; ++i)
|
|
{
|
|
jsval el;
|
|
if (!JS_GetElement(cx, obj, i, &el))
|
|
FAIL("Failed to read array element");
|
|
T el2;
|
|
if (!ScriptInterface::FromJSVal<T>(cx, el, el2))
|
|
return false;
|
|
out.push_back(el2);
|
|
}
|
|
return true;
|
|
}
|
|
|
|
// Instantiate various vector types:
|
|
|
|
#define VECTOR(T) \
|
|
template<> jsval ScriptInterface::ToJSVal<std::vector<T> >(JSContext* cx, const std::vector<T>& val) \
|
|
{ \
|
|
return ToJSVal_vector(cx, val); \
|
|
} \
|
|
template<> bool ScriptInterface::FromJSVal<std::vector<T> >(JSContext* cx, jsval v, std::vector<T>& out) \
|
|
{ \
|
|
return FromJSVal_vector(cx, v, out); \
|
|
}
|
|
|
|
VECTOR(int)
|
|
VECTOR(u32)
|
|
VECTOR(u16)
|
|
VECTOR(std::string)
|
|
VECTOR(std::wstring)
|
|
VECTOR(CScriptValRooted)
|
|
|
|
|
|
class IComponent;
|
|
template<> jsval ScriptInterface::ToJSVal<std::vector<IComponent*> >(JSContext* cx, const std::vector<IComponent*>& val)
|
|
{
|
|
return ToJSVal_vector(cx, val);
|
|
}
|
|
|
|
template<> bool ScriptInterface::FromJSVal<std::vector<Entity> >(JSContext* cx, jsval v, std::vector<Entity>& out)
|
|
{
|
|
return FromJSVal_vector(cx, v, out);
|
|
}
|