Utf8.widthindex

Available since: Gideros 2016.06
Class: utf8

Description

Returns the character index at given location in string s. This is a reverse operation of utf8.width().

(number) = utf8.widthindex(s,location,ambi_is_double,default_width)

This function returns an index of location, and an offset in in UTF-8 encoding. e.g. if cursor is at the second column (middle) of the wide char, offset will be 2. The width of character index is also returned.

Parameters

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

Return values

Returns (number) character index at given location

---

• 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