命名空间
变体
操作

mbrtoc16

出自 cppreference.cn
< c‎ | string‎ | multibyte
定义于头文件 <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 是空指针,则 npc16 的值将被忽略,并且调用等效于 mbrtoc16(NULL, "", 1, ps)

如果生成的宽字符是空字符,则转换状态 *ps 表示初始移位状态。

如果宏 __STDC_UTF_16__ 已定义,则此函数使用的 16 位编码是 UTF-16;否则,它是实现定义的。该宏始终已定义,且编码始终为 UTF-16。(自 C23 起) 在任何情况下,此函数使用的多字节字符编码由当前活动的 C 本地环境指定。

目录

[编辑] 参数

pc16 - 指向将写入结果 16 位宽字符的位置的指针
s - 指向用作输入的多字节字符串的指针
n - 可以检查的 s 中的字节数限制
ps - 指向在解释多字节字符串时使用的转换状态对象的指针

[编辑] 返回值

以下第一个适用的项

  • 0 如果从 s 转换(并存储在 *pc16 中,如果非空)的字符是空字符。
  • 成功从 s 转换的多字节字符的字节数 [1n]
  • (size_t)-3 如果来自多 char16_t 字符(例如,代理对)的下一个 char16_t 现在已写入 *pc16。在这种情况下,不处理来自输入的字节。
  • (size_t)-2 如果接下来的 n 个字节构成一个不完整但到目前为止有效的多字节字符。没有任何内容写入 *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ß水🍌"; // or "z\u00df\u6c34\U0001F34C"
    enum { in_sz = sizeof in / sizeof *in };
 
    printf("Processing %d UTF-8 code units: [", in_sz);
    for (int n = 0; n < in_sz; ++n)
        printf("%s%02X", 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)     // invalid input
            break;
        else if(rc == (size_t)-2) // truncated input
            break;
        else if(rc == (size_t)-3) // UTF-16 high surrogate
            p_out += 1;
        else
        {
            p_in += rc;
            p_out += 1;
        };
    }
 
    const size_t out_sz = p_out - out + 1;
    printf("into %zu UTF-16 code units: [", out_sz);
    for (size_t x = 0; x < out_sz; ++x)
        printf("%s%04X", x ? " " : "", out[x]);
    puts("]");
}

输出

Processing 11 UTF-8 code units: [7A C3 9F E6 B0 B4 F0 9F 8D 8C 00]
into 6 UTF-16 code units: [007A 00DF 6C34 D83C DF4C 0000]

[编辑] 参考文献

  • C23 标准 (ISO/IEC 9899:2024)
  • 7.30.1.3 mbrtoc16 函数 (p: 408-409)
  • C11 标准 (ISO/IEC 9899:2011)
  • 7.28.1.1 mbrtoc16 函数 (p: 398-399)

[编辑] 参见

将 UTF-16 字符转换为窄多字节编码
(函数) [编辑]
C++ 文档 关于 mbrtoc16