wordRe Class Reference

A wordRe is a Foam::word, but can contain a regular expression for matching words or strings. More...

#include <wordRe.H>

Inheritance diagram for wordRe:

Collaboration diagram for wordRe:

Public Types
enum	compOption {   LITERAL = 0 , REGEX = 1 , ICASE = 2 , NOCASE = 2 ,   DETECT = 4 , UNKNOWN = 4 , REGEX_ICASE = (REGEX|ICASE) , DETECT_ICASE = (DETECT|ICASE) }
	Enumeration with compile options. More...

Public Member Functions
	wordRe ()
	Default construct, empty literal.
	wordRe (const wordRe &str)
	Copy construct.
	wordRe (wordRe &&str)
	Move construct.
	wordRe (const word &str)
	Implicit copy construct from word, as LITERAL.
	wordRe (word &&str)
	Implicit move construct from word, as LITERAL.
	wordRe (const std::string &str, const compOption opt=compOption::LITERAL)
	Implicit copy construct from other string-types, with specified compile option (default is LITERAL).
	wordRe (const char *str, const compOption opt=compOption::LITERAL)
	Implicit construct from character array, with specified compile option (default is LITERAL).
	wordRe (const keyType &str)
	Implicit copy construct from keyType, using its compile type.
	wordRe (Istream &is)
	Construct from Istream by reading a token.
bool	isLiteral () const noexcept
	The wordRe is a literal string, not a pattern.
bool	isPattern () const noexcept
	The wordRe is a pattern, not a literal string.
bool	assign (const token &tok)
	Assign from word or string token.
bool	compile ()
	Compile as regular expression (if possible).
void	uncompile ()
	Mark as literal string, remove any regular expression.
bool	compile (const compOption opt)
	Possibly compile the regular expression, with greater control.
void	uncompile (bool adjust)
	Mark as literal string, optionally stripping invalid word characters when changing to a literal.
void	set (const std::string &str, const compOption opt=DETECT)
	Copy string, auto-test for regular expression or other options.
void	set (const char *str, const compOption opt=DETECT)
	Copy string, auto-test for regular expression or other options.
void	clear ()
	Clear string and regular expression.
void	swap (wordRe &str)
	Swap contents. Self-swapping is a no-op.
bool	match (const std::string &text, bool literal=false) const
	Smart match as regular expression or as a string.
bool	operator() (const std::string &text) const
	Perform smart match on text, as per match().
void	operator= (const wordRe &str)
	Copy assignment, retaining type (literal or regex).
void	operator= (const word &str)
	Copy word, never a regular expression.
void	operator= (const keyType &str)
	Copy keyType and its type (literal or regex).
void	operator= (const string &str)
	Copy string, auto-test for regular expression.
void	operator= (const std::string &str)
	Copy string, auto-test for regular expression.
void	operator= (const char *str)
	Copy string, auto-test for regular expression.
void	operator= (wordRe &&str)
	Move assignment.
Public Member Functions inherited from word
	word ()=default
	Default construct.
	word (const word &)=default
	Copy construct.
	word (word &&w)=default
	Move construct.
	word (const string &s, bool doStrip=true)
	Copy construct from Foam::string.
	word (string &&s, bool doStrip=true)
	Move construct from Foam::string.
	word (const std::string &s, bool doStrip=true)
	Copy construct from std::string.
	word (std::string &&s, bool doStrip=true)
	Move construct from std::string.
	word (const char *s, bool doStrip=true)
	Copy from character array.
	word (const char *s, size_type len, bool doStrip)
	Copy from buffer for a maximum number of characters.
	word (Istream &is)
	Construct from Istream.
void	stripInvalid ()
	Strip invalid characters from this word.
word	ext () const
	Return file name extension (part after last .).
word &	ext (const word &ending)
	Append a '.' and the ending, and return the object.
word &	replace_ext (const word &ending)
	Remove extension (if any) and append a new one.
word	lessExt () const
	Return word without extension (part before last .).
word &	operator= (const word &s)
	Copy assignment, no character validation required.
word &	operator= (word &&s)
	Move assignment, no character validation required.
