Custom Annotation Syntax for the Wasm Text Format
The Wasm binary format supports custom sections to enable associating arbitrary meta data with a Wasm module.
No equivalent exists for the text format. In particular, there is no way to
- represent custom sections themselves in the text format, cf. WebAssembly/design#1153 and https://gist.github.com/binji/d1cfff7faaebb2aa4f8b1c995234e5a0
- reflect arbitrary names in the text format, cf. WebAssembly/spec#617
- express information like for Web IDL bindings, cf. https://github.com/WebAssembly/webidl-bindings/blob/master/proposals/webidl-bindings/Explainer.md
This proposal adds the ability to decorate a module in textual notarion with arbitrary annotations of the form
Neither the syntactic shape nor the semantics is prescribed by the Wasm specification, though the Appendix might include a description of optional support for name section annotations and generic custom sections.
This proposal only affects the text format, nothing else.
Extend the Text Format as follows:
Anywhere where white space is allowed, allow annotations of the following form:
annot ::= "(@"idchar+ annotelem* ")" annotelem ::= keyword | reserved | uN | sN | fN | string | id | "(" annotelem* ")" | "(@"idchar+ annotelem* ")"
In other words, an annotation can contain any sequence of tokens, as long as it is well-bracketed. No white space is allowed as part of the initial
idchar+is meant to be an identifier categorising the extension, and plays a role similar to the name of a custom section. By convention, annotations corresponding to a custom section should use the same id.
Extend the Appendix on the Custom Sections:
Define annotations reflecting the Name section, which take the form of annotations
(@name "name"). They may be placed after the binder for any construct that can be named by the name section.
Define annotation syntax expressing arbitrary custom sections; cf. https://gist.github.com/binji/d1cfff7faaebb2aa4f8b1c995234e5a0 As with any matter concerning annotations, it is up to implementations how they handle the case where an explicit custom section overlaps with individual annotations that are associated with the same custom section.
Expressing generic custom sections (cf. https://gist.github.com/binji/d1cfff7faaebb2aa4f8b1c995234e5a0)
(module (@custom "my-fancy-section" (after function) "contents-bytes") )
(module (@name "Gümüsü") (func $lambda (@name "λ") (param $x (@name "α βγ δ") i32) (result i32) (get_local $x)) )
(module (func (export "f") (param i32 (@js unsigned)) ...) ;; argument converted as unsigned (func (export "method") (param $x anyref (@js this)) (param $y i32) ...) ;; maps this to first arg (func (import "m" "constructor") (@js new) (param i32) (result anyref) ;; is called as a constructor )