ustring.h

Go to the documentation of this file.

// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
**********************************************************************
*   Copyright (C) 1998-2014, International Business Machines
*   Corporation and others.  All Rights Reserved.
**********************************************************************
*
* File ustring.h
*
* Modification History:
*
*   Date        Name        Description
*   12/07/98    bertrand    Creation.
******************************************************************************
*/
 
#ifndef USTRING_H
#define USTRING_H
 
#include "unicode/utypes.h"
#include "unicode/putil.h"
#include "unicode/uiter.h"
 
#ifndef UBRK_TYPEDEF_UBREAK_ITERATOR
#   define UBRK_TYPEDEF_UBREAK_ITERATOR
    typedef struct UBreakIterator UBreakIterator;
#endif
 
U_CAPI int32_t U_EXPORT2
u_strlen(const UChar *s);
U_CAPI int32_t U_EXPORT2
u_countChar32(const UChar *s, int32_t length);
 
U_CAPI UBool U_EXPORT2
u_strHasMoreChar32Than(const UChar *s, int32_t length, int32_t number);
 
U_CAPI UChar* U_EXPORT2
u_strcat(UChar* dst U_LIFETIME_BOUND, const UChar* src);
 
U_CAPI UChar* U_EXPORT2
u_strncat(UChar* dst U_LIFETIME_BOUND, const UChar* src, int32_t n);
 
U_CAPI UChar* U_EXPORT2
u_strstr(const UChar* s U_LIFETIME_BOUND, const UChar* substring);
 
U_CAPI UChar* U_EXPORT2
u_strFindFirst(const UChar* s U_LIFETIME_BOUND,
               int32_t length,
               const UChar* substring,
               int32_t subLength);
 
U_CAPI UChar* U_EXPORT2
u_strchr(const UChar* s U_LIFETIME_BOUND, UChar c);
 
U_CAPI UChar* U_EXPORT2
u_strchr32(const UChar* s U_LIFETIME_BOUND, UChar32 c);
 
U_CAPI UChar* U_EXPORT2
u_strrstr(const UChar* s U_LIFETIME_BOUND, const UChar* substring);
 
U_CAPI UChar* U_EXPORT2
u_strFindLast(const UChar* s U_LIFETIME_BOUND,
              int32_t length,
              const UChar* substring,
              int32_t subLength);
 
U_CAPI UChar* U_EXPORT2
u_strrchr(const UChar* s U_LIFETIME_BOUND, UChar c);
 
U_CAPI UChar* U_EXPORT2
u_strrchr32(const UChar* s U_LIFETIME_BOUND, UChar32 c);
 
U_CAPI UChar* U_EXPORT2
u_strpbrk(const UChar* string U_LIFETIME_BOUND, const UChar* matchSet);
 
U_CAPI int32_t U_EXPORT2
u_strcspn(const UChar *string, const UChar *matchSet);
 
U_CAPI int32_t U_EXPORT2
u_strspn(const UChar *string, const UChar *matchSet);
 
U_CAPI UChar* U_EXPORT2
u_strtok_r(UChar* src U_LIFETIME_BOUND, const UChar* delim, UChar** saveState);
 
U_CAPI int32_t  U_EXPORT2
u_strcmp(const UChar     *s1, 
         const UChar     *s2);
 
U_CAPI int32_t U_EXPORT2
u_strcmpCodePointOrder(const UChar *s1, const UChar *s2);
 
U_CAPI int32_t U_EXPORT2
u_strCompare(const UChar *s1, int32_t length1,
             const UChar *s2, int32_t length2,
             UBool codePointOrder);
 
U_CAPI int32_t U_EXPORT2
u_strCompareIter(UCharIterator *iter1, UCharIterator *iter2, UBool codePointOrder);
 
U_CAPI int32_t U_EXPORT2
u_strCaseCompare(const UChar *s1, int32_t length1,
                 const UChar *s2, int32_t length2,
                 uint32_t options,
                 UErrorCode *pErrorCode);
 
U_CAPI int32_t U_EXPORT2
u_strncmp(const UChar     *ucs1, 
     const UChar     *ucs2, 
     int32_t     n);
 
U_CAPI int32_t U_EXPORT2
u_strncmpCodePointOrder(const UChar *s1, const UChar *s2, int32_t n);
 
U_CAPI int32_t U_EXPORT2
u_strcasecmp(const UChar *s1, const UChar *s2, uint32_t options);
 
U_CAPI int32_t U_EXPORT2
u_strncasecmp(const UChar *s1, const UChar *s2, int32_t n, uint32_t options);
 
