映射来自 C 语言的字符串——教程

映射来自 C 语言的字符串——教程

这是本系列的最后一篇教程。本系列的第一篇教程是映射来自 C 语言的原生数据类型。系列其余教程包括映射来自 C 语言的结构与联合类型与映射来自 C 语言的函数指针。

在本教程中会看到如何在 Kotlin/Native 中处理 C 语言的字符串。将会学习到如何：

传递一个 Kotlin 字符串给 C
在 Kotlin 中读取一个 C 字符串
接收 C 字符串字节并转换为 Kotlin 字符串

使用 C 语言字符串

在 C 语言中，没有专门用于字符串的类型。开发者需要从方法签名或文档中才能得知给定的 char * 在上下文中是否表示 C 字符串。 C 语言中的字符串以空值终止，即在字节序列尾部添加零字符 \0 来标记字符串终止。通常，使用 UTF-8 编码字符串。UTF-8 编码使用可变长度的字符，并且它向后兼容 ASCII。 Kotlin/Native 默认使用 UTF-8 字符编码。

理解在 C 语言与 Kotlin 之间进行映射的最好方式是尝试编写一个小型示例。为此创建一个小型库的头文件。首先，为以下处理 C 字符串的函数声明创建一个 lib.h 文件。

#ifndef LIB2_H_INCLUDED
#define LIB2_H_INCLUDED
void pass_string(char* str);
char* return_string();
int copy_string(char* str, int size);
#endif

在示例中，见到了大多数情况下受欢迎的方式来传递或接收 C 语言中的字符串。小心地返回 return_string。通常，最好确保我们使用正确的函数来处理被正确调用 free(..) 函数返回的 char*。

Kotlin/Native 附带 cinterop 工具；该工具可以生成 C 语言与 Kotlin 之间的绑定。它使用一个 .def 文件指定一个 C 库来导入。更多的细节将在与 C 库互操作教程中讨论。最快速的尝试 C API 映射的方法是将所有的 C 声明写到 interop.def 文件，而不用创建任何 .h 或 .c 文件。在 .def 文件中，所有的 C 声明都在特殊的 --- 分割行之后。

headers = lib.h
---
void pass_string(char* str) {
}
char* return_string() {
  return "C string";
}
int copy_string(char* str, int size) {
  *str++ = 'C';
  *str++ = ' ';
  *str++ = 'K';
  *str++ = '/';
  *str++ = 'N';
  *str++ = 0;
  return 0;
}

该 interop.def 文件足够用来编译并运行应用程序，或在 IDE 中打开它。现在是时候创建项目文件，并在 IntelliJ IDEA 中打开这个项目，然后运行它。

探查为 C 库生成的 Kotlin API

While it is possible to use the command line, either directly or by combining it with a script file (such as .sh or .bat file), this approach doesn’t scale well for big projects that have hundreds of files and libraries. It is then better to use the Kotlin/Native compiler with a build system, as it helps to download and cache the Kotlin/Native compiler binaries and libraries with transitive dependencies and run the compiler and tests. Kotlin/Native can use the Gradle build system through the kotlin-multiplatform plugin.

We covered the basics of setting up an IDE compatible project with Gradle in the A Basic Kotlin/Native Application tutorial. Please check it out if you are looking for detailed first steps and instructions on how to start a new Kotlin/Native project and open it in IntelliJ IDEA. In this tutorial, we’ll look at the advanced C interop related usages of Kotlin/Native and multiplatform builds with Gradle.

First, create a project folder. All the paths in this tutorial will be relative to this folder. Sometimes the missing directories will have to be created before any new files can be added.

Use the following build.gradle(.kts) Gradle build file:

【Kotlin】

plugins {
    kotlin("multiplatform") version "1.9.10"
}
repositories {
    mavenCentral()
}
kotlin {
  linuxX64("native") { // on Linux
  // macosX64("native") { // on x86_64 macOS
  // macosArm64("native") { // on Apple Silicon macOS
  // mingwX64("native") { // on Windows
    val main by compilations.getting
    val interop by main.cinterops.creating
    binaries {
      executable()
    }
  }
}
tasks.wrapper {
  gradleVersion = "7.6"
  distributionType = Wrapper.DistributionType.BIN
}

【Groovy】

plugins {
    id 'org.jetbrains.kotlin.multiplatform' version '1.9.10'
}
repositories {
    mavenCentral()
}
kotlin {
  linuxX64('native') { // on Linux
  // macosX64("native") { // on x86_64 macOS
  // macosArm64("native") { // on Apple Silicon macOS
  // mingwX64('native') { // on Windows
    compilations.main.cinterops {
      interop 
    }
    binaries {
      executable()
    }
  }
}
wrapper {
  gradleVersion = '7.6'
  distributionType = 'BIN'
}

The project file configures the C interop as an additional step of the build. Let’s move the interop.def file to the src/nativeInterop/cinterop directory. Gradle recommends using conventions instead of configurations, for example, the source files are expected to be in the src/nativeMain/kotlin folder. By default, all the symbols from C are imported to the interop package, you may want to import the whole package in our .kt files. Check out the kotlin-multiplatform plugin documentation to learn about all the different ways you could configure it.

