Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members
BLOCXX_NAMESPACE::String

BLOCXX_NAMESPACE::String Class Reference

This String class is an abstract data type that represents as NULL terminated string of characters. More...

#include <String.hpp>

Collaboration diagram for BLOCXX_NAMESPACE::String:

Collaboration graph
[legend]
List of all members.

Public Types

typedef COWIntrusiveReference<
ByteBuf > 		buf_t
enum  ETakeOwnershipFlag { E_TAKE_OWNERSHIP }
enum  EReturnDelimitersFlag { E_DISCARD_DELIMITERS, E_RETURN_DELIMITERS }
enum  EEmptyTokenReturnFlag { E_SKIP_EMPTY_TOKENS, E_RETURN_EMPTY_TOKENS }
enum  EIgnoreCaseFlag { E_CASE_SENSITIVE, E_CASE_INSENSITIVE }

Public Member Functions

 String ()
 Create a new String object with a length of 0.
 String (Int32 val)
 Create a new String object that will hold the string representation of the given Int32 value.
 String (UInt32 val)
 Create a new String object that will hold the string representation of the given UInt32 value.
 String (Int64 val)
 Create a new String object that will hold the string representation of the given Int64 value.
 String (UInt64 val)
 Create a new String object that will hold the string representation of the given UInt64 value.
 String (Real32 val)
 Create a new String object that will hold the string representation of the given Real32 value.
 String (Real64 val)
 Create a new String object that will hold the string representation of the given Real64 value.
 String (const char *str)
 Create a new String object that will contain a copy of the given character string.
 String (ETakeOwnershipFlag, char *allocatedMemory, size_t len)
 Create a new string object from a dynamically allocated buffer.
 String (const char *str, size_t len)
 Create s new String object that will contain a copy of the given character string for the given length.
 String (const String &arg)
 Create a new String object that is a copy of another String object.
 String (char c)
 Create a new String object that contains a single character.
 ~String ()
 Destroy this String object.
void swap (String &x)
 Swap this instance with another.
char * allocateCString () const
 Create a null terminated string that contains the contents of this String.
size_t length () const
size_t UTF8Length () const
 If the string is not valid UTF-8, then the result of this function is undefined.
bool empty () const
int format (const char *fmt,...)
 Format this string according to the given format and variable argument list (printf style).
StringArray tokenize (const char *delims=" \n\r\t\v", EReturnDelimitersFlag returnDelimitersAsTokens=E_DISCARD_DELIMITERS, EEmptyTokenReturnFlag returnEmptyTokens=E_SKIP_EMPTY_TOKENS) const
 Tokenize this String object using the given delimeters.
const char * c_str () const
char charAt (size_t ndx) const
 Get the character at a specified index.
int compareTo (const String &arg) const
 Compare another String object with this one.
int compareTo (const char *arg) const
 Compare another string with this one.
int compareToIgnoreCase (const String &arg) const
 Compare another string with this one ignoring case.
int compareToIgnoreCase (const char *arg) const
 Compare another string with this one ignoring case.
String & concat (const char *arg)
 Append a C string to this String object.
String & concat (const String &arg)
 Append another String object to this String object.
String & concat (char arg)
 Append a char to this String object.
bool endsWith (const char *arg, EIgnoreCaseFlag ignoreCase=E_CASE_SENSITIVE) const
 Determine if this String object ends with given C string.
bool endsWith (const String &arg, EIgnoreCaseFlag ignoreCase=E_CASE_SENSITIVE) const
 Determine if this String object ends with the same string represented by another String object.
bool endsWith (char arg) const
 Determine if this String object ends with a given character.
bool equals (const String &arg) const
 Determine if another String object is equal to this String object.
bool equals (const char *arg) const
 Determine if another string is equal to this String object.
bool equalsIgnoreCase (const String &arg) const
 Determine if another String object is equal to this String object, ignoring case in the comparision.
bool equalsIgnoreCase (const char *arg) const
 Determine if another string is equal to this String object, ignoring case in the comparision.
UInt32 hashCode () const
size_t indexOf (char ch, size_t fromIndex=0) const
 Find the first occurence of a given character in this String object.
size_t indexOf (const char *arg, size_t fromIndex=0) const
 Find the first occurence of a C string in this String object.
size_t indexOf (const String &arg, size_t fromIndex=0) const
 Find the first occurence of a string in this String object.
size_t lastIndexOf (char ch, size_t fromIndex=npos) const
 Find the last occurence of a character in this String object.
size_t lastIndexOf (const char *arg, size_t fromIndex=npos) const
 Find the last occurence of a C string in this String object.
size_t lastIndexOf (const String &arg, size_t fromIndex=npos) const
 Find the last occurence of a string in this String object.
bool startsWith (const char *arg, EIgnoreCaseFlag ignoreCase=E_CASE_SENSITIVE) const
 Determine if this String object starts with a given substring.
bool startsWith (const String &arg, EIgnoreCaseFlag ignoreCase=E_CASE_SENSITIVE) const
 Determine if this String object starts with a given substring.
bool startsWith (char arg) const
 Determine if this String object starts with a given character.
String substring (size_t beginIndex, size_t length=npos) const
 Create another String object that is comprised of a substring of this String object.
bool isSpaces () const
String & toLowerCase ()
 Convert this String object to lower case characters.
String & toUpperCase ()
 Convert this String object to upper case characters.
String & ltrim ()
 Strip all leading space characters from this String object.
String & rtrim ()
 Strip all trailing space characters from this String object.
String & trim ()
 Strip all leading and trailing space characters from this String object.
String & erase ()
 Delete all the characters of the string.
String & erase (size_t idx, size_t len=npos)
 Erases, at most, len characters of *this, starting at index idx.
String & operator= (const String &arg)
 Assignment operator.
const char & operator[] (size_t ndx) const
 Operator [].
char & operator[] (size_t ndx)
String & operator+= (const String &arg)
 Concatination operator.
String & operator+= (const char *arg)
 Concatination operator.
String & operator+= (char arg)
 Character concatination operator.
void readObject (std::istream &istrm)
 Read this String object from the given istream.
void writeObject (std::ostream &ostrm) const
 Write this String object to the given ostream.
