WoW:API strsplit: Difference between revisions
mNo edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
<!-- Describe the purpose of the function, exhausting detail can be saved for a later section --> | <!-- Describe the purpose of the function, exhausting detail can be saved for a later section --> | ||
Splits a string using a delimiter | Splits a string using a delimiter (optionally: into a specified number of pieces) | ||
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args --> | <!-- List return values and arguments as well as function name, follow Blizzard usage convention for args --> | ||
s1, s2, s3 ... sn = strsplit("delimiter", "subject") | s1, s2, s3 ... sn = strsplit("delimiter", "subject"[, pieces]) | ||
| Line 13: | Line 13: | ||
:;delimiter : String - Delimiter | :;delimiter : String - Delimiter | ||
:;subject : String - String to split | :;subject : String - String to split | ||
:;pieces : integer - Optional argument designating the number of pieces to make. | |||
| Line 21: | Line 22: | ||
== Example == | == Example == | ||
<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory --> | <!-- If it helps, include an example here, though it's not required if the usage is self-explanatory --> | ||
local a, b, c = strsplit(" ", "a b c") | local a, b, c = strsplit(" ", "a b c d", 3) | ||
<big>'''Result'''</big> | <big>'''Result'''</big> | ||
| Line 27: | Line 28: | ||
a = "a" | a = "a" | ||
b = "b" | b = "b" | ||
c = "c" | c = "c d" | ||
== Details == | == Details == | ||
Revision as of 03:27, 25 April 2009
Splits a string using a delimiter (optionally: into a specified number of pieces)
s1, s2, s3 ... sn = strsplit("delimiter", "subject"[, pieces])
Arguments
- (delimiter, subject)
- delimiter
- String - Delimiter
- subject
- String - String to split
- pieces
- integer - Optional argument designating the number of pieces to make.
Returns
A list of strings. Not a table.
Example
local a, b, c = strsplit(" ", "a b c d", 3)
Result
a = "a" b = "b" c = "c d"
Details
Again, note that the return from strsplit is a list of values, not a table. To get a table, use e.g.:
local tbl = { strsplit(delimiter, subject) }
Also note that strsplit uses a raw string as delimited, not a pattern, so it's not particularily well-suited for e.g. commandline arguments, where it should be ok to use multiple spaces. To extract whitespace-separated arguments, you can use e.g.
local tbl = {}
for v in string.gmatch(" this has lots of space ", "[^ ]+") do
tinsert(tbl, v)
end
Nota Bene: This function does not handle embedded NUL characters ("\0") gracefully. If you need a unique "signpost" character embedded in your strings to be split apart later, try the ASCII bell character ("\a"). This won't show up in the game, and strsplit handles it just fine.