std::mbrtoc16

来自cppreference.com
< cpp‎ | string‎ | multibyte
在标头 <cuchar> 定义
std::size_t mbrtoc16( char16_t* pc16,

                      const char* s,
                      std::size_t n,

                      std::mbstate_t* ps );
(C++11 起)

转换窄多字节字符到其 UTF-16 字符表示。

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

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

s 是空指针,则忽略 npc16 的值,而调用等价于 std::mbrtoc16(NULL, "", 1, ps)

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

此函数所用的多字节字符编码为当前活跃的 C 本地环境所指定。

参数

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

返回值

下列首个能适用者:

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

示例

#include <clocale>
#include <cstring>
#include <cuchar>
#include <cwchar>
#include <iomanip>
#include <iostream>
 
int main()
{
    std::setlocale(LC_ALL, "en_US.utf8");
 
    std::string str = u8"z\u00df\u6c34\U0001F34C"; // 或 u8"zß水🍌"
 
    std::cout << "处理 " << str.size() << " 个字节: [ " << std::showbase;
    for (unsigned char c: str)
        std::cout << std::hex << +c << ' ';
    std::cout << "]\n";
 
    std::mbstate_t state{}; // 零初始化到初始状态
    char16_t c16;
    const char *ptr = &str[0], *end = &str[0] + str.size();
 
    while (std::size_t rc = std::mbrtoc16(&c16, ptr, end - ptr + 1, &state))
    {
        std::cout << "下一个 UTF-16 字符: " << std::hex 
                  << static_cast<int>(c16) << " 来自 ";
        if (rc == (std::size_t)-3)
            std::cout << "前一个代理对\n";
        else if (rc == (std::size_t) - 2)
            break;
        else if (rc == (std::size_t) - 1)
            break;
        else
        {
            std::cout << std::dec << rc << " 个字节 [ ";
            for (std::size_t n = 0; n < rc; ++n)
                std::cout << std::hex << +static_cast<unsigned char>(ptr[n]) << ' ';
            std::cout << "]\n";
            ptr += rc;
        }
    }
}

输出:

处理 10 个字节: [ 0x7a 0xc3 0x9f 0xe6 0xb0 0xb4 0xf0 0x9f 0x8d 0x8c ]
下一个 UTF-16 字符: 0x7a 来自 1 个字节 [ 0x7a ]
下一个 UTF-16 字符: 0xdf 来自 2 个字节 [ 0xc3 0x9f ]
下一个 UTF-16 字符: 0x6c34 来自 3 个字节 [ 0xe6 0xb0 0xb4 ]
下一个 UTF-16 字符: 0xd83c 来自 4 个字节 [ 0xf0 0x9f 0x8d 0x8c ]
下一个 UTF-16 字符: 0xdf4c 来自前一个代理对

参阅

(C++11)
转换 16 位宽字符为窄多字节字符串
(函数)
[虚]
将字符串从 ExternT 转换到 InternT,例如在从文件读取时
(std::codecvt<InternT,ExternT,StateT> 的虚受保护成员函数)