word &	operator= (const string &s)
	Copy assignment from Foam::string, stripping invalid characters.
word &	operator= (string &&s)
	Move assignment from Foam::string, stripping invalid characters.
word &	operator= (const std::string &s)
	Copy assignment from std::string, stripping invalid characters.
word &	operator= (std::string &&s)
	Move assignment from std::string, stripping invalid characters.
word &	operator= (const char *s)
	Copy, stripping invalid characters.
bool	hasExt () const
	Same as has_ext().
bool	hasExt (const std::string &s) const
	Same as has_ext().
bool	removeExt ()
	Same as remove_ext().
template<class PrimitiveType>
Foam::word	printf (const char *fmt, const PrimitiveType &val)
template<class PrimitiveType>
Foam::word	printf (const std::string &fmt, const PrimitiveType &val)
bool	remove_ext ()
	Remove extension, return true if string changed.
bool	has_ext () const
	Various checks for extensions.
bool	has_ext (const char *ending) const
	Various checks for extensions.
bool	has_ext (const std::string &ending) const
	Various checks for extensions.
bool	has_ext (const wordRe &ending) const
	Various checks for extensions.
Public Member Functions inherited from string
	string ()=default
	Default construct.
	string (const std::string &str)
	Copy construct from std::string.
	string (std::string &&str)
	Move construct from std::string.
	string (const char *str)
	Construct as copy of character array.
	string (const char *str, const size_type len)
	Construct as copy with a maximum number of characters.
	string (const char c)
	Construct from a single character.
	string (const size_type len, const char c)
	Construct fill copies of a single character.
	string (Istream &is)
	Construct from Istream.
bool	match (const std::string &text) const
	Test for equality.
string &	replace (const std::string &s1, const std::string &s2, size_type pos=0)
	Replace first occurrence of sub-string s1 with s2, beginning at pos.
string &	replaceAll (const std::string &s1, const std::string &s2, size_type pos=0)
	Replace all occurrences of sub-string s1 with s2, beginning at pos in the string.
string &	replaceAny (const std::string &s1, const char c2, size_type pos=0)
	Replace any occurrence of s1 characters with c2, beginning at pos in the string.
string &	expand (const bool allowEmpty=false)
	Inplace expand initial tags, tildes, and all occurrences of environment variables as per stringOps::expand.
bool	removeRepeated (const char character)
	Remove repeated characters.
bool	removeStart (const std::string &text)
	Remove the given text from the start of the string.
bool	removeStart (const char c)
	Remove leading character, unless string is a single character.
bool	removeEnd (const std::string &text)
	Remove the given text from the end of the string.
bool	removeEnd (const char c)
	Remove trailing character, unless string is a single character.
void	swap (std::string &str)
	Swap contents. Self-swapping is a no-op.
bool	operator() (const std::string &text) const
	Test for equality. Allows use as a predicate.
bool	contains (char c) const noexcept
	True if string contains given character (cf. C++23).
bool	contains (const std::string &s) const noexcept
	True if string contains given [string view] substring (cf. C++23).
bool	contains (const char *s) const
	True if string contains given substring (cf. C++23).
bool	starts_with (char c) const
	True if string starts with given character (cf. C++20).
bool	starts_with (const std::string &s) const
	True if string starts with given [string view] prefix (C++20).
bool	starts_with (const char *s) const
	True if string starts with given prefix (C++20).
bool	ends_with (char c) const
	True if string ends with given character (cf. C++20).
bool	ends_with (const std::string &s) const
	True if string ends with given [string view] suffix (cf. C++20).
bool	ends_with (const char *s) const
	True if string ends with given suffix (cf. C++20).
size_type	count (const char c) const
	Count the number of occurrences of the specified character in the string.
bool	startsWith (const std::string &s) const
	Deprecated(2019-11).
bool	endsWith (const std::string &s) const
	Deprecated(2019-11).
bool	removeTrailing (const char c)
	Deprecated(2019-11).

Static Public Member Functions
static bool	valid (const char c)
	Test for valid wordRe character?
Static Public Member Functions inherited from word
template<class PrimitiveType>
static word	printf (const char *fmt, const PrimitiveType &val)
	Use a printf-style formatter for a primitive.
