Use the builder from the tools project in the sbt plugin

In order to ensure that the sbt plugin supports all options use the same
builder in the tools and sbt plugin projects. Separate out the options
into a new BindingOptions class to not expose unneeded methods in the
sbt plugin.

Author: jonas

docs/src/paradox/obtaining-bindgen/sbt-plugin.md

@@ -11,13 +11,7 @@ resolvers += Resolver.bintrayRepo("scala-native-bindgen", "maven")
 ```
 @@@
 
-Next configure the plugin using the settings scoped to either `Compile` or `Test`:
-
-|---------------------------|-------------------|
-|`nativeBindgenHeader`      | The C header file to read.
-|`nativeBindgenPackage`     | Package of the enclosing object. No package by default.
-|`name in nativeBindgen`    | Name of the enclosing object.
-|`nativeBindgenLink`        | Name of library to be linked.
+Next configure the plugin using the `nativeBindings` setting scoped to either `Compile` or `Test`. The `NativeBinding` type to configure each binding that should be generated. 
 
 @@@ note
 
@@ -37,15 +31,17 @@ Example settings:
 enablePlugins(ScalaNativeBindgenPlugin)
 inConfig(Compile)(
   Def.settings(
-    nativeBindgenHeader := (resourceDirectory in Compile).value / "header.h",
-    nativeBindgenPackage := Some("org.example.mylib"),
-    nativeBindgenLink := Some("mylib"), // Will pass `-lmylib` to the linker
-    nativeBindgenExclude := Some("__"),
-    name in nativeBindgen := "MyLib"
+    nativeBindings += {
+      NativeBinding((resourceDirectory in Compile).value / "header.h")
+        .name("MyLib")
+        .packageName("org.example.mylib")
+        .link("mylib"), // Will pass `-lmylib` to the linker
+        .excludePrefix("__")
+      }
   ))
 ```
 
