azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[readme] Improve gradle-plugin readme

Browse Source 
* Describe framework and dynamic library building
    * Describe setting custom targets for an artifact
This commit is contained in:
Ilya Matveev
2018-01-22 20:36:35 +07:00
committed by ilmat192
parent 618c53956f
commit d9a07c6b61
2 changed files with 97 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files
FAQ.md
+1 -1
View File
@@ -14,7 +14,7 @@ garbage.
Q: How do I create shared library? Q: How do I create shared library?
A: Use `-produce dynamic` compiler switch, or `konanArtifacts { dynamic {} }` in Gradle. A: Use `-produce dynamic` compiler switch, or `konanArtifacts { dynamic('foo') {} }` in Gradle.
It will produce platform-specific shared object (.so on Linux, .dylib on macOS and .dll on Windows targets) and It will produce platform-specific shared object (.so on Linux, .dylib on macOS and .dll on Windows targets) and
C language header, allowing to use all public APIs available in your Kotlin/Native program from C code. C language header, allowing to use all public APIs available in your Kotlin/Native program from C code.
See `samples/python_extension` as an example of using such shared object to provide a bridge between Python and See `samples/python_extension` as an example of using such shared object to provide a bridge between Python and
GRADLE_PLUGIN.md
+96 -26
View File
@@ -39,8 +39,10 @@ In this case the compiler will not be downloaded by the plugin.
The Kotlin/Native Gradle plugin allows one to build artifacts of the following types: The Kotlin/Native Gradle plugin allows one to build artifacts of the following types:
* Executable * Executable
* Library * KLibrary - a library used by Kotlin/Native compiler (`*.klib`)
* Interoperability library - a special type of library providing an interoperability with some native API. See [`INTEROP.md`](INTEROP.md) for details * Interoperability library - a special type of library providing an interoperability with some native API. See [`INTEROP.md`](INTEROP.md) for details
* Dynamic library (`*.so`/`*.dylib`/`*.dll`)
* Objective-C framework
* LLVM bitcode * LLVM bitcode
All Kotlin/Native artifacts should be declared in the `konanArtifacts` block. Note that the `konanInterop` script block was removed in All Kotlin/Native artifacts should be declared in the `konanArtifacts` block. Note that the `konanInterop` script block was removed in
@@ -51,6 +53,8 @@ v0.3.4. Use the `interop` method of the `konanArtifact` block instead:
library('bar') // library 'bar' library('bar') // library 'bar'
bitcode('baz') // bitcode file 'baz' bitcode('baz') // bitcode file 'baz'
interop('qux') // interoperability library 'qux'. Use it instead of konanInterop block. interop('qux') // interoperability library 'qux'. Use it instead of konanInterop block.
dynamic('quux') // dynamic library
framework ('quuux') // Objective-C framework
} }
All artifacts except interop libraries are built by the Kotlin/Native compiler. Such an artifact may be configured using its script block. All artifacts except interop libraries are built by the Kotlin/Native compiler. Such an artifact may be configured using its script block.
@@ -103,10 +107,28 @@ an interoperability library:
## Building for different targets ## Building for different targets
All the artifacts declared in a project may be built for different targets. By default they are built only for `host` target i.e. a All the artifacts declared in a project may be built for different targets. By default they are built only for `host` target i.e. a
computer used for building. One may change the target list using the `konan.targets` project extension: computer used for building. One may change the default target list using the `konan.targets` project extension:
konan.targets = [ 'linux', 'android_arm64', 'android_arm32' ] konan.targets = [ 'linux', 'android_arm64', 'android_arm32' ]
One may specify a custom target set for each particular artifact using `targets` parameter of an artifact declaration:
konan.targets = [ 'linux', 'android_arm64' ]
konanArtifacts {
// This artifact has no custom targets and will be built
// for all the default ones: 'linux', 'android_arm64'
program('foo') { /* ... */ }
// This artifact will be built only for Linux and Wasm32
program('bar', targets: ['linux', 'wasm32']) { /* ... */ }
// An Objective-C framework cannot be built for Linux and Wasm32 thus
// these targets will be skipped and the artifact will be built only for iOS
framework('baz', targets: [ 'linux', 'wasm32', 'iphone' ]) { /* ... */ }
}
The plugin creates tasks to compile each artifact for all targets supported by current host and declared in the `konan.targets` list. The plugin creates tasks to compile each artifact for all targets supported by current host and declared in the `konan.targets` list.
One may perform additional configuration for a target using `target` method of an artifact configuration block: One may perform additional configuration for a target using `target` method of an artifact configuration block:
@@ -186,14 +208,14 @@ and set dependencies between building tasks.
* Specify only name of a library. In this case the compiler will look for the library in its repositories. * Specify only name of a library. In this case the compiler will look for the library in its repositories.
``` ```
libraries { libraries {
klib 'foo' klib 'foo'
klibs 'lib1', 'lib2' klibs 'lib1', 'lib2'
// One may specify additional repositories // One may specify additional repositories
// All objects accepted by the Project.file method may be used here // All objects accepted by the Project.file method may be used here
useRepo 'build/libraries' useRepo 'build/libraries'
} }
``` ```
## Tasks ## Tasks
@@ -205,21 +227,22 @@ for each an artifact defined in a `konanArtifacts` block. Such a task may have d
##### Properties available for a compiler task (executable, library or bitcode building task): ##### Properties available for a compiler task (executable, library or bitcode building task):
|Property |Type |Description | |Property |Type |Description |
|---------------------|----------------------------|----------------------------------------------------| |---------------------|----------------------------|----------------------------------------------------------|
|`target `|`String` |Target the artifact is built for. Read only | |`target `|`String` |Target the artifact is built for. Read only |
|`artifactName `|`String` |Base name for the output file (without an extension)| |`artifactName `|`String` |Base name for the output file (without an extension) |
|`destinationDir `|`File` |Directory to place the output artifact | |`destinationDir `|`File` |Directory to place the output artifact |
|`artifact `|`File` |The output artifact. Read only | |`artifact `|`File` |The output artifact. Read only |
|`srcFiles `|`Collection<FileCollection>`|Compiled files | |`headerFile `|`File` |The output C header. Only for dynamic libraries, read only|
|`nativeLibraries `|`Collection<FileCollection>`|*.bc libraries used by the artifact | |`srcFiles `|`Collection<FileCollection>`|Compiled files |
|`linkerOpts `|`List<String>` |Additional options passed to the linker | |`nativeLibraries `|`Collection<FileCollection>`|*.bc libraries used by the artifact |
|`enableDebug `|`boolean` |Is the debugging support enabled | |`linkerOpts `|`List<String>` |Additional options passed to the linker |
|`noStdLib `|`boolean` |Is the artifact not linked with stdlib | |`enableDebug `|`boolean` |Is the debugging support enabled |
|`noMain `|`boolean` |Is the `main` function provided by a library used | |`noStdLib `|`boolean` |Is the artifact not linked with stdlib |
|`enableOptimizations`|`boolean` |Are the optimizations enabled | |`noMain `|`boolean` |Is the `main` function provided by a library used |
|`enableAssertions `|`boolean` |Is the assertion support enabled | |`enableOptimizations`|`boolean` |Are the optimizations enabled |
|`measureTime `|`boolean` |Does the compiler print phase time | |`enableAssertions `|`boolean` |Is the assertion support enabled |
|`measureTime `|`boolean` |Does the compiler print phase time |
##### Properties available for a cinterop task (task building an interoperability library): ##### Properties available for a cinterop task (task building an interoperability library):
@@ -261,6 +284,42 @@ parameters can be passed using the `runArgs` project property:
The plugin also edits the default `build` and `clean` tasks so that the first one allows one to build all the artifacts supported The plugin also edits the default `build` and `clean` tasks so that the first one allows one to build all the artifacts supported
(it's dependent on the `compileKonan` task) and the second one removes the files created by the Kotlin/Native build. (it's dependent on the `compileKonan` task) and the second one removes the files created by the Kotlin/Native build.
## Building dynamic libraries and frameworks
Kotlin/Native supports building artifacts to be used by other native languages. There are two types of such artifacts:
Objective-C framework and dynamic library.
* **Dynamic library.** A dynamic library may be built using the `dynamic` artifact block. This block contains the same
options as other ones (except `interop`) allowing one to specify source files, compiler options and libraries used.
Each task building a dynamic library produces two files: the library itself (a `*.so`/`*.dylib`/`*.dll` file depending
on the target platform) and a C language header. Both of them may be accessed via properties of a building task
(both properties have type `File`):
```
konanArtifacts {
// Build a dynamic library
dynamic('foo') { /* ... */ }
}
konanArtifacts.foo.getByTarget('host').artifact // Points to the library file
konanArtifacts.foo.getByTarget('host').headerFile // Points to the header file
```
Using a dynamic library is shown in the [python extension sample](samples/python_extension).
* **Framework.** An Objective-C framework can be built using the `framework` artifact block. This block contains the
same options as other ones. One may access the framework built using `artifact` property of the building task
(see the [**Tasks**](#Tasks) section). Unlike other artifacts this property points to a directory instead of a regular file.
```
konanArtifacts {
// Build an Objective-C framework
framework('foo') { /* ... */ }
}
konanArtifacts.foo.getByTarget('host').artifact // Points to the framework directory
```
Using a framework is shown in the [calculator sample](samples/calculator).
## Additional options ## Additional options
You can also pass additional command line keys to the compiler or cinterop tool using the `extraOpts` expression You can also pass additional command line keys to the compiler or cinterop tool using the `extraOpts` expression
@@ -294,7 +353,7 @@ tables below.
## Plugin DSL ## Plugin DSL
// Targets to build for. // Default targets to build for.
konan.targets = ['macbook', 'linux', 'wasm32'] konan.targets = ['macbook', 'linux', 'wasm32']
// Language and API version. // Language and API version.
@@ -302,7 +361,8 @@ tables below.
konan.apiVersion = 'version' konan.apiVersion = 'version'
konanArtifacts { konanArtifacts {
program('foo') { // Targets to build this artifact for (optional, override the konan.targets list)
program('foo', targets: ['android_arm32', 'android_arm64']) {
// Directory with source files. The default path is src/main/kotlin. // Directory with source files. The default path is src/main/kotlin.
srcDir 'src/other' srcDir 'src/other'
@@ -397,6 +457,16 @@ tables below.
// The default baseDir is build/konan/bitcode // The default baseDir is build/konan/bitcode
} }
dynamic('quux') {
// Dynamic library has the same parameters as an executable
// The default baseDir is build/konan/bin
}
framework('quuux') {
// Framework has the same parameters as an executable
// The default baseDir is build/konan/bin
}
interop('qux') { interop('qux') {
// Def-file describing the native API. // Def-file describing the native API.
// The default path is src/main/c_interop/<interop-name>.def // The default path is src/main/c_interop/<interop-name>.def