Добавление зависимостей iOS

Добавление библиотеки

1. Загрузите исходный код библиотеки и поместите его в место, на которое можно ссылаться из проекта.

2. Соберите библиотеку (обычно авторы библиотеки предоставляют инструкции по сборке) и получите путь к двоичным файлам.

3. В проекте создайте файл .def, например DateTools.def.

4. Добавьте в этот файл первую строку: language = Objective-C. Если вы хотите использовать чистую зависимость C, опустите свойство языка.

5. Укажите значения двух обязательных свойств:

   • headers задаёт заголовочные файлы, которые будут обработаны cinterop.

   • package задаёт имя пакета, в который следует поместить эти объявления.

   Например:

   headers = DateTools.h
   package = DateTools
   

6. Добавьте в сценарий сборки сведения о взаимодействии с этой библиотекой:

   • Укажите путь к файлу .def. Этот путь можно опустить, если файл .def называется так же, как cinterop, и находится в каталоге src/nativeInterop/cinterop/.

   • Укажите cinterop, где искать заголовочные файлы, с помощью параметра includeDirs.

   • Настройте компоновку с двоичными файлами библиотеки.

   kotlin {
       iosArm64() {
           compilations.getByName("main") {
               val DateTools by cinterops.creating {
                   // Path to the .def file
                   definitionFile.set(project.file("src/nativeInterop/cinterop/DateTools.def"))
   
                   // Directories for header search (an analogue of the -I<path> compiler option)
                   includeDirs("include/this/directory", "path/to/another/directory")
               }
               val anotherInterop by cinterops.creating { /* ... */ }
           }
   
           binaries.all {
               // Linker options required to link to the library.
               linkerOpts("-L/path/to/library/binaries", "-lbinaryname")
           }
       }
   }
   

   kotlin {
       iosArm64 {
           compilations.main {
               cinterops {
                   DateTools {
                       // Path to the .def file
                       definitionFile = project.file("src/nativeInterop/cinterop/DateTools.def")
   
                       // Directories for header search (an analogue of the -I<path> compiler option)
                       includeDirs("include/this/directory", "path/to/another/directory")
                   }
                   anotherInterop { /* ... */ }
               }
           }
   
           binaries.all {
               // Linker options required to link to the library.
               linkerOpts "-L/path/to/library/binaries", "-lbinaryname"
           }
       }
   }
   

7. Соберите проект.

Теперь эту зависимость можно использовать в коде Kotlin. Для этого импортируйте пакет, заданный в свойстве package файла .def. В приведённом выше примере это будет:

import DateTools.*

Добавление фреймворка

1. Загрузите исходный код фреймворка и поместите его в место, на которое можно ссылаться из проекта.

2. Соберите фреймворк (обычно авторы фреймворка предоставляют инструкции по сборке) и получите путь к двоичным файлам.

3. В проекте создайте файл .def, например MyFramework.def.

4. Добавьте в этот файл первую строку: language = Objective-C. Если вы хотите использовать чистую зависимость C, опустите свойство языка.

5. Укажите значения двух обязательных свойств:

   • modules — имя фреймворка, который должен обрабатывать cinterop.

   • package — имя пакета, в который следует поместить эти объявления.

   Например:

   modules = MyFramework
   package = MyFramework
   

6. Добавьте в сценарий сборки сведения о взаимодействии с фреймворком:

   • Укажите путь к файлу .def. Этот путь можно опустить, если файл .def называется так же, как cinterop, и находится в каталоге src/nativeInterop/cinterop/.

   • Передайте имя фреймворка компилятору и компоновщику с помощью параметра -framework. Передайте путь к исходным файлам и двоичным файлам фреймворка компилятору и компоновщику с помощью параметра -F.

   kotlin {
       iosArm64() {
           compilations.getByName("main") {
               val DateTools by cinterops.creating {
                   // Path to the .def file
                   definitionFile.set(project.file("src/nativeInterop/cinterop/DateTools.def"))
   
                   compilerOpts("-framework", "MyFramework", "-F/path/to/framework/")
               }
               val anotherInterop by cinterops.creating { /* ... */ }
           }
   
           binaries.all {
               // Tell the linker where the framework is located.
               linkerOpts("-framework", "MyFramework", "-F/path/to/framework/")
           }
      }
   }
   

   kotlin {
       iosArm64 {
           compilations.main {
               cinterops {
                   DateTools {
                       // Path to the .def file
                       definitionFile = project.file("src/nativeInterop/cinterop/MyFramework.def")
   
                       compilerOpts("-framework", "MyFramework", "-F/path/to/framework/")
                   }
                   anotherInterop { /* ... */ }
               }
           }
   
           binaries.all {
               // Tell the linker where the framework is located.
               linkerOpts("-framework", "MyFramework", "-F/path/to/framework/")
           }
       }
   }
   

7. Соберите проект.

Теперь эту зависимость можно использовать в коде Kotlin. Для этого импортируйте пакет, заданный в свойстве package файла .def. В приведённом выше примере это будет:

import MyFramework.*

Подробнее о взаимодействии Swift/Objective-C и настройке cinterop в Gradle.