命名空间
变体
操作

c16rtomb

来自 cppreference.com
< c‎ | string‎ | multibyte
定义在头文件 <uchar.h>
size_t c16rtomb( char* restrict s, char16_t c16, mbstate_t* restrict ps );
(自 C11 起)

将单个代码点从其可变长度 16 位宽字符表示(通常为 UTF-16)转换为其窄多字节字符表示。

如果 s 不是空指针,并且 c16 是代码点的有效可变长度编码中的最后一个 16 位代码单元,则该函数确定存储该代码点的多字节字符表示所需的字节数(包括任何移位序列,并考虑当前的多字节转换状态 *ps),并将多字节字符表示存储在第一个元素由 s 指向的字符数组中,根据需要更新 *ps。此函数最多可以写入 MB_CUR_MAX 个字节。

如果 s 是空指针,则调用等效于 c16rtomb(buf, u'\0', ps),其中 buf 是某个内部缓冲区。

如果 c16 是空宽字符 u'\0',则存储一个空字节,该空字节位于任何恢复初始移位状态所需的移位序列之前,并且转换状态参数 *ps 被更新为表示初始移位状态。

如果 c16 不是宽字符的 16 位表示中的最后一个代码单元,则它不会写入由 s 指向的数组,只有 *ps 会被更新。

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

内容

[编辑] 参数

s - 指向将存储多字节字符的窄字符数组的指针
c16 - 要转换的 16 位宽字符
ps - 指向用于解释多字节字符串的转换状态对象的指针

[编辑] 返回值

成功时,返回写入第一个元素由 s 指向的字符数组的字节数(包括任何移位序列)。此值可能为 0,例如,在处理多 char16_t 单元序列中的前导 char16_t 单元时(在处理 UTF-16 的代理对中的前导代理时发生)。

失败时(如果 c16 不是有效的 16 位代码单元),返回 -1,在 EILSEQ 中存储 errno,并将 *ps 留在未指定的状态。

[编辑] 注释

在发布的 C11 中,与 mbrtoc16 不同,mbrtoc16 将可变宽度多字节(如 UTF-8)转换为可变宽度 16 位(如 UTF-16)编码,此函数只能转换单单元 16 位编码,这意味着它不能将 UTF-16 转换为 UTF-8,尽管这是此函数的最初意图。 这是由 C11 后的缺陷报告 DR488 纠正的。

[编辑] 示例

注意:此示例假设已应用缺陷报告 DR488 的修复

#include <locale.h>
#include <stdio.h>
#include <stdlib.h>
#include <uchar.h>
 
mbstate_t state;
 
int main(void)
{
    setlocale(LC_ALL, "en_US.utf8");
    const char16_t in[] = u"zß水🍌"; // or "z\u00df\u6c34\U0001F34C"
    const size_t in_sz = sizeof in / sizeof *in;
 
    printf("Processing %zu UTF-16 code units: [ ", in_sz);
    for (size_t n = 0; n < in_sz; ++n)
        printf("%#x ", in[n]);
    puts("]");
 
    char out[MB_CUR_MAX * in_sz];
    char *p = out;
    for (size_t n = 0; n < in_sz; ++n)
    {
        size_t rc = c16rtomb(p, in[n], &state);
        if (rc == (size_t)-1)
            break;
        p += rc;
    }
 
    size_t out_sz = p - out;
    printf("into %zu UTF-8 code units: [ ", out_sz);
    for (size_t x = 0; x < out_sz; ++x)
        printf("%#x ", +(unsigned char)out[x]);
    puts("]");
}

输出

Processing 6 UTF-16 code units: [ 0x7a 0xdf 0x6c34 0xd83c 0xdf4c 0 ]
into 11 UTF-8 code units: [ 0x7a 0xc3 0x9f 0xe6 0xb0 0xb4 0xf0 0x9f 0x8d 0x8c 0 ]

[编辑] 参考文献

  • C23 标准 (ISO/IEC 9899:2024)
  • 7.28.1.2 c16rtomb 函数 (p: 待定)
  • C17 标准 (ISO/IEC 9899:2018)
  • 7.28.1.2 c16rtomb 函数 (p: 待定)
  • C11 标准 (ISO/IEC 9899:2011)
  • 7.28.1.2 c16rtomb 函数 (p: 399-400)

[编辑] 另请参见

从窄多字节字符串生成下一个 16 位宽字符
(函数) [编辑]
C++ 文档 针对 c16rtomb