GPL_RegularExpression

gpl

1998 12-05

CLASS

SYNOPSIS

PARENTS

CONSTRUCTORS

GPL_RegularExpression(const GPL_String & str)
Set the regular expression according to the pattern str.

MEMBER FUNCTIONS

GPL_String GetPattern(void) const
Return the pattern string.



Error GetLastError(void) const
Return the last error encountered.



GPL_Integer GetSubExpressionCount(void) const
Return the number of parenthesized sub-expressions in the regular expression.



GPL_Integer GetComplexity(void) const
Return a number indicating the complexity of a given regular expression relative to other regular expressions.



GPL_String GetMatch(const unsigned long index = 0) const
Return the sub-string which was matched by the parenthesized sub-expression indicated by index. Sub-expression 0 is the entire regular expression.



GPL_Boolean SetPattern(const GPL_String & str)
Set the regular expression according to the pattern str. Return TRUE if str is a valid pattern and FALSE otherwise.



GPL_Integer Compare(const GPL_RegularExpression & re) const
Return -1, 0, or 1 if the regular expression is less than, equal to, or greater than re, respectively.



GPL_Boolean Matches(const GPL_String & str, const unsigned long at)
Return TRUE if the sub-string of str starting at at matches the regular expression and FALSE otherwise. Any expression matches are stored as offsets into str. Thus, matches will only be valid if str itself persists. If str is a temporary constructed by the compiler because a char * value was given as the first argument, str will be destructed when Matches() returns and all subsequent matches will be invalid.

MEMBER DATA

static const char metaCharacters[]
Characters which have special meaning inside regular expression and thus may need to be escaped (i.e., preceded by '\\').

SEE ALSO