Difference between revisions of "getGroupStart"

From RPTools Wiki
Jump to navigationJump to search
Line 1: Line 1:
==Function getGroupStart==
+
{{MacroFunction
 +
|name=getGroupStart
 +
|description=Returns the start index of the specified capture group for the specified match that was found using [[strfind|strfind()]]
  
 
+
|usage=
Returns the start index of the specified capture group for the specified match that was found using [[Macros:Functions:strfind|strfind()]]
 
 
 
 
 
===Usage===
 
 
<source lang="mtmacro" line>
 
<source lang="mtmacro" line>
 
[h: text = getGroupStart(id, match, group)]
 
[h: text = getGroupStart(id, match, group)]
 
</source>
 
</source>
 
Where  
 
Where  
* id is the id returned by [[Macros:Functions:strfind|strfind()]]
+
* id is the id returned by [[strfind|strfind()]]
* match is the number of the match found by [[Macros:Functions:strfind|strfind()]]
+
* match is the number of the match found by [[strfind|strfind()]]
* group is the number of the capture group found by [[Macros:Functions:strfind|strfind()]]
+
* group is the number of the capture group found by [[strfind|strfind()]]
  
===Examples===
+
|example=
 
<source lang="mtmacro" line>
 
<source lang="mtmacro" line>
 
[h: id = strfind("this is a test", "(\\S+)\\s(\\S+)\\s*")]
 
[h: id = strfind("this is a test", "(\\S+)\\s(\\S+)\\s*")]
Line 29: Line 27:
 
match 2, group 2 start = 10  
 
match 2, group 2 start = 10  
 
</pre>
 
</pre>
 +
}}
 +
[[Category:String Function]]

Revision as of 03:15, 7 March 2009

getGroupStart() Function

Returns the start index of the specified capture group for the specified match that was found using strfind()

Usage

[h: text = getGroupStart(id, match, group)]

Where

  • id is the id returned by strfind()
  • match is the number of the match found by strfind()
  • group is the number of the capture group found by strfind()

Example

[h: id = strfind("this is a test", "(\\S+)\\s(\\S+)\\s*")]
match 1, group 1 start = [getGroupStart(id, 1, 1)]<br>
match 1, group 2 start = [getGroupStart(id, 1, 2)]<br>
match 2, group 1 start = [getGroupStart(id, 2, 1)]<br>
match 2, group 2 start = [getGroupStart(id, 2, 2)]<br>

Returns

match 1, group 1 start = 0 
match 1, group 2 start = 5 
match 2, group 1 start = 8 
match 2, group 2 start = 10