Function

GLib-2.0GLibutf8_normalize

  • Converts a string into canonical form, standardizing such issues as whether a character with an accent is represented as a base character and combining accent or as a single precomposed character. The string has to be valid UTF-8, otherwise null is returned. You should generally call g_utf8_normalize() before comparing two Unicode strings.

    The normalization mode GLib.NormalizeMode.DEFAULT only standardizes differences that do not affect the text content, such as the above-mentioned accent representation. GLib.NormalizeMode.ALL also standardizes the "compatibility" characters in Unicode, such as SUPERSCRIPT THREE to the standard forms (in this case DIGIT THREE). Formatting information may be lost but for most text operations such characters should be considered the same.

    GLib.NormalizeMode.DEFAULT_COMPOSE and GLib.NormalizeMode.ALL_COMPOSE are like GLib.NormalizeMode.DEFAULT and GLib.NormalizeMode.ALL, but returned a result with composed forms rather than a maximally decomposed form. This is often useful if you intend to convert the string to a legacy encoding or pass it to a system with less capable Unicode handling.

    Parameters

    • str: string

      a UTF-8 encoded string.

    • len: number

      length of str, in bytes, or -1 if str is nul-terminated.

    • mode: GLib.NormalizeMode

      the type of normalization to perform.

    Returns string

    a newly allocated string, that is the normalized form of str, or null if str is not valid UTF-8.