/* -*- 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_USTRBUF_HXX #define INCLUDED_RTL_USTRBUF_HXX #include "sal/config.h" #include #include #include #include #if defined LIBO_INTERNAL_ONLY #include #include #include #endif #include "rtl/ustrbuf.h" #include "rtl/ustring.hxx" #include "rtl/stringutils.hxx" #include "sal/types.h" #ifdef LIBO_INTERNAL_ONLY // "RTL_FAST_STRING" #include "o3tl/safeint.hxx" #include "rtl/stringconcat.hxx" #endif #ifdef RTL_STRING_UNITTEST extern bool rtl_string_unittest_invalid_conversion; #endif // The unittest uses slightly different code to help check that the proper // calls are made. The class is put into a different namespace to make // sure the compiler generates a different (if generating also non-inline) // copy of the function and does not merge them together. The class // is "brought" into the proper rtl namespace by a typedef below. #ifdef RTL_STRING_UNITTEST #define rtl rtlunittest #endif namespace rtl { #ifdef RTL_STRING_UNITTEST #undef rtl #endif /** A string buffer implements a mutable sequence of characters. */ class SAL_WARN_UNUSED OUStringBuffer { friend class OUString; public: /** Constructs a string buffer with no characters in it and an initial capacity of 16 characters. */ OUStringBuffer() : pData(NULL) , nCapacity( 16 ) { rtl_uString_new_WithLength( &pData, nCapacity ); } /** Allocates a new string buffer that contains the same sequence of characters as the string buffer argument. @param value a OUStringBuffer. */ OUStringBuffer( const OUStringBuffer & value ) : pData(NULL) , nCapacity( value.nCapacity ) { rtl_uStringbuffer_newFromStringBuffer( &pData, value.nCapacity, value.pData ); } /** Constructs a string buffer with no characters in it and an initial capacity specified by the length argument. @param length the initial capacity. */ explicit OUStringBuffer(sal_Int32 length) : pData(NULL) , nCapacity( length ) { rtl_uString_new_WithLength( &pData, length ); } #if defined LIBO_INTERNAL_ONLY template explicit OUStringBuffer(T length, std::enable_if_t, int> = 0) : OUStringBuffer(static_cast(length)) { assert( length >= 0 && static_cast>(length) <= static_cast>( std::numeric_limits::max())); } // avoid (obvious) bugs explicit OUStringBuffer(bool) = delete; explicit OUStringBuffer(char) = delete; explicit OUStringBuffer(wchar_t) = delete; #if !(defined _MSC_VER && _MSC_VER >= 1930 && _MSC_VER <= 1938 && defined _MANAGED) explicit OUStringBuffer(char8_t) = delete; #endif explicit OUStringBuffer(char16_t) = delete; explicit OUStringBuffer(char32_t) = delete; #endif /** Constructs a string buffer so that it represents the same sequence of characters as the string argument. The initial capacity of the string buffer is 16 plus the length of the string argument. @param value the initial contents of the buffer. */ #if defined LIBO_INTERNAL_ONLY OUStringBuffer(std::u16string_view sv) : pData(nullptr) , nCapacity( sv.length() + 16 ) { if (sv.size() > sal_uInt32(std::numeric_limits::max())) { throw std::bad_alloc(); } rtl_uStringbuffer_newFromStr_WithLength( &pData, sv.data(), sv.length() ); } #else OUStringBuffer(const OUString& value) : pData(NULL) , nCapacity( value.getLength() + 16 ) { rtl_uStringbuffer_newFromStr_WithLength( &pData, value.getStr(), value.getLength() ); } #endif template< typename T > OUStringBuffer( T& literal, typename libreoffice_internal::ConstCharArrayDetector< T, libreoffice_internal::Dummy >::Type = libreoffice_internal::Dummy() ) : pData(NULL) , nCapacity( libreoffice_internal::ConstCharArrayDetector::length + 16 ) { assert( libreoffice_internal::ConstCharArrayDetector::isValid(literal)); rtl_uString_newFromLiteral( &pData, libreoffice_internal::ConstCharArrayDetector::toPointer(literal), libreoffice_internal::ConstCharArrayDetector::length, 16); #ifdef RTL_STRING_UNITTEST rtl_string_unittest_const_literal = true; #endif } #if defined LIBO_INTERNAL_ONLY /** @overload @since LibreOffice 5.3 */ template OUStringBuffer( T & literal, typename libreoffice_internal::ConstCharArrayDetector< T, libreoffice_internal::Dummy>::TypeUtf16 = libreoffice_internal::Dummy()): pData(nullptr), nCapacity(libreoffice_internal::ConstCharArrayDetector::length + 16) { rtl_uStringbuffer_newFromStr_WithLength( &pData, libreoffice_internal::ConstCharArrayDetector::toPointer(literal), libreoffice_internal::ConstCharArrayDetector::length); } #endif #if defined LIBO_INTERNAL_ONLY && defined RTL_STRING_UNITTEST /// @cond INTERNAL /** * Only used by unittests to detect incorrect conversions. * @internal */ template< typename T > OUStringBuffer( T&, typename libreoffice_internal::ExceptConstCharArrayDetector< T >::Type = libreoffice_internal::Dummy() ) { pData = NULL; nCapacity = 10; rtl_uString_newFromLiteral( &pData, "!!br0ken!!", 10, 0 ); // set to garbage rtl_string_unittest_invalid_conversion = true; } /** * Only used by unittests to detect incorrect conversions. * @internal */ template< typename T > OUStringBuffer( const T&, typename libreoffice_internal::ExceptCharArrayDetector< T >::Type = libreoffice_internal::Dummy() ) { pData = NULL; nCapacity = 10; rtl_uString_newFromLiteral( &pData, "!!br0ken!!", 10, 0 ); // set to garbage rtl_string_unittest_invalid_conversion = true; } /// @endcond #endif #ifdef LIBO_INTERNAL_ONLY // "RTL_FAST_STRING" /** @overload @internal */ template< typename T1, typename T2 > OUStringBuffer( OUStringConcat< T1, T2 >&& c ) { const sal_Int32 l = c.length(); nCapacity = l + 16; pData = rtl_uString_alloc( nCapacity ); sal_Unicode* end = c.addData( pData->buffer ); *end = '\0'; pData->length = l; } /** @overload @internal */ template< std::size_t N > OUStringBuffer( OUStringNumber< N >&& n ) : pData(NULL) , nCapacity( n.length + 16 ) { rtl_uStringbuffer_newFromStr_WithLength( &pData, n.buf, n.length ); } #endif #if defined LIBO_INTERNAL_ONLY operator std::u16string_view() const { return {getStr(), sal_uInt32(getLength())}; } #endif /** Assign to this a copy of value. */ OUStringBuffer& operator = ( const OUStringBuffer& value ) { if (this != &value) { rtl_uStringbuffer_newFromStringBuffer(&pData, value.nCapacity, value.pData); nCapacity = value.nCapacity; } return *this; } #if defined LIBO_INTERNAL_ONLY /** Move assignment * @since LibreOffice 7.3 */ OUStringBuffer& operator = ( OUStringBuffer&& value ) noexcept { rtl_uString_release( pData ); pData = value.pData; nCapacity = value.nCapacity; value.pData = nullptr; value.nCapacity = 0; rtl_uString_new( &value.pData ); return *this; } #endif /** Assign from a string. @since LibreOffice 5.3 */ #if defined LIBO_INTERNAL_ONLY OUStringBuffer & operator =(std::u16string_view string) { sal_Int32 n = string.length(); if (n >= nCapacity) { ensureCapacity(n + 16); //TODO: check for overflow } std::memcpy( pData->buffer, string.data(), n * sizeof (sal_Unicode)); pData->buffer[n] = '\0'; pData->length = n; return *this; } #else OUStringBuffer & operator =(OUString const & string) { sal_Int32 n = string.getLength(); if (n >= nCapacity) { ensureCapacity(n + 16); //TODO: check for overflow } std::memcpy( pData->buffer, string.pData->buffer, (n + 1) * sizeof (sal_Unicode)); pData->length = n; return *this; } #endif /** Assign from a string literal. @since LibreOffice 5.3 */ template typename libreoffice_internal::ConstCharArrayDetector::Type operator =(T & literal) { assert( libreoffice_internal::ConstCharArrayDetector::isValid(literal)); sal_Int32 const n = libreoffice_internal::ConstCharArrayDetector::length; if (n >= nCapacity) { ensureCapacity(n + 16); //TODO: check for overflow } char const * from = libreoffice_internal::ConstCharArrayDetector::toPointer( literal); sal_Unicode * to = pData->buffer; for (sal_Int32 i = 0; i <= n; ++i) { to[i] = from[i]; } pData->length = n; return *this; } #if defined LIBO_INTERNAL_ONLY /** @overload @since LibreOffice 5.3 */ template typename libreoffice_internal::ConstCharArrayDetector< T, OUStringBuffer &>::TypeUtf16 operator =(T & literal) { sal_Int32 const n = libreoffice_internal::ConstCharArrayDetector::length; if (n >= nCapacity) { ensureCapacity(n + 16); //TODO: check for overflow } // For OUStringChar, which is covered by this template's ConstCharArrayDetector TypeUtf16 // check, toPointer does not return a NUL-terminated string, so we can't just memcpy n+1 // elements but rather need to add the terminating NUL manually: std::memcpy( pData->buffer, libreoffice_internal::ConstCharArrayDetector::toPointer(literal), n * sizeof (sal_Unicode)); pData->buffer[n] = '\0'; pData->length = n; return *this; } #endif #if defined LIBO_INTERNAL_ONLY /** @overload @since LibreOffice 5.3 */ template OUStringBuffer & operator =(OUStringConcat && concat) { sal_Int32 const n = concat.length(); if (n >= nCapacity) { ensureCapacity(n + 16); //TODO: check for overflow } *concat.addData(pData->buffer) = 0; pData->length = n; return *this; } /** @overload @internal */ template OUStringBuffer & operator =(OUStringNumber && n) { return operator =(std::u16string_view(n)); } #endif /** Release the string data. */ ~OUStringBuffer() { rtl_uString_release( pData ); } /** Fill the string data in the new string and clear the buffer. This method is more efficient than the constructor of the string. It does not copy the buffer. @return the string previously contained in the buffer. */ SAL_WARN_UNUSED_RESULT OUString makeStringAndClear() { return OUString( rtl_uStringBuffer_makeStringAndClear( &pData, &nCapacity ), SAL_NO_ACQUIRE ); } /** Returns the length (character count) of this string buffer. @return the number of characters in this string buffer. */ sal_Int32 getLength() const { return pData->length; } /** Checks if a string buffer is empty. @return true if the string buffer is empty; false, otherwise. @since LibreOffice 4.1 */ bool isEmpty() const { return pData->length == 0; } /** Returns the current capacity of the String buffer. The capacity is the amount of storage available for newly inserted characters. The real buffer size is 2 bytes longer, because all strings are 0 terminated. @return the current capacity of this string buffer. */ sal_Int32 getCapacity() const { return nCapacity; } /** Ensures that the capacity of the buffer is at least equal to the specified minimum. The new capacity will be at least as large as the maximum of the current length (so that no contents of the buffer is destroyed) and the given minimumCapacity. If the given minimumCapacity is negative, nothing is changed. @param minimumCapacity the minimum desired capacity. */ void ensureCapacity(sal_Int32 minimumCapacity) { rtl_uStringbuffer_ensureCapacity( &pData, &nCapacity, minimumCapacity ); } /** Sets the length of this String buffer. If the newLength argument is less than the current length of the string buffer, the string buffer is truncated to contain exactly the number of characters given by the newLength argument.

If the newLength argument is greater than or equal to the current length, sufficient null characters ('\u0000') are appended to the string buffer so that length becomes the newLength argument.

The newLength argument must be greater than or equal to 0. @param newLength the new length of the buffer. */ void setLength(sal_Int32 newLength) { assert(newLength >= 0); // Avoid modifications if pData points to const empty string: if( newLength != pData->length ) { if( newLength > nCapacity ) rtl_uStringbuffer_ensureCapacity(&pData, &nCapacity, newLength); else pData->buffer[newLength] = 0; pData->length = newLength; } } /** Returns the character at a specific index in this string buffer. The first character of a string buffer is at index 0, the next at index 1, and so on, for array indexing.

The index argument must be greater than or equal to 0, and less than the length of this string buffer. @param index the index of the desired character. @return the character at the specified index of this string buffer. */ SAL_DEPRECATED("use rtl::OUStringBuffer::operator [] instead") sal_Unicode charAt( sal_Int32 index ) const { assert(index >= 0 && index < pData->length); return pData->buffer[ index ]; } /** The character at the specified index of this string buffer is set to ch. The index argument must be greater than or equal to 0, and less than the length of this string buffer. @param index the index of the character to modify. @param ch the new character. */ SAL_DEPRECATED("use rtl::OUStringBuffer::operator [] instead") OUStringBuffer & setCharAt(sal_Int32 index, sal_Unicode ch) { assert(index >= 0 && index < pData->length); pData->buffer[ index ] = ch; return *this; } /** Return a null terminated unicode character array. */ const sal_Unicode* getStr() const SAL_RETURNS_NONNULL { return pData->buffer; } /** Access to individual characters. @param index must be non-negative and less than length. @return a reference to the character at the given index. @since LibreOffice 3.5 */ sal_Unicode & operator [](sal_Int32 index) { assert(index >= 0 && index < pData->length); return pData->buffer[index]; } /** Access to individual characters. @param index must be non-negative and less than length. @return a reference to the character at the given index. @since LibreOffice 4.2 */ const sal_Unicode & operator [](sal_Int32 index) const { assert(index >= 0 && index < pData->length); return pData->buffer[index]; } /** Return an OUString instance reflecting the current content of this OUStringBuffer. */ OUString toString() const { return OUString(pData->buffer, pData->length); } /** Appends the string to this string buffer. The characters of the OUString argument are appended, in order, to the contents of this string buffer, increasing the length of this string buffer by the length of the argument. @param str a string. @return this string buffer. */ #if !defined LIBO_INTERNAL_ONLY OUStringBuffer & append(const OUString &str) #else OUStringBuffer & append(std::u16string_view str) #endif { return insert(getLength(), str); } #if !defined LIBO_INTERNAL_ONLY /** Appends the content of a stringbuffer to this string buffer. The characters of the OUStringBuffer argument are appended, in order, to the contents of this string buffer, increasing the length of this string buffer by the length of the argument. @param str a string. @return this string buffer. @since LibreOffice 4.0 */ OUStringBuffer & append(const OUStringBuffer &str) { if(!str.isEmpty()) { append( str.getStr(), str.getLength() ); } return *this; } #endif /** Appends the string representation of the char array argument to this string buffer. The characters of the array argument are appended, in order, to the contents of this string buffer. The length of this string buffer increases by the length of the argument. @param str the characters to be appended. @return this string buffer. */ #if defined LIBO_INTERNAL_ONLY template typename libreoffice_internal::CharPtrDetector::TypeUtf16 append(T const & str) #else OUStringBuffer & append( const sal_Unicode * str ) #endif { return insert(getLength(), str); } /** Appends the string representation of the char array argument to this string buffer. Characters of the character array str are appended, in order, to the contents of this string buffer. The length of this string buffer increases by the value of len. @param str the characters to be appended; must be non-null, and must point to at least len characters @param len the number of characters to append; must be non-negative @return this string buffer. */ OUStringBuffer & append( const sal_Unicode * str, sal_Int32 len) { return insert(getLength(), str, len); } /** @overload This function accepts an ASCII string literal as its argument. @since LibreOffice 3.6 */ template< typename T > typename libreoffice_internal::ConstCharArrayDetector< T, OUStringBuffer& >::Type append( T& literal ) { return insert(getLength(), literal); } #if defined LIBO_INTERNAL_ONLY template typename libreoffice_internal::NonConstCharArrayDetector::TypeUtf16 append(T & value) { return append(static_cast(value)); } /** @overload @since LibreOffice 5.3 */ template typename libreoffice_internal::ConstCharArrayDetector< T, OUStringBuffer &>::TypeUtf16 append(T & literal) { return insert(getLength(), literal); } #endif #ifdef LIBO_INTERNAL_ONLY // "RTL_FAST_STRING" /** @overload @internal */ template< typename T1, typename T2 > OUStringBuffer& append( OUStringConcat< T1, T2 >&& c ) { return insert(getLength(), std::move(c)); } #endif /** Appends a 8-Bit ASCII character string to this string buffer. Since this method 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 between 0 and 127. The ASCII string must be NULL-terminated.

The characters of the array argument are appended, in order, to the contents of this string buffer. The length of this string buffer increases by the length of the argument. @param str the 8-Bit ASCII characters to be appended. @return this string buffer. */ OUStringBuffer & appendAscii( const char * str ) { return appendAscii( str, rtl_str_getLength( str ) ); } /** Appends a 8-Bit ASCII character string to this string buffer. Since this method 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 between 0 and 127.

Characters of the character array str are appended, in order, to the contents of this string buffer. The length of this string buffer increases by the value of len. @param str the 8-Bit ASCII characters to be appended; must be non-null, and must point to at least len characters @param len the number of characters to append; must be non-negative @return this string buffer. */ OUStringBuffer & appendAscii( const char * str, sal_Int32 len) { rtl_uStringbuffer_insert_ascii( &pData, &nCapacity, getLength(), str, len ); return *this; } /** Appends the string representation of the bool argument to the string buffer. The argument is converted to a string as if by the method String.valueOf, and the characters of that string are then appended to this string buffer. @param b a bool. @return this string buffer. @since LibreOffice 4.1 */ OUStringBuffer & append(bool b) { return insert(getLength(), b); } /// @cond INTERNAL // Pointer can be automatically converted to bool, which is unwanted here. // Explicitly delete all pointer append() overloads to prevent this // (except for char* and sal_Unicode* overloads, which are handled elsewhere). template< typename T > typename libreoffice_internal::Enable< void, !libreoffice_internal::CharPtrDetector< T* >::ok && !libreoffice_internal::SalUnicodePtrDetector< T* >::ok >::Type append( T* ) SAL_DELETED_FUNCTION; /// @endcond // This overload is needed because OUString has a ctor from rtl_uString*, but // the bool overload above would be preferred to the conversion. /** @internal */ OUStringBuffer & append(rtl_uString* str) { return append( OUString::unacquired( &str )); } /** Appends the string representation of the sal_Bool argument to the string buffer. The argument is converted to a string as if by the method String.valueOf, and the characters of that string are then appended to this string buffer. @param b a sal_Bool. @return this string buffer. */ OUStringBuffer & append(sal_Bool b) { return insert(getLength(), b); } /** Appends the string representation of the ASCII char argument to this string buffer. The argument is appended to the contents of this string buffer. The length of this string buffer increases by 1. @param c an ASCII char. @return this string buffer. @since LibreOffice 3.5 */ OUStringBuffer & append(char c) { assert(static_cast< unsigned char >(c) <= 0x7F); return insert(getLength(), c); } /** Appends the string representation of the char argument to this string buffer. The argument is appended to the contents of this string buffer. The length of this string buffer increases by 1. @param c a char. @return this string buffer. */ OUStringBuffer & append(sal_Unicode c) { return insert(getLength(), c); } #if defined LIBO_INTERNAL_ONLY void append(sal_uInt16) = delete; #endif /** Appends the string representation of the sal_Int32 argument to this string buffer. The argument is converted to a string as if by the method String.valueOf, and the characters of that string are then appended to this string buffer. @param i an sal_Int32. @param radix the radix @return this string buffer. */ OUStringBuffer & append(sal_Int32 i, sal_Int16 radix = 10 ) { return insert(getLength(), i, radix); } /** Appends the string representation of the long argument to this string buffer. The argument is converted to a string as if by the method String.valueOf, and the characters of that string are then appended to this string buffer. @param l a long. @param radix the radix @return this string buffer. */ OUStringBuffer & append(sal_Int64 l, sal_Int16 radix = 10 ) { return insert(getLength(), l, radix); } /** Appends the string representation of the float argument to this string buffer. The argument is converted to a string as if by the method String.valueOf, and the characters of that string are then appended to this string buffer. @param f a float. @return this string buffer. */ OUStringBuffer & append(float f) { return insert(getLength(), f); } /** Appends the string representation of the double argument to this string buffer. The argument is converted to a string as if by the method String.valueOf, and the characters of that string are then appended to this string buffer. @param d a double. @return this string buffer. */ OUStringBuffer & append(double d) { return insert(getLength(), d); } /** Appends a single UTF-32 character to this string buffer.

The single UTF-32 character will be represented within the string buffer as either one or two UTF-16 code units.

@param c a well-formed UTF-32 code unit (that is, a value in the range 00x10FFFF, but excluding 0xD8000xDFFF) @return this string buffer */ OUStringBuffer & appendUtf32(sal_uInt32 c) { return insertUtf32(getLength(), c); } /** Unsafe way to make space for a fixed amount of characters to be appended into this OUStringBuffer. A call to this function must immediately be followed by code that completely fills the uninitialized block pointed to by the return value. @param length the length of the uninitialized block of sal_Unicode entities; must be non-negative @return a pointer to the start of the uninitialized block; only valid until this OUStringBuffer's capacity changes @since LibreOffice 4.4 */ sal_Unicode * appendUninitialized(sal_Int32 length) SAL_RETURNS_NONNULL { sal_Int32 n = getLength(); rtl_uStringbuffer_insert(&pData, &nCapacity, n, NULL, length); return pData->buffer + n; } #if defined LIBO_INTERNAL_ONLY /** "Stream" operator to append a value to this OUStringBuffer. @internal @since LibreOffice 7.5 */ template OUStringBuffer& operator<<(T&& rValue) { return append(std::forward(rValue)); } #endif /** Inserts the string into this string buffer. The characters of the String argument are inserted, in order, into this string buffer at the indicated offset. The length of this string buffer is increased by the length of the argument.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this string buffer. @param offset the offset. @param str a string. @return this string buffer. */ #if defined LIBO_INTERNAL_ONLY OUStringBuffer & insert(sal_Int32 offset, std::u16string_view str) { if (str.size() > sal_uInt32(std::numeric_limits::max())) { throw std::bad_alloc(); } return insert( offset, str.data(), str.length() ); } #else OUStringBuffer & insert(sal_Int32 offset, const OUString & str) { return insert( offset, str.getStr(), str.getLength() ); } #endif #ifdef LIBO_INTERNAL_ONLY // "RTL_FAST_STRING" /** @overload @internal */ template OUStringBuffer& insert(sal_Int32 offset, OUStringConcat&& c) { const size_t l = c.length(); if (l == 0) return *this; if (l > o3tl::make_unsigned(std::numeric_limits::max() - pData->length)) throw std::bad_alloc(); rtl_uStringbuffer_insert(&pData, &nCapacity, offset, nullptr, l); /* insert the new characters */ c.addData(pData->buffer + offset); return *this; } #endif /** Inserts the string representation of the char array argument into this string buffer. The characters of the array argument are inserted into the contents of this string buffer at the position indicated by offset. The length of this string buffer increases by the length of the argument.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this string buffer. @param offset the offset. @param str a character array. @return this string buffer. */ OUStringBuffer & insert( sal_Int32 offset, const sal_Unicode * str ) { return insert( offset, str, rtl_ustr_getLength( str ) ); } /** Inserts the string representation of the char array argument into this string buffer. The characters of the array argument are inserted into the contents of this string buffer at the position indicated by offset. The length of this string buffer increases by the length of the argument.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this string buffer. @param offset the offset. @param str a character array. @param len the number of characters to append. @return this string buffer. */ OUStringBuffer & insert( sal_Int32 offset, const sal_Unicode * str, sal_Int32 len) { assert( len == 0 || str != NULL ); // cannot assert that in rtl_uStringbuffer_insert rtl_uStringbuffer_insert( &pData, &nCapacity, offset, str, len ); return *this; } /** @overload This function accepts an ASCII string literal as its argument. @since LibreOffice 3.6 */ template< typename T > typename libreoffice_internal::ConstCharArrayDetector< T, OUStringBuffer& >::Type insert( sal_Int32 offset, T& literal ) { assert( libreoffice_internal::ConstCharArrayDetector::isValid(literal)); rtl_uStringbuffer_insert_ascii( &pData, &nCapacity, offset, libreoffice_internal::ConstCharArrayDetector::toPointer(literal), libreoffice_internal::ConstCharArrayDetector::length); return *this; } #if defined LIBO_INTERNAL_ONLY /** @overload @since LibreOffice 5.3 */ template typename libreoffice_internal::ConstCharArrayDetector< T, OUStringBuffer &>::TypeUtf16 insert(sal_Int32 offset, T & literal) { return insert( offset, libreoffice_internal::ConstCharArrayDetector::toPointer(literal), libreoffice_internal::ConstCharArrayDetector::length); } #endif /** Inserts the string representation of the sal_Bool argument into this string buffer. The second argument is converted to a string as if by the method String.valueOf, and the characters of that string are then inserted into this string buffer at the indicated offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this string buffer. @param offset the offset. @param b a sal_Bool. @return this string buffer. */ OUStringBuffer & insert(sal_Int32 offset, sal_Bool b) { sal_Unicode sz[RTL_USTR_MAX_VALUEOFBOOLEAN]; return insert( offset, sz, rtl_ustr_valueOfBoolean( sz, b ) ); } /** Inserts the string representation of the bool argument into this string buffer. The second argument is converted to a string as if by the method OUString::boolean, and the characters of that string are then inserted into this string buffer at the indicated offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this string buffer. @param offset the offset. @param b a bool. @return this string buffer. @since LibreOffice 4.3 */ OUStringBuffer & insert(sal_Int32 offset, bool b) { sal_Unicode sz[RTL_USTR_MAX_VALUEOFBOOLEAN]; return insert( offset, sz, rtl_ustr_valueOfBoolean( sz, b ) ); } /** Inserts the string representation of the char argument into this string buffer. The second argument is inserted into the contents of this string buffer at the position indicated by offset. The length of this string buffer increases by one.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this string buffer. @param offset the offset. @param c a char. @return this string buffer. @since LibreOffice 3.6 */ OUStringBuffer & insert(sal_Int32 offset, char c) { sal_Unicode u = c; return insert( offset, &u, 1 ); } /** Inserts the string representation of the char argument into this string buffer. The second argument is inserted into the contents of this string buffer at the position indicated by offset. The length of this string buffer increases by one.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this string buffer. @param offset the offset. @param c a char. @return this string buffer. */ OUStringBuffer & insert(sal_Int32 offset, sal_Unicode c) { return insert( offset, &c, 1 ); } /** Inserts the string representation of the second sal_Int32 argument into this string buffer. The second argument is converted to a string as if by the method String.valueOf, and the characters of that string are then inserted into this string buffer at the indicated offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this string buffer. @param offset the offset. @param i an sal_Int32. @param radix the radix. @return this string buffer. @exception StringIndexOutOfBoundsException if the offset is invalid. */ OUStringBuffer & insert(sal_Int32 offset, sal_Int32 i, sal_Int16 radix = 10 ) { sal_Unicode sz[RTL_USTR_MAX_VALUEOFINT32]; return insert( offset, sz, rtl_ustr_valueOfInt32( sz, i, radix ) ); } /** Inserts the string representation of the long argument into this string buffer. The second argument is converted to a string as if by the method String.valueOf, and the characters of that string are then inserted into this string buffer at the indicated offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this string buffer. @param offset the offset. @param l a long. @param radix the radix. @return this string buffer. @exception StringIndexOutOfBoundsException if the offset is invalid. */ OUStringBuffer & insert(sal_Int32 offset, sal_Int64 l, sal_Int16 radix = 10 ) { sal_Unicode sz[RTL_USTR_MAX_VALUEOFINT64]; return insert( offset, sz, rtl_ustr_valueOfInt64( sz, l, radix ) ); } /** Inserts the string representation of the float argument into this string buffer. The second argument is converted to a string as if by the method String.valueOf, and the characters of that string are then inserted into this string buffer at the indicated offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this string buffer. @param offset the offset. @param f a float. @return this string buffer. @exception StringIndexOutOfBoundsException if the offset is invalid. */ OUStringBuffer & insert(sal_Int32 offset, float f) { // Same as rtl::str::valueOfFP, used for rtl_ustr_valueOfFloat rtl_math_doubleToUString(&pData, &nCapacity, offset, f, rtl_math_StringFormat_G, RTL_USTR_MAX_VALUEOFFLOAT - SAL_N_ELEMENTS("-x.E-xxx") + 1, '.', NULL, 0, true); return *this; } /** Inserts the string representation of the double argument into this string buffer. The second argument is converted to a string as if by the method String.valueOf, and the characters of that string are then inserted into this string buffer at the indicated offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this string buffer. @param offset the offset. @param d a double. @return this string buffer. @exception StringIndexOutOfBoundsException if the offset is invalid. */ OUStringBuffer & insert(sal_Int32 offset, double d) { // Same as rtl::str::valueOfFP, used for rtl_ustr_valueOfDouble rtl_math_doubleToUString(&pData, &nCapacity, offset, d, rtl_math_StringFormat_G, RTL_USTR_MAX_VALUEOFDOUBLE - SAL_N_ELEMENTS("-x.E-xxx") + 1, '.', NULL, 0, true); return *this; } /** Inserts a single UTF-32 character into this string buffer.

The single UTF-32 character will be represented within the string buffer as either one or two UTF-16 code units.

@param offset the offset into this string buffer (from zero to the length of this string buffer, inclusive) @param c a well-formed UTF-32 code unit (that is, a value in the range 00x10FFFF, but excluding 0xD8000xDFFF) @return this string buffer */ OUStringBuffer & insertUtf32(sal_Int32 offset, sal_uInt32 c) { rtl_uStringbuffer_insertUtf32(&pData, &nCapacity, offset, c); return *this; } /** Removes the characters in a substring of this sequence. The substring begins at the specified start and is len characters long. start must be >= 0 && <= This->length @param start The beginning index, inclusive @param len The substring length @return this string buffer. */ OUStringBuffer & remove( sal_Int32 start, sal_Int32 len ) { rtl_uStringbuffer_remove( &pData, start, len ); return *this; } /** Removes the tail of a string buffer start at the indicate position start must be >= 0 && <= This->length @param start The beginning index, inclusive. default to 0 @return this string buffer. @since LibreOffice 4.0 */ OUStringBuffer & truncate( sal_Int32 start = 0 ) { rtl_uStringbuffer_remove( &pData, start, getLength() - start ); return *this; } /** Replace all occurrences of oldChar in this string buffer with newChar. @since LibreOffice 4.0 @param oldChar the old character. @param newChar the new character. @return this string buffer */ OUStringBuffer& replace( sal_Unicode oldChar, sal_Unicode newChar ) { sal_Int32 index = 0; while((index = indexOf(oldChar, index)) >= 0) { pData->buffer[ index ] = newChar; } return *this; } /** Allows access to the internal data of this OUStringBuffer, for effective manipulation. This method should be used with care. After you have called this method, you may use the returned pInternalData or pInternalCapacity only as long as you make no other method call on this OUStringBuffer. @param pInternalData This output parameter receives a pointer to the internal data (rtl_uString pointer). pInternalData itself must not be null. @param pInternalCapacity This output parameter receives a pointer to the internal capacity. pInternalCapacity itself must not be null. */ void accessInternals(rtl_uString *** pInternalData, sal_Int32 ** pInternalCapacity) { *pInternalData = &pData; *pInternalCapacity = &nCapacity; } /** Returns the index within this string of the first occurrence of the specified character, starting the search at the specified index. @since LibreOffice 4.0 @param ch character to be located. @param fromIndex the index to start the search from. The index must be greater or equal than 0 and less or equal as the string length. @return the index of the first occurrence of the character in the character sequence represented by this string that is greater than or equal to fromIndex, or -1 if the character does not occur. */ sal_Int32 indexOf( sal_Unicode ch, sal_Int32 fromIndex = 0 ) const { assert( fromIndex >= 0 && fromIndex <= pData->length ); sal_Int32 ret = rtl_ustr_indexOfChar_WithLength( pData->buffer+fromIndex, pData->length-fromIndex, ch ); return (ret < 0 ? ret : ret+fromIndex); } /** Returns the index within this string of the last occurrence of the specified character, searching backward starting at the end. @since LibreOffice 4.0 @param ch character to be located. @return the index of the last occurrence of the character in the character sequence represented by this string, or -1 if the character does not occur. */ sal_Int32 lastIndexOf( sal_Unicode ch ) const { return rtl_ustr_lastIndexOfChar_WithLength( pData->buffer, pData->length, ch ); } /** Returns the index within this string of the last occurrence of the specified character, searching backward starting before the specified index. @since LibreOffice 4.0 @param ch character to be located. @param fromIndex the index before which to start the search. @return the index of the last occurrence of the character in the character sequence represented by this string that is less than fromIndex, or -1 if the character does not occur before that point. */ sal_Int32 lastIndexOf( sal_Unicode ch, sal_Int32 fromIndex ) const { assert( fromIndex >= 0 && fromIndex <= pData->length ); return rtl_ustr_lastIndexOfChar_WithLength( pData->buffer, fromIndex, ch ); } /** Returns the index within this string of the first occurrence of the specified substring, starting at the specified index. If str doesn't include any character, always -1 is returned. This is also the case, if both strings are empty. @since LibreOffice 4.0 @param str the substring to search for. @param fromIndex the index to start the search from. @return If the string argument occurs one or more times as a substring within this string at the starting index, then the index of the first character of the first such substring is returned. If it does not occur as a substring starting at fromIndex or beyond, -1 is returned. */ #if defined LIBO_INTERNAL_ONLY sal_Int32 indexOf( std::u16string_view str, sal_Int32 fromIndex = 0 ) const { assert( fromIndex >= 0 && fromIndex <= pData->length ); sal_Int32 ret = rtl_ustr_indexOfStr_WithLength( pData->buffer+fromIndex, pData->length-fromIndex, str.data(), str.length() ); return (ret < 0 ? ret : ret+fromIndex); } #else sal_Int32 indexOf( const OUString & str, sal_Int32 fromIndex = 0 ) const { assert( fromIndex >= 0 && fromIndex <= pData->length ); sal_Int32 ret = rtl_ustr_indexOfStr_WithLength( pData->buffer+fromIndex, pData->length-fromIndex, str.pData->buffer, str.pData->length ); return (ret < 0 ? ret : ret+fromIndex); } #endif /** @overload This function accepts an ASCII string literal as its argument. @since LibreOffice 4.0 */ template< typename T > typename libreoffice_internal::ConstCharArrayDetector< T, sal_Int32 >::Type indexOf( T& literal, sal_Int32 fromIndex = 0 ) const { assert( libreoffice_internal::ConstCharArrayDetector::isValid(literal)); sal_Int32 n = rtl_ustr_indexOfAscii_WithLength( pData->buffer + fromIndex, pData->length - fromIndex, libreoffice_internal::ConstCharArrayDetector::toPointer(literal), libreoffice_internal::ConstCharArrayDetector::length); return n < 0 ? n : n + fromIndex; } #if defined LIBO_INTERNAL_ONLY /** @overload @since LibreOffice 5.3 */ template typename libreoffice_internal::ConstCharArrayDetector::TypeUtf16 indexOf(T & literal, sal_Int32 fromIndex = 0) const { assert(fromIndex >= 0); auto n = rtl_ustr_indexOfStr_WithLength( pData->buffer + fromIndex, pData->length - fromIndex, libreoffice_internal::ConstCharArrayDetector::toPointer(literal), libreoffice_internal::ConstCharArrayDetector::length); return n < 0 ? n : n + fromIndex; } #endif /** Returns the index within this string of the last occurrence of the specified substring, searching backward starting at the end. The returned index indicates the starting index of the substring in this string. If str doesn't include any character, always -1 is returned. This is also the case, if both strings are empty. @since LibreOffice 4.0 @param str the substring to search for. @return If the string argument occurs one or more times as a substring within this string, then the index of the first character of the last such substring is returned. If it does not occur as a substring, -1 is returned. */ #if defined LIBO_INTERNAL_ONLY sal_Int32 lastIndexOf( std::u16string_view str ) const { return rtl_ustr_lastIndexOfStr_WithLength( pData->buffer, pData->length, str.data(), str.length() ); } #else sal_Int32 lastIndexOf( const OUString & str ) const { return rtl_ustr_lastIndexOfStr_WithLength( pData->buffer, pData->length, str.pData->buffer, str.pData->length ); } #endif /** Returns the index within this string of the last occurrence of the specified substring, searching backward starting before the specified index. The returned index indicates the starting index of the substring in this string. If str doesn't include any character, always -1 is returned. This is also the case, if both strings are empty. @since LibreOffice 4.0 @param str the substring to search for. @param fromIndex the index before which to start the search. @return If the string argument occurs one or more times as a substring within this string before the starting index, then the index of the first character of the last such substring is returned. Otherwise, -1 is returned. */ #if defined LIBO_INTERNAL_ONLY sal_Int32 lastIndexOf( std::u16string_view str, sal_Int32 fromIndex ) const { assert( fromIndex >= 0 && fromIndex <= pData->length ); return rtl_ustr_lastIndexOfStr_WithLength( pData->buffer, fromIndex, str.data(), str.length() ); } #else sal_Int32 lastIndexOf( const OUString & str, sal_Int32 fromIndex ) const { assert( fromIndex >= 0 && fromIndex <= pData->length ); return rtl_ustr_lastIndexOfStr_WithLength( pData->buffer, fromIndex, str.pData->buffer, str.pData->length ); } #endif /** @overload This function accepts an ASCII string literal as its argument. @since LibreOffice 4.0 */ template< typename T > typename libreoffice_internal::ConstCharArrayDetector< T, sal_Int32 >::Type lastIndexOf( T& literal ) const { assert( libreoffice_internal::ConstCharArrayDetector::isValid(literal)); return rtl_ustr_lastIndexOfAscii_WithLength( pData->buffer, pData->length, libreoffice_internal::ConstCharArrayDetector::toPointer(literal), libreoffice_internal::ConstCharArrayDetector::length); } #if defined LIBO_INTERNAL_ONLY /** @overload @since LibreOffice 5.3 */ template typename libreoffice_internal::ConstCharArrayDetector::TypeUtf16 lastIndexOf(T & literal) const { return rtl_ustr_lastIndexOfStr_WithLength( pData->buffer, pData->length, libreoffice_internal::ConstCharArrayDetector::toPointer(literal), libreoffice_internal::ConstCharArrayDetector::length); } #endif /** Strip the given character from the start of the buffer. @since LibreOffice 4.0 @param c the character to strip @return The number of characters stripped */ sal_Int32 stripStart(sal_Unicode c = ' ') { sal_Int32 index; for(index = 0; index < getLength() ; index++) { if(pData->buffer[ index ] != c) { break; } } if(index) { remove(0, index); } return index; } /** Strip the given character from the end of the buffer. @since LibreOffice 4.0 @param c the character to strip @return The number of characters stripped */ sal_Int32 stripEnd(sal_Unicode c = ' ') { sal_Int32 result = getLength(); sal_Int32 index; for(index = getLength(); index > 0 ; index--) { if(pData->buffer[ index - 1 ] != c) { break; } } if(index < getLength()) { truncate(index); } return result - getLength(); } /** Strip the given character from the both end of the buffer. @since LibreOffice 4.0 @param c the character to strip @return The number of characters stripped */ sal_Int32 strip(sal_Unicode c = ' ') { return stripStart(c) + stripEnd(c); } #if defined LIBO_INTERNAL_ONLY /** Returns a std::u16string_view that is a view of a substring of this string. The substring begins at the specified beginIndex. If beginIndex is negative or be greater than the length of this string, behaviour is undefined. @param beginIndex the beginning index, inclusive. @return the specified substring. */ SAL_WARN_UNUSED_RESULT std::u16string_view subView( sal_Int32 beginIndex ) const { assert(beginIndex >= 0); assert(beginIndex <= getLength()); return subView(beginIndex, getLength() - beginIndex); } /** Returns a std::u16string_view that is a view of a substring of this string. The substring begins at the specified beginIndex and contains count characters. If either beginIndex or count are negative, or beginIndex + count are greater than the length of this string then behaviour is undefined. @param beginIndex the beginning index, inclusive. @param count the number of characters. @return the specified substring. */ SAL_WARN_UNUSED_RESULT std::u16string_view subView( sal_Int32 beginIndex, sal_Int32 count ) const { assert(beginIndex >= 0); assert(count >= 0); assert(beginIndex <= getLength()); assert(count <= getLength() - beginIndex); return std::u16string_view(pData->buffer, sal_uInt32(pData->length)).substr(beginIndex, count); } #endif /** Returns a new string buffer that is a substring of this string. The substring begins at the specified beginIndex. If beginIndex is negative or be greater than the length of this string, behaviour is undefined. @param beginIndex the beginning index, inclusive. @return the specified substring. @since LibreOffice 4.1 */ OUStringBuffer copy( sal_Int32 beginIndex ) const { return copy( beginIndex, getLength() - beginIndex ); } /** Returns a new string buffer that is a substring of this string. The substring begins at the specified beginIndex and contains count characters. If either beginIndex or count are negative, or beginIndex + count are greater than the length of this string then behaviour is undefined. @param beginIndex the beginning index, inclusive. @param count the number of characters. @return the specified substring. @since LibreOffice 4.1 */ OUStringBuffer copy( sal_Int32 beginIndex, sal_Int32 count ) const { assert(beginIndex >= 0 && beginIndex <= getLength()); assert(count >= 0 && count <= getLength() - beginIndex); rtl_uString *pNew = NULL; rtl_uStringbuffer_newFromStr_WithLength( &pNew, getStr() + beginIndex, count ); return OUStringBuffer( pNew, count + 16 ); } private: OUStringBuffer( rtl_uString * value, const sal_Int32 capacity ) { pData = value; nCapacity = capacity; } /** A pointer to the data structure which contains the data. */ rtl_uString * pData; /** The len of the pData->buffer. */ sal_Int32 nCapacity; }; #if defined LIBO_INTERNAL_ONLY template<> struct ToStringHelper { static std::size_t length(OUStringBuffer const & s) { return s.getLength(); } sal_Unicode * operator()(sal_Unicode * buffer, OUStringBuffer const & s) const SAL_RETURNS_NONNULL { return addDataHelper(buffer, s.getStr(), s.getLength()); } }; #endif #if defined LIBO_INTERNAL_ONLY // Define this here to avoid circular includes inline OUString & OUString::operator+=( const OUStringBuffer & str ) & { // Call operator= if this is empty, otherwise rtl_uString_newConcat will attempt to // acquire() the str.pData buffer, which is part of the OUStringBuffer mutable state. if (isEmpty()) return operator=(str.toString()); else return internalAppend(str.pData); } inline OUString const& OUString::unacquired(const OUStringBuffer& str) { return unacquired(&str.pData); } #endif } #ifdef RTL_STRING_UNITTEST namespace rtl { typedef rtlunittest::OUStringBuffer OUStringBuffer; } #endif #if defined LIBO_INTERNAL_ONLY && !defined RTL_STRING_UNITTEST using ::rtl::OUStringBuffer; #endif #endif // INCLUDED_RTL_USTRBUF_HXX /* vim:set shiftwidth=4 softtabstop=4 expandtab: */