A string class that has a predefined string buffer. More...
#include <string.h>
Inheritance diagram for ucommon::stringbuf< S >:
Collaboration diagram for ucommon::stringbuf< S >:
Public Member Functions | |
| void | operator= (const char *text) |
| Assign a string buffer from a null terminated string. More... | |
| void | operator= (String &object) |
| Assign a string buffer from another string object. More... | |
| stringbuf () | |
| Create an empty instance of a string buffer. | |
| stringbuf (const char *text) | |
| Create a string buffer from a null terminated string. More... | |
 Public Member Functions inherited from ucommon::memstring | |
| memstring (void *memory, strsize_t size, char fill=0) | |
| Create an instance of a memory string. More... | |
| void | operator= (String &object) |
| Assign the text of a string to our object. More... | |
| void | operator= (const char *text) |
| Assign null terminated text to our object. More... | |
| ~memstring () | |
| Destroy memory string. | |
| Public Member Functions inherited from ucommon::String | |
| int | __isoc99_scanf (const char *format,...) |
| Scan input items from a string object. More... | |
| int | __isoc99_vscanf (const char *format, va_list args) |
| Scan input items from a string object. More... | |
| void | add (const char *text) |
| Append null terminated text to our string buffer. More... | |
| void | add (char character) |
| Append a single character to our string buffer. More... | |
| char | at (int position) const |
| Return character found at a specific position in the string. More... | |
| const char * | begin (void) const |
| Get pointer to first character in string for iteration. More... | |
| char * | c_mem (void) const |
| Get memory text buffer of string object. More... | |
| const char * | c_str (void) const |
| Get character text buffer of string object. More... | |
| strsize_t | ccount (const char *list) const |
| Count number of occurrences of characters in string. More... | |
| void | chop (const char *list) |
| Chop trailing characters from the string. More... | |
| void | chop (strsize_t count=1) |
| Chop trailing characters from text. More... | |
| const char * | chr (char character) const |
| Find pointer in string where specified character appears. More... | |
| void | clear (strsize_t offset, strsize_t size=0) |
| Clear a field of a filled string with filler. More... | |
| void | clear (void) |
| Clear string by setting to empty. | |
| int | collate (const char *string) const |
| virtual int | compare (const char *string) const |
| Compare the values of two string. More... | |
| String | copy (strsize_t offset, strsize_t size) const |
| Convenience method for substring extraction. More... | |
| strsize_t | count (void) const |
| Count all characters in the string (strlen). More... | |
| void | cut (strsize_t offset, strsize_t size=0) |
| Cut (remove) text from string. More... | |
| const char * | end (void) const |
| Get pointer to last character in string for iteration. More... | |
| void | erase (void) |
| Erase string memory. | |
| char | fill (void) |
| Get filler character used for field array strings. More... | |
| const char * | find (const char *list, strsize_t offset=0) const |
| Find a character in the string. More... | |
| bool | full (void) const |
| Test if the string's allocated space is all used up. More... | |
| String | get (strsize_t offset, strsize_t size=0) const |
| Get a new string object as a substring of the current object. More... | |
| String | left (strsize_t size) const |
| Convenience method for left of string. More... | |
| strsize_t | len (void) const |
| Get length of string. More... | |
| void | lower (void) |
| Convert string to lower case. | |
| strsize_t | offset (const char *pointer) const |
| Find offset of a pointer into our string buffer. More... | |
| operator bool () const | |
| Test if string has data. More... | |
| operator const char * () const | |
| Casting reference to raw text string. More... | |
| bool | operator! () const |
| Test if string is empty. More... | |
| bool | operator!= (const char *text) const |
| Compare our object with null terminated text. More... | |
| String & | operator% (short &value) |
| Parse short integer value from a string. More... | |
| String & | operator% (unsigned short &value) |
| Parse long integer value from a string. More... | |
| String & | operator% (long &value) |
| Parse long integer value from a string. More... | |
| String & | operator% (unsigned long &value) |
| Parse long integer value from a string. More... | |
| String & | operator% (double &value) |
| Parse double value from a string. More... | |
| String & | operator% (const char *text) |
| Parse text from a string in a scan expression. More... | |
| String & | operator& (const char *text) |
| Concatenate null terminated text to our object. More... | |
| String & | operator&= (const char *text) |
| String | operator() (int offset, strsize_t size) const |
| Get a new substring through object expression. More... | |
| const char * | operator() (int offset) const |
| Reference a string in the object by relative offset. More... | |
| const char * | operator* () const |
| Reference raw text buffer by pointer operator. More... | |
| bool | operator*= (const char *substring) |
| bool | operator*= (regex &expr) |
| String & | operator*= (strsize_t number) |
| Delete a specified number of characters from start of string. More... | |
| String | operator+ (const char *text) |
| Concatenate null terminated text to our object. More... | |
| String & | operator++ (void) |
| Delete first character from string. | |
| String & | operator+= (const char *text) |
| Concatenate text to an existing string object. More... | |
| String & | operator+= (strsize_t number) |
| Delete a specified number of characters from start of string. More... | |
| String & | operator-- (void) |
| Delete last character from string. | |
| String & | operator-= (strsize_t number) |
| Delete a specified number of characters from end of string. More... | |
| bool | operator< (const char *text) const |
| Compare our object with null terminated text. More... | |
| String & | operator<< (const char *text) |
| String & | operator<< (char code) |
| bool | operator<= (const char *text) const |
| Compare our object with null terminated text. More... | |
| String & | operator= (const String &object) |
| Assign our string with the cstring of another object. More... | |
| String & | operator= (const char *text) |
| Assign text to our existing buffer. More... | |
| bool | operator== (const char *text) const |
| Compare our object with null terminated text. More... | |
| bool | operator> (const char *text) const |
| Compare our object with null terminated text. More... | |
| bool | operator>= (const char *text) const |
| Compare our object with null terminated text. More... | |
| const char | operator[] (int offset) const |
| Reference a single character in string object by array offset. More... | |
| String & | operator^= (const String &object) |
| Create new cow instance and assign value from another string object. More... | |
| String & | operator^= (const char *text) |
| Create new cow instance and assign value from null terminated text. More... | |
| String & | operator| (const char *text) |
| Concatenate null terminated text to our object. More... | |
| String & | operator|= (const char *text) |
| Concatenate text to an existing string object. More... | |
| void | paste (strsize_t offset, const char *text, strsize_t size=0) |
| Insert (paste) text into string. More... | |
| strsize_t | printf (const char *format,...) |
| Print items into a string object. More... | |
| const char * | rchr (char character) const |
| Find pointer in string where specified character last appears. More... | |
| unsigned | replace (const char *string, const char *text=((void *) 0), unsigned flags=0) |
| unsigned | replace (regex &expr, const char *text=((void *) 0), unsigned flags=0) |
| const char * | rfind (const char *list, strsize_t offset=npos) const |
| Find last occurrence of character in the string. More... | |
| String | right (strsize_t offset) const |
| Convenience method for right of string. More... | |
| void | rset (const char *text, char overflow, strsize_t offset, strsize_t size=0) |
| Set a text field within our string object offset from the end of buffer. More... | |
| const char * | rskip (const char *list, strsize_t offset=npos) const |
| Skip trailing characters in the string. More... | |
| void | rsplit (const char *pointer) |
| Split the string by a pointer position. More... | |
| void | rsplit (strsize_t offset) |
| Split the string at a specific offset. More... | |
| const char * | search (const char *string, unsigned instance=0, unsigned flags=0) const |
| Search for a substring in the string. More... | |
| const char * | search (regex &expr, unsigned instance=0, unsigned flags=0) const |
| void | set (const char *text) |
| Set string object to text of a null terminated string. More... | |
| void | set (strsize_t offset, const char *text, strsize_t size=0) |
| Set a portion of the string object at a specified offset to a text string. More... | |
| void | set (const char *text, char overflow, strsize_t offset, strsize_t size=0) |
| Set a text field within our string object. More... | |
| strsize_t | size (void) const |
| Get the size of currently allocated space for string. More... | |
| const char * | skip (const char *list, strsize_t offset=0) const |
| Skip lead characters in the string. More... | |
| void | split (const char *pointer) |
| Split the string by a pointer position. More... | |
| void | split (strsize_t offset) |
| Split the string at a specific offset. More... | |
| String () | |
| Create a new empty string object. | |
| String (long value) | |
| Create a string from a long integer. More... | |
| String (double value) | |
| Create a string from a floating point. More... | |
| String (strsize_t size) | |
| Create an empty string with a buffer pre-allocated to a specified size. More... | |
| String (strsize_t size, char fill) | |
| Create a filled string with a buffer pre-allocated to a specified size. More... | |
| String (strsize_t size, const char *format,...) | |
| Create a string by printf-like formating into a pre-allocated space of a specified size. More... | |
| String (const char *text) | |
| Create a string from null terminated text. More... | |
| String (const char *text, strsize_t size) | |
| Create a string from null terminated text up to a maximum specified size. More... | |
| String (const char *text, const char *end) | |
| Create a string for a substring. More... | |
| String (const String &existing) | |
| Construct a copy of a string object. More... | |
| void | strip (const char *list) |
| Strip lead and trailing characters from the string. More... | |
| double | tod (char **pointer=((void *) 0)) |
| Convert string to a double value. More... | |
| char * | token (char **last, const char *list, const char *quote=((void *) 0), const char *end=((void *) 0)) |
| A thread-safe token parsing routine for strings objects. More... | |
| long | tol (char **pointer=((void *) 0)) |
| Convert string to a long value. More... | |
| void | trim (const char *list) |
| Trim lead characters from the string. More... | |
| void | trim (strsize_t count=1) |
| Trim lead characters from text. More... | |
| bool | unquote (const char *quote) |
| Unquote a quoted string. More... | |
| void | upper (void) |
| Convert string to upper case. | |
| strsize_t | vprintf (const char *format, va_list args) |
| Print items into a string object. More... | |
| virtual | ~String () |
| Destroy string. More... | |
| Public Member Functions inherited from ucommon::ObjectProtocol | |
| ObjectProtocol * | copy (void) |
| Retain (increase retention of) object when copying. | |
| void | operator++ (void) |
| Increase retention operator. | |
| void | operator-- (void) |
| Decrease retention operator. | |
| virtual | ~ObjectProtocol () |
| Required virtual destructor. | |
Additional Inherited Members | |
| Public Types inherited from ucommon::String | |
| enum | { SENSITIVE = 0x00, INSENSITIVE = 0x01 } |
| This is an internal class which contains the actual string data along with some control fields. More... | |
| Static Public Member Functions inherited from ucommon::memstring | |
| static memstring * | create (strsize_t size, char fill=0) |
| Create a memory string with memory allocated from the heap. More... | |
| static memstring * | create (MemoryProtocol *pager, strsize_t size, char fill=0) |
| Create a memory string with memory allocated from a pager. More... | |
| Static Public Attributes inherited from ucommon::memstring | |
| static const size_t | header |
| Protected Member Functions inherited from ucommon::memstring | |
| cstring * | c_copy (void) const |
| Return cstring to use in copy constructors. More... | |
| Protected Attributes inherited from ucommon::String | |
| cstring * | str |
| cstring instance our object references. More... | |
Detailed Description
template<strsize_t S>
class ucommon::stringbuf< S >
A string class that has a predefined string buffer.
The string class and buffer are allocated together as one object. This allows one to use string objects entirely resident on the local stack as well as on the heap. Using a string class on the local stack may be more convenient than a char array since one can use all the features of the class including assignment and concatenation which a char buffer cannot as easily do.
Constructor & Destructor Documentation
template<strsize_t S>
|
inline |
Member Function Documentation
template<strsize_t S>
|
inline |
template<strsize_t S>
|
inline |
The documentation for this class was generated from the following file:
- ucommon/string.h
