Add minimal mention of Wasm/TS support in docs

mutagene · mutagene · commit e0c0dce2d355 · 2023-11-18T23:33:57.000+01:00
diff --git a/README.md b/README.md
@@ -20,6 +20,7 @@ Djinni generator parses an interface definition file and generates:
 - Objective-C++ code to convert between C++ and Objective-C
 - Python and C code to convert between C++ and Python over CFFI
 - C++/CLI code to convert between C++ and C#
+- C++ code to convert between WebAssembly and TS/JS
 
 
 ## Installation
@@ -86,3 +87,5 @@ The code in this repository is in large portions copied from [dropbox/djinni](ht
 - Jacob Potter
 - Iulia Tamas
 - Andrew Twyman
+
+WebAssembly support is borrowed in large part from [snapchat/djinni](https://github.com/snapchat/djinni).
diff --git a/docs/cli-usage.md b/docs/cli-usage.md
@@ -145,6 +145,14 @@ djinni \
 | `--cppcli-namespace ...`               | The namespace name to use for generated C++/CLI classes.                   |
 | `--cppcli-include-cpp-prefix <prefix>` | The prefix for `#include` of the main C++ header files from C++/CLI files. |
 
+### WebAssembly/TS/JS
+
+| Argument                               | Description                                                                |
+|----------------------------------------|----------------------------------------------------------------------------|
+| `--wasm-out <out-folder>`              | WebAssembly bridge code output folder   |
+| `--ts-out <out-folder>`                | Path to the Typescript type definitions output folder                   |
+| `--ts-module <module>`                 | Name of the module for the Typescript types. `module.ts` by default. |
+
 
 ### Yaml Generation
 
diff --git a/src/main/scala/djinni/TsGenerator.scala b/src/main/scala/djinni/TsGenerator.scala
@@ -156,7 +156,7 @@ class TsGenerator(spec: Spec) extends Generator(spec) {
     }
   }
 
-  //------------------------------------------------------------------------
+  // ------------------------------------------------------------------------
   private def generateEnum(
       origin: String,
       ident: Ident,
@@ -245,7 +245,7 @@ class TsGenerator(spec: Spec) extends Generator(spec) {
         ) + sep + name
       case None => name
     }
-  //--------------------------------------------------------------------------
+  // --------------------------------------------------------------------------
   override def generate(idl: Seq[TypeDecl]) {
     createFile(
       spec.tsOutFolder.get,
diff --git a/src/main/scala/djinni/WasmGenerator.scala b/src/main/scala/djinni/WasmGenerator.scala
@@ -234,7 +234,7 @@ class WasmGenerator(spec: Spec) extends Generator(spec) {
       if (!spec.wasmOmitNsAlias && !spec.wasmNamespace.isEmpty) {
         w.wl(
           s"""    ::djinni::djinni_register_name_in_ns("${fullyQualifiedName}", "${spec.wasmNamespace.get}.${idJs
-            .ty(ident)}");"""
+              .ty(ident)}");"""
         )
       }
       w.wl(s"});")
@@ -249,7 +249,7 @@ class WasmGenerator(spec: Spec) extends Generator(spec) {
     }
   }
 
-  //------------------------------------------------------------------------------
+  // ------------------------------------------------------------------------------
 
   override def generateEnum(origin: String, ident: Ident, doc: Doc, e: Enum) {
     val refs = new WasmRefs(ident.name)
@@ -306,7 +306,7 @@ class WasmGenerator(spec: Spec) extends Generator(spec) {
             if (!spec.wasmOmitNsAlias && !spec.wasmNamespace.isEmpty) {
               w.wl(
                 s"""    ::djinni::djinni_register_name_in_ns("${fullyQualifiedName}", "${spec.wasmNamespace.get}.${idJs
-                  .ty(ident)}");"""
+                    .ty(ident)}");"""
               )
             }
             w.wl(s"});")
@@ -484,7 +484,7 @@ class WasmGenerator(spec: Spec) extends Generator(spec) {
                 w.wl(";")
                 m.ret.fold(())(r =>
                   w.wl(s"return ${helperClass(r.resolved)}::fromCpp(${cppMarshal
-                    .maybeMove("r", r)});")
+                      .maybeMove("r", r)});")
                 )
               }
               w.w("catch(const std::exception& e)").braced {
@@ -506,7 +506,7 @@ class WasmGenerator(spec: Spec) extends Generator(spec) {
               val constModifier = if (m.const) " const" else ""
               w.w(
                 s"${cppMarshal.fqReturnType(m.ret)} ${helper}::JsProxy::${idCpp
-                  .method(m.ident)}("
+                    .method(m.ident)}("
               )
               w.w(
                 m.params
@@ -526,7 +526,7 @@ class WasmGenerator(spec: Spec) extends Generator(spec) {
                   s")",
                   p => {
                     s"${helperClass(p.ty.resolved)}::fromCpp(${cppMarshal
-                      .maybeMove(idCpp.local(p.ident), p.ty)})"
+                        .maybeMove(idCpp.local(p.ident), p.ty)})"
                   }
                 )
                 w.wl(";")