-Running `nativeBindgen` will generate a file named `target/scala-2.x/src_managed/main/sbt-scala-native-bindgen//ScalaNativeBindgen.scala` containing something along the following lines:
+Running `nativeBindgen` will generate a file named `target/scala-2.x/src_managed/main/sbt-scala-native-bindgen/MyLib.scala` containing something along the following lines:
 
 ```scala
 package org.example.mylib
@@ -58,4 +54,4 @@ import scala.scalanative.native._
 object MyLib {
   // ... left out for brevity ...
 }
-```
+```

sbt-scala-native-bindgen/src/main/scala/org/scalanative/bindgen/sbt/ScalaNativeBindgenPlugin.scala

@@ -6,7 +6,7 @@ import sbt.Keys._
 import java.nio.file.Files
 import java.nio.file.attribute.{PosixFileAttributeView, PosixFilePermission}
 
-import org.scalanative.bindgen.Bindgen
+import org.scalanative.bindgen.{Bindgen, BindingOptions}
 
 /**
  * Generate Scala bindings from C headers.
@@ -37,21 +37,20 @@ import org.scalanative.bindgen.Bindgen
  *
  * @example
  * {{{
- * nativeBindgenHeader in Compile := file("/usr/include/ctype.h")
- * nativeBindgenPackage in Compile := Some("org.example.app")
- * name in (Compile, nativeBindgen) := "ctype"
+ * nativeBindings += {
+ *   NativeBinding(file("/usr/include/uv.h"))
+ *     .name("uv")
+ *     .packageName("org.example.uv")
+ *     .link("uv"),
+ *     .excludePrefix("__")
+ * }
  * }}}
  */
 object ScalaNativeBindgenPlugin extends AutoPlugin {
 
   object autoImport {
-    case class NativeBinding(
-        name: String,
-        header: File,
-        packageName: Option[String],
-        link: Option[String],
-        excludePrefix: Option[String]
-    )
+    type NativeBinding = BindingOptions
+    val NativeBinding      = BindingOptions
     val ScalaNativeBindgen = config("scala-native-bindgen").hide
     val nativeBindgenPath =
       taskKey[File]("Path to the scala-native-bindgen executable")
@@ -105,14 +104,6 @@ object ScalaNativeBindgenPlugin extends AutoPlugin {
         }
       )
 
-  private implicit class BindgenOps(val bindgen: Bindgen) extends AnyVal {
-    def maybe[T](opt: Option[T], f: Bindgen => T => Bindgen): Bindgen =
-      opt match {
-        case None        => bindgen
-        case Some(value) => f(bindgen)(value)
-      }
-  }
-
   private val artifactName =
     Option(System.getProperty("os.name")).collect {
       case "Mac OS X" => "scala-native-bindgen-darwin"
@@ -126,34 +117,26 @@ object ScalaNativeBindgenPlugin extends AutoPlugin {
         sourceGenerators += Def.task { nativeBindgen.value },
         target in nativeBindgen := sourceManaged.value / "sbt-scala-native-bindgen",
         nativeBindgen := {
-          val bindgenPath     = nativeBindgenPath.value
-          val bindings        = nativeBindings.value
+          val bindgen         = Bindgen(nativeBindgenPath.value)
+          val optionsList     = nativeBindings.value
           val outputDirectory = (target in nativeBindgen).value
           val logger          = streams.value.log
 
-          bindings.map {
-            binding =>
-              val output = outputDirectory / s"${binding.name}.scala"
-              val result = Bindgen()
-                .bindgenExecutable(bindgenPath)
-                .header(binding.header)
-                .name(binding.name)
-                .maybe(binding.link, _.link)
-                .maybe(binding.packageName, _.packageName)
-                .maybe(binding.excludePrefix, _.excludePrefix)
-                .generate()
+          // FIXME: Check uniqueness of names.
 
-              result match {
+          optionsList.map {
+            case options: BindingOptions.Impl =>
+              bindgen.generate(options) match {
                 case Right(bindings) =>
+                  val output = outputDirectory / s"${bindings.name}.scala"
                   bindings.writeToFile(output)
                   bindings.errors.foreach(error => logger.error(error))
+                  output
                 case Left(errors) =>
                   errors.foreach(error => logger.error(error))
                   sys.error(
                     "scala-native-bindgen failed with non-zero exit code")
               }
-
-              output
           }
         }
       ))

sbt-scala-native-bindgen/src/sbt-test/bindgen/generate/build.sbt

@@ -6,15 +6,12 @@ scalaVersion := "2.11.12"
 inConfig(Compile)(
   Def.settings(
     nativeBindgenPath := file(System.getProperty("bindgen.path")),
-    nativeBindings := Seq(
-      NativeBinding(
-        name = "stdlib",
-        header = (resourceDirectory in Compile).value / "stdlib.h",
-        packageName = Some("org.example.app.stdlib"),
-        link = None,
-        excludePrefix = Some("__")
-      )
-    )
+    nativeBindings += {
+      NativeBinding((resourceDirectory in Compile).value / "stdlib.h")
+        .name("stdlib")
+        .packageName("org.example.app.stdlib")
+        .excludePrefix("__")
+    }
   ))
 
 val nativeBindgenCustomTarget = SettingKey[File]("nativeBindgenCustomTarget")
@@ -23,13 +20,9 @@ nativeBindgenCustomTarget := baseDirectory.value / "src/main/scala/org/example"
 val nativeBindgenCoreBinding =
   SettingKey[NativeBinding]("nativeBindgenCoreBinding")
 nativeBindgenCoreBinding := {
-  NativeBinding(
-    name = "core",
-    header = (resourceDirectory in Compile).value / "core.h",
-    packageName = Some("org.example.app.core"),
-    link = Some("core"),
-    excludePrefix = None
-  )
+  NativeBinding((resourceDirectory in Compile).value / "core.h")
+    .packageName("org.example.app.core")
+    .link("core")
 }
 
 val StdlibOutput =
@@ -47,14 +40,14 @@ val StdlibOutput =
   """.stripMargin
 
 def assertFileContent(file: File, expected: String): Unit = {
-  val actual = IO.read(file).trim
+  val actual = IO.read(file).trim()
   if (actual != expected.trim) {
     println(s"== [ actual ${file.getName} ] ========")
     println(actual)
     println(s"== [ expected ${file.getName} ] ========")
-    println(expected.trim)
+    println(expected.trim())
   }
-  assert(actual == expected.trim)
+  assert(actual == expected.trim())
 }
 
 TaskKey[Unit]("checkSingle") := {

tests/src/test/scala/org/scalanative/bindgen/BindgenReportingSpec.scala

@@ -7,7 +7,7 @@ import org.scalatest.FunSpec
 class BindgenReportingSpec extends FunSpec {
   describe("Bindgen") {
 
-    val bindgenPath = System.getProperty("bindgen.path")
+    val bindgen = Bindgen(new File(System.getProperty("bindgen.path")))
 
     def writeToFile(file: File, input: String): Unit = {
       new PrintWriter(file) {
@@ -24,16 +24,13 @@ class BindgenReportingSpec extends FunSpec {
       try {
         writeToFile(tempFile, input)
 
-        val result = Bindgen()
-          .bindgenExecutable(new File(bindgenPath))
-          .header(tempFile)
+        val options = BindingOptions(tempFile)
           .name("BindgenTests")
           .link("bindgentests")
           .packageName("org.scalanative.bindgen.samples")
           .excludePrefix("__")
-          .generate()
 
-        result match {
+        bindgen.generate(options) match {
           case Right(binding) =>
             assert(binding.errors == errors)
           case Left(errors) =>

tests/src/test/scala/org/scalanative/bindgen/BindgenSpec.scala

@@ -6,33 +6,15 @@ import scala.io.Source
 
 class BindgenSpec extends FunSpec {
   describe("Bindgen") {
-    val bindgenPath    = System.getProperty("bindgen.path")
+    val bindgen        = Bindgen(new File(System.getProperty("bindgen.path")))
     val inputDirectory = new File("samples")
 
     val outputDir = new File("target/bindgen-samples")
     Option(outputDir.listFiles()).foreach(_.foreach(_.delete()))
     outputDir.mkdirs()
 
-    it("should exist") {
-      assert(new File(bindgenPath).exists, s"$bindgenPath does not exist")
-    }
-
-    def bindgen(inputFile: File, name: String, outputFile: File): Unit = {
-      val result = Bindgen()
-        .bindgenExecutable(new File(bindgenPath))
-        .header(inputFile)
-        .name(name)
-        .link("bindgentests")
-        .packageName("org.scalanative.bindgen.samples")
-        .excludePrefix("__")
-        .generate()
-
-      result match {
-        case Right(binding) =>
-          binding.writeToFile(outputFile)
-        case Left(errors) =>
-          fail("scala-native-bindgen failed: " + errors.mkString("\n"))
-      }
+    it("executable should exist") {
+      assert(bindgen.executable.exists, s"${bindgen.executable} does not exist")
     }
 
     def contentOf(file: File) =
@@ -42,12 +24,18 @@ class BindgenSpec extends FunSpec {
       it(s"should generate bindings for ${input.getName}") {
         val testName = input.getName.replace(".h", "")
         val expected = new File(inputDirectory, testName + ".scala")
-        val output   = new File(outputDir, testName + ".scala")
-
-        bindgen(input, testName, output)
-
-        assert(output.exists())
-        assert(contentOf(output) == contentOf(expected))
+        val options = BindingOptions(input)
+          .name(testName)
+          .link("bindgentests")
+          .packageName("org.scalanative.bindgen.samples")
+          .excludePrefix("__")
+
+        bindgen.generate(options) match {
+          case Right(binding) =>
+            assert(binding.source.trim() == contentOf(expected))
+          case Left(errors) =>
+            fail("scala-native-bindgen failed: " + errors.mkString("\n"))
+        }
       }
     }
   }