template<class PrimitiveType>
static word	printf (const std::string &fmt, const PrimitiveType &val)
	Use a printf-style formatter for a primitive.
static bool	valid (char c)
	Is this character valid for a word?
static word	validate (const std::string &s, const bool prefix=false)
	Construct validated word (no invalid characters).
static word	validate (const char *first, const char *last, const bool prefix=false)
	Construct validated word (no invalid characters) from a sequence of characters in the range [first,last),.
Static Public Member Functions inherited from string
static std::string::size_type	length (const char *s)
	Length of the character sequence (with nullptr protection).
static std::string::size_type	length (const std::string &s)
	The length of the string.
template<class StringType>
static bool	valid (const std::string &str)
	Does the string contain valid characters only?
template<class StringType>
static bool	stripInvalid (std::string &str)
	Strip invalid characters from the given string.
template<class StringType>
static StringType	validate (const std::string &str)
	Return a valid String from the given string.

Static Public Attributes
static const wordRe	null
	An empty wordRe.
Static Public Attributes inherited from word
static const char *const	typeName = "word"
	The typeName.
static int	debug
	Debugging.
static const word	null
	An empty word.
Static Public Attributes inherited from string
static const char *const	typeName = "string"
	The type name "string".
static int	debug
	The debug flag.
static const string	null
	An empty string.

Additional Inherited Members
Protected Member Functions inherited from string
std::string::size_type	find_ext () const
	Find position of a file extension dot, return npos on failure.
word	ext () const
	Return file name extension (part after last .).
bool	ext (const word &ending)
	Append a '.' and the ending.
bool	has_ext () const
	Return true if it has an extension or simply ends with a '.'.
bool	has_ext (const char *ending) const
	Return true if the extension is the same as the given ending.
bool	has_ext (const std::string &ending) const
	Return true if the extension is the same as the given ending.
bool	has_ext (const wordRe &ending) const
	Return true if the extension matches the given ending.
bool	remove_path ()
	Remove leading path, return true if string changed.
bool	remove_ext ()
	Remove extension, return true if string changed.
Static Protected Member Functions inherited from string
static std::string::size_type	find_ext (const std::string &str)
	Find position of a file extension dot, return npos on failure.
template<class PrimitiveType>
static std::string::size_type	string_printf (std::string &output, const char *fmt, const PrimitiveType &val)
	A printf-style formatter for a primitive.
template<class PrimitiveType>
static std::string::size_type	string_printf (std::string &output, const std::string &fmt, const PrimitiveType &val)
	A printf-style formatter for a primitive.

Detailed Description

A wordRe is a Foam::word, but can contain a regular expression for matching words or strings.

By default the constructors will generally preserve the argument as a string literal and the assignment operators will use the wordRe::DETECT compOption to scan the string for regular expression meta characters and/or invalid word characters and react accordingly.

The exceptions are when constructing/assigning from another Foam::wordRe (preserve the same type) or from a Foam::word (always literal).

Note

If the string contents are changed - eg, by the operator+=() or by string::replace(), etc - it will be necessary to use compile() or uncompile() to synchronize the regular expression.

Source files

• wordRe.H
• wordReI.H
• wordRe.C

Definition at line 78 of file wordRe.H.

Member Enumeration Documentation

compOption

enum compOption

Enumeration with compile options.

Note that 'REGEX' is implicit if 'ICASE' is specified alone.

Enumerator
LITERAL	String literal.
REGEX	Regular expression.
ICASE	Ignore case in regular expression.
NOCASE	Deprecated (2018-04) Alias for ICASE
DETECT	Detect if the string contains meta-characters.
UNKNOWN	Unknown content (for return value).
REGEX_ICASE	Combined REGEX and ICASE.
DETECT_ICASE	Combined DETECT and ICASE.

Definition at line 107 of file wordRe.H.

Constructor & Destructor Documentation

wordRe() [1/9]

wordRe ( )

inline

Default construct, empty literal.

Definition at line 33 of file wordReI.H.

References word::word().

Referenced by operator=(), operator=(), swap(), wordRe(), and wordRe().

