File: ScriptConversions.h

package info (click to toggle)
0ad 0.28.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 182,352 kB
  • sloc: cpp: 201,989; javascript: 19,730; ansic: 15,057; python: 6,597; sh: 2,046; perl: 1,232; xml: 543; java: 533; makefile: 105
file content (199 lines) | stat: -rw-r--r-- 5,506 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
/* Copyright (C) 2025 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/>.
 */

#ifndef INCLUDED_SCRIPTCONVERSIONS
#define INCLUDED_SCRIPTCONVERSIONS

#include "lib/code_generation.h"
#include "lib/debug.h"
#include "lib/types.h"
#include "ps/CStr.h"
#include "scriptinterface/ScriptExceptions.h"
#include "scriptinterface/ScriptRequest.h"

#include <js/Array.h>
#include <js/PropertyAndElement.h>
#include <js/RootingAPI.h>
#include <js/TypeDecls.h>
#include <js/Value.h>
#include <js/experimental/TypedData.h>
#include <limits>
#include <optional>
#include <string>
#include <utility>
#include <vector>

namespace Script
{
/**
 * Convert a JS::Value to a C++ type. (This might trigger GC.)
 */
template<typename T> bool FromJSVal(const ScriptRequest& rq, const JS::HandleValue val, T& ret);

template<typename T>
bool FromJSVal(const ScriptRequest& rq, JS::HandleValue v, std::optional<T>& out)
{
	if (v.isNullOrUndefined())
	{
		out = std::nullopt;
		return true;
	}
	T value;
	if (!FromJSVal(rq, v, value))
		return false;
	out = std::move(value);
	return true;
}

/**
 * Convert a C++ type to a JS::Value. (This might trigger GC. The return
 * value must be rooted if you don't want it to be collected.)
 * NOTE: We are passing the JS::Value by reference instead of returning it by value.
 * The reason is a memory corruption problem that appears to be caused by a bug in Visual Studio.
 * Details here: http://www.wildfiregames.com/forum/index.php?showtopic=17289&p=285921
 */
template<typename T> void ToJSVal(const ScriptRequest& rq, JS::MutableHandleValue ret, T const& val);

template<std::size_t N>
void ToJSVal(const ScriptRequest& rq, JS::MutableHandleValue ret, const char (&val)[N])
{
	ToJSVal(rq, ret, static_cast<const char*>(val));
}
template<std::size_t N>
void ToJSVal(const ScriptRequest& rq, JS::MutableHandleValue ret, const wchar_t (&val)[N])
{
	ToJSVal(rq, ret, static_cast<const wchar_t*>(val));
}

template<>
inline void ToJSVal<JS::PersistentRootedValue>(const ScriptRequest&, JS::MutableHandleValue handle,
	const JS::PersistentRootedValue& a)
{
	handle.set(a);
}

template<>
inline void ToJSVal<JS::Heap<JS::Value> >(const ScriptRequest&, JS::MutableHandleValue handle,
	const JS::Heap<JS::Value>& a)
{
	handle.set(a);
}

template<>
inline void ToJSVal<JS::RootedValue>(const ScriptRequest&, JS::MutableHandleValue handle,
	const JS::RootedValue& a)
{
	handle.set(a);
}

template <>
inline void ToJSVal<JS::HandleValue>(const ScriptRequest&, JS::MutableHandleValue handle,
	const JS::HandleValue& a)
{
	handle.set(a);
}

/**
 * Convert a named property of an object to a C++ type.
 */
template<typename T> inline bool FromJSProperty(const ScriptRequest& rq, const JS::HandleValue val, const char* name, T& ret, bool strict = false)
{
	if (!val.isObject())
		return false;

	JS::RootedObject obj(rq.cx, &val.toObject());

	bool hasProperty;
	if (!JS_HasProperty(rq.cx, obj, name, &hasProperty) || !hasProperty)
		return false;

	JS::RootedValue value(rq.cx);
	if (!JS_GetProperty(rq.cx, obj, name, &value))
		return false;

	if (strict && value.isNull())
		return false;

	return FromJSVal(rq, value, ret);
}

template<typename T> inline void ToJSVal_vector(const ScriptRequest& rq, JS::MutableHandleValue ret, const std::vector<T>& val)
{
	JS::RootedObject obj(rq.cx, JS::NewArrayObject(rq.cx, 0));
	if (!obj)
	{
		ret.setUndefined();
		return;
	}

	ENSURE(val.size() <= std::numeric_limits<u32>::max());
	for (u32 i = 0; i < val.size(); ++i)
	{
		JS::RootedValue el(rq.cx);
		Script::ToJSVal<T>(rq, &el, val[i]);
		JS_SetElement(rq.cx, obj, i, el);
	}
	ret.setObject(*obj);
}

#define FAIL(msg) STMT(ScriptException::Raise(rq, msg); return false)

template<typename T> inline bool FromJSVal_vector(const ScriptRequest& rq, JS::HandleValue v, std::vector<T>& out)
{
	JS::RootedObject obj(rq.cx);
	if (!v.isObject())
		FAIL("Argument must be an array");

	bool isArray;
	obj = &v.toObject();
	if ((!JS::IsArrayObject(rq.cx, obj, &isArray) || !isArray) && !JS_IsTypedArrayObject(obj))
		FAIL("Argument must be an array");

	u32 length;
	if (!JS::GetArrayLength(rq.cx, obj, &length))
		FAIL("Failed to get array length");

	out.clear();
	out.reserve(length);
	for (u32 i = 0; i < length; ++i)
	{
		JS::RootedValue el(rq.cx);
		if (!JS_GetElement(rq.cx, obj, i, &el))
			FAIL("Failed to read array element");
		T el2{};
		if (!Script::FromJSVal<T>(rq, el, el2))
			return false;
		out.push_back(el2);
	}
	return true;
}

#undef FAIL

#define JSVAL_VECTOR(T) \
template<> void Script::ToJSVal<std::vector<T> >(const ScriptRequest& rq, JS::MutableHandleValue ret, const std::vector<T>& val) \
{ \
	ToJSVal_vector(rq, ret, val); \
} \
template<> bool Script::FromJSVal<std::vector<T> >(const ScriptRequest& rq, JS::HandleValue v, std::vector<T>& out) \
{ \
	return FromJSVal_vector(rq, v, out); \
}

} // namespace Script

#endif //INCLUDED_SCRIPTCONVERSIONS