Implement IDL based generators #447

Diggsey · 2018-01-25T20:27:30Z

Example generated bindings:
https://gist.github.com/Diggsey/c8a4cb93c7d5643d20203401ead178a7

This can't be merged until:

I've tested it beyond the bindings compiling
The next version of stdweb is released, which will contain the CanvasElement type

Diggsey · 2018-01-28T02:45:44Z

I've just implemented a massive rework of the type-generation - it's now really powerful, and will generate borrowed versions of types for arguments and will generate generic methods when appropriate.

Diggsey · 2018-01-28T16:56:58Z

brendanzab · 2018-01-29T00:09:02Z

Woo! This is looking great!

brendanzab · 2018-01-29T00:12:30Z

I'm wondering if it might actually make sense to create a new crate instead under this repository, called webgl_generator?

Diggsey · 2018-01-29T00:28:32Z

Yeah, I don't really mind, is that what you'd prefer?

tomaka · 2018-01-29T10:47:32Z

I personally don't think it's worth creating a new repo.

brendanzab · 2018-01-29T11:46:56Z

Wasn't talking about creating a new repo, just a new crate as a directory in this repo. If I'm not mistaken it seems like gl_generator and webgl_generator are orthogonal in their implementations and their dependencies?

tomaka · 2018-01-29T12:50:01Z

Oh sorry, yes that would make sense!

edwin0cheng · 2018-01-31T06:16:46Z

@Diggsey As i mentioned in koute/stdweb#92, will it works in Firefox ?

Diggsey · 2018-01-31T10:49:14Z

@edwin0cheng not right now - at least not if you try do anything complex. I think this can (and should) be fixed from the stdweb side though.

brendanzab · 2018-02-02T03:49:37Z

Looking great so far! Let me know when this can progress forward!

Diggsey · 2018-02-04T15:28:46Z

@brendanzab I've realised that the IDL files are missing information on extensions - these are described via separate IDL embedded in XML in the Khronos WebGL repo.

I would like to expose a mapping from "<extension name>" => "<IDL contents>" in the khronos_api crate - this will involve a build step to extract the IDL from the XML and will need to be stored as a static array of type &'static [(&'static str, &'static str)]. Does that sound reasonable to you?

Diggsey · 2018-02-04T22:54:31Z

I've opened a separate PR to add extension support to khronos_api, and I've rebased this PR on top.

The generated bindings are now up to 10,000 lines, and include support for all accepted WebGL extensions. There's also a "version-less" GLContext type to make it easier to write code which can work with multiple versions.

I've uploaded the generated documentation as I think it's quite interesting to read:
http://awesome-davinci-d3197a.bitballoon.com/webgl_stdweb/index.html

brendanzab · 2018-02-05T13:50:16Z

I would like to expose a mapping from "" => "" in the khronos_api crate - this will involve a build step to extract the IDL from the XML and will need to be stored as a static array of type &'static [(&'static str, &'static str)]. Does that sound reasonable to you?

Oh, missed this comment! Would have been helpful if you had have linked to it in the PR of #451! Yes, that sounds great.

Diggsey · 2018-02-05T15:12:04Z

One thing that might be cool would be to pull out the "summary" and "function" sections from the XML files and attach them as doc-comments to the generated code.

brendanzab · 2018-02-05T15:21:15Z

Ooooh! Wondering if we could do that for all the generators 😮

Diggsey · 2018-02-26T21:20:45Z

@brendanzab stdweb 0.4.0 was released, and I've updated the PR to use that. It should be ready for you to review now!

brendanzab · 2018-02-27T09:41:34Z

Woo, looking now!

brendanzab · 2018-02-27T09:51:36Z

webgl_generator/webgl_generators/stdweb_gen.rs

+        &TypeKind::Primitive(ref p) => ProcessedResult::simple(p.name()),
+        &TypeKind::String => ProcessedResult::simple("String"),
+        &TypeKind::ArrayBuffer | &TypeKind::ArrayBufferView => ProcessedResult::simple("ArrayBuffer"),
+        &TypeKind::BufferSource => unimplemented!("BufferSource not supported in output"),


Should we be using unimplemented! here? Are you planning to add support for this later?

BufferSource is not currently used in the WebGL IDL files, so I haven't bothered implementing it.

brendanzab · 2018-02-27T09:54:08Z

webgl_generator/webgl_generators/stdweb_gen.rs

+    }).collect();
+
+    let rust_args = args.iter().map(|a| a.arg.clone()).collect::<Vec<_>>().join(", ");
+    let js_args = args.iter().map(|a| a.js_arg.clone()).collect::<Vec<_>>().join(", ");


itertools has join if you wanted to use that to skip the intermediate collect!

Didn't seem worth it - this only happens at build time, and the cost of the extra dependency would outweigh any minor performance improvements.

brendanzab · 2018-02-27T10:01:55Z

webgl_generator/webgl_registry/mod.rs

+
+            // Strings
+            DOMString | USVString => TypeKind::String,
+            ByteString => unimplemented!(),


Has this been forgotten?

Just not needed for WebGL

brendanzab · 2018-02-27T10:02:57Z

webgl_generator/webgl_registry/mod.rs

+
+        Some((field.name, Field {
+            type_
+        }))


Why does this need to be an Option?

brendanzab · 2018-02-27T10:05:40Z

Would be nice to Run rustfmt on this if you don't mind!

Diggsey · 2018-03-04T14:40:25Z

@brendanzab done

Diggsey · 2018-03-20T14:51:34Z

@brendanzab hey is this good to go?

