forked from GaijinEntertainment/quirrel
-
Notifications
You must be signed in to change notification settings - Fork 0
/
sqmodules.cpp
481 lines (374 loc) · 11.8 KB
/
sqmodules.cpp
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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
#include "sqmodules.h"
#include "path.h"
#include <sqstdmath.h>
#include <sqstdstring.h>
#include <sqstdblob.h>
#include <sqstdio.h>
#include <sqstdsystem.h>
#include <sqstdaux.h>
#include <sqdirect.h>
#include <string.h>
#include <assert.h>
#ifdef _WIN32
# include <io.h>
#else
# include <unistd.h>
# define _access access
#endif
const char* SqModules::__main__ = "__main__";
const char* SqModules::__fn__ = nullptr;
static SQInteger persist_state(HSQUIRRELVM vm)
{
// arguments:
// 1 - module 'this', 2 - slot id, 3 - intitializer, 4 - state storage
assert(sq_gettype(vm, 4) == OT_TABLE);
const SQChar *slotName;
sq_getstring(vm, 2, &slotName);
sq_push(vm, 2); // slot id @ 5
if (SQ_SUCCEEDED(sq_get_noerr(vm, 4)))
return 1;
HSQOBJECT mState;
sq_getstackobj(vm, 4, &mState);
sq_push(vm, 3); // initializer
sq_push(vm, 1); // module 'this'
if (SQ_FAILED(sq_call(vm, 1, SQTrue, SQTrue)))
return sq_throwerror(vm, _SC("Failed to call initializer"));
SQObjectType tp = sq_gettype(vm, -1);
bool isMutable = tp==OT_TABLE || tp==OT_ARRAY || tp==OT_USERDATA || tp==OT_CLASS || tp==OT_INSTANCE;
if (!isMutable)
{
const SQChar *slotName = nullptr;
if (sq_getstring(vm, 2, &slotName))
return sqstd_throwerrorf(vm, _SC("Persist '%s' is not mutable, probably an error"), slotName);
else
return sq_throwerror(vm, _SC("Persist is not mutable, probably an error"));
}
HSQOBJECT res;
sq_getstackobj(vm, -1, &res);
sq_addref(vm, &res);
sq_pop(vm, 1); // initializer closure
sq_push(vm, 2); // slot id
sq_pushobject(vm, res); // initializer result
sq_newslot(vm, 4, false);
sq_pushobject(vm, res);
sq_release(vm, &res);
return 1;
}
static SQInteger keepref(HSQUIRRELVM vm)
{
// arguments: this, object, ref holder
sq_push(vm, 2); // push object
sq_arrayappend(vm, 3); // append to ref holder
sq_push(vm, 2); // push object again
return 1;
}
void SqModules::resolveFileName(const char *requested_fn, std::string &res)
{
res.clear();
std::vector<char> scriptPathBuf;
// try relative path first
if (!runningScripts.empty())
{
const std::string &curFile = runningScripts.back();
scriptPathBuf.resize(curFile.length()+2);
dd_get_fname_location(&scriptPathBuf[0], curFile.c_str());
dd_append_slash_c(&scriptPathBuf[0]);
size_t locationLen = strlen(&scriptPathBuf[0]);
size_t reqFnLen = strlen(requested_fn);
scriptPathBuf.resize(locationLen + reqFnLen + 1);
strcpy(&scriptPathBuf[locationLen], requested_fn);
dd_simplify_fname_c(&scriptPathBuf[0]);
scriptPathBuf.resize(strlen(&scriptPathBuf[0])+1);
bool exists = _access(&scriptPathBuf[0], 0) == 0;
if (exists)
res.insert(res.end(), scriptPathBuf.begin(), scriptPathBuf.end());
}
if (res.empty())
{
scriptPathBuf.resize(strlen(requested_fn)+1);
strcpy(&scriptPathBuf[0], requested_fn);
dd_simplify_fname_c(&scriptPathBuf[0]);
res.insert(res.end(), scriptPathBuf.begin(), scriptPathBuf.end());
}
}
bool SqModules::checkCircularReferences(const char* resolved_fn, const char *requested_fn)
{
for (const std::string& scriptFn : runningScripts)
if (scriptFn == resolved_fn)
return false;
return true;
}
SqModules::CompileScriptResult SqModules::compileScript(const char *resolved_fn, const char *requested_fn,
SqObjPtr &script_closure, std::string &out_err_msg)
{
script_closure.release();
FILE* f = fopen(resolved_fn, "r");
if (!f)
{
out_err_msg = std::string("Script file not found: ") + requested_fn +" / " + resolved_fn;
return CompileScriptResult::FileNotFound;
}
std::vector<char> buf;
#ifdef _WIN32
long len = _filelength(_fileno(f));
#else
fseek(f, 0, SEEK_END);
long len = ftell(f);
if (len < 0)
{
fclose(f);
out_err_msg = std::string("Cannot read script file: ") + requested_fn +" / " + resolved_fn;
return CompileScriptResult::FileNotFound;
}
fseek(f, 0, SEEK_SET);
#endif
buf.resize(len+1);
fread(&buf[0], 1, len, f);
buf[len] = 0;
fclose(f);
if (SQ_FAILED(sq_compilebuffer(sqvm, &buf[0], len, resolved_fn, true)))
{
out_err_msg = std::string("Failed to compile file: ") + requested_fn +" / " + resolved_fn;
return CompileScriptResult::CompilationFailed;
}
script_closure.attachToStack(sqvm, -1);
sq_pop(sqvm, 1);
return CompileScriptResult::Ok;
}
SqModules::SqObjPtr SqModules::setupStateStorage(HSQOBJECT hContext, const char* resolved_fn)
{
bool havePrevState = false;
for (const Module &prevMod : prevModules)
if (dd_fname_equal(prevMod.fn.c_str(), resolved_fn))
return prevMod.stateStorage;
HSQOBJECT ho;
sq_newtable(sqvm);
sq_getstackobj(sqvm, -1, &ho);
SqObjPtr res(sqvm, ho);
sq_poptop(sqvm);
return res;
}
SqModules::Module * SqModules::findModule(const char * resolved_fn)
{
for (Module &m : modules)
if (dd_fname_equal(resolved_fn, m.fn.c_str()))
return &m;
return nullptr;
}
// replaces closure at stack position -1 with one bound to environment
static void bind_closure(HSQUIRRELVM vm, HSQOBJECT env)
{
HSQOBJECT hBoundClosure;
sq_pushobject(vm, env);
sq_bindenv(vm, -2);
sq_getstackobj(vm, -1, &hBoundClosure);
sq_addref(vm, &hBoundClosure);
sq_pop(vm, 2);
sq_pushobject(vm, hBoundClosure);
sq_release(vm, &hBoundClosure);
}
void SqModules::bindRequireApi(HSQOBJECT module_this)
{
sq_pushobject(sqvm, module_this);
sq_pushstring(sqvm, _SC("require"), 7);
sq_pushuserpointer(sqvm, this);
sq_newclosure(sqvm, sqRequire<true>, 1);
sq_setparamscheck(sqvm, 2, _SC(".s"));
bind_closure(sqvm, module_this);
sq_rawset(sqvm, -3);
sq_pushstring(sqvm, _SC("require_optional"), 16);
sq_pushuserpointer(sqvm, this);
sq_newclosure(sqvm, sqRequire<false>, 1);
sq_setparamscheck(sqvm, 2, _SC(".s"));
bind_closure(sqvm, module_this);
sq_rawset(sqvm, -3);
sq_poptop(sqvm); // module_this
}
bool SqModules::requireModule(const char *requested_fn, bool must_exist, const char *__name__,
SqObjPtr &exports, std::string &out_err_msg)
{
out_err_msg.clear();
exports.release();
std::string resolvedFn;
resolveFileName(requested_fn, resolvedFn);
if (!checkCircularReferences(resolvedFn.c_str(), requested_fn))
{
out_err_msg = "Circular references error";
// ^ will not be needed because of fatal() but keep it for the case of future changes
return false;
}
if (Module * found = findModule(resolvedFn.c_str()))
{
exports = found->exports;
return true;
}
SQInteger prevTop = sq_gettop(sqvm);
(void)prevTop;
SqObjPtr scriptClosure;
CompileScriptResult res = compileScript(resolvedFn.c_str(), requested_fn, scriptClosure, out_err_msg);
if (!must_exist && res == CompileScriptResult::FileNotFound)
{
exports.release();
return true;
}
if (res != CompileScriptResult::Ok)
return false;
if (__name__ == __fn__)
__name__ = resolvedFn.c_str();
HSQUIRRELVM vm = sqvm;
sq_pushobject(vm, scriptClosure.o);
sq_newtable(vm);
HSQOBJECT hThis;
sq_getstackobj(vm, -1, &hThis);
assert(sq_gettype(vm, -1) == OT_TABLE);
SqObjPtr objThis(vm, hThis);
SqObjPtr stateStorage = setupStateStorage(hThis, resolvedFn.c_str());
assert(sq_gettop(vm) == prevTop+2); // module closure+context
sq_pushstring(vm, "persist", 7);
sq_pushobject(vm, stateStorage.o);
sq_newclosure(vm, persist_state, 1);
sq_setparamscheck(vm, 3, ".sc");
bind_closure(vm, hThis);
sq_rawset(vm, -3);
sq_newarray(vm, 0);
SqObjPtr refHolder;
refHolder.attachToStack(vm, -1);
sq_poptop(vm);
sq_pushstring(vm, "keepref", 7);
sq_pushobject(vm, refHolder.o);
sq_newclosure(vm, keepref, 1);
bind_closure(vm, hThis);
sq_rawset(vm, -3);
sq_pushstring(vm, "__name__", 8);
sq_pushstring(vm, __name__, -1);
sq_rawset(vm, -3);
assert(sq_gettop(vm) == prevTop+2); // module closure+context
bindRequireApi(hThis);
assert(sq_gettop(vm) == prevTop+2); // module closure+context
size_t rsIdx = runningScripts.size();
runningScripts.emplace_back(resolvedFn.c_str());
SQRESULT callRes = sq_call(vm, 1, true, true);
(void)rsIdx;
assert(runningScripts.size() == rsIdx+1);
runningScripts.pop_back();
if (SQ_FAILED(callRes))
{
out_err_msg = std::string("Failed to run script ") + requested_fn + " / " + resolvedFn;
sq_pop(vm, 1); // clojure, no return value on error
return false;
}
HSQOBJECT hExports;
sq_getstackobj(vm, -1, &hExports);
exports = SqObjPtr(vm, hExports);
sq_pop(vm, 2); // retval + closure
assert(sq_gettop(vm) == prevTop);
Module module;
module.exports = exports;
module.fn = resolvedFn;
module.stateStorage = stateStorage;
module.moduleThis = objThis;
module.refHolder = refHolder;
module.__name__ = __name__;
modules.push_back(module);
return true;
}
bool SqModules::reloadModule(const char *fn, bool must_exist, const char *__name__, SqObjPtr &exports, std::string &out_err_msg)
{
assert(prevModules.empty());
std::string resolvedFn;
resolveFileName(fn, resolvedFn);
Module * found = findModule(resolvedFn.c_str());
modules.swap(prevModules);
modules.clear(); // just in case
std::string errMsg;
bool res = requireModule(fn, must_exist, __name__, exports, out_err_msg);
prevModules.clear();
return res;
}
bool SqModules::reloadAll(std::string &full_err_msg)
{
assert(prevModules.empty());
full_err_msg.clear();
modules.swap(prevModules);
modules.clear(); // just in case
bool res = true;
SqObjPtr exportsTmp;
std::string errMsg;
for (const Module &prev : prevModules)
{
if (!requireModule(prev.fn.c_str(), true, prev.__name__.c_str(), exportsTmp, errMsg))
{
res = false;
full_err_msg += prev.fn + ": " + errMsg + "\n";
}
}
prevModules.clear();
return res;
}
bool SqModules::addNativeModule(const char *module_name, const SqObjPtr &exports)
{
if (!module_name || !*module_name)
return false;
auto ins = nativeModules.insert({std::string(module_name), exports});
return ins.second; // false if already registered
}
template<bool must_exist> SQInteger SqModules::sqRequire(HSQUIRRELVM vm)
{
SQUserPointer selfPtr = nullptr;
if (SQ_FAILED(sq_getuserpointer(vm, -1, &selfPtr)) || !selfPtr)
return sq_throwerror(vm, "No module manager");
SqModules *self = reinterpret_cast<SqModules *>(selfPtr);
assert(self->sqvm == vm);
const char *fileName = nullptr;
SQInteger fileNameLen = -1;
sq_getstringandsize(vm, 2, &fileName, &fileNameLen);
if (strcmp(fileName, "squirrel.native_modules")==0)
{
sq_newarray(vm, self->nativeModules.size());
SQInteger idx = 0;
for (auto &nm : self->nativeModules)
{
sq_pushinteger(vm, idx);
sq_pushstring(vm, nm.first.data(), -1);
sq_set(vm, -3);
++idx;
}
return 1;
}
auto nativeIt = self->nativeModules.find(fileName);
if (nativeIt != self->nativeModules.end())
{
sq_pushobject(vm, nativeIt->second.o);
return 1;
}
SqObjPtr exports;
std::string errMsg;
if (!self->requireModule(fileName, must_exist, __fn__, exports, errMsg))
return sq_throwerror(vm, errMsg.c_str());
sq_pushobject(vm, exports.o);
return 1;
}
void SqModules::registerBaseLibNativeModule(const char *name, RegFunc reg_func)
{
HSQOBJECT hModule;
sq_newtable(sqvm);
sq_getstackobj(sqvm, -1, &hModule);
reg_func(sqvm);
bool regRes = addNativeModule(name, SqObjPtr(sqvm, hModule));
assert(regRes);
sq_pop(sqvm, 1);
}
void SqModules::registerBaseLibs()
{
registerBaseLibNativeModule("math", sqstd_register_mathlib);
registerBaseLibNativeModule("string", sqstd_register_stringlib);
registerBaseLibNativeModule("blob", sqstd_register_bloblib);
}
void SqModules::registerSystemLib()
{
registerBaseLibNativeModule("system", sqstd_register_systemlib);
}
void SqModules::registerIoLib()
{
registerBaseLibNativeModule("io", sqstd_register_iolib);
}