String toString () const
Real32 toReal32 () const
Real64 toReal64 () const
bool toBool () const
UInt8 toUInt8 (int base=10) const
Int8 toInt8 (int base=10) const
UInt16 toUInt16 (int base=10) const
Int16 toInt16 (int base=10) const
UInt32 toUInt32 (int base=10) const
Int32 toInt32 (int base=10) const
UInt64 toUInt64 (int base=10) const
Int64 toInt64 (int base=10) const
unsigned int toUnsignedInt (int base=10) const
int toInt (int base=10) const

Static Public Member Functions

static unsigned long long int strtoull (const char *nptr, char **endptr, int base)
 Convert a null terminated string to an unsigned 64 bit value.
static long long int strtoll (const char *nptr, char **endptr, int base)
 Convert a null terminated string to an signed 64 bit value.
static const char * strchr (const char *theStr, int c)
 Find the first occurrence of a character in a null terminated string.
static String getLine (std::istream &istr)
 Reads from in input stream until a newline is encountered.

Static Public Attributes

static const size_t npos = ~0

Private Attributes

buf_t m_buf

Classes

class  ByteBuf

Detailed Description

This String class is an abstract data type that represents as NULL terminated string of characters.

String objects are ref counted and copy on write. Internal representation is UTF-8. Conversion to/from Char16 (UCS-2) is performed correctly. All operations that return/take an offset are based on the character array as if this were an ASCII string. The class does not enforce or maintain the integrity of any UTF-8 chars. length() returns the size in bytes of the string. Use UTF8Length() to get the number of chars in the string.

Definition at line 64 of file String.hpp.

Member Typedef Documentation

typedef COWIntrusiveReference<ByteBuf> BLOCXX_NAMESPACE::String::buf_t
 

Definition at line 700 of file String.hpp.

Member Enumeration Documentation

enum BLOCXX_NAMESPACE::String::EEmptyTokenReturnFlag
 

Enumerator:
E_SKIP_EMPTY_TOKENS 
E_RETURN_EMPTY_TOKENS 

Definition at line 217 of file String.hpp.

enum BLOCXX_NAMESPACE::String::EIgnoreCaseFlag
 

Enumerator:
E_CASE_SENSITIVE 
E_CASE_INSENSITIVE 

Definition at line 305 of file String.hpp.

enum BLOCXX_NAMESPACE::String::EReturnDelimitersFlag
 

Enumerator:
E_DISCARD_DELIMITERS 
E_RETURN_DELIMITERS 

Definition at line 212 of file String.hpp.

enum BLOCXX_NAMESPACE::String::ETakeOwnershipFlag
 

Enumerator:
E_TAKE_OWNERSHIP 

Definition at line 138 of file String.hpp.

Constructor & Destructor Documentation

BLOCXX_NAMESPACE::String::String (   ) 
 

Create a new String object with a length of 0.

Definition at line 136 of file String.cpp.

Referenced by ltrim(), rtrim(), substring(), tokenize(), and trim().

BLOCXX_NAMESPACE::String::String (  Int32  val  )  [explicit]
 

Create a new String object that will hold the string representation of the given Int32 value.

Parameters:
val The 32 bit value this String will hold the string representation of.

Definition at line 144 of file String.cpp.

References BLOCXX_NAMESPACE::AutoPtrVec< X >::get(), and m_buf.

BLOCXX_NAMESPACE::String::String (  UInt32  val  )  [explicit]
 

Create a new String object that will hold the string representation of the given UInt32 value.

Parameters:
val The 32 bit value this String will hold the string representation of.

Definition at line 154 of file String.cpp.

References BLOCXX_NAMESPACE::AutoPtrVec< X >::get(), and m_buf.

BLOCXX_NAMESPACE::String::String (  Int64  val  )  [explicit]
 

Create a new String object that will hold the string representation of the given Int64 value.

Parameters:
val The 64 bit value this String will hold the string representation of.

Definition at line 189 of file String.cpp.

References BLOCXX_NAMESPACE::OStringStream::c_str(), and m_buf.

BLOCXX_NAMESPACE::String::String (  UInt64  val  )  [explicit]
 

Create a new String object that will hold the string representation of the given UInt64 value.

Parameters:
val The 64 bit value this String will hold the string representation of.

Definition at line 197 of file String.cpp.

References BLOCXX_NAMESPACE::OStringStream::c_str(), and m_buf.

BLOCXX_NAMESPACE::String::String (  Real32  val  )  [explicit]
 

Create a new String object that will hold the string representation of the given Real32 value.

Parameters:
val The real value this String will hold the string representation of.

Definition at line 214 of file String.cpp.

References m_buf, and SNPRINTF.

BLOCXX_NAMESPACE::String::String (  Real64  val  )  [explicit]
 

Create a new String object that will hold the string representation of the given Real64 value.

Parameters:
val The real value this String will hold the string representation of.

Definition at line 230 of file String.cpp.

References m_buf, and SNPRINTF.

BLOCXX_NAMESPACE::String::String (  const char *  str  ) 
 

Create a new String object that will contain a copy of the given character string.

Parameters:
str The null terminated string to make a copy of.

Definition at line 246 of file String.cpp.

References m_buf.

BLOCXX_NAMESPACE::String::String (  ETakeOwnershipFlag  ,
char *  allocatedMemory,
size_t  len
)  [explicit]
 

Create a new string object from a dynamically allocated buffer.

The buffer is assumed to contain a valid c string and be previously allocated with the new operator. The memory given by the allocatedMemory parameter will be deallocated by the String class.

Parameters:
takeOwnerShipTag This parm is not used. It is here to differentiate this constructor from the others.
allocatedMemory The dynamically allocated string that will be used by this String. Must not be NULL.
len The length of the string allocatedMemory.

Definition at line 252 of file String.cpp.

References BLOCXX_ASSERT, and m_buf.

BLOCXX_NAMESPACE::String::String (  const char *  str,
size_t  len
)  [explicit]
 

Create s new String object that will contain a copy of the given character string for the given length.

Parameters:
str The character array to copy from.
len The number of bytes to copy from the str param.

Definition at line 260 of file String.cpp.

References BLOCXX_NAMESPACE::AutoPtrVec< X >::get(), and m_buf.

BLOCXX_NAMESPACE::String::String (  const String &  arg  ) 
 

Create a new String object that is a copy of another String object.

Upon return, both String objects will point to the same underlying character buffer. This state will remain until one of the 2 String objects is modified (copy on write)