brendanzab · 2018-04-01T12:06:25Z

Ack - left this one sit around in my notifications making me feel guilty for too long! Merging!

Diggsey · 2018-04-01T12:18:52Z

Thanks! Are you happy to publish the new crate(s) to crates.io?

brendanzab · 2018-04-01T12:21:26Z

Yup, will do. I'll add you to the crate owners too.

brendanzab · 2018-04-01T12:22:27Z

What needs to be published - just the new crates?

brendanzab · 2018-04-01T12:30:53Z

Hum, when publishing I get:

error[E0425]: cannot find value `WEBGL_EXT_XML` in module `khronos_api`
  --> webgl_registry/mod.rs:69:38
   |
69 |         for &ext_xml in khronos_api::WEBGL_EXT_XML {
   |                                      ^^^^^^^^^^^^^ not found in `khronos_api`

error: aborting due to previous error

For more information about this error, try `rustc --explain E0425`.
error: failed to verify package tarball

Caused by:
  Could not compile `webgl_generator`.

brendanzab · 2018-04-01T12:32:39Z

Oh, I think I need to bump the khronos_api version 🤔

brendanzab · 2018-04-01T12:33:15Z

Oh, and probably also publish those changes

Diggsey · 2018-04-01T12:36:27Z

~~Yes, I think so?~~

brendanzab · 2018-04-01T12:59:11Z

Done!

This was referenced Jan 28, 2018

Add webgl example koute/stdweb#97

Merged

Leverage WebIDL to generate API wrappers koute/stdweb#4

Open

Diggsey force-pushed the webgl-gen branch from 0b42c8c to 643c5ac Compare February 4, 2018 22:49

brendanzab mentioned this pull request Feb 5, 2018

Add WebGL extension constants #451

Merged

Diggsey force-pushed the webgl-gen branch from 643c5ac to 43294b0 Compare February 5, 2018 22:35

Diggsey added 9 commits February 8, 2018 18:50

Add comments

4cb62f1

Implement IDL based generators

4201c95

Implement RenderingContext trait

685b106

Macros are special

aa8e6cb

Implement full type support

d9a1893

Fix type naming

d70e503

Implement support for overloaded functions

7c2c2df

Fix naming of overloads

9701f15

Move webgl_generator into separate crate

2d04c12

Handle name collisions better

e36a3e0

Diggsey mentioned this pull request Feb 16, 2018

Generate wasm -sys crates from webidl rustwasm/team#66

Closed

Diggsey mentioned this pull request Feb 26, 2018

Added WebGL Rendering Context koute/stdweb#110

Closed

Diggsey added 2 commits February 26, 2018 18:30

Use newly released version of stdweb

72b79b2

Remove broken example

1823a5d

brendanzab reviewed Feb 27, 2018

View reviewed changes

webgl_generator/webgl_registry/mod.rs Outdated

Some((field.name, Field {

type_

}))

Copy link

Owner

brendanzab Feb 27, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why does this need to be an Option?

Diggsey added 4 commits March 4, 2018 14:22

Refactor and clean-up

12a4d86

Run rustfmt

3087242

Remove unnecessary option

28ac94f

Add missing license headers

136122f

Diggsey mentioned this pull request Mar 4, 2018

WebIDL binding generator rustwasm/wasm-bindgen#42

Closed

brendanzab merged commit 4f081d2 into brendanzab:master Apr 1, 2018

Diggsey deleted the webgl-gen branch April 1, 2018 12:17

Implement IDL based generators #447

Implement IDL based generators #447

Conversation

Diggsey commented Jan 25, 2018

Diggsey commented Jan 28, 2018

Diggsey commented Jan 28, 2018

brendanzab commented Jan 29, 2018

brendanzab commented Jan 29, 2018

Diggsey commented Jan 29, 2018

tomaka commented Jan 29, 2018

brendanzab commented Jan 29, 2018

tomaka commented Jan 29, 2018

edwin0cheng commented Jan 31, 2018

Diggsey commented Jan 31, 2018

brendanzab commented Feb 2, 2018

Diggsey commented Feb 4, 2018 • edited Loading

Diggsey commented Feb 4, 2018

brendanzab commented Feb 5, 2018

Diggsey commented Feb 5, 2018

brendanzab commented Feb 5, 2018

Diggsey commented Feb 26, 2018 • edited Loading

brendanzab commented Feb 27, 2018

brendanzab Feb 27, 2018

Choose a reason for hiding this comment

Diggsey Mar 3, 2018

Choose a reason for hiding this comment

brendanzab Feb 27, 2018

Choose a reason for hiding this comment

Diggsey Mar 3, 2018

Choose a reason for hiding this comment

brendanzab Feb 27, 2018

Choose a reason for hiding this comment

Diggsey Mar 3, 2018

Choose a reason for hiding this comment

brendanzab Feb 27, 2018

Choose a reason for hiding this comment

brendanzab commented Feb 27, 2018

Diggsey commented Mar 4, 2018

Diggsey commented Mar 20, 2018

brendanzab commented Apr 1, 2018

Diggsey commented Apr 1, 2018

brendanzab commented Apr 1, 2018

brendanzab commented Apr 1, 2018

brendanzab commented Apr 1, 2018

brendanzab commented Apr 1, 2018

brendanzab commented Apr 1, 2018

Diggsey commented Apr 1, 2018 • edited Loading

brendanzab commented Apr 1, 2018

Diggsey commented Feb 4, 2018 •

edited

Loading

Diggsey commented Feb 26, 2018 •

edited

Loading

Diggsey commented Apr 1, 2018 •

edited

Loading