Difference between revisions of "String.gmatch"

From GiderosMobile
(remove language stuff)
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 +
'''Class:''' [[string]]<br/>
 +
 
=== Description ===
 
=== Description ===
<translate>Returns an iterator function that, each time it is called, returns the next captures from pattern over string s. If pattern specifies no captures, then the whole match is produced in each call.  
+
Returns an iterator function that, each time it is called, returns the next captures from pattern ''pat'' over string ''s''. If pattern specifies no captures, then the whole match is produced in each call.
 +
<source lang="lua">
 +
(function) = string.gmatch(s,pat)
 +
</source>
  
 +
=== Parameters ===
 +
'''s''': (string) string where to look for patterns<br/>
 +
'''pat''': (string) pattern to look for<br/>
  
As an example, the following loop
+
=== Return values ===
 +
'''Returns''' (function) iterator function<br/>
  
    [[s = "hello world from Lua"]]
+
=== Examples ===
    [[for w in string.gmatch(s, "%a+") do]]
+
'''The following loop will iterate over all the words from string s, printing one per line'''
      [[print(w)]]
+
<source lang="lua">
    [[end]]
+
s = "hello world from Lua"
</pre>
+
for w in string.gmatch(s, "%a+") do
 +
  print(w)
 +
end
 +
</source>
  
will iterate over all the words from string s, printing one per line. The next example collects all pairs key=value from the given string into a table:
+
'''The next example collects all pairs key=value from the given string into a table'''
 
 
    [[t = {}]]
 
    [[s = "from=world, to=Lua"]]
 
    [[for k, v in string.gmatch(s, "(%w+)=(%w+)") do]]
 
      [[t[k] = v]]
 
    [[end]]
 
 
 
 
 
For this function, a '^' at the start of a pattern does not work as an anchor, as this would prevent the iteration.</translate>
 
 
<source lang="lua">
 
<source lang="lua">
(function) = string.gmatch(s,pat)
+
t = {}
 +
s = "from=world, to=Lua"
 +
for k, v in string.gmatch(s, "(%w+)=(%w+)") do
 +
  t[k] = v
 +
end
 
</source>
 
</source>
=== Parameters ===
+
For this function, a '^' at the start of a pattern does not work as an anchor, as this would prevent the iteration.
'''s''': (string) <translate>string where to look for patterns</translate> <br/>
+
 
'''pat''': (string) <translate>pattern to look for</translate> <br/>
+
{{String}}
=== Return values ===
 
'''Returns''' (function) <translate>iterator function</translate><br/>
 

Revision as of 03:40, 24 February 2021

Available since: Gideros 2011.6
Class: string

Description

Returns an iterator function that, each time it is called, returns the next captures from pattern pat over string s. If pattern specifies no captures, then the whole match is produced in each call.

(function) = string.gmatch(s,pat)

Parameters

s: (string) string where to look for patterns
pat: (string) pattern to look for

Return values

Returns (function) iterator function

Examples

The following loop will iterate over all the words from string s, printing one per line

s = "hello world from Lua"
for w in string.gmatch(s, "%a+") do
   print(w)
end

The next example collects all pairs key=value from the given string into a table

t = {}
s = "from=world, to=Lua"
for k, v in string.gmatch(s, "(%w+)=(%w+)") do
   t[k] = v
end

For this function, a '^' at the start of a pattern does not work as an anchor, as this would prevent the iteration.