# regex.h File Reference

C++ API: Regular Expressions. More...

`#include "unicode/utypes.h"`
`#include "unicode/uobject.h"`
`#include "unicode/unistr.h"`
`#include "unicode/parseerr.h"`
`#include "unicode/uregex.h"`

Go to the source code of this file.

## Data Structures
class | RegexPattern
| Class `RegexPattern` represents a compiled regular expression. More...
class | RegexMatcher
| class RegexMatcher bundles together a reular expression pattern and input text to which the expression can be applied. More...
## Defines
#define | RegexPatternDump(pat)
| RBBIPatternDump Debug function, displays the compiled form of a pattern.

## Detailed Description

C++ API: Regular Expressions.

## Regular Expression API

The ICU API for processing regular expressions consists of two classes, `RegexPattern` and `RegexMatcher`. `RegexPattern` objects represent a pre-processed, or compiled regular expression. They are created from a regular expression pattern string, and can be used to create `RegexMatcher` objects for the pattern.

Class `RegexMatcher` bundles together a regular expression pattern and a target string to which the search pattern will be applied. `RegexMatcher` includes API for doing plain find or search operations, for search and replace operations, and for obtaining detailed information about bounds of a match.

Note that by constructing `RegexMatcher` objects directly from regular expression pattern strings application code can be simplified and the explicit need for `RegexPattern` objects can usually be eliminated.

Definition in file regex.h.

## Define Documentation

#define RegexPatternDump | ( | pat |  | ) |

RBBIPatternDump Debug function, displays the compiled form of a pattern.

Internal:
  Do not use. This API is for internal use only.

Definition at line 81 of file regex.h.