Namespaces
Variants

std:: codecvt_utf8

From cppreference.net
C++
Text processing library
Localization library
Défini dans l'en-tête <codecvt>
template <

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

: public std:: codecvt < Elem, char , std:: mbstate_t > ;
(depuis C++11)
(obsolète en C++17)
(supprimé en C++26)

std::codecvt_utf8 est une facette std::codecvt qui encapsule la conversion entre une chaîne d'octets encodée en UTF-8 et une chaîne de caractères UCS-2 ou UTF-32 (selon le type de Elem ). Cette facette std::codecvt peut être utilisée pour lire et écrire des fichiers UTF-8, à la fois texte et binaires.

UCS-2 est un encodage archaïque qui est un sous-ensemble de UTF-16, lequel encode uniquement les valeurs scalaires dans la plage U+0000-U+FFFF (Plan Multilingue de Base).

Table des matières

Paramètres du Modèle

Elem - soit char16_t , char32_t , ou wchar_t
Maxcode - la plus grande valeur de Elem que ce facet lira ou écrira sans erreur
Mode - une constante de type std::codecvt_mode

Fonctions membres

(constructeur)
construit une nouvelle facette codecvt_utf8
(fonction membre publique)
(destructeur)
détruit une facette codecvt_utf8
(fonction membre publique)

std::codecvt_utf8:: codecvt_utf8

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

Construit un nouveau facet std::codecvt_utf8 , transmet le compteur de références initial refs à la classe de base.

Paramètres

refs - le nombre de références liées au facet

std::codecvt_utf8:: ~codecvt_utf8

~codecvt_utf8 ( ) ;

Détruit le facet. Contrairement aux facets gérés par les locales, le destructeur de ce facet est public.

Hérité de std:: codecvt

Types imbriqués

Type Définition
intern_type internT
extern_type externT
state_type stateT

Membres de données

Membre Description
std::locale::id id [static] l'identifiant du facet

Fonctions membres

appelle do_out
(fonction membre publique de std::codecvt<InternT,ExternT,StateT> )
appelle do_in
(fonction membre publique de std::codecvt<InternT,ExternT,StateT> )
appelle do_unshift
(fonction membre publique de std::codecvt<InternT,ExternT,StateT> )
appelle do_encoding
(fonction membre publique de std::codecvt<InternT,ExternT,StateT> )
appelle do_always_noconv
(fonction membre publique de std::codecvt<InternT,ExternT,StateT> )
appelle do_length
(fonction membre publique de std::codecvt<InternT,ExternT,StateT> )
appelle do_max_length
(fonction membre publique de std::codecvt<InternT,ExternT,StateT> )

Fonctions membres protégées

[virtual]
convertit une chaîne de InternT vers ExternT , par exemple lors de l'écriture dans un fichier
(fonction membre protégée virtuelle de std::codecvt<InternT,ExternT,StateT> )
[virtual]
convertit une chaîne de ExternT vers InternT , par exemple lors de la lecture depuis un fichier
(fonction membre protégée virtuelle de std::codecvt<InternT,ExternT,StateT> )
[virtual]
génère la séquence de caractères de terminaison ExternT pour une conversion incomplète
(fonction membre protégée virtuelle de std::codecvt<InternT,ExternT,StateT> )
[virtual]
renvoie le nombre de caractères ExternT nécessaires pour produire un caractère InternT , si constant
(fonction membre protégée virtuelle de std::codecvt<InternT,ExternT,StateT> )
[virtual]
teste si le facet encode une conversion identité pour toutes les valeurs d'argument valides
(fonction membre protégée virtuelle de std::codecvt<InternT,ExternT,StateT> )
[virtual]
calcule la longueur de la chaîne ExternT qui serait consommée par conversion dans le tampon InternT donné
(fonction membre protégée virtuelle de std::codecvt<InternT,ExternT,StateT> )
[virtual]
renvoie le nombre maximum de caractères ExternT qui pourraient être convertis en un seul caractère InternT
(fonction membre protégée virtuelle de std::codecvt<InternT,ExternT,StateT> )

Hérité de std:: codecvt_base

Type imbriqué Définition
enum result { ok, partial, error, noconv } ; Type d'énumération non-scopée
Constante d'énumération Définition
ok la conversion s'est terminée sans erreur
partial tous les caractères source n'ont pas été convertis
error un caractère invalide a été rencontré
noconv aucune conversion nécessaire, les types d'entrée et de sortie sont identiques

Notes

Bien que la norme exige que cette facette fonctionne avec UCS-2 lorsque la taille de Elem est de 16 bits, certaines implémentations utilisent UTF-16 à la place. Le terme "UCS-2" a été déprécié et supprimé de l'ISO 10646.

Exemple

L'exemple suivant démontre la différence entre les conversions UCS-2/UTF-8 et UTF-16/UTF-8 : le troisième caractère de la chaîne n'est pas un caractère UCS-2 valide.

Exécuter ce code 
#include <codecvt>
#include <cstdint>
#include <iostream>
#include <locale>
#include <string>
int main()
{
    // UTF-8 data. The character U+1d10b, musical sign segno, does not fit in UCS-2
    std::string utf8 = "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 << "UTF-16 conversion produced " << utf16.size() << " code units:\n"
              << std::showbase << std::hex;
    for (char16_t c : utf16)
        std::cout << static_cast<std::uint16_t>(c) << ' ';
    // the UTF-8 / UCS-2 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 << "\nUCS-2 failed after producing " << std::dec << ucs2.size()
                  << " characters:\n" << std::showbase << std::hex;
        for (char16_t c : ucs2)
            std::cout << static_cast<std::uint16_t>(c) << ' ';
        std::cout << '\n';
    }
}

Sortie : 

UTF-16 conversion produced 4 code units:
0x7a 0x6c34 0xd834 0xdd0b
UCS-2 failed after producing 2 characters:
0x7a 0x6c34

Rapports de défauts

Les rapports de défauts modifiant le comportement suivants ont été appliqués rétroactivement aux normes C++ précédemment publiées.

DR Appliqué à Comportement publié Comportement corrigé
LWG 2229 C++98 le constructeur et le destructeur n'étaient pas spécifiés les spécifie

Voir aussi

Conversions de caractères
Multioctets définis par les paramètres régionaux
(UTF-8, GB18030) 		UTF-8
UTF-16
UTF-16 mbrtoc16 / c16rtomb (avec DR488 de C11)

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 (sans DR488 de C11) 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 >

système 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 >
convertit entre les encodages de caractères, y compris UTF-8, UTF-16, UTF-32
(modèle de classe)
(C++11) (obsolète en C++17) (supprimé en C++26)
balises pour modifier le comportement des facettes codecvt standard
(énumération)
(C++11) (obsolète en C++17) (supprimé en C++26)
convertit entre UTF-16 et UCS-2/UCS-4
(modèle de classe)
(C++11) (obsolète en C++17) (supprimé en C++26)
convertit entre UTF-8 et UTF-16
(modèle de classe)