Module tables

Structs

Align32 🔒

Align64 🔒

Align128 🔒

WidthInfo 🔒

Constants

UNICODE_VERSION

The version of Unicode that this version of unicode-width is based on.

WIDTH_LEAVES_LEN 🔒

WIDTH_MIDDLE_LEN 🔒

Statics

EMOJI_MODIFIER_LEAF_0 🔒

EMOJI_MODIFIER_LEAF_1 🔒

EMOJI_MODIFIER_LEAF_2 🔒

EMOJI_MODIFIER_LEAF_3 🔒

EMOJI_MODIFIER_LEAF_4 🔒

EMOJI_MODIFIER_LEAF_5 🔒

EMOJI_MODIFIER_LEAF_6 🔒

EMOJI_MODIFIER_LEAF_7 🔒

EMOJI_PRESENTATION_LEAVES 🔒

Array of 1024-bit bitmaps. Index into the correct bitmap with the 10 LSB of your codepoint to get whether it can start an emoji presentation sequence.

NON_TRANSPARENT_ZERO_WIDTHS 🔒

Sorted list of codepoint ranges (inclusive) that are zero-width but not Joining_Type=Transparent FIXME: can we get better compression?

SOLIDUS_TRANSPARENT 🔒

Sorted list of codepoint ranges (inclusive) that don’t affect how the combining solidus applies (mostly ccc > 1). FIXME: can we get better compression?

TEXT_PRESENTATION_LEAF_0 🔒

TEXT_PRESENTATION_LEAF_1 🔒

TEXT_PRESENTATION_LEAF_2 🔒

TEXT_PRESENTATION_LEAF_3 🔒

TEXT_PRESENTATION_LEAF_4 🔒

TEXT_PRESENTATION_LEAF_5 🔒

TEXT_PRESENTATION_LEAF_6 🔒

TEXT_PRESENTATION_LEAF_7 🔒

TEXT_PRESENTATION_LEAF_8 🔒

TEXT_PRESENTATION_LEAF_9 🔒

WIDTH_LEAVES 🔒

Autogenerated. 180 sub-table(s). Consult lookup_width for layout info.

WIDTH_MIDDLE 🔒

Autogenerated. 4 sub-table(s). Consult lookup_width for layout info.

WIDTH_ROOT 🔒

Autogenerated. 1 sub-table(s). Consult lookup_width for layout info.)

WIDTH_ROOT_CJK 🔒

Autogenerated. 17 sub-table(s). Consult lookup_width for layout info.)

Functions

is_emoji_modifier_base

Returns true if c is an Emoji_Modifier_Base.

is_ligature_transparent 🔒

Whether this character is a default-ignorable combining mark or ZWJ. These characters won’t interrupt non-Arabic ligatures.

is_solidus_transparent 🔒

Whether this character is transparent wrt the effect of U+0338 COMBINING LONG SOLIDUS OVERLAY on its base character.

is_transparent_zero_width 🔒

Whether this character is a zero-width character with Joining_Type=Transparent. Used by the Alef-Lamed ligatures. See also is_ligature_transparent, a near-subset of this (only ZWJ is excepted) which is transparent for non-Arabic ligatures.

lookup_width 🔒

Returns the UAX #11 based width of c by consulting a multi-level lookup table.

lookup_width_cjk 🔒

Returns the UAX #11 based width of c by consulting a multi-level lookup table.

single_char_width

Returns the UAX #11 based width of c, or None if c is a control character. Ambiguous width characters are treated as narrow.

single_char_width_cjk

Returns the UAX #11 based width of c, or None if c is a control character. Ambiguous width characters are treated as wide.

starts_emoji_presentation_seq

Whether this character forms an [emoji presentation sequence] (https://www.unicode.org/reports/tr51/#def_emoji_presentation_sequence) when followed by '\u{FEOF}'. Emoji presentation sequences are considered to have width 2.

starts_non_ideographic_text_presentation_seq

Returns true if c has default emoji presentation, but forms a [text presentation sequence] (https://www.unicode.org/reports/tr51/#def_text_presentation_sequence) when followed by '\u{FEOE}', and is not ideographic. Such sequences are considered to have width 1.

str_width

str_width_cjk

width_in_str 🔒

Returns the UAX #11 based width of c. Ambiguous width characters are treated as narrow.

width_in_str_cjk 🔒

Returns the UAX #11 based width of c. Ambiguous width characters are treated as wide.