Parameters:
arg The String object to make a copy of.

Definition at line 276 of file String.cpp.

BLOCXX_NAMESPACE::String::String (  char  c  )  [explicit]
 

Create a new String object that contains a single character.

Parameters:
c The character that this string will contain.

Definition at line 281 of file String.cpp.

References m_buf.

BLOCXX_NAMESPACE::String::~String (   ) 
 

Destroy this String object.

Definition at line 297 of file String.cpp.

Member Function Documentation

char * BLOCXX_NAMESPACE::String::allocateCString (   )  const
 

Create a null terminated string that contains the contents of this String.

The returned pointer MUST be deleted by the caller using free().

Returns:
A pointer to the newly allocated buffer that contains the contents of this String object.

Definition at line 308 of file String.cpp.

References c_str(), and length().

const char * BLOCXX_NAMESPACE::String::c_str (   )  const
 

Returns:
The c string representation of this String object. This will be a null terminated character array.

Definition at line 870 of file String.cpp.

References m_buf.

Referenced by allocateCString(), BLOCXX_NAMESPACE::StringBuffer::append(), BLOCXX_NAMESPACE::FileSystem::canRead(), BLOCXX_NAMESPACE::FileSystem::canWrite(), BLOCXX_NAMESPACE::FileSystem::changeDirectory(), BLOCXX_NAMESPACE::FileSystem::changeFileOwner(), BLOCXX_NAMESPACE::Char16::Char16(), BLOCXX_NAMESPACE::ServerSocketImpl::close(), BLOCXX_NAMESPACE::CmdLineParser::CmdLineParser(), compareTo(), compareToIgnoreCase(), BLOCXX_NAMESPACE::PosixRegEx::compile(), BLOCXX_NAMESPACE::PerlRegEx::compile(), concat(), BLOCXX_NAMESPACE::FileSystem::createFile(), BLOCXX_NAMESPACE::LogAppender::createLogAppender(), BLOCXX_NAMESPACE::dlSharedLibrary::doGetFunctionPointer(), BLOCXX_NAMESPACE::FileAppender::doProcessLogMessage(), endsWith(), equals(), equalsIgnoreCase(), BLOCXX_NAMESPACE::PosixRegEx::execute(), BLOCXX_NAMESPACE::PerlRegEx::execute(), BLOCXX_NAMESPACE::FileSystem::exists(), BLOCXX_NAMESPACE::FileAppender::FileAppender(), BLOCXX_NAMESPACE::IConv::fromByteString(), BLOCXX_NAMESPACE::SocketAddress::getByName(), BLOCXX_NAMESPACE::FileSystem::getDirectoryContents(), BLOCXX_NAMESPACE::FileSystem::getFileContents(), BLOCXX_NAMESPACE::FileSystem::getFileSize(), BLOCXX_NAMESPACE::GetPass::getPass(), BLOCXX_NAMESPACE::SocketAddress::getUDS(), BLOCXX_NAMESPACE::UserUtils::getUserId(), BLOCXX_NAMESPACE::IConv_t::IConv_t(), indexOf(), BLOCXX_NAMESPACE::FileSystem::initRandomFile(), BLOCXX_NAMESPACE::FileSystem::isDirectory(), BLOCXX_NAMESPACE::FileSystem::isExecutable(), BLOCXX_NAMESPACE::FileSystem::isLink(), BLOCXX_NAMESPACE::IStringStreamBuf::IStringStreamBuf(), lastIndexOf(), BLOCXX_NAMESPACE::dlSharedLibraryLoader::loadSharedLibrary(), BLOCXX_NAMESPACE::FileSystem::makeDirectory(), BLOCXX_NAMESPACE::PosixRegEx::match(), BLOCXX_NAMESPACE::PerlRegEx::match(), BLOCXX_NAMESPACE::NwIface::NwIface(), BLOCXX_NAMESPACE::TmpFileImpl::open(), BLOCXX_NAMESPACE::IConv_t::open(), BLOCXX_NAMESPACE::FileSystem::openFile(), BLOCXX_NAMESPACE::FileSystem::openOrCreateFile(), __gnu_cxx::hash< BLOCXX_NAMESPACE::String >::operator()(), BLOCXX_NAMESPACE::operator<<(), BLOCXX_NAMESPACE::operator==(), BLOCXX_NAMESPACE::StackTrace::printStackTrace(), BLOCXX_NAMESPACE::SocketBaseImpl::read(), BLOCXX_NAMESPACE::FileSystem::readSymbolicLink(), BLOCXX_NAMESPACE::FileSystem::Path::realPath(), BLOCXX_NAMESPACE::FileSystem::removeDirectory(), BLOCXX_NAMESPACE::FileSystem::removeFile(), BLOCXX_NAMESPACE::FileSystem::renameFile(), BLOCXX_NAMESPACE::Exec::safePopen(), BLOCXX_NAMESPACE::EnvVars::setVar(), startsWith(), BLOCXX_NAMESPACE::StringBuffer::StringBuffer(), BLOCXX_NAMESPACE::NwIface::stringToAddress(), BLOCXX_NAMESPACE::UTF8Utils::StringToUCS2Common(), BLOCXX_NAMESPACE::SyslogAppender::SyslogAppender(), BLOCXX_NAMESPACE::TmpFileImpl::TmpFileImpl(), toBool(), BLOCXX_NAMESPACE::IConv::toByteString(), BLOCXX_NAMESPACE::IConv::toWideString(), BLOCXX_NAMESPACE::MD5::update(), UTF8Length(), BLOCXX_NAMESPACE::UUID::UUID(), BLOCXX_NAMESPACE::SocketBaseImpl::write(), and BLOCXX_NAMESPACE::UnnamedPipe::writeString().

char BLOCXX_NAMESPACE::String::charAt (  size_t  ndx  )  const
 

Get the character at a specified index.

Parameters:
ndx The index of the character to return within the char array.
Returns:
The character at the given index within the array. If the index is out of bounds, then a 0 is returned.

Definition at line 362 of file String.cpp.

References m_buf.

Referenced by BLOCXX_NAMESPACE::substitute_caps().

int BLOCXX_NAMESPACE::String::compareTo (  const char *  arg  )  const
 

Compare another string with this one.

