Generate Firefox Desktop front-end bindings with WebIDL (#255); r=@rfk,

@nnethercote

This commit adds a backend that generates bindings for Firefox
front-end code. The bindings are written in WebIDL. For more details,
please see the comments in the `gecko_js` module, as well as the
ADR.

Closes #11.

Co-authored-by: Dan Mosedale <dmose2@gmail.com>

examples/arithmetic/Cargo.toml

@@ -7,7 +7,7 @@ license = "MPL-2.0"
 publish = false
 
 [lib]
-crate-type = ["cdylib"]
+crate-type = ["cdylib", "lib"]
 name = "uniffi_arithmetic"
 
 [dependencies]

examples/rondpoint/Cargo.toml

@@ -7,7 +7,7 @@ license = "MPL-2.0"
 publish = false
 
 [lib]
-crate-type = ["cdylib"]
+crate-type = ["cdylib", "lib"]
 name = "uniffi_rondpoint"
 
 [dependencies]

examples/rondpoint/tests/gecko_js/test_rondpoint.js

@@ -0,0 +1,257 @@
+/*
+ * This file is an xpcshell test that exercises the Rondpoint binding in
+ * Firefox. Non-Gecko JS consumers can safely ignore it.
+ *
+ * If you're working on the Gecko JS bindings, you'll want to either copy or
+ * symlink this folder into m-c, and add the `xpcshell.ini` manifest in this
+ * folder to an `XPCSHELL_TESTS_MANIFESTS` section in the `moz.build` file
+ * that includes the generated bindings.
+ *
+ * Currently, this must be done manually, though we're looking at ways to
+ * run `uniffi-bindgen` as part of the Firefox build, and keep the UniFFI
+ * bindings tests in the tree. https://github.com/mozilla/uniffi-rs/issues/272
+ * has more details.
+ */
+
+add_task(async function test_rondpoint() {
+  deepEqual(
+    Rondpoint.copieDictionnaire({
+      un: "deux",
+      deux: true,
+      petitNombre: 0,
+      grosNombre: 123456789,
+    }),
+    {
+      un: "deux",
+      deux: true,
+      petitNombre: 0,
+      grosNombre: 123456789,
+    }
+  );
+  equal(Rondpoint.copieEnumeration("deux"), "deux");
+  deepEqual(Rondpoint.copieEnumerations(["un", "deux"]), ["un", "deux"]);
+  deepEqual(
+    Rondpoint.copieCarte({
+      1: "un",
+      2: "deux",
+    }),
+    {
+      1: "un",
+      2: "deux",
+    }
+  );
+  ok(Rondpoint.switcheroo(false));
+});
+
+add_task(async function test_retourneur() {
+  let rt = new Retourneur();
+
+  // Booleans.
+  [true, false].forEach(v => strictEqual(rt.identiqueBoolean(v), v));
+
+  // Bytes.
+  [-128, 127].forEach(v => equal(rt.identiqueI8(v), v));
+  [0x00, 0xff].forEach(v => equal(rt.identiqueU8(v), v));
+
+  // Shorts.
+  [-Math.pow(2, 15), Math.pow(2, 15) - 1].forEach(v =>
+    equal(rt.identiqueI16(v), v)
+  );
+  [0, 0xffff].forEach(v => equal(rt.identiqueU16(v), v));
+
+  // Ints.
+  [0, 1, -1, -Math.pow(2, 31), Math.pow(2, 31) - 1].forEach(v =>
+    equal(rt.identiqueI32(v), v)
+  );
+  [0, Math.pow(2, 32) - 1].forEach(v => equal(rt.identiqueU32(v), v));
+
+  // Longs.
+  [0, 1, -1, Number.MIN_SAFE_INTEGER, Number.MAX_SAFE_INTEGER].forEach(v =>
+    equal(rt.identiqueI64(v), v)
+  );
+  [0, 1, Number.MAX_SAFE_INTEGER].forEach(v => equal(rt.identiqueU64(v), v));
+
+  // Floats.
+  [0, 1, 0.25].forEach(v => equal(rt.identiqueFloat(v), v));
+
+  // Doubles.
+  [0, 1, 0.25].forEach(v => equal(rt.identiqueDouble(v), v));
+
+  // Strings.
+  [
+    "",
+    "abc",
+    "null\0byte",
+    "été",
+    "ښي لاس ته لوستلو لوستل",
+    "😻emoji 👨‍👧‍👦multi-emoji, 🇨🇭a flag, a canal, panama",
+  ].forEach(v => equal(rt.identiqueString(v), v));
+
+  [-1, 0, 1].forEach(v => {
+    let dict = {
+      petitNombre: v,
+      courtNombre: v,
+      nombreSimple: v,
+      grosNombre: v,
+    };
+    deepEqual(rt.identiqueNombresSignes(dict), dict);
+  });
+
+  [0, 1].forEach(v => {
+    let dict = {
+      petitNombre: v,
+      courtNombre: v,
+      nombreSimple: v,
+      grosNombre: v,
+    };
+    deepEqual(rt.identiqueNombres(dict), dict);
+  });
+});
+
+add_task(async function test_stringifier() {
+  let st = new Stringifier();
+
+  let wellKnown = st.wellKnownString("firefox");
+  equal(wellKnown, "uniffi 💚 firefox!");
+
+  let table = {
+    toStringBoolean: [
+      [true, "true"],
+      [false, "false"],
+    ],
+    toStringI8: [
+      [-128, "-128"],
+      [127, "127"],
+    ],
+    toStringU8: [
+      [0x00, "0"],
+      [0xff, "255"],
+    ],
+    toStringI16: [
+      [-Math.pow(2, 15), "-32768"],
+      [Math.pow(2, 15) - 1, "32767"],
+    ],
+    toStringU16: [
+      [0, "0"],
+      [0xffff, "65535"],
+    ],
+    toStringI32: [
+      [0, "0"],
+      [1, "1"],
+      [-1, "-1"],
+      [-Math.pow(2, 31), "-2147483648"],
+      [Math.pow(2, 31) - 1, "2147483647"],
+    ],
+    toStringU32: [
+      [0, "0"],
+      [Math.pow(2, 32) - 1, "4294967295"],
+    ],
+    toStringI64: [
+      [0, "0"],
+      [1, "1"],
+      [-1, "-1"],
+      [Number.MIN_SAFE_INTEGER, "-9007199254740991"],
+      [Number.MAX_SAFE_INTEGER, "9007199254740991"],
+    ],
+    toStringU64: [
+      [0, "0"],
+      [1, "1"],
+      [Number.MAX_SAFE_INTEGER, "9007199254740991"],
+    ],
+    toStringFloat: [
+      [0, "0"],
+      [1, "1"],
+      [0.25, "0.25"],
+    ],
+    toStringDouble: [
+      [0, "0"],
+      [1, "1"],
+      [0.25, "0.25"],
+    ],
+  };
+  for (let method in table) {
+    for (let [v, expected] of table[method]) {
+      strictEqual(st[method](v), expected);
+    }
+  }
+});
+
+add_task(async function test_optionneur() {
+  // Step 1: call the methods without arguments, and check against the IDL.
+
+  let op = new Optionneur();
+
+  equal(op.sinonString(), "default");
+  strictEqual(op.sinonBoolean(), false);
+  deepEqual(op.sinonSequence(), []);
+
+  // Nullables.
+  strictEqual(op.sinonNull(), null);
+  strictEqual(op.sinonZero(), 0);
+
+  // Decimal integers.
+  equal(op.sinonI8Dec(), -42);
+  equal(op.sinonU8Dec(), 42);
+  equal(op.sinonI16Dec(), 42);
+  equal(op.sinonU16Dec(), 42);
+  equal(op.sinonI32Dec(), 42);
+  equal(op.sinonU32Dec(), 42);
+  equal(op.sinonI64Dec(), 42);
+  equal(op.sinonU64Dec(), 42);
+
+  // Hexadecimal integers.
+  equal(op.sinonI8Hex(), -0x7f);
+  equal(op.sinonU8Hex(), 0xff);
+  equal(op.sinonI16Hex(), 0x7f);
+  equal(op.sinonU16Hex(), 0xffff);
+  equal(op.sinonI32Hex(), 0x7fffffff);
+  equal(op.sinonU32Hex(), 0xffffffff);
+
+  // Octal integers.
+  equal(op.sinonU32Oct(), 493);
+
+  // Floats.
+  equal(op.sinonF32(), 42);
+  equal(op.sinonF64(), 42.1);
+
+  // Enums.
+  equal(op.sinonEnum(), "trois");
+
+  // Step 2. Convince ourselves that if we pass something else, then that
+  // changes the output.
+
+  let table = {
+    sinonString: ["foo", "bar"],
+    sinonBoolean: [true, false],
+    sinonNull: ["0", "1"],
+    sinonZero: [0, 1],
+    sinonU8Dec: [0, 1],
+    sinonI8Dec: [0, 1],
+    sinonU16Dec: [0, 1],
+    sinonI16Dec: [0, 1],
+    sinonU32Dec: [0, 1],
+    sinonI32Dec: [0, 1],
+    sinonU64Dec: [0, 1],
+    sinonI64Dec: [0, 1],
+    sinonU8Hex: [0, 1],
+    sinonI8Hex: [0, 1],
+    sinonU16Hex: [0, 1],
+    sinonI16Hex: [0, 1],
+    sinonU32Hex: [0, 1],
+    sinonI32Hex: [0, 1],
+    sinonU64Hex: [0, 1],
+    sinonI64Hex: [0, 1],
+    sinonU32Oct: [0, 1],
+    sinonF32: [0, 1],
+    sinonF64: [0, 1],
+    sinonEnum: ["un", "deux", "trois"],
+  };
+  for (let method in table) {
+    for (let v of table[method]) {
+      strictEqual(op[method](v), v);
+    }
+  }
+  [["a", "b"], []].forEach(v => {
+    deepEqual(op.sinonSequence(v), v);
+  });
+});

examples/rondpoint/tests/gecko_js/xpcshell.ini

@@ -0,0 +1 @@
+[test_rondpoint.js]

uniffi/Cargo.toml

@@ -18,7 +18,7 @@ ffi-support = "~0.4.2"
 lazy_static = "1.4"
 log = "0.4"
 # Regular dependencies
-cargo_metadata = "0.11"
+cargo_metadata = "0.11.3"
 paste = "1.0"
 uniffi_bindgen = { path = "../uniffi_bindgen", optional = true, version = "0.2.0" }
 

uniffi_bindgen/Cargo.toml

@@ -15,7 +15,7 @@ name = "uniffi-bindgen"
 path = "src/main.rs"
 
 [dependencies]
-cargo_metadata = "0.11"
+cargo_metadata = "0.11.3"
 weedle = "0.11"
 anyhow = "1"
 askama = "0.10"

uniffi_bindgen/askama.toml

@@ -1,6 +1,6 @@
 [general]
 # Directories to search for templates, relative to the crate root.
-dirs = [ "src/templates", "src/bindings/kotlin/templates", "src/bindings/python/templates", "src/bindings/swift/templates" ]
+dirs = [ "src/templates", "src/bindings/kotlin/templates", "src/bindings/python/templates", "src/bindings/swift/templates", "src/bindings/gecko_js/templates" ]
 
 [[syntax]]
 name = "kt"
@@ -15,4 +15,13 @@ name = "swift"
 name = "c"
 
 [[syntax]]
-name = "rs"
+name = "rs"
+
+[[syntax]]
+name = "webidl"
+
+[[syntax]]
+name = "xpidl"
+
+[[syntax]]
+name = "cpp"