ustring.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

/*
 * This file is part of LibreOffice published API.
 */

#ifndef INCLUDED_RTL_USTRING_H
#define INCLUDED_RTL_USTRING_H

#include "sal/config.h"

#include "osl/interlck.h"
#include "rtl/string.h"
#include "rtl/textenc.h"
#include "sal/saldllapi.h"
#include "sal/types.h"

#ifdef __cplusplus
extern "C" {
#endif

/* ======================================================================= */

SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_ustr_getLength(
        const sal_Unicode * str ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_ustr_compare(
        const sal_Unicode * first, const sal_Unicode * second ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC 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();

SAL_DLLPUBLIC 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();

SAL_DLLPUBLIC 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();

SAL_DLLPUBLIC sal_Bool SAL_CALL rtl_ustr_asciil_reverseEquals_WithLength(
        const sal_Unicode * first, const char * second, sal_Int32 len ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_ustr_compareIgnoreAsciiCase(
        const sal_Unicode * first, const sal_Unicode * second ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC 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();

SAL_DLLPUBLIC 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();

SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_ustr_ascii_compare(
        const sal_Unicode * first, const char * second ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_ustr_ascii_compare_WithLength(
        const sal_Unicode * first, sal_Int32 firstLen, const char * second ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_ustr_ascii_shortenedCompare_WithLength(
        const sal_Unicode * first, sal_Int32 firstLen, const char * second, sal_Int32 shortenedLen ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_ustr_asciil_reverseCompare_WithLength(
        const sal_Unicode * first, sal_Int32 firstLen, const char * second, sal_Int32 secondLen ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_ustr_ascii_compareIgnoreAsciiCase(
        const sal_Unicode * first, const char * second ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_ustr_ascii_compareIgnoreAsciiCase_WithLength(
        const sal_Unicode * first, sal_Int32 firstLen, const char * second ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC 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();

SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_ustr_ascii_shortenedCompareIgnoreAsciiCase_WithLength(
        const sal_Unicode * first, sal_Int32 firstLen, const char * second, sal_Int32 shortenedLen ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_ustr_hashCode(
        const sal_Unicode * str ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_ustr_hashCode_WithLength(
        const sal_Unicode * str, sal_Int32 len ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_ustr_indexOfChar(
        const sal_Unicode * str, sal_Unicode ch ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_ustr_indexOfChar_WithLength(
        const sal_Unicode * str, sal_Int32 len, sal_Unicode ch ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_ustr_lastIndexOfChar(
        const sal_Unicode * str, sal_Unicode ch ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_ustr_lastIndexOfChar_WithLength(
        const sal_Unicode * str, sal_Int32 len, sal_Unicode ch ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_ustr_indexOfStr(
        const sal_Unicode * str, const sal_Unicode * subStr ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC 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();

SAL_DLLPUBLIC 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();

SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_ustr_lastIndexOfStr(
        const sal_Unicode * str, const sal_Unicode * subStr ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC 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();

SAL_DLLPUBLIC 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();

SAL_DLLPUBLIC void SAL_CALL rtl_ustr_replaceChar(
        sal_Unicode * str, sal_Unicode oldChar, sal_Unicode newChar ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_ustr_replaceChar_WithLength(
        sal_Unicode * str, sal_Int32 len, sal_Unicode oldChar, sal_Unicode newChar ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_ustr_toAsciiLowerCase(
        sal_Unicode * str ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_ustr_toAsciiLowerCase_WithLength(
        sal_Unicode * str, sal_Int32 len ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_ustr_toAsciiUpperCase(
        sal_Unicode * str ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_ustr_toAsciiUpperCase_WithLength(
        sal_Unicode * str, sal_Int32 len ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_ustr_trim(
        sal_Unicode * str ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_ustr_trim_WithLength(
        sal_Unicode * str, sal_Int32 len ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC 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

SAL_DLLPUBLIC 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

SAL_DLLPUBLIC 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

SAL_DLLPUBLIC 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

SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_ustr_valueOfUInt64(
        sal_Unicode * str, sal_uInt64 l, sal_Int16 radix ) SAL_THROW_EXTERN_C();
#define RTL_USTR_MAX_VALUEOFUINT64 RTL_STR_MAX_VALUEOFUINT64

SAL_DLLPUBLIC 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

SAL_DLLPUBLIC 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

SAL_DLLPUBLIC sal_Bool SAL_CALL rtl_ustr_toBoolean(
        const sal_Unicode * str ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_ustr_toInt32(
        const sal_Unicode * str, sal_Int16 radix ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC sal_uInt32 SAL_CALL rtl_ustr_toUInt32(
        const sal_Unicode * str, sal_Int16 radix ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC sal_Int64 SAL_CALL rtl_ustr_toInt64(
        const sal_Unicode * str, sal_Int16 radix ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC sal_Int64 SAL_CALL rtl_ustr_toInt64_WithLength(
        const sal_Unicode * str, sal_Int16 radix, sal_Int32 nStrLength ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC sal_uInt64 SAL_CALL rtl_ustr_toUInt64(
        const sal_Unicode * str, sal_Int16 radix ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC float SAL_CALL rtl_ustr_toFloat(
        const sal_Unicode * str ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC double SAL_CALL rtl_ustr_toDouble(
        const sal_Unicode * str ) SAL_THROW_EXTERN_C();

/* ======================================================================= */

typedef struct SAL_DLLPUBLIC_RTTI _rtl_uString
{
    oslInterlockedCount refCount; /* opaque */
    sal_Int32           length;
    sal_Unicode         buffer[1];
} rtl_uString;
/* ----------------------------------------------------------------------- */

SAL_DLLPUBLIC void SAL_CALL rtl_uString_acquire(
        rtl_uString * str ) SAL_THROW_EXTERN_C() SAL_HOT;

SAL_DLLPUBLIC void SAL_CALL rtl_uString_release(
        rtl_uString * str ) SAL_THROW_EXTERN_C() SAL_HOT;

SAL_DLLPUBLIC void SAL_CALL rtl_uString_new(
        rtl_uString ** newStr ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC rtl_uString * SAL_CALL rtl_uString_alloc(sal_Int32 nLen) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_new_WithLength(
        rtl_uString ** newStr, sal_Int32 nLen ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newFromString(
        rtl_uString ** newStr, const rtl_uString * value ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newFromStr(
        rtl_uString ** newStr, const sal_Unicode * value ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newFromStr_WithLength(
        rtl_uString ** newStr, const sal_Unicode * value, sal_Int32 len ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newFromSubString(
        rtl_uString ** newStr, const rtl_uString * from,
        sal_Int32 beginIndex, sal_Int32 count ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newFromAscii(
        rtl_uString ** newStr, const char * value ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newFromLiteral(
        rtl_uString ** newStr, const char * value, sal_Int32 len,
        sal_Int32 allocExtra ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newFromCodePoints(
    rtl_uString ** newString, sal_uInt32 const * codePoints,
    sal_Int32 codePointCount) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_assign(
        rtl_uString ** str, rtl_uString * rightValue ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_uString_getLength(
        const rtl_uString * str ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC sal_Unicode * SAL_CALL rtl_uString_getStr(
        rtl_uString * str ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newConcat(
        rtl_uString ** newStr, rtl_uString * left, rtl_uString * right ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newConcatAsciiL(
    rtl_uString ** newString, rtl_uString * left, char const * right,
    sal_Int32 rightLength);

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newConcatUtf16L(
    rtl_uString ** newString, rtl_uString * left, sal_Unicode const * right,
    sal_Int32 rightLength);

SAL_DLLPUBLIC 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();

#ifdef LIBO_INTERNAL_ONLY
SAL_DLLPUBLIC void SAL_CALL rtl_uString_newReplaceStrAtUtf16L(
        rtl_uString ** newStr, rtl_uString * str, sal_Int32 idx, sal_Int32 count, sal_Unicode const * subStr, sal_Int32 substrLen ) SAL_THROW_EXTERN_C();
#endif

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newReplace(
        rtl_uString ** newStr, rtl_uString * str, sal_Unicode oldChar, sal_Unicode newChar ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newReplaceFirst(
    rtl_uString ** newStr, rtl_uString * str, rtl_uString const * from,
    rtl_uString const * to, sal_Int32 * index) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newReplaceFirstAsciiL(
    rtl_uString ** newStr, rtl_uString * str, char const * from,
    sal_Int32 fromLength, rtl_uString const * to, sal_Int32 * index)
    SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newReplaceFirstToAsciiL(
    rtl_uString ** newStr, rtl_uString * str, rtl_uString const * from,
    char const * to, sal_Int32 toLength, sal_Int32 * index)
    SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newReplaceFirstAsciiLAsciiL(
    rtl_uString ** newStr, rtl_uString * str, char const * from,
    sal_Int32 fromLength, char const * to, sal_Int32 toLength,
    sal_Int32 * index) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newReplaceFirstAsciiLUtf16L(
    rtl_uString ** newStr, rtl_uString * str, char const * from,
    sal_Int32 fromLength, sal_Unicode const * to, sal_Int32 toLength,
    sal_Int32 * index) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newReplaceFirstUtf16LAsciiL(
    rtl_uString ** newStr, rtl_uString * str, sal_Unicode const * from,
    sal_Int32 fromLength, char const * to, sal_Int32 toLength,
    sal_Int32 * index) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newReplaceFirstUtf16LUtf16L(
    rtl_uString ** newStr, rtl_uString * str, sal_Unicode const * from,
    sal_Int32 fromLength, sal_Unicode const * to, sal_Int32 toLength,
    sal_Int32 * index) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newReplaceAll(
    rtl_uString ** newStr, rtl_uString * str, rtl_uString const * from,
    rtl_uString const * to) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newReplaceAllFromIndex(
    rtl_uString ** newStr, rtl_uString * str, rtl_uString const * from,
    rtl_uString const * to, sal_Int32 fromIndex) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newReplaceAllAsciiL(
    rtl_uString ** newStr, rtl_uString * str, char const * from,
    sal_Int32 fromLength, rtl_uString const * to) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newReplaceAllToAsciiL(
    rtl_uString ** newStr, rtl_uString * str, rtl_uString const * from,
    char const * to, sal_Int32 toLength) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newReplaceAllAsciiLAsciiL(
    rtl_uString ** newStr, rtl_uString * str, char const * from,
    sal_Int32 fromLength, char const * to, sal_Int32 toLength)
    SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newReplaceAllAsciiLUtf16L(
    rtl_uString ** newStr, rtl_uString * str, char const * from,
    sal_Int32 fromLength, sal_Unicode const * to, sal_Int32 toLength)
    SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newReplaceAllUtf16LAsciiL(
    rtl_uString ** newStr, rtl_uString * str, sal_Unicode const * from,
    sal_Int32 fromLength, char const * to, sal_Int32 toLength)
    SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newReplaceAllUtf16LUtf16L(
    rtl_uString ** newStr, rtl_uString * str, sal_Unicode const * from,
    sal_Int32 fromLength, sal_Unicode const * to, sal_Int32 toLength)
    SAL_THROW_EXTERN_C();

#if defined LIBO_INTERNAL_ONLY

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newReplaceAllFromIndexUtf16LUtf16L(
    rtl_uString ** newStr, rtl_uString * str, sal_Unicode const * from,
    sal_Int32 fromLength, sal_Unicode const * to, sal_Int32 toLength, sal_Int32 fromIndex)
    SAL_THROW_EXTERN_C();
#endif

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newToAsciiLowerCase(
        rtl_uString ** newStr, rtl_uString * str ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newToAsciiUpperCase(
        rtl_uString ** newStr, rtl_uString * str ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_newTrim(
        rtl_uString ** newStr, rtl_uString * str ) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC 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();

/* ======================================================================= */

// The &foo[0] trick is intentional, it makes sure the type is char* or const char*
// (plain cast to const char* would not work with non-const char foo[]="a", which seems to be allowed).
// This is to avoid mistaken use with functions that accept string literals
// (i.e. const char (&)[N]) where usage of this macro otherwise could match
// the argument and a following int argument with a default value (e.g. OUString::match()).
#define RTL_CONSTASCII_USTRINGPARAM( constAsciiStr ) (&(constAsciiStr)[0]), \
    ((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)

/* ----------------------------------------------------------------------- */

SAL_DLLPUBLIC void SAL_CALL rtl_string2UString(
        rtl_uString ** newStr, const char * str, sal_Int32 len, rtl_TextEncoding encoding, sal_uInt32 convertFlags ) SAL_THROW_EXTERN_C();

/* ======================================================================= */
/* Interning methods */

SAL_DLLPUBLIC void SAL_CALL rtl_uString_intern(
        rtl_uString ** newStr, rtl_uString * str) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_internConvert(
                                         rtl_uString   ** newStr,
                                         const char * str,
                                         sal_Int32        len,
                                         rtl_TextEncoding encoding,
                                         sal_uInt32       convertFlags,
                                         sal_uInt32      *pInfo) SAL_THROW_EXTERN_C();

SAL_DLLPUBLIC sal_uInt32 SAL_CALL rtl_uString_iterateCodePoints(
    rtl_uString const * string, sal_Int32 * indexUtf16,
    sal_Int32 incrementCodePoints);

SAL_DLLPUBLIC 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();

SAL_DLLPUBLIC void SAL_CALL rtl_uString_ensureCapacity( rtl_uString ** str, sal_Int32 size ) SAL_THROW_EXTERN_C();

#ifdef __cplusplus
}
#endif

#endif // INCLUDED_RTL_USTRING_H

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */