RegexPattern Class Reference

Class RegexPattern represents a compiled regular expression. More...

#include <regex.h>

Inheritance diagram for RegexPattern:
UObject UMemory

Public Member Functions

 RegexPattern ()
 default constructor.
 RegexPattern (const RegexPattern &source)
 Copy Constructor.
virtual ~RegexPattern ()
 Destructor.
UBool operator== (const RegexPattern &that) const
 Comparison operator.
UBool operator!= (const RegexPattern &that) const
 Comparison operator.
RegexPatternoperator= (const RegexPattern &source)
 Assignment operator.
virtual RegexPatternclone () const
 Create an exact copy of this RegexPattern object.
virtual uint32_t flags () const
 Get the match mode flags that were used when compiling this pattern.
virtual RegexMatchermatcher (const UnicodeString &input, UErrorCode &status) const
 Creates a RegexMatcher that will match the given input against this pattern.
virtual RegexMatchermatcher (UErrorCode &status) const
 Creates a RegexMatcher that will match against this pattern.
virtual UnicodeString pattern () const
 Returns the regular expression from which this pattern was compiled.
virtual int32_t split (const UnicodeString &input, UnicodeString dest[], int32_t destCapacity, UErrorCode &status) const
 Split a string into fields.
virtual UClassID getDynamicClassID () const
 ICU "poor man's RTTI", returns a UClassID for the actual class.

Static Public Member Functions

static RegexPatterncompile (const UnicodeString &regex, UParseError &pe, UErrorCode &status)
 Compiles the regular expression in string form into a RegexPattern object.
static RegexPatterncompile (const UnicodeString &regex, uint32_t flags, UParseError &pe, UErrorCode &status)
 Compiles the regular expression in string form into a RegexPattern object using the specified match mode flags.
static RegexPatterncompile (const UnicodeString &regex, uint32_t flags, UErrorCode &status)
 Compiles the regular expression in string form into a RegexPattern object using the specified match mode flags.
static UBool matches (const UnicodeString &regex, const UnicodeString &input, UParseError &pe, UErrorCode &status)
 Test whether a string matches a regular expression.
static UClassID getStaticClassID ()
 ICU "poor man's RTTI", returns a UClassID for this class.

Friends

class RegexCompile
class RegexMatcher
class RegexCImpl

Detailed Description

Class RegexPattern represents a compiled regular expression.

It includes factory methods for creating a RegexPattern object from the source (string) form of a regular expression, methods for creating RegexMatchers that allow the pattern to be applied to input text, and a few convenience methods for simple common uses of regular expressions.

Class RegexPattern is not intended to be subclassed.

Stable:
ICU 2.4

Definition at line 98 of file regex.h.


Constructor & Destructor Documentation

RegexPattern::RegexPattern (  ) 

default constructor.

Create a RegexPattern object that refers to no actual pattern. Not normally needed; RegexPattern objects are usually created using the factory method compile().

Stable:
ICU 2.4
RegexPattern::RegexPattern ( const RegexPattern source  ) 

Copy Constructor.

Create a new RegexPattern object that is equivalent to the source object.

Parameters:
source the pattern object to be copied.
Stable:
ICU 2.4
virtual RegexPattern::~RegexPattern (  )  [virtual]

Destructor.

Note that a RegexPattern object must persist so long as any RegexMatcher objects that were created from the RegexPattern are active.

Stable:
ICU 2.4

Member Function Documentation

virtual RegexPattern* RegexPattern::clone (  )  const [virtual]

Create an exact copy of this RegexPattern object.

Since RegexPattern is not intended to be subclasses, clone() and the copy construction are equivalent operations.

Returns:
the copy of this RegexPattern
Stable:
ICU 2.4
static RegexPattern* RegexPattern::compile ( const UnicodeString regex,
uint32_t  flags,
UErrorCode status 
) [static]

Compiles the regular expression in string form into a RegexPattern object using the specified match mode flags.

These compile methods, rather than the constructors, are the usual way that RegexPattern objects are created.

Note that RegexPattern objects must not be deleted while RegexMatcher objects created from the pattern are active. RegexMatchers keep a pointer back to their pattern, so premature deletion of the pattern is a catastrophic error.

Note that it is often more convenient to construct a RegexMatcher directly from a pattern string instead of than separately compiling the pattern and then creating a RegexMatcher object from the pattern.

Parameters:
regex The regular expression to be compiled.
flags The match mode flags to be used.
status A reference to a UErrorCode to receive any errors.
Returns:
A regexPattern object for the compiled pattern.
Stable:
ICU 2.6
static RegexPattern* RegexPattern::compile ( const UnicodeString regex,
uint32_t  flags,
UParseError pe,
UErrorCode status 
) [static]

Compiles the regular expression in string form into a RegexPattern object using the specified match mode flags.

These compile methods, rather than the constructors, are the usual way that RegexPattern objects are created.

Note that RegexPattern objects must not be deleted while RegexMatcher objects created from the pattern are active. RegexMatchers keep a pointer back to their pattern, so premature deletion of the pattern is a catastrophic error.

Note that it is often more convenient to construct a RegexMatcher directly from a pattern string instead of than separately compiling the pattern and then creating a RegexMatcher object from the pattern.

Parameters:
regex The regular expression to be compiled.
flags The match mode flags to be used.
pe Receives the position (line and column nubers) of any error within the regular expression.)
status A reference to a UErrorCode to receive any errors.
Returns:
A regexPattern object for the compiled pattern.
Stable:
ICU 2.4
static RegexPattern* RegexPattern::compile ( const UnicodeString regex,
UParseError pe,
UErrorCode status 
) [static]

Compiles the regular expression in string form into a RegexPattern object.

These compile methods, rather than the constructors, are the usual way that RegexPattern objects are created.

Note that RegexPattern objects must not be deleted while RegexMatcher objects created from the pattern are active. RegexMatchers keep a pointer back to their pattern, so premature deletion of the pattern is a catastrophic error.

All pattern match mode flags are set to their default values.

Note that it is often more convenient to construct a RegexMatcher directly from a pattern string rather than separately compiling the pattern and then creating a RegexMatcher object from the pattern.

Parameters:
regex The regular expression to be compiled.
pe Receives the position (line and column nubers) of any error within the regular expression.)
status A reference to a UErrorCode to receive any errors.
Returns:
A regexPattern object for the compiled pattern.
Stable:
ICU 2.4
virtual uint32_t RegexPattern::flags (  )  const [virtual]

Get the match mode flags that were used when compiling this pattern.

Returns:
the match mode flags
Stable:
ICU 2.4
virtual UClassID RegexPattern::getDynamicClassID (  )  const [virtual]

ICU "poor man's RTTI", returns a UClassID for the actual class.

Stable:
ICU 2.4

Implements UObject.

static UClassID RegexPattern::getStaticClassID (  )  [static]

ICU "poor man's RTTI", returns a UClassID for this class.

Stable:
ICU 2.4
virtual RegexMatcher* RegexPattern::matcher ( UErrorCode status  )  const [virtual]

Creates a RegexMatcher that will match against this pattern.

The RegexMatcher can be used to perform match, find or replace operations. Note that a RegexPattern object must not be deleted while RegexMatchers created from it still exist and might possibly be used again.

Parameters:
status A reference to a UErrorCode to receive any errors.
Returns:
A RegexMatcher object for this pattern and input.
Stable:
ICU 2.6
virtual RegexMatcher* RegexPattern::matcher ( const UnicodeString input,
UErrorCode status 
) const [virtual]

Creates a RegexMatcher that will match the given input against this pattern.

The RegexMatcher can then be used to perform match, find or replace operations on the input. Note that a RegexPattern object must not be deleted while RegexMatchers created from it still exist and might possibly be used again.

The matcher will retain a reference to the supplied input string, and all regexp pattern matching operations happen directly on this original string. It is critical that the string not be altered or deleted before use by the regular expression operations is complete.

Parameters:
input The input string to which the regular expression will be applied.
status A reference to a UErrorCode to receive any errors.
Returns:
A RegexMatcher object for this pattern and input.
Stable:
ICU 2.4
static UBool RegexPattern::matches ( const UnicodeString regex,
const UnicodeString input,
UParseError pe,
UErrorCode status 
) [static]

Test whether a string matches a regular expression.

This convenience function both compiles the reguluar expression and applies it in a single operation. Note that if the same pattern needs to be applied repeatedly, this method will be less efficient than creating and reusing a RegexMatcher object.

Parameters:
regex The regular expression
input The string data to be matched
pe Receives the position of any syntax errors within the regular expression
status A reference to a UErrorCode to receive any errors.
Returns:
True if the regular expression exactly matches the full input string.
Stable:
ICU 2.4
UBool RegexPattern::operator!= ( const RegexPattern that  )  const [inline]

Comparison operator.

Two RegexPattern objects are considered equal if they were constructed from identical source patterns using the same match flag settings.

Parameters:
that a RegexPattern object to compare with "this".
Returns:
TRUE if the objects are different.
Stable:
ICU 2.4

Definition at line 143 of file regex.h.

RegexPattern& RegexPattern::operator= ( const RegexPattern source  ) 

Assignment operator.

After assignment, this RegexPattern will behave identically to the source object.

Stable:
ICU 2.4
UBool RegexPattern::operator== ( const RegexPattern that  )  const

Comparison operator.

Two RegexPattern objects are considered equal if they were constructed from identical source patterns using the same match flag settings.

Parameters:
that a RegexPattern object to compare with "this".
Returns:
TRUE if the objects are equivalent.
Stable:
ICU 2.4
virtual UnicodeString RegexPattern::pattern (  )  const [virtual]

Returns the regular expression from which this pattern was compiled.

Stable:
ICU 2.4
virtual int32_t RegexPattern::split ( const UnicodeString input,
UnicodeString  dest[],
int32_t  destCapacity,
UErrorCode status 
) const [virtual]

Split a string into fields.

Somewhat like split() from Perl. The pattern matches identify delimiters that separate the input into fields. The input data between the matches becomes the fields themselves.

For the best performance on split() operations, RegexMatcher::split is perferable to this function

Parameters:
input The string to be split into fields. The field delimiters match the pattern (in the "this" object)
dest An array of UnicodeStrings to receive the results of the split. This is an array of actual UnicodeString objects, not an array of pointers to strings. Local (stack based) arrays can work well here.
destCapacity The number of elements in the destination array. If the number of fields found is less than destCapacity, the extra strings in the destination array are not altered. If the number of destination strings is less than the number of fields, the trailing part of the input string, including any field delimiters, is placed in the last destination string.
status A reference to a UErrorCode to receive any errors.
Returns:
The number of fields into which the input string was split.
Stable:
ICU 2.4

The documentation for this class was generated from the following file:
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on Sat Jan 23 15:17:43 2010 for ICU 4.3.4 by  doxygen 1.6.1