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

A class for handling words, derived from string. More...

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

Public Member Functions

 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 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 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

word operator& (const word &, const word &)
 
Istreamoperator>> (Istream &, word &)
 
Ostreamoperator<< (Ostream &, const word &)
 

Detailed Description

A class for handling words, derived from string.

A word is a string of characters without whitespace, quotes, slashes, semicolons or brace brackets. Words are delimited by whitespace.

Source files

Definition at line 59 of file word.H.

Constructor & Destructor Documentation

word ( )
inline

Construct null.

Definition at line 61 of file wordI.H.

Referenced by word::word().

Here is the caller graph for this function:

word ( const word w)
inline

Construct as copy.

Definition at line 55 of file wordI.H.

word ( const char *  s,
const bool  doStripInvalid = true 
)
inline

Construct as copy of character array.

Definition at line 89 of file wordI.H.

References word::word().

Here is the call graph for this function:

word ( const char *  s,
const size_type  n,
const bool  doStripInvalid 
)
inline

Construct as copy with a maximum number of characters.

Definition at line 100 of file wordI.H.

word ( const string s,
const bool  doStripInvalid = true 
)
inline

Construct as copy of string.

Definition at line 67 of file wordI.H.

word ( const std::string &  s,
const bool  doStripInvalid = true 
)
inline

Construct as copy of std::string.

Definition at line 78 of file wordI.H.

word ( Istream is)

Construct from Istream.

Definition at line 31 of file wordIO.C.

Member Function Documentation

bool valid ( char  c)
inlinestatic

Is this character valid for a word.

Definition at line 117 of file wordI.H.

References Foam::isspace().

Referenced by cyclicAMIPolyPatch::cyclicAMIPolyPatch(), cyclicPolyPatch::cyclicPolyPatch(), and ISstream::read().

Here is the call graph for this function:

Here is the caller graph for this function:

const Foam::word & operator= ( const word q)
inline

Definition at line 134 of file wordI.H.

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

Here is the caller graph for this function:

const Foam::word & operator= ( const string q)
inline

Definition at line 141 of file wordI.H.

const Foam::word & operator= ( const std::string &  q)
inline

Definition at line 149 of file wordI.H.

const Foam::word & operator= ( const char *  q)
inline

Definition at line 157 of file wordI.H.

Friends And Related Function Documentation

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

Member Data Documentation

const char *const typeName = "word"
static

Definition at line 73 of file word.H.

int debug
static

Definition at line 74 of file word.H.

Referenced by wordRe::uncompile().

const Foam::word null
static

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