ACE_String_Base< CHAR > Class Template Reference

This class provides a wrapper facade for C strings. More...

#include <String_Base.h>

Inheritance diagram for ACE_String_Base< CHAR >:

[legend]Collaboration diagram for ACE_String_Base< CHAR >:

[legend]List of all members.

Public Types
typedef ACE_Allocator::size_type	size_type
Public Member Functions
	ACE_String_Base (ACE_Allocator *the_allocator=0)
	ACE_String_Base (const CHAR *s, ACE_Allocator *the_allocator=0, bool release=true)
	ACE_String_Base (const CHAR *s, size_type len, ACE_Allocator *the_allocator=0, bool release=true)
	ACE_String_Base (const ACE_String_Base< CHAR > &s)
	ACE_String_Base (CHAR c, ACE_Allocator *the_allocator=0)
	ACE_String_Base (size_type len, CHAR c=0, ACE_Allocator *the_allocator=0)
	~ACE_String_Base (void)
const CHAR &	operator[] (size_type slot) const
CHAR &	operator[] (size_type slot)
ACE_String_Base< CHAR > &	operator= (const CHAR *s)
ACE_String_Base< CHAR > &	operator= (const ACE_String_Base< CHAR > &s)
ACE_String_Base< CHAR > &	assign_nocopy (const ACE_String_Base< CHAR > &s)
void	set (const CHAR *s, bool release=true)
void	set (const CHAR *s, size_type len, bool release)
void	clear (bool release=false)
void	fast_clear (void)
ACE_String_Base< CHAR >	substring (size_type offset, size_type length=npos) const
ACE_String_Base< CHAR >	substr (size_type offset, size_type length=npos) const
ACE_String_Base< CHAR > &	operator+= (const ACE_String_Base< CHAR > &s)
ACE_String_Base< CHAR > &	operator+= (const CHAR *s)
ACE_String_Base< CHAR > &	operator+= (const CHAR c)
ACE_String_Base< CHAR > &	append (const CHAR *s, size_type slen)
u_long	hash (void) const
size_type	length (void) const
size_t	capacity (void) const
bool	is_empty (void) const
bool	empty (void) const
CHAR *	rep (void) const
const CHAR *	fast_rep (void) const
const CHAR *	c_str (void) const
size_type	strstr (const ACE_String_Base< CHAR > &s) const
size_type	find (const ACE_String_Base< CHAR > &str, size_type pos=0) const
size_type	find (const CHAR *s, size_type pos=0) const
size_type	find (CHAR c, size_type pos=0) const
size_type	rfind (CHAR c, size_type pos=npos) const
bool	operator== (const ACE_String_Base< CHAR > &s) const
bool	operator== (const CHAR *s) const
bool	operator< (const ACE_String_Base< CHAR > &s) const
bool	operator> (const ACE_String_Base< CHAR > &s) const
bool	operator!= (const ACE_String_Base< CHAR > &s) const
bool	operator!= (const CHAR *s) const
int	compare (const ACE_String_Base< CHAR > &s) const
void	dump (void) const
void	resize (size_type len, CHAR c=0)
void	fast_resize (size_t len)
void	swap (ACE_String_Base< CHAR > &str)
	Swap the contents of this ACE_String_Base with str.
Public Attributes
	ACE_ALLOC_HOOK_DECLARE
Protected Attributes
ACE_Allocator *	allocator_
size_type	len_
size_type	buf_len_
CHAR *	rep_
bool	release_
Static Protected Attributes
CHAR	NULL_String_ = 0

---

Detailed Description

template<class CHAR>
class ACE_String_Base< CHAR >

This class provides a wrapper facade for C strings.

This class uses an ACE_Allocator to allocate memory. The user can make this a persistant class by providing an ACE_Allocator with a persistable memory pool. This class is optimized for efficiency, so it doesn't provide any internal locking.

Note:

If an instance of this class is constructed from or assigned an empty string (with first element of ''), then it is not allocated new space. Instead, its internal representation is set equal to a global empty string. CAUTION: in cases when ACE_String_Base is constructed from a provided buffer with the release parameter set to false, ACE_String_Base is not guaranteed to be '' terminated.

• Do not use a "@c -1" magic number to refer to the "no position" condition. This was never the right thing to do. The "@c npos" constant should be used in such cases.
• Do not assign or pass string positions to or from signed types. Use the "@c size_type" typedef found in all ACE string classes. This typedef is analogous to the "@c size_type" typedef found in the standard C++ string class as well as many STL class templates. If you find yourself casting you're probably doing something wrong.

Definition at line 58 of file String_Base.h.

---

Member Typedef Documentation

template<class CHAR> typedef ACE_Allocator::size_type ACE_String_Base_Const::size_type

Definition at line 41 of file String_Base_Const.h.

---

Constructor & Destructor Documentation

template<class CHAR> ACE_String_Base< CHAR >::ACE_String_Base (  ACE_Allocator *  the_allocator = 0  )

Default constructor. Parameters: the_allocator  ACE_Allocator associated with string Returns: Default ACE_String_Base string. Definition at line 28 of file String_Base.cpp. References ACE_TRACE. : allocator_ (the_allocator ? the_allocator : ACE_Allocator::instance ()), len_ (0), buf_len_ (0), rep_ (&ACE_String_Base<CHAR>::NULL_String_), release_ (false) { ACE_TRACE ("ACE_String_Base<CHAR>::ACE_String_Base"); }

template<class CHAR> ACE_String_Base< CHAR >::ACE_String_Base (  const CHAR *  s, ACE_Allocator *  the_allocator = 0, bool  release = true )

