|
Vuo 2.4.4
|
A Unicode (UTF-8) text string.
Macros | |
| #define | VuoText_SUPPORTS_COMPARISON |
| Instances of this type can be compared and sorted. | |
| #define | VUOTEXT_FORMAT_ATTRIBUTE |
| Work around spurious Doxygen warning about VuoText_format() not being documented. | |
Typedefs | |
| typedef const char * | VuoText |
| A Unicode (UTF-8) text string. | |
Enumerations | |
| enum | VuoTextTruncation { VuoTextTruncation_Beginning , VuoTextTruncation_End } |
| Where to truncate text. More... | |
Functions | |
| VuoText | VuoText_makeFromJson (json_object *js) |
Decodes the JSON object js, expected to contain a UTF-8 string, to create a new value. | |
| json_object * | VuoText_getJson (const VuoText value) |
Encodes value as a JSON object. | |
| char * | VuoText_getSummary (const VuoText value) |
Creates a new UTF-8 C string from value, or, if it's more than 50 Unicode characters long, creates an aposiopesis. | |
| VuoText | VuoText_makeWithoutCopying (const char *string) |
| Creates a VuoText value from a UTF-8 C string. | |
| VuoText | VuoText_make (const char *string) |
| Creates a VuoText value from a UTF-8 C string. | |
| size_t | VuoText_length (const VuoText text) |
| Returns the number of Unicode characters in the text. | |
| bool | VuoText_isLessThan (const VuoText text1, const VuoText text2) |
| Returns true if text1 is ordered before text2 in a case-sensitive lexicographic ordering (which treats different UTF-8 encodings and Unicode character decompositions as equivalent). | |
| bool | VuoText_isLessThanCaseInsensitive (const VuoText text1, const VuoText text2) |
| Returns true if text1 is ordered before text2 in a case-insensitive lexicographic ordering (which treats different UTF-8 encodings and Unicode character decompositions as equivalent). | |
| bool | VuoText_isLessThanNumeric (const VuoText text1, const VuoText text2) |
| Returns true if the number in text1 is less than the number in text2. | |
| bool | VuoText_compare (VuoText text1, VuoTextComparison comparison, VuoText text2) |
| Returns true if text1 matches text2 based on comparison. | |
| size_t | VuoText_findFirstOccurrence (const VuoText string, const VuoText substring, const size_t startIndex) |
| Returns the index (starting at 1) of the first instance of substring in string at index >= startIndex. | |
| size_t | VuoText_findLastOccurrence (const VuoText string, const VuoText substring) |
| Returns the index (starting at 1) of the last instance of substring in string. | |
| VuoText | VuoText_substring (const VuoText string, int startIndex, int length) |
Returns the substring of string starting at index startIndex and spanning length Unicode characters. | |
| VuoText | VuoText_append (VuoText *texts, size_t textsCount) |
Returns a string consisting of the elements in the texts array concatenated together. | |
| VuoText | VuoText_appendWithSeparator (VuoList_VuoText texts, VuoText separator, bool includeEmptyParts) |
Returns a string consisting of the elements in texts array concatenated together, with separator between them. | |
| VuoText * | VuoText_split (VuoText text, VuoText separator, bool includeEmptyParts, size_t *partsCount) |
| Splits text into parts (basically the inverse of VuoText_append()). | |
| void | VuoText_performWithUTF8Locale (void(^function)(locale_t utf8Locale)) |
| Activates the UTF-8 locale and executes the specified block. | |
| void | VuoText_performWithSystemLocale (void(^function)(locale_t systemLocale)) |
| Activates the system locale and executes the specified block. | |
| VuoText | VuoText_makeWithMaxLength (const void *data, const size_t maxLength) |
| Creates a VuoText value by copying from an untrusted source (one that might not contain a NULL terminator within its memory page). | |
| VuoText | VuoText_makeFromCFString (const void *cfString) |
Creates a VuoText value by copying from a CFStringRef. | |
| VuoText | VuoText_makeFromData (const unsigned char *data, const unsigned long size) |
Attempts to interpret data as UTF-8 text, copying it to a VuoText value if it is valid UTF-8. | |
| VuoText | VuoText_makeFromUtf32 (const uint32_t *data, size_t length) |
| Create a VuoText value by copying from an array of UTF-32 values. | |
| VuoText | VuoText_makeFromMacRoman (const char *string) |
| Creates a VuoText value by copying from a MacRoman-encoded string. | |
| size_t | VuoText_byteCount (const VuoText text) |
| Returns the number of bytes in the text, not including the null terminator. | |
| bool | VuoText_isEmpty (const VuoText text) |
Returns true if text is empty (is NULL or is non-NULL with zero length). | |
| bool | VuoText_isPopulated (const VuoText text) |
Returns true if text is not empty. | |
| bool | VuoText_areEqual (const VuoText text1, const VuoText text2) |
| Returns true if the two texts represent the same Unicode string (even if they use different UTF-8 encodings or Unicode character decompositions). | |
| VuoList_VuoInteger | VuoText_findOccurrences (const VuoText string, const VuoText substring) |
Returns a list containing all occurrences of substring in string. | |
| VuoText | VuoText_insert (const VuoText string, int startIndex, const VuoText newText) |
Returns a new string with newText inserted at the startIndex. | |
| VuoText | VuoText_removeAt (const VuoText string, int startIndex, int length) |
Returns a new string where characters from startIndex to startIndex + length are removed. | |
| VuoText | VuoText_replace (VuoText subject, VuoText stringToFind, VuoText replacement) |
Returns a new string in which each occurrence of stringToFind in subject has been replaced with replacement. | |
| VuoText | VuoText_truncateWithEllipsis (const VuoText subject, int maxLength, VuoTextTruncation where) |
If subject is less than or equal to maxLength Unicode characters long, returns subject. | |
| VuoText | VuoText_trim (const VuoText text) |
Returns a new string consisting of text without the whitespace at the beginning and end. | |
| VuoText | VuoText_changeCase (const VuoText text, VuoTextCase textCase) |
Returns a new string with the text characters cased in the textCase style. | |
| uint32_t * | VuoText_getUtf32Values (const VuoText text, size_t *length) |
| Returns an array of unicode 32 bit decimal values for each character in a string. | |
| char * | VuoText_format (const char *format,...) VUOTEXT_FORMAT_ATTRIBUTE |
Returns a new string formatted using the printf-style format string. | |
| char * | VuoText_getString (const VuoText value) |
| Automatically generated function. | |
| void | VuoText_retain (VuoText value) |
| Automatically generated function. | |
| void | VuoText_release (VuoText value) |
| Automatically generated function. | |
| #define VUOTEXT_FORMAT_ATTRIBUTE |
Work around spurious Doxygen warning about VuoText_format() not being documented.
| #define VuoText_SUPPORTS_COMPARISON |
| enum VuoTextTruncation |
| VuoText VuoText_appendWithSeparator | ( | VuoList_VuoText | texts, |
| VuoText | separator, | ||
| bool | includeEmptyParts | ||
| ) |
| size_t VuoText_byteCount | ( | const VuoText | text | ) |
| VuoText VuoText_changeCase | ( | const VuoText | text, |
| VuoTextCase | textCase | ||
| ) |
| bool VuoText_compare | ( | VuoText | text1, |
| VuoTextComparison | comparison, | ||
| VuoText | text2 | ||
| ) |
| size_t VuoText_findFirstOccurrence | ( | const VuoText | string, |
| const VuoText | substring, | ||
| const size_t | startIndex | ||
| ) |
Returns the index (starting at 1) of the first instance of substring in string at index >= startIndex.
Returns 0 if substring is not found.
This function will find occurrences that consist of the same Unicode characters as substring, but won't find occurrences that consist of the same Unicode string decomposed into a different number of Unicode characters.
Returns the index (starting at 1) of the last instance of substring in string.
Returns 0 if substring is not found.
This function will find occurrences that consist of the same Unicode characters as substring, but won't find occurrences that consist of the same Unicode string decomposed into a different number of Unicode characters.
| VuoList_VuoInteger VuoText_findOccurrences | ( | const VuoText | string, |
| const VuoText | substring | ||
| ) |
Returns a list containing all occurrences of substring in string.
This function will find occurrences that consist of the same Unicode characters as substring, but won't find occurrences that consist of the same Unicode string decomposed into a different number of Unicode characters.
| char * VuoText_format | ( | const char * | format, |
| ... | |||
| ) |
| struct json_object * VuoText_getJson | ( | const VuoText | value | ) |
| char * VuoText_getString | ( | const VuoText | value | ) |
Automatically generated function.
| char * VuoText_getSummary | ( | const VuoText | value | ) |
| uint32_t * VuoText_getUtf32Values | ( | const VuoText | text, |
| size_t * | length | ||
| ) |
Returns an array of unicode 32 bit decimal values for each character in a string.
If conversion fails, length will be set to 0 null is returned. Otherwise an array is returned and length is set to the size of the array. Caller is responsible for freeing the returned array.
Returns a new string with newText inserted at the startIndex.
startIndex is 1 indexed, not 0. If startIndex is less than 1, newText is inserted at the beginning of string. If startIndex is greater than string length, newText is appended to the ending of string.
| bool VuoText_isEmpty | ( | const VuoText | text | ) |
| bool VuoText_isPopulated | ( | const VuoText | text | ) |
| size_t VuoText_length | ( | const VuoText | text | ) |
| VuoText VuoText_make | ( | const char * | string | ) |
| VuoText VuoText_makeFromCFString | ( | const void * | cfString | ) |
| VuoText VuoText_makeFromData | ( | const unsigned char * | data, |
| const unsigned long | size | ||
| ) |
| VuoText VuoText_makeFromJson | ( | json_object * | js | ) |
| VuoText VuoText_makeFromMacRoman | ( | const char * | string | ) |
| VuoText VuoText_makeFromUtf32 | ( | const uint32_t * | data, |
| size_t | size | ||
| ) |
| VuoText VuoText_makeWithMaxLength | ( | const void * | data, |
| const size_t | maxLength | ||
| ) |
Creates a VuoText value by copying from an untrusted source (one that might not contain a NULL terminator within its memory page).
Use this, for example, to safely handle a string that's part of a network packet.
If data ends with a NULL terminator, this function simply copies it into a new VuoText instance.
If data does not end with a NULL terminator, this function scans up to maxLength bytes in data. If it finds a NULL terminator, it returns text up to and including the NULL terminator. If it doesn't find a NULL terminator, it returns maxLength characters followed by a NULL terminator.
If data is in a multi-byte UTF8 character sequence when maxLength is reached, the sequence will be terminated partway, probably resulting in an invalid UTF8 sequence.
| VuoText VuoText_makeWithoutCopying | ( | const char * | string | ) |
| void VuoText_performWithSystemLocale | ( | void(^)(locale_t systemLocale) | function | ) |
| void VuoText_performWithUTF8Locale | ( | void(^)(locale_t utf8Locale) | function | ) |
| void VuoText_release | ( | VuoText | value | ) |
Automatically generated function.
| void VuoText_retain | ( | VuoText | value | ) |
Automatically generated function.
| VuoText * VuoText_split | ( | VuoText | text, |
| VuoText | separator, | ||
| bool | includeEmptyParts, | ||
| size_t * | partsCount | ||
| ) |
Splits text into parts (basically the inverse of VuoText_append()).
Returns the substring of string starting at index startIndex and spanning length Unicode characters.
startIndex is indexed from 1, not 0.
If startIndex is past the end of string, returns the empty string.
If startIndex is before the beginning of string, deducts the number of characters before the beginning from length, and returns characters starting at the beginning of string.
If string has fewer than length characters from startIndex to the end of string, returns all characters from startIndex to the end of string.
Returns a new string consisting of text without the whitespace at the beginning and end.
This function trims ASCII spaces, tabs, and linebreaks, but not other Unicode whitespace characters.
| VuoText VuoText_truncateWithEllipsis | ( | const VuoText | subject, |
| int | maxLength, | ||
| VuoTextTruncation | where | ||
| ) |
1.9.8