#include <string.h>
Inheritance diagram for ucommon::String:
Public Types | |
enum | { SENSITIVE = 0x00, INSENSITIVE = 0x01 } |
This is an internal class which contains the actual string data along with some control fields. More... | |
INSENSITIVE = 0x01 | |
SENSITIVE = 0x00 | |
Public Member Functions | |
void | add (char character) |
Append a single character to our string buffer. | |
void | add (char *text) |
Append null terminated text 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 (strsize_t count=1) |
Chop trailing characters from text. | |
void | chop (char *list) |
Chop trailing characters from the string. | |
char * | chr (char character) |
Find pointer in string where specified character appears. | |
void | clear (void) |
Clear string by setting to empty. | |
void | clear (strsize_t offset, strsize_t size=0) |
Clear a field of a filled string with filler. | |
int | collate (char *string) |
virtual int | compare (char *string) |
Compare the values of two string. | |
String | copy (strsize_t offset, strsize_t size) |
Convenience method for substring extraction. | |
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. | |
void | erase (void) |
Erase string memory. | |
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. | |
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. | |
String | left (strsize_t size) |
Convenience method for left of 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. | |
String & | operator & (char *text) |
Concatenate null terminated text to our object. | |
String & | operator &= (char *text) |
char * | operator * () |
Reference raw text buffer by pointer operator. | |
String & | operator *= (strsize_t number) |
Delete a specified number of characters from start of string. | |
bool | operator *= (regex &expr) |
bool | operator *= (char *substring) |
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% (char *text) |
Parse text from a string in a scan expression. | |
String & | operator% (double &value) |
Parse double value from a string. | |
String & | operator% (unsigned long &value) |
Parse long integer value from a string. | |
String & | operator% (long &value) |
Parse long integer value from a string. | |
String & | operator% (unsigned short &value) |
Parse long integer value from a string. | |
String & | operator% (short &value) |
Parse short integer value from a string. | |
char * | operator() (int offset) |
Reference a string in the object by relative offset. | |
String | operator() (int offset, strsize_t size) |
Get a new substring through object expression. | |
String | operator+ (char *text) |
Concatenate null terminated text to our object. | |
String & | operator++ (void) |
Delete first character from string. | |
String & | operator+= (strsize_t number) |
Delete a specified number of characters from start of string. | |
String & | operator+= (char *text) |
Concatenate text to an existing string object. | |
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. | |
String & | operator<< (char code) |
String & | operator<< (char *text) |
bool | operator<= (char *text) |
Compare our object with null terminated text. | |
String & | operator= (char *text) |
Assign text to our existing buffer. | |
String & | operator= (String &object) |
Assign our string with the cstring of another object. | |
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^= (char *text) |
Create new cow instance and assign value from null terminated text. | |
String & | operator^= (String &object) |
Create new cow instance and assign value from another string object. | |
String & | operator| (char *text) |
Concatenate null terminated text to our object. | |
String & | operator|= (char *text) |
Concatenate text to an existing string object. | |
void | paste (strsize_t offset, char *text, strsize_t size=0) |
Insert (paste) text into string. | |
strsize_t | printf (char *format,...) |
Print items into a string object. | |
char * | rchr (char character) |
Find pointer in string where specified character last appears. | |
unsigned | replace (regex &expr, char *text=((void *) 0), unsigned flags=0) |
unsigned | replace (char *string, char *text=((void *) 0), unsigned flags=0) |
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. | |
String | right (strsize_t offset) |
Convenience method for right of 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 (strsize_t offset) |
Split the string at a specific offset. | |
void | rsplit (char *pointer) |
Split the string by a pointer position. | |
int | scanf (char *format,...) |
Scan input items from a string object. | |
char * | search (regex &expr, unsigned instance=0, unsigned flags=0) |
char * | search (char *string, unsigned instance=0, unsigned flags=0) |
Search for a substring in the string. | |
void | set (char *text, char overflow, strsize_t offset, strsize_t size=0) |
Set a text field within our string object. | |
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) |
Set string object to text of a null terminated string. | |
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 (strsize_t offset) |
Split the string at a specific offset. | |
void | split (char *pointer) |
Split the string by a pointer position. | |
String (String &existing) | |
Construct a copy of a string object. | |
String (char *text, char *end) | |
Create a string for a substring. | |
String (char *text, strsize_t size) | |
Create a string from null terminated text up to a maximum specified size. | |
String (char *text) | |
Create a string from null terminated text. | |
String (strsize_t size, char *format,...) | |
Create a string by printf-like formating into a pre-allocated space of 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) | |
Create an empty string with a buffer pre-allocated to a specified size. | |
String (double value) | |
Create a string from a floating point. | |
String (long value) | |
Create a string from a long integer. | |
String () | |
Create a new empty string object. | |
void | strip (char *list) |
Strip lead and trailing characters from the string. | |
double | tod (char **pointer=((void *) 0)) |
Convert string to a double value. | |
char * | token (char **last, char *list, char *quote=((void *) 0), char *end=((void *) 0)) |
A thread-safe token parsing routine for strings objects. | |
long | tol (char **pointer=((void *) 0)) |
Convert string to a long value. | |
void | trim (strsize_t count=1) |
Trim lead characters from text. | |
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. | |
int | vscanf (char *format, va_list args) |
Scan input items from a string object. | |
virtual | ~String () |
Destroy string. | |
Static Public Member Functions | |
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 char * | add (char *buffer, size_t size, char *text) |
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, size_t size) |
Depreciated case insensitive string comparison function. | |
static int | case_compare (char *text1, char *text2) |
Depreciated case insensitive string comparison function. | |
static unsigned | ccount (char *text, char *list) |
Count instances of characters in a list in a text buffer. | |
static char * | chop (char *text, char *list) |
Strip trailing characters from the text string. | |
static int | collate (char *text1, char *text2) |
static int | compare (char *text1, char *text2, size_t size) |
Depreciated string comparison function. | |
static int | compare (char *text1, char *text2) |
Safe string collation function. | |
static char * | copy (char *text, size_t offset, size_t len) |
static size_t | count (char *text) |
Safe version of strlen function. | |
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 void | cut (char *text, size_t offset, size_t len) |
static char * | dup (char *text) |
Duplicate null terminated text into the heap. | |
static bool | eq_case (char *text1, char *text2, size_t size) |
Simple case insensitive equal test for strings. | |
static bool | eq_case (char *text1, char *text2) |
Simple case insensitive equal test for strings. | |
static bool | equal (char *text1, char *text2, size_t size) |
Simple equal test for strings. | |
static bool | equal (char *text1, char *text2) |
Simple equal test for strings. | |
static void | erase (char *text) |
Erase string memory. | |
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 *list) |
Find the first occurrence of a character in a text buffer. | |
static char * | find (char *text, char *key, char *optional) |
Find position of substring within a string. | |
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 * | left (char *text, size_t size) |
Duplicate null terminated text of specific size to heap. | |
static void | lower (char *text) |
Convert null terminated text to lower case. | |
static void | paste (char *text, size_t max, size_t offset, char *data, size_t len=0) |
static char * | pos (char *text, ssize_t offset) |
Compute position in string. | |
static char * | rfind (char *text, char *list) |
Find the last occurrence of a character in a text buffer. | |
static char * | right (char *text, size_t size) |
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 size_t | seek (char *text, char *list) |
Offset until next occurrence of character in a text or length. | |
static char * | set (char *buffer, size_t size, char *text, size_t max) |
Safely set a null terminated string buffer in memory. | |
static char * | set (char *buffer, size_t size, char *text) |
Safely set a null terminated string buffer in memory. | |
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 | swap (String &object1, String &object2) |
Swap the cstring references between two strings. | |
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 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 char * | unquote (char *text, char *quote) |
Unquote a quoted null terminated string. | |
static void | upper (char *text) |
Convert null terminated text to upper case. | |
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. | |
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. | |
Data Structures | |
class | cstring |
class | regex |
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.
Definition at line 82 of file string.h.
anonymous enum |
This is an internal class which contains the actual string data along with some control fields.
The string can be either NULL terminated or filled like a Pascal-style string, but with a user selected fill character. The cstring object is an overdraft object, as the actual string text which is of unknown size follows immediately after the class control data. This class is primarily for internal use.
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, | |||
... | ||||
) |
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 ucommon::String::~String | ( | ) | [virtual] |
Destroy string.
De-reference cstring. If last reference to cstring, then also remove cstring from heap.
static char* ucommon::String::add | ( | char * | buffer, | |
size_t | size, | |||
char * | text, | |||
size_t | max | |||
) | [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. |
static char* ucommon::String::add | ( | char * | buffer, | |
size_t | size, | |||
char * | text | |||
) | [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. |
void ucommon::String::add | ( | char | character | ) |
Append a single character to our string buffer.
character | to append. |
void ucommon::String::add | ( | char * | text | ) |
Append null terminated text to our string buffer.
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 size_t ucommon::String::b64decode | ( | uint8_t * | binary, | |
char * | string, | |||
size_t | size | |||
) | [static] |
Standard radix 64 decoding.
binary | data to save. | |
string | of encoded text. | |
size | of destination buffer. |
static size_t ucommon::String::b64encode | ( | char * | string, | |
uint8_t * | binary, | |||
size_t | size, | |||
size_t | width = 0 | |||
) | [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.
virtual cstring* ucommon::String::c_copy | ( | void | ) | [protected, virtual] |
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.
Referenced by ucommon::stringbuf< S >::operator=(), and ucommon::memstring::operator=().
static int ucommon::String::case_compare | ( | char * | text1, | |
char * | text2, | |||
size_t | size | |||
) | [static] |
Depreciated case insensitive string comparison function.
text1 | to compare. | |
text2 | to compare. | |
size | limit of strings to compare. |
static int ucommon::String::case_compare | ( | char * | text1, | |
char * | text2 | |||
) | [static] |
Depreciated case insensitive string comparison function.
text1 | to compare. | |
text2 | to compare. |
static unsigned ucommon::String::ccount | ( | char * | text, | |
char * | list | |||
) | [static] |
Count instances of characters in a list in a text buffer.
text | buffer to examine. | |
list | of characters to count in buffer. |
strsize_t ucommon::String::ccount | ( | char * | list | ) |
Count number of occurrences of characters in string.
list | of characters to find. |
static char* ucommon::String::chop | ( | char * | text, | |
char * | list | |||
) | [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. |
void ucommon::String::chop | ( | strsize_t | count = 1 |
) | [inline] |
void ucommon::String::chop | ( | char * | list | ) |
Chop trailing characters from the string.
list | of characters to remove. |
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. |
static int ucommon::String::compare | ( | char * | text1, | |
char * | text2, | |||
size_t | size | |||
) | [static] |
Depreciated string comparison function.
text1 | to compare. | |
text2 | to compare. | |
size | limit of strings to compare. |
static int ucommon::String::compare | ( | char * | text1, | |
char * | text2 | |||
) | [static] |
Safe string collation function.
text1 | to compare. | |
text2 | to compare. |
virtual int ucommon::String::compare | ( | char * | string | ) | [virtual] |
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. |
Referenced by ucommon::eq(), ucommon::ge(), ucommon::gt(), ucommon::le(), ucommon::lt(), and ucommon::ne().
Convenience method for substring extraction.
offset | into string. | |
size | of string to return. |
Reimplemented in ucommon::UString.
static size_t ucommon::String::count | ( | char * | text | ) | [static] |
Safe version of strlen function.
Accepts NULL as 0 length strings.
text | string. |
strsize_t ucommon::String::count | ( | void | ) |
Count all characters in the string (strlen).
Reimplemented in ucommon::UString.
virtual void ucommon::String::cow | ( | strsize_t | size = 0 |
) | [protected, virtual] |
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 uint16_t ucommon::String::crc16 | ( | uint8_t * | binary, | |
size_t | size | |||
) | [static] |
ccitt 16 bit crc for binary data.
binary | data to sum. | |
size | of binary data to sum. |
static uint32_t ucommon::String::crc24 | ( | uint8_t * | binary, | |
size_t | size | |||
) | [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. |
Reimplemented in ucommon::UString.
static char* ucommon::String::dup | ( | char * | text | ) | [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.
static bool ucommon::String::eq_case | ( | char * | text1, | |
char * | text2, | |||
size_t | size | |||
) | [static] |
Simple case insensitive equal test for strings.
text1 | to test. | |
text2 | to test. | |
size | limit of strings to compare. |
static bool ucommon::String::eq_case | ( | char * | text1, | |
char * | text2 | |||
) | [static] |
Simple case insensitive equal test for strings.
text1 | to test. | |
text2 | to test. |
static bool ucommon::String::equal | ( | char * | text1, | |
char * | text2, | |||
size_t | size | |||
) | [static] |
Simple equal test for strings.
text1 | to test. | |
text2 | to test. | |
size | limit of strings to compare. |
static bool ucommon::String::equal | ( | char * | text1, | |
char * | text2 | |||
) | [static] |
Simple equal test for strings.
text1 | to test. | |
text2 | to test. |
bool ucommon::String::equal | ( | char * | string | ) | [protected] |
Test if two string values are equal.
string | to compare with. |
static void ucommon::String::erase | ( | char * | text | ) | [static] |
Erase string memory.
Often used to clear out passwords.
text | string to erase. |
static char* ucommon::String::fill | ( | char * | text, | |
size_t | size, | |||
char | character | |||
) | [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::fill | ( | void | ) |
Get filler character used for field array strings.
static char* ucommon::String::find | ( | char * | text, | |
char * | list | |||
) | [static] |
Find the first occurrence of a character in a text buffer.
text | buffer to examine. | |
list | of characters to search for. |
static char* ucommon::String::find | ( | char * | text, | |
char * | key, | |||
char * | optional | |||
) | [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. |
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 void ucommon::String::fix | ( | String & | object | ) | [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.
Referenced by ucommon::UString::operator()().
static unsigned ucommon::String::hexdump | ( | unsigned char * | binary, | |
char * | string, | |||
char * | format | |||
) | [static] |
Dump hex data to a string buffer.
binary | memory to dump. | |
string | to save into. | |
format | string to convert with. |
static unsigned ucommon::String::hexpack | ( | unsigned char * | binary, | |
char * | string, | |||
char * | format | |||
) | [static] |
Pack hex data from a string buffer.
binary | memory to pack. | |
string | to save into. | |
format | string to convert with. |
static char* ucommon::String::ifind | ( | char * | text, | |
char * | key, | |||
char * | optional | |||
) | [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. |
static char* ucommon::String::left | ( | char * | text, | |
size_t | size | |||
) | [static] |
Duplicate null terminated text of specific size to heap.
text | to duplicate. | |
size | of text, maximum space allocated. |
Convenience method for left of string.
size | of substring to gather. |
Reimplemented in ucommon::UString.
strsize_t ucommon::String::len | ( | void | ) |
Get length of string.
static void ucommon::String::lower | ( | char * | text | ) | [static] |
Convert null terminated text to lower case.
text | to convert. |
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. |
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. |
char* ucommon::String::operator * | ( | ) | [inline] |
Delete a specified number of characters from start of string.
number | of characters to delete. |
ucommon::String::operator bool | ( | ) |
Test if string has data.
ucommon::String::operator char * | ( | ) | [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% | ( | char * | text | ) |
Parse text from a string in a scan expression.
text | to scan and bypass. |
String& ucommon::String::operator% | ( | double & | value | ) |
Parse double 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% | ( | long & | value | ) |
Parse long 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% | ( | short & | value | ) |
Parse short integer value from a string.
value | to store. |
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.
Get a new substring through object expression.
offset | of substring. | |
size | of substring or 0 if to end. |
Reimplemented in ucommon::UString.
Referenced by ucommon::UString::copy(), ucommon::UString::left(), and ucommon::UString::right().
String ucommon::String::operator+ | ( | char * | text | ) |
Concatenate null terminated text to our object.
text | to concatenate. |
Delete a specified number of characters from start of string.
number | of characters to delete. |
String& ucommon::String::operator+= | ( | char * | text | ) |
Concatenate text to an existing string object.
text | to add. |
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. |
String& ucommon::String::operator= | ( | char * | text | ) |
Assign text to our existing buffer.
This performs a set method.
text | to assign from. |
Reimplemented in ucommon::memstring, and ucommon::stringbuf< S >.
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::memstring, and ucommon::stringbuf< S >.
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.
String& ucommon::String::operator^= | ( | char * | text | ) |
Create new cow instance and assign value from null terminated text.
text | to assign from. |
Create new cow instance and assign value from another string object.
object | to assign from. |
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. This will eventually replace '+' when + creates a new string instance instead.
text | to concatenate. |
String& ucommon::String::operator|= | ( | char * | text | ) |
Concatenate text to an existing string object.
This will use the old behavior when +/= updated.
Insert (paste) text into string.
offset | to start paste. | |
text | to paste. | |
size | of text to paste. |
Reimplemented in ucommon::UString.
static char* ucommon::String::pos | ( | char * | text, | |
ssize_t | offset | |||
) | [static] |
Compute position in string.
text | of string. | |
offset | from start, negative values from end. |
strsize_t ucommon::String::printf | ( | char * | format, | |
... | ||||
) |
Print items into a string object.
format | string of print format. |
char* ucommon::String::rchr | ( | char | character | ) |
Find pointer in string where specified character last appears.
character | to find. |
virtual void ucommon::String::release | ( | void | ) | [protected, virtual] |
Decrease retention of our reference counted cstring.
May be overridden for memstring which has fixed cstring object.
Implements ucommon::ObjectProtocol.
virtual bool ucommon::String::resize | ( | strsize_t | size | ) | [virtual] |
Resize and re-allocate string memory.
size | to allocate for string. |
virtual void ucommon::String::retain | ( | void | ) | [protected, virtual] |
Increase retention of our reference counted cstring.
May be overridden for memstring which has fixed cstring object.
Implements ucommon::ObjectProtocol.
static char* ucommon::String::rfind | ( | char * | text, | |
char * | list | |||
) | [static] |
Find the last occurrence of a character in a text buffer.
text | buffer to examine. | |
list | of characters to search for. |
Find last occurrence of character in the string.
list | of characters to search for. | |
offset | to start of search. Default is end of string. |
Convenience method for right of string.
offset | of substring from right. |
Reimplemented in ucommon::UString.
static char* ucommon::String::rset | ( | char * | buffer, | |
size_t | size, | |||
char * | text | |||
) | [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. |
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 char* ucommon::String::rskip | ( | char * | text, | |
char * | list | |||
) | [static] |
Skip before trailing characters in a null terminated string.
text | pointer to start at. | |
list | of characters to skip when found. |
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. |
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::rsplit | ( | char * | pointer | ) |
Split the string by a pointer position.
Everything before the pointer is removed.
pointer | to split position in string. |
int ucommon::String::scanf | ( | char * | format, | |
... | ||||
) |
Scan input items from a string object.
format | string of input to scan. |
char* ucommon::String::search | ( | char * | string, | |
unsigned | instance = 0 , |
|||
unsigned | flags = 0 | |||
) |
Search for a substring in the string.
substring | to search for. | |
flags | for case insensitive search. |
static size_t ucommon::String::seek | ( | char * | text, | |
char * | list | |||
) | [static] |
Offset until next occurrence of character in a text or length.
text | buffer to examine. | |
list | of characters to search for. |
static char* ucommon::String::set | ( | char * | buffer, | |
size_t | size, | |||
char * | text, | |||
size_t | max | |||
) | [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. |
static char* ucommon::String::set | ( | char * | buffer, | |
size_t | size, | |||
char * | text | |||
) | [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. |
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. |
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. |
void ucommon::String::set | ( | char * | text | ) |
Set string object to text of a null terminated string.
text | string to set. |
Referenced by ucommon::memstring::operator=().
strsize_t ucommon::String::size | ( | void | ) |
Get the size of currently allocated space for string.
static char* ucommon::String::skip | ( | char * | text, | |
char * | list | |||
) | [static] |
Skip after lead characters in a null terminated string.
text | pointer to start at. | |
list | of characters to skip when found. |
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. |
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::split | ( | char * | pointer | ) |
Split the string by a pointer position.
Everything after the pointer is removed.
pointer | to split position in string. |
static char* ucommon::String::strip | ( | char * | text, | |
char * | list | |||
) | [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. |
void ucommon::String::strip | ( | char * | list | ) |
Strip lead and trailing characters from the string.
list | of characters to remove. |
Swap the cstring references between two strings.
object1 | to swap. | |
object2 | to swap. |
static double ucommon::String::tod | ( | char * | text, | |
char ** | pointer = ((void*)0) | |||
) | [inline, static] |
double ucommon::String::tod | ( | char ** | pointer = ((void*)0) |
) | [inline] |
char* ucommon::String::token | ( | char ** | last, | |
char * | list, | |||
char * | quote = ((void*)0) , |
|||
char * | end = ((void*)0) | |||
) | [inline] |
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.
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. |
static char* ucommon::String::token | ( | char * | text, | |
char ** | last, | |||
char * | list, | |||
char * | quote = ((void *) 0) , |
|||
char * | end = ((void *) 0) | |||
) | [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. |
static long ucommon::String::tol | ( | char * | text, | |
char ** | pointer = ((void*)0) | |||
) | [inline, static] |
long ucommon::String::tol | ( | char ** | pointer = ((void*)0) |
) | [inline] |
static char* ucommon::String::trim | ( | char * | text, | |
char * | list | |||
) | [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. |
void ucommon::String::trim | ( | strsize_t | count = 1 |
) | [inline] |
void ucommon::String::trim | ( | char * | list | ) |
Trim lead characters from the string.
list | of characters to remove. |
static char* ucommon::String::unquote | ( | char * | text, | |
char * | 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. |
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 void ucommon::String::upper | ( | char * | text | ) | [static] |
Convert null terminated text to upper case.
text | to convert. |
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. |
int ucommon::String::vscanf | ( | char * | format, | |
va_list | args | |||
) |
Scan input items from a string object.
format | string of input to scan. | |
args | list to scan into. |