U_CAPI int32_t U_EXPORT2
u_memcasecmp(const UChar *s1, const UChar *s2, int32_t length, uint32_t options);
 
U_CAPI UChar* U_EXPORT2
u_strcpy(UChar* dst U_LIFETIME_BOUND, const UChar* src);
 
U_CAPI UChar* U_EXPORT2
u_strncpy(UChar* dst U_LIFETIME_BOUND, const UChar* src, int32_t n);
 
#if !UCONFIG_NO_CONVERSION
 
U_CAPI UChar* U_EXPORT2 u_uastrcpy(UChar* dst U_LIFETIME_BOUND, const char* src);
 
U_CAPI UChar* U_EXPORT2 u_uastrncpy(UChar* dst U_LIFETIME_BOUND, const char* src, int32_t n);
 
U_CAPI char* U_EXPORT2 u_austrcpy(char* dst U_LIFETIME_BOUND, const UChar* src);
 
U_CAPI char* U_EXPORT2 u_austrncpy(char* dst U_LIFETIME_BOUND, const UChar* src, int32_t n);
 
#endif
 
U_CAPI UChar* U_EXPORT2
u_memcpy(UChar* dest U_LIFETIME_BOUND, const UChar* src, int32_t count);
 
U_CAPI UChar* U_EXPORT2
u_memmove(UChar* dest U_LIFETIME_BOUND, const UChar* src, int32_t count);
 
U_CAPI UChar* U_EXPORT2
u_memset(UChar* dest U_LIFETIME_BOUND, UChar c, int32_t count);
 
U_CAPI int32_t U_EXPORT2
u_memcmp(const UChar *buf1, const UChar *buf2, int32_t count);
 
U_CAPI int32_t U_EXPORT2
u_memcmpCodePointOrder(const UChar *s1, const UChar *s2, int32_t count);
 
U_CAPI UChar* U_EXPORT2
u_memchr(const UChar* s U_LIFETIME_BOUND, UChar c, int32_t count);
 
U_CAPI UChar* U_EXPORT2
u_memchr32(const UChar* s U_LIFETIME_BOUND, UChar32 c, int32_t count);
 
U_CAPI UChar* U_EXPORT2
u_memrchr(const UChar* s U_LIFETIME_BOUND, UChar c, int32_t count);
 
U_CAPI UChar* U_EXPORT2
u_memrchr32(const UChar* s U_LIFETIME_BOUND, UChar32 c, int32_t count);
 
#if defined(U_DECLARE_UTF16)
#   define U_STRING_DECL(var, cs, length) static const UChar *var=(const UChar *)U_DECLARE_UTF16(cs)
#   define U_STRING_INIT(var, cs, length)
#elif U_SIZEOF_WCHAR_T==U_SIZEOF_UCHAR && (U_CHARSET_FAMILY==U_ASCII_FAMILY || defined(U_WCHAR_IS_UTF16))
#   define U_STRING_DECL(var, cs, length) static const UChar var[(length)+1]=L ## cs
#   define U_STRING_INIT(var, cs, length)
#else
#   define U_STRING_DECL(var, cs, length) static UChar var[(length)+1]
#   define U_STRING_INIT(var, cs, length) u_charsToUChars(cs, var, length+1)
#endif
 
U_CAPI int32_t U_EXPORT2
u_unescape(const char *src,
           UChar *dest, int32_t destCapacity);
 
U_CDECL_BEGIN
typedef UChar (U_CALLCONV *UNESCAPE_CHAR_AT)(int32_t offset, void *context);
U_CDECL_END
 
U_CAPI UChar32 U_EXPORT2
u_unescapeAt(UNESCAPE_CHAR_AT charAt,
             int32_t *offset,
             int32_t length,
             void *context);
 
U_CAPI int32_t U_EXPORT2
u_strToUpper(UChar *dest, int32_t destCapacity,
             const UChar *src, int32_t srcLength,
             const char *locale,
             UErrorCode *pErrorCode);
 
U_CAPI int32_t U_EXPORT2
u_strToLower(UChar *dest, int32_t destCapacity,
             const UChar *src, int32_t srcLength,
             const char *locale,
             UErrorCode *pErrorCode);
 
#if !UCONFIG_NO_BREAK_ITERATION
 
U_CAPI int32_t U_EXPORT2
u_strToTitle(UChar *dest, int32_t destCapacity,
             const UChar *src, int32_t srcLength,
             UBreakIterator *titleIter,
             const char *locale,
             UErrorCode *pErrorCode);
 
#endif
 
U_CAPI int32_t U_EXPORT2
u_strFoldCase(UChar *dest, int32_t destCapacity,
              const UChar *src, int32_t srcLength,
              uint32_t options,
              UErrorCode *pErrorCode);
 
