Summary

Matches a regexp to a string, applying a function

Prototype

result = re:gmatch (string, fun, count, flags)

Description

The gmatch function:

• Tries to match the regex re against string up to count times (or as many as possible if count is either not given or is not a positive number), subject to execution flags "flags".
  
  
• Each time there is a match, fun is called as fun (m, t), where m is the matched string and t is a table of substring matches (this table contains false in the positions where the corresponding sub-pattern did not match.).
  
  
• If fun returns a true value, then gmatch immediately returns.
  
  
• gmatch returns the number of matches made.
  

re = rex.new ("(\[A-Za-z\]+)")
n = re:gmatch ("Nick goes East", function (m, t) print (m) end )
print (n) --> 3

See Also ...

Lua functions

re:exec - Matches a regexp to a string, returning offsets
re:match - Matches a regexp to a string
rex.flags - Returns a table of PCRE flags
rex.new - Compiles a regular expression

Topics

Lua base functions
Lua bc (big number) functions
Lua bit manipulation functions
Lua coroutine functions
Lua debug functions
Lua io functions
Lua LPEG library
Lua math functions
Lua os functions
Lua package functions
Lua PCRE regular expression functions
Lua script extensions
Lua string functions
Lua syntax
Lua table functions
Lua utilities
Scripting
Scripting callbacks - plugins

(Help topic: lua=re:gmatch)