Namensräume
Varianten
Aktionen

std::codecvt_utf16

Von cppreference.com
< cpp‎ | locale
 
 
 
 
Definiert in Header <codecvt>
template<

    class Elem,
    unsigned long Maxcode = 0x10ffff,
    std::codecvt_mode Mode = (std::codecvt_mode)0 >
class codecvt_utf16

    : public std::codecvt<Elem, char, std::mbstate_t>;
(seit C++11)
(veraltet in C++17)
(entfernt in C++26)

std::codefmt_utf16 ist ein std::codecvt Facette, das die Konvertierung zwischen einem UTF-16-kodierten Byte-String und einer UCS-2- oder UTF-32-Zeichenkette (abhängig vom Typ von Elem) kapselt. Diese std::codecvt Facette kann verwendet werden, um UTF-16-Dateien im Binärmodus zu lesen und zu schreiben.

UCS-2 ist eine archaische Kodierung, die eine Teilmenge von UTF-16 ist und nur Skalarwerte im Bereich U+0000-U+FFFF (Basic Multilingual Plane) kodiert.

Inhalt

[bearbeiten] Template-Parameter

Elem - entweder char16_t, char32_t oder wchar_t
Maxcode - der größte Wert von Elem, den diese Facette ohne Fehler lesen oder schreiben wird
Mode - eine Konstante vom Typ std::codecvt_mode

[bearbeiten] Member-Funktionen

(Konstruktor)
erzeugt eine neue codecvt_utf16 Facette
(öffentliche Memberfunktion)
(Destruktor)
zerstört eine codecvt_utf16 Facette
(öffentliche Memberfunktion)

std::codecvt_utf16::codecvt_utf16

explicit codecvt_utf16( std::size_t refs = 0 );

Konstruiert eine neue std::codecvt_utf16 Facette und übergibt den anfänglichen Referenzzähler refs an die Basisklasse.

Parameter

refs - die Anzahl der Referenzen, die auf die Facettenklasse verweisen

std::codecvt_utf16::~codecvt_utf16

~codecvt_utf16();

Zerstört die Facette. Im Gegensatz zu den locale-verwalteten Facetten ist der Destruktor dieser Facette öffentlich.

Abgeleitet von std::codecvt

Verschachtelte Typen

Typ Definition
intern_type internT
extern_type externT
state_type stateT

[edit] Datenmember

Mitglied Beschreibung
std::locale::id id [static] die Kennung des Facets

Memberfunktionen

ruft do_out auf
(public member function of std::codecvt<InternT,ExternT,StateT>) [edit]
ruft do_in auf
(public member function of std::codecvt<InternT,ExternT,StateT>) [edit]
ruft do_unshift auf
(public member function of std::codecvt<InternT,ExternT,StateT>) [edit]
ruft do_encoding auf
(public member function of std::codecvt<InternT,ExternT,StateT>) [edit]
ruft do_always_noconv auf
(public member function of std::codecvt<InternT,ExternT,StateT>) [edit]
ruft do_length auf
(public member function of std::codecvt<InternT,ExternT,StateT>) [edit]
ruft do_max_length auf
(public member function of std::codecvt<InternT,ExternT,StateT>) [edit]

Geschützte Memberfunktionen

[virtuell]
konvertiert eine Zeichenkette von InternT nach ExternT, z. B. beim Schreiben in eine Datei
(virtual protected member function of std::codecvt<InternT,ExternT,StateT>) [edit]
[virtuell]
konvertiert eine Zeichenkette von ExternT nach InternT, z. B. beim Lesen aus einer Datei
(virtual protected member function of std::codecvt<InternT,ExternT,StateT>) [edit]
[virtuell]
erzeugt die Abschlusszeichenfolge von ExternT-Zeichen für eine unvollständige Konvertierung
(virtual protected member function of std::codecvt<InternT,ExternT,StateT>) [edit]
[virtuell]
gibt die Anzahl der ExternT-Zeichen zurück, die zur Erzeugung eines InternT-Zeichens erforderlich sind, falls diese konstant ist
(virtual protected member function of std::codecvt<InternT,ExternT,StateT>) [edit]
prüft, ob das Facet eine Identitätskonvertierung für alle gültigen Argumentwerte kodiert
(virtual protected member function of std::codecvt<InternT,ExternT,StateT>) [edit]
[virtuell]
berechnet die Länge der ExternT-Zeichenkette, die bei der Konvertierung in den gegebenen InternT-Puffer verbraucht würde
(virtual protected member function of std::codecvt<InternT,ExternT,StateT>) [edit]
[virtuell]
gibt die maximale Anzahl von ExternT-Zeichen zurück, die in ein einzelnes InternT-Zeichen konvertiert werden könnten
(virtual protected member function of std::codecvt<InternT,ExternT,StateT>) [edit]

Geerbt von std::codecvt_base

Verschachtelter Typ Definition
enum result { ok, partial, error, noconv }; Aufzählungstyp ohne Gültigkeitsbereich
Enumerationskonstante Definition
ok Die Konvertierung wurde ohne Fehler abgeschlossen.
partiell Nicht alle Quellzeichen wurden konvertiert.
error Ungültiges Zeichen angetroffen.
noconv Keine Konvertierung erforderlich, Eingabe- und Ausgabetypen sind identisch.

[bearbeiten] Hinweise

Obwohl der Standard verlangt, dass diese Facette mit UCS-2 funktioniert, wenn die Größe von Elem 16 Bits beträgt, verwenden einige Implementierungen stattdessen UTF-16, was dies zu einer nicht-konvertierenden Locale macht. Der Begriff "UCS-2" wurde als veraltet eingestuft und aus ISO 10646 entfernt.

[bearbeiten] Beispiel

Das folgende Beispiel demonstriert die Dekodierung einer UTF-16le-Datei auf einem System mit 32-Bit wchar_t. Auf einem System mit 16-Bit wchar_t schlägt die Dekodierung des dritten Zeichens fehl, da std::codecvt_utf16<char16_t> UCS-2 und nicht UTF-16 erzeugt.

#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');
}

Ausgabe

0x7a
0x6c34
0x1d10b

[bearbeiten] Fehlerberichte

Die folgenden Verhaltensändernden Fehlerberichte wurden rückwirkend auf zuvor veröffentlichte C++-Standards angewendet.

DR angewendet auf Verhalten wie veröffentlicht Korrigiertes Verhalten
LWG 2229 C++98 der Konstruktor und Destruktor waren nicht spezifiziert spezifiziert sie

[bearbeiten] Siehe auch

Zeichen
Konvertierungen
lokal definierte Multibyte-Zeichen
(UTF-8, GB18030)
UTF-8
UTF-16
UTF-16 mbrtoc16 / c16rtomb (mit C11 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 (ohne C11 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>
konvertiert zwischen Zeichenkodierungen, einschließlich UTF-8, UTF-16, UTF-32
(Klassentemplate) [bearbeiten]
(C++11)(deprecated in C++17)(removed in C++26)
Tags zur Änderung des Verhaltens der Standard-Codecvt-Facetten
(Enum) [bearbeiten]
(C++11)(deprecated in C++17)(removed in C++26)
konvertiert zwischen UTF-8 und UCS-2/UCS-4
(Klassentemplate) [bearbeiten]
(C++11)(deprecated in C++17)(removed in C++26)
konvertiert zwischen UTF-8 und UTF-16
(Klassentemplate) [bearbeiten]