[emscripten] Fix and improvements for 1.39.5 (#41621)

* [emscripten] Add module loader when -s MODULARIZE=1 enabled Add Module() call and Module().then(callback). Related: https://emscripten.org/docs/getting_started/FAQ.html#how-can-i-tell-when-the-page-is-fully-loaded-and-it-is-safe-to-call-compiled-functions Signed-off-by: Bumsik Kim <k.bumsik@gmail.com> * [emscripten] Move runtime functions to the global space All of these runtime functions are removed more than a year ago. Related: https://github.com/emscripten-core/emscripten/blob/79523944931f526c4b1c2a92e1a826475c987a2b/src/settings.js#L674-L685 Signed-off-by: Bumsik Kim <k.bumsik@gmail.com> * [emscripten] Add missing runtime methods * [emscripten] Make FS methods more accurate Signed-off-by: Bumsik Kim <k.bumsik@gmail.com> * [emscripten] Make function signatures more accurate Signed-off-by: Bumsik Kim <k.bumsik@gmail.com> * [emscripten] Runtime is removed Signed-off-by: Bumsik Kim <k.bumsik@gmail.com> * [emscripten] Fix test and add stack alloc test Signed-off-by: Bumsik Kim <k.bumsik@gmail.com> * [emscripten] Add contributor: Bumsik Kim Signed-off-by: Bumsik Kim <k.bumsik@gmail.com> * [emscripten] Bump version: 1.39.5 Signed-off-by: Bumsik Kim <k.bumsik@gmail.com>
2026-08-12 04:50:18 +00:00 · 2020-01-21 16:48:16 -08:00
parent 8036fc4dd8
commit b3b3305bd8
2 changed files with 106 additions and 34 deletions
@@ -1,7 +1,18 @@
+/// Extending Module
+// This requires -s "EXTRA_EXPORTED_RUNTIME_METHODS=['cwrap','ccall','getValue','setvalue']"
+// in emcc compilation flags
+interface EmscriptenModule {
+    cwrap: typeof cwrap;
+    ccall: typeof ccall;
+    getValue: typeof getValue;
+    setValue: typeof setValue;
+}
+
 /// Module
 function ModuleTest(): void {
    Module.environment = "WEB";
    Module.environment = "NODE";
+    Module.environment = "WORKER";
    Module.noInitialRun = false;
    Module.logReadFiles = false;
    Module.filePackagePrefixURL = "http://www.example.org/";
@@ -81,7 +92,9 @@ function FSTest(): void {
    FS.writeFile('file', 'foobar');
    FS.truncate('file', 3);

-    const contents = FS.readFile('file', { encoding: 'utf8' });
+    const contents1 = FS.readFile('file', { encoding: 'utf8' });
+    const contents2 = FS.readFile('file', { encoding: 'binary' });
+    const contents3 = FS.readFile('file');

    const rstream = FS.open('abinaryfile', 'r');
    const buf = new Uint8Array(4);
@@ -89,10 +102,12 @@ function FSTest(): void {
    FS.close(rstream);

    const data = new Uint8Array(32);
-    const wstream = FS.open('dummy', 'w+');
+    const wstream = FS.open('dummy1', 'w+');
    FS.write(wstream, data, 0, data.length, 0);
    FS.close(wstream);

+    FS.createDataFile('/', 'dummy2', data, true, true);
+
    const lookup = FS.lookupPath("path", { parent: true });
 }

@@ -118,3 +133,11 @@ function StringConv(): void {
    p = allocateUTF8(s);
    Module._free(p);
 }
+
+// Stack allocations
+function StackAlloc() {
+    const stack = stackSave();
+    const ptr = stackAlloc(42);
+    const strPtr = allocateUTF8OnStack('testString');
+    stackRestore(stack);
+}
@@ -1,7 +1,8 @@
-// Type definitions for Emscripten 1.38.33
+// Type definitions for Emscripten 1.39.5
 // Project: http://kripken.github.io/emscripten-site/index.html
 // Definitions by: Kensuke Matsuzaki <https://github.com/zakki>
 //                 Periklis Tsirakidis <https://github.com/periklis>
+//                 Bumsik Kim <https://github.com/kbumsik>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 // TypeScript Version: 2.2

@@ -14,9 +15,15 @@ declare namespace Emscripten {
    interface FileSystemType {
    }
    type EnvironmentType = "WEB" | "NODE" | "SHELL" | "WORKER";
-    type ValueType = "number" | "string" | "array" | "boolean";
+
+    type JSType = "number" | "string" | "array" | "boolean";
    type TypeCompatibleWithC = number | string | any[] | boolean;

+    type CIntType = 'i8' | 'i16' | 'i32' | 'i64';
+    type CFloatType = 'float' | 'double';
+    type CPointerType = 'i8*' | 'i16*' | 'i32*' | 'i64*' | 'float*' | 'double*' | '*';
+    type CType =  CIntType | CFloatType | CPointerType;
+
    type WebAssemblyImports =  Array<{
        name: string;
        kind: string;
@@ -34,6 +41,26 @@ declare namespace Emscripten {
 }

 interface EmscriptenModule {
+    /**
+     * Initializes an EmscriptenModule object and returns it. The initialized
+     * obejct will be passed to then(). Works only when -s MODULARIZE=1 is
+     * enabled. This is default exported function when -s EXPORT_ES6=1 is
+     * enabled.
+     * https://emscripten.org/docs/getting_started/FAQ.html#how-can-i-tell-when-the-page-is-fully-loaded-and-it-is-safe-to-call-compiled-functions
+     * @param moduleOverrides Properties of an initialized module to override.
+     */
+    (moduleOverrides?: Partial<this>): this;
+    /**
+     * Promise-like then() inteface.
+     * WRANGING: Emscripten's then() is not really promise-based 'thenable'.
+     * Don't try to use it with Promise.resolve() or in an async function
+     * without deleting delete Module["then"] in the callback.
+     * https://github.com/kripken/emscripten/issues/5820
+     * Works only when -s MODULARIZE=1 is enabled.
+     * @param callback A callback chained from Module() with an Module instance.
+     */
+    then(callback: (module: this) => void): this;
+
    print(str: string): void;
    printErr(str: string): void;
    arguments: string[];
@@ -59,22 +86,6 @@ interface EmscriptenModule {
    locateFile(url: string): string;
    onCustomMessage(event: MessageEvent): void;

-    Runtime: any;
-
-    ccall(ident: string, returnType: Emscripten.ValueType | null, argTypes: Emscripten.ValueType[], args: Emscripten.TypeCompatibleWithC[], opts?: Emscripten.CCallOpts): any;
-    cwrap(ident: string, returnType: Emscripten.ValueType | null, argTypes: Emscripten.ValueType[], opts?: Emscripten.CCallOpts): (...args: any[]) => any;
-
-    setValue(ptr: number, value: any, type: string, noSafe?: boolean): void;
-    getValue(ptr: number, type: string, noSafe?: boolean): number;
-
-    ALLOC_NORMAL: number;
-    ALLOC_STACK: number;
-    ALLOC_STATIC: number;
-    ALLOC_DYNAMIC: number;
-    ALLOC_NONE: number;
-
-    allocate(slab: any, types: string | string[], allocator: number, ptr: number): number;
-
    // USE_TYPED_ARRAYS == 1
    HEAP: Int32Array;
    IHEAP: Int32Array;
@@ -100,16 +111,6 @@ interface EmscriptenModule {
    addOnExit(cb: () => any): void;
    addOnPostRun(cb: () => any): void;

-    // Tools
-    intArrayFromString(stringy: string, dontAddNull?: boolean, length?: number): number[];
-    intArrayToString(array: number[]): string;
-    writeStringToMemory(str: string, buffer: number, dontAddNull: boolean): void;
-    writeArrayToMemory(array: number[], buffer: number): void;
-    writeAsciiToMemory(str: string, buffer: number, dontAddNull: boolean): void;
-
-    addRunDependency(id: any): void;
-    removeRunDependency(id: any): void;
-
    preloadedImages: any;
    preloadedAudios: any;

@@ -197,7 +198,9 @@ declare namespace FS {
    function allocate(stream: FSStream, offset: number, length: number): void;
    function mmap(stream: FSStream, buffer: ArrayBufferView, offset: number, length: number, position: number, prot: number, flags: number): any;
    function ioctl(stream: FSStream, cmd: any, arg: any): any;
-    function readFile(path: string, opts?: { encoding?: "binary" | "utf8"; flags?: string }): string | Uint8Array;
+    function readFile(path: string, opts: { encoding: "binary", flags?: string }): Uint8Array;
+    function readFile(path: string, opts: { encoding: "utf8", flags?: string }): string;
+    function readFile(path: string, opts?: { flags?: string }): Uint8Array;
    function writeFile(path: string, data: string | ArrayBufferView, opts?: { flags?: string }): void;

    //
@@ -214,16 +217,48 @@ declare namespace FS {
    function createLazyFile(parent: string | FSNode, name: string, url: string, canRead: boolean, canWrite: boolean): FSNode;
    function createPreloadedFile(parent: string | FSNode, name: string, url: string,
        canRead: boolean, canWrite: boolean, onload?: () => void, onerror?: () => void, dontCreateFile?: boolean, canOwn?: boolean): void;
+    function createDataFile(parent: string | FSNode, name: string, data: ArrayBufferView, canRead: boolean, canWrite: boolean): FSNode;
+}
+
+interface Math {
+    imul(a: number, b: number): number;
 }

 declare var MEMFS: Emscripten.FileSystemType;
 declare var NODEFS: Emscripten.FileSystemType;
 declare var IDBFS: Emscripten.FileSystemType;

+// Below runtime function/variable declarations are exportable by
+// -s EXTRA_EXPORTED_RUNTIME_METHODS. You can extend or merge
+// EmscriptenModule interface to add runtime functions.
+//
+// For example, by using -s "EXTRA_EXPORTED_RUNTIME_METHODS=['ccall']"
+// You can access ccall() via Module["ccall"]. In this case, you should
+// extend EmscriptenModule to pass the compiler check like the following:
+//
+// interface YourOwnEmscriptenModule extends EmscriptenModule {
+//     ccall: typeof ccall;
+// }
+//
+// See: https://emscripten.org/docs/getting_started/FAQ.html#why-do-i-get-typeerror-module-something-is-not-a-function
+
+declare function ccall(ident: string, returnType: Emscripten.JSType | null, argTypes: Emscripten.JSType[], args: Emscripten.TypeCompatibleWithC[], opts?: Emscripten.CCallOpts): any;
+declare function cwrap(ident: string, returnType: Emscripten.JSType | null, argTypes: Emscripten.JSType[], opts?: Emscripten.CCallOpts): (...args: any[]) => any;
+
+declare function setValue(ptr: number, value: any, type: Emscripten.CType, noSafe?: boolean): void;
+declare function getValue(ptr: number, type: Emscripten.CType, noSafe?: boolean): number;
+
+declare function allocate(slab: number[] | ArrayBufferView | number, types: Emscripten.CType | Emscripten.CType[], allocator: number, ptr?: number): number;
+
+declare function stackAlloc(size: number): number;
+declare function stackSave(): number;
+declare function stackRestore(ptr: number): void;
+
 declare function UTF8ToString(ptr: number, maxBytesToRead?: number): string;
 declare function stringToUTF8(str: string, outPtr: number, maxBytesToRead?: number): void;
 declare function lengthBytesUTF8(str: string): number;
 declare function allocateUTF8(str: string): number;
+declare function allocateUTF8OnStack(str: string): number;
 declare function UTF16ToString(ptr: number): string;
 declare function stringToUTF16(str: string, outPtr: number, maxBytesToRead?: number): void;
 declare function lengthBytesUTF16(str: string): number;
@@ -231,6 +266,20 @@ declare function UTF32ToString(ptr: number): string;
 declare function stringToUTF32(str: string, outPtr: number, maxBytesToRead?: number): void;
 declare function lengthBytesUTF32(str: string): number;

-interface Math {
-    imul(a: number, b: number): number;
-}
+declare function intArrayFromString(stringy: string, dontAddNull?: boolean, length?: number): number[];
+declare function intArrayToString(array: number[]): string;
+declare function writeStringToMemory(str: string, buffer: number, dontAddNull: boolean): void;
+declare function writeArrayToMemory(array: number[], buffer: number): void;
+declare function writeAsciiToMemory(str: string, buffer: number, dontAddNull: boolean): void;
+
+declare function addRunDependency(id: any): void;
+declare function removeRunDependency(id: any): void;
+
+declare function addFunction(func: () => any, signature?: string): number;
+declare function removeFunction(funcPtr: number): void;
+
+declare var ALLOC_NORMAL: number;
+declare var ALLOC_STACK: number;
+declare var ALLOC_STATIC: number;
+declare var ALLOC_DYNAMIC: number;
+declare var ALLOC_NONE: number;