Here is the call graph for this function:

Here is the caller graph for this function:

wordRe() [2/9]

wordRe ( const wordRe & str )

inline

Copy construct.

Definition at line 40 of file wordReI.H.

References isPattern(), word::word(), and wordRe().

Here is the call graph for this function:

wordRe() [3/9]

wordRe ( wordRe && str )

inline

Move construct.

Definition at line 51 of file wordReI.H.

References word::word(), and wordRe().

Here is the call graph for this function:

wordRe() [4/9]

wordRe ( const word & str )

inline

Implicit copy construct from word, as LITERAL.

Definition at line 58 of file wordReI.H.

References word::word().

Here is the call graph for this function:

wordRe() [5/9]

wordRe ( word && str )

inline

Implicit move construct from word, as LITERAL.

Definition at line 65 of file wordReI.H.

References word::word().

Here is the call graph for this function:

wordRe() [6/9]

wordRe ( const std::string & str, const compOption opt = compOption::LITERAL )

inline

Implicit copy construct from other string-types, with specified compile option (default is LITERAL).

Definition at line 72 of file wordReI.H.

References compile(), LITERAL, and word::word().

Here is the call graph for this function:

wordRe() [7/9]

wordRe ( const char * str, const compOption opt = compOption::LITERAL )

inline

Implicit construct from character array, with specified compile option (default is LITERAL).

Definition at line 84 of file wordReI.H.

References compile(), LITERAL, and word::word().

Here is the call graph for this function:

wordRe() [8/9]

wordRe

(

const keyType &

str

)

Implicit copy construct from keyType, using its compile type.

Definition at line 34 of file wordRe.C.

References keyType::isPattern(), and word::word().

Here is the call graph for this function:

wordRe() [9/9]

wordRe ( Istream & is )

explicit

Construct from Istream by reading a token.

Words are treated as literals, strings with an auto-detect

Definition at line 46 of file wordRe.C.

References word::word().

Here is the call graph for this function:

Member Function Documentation

valid()

bool valid ( const char c )

inlinestatic

Test for valid wordRe character?

Like Foam::word, but with brace-brackets, which are valid for some regexs.

Definition at line 24 of file wordReI.H.

References word::valid().

Here is the call graph for this function:

isLiteral()

bool isLiteral ( ) const

inlinenoexcept

The wordRe is a literal string, not a pattern.

Definition at line 98 of file wordReI.H.

References Foam::noexcept.

Referenced by string::has_ext().

Here is the caller graph for this function:

isPattern()

bool isPattern ( ) const

inlinenoexcept

The wordRe is a pattern, not a literal string.

Definition at line 104 of file wordReI.H.

References Foam::noexcept.

Referenced by fieldSelection::containsPattern(), faBoundaryMesh::indices(), pointBoundaryMesh::indices(), polyBoundaryMesh::indices(), ZoneMesh< ZoneType, MeshType >::indices(), Foam::operator<<(), operator=(), triSurfaceLoader::select(), uncompile(), and wordRe().

Here is the caller graph for this function:

assign()

bool assign

(

const token &

tok

)

Assign from word or string token.

Words are treated as literals, strings with an auto-detect

Returns

false if the token was the incorrect type

Definition at line 57 of file wordRe.C.

References assign(), compile(), DETECT, token::isQuotedString(), token::isWord(), token::stringToken(), uncompile(), and token::wordToken().

Referenced by assign(), operator=(), operator=(), operator=(), operator=(), operator=(), operator=(), Foam::operator>>(), set(), and set().

Here is the call graph for this function:

Here is the caller graph for this function:

compile() [1/2]

bool compile ( )

inline

Compile as regular expression (if possible).

Definition at line 152 of file wordReI.H.

Referenced by assign(), operator=(), operator=(), operator=(), operator=(), operator=(), set(), set(), wordRe(), and wordRe().

Here is the caller graph for this function:

uncompile() [1/2]

void uncompile ( )

inline

Mark as literal string, remove any regular expression.

Definition at line 169 of file wordReI.H.

Referenced by assign(), and operator=().

Here is the caller graph for this function:

compile() [2/2]

