Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
wordRe Class Reference

A wordRe is a word, but can also have a regular expression for matching words. More...

Inheritance diagram for wordRe:
Inheritance graph
[legend]
Collaboration diagram for wordRe:
Collaboration graph
[legend]

Public Types

enum  compOption {
  LITERAL = 0, DETECT = 1, REGEXP = 2, NOCASE = 4,
  DETECT_NOCASE = DETECT | NOCASE, REGEXP_NOCASE = REGEXP | NOCASE
}
 Enumeration with compile options. More...
 

Public Member Functions

 wordRe ()
 Construct null. More...
 
 wordRe (const wordRe &)
 Construct as copy. More...
 
 wordRe (const keyType &)
 Construct from keyType. More...
 
 wordRe (const keyType &, const compOption)
 Construct from keyType. More...
 
 wordRe (const word &)
 Construct as copy of word. More...
 
 wordRe (const char *, const compOption=LITERAL)
 Construct as copy of character array. More...
 
 wordRe (const string &, const compOption=LITERAL)
 Construct as copy of string. More...
 
 wordRe (const std::string &, const compOption=LITERAL)
 Construct as copy of std::string. More...
 
 wordRe (Istream &)
 Construct from Istream. More...
 
bool isPattern () const
 Should be treated as a match rather than a literal string? More...
 
bool compile () const
 Compile the regular expression. More...
 
bool compile (const compOption) const
 Possibly compile the regular expression, with greater control. More...
 
bool recompile () const
 Recompile an existing regular expression. More...
 
void uncompile (const bool doStripInvalid=false) const
 Frees precompiled regular expression, making wordRe a literal. More...
 
void set (const std::string &, const compOption=DETECT)
 Copy string, auto-test for regular expression or other options. More...
 
void set (const char *, const compOption=DETECT)
 Copy string, auto-test for regular expression or other options. More...
 
void clear ()
 Clear string and precompiled regular expression. More...
 
bool match (const std::string &, bool literalMatch=false) const
 Smart match as regular expression or as a string. More...
 
string quotemeta () const
 Return a string with quoted meta-characters. More...
 
Ostreaminfo (Ostream &) const
 Output some basic info. More...
 
const wordReoperator= (const wordRe &)
 Assign copy. More...
 
const wordReoperator= (const word &)
 Copy word, never a regular expression. More...
 
const wordReoperator= (const keyType &)
 Copy keyType, auto-test for regular expression. More...
 
const wordReoperator= (const string &)
 Copy string, auto-test for regular expression. More...
 
const wordReoperator= (const std::string &)
 Copy string, auto-test for regular expression. More...
 
const wordReoperator= (const char *)
 Copy string, auto-test for regular expression. More...
 
- Public Member Functions inherited from word
 word ()
 Construct null. More...
 
 word (const word &)
 Construct as copy. More...
 
 word (const char *, const bool doStripInvalid=true)
 Construct as copy of character array. More...
 
 word (const char *, const size_type, const bool doStripInvalid)
 Construct as copy with a maximum number of characters. More...
 
 word (const string &, const bool doStripInvalid=true)
 Construct as copy of string. More...
 
 word (const std::string &, const bool doStripInvalid=true)
 Construct as copy of std::string. More...
 
 word (Istream &)
 Construct from Istream. More...
 
const wordoperator= (const word &)
 
const wordoperator= (const string &)
 
const wordoperator= (const std::string &)
 
const wordoperator= (const char *)
 
- Public Member Functions inherited from string
 string ()
 Construct null. More...
 
 string (const std::string &)
 Construct from std::string. More...
 
 string (const char *)
 Construct as copy of character array. More...
 
 string (const char *, const size_type)
 Construct as copy of specified number of characters. More...
 
 string (const char)
 Construct from a single character. More...
 
 string (Istream &)
 Construct from Istream. More...
 
size_type count (const char) const
 Count and return the number of a given character in the string. More...
 
bool match (const std::string &) const
 True when strings match literally. More...
 
stringreplace (const string &oldStr, const string &newStr, size_type start=0)
 Replace first occurence of sub-string oldStr with newStr. More...
 
stringreplaceAll (const string &oldStr, const string &newStr, size_type start=0)
 Replace all occurences of sub-string oldStr with newStr. More...
 
