FSRegexMatch

A single occurence of a regular expression.

Superclass: NSObject
Declared In: FSRegex.h

Discussion

An FSRegexMatch represents a single occurence of a regular expression within the target string. The range of each subpattern within the target string is returned by -range, -rangeAtIndex:, or -rangeNamed:. The part of the target string that matched each subpattern is returned by -group, -groupAtIndex:, or -groupNamed:.

Methods

-count
-group
-groupAtIndex:
-groupNamed:
-range
-rangeAtIndex:
-rangeNamed:
-string

count

- (int)count;

Discussion

The number of capturing subpatterns, including the pattern itself.

group

- (NSString *)group;

Discussion

Returns the part of the target string that matched the pattern.

groupAtIndex:

- (NSString *)groupAtIndex:(int)idx;

Discussion

Returns the part of the target string that matched the subpattern at the given index or nil if it wasn't matched. The subpatterns are indexed in order of their opening parentheses, 0 is the entire pattern, 1 is the first capturing subpattern, and so on.

groupNamed:

- (NSString *)groupNamed:(NSString *)name;

Discussion

Returns the part of the target string that matched the subpattern of the given name or nil if it wasn't matched.

range

- (NSRange)range;

Discussion

Returns the range of the target string that matched the pattern.

rangeAtIndex:

- (NSRange)rangeAtIndex:(int)idx;

Discussion

Returns the range of the target string that matched the subpattern at the given index or {NSNotFound, 0} if it wasn't matched. The subpatterns are indexed in order of their opening parentheses, 0 is the entire pattern, 1 is the first capturing subpattern, and so on.

rangeNamed:

- (NSRange)rangeNamed:(NSString *)name;

Discussion

Returns the range of the target string that matched the subpattern of the given name or {NSNotFound, 0} if it wasn't matched.

string

- (NSString *)string;

Discussion

Returns the target string.