WoW:API strsplit - Revision history

Move page script: Move page script moved page API strsplit to WoW:API strsplit without leaving a redirect

2023-08-15T04:47:30Z

Move page script moved page API strsplit to API strsplit without leaving a redirect

← Older revision

Revision as of 04:47, 15 August 2023

2010-04-29T00:23:09Z

Arguments: boilerplate

← Older revision		Revision as of 00:23, 29 April 2010
Line 8:		Line 8:

	== Arguments ==		== Arguments ==
	~~<!-- List each argument, together with its type -->~~		;delimiter : String - Characters (bytes) that will be interpreted as delimiter characters (bytes) in the string.
	~~:(delimiter, subject)~~		;subject : String - String to split.
			;pieces : Number (optional) - Maximum number of pieces to make (the "last" piece would contain the rest of the string); by default, an unbounded number of pieces is returned.
	:;delimiter : String - ~~Delimiter~~ (~~every single byte of the string~~ will be ~~used to split; see details~~)
	:;subject : String - String to split
	:;pieces : ~~integer~~ - ~~Optional argument designating the~~ number of pieces to make.


	== Returns ==		== Returns ==

2010-04-14T04:35:35Z

Returns

← Older revision		Revision as of 04:35, 14 April 2010
Line 18:		Line 18:
	== Returns ==		== Returns ==
	<!-- List each return value, together with its type -->		<!-- List each return value, together with its type -->
	A list of strings. Not a table.		A list of strings. Not a table. If the delimiter is not found in the subject string, the whole subject string will be returned.

	== Example ==		== Example ==

2010-03-09T10:44:09Z

← Older revision		Revision as of 10:44, 9 March 2010
Line 11:		Line 11:
	:(delimiter, subject)		:(delimiter, subject)

	:;delimiter : String - Delimiter		:;delimiter : String - Delimiter (every single byte of the string will be used to split; see details)
	:;subject : String - String to split		:;subject : String - String to split
	:;pieces : integer - Optional argument designating the number of pieces to make.		:;pieces : integer - Optional argument designating the number of pieces to make.
Line 41:		Line 41:
	tinsert(tbl, v)		tinsert(tbl, v)
	end		end

			Additionally note that the delimiter defines all bytes that will split the string, e.g.:
			strsplit("ab", "1a2b3") -- => "1", "2", "3"
			or
			strsplit("ab", "1ab2") -- => "1", "", "2"

	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.		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.

2009-04-25T03:27:38Z

← Older revision		Revision as of 03:27, 25 April 2009
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 ==

2009-01-08T21:09:33Z

← Older revision		Revision as of 21:09, 8 January 2009
Line 40:		Line 40:
	tinsert(tbl, v)		tinsert(tbl, v)
	end		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.

2007-11-26T16:59:29Z

← Older revision		Revision as of 16:59, 26 November 2007
Line 12:		Line 12:

	:;delimiter : String - Delimiter		:;delimiter : String - Delimiter
	:;~~subejct~~ : String - String to split		:;subject : String - String to split


Line 21:		Line 21:
	== 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")

	<big>'''Result'''</big>		<big>'''Result'''</big>

2007-10-19T17:00:44Z

Add note about multiple occurences of separator and add example using string.gmatch

← Older revision		Revision as of 17:00, 19 October 2007
Line 30:		Line 30:

	== Details ==		== Details ==
	~~<!-- Details not appropriate for the main description can go here.~~
	~~REMOVE the section if you're just going to restate the intro line! -->~~

	To get a table use:		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) }		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