forked from dropbox/djinni
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Generate YAML files with type descriptions for other projects
These YAML files generated by Djinni hold all the necessary information to integrate these types with other Djinni projects, thus making (precompiled) libraries with possible. There are still limitations: - Extern enums/records cannot be used as constants as their enumerant/field information is not yet preserved. - Include paths are fixed at the point of YAML generation, including paths do Djinni's support-lib. This may require some form of placeholders, or being smart about project structure in general. Generation is controlled with following options - --yaml-out: The output folder for YAML files (Generator disabled if unspecified). - --yaml-out-file: If specified all types are merged into a single YAML file instead of generating one file per type (relative to --yaml-out). - --yaml-prefix: The prefix to add to type names stored in YAML files (default: "").
- Loading branch information
Showing
10 changed files
with
287 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,181 @@ | ||
| package djinni | ||
|
|
||
| import djinni.ast._ | ||
| import djinni.ast.Record.DerivingType.DerivingType | ||
| import djinni.generatorTools._ | ||
| import djinni.meta._ | ||
| import djinni.writer.IndentWriter | ||
| import java.util.{Map => JMap} | ||
| import scala.collection.JavaConversions._ | ||
| import scala.collection.mutable | ||
|
|
||
| class YamlGenerator(spec: Spec) extends Generator(spec) { | ||
|
|
||
| val cppMarshal = new CppMarshal(spec) | ||
| val objcMarshal = new ObjcMarshal(spec) | ||
| val objcppMarshal = new ObjcppMarshal(spec) | ||
| val javaMarshal = new JavaMarshal(spec) | ||
| val jniMarshal = new JNIMarshal(spec) | ||
|
|
||
| case class QuotedString(str: String) // For anything that migt require escaping | ||
|
|
||
| private def writeYamlFile(name: String, origin: String, f: IndentWriter => Unit): Unit = { | ||
| createFile(spec.yamlOutFolder.get, name, out => new IndentWriter(out, " "), w => { | ||
| w.wl("# AUTOGENERATED FILE - DO NOT MODIFY!") | ||
| w.wl("# This file generated by Djinni from " + origin) | ||
| f(w) | ||
| }) | ||
| } | ||
|
|
||
| private def writeYamlFile(tds: Seq[InternTypeDecl]): Unit = { | ||
| val origins = tds.map(_.origin).distinct.sorted.mkString(", ") | ||
| writeYamlFile(spec.yamlOutFile.get, origins, w => { | ||
| // Writing with SnakeYAML creates loads of cluttering and unnecessary tags, so write manually. | ||
| // We're not doing anything complicated anyway and it's good to have human readable output. | ||
| for(td <- tds) { | ||
| w.wl("---") | ||
| write(w, td) | ||
| } | ||
| }) | ||
| } | ||
|
|
||
| private def writeYamlFile(ident: String, origin: String, td: InternTypeDecl): Unit = | ||
| writeYamlFile(spec.yamlPrefix + ident + ".yaml", origin, w => { | ||
| write(w, td) | ||
| }) | ||
|
|
||
| private def write(w: IndentWriter, td: TypeDecl) { | ||
| write(w, preamble(td)) | ||
| w.wl("cpp:").nested { write(w, cpp(td)) } | ||
| w.wl("objc:").nested { write(w, objc(td)) } | ||
| w.wl("objcpp:").nested { write(w, objcpp(td)) } | ||
| w.wl("java:").nested { write(w, java(td)) } | ||
| w.wl("jni:").nested { write(w, jni(td)) } | ||
| } | ||
|
|
||
| private def write(w: IndentWriter, m: Map[String, Any]) { | ||
| for((k, v) <- m) { | ||
| w.w(k + ": ") | ||
| v match { | ||
| case s: String => write(w, s) | ||
| case s: QuotedString => write(w, s) | ||
| case m: Map[_, _] => w.wl.nested { write(w, m.asInstanceOf[Map[String, Any]]) } | ||
| case s: Seq[_] => write(w, s) | ||
| case b: Boolean => write(w, b) | ||
| case _ => throw new AssertionError("unexpected map value") | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private def write(w: IndentWriter, s: Seq[Any]) { | ||
| // The only arrays we have are small enough to use flow notation | ||
| w.wl(s.mkString("[", ",", "]")) | ||
| } | ||
|
|
||
| private def write(w: IndentWriter, b: Boolean) { | ||
| w.wl(if(b) "true" else "false") | ||
| } | ||
|
|
||
| private def write(w: IndentWriter, s: String) { | ||
| if(s.isEmpty) w.wl(q("")) else w.wl(s) | ||
| } | ||
|
|
||
| private def write(w: IndentWriter, s: QuotedString) { | ||
| if(s.str.isEmpty) w.wl(q("")) else w.wl("'" + s.str.replaceAllLiterally("'", "''") + "'") | ||
| } | ||
|
|
||
| private def preamble(td: TypeDecl) = Map[String, Any]( | ||
| "name" -> (spec.yamlPrefix + td.ident.name), | ||
| "typedef" -> QuotedString(typeDef(td)), | ||
| "params" -> td.params.collect { case p: TypeParam => p.ident.name }, | ||
| "prefix" -> spec.yamlPrefix | ||
| ) | ||
|
|
||
| private def typeDef(td: TypeDecl) = { | ||
| def ext(e: Ext): String = (if(e.cpp) " +c" else "") + (if(e.objc) " +o" else "") + (if(e.java) " +j" else "") | ||
| def deriving(r: Record) = { | ||
| if(r.derivingTypes.isEmpty) { | ||
| "" | ||
| } else { | ||
| r.derivingTypes.collect { | ||
| case Record.DerivingType.Eq => "eq" | ||
| case Record.DerivingType.Ord => "ord" | ||
| }.mkString(" deriving(", ", ", ")") | ||
| } | ||
| } | ||
| td.body match { | ||
| case i: Interface => "interface" + ext(i.ext) | ||
| case r: Record => "record" + ext(r.ext) + deriving(r) | ||
| case e: Enum => "enum" | ||
| } | ||
| } | ||
|
|
||
| private def cpp(td: TypeDecl) = Map[String, Any]( | ||
| "typename" -> QuotedString(cppMarshal.fqTypename(td.ident, td.body)), | ||
| "header" -> QuotedString(cppMarshal.include(td.ident)), | ||
| "byValue" -> cppMarshal.byValue(td) | ||
| ) | ||
|
|
||
| private def objc(td: TypeDecl) = Map[String, Any]( | ||
| "typename" -> QuotedString(objcMarshal.fqTypename(td.ident, td.body)), | ||
| "header" -> QuotedString(objcMarshal.include(td.ident)), | ||
| "boxed" -> QuotedString(objcMarshal.boxedTypename(td)), | ||
| "pointer" -> objcMarshal.isPointer(td), | ||
| "hash" -> QuotedString("%s.hash") | ||
| ) | ||
|
|
||
| private def objcpp(td: TypeDecl) = Map[String, Any]( | ||
| "translator" -> QuotedString(objcppMarshal.helperName(mexpr(td))), | ||
| "header" -> QuotedString(objcppMarshal.include(meta(td))) | ||
| ) | ||
|
|
||
| private def java(td: TypeDecl) = Map[String, Any]( | ||
| "typename" -> QuotedString(javaMarshal.fqTypename(td.ident, td.body)), | ||
| "boxed" -> QuotedString(javaMarshal.fqTypename(td.ident, td.body)), | ||
| "reference" -> javaMarshal.isReference(td), | ||
| "generic" -> true, | ||
| "hash" -> QuotedString("%s.hashCode()") | ||
| ) | ||
|
|
||
| private def jni(td: TypeDecl) = Map[String, Any]( | ||
| "translator" -> QuotedString(jniMarshal.helperName(mexpr(td))), | ||
| "header" -> QuotedString(jniMarshal.include(td.ident)), | ||
| "typename" -> jniMarshal.fqParamType(mexpr(td)), | ||
| "typeSignature" -> QuotedString(jniMarshal.fqTypename(td.ident, td.body)) | ||
| ) | ||
|
|
||
| // TODO: there has to be a way to do all this without the MExpr/Meta conversions? | ||
| private def mexpr(td: TypeDecl) = MExpr(meta(td), List()) | ||
|
|
||
| private def meta(td: TypeDecl) = { | ||
| val defType = td.body match { | ||
| case i: Interface => DInterface | ||
| case r: Record => DRecord | ||
| case e: Enum => DEnum | ||
| } | ||
| MDef(td.ident, 0, defType, td.body) | ||
| } | ||
|
|
||
| override def generate(idl: Seq[TypeDecl]) { | ||
| val internOnly = idl.collect { case itd: InternTypeDecl => itd }.sortWith(_.ident.name < _.ident.name) | ||
| if(spec.yamlOutFile.isDefined) { | ||
| writeYamlFile(internOnly) | ||
| } else { | ||
| for(td <- internOnly) { | ||
| writeYamlFile(td.ident, td.origin, td) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| override def generateEnum(origin: String, ident: Ident, doc: Doc, e: Enum) { | ||
| // unused | ||
| } | ||
|
|
||
| override def generateInterface(origin: String, ident: Ident, doc: Doc, typeParams: Seq[TypeParam], i: Interface) { | ||
| // unused | ||
| } | ||
|
|
||
| override def generateRecord(origin: String, ident: Ident, doc: Doc, params: Seq[TypeParam], r: Record) { | ||
| // unused | ||
| } | ||
| } |
Oops, something went wrong.