Skip to content
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

Jump to bottom

[embind] Better reflect the actual class hierarchy in TS. #22734

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[embind] Better reflect the actual class hierarchy in TS. #22734

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 20 additions & 1 deletion src/embind/embind_gen.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,8 @@ var LibraryEmbind = {
out.push(`export interface ${this.name}`);
if (this.base) {
out.push(` extends ${this.base.name}`);
} else {
out.push(' extends ClassHandle');
}
out.push(' {\n');
for (const property of this.properties) {
Expand All @@ -186,7 +188,6 @@ var LibraryEmbind = {
method.printFunction(nameMap, out);
out.push(';\n');
}
out.push(' delete(): void;\n');
out.push('}\n\n');
}

Expand Down Expand Up @@ -402,6 +403,24 @@ var LibraryEmbind = {

print() {
const out = [];
let hadClass = false;
for (const def of this.definitions) {
if (def instanceof ClassDefinition) {
hadClass = true;
break;
}
}
if (hadClass) {
out.push(
'export interface ClassHandle {\n',
' isAliasOf(other: ClassHandle): boolean;\n',
' delete(): void;\n',
' deleteLater(): void;\n',
' isDeleted(): boolean;\n',
' clone(): this;\n',
'}\n',
);
}
for (const def of this.definitions) {
if (!def.print) {
continue;
Expand Down
39 changes: 17 additions & 22 deletions test/other/embind_tsgen.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,14 @@ interface WasmModule {
}

type EmbindString = ArrayBuffer|Uint8Array|Uint8ClampedArray|Int8Array|string;
export interface Test {
export interface ClassHandle {
isAliasOf(other: ClassHandle): boolean;
delete(): void;
deleteLater(): void;
isDeleted(): boolean;
clone(): this;
}
export interface Test extends ClassHandle {
x: number;
readonly y: number;
get stringProperty(): string;
Expand All @@ -30,11 +37,9 @@ export interface Test {
longFn(_0: number): number;
functionThree(_0: EmbindString): number;
functionSix(str: EmbindString): number;
delete(): void;
}

export interface Obj {
delete(): void;
export interface Obj extends ClassHandle {
}

export interface BarValue<T extends number> {
Expand All @@ -49,40 +54,34 @@ export type EmptyEnum = never/* Empty Enumerator */;

export type ValArrIx = [ Bar, Bar, Bar, Bar ];

export interface IntVec {
export interface IntVec extends ClassHandle {
push_back(_0: number): void;
resize(_0: number, _1: number): void;
size(): number;
get(_0: number): number | undefined;
set(_0: number, _1: number): boolean;
delete(): void;
}

export interface MapIntInt {
export interface MapIntInt extends ClassHandle {
keys(): IntVec;
get(_0: number): number | undefined;
set(_0: number, _1: number): void;
size(): number;
delete(): void;
}

export interface Foo {
export interface Foo extends ClassHandle {
process(_0: Test): void;
delete(): void;
}

export interface ClassWithConstructor {
export interface ClassWithConstructor extends ClassHandle {
fn(_0: number): number;
delete(): void;
}

export interface ClassWithTwoConstructors {
delete(): void;
export interface ClassWithTwoConstructors extends ClassHandle {
}

export interface ClassWithSmartPtrConstructor {
export interface ClassWithSmartPtrConstructor extends ClassHandle {
fn(_0: number): number;
delete(): void;
}

export type ValObj = {
Expand All @@ -91,24 +90,20 @@ export type ValObj = {
callback: (message: string) => void
};

export interface BaseClass {
export interface BaseClass extends ClassHandle {
fn(_0: number): number;
delete(): void;
}

export interface DerivedClass extends BaseClass {
fn2(_0: number): number;
delete(): void;
}

export interface Interface {
export interface Interface extends ClassHandle {
invoke(_0: EmbindString): void;
delete(): void;
}

export interface InterfaceWrapper extends Interface {
notifyOnDestruction(): void;
delete(): void;
}

export type ValArr = [ number, number, number ];
Expand Down
39 changes: 17 additions & 22 deletions test/other/embind_tsgen_ignore_1.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,14 @@ interface WasmModule {
}

type EmbindString = ArrayBuffer|Uint8Array|Uint8ClampedArray|Int8Array|string;
export interface Test {
export interface ClassHandle {
isAliasOf(other: ClassHandle): boolean;
delete(): void;
deleteLater(): void;
isDeleted(): boolean;
clone(): this;
}
export interface Test extends ClassHandle {
x: number;
readonly y: number;
get stringProperty(): string;
Expand All @@ -39,11 +46,9 @@ export interface Test {
longFn(_0: number): number;
functionThree(_0: EmbindString): number;
functionSix(str: EmbindString): number;
delete(): void;
}

export interface Obj {
delete(): void;
export interface Obj extends ClassHandle {
}

export interface BarValue<T extends number> {
Expand All @@ -58,40 +63,34 @@ export type EmptyEnum = never/* Empty Enumerator */;

export type ValArrIx = [ Bar, Bar, Bar, Bar ];

export interface IntVec {
export interface IntVec extends ClassHandle {
push_back(_0: number): void;
resize(_0: number, _1: number): void;
size(): number;
get(_0: number): number | undefined;
set(_0: number, _1: number): boolean;
delete(): void;
}

export interface MapIntInt {
export interface MapIntInt extends ClassHandle {
keys(): IntVec;
get(_0: number): number | undefined;
set(_0: number, _1: number): void;
size(): number;
delete(): void;
}

export interface Foo {
export interface Foo extends ClassHandle {
process(_0: Test): void;
delete(): void;
}

export interface ClassWithConstructor {
export interface ClassWithConstructor extends ClassHandle {
fn(_0: number): number;
delete(): void;
}

export interface ClassWithTwoConstructors {
delete(): void;
export interface ClassWithTwoConstructors extends ClassHandle {
}

export interface ClassWithSmartPtrConstructor {
export interface ClassWithSmartPtrConstructor extends ClassHandle {
fn(_0: number): number;
delete(): void;
}

export type ValObj = {
Expand All @@ -100,24 +99,20 @@ export type ValObj = {
callback: (message: string) => void
};

export interface BaseClass {
export interface BaseClass extends ClassHandle {
fn(_0: number): number;
delete(): void;
}

export interface DerivedClass extends BaseClass {
fn2(_0: number): number;
delete(): void;
}

export interface Interface {
export interface Interface extends ClassHandle {
invoke(_0: EmbindString): void;
delete(): void;
}

export interface InterfaceWrapper extends Interface {
notifyOnDestruction(): void;
delete(): void;
}

export type ValArr = [ number, number, number ];
Expand Down
39 changes: 17 additions & 22 deletions test/other/embind_tsgen_ignore_2.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,14 @@ interface WasmModule {
}

type EmbindString = ArrayBuffer|Uint8Array|Uint8ClampedArray|Int8Array|string;
export interface Test {
export interface ClassHandle {
isAliasOf(other: ClassHandle): boolean;
delete(): void;
deleteLater(): void;
isDeleted(): boolean;
clone(): this;
}
export interface Test extends ClassHandle {
x: number;
readonly y: number;
get stringProperty(): string;
Expand All @@ -16,11 +23,9 @@ export interface Test {
longFn(_0: number): number;
functionThree(_0: EmbindString): number;
functionSix(str: EmbindString): number;
delete(): void;
}

export interface Obj {
delete(): void;
export interface Obj extends ClassHandle {
}

export interface BarValue<T extends number> {
Expand All @@ -35,40 +40,34 @@ export type EmptyEnum = never/* Empty Enumerator */;

export type ValArrIx = [ Bar, Bar, Bar, Bar ];

export interface IntVec {
export interface IntVec extends ClassHandle {
push_back(_0: number): void;
resize(_0: number, _1: number): void;
size(): number;
get(_0: number): number | undefined;
set(_0: number, _1: number): boolean;
delete(): void;
}

export interface MapIntInt {
export interface MapIntInt extends ClassHandle {
keys(): IntVec;
get(_0: number): number | undefined;
set(_0: number, _1: number): void;
size(): number;
delete(): void;
}

export interface Foo {
export interface Foo extends ClassHandle {
process(_0: Test): void;
delete(): void;
}

export interface ClassWithConstructor {
export interface ClassWithConstructor extends ClassHandle {
fn(_0: number): number;
delete(): void;
}

export interface ClassWithTwoConstructors {
delete(): void;
export interface ClassWithTwoConstructors extends ClassHandle {
}

export interface ClassWithSmartPtrConstructor {
export interface ClassWithSmartPtrConstructor extends ClassHandle {
fn(_0: number): number;
delete(): void;
}

export type ValObj = {
Expand All @@ -77,24 +76,20 @@ export type ValObj = {
callback: (message: string) => void
};

export interface BaseClass {
export interface BaseClass extends ClassHandle {
fn(_0: number): number;
delete(): void;
}

export interface DerivedClass extends BaseClass {
fn2(_0: number): number;
delete(): void;
}

export interface Interface {
export interface Interface extends ClassHandle {
invoke(_0: EmbindString): void;
delete(): void;
}

export interface InterfaceWrapper extends Interface {
notifyOnDestruction(): void;
delete(): void;
}

export type ValArr = [ number, number, number ];
Expand Down
Loading
Loading