Constructor that copies s into dynamically allocated memory. if release == true then a new buffer is allocated internally, and s is copied to the internal buffer. if release == false then the s buffer is used directly. If s == 0 then it will _not_ be used, and instead the internal buffer is set to NULL_String_. Parameters: s  Zero terminated input string the_allocator  ACE_Allocator associated with string release  Allocator responsible(true)/not reponsible(false) for freeing memory. Returns: ACE_String_Base containing const CHAR *s Definition at line 41 of file String_Base.cpp. References ACE_TRACE, and ACE_String_Base< CHAR >::set(). : allocator_ (the_allocator ? the_allocator : ACE_Allocator::instance ()), len_ (0), buf_len_ (0), rep_ (0), release_ (false) { ACE_TRACE ("ACE_String_Base<CHAR>::ACE_String_Base"); this->set (s, release); }

template<class CHAR> ACE_String_Base< CHAR >::ACE_String_Base (  const CHAR *  s, size_type  len, ACE_Allocator *  the_allocator = 0, bool  release = true )

Constructor that copies len CHARs of s into dynamically allocated memory (will zero terminate the result). if release == true then a new buffer is allocated internally. s is copied to the internal buffer. if release == false then the s buffer is used directly. If s == 0 then it will _not_ be used, and instead the internal buffer is set to NULL_String_. Parameters: s  Non-zero terminated input string len  Length of non-zero terminated input string the_allocator  ACE_Allocator associated with string release  Allocator responsible(true)/not reponsible(false) for freeing memory. Returns: ACE_String_Base containing const CHAR *s Definition at line 71 of file String_Base.cpp. References ACE_TRACE, and ACE_String_Base< CHAR >::set(). : allocator_ (the_allocator ? the_allocator : ACE_Allocator::instance ()), len_ (0), buf_len_ (0), rep_ (0), release_ (false) { ACE_TRACE ("ACE_String_Base<CHAR>::ACE_String_Base"); this->set (s, len, release); }

template<class CHAR> ACE_String_Base< CHAR >::ACE_String_Base (  const ACE_String_Base< CHAR > &  s  )

Copy constructor. Parameters: s  Input ACE_String_Base string to copy Returns: Copy of input string s Definition at line 90 of file String_Base.cpp. References ACE_TRACE, ACE_String_Base< CHAR >::len_, ACE_String_Base< CHAR >::rep_, and ACE_String_Base< CHAR >::set(). : allocator_ (s.allocator_ ? s.allocator_ : ACE_Allocator::instance ()), len_ (0), buf_len_ (0), rep_ (0), release_ (false) { ACE_TRACE ("ACE_String_Base<CHAR>::ACE_String_Base"); this->set (s.rep_, s.len_, true); }

template<class CHAR> ACE_String_Base< CHAR >::ACE_String_Base (  CHAR  c, ACE_Allocator *  the_allocator = 0 )

Constructor that copies c into dynamically allocated memory. Parameters: c  Single input character. the_allocator  ACE_Allocator associated with string Returns: ACE_String_Base containing CHAR 'c' Definition at line 55 of file String_Base.cpp. References ACE_TRACE, and ACE_String_Base< CHAR >::set(). : allocator_ (the_allocator ? the_allocator : ACE_Allocator::instance ()), len_ (0), buf_len_ (0), rep_ (0), release_ (false) { ACE_TRACE ("ACE_String_Base<CHAR>::ACE_String_Base"); this->set (&c, 1, true); }

template<class CHAR> ACE_String_Base< CHAR >::ACE_String_Base (  size_type  len, CHAR  c = 0, ACE_Allocator *  the_allocator = 0 )

Constructor that allocates a len long string. Warning : This constructor was incorrectly documented in the past. It simply calls resize(len, c). It is probably not advisable to use the second parameter. See resize() for more information. Parameters: len  Amount of space to reserve for the string. c  The array is filled with c's the_allocator  ACE_Allocator associated with string Returns: Empty ACE_String_Base with room for len CHARs Definition at line 103 of file String_Base.cpp. References ACE_TRACE, and ACE_String_Base< CHAR >::resize(). : allocator_ (the_allocator ? the_allocator : ACE_Allocator::instance ()), len_ (0), buf_len_ (0), rep_ (0), release_ (false) { ACE_TRACE ("ACE_String_Base<CHAR>::ACE_String_Base"); this->resize (len, c); }

template<class CHAR> ACE_String_Base< CHAR >::~ACE_String_Base (  void   )

Deletes the memory... Definition at line 119 of file String_Base.cpp. References ACE_TRACE, ACE_String_Base< CHAR >::buf_len_, ACE_Allocator::free(), and ACE_String_Base< CHAR >::release_. { ACE_TRACE ("ACE_String_Base<CHAR>::~ACE_String_Base"); if (this->buf_len_ != 0 && this->release_) this->allocator_->free (this->rep_); }

---

Member Function Documentation

template<class CHAR> ACE_String_Base< CHAR > & ACE_String_Base< CHAR >::append (  const CHAR *  s, size_type  slen )