stringexpand (const bool allowEmpty=false)
 Expand initial tildes and all occurences of environment variables. More...
 
bool removeRepeated (const char)
 Remove repeated characters returning true if string changed. More...
 
string removeRepeated (const char) const
 Return string with repeated characters removed. More...
 
bool removeTrailing (const char)
 Remove trailing character returning true if string changed. More...
 
string removeTrailing (const char) const
 Return string with trailing character removed. More...
 
string operator() (const size_type i, const size_type n) const
 Return the sub-string from the i-th character for n characters. More...
 
string operator() (const size_type n) const
 Return the sub-string from the first character for n characters. More...
 
template<class String >
Foam::string quotemeta (const string &str, const char quote)
 

Static Public Member Functions

static bool meta (char)
 Is this a meta character? More...
 
static bool isPattern (const string &)
 Test string for regular expression meta characters. More...
 
- Static Public Member Functions inherited from word
static bool valid (char)
 Is this character valid for a word. More...
 
- Static Public Member Functions inherited from string
template<class String >
static bool valid (const string &)
 Is this string type valid? More...
 
template<class String >
static bool meta (const string &, const char quote='\\')
 Does this string have particular meta-characters? More...
 
template<class String >
static bool stripInvalid (string &)
 Strip invalid characters from the given string. More...
 
template<class String >
static String validate (const string &)
 Return a valid String from the given string. More...
 
template<class String >
static string quotemeta (const string &, const char quote='\\')
 Return a String with quoted meta-characters from the given string. More...
 

Static Public Attributes

static const wordRe null
 An empty wordRe. More...
 
- Static Public Attributes inherited from word
static const char *const typeName = "word"
 
static int debug
 
static const word null
 An empty word. More...
 
- Static Public Attributes inherited from string
static const char *const typeName = "string"
 
static int debug
 
static const string null
 An empty string. More...
 

Friends

Istreamoperator>> (Istream &, wordRe &)
 
Ostreamoperator<< (Ostream &, const wordRe &)
 

Detailed Description

A wordRe is a word, but can also have a regular expression for matching words.

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 recompile() to synchronize the regular expression.
Source files

Definition at line 74 of file wordRe.H.

Member Enumeration Documentation

enum compOption

Enumeration with compile options.

Note that 'REGEXP' is implicit if 'NOCASE' is specified alone.

Enumerator
LITERAL 

treat as a string literal

DETECT 

treat as regular expression

REGEXP 

detect if the string contains meta-characters

NOCASE 

ignore case in regular expression

DETECT_NOCASE 
REGEXP_NOCASE 

Definition at line 95 of file wordRe.H.

Constructor & Destructor Documentation

wordRe ( )
inline

Construct null.

Definition at line 42 of file wordReI.H.

wordRe ( const wordRe str)
inline

Construct as copy.

Definition at line 49 of file wordReI.H.

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

Here is the call graph for this function:

wordRe ( const keyType str)
inlineexplicit

Construct from keyType.

Definition at line 68 of file wordReI.H.

References wordRe::compile(), and keyType::isPattern().

Here is the call graph for this function:

wordRe ( const keyType str,
const compOption  opt 
)
inline

Construct from keyType.

Definition at line 80 of file wordReI.H.

References wordRe::compile(), and keyType::isPattern().

Here is the call graph for this function:

wordRe ( const word str)
inlineexplicit

Construct as copy of word.

Definition at line 61 of file wordReI.H.

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

Construct as copy of character array.

Optionally specify how it should be treated.

Definition at line 92 of file wordReI.H.

References wordRe::compile().

Here is the call graph for this function:

wordRe ( const string str,
const compOption  opt = LITERAL 
)
inlineexplicit

Construct as copy of string.

Optionally specify how it should be treated.

Definition at line 101 of file wordReI.H.

References wordRe::compile().

Here is the call graph for this function:

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

Construct as copy of std::string.

Optionally specify how it should be treated.

Definition at line 110 of file wordReI.H.

References wordRe::compile().

Here is the call graph for this function:

wordRe ( Istream is)

Construct from Istream.

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

Definition at line 37 of file wordRe.C.

Member Function Documentation

bool meta ( char  c)
inlinestatic

Is this a meta character?

Definition at line 28 of file wordReI.H.

References regExp::meta().