Parameters:
arg The string to compare with this one.
Returns:
0 if this String object is equal to arg. Greater than 0 if this String object is greater than arg. Less than 0 if this String object is less than arg.

Definition at line 368 of file String.cpp.

References m_buf.

int BLOCXX_NAMESPACE::String::compareTo (  const String &  arg  )  const
 

Compare another String object with this one.

Parameters:
arg The String object to compare with this one.
Returns:
0 if this String object is equal to arg. Greater than 0 if this String object is greater than arg. Less than 0 if this String object is less than arg.

Definition at line 379 of file String.cpp.

References c_str().

Referenced by equals(), BLOCXX_NAMESPACE::operator!=(), BLOCXX_NAMESPACE::operator<(), BLOCXX_NAMESPACE::operator<=(), BLOCXX_NAMESPACE::operator==(), BLOCXX_NAMESPACE::operator>(), and BLOCXX_NAMESPACE::operator>=().

int BLOCXX_NAMESPACE::String::compareToIgnoreCase (  const char *  arg  )  const
 

Compare another string with this one ignoring case.

Parameters:
arg The string to compare with this one.
Returns:
0 if this String object is equal to arg. Greater than 0 if this String object is greater than arg. Less than 0 if this String object is less than arg.

Definition at line 385 of file String.cpp.

References BLOCXX_NAMESPACE::UTF8Utils::compareToIgnoreCase(), and m_buf.

int BLOCXX_NAMESPACE::String::compareToIgnoreCase (  const String &  arg  )  const
 

Compare another string with this one ignoring case.

Parameters:
arg The string to compare with this one.
Returns:
0 if this String object is equal to arg. Greater than 0 if this String object is greater than arg. Less than 0 if this String object is less than arg.

Definition at line 396 of file String.cpp.

References c_str().

Referenced by equalsIgnoreCase().

String & BLOCXX_NAMESPACE::String::concat (  char  arg  ) 
 

Append a char to this String object.

Parameters:
arg The char to append to this String object.
Returns:
A reference to this String object.

Definition at line 422 of file String.cpp.

References BLOCXX_NAMESPACE::AutoPtrVec< X >::get(), length(), and m_buf.

String& BLOCXX_NAMESPACE::String::concat (  const String &  arg  )  [inline]
 

Append another String object to this String object.

Parameters:
arg The String object to append to this String object.
Returns:
A reference to this String object.

Definition at line 294 of file String.hpp.

References c_str().

String & BLOCXX_NAMESPACE::String::concat (  const char *  arg  ) 
 

Append a C string to this String object.

Parameters:
arg The C string to append to this String object.
Returns:
A reference to this String object.

Definition at line 403 of file String.cpp.

References BLOCXX_NAMESPACE::AutoPtrVec< X >::get(), length(), and m_buf.

bool BLOCXX_NAMESPACE::String::empty (   )  const [inline]
 

Returns:
True if empty string, false otherwise

Definition at line 202 of file String.hpp.

Referenced by BLOCXX_NAMESPACE::CmdLineParser::CmdLineParser(), BLOCXX_NAMESPACE::LogAppender::createLogAppender(), BLOCXX_NAMESPACE::DateTime::DateTime(), BLOCXX_NAMESPACE::Format::Format(), BLOCXX_NAMESPACE::dlSharedLibraryLoader::loadSharedLibrary(), processLine::operator()(), BLOCXX_NAMESPACE::Logger::processLogMessage(), BLOCXX_NAMESPACE::SocketBaseImpl::read(), BLOCXX_NAMESPACE::FileSystem::Path::realPath(), BLOCXX_NAMESPACE::PosixRegEx::split(), BLOCXX_NAMESPACE::PerlRegEx::split(), BLOCXX_NAMESPACE::SyslogAppender::SyslogAppender(), BLOCXX_NAMESPACE::IConv::toByteString(), tokenize(), BLOCXX_NAMESPACE::IConv::toWideString(), and BLOCXX_NAMESPACE::SocketBaseImpl::write().

bool BLOCXX_NAMESPACE::String::endsWith (  char  arg  )  const
 

Determine if this String object ends with a given character.

Parameters:
arg The character to test for.
Returns:
true if this String ends with the given character. Otherwise return false.

Definition at line 439 of file String.cpp.

References m_buf.

bool BLOCXX_NAMESPACE::String::endsWith (  const String &  arg,
EIgnoreCaseFlag  ignoreCase = E_CASE_SENSITIVE
)  const [inline]
 

Determine if this String object ends with the same string represented by another String object.

Parameters:
arg The String object to search the end of this String object for.
ignoreCase If true, character case will be ignored.
Returns:
true if this String ends with the given String. Otherwise return false.

Definition at line 329 of file String.hpp.

References c_str().

bool BLOCXX_NAMESPACE::String::endsWith (  const char *  arg,
EIgnoreCaseFlag  ignoreCase = E_CASE_SENSITIVE
)  const
 

Determine if this String object ends with given C string.

Parameters:
arg The C string object to search the end of this String object for.
ignoreCase If true, character case will be ignored.
Returns:
true if this String ends with the given String. Otherwise return false.

Definition at line 448 of file String.cpp.

References BLOCXX_NAMESPACE::UTF8Utils::compareToIgnoreCase(), length(), and m_buf.

Referenced by BLOCXX_NAMESPACE::FileSystem::getDirectoryContents().

bool BLOCXX_NAMESPACE::String::equals (  const char *  arg  )  const
 

Determine if another string is equal to this String object.

Parameters:
arg The string to check this String object against for equality.
Returns:
true if this String object is equal to the given String object. Otherwise return false.

Definition at line 472 of file String.cpp.

References compareTo().

bool BLOCXX_NAMESPACE::String::equals (  const String &  arg  )  const
 

Determine if another String object is equal to this String object.

Parameters:
arg The String object to check this String object against for equality.
Returns:
true if this String object is equal to the given String object. Otherwise return false.

Definition at line 478 of file String.cpp.

References c_str().

Referenced by BLOCXX_NAMESPACE::decodeLongMonth(), BLOCXX_NAMESPACE::operator==(), and BLOCXX_NAMESPACE::SyslogAppender::SyslogAppender().

bool BLOCXX_NAMESPACE::String::equalsIgnoreCase (  const char *  arg  )  const
 

Determine if another string is equal to this String object, ignoring case in the comparision.

