Utf8.width

Available since: Gideros 2016.06
Class: utf8

Description

Calculates the width of UTF-8 string s.

(number) = utf8.width(s,ambi_is_double,default_width)

If ambi_is_double is given, the ambiguous width character width is 2, otherwise it is 1.

fullwidth/doublewidth character width is 2, and other characters width is 1.

If default_width is given, it will be the width of unprintable character, used to display a non-character mark for these characters.

If s is a code point, returns the width of this code point.

Parameters

s: (string)
ambi_is_double: (boolean) optional
default_width: (number) optional

Return values

Returns (number) string width

---

• Utf8
• Utf8.byte
• Utf8.char
• Utf8.charpattern
• Utf8.charpos
• Utf8.codepoint
• Utf8.codes
• Utf8.escape
• Utf8.find
• Utf8.fold
• Utf8.gmatch
• Utf8.gsub
• Utf8.insert
• Utf8.len
• Utf8.lower
• Utf8.match
• Utf8.ncasecmp
• Utf8.next
• Utf8.offset
• Utf8.remove
• Utf8.reverse
• Utf8.sub
• Utf8.title
• Utf8.upper
• Utf8.width
• Utf8.widthindex

---

---

• Main Page
• Lua API
• Main API
• Plugins