diff options
author | Michael Stahl <mstahl@redhat.com> | 2012-01-28 20:57:40 +0100 |
---|---|---|
committer | Michael Stahl <mstahl@redhat.com> | 2012-01-28 20:57:40 +0100 |
commit | 2716f7dce26f16a2b677c178aa7d01cea096ae47 (patch) | |
tree | 9e9f67205cd5b72f1031721273e1534a3a1e5b0f /sal/inc/rtl/ustring.h | |
parent | 10ac9e750447fd57e3cef7993b0ad6c6538d6269 (diff) |
replace obsolete "master" branch with README that points at new repoHEADmaster-deletedmaster
Diffstat (limited to 'sal/inc/rtl/ustring.h')
-rw-r--r-- | sal/inc/rtl/ustring.h | 1663 |
1 files changed, 0 insertions, 1663 deletions
diff --git a/sal/inc/rtl/ustring.h b/sal/inc/rtl/ustring.h deleted file mode 100644 index e52242d68..000000000 --- a/sal/inc/rtl/ustring.h +++ /dev/null @@ -1,1663 +0,0 @@ -/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2000, 2010 Oracle and/or its affiliates. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * This file is part of OpenOffice.org. - * - * OpenOffice.org is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License version 3 - * only, as published by the Free Software Foundation. - * - * OpenOffice.org is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License version 3 for more details - * (a copy is included in the LICENSE file that accompanied this code). - * - * You should have received a copy of the GNU Lesser General Public License - * version 3 along with OpenOffice.org. If not, see - * <http://www.openoffice.org/license.html> - * for a copy of the LGPLv3 License. - * - ************************************************************************/ - -#ifndef _RTL_USTRING_H_ -#define _RTL_USTRING_H_ - -#include <sal/types.h> -#include <osl/interlck.h> -#include <rtl/string.h> -#include <rtl/textenc.h> - -#ifdef __cplusplus -extern "C" { -#endif - -/* ======================================================================= */ - -/** Return the length of a string. - - The length is equal to the number of 16-bit Unicode characters in the - string, without the terminating NUL character. - - @param str - a null-terminated string. - - @return - the length of the sequence of characters represented by this string, - excluding the terminating NUL character. - */ -sal_Int32 SAL_CALL rtl_ustr_getLength( const sal_Unicode * str ) SAL_THROW_EXTERN_C(); - -/** Compare two strings. - - The comparison is based on the numeric value of each character in the - strings and returns a value indicating their relationship. This function - cannot be used for language-specific sorting. Both strings must be - null-terminated. - - @param first - the first null-terminated string to be compared. - - @param second - the second null-terminated string which is compared with the first one. - - @return - 0 if both strings are equal, a value less than 0 if the first string is - less than the second string, and a value greater than 0 if the first - string is greater than the second string. - */ -sal_Int32 SAL_CALL rtl_ustr_compare( const sal_Unicode * first, const sal_Unicode * second ) SAL_THROW_EXTERN_C(); - -/** Compare two strings. - - The comparison is based on the numeric value of each character in the - strings and returns a value indicating their relationship. This function - cannot be used for language-specific sorting. - - @param first - the first string to be compared. Need not be null-terminated, but must be - at least as long as the specified firstLen. - - @param firstLen - the length of the first string. - - @param second - the second string which is compared with the first one. Need not be - null-terminated, but must be at least as long as the specified secondLen. - - @param secondLen - the length of the second string. - - @return - 0 if both strings are equal, a value less than 0 if the first string is - less than the second string, and a value greater than 0 if the first - string is greater than the second string. - */ -sal_Int32 SAL_CALL rtl_ustr_compare_WithLength( const sal_Unicode * first, sal_Int32 firstLen, const sal_Unicode * second, sal_Int32 secondLen ) SAL_THROW_EXTERN_C(); - -/** Compare two strings with a maximum count of characters. - - The comparison is based on the numeric value of each character in the - strings and returns a value indicating their relationship. This function - cannot be used for language-specific sorting. - - @param first - the first string to be compared. Need not be null-terminated, but must be - at least as long as the specified firstLen. - - @param firstLen - the length of the first string. - - @param second - the second string which is compared with the first one. Need not be - null-terminated, but must be at least as long as the specified secondLen. - - @param secondLen - the length of the second string. - - @param shortenedLen - the maximum number of characters to compare. This length can be greater - or smaller than the lengths of the two strings. - - @return - 0 if both substrings are equal, a value less than 0 if the first substring - is less than the second substring, and a value greater than 0 if the first - substring is greater than the second substring. - */ -sal_Int32 SAL_CALL rtl_ustr_shortenedCompare_WithLength( const sal_Unicode * first, sal_Int32 firstLen, const sal_Unicode * second, sal_Int32 secondLen, sal_Int32 shortenedLen ) SAL_THROW_EXTERN_C(); - -/** Compare two strings from back to front. - - The comparison is based on the numeric value of each character in the - strings and returns a value indicating their relationship. This function - cannot be used for language-specific sorting. - - @param first - the first string to be compared. Need not be null-terminated, but must be - at least as long as the specified firstLen. - - @param firstLen - the length of the first string. - - @param second - the second string which is compared with the first one. Need not be - null-terminated, but must be at least as long as the specified secondLen. - - @param secondLen - the length of the second string. - - @return - 0 if both strings are equal, a value less than 0 if the first string - compares less than the second string, and a value greater than 0 if the - first string compares greater than the second string. - */ -sal_Int32 SAL_CALL rtl_ustr_reverseCompare_WithLength( const sal_Unicode * first, sal_Int32 firstLen, const sal_Unicode * second, sal_Int32 secondLen ) SAL_THROW_EXTERN_C(); - -/** Compare two strings from back to front for equality. - - The comparison is based on the numeric value of each character in the - strings and returns 'true' if, ans only if, both strings are equal. - This function cannot be used for language-specific sorting. - - @param first - the first string to be compared. Need not be null-terminated, but must be - at least as long as the specified len. - - @param second - the second string which is compared with the first one. Need not be - null-terminated, but must be at least as long as the specified len. - - @param len - the length of both strings. - - @return - true if both strings are equal, false if they are not equal. - */ - -sal_Bool SAL_CALL rtl_ustr_asciil_reverseEquals_WithLength( const sal_Unicode * first, const sal_Char * second, sal_Int32 len ) SAL_THROW_EXTERN_C(); - -/** Compare two strings, ignoring the case of ASCII characters. - - The comparison is based on the numeric value of each character in the - strings and returns a value indicating their relationship. Character - values between 65 and 90 (ASCII A--Z) are interpreted as values between 97 - and 122 (ASCII a--z). This function cannot be used for language-specific - sorting. Both strings must be null-terminated. - - @param first - the first null-terminated string to be compared. - - @param second - the second null-terminated string which is compared with the first one. - - @return - 0 if both strings are equal, a value less than 0 if the first string is - less than the second string, and a value greater than 0 if the first - string is greater than the second string. - */ -sal_Int32 SAL_CALL rtl_ustr_compareIgnoreAsciiCase( const sal_Unicode * first, const sal_Unicode * second ) SAL_THROW_EXTERN_C(); - -/** Compare two strings, ignoring the case of ASCII characters. - - The comparison is based on the numeric value of each character in the - strings and returns a value indicating their relationship. Character - values between 65 and 90 (ASCII A--Z) are interpreted as values between 97 - and 122 (ASCII a--z). This function cannot be used for language-specific - sorting. - - @param first - the first string to be compared. Need not be null-terminated, but must be - at least as long as the specified firstLen. - - @param firstLen - the length of the first string. - - @param second - the second string which is compared with the first one. Need not be - null-terminated, but must be at least as long as the specified secondLen. - - @param secondLen - the length of the second string. - - @return - 0 if both strings are equal, a value less than 0 if the first string is - less than the second string, and a value greater than 0 if the first - string is greater than the second string. - */ -sal_Int32 SAL_CALL rtl_ustr_compareIgnoreAsciiCase_WithLength( const sal_Unicode * first, sal_Int32 firstLen, const sal_Unicode * second, sal_Int32 secondLen ) SAL_THROW_EXTERN_C(); - -/** Compare two strings with a maximum count of characters, ignoring the case - of ASCII characters. - - The comparison is based on the numeric value of each character in the - strings and returns a value indicating their relationship. Character - values between 65 and 90 (ASCII A--Z) are interpreted as values between 97 - and 122 (ASCII a--z). This function cannot be used for language-specific - sorting. - - @param first - the first string to be compared. Need not be null-terminated, but must be - at least as long as the specified firstLen. - - @param firstLen - the length of the first string. - - @param second - the second string which is compared with the first one. Need not be - null-terminated, but must be at least as long as the specified secondLen. - - @param secondLen - the length of the second string. - - @param shortenedLen - the maximum number of characters to compare. This length can be greater - or smaller than the lengths of the two strings. - - @return - 0 if both substrings are equal, a value less than 0 if the first substring - is less than the second substring, and a value greater than 0 if the first - substring is greater than the second substring. - */ -sal_Int32 SAL_CALL rtl_ustr_shortenedCompareIgnoreAsciiCase_WithLength( const sal_Unicode * first, sal_Int32 firstLen, const sal_Unicode * second, sal_Int32 secondLen, sal_Int32 shortenedLen ) SAL_THROW_EXTERN_C(); - -/** Compare two strings. - - The comparison is based on the numeric value of each character in the - strings and returns a value indicating their relationship. This function - cannot be used for language-specific sorting. Both strings must be - null-terminated. - - Since this function is optimized for performance, the ASCII character - values are not converted in any way. The caller has to make sure that - all ASCII characters are in the allowed range of 0 and 127, inclusive. - - @param first - the first null-terminated string to be compared. - - @param second - the second null-terminated ASCII string which is compared with the first - one. - - @return - 0 if both substrings are equal, a value less than 0 if the first substring - is less than the second substring, and a value greater than 0 if the first - substring is greater than the second substring. - */ -sal_Int32 SAL_CALL rtl_ustr_ascii_compare( const sal_Unicode * first, const sal_Char * second ) SAL_THROW_EXTERN_C(); - -/** Compare two strings. - - The comparison is based on the numeric value of each character in the - strings and returns a value indicating their relationship. This function - cannot be used for language-specific sorting. - - Since this function is optimized for performance, the ASCII character - values are not converted in any way. The caller has to make sure that - all ASCII characters are in the allowed range of 0 and 127, inclusive. - - @param first - the first string to be compared. Need not be null-terminated, but must be - at least as long as the specified firstLen. - - @param firstLen - the length of the first string. - - @param second - the second null-terminated ASCII string which is compared with the first - one. - - @return - 0 if both substrings are equal, a value less than 0 if the first substring - is less than the second substring, and a value greater than 0 if the first - substring is greater than the second substring. - */ -sal_Int32 SAL_CALL rtl_ustr_ascii_compare_WithLength( const sal_Unicode * first, sal_Int32 firstLen, const sal_Char * second ) SAL_THROW_EXTERN_C(); - -/** Compare two strings with a maximum count of characters. - - The comparison is based on the numeric value of each character in the - strings and returns a value indicating their relationship. This function - cannot be used for language-specific sorting. - - Since this function is optimized for performance, the ASCII character - values are not converted in any way. The caller has to make sure that - all ASCII characters are in the allowed range of 0 and 127, inclusive. - - @param first - the first string to be compared. Need not be null-terminated, but must be - at least as long as the specified firstLen. - - @param firstLen - the length of the first string. - - @param second - the second null-terminated ASCII string which is compared with the first - one. - - @param shortenedLen - the maximum number of characters to compare. This length can be greater - or smaller than the lengths of the two strings. - - @return - 0 if both substrings are equal, a value less than 0 if the first substring - is less than the second substring, and a value greater than 0 if the first - substring is greater than the second substring. - */ -sal_Int32 SAL_CALL rtl_ustr_ascii_shortenedCompare_WithLength( const sal_Unicode * first, sal_Int32 firstLen, const sal_Char * second, sal_Int32 shortenedLen ) SAL_THROW_EXTERN_C(); - -/** Compare two strings from back to front. - - The comparison is based on the numeric value of each character in the - strings and returns a value indicating their relationship. This function - cannot be used for language-specific sorting. - - Since this function is optimized for performance, the ASCII character - values are not converted in any way. The caller has to make sure that - all ASCII characters are in the allowed range of 0 and 127, inclusive. - - @param first - the first string to be compared. Need not be null-terminated, but must be - at least as long as the specified firstLen. - - @param firstLen - the length of the first string. - - @param second - the second ASCII string which is compared with the first one. Need not be - null-terminated, but must be at least as long as the specified secondLen. - - @param secondLen - the length of the second string. - - @return - 0 if both strings are equal, a value less than 0 if the first string - compares less than the second string, and a value greater than 0 if the - first string compares greater than the second string. - */ -sal_Int32 SAL_CALL rtl_ustr_asciil_reverseCompare_WithLength( const sal_Unicode * first, sal_Int32 firstLen, const sal_Char * second, sal_Int32 secondLen ) SAL_THROW_EXTERN_C(); - -/** Compare two strings, ignoring the case of ASCII characters. - - The comparison is based on the numeric value of each character in the - strings and returns a value indicating their relationship. Character - values between 65 and 90 (ASCII A--Z) are interpreted as values between 97 - and 122 (ASCII a--z). This function cannot be used for language-specific - sorting. Both strings must be null-terminated. - - Since this function is optimized for performance, the ASCII character - values are not converted in any way. The caller has to make sure that - all ASCII characters are in the allowed range of 0 and 127, inclusive. - - @param first - the first null-terminated string to be compared. - - @param second - the second null-terminated ASCII string which is compared with the first - one. - - @return - 0 if both strings are equal, a value less than 0 if the first string is - less than the second string, and a value greater than 0 if the first - string is greater than the second string. - */ -sal_Int32 SAL_CALL rtl_ustr_ascii_compareIgnoreAsciiCase( const sal_Unicode * first, const sal_Char * second ) SAL_THROW_EXTERN_C(); - -/** Compare two strings, ignoring the case of ASCII characters. - - The comparison is based on the numeric value of each character in the - strings and returns a value indicating their relationship. Character - values between 65 and 90 (ASCII A--Z) are interpreted as values between 97 - and 122 (ASCII a--z). This function cannot be used for language-specific - sorting. - - Since this function is optimized for performance, the ASCII character - values are not converted in any way. The caller has to make sure that - all ASCII characters are in the allowed range of 0 and 127, inclusive. - - @param first - the first string to be compared. Need not be null-terminated, but must be - at least as long as the specified firstLen. - - @param firstLen - the length of the first string. - - @param second - the second null-terminated ASCII string which is compared with the first - one. - - @return - 0 if both strings are equal, a value less than 0 if the first string is - less than the second string, and a value greater than 0 if the first - string is greater than the second string. - */ -sal_Int32 SAL_CALL rtl_ustr_ascii_compareIgnoreAsciiCase_WithLength( const sal_Unicode * first, sal_Int32 firstLen, const sal_Char * second ) SAL_THROW_EXTERN_C(); - -/** Compare two strings, ignoring the case of ASCII characters. - - The comparison is based on the numeric value of each character in the - strings and returns a value indicating their relationship. Character - values between 65 and 90 (ASCII A--Z) are interpreted as values between 97 - and 122 (ASCII a--z). This function cannot be used for language-specific - sorting. - - Since this function is optimized for performance, the ASCII character - values are not converted in any way. The caller has to make sure that - all ASCII characters are in the allowed range of 0 and 127, inclusive. - - @param first - the first string to be compared. Need not be null-terminated, but must be - at least as long as the specified firstLen. - - @param firstLen - the length of the first string. - - @param second - the second string which is compared with the first one. Need not be - null-terminated, but must be at least as long as the specified secondLen. - - @param secondLen - the length of the second string. - - @return - 0 if both strings are equal, a value less than 0 if the first string is - less than the second string, and a value greater than 0 if the first - string is greater than the second string. - */ -sal_Int32 SAL_CALL rtl_ustr_ascii_compareIgnoreAsciiCase_WithLengths( - sal_Unicode const * first, sal_Int32 firstLen, - char const * second, sal_Int32 secondLen) SAL_THROW_EXTERN_C(); - -/** Compare two strings with a maximum count of characters, ignoring the case - of ASCII characters. - - The comparison is based on the numeric value of each character in the - strings and returns a value indicating their relationship. Character - values between 65 and 90 (ASCII A--Z) are interpreted as values between 97 - and 122 (ASCII a--z). This function cannot be used for language-specific - sorting. - - Since this function is optimized for performance, the ASCII character - values are not converted in any way. The caller has to make sure that - all ASCII characters are in the allowed range of 0 and 127, inclusive. - - @param first - the first string to be compared. Need not be null-terminated, but must be - at least as long as the specified firstLen. - - @param firstLen - the length of the first string. - - @param second - the second null-terminated ASCII string which is compared with the first - one. - - @param shortenedLen - the maximum number of characters to compare. This length can be greater - or smaller than the lengths of the two strings. - - @return - 0 if both substrings are equal, a value less than 0 if the first substring - is less than the second substring, and a value greater than 0 if the first - substring is greater than the second substring. - */ -sal_Int32 SAL_CALL rtl_ustr_ascii_shortenedCompareIgnoreAsciiCase_WithLength( const sal_Unicode * first, sal_Int32 firstLen, const sal_Char * second, sal_Int32 shortenedLen ) SAL_THROW_EXTERN_C(); - -/** Return a hash code for a string. - - It is not allowed to store the hash code persistently, because later - versions could return other hash codes. The string must be - null-terminated. - - @param str - a null-terminated string. - - @return - a hash code for the given string. - */ -sal_Int32 SAL_CALL rtl_ustr_hashCode( const sal_Unicode * str ) SAL_THROW_EXTERN_C(); - -/** Return a hash code for a string. - - It is not allowed to store the hash code persistently, because later - versions could return other hash codes. - - @param str - a string. Need not be null-terminated, but must be at least as long as - the specified len. - - @param len - the length of the string. - - @return - a hash code for the given string. - */ -sal_Int32 SAL_CALL rtl_ustr_hashCode_WithLength( const sal_Unicode * str, sal_Int32 len ) SAL_THROW_EXTERN_C(); - -/** Search for the first occurrence of a character within a string. - - The string must be null-terminated. - - @param str - a null-terminated string. - - @param ch - the character to be searched for. - - @return - the index (starting at 0) of the first occurrence of the character in the - string, or -1 if the character does not occur. - */ -sal_Int32 SAL_CALL rtl_ustr_indexOfChar( const sal_Unicode * str, sal_Unicode ch ) SAL_THROW_EXTERN_C(); - -/** Search for the first occurrence of a character within a string. - - @param str - a string. Need not be null-terminated, but must be at least as long as - the specified len. - - @param len - the length of the string. - - @param ch - the character to be searched for. - - @return - the index (starting at 0) of the first occurrence of the character in the - string, or -1 if the character does not occur. - */ -sal_Int32 SAL_CALL rtl_ustr_indexOfChar_WithLength( const sal_Unicode * str, sal_Int32 len, sal_Unicode ch ) SAL_THROW_EXTERN_C(); - -/** Search for the last occurrence of a character within a string. - - The string must be null-terminated. - - @param str - a null-terminated string. - - @param ch - the character to be searched for. - - @return - the index (starting at 0) of the last occurrence of the character in the - string, or -1 if the character does not occur. The returned value is - always smaller than the string length. - */ -sal_Int32 SAL_CALL rtl_ustr_lastIndexOfChar( const sal_Unicode * str, sal_Unicode ch ) SAL_THROW_EXTERN_C(); - -/** Search for the last occurrence of a character within a string. - - @param str - a string. Need not be null-terminated, but must be at least as long as - the specified len. - - @param len - the length of the string. - - @param ch - the character to be searched for. - - @return - the index (starting at 0) of the last occurrence of the character in the - string, or -1 if the character does not occur. The returned value is - always smaller than the string length. - */ -sal_Int32 SAL_CALL rtl_ustr_lastIndexOfChar_WithLength( const sal_Unicode * str, sal_Int32 len, sal_Unicode ch ) SAL_THROW_EXTERN_C(); - -/** Search for the first occurrence of a substring within a string. - - If subStr is empty, or both str and subStr are empty, -1 is returned. - Both strings must be null-terminated. - - @param str - a null-terminated string. - - @param subStr - the null-terminated substring to be searched for. - - @return - the index (starting at 0) of the first character of the first occurrence - of the substring within the string, or -1 if the substring does not occur. - */ -sal_Int32 SAL_CALL rtl_ustr_indexOfStr( const sal_Unicode * str, const sal_Unicode * subStr ) SAL_THROW_EXTERN_C(); - -/** Search for the first occurrence of a substring within a string. - - If subStr is empty, or both str and subStr are empty, -1 is returned. - - @param str - a string. Need not be null-terminated, but must be at least as long as - the specified len. - - @param len - the length of the string. - - @param subStr - the substring to be searched for. Need not be null-terminated, but must - be at least as long as the specified subLen. - - @param subLen - the length of the substring. - - @return - the index (starting at 0) of the first character of the first occurrence - of the substring within the string, or -1 if the substring does not occur. - */ -sal_Int32 SAL_CALL rtl_ustr_indexOfStr_WithLength( const sal_Unicode * str, sal_Int32 len, const sal_Unicode * subStr, sal_Int32 subLen ) SAL_THROW_EXTERN_C(); - -/** Search for the first occurrence of an ASCII substring within a string. - - @param str - a string. Need not be null-terminated, but must be at least as long as - the specified len. - - @param len - the length of the string; must be non-negative. - - @param subStr - the substring to be searched for. Need not be null-terminated, but must - be at least as long as the specified subLen. Must only contain characters - in the ASCII range 0x00--7F. - - @param subLen - the length of the substring; must be non-negative. - - @return - the index (starting at 0) of the first character of the first occurrence - of the substring within the string, or -1 if the substring does not occur. - If subLen is zero, -1 is returned. - - @since UDK 3.2.7 -*/ -sal_Int32 SAL_CALL rtl_ustr_indexOfAscii_WithLength( - sal_Unicode const * str, sal_Int32 len, - char const * subStr, sal_Int32 subLen) SAL_THROW_EXTERN_C(); - -/** Search for the last occurrence of a substring within a string. - - If subStr is empty, or both str and subStr are empty, -1 is returned. - Both strings must be null-terminated. - - @param str - a null-terminated string. - - @param subStr - the null-terminated substring to be searched for. - - @return - the index (starting at 0) of the first character of the last occurrence - of the substring within the string, or -1 if the substring does not occur. - */ -sal_Int32 SAL_CALL rtl_ustr_lastIndexOfStr( const sal_Unicode * str, const sal_Unicode * subStr ) SAL_THROW_EXTERN_C(); - -/** Search for the last occurrence of a substring within a string. - - If subStr is empty, or both str and subStr are empty, -1 is returned. - - @param str - a string. Need not be null-terminated, but must be at least as long as - the specified len. - - @param len - the length of the string. - - @param subStr - the substring to be searched for. Need not be null-terminated, but must - be at least as long as the specified subLen. - - @param subLen - the length of the substring. - - @return - the index (starting at 0) of the first character of the first occurrence - of the substring within the string, or -1 if the substring does not occur. - */ -sal_Int32 SAL_CALL rtl_ustr_lastIndexOfStr_WithLength( const sal_Unicode * str, sal_Int32 len, const sal_Unicode * subStr, sal_Int32 subLen ) SAL_THROW_EXTERN_C(); - -/** Search for the last occurrence of an ASCII substring within a string. - - @param str - a string. Need not be null-terminated, but must be at least as long as - the specified len. - - @param len - the length of the string; must be non-negative. - - @param subStr - the substring to be searched for. Need not be null-terminated, but must - be at least as long as the specified subLen. Must only contain characters - in the ASCII range 0x00--7F. - - @param subLen - the length of the substring; must be non-negative. - - @return - the index (starting at 0) of the first character of the last occurrence - of the substring within the string, or -1 if the substring does not occur. - If subLen is zero, -1 is returned. - - @since UDK 3.2.7 -*/ -sal_Int32 SAL_CALL rtl_ustr_lastIndexOfAscii_WithLength( - sal_Unicode const * str, sal_Int32 len, - char const * subStr, sal_Int32 subLen) SAL_THROW_EXTERN_C(); - -/** Replace all occurrences of a single character within a string. - - If oldChar does not occur within str, then the string is not modified. - The string must be null-terminated. - - @param str - a null-terminated string. - - @param oldChar - the old character. - - @param newChar - the new character. - */ -void SAL_CALL rtl_ustr_replaceChar( sal_Unicode * str, sal_Unicode oldChar, sal_Unicode newChar ) SAL_THROW_EXTERN_C(); - -/** Replace all occurrences of a single character within a string. - - If oldChar does not occur within str, then the string is not modified. - - @param str - a string. Need not be null-terminated, but must be at least as long as - the specified len. - - @param len - the length of the string. - - @param oldChar - the old character. - - @param newChar - the new character. - */ -void SAL_CALL rtl_ustr_replaceChar_WithLength( sal_Unicode * str, sal_Int32 len, sal_Unicode oldChar, sal_Unicode newChar ) SAL_THROW_EXTERN_C(); - -/** Convert all ASCII uppercase letters to lowercase within a string. - - The characters with values between 65 and 90 (ASCII A--Z) are replaced - with values between 97 and 122 (ASCII a--z). The string must be - null-terminated. - - @param str - a null-terminated string. - */ -void SAL_CALL rtl_ustr_toAsciiLowerCase( sal_Unicode * str ) SAL_THROW_EXTERN_C(); - -/** Convert all ASCII uppercase letters to lowercase within a string. - - The characters with values between 65 and 90 (ASCII A--Z) are replaced - with values between 97 and 122 (ASCII a--z). - - @param str - a string. Need not be null-terminated, but must be at least as long as - the specified len. - - @param len - the length of the string. - */ -void SAL_CALL rtl_ustr_toAsciiLowerCase_WithLength( sal_Unicode * str, sal_Int32 len ) SAL_THROW_EXTERN_C(); - -/** Convert all ASCII lowercase letters to uppercase within a string. - - The characters with values between 97 and 122 (ASCII a--z) are replaced - with values between 65 and 90 (ASCII A--Z). The string must be - null-terminated. - - @param str - a null-terminated string. - */ -void SAL_CALL rtl_ustr_toAsciiUpperCase( sal_Unicode * str ) SAL_THROW_EXTERN_C(); - -/** Convert all ASCII lowercase letters to uppercase within a string. - - The characters with values between 97 and 122 (ASCII a--z) are replaced - with values between 65 and 90 (ASCII A--Z). - - @param str - a string. Need not be null-terminated, but must be at least as long as - the specified len. - - @param len - the length of the string. - */ -void SAL_CALL rtl_ustr_toAsciiUpperCase_WithLength( sal_Unicode * str, sal_Int32 len ) SAL_THROW_EXTERN_C(); - -/** Remove white space from both ends of a string. - - All characters with values less than or equal to 32 (the space character) - are considered to be white space. This function cannot be used for - language-specific operations. The string must be null-terminated. - - @param str - a null-terminated string. - - @return - the new length of the string. - */ -sal_Int32 SAL_CALL rtl_ustr_trim( sal_Unicode * str ) SAL_THROW_EXTERN_C(); - -/** Remove white space from both ends of the string. - - All characters with values less than or equal to 32 (the space character) - are considered to be white space. This function cannot be used for - language-specific operations. The string must be null-terminated. - - @param str - a string. Need not be null-terminated, but must be at least as long as - the specified len. - - @param len - the original length of the string. - - @return - the new length of the string. - */ -sal_Int32 SAL_CALL rtl_ustr_trim_WithLength( sal_Unicode * str, sal_Int32 len ) SAL_THROW_EXTERN_C(); - -/** Create the string representation of a boolean. - - If b is true, the buffer is filled with the string "true" and 5 is - returned. If b is false, the buffer is filled with the string "false" and - 6 is returned. This function cannot be used for language-specific - operations. - - @param str - a buffer that is big enough to hold the result and the terminating NUL - character. You should use the RTL_USTR_MAX_VALUEOFBOOLEAN define to - create a buffer that is big enough. - - @param b - a boolean value. - - @return - the length of the string. - */ -sal_Int32 SAL_CALL rtl_ustr_valueOfBoolean( sal_Unicode * str, sal_Bool b ) SAL_THROW_EXTERN_C(); -#define RTL_USTR_MAX_VALUEOFBOOLEAN RTL_STR_MAX_VALUEOFBOOLEAN - -/** Create the string representation of a character. - - @param str - a buffer that is big enough to hold the result and the terminating NUL - character. You should use the RTL_USTR_MAX_VALUEOFCHAR define to create a - buffer that is big enough. - - @param ch - a character value. - - @return - the length of the string. - */ -sal_Int32 SAL_CALL rtl_ustr_valueOfChar( sal_Unicode * str, sal_Unicode ch ) SAL_THROW_EXTERN_C(); -#define RTL_USTR_MAX_VALUEOFCHAR RTL_STR_MAX_VALUEOFCHAR - -/** Create the string representation of an integer. - - This function cannot be used for language-specific operations. - - @param str - a buffer that is big enough to hold the result and the terminating NUL - character. You should use the RTL_USTR_MAX_VALUEOFINT32 define to create - a buffer that is big enough. - - @param i - an integer value. - - @param radix - the radix. Must be between RTL_USTR_MIN_RADIX (2) and RTL_USTR_MAX_RADIX - (36), inclusive. - - @return - the length of the string. - */ -sal_Int32 SAL_CALL rtl_ustr_valueOfInt32( sal_Unicode * str, sal_Int32 i, sal_Int16 radix ) SAL_THROW_EXTERN_C(); -#define RTL_USTR_MIN_RADIX RTL_STR_MIN_RADIX -#define RTL_USTR_MAX_RADIX RTL_STR_MAX_RADIX -#define RTL_USTR_MAX_VALUEOFINT32 RTL_STR_MAX_VALUEOFINT32 - -/** Create the string representation of a long integer. - - This function cannot be used for language-specific operations. - - @param str - a buffer that is big enough to hold the result and the terminating NUL - character. You should use the RTL_USTR_MAX_VALUEOFINT64 define to create - a buffer that is big enough. - - @param l - a long integer value. - - @param radix - the radix. Must be between RTL_USTR_MIN_RADIX (2) and RTL_USTR_MAX_RADIX - (36), inclusive. - - @return - the length of the string. - */ -sal_Int32 SAL_CALL rtl_ustr_valueOfInt64( sal_Unicode * str, sal_Int64 l, sal_Int16 radix ) SAL_THROW_EXTERN_C(); -#define RTL_USTR_MAX_VALUEOFINT64 RTL_STR_MAX_VALUEOFINT64 - -/** Create the string representation of a float. - - This function cannot be used for language-specific conversion. - - @param str - a buffer that is big enough to hold the result and the terminating NUL - character. You should use the RTL_USTR_MAX_VALUEOFFLOAT define to create - a buffer that is big enough. - - @param f - a float value. - - @return - the length of the string. - */ -sal_Int32 SAL_CALL rtl_ustr_valueOfFloat( sal_Unicode * str, float f ) SAL_THROW_EXTERN_C(); -#define RTL_USTR_MAX_VALUEOFFLOAT RTL_STR_MAX_VALUEOFFLOAT - -/** Create the string representation of a double. - - This function cannot be used for language-specific conversion. - - @param str - a buffer that is big enough to hold the result and the terminating NUL - character. You should use the RTL_USTR_MAX_VALUEOFDOUBLE define to create - a buffer that is big enough. - - @param d - a double value. - - @return - the length of the string. - */ -sal_Int32 SAL_CALL rtl_ustr_valueOfDouble( sal_Unicode * str, double d ) SAL_THROW_EXTERN_C(); -#define RTL_USTR_MAX_VALUEOFDOUBLE RTL_STR_MAX_VALUEOFDOUBLE - -/** Interpret a string as a boolean. - - This function cannot be used for language-specific conversion. The string - must be null-terminated. - - @param str - a null-terminated string. - - @return - true if the string is "1" or "true" in any ASCII case, false otherwise. - */ -sal_Bool SAL_CALL rtl_ustr_toBoolean( const sal_Unicode * str ) SAL_THROW_EXTERN_C(); - -/** Interpret a string as an integer. - - This function cannot be used for language-specific conversion. The string - must be null-terminated. - - @param str - a null-terminated string. - - @param radix - the radix. Must be between RTL_USTR_MIN_RADIX (2) and RTL_USTR_MAX_RADIX - (36), inclusive. - - @return - the integer value represented by the string, or 0 if the string does not - represent an integer. - */ -sal_Int32 SAL_CALL rtl_ustr_toInt32( const sal_Unicode * str, sal_Int16 radix ) SAL_THROW_EXTERN_C(); - -/** Interpret a string as a long integer. - - This function cannot be used for language-specific conversion. The string - must be null-terminated. - - @param str - a null-terminated string. - - @param radix - the radix. Must be between RTL_USTR_MIN_RADIX (2) and RTL_USTR_MAX_RADIX - (36), inclusive. - - @return - the long integer value represented by the string, or 0 if the string does - not represent a long integer. - */ -sal_Int64 SAL_CALL rtl_ustr_toInt64( const sal_Unicode * str, sal_Int16 radix ) SAL_THROW_EXTERN_C(); - -/** Interpret a string as a float. - - This function cannot be used for language-specific conversion. The string - must be null-terminated. - - @param str - a null-terminated string. - - @return - the float value represented by the string, or 0.0 if the string does not - represent a float. - */ -float SAL_CALL rtl_ustr_toFloat( const sal_Unicode * str ) SAL_THROW_EXTERN_C(); - -/** Interpret a string as a double. - - This function cannot be used for language-specific conversion. The string - must be null-terminated. - - @param str - a null-terminated string. - - @return - the float value represented by the string, or 0.0 if the string does not - represent a double. - */ -double SAL_CALL rtl_ustr_toDouble( const sal_Unicode * str ) SAL_THROW_EXTERN_C(); - -/* ======================================================================= */ - -#if defined(SAL_W32) -#pragma pack(push, 4) -#endif - -/** The implementation of a Unicode string. - - @internal -*/ -typedef struct _rtl_uString -{ - oslInterlockedCount refCount; /* opaque */ - sal_Int32 length; - sal_Unicode buffer[1]; -} rtl_uString; - -#if defined(SAL_W32) -#pragma pack(pop) -#endif - -/* ----------------------------------------------------------------------- */ - -/** Increment the reference count of a string. - - @param str - a string. - */ -void SAL_CALL rtl_uString_acquire( rtl_uString * str ) SAL_THROW_EXTERN_C(); - -/** Decrement the reference count of a string. - - If the count goes to zero than the string data is deleted. - - @param str - a string. - */ -void SAL_CALL rtl_uString_release( rtl_uString * str ) SAL_THROW_EXTERN_C(); - -/** Allocate a new string containing no characters. - - @param newStr - pointer to the new string. The pointed-to data must be null or a valid - string. - */ -void SAL_CALL rtl_uString_new( rtl_uString ** newStr ) SAL_THROW_EXTERN_C(); - -/** Allocate a new string containing space for a given number of characters. - - If len is greater than zero, the reference count of the new string will be - 1. The values of all characters are set to 0 and the length of the string - is 0. This function does not handle out-of-memory conditions. - - @param newStr - pointer to the new string. The pointed-to data must be null or a valid - string. - - @param len - the number of characters. - */ -void SAL_CALL rtl_uString_new_WithLength( rtl_uString ** newStr, sal_Int32 nLen ) SAL_THROW_EXTERN_C(); - -/** Allocate a new string that contains a copy of another string. - - If the length of value is greater than zero, the reference count of the - new string will be 1. This function does not handle out-of-memory - conditions. - - @param newStr - pointer to the new string. The pointed-to data must be null or a valid - string. - - @param value - a valid string. - */ -void SAL_CALL rtl_uString_newFromString( rtl_uString ** newStr, const rtl_uString * value ) SAL_THROW_EXTERN_C(); - -/** Allocate a new string that contains a copy of a character array. - - If the length of value is greater than zero, the reference count of the - new string will be 1. This function does not handle out-of-memory - conditions. - - @param newStr - pointer to the new string. The pointed-to data must be null or a valid - string. - - @param value - a null-terminated character array. - */ -void SAL_CALL rtl_uString_newFromStr( rtl_uString ** newStr, const sal_Unicode * value ) SAL_THROW_EXTERN_C(); - -/** Allocate a new string that contains a copy of a character array. - - If the length of value is greater than zero, the reference count of the - new string will be 1. This function does not handle out-of-memory - conditions. - - @param newStr - pointer to the new string. The pointed-to data must be null or a valid - string. - - @param value - a character array. Need not be null-terminated, but must be at least as - long as the specified len. - - @param len - the length of the character array. - */ -void SAL_CALL rtl_uString_newFromStr_WithLength( rtl_uString ** newStr, const sal_Unicode * value, sal_Int32 len ) SAL_THROW_EXTERN_C(); - -/** Allocate a new string that contains a copy of a character array. - - If the length of value is greater than zero, the reference count of the - new string will be 1. This function does not handle out-of-memory - conditions. - - Since this function is optimized for performance, the ASCII character - values are not converted in any way. The caller has to make sure that - all ASCII characters are in the allowed range of 0 and 127, inclusive. - - @param newStr - pointer to the new string. The pointed-to data must be null or a valid - string. - - @param value - a null-terminated ASCII character array. - */ -void SAL_CALL rtl_uString_newFromAscii( rtl_uString ** newStr, const sal_Char * value ) SAL_THROW_EXTERN_C(); - -/** Allocate a new string from an array of Unicode code points. - - @param newString - a non-null pointer to a (possibly null) rtl_uString pointer, which (if - non-null) will have been passed to rtl_uString_release before the function - returns. Upon return, points to the newly allocated string or to null if - there was either an out-of-memory condition or the resulting number of - UTF-16 code units would have been larger than SAL_MAX_INT32. The newly - allocated string (if any) must ultimately be passed to rtl_uString_release. - - @param codePoints - an array of at least codePointCount code points, which each must be in the - range from 0 to 0x10FFFF, inclusive. May be null if codePointCount is zero. - - @param codePointCount - the non-negative number of code points. - - @since UDK 3.2.7 -*/ -void SAL_CALL rtl_uString_newFromCodePoints( - rtl_uString ** newString, sal_uInt32 const * codePoints, - sal_Int32 codePointCount) SAL_THROW_EXTERN_C(); - -/** Assign a new value to a string. - - First releases any value str might currently hold, then acquires - rightValue. - - @param str - pointer to the string. The pointed-to data must be null or a valid - string. - - @param rightValue - a valid string. - */ -void SAL_CALL rtl_uString_assign( rtl_uString ** str, rtl_uString * rightValue ) SAL_THROW_EXTERN_C(); - -/** Return the length of a string. - - The length is equal to the number of characters in the string. - - @param str - a valid string. - - @return - the length of the string. - */ -sal_Int32 SAL_CALL rtl_uString_getLength( const rtl_uString * str ) SAL_THROW_EXTERN_C(); - -/** Return a pointer to the underlying character array of a string. - - @param str - a valid string. - - @return - a pointer to the null-terminated character array. - */ -sal_Unicode * SAL_CALL rtl_uString_getStr( rtl_uString * str ) SAL_THROW_EXTERN_C(); - -/** Create a new string that is the concatenation of two other strings. - - The new string does not necessarily have a reference count of 1 (in cases - where one of the two other strings is empty), so it must not be modified - without checking the reference count. This function does not handle - out-of-memory conditions. - - @param newStr - pointer to the new string. The pointed-to data must be null or a valid - string. - - @param left - a valid string. - - @param right - a valid string. - */ -void SAL_CALL rtl_uString_newConcat( rtl_uString ** newStr, rtl_uString * left, rtl_uString * right ) SAL_THROW_EXTERN_C(); - -/** Create a new string by replacing a substring of another string. - - The new string results from replacing a number of characters (count), - starting at the specified position (index) in the original string (str), - with some new substring (subStr). If subStr is null, than only a number - of characters is deleted. - - The new string does not necessarily have a reference count of 1, so it - must not be modified without checking the reference count. This function - does not handle out-of-memory conditions. - - @param newStr - pointer to the new string. The pointed-to data must be null or a valid - string. - - @param str - a valid string. - - @param index - the index into str at which to start replacement. Must be between 0 and - the length of str, inclusive. - - @param count - the number of charcters to remove. Must not be negative, and the sum of - index and count must not exceed the length of str. - - @param subStr - either null or a valid string to be inserted. - */ -void SAL_CALL rtl_uString_newReplaceStrAt( rtl_uString ** newStr, rtl_uString * str, sal_Int32 idx, sal_Int32 count, rtl_uString * subStr ) SAL_THROW_EXTERN_C(); - -/** Create a new string by replacing all occurrences of a single character - within another string. - - The new string results from replacing all occurrences of oldChar in str - with newChar. - - The new string does not necessarily have a reference count of 1 (in cases - where oldChar does not occur in str), so it must not be modified without - checking the reference count. This function does not handle out-of-memory - conditions. - - @param newStr - pointer to the new string. The pointed-to data must be null or a valid - string. - - @param str - a valid string. - - @param oldChar - the old character. - - @param newChar - the new character. - */ -void SAL_CALL rtl_uString_newReplace( rtl_uString ** newStr, rtl_uString * str, sal_Unicode oldChar, sal_Unicode newChar ) SAL_THROW_EXTERN_C(); - -/** Create a new string by converting all ASCII uppercase letters to lowercase - within another string. - - The new string results from replacing all characters with values between - 65 and 90 (ASCII A--Z) by values between 97 and 122 (ASCII a--z). - - This function cannot be used for language-specific conversion. The new - string does not necessarily have a reference count of 1 (in cases where - no characters need to be converted), so it must not be modified without - checking the reference count. This function does not handle out-of-memory - conditions. - - @param newStr - pointer to the new string. The pointed-to data must be null or a valid - string. - - @param str - a valid string. - */ -void SAL_CALL rtl_uString_newToAsciiLowerCase( rtl_uString ** newStr, rtl_uString * str ) SAL_THROW_EXTERN_C(); - -/** Create a new string by converting all ASCII lowercase letters to uppercase - within another string. - - The new string results from replacing all characters with values between - 97 and 122 (ASCII a--z) by values between 65 and 90 (ASCII A--Z). - - This function cannot be used for language-specific conversion. The new - string does not necessarily have a reference count of 1 (in cases where - no characters need to be converted), so it must not be modified without - checking the reference count. This function does not handle out-of-memory - conditions. - - @param newStr - pointer to the new string. The pointed-to data must be null or a valid - string. - - @param str - a valid string. - */ -void SAL_CALL rtl_uString_newToAsciiUpperCase( rtl_uString ** newStr, rtl_uString * str ) SAL_THROW_EXTERN_C(); - -/** Create a new string by removing white space from both ends of another - string. - - The new string results from removing all characters with values less than - or equal to 32 (the space character) form both ends of str. - - This function cannot be used for language-specific conversion. The new - string does not necessarily have a reference count of 1 (in cases where - no characters need to be removed), so it must not be modified without - checking the reference count. This function does not handle out-of-memory - conditions. - - @param newStr - pointer to the new string. The pointed-to data must be null or a valid - string. - - @param str - a valid string. - */ -void SAL_CALL rtl_uString_newTrim( rtl_uString ** newStr, rtl_uString * str ) SAL_THROW_EXTERN_C(); - -/** Create a new string by extracting a single token from another string. - - Starting at index, the token's next token is searched for. If there is no - such token, the result is an empty string. Otherwise, all characters from - the start of that token and up to, but not including the next occurrence - of cTok make up the resulting token. The return value is the position of - the next token, or -1 if no more tokens follow. - - Example code could look like - rtl_uString * pToken = NULL; - sal_Int32 nIndex = 0; - do - { - ... - nIndex = rtl_uString_getToken(&pToken, pStr, 0, ';', nIndex); - ... - } - while (nIndex >= 0); - - The new string does not necessarily have a reference count of 1, so it - must not be modified without checking the reference count. This function - does not handle out-of-memory conditions. - - @param newStr - pointer to the new string. The pointed-to data must be null or a valid - string. If either token or index is negative, an empty token is stored in - newStr (and -1 is returned). - - @param str - a valid string. - - @param token - the number of the token to return, starting at index. - - @param cTok - the character that seperates the tokens. - - @param index - the position at which searching for the token starts. Must not be greater - than the length of str. - - @return - the index of the next token, or -1 if no more tokens follow. - */ -sal_Int32 SAL_CALL rtl_uString_getToken( rtl_uString ** newStr , rtl_uString * str, sal_Int32 token, sal_Unicode cTok, sal_Int32 idx ) SAL_THROW_EXTERN_C(); - -/* ======================================================================= */ - -/** Supply an ASCII string literal together with its length and text encoding. - - This macro can be used to compute (some of) the arguments in function calls - like rtl::OUString(RTL_CONSTASCII_USTRINGPARAM("foo")). - - @param constAsciiStr - must be an expression of type "(possibly cv-qualified reference to) array of - (possibly cv-qualified) char." Each element of the referenced array must - represent an ASCII value in the range 0x00--0x7F. The last element of the - referenced array is not considered part of the represented ASCII string, and - its value should be 0x00. Depending on where this macro is used, the nature - of the supplied expression might be further restricted. -*/ -#define RTL_CONSTASCII_USTRINGPARAM( constAsciiStr ) constAsciiStr, ((sal_Int32)(SAL_N_ELEMENTS(constAsciiStr)-1)), RTL_TEXTENCODING_ASCII_US - -/* ======================================================================= */ - -/* predefined constants for String-Conversion */ -#define OSTRING_TO_OUSTRING_CVTFLAGS (RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_MAPTOPRIVATE |\ - RTL_TEXTTOUNICODE_FLAGS_MBUNDEFINED_DEFAULT |\ - RTL_TEXTTOUNICODE_FLAGS_INVALID_DEFAULT) - -/* ----------------------------------------------------------------------- */ - -/** Create a new Unicode string by converting a byte string, using a specific - text encoding. - - The lengths of the byte string and the Unicode string may differ (e.g., - for double-byte encodings, UTF-7, UTF-8). - - If the length of the byte string is greater than zero, the reference count - of the new string will be 1. - - If an out-of-memory condition occurs, newStr will point to a null pointer - upon return. - - @param newStr - pointer to the new string. The pointed-to data must be null or a valid - string. - - @param str - a byte character array. Need not be null-terminated, but must be at - least as long as the specified len. - - @param len - the length of the byte character array. - - @param encoding - the text encoding to use for conversion. - - @param convertFlags - flags which control the conversion. Either use - OSTRING_TO_OUSTRING_CVTFLAGS, or see - <http://udk.openoffice.org/cpp/man/spec/textconversion.html> for more - details. - */ -void SAL_CALL rtl_string2UString( rtl_uString ** newStr, const sal_Char * str, sal_Int32 len, rtl_TextEncoding encoding, sal_uInt32 convertFlags ) SAL_THROW_EXTERN_C(); - -/* ======================================================================= */ -/* Interning methods */ - -/** Return a canonical representation for a string. - - A pool of strings, initially empty is maintained privately - by the string class. On invocation, if present in the pool - the original string will be returned. Otherwise this string, - or a copy thereof will be added to the pool and returned. - - @param newStr - pointer to the new string. The pointed-to data must be null or a valid - string. - - If an out-of-memory condition occurs, newStr will point to a null pointer - upon return. - - @param str - pointer to the string to be interned. - - @since UDK 3.2.7 - */ -void SAL_CALL rtl_uString_intern( rtl_uString ** newStr, - rtl_uString * str) SAL_THROW_EXTERN_C(); - -/** Return a canonical representation for a string. - - A pool of strings, initially empty is maintained privately - by the string class. On invocation, if present in the pool - the original string will be returned. Otherwise this string, - or a copy thereof will be added to the pool and returned. - - @param newStr - pointer to the new string. The pointed-to data must be null or a valid - string. - - If an out-of-memory condition occurs, newStr will point to a null pointer - upon return. - - @param str - a byte character array. Need not be null-terminated, but must be at - least as long as the specified len. - - @param len - the length of the byte character array. - - @param encoding - the text encoding to use for conversion. - - @param convertFlags - flags which control the conversion. Either use - OSTRING_TO_OUSTRING_CVTFLAGS, or see - <http://udk.openoffice.org/cpp/man/spec/textconversion.html> for more - details. - - @param pInfo - pointer to return conversion status in, or NULL. - - @since UDK 3.2.7 - */ -void SAL_CALL rtl_uString_internConvert( rtl_uString ** newStr, - const sal_Char * str, - sal_Int32 len, - rtl_TextEncoding encoding, - sal_uInt32 convertFlags, - sal_uInt32 *pInfo) SAL_THROW_EXTERN_C(); - -/** Iterate through a string based on code points instead of UTF-16 code units. - - See Chapter 3 of The Unicode Standard 5.0 (Addison--Wesley, 2006) for - definitions of the various terms used in this description. - - The given string is interpreted as a sequence of zero or more UTF-16 code - units. For each index into this sequence (from zero to one less than the - length of the sequence, inclusive), a code point represented starting at the - given index is computed as follows: - - - If the UTF-16 code unit addressed by the index constitutes a well-formed - UTF-16 code unit sequence, the computed code point is the scalar value - encoded by that UTF-16 code unit sequence. - - - Otherwise, if the index is at least two UTF-16 code units away from the - end of the sequence, and the sequence of two UTF-16 code units addressed by - the index constitutes a well-formed UTF-16 code unit sequence, the computed - code point is the scalar value encoded by that UTF-16 code unit sequence. - - - Otherwise, the computed code point is the UTF-16 code unit addressed by - the index. (This last case catches unmatched surrogates as well as indices - pointing into the middle of surrogate pairs.) - - @param string - pointer to a valid string; must not be null. - - @param indexUtf16 - pointer to a UTF-16 based index into the given string; must not be null. On - entry, the index must be in the range from zero to the length of the string - (in UTF-16 code units), inclusive. Upon successful return, the index will - be updated to address the UTF-16 code unit that is the given - incrementCodePoints away from the initial index. - - @param incrementCodePoints - the number of code points to move the given *indexUtf16. If non-negative, - moving is done after determining the code point at the index. If negative, - moving is done before determining the code point at the (then updated) - index. The value must be such that the resulting UTF-16 based index is in - the range from zero to the length of the string (in UTF-16 code units), - inclusive. - - @return - the code point (an integer in the range from 0 to 0x10FFFF, inclusive) that - is represented within the string starting at the index computed as follows: - If incrementCodePoints is non-negative, the index is the initial value of - *indexUtf16; if incrementCodePoints is negative, the index is the updated - value of *indexUtf16. In either case, the computed index must be in the - range from zero to one less than the length of the string (in UTF-16 code - units), inclusive. - - @since UDK 3.2.7 -*/ -sal_uInt32 SAL_CALL rtl_uString_iterateCodePoints( - rtl_uString const * string, sal_Int32 * indexUtf16, - sal_Int32 incrementCodePoints); - -/** Converts a byte string to a Unicode string, signalling failure. - - @param target - An out parameter receiving the converted string. Must not be null itself, - and must contain either null or a pointer to a valid rtl_uString; the - contents are unspecified if conversion fails (rtl_convertStringToUString - returns false). - - @param source - The byte string. May only be null if length is zero. - - @param length - The length of the byte string. Must be non-negative. - - @param encoding - The text encoding to convert from. Must be an octet encoding (i.e., - rtl_isOctetTextEncoding(encoding) must return true). - - @param flags - A combination of RTL_TEXTTOUNICODE_FLAGS that detail how to do the - conversion (see rtl_convertTextToUnicode). RTL_TEXTTOUNICODE_FLAGS_FLUSH - need not be included, it is implicitly assumed. Typical uses are either - RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_ERROR | - RTL_TEXTTOUNICODE_FLAGS_MBUNDEFINED_ERROR | - RTL_TEXTTOUNICODE_FLAGS_INVALID_ERROR (fail if a byte or multi-byte sequence - cannot be converted from the source encoding) or - OSTRING_TO_OUSTRING_CVTFLAGS (make a best efforts conversion). - - @return - True if the conversion succeeded, false otherwise. - - @since UDK 3.2.9 -*/ -sal_Bool SAL_CALL rtl_convertStringToUString( - rtl_uString ** target, char const * source, sal_Int32 length, - rtl_TextEncoding encoding, sal_uInt32 flags) SAL_THROW_EXTERN_C(); - -#ifdef __cplusplus -} -#endif - -#endif /* _RTL_USTRING_H_ */ - -/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |