embind: tsgen function params name #20141

tayyabejaz2000 · 2023-08-28T14:31:30Z

Custom function parameter names for TS.
Parameter names are optional, added just after method name for better TS Typings

int TestFunctionWithOneParam(int x);
int TestFunctionWithTwoParams(float param1, bool param2);
int TestFunctionWithThreeParams(float param1, bool param2, int param3);

EMSCRIPTEN_BINDINGS(ParamsNameGen)
{
  function("TestFunctionWithOneParam", TestFunctionWithOneParam);
  function("TestFunctionWithTwoParams(param1, param2)", TestFunctionWithTwoParams);
  function("TestFunctionWithThreeParams(param1, param3)", TestFunctionWithThreeParams);
  function("TestFunctionWithThreeParams_1(param1,param2,params3,params4)", TestFunctionWithThreeParams);
}

Specifying less parameters than expected will use _<n> convention
Specifying more parameters will ignore extra parameters

export interface MainModule {
  TestFunctionWithOneParam(_0: number): number;
  TestFunctionWithTwoParams(param1: number, param2: boolean): number;
  TestFunctionWithThreeParams(param1: number, param3: boolean, _2: number): number;
  TestFunctionWithThreeParams_1(param1: number, param2: boolean, params3: number): number;
}

Also works for Class Functions/Class Static Functions

sbc100 · 2023-08-28T17:26:03Z

Its a shame we can't extract the argument names from the C/C++ declarations.. but that would be highly non-trivial.

brendandahl

A few minor things and please add some tests to https://github.com/emscripten-core/emscripten/blob/main/test/other/embind_tsgen.cpp and update the expected defintions.

I would ultimately like to get to a situation where we extract argument names, but I think that will require a clang plugin or extracting the argument names from the debug info.

brendandahl · 2023-09-08T20:17:54Z

src/embind/embind_ts.js

      for (let i = argStart; i < argTypes.length; i++) {
-        args.push(new Argument(`_${i - argStart}`, argTypes[i]));
+        if (argsName.length && x < argsName.length) {


Let's add an assert that if argNames are used it matches the expected number of arguments. This will help prevent bindings getting out of sync with their TS definitions.

tayyabejaz2000 · 2023-09-10T09:59:54Z

src/embind/embind_shared.js

+    signature = signature.trim();
+    const argsIndex = signature.indexOf("(") + 1;
+    if (argsIndex !== 0) {
+      assert(signature[signature.length - 1] == ")", "Unmatching paranthesis for argument names.");


Added assertion for unmatching parenthesis in function signature

tayyabejaz2000 · 2023-09-10T10:00:01Z

src/embind/embind_ts.js

      const returnType = argTypes[0];
      let thisType = null;
      let argStart = 1;
      if (hasThis) {
        thisType = argTypes[1];
        argStart = 2;
      }
+      if (argsName.length)
+        assert(argsName.length == (argTypes.length - hasThis - 1), 'Argument names should match number of parameters.');


Added assertions for argument names to match expected number of parameters

brendandahl

Still missings tests in https://github.com/emscripten-core/emscripten/blob/main/test/other/embind_tsgen.cpp and update the expected defintions

brendandahl · 2023-09-12T18:25:30Z

src/embind/embind_shared.js

+    signature = signature.trim();
+    const argsIndex = signature.indexOf("(");
+    if (argsIndex !== -1) {
+      assert(signature[signature.length - 1] == ")", "Unmatching paranthesis for argument names.");


'Parentheses for argument names should match.'

brendandahl · 2023-09-12T18:25:55Z

src/embind/embind_shared.js

+    signature = signature.trim();
+    const argsIndex = signature.indexOf("(") + 1;
+    if (argsIndex !== 0) {
+      assert(signature[signature.length - 1] == ")", "Unmatching paranthesis for argument names.");


'Parentheses for argument names should match.'

…0/emscripten into tsgen-function-params-name

mrroohian · 2023-09-29T09:41:43Z

@tayyabejaz2000 @brendandahl This is a good idea until extracting names is possible. Quick question: what about constructors? Is there a solution available for those too?

tayyabejaz2000 added 2 commits August 28, 2023 18:35

embind: tsgen custom param names

b1a0036

embind: tsgen custom param names

265dcf3

sbc100 requested a review from brendandahl August 28, 2023 17:25

brendandahl requested changes Sep 8, 2023

View reviewed changes

tayyabejaz2000 and others added 2 commits September 10, 2023 14:48

fix: added assertions

356f375

Merge branch 'emscripten-core:main' into tsgen-function-params-name

ecbf3a9

tayyabejaz2000 commented Sep 10, 2023

View reviewed changes

tayyabejaz2000 requested a review from brendandahl September 10, 2023 10:00

brendandahl requested changes Sep 12, 2023

View reviewed changes

Tobii700 added 3 commits September 14, 2023 12:39

feat: added tests for param name generation

8e79f11

fix: error message for unmatching parantheses

011eaf9

Merge branch 'tsgen-function-params-name' of github.com:tayyabejaz200…

15b4ca2

…0/emscripten into tsgen-function-params-name

brendandahl merged commit d515cd5 into emscripten-core:main Sep 18, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

embind: tsgen function params name #20141

embind: tsgen function params name #20141

Uh oh!

tayyabejaz2000 commented Aug 28, 2023 •

edited

Loading

Uh oh!

sbc100 commented Aug 28, 2023

Uh oh!

brendandahl left a comment

Uh oh!

brendandahl Sep 8, 2023

Uh oh!

tayyabejaz2000 Sep 10, 2023

Uh oh!

tayyabejaz2000 Sep 10, 2023

Uh oh!

brendandahl left a comment

Uh oh!

brendandahl Sep 12, 2023

Uh oh!

brendandahl Sep 12, 2023

Uh oh!

mrroohian commented Sep 29, 2023 •

edited

Loading

Uh oh!

Uh oh!

embind: tsgen function params name #20141

embind: tsgen function params name #20141

Uh oh!

Conversation

tayyabejaz2000 commented Aug 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sbc100 commented Aug 28, 2023

Uh oh!

brendandahl left a comment

Choose a reason for hiding this comment

Uh oh!

brendandahl Sep 8, 2023

Choose a reason for hiding this comment

Uh oh!

tayyabejaz2000 Sep 10, 2023

Choose a reason for hiding this comment

Uh oh!

tayyabejaz2000 Sep 10, 2023

Choose a reason for hiding this comment

Uh oh!

brendandahl left a comment

Choose a reason for hiding this comment

Uh oh!

brendandahl Sep 12, 2023

Choose a reason for hiding this comment

Uh oh!

brendandahl Sep 12, 2023

Choose a reason for hiding this comment

Uh oh!

mrroohian commented Sep 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

tayyabejaz2000 commented Aug 28, 2023 •

edited

Loading

mrroohian commented Sep 29, 2023 •

edited

Loading