我们使用下面的内容创建一个 src/nativeMain/kotlin/hello.kt 存根文件，以用来观察 C 语言中的字符串是如何在 Kotlin 中可见的：

import interop.*
fun main() {
  println("Hello Kotlin/Native!")
  pass_string(/*fix me*/)
  val useMe = return_string()
  val useMe2 = copy_string(/*fix me*/)
}

现在已经准备好在 IntelliJ IDEA 中打开这个项目并且看看如何修正这个示例项目。当做了这些之后，可以看下 C 语言字符串是如何映射到 Kotlin/Native 声明的。

Strings in Kotlin

通过 IntelliJ IDEA 的 Go to | Declaration 或编译器错误的帮助，可以看到如下为 C 函数生成的声明：

fun pass_string(str: CValuesRef<ByteVar /* = ByteVarOf<Byte> */>?)
fun return_string(): CPointer<ByteVar /* = ByteVarOf<Byte> */>?
fun copy_string(str: CValuesRef<ByteVar /* = ByteVarOf<Byte> */>?, size: Int): Int

这些声明看起来很清晰。所有的 char * 指针在参数处都被转换为 str: CValuesRef<ByteVar>? 而返回值类型则被转换为 CPointer<ByteVar>?。Kotlin 将 char 类型转换为 kotlin.Byte 类型，因为它通常是 8 位有符号值。

在生成的 Kotlin 声明中，可以看到 str 被 CValuesRef<ByteVar/>? 表示。该类型是可空的，可以简单地将 Kotlin null 作为参数值。

将 Kotlin 字符串传递给 C

我们来尝试在 Kotlin 中使用这些 API。首先调用 pass_string：

fun passStringToC() {
  val str = "this is a Kotlin String"
  pass_string(str.cstr)
}

将 Kotlin 字符串传递到 C 非常简单，幸亏事实上在 Kotlin 中有 String.cstr 扩展属性来应对这种情况。当需要 UTF-16 字符编码时，也有 String.wcstr 来应对这种情况。

在 Kotlin 中读取 C 字符串

这次会从 return_string 函数获取一个返回的 char * 并将其转换为一个 Kotlin 字符串。为此在 Kotlin 中做了如下这些事：

fun passStringToC() {
  val stringFromC = return_string()?.toKString()
  println("Returned from C: $stringFromC")
}

在上面的示例中的代码使用了 toKString() 扩展函数。请不要与 toString() 函数混淆。toKString() 在 Kotlin 中拥有两个版本的重载扩展函数：

fun CPointer<ByteVar>.toKString(): String
fun CPointer<ShortVar>.toKString(): String

第一个重载扩展函数将得到一个 char * 作为 UTF-8 字符串并转换到 String。第二个重载函数做了相同的事，但是它针对 UTF-16 字符串。

在 Kotlin 中接收 C 字符串字节

这次我们将要求 C 函数将 C 字符串写入给定的缓冲区。这个函数被称为 copy_string。它需要一个指针来定位写入字符的位置并分配缓冲区的大小。该函数返回一些内容以指示它是成功还是失败。我们假设 0 表示成功，并且提供的缓冲区足够大：

fun sendString() {
  val buf = ByteArray(255)
  buf.usePinned { pinned ->
    if (copy_string(pinned.addressOf(0), buf.size - 1) != 0) {
      throw Error("Failed to read string from C")
    }
  }
  val copiedStringFromC = buf.decodeToString()
  println("Message from C: $copiedStringFromC")
}

首先，需要有一个原生的指针来传递这个 C 函数。使用 usePinned 扩展函数来临时固定字节数组的原生内存地址。该 C 函数填充了带数据的字节数组。使用另一个扩展函数 ByteArray.decodeToString() 将字节数组转换为一个 Kotlin String，假设它是 UTF-8 编码的。

修复代码

看过了所有的定义并且是时候来修改代码了。在 IDE 中运行 runDebugExecutableNative Gradle 任务或使用下面的命令来运行代码：

./gradlew runDebugExecutableNative

hello.kt 文件中的代码最终看起来会是这样的：

import interop.*
import kotlinx.cinterop.*
fun main() {
  println("Hello Kotlin/Native!")
  val str = "this is a Kotlin String"
  pass_string(str.cstr)
  val useMe = return_string()?.toKString() ?: error("null pointer returned")
  println(useMe)
  val copyFromC = ByteArray(255).usePinned { pinned ->
    val useMe2 = copy_string(pinned.addressOf(0), pinned.get().size - 1)
    if (useMe2 != 0) throw Error("Failed to read string from C")
    pinned.get().decodeToString()
  }
  println(copyFromC)
}

接下来

继续在以下几篇教程中继续探索更多的 C 语言类型及其在 Kotlin/Native 中的表示：

这篇与 C 语言互操作文档涵盖了更多的高级互操作场景