Skip to content

Updates Emscripten types with new MODULARIZE API #44590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sandersn merged 2 commits into from
May 15, 2020
Merged

Updates Emscripten types with new MODULARIZE API #44590

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aaa09c1
Updates Emscripten types with new `MODULARIZE` API
May 9, 2020
cdce35b
Runs prettier on the emscripten types
May 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 46 additions & 19 deletions types/emscripten/emscripten-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,27 +10,29 @@ interface EmscriptenModule {
setValue: typeof setValue;
}

let Module: EmscriptenModule;

/// Module
function ModuleTest(): void {
Module.environment = "WEB";
Module.environment = "NODE";
Module.environment = "WORKER";
Module.environment = 'WEB';
Module.environment = 'NODE';
Module.environment = 'WORKER';
Module.noInitialRun = false;
Module.logReadFiles = false;
Module.filePackagePrefixURL = "http://www.example.org/";
Module.filePackagePrefixURL = 'http://www.example.org/';
Module.preinitializedWebGLContext = new WebGLRenderingContext();
Module.onAbort = (what) => console.log('abort');
Module.onAbort = what => console.log('abort');
Module.onRuntimeInitialized = () => console.log('init');

const package: ArrayBuffer = Module.getPreloadedPackage("package-name", 100);
const package: ArrayBuffer = Module.getPreloadedPackage('package-name', 100);
const exports: Emscripten.WebAssemblyExports = Module.instantiateWasm(
[{name: "func-name", kind: "function"}],
(module: WebAssembly.Module) => {}
[{ name: 'func-name', kind: 'function' }],
(module: WebAssembly.Module) => {},
);
const memFile: string = Module.locateFile("file.mem", "http://www.example.org/");
Module.onCustomMessage(new MessageEvent("TestType"));
const memFile: string = Module.locateFile('file.mem', 'http://www.example.org/');
Module.onCustomMessage(new MessageEvent('TestType'));

Module.print = (text) => alert('stdout: ' + text);
Module.print = text => alert('stdout: ' + text);

let int_sqrt = Module.cwrap('int_sqrt', 'number', ['number']);
int_sqrt = Module.cwrap('int_sqrt', null, ['number']);
Expand All @@ -44,17 +46,21 @@ function ModuleTest(): void {
Module.HEAPU8.set(myTypedArray, buf);
Module.ccall('my_function', 'number', ['number'], [buf]);
Module.ccall('my_function', null, ['number'], [buf]);
Module.ccall('my_function', null, ['number'], [buf], {async: true});
Module.ccall('my_function', null, ['number'], [buf], { async: true });
Module.cwrap('my_function', 'string', ['number', 'boolean', 'array']);
Module.cwrap('my_function', null, ['number']);
Module.cwrap('my_function', 'string', ['number', 'boolean', 'array'], {async: true});
Module.cwrap('my_function', 'string', ['number', 'boolean', 'array'], { async: true });
Module._free(buf);
Module.destroy({});
}

/// FS
function FSTest(): void {
FS.init(() => null, _ => null, _ => null);
FS.init(
() => null,
_ => null,
_ => null,
);
FS.init(null, null, null);

FS.mkdir('/working');
Expand All @@ -64,13 +70,13 @@ function FSTest(): void {
FS.mkdir('/data');
FS.mount(IDBFS, {}, '/data');

FS.syncfs(true, (err) => {
FS.syncfs(true, err => {
// handle callback
});
}

function myAppShutdown() {
FS.syncfs((err) => {
FS.syncfs(err => {
// handle callback
});
}
Expand All @@ -88,8 +94,8 @@ function FSTest(): void {
FS.writeFile('file', 'foobar');
FS.symlink('file', 'link');

FS.writeFile('forbidden', 'can\'t touch this');
FS.chmod('forbidden', parseInt("0000", 8));
FS.writeFile('forbidden', "can't touch this");
FS.chmod('forbidden', parseInt('0000', 8));

FS.writeFile('file', 'foobar');
FS.truncate('file', 3);
Expand All @@ -110,7 +116,7 @@ function FSTest(): void {

FS.createDataFile('/', 'dummy2', data, true, true, true);

const lookup = FS.lookupPath("path", { parent: true });
const lookup = FS.lookupPath('path', { parent: true });
}

/// String conversions
Expand Down Expand Up @@ -143,3 +149,24 @@ function StackAlloc() {
const strPtr = allocateUTF8OnStack('testString');
stackRestore(stack);
}

let createModule: EmscriptenModuleFactory;
interface MyModule extends EmscriptenModule {
foo: string;
}
let createMyModule: EmscriptenModuleFactory<MyModule>;

async function ModuleFactoryTest() {
const module1 = await createModule();
module1.print('🦆');
const module2 = await createModule({
print() {
console.log('testing passing overrides');
},
});
const myModule: MyModule = await createMyModule({
foo: 'bar',
locateFile: (url, dir) => '🌈',
});
myModule.foo;
}
135 changes: 90 additions & 45 deletions types/emscripten/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
// Type definitions for Emscripten 1.39.5
// Project: http://kripken.github.io/emscripten-site/index.html
// Type definitions for Emscripten 1.39.16
// Project: https://emscripten.org
// Definitions by: Kensuke Matsuzaki <https://github.com/zakki>
// Periklis Tsirakidis <https://github.com/periklis>
// Bumsik Kim <https://github.com/kbumsik>
// Louis DeScioli <https://github.com/lourd>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.2

/** Other WebAssembly declarations, for compatibility with older versions of Typescript */
declare namespace WebAssembly {
interface Module { }
interface Module {}
}

declare namespace Emscripten {
interface FileSystemType {
}
type EnvironmentType = "WEB" | "NODE" | "SHELL" | "WORKER";
interface FileSystemType {}
type EnvironmentType = 'WEB' | 'NODE' | 'SHELL' | 'WORKER';

type JSType = "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 CType = CIntType | CFloatType | CPointerType;

type WebAssemblyImports = Array<{
type WebAssemblyImports = Array<{
name: string;
kind: string;
}>;
Expand All @@ -41,26 +41,6 @@ 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[];
Expand All @@ -81,7 +61,7 @@ interface EmscriptenModule {
getPreloadedPackage(remotePackageName: string, remotePackageSize: number): ArrayBuffer;
instantiateWasm(
imports: Emscripten.WebAssemblyImports,
successCallback: (module: WebAssembly.Module) => void
successCallback: (module: WebAssembly.Module) => void,
): Emscripten.WebAssemblyExports;
locateFile(url: string, scriptDirectory: string): string;
onCustomMessage(event: MessageEvent): void;
Expand Down Expand Up @@ -118,10 +98,22 @@ interface EmscriptenModule {
_free(ptr: number): void;
}

// By default Emscripten emits a single global Module. Users setting -s
// MODULARIZE=1 -s EXPORT_NAME=MyMod should declare their own types, e.g.
// declare var MyMod: EmscriptenModule;
declare var Module: EmscriptenModule;
/**
* A factory function is generated when setting the `MODULARIZE` build option
* to `1` in your Emscripten build. It return a Promise that resolves to an
* initialized, ready-to-call `EmscriptenModule` instance.
*
* By default, the factory function will be named `Module`. It's recommended to
* use the `EXPORT_ES6` option, in which the factory function will be the
* default export. If used without `EXPORT_ES6`, the factory function will be a
* global variable. You can rename the variable using the `EXPORT_NAME` build
* option. It's left to you to declare any global variables as needed in your
* application's types.
* @param moduleOverrides Default properties for the initialized module.
*/
type EmscriptenModuleFactory<T extends EmscriptenModule = EmscriptenModule> = (
moduleOverrides?: Partial<T>,
) => Promise<T>;

declare namespace FS {
interface Lookup {
Expand Down Expand Up @@ -194,12 +186,27 @@ declare namespace FS {
function close(stream: FSStream): void;
function llseek(stream: FSStream, offset: number, whence: number): any;
function read(stream: FSStream, buffer: ArrayBufferView, offset: number, length: number, position?: number): number;
function write(stream: FSStream, buffer: ArrayBufferView, offset: number, length: number, position?: number, canOwn?: boolean): number;
function write(
stream: FSStream,
buffer: ArrayBufferView,
offset: number,
length: number,
position?: number,
canOwn?: boolean,
): number;
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 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", flags?: string }): Uint8Array;
function readFile(path: string, opts: { encoding: "utf8", flags?: string }): string;
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;

Expand All @@ -214,10 +221,32 @@ declare namespace FS {
error: null | ((c: number) => any),
): void;

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, canOwn: boolean): FSNode;
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,
canOwn: boolean,
): FSNode;
}

declare var MEMFS: Emscripten.FileSystemType;
Expand All @@ -238,13 +267,29 @@ declare var IDBFS: Emscripten.FileSystemType;
//
// 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 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 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;
Expand Down
2 changes: 1 addition & 1 deletion types/sql.js/module.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ export namespace SqlJs {
type ValueType = number | string | Uint8Array | null;
type ParamsObject = Record<string, ValueType>;
type ParamsCallback = (obj: ParamsObject) => void;
type Config = Partial<typeof Module>;
type Config = Partial<EmscriptenModule>;

interface QueryResults {
columns: string[];
Expand Down