Parameters:
arg The string to check this String object against for equality.
Returns:
true if this String object is equal to the given String object. Otherwise return false.

Definition at line 484 of file String.cpp.

References compareToIgnoreCase().

bool BLOCXX_NAMESPACE::String::equalsIgnoreCase (  const String &  arg  )  const
 

Determine if another String object is equal to this String object, ignoring case in the comparision.

Parameters:
arg The String object to check this String object against for equality.
Returns:
true if this String object is equal to the given String object. Otherwise return false.

Definition at line 490 of file String.cpp.

References c_str().

Referenced by BLOCXX_NAMESPACE::LogAppender::createLogAppender(), BLOCXX_NAMESPACE::Logger::setLogLevel(), and toBool().

String & BLOCXX_NAMESPACE::String::erase (  size_t  idx,
size_t  len = npos
) 
 

Erases, at most, len characters of *this, starting at index idx.

if len == npos, erase to the end of the string.

Returns:
A referernce to this object.

Definition at line 796 of file String.cpp.

References length(), npos, and substring().

String & BLOCXX_NAMESPACE::String::erase (   ) 
 

Delete all the characters of the string.

Thus, the string is empty after the call.

Returns:
A referernce to this object.

Definition at line 789 of file String.cpp.

References m_buf.

Referenced by BLOCXX_NAMESPACE::PosixRegEx::compile(), BLOCXX_NAMESPACE::PerlRegEx::compile(), BLOCXX_NAMESPACE::PosixRegEx::execute(), BLOCXX_NAMESPACE::PerlRegEx::execute(), BLOCXX_NAMESPACE::getKeyValue(), BLOCXX_NAMESPACE::PosixRegEx::grep(), BLOCXX_NAMESPACE::PerlRegEx::grep(), BLOCXX_NAMESPACE::PosixRegEx::match(), BLOCXX_NAMESPACE::PerlRegEx::match(), BLOCXX_NAMESPACE::PosixRegEx::operator=(), BLOCXX_NAMESPACE::PerlRegEx::operator=(), BLOCXX_NAMESPACE::Format::process(), BLOCXX_NAMESPACE::FileSystem::Path::realPath(), BLOCXX_NAMESPACE::PosixRegEx::replace(), BLOCXX_NAMESPACE::PerlRegEx::replace(), BLOCXX_NAMESPACE::PosixRegEx::split(), BLOCXX_NAMESPACE::PerlRegEx::split(), and BLOCXX_NAMESPACE::substitute_caps().

int BLOCXX_NAMESPACE::String::format (  const char *  fmt,
  ...
) 
 

Format this string according to the given format and variable argument list (printf style).

Parameters:
fmt The format to use during the operation
... A variable argument list to be applied to the format
Returns:
The length of the string after the operation on success. npos on error.

Definition at line 332 of file String.cpp.

References BLOCXX_NAMESPACE::AutoPtrVec< X >::get(), length(), and m_buf.

static String BLOCXX_NAMESPACE::String::getLine (  std::istream &  istr  )  [static]
 

Reads from in input stream until a newline is encountered.

