mbrtoc16

来自cppreference.com
 
C
 
字符串库
 
空终止多字节字符串
 
在标头 <uchar.h> 定义 
size_t mbrtoc16( char16_t* restrict pc16, const char* restrict s,
                 size_t n, mbstate_t* restrict ps );
(C11 起)

将单个编码点从其多字节字符表示转换成其变长 16 位宽字符（典型地为 UTF-16）表示。

若 s 不是空指针，则审查从 s 所指的字节开始的多字节字符串的至多 n 个字节，以检查完成下个多字节字符的字节数（包含任何迁移序列，并计入当前的多字节转换状态 *ps）。若函数确定 s 中下个多字节字符完整且合法，则将它转换到对应的 16 位宽字符，并将它存储于 *pc16（若 pc16 非空）。

若 *s 中的宽字符对应多 char16_t 序列（例如 UTF-16 中的代理对），则在首次调用此函数后更新 *ps，以令下次到 mbrtoc16 的调用将写出额外的 char16_t，而不考虑 *s。

若 s 是空指针，则忽略 n 与 pc16 的值，而调用等价于 mbrtoc16(NULL, "", 1, ps)。

若产生的宽字符是空字符，则转换状态 *ps 表示初始迁移状态。

若定义了 __STDC_UTF_16__ 宏，则此函数使用的 16 位编码是 UTF-16；否则它是实现定义的。总是定义这个宏，且编码总是 UTF-16。(C23 起)任何情况下，此函数所用的多字节字符编码为当前活跃的 C 本地环境所指定。

参数

pc16 - 指向将写入产生的 16 位宽字符的位置的指针
s - 指向用作输入的多字节字符串的指针
n - 能检验的字节数上的限制
ps - 指向转译多字节字符串时所用转换状态对象的指针

返回值

下列首个适用者：

  • 若从 s 转换的字符是空字符（并存储于 *pc16，若它非空），则为 0。
  • 成功从 s 转换的多字节字符 [1, n] 的字节数。
  • 若下个 char16_t 组成多 char16_t 字符，并已写入 *pc16，则为 (size_t)-3。此情况下不处理输入的任何字节。
  • 若接下来 n 个字符组成不完整，但到此还合法的多字节字符，则为 (size_t)-2。不写入 *pc16。
  • 若出现编码错误则为 (size_t)-1。不写入 *pc16，存储值 EILSEQ 于 errno，且 *ps 状态未指定。

示例

在 MSVC 上可能需要 /utf-8 编译器标志以使 UTF_8 正常工作。

运行此代码
#include <locale.h>
#include <stdio.h>
#include <uchar.h>

int main(void)
{
    setlocale(LC_ALL, "en_US.utf8");
    const char in[] = u8"zß水🍌"; // 即 "z\u00df\u6c34\U0001F34C"
    enum { in_sz = sizeof in / sizeof *in };

    printf("%d 个 UTF-8 码元：[", in_sz);
    for (int n = 0; n < in_sz; ++n)
        printf("%s%04X", n ? " " : "", (unsigned char)in[n]);
    puts("]");

    char16_t out[in_sz];
    const char* p_in = in;
    const char* end = in + in_sz;
    char16_t* p_out = out;
    mbstate_t state = {0};

    for (size_t rc; (rc = mbrtoc16(p_out, p_in, end - p_in, &state));)
    {
        if (rc == (size_t)-1)     // 无效输入
            break;
        else if(rc == (size_t)-2) // 被截断的输入
            break;
        else if(rc == (size_t)-3) // UTF-16 高位代理
            p_out += 1;
        else
        {
            p_in += rc;
            p_out += 1;
        };
    }

    const size_t out_sz = p_out - out + 1;
    printf("处理成 %zu 个 UTF-16 码元：[", out_sz);
    for (size_t x = 0; x < out_sz; ++x)
        printf("%s%04X", x ? " " : "", out[x]);
    puts("]");
}

输出： 

11 个 UTF-8 码元：[7A C3 9F E6 B0 B4 F0 9F 8D 8C 00]
处理成 6 个 UTF-16 码元：[007A 00DF 6C34 D83C DF4C 0000]

引用

  • C23 标准（ISO/IEC 9899:2024）：
  • 7.30.1.3 The mbrtoc16 function （第 408-409 页）
  • C11 标准（ISO/IEC 9899:2011）：
  • 7.28.1.1 The mbrtoc16 function （第 398-399 页）

参阅

(C11)
 转换 UTF-16 字符为窄多字节编码
(函数)
mbrtoc16 的 C++ 文档