Wrapper around C++11 regular expressions. More...

Public Types
typedef std::smatch	results_type
	Type for matches. More...

Public Member Functions
	regExpCxx ()
	Construct null. More...

	regExpCxx (const regExpCxx &rgx)
	Copy construct. More...

	regExpCxx (regExpCxx &&rgx)
	Move construct. More...

	regExpCxx (const char *pattern)
	Construct from character array. More...

	regExpCxx (const std::string &pattern)
	Construct from string. More...

	regExpCxx (const char *pattern, bool ignoreCase)
	Construct from character array, optionally ignore case. More...

	regExpCxx (const std::string &pattern, bool ignoreCase)
	Construct from string, optionally ignore case. More...

	~regExpCxx ()=default
	Destructor. More...

bool	empty () const noexcept
	Return true if expression is empty. More...

bool	exists () const noexcept
	Return true if expression is non-empty. More...

unsigned	ngroups () const
	The number of capture groups for a non-empty expression. More...

bool	nocase () const

bool	clear ()
	Clear expression. More...

void	swap (regExpCxx &rgx)
	Swap contents. More...

bool	set (const char *pattern, bool ignoreCase=false)
	Compile pattern into a regular expression, optionally ignore case. More...

bool	set (const std::string &pattern, bool ignoreCase=false)
	Compile pattern into a regular expression, optionally ignore case. More...

std::string::size_type	find (const std::string &text) const
	Find position within the text. More...

bool	match (const std::string &text) const
	True if the regex matches the entire text. More...

bool	match (const std::string &text, results_type &matches) const
	True if the regex matches the text, set the matches. More...

bool	search (const std::string &text) const
	Return true if the regex was found within the text. More...

bool	operator() (const std::string &text) const
	Perform match on text. More...

void	operator= (const regExpCxx &rgx)
	Copy assignment. More...

void	operator= (regExpCxx &&rgx)
	Move assignment. More...

void	operator= (const char *pattern)
	Assign and compile pattern from a character array. More...

void	operator= (const std::string &pattern)
	Assign and compile pattern from string. More...

Static Public Member Functions
static bool	meta (const char c)
	Test if character appears to be a regular expression meta-character. More...

Static Public Attributes
static int	grammar
	The default grammar (extended \| ECMAScript). More...

Detailed Description

Wrapper around C++11 regular expressions.

Using either POSIX extended regular expressions or modified ECMAScript regular expression grammar

Since ECMAScript grammar may not work correctly on all installations, the current default is to use extended regular expressions.

The JAVA/PCRE '(?i)' extension is supported as a prefix to compile the regular expression as being case-insensitive.

Note: The C++11 regular expressions may be broken on some compilers. For example, gcc 4.8 is known to fail. For these systems the POSIX implementation or alternative must be used.

Warning: This class should not be used directly. Use the Foam::regExp typedef instead.

Source files

Definition at line 72 of file regExpCxx.H.

Member Typedef Documentation

◆ results_type

typedef std::smatch results_type

Type for matches.

Definition at line 93 of file regExpCxx.H.

Constructor & Destructor Documentation

◆ regExpCxx() [1/7]

regExpCxx ( )

inline

Construct null.

Definition at line 56 of file regExpCxxI.H.

◆ regExpCxx() [2/7]

regExpCxx ( const regExpCxx & rgx )

inline

Copy construct.

Definition at line 63 of file regExpCxxI.H.

◆ regExpCxx() [3/7]

regExpCxx ( regExpCxx && rgx )

inline

Move construct.

Definition at line 70 of file regExpCxxI.H.

◆ regExpCxx() [4/7]

regExpCxx ( const char * pattern )

inlineexplicit

Construct from character array.

Definition at line 79 of file regExpCxxI.H.

References regExpCxx::set().

Here is the call graph for this function:

◆ regExpCxx() [5/7]

regExpCxx ( const std::string & pattern )

inlineexplicit

Construct from string.

Definition at line 88 of file regExpCxxI.H.

References regExpCxx::set().

Here is the call graph for this function:

◆ regExpCxx() [6/7]

regExpCxx	(	const char *	pattern,
		bool	ignoreCase
	)

inline

Construct from character array, optionally ignore case.

Definition at line 97 of file regExpCxxI.H.

References regExpCxx::set().

Here is the call graph for this function:

◆ regExpCxx() [7/7]

regExpCxx	(	const std::string &	pattern,
		bool	ignoreCase
	)

inline

Construct from string, optionally ignore case.

Definition at line 106 of file regExpCxxI.H.

References regExpCxx::set().

Here is the call graph for this function:

◆ ~regExpCxx()

~regExpCxx ( )

default

Destructor.

Member Function Documentation

◆ meta()

bool meta ( const char c )

inlinestatic

Test if character appears to be a regular expression meta-character.

Returns

true if character is one of the following:

any character: '.'
quantifiers: '*', '+', '?'
grouping: '(', '|', ')'
range: '[', ']'

