This repository has been archived by the owner. It is now read-only.
Permalink
Please
sign in to comment.
Browse files
core, vm: refactor module system
Make it more similar to Node y wrapping files in a CommonJS wrapper before executing. Also expose __filename and __dirname. This uses a slightly modified version of the Node module system Duktape extra. Refs: #32
- Loading branch information
Showing
with
536 additions
and 215 deletions.
- +1 −0 CMakeLists.txt
- +10 −3 docs/source/modules.rst
- +7 −2 docs/source/usage.rst
- +7 −0 include/sjs/vm.h
- +4 −4 src/cli/cli.c
- +285 −0 src/duk_module_node.c
- +10 −0 src/duk_module_node.h
- +4 −1 src/internal.h
- +128 −135 src/modules.c
- +72 −53 src/vm.c
- +0 −9 test/test-duktape-modsearch-writable.js
- +1 −1 test/test-module-file.js
- +1 −1 test/test-os-fork-execv.js
- +1 −1 test/test-os-fork-execve-args.js
- +1 −1 test/test-os-fork-execve-env.js
- +1 −1 test/test-os-fork-execve.js
- +1 −1 test/test-os-popen-sample.js
- +1 −1 test/test-require-bad-dir.js
- +1 −1 test/test-shebang-require.js
| @@ -0,0 +1,285 @@ | ||
| /* | ||
| * Node.js-like module loading framework for Duktape | ||
| * | ||
| * https://nodejs.org/api/modules.html | ||
| */ | ||
|
|
||
| #include <libgen.h> | ||
|
|
||
| #include "duktape.h" | ||
| #include "duk_module_node.h" | ||
|
|
||
|
|
||
| static duk_int_t duk__eval_module_source(duk_context *ctx); | ||
| static void duk__push_module_object(duk_context *ctx, const char *id); | ||
|
|
||
| static duk_bool_t duk__get_cached_module(duk_context *ctx, const char *id) { | ||
| duk_push_global_stash(ctx); | ||
| (void) duk_get_prop_string(ctx, -1, "\xff" "requireCache"); | ||
| if (duk_get_prop_string(ctx, -1, id)) { | ||
| duk_remove(ctx, -2); | ||
| duk_remove(ctx, -2); | ||
| return 1; | ||
| } else { | ||
| duk_pop_3(ctx); | ||
| return 0; | ||
| } | ||
| } | ||
|
|
||
| /* Place a `module` object on the top of the value stack into the require cache | ||
| * based on its `.id` property. As a convenience to the caller, leave the | ||
| * object on top of the value stack afterwards. | ||
| */ | ||
| static void duk__put_cached_module(duk_context *ctx) { | ||
| /* [ ... module ] */ | ||
|
|
||
| duk_push_global_stash(ctx); | ||
| (void) duk_get_prop_string(ctx, -1, "\xff" "requireCache"); | ||
| duk_dup(ctx, -3); | ||
|
|
||
| /* [ ... module stash req_cache module ] */ | ||
|
|
||
| (void) duk_get_prop_string(ctx, -1, "id"); | ||
| duk_dup(ctx, -2); | ||
| duk_put_prop(ctx, -4); | ||
|
|
||
| duk_pop_3(ctx); /* [ ... module ] */ | ||
| } | ||
|
|
||
| static void duk__del_cached_module(duk_context *ctx, const char *id) { | ||
| duk_push_global_stash(ctx); | ||
| (void) duk_get_prop_string(ctx, -1, "\xff" "requireCache"); | ||
| duk_del_prop_string(ctx, -1, id); | ||
| duk_pop_2(ctx); | ||
| } | ||
|
|
||
| static duk_ret_t duk__handle_require(duk_context *ctx) { | ||
| /* | ||
| * Value stack handling here is a bit sloppy but should be correct. | ||
| * Call handling will clean up any extra garbage for us. | ||
| */ | ||
|
|
||
| const char *id; | ||
| const char *parent_id; | ||
| duk_idx_t module_idx; | ||
| duk_idx_t stash_idx; | ||
| duk_int_t ret; | ||
|
|
||
| duk_push_global_stash(ctx); | ||
| stash_idx = duk_normalize_index(ctx, -1); | ||
|
|
||
| duk_push_current_function(ctx); | ||
| (void) duk_get_prop_string(ctx, -1, "\xff" "moduleId"); | ||
| parent_id = duk_require_string(ctx, -1); | ||
| (void) parent_id; /* not used directly; suppress warning */ | ||
|
|
||
| /* [ id stash require parent_id ] */ | ||
|
|
||
| id = duk_require_string(ctx, 0); | ||
|
|
||
| (void) duk_get_prop_string(ctx, stash_idx, "\xff" "modResolve"); | ||
| duk_dup(ctx, 0); /* module ID */ | ||
| duk_dup(ctx, -3); /* parent ID */ | ||
| duk_call(ctx, 2); | ||
|
|
||
| /* [ ... stash ... resolved_id ] */ | ||
|
|
||
| id = duk_require_string(ctx, -1); | ||
|
|
||
| if (duk__get_cached_module(ctx, id)) { | ||
| goto have_module; /* use the cached module */ | ||
| } | ||
|
|
||
| duk__push_module_object(ctx, id); | ||
| duk__put_cached_module(ctx); /* module remains on stack */ | ||
|
|
||
| /* | ||
| * From here on out, we have to be careful not to throw. If it can't be | ||
| * avoided, the error must be caught and the module removed from the | ||
| * require cache before rethrowing. This allows the application to | ||
| * reattempt loading the module. | ||
| */ | ||
|
|
||
| module_idx = duk_normalize_index(ctx, -1); | ||
|
|
||
| /* [ ... stash ... resolved_id module ] */ | ||
|
|
||
| (void) duk_get_prop_string(ctx, stash_idx, "\xff" "modLoad"); | ||
| duk_dup(ctx, -3); /* resolved ID */ | ||
| (void) duk_get_prop_string(ctx, module_idx, "exports"); | ||
| duk_dup(ctx, module_idx); | ||
| ret = duk_pcall(ctx, 3); | ||
| if (ret != DUK_EXEC_SUCCESS) { | ||
| duk__del_cached_module(ctx, id); | ||
| duk_throw(ctx); /* rethrow */ | ||
| } | ||
|
|
||
| if (duk_is_string(ctx, -1)) { | ||
| duk_int_t ret; | ||
|
|
||
| /* [ ... module source ] */ | ||
|
|
||
| ret = duk_safe_call(ctx, duk__eval_module_source, 2, 1); | ||
| if (ret != DUK_EXEC_SUCCESS) { | ||
| duk__del_cached_module(ctx, id); | ||
| duk_throw(ctx); /* rethrow */ | ||
| } | ||
| } else if (duk_is_undefined(ctx, -1)) { | ||
| duk_pop(ctx); | ||
| } else { | ||
| duk__del_cached_module(ctx, id); | ||
| duk_error(ctx, DUK_ERR_API_ERROR, "invalid module load callback return value"); | ||
| } | ||
|
|
||
| /* fall through */ | ||
|
|
||
| have_module: | ||
| /* [ ... module ] */ | ||
|
|
||
| (void) duk_get_prop_string(ctx, -1, "exports"); | ||
| return 1; | ||
| } | ||
|
|
||
| static void duk__push_require_function(duk_context *ctx, const char *id) { | ||
| duk_push_c_function(ctx, duk__handle_require, 1); | ||
| duk_push_string(ctx, "name"); | ||
| duk_push_string(ctx, "require"); | ||
| duk_def_prop(ctx, -3, DUK_DEFPROP_HAVE_VALUE); | ||
| duk_push_string(ctx, id); | ||
| duk_put_prop_string(ctx, -2, "\xff" "moduleId"); | ||
|
|
||
| /* require.cache */ | ||
| duk_push_global_stash(ctx); | ||
| (void) duk_get_prop_string(ctx, -1, "\xff" "requireCache"); | ||
| duk_put_prop_string(ctx, -3, "cache"); | ||
| duk_pop(ctx); | ||
| } | ||
|
|
||
| static void duk__push_module_object(duk_context *ctx, const char *id) { | ||
| duk_push_object(ctx); | ||
|
|
||
| /* Node.js uses the canonicalized filename of a module for both module.id | ||
| * and module.filename. We have no concept of a file system here, so just | ||
| * use the module ID for both values. | ||
| */ | ||
| duk_push_string(ctx, id); | ||
| duk_dup(ctx, -1); | ||
| duk_put_prop_string(ctx, -3, "filename"); | ||
| duk_put_prop_string(ctx, -2, "id"); | ||
|
|
||
| /* module.exports = {} */ | ||
| duk_push_object(ctx); | ||
| duk_put_prop_string(ctx, -2, "exports"); | ||
|
|
||
| /* module.loaded = false */ | ||
| duk_push_false(ctx); | ||
| duk_put_prop_string(ctx, -2, "loaded"); | ||
|
|
||
| /* module.require */ | ||
| duk__push_require_function(ctx, id); | ||
| duk_put_prop_string(ctx, -2, "require"); | ||
| } | ||
|
|
||
| static duk_int_t duk__eval_module_source(duk_context *ctx) { | ||
| /* | ||
| * Stack: [ ... module source ] | ||
| */ | ||
|
|
||
| const char* filename; | ||
| char tmp[8192]; | ||
|
|
||
| /* Wrap the module code in a function expression. This is the simplest | ||
| * way to implement CommonJS closure semantics and matches the behavior of | ||
| * e.g. Node.js. | ||
| */ | ||
| duk_push_string(ctx, "(function main(exports,require,module,__filename,__dirname){"); | ||
| duk_dup(ctx, -2); /* source */ | ||
| duk_push_string(ctx, "})"); | ||
| duk_concat(ctx, 3); | ||
|
|
||
| /* [ ... module source func_src ] */ | ||
|
|
||
| (void) duk_get_prop_string(ctx, -3, "filename"); | ||
| filename = duk_get_string(ctx, -1); | ||
| strcpy(tmp, filename); | ||
| duk_compile(ctx, DUK_COMPILE_EVAL); | ||
| duk_call(ctx, 0); | ||
|
|
||
| /* [ ... module source func ] */ | ||
|
|
||
| /* call the function wrapper */ | ||
| (void) duk_get_prop_string(ctx, -3, "exports"); /* exports */ | ||
| (void) duk_get_prop_string(ctx, -4, "require"); /* require */ | ||
| duk_dup(ctx, -5); /* module */ | ||
| (void) duk_get_prop_string(ctx, -6, "filename"); /* __filename */ | ||
| duk_push_string(ctx, dirname(tmp)); /* __dirname */ | ||
| duk_call(ctx, 5); | ||
|
|
||
| /* [ ... module source result(ignore) ] */ | ||
|
|
||
| /* module.loaded = true */ | ||
| duk_push_true(ctx); | ||
| duk_put_prop_string(ctx, -4, "loaded"); | ||
|
|
||
| /* [ ... module source retval ] */ | ||
|
|
||
| duk_pop_2(ctx); | ||
|
|
||
| /* [ ... module ] */ | ||
|
|
||
| return 1; | ||
| } | ||
|
|
||
| duk_ret_t duk_module_node_eval_code(duk_context *ctx, const char* filename) { | ||
| /* | ||
| * Stack: [ ... source ] | ||
| */ | ||
|
|
||
| duk__push_module_object(ctx, filename); | ||
| /* [ ... source module ] */ | ||
|
|
||
| duk_dup(ctx, 0); | ||
| /* [ ... source module source ] */ | ||
|
|
||
| return duk_safe_call(ctx, duk__eval_module_source, 2, 1); | ||
| } | ||
|
|
||
| void duk_module_node_init(duk_context *ctx) { | ||
| /* | ||
| * Stack: [ ... options ] => [ ... ] | ||
| */ | ||
|
|
||
| duk_idx_t options_idx; | ||
|
|
||
| duk_require_object_coercible(ctx, -1); /* error before setting up requireCache */ | ||
| options_idx = duk_require_normalize_index(ctx, -1); | ||
|
|
||
| /* Initialize the require cache to a fresh object. */ | ||
| duk_push_global_stash(ctx); | ||
| duk_push_object(ctx); | ||
| duk_put_prop_string(ctx, -2, "\xff" "requireCache"); | ||
| duk_pop(ctx); | ||
|
|
||
| /* Stash callbacks for later use. User code can overwrite them later | ||
| * on directly by accessing the global stash. | ||
| */ | ||
| duk_push_global_stash(ctx); | ||
| duk_get_prop_string(ctx, options_idx, "resolve"); | ||
| duk_require_function(ctx, -1); | ||
| duk_put_prop_string(ctx, -2, "\xff" "modResolve"); | ||
| duk_get_prop_string(ctx, options_idx, "load"); | ||
| duk_require_function(ctx, -1); | ||
| duk_put_prop_string(ctx, -2, "\xff" "modLoad"); | ||
| duk_pop(ctx); | ||
|
|
||
| /* register `require` as a global function */ | ||
| duk_push_global_object(ctx); | ||
| duk_push_string(ctx, "require"); | ||
| duk__push_require_function(ctx, ""); | ||
| duk_def_prop(ctx, -3, DUK_DEFPROP_HAVE_VALUE | | ||
| DUK_DEFPROP_SET_WRITABLE | | ||
| DUK_DEFPROP_SET_CONFIGURABLE); | ||
| duk_pop(ctx); | ||
|
|
||
| duk_pop(ctx); /* pop argument */ | ||
| } |
Oops, something went wrong.
0 comments on commit
2569f12