std::codecvt_utf16 is a std::codecvt facet which encapsulates conversion between a UTF-16 encoded byte string and UCS-2 or UTF-32 character string (depending on the type of Elem). This std::codecvt facet can be used to read and write UTF-16 files in binary mode.
UCS-2 is an archaic encoding that is a subset of UTF-16, which encodes scalar values in the range U+0000-U+FFFF (Basic Multilingual Plane) only.
[edit] Template Parameters Elem - either char16_t, char32_t, or wchar_t Maxcode - the largest value ofElem that this facet will read or write without error Mode - a constant of type std::codecvt_mode [edit] Member functions constructs a new codecvt_utf16 facet
codecvt_utf16 facet
Constructs a new std::codecvt_utf16 facet, passes the initial reference counter refs to the base class.
Destroys the facet. Unlike the locale-managed facets, this facet's destructor is public.
Inherited from std::codecvt Nested types Type Definitionintern_type internT extern_type externT state_type stateT [edit] Data members Member functions invokes do_out
std::codecvt<InternT,ExternT,StateT>) [edit] invokes do_in
std::codecvt<InternT,ExternT,StateT>) [edit] invokes do_unshift
std::codecvt<InternT,ExternT,StateT>) [edit] invokes do_encoding
std::codecvt<InternT,ExternT,StateT>) [edit] invokes do_always_noconv
std::codecvt<InternT,ExternT,StateT>) [edit] invokes do_length
std::codecvt<InternT,ExternT,StateT>) [edit] invokes do_max_length
std::codecvt<InternT,ExternT,StateT>) [edit] Protected member functions converts a string from InternT to ExternT, such as when writing to file
std::codecvt<InternT,ExternT,StateT>) [edit] converts a string from ExternT to InternT, such as when reading from file
std::codecvt<InternT,ExternT,StateT>) [edit] generates the termination character sequence of ExternT characters for incomplete conversion
std::codecvt<InternT,ExternT,StateT>) [edit] returns the number of ExternT characters necessary to produce one InternT character, if constant
std::codecvt<InternT,ExternT,StateT>) [edit] tests if the facet encodes an identity conversion for all valid argument values
std::codecvt<InternT,ExternT,StateT>) [edit] calculates the length of the ExternT string that would be consumed by conversion into given InternT buffer
std::codecvt<InternT,ExternT,StateT>) [edit] returns the maximum number of ExternT characters that could be converted into a single InternT character
std::codecvt<InternT,ExternT,StateT>) [edit] Inherited from std::codecvt_base Nested type Definition enum result { ok, partial, error, noconv }; Unscoped enumeration type Enumeration constant Definition ok conversion was completed with no error partial not all source characters were converted error encountered an invalid character noconv no conversion required, input and output types are the same [edit] Notes
Although the standard requires that this facet works with UCS-2 when the size of Elem is 16 bits, some implementations use UTF-16 instead, making this a non-converting locale. The term "UCS-2" was deprecated and removed from ISO 10646.
The following example demonstrates decoding of UTF-16le file on a system with 32-bit wchar_t. On a system with 16-bit wchar_t, decoding of the third character will fail because std::codecvt_utf16<char16_t> produces UCS-2, not UTF-16.
#include <codecvt>
#include <cwchar>
#include <fstream>
#include <iostream>
#include <locale>
#include <string>
void prepare_file()
{
// UTF-16le data (if host system is little-endian)
char16_t utf16le[4] = {0x007a, // latin small letter 'z' U+007a
0x6c34, // CJK ideograph "water" U+6c34
0xd834, 0xdd0b}; // musical sign segno U+1d10b
// store in a file
std::ofstream fout("text.txt");
fout.write(reinterpret_cast<char*>(utf16le), sizeof utf16le);
}
int main()
{
prepare_file();
// open as a byte stream
std::wifstream fin("text.txt", std::ios::binary);
// apply facet
fin.imbue(std::locale(fin.getloc(),
new std::codecvt_utf16<wchar_t, 0x10ffff, std::little_endian>));
wchar_t c = 0;
for (std::cout << std::showbase << std::hex; fin.get(c);
std::cout << static_cast<std::wint_t>(c) << '\n');
}
Output:
[edit] Defect reportsThe following behavior-changing defect reports were applied retroactively to previously published C++ standards.
DR Applied to Behavior as published Correct behavior LWG 2229 C++98 the constructor and destructor were not specified specifies them [edit] See also converts between character encodings, including UTF-8, UTF-16, UTF-32(C++11)(deprecated in C++17)(removed in C++26)
tags to alter behavior of the standard codecvt facets(C++11)(deprecated in C++17)(removed in C++26)
converts between UTF-8 and UCS-2/UCS-4(C++11)(deprecated in C++17)(removed in C++26)
converts between UTF-8 and UTF-16RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4