ACE_SString Class Reference

A very Simple String ACE_SString class. This is not a general-purpose string class, and you should probably consider using ACE_CString is you don't understand why this class exists... More...

#include <SString.h>

Collaboration diagram for ACE_SString:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ACE_SString (ACE_Allocator *alloc=0)
 Default constructor.
 ACE_SString (const char *s, ACE_Allocator *alloc=0)
 Constructor that copies s into dynamically allocated memory.
 ACE_SString (const char *s, size_t len, ACE_Allocator *alloc=0)
 ACE_SString (const ACE_SString &)
 Copy constructor.
 ACE_SString (char c, ACE_Allocator *alloc=0)
 Constructor that copies c into dynamically allocated memory.
 ~ACE_SString (void)
 Default destructor.
char operator[] (size_t slot) const
char & operator[] (size_t slot)
ACE_SStringoperator= (const ACE_SString &)
 Assignment operator (does copy memory).
ACE_SString substring (size_t offset, ssize_t length=-1) const
ACE_SString substr (size_t offset, ssize_t length=-1) const
 Same as substring.
u_long hash (void) const
 Returns a hash value for this string.
size_t length (void) const
 Return the length of the string.
void rep (char *s)
const char * rep (void) const
 Get the underlying pointer.
const char * fast_rep (void) const
 Get the underlying pointer.
const char * c_str (void) const
 Same as STL String's <c_str> and <fast_rep>.
int strstr (const ACE_SString &s) const
int find (const ACE_SString &str, int pos=0) const
int find (const char *s, int pos=0) const
int find (char c, int pos=0) const
int rfind (char c, int pos=npos) const
bool operator== (const ACE_SString &s) const
 Equality comparison operator (must match entire string).
bool operator< (const ACE_SString &s) const
 Less than comparison operator.
bool operator> (const ACE_SString &s) const
 Greater than comparison operator.
bool operator!= (const ACE_SString &s) const
 Inequality comparison operator.
int compare (const ACE_SString &s) const
 Performs a <strcmp>-style comparison.
void dump (void) const
 Dump the state of an object.

Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks.

Static Public Attributes

static const int npos = -1
 No position constant.

Private Attributes

ACE_Allocatorallocator_
 Pointer to a memory allocator.
size_t len_
 Length of the ACE_SString (not counting the trailing '').
char * rep_
 Pointer to data.

Detailed Description

A very Simple String ACE_SString class. This is not a general-purpose string class, and you should probably consider using ACE_CString is you don't understand why this class exists...

This class is optimized for efficiency, so it doesn't provide any internal locking. CAUTION: This class is only intended for use with applications that understand how it works. In particular, its destructor does not deallocate its memory when it is destroyed... We need this class since the ACE_Map_Manager requires an object that supports the operator == and operator !=. 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.


Constructor & Destructor Documentation

ACE_SString::ACE_SString ACE_Allocator alloc = 0  ) 
 

Default constructor.

ACE_SString::ACE_SString const char *  s,
ACE_Allocator alloc = 0
 

Constructor that copies s into dynamically allocated memory.

ACE_SString::ACE_SString const char *  s,
size_t  len,
ACE_Allocator alloc = 0
 

Constructor that copies len chars of into dynamically allocated memory (will NUL terminate the result).

ACE_SString::ACE_SString const ACE_SString  ) 
 

Copy constructor.

ACE_SString::ACE_SString char  c,
ACE_Allocator alloc = 0
 

Constructor that copies c into dynamically allocated memory.

ACE_INLINE ACE_SString::~ACE_SString void   ) 
 

Default destructor.


Member Function Documentation

ACE_INLINE const char * ACE_SString::c_str void   )  const
 

Same as STL String's <c_str> and <fast_rep>.

ACE_INLINE int ACE_SString::compare const ACE_SString s  )  const
 

Performs a <strcmp>-style comparison.

void ACE_SString::dump void   )  const
 

Dump the state of an object.

ACE_INLINE const char * ACE_SString::fast_rep void   )  const
 

Get the underlying pointer.

ACE_INLINE int ACE_SString::find char  c,
int  pos = 0
const
 

Find starting at pos. Returns the slot of the first location that matches (will be >= pos), else npos.

ACE_INLINE int ACE_SString::find const char *  s,
int  pos = 0
const
 

Find <s> starting at pos. Returns the slot of the first location that matches (will be >= pos), else npos.

ACE_INLINE int ACE_SString::find const ACE_SString str,
int  pos = 0
const
 

Find <str> starting at pos. Returns the slot of the first location that matches (will be >= pos), else npos.

ACE_INLINE u_long ACE_SString::hash void   )  const
 

Returns a hash value for this string.

ACE_INLINE size_t ACE_SString::length void   )  const
 

Return the length of the string.

ACE_INLINE bool ACE_SString::operator!= const ACE_SString s  )  const
 

Inequality comparison operator.

ACE_INLINE bool ACE_SString::operator< const ACE_SString s  )  const
 

Less than comparison operator.

ACE_SString & ACE_SString::operator= const ACE_SString  ) 
 

Assignment operator (does copy memory).

ACE_INLINE bool ACE_SString::operator== const ACE_SString s  )  const
 

Equality comparison operator (must match entire string).

ACE_INLINE bool ACE_SString::operator> const ACE_SString s  )  const
 

Greater than comparison operator.

ACE_INLINE char & ACE_SString::operator[] size_t  slot  ) 
 

Return the <slot'th> character by reference in the string (doesn't perform bounds checking).

ACE_INLINE char ACE_SString::operator[] size_t  slot  )  const
 

Return the <slot'th> character in the string (doesn't perform bounds checking).

ACE_INLINE const char * ACE_SString::rep void   )  const
 

Get the underlying pointer.

void ACE_SString::rep char *  s  ) 
 

Set the underlying pointer. Since this does not copy memory or delete existing memory use with extreme caution!!!

ACE_INLINE int ACE_SString::rfind char  c,
int  pos = npos
const
 

Find starting at pos (counting from the end). Returns the slot of the first location that matches, else npos.

ACE_INLINE int ACE_SString::strstr const ACE_SString s  )  const
 

Comparison operator that will match substrings. Returns the slot of the first location that matches, else -1.

ACE_INLINE ACE_SString ACE_SString::substr size_t  offset,
ssize_t  length = -1
const
 

Same as substring.

ACE_SString ACE_SString::substring size_t  offset,
ssize_t  length = -1
const
 

Return a substring given an offset and length, if length == -1 use rest of str return empty substring if offset or offset/length are invalid


Member Data Documentation

ACE_SString::ACE_ALLOC_HOOK_DECLARE
 

Declare the dynamic allocation hooks.

ACE_Allocator* ACE_SString::allocator_ [private]
 

Pointer to a memory allocator.

size_t ACE_SString::len_ [private]
 

Length of the ACE_SString (not counting the trailing '').

const int ACE_SString::npos = -1 [static]
 

No position constant.

char* ACE_SString::rep_ [private]
 

Pointer to data.


The documentation for this class was generated from the following files:
Generated on Wed Nov 23 15:50:38 2005 for ACE by  doxygen 1.4.5