Difference between revisions of "Utf8.find"

From GiderosMobile
(Created page with "__NOTOC__ '''Available since:''' Gideros 2016.06<br/> === Description === Looks for the first match of pattern in the string s. If it finds a match, then find returns the indi...")
 
Line 5: Line 5:
 
If the pattern has captures, then in a successful match the captured values are also returned, after the two indices.
 
If the pattern has captures, then in a successful match the captured values are also returned, after the two indices.
 
<source lang="lua">
 
<source lang="lua">
(numbers), = utf8.find(spatterninitplain,)
+
(numbers) = utf8.find(s,pattern,init,plain)
 
</source>
 
</source>
'''s:''' (string)  ''''''<br/>
+
'''s''': (string)  ''''''<br/>
'''pattern:''' (string)  ''''''<br/>
+
'''pattern''': (string)  ''''''<br/>
'''init:''' (number)  '''optional'''<br/>
+
'''init''': (number)  '''optional'''<br/>
'''plain:''' (boolean)  '''optional'''<br/>
+
'''plain''': (boolean)  '''optional'''<br/>
 
'''Returns''' (numbers) the indices of s where this occurrence starts and ends; otherwise, it returns nil<br/>
 
'''Returns''' (numbers) the indices of s where this occurrence starts and ends; otherwise, it returns nil<br/>

Revision as of 11:20, 23 August 2018

Available since: Gideros 2016.06

Description

Looks for the first match of pattern in the string s. If it finds a match, then find returns the indices of s where this occurrence starts and ends; otherwise, it returns nil. A third, optional numerical argument init specifies where to start the search; its default value is 1 and can be negative. A value of true as a fourth, optional argument plain turns off the pattern matching facilities, so the function does a plain "find substring" operation, with no characters in pattern being considered magic. Note that if plain is given, then init must be given as well. If the pattern has captures, then in a successful match the captured values are also returned, after the two indices.

(numbers) = utf8.find(s,pattern,init,plain)

's: (string) '
'pattern: (string) '
init: (number) optional
plain: (boolean) optional
Returns (numbers) the indices of s where this occurrence starts and ends; otherwise, it returns nil