Difference between revisions of "getGroupStart"

From RPTools Wiki
Jump to navigationJump to search
m (Added version.)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Function getGroupEnd==
+
{{MacroFunction
{{ProposedChange}}
+
|name=getGroupStart
 +
|version=1.3b48
 +
|description=Returns the start index of the specified capture group for the specified match that was found using [[strfind|strfind()]]
  
Returns the start index of the specified capture group for the specified match that was found using [[Macros:Functions:strfind|strfind()]]
+
|usage=
 
 
 
 
===Usage===
 
 
<source lang="mtmacro" line>
 
<source lang="mtmacro" line>
[h: text = getGroupStart(id, match, group)]
+
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 28:
 
match 2, group 2 start = 10  
 
match 2, group 2 start = 10  
 
</pre>
 
</pre>
 +
}}
 +
[[Category:String Function]]

Latest revision as of 11:53, 10 March 2009

getGroupStart() Function

Introduced in version 1.3b48
Returns the start index of the specified capture group for the specified match that was found using strfind()

Usage

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