kotlin-gradle-plugin-api/org.jetbrains.kotlin.gradle.plugin/CInteropSettings

CInteropSettings

C interoperability settings

This interface represents the configuration settings for invoking the cinterop tool in Kotlin/Native projects. The cinterop tool provides the ability to use C libraries inside Kotlin projects.

Important: Use the CInteropSettings API instead of directly accessing tasks, configurations, and other related domain objects through the Gradle API.

Example

Here is an example of how to use CInteropSettings to configure a cinterop task for the linuxX64 target:

//build.gradle.kts
kotlin {
    linuxX64() {
        compilations.getByName("main") {
            cinterops {
                val cinteropForLinuxX64 by creating {
                     // Configure the CInteropSettings here
                }
            }
        }
    }
}

In this example, we've added a cinterop setting named cinteropForLinuxX64 to the linuxX64 main KotlinCompilation. These settings are used to create and configure a cinterop task, along with the necessary dependencies for the compile task.

Types

IncludeDirectories

interface IncludeDirectories

A collection of directories to look for headers.

Properties

dependencyFiles

abstract var dependencyFiles: FileCollection

The collection of libraries used for building during the C interoperability process. It's equivalent to the -library/-l cinterop tool options.

Functions

compilerOpts

abstract fun compilerOpts(vararg values: String)

abstract fun compilerOpts(values: List<String>)

The options that are passed to the compiler by the cinterop tool.

defFile

abstract fun defFile(file: Any)

Specifies the path to the .def file that declares bindings for the C libraries. This function serves as a setter for the .def file path and is equivalent to passing -def to the cinterop tool.

extraOpts