A class for handling character strings derived from std::string.
More...
#include <OpenFOAM/string.H>
Detailed Description
A class for handling character strings derived from std::string.
Strings may contain any characters and therefore are delimited by quotes for IO : "any list of characters".
Used as a base class for word and fileName.
- See also:
- Foam::findEtcFile() for information about the site/user OpenFOAM configuration directory
- Source files
-
Definition at line 75 of file string.H.
List of all members.
Classes |
class | hash |
| Hashing function class, shared by all the derived classes. More...
|
Public Member Functions |
| string () |
| Construct null.
|
| string (const std::string &) |
| Construct from std::string.
|
| string (const char *) |
| Construct as copy of character array.
|
| string (const char *, const size_type) |
| Construct as copy of specified number of characters.
|
| string (const char) |
| Construct from a single character.
|
| string (Istream &) |
| Construct from Istream.
|
size_type | count (const char) const |
| Count and return the number of a given character in the string.
|
string & | replace (const string &oldStr, const string &newStr, size_type start=0) |
| Replace first occurence of sub-string oldStr with newStr.
|
string & | replaceAll (const string &oldStr, const string &newStr, size_type start=0) |
| Replace all occurences of sub-string oldStr with newStr.
|
string & | expand () |
| Expand initial tildes and all occurences of environment variables.
|
bool | removeRepeated (const char) |
| Remove repeated characters returning true if string changed.
|
string | removeRepeated (const char) const |
| Return string with repeated characters removed.
|
bool | removeTrailing (const char) |
| Remove trailing character returning true if string changed.
|
string | removeTrailing (const char) const |
| Return string with trailing character removed.
|
string | operator() (const size_type i, const size_type n) const |
| Return the sub-string from the i-th character for n characters.
|
string | operator() (const size_type n) const |
| Return the sub-string from the first character for n characters.
|
Static Public Member Functions |
template<class String > |
static bool | valid (const string &) |
| Is this string type valid?
|
template<class String > |
static bool | meta (const string &, const char quote='\\') |
| Does this string have particular meta-characters?
|
template<class String > |
static bool | stripInvalid (string &) |
| Strip invalid characters from the given string.
|
template<class String > |
static String | validate (const string &) |
| Return a valid String from the given string.
|
template<class String > |
static string | quotemeta (const string &, const char quote='\\') |
| Return a String with quoted meta-characters from the given string.
|
Constructor & Destructor Documentation
Construct null.
Definition at line 30 of file stringI.H.
string |
( |
const std::string & |
str | ) |
|
|
inline |
Construct from std::string.
Definition at line 34 of file stringI.H.
Construct as copy of character array.
Definition at line 41 of file stringI.H.
string |
( |
const char * |
str, |
|
|
const size_type |
len |
|
) |
| |
|
inline |
Construct as copy of specified number of characters.
Definition at line 48 of file stringI.H.
Construct from a single character.
Definition at line 55 of file stringI.H.
Member Function Documentation
Foam::string::size_type count |
( |
const char |
c | ) |
const |
bool valid |
( |
const string & |
str | ) |
|
|
inlinestatic |
Is this string type valid?
Definition at line 64 of file stringI.H.
bool meta |
( |
const string & |
str, |
|
|
const char |
quote = '\\' |
|
) |
| |
|
inlinestatic |
Does this string have particular meta-characters?
The meta characters can be optionally quoted.
Definition at line 112 of file stringI.H.
bool stripInvalid |
( |
string & |
str | ) |
|
|
inlinestatic |
Strip invalid characters from the given string.
Definition at line 78 of file stringI.H.
String validate |
( |
const string & |
str | ) |
|
|
inlinestatic |
Return a valid String from the given string.
Definition at line 172 of file stringI.H.
Return a String with quoted meta-characters from the given string.
Definition at line 136 of file stringI.H.
bool removeRepeated |
( |
const char |
character | ) |
|
bool removeTrailing |
( |
const char |
character | ) |
|
Foam::string operator() |
( |
const size_type |
i, |
|
|
const size_type |
n |
|
) |
| const |
|
inline |
Return the sub-string from the i-th character for n characters.
Definition at line 183 of file stringI.H.
Return the sub-string from the first character for n characters.
Definition at line 192 of file stringI.H.
Friends And Related Function Documentation
Member Data Documentation
const char *const typeName = "string" |
|
static |
The documentation for this class was generated from the following files:
- src/OpenFOAM/primitives/strings/string/string.H
- src/OpenFOAM/primitives/strings/string/string.C
- src/OpenFOAM/primitives/strings/string/stringI.H
- src/OpenFOAM/primitives/strings/string/stringIO.C