Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/locale/codecvt"

From cppreference.com
< cpp‎ | locale
m (templated codecvt_base inheirt)
(Added LWG issue #3767 DR.)
 
(47 intermediate revisions by 16 users not shown)
Line 1: Line 1:
{{cpp/title | codecvt}}
+
{{cpp/title|codecvt}}
{{cpp/locale/codecvt/sidebar}}
+
{{cpp/locale/codecvt/navbar}}
{{ddcl list begin}}
+
{{ddcl|header=locale|
{{ddcl list header | locale}}
+
template<  
{{ddcl list item | 1=
+
    class InternT,  
template< class internT, class externT, class stateT >
+
    class ExternT,  
class codecvt : public std::locale::facet, public std::codecvt_base;;
+
    class StateT
 +
> class codecvt;
 
}}
 
}}
{{ddcl list end}}
 
  
Class {{cpp|std::codecvt}} encapsulates conversion of character strings, including wide and multibyte, from one encoding to another. All file I/O operations performed through {{cpp|std::basic_fstream<CharT>}} use the {{cpp|std::codecvt<CharT, char, std::mbstate_t>}} facet of the locale imbued in the stream.
+
Class template {{tt|std::codecvt}} encapsulates conversion of character strings, including wide and multibyte, from one encoding to another. All file I/O operations performed through {{c/core|std::basic_fstream<CharT>}} use the {{c/core|std::codecvt<CharT, char, std::mbstate_t>}} facet of the locale imbued in the stream.
  
Four specializations are provided by the standard library and are implemented by all locale objects created in a C++ program:
+
{{inheritance diagram/std-codecvt}}
  
{{tdcl list begin}}
+
===Specializations===
{{tdcl list header | locale }}
+
The standard library is guaranteed to provide the following specializations (they are {{rlp|locale|required to be implemented by any locale object}}):
{{tdcl list item | {{cpp|std::codecvt<char, char, std::mbstate_t>}} | identity conversion }}
+
{{dsc begin}}
{{tdcl list item | {{cpp|std::codecvt<char16_t, char, std::mbstate_t>}} | conversion between UTF-16 and UTF-8 {{mark c++11 feature}}}}
+
{{dsc header|locale}}
{{tdcl list item | {{cpp|std::codecvt<char32_t, char, std::mbstate_t>}} | conversion between UTF-32 and UTF-8 {{mark c++11 feature}}}}
+
{{dsc|{{c/core|std::codecvt<char, char, std::mbstate_t>}}|identity conversion}}
{{tdcl list item | {{cpp|std::codecvt<wchar_t, char, std::mbstate_t>}} | locale-specific conversion between wide string and narrow, possibly multibyte, string}}
+
{{dsc|{{c/core|std::codecvt<char16_t, char, std::mbstate_t>}}<br>{{mark life|since=c++11|deprecated=c++20}}|conversion between UTF-16 and UTF-8}}
{{tdcl list end}}
+
{{dsc|{{c/core|std::codecvt<char16_t, char8_t, std::mbstate_t>}}<br>{{mark since c++20}}{{mark deprecated}}|conversion between UTF-16 and UTF-8}}
 +
{{dsc|{{c/core|std::codecvt<char32_t, char, std::mbstate_t>}}<br>{{mark life|since=c++11|deprecated=c++20}}|conversion between UTF-32 and UTF-8}}
 +
{{dsc|{{c/core|std::codecvt<char32_t, char8_t, std::mbstate_t>}}<br>{{mark since c++20}}{{mark deprecated}}|conversion between UTF-32 and UTF-8}}
 +
{{dsc|{{c/core|std::codecvt<wchar_t, char, std::mbstate_t>}}|conversion between the system's native wide and the single-byte narrow character sets}}
 +
{{dsc end}}
  
 
===Member types===
 
===Member types===
{{tdcl list begin}}
+
{{dsc begin}}
{{tdcl list hitem | Member type | Definition}}
+
{{dsc hitem|Member name|Definition}}
{{tdcl list item | {{tt|intern_type}} | {{tt|internT}}}}
+
{{dsc|{{tt|intern_type}}|{{tt|InternT}}}}
{{tdcl list item | {{tt|extern_type}} | {{tt|externT}}}}
+
{{dsc|{{tt|extern_type}}|{{tt|ExternT}}}}
{{tdcl list item | {{tt|state_type}} | {{tt|stateT}}}}
+
{{dsc|{{tt|state_type}}|{{tt|StateT}}}}
{{tdcl list end}}
+
{{dsc end}}
 
+
===Member objects===
+
{{tdcl list begin}}
+
{{tdcl list hitem | Member name | Type}}
+
{{tdcl list item | {{tt|id}} {{mark|static}} | {{cpp|std::locale::id}} }}
+
{{tdcl list end}}
+
  
 
===Member functions===
 
===Member functions===
{{dcl list begin}}
+
{{dsc begin}}
{{dcl list mem ctor | cpp/locale/codecvt/codecvt | constructs a new codecvt facet }}
+
{{dsc mem ctor|cpp/locale/codecvt/codecvt|constructs a new codecvt facet}}
{{dcl list prot mem dtor | cpp/locale/codecvt/~codecvt | destructs a codecvt facet }}
+
{{dsc inc|cpp/locale/codecvt/dsc out}}
{{dcl list mem fun | cpp/locale/codecvt/do_out | title=out | invokes {{tt|do_out}} }}
+
{{dsc inc|cpp/locale/codecvt/dsc in}}
{{dcl list mem fun | cpp/locale/codecvt/do_in | title=in | invokes {{tt|do_in}} }}
+
{{dsc inc|cpp/locale/codecvt/dsc unshift}}
{{dcl list mem fun | cpp/locale/codecvt/do_unshift | title=unshift | invokes {{tt|do_unshift}} }}
+
{{dsc inc|cpp/locale/codecvt/dsc encoding}}
{{dcl list mem fun | cpp/locale/codecvt/do_encoding | title=encoding | invokes {{tt|do_encoding}} }}
+
{{dsc inc|cpp/locale/codecvt/dsc always_noconv}}
{{dcl list mem fun | cpp/locale/codecvt/do_always_noconv | title=always_noconv | invokes {{tt|do_always_noconv}} }}
+
{{dsc inc|cpp/locale/codecvt/dsc length}}
{{dcl list mem fun | cpp/locale/codecvt/do_length | title=length | invokes {{tt|do_length}} }}
+
{{dsc inc|cpp/locale/codecvt/dsc max_length}}
{{dcl list mem fun | cpp/locale/codecvt/do_max_length | title=max_length | invokes {{tt|do_max_length}} }}
+
{{dsc end}}
{{dcl list end}}
+
 
 +
===Member objects===
 +
{{dsc begin}}
 +
{{dsc mem obj|nolink=true|{{dsc small|static std::locale::id}} id|''id'' of the locale}}
 +
{{dsc end}}
  
 
===Protected member functions===
 
===Protected member functions===
{{dcl list begin}}
+
{{dsc begin}}
{{dcl list prot mem vfun | cpp/locale/codecvt/do_out | converts a string from internT to externT, such as when writing to file}}
+
{{dsc prot mem dtor|cpp/locale/codecvt/~codecvt|destructs a codecvt facet}}
{{dcl list prot mem vfun | cpp/locale/codecvt/do_in | converts a string from externT to internT, such as when reading from file}}
+
{{dsc inc|cpp/locale/codecvt/dsc do_out}}
{{dcl list prot mem vfun | cpp/locale/codecvt/do_unshift | generates the termination character sequence of externT characters for incomplete conversion}}
+
{{dsc inc|cpp/locale/codecvt/dsc do_in}}
{{dcl list prot mem vfun | cpp/locale/codecvt/do_encoding | returns the number of externT characters necessary to produce one internT character, if constant}}
+
{{dsc inc|cpp/locale/codecvt/dsc do_unshift}}
{{dcl list prot mem vfun | cpp/locale/codecvt/do_always_noconv | tests if the facet encodes an identity conversion for all valid argument values }}
+
{{dsc inc|cpp/locale/codecvt/dsc do_encoding}}
{{dcl list prot mem vfun | cpp/locale/codecvt/do_length | calculates the length of the externT string that would be consumed by conversion into given internT buffer}}
+
{{dsc inc|cpp/locale/codecvt/dsc do_always_noconv}}
{{dcl list prot mem vfun | cpp/locale/codecvt/do_max_length | returns the maximum number of externT characters that could be converted into a single internT character}}
+
{{dsc inc|cpp/locale/codecvt/dsc do_length}}
{{dcl list end}}
+
{{dsc inc|cpp/locale/codecvt/dsc do_max_length}}
 +
{{dsc end}}
  
 
{{cpp/locale/codecvt_base/inherit}}
 
{{cpp/locale/codecvt_base/inherit}}
  
 
===Example===
 
===Example===
 
+
{{example
{{example cpp
+
|The following examples reads a UTF-8 file using a locale which implements UTF-8 conversion in {{c/core|codecvt<wchar_t, char, std::mbstate_t>}} and converts a UTF-8 string to UTF-16 using one of the standard specializations of {{tt|std::codecvt}}.
| The following examples reads a UTF-8 file using a locale which implements UTF-8 conversion in codecvt<wchar_t, char, mbstate_t>
+
|code=
| code=
+
#include <codecvt>
#include <iostream>
+
#include <cstdint>
 
#include <fstream>
 
#include <fstream>
#include <string>
 
#include <locale>
 
 
#include <iomanip>
 
#include <iomanip>
 +
#include <iostream>
 +
#include <locale>
 +
#include <string>
 +
 +
// utility wrapper to adapt locale-bound facets for wstring/wbuffer convert
 +
template<class Facet>
 +
struct deletable_facet : Facet
 +
{
 +
    template<class... Args>
 +
    deletable_facet(Args&&... args) : Facet(std::forward<Args>(args)...) {}
 +
    ~deletable_facet() {}
 +
};
 +
 
int main()
 
int main()
 
{
 
{
 
     // UTF-8 narrow multibyte encoding
 
     // UTF-8 narrow multibyte encoding
     std::ofstream("text.txt") << u8"z\u00df\u6c34\U0001d10b"; // or u8"zß水𝄋"
+
     std::string data = reinterpret_cast<const char*>(+u8"z\u00df\u6c34\U0001f34c");
                                          // or "\x7a\xc3\x9f\xe6\xb0\xb4\xf0\x9d\x84\x8b";
+
                      // or reinterpret_cast<const char*>(+u8"zß水🍌")
 +
                      // or "\x7a\xc3\x9f\xe6\xb0\xb4\xf0\x9f\x8d\x8c"
 +
   
 +
    std::ofstream("text.txt") << data;
 +
   
 +
    // using system-supplied locale's codecvt facet
 
     std::wifstream fin("text.txt");
 
     std::wifstream fin("text.txt");
     fin.imbue(std::locale("en_US.UTF-8")); // this locale's codecvt<wchar_t, char, mbstate_t>
+
     // reading from wifstream will use codecvt<wchar_t, char, std::mbstate_t>
                                          // converts UTF-8 to UCS4
+
    // this locale's codecvt converts UTF-8 to UCS4 (on systems such as Linux)
     std::cout << "The UTF-8 file contains the following wide characters: \n";
+
    fin.imbue(std::locale("en_US.UTF-8"));
     for(wchar_t c; fin >> c; )
+
     std::cout << "The UTF-8 file contains the following UCS4 code units:\n" << std::hex;
         std::cout << "U+" << std::hex << std::setw(4) << std::setfill('0') << c << '\n';
+
     for (wchar_t c; fin >> c;)
 +
         std::cout << "U+" << std::setw(4) << std::setfill('0')
 +
                  << static_cast<uint32_t>(c) << ' ';
 +
   
 +
    // using standard (locale-independent) codecvt facet
 +
    std::wstring_convert<
 +
        deletable_facet<std::codecvt<char16_t, char, std::mbstate_t>>, char16_t> conv16;
 +
    std::u16string str16 = conv16.from_bytes(data);
 +
   
 +
    std::cout << "\n\nThe UTF-8 file contains the following UTF-16 code units:\n"
 +
              << std::hex;
 +
    for (char16_t c : str16)
 +
        std::cout << "U+" << std::setw(4) << std::setfill('0')
 +
                  << static_cast<uint16_t>(c) << ' ';
 +
    std::cout << '\n';
 
}
 
}
| output=
+
|output=
The UTF-8 file contains the following wide characters:
+
The UTF-8 file contains the following UCS4 code units:
U+007a
+
U+007a U+00df U+6c34 U+1f34c
U+00df
+
 
U+6c34
+
The UTF-8 file contains the following UTF-16 code units:
U+1d10b
+
U+007a U+00df U+6c34 U+d83c U+df4c
 
}}
 
}}
 +
 +
===Defect reports===
 +
{{dr list begin}}
 +
{{dr list item|wg=lwg|dr=3767|std=C++20|before={{c/core|std::codecvt<char16_t, char8_t, std::mbstate_t>}} and<br>{{c/core|std::codecvt<char32_t, char8_t, std::mbstate_t>}} are locale-independent|after=deprecated them}}
 +
{{dr list end}}
  
 
===See also===
 
===See also===
 
{{cpp/locale/unicode string conversions}}
 
{{cpp/locale/unicode string conversions}}
{{dcl list begin}}
+
{{dsc begin}}
{{dcl list tclass | cpp/locale/codecvt_base | defines character conversion errors }}
+
{{dsc inc|cpp/locale/dsc codecvt_base}}
{{dcl list tclass | cpp/locale/codecvt_byname | creates a codecvt facet for the named locale }}
+
{{dsc inc|cpp/locale/dsc codecvt_byname}}
{{dcl list template | cpp/locale/dcl list codecvt_utf8}}
+
{{dsc inc|cpp/locale/dsc codecvt_utf8}}
{{dcl list template | cpp/locale/dcl list codecvt_utf16}}
+
{{dsc inc|cpp/locale/dsc codecvt_utf16}}
{{dcl list template | cpp/locale/dcl list codecvt_utf8_utf16}}
+
{{dsc inc|cpp/locale/dsc codecvt_utf8_utf16}}
{{dcl list end}}
+
{{dsc end}}
 +
 
 +
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}

Latest revision as of 23:12, 27 June 2024

 
 
 
 
Defined in header <locale>
template<

    class InternT,
    class ExternT,
    class StateT

> class codecvt;

Class template std::codecvt encapsulates conversion of character strings, including wide and multibyte, from one encoding to another. All file I/O operations performed through std::basic_fstream<CharT> use the std::codecvt<CharT, char, std::mbstate_t> facet of the locale imbued in the stream.

cpp/locale/codecvt basecpp/locale/locale/facetstd-codecvt-inheritance.svg

Inheritance diagram

Contents

[edit] Specializations

The standard library is guaranteed to provide the following specializations (they are required to be implemented by any locale object):

Defined in header <locale>
std::codecvt<char, char, std::mbstate_t> identity conversion
std::codecvt<char16_t, char, std::mbstate_t>
(since C++11)(deprecated in C++20)
conversion between UTF-16 and UTF-8
std::codecvt<char16_t, char8_t, std::mbstate_t>
(since C++20)(deprecated)
conversion between UTF-16 and UTF-8
std::codecvt<char32_t, char, std::mbstate_t>
(since C++11)(deprecated in C++20)
conversion between UTF-32 and UTF-8
std::codecvt<char32_t, char8_t, std::mbstate_t>
(since C++20)(deprecated)
conversion between UTF-32 and UTF-8
std::codecvt<wchar_t, char, std::mbstate_t> conversion between the system's native wide and the single-byte narrow character sets

[edit] Member types

Member name Definition
intern_type InternT
extern_type ExternT
state_type StateT

[edit] Member functions

constructs a new codecvt facet
(public member function)
invokes do_out
(public member function) [edit]
invokes do_in
(public member function) [edit]
invokes do_unshift
(public member function) [edit]
invokes do_encoding
(public member function) [edit]
invokes do_always_noconv
(public member function) [edit]
invokes do_length
(public member function) [edit]
invokes do_max_length
(public member function) [edit]

[edit] Member objects

static std::locale::id id
id of the locale
(public member object)

[edit] Protected member functions

destructs a codecvt facet
(protected member function)
[virtual]
converts a string from InternT to ExternT, such as when writing to file
(virtual protected member function) [edit]
[virtual]
converts a string from ExternT to InternT, such as when reading from file
(virtual protected member function) [edit]
[virtual]
generates the termination character sequence of ExternT characters for incomplete conversion
(virtual protected member function) [edit]
[virtual]
returns the number of ExternT characters necessary to produce one InternT character, if constant
(virtual protected member function) [edit]
tests if the facet encodes an identity conversion for all valid argument values
(virtual protected member function) [edit]
[virtual]
calculates the length of the ExternT string that would be consumed by conversion into given InternT buffer
(virtual protected member function) [edit]
returns the maximum number of ExternT characters that could be converted into a single InternT character
(virtual protected member function) [edit]

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

[edit] Example

The following examples reads a UTF-8 file using a locale which implements UTF-8 conversion in codecvt<wchar_t, char, std::mbstate_t> and converts a UTF-8 string to UTF-16 using one of the standard specializations of std::codecvt.

#include <codecvt>
#include <cstdint>
#include <fstream>
#include <iomanip>
#include <iostream>
#include <locale>
#include <string>
 
// utility wrapper to adapt locale-bound facets for wstring/wbuffer convert
template<class Facet>
struct deletable_facet : Facet
{
    template<class... Args>
    deletable_facet(Args&&... args) : Facet(std::forward<Args>(args)...) {}
    ~deletable_facet() {}
};
 
int main()
{
    // UTF-8 narrow multibyte encoding
    std::string data = reinterpret_cast<const char*>(+u8"z\u00df\u6c34\U0001f34c");
                       // or reinterpret_cast<const char*>(+u8"zß水🍌")
                       // or "\x7a\xc3\x9f\xe6\xb0\xb4\xf0\x9f\x8d\x8c"
 
    std::ofstream("text.txt") << data;
 
    // using system-supplied locale's codecvt facet
    std::wifstream fin("text.txt");
    // reading from wifstream will use codecvt<wchar_t, char, std::mbstate_t>
    // this locale's codecvt converts UTF-8 to UCS4 (on systems such as Linux)
    fin.imbue(std::locale("en_US.UTF-8"));
    std::cout << "The UTF-8 file contains the following UCS4 code units:\n" << std::hex;
    for (wchar_t c; fin >> c;)
        std::cout << "U+" << std::setw(4) << std::setfill('0')
                  << static_cast<uint32_t>(c) << ' ';
 
    // using standard (locale-independent) codecvt facet
    std::wstring_convert<
        deletable_facet<std::codecvt<char16_t, char, std::mbstate_t>>, char16_t> conv16;
    std::u16string str16 = conv16.from_bytes(data);
 
    std::cout << "\n\nThe UTF-8 file contains the following UTF-16 code units:\n"
              << std::hex;
    for (char16_t c : str16)
        std::cout << "U+" << std::setw(4) << std::setfill('0')
                  << static_cast<uint16_t>(c) << ' ';
    std::cout << '\n';
}

Output:

The UTF-8 file contains the following UCS4 code units:
U+007a U+00df U+6c34 U+1f34c 
 
The UTF-8 file contains the following UTF-16 code units:
U+007a U+00df U+6c34 U+d83c U+df4c

[edit] Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

DR Applied to Behavior as published Correct behavior
LWG 3767 C++20 std::codecvt<char16_t, char8_t, std::mbstate_t> and
std::codecvt<char32_t, char8_t, std::mbstate_t> are locale-independent
deprecated them

[edit] See also

Character
conversions
locale-defined multibyte
(UTF-8, GB18030)
UTF-8
UTF-16
UTF-16 mbrtoc16 / c16rtomb (with C11's DR488)

codecvt<char16_t,char,mbstate_t>
codecvt_utf8_utf16<char16_t>
codecvt_utf8_utf16<char32_t>
codecvt_utf8_utf16<wchar_t>

N/A
UCS-2 c16rtomb (without C11's DR488) codecvt_utf8<char16_t> codecvt_utf16<char16_t>
UTF-32

mbrtoc32 / c32rtomb

codecvt<char32_t,char,mbstate_t>
codecvt_utf8<char32_t>

codecvt_utf16<char32_t>

system wchar_t:

UTF-32 (non-Windows)
UCS-2 (Windows)

mbsrtowcs / wcsrtombs
use_facet<codecvt
<wchar_t,char,mbstate_t>>(locale)

codecvt_utf8<wchar_t> codecvt_utf16<wchar_t>
defines character conversion errors
(class) [edit]
represents the system-supplied std::codecvt for the named locale
(class template) [edit]
(C++11)(deprecated in C++17)(removed in C++26)
converts between UTF-8 and UCS-2/UCS-4
(class template) [edit]
(C++11)(deprecated in C++17)(removed in C++26)
converts between UTF-16 and UCS-2/UCS-4
(class template) [edit]
(C++11)(deprecated in C++17)(removed in C++26)
converts between UTF-8 and UTF-16
(class template) [edit]