Files
MagicSetEditor2/doc/function/match.txt
twanvl 158ecf67ad Now all regex functions use ScriptRule.
The *_rule functions can now be considered deprecated
Documented this by removing mentions of the rule functions, except for a mention of backwards compatibility.

git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@997 0fc631ac-6414-0410-93d0-97cfa31319b6
2008-06-19 00:37:48 +00:00

30 lines
894 B
Plaintext

Function: match
--Usage--
> match(some_string, match: regular expression)
Does a string match the given [[type:regex|regular expression]]?
When the match is performed many times with the same regular expression it is more efficient to declare that as a default argument:
> my_match := match@(match: "something")
> my_match("input") # called many times
This way the regular expression is only compiled once.
--Parameters--
! Parameter Type Description
| @input@ [[type:string]] String to match.
| @match@ [[type:regex]] Regular expression to match.
--Examples--
> match("aaaa", match:"a*") == true
> match("a", match:"b*") == true
> match("abc", match:"b+") == true
> match("abc", match:"$b+^") == false
>
> f := match@(match: "a+|b+")
> f("xyz") == false
> f("aabb") == true
--See also--
| [[fun:contains]] Does a string contain another one?