Module pl.stringx
Python-style extended string library.
see 3.6.1 of the Python reference.
If you want to make these available as string methods, then say
stringx.import() to bring them into the standard string table.
See the Guide
Dependencies: pl.utils
| lfind (s, sub[, first[, last]]) |
find index of first instance of sub in s from the left. |
| rfind (s, sub[, first[, last]]) |
find index of first instance of sub in s from the right. |
| replace (s, old, new[, n]) |
replace up to n instances of old by new in the string s. |
| count (s, sub) |
count all instances of substring in string. |
| lines (s) |
return an iterator over all lines in a string |
| title (s) |
iniital word letters uppercase (‘title case’). |
| shorten (s, w, tail) |
Return a shortened version of a string. |
| quote_string (s) |
Quote the given string and preserve any control or escape characters, such that reloading the string in Lua returns the same result. |
-
isalpha (s)
-
does s only contain alphabetic characters?
Parameters:
-
isdigit (s)
-
does s only contain digits?
Parameters:
-
isalnum (s)
-
does s only contain alphanumeric characters?
Parameters:
-
isspace (s)
-
does s only contain spaces?
Parameters:
-
islower (s)
-
does s only contain lower case characters?
Parameters:
-
isupper (s)
-
does s only contain upper case characters?
Parameters:
-
startswith (s, prefix)
-
does s start with prefix or one of prefixes?
Parameters:
- s
string
a string
- prefix
a string or an array of strings
-
endswith (s, suffix)
-
does s end with suffix or one of suffixes?
Parameters:
- s
string
a string
- suffix
a string or an array of strings
-
join (s, seq)
-
concatenate the strings using this string as a delimiter.
Parameters:
- s
string
the string
- seq
a table of strings or numbers
Usage:
(' '):join {1,2,3} == '1 2 3'
-
splitlines (s[, keep_ends])
-
Split a string into a list of lines.
"\r", "\n", and "\r\n" are considered line ends.
They are not included in the lines unless keepends is passed.
Terminal line end does not produce an extra line.
Splitting an empty string results in an empty list.
Parameters:
- s
string
the string.
- keep_ends
bool
include line ends.
(optional)
-
split (s[, re[, n]])
-
split a string into a list of strings using a delimiter.
Parameters:
- s
string
the string
- re
string
a delimiter (defaults to whitespace)
(optional)
- n
int
maximum number of results
(optional)
Usage:
#(('one two'):split()) == 2('one,two,three'):split(',') == List{'one','two','three'}('one,two,three'):split(',',2) == List{'one','two,three'}
-
expandtabs (s, tabsize)
-
replace all tabs in s with tabsize spaces. If not specified, tabsize defaults to 8.
with 0.9.5 this now correctly expands to the next tab stop (if you really
want to just replace tabs, use :gsub(‘\t’,‘ ’) etc)
Parameters:
- s
string
the string
- tabsize
int
[opt=8] number of spaces to expand each tab
-
lfind (s, sub[, first[, last]])
-
find index of first instance of sub in s from the left.
Parameters:
- s
string
the string
- sub
string
substring
- first
int
first index
(optional)
- last
int
last index
(optional)
-
rfind (s, sub[, first[, last]])
-
find index of first instance of sub in s from the right.
Parameters:
- s
string
the string
- sub
string
substring
- first
int
first index
(optional)
- last
int
last index
(optional)
-
replace (s, old, new[, n])
-
replace up to n instances of old by new in the string s.
if n is not present, replace all instances.
Parameters:
- s
string
the string
- old
string
the target substring
- new
string
the substitution
- n
int
optional maximum number of substitutions
(optional)
Returns:
result string
-
count (s, sub)
-
count all instances of substring in string.
Parameters:
-
ljust (s, w[, ch=' '])
-
left-justify s with width w.
Parameters:
- s
string
the string
- w
int
width of justification
- ch
string
padding character
(default ' ')
-
rjust (s, w[, ch=' '])
-
right-justify s with width w.
Parameters:
- s
string
the string
- w
int
width of justification
- ch
string
padding character
(default ' ')
-
center (s, w[, ch=' '])
-
center-justify s with width w.
Parameters:
- s
string
the string
- w
int
width of justification
- ch
string
padding character
(default ' ')
-
lstrip (s[, chrs='%s'])
-
trim any whitespace on the left of s.
Parameters:
- s
string
the string
- chrs
string
default any whitespace character,
but can be a string of characters to be trimmed
(default '%s')
-
rstrip (s[, chrs='%s'])
-
trim any whitespace on the right of s.
Parameters:
- s
string
the string
- chrs
string
default any whitespace character,
but can be a string of characters to be trimmed
(default '%s')
-
strip (s[, chrs='%s'])
-
trim any whitespace on both left and right of s.
Parameters:
- s
string
the string
- chrs
string
default any whitespace character,
but can be a string of characters to be trimmed
(default '%s')
-
splitv (s[, re='%s'])
-
split a string using a pattern. Note that at least one value will be returned!
Parameters:
- s
string
the string
- re
string
a Lua string pattern (defaults to whitespace)
(default '%s')
Returns:
the parts of the string
Usage:
a,b = line:splitv('=')
-
partition (s, ch)
-
partition the string using first occurance of a delimiter
Parameters:
Returns:
-
part before ch
-
ch
-
part after ch
-
rpartition (s, ch)
-
partition the string p using last occurance of a delimiter
Parameters:
Returns:
-
part before ch
-
ch
-
part after ch
-
at (s, idx)
-
return the ‘character’ at the index.
Parameters:
- s
string
the string
- idx
int
an index (can be negative)
Returns:
a substring of length 1 if successful, empty string otherwise.
-
lines (s)
-
return an iterator over all lines in a string
Parameters:
Returns:
an iterator
-
title (s)
-
iniital word letters uppercase (‘title case’).
Here ‘words’ mean chunks of non-space characters.
Parameters:
Returns:
a string with each word’s first letter uppercase
-
shorten (s, w, tail)
-
Return a shortened version of a string.
Fits string within w characters. Removed characters are marked with ellipsis.
Parameters:
- s
string
the string
- w
int
the maxinum size allowed
- tail
bool
true if we want to show the end of the string (head otherwise)
Usage:
('1234567890'):shorten(8) == '12345...'('1234567890'):shorten(8, true) == '...67890'('1234567890'):shorten(20) == '1234567890'
-
quote_string (s)
-
Quote the given string and preserve any control or escape characters, such that reloading the string in Lua returns the same result.
Parameters:
- s
The string to be quoted.
Returns:
The quoted string.