unicode

nimony/lib/std/unicode.nim

type Rune = distinct int32
\ Type that can hold a single Unicode code point.
A Rune may be composed with other Runes to a character on the screen. RuneImpl is the underlying type used to store Runes, currently int32.
func runeLen(s: openArray): int64
Returns the number of runes (code points) in s, not the UTF-8 byte length (len(s)).
func runeLenAt(s: openArray; i: int64): int64
Returns the number of bytes the rune starting at s[i] takes.
See also:
- fastRuneAt template
template fastRuneAt(s: openArray; i: int64; result: untyped; doInc: bool): untyped
Returns the rune s[i] in result.
If doInc == true (default), i is incremented by the number of bytes that have been processed.
func runeAt(s: openArray; i: int64): Rune
Returns the rune in s at byte index i.
See also:
func validateUtf8(s: openArray): int64
Returns the position of the invalid byte in s if the string s does not hold valid UTF-8 data. Otherwise -1 is returned.
See also:
- toUTF8 func
- $ func alias for toUTF8
- fastToUTF8Copy template
template fastToUTF8Copy(c: Rune; s: var string; pos: int64; doInc: bool): untyped
Copies UTF-8 representation of c into the preallocated string s starting at position pos.
If doInc == true (default), pos is incremented by the number of bytes that have been processed.
To be the most efficient, make sure s is preallocated with an additional amount equal to the byte length of c.
See also:
- validateUtf8 func
- toUTF8 func
- $ func alias for toUTF8
func toUTF8(c: Rune): string
Converts a rune into its UTF-8 representation.
See also:
- validateUtf8 func
- $ func alias for toUTF8
- utf8 iterator
- fastToUTF8Copy template
func add(s: var string; c: Rune)
Adds a rune c to a string s.
func $(rune: Rune): string
An alias for toUTF8.
See also:
- validateUtf8 func
- fastToUTF8Copy template
func $(runes: seq): string
Converts a sequence of Runes to a string.
See also:
- toRunes for a reverse operation
func runeOffset(s: openArray; pos: int64; start: int64): int64
Returns the byte offset in s where code-point index pos begins, optionally skipping ahead to start bytes first. Returns -1 if pos is past the last code point.
Beware: This can lead to unoptimized code and slow execution! Most problems can be solved more efficiently by using an iterator or conversion to a seq of Rune.
See also:
- runeReverseOffset func
func runeReverseOffset(s: openArray; rev: int64): tuple[int64, int64]
Returns a tuple with the byte offset of the rune at position rev in s, counting from the end (starting with 1) and the total number of runes in the string.
Returns a negative value for offset if there are too few runes in the string to satisfy the request.
Beware: This can lead to unoptimized code and slow execution! Most problems can be solved more efficiently by using an iterator or conversion to a seq of Rune.
See also:
- runeOffset func
func runeAtPos(s: openArray; pos: int64): Rune
Returns the rune at code-point index pos (not a UTF-8 byte index; see runeAt).
Beware: This can lead to unoptimized code and slow execution! Most problems can be solved more efficiently by using an iterator or conversion to a seq of Rune.
See also:
func runeStrAtPos(s: openArray; pos: int64): string
Returns the UTF-8 substring for the rune at code-point index pos.
Beware: This can lead to unoptimized code and slow execution! Most problems can be solved more efficiently by using an iterator or conversion to a seq of Rune.
See also:
func runeSubStr(s: openArray; pos: int64; len: int64): string
Returns the UTF-8 substring starting at code point pos with len code points.
If pos or len is negative they count from the end of the string. If len is not given it means the longest possible string.
func <=%(a: Rune; b: Rune): bool
Checks if code point of a is smaller or equal to code point of b.
func <%(a: Rune; b: Rune): bool
Checks if code point of a is smaller than code point of b.
func ==(a: Rune; b: Rune): bool
Checks if two runes are equal.
func toLower(c: Rune): Rune
Converts c into lower case. This works for any rune.
If possible, prefer toLower over toUpper.
See also:
func toUpper(c: Rune): Rune
Converts c into upper case. This works for any rune.
If possible, prefer toLower over toUpper.
See also:
func toTitle(c: Rune): Rune
Converts c to title case.
See also:
func isLower(c: Rune): bool
Returns true if c is a lower case rune.
If possible, prefer isLower over isUpper.
See also:
func isUpper(c: Rune): bool
Returns true if c is a upper case rune.
If possible, prefer isLower over isUpper.
See also:
func isAlpha(c: Rune): bool
Returns true if c is an alpha rune (i.e., a letter).
See also:
func isTitle(c: Rune): bool
Returns true if c is a Unicode titlecase code point.
See also:
func isWhiteSpace(c: Rune): bool
Returns true if c is a Unicode whitespace code point.
See also:
func isCombining(c: Rune): bool
Returns true if c is a Unicode combining code unit.
See also:
func isAlpha(s: openArray): bool
Returns true if s contains all alphabetic runes.
func isSpace(s: openArray): bool
Returns true if s contains all whitespace runes.
func toUpper(s: openArray): string
Converts s into upper-case runes.
func toLower(s: openArray): string
Converts s into lower-case runes.
func swapCase(s: openArray): string
Swaps the case of runes in s.
Returns a new string such that the cases of all runes are swapped if possible.
func capitalize(s: openArray): string
Converts the first character of s into an upper-case rune.
func translate(s: openArray; replacements: proc (key: string): string {.noSideEffect.}): string
Translates words in a string using the replacements func to substitute words inside s with their replacements.
replacements is any func that takes a word and returns a new word to fill it's place.
func title(s: openArray): string
Converts s to a unicode title.
Returns a new string such that the first character in each word inside s is capitalized.
iterator runes(s: openArray): Rune
Iterates over any rune of the string s returning runes.
iterator utf8(s: openArray): string
Iterates over any rune of the string s returning utf8 values.
See also:
- validateUtf8 func
- toUTF8 func
- $ func alias for toUTF8
- fastToUTF8Copy template
func toRunes(s: openArray): seq
Obtains a sequence containing the Runes in s.
See also:
- $ func for a reverse operation
func cmpRunesIgnoreCase(a: openArray; b: openArray): int64
Compares two UTF-8 strings and ignores the case. Returns:
| 0 if a == b
| < 0 if a < b
| > 0 if a > b
func reversed(s: openArray): string
Returns the reverse of s, interpreting it as runes.
Unicode combining characters are correctly interpreted as well.
func graphemeLen(s: openArray; i: int64): int64
The number of bytes belonging to byte index s[i], including following combining code units.
func lastRune(s: openArray; last: int64): tuple[Rune, int64]
Treating last as the inclusive byte index of the final UTF-8 byte of interest, finds that code unit's starting byte (walking backward through continuation bytes), decodes one Rune, and returns (rune, byteLength) for that encoding.
func size(r: Rune): int64
Returns the number of bytes the rune r takes.
iterator split(s: openArray; seps: openArray; maxsplit: int64): string
Splits the unicode string s into substrings using a group of separators.
Substrings are separated by a substring containing only seps.
iterator splitWhitespace(s: openArray): string
Splits a unicode string at whitespace runes.
func splitWhitespace(s: openArray): seq
The same as the splitWhitespace iterator, but is a func that returns a sequence of substrings.
iterator split(s: openArray; sep: Rune; maxsplit: int64): string
Splits the unicode string s into substrings using a single separator. Substrings are separated by the rune sep.
func split(s: openArray; seps: openArray; maxsplit: int64): seq
The same as the split iterator, but is a func that returns a sequence of substrings.
func split(s: openArray; sep: Rune; maxsplit: int64): seq
The same as the split iterator, but is a func that returns a sequence of substrings.
func strip(s: openArray; leading: bool; trailing: bool; runes: openArray): string
Strips leading or trailing runes from s and returns the resulting string.
If leading is true (default), leading runes are stripped. If trailing is true (default), trailing runes are stripped. If both are false, the string is returned unchanged.
func repeat(c: Rune; count: int64): string
Returns a string of count Runes c.
The returned string will have a rune-length of count.
func align(s: openArray; count: int64; padding: Rune): string
Aligns a unicode string s with padding, so that it has a rune-length of count.
padding characters (by default spaces) are added before s resulting in right alignment. If s.runelen >= count, no spaces are added and s is returned unchanged. If you need to left align a string use the alignLeft func.
func alignLeft(s: openArray; count: int64; padding: Rune): string
Left-aligns a unicode string s with padding, so that it has a rune-length of count.
padding characters (by default spaces) are added after s resulting in left alignment. If s.runelen >= count, no spaces are added and s is returned unchanged. If you need to right align a string use the align func.
func runeLen(s: string): int64
Returns the number of runes (code points) in s, not s.len (bytes).
func runeLenAt(s: string; i: int64): int64
Returns the number of bytes the rune starting at s[i] takes.
See also:
- fastRuneAt template
func runeAt(s: string; i: int64): Rune
Returns the rune in s at byte index i.
See also:
func validateUtf8(s: string): int64
Returns the position of the invalid byte in s if the string s does not hold valid UTF-8 data. Otherwise -1 is returned.
See also:
- toUTF8 func
- $ func alias for toUTF8
- fastToUTF8Copy template
func runeOffset(s: string; pos: int64; start: int64): int64
Returns the byte offset in s where code-point index pos begins, optionally skipping ahead to start bytes first. Returns -1 if pos is past the last code point.
Beware: This can lead to unoptimized code and slow execution! Most problems can be solved more efficiently by using an iterator or conversion to a seq of Rune.
See also:
- runeReverseOffset func
func runeReverseOffset(s: string; rev: int64): tuple[int64, int64]
Returns a tuple with the byte offset of the rune at position rev in s, counting from the end (starting with 1) and the total number of runes in the string.
Returns a negative value for offset if there are too few runes in the string to satisfy the request.
Beware: This can lead to unoptimized code and slow execution! Most problems can be solved more efficiently by using an iterator or conversion to a seq of Rune.
See also:
- runeOffset func
func runeAtPos(s: string; pos: int64): Rune
Returns the rune at code-point index pos (not a UTF-8 byte index; see runeAt).
Beware: This can lead to unoptimized code and slow execution! Most problems can be solved more efficiently by using an iterator or conversion to a seq of Rune.
See also:
func runeStrAtPos(s: string; pos: int64): string
Returns the UTF-8 substring for the rune at code-point index pos.
Beware: This can lead to unoptimized code and slow execution! Most problems can be solved more efficiently by using an iterator or conversion to a seq of Rune.
See also:
func runeSubStr(s: string; pos: int64; len: int64): string
Returns the UTF-8 substring starting at code point pos with len code points.
If pos or len is negative they count from the end of the string. If len is not given it means the longest possible string.
func isAlpha(s: string): bool
Returns true if s contains all alphabetic runes.
func isSpace(s: string): bool
Returns true if s contains all whitespace runes.
func toUpper(s: string): string
Converts s into upper-case runes.
func toLower(s: string): string
Converts s into lower-case runes.
func swapCase(s: string): string
Swaps the case of runes in s.
Returns a new string such that the cases of all runes are swapped if possible.
func capitalize(s: string): string
Converts the first character of s into an upper-case rune.
func translate(s: string; replacements: proc (key: string): string {.noSideEffect.}): string
Translates words in a string using the replacements func to substitute words inside s with their replacements.
replacements is any func that takes a word and returns a new word to fill it's place.
func title(s: string): string
Converts s to a unicode title.
Returns a new string such that the first character in each word inside s is capitalized.
iterator runes(s: string): Rune
Iterates over any rune of the string s returning runes.
iterator utf8(s: string): string
Iterates over any rune of the string s returning utf8 values.
See also:
- validateUtf8 func
- toUTF8 func
- $ func alias for toUTF8
- fastToUTF8Copy template
func toRunes(s: string): seq
Obtains a sequence containing the Runes in s.
See also:
- $ func for a reverse operation
func cmpRunesIgnoreCase(a: string; b: string): int64
Compares two UTF-8 strings and ignores the case. Returns:
| 0 if a == b
| < 0 if a < b
| > 0 if a > b
func reversed(s: string): string
Returns the reverse of s, interpreting it as runes.
Unicode combining characters are correctly interpreted as well.
func graphemeLen(s: string; i: int64): int64
The number of bytes belonging to byte index s[i], including following combining code units.
func lastRune(s: string; last: int64): tuple[Rune, int64]
Same as lastRune(openArray[char], int) — last is the inclusive byte index of the final UTF-8 byte examined.
iterator split(s: string; seps: openArray; maxsplit: int64): string
Splits the unicode string s into substrings using a group of separators.
Substrings are separated by a substring containing only seps.
iterator splitWhitespace(s: string): string
Splits a unicode string at whitespace runes.
func splitWhitespace(s: string): seq
The same as the splitWhitespace iterator, but is a func that returns a sequence of substrings.
iterator split(s: string; sep: Rune; maxsplit: int64): string
Splits the unicode string s into substrings using a single separator. Substrings are separated by the rune sep.
func split(s: string; seps: openArray; maxsplit: int64): seq
The same as the split iterator, but is a func that returns a sequence of substrings.
func split(s: string; sep: Rune; maxsplit: int64): seq
The same as the split iterator, but is a func that returns a sequence of substrings.
func strip(s: string; leading: bool; trailing: bool; runes: openArray): string
Strips leading or trailing runes from s and returns the resulting string.
If leading is true (default), leading runes are stripped. If trailing is true (default), trailing runes are stripped. If both are false, the string is returned unchanged.
func align(s: string; count: int64; padding: Rune): string
Aligns a unicode string s with padding, so that it has a rune-length of count.
padding characters (by default spaces) are added before s resulting in right alignment. If s.runelen >= count, no spaces are added and s is returned unchanged. If you need to left align a string use the alignLeft func.
func alignLeft(s: string; count: int64; padding: Rune): string
Left-aligns a unicode string s with padding, so that it has a rune-length of count.
padding characters (by default spaces) are added after s resulting in left alignment. If s.runelen >= count, no spaces are added and s is returned unchanged. If you need to right align a string use the align func.