This consumes the newline character (but doesn't put the newline in the return value), and leaves the file pointer at the char past the newline.

Returns:
an String containing the line.

Referenced by BLOCXX_NAMESPACE::StackTrace::printStackTrace().

UInt32 BLOCXX_NAMESPACE::String::hashCode (   )  const
 

Returns:
a 32 bit hashcode of this String object.

Definition at line 496 of file String.cpp.

References i, length(), and m_buf.

size_t BLOCXX_NAMESPACE::String::indexOf (  const String &  arg,
size_t  fromIndex = 0
)  const [inline]
 

Find the first occurence of a string in this String object.

Parameters:
arg The string to search for.
fromIndex The index to start the search from.
Returns:
The index of the given string in the underlying array if it was found. npos if the string was not found at or after the fromIndex.

Definition at line 404 of file String.hpp.

References c_str().

size_t BLOCXX_NAMESPACE::String::indexOf (  const char *  arg,
size_t  fromIndex = 0
)  const
 

Find the first occurence of a C string in this String object.

Parameters:
arg The C string to search for.
fromIndex The index to start the search from.
Returns:
The index of the given string in the underlying array if it was found. npos if the string was not found at or after the fromIndex.

Definition at line 538 of file String.cpp.

References length(), m_buf, and npos.

size_t BLOCXX_NAMESPACE::String::indexOf (  char  ch,
size_t  fromIndex = 0
)  const
 

Find the first occurence of a given character in this String object.

Parameters:
ch The character to search for.
fromIndex The index to start the search from.
Returns:
The index of the given character in the underlying array if it was found. npos if the character was not found at or after the given fromIndex.

Definition at line 517 of file String.cpp.

References length(), m_buf, npos, and strchr().

Referenced by BLOCXX_NAMESPACE::SocketAddress::getAnyLocalHost(), BLOCXX_NAMESPACE::CmdLineParser::getUsage(), BLOCXX_NAMESPACE::isValidKey(), and BLOCXX_NAMESPACE::substitute_caps().

bool BLOCXX_NAMESPACE::String::isSpaces (   )  const
 

Returns:
true if this String object contains nothing but space characters.

Definition at line 694 of file String.cpp.

References m_buf.

Referenced by BLOCXX_NAMESPACE::SyslogAppender::SyslogAppender().

size_t BLOCXX_NAMESPACE::String::lastIndexOf (  const String &  arg,
size_t  fromIndex = npos
)  const [inline]
 

Find the last occurence of a string in this String object.

Parameters:
arg The string to search for.
fromIndex The index to start the search from.
Returns:
The index of the last occurence of the string in the underlying array if it was found. npos if the this String does not contain the given substring before the fromIndex.

Definition at line 435 of file String.hpp.

References c_str().

size_t BLOCXX_NAMESPACE::String::lastIndexOf (  const char *  arg,
size_t  fromIndex = npos
)  const
 

Find the last occurence of a C string in this String object.

Parameters:
arg The C string to search for.
fromIndex The index to start the search from.
Returns:
The index of the last occurence of the string in the underlying array if it was found. npos if the this String does not contain the given substring before the fromIndex.

Definition at line 591 of file String.cpp.

References length(), m_buf, and npos.

size_t BLOCXX_NAMESPACE::String::lastIndexOf (  char  ch,
size_t  fromIndex = npos
)  const
 

Find the last occurence of a character in this String object.

Parameters:
ch The character to search for.
fromIndex The index to start the search from.
Returns:
The index of the last occurence of the given character in the underlying array if it was found. npos if this String object does not contain the character before the given fromIndex.

Definition at line 564 of file String.cpp.

References i, length(), m_buf, and npos.

Referenced by BLOCXX_NAMESPACE::FileSystem::Path::dirname(), BLOCXX_NAMESPACE::CmdLineParser::getUsage(), and BLOCXX_NAMESPACE::FileSystem::Path::realPath().

size_t BLOCXX_NAMESPACE::String::length (   )  const
 

Returns:
The number of bytes in this String.

Definition at line 317 of file String.cpp.

References m_buf.

Referenced by allocateCString(), BLOCXX_NAMESPACE::StringBuffer::append(), buildTransitions(), BLOCXX_NAMESPACE::CmdLineParser::CmdLineParser(), concat(), BLOCXX_NAMESPACE::DateTime::DateTime(), BLOCXX_NAMESPACE::FileSystem::Path::dirname(), BLOCXX_NAMESPACE::FileAppender::doProcessLogMessage(), endsWith(), erase(), BLOCXX_NAMESPACE::PosixRegEx::execute(), BLOCXX_NAMESPACE::PerlRegEx::execute(), format(), BLOCXX_NAMESPACE::getTimeZoneOffset(), BLOCXX_NAMESPACE::SocketAddress::getUDS(), hashCode(), indexOf(), BLOCXX_NAMESPACE::IStringStreamBuf::IStringStreamBuf(), BLOCXX_NAMESPACE::isValidKey(), lastIndexOf(), main(), BLOCXX_NAMESPACE::PosixRegEx::match(), BLOCXX_NAMESPACE::PerlRegEx::match(), BLOCXX_NAMESPACE::TmpFileImpl::open(), BLOCXX_NAMESPACE::operator<<(), operator[](), printStrings(), BLOCXX_NAMESPACE::Format::process(), BLOCXX_NAMESPACE::FileSystem::Path::realPath(), BLOCXX_NAMESPACE::PosixRegEx::replace(), BLOCXX_NAMESPACE::PerlRegEx::replace(), rtrim(), BLOCXX_NAMESPACE::Exec::safePopen(), BLOCXX_NAMESPACE::PosixRegEx::split(), BLOCXX_NAMESPACE::PerlRegEx::split(), startsWith(), BLOCXX_NAMESPACE::UTF8Utils::StringToUCS2Common(), BLOCXX_NAMESPACE::substitute_caps(), substring(), BLOCXX_NAMESPACE::TmpFileImpl::TmpFileImpl(), BLOCXX_NAMESPACE::IConv::toByteString(), BLOCXX_NAMESPACE::IConv::toWideString(), trim(), BLOCXX_NAMESPACE::MD5::update(), BLOCXX_NAMESPACE::UUID::UUID(), and BLOCXX_NAMESPACE::UnnamedPipe::writeString().

String & BLOCXX_NAMESPACE::String::ltrim (   ) 
 

Strip all leading space characters from this String object.

Returns:
A reference to this String object after the operation has taken place.

Definition at line 709 of file String.cpp.

References m_buf, and String().

String& BLOCXX_NAMESPACE::String::operator+= (  char  arg  )  [inline]
 

Character concatination operator.

Parameters:
arg The character to append to the end of this String.
Returns:
A reference to this String object after the concatination has taken place.

Definition at line 564 of file String.hpp.

String& BLOCXX_NAMESPACE::String::operator+= (  const char *  arg  )  [inline]
 

Concatination operator.

Parameters:
arg The C string to append to the end of this String.
Returns:
A reference to this String object after the concatination has taken place.

Definition at line 557 of file String.hpp.

String& BLOCXX_NAMESPACE::String::operator+= (  const String &  arg  )  [inline]
 

Concatination operator.

Parameters:
arg The String to append to the end of this String.
Returns:
A reference to this String object after the concatination has taken place.

Definition at line 550 of file String.hpp.

String & BLOCXX_NAMESPACE::String::operator= (  const String &  arg  ) 
 

Assignment operator.

Parameters:
arg The String object to assign to this String.
Returns:
A reference to this String object after the assignment has taken place.

Definition at line 863 of file String.cpp.

References m_buf.

char & BLOCXX_NAMESPACE::String::operator[] (  size_t  ndx  ) 
 

Definition at line 904 of file String.cpp.

References BLOCXX_ASSERT, length(), m_buf, and BLOCXX_NAMESPACE::nullChar.

const char & BLOCXX_NAMESPACE::String::operator[] (  size_t  ndx  )  const
 

Operator [].

Parameters:
ndx The index of the character to retrieve from the underlying character array.
Returns:
The character at the given index within the underlying character array. If ndx is out of bounds, 0 is returned.

Definition at line 884 of file String.cpp.

References BLOCXX_ASSERT, BLOCXX_NAMESPACE::cnullChar, length(), and m_buf.

void BLOCXX_NAMESPACE::String::readObject (  std::istream &  istrm  ) 
 

Read this String object from the given istream.

An String must have been previously written to this location of the stream.

Parameters:
istrm The input stream to read this String from.
Exceptions:
IOException 

Referenced by BLOCXX_NAMESPACE::BinarySerialization::read(), and BLOCXX_NAMESPACE::BinarySerialization::readString().

String & BLOCXX_NAMESPACE::String::rtrim (   ) 
 

Strip all trailing space characters from this String object.

Returns:
A reference to this String object after the operation has taken place.

Definition at line 729 of file String.cpp.

References length(), m_buf, and String().

bool BLOCXX_NAMESPACE::String::startsWith (  char  arg  )  const
 

Determine if this String object starts with a given character.

Parameters:
arg The character to test for.
Returns:
true if this String object starts with the given character. Otherwise false.

Definition at line 624 of file String.cpp.

References m_buf.

bool BLOCXX_NAMESPACE::String::startsWith (  const String &  arg,
EIgnoreCaseFlag  ignoreCase = E_CASE_SENSITIVE
)  const [inline]
 

Determine if this String object starts with a given substring.

Parameters:
arg The String object to search the beginning of this String object for.
ignoreCase If true, case of the characters will be ignored.
Returns:
true if this String object starts with the given string. Otherwise false.

Definition at line 457 of file String.hpp.

References c_str().

bool BLOCXX_NAMESPACE::String::startsWith (  const char *  arg,
EIgnoreCaseFlag  ignoreCase = E_CASE_SENSITIVE
)  const
 

Determine if this String object starts with a given substring.

Parameters:
arg The String object to search the beginning of this String object for.
ignoreCase If true, case of the characters will be ignored.
Returns:
true if this String object starts with the given string. Otherwise false.

Definition at line 633 of file String.cpp.

References length(), m_buf, and BLOCXX_NAMESPACE::strncmpi().

Referenced by BLOCXX_NAMESPACE::CmdLineParserException::~CmdLineParserException().

const char * BLOCXX_NAMESPACE::String::strchr (  const char *  theStr,
int  c
)  [static]
 

Find the first occurrence of a character in a null terminated string.

Parameters:
theStr The string to search for the given character.
c The character to to search for.
Returns:
a pointer to the first occurrence of the character c in the string theStr if found. Otherwise a NULL pointer.

Definition at line 1470 of file String.cpp.

Referenced by indexOf(), tokenize(), and trim().

long long int BLOCXX_NAMESPACE::String::strtoll (  const char *  nptr,
char **  endptr,
int  base
)  [static]
 

Convert a null terminated string to an signed 64 bit value.

Parameters:
nptr A pointer to beginning of string to convert.
endptr If not NULL, this function stores the address of the 1st invalid character in *endptr.
base A number that specifies the base for the number pointed to by nptr.
Returns:
The signed 64 bit value of the number represented in string form pointed to by nptr.

Definition at line 1160 of file String.cpp.

Referenced by BLOCXX_NAMESPACE::convertToInt64Type().

unsigned long long int BLOCXX_NAMESPACE::String::strtoull (  const char *  nptr,
char **  endptr,
int  base
)  [static]
 

Convert a null terminated string to an unsigned 64 bit value.

Parameters:
nptr A pointer to beginning of string to convert.
endptr If not NULL, this function stores the address of the 1st invalid character in *endptr.
base A number that specifies the base for the number pointed to by nptr.
Returns:
The unsigned 64 bit value of the number represented in string form pointed to by nptr.

Definition at line 1304 of file String.cpp.

Referenced by BLOCXX_NAMESPACE::convertToUInt64Type().

String BLOCXX_NAMESPACE::String::substring (  size_t  beginIndex,
size_t  length = npos
)  const
 

Create another String object that is comprised of a substring of this String object.

Parameters:
beginIndex The start index of the substring.
length The length of the substring to use.
Returns:
A new String object representing the substring of this String object.

Definition at line 663 of file String.cpp.

References length(), m_buf, npos, and String().

Referenced by BLOCXX_NAMESPACE::PosixRegEx::capture(), BLOCXX_NAMESPACE::PerlRegEx::capture(), BLOCXX_NAMESPACE::CmdLineParser::CmdLineParser(), BLOCXX_NAMESPACE::DateTime::DateTime(), BLOCXX_NAMESPACE::FileSystem::Path::dirname(), erase(), BLOCXX_NAMESPACE::LogMessagePatternFormatter::Converter::formatMessage(), BLOCXX_NAMESPACE::CmdLineParser::getUsage(), BLOCXX_NAMESPACE::Format::process(), BLOCXX_NAMESPACE::PosixRegEx::replace(), BLOCXX_NAMESPACE::PerlRegEx::replace(), BLOCXX_NAMESPACE::PosixRegEx::split(), BLOCXX_NAMESPACE::PerlRegEx::split(), and BLOCXX_NAMESPACE::substitute_caps().

void BLOCXX_NAMESPACE::String::swap (  String &  x  ) 
 

Swap this instance with another.

Definition at line 302 of file String.cpp.

References m_buf, and BLOCXX_NAMESPACE::COWIntrusiveReference< T >::swap().

Referenced by BLOCXX_NAMESPACE::Logger::swap().

bool BLOCXX_NAMESPACE::String::toBool (   )  const
 

Returns:
The boolean value of this String object. The string is assumed to be the value of "TRUE"/"FALSE" ignoring case.
Exceptions:
StringConversionException if the conversion is impossible.

Definition at line 975 of file String.cpp.

References c_str(), equalsIgnoreCase(), and BLOCXX_NAMESPACE::throwStringConversion().

int BLOCXX_NAMESPACE::String::toInt (  int  base = 10  )  const
 

Returns:
The int value of this String object.
Exceptions:
StringConversionException if the conversion is impossible.

Definition at line 1097 of file String.cpp.

References m_buf.

Int16 BLOCXX_NAMESPACE::String::toInt16 (  int  base = 10  )  const
 

Returns:
The Int16 value of this String object.
Exceptions:
StringConversionException if the conversion is impossible.

Definition at line 1061 of file String.cpp.

References m_buf.

Int32 BLOCXX_NAMESPACE::String::toInt32 (  int  base = 10  )  const
 

Returns:
The Int32 value of this String object.
Exceptions:
StringConversionException if the conversion is impossible.

Definition at line 1073 of file String.cpp.

References m_buf.

Referenced by BLOCXX_NAMESPACE::DateTime::DateTime().

Int64 BLOCXX_NAMESPACE::String::toInt64 (  int  base = 10  )  const
 

Returns:
The Int64 value of this String object.
Exceptions:
StringConversionException if the conversion is impossible.

Definition at line 1085 of file String.cpp.

References m_buf.

Int8 BLOCXX_NAMESPACE::String::toInt8 (  int  base = 10  )  const
 

Returns:
The Int8 value of this String object.
Exceptions:
StringConversionException if the conversion is impossible.

Definition at line 1049 of file String.cpp.

References m_buf.

StringArray BLOCXX_NAMESPACE::String::tokenize (  const char *  delims = " \n\r\t\v",
EReturnDelimitersFlag  returnDelimitersAsTokens = E_DISCARD_DELIMITERS,
EEmptyTokenReturnFlag  returnEmptyTokens = E_SKIP_EMPTY_TOKENS
)  const
 

Tokenize this String object using the given delimeters.

Parameters:
delims A pointer to a char array of delimeters that separate the tokens in this String object.
returnDelimitersAsTokens If this flag is E_RETURN_DELIMITERS, then the delimiter characters are also returned as tokens, otherwise the delimiters are removed.
returnEmptyTokens If this flag is E_RETURN_EMPTY_TOKENS, then two sequential delimiters will result in an empty token being returned.
Returns:
An StringArray that contains the tokens from this String object. If there are no tokens the StringArray will be empty.

Definition at line 1103 of file String.cpp.

References BLOCXX_NAMESPACE::Array< T >::append(), E_RETURN_DELIMITERS, E_RETURN_EMPTY_TOKENS, empty(), i, m_buf, strchr(), and String().

Referenced by BLOCXX_NAMESPACE::DateTime::DateTime(), BLOCXX_NAMESPACE::SyslogAppender::doProcessLogMessage(), BLOCXX_NAMESPACE::FileSystem::getFileLines(), main(), and processLine::operator()().

String & BLOCXX_NAMESPACE::String::toLowerCase (   ) 
 

Convert this String object to lower case characters.

Returns:
A reference to this String object after the conversion has taken place.

Definition at line 814 of file String.cpp.

References m_buf, BLOCXX_NAMESPACE::UTF8Utils::toLowerCase(), and BLOCXX_NAMESPACE::UTF8Utils::toLowerCaseInPlace().

Real32 BLOCXX_NAMESPACE::String::toReal32 (   )  const
 

Returns:
The Real32 value of this String object.
Exceptions:
StringConversionException if the conversion is impossible.

Definition at line 955 of file String.cpp.

References m_buf.

Real64 BLOCXX_NAMESPACE::String::toReal64 (   )  const
 

Returns:
The Real64 value of this String object.
Exceptions:
StringConversionException if the conversion is impossible.

Definition at line 965 of file String.cpp.

References m_buf.

String BLOCXX_NAMESPACE::String::toString (   )  const
 

Returns:
A copy of this String object.

Definition at line 915 of file String.cpp.

UInt16 BLOCXX_NAMESPACE::String::toUInt16 (  int  base = 10  )  const
 

Returns:
The UInt16 value of this String object.
Exceptions:
StringConversionException if the conversion is impossible.

Definition at line 1055 of file String.cpp.

References m_buf.

UInt32 BLOCXX_NAMESPACE::String::toUInt32 (  int  base = 10  )  const
 

Returns:
The UInt32 value of this String object.
Exceptions:
StringConversionException if the conversion is impossible.

Definition at line 1067 of file String.cpp.

References m_buf.

Referenced by main().

UInt64 BLOCXX_NAMESPACE::String::toUInt64 (  int  base = 10  )  const
 

Returns:
The UInt64 value of this String object.
Exceptions:
StringConversionException if the conversion is impossible.

Definition at line 1079 of file String.cpp.

References m_buf.

Referenced by BLOCXX_NAMESPACE::LogAppender::createLogAppender().

UInt8 BLOCXX_NAMESPACE::String::toUInt8 (  int  base = 10  )  const
 

Returns:
The UInt8 value of this String object.
Exceptions:
StringConversionException if the conversion is impossible.

Definition at line 1043 of file String.cpp.

References m_buf.

unsigned int BLOCXX_NAMESPACE::String::toUnsignedInt (  int  base = 10  )  const
 

Returns:
The unsigned int value of this String object.
Exceptions:
StringConversionException if the conversion is impossible.

Definition at line 1091 of file String.cpp.

References m_buf.

Referenced by BLOCXX_NAMESPACE::LogAppender::createLogAppender().

String & BLOCXX_NAMESPACE::String::toUpperCase (   ) 
 

Convert this String object to upper case characters.

Returns:
A reference to this String object after the conversion has taken place.

Definition at line 828 of file String.cpp.

References m_buf, BLOCXX_NAMESPACE::UTF8Utils::toUpperCase(), and BLOCXX_NAMESPACE::UTF8Utils::toUpperCaseInPlace().

String & BLOCXX_NAMESPACE::String::trim (   ) 
 

Strip all leading and trailing space characters from this String object.

Returns:
A reference to this String object after the operation has taken place.

Definition at line 755 of file String.cpp.

References length(), m_buf, strchr(), and String().

size_t BLOCXX_NAMESPACE::String::UTF8Length (   )  const
 

If the string is not valid UTF-8, then the result of this function is undefined.

Returns:
The number of UTF-8 chars in this String.

Definition at line 323 of file String.cpp.

References c_str(), and BLOCXX_NAMESPACE::UTF8Utils::charCount().

void BLOCXX_NAMESPACE::String::writeObject (  std::ostream &  ostrm  )  const
 

Write this String object to the given ostream.

Parameters:
ostrm The output stream to write this String to.
Exceptions:
IOException 

Referenced by BLOCXX_NAMESPACE::BinarySerialization::write(), and BLOCXX_NAMESPACE::BinarySerialization::writeString().

Member Data Documentation

buf_t BLOCXX_NAMESPACE::String::m_buf [private]
 

Definition at line 702 of file String.hpp.

Referenced by c_str(), charAt(), compareTo(), compareToIgnoreCase(), concat(), endsWith(), erase(), format(), hashCode(), indexOf(), isSpaces(), lastIndexOf(), length(), ltrim(), operator=(), operator[](), rtrim(), startsWith(), String(), substring(), swap(), toInt(), toInt16(), toInt32(), toInt64(), toInt8(), tokenize(), toLowerCase(), toReal32(), toReal64(), toUInt16(), toUInt32(), toUInt64(), toUInt8(), toUnsignedInt(), toUpperCase(), and trim().

const size_t BLOCXX_NAMESPACE::String::npos = ~0 [static]
 

Definition at line 692 of file String.hpp.

Referenced by BLOCXX_NAMESPACE::DateTime::DateTime(), BLOCXX_NAMESPACE::FileSystem::Path::dirname(), erase(), BLOCXX_NAMESPACE::SocketAddress::getAnyLocalHost(), BLOCXX_NAMESPACE::CmdLineParser::getUsage(), indexOf(), BLOCXX_NAMESPACE::isValidKey(), lastIndexOf(), BLOCXX_NAMESPACE::FileSystem::Path::realPath(), BLOCXX_NAMESPACE::substitute_caps(), and substring().

The documentation for this class was generated from the following files:
Generated on Tue Sep 13 00:07:02 2005 for blocxx by  doxygen 1.4.4