feat: support async iterable<> (#365)

w3c · Aug 7, 2019 · cf8caf5 · cf8caf5
1 parent 76dca6b
commit cf8caf5
Show file tree

Hide file tree

Showing 14 changed files with 148 additions and 14 deletions.
diff --git a/lib/productions/iterable.js b/lib/productions/iterable.js
@@ -10,16 +10,20 @@ export class IterableLike extends Base {
     const tokens = {};
     const ret = new IterableLike({ source: tokeniser.source, tokens });
     tokens.readonly = tokeniser.consume("readonly");
-    tokens.base = tokens.readonly ?
-      tokeniser.consume("maplike", "setlike") :
+    if (!tokens.readonly) {
+      tokens.async = tokeniser.consume("async");
+    }
+    tokens.base =
+      tokens.readonly ? tokeniser.consume("maplike", "setlike") :
+      tokens.async ? tokeniser.consume("iterable") :
       tokeniser.consume("iterable", "maplike", "setlike");
     if (!tokens.base) {
       tokeniser.unconsume(start_position);
       return;
     }
 
     const { type } = ret;
-    const secondTypeRequired = type === "maplike";
+    const secondTypeRequired = type === "maplike" || ret.async;
     const secondTypeAllowed = secondTypeRequired || type === "iterable";
 
     tokens.open = tokeniser.consume("<") || tokeniser.error(`Missing less-than sign \`<\` in ${type} declaration`);
@@ -30,8 +34,9 @@ export class IterableLike extends Base {
       if (first.tokens.separator) {
         ret.idlType.push(type_with_extended_attributes(tokeniser));
       }
-      else if (secondTypeRequired)
-      tokeniser.error(`Missing second type argument in ${type} declaration`);
+      else if (secondTypeRequired) {
+        tokeniser.error(`Missing second type argument in ${type} declaration`);
+      }
     }
     tokens.close = tokeniser.consume(">") || tokeniser.error(`Missing greater-than sign \`>\` in ${type} declaration`);
     tokens.termination = tokeniser.consume(";") || tokeniser.error(`Missing semicolon after ${type} declaration`);
@@ -45,4 +50,7 @@ export class IterableLike extends Base {
   get readonly() {
     return !!this.tokens.readonly;
   }
+  get async() {
+    return !!this.tokens.async;
+  }
 }
diff --git a/lib/tokeniser.js b/lib/tokeniser.js
@@ -50,6 +50,7 @@ const nonRegexTerminals = [
   "Infinity",
   "NaN",
   "Promise",
+  "async",
   "boolean",
   "byte",
   "double",

diff --git a/lib/writer.js b/lib/writer.js
@@ -257,6 +257,7 @@ export function write(ast, { templates: ts = templates } = {}) {
     return ts.definition(ts.wrap([
       extended_attributes(it.extAttrs),
       token(it.tokens.readonly),
+      token(it.tokens.async),
       token(it.tokens.base, ts.generic),
       token(it.tokens.open),
       ts.wrap(it.idlType.map(type)),

diff --git a/test/invalid/baseline/async-iterable-readonly.txt b/test/invalid/baseline/async-iterable-readonly.txt
@@ -0,0 +1,3 @@
+Syntax error at line 3 in async-iterable-readonly.webidl, since `interface AsyncIterable`:
+  readonly async iterable<long
+  ^ Missing return type
diff --git a/test/invalid/baseline/async-iterable-single.txt b/test/invalid/baseline/async-iterable-single.txt
@@ -0,0 +1,3 @@
+Syntax error at line 3 in async-iterable-single.webidl, since `interface AsyncIterable`:
+  async iterable<long>;
+                     ^ Missing second type argument in iterable declaration
diff --git a/test/invalid/baseline/async-maplike.txt b/test/invalid/baseline/async-maplike.txt
@@ -0,0 +1,3 @@
+Syntax error at line 3 in async-maplike.webidl, since `interface AsyncIterable`:
+  async maplike<DOMString,
+  ^ Missing return type
diff --git a/test/invalid/idl/async-iterable-readonly.webidl b/test/invalid/idl/async-iterable-readonly.webidl
@@ -0,0 +1,4 @@
+[Exposed=Window]
+interface AsyncIterable {
+  readonly async iterable<long, short>;
+};
diff --git a/test/invalid/idl/async-iterable-single.webidl b/test/invalid/idl/async-iterable-single.webidl
@@ -0,0 +1,4 @@
+[Exposed=Window]
+interface AsyncIterable {
+  async iterable<long>;
+};
diff --git a/test/invalid/idl/async-maplike.webidl b/test/invalid/idl/async-maplike.webidl
@@ -0,0 +1,4 @@
+[Exposed=Window]
+interface AsyncIterable {
+  async maplike<DOMString, DOMString>;
+};
diff --git a/test/syntax/baseline/async-iterable.json b/test/syntax/baseline/async-iterable.json
@@ -0,0 +1,87 @@
+[
+    {
+        "type": "interface",
+        "name": "AsyncIterable",
+        "inheritance": null,
+        "members": [
+            {
+                "type": "iterable",
+                "idlType": [
+                    {
+                        "type": null,
+                        "extAttrs": [],
+                        "generic": "",
+                        "nullable": false,
+                        "union": false,
+                        "idlType": "long"
+                    },
+                    {
+                        "type": null,
+                        "extAttrs": [],
+                        "generic": "",
+                        "nullable": false,
+                        "union": false,
+                        "idlType": "float"
+                    }
+                ],
+                "extAttrs": [],
+                "readonly": false,
+                "async": true
+            }
+        ],
+        "extAttrs": [],
+        "partial": false
+    },
+    {
+        "type": "interface",
+        "name": "AsyncIterableWithExtAttr",
+        "inheritance": null,
+        "members": [
+            {
+                "type": "iterable",
+                "idlType": [
+                    {
+                        "type": null,
+                        "extAttrs": [
+                            {
+                                "type": "extended-attribute",
+                                "name": "XAttr2",
+                                "rhs": null,
+                                "arguments": []
+                            }
+                        ],
+                        "generic": "",
+                        "nullable": false,
+                        "union": false,
+                        "idlType": "DOMString"
+                    },
+                    {
+                        "type": null,
+                        "extAttrs": [
+                            {
+                                "type": "extended-attribute",
+                                "name": "XAttr3",
+                                "rhs": null,
+                                "arguments": []
+                            }
+                        ],
+                        "generic": "",
+                        "nullable": false,
+                        "union": false,
+                        "idlType": "long"
+                    }
+                ],
+                "extAttrs": [],
+                "readonly": false,
+                "async": true
+            }
+        ],
+        "extAttrs": [],
+        "partial": false
+    },
+    {
+        "type": "eof",
+        "value": "",
+        "trivia": "\n"
+    }
+]
diff --git a/test/syntax/baseline/iterable.json b/test/syntax/baseline/iterable.json
@@ -17,7 +17,8 @@
                     }
                 ],
                 "extAttrs": [],
-                "readonly": false
+                "readonly": false,
+                "async": false
             }
         ],
         "extAttrs": [],
@@ -49,7 +50,8 @@
                     }
                 ],
                 "extAttrs": [],
-                "readonly": false
+                "readonly": false,
+                "async": false
             }
         ],
         "extAttrs": [],