@@ -556,7 +556,7 @@ class WasmGenerator(spec: Spec) extends Generator(spec) {
           val classRegister =
             if (!spec.wasmOmitNsAlias && !spec.wasmNamespace.isEmpty) {
               s"""::djinni::DjinniClass_<$cls>("${fullyQualifiedJsName}", "${spec.wasmNamespace.get}.${idJs
-                .ty(ident.name)}")"""
+                  .ty(ident.name)}")"""
             } else {
               s"""em::class_<$cls>("${fullyQualifiedJsName}")"""
             }
@@ -566,13 +566,13 @@ class WasmGenerator(spec: Spec) extends Generator(spec) {
               s""".smart_ptr<std::shared_ptr<$cls>>("${fullyQualifiedJsName}")"""
             )
             w.wl(s""".function("${idJs
-              .method("native_destroy")}", &$helper::nativeDestroy)""")
+                .method("native_destroy")}", &$helper::nativeDestroy)""")
             if (i.ext.cpp) {
               for (m <- i.methods.filter(m => !m.static || m.lang.js)) {
                 val funcType = if (m.static) "class_function" else "function"
                 w.wl(s""".$funcType("${idJs.method(
-                  m.ident.name
-                )}", $helper::${idCpp.method(m.ident)})""")
+                    m.ident.name
+                  )}", $helper::${idCpp.method(m.ident)})""")
               }
             }
             w.wl(";")
@@ -661,7 +661,7 @@ class WasmGenerator(spec: Spec) extends Generator(spec) {
             "}",
             f => {
               s"""${helperClass(f.ty.resolved)}::Boxed::toCpp(j["${idJs
-                .field(f.ident.name)}"])"""
+                  .field(f.ident.name)}"])"""
             }
           )
           w.wl(";")
