C言語の関数ポインタのマッピング – チュートリアル
Cライブラリのインポートはベータ版です。cinteropツールによってCライブラリから生成されるすべてのKotlin宣言には、@ExperimentalForeignApiアノテーションが必要です。
Kotlin/Nativeに同梱されているネイティブプラットフォームライブラリ(Foundation、UIKit、POSIXなど)では、一部のAPIのみオプトインが必要です。
KotlinからどのC関数ポインタが参照できるかを確認し、Kotlin/Nativeおよびマルチプラットフォーム Gradleビルドにおける高度なC相互運用のユースケースを調べてみましょう。
このチュートリアルでは、以下の内容を学びます。
C言語の関数ポインタ型のマッピング
KotlinとCの間のマッピングを理解するために、関数ポインタをパラメータとして受け取る関数と、関数ポインタを返す関数の2つを宣言してみましょう。
シリーズの第1部で、必要なファイルを含むCライブラリをすでに作成しました。このステップでは、interop.defファイルの---セパレータ以降の宣言を更新します。
---
int myFun(int i) {
return i+1;
}
typedef int (*MyFun)(int);
void accept_fun(MyFun f) {
f(42);
}
MyFun supply_fun() {
return myFun;
}interop.defファイルは、アプリケーションをコンパイル、実行、またはIDEで開くために必要なすべてを提供します。
Cライブラリ用に生成されたKotlin APIの確認
C関数ポインタがKotlin/Nativeにどのようにマッピングされるかを確認し、プロジェクトを更新してみましょう。
src/nativeMain/kotlinにある、前のチュートリアルのhello.ktファイルを以下の内容で更新します。kotlinimport interop.* import kotlinx.cinterop.ExperimentalForeignApi @OptIn(ExperimentalForeignApi::class) fun main() { println("Hello Kotlin/Native!") accept_fun(/* fix me*/) val useMe = supply_fun() }IntelliJ IDEAの宣言へ移動 (Go to declaration)コマンド(Cmd + B/Ctrl + B)を使用して、C関数用に生成された以下のAPIに移動します。
kotlinfun myFun(i: kotlin.Int): kotlin.Int fun accept_fun(f: kotlinx.cinterop.CPointer<kotlinx.cinterop.CFunction<(kotlin.Int) -> kotlin.Int>>? /* from: interop.MyFun? */) fun supply_fun(): kotlinx.cinterop.CPointer<kotlinx.cinterop.CFunction<(kotlin.Int) -> kotlin.Int>>? /* from: interop.MyFun? */
見てわかるように、C関数ポインタはKotlinではCPointer<CFunction<...>>を使用して表現されます。accept_fun()関数はパラメータとしてオプショナルな関数ポインタを受け取り、supply_fun()は関数ポインタを返します。
CFunction<(Int) -> Int>は関数シグネチャを表し、CPointer<CFunction<...>>?はnull許容(nullable)の関数ポインタを表します。すべてのCPointer<CFunction<...>>型には.invoke()演算子拡張関数が用意されており、関数ポインタを通常のKotlin関数であるかのように呼び出すことができます。
Kotlin関数をC関数ポインタとして渡す
それでは、KotlinコードからC関数を使用してみましょう。accept_fun()関数を呼び出し、C関数ポインタをKotlinラムダに渡します。
import interop.*
import kotlinx.cinterop.staticCFunction
import kotlinx.cinterop.ExperimentalForeignApi
@OptIn(ExperimentalForeignApi::class)
fun myFun() {
accept_fun(staticCFunction<Int, Int> { it + 1 })
}この呼び出しでは、Kotlin/Nativeのヘルパー関数staticCFunction {}を使用して、Kotlinラムダ関数をC関数ポインタにラップしています。これにはアンバウンド(非バインド)でキャプチャを行わないラムダ関数のみを使用できます。たとえば、関数内のローカル変数をキャプチャすることはできず、グローバルに参照可能な宣言のみをキャプチャできます。
関数が例外をスローしないように注意してください。staticCFunction {}から例外をスローすると、非決定論的な副作用が発生します。
KotlinからC関数ポインタを使用する
次のステップは、supply_fun()呼び出しから返されたC関数ポインタを実行することです。
import interop.*
import kotlinx.cinterop.ExperimentalForeignApi
import kotlinx.cinterop.invoke
@OptIn(ExperimentalForeignApi::class)
fun myFun2() {
val functionFromC = supply_fun() ?: error("No function is returned")
functionFromC(42)
}Kotlinは関数ポインタの戻り値の型をnull許容のCPointer<CFunction<>オブジェクトに変換します。そのため、最初に明示的にnullをチェックする必要があり、上記コードではElvis演算子が使用されています。 cinteropツールを使用すると、C関数ポインタを通常のKotlin関数の呼び出し(functionFromC(42))のように呼び出すことができます。
Kotlinコードの更新
すべての定義を確認できたので、プロジェクトでそれらを使用してみましょう。 hello.ktファイルのコードは以下のようになります。
import interop.*
import kotlinx.cinterop.ExperimentalForeignApi
import kotlinx.cinterop.invoke
import kotlinx.cinterop.staticCFunction
@OptIn(ExperimentalForeignApi::class)
fun main() {
println("Hello Kotlin/Native!")
val cFunctionPointer = staticCFunction<Int, Int> { it + 1 }
accept_fun(cFunctionPointer)
val funFromC = supply_fun() ?: error("No function is returned")
funFromC(42)
}すべてが期待どおりに動作することを確認するには、IDEでrunDebugExecutable<YourTargetName> Gradleタスクを実行するか、ターミナルでコンソールコマンドを使用します(この例の場合):
./gradlew runDebugExecutableMacosArm64次のステップ
シリーズの次のパートでは、KotlinとCの間で文字列がどのようにマッピングされるかを学びます。
関連項目
より高度なシナリオをカバーしているC言語との相互運用性のドキュメントで詳細をご確認ください。
