Files
MagicSetEditor2/doc/function/match.txt
T
twanvl 689def7325 Yet more function documentation
git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@571 0fc631ac-6414-0410-93d0-97cfa31319b6
2007-07-14 00:29:25 +00:00

28 lines
837 B
Plaintext

Function: match
--Usage--
> match(some_string, match: regular expression)
> match_rule(match:regular expression)(some_string)
Does a string match the given [[type:regex|regular expression]]?
This function is available in [[script:rule form]].
When the match is performed many times the rule form is more efficient, because 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_rule(match: "a+|b+")
> f("xyz") == false
--See also--
| [[fun:contains]] Does a string contain another one?