Fix #173: Reorganize bindings (#188)

- Move the bindings to the org.scala-native.bindings organization.
- Move binding modules under org.scalanative.bindings dropping the
  per-binding package if only one module is emitted.
- Drop the "lib" prefix from the binding artifact name.

Author: jonas

bindings/iconv/src/main/scala/org/scalanative/bindgen/bindings/iconv/iconv.scala renamed to bindings/iconv/src/main/scala/org/scalanative/bindings/iconv.scala

@@ -1,4 +1,4 @@
-package org.scalanative.bindgen.bindings.iconv
+package org.scalanative.bindings
 
 import scala.scalanative._
 import scala.scalanative.native._

bindings/iconv/src/test/scala/org/scalanative/bindgen/bindings/tests/IconvSpec.scala renamed to bindings/iconv/src/test/scala/org/scalanative/bindings/tests/IconvSpec.scala

@@ -1,12 +1,12 @@
-package org.scalanative.bindgen.bindings.iconv.tests
+package org.scalanative.bindings.tests
 
 import org.scalatest.FunSpec
 
 class IconvSpec extends FunSpec {
   describe("iconv") {
     it("should convert back and forth between UTF-8 and ISO-8859-1") {
       //#usage-example
-      import org.scalanative.bindgen.bindings.iconv.iconv._
+      import org.scalanative.bindings.iconv._
       import scala.scalanative.native._
       import java.nio.charset.Charset
 

bindings/posix/src/main/scala/org/scalanative/bindgen/bindings/posix/fnmatch.scala renamed to bindings/posix/src/main/scala/org/scalanative/bindings/posix/fnmatch.scala

@@ -1,4 +1,4 @@
-package org.scalanative.bindgen.bindings.posix
+package org.scalanative.bindings.posix
 
 import scala.scalanative._
 import scala.scalanative.native._

bindings/posix/src/main/scala/org/scalanative/bindgen/bindings/posix/regex.scala renamed to bindings/posix/src/main/scala/org/scalanative/bindings/posix/regex.scala

@@ -1,4 +1,4 @@
-package org.scalanative.bindgen.bindings.posix
+package org.scalanative.bindings.posix
 
 import scala.scalanative._
 import scala.scalanative.native._

bindings/posix/src/test/scala/org/scalanative/bindgen/bindings/tests/FnmatchSpec.scala renamed to bindings/posix/src/test/scala/org/scalanative/bindings/tests/FnmatchSpec.scala

@@ -1,4 +1,4 @@
-package org.scalanative.bindgen.bindings.tests
+package org.scalanative.bindings.tests
 
 import org.scalatest.FunSpec
 
@@ -7,7 +7,7 @@ class FnmatchSpec extends FunSpec {
     it("should match patterns") {
       //#usage-example
       import scala.scalanative.native._
-      import org.scalanative.bindgen.bindings.posix.fnmatch._
+      import org.scalanative.bindings.posix.fnmatch._
 
       assert(fnmatch(c"*.md", c"README.md", 0) == 0)
       assert(fnmatch(c"*.[ch]", c"main.h", 0) == 0)

bindings/posix/src/test/scala/org/scalanative/bindgen/bindings/tests/RegexSpec.scala renamed to bindings/posix/src/test/scala/org/scalanative/bindings/tests/RegexSpec.scala

@@ -1,4 +1,4 @@
-package org.scalanative.bindgen.bindings.tests
+package org.scalanative.bindings.tests
 
 import org.scalatest.FunSpec
 
@@ -7,7 +7,7 @@ class RegexSpec extends FunSpec {
     it("should match regular expressions") {
       //#usage-example
       import scala.scalanative.native._
-      import org.scalanative.bindgen.bindings.posix.regex._
+      import org.scalanative.bindings.posix.regex._
 
       val reg = stackalloc[regex_t]
 

bindings/utf8proc/src/main/scala/org/scalanative/bindgen/bindings/utf8proc/utf8proc.scala renamed to bindings/utf8proc/src/main/scala/org/scalanative/bindings/utf8proc.scala

@@ -1,4 +1,4 @@
-package org.scalanative.bindgen.bindings.utf8proc
+package org.scalanative.bindings
 
 import scala.scalanative._
 import scala.scalanative.native._

bindings/utf8proc/src/test/scala/org/scalanative/bindgen/bindings/tests/Utf8procSpec.scala renamed to bindings/utf8proc/src/test/scala/org/scalanative/bindings/tests/Utf8procSpec.scala

@@ -1,12 +1,12 @@
-package org.scalanative.bindgen.bindings.tests
+package org.scalanative.bindings.tests
 
 import org.scalatest.FunSpec
 
 class Utf8procSpec extends FunSpec {
   describe("utf8proc") {
     it("should iterate UTF-8 and count character width") {
       //#usage-example
-      import org.scalanative.bindgen.bindings.utf8proc.utf8proc._
+      import org.scalanative.bindings.utf8proc._
       import scala.scalanative.native._
 
       val text    = c"Spørge"
@@ -32,7 +32,7 @@ class Utf8procSpec extends FunSpec {
     }
 
     it("utf8proc_tolower") {
-      import org.scalanative.bindgen.bindings.utf8proc.utf8proc._
+      import org.scalanative.bindings.utf8proc._
 
       val `Ø`  = 0x00D8
       val `ø`  = 0x00F8

build.sbt

@@ -212,8 +212,7 @@ lazy val bindings = project("bindings")
     libutf8proc
   )
 
-lazy val libiconv = bindingProject("iconv")
-  .configure(binding("iconv.h"))
+lazy val libiconv = bindingProject("iconv")("iconv.h")
   .settings(
     //#sbt-iconv-linking-options
     Compile / nativeLinkingOptions ++= {
@@ -230,14 +229,15 @@ lazy val libiconv = bindingProject("iconv")
   )
 
 //#sbt-binding-project-multi-header
-lazy val libposix = bindingProject("posix")
-  .configure(binding("fnmatch.h"))
-  .configure(binding("regex.h"))
+lazy val libposix = bindingProject("posix")(
+  "fnmatch.h",
+  "regex.h"
+)
 //#sbt-binding-project-multi-header
 
 //#sbt-binding-project
-lazy val libutf8proc = bindingProject("utf8proc")
-  .configure(binding("utf8proc.h", Some("utf8proc")))
+lazy val libutf8proc =
+  bindingProject("utf8proc", Some("utf8proc"))("utf8proc.h")
 //#sbt-binding-project
 
 def project(name: String, plugged: AutoPlugin*) = {
@@ -333,45 +333,51 @@ lazy val bindingsExtraArgs = Try {
   s"-I$libDir/clang/$version/include"
 }.toOption
 
-def bindingProject(name: String) = {
+def bindingProject(name: String, link: Option[String] = None)(
+    headers: String*) = {
+  val packagePath = Seq("org", "scalanative", "bindings") ++
+    (if (headers.length > 1) Seq(name) else Seq.empty)
+
   nativeProject(s"lib$name")
     .enablePlugins(ScalaNativeBindgenPlugin)
     .in(file(s"bindings/$name"))
     .settings(
+      Keys.name := name,
       libraryDependencies += "org.scalatest" %%% "scalatest" % "3.2.0-SNAP10" % Test,
-      Compile / nativeBindgen / target :=
-        (Compile / scalaSource).value / "org/scalanative/bindgen/bindings" / name
+      Compile / nativeBindgen / target := {
+        packagePath.foldLeft((Compile / scalaSource).value)(_ / _)
+      }
     )
+    .settings(
+      headers.flatMap(binding(name, packagePath.mkString("."), link)): _*)
 }
 
-def binding(header: String, link: Option[String] = None)(
-    project: Project): Project = {
-  val headerFile = file("/usr/include") / header
-  val libname    = project.base.getName
-  project.settings(
-    inConfig(Compile)(
+def binding(name: String, packageName: String, link: Option[String])(
+    header: String): Seq[Setting[_]] = {
+  val includeDirs = Seq("/usr/include", "/usr/local/include")
+  val headerFiles = includeDirs.map(dir => file(dir) / header).filter(_.exists)
+
+  headerFiles.headOption match {
+    case Some(headerFile) =>
       Def.settings(
-        nativeBindings ++= {
-          if (headerFile.exists) Seq {
-            NativeBinding(headerFile)
-              .name(header.replace(".h", ""))
-              .packageName(s"org.scalanative.bindgen.bindings.$libname")
-              .maybe(link, _.link)
-              .excludePrefix("__")
-              .extraArgs(bindingsExtraArgs.toSeq: _*)
-              .extraArgs("-D_POSIX_C_SOURCE")
-          } else {
-            Seq.empty
-          }
+        organization := "org.scala-native.binding",
+        Compile / nativeBindings += {
+          NativeBinding(headerFile)
+            .name(link.map(_ => name).getOrElse(header.replace(".h", "")))
+            .packageName(packageName)
+            .maybe(link, _.link)
+            .excludePrefix("__")
+            .extraArgs(bindingsExtraArgs.toSeq: _*)
+            .extraArgs("-D_POSIX_C_SOURCE")
         }
-      )),
-    test := (Def.taskDyn {
-      if (headerFile.exists)
-        Def.task { (Test / test).value } else
-        Def.task {
-          streams.value.log.warn(
-            s"Skipping $libname tests due to missing header file $headerFile")
+      )
+
+    case None =>
+      Def.settings(
+        test := {
+          streams.value.log
+            .warn(s"Skipping $name tests due to missing header file <$header>")
         }
-    }).value
-  )
+      )
+  }
 }

docs/src/paradox/bindings/iconv.md

@@ -13,6 +13,6 @@ For sbt, you can use the following code:
 
 ## Example
 
-@@snip [iconv](../../../../bindings/iconv/src/test/scala/org/scalanative/bindgen/bindings/tests/IconvSpec.scala) { #usage-example }
+@@snip [iconv](../../../../bindings/iconv/src/test/scala/org/scalanative/bindings/tests/IconvSpec.scala) { #usage-example }
 
  [`iconv.h`]: http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/iconv.h.html