@@ -670,9 +670,9 @@ class WasmGenerator(spec: Spec) extends Generator(spec) {
           w.wl("em::val js = em::val::object();")
           for (f <- r.fields) {
             w.wl(s"""js.set("${idJs.field(f.ident.name)}", ${helperClass(
-              f.ty.resolved
-            )}::Boxed::fromCpp(${cppMarshal
-              .maybeMove("c." + idCpp.field(f.ident), f.ty)}));""")
+                f.ty.resolved
+              )}::Boxed::fromCpp(${cppMarshal
+                .maybeMove("c." + idCpp.field(f.ident), f.ty)}));""")
           }
           w.wl("return js;")
         }
diff --git a/src/main/scala/djinni/YamlGenerator.scala b/src/main/scala/djinni/YamlGenerator.scala
@@ -206,7 +206,7 @@ class YamlGenerator(spec: Spec) extends Generator(spec) {
   private def ts(td: TypeDecl) = Map[String, Any](
     "typename" -> tsMarshal.toTsType(mexpr(td), /*addNullability*/ false),
     "module" -> QuotedString("./" + spec.tsModule)
-    //, "generic" -> false
+    // , "generic" -> false
   )
 
   // TODO: there has to be a way to do all this without the MExpr/Meta conversions?
diff --git a/src/main/scala/djinni/parser.scala b/src/main/scala/djinni/parser.scala
@@ -91,7 +91,7 @@ case class Parser(includePaths: List[String]) {
           InternTypeDecl(ident, typeParams, body, doc, origin)
       }
 
-    def ext(default: Ext): Parser[Ext] = 
+    def ext(default: Ext): Parser[Ext] =
       (rep1("+" ~> ident) >> checkExts) | success(default)
     def extRecord: Parser[Ext] = ext(
       Ext(

Original file line number	Diff line number	Diff line change
`@@ -156,7 +156,7 @@ class TsGenerator(spec: Spec) extends Generator(spec) {`
`156`	`156`	`}`
`157`	`157`	`}`
`158`	`158`
`159`		`- //------------------------------------------------------------------------`
	`159`	`+ // ------------------------------------------------------------------------`
`160`	`160`	`private def generateEnum(`
`161`	`161`	`origin: String,`
`162`	`162`	`ident: Ident,`
`@@ -245,7 +245,7 @@ class TsGenerator(spec: Spec) extends Generator(spec) {`
`245`	`245`	`) + sep + name`
`246`	`246`	`case None => name`
`247`	`247`	`}`
`248`		`- //--------------------------------------------------------------------------`
	`248`	`+ // --------------------------------------------------------------------------`
`249`	`249`	`override def generate(idl: Seq[TypeDecl]) {`
`250`	`250`	`createFile(`
`251`	`251`	`spec.tsOutFolder.get,`
Original file line number	Diff line number	Diff line change
`@@ -234,7 +234,7 @@ class WasmGenerator(spec: Spec) extends Generator(spec) {`
`234`	`234`	`if (!spec.wasmOmitNsAlias && !spec.wasmNamespace.isEmpty) {`
`235`	`235`	`w.wl(`
`236`	`236`	`s""" ::djinni::djinni_register_name_in_ns("${fullyQualifiedName}", "${spec.wasmNamespace.get}.${idJs`
`237`		`- .ty(ident)}");"""`
	`237`	`+ .ty(ident)}");"""`
`238`	`238`	`)`
`239`	`239`	`}`
`240`	`240`	`w.wl(s"});")`
`@@ -249,7 +249,7 @@ class WasmGenerator(spec: Spec) extends Generator(spec) {`
`249`	`249`	`}`
`250`	`250`	`}`
`251`	`251`
`252`		`- //------------------------------------------------------------------------------`
	`252`	`+ // ------------------------------------------------------------------------------`
`253`	`253`
`254`	`254`	`override def generateEnum(origin: String, ident: Ident, doc: Doc, e: Enum) {`
`255`	`255`	`val refs = new WasmRefs(ident.name)`
`@@ -306,7 +306,7 @@ class WasmGenerator(spec: Spec) extends Generator(spec) {`
`306`	`306`	`if (!spec.wasmOmitNsAlias && !spec.wasmNamespace.isEmpty) {`
`307`	`307`	`w.wl(`
`308`	`308`	`s""" ::djinni::djinni_register_name_in_ns("${fullyQualifiedName}", "${spec.wasmNamespace.get}.${idJs`
`309`		`- .ty(ident)}");"""`
	`309`	`+ .ty(ident)}");"""`
`310`	`310`	`)`
`311`	`311`	`}`
`312`	`312`	`w.wl(s"});")`
`@@ -484,7 +484,7 @@ class WasmGenerator(spec: Spec) extends Generator(spec) {`
`484`	`484`	`w.wl(";")`
`485`	`485`	`m.ret.fold(())(r =>`
`486`	`486`	`w.wl(s"return ${helperClass(r.resolved)}::fromCpp(${cppMarshal`
`487`		`- .maybeMove("r", r)});")`
	`487`	`+ .maybeMove("r", r)});")`
`488`	`488`	`)`
`489`	`489`	`}`
`490`	`490`	`w.w("catch(const std::exception& e)").braced {`
`@@ -506,7 +506,7 @@ class WasmGenerator(spec: Spec) extends Generator(spec) {`
`506`	`506`	`val constModifier = if (m.const) " const" else ""`
`507`	`507`	`w.w(`
`508`	`508`	`s"${cppMarshal.fqReturnType(m.ret)} ${helper}::JsProxy::${idCpp`
`509`		`- .method(m.ident)}("`
	`509`	`+ .method(m.ident)}("`
`510`	`510`	`)`
`511`	`511`	`w.w(`
`512`	`512`	`m.params`
`@@ -526,7 +526,7 @@ class WasmGenerator(spec: Spec) extends Generator(spec) {`
`526`	`526`	`s")",`
`527`	`527`	`p => {`
`528`	`528`	`s"${helperClass(p.ty.resolved)}::fromCpp(${cppMarshal`
`529`		`- .maybeMove(idCpp.local(p.ident), p.ty)})"`
	`529`	`+ .maybeMove(idCpp.local(p.ident), p.ty)})"`
`530`	`530`	`}`
`531`	`531`	`)`
`532`	`532`	`w.wl(";")`
`@@ -556,7 +556,7 @@ class WasmGenerator(spec: Spec) extends Generator(spec) {`
`556`	`556`	`val classRegister =`
`557`	`557`	`if (!spec.wasmOmitNsAlias && !spec.wasmNamespace.isEmpty) {`
`558`	`558`	`s"""::djinni::DjinniClass_<$cls>("${fullyQualifiedJsName}", "${spec.wasmNamespace.get}.${idJs`
`559`		`- .ty(ident.name)}")"""`
	`559`	`+ .ty(ident.name)}")"""`
`560`	`560`	`} else {`
`561`	`561`	`s"""em::class_<$cls>("${fullyQualifiedJsName}")"""`
`562`	`562`	`}`
`@@ -566,13 +566,13 @@ class WasmGenerator(spec: Spec) extends Generator(spec) {`
`566`	`566`	`s""".smart_ptr<std::shared_ptr<$cls>>("${fullyQualifiedJsName}")"""`
`567`	`567`	`)`
`568`	`568`	`w.wl(s""".function("${idJs`
`569`		`- .method("native_destroy")}", &$helper::nativeDestroy)""")`
	`569`	`+ .method("native_destroy")}", &$helper::nativeDestroy)""")`
`570`	`570`	`if (i.ext.cpp) {`
`571`	`571`	`for (m <- i.methods.filter(m => !m.static \|\| m.lang.js)) {`
`572`	`572`	`val funcType = if (m.static) "class_function" else "function"`
`573`	`573`	`w.wl(s""".$funcType("${idJs.method(`
`574`		`- m.ident.name`
`575`		`- )}", $helper::${idCpp.method(m.ident)})""")`
	`574`	`+ m.ident.name`
	`575`	`+ )}", $helper::${idCpp.method(m.ident)})""")`
`576`	`576`	`}`
`577`	`577`	`}`
`578`	`578`	`w.wl(";")`
`@@ -661,7 +661,7 @@ class WasmGenerator(spec: Spec) extends Generator(spec) {`
`661`	`661`	`"}",`
`662`	`662`	`f => {`
`663`	`663`	`s"""${helperClass(f.ty.resolved)}::Boxed::toCpp(j["${idJs`
`664`		`- .field(f.ident.name)}"])"""`
	`664`	`+ .field(f.ident.name)}"])"""`
`665`	`665`	`}`
`666`	`666`	`)`
`667`	`667`	`w.wl(";")`
`@@ -670,9 +670,9 @@ class WasmGenerator(spec: Spec) extends Generator(spec) {`
`670`	`670`	`w.wl("em::val js = em::val::object();")`
`671`	`671`	`for (f <- r.fields) {`
`672`	`672`	`w.wl(s"""js.set("${idJs.field(f.ident.name)}", ${helperClass(`
`673`		`- f.ty.resolved`
`674`		`- )}::Boxed::fromCpp(${cppMarshal`
`675`		`- .maybeMove("c." + idCpp.field(f.ident), f.ty)}));""")`
	`673`	`+ f.ty.resolved`
	`674`	`+ )}::Boxed::fromCpp(${cppMarshal`
	`675`	`+ .maybeMove("c." + idCpp.field(f.ident), f.ty)}));""")`
`676`	`676`	`}`
`677`	`677`	`w.wl("return js;")`
`678`	`678`	`}`
Original file line number	Diff line number	Diff line change
`@@ -206,7 +206,7 @@ class YamlGenerator(spec: Spec) extends Generator(spec) {`
`206`	`206`	`private def ts(td: TypeDecl) = Map[String, Any](`
`207`	`207`	`"typename" -> tsMarshal.toTsType(mexpr(td), /addNullability/ false),`
`208`	`208`	`"module" -> QuotedString("./" + spec.tsModule)`
`209`		`- //, "generic" -> false`
	`209`	`+ // , "generic" -> false`
`210`	`210`	`)`
`211`	`211`
`212`	`212`	`// TODO: there has to be a way to do all this without the MExpr/Meta conversions?`
Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ case class Parser(includePaths: List[String]) {`
`91`	`91`	`InternTypeDecl(ident, typeParams, body, doc, origin)`
`92`	`92`	`}`
`93`	`93`
`94`		`- def ext(default: Ext): Parser[Ext] =`
	`94`	`+ def ext(default: Ext): Parser[Ext] =`
`95`	`95`	`(rep1("+" ~> ident) >> checkExts) \| success(default)`
`96`	`96`	`def extRecord: Parser[Ext] = ext(`
`97`	`97`	`Ext(`