Note: The presence of '{', '}' regex bounds is not considered

Definition at line 42 of file regExpCxxI.H.

References Foam::constant::universal::c.

Referenced by wordRe::meta().

Here is the caller graph for this function:

◆ empty()

bool empty ( ) const

inlinenoexcept

Return true if expression is empty.

Definition at line 117 of file regExpCxxI.H.

◆ exists()

bool exists ( ) const

inlinenoexcept

Return true if expression is non-empty.

Definition at line 123 of file regExpCxxI.H.

◆ ngroups()

unsigned ngroups ( ) const

inline

The number of capture groups for a non-empty expression.

Definition at line 129 of file regExpCxxI.H.

◆ nocase()

bool nocase ( ) const

inline

Definition at line 135 of file regExpCxxI.H.

◆ clear()

bool clear ( )

inline

Clear expression.

Returns: True if expression had existed prior to the clear.

Definition at line 141 of file regExpCxxI.H.

Referenced by regExpCxx::set().

Here is the caller graph for this function:

◆ swap()

void swap ( regExpCxx & rgx )

inline

Swap contents.

Definition at line 155 of file regExpCxxI.H.

◆ set() [1/2]

bool set	(	const char *	pattern,
		bool	ignoreCase = `false`
	)

Compile pattern into a regular expression, optionally ignore case.

Returns: True if the pattern was compiled

Definition at line 111 of file regExpCxx.C.

References regExpCxx::clear(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.

Referenced by regExpCxx::regExpCxx().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set() [2/2]

bool set	(	const std::string &	pattern,
		bool	ignoreCase = `false`
	)

Compile pattern into a regular expression, optionally ignore case.

Returns: True if the pattern was compiled

Definition at line 160 of file regExpCxx.C.

References clear(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.

Here is the call graph for this function:

◆ find()

std::string::size_type find ( const std::string & text ) const

inline

Find position within the text.

Returns: The index where it begins or string::npos if not found

Definition at line 167 of file regExpCxxI.H.

◆ match() [1/2]

bool match ( const std::string & text ) const

inline

True if the regex matches the entire text.

The begin-of-line (^) and end-of-line ($) anchors are implicit

Definition at line 185 of file regExpCxxI.H.

Referenced by keyType::match(), and STARCDsurfaceFormatCore::readInpCellTable().

Here is the caller graph for this function:

◆ match() [2/2]

bool match	(	const std::string &	text,
		results_type &	matches
	)		const

inline

True if the regex matches the text, set the matches.

The first group starts at index 1 (0 is the entire match). The begin-of-line (^) and end-of-line ($) anchors are implicit

Definition at line 192 of file regExpCxxI.H.

◆ search()

bool search ( const std::string & text ) const

inline

Return true if the regex was found within the text.

Definition at line 179 of file regExpCxxI.H.

◆ operator()()

bool operator() ( const std::string & text ) const

inline

Perform match on text.

Definition at line 203 of file regExpCxxI.H.

References Foam::stringOps::match().

Here is the call graph for this function:

◆ operator=() [1/4]

void operator= ( const regExpCxx & rgx )

inline

Copy assignment.

Definition at line 209 of file regExpCxxI.H.

◆ operator=() [2/4]

void operator= ( regExpCxx && rgx )

inline

Move assignment.

Definition at line 216 of file regExpCxxI.H.

References clear().

Here is the call graph for this function:

◆ operator=() [3/4]

void operator= ( const char * pattern )

inline

Assign and compile pattern from a character array.

Matching is case sensitive.

Definition at line 223 of file regExpCxxI.H.

References Foam::BitOps::set().

Here is the call graph for this function:

◆ operator=() [4/4]

void operator= ( const std::string & pattern )

inline

Assign and compile pattern from string.

Matching is case sensitive.

Definition at line 229 of file regExpCxxI.H.

References Foam::BitOps::set().

Here is the call graph for this function:

Member Data Documentation

◆ grammar

int grammar

static

The default grammar (extended | ECMAScript).

Definition at line 99 of file regExpCxx.H.

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

src/OpenFOAM/primitives/strings/regex/regExpCxx.H
src/OpenFOAM/primitives/strings/regex/regExpCxx.C
src/OpenFOAM/primitives/strings/regex/regExpCxxI.H

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ results_type

Constructor & Destructor Documentation

◆ regExpCxx() [1/7]

◆ regExpCxx() [2/7]

◆ regExpCxx() [3/7]

◆ regExpCxx() [4/7]

◆ regExpCxx() [5/7]

◆ regExpCxx() [6/7]

◆ regExpCxx() [7/7]

◆ ~regExpCxx()

Member Function Documentation

◆ meta()

◆ empty()

◆ exists()

◆ ngroups()

◆ nocase()

◆ clear()

◆ swap()

◆ set() [1/2]

◆ set() [2/2]

◆ find()

◆ match() [1/2]

◆ match() [2/2]

◆ search()

◆ operator()()

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

Member Data Documentation

◆ grammar