ALib C++ Library
Library Version: 2402 R1
Documentation generated by doxygen
No Matches
RegexMatcher Class Reference


This utility class wraps boost::regex library and interfaces ALib Strings with it.

The availability of the class is dependent on compiler symbol ALIB_FEAT_BOOST_REGEX which has to be true, and in parallel either ALIB_CHARACTERS_WIDE is false or ALIB_CHARACTERS_NATIVE_WCHAR equals true.

Method Compile accepts the pattern string and compiles it to boost::regex. Subsequent invocations of Match will then use the compiled regular expression for testing a given string.

The syntax of the regular expressions is compatible to Perl Regular Expressions .

This a most very basic wrapper that supports a just the bare minimum of the features available in the original boost::regex library. I.e, the expression syntax is fixed to be Perl-compatible and no string replacement features or even match positioning are available.

Definition at line 41 of file regexmatcher.hpp.

#include <regexmatcher.hpp>

Public Method Index:

 RegexMatcher (const String &pattern=NullString())
ALIB_API ~RegexMatcher ()
ALIB_API void Compile (const String &pattern)
ALIB_API bool Match (const String &haystack)

Field Details:

◆ boostRegex

void* boostRegex = nullptr

This is the internal regex matcher. Yes, a nasty reinterpret_cast is performed in the compilation unit. This is for avoiding the inclusion of external headers with ALib headers at the expense of an otherwise unnecessary heap allocation.

Definition at line 49 of file regexmatcher.hpp.

Constructor(s) / Destructor Details::

◆ RegexMatcher()

RegexMatcher ( const String & pattern = NullString())

Constructs a RegexMatcher to work on a given string. Passes the optional parameters to method Compile.

patternThe string pattern to match. Defaults to NullString() to allow parameterless construction, with later invocation of Compile.

Definition at line 60 of file regexmatcher.hpp.

Here is the call graph for this function:

◆ ~RegexMatcher()


Definition at line 34 of file regexmatcher.cpp.

Method Details:

◆ Compile()

void Compile ( const String & pattern)

Resets this object to use the given pattern.

patternThe string pattern to match.

Definition at line 40 of file regexmatcher.cpp.

Here is the call graph for this function:

◆ Match()

bool Match ( const String & haystack)

Tests if given haystack matches the actual pattern. If Compile was not invoked or an empty pattern string was given, true is returned.

haystackThe string to test.
true if given haystack matches the actual pattern, false otherwise.

Definition at line 54 of file regexmatcher.cpp.

Here is the call graph for this function:

The documentation for this class was generated from the following files: