unicode

Returns the name and the range of the unicode block that contains the given code point.

Some ranges are not assigned to any block, nil is returned for them.

Returns an iterator over all unicode blocks in code point order.

for block_name, first_codepoint, last_codepoint in unicode.blocks() do
    print( block_name, unicode.tag( first_codepoint ), unicode.tag( last_codepoint ) )
end

Capitalizes a UTF-8 string: the first case-able character within the given range is converted to uppercase (left untouched if it's already uppercase), and every case-able character after it is converted to lowercase.

Characters with no case mapping (digits, symbols, whitespace, etc.) are skipped and do not count as "the first character".

Returns the number of terminal columns the given UTF-8 string takes in a monospace font.

Unlike utf8.len, wide characters (CJK, emoji) count as 2, combining marks and other zero-width characters count as 0, emoji ZWJ sequences (👨‍👩‍👧), skin tones (👍🏽) and flags (🇺🇦) count as a single wide character.

The result depends on the font and terminal, emoji are rendered inconsistently across them.

Converts each character in the input string into a unicode escape sequence, suitable for serialization, logging, or safe ASCII output.

Combines a UTF-16 surrogate pair into a supplementary code point.

Checks if the given code point is a UTF-16 high (leading) surrogate, in range U+D800 - U+DBFF.

Checks if the given code point is a UTF-16 low (trailing) surrogate, in range U+DC00 - U+DFFF.

Checks if the given code point is a noncharacter, U+FDD0 - U+FDEF or the last two code points of any plane (U+xFFFE, U+xFFFF).

Checks if the given code point belongs to a private use area, U+E000 - U+F8FF, U+F0000 - U+FFFFD or U+100000 - U+10FFFD.

Checks if the given code point is a UTF-16 surrogate, in range U+D800 - U+DFFF.

Checks if the given value is a unicode scalar value, an integer in range U+0000 - U+10FFFF that is not a surrogate.

Only scalar values can be encoded in UTF-8.

Converts a UTF-8 string to lowercase within the given byte range.

Each decoded codepoint that has a known uppercase-to-lowercase mapping is replaced with its lowercase form; any codepoint with no such mapping (already lowercase, digits, symbols, whitespace, or characters outside the known case tables) is left unchanged.

Bytes outside the given range are always left untouched.

Pads a UTF-8 string with a repeated padding string until it is desired_width columns wide (see unicode.displayWidth), on the left, the right, or both sides evenly.

If neither left nor right is true, padding has no width, or the string is already at least desired_width columns wide, utf8_string is returned unchanged.

When padding both sides, the missing width is split as evenly as possible between the left and right, with any extra leftover column going to the right side; if it doesn't divide evenly by whole copies of padding, the shortfall is made up with a partial copy of padding, and with spaces where a wide character of padding doesn't fit.

Returns the unicode plane of the given code point, 0 for the Basic Multilingual Plane up to 16.

Returns a string representation of the given unicode code point.

Converts a UTF-8 string to title case within the given range: the first case-able character of each word is converted to uppercase (left alone if already uppercase), and every other case-able character in the word is converted to lowercase.

Words are separated by whitespace and punctuation, apostrophes (' and ’), digits and letters without case (ß, CJK, etc.) don't break a word.

Splits a supplementary code point (U+10000 - U+10FFFF) into a UTF-16 surrogate pair.

Converts unicode escape sequences into actual characters.

Supported formats are \uXXXX (exactly 4 hex digits), UTF-16 surrogate pairs \uXXXX\uXXXX, \u{X} (any number of hex digits) and \UXXXXXXXX (exactly 8 hex digits).

\\ is treated as an escaped backslash and left as is, malformed sequences are left as is.

Returns the unicode code point represented by the given string.

Converts a UTF-8 string to uppercase within the given byte range.

Each decoded codepoint that has a known lowercase-to-uppercase mapping is replaced with its uppercase form; any codepoint with no such mapping (already uppercase, digits, symbols, whitespace, or characters outside the known case tables) is left unchanged.

Bytes outside the given range are always left untouched.

Returns the number of terminal columns the given code point takes in a monospace font.

• 0 for control characters, combining marks, format characters (ZWJ, ZWSP, BOM, ...) and variation selectors.
• 2 for East Asian wide and fullwidth characters (CJK, kana, hangul) and emoji.
• 1 for everything else.

Use unicode.displayWidth for strings, it also handles emoji sequences.

Wraps a UTF-8 string so that no line is wider than max_width columns (see unicode.displayWidth), breaking on the last ASCII space before the limit when one is available within the current line, or hard-splitting mid-word otherwise.

Zero-width characters stay with the character they belong to, so a line can only exceed max_width when a single wide character doesn't fit into it.

Lines are joined with "\n", existing "\n" characters start a new line.

Bytes outside the given range are left untouched and don't count towards the line width.