bool compile ( const compOption opt )

inline

Possibly compile the regular expression, with greater control.

Definition at line 110 of file wordReI.H.

References DETECT, ICASE, regExpCxx::is_meta(), LITERAL, REGEX, and string::valid().

Here is the call graph for this function:

uncompile() [2/2]

void uncompile ( bool adjust )

inline

Mark as literal string, optionally stripping invalid word characters when changing to a literal.

Definition at line 175 of file wordReI.H.

References word::debug, isPattern(), and string::stripInvalid().

Here is the call graph for this function:

set() [1/2]

void set ( const std::string & str, const compOption opt = DETECT )

inline

Copy string, auto-test for regular expression or other options.

Definition at line 204 of file wordReI.H.

References assign(), and compile().

Here is the call graph for this function:

set() [2/2]

void set ( const char * str, const compOption opt = DETECT )

inline

Copy string, auto-test for regular expression or other options.

Definition at line 211 of file wordReI.H.

References assign(), and compile().

Here is the call graph for this function:

clear()

void clear ( )

inline

Clear string and regular expression.

Definition at line 186 of file wordReI.H.

Referenced by zoneToCell::zones(), zoneToFace::zones(), and zoneToPoint::zones().

Here is the caller graph for this function:

swap()

void swap ( wordRe & str )

inline

Swap contents. Self-swapping is a no-op.

Definition at line 219 of file wordReI.H.

References string::swap(), word::word(), and wordRe().

Referenced by operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

match()

bool match ( const std::string & text, bool literal = false ) const

inline

Smart match as regular expression or as a string.

Optionally force a literal match only

Definition at line 193 of file wordReI.H.

Referenced by string::has_ext(), operator()(), and solverFieldSelection::updateSelection().

Here is the caller graph for this function:

operator()()

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

inline

Perform smart match on text, as per match().

Allows use as a predicate.

Definition at line 233 of file wordReI.H.

References match().

Here is the call graph for this function:

operator=() [1/7]

void operator= ( const wordRe & str )

inline

Copy assignment, retaining type (literal or regex).

Self-assignment is a no-op.

Definition at line 239 of file wordReI.H.

References assign(), compile(), isPattern(), and wordRe().

Here is the call graph for this function:

operator=() [2/7]

void operator= ( const word & str )

inline

Copy word, never a regular expression.

Definition at line 258 of file wordReI.H.

References assign(), and word::word().

Here is the call graph for this function:

operator=() [3/7]

void operator=

(

const keyType &

str

)

Copy keyType and its type (literal or regex).

Always case sensitive

Definition at line 80 of file wordRe.C.

References assign(), compile(), keyType::isPattern(), and uncompile().

Here is the call graph for this function:

operator=() [4/7]

void operator= ( const string & str )

inline

Copy string, auto-test for regular expression.

Always case sensitive

Definition at line 265 of file wordReI.H.

References assign(), compile(), and DETECT.

Here is the call graph for this function:

operator=() [5/7]

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

inline

Copy string, auto-test for regular expression.

Always case sensitive

Definition at line 272 of file wordReI.H.

References assign(), compile(), and DETECT.

Here is the call graph for this function:

operator=() [6/7]

void operator= ( const char * str )

inline

Copy string, auto-test for regular expression.

Always case sensitive

Definition at line 279 of file wordReI.H.

References assign(), compile(), and DETECT.

Here is the call graph for this function:

operator=() [7/7]

void operator= ( wordRe && str )

inline

Move assignment.

Self-assignment is a no-op.

Definition at line 286 of file wordReI.H.

References clear(), swap(), and wordRe().

Here is the call graph for this function:

Member Data Documentation

null

const Foam::wordRe null

static

An empty wordRe.

Definition at line 97 of file wordRe.H.

Referenced by porosityModel::declareRunTimeSelectionTable(), faceSetOption::zoneName(), and cellSetOption::zoneName().

---

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

• src/OpenFOAM/primitives/strings/wordRe/wordRe.H
• src/OpenFOAM/primitives/strings/wordRe/wordRe.C
• src/OpenFOAM/primitives/strings/wordRe/wordReI.H