CoreComponents 3.0.0
A Modern C++ Toolkit
Loading...
Searching...
No Matches
Pattern Class Referencefinal

Regular expression pattern. More...

#include <cc/Pattern>

Inheritance diagram for Pattern:

Public Member Functions

 Pattern ()=default
 Create a null pattern.
 
 Pattern (const String &text)
 Create a new pattern from a regular expression text.
 
bool match (const String &text, Out< List< Range > > captures=None{}) const
 Match text against this pattern
 
Range findIn (const String &text, InOut< long > offset=None{}) const
 Find the next occurrence of this pattern.
 
List< StringbreakUp (const String &text) const
 Break up text into the non-matching parts.
 
long matchLength () const
 Exact length of a match if not variable.
 
List< Stringexplain () const
 Return a textual representation of the compiled pattern expression
 
String text () const
 The regular expression text this pattern was created from.
 
- Public Member Functions inherited from Object
 Object ()=default
 Create a null object.
 
 operator bool () const
 Check if this is a non-null object.
 
bool isNull () const
 Check if this is a null object.
 
template<class T >
bool is () const
 Check if this object is of type T.
 
template<class T >
as () const
 Cast this object to type T.
 
bool isWeak () const
 Check if the underlying object reference is weak.
 
bool operator== (const Object &other) const
 Equality operator.
 
std::strong_ordering operator<=> (const Object &other) const
 Ordering operator.
 
long useCount () const
 Reference count.
 

Additional Inherited Members

- Protected Member Functions inherited from Object
template<class T >
weak () const
 
template<class T >
void initOnce ()
 Create the object state when called the first time.
 
template<class T >
void initOncePerThread ()
 Create a distinct object state for each thread when called the first time in that thread.
 
 Object (State *newState)
 Initialize object with newState.
 
 Object (State *state, Alias)
 
 Object (State *state, Weak)
 
Objectoperator= (std::nullptr_t)
 
- Static Protected Member Functions inherited from Object
template<class T >
static T alias (const State *state)
 Create an alias object for the given state.
 
template<class T >
static T weak (const State *state)
 
- Protected Attributes inherited from Object
Handle< Stateme
 Internal object state
 

Detailed Description

Regular expression pattern.

Exceptions
TextError

Constructor & Destructor Documentation

◆ Pattern() [1/2]

Pattern ( )
default

Create a null pattern.

◆ Pattern() [2/2]

Pattern ( const String & text)

Create a new pattern from a regular expression text.

Member Function Documentation

◆ match()

bool match ( const String & text,
Out< List< Range > > captures = None{} ) const

Match text against this pattern

Parameters
textCandidate input text
capturesMatching Range for each matching grouped sub-expression (in brackets)
Returns
True if text matches

◆ findIn()

Range findIn ( const String & text,
InOut< long > offset = None{} ) const

Find the next occurrence of this pattern.

Parameters
textText to search in
offsetProvide start offset and return final offset
Returns
Valid range if a match could be found in text

◆ breakUp()

List< String > breakUp ( const String & text) const

Break up text into the non-matching parts.

◆ matchLength()

long matchLength ( ) const

Exact length of a match if not variable.

◆ explain()

List< String > explain ( ) const

Return a textual representation of the compiled pattern expression

◆ text()

String text ( ) const

The regular expression text this pattern was created from.