Библиотеки Kotlin/Native

Компиляция библиотеки

Для создания артефакта *.klib для вашей библиотеки можно использовать файл сборки проекта или компилятор Kotlin/Native.

Утилита klib

Утилита управления библиотеками klib позволяет изучать библиотеки с помощью следующего синтаксиса:

klib <command> <library path> [<option>]

В настоящее время доступны следующие команды:

Все перечисленные выше команды для вывода данных принимают дополнительный аргумент -signature-version {N}, указывающий утилите klib, какую версию сигнатур IR использовать при их выводе. Если аргумент не задан, используется самая актуальная версия, поддерживаемая библиотекой. Например:

klib dump-metadata-signatures mylib.klib -signature-version 1

Кроме того, команда dump-metadata принимает аргумент -print-signatures {true|false}, который указывает утилите klib выводить сигнатуры IR для каждого объявления.

Создание и использование библиотеки

1. Создайте библиотеку, поместив исходный код в kotlinizer.kt:

   package kotlinizer
   
   val String.kotlinized
       get() = "Kotlin $this"
   

2. Скомпилируйте библиотеку в .klib:

   kotlinc-native kotlinizer.kt -p library -o kotlinizer
   

3. Проверьте, появилась ли созданная библиотека в текущем каталоге:

   ls kotlinizer.klib
   

4. Просмотрите общую информацию о библиотеке:

   klib info kotlinizer.klib
   

5. Создайте небольшую программу в файле use.kt:

   import kotlinizer.*
   
   fun main(args: Array<String>) {
       println("Hello, ${"world".kotlinized}!")
   }
   

6. Скомпилируйте программу, связав исходный файл use.kt с библиотекой:

   kotlinc-native use.kt -l kotlinizer -o kohello
   

7. Запустите программу:

   ./kohello.kexe
   

В результате вы должны увидеть Hello, Kotlin world!.

Порядок поиска библиотек

Если указан параметр -library foo, компилятор ищет библиотеку foo в следующем порядке:

1. Текущий каталог компиляции или абсолютный путь.

2. Библиотеки, установленные в репозитории по умолчанию.

3. Библиотеки, установленные в каталоге $installation/klib.

Формат библиотеки

Библиотеки Kotlin/Native — это ZIP-файлы с предопределенной структурой каталогов, которая выглядит следующим образом:

После распаковки foo.klib как foo/ получаем:

- foo/
  - $component_name/
    - ir/
      - Serialized Kotlin IR.
    - targets/
      - $platform/
        - kotlin/
          - Kotlin compiled to LLVM bitcode.
        - native/
          - Bitcode files of additional native objects.
      - $another_platform/
        - There can be several platform specific kotlin and native pairs.
    - linkdata/
      - A set of ProtoBuf files with serialized linkage metadata.
    - resources/
      - General resources such as images. (Not used yet).
    - manifest - A file in the java property format describing the library.

Пример структуры можно найти в каталоге klib/common/stdlib в папке установки компилятора Kotlin/Native.

Использование относительных путей в klib

Сериализованное представление IR исходных файлов — часть библиотеки klib. Оно содержит пути к файлам, необходимые для создания корректной отладочной информации. По умолчанию сохраняются абсолютные пути.

С помощью параметра компилятора -Xklib-relative-path-base можно изменить формат и использовать в артефакте только относительные пути. Для этого передайте в качестве аргумента один или несколько базовых путей к исходным файлам:

import org.jetbrains.kotlin.gradle.tasks.KotlinCompilationTask
// ...

tasks.named<KotlinCompilationTask<*>>("compileKotlin").configure {
    // $base is a base path of source files
    compilerOptions.freeCompilerArgs.add("-Xklib-relative-path-base=$base")
}

import org.jetbrains.kotlin.gradle.tasks.KotlinCompilationTask
// ...

tasks.named('compileKotlin', KotlinCompilationTask) {
    compilerOptions {
        // $base is a base path of source files
        freeCompilerArgs.add("-Xklib-relative-path-base=$base")
    }
}

Что дальше?

Узнайте, как использовать инструмент cinterop для создания артефактов *.klib