#if defined(U_WCHAR_IS_UTF16) || defined(U_WCHAR_IS_UTF32) || !UCONFIG_NO_CONVERSION
U_CAPI wchar_t* U_EXPORT2
u_strToWCS(wchar_t* dest U_LIFETIME_BOUND,
           int32_t destCapacity,
           int32_t* pDestLength,
           const UChar* src,
           int32_t srcLength,
           UErrorCode* pErrorCode);
U_CAPI UChar* U_EXPORT2
u_strFromWCS(UChar* dest U_LIFETIME_BOUND,
             int32_t destCapacity,
             int32_t* pDestLength,
             const wchar_t* src,
             int32_t srcLength,
             UErrorCode* pErrorCode);
#endif /* defined(U_WCHAR_IS_UTF16) || defined(U_WCHAR_IS_UTF32) || !UCONFIG_NO_CONVERSION */
 
U_CAPI char* U_EXPORT2
u_strToUTF8(char* dest U_LIFETIME_BOUND,
            int32_t destCapacity,
            int32_t* pDestLength,
            const UChar* src,
            int32_t srcLength,
            UErrorCode* pErrorCode);
 
U_CAPI UChar* U_EXPORT2
u_strFromUTF8(UChar* dest U_LIFETIME_BOUND,
              int32_t destCapacity,
              int32_t* pDestLength,
              const char* src,
              int32_t srcLength,
              UErrorCode* pErrorCode);
 
U_CAPI char* U_EXPORT2
u_strToUTF8WithSub(char* dest U_LIFETIME_BOUND,
                   int32_t destCapacity,
                   int32_t* pDestLength,
                   const UChar* src,
                   int32_t srcLength,
                   UChar32 subchar,
                   int32_t* pNumSubstitutions,
                   UErrorCode* pErrorCode);
 
U_CAPI UChar* U_EXPORT2
u_strFromUTF8WithSub(UChar* dest U_LIFETIME_BOUND,
                     int32_t destCapacity,
                     int32_t* pDestLength,
                     const char* src,
                     int32_t srcLength,
                     UChar32 subchar,
                     int32_t* pNumSubstitutions,
                     UErrorCode* pErrorCode);
 
U_CAPI UChar* U_EXPORT2
u_strFromUTF8Lenient(UChar* dest U_LIFETIME_BOUND,
                     int32_t destCapacity,
                     int32_t* pDestLength,
                     const char* src,
                     int32_t srcLength,
                     UErrorCode* pErrorCode);
 
U_CAPI UChar32* U_EXPORT2
u_strToUTF32(UChar32* dest U_LIFETIME_BOUND,
             int32_t destCapacity,
             int32_t* pDestLength,
             const UChar* src,
             int32_t srcLength,
             UErrorCode* pErrorCode);
 
U_CAPI UChar* U_EXPORT2
u_strFromUTF32(UChar* dest U_LIFETIME_BOUND,
               int32_t destCapacity,
               int32_t* pDestLength,
               const UChar32* src,
               int32_t srcLength,
               UErrorCode* pErrorCode);
 
U_CAPI UChar32* U_EXPORT2
u_strToUTF32WithSub(UChar32* dest U_LIFETIME_BOUND,
                    int32_t destCapacity,
                    int32_t* pDestLength,
                    const UChar* src,
                    int32_t srcLength,
                    UChar32 subchar,
                    int32_t* pNumSubstitutions,
                    UErrorCode* pErrorCode);
 
U_CAPI UChar* U_EXPORT2
u_strFromUTF32WithSub(UChar* dest U_LIFETIME_BOUND,
                      int32_t destCapacity,
                      int32_t* pDestLength,
                      const UChar32* src,
                      int32_t srcLength,
                      UChar32 subchar,
                      int32_t* pNumSubstitutions,
                      UErrorCode* pErrorCode);
 
U_CAPI char* U_EXPORT2
u_strToJavaModifiedUTF8(char* dest U_LIFETIME_BOUND,
                        int32_t destCapacity,
                        int32_t* pDestLength,
                        const UChar* src,
                        int32_t srcLength,
                        UErrorCode* pErrorCode);
 
U_CAPI UChar* U_EXPORT2
u_strFromJavaModifiedUTF8WithSub(UChar* dest U_LIFETIME_BOUND,
                                 int32_t destCapacity,
                                 int32_t* pDestLength,
                                 const char* src,
                                 int32_t srcLength,
                                 UChar32 subchar,
                                 int32_t* pNumSubstitutions,
                                 UErrorCode* pErrorCode);
 
#endif