Tcl_UtfToNormalized(3)

NAME
Tcl_UtfToNormalized, Tcl_UtfToNormalizedDString - procedures for Unicode normalization

SYNOPSIS
#include <tcl.h>

int
Tcl_UtfToNormalized(interp, src, numBytes, normForm, profile, dst, dstLen, dstWrotePtr)

int
Tcl_UtfToNormalizedDString(interp, src, numBytes, normForm, profile, dstPtr)

ARGUMENTS
Interpreter to use for error reporting, or NULL if no error reporting is desired. An array of bytes in Tcl's internal UTF-8 based encoding. Length of src in bytes. If the length is negative, the length includes all bytes until the first nul byte. Buffer in which the converted result will be stored. No more than dstLen bytes will be stored in dst. The size of the output buffer dst in bytes. Filled with the number of bytes in the normalized string. This number does not include the terminating nul character. May be NULL. Must be one of the Tcl_UnicodeNormalizationForm members TCL_NFC, TCL_NFD, TCL_NFKC or TCL_NFKD specifying the Unicode normalization type. The encoding profile as described in the Tcl_GetEncoding documentation. Must be either TCL_ENCODING_PROFILE_STRICT or TCL_ENCODING_PROFILE_REPLACE. Pointer to an uninitialized or free Tcl_DString in which the converted result, which is also encoded in Tcl's internal UTF-8 encoding, will be stored. The function initializes the storage and caller must call Tcl_DStringFree on success.

DESCRIPTION

The Tcl_UtfToNormalized and Tcl_UtfToNormalizedDString functions transform the passed string into one of the standard normalization forms defined in the Unicode standard. The normalization form is specified via the normForm argument which must have one of the values TCL_NFC, TCL_NFD, TCL_NFKC or TCL_NFKD corresponding to the Unicode normalization forms Normalization Form C (NFC), Normalization Form D (NFD), Normalization Form KC (NFKC) and Normalization Form KD (NFKD) respectively. For details on the above normalization forms, refer to Section 3.11 of the Unicode standard (https://www.unicode.org/versions/Unicode16.0.0/core-spec/chapter-3/).

The Tcl_UtfToNormalized function stores the normalized result in the buffer provided by the caller through the dst argument. The result is nul terminated but the nul is not included in the count of stored bytes returned in dstWrotePtr. The function returns TCL_OK on success, TCL_CONVERT_NOSPACE if there is insufficient room in the output buffer and TCL_ERROR in case of other failures. In the latter two cases, an error message is stored in interp if it is not NULL.

The Tcl_UtfToNormalizedDString function stores the normalized result in dstPtr which must eventually be freed by caller through Tcl_DStringFree. The function returns TCL_OK on success and TCL_ERROR on failure with an error message in interp if it is not NULL.

SEE ALSO
unicode(n)

KEYWORDS
utf, Unicode, normalize