ucommon
|
A copy-on-write string class that operates by reference count. More...
#include <string.h>
Data Structures | |
class | cstring |
This is an internal class which contains the actual string data along with some control fields. More... |
Public Member Functions | |
int | __isoc99_scanf (char *format,...) |
Scan input items from a string object. | |
int | __isoc99_vscanf (char *format, va_list args) |
Scan input items from a string object. | |
void | add (char *text) |
Append null terminated text to our string buffer. | |
void | add (char character) |
Append a single character to our string buffer. | |
char | at (int position) |
Return character found at a specific position in the string. | |
char * | begin (void) |
Get pointer to first character in string for iteration. | |
char * | c_mem (void) |
Get memory text buffer of string object. | |
char * | c_str (void) |
Get character text buffer of string object. | |
strsize_t | ccount (char *list) |
Count number of occurrences of characters in string. | |
void | chop (char *list) |
Chop trailing characters from the string. | |
char * | chr (char character) |
Find pointer in string where specified character appears. | |
void | clear (strsize_t offset, strsize_t size=0) |
Clear a field of a filled string with filler. | |
void | clear (void) |
Clear string by setting to empty. | |
strsize_t | count (void) |
Count all characters in the string (strlen). | |
void | cut (strsize_t offset, strsize_t size=0) |
Cut (remove) text from string. | |
char * | end (void) |
Get pointer to last character in string for iteration. | |
char | fill (void) |
Get filler character used for field array strings. | |
char * | find (char *list, strsize_t offset=0) |
Find a character in the string. | |
char * | first (char *list) |
Find first occurrence of a character in the string. | |
bool | full (void) |
Test if the string's allocated space is all used up. | |
string | get (strsize_t offset, strsize_t size=0) |
Get a new string object as a substring of the current object. | |
char * | last (char *list) |
Find last occurrence of a character in the string. | |
strsize_t | len (void) |
Get length of string. | |
void | lower (void) |
Convert string to lower case. | |
strsize_t | offset (char *pointer) |
Find offset of a pointer into our string buffer. | |
operator bool () | |
Test if string has data. | |
operator char * () | |
Casting reference to raw text string. | |
bool | operator! () |
Test if string is empty. | |
bool | operator!= (char *text) |
Compare our object with null terminated text. | |
string & | operator% (short &value) |
Parse short integer value from a string. | |
string & | operator% (unsigned short &value) |
Parse long integer value from a string. | |
string & | operator% (long &value) |
Parse long integer value from a string. | |
string & | operator% (unsigned long &value) |
Parse long integer value from a string. | |
string & | operator% (double &value) |
Parse double value from a string. | |
string & | operator% (char *text) |
Parse text from a string in a scan expression. | |
string & | operator& (char *text) |
Concatenate null terminated text to our object. | |
string | operator() (int offset, strsize_t size) |
Get a new substring through object expression. | |
char * | operator() (int offset) |
Reference a string in the object by relative offset. | |
char * | operator* () |
Reference raw text buffer by pointer operator. | |
string & | operator+ (char *text) |
Concatenate null terminated text to our object. | |
string & | operator++ (void) |
Delete first character from string. | |
string & | operator+= (char *text) |
Concatenate text to an existing string object. | |
string & | operator+= (strsize_t number) |
Delete a specified number of characters from start of string. | |
string & | operator-- (void) |
Delete last character from string. | |
string & | operator-= (strsize_t number) |
Delete a specified number of characters from end of string. | |
bool | operator< (char *text) |
Compare our object with null terminated text. | |
bool | operator<= (char *text) |
Compare our object with null terminated text. | |
string & | operator= (string &object) |
Assign our string with the cstring of another object. | |
string & | operator= (char *text) |
Assign text to our existing buffer. | |
bool | operator== (char *text) |
Compare our object with null terminated text. | |
bool | operator> (char *text) |
Compare our object with null terminated text. | |
bool | operator>= (char *text) |
Compare our object with null terminated text. | |
char | operator[] (int offset) |
Reference a single character in string object by array offset. | |
string & | operator^= (string &object) |
Create new cow instance and assign value from another string object. | |
string & | operator^= (char *text) |
Create new cow instance and assign value from null terminated text. | |
strsize_t | printf (char *format,...) |
Print items into a string object. | |
char * | rchr (char character) |
Find pointer in string where specified character last appears. | |
virtual bool | resize (strsize_t size) |
Resize and re-allocate string memory. | |
char * | rfind (char *list, strsize_t offset=npos) |
Find last occurrence of character in the string. | |
void | rset (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. | |
char * | rskip (char *list, strsize_t offset=npos) |
Skip trailing characters in the string. | |
void | rsplit (char *pointer) |
Split the string by a pointer position. | |
void | rsplit (strsize_t offset) |
Split the string at a specific offset. | |
void | set (char *text) |
Set string object to text of a null terminated string. | |
void | set (strsize_t offset, char *text, strsize_t size=0) |
Set a portion of the string object at a specified offset to a text string. | |
void | set (char *text, char overflow, strsize_t offset, strsize_t size=0) |
Set a text field within our string object. | |
strsize_t | size (void) |
Get the size of currently allocated space for string. | |
char * | skip (char *list, strsize_t offset=0) |
Skip lead characters in the string. | |
void | split (char *pointer) |
Split the string by a pointer position. | |
void | split (strsize_t offset) |
Split the string at a specific offset. | |
string () | |
Create a new empty string object. | |
string (long value) | |
Create a string from a long integer. | |
string (double value) | |
Create a string from a floating point. | |
string (strsize_t size) | |
Create an empty string with a buffer pre-allocated to a specified size. | |
string (strsize_t size, char fill) | |
Create a filled string with a buffer pre-allocated to a specified size. | |
string (strsize_t size, char *format,...) | |
Create a string by printf-like formating into a pre-allocated space of a specified size. | |
string (char *text) | |
Create a string from null terminated text. | |
string (char *text, strsize_t size) | |
Create a string from null terminated text up to a maximum specified size. | |
string (char *text, char *end) | |
Create a string for a substring. | |
string (string &existing) | |
Construct a copy of a string object. | |
void | strip (char *list) |
Strip lead and trailing characters from the string. | |
void | trim (char *list) |
Trim lead characters from the string. | |
bool | unquote (char *quote) |
Unquote a quoted string. | |
void | upper (void) |
Convert string to upper case. | |
strsize_t | vprintf (char *format, va_list args) |
Print items into a string object. | |
virtual | ~string () |
Destroy string. | |
![]() | |
ObjectProtocol * | copy (void) |
Retain (increase retention of) object when copying. | |
virtual | ~ObjectProtocol () |
Required virtual destructor. |
Static Public Member Functions | |
static int | __isoc99_scanf (string &object, char *format,...) |
Scan input items from a string object. | |
static int | __isoc99_vscanf (string &object, char *format, va_list args) |
Scan input items from a string object. | |
static char * | add (char *buffer, size_t size, char *text) |
Safely append a null terminated string into an existing string in memory. | |
static char * | add (char *buffer, size_t size, char *text, size_t max) |
Safely append a null terminated string into an existing string in memory. | |
static size_t | b64decode (uint8_t *binary, char *string, size_t size) |
Standard radix 64 decoding. | |
static size_t | b64encode (char *string, uint8_t *binary, size_t size, size_t width=0) |
Standard radix 64 encoding. | |
static int | case_compare (char *text1, char *text2) |
Depreciated case insensitive string comparison function. | |
static int | case_compare (char *text1, char *text2, size_t size) |
Depreciated case insensitive string comparison function. | |
static bool | case_equal (char *text1, char *text2) |
Simple case insensitive equal test for strings. | |
static bool | case_equal (char *text1, char *text2, size_t size) |
Simple case insensitive equal test for strings. | |
static unsigned | ccount (char *text, char *list) |
Count instances of characters in a list in a text buffer. | |
static unsigned | ccount (string &object, char *list) |
Count number of occurrences of characters in string object. | |
static char * | chop (char *text, char *list) |
Strip trailing characters from the text string. | |
static void | chop (string &object, char *list) |
Chop trailing characters from the string. | |
static void | clear (string &object) |
Clear a string object. | |
static int | collate (char *text1, char *text2) |
static int | compare (char *text1, char *text2) |
Safe string collation function. | |
static int | compare (char *text1, char *text2, size_t size) |
Depreciated string comparison function. | |
static size_t | count (char *text) |
Safe version of strlen function. | |
static size_t | count (string &object) |
Count all characters in the string object (strlen). | |
static uint16_t | crc16 (uint8_t *binary, size_t size) |
ccitt 16 bit crc for binary data. | |
static uint32_t | crc24 (uint8_t *binary, size_t size) |
24 bit crc as used in openpgp. | |
static char * | dup (char *text) |
Duplicate null terminated text into the heap. | |
static bool | equal (char *text1, char *text2) |
Simple equal test for strings. | |
static bool | equal (char *text1, char *text2, size_t size) |
Simple equal test for strings. | |
static char * | fill (char *text, size_t size, char character) |
Fill a section of memory with a fixed text character. | |
static char * | find (char *text, char *key, char *optional) |
Find position of substring within a string. | |
static char * | find (char *text, char *list) |
Find the first occurrence of a character in a text buffer. | |
static char * | find (string &object, char *list) |
Find a character in the string. | |
static char * | first (char *text, char *list) |
Get pointer to first character past character requested. | |
static char * | first (string &object, char *list) |
Get pointer to first character past character requested. | |
static void | fix (string &object) |
Fix and reset string object filler. | |
static unsigned | hexdump (unsigned char *binary, char *string, char *format) |
Dump hex data to a string buffer. | |
static unsigned | hexpack (unsigned char *binary, char *string, char *format) |
Pack hex data from a string buffer. | |
static unsigned | hexsize (char *format) |
static char * | ifind (char *text, char *key, char *optional) |
Find position of case insensitive substring within a string. | |
static char * | last (char *text, char *list) |
Get pointer to last character before character requested. | |
static char * | last (string &object, char *list) |
Get pointer to last character past character requested. | |
static strsize_t | len (string &object) |
Count all characters in the string object (strlen). | |
static void | lower (char *text) |
Convert null terminated text to lower case. | |
static void | lower (string &object) |
Convert string object to lower case. | |
static char * | mem (string &object) |
Get memory text buffer of string object. | |
static strsize_t | printf (string &object, char *format,...) |
Print formatted items into a string object. | |
static char * | rfind (char *text, char *list) |
Find the last occurrence of a character in a text buffer. | |
static char * | rfind (string &object, char *list) |
Find last character in the string. | |
static char * | rset (char *buffer, size_t size, char *text) |
Set a field in a null terminated string relative to the end of text. | |
static char * | rskip (char *text, char *list) |
Skip before trailing characters in a null terminated string. | |
static char * | set (char *buffer, size_t size, char *text) |
Safely set a null terminated string buffer in memory. | |
static char * | set (char *buffer, size_t size, char *text, size_t max) |
Safely set a null terminated string buffer in memory. | |
static strsize_t | size (string &object) |
Get the size of currently allocated space for string. | |
static char * | skip (char *text, char *list) |
Skip after lead characters in a null terminated string. | |
static char * | strip (char *text, char *list) |
Skip lead and remove trailing characters from a text string. | |
static void | strip (string &object, char *list) |
Strip lead and trailing characters from the string. | |
static void | swap (string &object1, string &object2) |
Swap the cstring references between two strings. | |
static double | tod (string &object, char **pointer=((void *) 0)) |
Convert string to a double value. | |
static double | tod (char *text, char **pointer=((void *) 0)) |
Convert text to a double value. | |
static char * | token (char *text, char **last, char *list, char *quote=((void *) 0), char *end=((void *) 0)) |
A thread-safe token parsing routine for null terminated strings. | |
static char * | token (string &object, char **last, char *list, char *quote=((void *) 0), char *end=((void *) 0)) |
A thread-safe token parsing routine for strings objects. | |
static long | tol (string &object, char **pointer=((void *) 0)) |
Convert string to a long value. | |
static long | tol (char *text, char **pointer=((void *) 0)) |
Convert text to a long value. | |
static char * | trim (char *text, char *list) |
Return start of string after characters to trim from beginning. | |
static void | trim (string &object, char *list) |
Trim lead characters from the string. | |
static char * | unquote (char *text, char *quote) |
Unquote a quoted null terminated string. | |
static bool | unquote (string &object, char *quote) |
Unquote a quoted string. | |
static void | upper (char *text) |
Convert null terminated text to upper case. | |
static void | upper (string &object) |
Convert string object to upper case. | |
static strsize_t | vprintf (string &object, char *format, va_list args) |
Print items into a string object. |
Static Public Attributes | |
static strsize_t | npos |
A constant for an invalid position value. |
Protected Member Functions | |
virtual cstring * | c_copy (void) |
Return cstring to use in copy constructors. | |
int | collate (char *string) |
virtual int | compare (char *string) |
Compare the values of two string. | |
virtual void | cow (strsize_t size=0) |
Copy on write operation for cstring. | |
cstring * | create (strsize_t size, char fill=0) |
Factory create a cstring object of specified size. | |
bool | equal (char *string) |
Test if two string values are equal. | |
strsize_t | getStringSize (void) |
virtual void | release (void) |
Decrease retention of our reference counted cstring. | |
virtual void | retain (void) |
Increase retention of our reference counted cstring. |
Protected Attributes | |
cstring * | str |
cstring instance our object references. |
A copy-on-write string class that operates by reference count.
This string class anchors a counted object that is managed as a copy-on-write instance of the string data. This means that multiple instances of the string class can refer to the same string in memory if it has not been modifed, which reduces heap allocation. The string class offers functions to manipulate both the string object, and generic safe string functions to manipulate ordinary null terminated character arrays directly in memory.
ucommon::string::string | ( | long | value | ) |
Create a string from a long integer.
value | to convert to string. |
ucommon::string::string | ( | double | value | ) |
Create a string from a floating point.
value | to convert to string. |
ucommon::string::string | ( | strsize_t | size | ) |
Create an empty string with a buffer pre-allocated to a specified size.
size | of buffer to allocate. |
ucommon::string::string | ( | strsize_t | size, |
char | fill | ||
) |
Create a filled string with a buffer pre-allocated to a specified size.
size | of buffer to allocate. |
fill | character to use. |
ucommon::string::string | ( | strsize_t | size, |
char * | format, | ||
... | |||
) |
Create a string by printf-like formating into a pre-allocated space of a specified size.
A typical use might be in a concat function like String x = (String)something + (String){10, "%ud", var}.
size | of buffer to allocate. |
format | control for string. |
ucommon::string::string | ( | char * | text | ) |
Create a string from null terminated text.
text | to use for string. |
ucommon::string::string | ( | char * | text, |
strsize_t | size | ||
) |
Create a string from null terminated text up to a maximum specified size.
text | to use for string. |
size | limit of new string. |
ucommon::string::string | ( | char * | text, |
char * | end | ||
) |
Create a string for a substring.
The end of the substring is a pointer within the substring itself.
text | to use for string. |
end | of text in substring. |
ucommon::string::string | ( | string & | existing | ) |
Construct a copy of a string object.
Our copy inherets the same reference counted instance of cstring as in the original.
existing | string to copy from. |
|
virtual |
Destroy string.
De-reference cstring. If last reference to cstring, then also remove cstring from heap.
int ucommon::string::__isoc99_scanf | ( | char * | format, |
... | |||
) |
Scan input items from a string object.
format | string of input to scan. |
|
static |
Scan input items from a string object.
object | to scan from. |
format | string of input to scan. |
int ucommon::string::__isoc99_vscanf | ( | char * | format, |
va_list | args | ||
) |
Scan input items from a string object.
format | string of input to scan. |
args | list to scan into. |
|
inlinestatic |
void ucommon::string::add | ( | char * | text | ) |
Append null terminated text to our string buffer.
text | to append. |
void ucommon::string::add | ( | char | character | ) |
Append a single character to our string buffer.
character | to append. |
|
static |
Safely append a null terminated string into an existing string in memory.
If the resulting string is too large to fit into the buffer, it is truncated to the size.
buffer | to set. |
size | of buffer. Includes null byte at end of string. |
text | to set in buffer. |
|
static |
Safely append a null terminated string into an existing string in memory.
If the resulting string is too large to fit into the buffer, it is truncated to the size.
buffer | to set. |
size | of buffer. Includes null byte at end of string. |
text | to set in buffer. |
max | size of text to append. |
char ucommon::string::at | ( | int | position | ) |
Return character found at a specific position in the string.
position | in string, negative values computed from end. |
Reimplemented in ucommon::UString.
|
static |
Standard radix 64 decoding.
binary | data to save. |
string | of encoded text. |
size | of destination buffer. |
|
static |
Standard radix 64 encoding.
string | of encoded text save into. |
binary | data to encode. |
size | of binary data to encode. |
width | of string buffer for data if partial supported. |
char* ucommon::string::begin | ( | void | ) |
Get pointer to first character in string for iteration.
|
protectedvirtual |
Return cstring to use in copy constructors.
Is virtual for memstring.
Reimplemented in ucommon::memstring.
char* ucommon::string::c_mem | ( | void | ) |
Get memory text buffer of string object.
char* ucommon::string::c_str | ( | void | ) |
Get character text buffer of string object.
|
static |
Depreciated case insensitive string comparison function.
text1 | to compare. |
text2 | to compare. |
|
static |
Depreciated case insensitive string comparison function.
text1 | to compare. |
text2 | to compare. |
size | limit of strings to compare. |
|
static |
Simple case insensitive equal test for strings.
text1 | to test. |
text2 | to test. |
|
static |
Simple case insensitive equal test for strings.
text1 | to test. |
text2 | to test. |
size | limit of strings to compare. |
strsize_t ucommon::string::ccount | ( | char * | list | ) |
Count number of occurrences of characters in string.
list | of characters to find. |
|
static |
Count instances of characters in a list in a text buffer.
text | buffer to examine. |
list | of characters to count in buffer. |
|
inlinestatic |
void ucommon::string::chop | ( | char * | list | ) |
Chop trailing characters from the string.
list | of characters to remove. |
|
static |
Strip trailing characters from the text string.
This function will modify memory.
text | buffer to examine. |
list | of characters to chop from trailing end of string. |
|
inlinestatic |
char* ucommon::string::chr | ( | char | character | ) |
Find pointer in string where specified character appears.
character | to find. |
Clear a field of a filled string with filler.
offset | to start of field to clear. |
size | of field to fill or 0 to fill to end of string. |
|
inlinestatic |
|
protectedvirtual |
Compare the values of two string.
This is a virtual so that it can be overridden for example if we want to create strings which ignore case, or which have special ordering rules.
string | to compare with. |
|
static |
Safe string collation function.
text1 | to compare. |
text2 | to compare. |
|
static |
Depreciated string comparison function.
text1 | to compare. |
text2 | to compare. |
size | limit of strings to compare. |
strsize_t ucommon::string::count | ( | void | ) |
Count all characters in the string (strlen).
Reimplemented in ucommon::UString.
|
static |
Safe version of strlen function.
Accepts NULL as 0 length strings.
text | string. |
|
inlinestatic |
|
protectedvirtual |
Copy on write operation for cstring.
This always creates a new unique copy for write/modify operations and is a virtual for memstring to disable.
size | to add to allocated space when creating new cstring. |
|
static |
ccitt 16 bit crc for binary data.
binary | data to sum. |
size | of binary data to sum. |
|
static |
24 bit crc as used in openpgp.
binary | data to sum. |
size | of binary data to sum. |
Factory create a cstring object of specified size.
size | of allocated space for string buffer. |
fill | character to use or 0 if null. |
Reimplemented in ucommon::memstring.
Cut (remove) text from string.
offset | to start of text field to remove. |
size | of text field to remove or 0 to remove to end of string. |
|
static |
Duplicate null terminated text into the heap.
text | to duplicate. |
char* ucommon::string::end | ( | void | ) |
Get pointer to last character in string for iteration.
|
protected |
Test if two string values are equal.
string | to compare with. |
|
static |
Simple equal test for strings.
text1 | to test. |
text2 | to test. |
|
static |
Simple equal test for strings.
text1 | to test. |
text2 | to test. |
size | limit of strings to compare. |
char ucommon::string::fill | ( | void | ) |
Get filler character used for field array strings.
|
static |
Fill a section of memory with a fixed text character.
Adds a null byte at the end.
text | buffer to fill. |
size | of text buffer with null terminated byte. |
character | to fill with. |
char* ucommon::string::find | ( | char * | list, |
strsize_t | offset = 0 |
||
) |
Find a character in the string.
list | of characters to search for. |
offset | to start of search. |
|
static |
Find position of substring within a string.
text | to search in. |
key | string to locate. |
optional | separator chars if formatted as list of keys. |
|
static |
Find the first occurrence of a character in a text buffer.
text | buffer to examine. |
list | of characters to search for. |
|
inlinestatic |
char* ucommon::string::first | ( | char * | list | ) |
Find first occurrence of a character in the string.
list | of characters to search for. |
|
static |
Get pointer to first character past character requested.
text | buffer to examine. |
list | of characters. |
|
inlinestatic |
|
static |
Fix and reset string object filler.
object | to fix. |
bool ucommon::string::full | ( | void | ) |
Test if the string's allocated space is all used up.
Get a new string object as a substring of the current object.
offset | of substring. |
size | of substring or 0 if to end. |
Reimplemented in ucommon::UString.
|
static |
Dump hex data to a string buffer.
binary | memory to dump. |
string | to save into. |
format | string to convert with. |
|
static |
Pack hex data from a string buffer.
binary | memory to pack. |
string | to save into. |
format | string to convert with. |
|
static |
Find position of case insensitive substring within a string.
text | to search in. |
key | string to locate. |
optional | separator chars if formatted as list of keys. |
char* ucommon::string::last | ( | char * | list | ) |
Find last occurrence of a character in the string.
list | of characters to search for. |
|
static |
Get pointer to last character before character requested.
text | buffer to examine. |
list | of characters. |
|
inlinestatic |
strsize_t ucommon::string::len | ( | void | ) |
Get length of string.
|
static |
Convert null terminated text to lower case.
text | to convert. |
|
inlinestatic |
|
inlinestatic |
strsize_t ucommon::string::offset | ( | char * | pointer | ) |
Find offset of a pointer into our string buffer.
This can be used to find the offset position of a pointer returned by find, for example. This is used when one needs to convert a member function that returns a pointer to call a member function that operates by a offset value. If the pointer is outside the range of the string then npos is returned.
pointer | into our object's string buffer. |
ucommon::string::operator bool | ( | ) |
Test if string has data.
|
inline |
bool ucommon::string::operator! | ( | ) |
Test if string is empty.
bool ucommon::string::operator!= | ( | char * | text | ) |
Compare our object with null terminated text.
Compare method is used.
text | to compare with. |
string& ucommon::string::operator% | ( | short & | value | ) |
Parse short integer value from a string.
value | to store. |
string& ucommon::string::operator% | ( | unsigned short & | value | ) |
Parse long integer value from a string.
value | to store. |
string& ucommon::string::operator% | ( | long & | value | ) |
Parse long integer value from a string.
value | to store. |
string& ucommon::string::operator% | ( | unsigned long & | value | ) |
Parse long integer value from a string.
value | to store. |
string& ucommon::string::operator% | ( | double & | value | ) |
Parse double value from a string.
value | to store. |
string& ucommon::string::operator% | ( | char * | text | ) |
Parse text from a string in a scan expression.
text | to scan and bypass. |
string& ucommon::string::operator& | ( | char * | text | ) |
Concatenate null terminated text to our object.
This directly appends the text to the string buffer and does not resize the object if the existing cstring allocation space is fully used.
text | to concatenate. |
Get a new substring through object expression.
offset | of substring. |
size | of substring or 0 if to end. |
Reimplemented in ucommon::UString.
char* ucommon::string::operator() | ( | int | offset | ) |
Reference a string in the object by relative offset.
Positive offsets are from the start of the string, negative from the end.
offset | to string position. |
Reimplemented in ucommon::UString.
|
inline |
string& ucommon::string::operator+ | ( | char * | text | ) |
Concatenate null terminated text to our object.
This creates a new copy-on-write instance to hold the concatenated string.
text | to concatenate. |
string& ucommon::string::operator+= | ( | char * | text | ) |
Concatenate text to an existing string object.
text | to add. |
Delete a specified number of characters from start of string.
number | of characters to delete. |
Delete a specified number of characters from end of string.
number | of characters to delete. |
bool ucommon::string::operator< | ( | char * | text | ) |
Compare our object with null terminated text.
Compare method is used.
text | to compare with. |
bool ucommon::string::operator<= | ( | char * | text | ) |
Compare our object with null terminated text.
Compare method is used.
text | to compare with. |
Assign our string with the cstring of another object.
If we had an active string reference, it is released. The object now has a duplicate reference to the cstring of the other object.
object | to assign from. |
Reimplemented in ucommon::stringbuf< S >, and ucommon::memstring.
string& ucommon::string::operator= | ( | char * | text | ) |
Assign text to our existing buffer.
This performs a set method.
text | to assign from. |
Reimplemented in ucommon::stringbuf< S >, and ucommon::memstring.
bool ucommon::string::operator== | ( | char * | text | ) |
Compare our object with null terminated text.
text | to compare with. |
bool ucommon::string::operator> | ( | char * | text | ) |
Compare our object with null terminated text.
Compare method is used.
text | to compare with. |
bool ucommon::string::operator>= | ( | char * | text | ) |
Compare our object with null terminated text.
Compare method is used.
text | to compare with. |
char ucommon::string::operator[] | ( | int | offset | ) |
Reference a single character in string object by array offset.
offset | to character. |
Reimplemented in ucommon::UString.
Create new cow instance and assign value from another string object.
object | to assign from. |
string& ucommon::string::operator^= | ( | char * | text | ) |
Create new cow instance and assign value from null terminated text.
text | to assign from. |
strsize_t ucommon::string::printf | ( | char * | format, |
... | |||
) |
Print items into a string object.
format | string of print format. |
Print formatted items into a string object.
object | to print into. |
format | string to print with. |
char* ucommon::string::rchr | ( | char | character | ) |
Find pointer in string where specified character last appears.
character | to find. |
|
protectedvirtual |
Decrease retention of our reference counted cstring.
May be overridden for memstring which has fixed cstring object.
Implements ucommon::ObjectProtocol.
|
virtual |
Resize and re-allocate string memory.
size | to allocate for string. |
|
protectedvirtual |
Increase retention of our reference counted cstring.
May be overridden for memstring which has fixed cstring object.
Implements ucommon::ObjectProtocol.
Find last occurrence of character in the string.
list | of characters to search for. |
offset | to start of search. Default is end of string. |
|
static |
Find the last occurrence of a character in a text buffer.
text | buffer to examine. |
list | of characters to search for. |
|
inlinestatic |
Set a text field within our string object offset from the end of buffer.
text | to set. |
overflow | character to use as filler if text is too short. |
offset | from end of object string buffer to set text at. |
size | of part of buffer to set with text and overflow. |
|
static |
Set a field in a null terminated string relative to the end of text.
buffer | to modify. |
size | of field to set. |
text | to replace end of string with. |
Skip trailing characters in the string.
This searches the string in reverse order.
list | of characters to skip when found. |
offset | to start of scan. Default is end of string. |
|
static |
Skip before trailing characters in a null terminated string.
text | pointer to start at. |
list | of characters to skip when found. |
void ucommon::string::rsplit | ( | char * | pointer | ) |
Split the string by a pointer position.
Everything before the pointer is removed.
pointer | to split position in string. |
void ucommon::string::rsplit | ( | strsize_t | offset | ) |
Split the string at a specific offset.
Everything before the offset is removed.
offset | to split position in string. |
void ucommon::string::set | ( | char * | text | ) |
Set string object to text of a null terminated string.
text | string to set. |
Set a portion of the string object at a specified offset to a text string.
offset | in object string buffer. |
text | to set at offset. |
size | of text area to set or 0 until end of text. |
Set a text field within our string object.
text | to set. |
overflow | character to use as filler if text is too short. |
offset | in object string buffer to set text at. |
size | of part of buffer to set with text and overflow. |
|
static |
Safely set a null terminated string buffer in memory.
If the text is too large to fit into the buffer, it is truncated to the size.
buffer | to set. |
size | of buffer. Includes null byte at end of string. |
text | to set in buffer. |
|
static |
Safely set a null terminated string buffer in memory.
If the text is too large to fit into the buffer, it is truncated to the size.
buffer | to set. |
size | of buffer. Includes null byte at end of string. |
text | to set in buffer. |
max | size of text to set. |
strsize_t ucommon::string::size | ( | void | ) |
Get the size of currently allocated space for string.
char* ucommon::string::skip | ( | char * | list, |
strsize_t | offset = 0 |
||
) |
Skip lead characters in the string.
list | of characters to skip when found. |
offset | to start of scan. |
|
static |
Skip after lead characters in a null terminated string.
text | pointer to start at. |
list | of characters to skip when found. |
void ucommon::string::split | ( | char * | pointer | ) |
Split the string by a pointer position.
Everything after the pointer is removed.
pointer | to split position in string. |
void ucommon::string::split | ( | strsize_t | offset | ) |
Split the string at a specific offset.
Everything after the offset is removed.
offset | to split position in string. |
void ucommon::string::strip | ( | char * | list | ) |
Strip lead and trailing characters from the string.
list | of characters to remove. |
|
static |
Skip lead and remove trailing characters from a text string.
This function will modify memory.
text | buffer to examine. |
list | of characters to trim and chop. |
|
inlinestatic |
Swap the cstring references between two strings.
object1 | to swap. |
object2 | to swap. |
|
inlinestatic |
|
inlinestatic |
|
static |
A thread-safe token parsing routine for null terminated strings.
This is related to strtok, but with safety checks for NULL values and a number of enhancements including support for quoted text that may contain token separators within quotes. The text string is modified as it is parsed.
text | string to examine for tokens. |
last | token position or set to NULL for start of string. |
list | of characters to use as token separators. |
quote | pairs of characters for quoted text or NULL if not used. |
end | of line marker characters or NULL if not used. |
|
inlinestatic |
A thread-safe token parsing routine for strings objects.
This is related to strtok, but with safety checks for NULL values and a number of enhancements including support for quoted text that may contain token separators within quotes. The object is modified as it is parsed.
object | to examine for tokens. |
last | token position or set to NULL for start of string. |
list | of characters to use as token separators. |
quote | pairs of characters for quoted text or NULL if not used. |
end | of line marker characters or NULL if not used. |
Definition at line 1174 of file string.h.
|
inlinestatic |
|
inlinestatic |
void ucommon::string::trim | ( | char * | list | ) |
Trim lead characters from the string.
list | of characters to remove. |
|
static |
Return start of string after characters to trim from beginning.
This function does not modify memory.
text | buffer to examine. |
list | of characters to skip from start. |
|
inlinestatic |
bool ucommon::string::unquote | ( | char * | quote | ) |
Unquote a quoted string.
Removes lead and trailing quote marks.
quote | pairs of characters for open and close quote. |
|
static |
Unquote a quoted null terminated string.
Returns updated string position and replaces trailing quote with null byte if quoted.
text | to examine. |
quote | pairs of character for open and close quote. |
|
inlinestatic |
|
static |
Convert null terminated text to upper case.
text | to convert. |
|
inlinestatic |
strsize_t ucommon::string::vprintf | ( | char * | format, |
va_list | args | ||
) |
Print items into a string object.
format | string of print format. |
args | list to print. |
|
protected |