Here is the call graph for this function:

bool isPattern ( const string str)
inlinestatic

Test string for regular expression meta characters.

Definition at line 34 of file wordReI.H.

Referenced by Foam::operator<<(), wordRe::operator=(), and wordRe::wordRe().

Here is the caller graph for this function:

bool isPattern ( ) const
inline

Should be treated as a match rather than a literal string?

Definition at line 121 of file wordReI.H.

References regExp::exists().

Referenced by wordRe::info().

Here is the call graph for this function:

Here is the caller graph for this function:

bool compile ( ) const
inline

Compile the regular expression.

Definition at line 161 of file wordReI.H.

References regExp::exists().

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

Here is the call graph for this function:

Here is the caller graph for this function:

bool compile ( const compOption  opt) const
inline

Possibly compile the regular expression, with greater control.

Definition at line 127 of file wordReI.H.

References regExp::clear(), wordRe::DETECT, regExp::exists(), wordRe::NOCASE, wordRe::REGEXP, and regExp::set().

Here is the call graph for this function:

bool recompile ( ) const
inline

Recompile an existing regular expression.

Definition at line 168 of file wordReI.H.

References regExp::exists().

Here is the call graph for this function:

void uncompile ( const bool  doStripInvalid = false) const
inline

Frees precompiled regular expression, making wordRe a literal.

Optionally strips invalid word characters

Definition at line 179 of file wordReI.H.

References regExp::clear(), and word::debug.

Here is the call graph for this function:

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

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

Definition at line 223 of file wordReI.H.

References wordRe::compile().

Here is the call graph for this function:

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

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

Definition at line 230 of file wordReI.H.

References wordRe::compile().

Here is the call graph for this function:

void clear ( )
inline

Clear string and precompiled regular expression.

Definition at line 195 of file wordReI.H.

References clear(), and regExp::clear().

Here is the call graph for this function:

bool match ( const std::string &  str,
bool  literalMatch = false 
) const
inline

Smart match as regular expression or as a string.

Optionally force a literal match only

Definition at line 202 of file wordReI.H.

References regExp::exists(), and regExp::match().

Referenced by IOobjectList::lookup(), and objectRegistry::names().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::string quotemeta ( ) const
inline

Return a string with quoted meta-characters.

Definition at line 217 of file wordReI.H.

Foam::Ostream & info ( Ostream os) const

Output some basic info.

Definition at line 103 of file wordRe.C.

References Ostream::flush(), and wordRe::isPattern().

Here is the call graph for this function:

const Foam::wordRe & operator= ( const wordRe str)
inline

Assign copy.

Always case sensitive

Definition at line 239 of file wordReI.H.

References regExp::clear(), wordRe::compile(), and wordRe::isPattern().

Here is the call graph for this function:

const Foam::wordRe & operator= ( const word str)
inline

Copy word, never a regular expression.

Definition at line 255 of file wordReI.H.

References regExp::clear(), and word::operator=().

Here is the call graph for this function:

const Foam::wordRe & operator= ( const keyType str)
inline

Copy keyType, auto-test for regular expression.

Always case sensitive

Definition at line 263 of file wordReI.H.

References wordRe::compile(), and keyType::isPattern().

Here is the call graph for this function:

const Foam::wordRe & operator= ( const string str)
inline

Copy string, auto-test for regular expression.

Always case sensitive

Definition at line 274 of file wordReI.H.

References wordRe::compile(), and wordRe::DETECT.

Here is the call graph for this function:

const Foam::wordRe & operator= ( const std::string &  str)
inline

Copy string, auto-test for regular expression.

Always case sensitive

Definition at line 282 of file wordReI.H.

References wordRe::compile(), and wordRe::DETECT.

Here is the call graph for this function:

const Foam::wordRe & operator= ( const char *  str)
inline

Copy string, auto-test for regular expression.

Always case sensitive

Definition at line 290 of file wordReI.H.

References wordRe::compile(), and wordRe::DETECT.

Here is the call graph for this function:

Friends And Related Function Documentation

Istream& operator>> ( Istream ,
wordRe  
)
friend
Ostream& operator<< ( Ostream ,
const wordRe  
)
friend

Member Data Documentation

const Foam::wordRe null
static

An empty wordRe.

Definition at line 88 of file wordRe.H.


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