![]() |
CUGL 2.1
Cornell University Game Library
|
Enumerations | |
enum | UnicodeType : int { SPACE = 0, NEWLINE = 1, CONTROL = 2, CJK = 3, CHAR = 4 } |
Functions | |
std::string | to_string (Uint8 value) |
std::string | to_string (Sint16 value) |
std::string | to_string (Uint16 value) |
std::string | to_string (Sint32 value) |
std::string | to_string (Uint32 value) |
std::string | to_string (Sint64 value) |
std::string | to_string (Uint64 value) |
std::string | to_string (float value, int precision=-1) |
std::string | to_string (double value, int precision=-1) |
std::string | to_string (Uint8 *array, size_t length, size_t offset=0) |
std::string | to_string (Sint16 *array, size_t length, size_t offset=0) |
std::string | to_string (Uint16 *array, size_t length, size_t offset=0) |
std::string | to_string (Sint32 *array, size_t length, size_t offset=0) |
std::string | to_string (Uint32 *array, size_t length, size_t offset=0) |
std::string | to_string (Sint64 *array, size_t length, size_t offset=0) |
std::string | to_string (Uint64 *array, size_t length, size_t offset=0) |
std::string | to_string (float *array, size_t length, size_t offset=0, int precision=-1) |
std::string | to_string (double *array, size_t length, size_t offset=0, int precision=-1) |
Uint8 | stou8 (const std::string str, std::size_t *pos=0, int base=10) |
Sint16 | stos16 (const std::string str, std::size_t *pos=0, int base=10) |
Uint16 | stou16 (const std::string str, std::size_t *pos=0, int base=10) |
Sint32 | stos32 (const std::string str, std::size_t *pos=0, int base=10) |
Uint32 | stou32 (const std::string str, std::size_t *pos=0, int base=10) |
Sint64 | stos64 (const std::string str, std::size_t *pos=0, int base=10) |
Uint64 | stou64 (const std::string str, std::size_t *pos=0, int base=10) |
float | stof (const std::string str, std::size_t *pos=0) |
double | stod (const std::string str, std::size_t *pos=0) |
bool | isalpha (const std::string str) |
bool | isalphanum (const std::string str) |
bool | isnumeric (const std::string str) |
bool | isnumber (const std::string str) |
int | count (const std::string str, const std::string a) |
bool | starts_with (const std::string str, const std::string a) |
bool | ends_with (const std::string str, const std::string a) |
bool | islower (const std::string str) |
bool | isupper (const std::string str) |
std::vector< std::string > | split (const std::string str, const std::string sep) |
std::vector< std::string > | splitlines (const std::string str) |
std::string | join (const std::string sep, std::initializer_list< std::string > elts) |
std::string | join (const std::string sep, std::vector< std::string > elts) |
std::string | join (const std::string sep, const std::string *elts, size_t size) |
std::string | trim (const std::string str) |
std::string | ltrim (const std::string str) |
std::string | rtrim (const std::string str) |
template<typename ... Args> | |
std::string | format (const std::string format, Args ... args) |
std::string | tolower (std::string str) |
std::string | toupper (const std::string str) |
std::string | replace (const std::string str, const std::string a, const std::string b) |
std::string | replaceall (const std::string str, const std::string a, const std::string b) |
UnicodeType | getUnicodeType (Uint32 code) |
UnicodeType | getUnicodeType (const std::string str) |
UnicodeType | getUnicodeType (const char *substr, const char *end) |
std::vector< Uint32 > | getCodePoints (const std::string str) |
std::vector< Uint32 > | getCodePoints (const char *substr, const char *end) |
size_t | getUTF8Length (const std::string str) |
size_t | getUTF8Length (const char *substr, const char *end) |
A platform independent module for generating strings.
The functions in this namespace are necessary because Android does not support a lot of the built-in string methods. Therefore, we need alternate definitions that are platform agnostic. Note that these functions have names that are very similar to those in the std namespace, but all live in the cugl::strtool namespace.
Note that this module does not refer to the integral types as short, int, long, etc. Those types are NOT cross-platform. For example, a long is 8 bytes on Unix/OS X, but 4 bytes on some Win32 platforms. Hence we use the SDL naming convention instead.
enum cugl::strtool::UnicodeType : int |
This enum categorizes the type of unicode characters we might encounter
Unicode character types are independent of font choice. Identifying non-printable characters (or spacing) is useful for when we need to break up text over multiple lines.
int cugl::strtool::count | ( | const std::string | str, |
const std::string | a | ||
) |
Returns the number of times substring a appears in str.
Overlapping substring count. So count("aaa","aa") returns 2.
str | The string to count from |
a | The substring to count |
bool cugl::strtool::ends_with | ( | const std::string | str, |
const std::string | a | ||
) |
Returns true if str ends with the substring a.
str | The string to query |
a | The substring to match |
std::string cugl::strtool::format | ( | const std::string | format, |
Args ... | args | ||
) |
Returns a new string from the given formatter and arguments
This funciton is similar to the C-function sprintf
except that it supports C++ style strings.
format | The formatting string |
args | The argument list |
std::vector<Uint32> cugl::strtool::getCodePoints | ( | const char * | substr, |
const char * | end | ||
) |
Returns the code points for the elements of substr.
The C-style string substr need not be null-terminated. Instead, the termination is indicated by the parameter end. This provides efficient substring processing.
The string may either be in UTF8 or ASCII; the method will handle conversion automatically. Note that for an ASCII string, this will simply fill the vector with the elements of str.
substr | The start of the string to test |
end | The end of the string to test |
std::vector<Uint32> cugl::strtool::getCodePoints | ( | const std::string | str | ) |
Returns the code points for the elements of str.
The string may either be in UTF8 or ASCII; the method will handle conversion automatically. Note that for an ASCII string, this will simply fill the vector with the elements of str.
str | The string to convert |
UnicodeType cugl::strtool::getUnicodeType | ( | const char * | substr, |
const char * | end | ||
) |
Returns the unicode type for the FIRST character of substr.
The C-style string substr need not be null-terminated. Instead, the termination is indicated by the parameter end. This provides efficient substring processing.
The string may either be in UTF8 or ASCII; the method will handle conversion automatically. Note that a character of a UTF8 string may comprise multiple elements of the string type.
substr | The start of the string to test |
end | The end of the string to test |
UnicodeType cugl::strtool::getUnicodeType | ( | const std::string | str | ) |
Returns the unicode type for the FIRST character of str.
The string may either be in UTF8 or ASCII; the method will handle conversion automatically. Note that a character of a UTF8 string may comprise multiple elements of the string type.
str | The string to test |
UnicodeType cugl::strtool::getUnicodeType | ( | Uint32 | code | ) |
Returns the unicode type for the given unicode code point
A unicode code point is the 32-bit representation of a character. It is endian specific and therefore not serializable. A UTF8 representation should be used for serialization.
code | The unicode code point |
size_t cugl::strtool::getUTF8Length | ( | const char * | substr, |
const char * | end | ||
) |
Returns the length of substr in UTF8 encoding
The C-style string substr need not be null-terminated. Instead, the termination is indicated by the parameter end. This provides efficient substring processing.
The string may either be in UTF8 or ASCII; the method will handle conversion automatically. Note that for an ASCII string, this will simply return the size of the string.
substr | The start of the string to test |
end | The end of the string to test |
size_t cugl::strtool::getUTF8Length | ( | const std::string | str | ) |
Returns the length of str in UTF8 encoding
The string may either be in UTF8 or ASCII; the method will handle conversion automatically. Note that for an ASCII string, this will simply return the size of the string.
str | The string to convert |
bool cugl::strtool::isalpha | ( | const std::string | str | ) |
Returns true if the string only contains alphabetic characters.
This function uses the current C++ locale.
str | The string to check |
bool cugl::strtool::isalphanum | ( | const std::string | str | ) |
Returns true if the string only contains alphabetic and numeric characters.
This function uses the current C++ locale.
str | The string to check |
bool cugl::strtool::islower | ( | const std::string | str | ) |
Returns true if the string is lower case
This method ignores any non-letter characters and returns true if str is the empty string. So the only way it can be false is if there is an upper case letter in the string.
This function uses the current C++ locale.
str | The string to query |
bool cugl::strtool::isnumber | ( | const std::string | str | ) |
Returns true if the string can safely be converted to a number (double)
This function uses the current C++ locale.
str | The string to check |
bool cugl::strtool::isnumeric | ( | const std::string | str | ) |
Returns true if the string only contains numeric characters.
This function uses the current C++ locale.
str | The string to check |
bool cugl::strtool::isupper | ( | const std::string | str | ) |
Returns true if the string is upper case
This method ignores any non-letter characters and returns true if str is the empty string. So the only way it can be false is if there is a lower case letter in the string.
This function uses the current C++ locale.
str | The string to query |
std::string cugl::strtool::join | ( | const std::string | sep, |
const std::string * | elts, | ||
size_t | size | ||
) |
Returns a string that is the concatenation of elts.
The string sep is placed between each concatenated item of elts. If elts is one element or none, then sep is ignored.
sep | The join separator |
elts | The strings to join |
size | The number of items in elts. |
std::string cugl::strtool::join | ( | const std::string | sep, |
std::initializer_list< std::string > | elts | ||
) |
Returns a string that is the concatenation of elts.
The string sep is placed between each concatenated item of elts. If elts is one element or none, then sep is ignored.
sep | The join separator |
elts | The strings to join |
std::string cugl::strtool::join | ( | const std::string | sep, |
std::vector< std::string > | elts | ||
) |
Returns a string that is the concatenation of elts.
The string sep is placed between each concatenated item of elts. If elts is one element or none, then sep is ignored.
sep | The join separator |
elts | The strings to join |
std::string cugl::strtool::ltrim | ( | const std::string | str | ) |
Returns a copy of str with any leading whitespace removed.
This function uses the current C++ locale.
str | The string to trim |
std::string cugl::strtool::replace | ( | const std::string | str, |
const std::string | a, | ||
const std::string | b | ||
) |
Returns a copy of str with the first instance of a replaced by b.
If a is not a substring of str, the function returns an unmodified copy of str.
str | The string to modify |
a | The substring to replace |
b | The substring to substitute |
std::string cugl::strtool::replaceall | ( | const std::string | str, |
const std::string | a, | ||
const std::string | b | ||
) |
Returns a copy of str with all instances of a replaced by b.
If a is not a substring of str, the function returns an unmodified copy of str.
str | The string to modify |
a | The substring to replace |
b | The substring to substitute |
std::string cugl::strtool::rtrim | ( | const std::string | str | ) |
Returns a copy of str with any trailing whitespace removed.
This function uses the current C++ locale.
str | The string to trim |
std::vector<std::string> cugl::strtool::split | ( | const std::string | str, |
const std::string | sep | ||
) |
Returns a list of substrings separate by the given separator
The separator is interpretted exactly; no whitespace is removed around the separator. If the separator is the empty string, this function will return a list of the characters in str.
str | The string to split |
sep | The splitting delimeter |
std::vector<std::string> cugl::strtool::splitlines | ( | const std::string | str | ) |
Returns a list of substrings separated by the line separator
This function treats both newlines and carriage returns as line separators. Windows-style line separators (CR+NL) do not produce an extra line in the middle.
str | The string to split |
bool cugl::strtool::starts_with | ( | const std::string | str, |
const std::string | a | ||
) |
Returns true if str starts with the substring a.
str | The string to query |
a | The substring to match |
double cugl::strtool::stod | ( | const std::string | str, |
std::size_t * | pos = 0 |
||
) |
Returns the double equivalent to the given string
This function discards any whitespace characters (as determined by std::isspace()) until first non-whitespace character is found. Then it takes as many characters as possible to form a valid floating point representation and converts them to a floating point value.
str | the string to convert |
pos | address of an integer to store the number of characters processed |
float cugl::strtool::stof | ( | const std::string | str, |
std::size_t * | pos = 0 |
||
) |
Returns the float equivalent to the given string
This function discards any whitespace characters (as determined by std::isspace()) until first non-whitespace character is found. Then it takes as many characters as possible to form a valid floating point representation and converts them to a floating point value.
str | the string to convert |
pos | address of an integer to store the number of characters processed |
Sint16 cugl::strtool::stos16 | ( | const std::string | str, |
std::size_t * | pos = 0 , |
||
int | base = 10 |
||
) |
Returns the signed 16 bit integer equivalent to the given string
This function discards any whitespace characters (as identified by calling isspace()) until the first non-whitespace character is found, then takes as many characters as possible to form a valid base-n (where n=base) integer number representation and converts them to a long value.
str | the string to convert |
pos | address of an integer to store the number of characters processed |
base | the number base |
Sint32 cugl::strtool::stos32 | ( | const std::string | str, |
std::size_t * | pos = 0 , |
||
int | base = 10 |
||
) |
Returns the signed 32 bit integer equivalent to the given string
This function discards any whitespace characters (as identified by calling isspace()) until the first non-whitespace character is found, then takes as many characters as possible to form a valid base-n (where n=base) integer number representation and converts them to a long value.
str | the string to convert |
pos | address of an integer to store the number of characters processed |
base | the number base |
Sint64 cugl::strtool::stos64 | ( | const std::string | str, |
std::size_t * | pos = 0 , |
||
int | base = 10 |
||
) |
Returns the signed 64 bit integer equivalent to the given string
This function discards any whitespace characters (as identified by calling isspace()) until the first non-whitespace character is found, then takes as many characters as possible to form a valid base-n (where n=base) integer number representation and converts them to a long value.
str | the string to convert |
pos | address of an integer to store the number of characters processed |
base | the number base |
Uint16 cugl::strtool::stou16 | ( | const std::string | str, |
std::size_t * | pos = 0 , |
||
int | base = 10 |
||
) |
Returns the unsigned 16 bit integer equivalent to the given string
This function discards any whitespace characters (as identified by calling isspace()) until the first non-whitespace character is found, then takes as many characters as possible to form a valid base-n (where n=base) integer number representation and converts them to a long value.
str | the string to convert |
pos | address of an integer to store the number of characters processed |
base | the number base |
Uint32 cugl::strtool::stou32 | ( | const std::string | str, |
std::size_t * | pos = 0 , |
||
int | base = 10 |
||
) |
Returns the unsigned 32 bit integer equivalent to the given string
This function discards any whitespace characters (as identified by calling isspace()) until the first non-whitespace character is found, then takes as many characters as possible to form a valid base-n (where n=base) integer number representation and converts them to a long value.
str | the string to convert |
pos | address of an integer to store the number of characters processed |
base | the number base |
Uint64 cugl::strtool::stou64 | ( | const std::string | str, |
std::size_t * | pos = 0 , |
||
int | base = 10 |
||
) |
Returns the unsigned 64 bit integer equivalent to the given string
This function discards any whitespace characters (as identified by calling isspace()) until the first non-whitespace character is found, then takes as many characters as possible to form a valid base-n (where n=base) integer number representation and converts them to a long value.
str | the string to convert |
pos | address of an integer to store the number of characters processed |
base | the number base |
Uint8 cugl::strtool::stou8 | ( | const std::string | str, |
std::size_t * | pos = 0 , |
||
int | base = 10 |
||
) |
Returns the byte equivalent to the given string
This function discards any whitespace characters (as identified by calling isspace()) until the first non-whitespace character is found, then takes as many characters as possible to form a valid base-n (where n=base) integer number representation and converts them to an integer value.
str | the string to convert |
pos | address of an integer to store the number of characters processed |
base | the number base |
std::string cugl::strtool::to_string | ( | double * | array, |
size_t | length, | ||
size_t | offset = 0 , |
||
int | precision = -1 |
||
) |
Returns a string equivalent to the given double array
The value is display as a python-style list in brackets.
As with to_string(double), this function allows us to specify a precision (the number of digits to display after the decimal point). If precision is negative, then maximum precision will be used.
array | the array to convert |
length | the array length |
offset | the starting position in the array |
precision | the number of digits to display after the decimal |
std::string cugl::strtool::to_string | ( | double | value, |
int | precision = -1 |
||
) |
Returns a string equivalent to the given double value
This function differs from std::to_string(double) in that it allows us to specify a precision (the number of digits to display after the decimal point). If precision is negative, then maximum precision will be used.
value | the numeric value to convert |
precision | the number of digits to display after the decimal |
std::string cugl::strtool::to_string | ( | float * | array, |
size_t | length, | ||
size_t | offset = 0 , |
||
int | precision = -1 |
||
) |
Returns a string equivalent to the given float array
The value is display as a python-style list in brackets.
As with to_string(float), this function allows us to specify a precision (the number of digits to display after the decimal point). If precision is negative, then maximum precision will be used.
array | the array to convert |
length | the array length |
offset | the starting position in the array |
precision | the number of digits to display after the decimal |
std::string cugl::strtool::to_string | ( | float | value, |
int | precision = -1 |
||
) |
Returns a string equivalent to the given float value
This function differs from std::to_string(float) in that it allows us to specify a precision (the number of digits to display after the decimal point). If precision is negative, then maximum precision will be used.
value | the numeric value to convert |
precision | the number of digits to display after the decimal |
std::string cugl::strtool::to_string | ( | Sint16 * | array, |
size_t | length, | ||
size_t | offset = 0 |
||
) |
Returns a string equivalent to the signed 16 bit integer array
The value is display as a python-style list in brackets.
array | the array to convert |
length | the array length |
offset | the starting position in the array |
std::string cugl::strtool::to_string | ( | Sint16 | value | ) |
Returns a string equivalent to the given signed 16 bit integer
value | the numeric value to convert |
std::string cugl::strtool::to_string | ( | Sint32 * | array, |
size_t | length, | ||
size_t | offset = 0 |
||
) |
Returns a string equivalent to the signed 32 bit integer array
The value is display as a python-style list in brackets.
array | the array to convert |
length | the array length |
offset | the starting position in the array |
std::string cugl::strtool::to_string | ( | Sint32 | value | ) |
Returns a string equivalent to the given signed 32 bit integer
value | the numeric value to convert |
std::string cugl::strtool::to_string | ( | Sint64 * | array, |
size_t | length, | ||
size_t | offset = 0 |
||
) |
Returns a string equivalent to the signed 64 bit integer array
The value is display as a python-style list in brackets.
array | the array to convert |
length | the array length |
offset | the starting position in the array |
std::string cugl::strtool::to_string | ( | Sint64 | value | ) |
Returns a string equivalent to the given signed 64 bit integer
value | the numeric value to convert |
std::string cugl::strtool::to_string | ( | Uint16 * | array, |
size_t | length, | ||
size_t | offset = 0 |
||
) |
Returns a string equivalent to the unsigned 16 bit integer array
The value is display as a python-style list in brackets.
array | the array to convert |
length | the array length |
offset | the starting position in the array |
std::string cugl::strtool::to_string | ( | Uint16 | value | ) |
Returns a string equivalent to the given unsigned 16 bit integer
value | the numeric value to convert |
std::string cugl::strtool::to_string | ( | Uint32 * | array, |
size_t | length, | ||
size_t | offset = 0 |
||
) |
Returns a string equivalent to the unsigned 32 bit integer array
The value is display as a python-style list in brackets.
array | the array to convert |
length | the array length |
offset | the starting position in the array |
std::string cugl::strtool::to_string | ( | Uint32 | value | ) |
Returns a string equivalent to the given unsigned 32 bit integer
value | the numeric value to convert |
std::string cugl::strtool::to_string | ( | Uint64 * | array, |
size_t | length, | ||
size_t | offset = 0 |
||
) |
Returns a string equivalent to the unsigned 64 bit integer array
The value is display as a python-style list in brackets.
array | the array to convert |
length | the array length |
offset | the starting position in the array |
std::string cugl::strtool::to_string | ( | Uint64 | value | ) |
Returns a string equivalent to the given unsigned 64 bit integer
value | the numeric value to convert |
std::string cugl::strtool::to_string | ( | Uint8 * | array, |
size_t | length, | ||
size_t | offset = 0 |
||
) |
Returns a string equivalent to the given byte array
The value is display as a python-style list in brackets.
array | the array to convert |
length | the array length |
offset | the starting position in the array |
std::string cugl::strtool::to_string | ( | Uint8 | value | ) |
Returns a string equivalent to the given byte
The value is displayed as a number, not a character.
value | the numeric value to convert |
std::string cugl::strtool::tolower | ( | std::string | str | ) |
Returns a lower case copy of str.
This function uses the current C++ locale.
str | The string to convert |
std::string cugl::strtool::toupper | ( | const std::string | str | ) |
Returns an upper case copy of str.
This function uses the current C++ locale.
str | The string to convert |
std::string cugl::strtool::trim | ( | const std::string | str | ) |
Returns a copy of str with any leading and trailing whitespace removed.
This function uses the current C++ locale.
str | The string to trim |