Pike Module Reference:

Creates a regex object.

The pattern to be used for matching.

Any of the following options ORed together.

Case insensitive matching

The ^ and $ special characters match based on \n characters within the string

The . special character will match anything, including \n

Allow comments using # and ignore unescaped whitespace within the pattern

Force the pattern to only match at the first matching point in the string

The $ special character will not match a final \n at the end of the string

Throw an error when the pattern contains a backslash followed by a letter which has no special meaning

Invert the greediness of matching.

Treat the pattern and subject strings as UTF8 strings. Will throw an error if used when pcre was not compiled with utf8 support

Disable automatic substring capturing. Named substrings may still be used.

Returns 1 if subject matches the pattern, or 0 if it does not.

The string to search.

The offset into the subject to begin searching.

Returns the number of times the pattern matches subject, or an array with the first element the number of matches, and the second element an array of the matched substrings if substrings is not 0.

The string to search.

The offset into the subject to begin searching.

Stop searching for more matches once this many matches have been found.

In addition to the number of matches, also return an array containing the matches that were found. Each element in this array is another array, where element 0 is the entire match, and each element after that is a captured substring.

Returns the subject with any matches replaced, or an array with the first element the replaced subject, and the second element an array of the matched substrings if substrings is not 0.

The string to search and replace in.

If replacement is a string, each match in subject will be replaced with this string. If replacement is a function, it will be called for each match, and the matching part of subject will be replaced with the string returned. This function is passed an array of strings, where element 0 is the entire match, and each element after that is a captured substring.

The offset into the subject to begin searching.

Stop searching for more matches once this many replacments have been done.

In addition to the replaced subject, also return an array containing the matches that were found. Each element in this array is another array, where element 0 is the entire match, and each element after that is a captured substring.

Returns an array of strings containing the parts of the subject split on the pattern, or an array with the first element the array of the split subject, and the second element an array of the matched substrings if substrings is not 0.

The string to split.

The offset into the subject to begin searching.

Stop searching for more matches to split on once this many matches have been found.

In addition to the split subject, also return an array containing the matches that were found. Each element in this array is another array, where element 0 is the entire match, and each element after that is a captured substring.