Append function (copies memory). Parameters: s  Input CHAR array to concatenate to this string. slen  The length of the array. Returns: The combined string (input append to the end of the old). New string is zero terminated. Definition at line 213 of file String_Base.cpp. References ACE_ALLOCATOR_RETURN, ace_max(), ACE_TRACE, ACE_String_Base< CHAR >::buf_len_, ACE_Allocator::free(), ACE_OS::memcpy(), and ACE_String_Base< CHAR >::release_. Referenced by operator+(), and ACE_String_Base< CHAR >::operator+=(). { ACE_TRACE ("ACE_String_Base<CHAR>::append(const CHAR*, size_type)"); if (slen > 0 && slen != npos) { // case 1. No memory allocation needed. if (this->buf_len_ >= this->len_ + slen + 1) { // Copy in data from new string. ACE_OS::memcpy (this->rep_ + this->len_, s, slen * sizeof (CHAR)); } else // case 2. Memory reallocation is needed { const size_type new_buf_len = ace_max(this->len_ + slen + 1, this->buf_len_ + this->buf_len_ / 2); CHAR *t = 0; ACE_ALLOCATOR_RETURN (t, (CHAR *) this->allocator_->malloc (new_buf_len * sizeof (CHAR)), *this); // Copy memory from old string into new string. ACE_OS::memcpy (t, this->rep_, this->len_ * sizeof (CHAR)); ACE_OS::memcpy (t + this->len_, s, slen * sizeof (CHAR)); if (this->buf_len_ != 0 && this->release_) this->allocator_->free (this->rep_); this->release_ = true; this->rep_ = t; this->buf_len_ = new_buf_len; } this->len_ += slen; this->rep_[this->len_] = 0; } return *this; }

template<class CHAR> ACE_INLINE ACE_String_Base< CHAR > & ACE_String_Base< CHAR >::assign_nocopy (  const ACE_String_Base< CHAR > &  s  )

Assignment alternative method (does not copy memory). Parameters: s  Input ACE_String_Base string to assign to this object. Returns: Return this string. Definition at line 22 of file String_Base.inl. References ACE_TRACE, ACE_String_Base< CHAR >::len_, ACE_String_Base< CHAR >::rep_, and ACE_String_Base< CHAR >::set(). Referenced by ACE_Configuration_Heap::load_key(). { ACE_TRACE ("ACE_String_Base<CHAR>::assign_nocopy"); this->set (s.rep_, s.len_, false); return *this; }

template<class CHAR> ACE_INLINE const CHAR * ACE_String_Base< CHAR >::c_str (  void   )  const

Same as STL String's and . Definition at line 91 of file String_Base.inl. Referenced by ACE_Get_Opt::dump(), ACE_Utils::UUID::from_string_i(), ACE_Capabilities::getent(), ACE_Capabilities::is_entry(), ACE_Get_Opt::last_option(), ACE_Codeset_Registry::locale_to_registry(), ACE_Codeset_Registry::locale_to_registry_i(), ACE_DLL_Handle::open(), ACE_Configuration_Heap::open_section(), ACE_Configuration::operator==(), ACE_Get_Opt::optstring(), ACE_Utils::UUID::to_string(), ACE_OutputCDR::write_string(), and ACE_SizeCDR::write_string(). { return this->rep_; }

template<class CHAR> ACE_INLINE size_t ACE_String_Base< CHAR >::capacity (  void   )  const

Return the number of allocated CHARs in the string object. This may be greater than the current length of the string. Returns: Maximum number of CHAR units that can be stored, including any terminating nul that may be needed. Definition at line 37 of file String_Base.inl. References ACE_TRACE, and ACE_String_Base< CHAR >::buf_len_. { ACE_TRACE ("ACE_String_Base<CHAR>::capacity"); return this->buf_len_; }

template<class CHAR> void ACE_String_Base< CHAR >::clear (  bool  release = false  )

Clear this string. Memory is _not_ freed if release is false. Warning: This method was incorrectly documented in the past, but the current implementation has been changed to match the documented behavior. Warning: clear(false) behaves like fast_clear() below. Parameters: release  Memory is freed if true, and not freed if false. Definition at line 296 of file String_Base.cpp. References ACE_String_Base< CHAR >::buf_len_, ACE_String_Base< CHAR >::fast_clear(), ACE_Allocator::free(), and ACE_String_Base< CHAR >::release_. { // This can't use set(), because that would free memory if release=false if (release) { if (this->buf_len_ != 0 && this->release_) this->allocator_->free (this->rep_); this->rep_ = &ACE_String_Base<CHAR>::NULL_String_; this->len_ = 0; this->buf_len_ = 0; this->release_ = false; } else { this->fast_clear (); } }

template<class CHAR> int ACE_String_Base< CHAR >::compare (  const ACE_String_Base< CHAR > &  s  )  const

Performs a strncmp comparison. Parameters: s  Input ACE_String_Base string to compare against stored string. Returns: Integer value of result (less than 0, 0, greater than 0) depending on how input string s is to the stored string. Definition at line 383 of file String_Base.cpp. References ace_min(), ACE_TRACE, ACE_String_Base< CHAR >::len_, ACE_OS::memcmp(), and ACE_String_Base< CHAR >::rep_. Referenced by ACE_String_Base< CHAR >::operator<(), and ACE_String_Base< CHAR >::operator>(). { ACE_TRACE ("ACE_String_Base<CHAR>::compare"); if (this->rep_ == s.rep_) return 0; // Pick smaller of the two lengths and perform the comparison. size_type smaller_length = ace_min (this->len_, s.len_); int result = ACE_OS::memcmp (this->rep_, s.rep_, smaller_length * sizeof (CHAR)); if (!result) result = static_cast<int> (this->len_ - s.len_); return result; }

template<class CHAR> ACE_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE void ACE_String_Base< CHAR >::dump (  void   )  const

Dump the state of an object. Definition at line 13 of file String_Base.inl. References ACE_TRACE. { #if defined (ACE_HAS_DUMP) ACE_TRACE ("ACE_String_Base<CHAR>::dump"); #endif /* ACE_HAS_DUMP */ }

template<class CHAR> ACE_INLINE bool ACE_String_Base< CHAR >::empty (  void   )  const

Return true if the length of the string is zero, else false. We recommend using is_empty() instead since it's more consistent with the ACE container naming conventions. Definition at line 50 of file String_Base.inl. References ACE_String_Base< CHAR >::is_empty(). { return this->is_empty (); }

template<class CHAR> void ACE_String_Base< CHAR >::fast_clear (  void   )

A more specialized version of clear(): "fast clear". fast_clear() resets the string to 0 length. If the string owns the buffer ( release_== true): the string buffer is not freed the first character of the buffer is set to 0. If release_ is false (this object does not own the buffer): the buffer pointer is reset to the NULL_String_ and does not maintain a pointer to the caller-supplied buffer on return the maximum string length is reset to 0. Warning : Calling clear(false) or fast_clear() can have unintended side-effects if the string was constructed (or set()) with an external buffer. The string will be disassociated with the buffer and the next append() or +=() will cause a new buffer to be allocated internally. Definition at line 351 of file String_Base.cpp. References ACE_String_Base< CHAR >::buf_len_, and ACE_String_Base< CHAR >::release_. Referenced by ACE_String_Base< CHAR >::clear(). { this->len_ = 0; if (this->release_) { // String retains the original buffer. if (this->rep_ != &ACE_String_Base<CHAR>::NULL_String_) this->rep_[0] = 0; } else { // External buffer: string relinquishes control of it. this->buf_len_ = 0; this->rep_ = &ACE_String_Base<CHAR>::NULL_String_; } }

template<class CHAR> ACE_INLINE const CHAR * ACE_String_Base< CHAR >::fast_rep (  void   )  const

Get at the underlying representation directly! _Don't_ even think about casting the result to (char *) and modifying it, if it has length 0! Returns: Pointer reference to the stored string data. No guarantee is that the string is zero terminated. Definition at line 85 of file String_Base.inl. Referenced by ACE_Configuration_Heap::add_section(), ACE_Ini_ImpExp::export_section(), ACE_Registry_ImpExp::export_section(), ACE_Configuration_Heap::find_value(), ACE_Configuration_Heap::get_binary_value(), ACE_Configuration_Heap::get_integer_value(), ACE_Configuration_Heap::get_string_value(), ACE_Configuration_Heap::new_section(), ACE_Configuration_Heap::open_simple_section(), operator<<(), ACE_Service_Gestalt::process_commandline_directives(), ACE_Service_Gestalt::process_directives(), ACE_Configuration_Heap::remove_section(), ACE_Configuration_Heap::remove_value(), ACE_Configuration_Heap::set_binary_value(), ACE_Configuration_Heap::set_integer_value(), ACE_Configuration_Heap::set_string_value(), and ACE_Configuration_Win32Registry::set_string_value(). { return this->rep_; }

template<class CHAR> void ACE_String_Base< CHAR >::fast_resize (  size_t  len  )

Definition at line 275 of file String_Base.cpp. References ACE_TRACE, ACE_String_Base< CHAR >::buf_len_, ACE_Allocator::free(), ACE_Allocator::malloc(), and ACE_String_Base< CHAR >::release_. Referenced by ACE_String_Base< CHAR >::resize(). { ACE_TRACE ("ACE_String_Base<CHAR>::fast_resize"); // Only reallocate if we don't have enough space... if (this->buf_len_ <= len) { if (this->buf_len_ != 0 && this->release_) this->allocator_->free (this->rep_); this->rep_ = static_cast<CHAR*> (this->allocator_->malloc ((len + 1) * sizeof (CHAR))); this->buf_len_ = len + 1; this->release_ = true; } this->len_ = 0; if (len > 0) this->rep_[0] = 0; }

template<class CHAR> ACE_String_Base< CHAR >::size_type ACE_String_Base< CHAR >::find (  CHAR  c, size_type  pos = 0 )  const

Find c starting at pos. Returns the slot of the first location that matches (will be >= pos), else npos. Parameters: c  Input character to search for in stored string. pos  Starting index position to start searching for string str. Returns: Index value of the first location of string str else npos. Definition at line 438 of file String_Base.cpp. References ACE_OS::strnchr(). { CHAR *substr = this->rep_ + pos; CHAR *pointer = ACE_OS::strnchr (substr, c, this->len_ - pos); if (pointer == 0) return ACE_String_Base<CHAR>::npos; else return pointer - this->rep_; }

template<class CHAR> ACE_String_Base< CHAR >::size_type ACE_String_Base< CHAR >::find (  const CHAR *  s, size_type  pos = 0 )  const

Find s starting at pos. Returns the slot of the first location that matches (will be >= pos), else npos. Parameters: s  non-zero input string to search for in stored string. pos  Starting index position to start searching for string str. Returns: Index value of the first location of string str else npos. Definition at line 424 of file String_Base.cpp. References ACE_OS::strlen(), and ACE_OS::strnstr(). { CHAR *substr = this->rep_ + pos; size_t len = ACE_OS::strlen (s); CHAR *pointer = ACE_OS::strnstr (substr, s, len); if (pointer == 0) return ACE_String_Base<CHAR>::npos; else return pointer - this->rep_; }

template<class CHAR> ACE_INLINE ACE_String_Base< CHAR >::size_type ACE_String_Base< CHAR >::find (  const ACE_String_Base< CHAR > &  str, size_type  pos = 0 )  const

Find starting at pos. Returns the slot of the first location that matches (will be >= pos), else npos. Parameters: str  Input ACE_String_Base string to search for in stored string. pos  Starting index position to start searching for string str. Returns: Index value of the first location of string str else npos. Definition at line 131 of file String_Base.inl. References ACE_TRACE, and ACE_String_Base< CHAR >::rep_. Referenced by ACE_Utils::UUID::from_string_i(), ACE_Get_Opt::long_option_i(), and ACE_String_Base< CHAR >::strstr(). { ACE_TRACE ("ACE_String_Base<CHAR>::find"); return this->find (str.rep_, pos); }

template<class CHAR> u_long ACE_String_Base< CHAR >::hash (  void   )  const

Returns a hash value for this string. Returns: Hash value of string Definition at line 256 of file String_Base.cpp. References ACE::hash_pjw(). Referenced by ACE_Configuration_ExtId::hash(), and ACE_Hash< ACE_CString >::operator()(). { return ACE::hash_pjw (reinterpret_cast<char *> ( const_cast<CHAR *> (this->rep_)), this->len_ * sizeof (CHAR)); }

template<class CHAR> ACE_INLINE bool ACE_String_Base< CHAR >::is_empty (  void   )  const

Return true if the length of the string is zero, else false. Definition at line 44 of file String_Base.inl. Referenced by ACE_String_Base< CHAR >::empty(). { return this->len_ == 0; }

template<class CHAR> ACE_INLINE ACE_String_Base< CHAR >::size_type ACE_String_Base< CHAR >::length (  void   )  const

Return the length of the string. Returns: Length of stored string Definition at line 30 of file String_Base.inl. References ACE_TRACE. Referenced by ACE_Configuration_Heap::add_section(), ACE_Remote_Name_Space::bind(), ACE_Ini_ImpExp::export_section(), ACE_Registry_ImpExp::export_section(), ACE_Utils::UUID::from_string_i(), ACE_DLL_Handle::get_dll_names(), ACE_Capabilities::getline(), ACE_Remote_Name_Space::list_name_entries(), ACE_Remote_Name_Space::list_names(), ACE_Remote_Name_Space::list_type_entries(), ACE_Remote_Name_Space::list_types(), ACE_Remote_Name_Space::list_value_entries(), ACE_Remote_Name_Space::list_values(), ACE_Configuration_Heap::new_section(), ACE_DLL_Handle::open(), ACE_Configuration_Heap::open_simple_section(), operator+(), ACE_Remote_Name_Space::rebind(), ACE_Configuration_Heap::remove_section(), ACE_Remote_Name_Space::resolve(), ACE_Configuration_Heap::set_string_value(), ACE_Configuration_Win32Registry::set_string_value(), ACE_Local_Name_Space<, ACE_LOCK >::shared_bind_i(), ACE_Utils::UUID::to_string(), ACE_Remote_Name_Space::unbind(), ACE_OutputCDR::write_string(), and ACE_SizeCDR::write_string(). { ACE_TRACE ("ACE_String_Base<CHAR>::length"); return this->len_; }

template<class CHAR> ACE_INLINE bool ACE_String_Base< CHAR >::operator!= (  const CHAR *  s  )  const

Inequality comparison operator. Parameters: s  Null terminated string to compare against stored string. Returns: true if not equal, false otherwise. Definition at line 125 of file String_Base.inl. { return !(*this == s); }

template<class CHAR> ACE_INLINE bool ACE_String_Base< CHAR >::operator!= (  const ACE_String_Base< CHAR > &  s  )  const

Inequality comparison operator. Parameters: s  String to compare against stored string. Returns: true if not equal, false otherwise. Definition at line 118 of file String_Base.inl. References ACE_TRACE. { ACE_TRACE ("ACE_String_Base<CHAR>::operator!="); return !(*this == s); }

template<class CHAR> ACE_String_Base< CHAR > & ACE_String_Base< CHAR >::operator+= (  const CHAR  c  )

Concat operator (copies memory). Parameters: c  Input CHAR to concatenate to this string. Returns: The combined string (input append to the end of the old). New string is zero terminated. Definition at line 554 of file String_Base.cpp. References ACE_TRACE, and ACE_String_Base< CHAR >::append(). { ACE_TRACE ("ACE_String_Base<CHAR>::operator+=(const CHAR)"); const size_type slen = 1; return this->append (&c, slen); }

template<class CHAR> ACE_String_Base< CHAR > & ACE_String_Base< CHAR >::operator+= (  const CHAR *  s  )

Concat operator (copies memory). Parameters: s  Input C string to concatenate to this string. Returns: The combined string (input append to the end of the old). New string is zero terminated. Definition at line 536 of file String_Base.cpp. References ACE_String_Base< CHAR >::append(), and ACE_OS::strlen(). { size_t slen = 0; if (s != 0) slen = ACE_OS::strlen (s); return this->append (s, slen); }

template<class CHAR> ACE_String_Base< CHAR > & ACE_String_Base< CHAR >::operator+= (  const ACE_String_Base< CHAR > &  s  )

Concat operator (copies memory). Parameters: s  Input ACE_String_Base string to concatenate to this string. Returns: The combined string (input append to the end of the old). New string is zero terminated. Definition at line 546 of file String_Base.cpp. References ACE_TRACE, ACE_String_Base< CHAR >::append(), ACE_String_Base< CHAR >::len_, and ACE_String_Base< CHAR >::rep_. { ACE_TRACE ("ACE_String_Base<CHAR>::operator+=(const ACE_String_Base<CHAR> &)"); return this->append (s.rep_, s.len_); }

template<class CHAR> ACE_INLINE bool ACE_String_Base< CHAR >::operator< (  const ACE_String_Base< CHAR > &  s  )  const

Less than comparison operator. Parameters: s  Input ACE_String_Base string to compare against stored string. Returns: true if less than, false otherwise. Definition at line 99 of file String_Base.inl. References ACE_TRACE, and ACE_String_Base< CHAR >::compare(). { ACE_TRACE ("ACE_String_Base<CHAR>::operator <"); return compare (s) < 0; }

template<class CHAR> ACE_String_Base< CHAR > & ACE_String_Base< CHAR >::operator= (  const ACE_String_Base< CHAR > &  s  )

Assignment operator (does copy memory). Parameters: s  Input ACE_String_Base string to assign to this object. Returns: Return a copy of the this string. Definition at line 327 of file String_Base.cpp. References ACE_TRACE, ACE_String_Base< CHAR >::len_, ACE_String_Base< CHAR >::rep_, and ACE_String_Base< CHAR >::set(). { ACE_TRACE ("ACE_String_Base<CHAR>::operator="); // Check for self-assignment. if (this != &s) { this->set (s.rep_, s.len_, true); } return *this; }

template<class CHAR> ACE_String_Base< CHAR > & ACE_String_Base< CHAR >::operator= (  const CHAR *  s  )

Assignment operator (does copy memory). Parameters: s  Input null-terminated CHAR string to assign to this object. Returns: Return a copy of the this string. Definition at line 317 of file String_Base.cpp. References ACE_TRACE, and ACE_String_Base< CHAR >::set(). { ACE_TRACE ("ACE_String_Base<CHAR>::operator="); if (s != 0) this->set (s, true); return *this; }

template<class CHAR> bool ACE_String_Base< CHAR >::operator== (  const CHAR *  s  )  const

Equality comparison operator (must match entire string). Parameters: s  Null terminated string to compare against stored string. Returns: true if equal, false otherwise. Definition at line 414 of file String_Base.cpp. References ACE_OS::memcmp(), and ACE_OS::strlen(). { size_t len = ACE_OS::strlen (s); return this->len_ == len && ACE_OS::memcmp (this->rep_, s, len * sizeof (CHAR)) == 0; }

template<class CHAR> bool ACE_String_Base< CHAR >::operator== (  const ACE_String_Base< CHAR > &  s  )  const

Equality comparison operator (must match entire string). Parameters: s  Input ACE_String_Base string to compare against stored string. Returns: true if equal, false otherwise. Definition at line 405 of file String_Base.cpp. References ACE_String_Base< CHAR >::len_, ACE_OS::memcmp(), and ACE_String_Base< CHAR >::rep_. { return this->len_ == s.len_ && ACE_OS::memcmp (this->rep_, s.rep_, this->len_ * sizeof (CHAR)) == 0; }

template<class CHAR> ACE_INLINE bool ACE_String_Base< CHAR >::operator> (  const ACE_String_Base< CHAR > &  s  )  const

Greater than comparison operator. Parameters: s  Input ACE_String_Base string to compare against stored string. Returns: true if greater than, false otherwise. Definition at line 108 of file String_Base.inl. References ACE_TRACE, and ACE_String_Base< CHAR >::compare(). { ACE_TRACE ("ACE_String_Base<CHAR>::operator >"); return compare (s) > 0; }

template<class CHAR> ACE_INLINE CHAR & ACE_String_Base< CHAR >::operator[] (  size_type  slot  )

Return the <slot'th> character by reference in the string (doesn't perform bounds checking). Parameters: slot  Index of the desired character Returns: The character at index slot Definition at line 77 of file String_Base.inl. References ACE_TRACE. { ACE_TRACE ("ACE_String_Base<CHAR>::operator[]"); return this->rep_[slot]; }

template<class CHAR> ACE_INLINE const CHAR & ACE_String_Base< CHAR >::operator[] (  size_type  slot  )  const

Return the <slot'th> character in the string (doesn't perform bounds checking). Parameters: slot  Index of the desired character Returns: The character at index slot Definition at line 67 of file String_Base.inl. References ACE_TRACE. { ACE_TRACE ("ACE_String_Base<CHAR>::operator[]"); return this->rep_[slot]; }

template<class CHAR> CHAR * ACE_String_Base< CHAR >::rep (  void   )  const

Get a copy of the underlying representation. This method allocates memory for a copy of the string and returns a pointer to the new area. The caller is responsible for freeing the memory when finished; use delete [] Returns: Pointer reference to the string data. Returned string is zero terminated. Definition at line 371 of file String_Base.cpp. References ACE_NEW_RETURN, ACE_TRACE, and ACE_OS::strsncpy(). Referenced by ACE_Remote_Name_Space::bind(), ACE_Configuration::expand_path(), ACE_Remote_Name_Space::list_name_entries(), ACE_Remote_Name_Space::list_names(), ACE_Remote_Name_Space::list_type_entries(), ACE_Remote_Name_Space::list_types(), ACE_Remote_Name_Space::list_value_entries(), ACE_Remote_Name_Space::list_values(), ACE_Remote_Name_Space::rebind(), ACE_Remote_Name_Space::resolve(), ACE_Local_Name_Space<, ACE_LOCK >::shared_bind_i(), and ACE_Remote_Name_Space::unbind(). { ACE_TRACE ("ACE_String_Base<CHAR>::rep"); CHAR *new_string; ACE_NEW_RETURN (new_string, CHAR[this->len_ + 1], 0); ACE_OS::strsncpy (new_string, this->rep_, this->len_+1); return new_string; }

template<class CHAR> void ACE_String_Base< CHAR >::resize (  size_type  len, CHAR  c = 0 )

This method is designed for high-performance. Please use with care ;-) Warning : This method was documented incorrectly in the past. The original intention was to change the length of the string to len, and to fill the whole thing with c CHARs. However, what was actually done was to set the length of the string to zero, and fill the buffer with c's. The buffer was also not null-terminated unless c happened to be zero. Rather than fix the method to work as documented, the code is left as is, but the second parameter should probably not be used. fast_resize just adjusts the buffer if needed and sets the length, it doesn't fill the buffer, so is much faster. Parameters: len  The number of CHARs to reserve c  The CHAR to use when filling the string. Definition at line 265 of file String_Base.cpp. References ACE_TRACE, ACE_String_Base< CHAR >::fast_resize(), and ACE_OS::memset(). Referenced by ACE_String_Base< CHAR >::ACE_String_Base(). { ACE_TRACE ("ACE_String_Base<CHAR>::resize"); fast_resize(len); ACE_OS::memset (this->rep_, c, this->buf_len_ * sizeof (CHAR)); }

template<class CHAR> ACE_String_Base< CHAR >::size_type ACE_String_Base< CHAR >::rfind (  CHAR  c, size_type  pos = npos )  const

Find c starting at pos (counting from the end). Returns the slot of the first location that matches, else npos. Parameters: c  Input character to search for in stored string. pos  Starting index position to start searching for string str. Returns: Index value of the first location of string str else npos. Definition at line 451 of file String_Base.cpp. Referenced by ACE_DLL_Handle::get_dll_names(). { if (pos == npos || pos > this->len_) pos = this->len_; // Do not change to prefix operator! Proper operation of this loop // depends on postfix decrement behavior. for (size_type i = pos; i-- != 0; ) if (this->rep_[i] == c) return i; return ACE_String_Base<CHAR>::npos; }

template<class CHAR> void ACE_String_Base< CHAR >::set (  const CHAR *  s, size_type  len, bool  release )

Copy len bytes of s (will zero terminate the result). If release == true then a new buffer is allocated internally if the existing one is not big enough to hold s. If the existing buffer is big enough, then it will be used. This means that set(*, *, 1) is illegal when the string is constructed with a non-owned const char*. (e.g. ACE_String_Base("test", 0, 0)) If release == false then the s buffer is used directly, and any existing buffer is destroyed. If s == 0 then it will _not_ be used, and instead the internal buffer is set to NULL_String_. Parameters: s  Non-zero terminated input string len  Length of input string 's' release  Allocator responsible(true)/not reponsible(false) for freeing memory. Definition at line 129 of file String_Base.cpp. References ACE_ALLOCATOR, ACE_String_Base< CHAR >::buf_len_, ACE_Allocator::free(), ACE_OS::memcpy(), and ACE_String_Base< CHAR >::release_. { // Case 1. Going from memory to more memory size_type new_buf_len = len + 1; if (s != 0 && len != 0 && release && this->buf_len_ < new_buf_len) { CHAR *temp; ACE_ALLOCATOR (temp, (CHAR *) this->allocator_->malloc (new_buf_len * sizeof (CHAR))); if (this->buf_len_ != 0 && this->release_) this->allocator_->free (this->rep_); this->rep_ = temp; this->buf_len_ = new_buf_len; this->release_ = true; this->len_ = len; ACE_OS::memcpy (this->rep_, s, len * sizeof (CHAR)); this->rep_[len] = 0; } else // Case 2. No memory allocation is necessary. { // Free memory if necessary and figure out future ownership if (!release || s == 0 || len == 0) { if (this->buf_len_ != 0 && this->release_) { this->allocator_->free (this->rep_); this->release_ = false; } } // Populate data. if (s == 0 || len == 0) { this->buf_len_ = 0; this->len_ = 0; this->rep_ = &ACE_String_Base<CHAR>::NULL_String_; this->release_ = false; } else if (!release) // Note: No guarantee that rep_ is null terminated. { this->buf_len_ = len; this->len_ = len; this->rep_ = const_cast <CHAR *> (s); this->release_ = false; } else { ACE_OS::memcpy (this->rep_, s, len * sizeof (CHAR)); this->rep_[len] = 0; this->len_ = len; } } }

template<class CHAR> void ACE_String_Base< CHAR >::set (  const CHAR *  s, bool  release = true )

Copy s into this ACE_String_Base. If release == true then a new buffer is allocated internally if the existing one is not big enough to hold s. If the existing buffer is big enough, then it will be used. This means that set(*, 1) can be illegal when the string is constructed with a const char*. (e.g. ACE_String_Base("test", 0, false)). if release == false then the s buffer is used directly, and any existing buffer is destroyed. If s == 0 then it will _not_ be used, and instead the internal buffer is set to NULL_String_. Parameters: s  Null terminated input string release  Allocator responsible(true)/not reponsible(false) for freeing memory. Definition at line 341 of file String_Base.cpp. References ACE_OS::strlen(). Referenced by ACE_String_Base< CHAR >::ACE_String_Base(), ACE_String_Base< CHAR >::assign_nocopy(), ACE_Capabilities::getline(), ACE_String_Base< CHAR >::operator=(), ACE_Codeset_Registry::registry_to_locale(), and ACE_Codeset_Registry::registry_to_locale_i(). { size_t length = 0; if (s != 0) length = ACE_OS::strlen (s); this->set (s, length, release); }

template<class CHAR> ACE_INLINE ACE_String_Base< CHAR >::size_type ACE_String_Base< CHAR >::strstr (  const ACE_String_Base< CHAR > &  s  )  const

Comparison operator that will match substrings. Returns the slot of the first location that matches, else npos. Parameters: s  Input ACE_String_Base string Returns: Integer index value of the first location of string s or npos (not found). Definition at line 139 of file String_Base.inl. References ACE_TRACE, ACE_String_Base< CHAR >::find(), and ACE_String_Base< CHAR >::rep_. Referenced by ACE_DLL_Handle::open(). { ACE_TRACE ("ACE_String_Base<CHAR>::strstr"); return this->find (s.rep_); }

template<class CHAR> ACE_INLINE ACE_String_Base< CHAR > ACE_String_Base< CHAR >::substr (  size_type  offset, size_type  length = npos )  const

Same as . Parameters: offset  Index of first desired character of the substring. length  How many characters to return starting at the offset. Returns: The string containing the desired substring Definition at line 56 of file String_Base.inl. References ACE_TRACE, and ACE_String_Base< CHAR >::substring(). Referenced by ACE_Utils::UUID::from_string_i(), and ACE_DLL_Handle::get_dll_names(). { ACE_TRACE ("ACE_String_Base<CHAR>::substr"); return this->substring (offset, length); }

template<class CHAR> ACE_String_Base< CHAR > ACE_String_Base< CHAR >::substring (  size_type  offset, size_type  length = npos )  const

Return a substring given an offset and length. If length == npos use rest of str. Return empty substring if offset or offset/length are invalid. Parameters: offset  Index of first desired character of the substring. length  How many characters to return starting at the offset. Returns: The string containing the desired substring Definition at line 188 of file String_Base.cpp. Referenced by ACE_String_Base< CHAR >::substr(). { ACE_String_Base<CHAR> nill; size_type count = length; // case 1. empty string if (this->len_ == 0) return nill; // case 2. start pos past our end if (offset >= this->len_) return nill; // No length == empty string. else if (length == 0) return nill; // Get all remaining bytes. else if (length == npos || count > (this->len_ - offset)) count = this->len_ - offset; return ACE_String_Base<CHAR> (&this->rep_[offset], count, this->allocator_); }

template<class CHAR> void ACE_String_Base< CHAR >::swap (  ACE_String_Base< CHAR > &  str  )

Swap the contents of this ACE_String_Base with str. Note: This is non-throwing operation. Definition at line 468 of file String_Base.cpp. References ACE_String_Base< CHAR >::allocator_, ACE_String_Base< CHAR >::buf_len_, ACE_String_Base< CHAR >::len_, ACE_String_Base< CHAR >::release_, and ACE_String_Base< CHAR >::rep_. { std::swap (this->allocator_ , str.allocator_); std::swap (this->len_ , str.len_); std::swap (this->buf_len_ , str.buf_len_); std::swap (this->rep_ , str.rep_); std::swap (this->release_ , str.release_); }

---

Member Data Documentation

template<class CHAR> ACE_String_Base< CHAR >::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks. Definition at line 535 of file String_Base.h.

template<class CHAR> ACE_Allocator* ACE_String_Base< CHAR >::allocator_ [protected]

Pointer to a memory allocator. Definition at line 541 of file String_Base.h. Referenced by ACE_String_Base< CHAR >::swap().

template<class CHAR> size_type ACE_String_Base< CHAR >::buf_len_ [protected]

Length of the ACE_String_Base data buffer. Keeping track of the length allows to avoid unnecessary dynamic allocations. Definition at line 552 of file String_Base.h. Referenced by ACE_String_Base< CHAR >::append(), ACE_String_Base< CHAR >::capacity(), ACE_String_Base< CHAR >::clear(), ACE_String_Base< CHAR >::fast_clear(), ACE_String_Base< CHAR >::fast_resize(), ACE_String_Base< CHAR >::set(), ACE_String_Base< CHAR >::swap(), and ACE_String_Base< CHAR >::~ACE_String_Base().

template<class CHAR> size_type ACE_String_Base< CHAR >::len_ [protected]

Length of the ACE_String_Base data (not counting the trailing ''). Definition at line 546 of file String_Base.h. Referenced by ACE_String_Base< CHAR >::ACE_String_Base(), ACE_String_Base< CHAR >::assign_nocopy(), ACE_String_Base< CHAR >::compare(), ACE_String_Base< CHAR >::operator+=(), ACE_String_Base< CHAR >::operator=(), ACE_String_Base< CHAR >::operator==(), and ACE_String_Base< CHAR >::swap().

template<class CHAR> ACE_BEGIN_VERSIONED_NAMESPACE_DECL CHAR ACE_String_Base< CHAR >::NULL_String_ = 0 [static, protected]

Represents the "NULL" string to simplify the internal logic. Definition at line 23 of file String_Base.cpp.

template<class CHAR> bool ACE_String_Base< CHAR >::release_ [protected]

Flag that indicates if we own the memory Definition at line 562 of file String_Base.h. Referenced by ACE_String_Base< CHAR >::append(), ACE_String_Base< CHAR >::clear(), ACE_String_Base< CHAR >::fast_clear(), ACE_String_Base< CHAR >::fast_resize(), ACE_String_Base< CHAR >::set(), ACE_String_Base< CHAR >::swap(), and ACE_String_Base< CHAR >::~ACE_String_Base().

template<class CHAR> CHAR* ACE_String_Base< CHAR >::rep_ [protected]

Pointer to data. Definition at line 557 of file String_Base.h. Referenced by ACE_String_Base< CHAR >::ACE_String_Base(), ACE_String_Base< CHAR >::assign_nocopy(), ACE_String_Base< CHAR >::compare(), ACE_String_Base< CHAR >::find(), ACE_String_Base< CHAR >::operator+=(), ACE_String_Base< CHAR >::operator=(), ACE_String_Base< CHAR >::operator==(), ACE_String_Base< CHAR >::strstr(), and ACE_String_Base< CHAR >::swap().

---

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

• String_Base.h
• String_Base.cpp
• String_Base.inl

---