v0.2.2 Release

Author: kpgalligan

OLDREADME.md

@@ -0,0 +1,80 @@
+## The Problem
+
+When you want to access C-etc code from Kotlin/Native, you point the cinterop process at it. That will create Kotlin code to enable
+calling the native code. That's only one part of the process, though. You *also* need to build and link binaries to implement
+the native calls. Configuring native builds can be complex because of the number of options that need to be correctly configured,
+as well as the need to package and link the complied binaries.
+
+## The Solution
+
+This problem is already kind of solved by Kotlin/Native itself. The platform is based largely on C and C++. There's a [Gradle
+plugin](https://github.com/JetBrains/kotlin/blob/7b73917217de6dc66330593887c44e67a4efb7d3/kotlin-native/build-tools/src/main/kotlin/org/jetbrains/kotlin/bitcode/CompileToBitcodePlugin.kt)
+and set of tasks embedded within Kotlin/Native and the broader Kotlin platform that configures and builds native C-etc code.
+That plugin is not published in an accessible way, unfortunately. CKlib extracts that Clang Gradle plugin to be used externally.
+
+For packaging, the problem is already solved there as well. You can just insert the compiled binary into your klib. CKlib
+is configured to do that for you.
+
+## Status
+
+This plugin hasn't been designed for all use cases. We needed to compile and embed C code with no real external dependencies.
+You may want to build and embed C-etc code for other use cases we haven't considered, and this plugin will almost certainly
+need to be modified for your particular situation. Please start conversations and/or submit PRs if you add anything significant.
+
+## Usage
+
+Add the plugin to your buildscript path:
+
+```kotlin
+buildscript {
+  repositories {
+    mavenCentral() // <- need this
+    google()
+    gradlePluginPortal()
+  }
+  dependencies {
+    classpath("co.touchlab:cklib-gradle-plugin:1.5.31.3") // <- Replace with current version
+  }
+}
+```
+
+Apply the plugin. You will also need to have the Kotlin Multiplatform plugin applied. CKlib depends on it.
+
+```kotlin
+plugins {
+  kotlin("multiplatform")
+  id("co.touchlab.cklib")
+}
+```
+
+To create compilations, add the `cklib` block, set the Kotlin version, and then point at C-etc source.
+
+```kotlin
+cklib {
+  config.kotlinVersion = "1.6.0"  
+  create("somecode") {
+    language = C
+    compilerArgs.addAll(
+      listOf(
+        "-Wno-unused-function"
+      )
+    )
+  }
+}
+```
+
+By default, the C-etc code is built and packaged in compatible Kotlin/Native klibs. You can specify source folders and
+you will likely need to add some compiler args. Anything more custom will probably require tweaking the plugin itself, as
+it was really designed for a very particular use case.
+
+## We're Hiring!
+
+Touchlab is looking for a Mobile Developer, with Android/Kotlin experience, who is eager to dive into Kotlin Multiplatform Mobile (KMM) development. Come join the remote-first team putting KMM in production. [More info here](https://go.touchlab.co/careers-gh).
+
+## Primary Maintainer
+
+[Kevin Galligan](https://github.com/kpgalligan/)
+
+![Image of Kevin](https://avatars.githubusercontent.com/u/68384?s=140&v=4)
+
+*Ping me on twitter [@kpgalligan](https://twitter.com/kpgalligan/) if you don't get a timely reply!* -Kevin

README.md

@@ -2,86 +2,13 @@
 
 CKlib is a gradle plugin that will build and package C/C++/Objective-C code for Kotlin/Native.
 
-## The Problem
+# Note
 
-When you want to access C-etc code from Kotlin/Native, you point the cinterop process at it. That will create Kotlin code to enable
-calling the native code. That's only one part of the process, though. You *also* need to build and link binaries to implement 
-the native calls. Configuring native builds can be complex because of the number of options that need to be correctly configured,
-as well as the need to package and link the complied binaries.
+The main Kotlin project has changed how locally embedded C-like code is included in libraries, so we'll probably remove
+this project from public access soon until we land on a complete answer to handling this (our current solution is kind 
+of a copy/paste of the main Kotlin solution).
 
-## The Solution
-
-This problem is already kind of solved by Kotlin/Native itself. The platform is based largely on C and C++. There's a [Gradle
-plugin](https://github.com/JetBrains/kotlin/blob/7b73917217de6dc66330593887c44e67a4efb7d3/kotlin-native/build-tools/src/main/kotlin/org/jetbrains/kotlin/bitcode/CompileToBitcodePlugin.kt)
-and set of tasks embedded within Kotlin/Native and the broader Kotlin platform that configures and builds native C-etc code.
-That plugin is not published in an accessible way, unfortunately. CKlib extracts that Clang Gradle plugin to be used externally.
-
-For packaging, the problem is already solved there as well. You can just insert the compiled binary into your klib. CKlib 
-is configured to do that for you.
-
-## Status
-
-This plugin hasn't been designed for all use cases. We needed to compile and embed C code with no real external dependencies. 
-You may want to build and embed C-etc code for other use cases we haven't considered, and this plugin will almost certainly
-need to be modified for your particular situation. Please start conversations and/or submit PRs if you add anything significant.
-
-## Usage
-
-Add the plugin to your buildscript path:
-
-```kotlin
-buildscript {
-  repositories {
-    mavenCentral() // <- need this
-    google()
-    gradlePluginPortal()
-  }
-  dependencies {
-    classpath("co.touchlab:cklib-gradle-plugin:1.5.31.3") // <- Replace with current version
-  }
-}
-```
-
-Apply the plugin. You will also need to have the Kotlin Multiplatform plugin applied. CKlib depends on it.
-
-```kotlin
-plugins {
-  kotlin("multiplatform")
-  id("co.touchlab.cklib")
-}
-```
-
-To create compilations, add the `cklib` block, set the Kotlin version, and then point at C-etc source.
-
-```kotlin
-cklib {
-  config.kotlinVersion = "1.6.0"  
-  create("somecode") {
-    language = C
-    compilerArgs.addAll(
-      listOf(
-        "-Wno-unused-function"
-      )
-    )
-  }
-}
-```
-
-By default, the C-etc code is built and packaged in compatible Kotlin/Native klibs. You can specify source folders and 
-you will likely need to add some compiler args. Anything more custom will probably require tweaking the plugin itself, as 
-it was really designed for a very particular use case.
-
-## We're Hiring!
-
-Touchlab is looking for a Mobile Developer, with Android/Kotlin experience, who is eager to dive into Kotlin Multiplatform Mobile (KMM) development. Come join the remote-first team putting KMM in production. [More info here](https://go.touchlab.co/careers-gh).
-
-## Primary Maintainer
-
-[Kevin Galligan](https://github.com/kpgalligan/)
-
-![Image of Kevin](https://avatars.githubusercontent.com/u/68384?s=140&v=4)
-
-*Ping me on twitter [@kpgalligan](https://twitter.com/kpgalligan/) if you don't get a timely reply!* -Kevin
+You can use this, but we won't be supporting it publicly as it's kind of brittle to set up and debug. Just FYI.
 
 License
 =======

gradle.properties

@@ -15,7 +15,7 @@ org.gradle.jvmargs=-Xmx2g
 
 GROUP=co.touchlab
 KOTLIN_VERSION=1.6.0
-CKLIB_VERSION=0.2.1
+CKLIB_VERSION=0.2.2
 
 POM_NAME=CKlib
 POM_DESCRIPTION=C/C++ Bitcode Into Klib

plugin/src/main/kotlin/co/touchlab/cklib/gradle/CKlibGradleExtension.kt

@@ -21,7 +21,6 @@ import javax.inject.Inject
 open class CKlibGradleExtension @Inject constructor(val project: Project) {
     private var _konanHome: String? = null
     private var _llvmHome: String? = null
-    private var _llvmDir: String? = null
 
     var kotlinVersion: String? = null
     var arch: String = hostArch
@@ -40,16 +39,10 @@ open class CKlibGradleExtension @Inject constructor(val project: Project) {
         }
 
     var llvmHome: String
-        get() = _llvmHome ?: "${System.getProperty("user.home")}/.konan/dependencies/${llvmDir}"
+        get() = _llvmHome ?: "${System.getProperty("user.home")}/.cklib/clang-llvm-apple-8.0.0-darwin-macos"
         set(value) {
             _llvmHome = value
         }
-
-    var llvmDir: String
-        get() = _llvmDir ?: llvmName
-        set(value) {
-            _llvmDir = value
-        }
 }
 
 internal val Project.platformManager: PlatformManager

plugin/src/main/kotlin/co/touchlab/cklib/gradle/CompileToBitcodePlugin.kt

@@ -24,7 +24,7 @@ import java.util.*
 class CompileToBitcodePlugin : Plugin<Project> {
     override fun apply(target: Project) = with(target) {
         extensions.create(EXTENSION_NAME, CompileToBitcodeExtension::class.java, target)
-        downloadIfNeeded()
+        downloadIfNeeded(target)
 
         target.pluginManager.withPlugin("org.jetbrains.kotlin.multiplatform"){ appliedPlugin ->
             extensions.getByType(KotlinMultiplatformExtension::class.java)
@@ -42,28 +42,34 @@ class CompileToBitcodePlugin : Plugin<Project> {
         }*/
     }
 
-    private fun downloadIfNeeded() {
+    //This is pretty hacky, but the process changed in 1.6.0. We'll probably just split off and do our own thing
+    //going forward, but need to be able to build for the next few weeks.
+    private fun downloadIfNeeded(target: Project) {
         val cklibDir = File("${System.getProperty("user.home")}/.cklib")
         val localFile = File(cklibDir, "clang-llvm-apple-8.0.0-darwin-macos")
         val clangExists = localFile.exists()
         if(!clangExists){
+            target.logger.info("cklib downloading dependencies (may take a while...)")
             cklibDir.mkdirs()
             val tempFileName = UUID.randomUUID().toString()
-            val tempDl = File(cklibDir, "${tempFileName}.tar.gz")
+            val extractDir = File(cklibDir, tempFileName)
+            val tempDl = File(cklibDir, "${tempFileName}.zip")
+
             try {
                 val fos = FileOutputStream(tempDl)
-                val inp = BufferedInputStream(URL("https://touchlab-deps-public.s3.us-east-2.amazonaws.com/clang-llvm-apple-8.0.0-darwin-macos.tar.gz").openStream())
+                val inp = BufferedInputStream(URL("https://touchlab-deps-public.s3.us-east-2.amazonaws.com/clang-llvm-apple-8.0.0-darwin-macos.zip").openStream())
                 inp.copyTo(fos)
                 fos.close()
                 inp.close()
 
-                val archiver = ArchiverFactory.createArchiver(ArchiveFormat.TAR)
+                val archiver = ArchiverFactory.createArchiver(ArchiveFormat.ZIP)
 
-                val extractDir = File(cklibDir, tempFileName)
                 archiver.extract(tempDl, extractDir)
-                extractDir.renameTo(localFile)
+                val extractChild = File(extractDir, "clang-llvm-apple-8.0.0-darwin-macos")
+                extractChild.renameTo(localFile)
             } finally {
                 tempDl.delete()
+                extractDir.delete()
             }
         }
     }