Merge pull request #25 from jyasskin/required-dictionary-field

Parse required dictionary fields.
w3c · Apr 23, 2015 · e5ef393 · e5ef393
2 parents d2da147 + 5d81cee
commit e5ef393
Show file tree

Hide file tree

Showing 7 changed files with 42 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -223,6 +223,7 @@ A dictionary looks like this:
             {
                 "type": "field",
                 "name": "fillPattern",
+                "required": false,
                 "idlType": {
                     "sequence": false,
                     "generic": null,
@@ -255,6 +256,7 @@ All the members are fields as follows:
 
 * `type`: Always "field".
 * `name`: The name of the field.
+* `required`: Boolean indicating whether this is a [required](https://heycam.github.io/webidl/#required-dictionary-member) field.
 * `idlType`: An [IDL Type](#idl-type) describing what field's type.
 * `extAttrs`: A list of [extended attributes](#extended-attributes).
 * `default`: A [default value](#default-and-const-values), absent if there is none.

diff --git a/lib/webidl2.js b/lib/webidl2.js
@@ -758,15 +758,19 @@
                 }
                 var ea = extended_attrs(store ? mems : null);
                 all_ws(store ? mems : null, "pea");
+                var required = consume(ID, "required");
                 var typ = type() || error("No type for dictionary member");
                 all_ws();
                 var name = consume(ID) || error("No name for dictionary member");
+                var dflt = default_();
+                if (required && dflt) error("Required member must not have a default");
                 ret.members.push({
                     type:       "field"
                 ,   name:       name.value
+                ,   required:   !!required
                 ,   idlType:    typ
                 ,   extAttrs:   ea
-                ,   "default":  default_()
+                ,   "default":  dflt
                 });
                 all_ws();
                 consume(OTHER, ";") || error("Unterminated dictionary member");

diff --git a/test/invalid/idl/dict-required-default.widl b/test/invalid/idl/dict-required-default.widl
@@ -0,0 +1,5 @@
+// https://heycam.github.io/webidl/#required-dictionary-member
+// "A required dictionary member must not have a default value."
+dictionary Dict {
+  required long member = 0;
+};
diff --git a/test/invalid/json/dict-required-default.json b/test/invalid/json/dict-required-default.json
@@ -0,0 +1,4 @@
+{
+    "message":  "Required member must not have a default"
+,   "line":     4
+}
diff --git a/test/syntax/idl/dictionary.widl b/test/syntax/idl/dictionary.widl
@@ -5,6 +5,8 @@ dictionary PaintOptions {
   Point position;
   // https://heycam.github.io/webidl/#dfn-optional-argument-default-value allows sequences to default to "[]".
   sequence<long> seq = [];
+  // https://heycam.github.io/webidl/#required-dictionary-member
+  required long reqSeq;
 };
 
 partial dictionary A {

diff --git a/test/syntax/json/dictionary-inherits.json b/test/syntax/json/dictionary-inherits.json
@@ -7,6 +7,7 @@
             {
                 "type": "field",
                 "name": "fillPattern",
+                "required": false,
                 "idlType": {
                     "sequence": false,
                     "generic": null,
@@ -24,6 +25,7 @@
             {
                 "type": "field",
                 "name": "strokePattern",
+                "required": false,
                 "idlType": {
                     "sequence": false,
                     "generic": null,
@@ -40,6 +42,7 @@
             {
                 "type": "field",
                 "name": "position",
+                "required": false,
                 "idlType": {
                     "sequence": false,
                     "generic": null,
@@ -62,6 +65,7 @@
             {
                 "type": "field",
                 "name": "hydrometry",
+                "required": false,
                 "idlType": {
                     "sequence": false,
                     "generic": null,

diff --git a/test/syntax/json/dictionary.json b/test/syntax/json/dictionary.json
@@ -7,6 +7,7 @@
             {
                 "type": "field",
                 "name": "fillPattern",
+                "required": false,
                 "idlType": {
                     "sequence": false,
                     "generic": null,
@@ -24,6 +25,7 @@
             {
                 "type": "field",
                 "name": "strokePattern",
+                "required": false,
                 "idlType": {
                     "sequence": false,
                     "generic": null,
@@ -40,6 +42,7 @@
             {
                 "type": "field",
                 "name": "position",
+                "required": false,
                 "idlType": {
                     "sequence": false,
                     "generic": null,
@@ -53,6 +56,7 @@
             {
                 "type": "field",
                 "name": "seq",
+                "required": false,
                 "idlType": {
                     "sequence": true,
                     "generic": "sequence",
@@ -73,6 +77,20 @@
                     "type": "sequence",
                     "value": []
                 }
+            },
+            {
+                "type": "field",
+                "name": "reqSeq",
+                "required": true,
+                "idlType": {
+                    "sequence": false,
+                    "generic": null,
+                    "nullable": false,
+                    "array": false,
+                    "union": false,
+                    "idlType": "long"
+                },
+                "extAttrs": []
             }
         ],
         "inheritance": null,
@@ -86,6 +104,7 @@
             {
                 "type": "field",
                 "name": "h",
+                "required": false,
                 "idlType": {
                     "sequence": false,
                     "generic": null,
@@ -99,6 +118,7 @@
             {
                 "type": "field",
                 "name": "d",
+                "required": false,
                 "idlType": {
                     "sequence": false,
                     "generic": null,