@@ -80,7 +82,8 @@
                     }
                 ],
                 "extAttrs": [],
-                "readonly": false
+                "readonly": false,
+                "async": false
             }
         ],
         "extAttrs": [],

diff --git a/test/syntax/baseline/maplike.json b/test/syntax/baseline/maplike.json
@@ -25,7 +25,8 @@
                     }
                 ],
                 "extAttrs": [],
-                "readonly": false
+                "readonly": false,
+                "async": false
             }
         ],
         "extAttrs": [],
@@ -57,7 +58,8 @@
                     }
                 ],
                 "extAttrs": [],
-                "readonly": true
+                "readonly": true,
+                "async": false
             }
         ],
         "extAttrs": [],
@@ -103,7 +105,8 @@
                     }
                 ],
                 "extAttrs": [],
-                "readonly": false
+                "readonly": false,
+                "async": false
             }
         ],
         "extAttrs": [],

diff --git a/test/syntax/baseline/setlike.json b/test/syntax/baseline/setlike.json
@@ -17,7 +17,8 @@
                     }
                 ],
                 "extAttrs": [],
-                "readonly": false
+                "readonly": false,
+                "async": false
             }
         ],
         "extAttrs": [],
@@ -41,7 +42,8 @@
                     }
                 ],
                 "extAttrs": [],
-                "readonly": true
+                "readonly": true,
+                "async": false
             }
         ],
         "extAttrs": [],
@@ -72,7 +74,8 @@
                     }
                 ],
                 "extAttrs": [],
-                "readonly": false
+                "readonly": false,
+                "async": false
             }
         ],
         "extAttrs": [],

diff --git a/test/syntax/idl/async-iterable.webidl b/test/syntax/idl/async-iterable.webidl
@@ -0,0 +1,7 @@
+interface AsyncIterable {
+  async iterable<long, float>;
+};
+
+interface AsyncIterableWithExtAttr {
+    async iterable<[XAttr2] DOMString, [XAttr3] long>;
+};