Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 77
Expand file tree
/
Copy pathEngine.h
More file actions
277 lines (234 loc) · 9.31 KB
/
Copy pathEngine.h
File metadata and controls
277 lines (234 loc) · 9.31 KB
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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
/*
* Tencent is pleased to support the open source community by making ScriptX available.
* Copyright (C) 2021 THL A29 Limited, a Tencent company. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#pragma once
#include <memory>
#include <string_view>
#include <unordered_map>
#include <unordered_set>
#include "Reference.h"
#include "Value.h"
#include "types.h"
#include "utils/MessageQueue.h"
#include "utils/TypeInformation.h"
namespace script {
class ScriptEngine {
protected:
std::unordered_map<internal::TypeIndex, const internal::ClassDefineState*> classDefineRegistry_{};
std::unordered_set<const internal::ClassDefineState*> staticClassDefineRegistry_{};
std::shared_ptr<void> userData_{};
public:
explicit ScriptEngine(std::shared_ptr<utils::MessageQueue> messageQueue = {}) {}
/**
* destroy this ScriptEngine instance, and delete itself.
* ScriptEngine don't expose a public destructor,
* since C++ don't allow virtual method call inside which.
* we use this method instead of a destructor.
*
* note: please release any resource got from this ScriptEngine, like Global, Weak ref,
* otherwise it's undefined behavior.
*
*/
virtual void destroy() = 0;
/**
* check if the engine is in the process of destroying.
* this is usually used in destructor of ScriptClass, to check if ScriptEngine API can be called.
*
* note: when enter EngineScope with a destroying engine, it throws std::logic_error
*/
virtual bool isDestroying() const = 0;
SCRIPTX_DISALLOW_COPY_AND_MOVE(ScriptEngine);
/**
* the delete impl for ScriptEngine to be used with unique_ptr && shared_ptr
*/
struct Deleter {
void operator()(ScriptEngine* ptr) const noexcept { ptr->destroy(); }
};
/**
* get value from the script engine context
*/
virtual Local<Value> get(const Local<String>& key) = 0;
/**
* get value from the script engine context
*/
template <typename StringLike, StringLikeConcept(StringLike)>
Local<Value> get(StringLike&& keyStringLike) {
return get(String::newString(std::forward<StringLike>(keyStringLike)));
}
/*
* set value of the script engine context
*/
virtual void set(const Local<String>& key, const Local<Value>& value) = 0;
/**
* set value of the script engine context
*
* helper method handle convert of value to Local<Value>
* @param value any thing supported by the type converter
*/
template <typename T>
void set(const Local<String>& key, T&& value);
/**
* @param keyStringLike any thing can fit in String::new(keyStringLike)
* @param value any thing supported by the type converter
*/
template <typename StringLike, typename T = Local<Value>, StringLikeConcept(StringLike)>
void set(StringLike&& keyStringLike, T&& value);
/**
* @param script script content
* @param sourceFile debug name of the source file
* @return evaluate result
*/
virtual Local<Value> eval(const Local<String>& script, const Local<String>& sourceFile) = 0;
/**
* @param script script content
* @return evaluate result
*/
virtual Local<Value> eval(const Local<String>& script) = 0;
template <typename T, typename R = std::string, StringLikeConcept(T), StringLikeConcept(R)>
Local<Value> eval(T&& scriptStringLike, R&& sourceFileStringLike = {}) {
return eval(String::newString(std::forward<T>(scriptStringLike)),
String::newString(std::forward<R>(sourceFileStringLike)));
}
/**
* register a native class definition (constructor & property & function) to script.
* @tparam T a subclass of the NativeClass, which implements all the Script-Native method in cpp.
* (can be void if no instance is required).
* @param classDefine the pointer should be valid until the engine is destroyed.
* @throws ::script::Exception on failure or if the classDefine is already registered.
*/
template <typename T>
void registerNativeClass(const ClassDefine<T>& classDefine);
/**
* handy method to call NativeRegister::registerNativeClass.
*/
void registerNativeClass(const NativeRegister& nativeRegister);
/**
* the ClassDefine<T>* for type T, throw exception for not found
* @tparam T must be sub class of ScriptClass
* @return non-null
*/
template <typename T>
const ClassDefine<T>& getClassDefine() const;
template <typename T>
Local<Object> newNativeClass(const std::initializer_list<Local<Value>>& args);
/**
* create a script class instance of the given native classDefine.
* the classDefine must already be registered by registerNativeClass.
* @tparam T a subclass of the NativeClass, which implements all the Script-Native method in cpp.
* (can be void if no instance is required).
* @param classDefine the pointer should be valid until the engine is destroyed.
* @return the created value, null for failure.
* @throw Exception if ClassDefine<T> is not already registered.
*/
template <typename T>
Local<Object> newNativeClass(const std::vector<Local<Value>>& args);
/**
* typesafe variadic template helper method
* @tparam T MUST BE local reference, ie: Local<Type>. or supported raw C++ type to convert.
* @param classDefine the pointer should be valid until the engine is destroyed.
* @return the created value, null for failure.
* @throw Exception if ClassDefine<T> is not already registered.
*/
template <typename D, typename... T>
Local<Object> newNativeClass(T&&... args);
/**
* check whether value is instance of a registered native class
* @throw Exception if ClassDefine<T> is not already registered.
*/
template <typename T>
bool isInstanceOf(const Local<Value>& value);
/**
* if value is instance of a registered native class, return the native instance,
* else return nullptr.
* @throw Exception if ClassDefine<T> is not already registered.
*/
template <typename T>
T* getNativeInstance(const Local<Value>& value);
/**
* @return a MessageQueue to provide event-loop/run-loop facility
*
* note: when the engine is destroyed, it remove all message whose "tag == engine" in the queue,
* so all your engine related message should set tag to corresponding engine.
*/
virtual std::shared_ptr<utils::MessageQueue> messageQueue() = 0;
/**
* Suggest the engine to gc.
*/
virtual void gc() {}
/**
* Get how much memory this Engine takes in unit of Byte.
* return 0 for unknown value.
*/
virtual size_t getHeapSize() { return 0; }
/**
* An associated memory is native memory associated with script object.
* This method is just an suggest to the engine,
* helps it measure memory pressure more precisely.
* @param count positive for allocation, negative for deallocation.
*/
virtual void adjustAssociatedMemory(int64_t count) { SCRIPTX_UNUSED(count); }
/**
* @return script language the engine supported
*/
virtual ScriptLanguage getLanguageType() = 0;
/**
* @return the backend engine version string
*/
virtual std::string getEngineVersion() = 0;
/**
* set any arbitrary user data to the engine, the shared_ptr will get released on engine destroy.
*/
void setData(std::shared_ptr<void> arbitraryData);
/**
* get the set arbitrary user data by setData(), return null if not previously set.
*/
template <typename T = void>
std::shared_ptr<T> getData();
protected:
/**
* should not be public, use destroy instead of dtor.
*/
virtual ~ScriptEngine() = default;
void destroyUserData();
// non-template version of ClassDefine related api
private:
void registerNativeClassInternal(
internal::TypeIndex typeIndex, const internal::ClassDefineState* classDefine,
ScriptClass* (*instanceTypeToScriptClass)(void* instancePointer));
const internal::ClassDefineState* getClassDefineInternal(internal::TypeIndex typeIndex) const;
// implemented by backend
protected:
virtual void performRegisterNativeClass(
internal::TypeIndex typeIndex, const internal::ClassDefineState* classDefine,
ScriptClass* (*instanceTypeToScriptClass)(void* instancePointer)) = 0;
virtual Local<Object> performNewNativeClass(internal::TypeIndex typeIndex,
const internal::ClassDefineState* classDefine,
size_t size, const Local<Value>* args) = 0;
virtual bool performIsInstanceOf(const Local<Value>& value,
const internal::ClassDefineState* classDefine) = 0;
/**
* @param value
* @param classDefine
* @return pointer of the instance
*/
virtual void* performGetNativeInstance(const Local<Value>& value,
const internal::ClassDefineState* classDefine) = 0;
};
/**
* ScriptEngine don't have public destructor, use ScriptEngine::Deleter.
*/
using UniqueEnginePtr = std::unique_ptr<ScriptEngine, ScriptEngine::Deleter>;
} // namespace script
You can’t perform that action at this time.