stdcodecvt_utf8(3)
std::codecvt_utf8 - std::codecvt_utf8
Synopsis
Defined in header<codecvt>
template <
class Elem, (since C++ 11)
unsigned long Maxcode = 0x10ffff,
(deprecated in C++ 17)
std::codecvt_mode Mode = (std::codecvt_mode)0
>
class codecvt_utf8 : public std::codecvt<Elem, char, std::mbstate_t>;std::codecvt_utf8 is a std::codecvt facet which encapsulates conversion between a UTF-8 encoded byte string and UCS2 or UTF-32 character string (depending on the type of Elem). This codecvt facet can be used to read and write UTF-8 files, both text and binary.
Template Parameters
Elem - either char16_t, char32_t, or wchar_t Maxcode - the largest value of Elem that this facet will read or write without error Mode - a constant of type std::codecvt_mode
Member functions
std::codecvt_utf8::codecvt_utf8
explicit codecvt_utf8( std::size_t refs = 0 );
Constructs a new std::codecvt_utf8 facet, passes the initial reference counter refs to the base class.
Parameters
refs - the number of references that link to the facet
std::codecvt_utf8::~codecvt_utf8
~codecvt_utf8();
Destroys the facet. Unlike the locale-managed facets, this facet’s destructor is public.
Inherited from std::codecvt
Member types
Member type Definition intern_type internT extern_type externT state_type stateT
Member objects
Member name Type id (static) std::locale::id
Member functions
Protected member functions
do_out converts a string from internT to externT, such as when writing to file
do_in converts a string from externT to internT, such as when reading from file
do_unshift generates the termination character sequence of externT characters for incomplete conversion
do_encoding returns the number of externT characters necessary to produce one internT character, if constant
do_always_noconv tests if the facet encodes an identity conversion for all valid argument values
do_length calculates the length of the externT string that would be consumed by conversion into given internT buffer
do_max_length returns the maximum number of externT characters that could be converted into a single internT character
Inherited from std::codecvt_base
Member 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
Notes
Although the standard requires that this facet works with UCS2 when the size of Elem is 16 bits, some implementations use UTF-16 instead. The term "UCS2" was deprecated and removed from the Unicode standard.
Example
The following example demonstrates the difference between UCS2/UTF-8 and UTF-16/UTF-8 conversions: the third character in the string is not a valid UCS2 character. // Run this code
#include <iostream>
#include <string>
#include <locale>
#include <codecvt>
int main()
{
// UTF-8 data. The character U+1d10b, musical sign segno, does not fit in UCS2
std::string utf8 = u8"z\u6c34\U0001d10b";
// the UTF-8 / UTF-16 standard conversion facet
std::wstring_convert<std::codecvt_utf8_utf16<char16_t>, char16_t> utf16conv;
std::u16string utf16 = utf16conv.from_bytes(utf8);
std::cout << "UTF16 conversion produced " << utf16.size() << " code units:\n";
for (char16_t c : utf16)
std::cout << std::hex << std::showbase << c << ‘\n’;
// the UTF-8 / UCS2 standard conversion facet
std::wstring_convert<std::codecvt_utf8<char16_t>, char16_t> ucs2conv;
try {
std::u16string ucs2 = ucs2conv.from_bytes(utf8);
} catch (const std::range_error &e) {
std::u16string ucs2 = ucs2conv.from_bytes(utf8.substr(0, ucs2conv.converted()));
std::cout << "UCS2 failed after producing " << std::dec << ucs2.size() << " characters:\n";
for (char16_t c : ucs2)
std::cout << std::hex << std::showbase << c << ‘\n’;
}
}
Output:
See also
Character locale-defined multibyte UTF-8 UTF-16
conversions (UTF-8, GB18030)