Namensräume
Varianten
Aktionen

mbrtoc16

Von cppreference.com
< c‎ | string‎ | multibyte
Definiert im Header <uchar.h>
size_t mbrtoc16( char16_t* restrict pc16, const char* restrict s,
                 size_t n, mbstate_t* restrict ps );
(seit C11)

Konvertiert einen einzelnen Codepunkt von seiner schmalen Mehrbyte-Zeichen-Repräsentation in seine Variable-Längen-16-Bit-Breitzeichen-Repräsentation (typischerweise UTF-16).

Wenn s kein Null-Zeiger ist, werden höchstens n Bytes des Mehrbyte-Zeichen-Strings inspiziert, beginnend mit dem Byte, auf das s zeigt, um die Anzahl der Bytes zu bestimmen, die zum Vervollständigen des nächsten Mehrbyte-Zeichens erforderlich sind (einschließlich aller Verschiebesequenzen und unter Berücksichtigung des aktuellen Mehrbyte-Konvertierungszustands *ps). Wenn die Funktion feststellt, dass das nächste Mehrbyte-Zeichen in s vollständig und gültig ist, wird es in das entsprechende 16-Bit-Breitzeichen konvertiert und in *pc16 gespeichert (wenn pc16 nicht null ist).

Wenn das Mehrbyte-Zeichen in *s einer Mehrfach-char16_t-Sequenz entspricht (z. B. ein Ersatzpaar in UTF-16), dann wird nach dem ersten Aufruf dieser Funktion *ps so aktualisiert, dass der nächste Aufruf von mbrtoc16 das zusätzliche char16_t ausgibt, ohne *s zu berücksichtigen.

Wenn s ein Null-Zeiger ist, werden die Werte von n und pc16 ignoriert und der Aufruf ist äquivalent zu mbrtoc16(NULL, "", 1, ps).

Wenn das erzeugte breite Zeichen das Nullzeichen ist, repräsentiert der Konvertierungszustand *ps den initialen Verschiebezustand.

Wenn das Makro __STDC_UTF_16__ definiert ist, ist die von dieser Funktion verwendete 16-Bit-Kodierung UTF-16; andernfalls ist sie implementierungsabhängig. Das Makro ist immer definiert und die Kodierung ist immer UTF-16.(seit C23) In jedem Fall wird die von dieser Funktion verwendete Mehrbyte-Zeichen-Kodierung durch die aktuell aktive C-Locale bestimmt.

Inhalt

[bearbeiten] Parameter

pc16 - Zeiger auf die Speicherstelle, an der das resultierende 16-Bit-Breitzeichen geschrieben wird
s - Zeiger auf den Mehrbyte-Zeichenstring, der als Eingabe verwendet wird
n - Grenze für die Anzahl der Bytes in s, die untersucht werden können
ps - Zeiger auf das Konvertierungszustandsobjekt, das bei der Interpretation des Multibyte-Strings verwendet wird

[bearbeiten] Rückgabewert

Das erste der folgenden zutreffenden Elemente

  • 0, wenn das aus s konvertierte Zeichen (und falls nicht null in *pc16 gespeichert) das Nullzeichen war.
  • Die Anzahl der Bytes [1n] des erfolgreich aus s konvertierten Mehrbyte-Zeichens.
  • (size_t)-3, wenn das nächste char16_t aus einem Mehrfach-char16_t-Zeichen (z. B. ein Ersatzpaar) jetzt in *pc16 geschrieben wurde. In diesem Fall werden keine Bytes aus der Eingabe verarbeitet.
  • (size_t)-2, wenn die nächsten n Bytes ein unvollständiges, aber bisher gültiges, Mehrbyte-Zeichen darstellen. Nichts wird in *pc16 geschrieben.
  • (size_t)-1, wenn ein Kodierungsfehler auftritt. Nichts wird in *pc16 geschrieben, der Wert EILSEQ wird in errno gespeichert und der Wert von *ps ist nicht spezifiziert.

[bearbeiten] Beispiel

Unter MSVC benötigen Sie möglicherweise das Compiler-Flag /utf-8, damit UTF_8 korrekt funktioniert.

#include <locale.h>
#include <stdio.h>
#include <uchar.h>
 
int main(void)
{
    setlocale(LC_ALL, "en_US.utf8");
    const char in[] = u8"zß水🍌"; // or "z\u00df\u6c34\U0001F34C"
    enum { in_sz = sizeof in / sizeof *in };
 
    printf("Processing %d UTF-8 code units: [", in_sz);
    for (int n = 0; n < in_sz; ++n)
        printf("%s%02X", n ? " " : "", (unsigned char)in[n]);
    puts("]");
 
    char16_t out[in_sz];
    const char* p_in = in;
    const char* end = in + in_sz;
    char16_t* p_out = out;
    mbstate_t state = {0};
 
    for (size_t rc; (rc = mbrtoc16(p_out, p_in, end - p_in, &state));)
    {
        if (rc == (size_t)-1)     // invalid input
            break;
        else if(rc == (size_t)-2) // truncated input
            break;
        else if(rc == (size_t)-3) // UTF-16 high surrogate
            p_out += 1;
        else
        {
            p_in += rc;
            p_out += 1;
        };
    }
 
    const size_t out_sz = p_out - out + 1;
    printf("into %zu UTF-16 code units: [", out_sz);
    for (size_t x = 0; x < out_sz; ++x)
        printf("%s%04X", x ? " " : "", out[x]);
    puts("]");
}

Ausgabe

Processing 11 UTF-8 code units: [7A C3 9F E6 B0 B4 F0 9F 8D 8C 00]
into 6 UTF-16 code units: [007A 00DF 6C34 D83C DF4C 0000]

[bearbeiten] Referenzen

  • C23-Standard (ISO/IEC 9899:2024)
  • 7.30.1.3 Die Funktion mbrtoc16 (S. 408-409)
  • C11-Standard (ISO/IEC 9899:2011)
  • 7.28.1.1 Die Funktion mbrtoc16 (S. 398-399)

[bearbeiten] Siehe auch

konvertiert ein UTF-16-Zeichen in eine schmale Multibyte-Kodierung
(Funktion) [bearbeiten]
C++ Dokumentation für mbrtoc16