/* -*- 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 . */ #ifndef _RTL_STRBUF_HXX_ #define _RTL_STRBUF_HXX_ #include "sal/config.h" #include #include #include #include #include #ifdef RTL_FAST_STRING #include #endif #ifdef __cplusplus // 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 { /// @cond INTERNAL #ifdef RTL_STRING_UNITTEST #undef rtl // helper macro to make functions appear more readable #define RTL_STRING_CONST_FUNCTION rtl_string_unittest_const_literal_function = true; #else #define RTL_STRING_CONST_FUNCTION #endif /// @endcond /** A string buffer implements a mutable sequence of characters.

String buffers are safe for use by multiple threads. The methods are synchronized where necessary so that all the operations on any particular instance behave as if they occur in some serial order.

String buffers are used by the compiler to implement the binary string concatenation operator +. For example, the code: 

        x = "a" + 4 + "c"

is compiled to the equivalent of: 

        x = new OStringBuffer().append("a").append(4).append("c")
                              .makeStringAndClear()

The principal operations on a OStringBuffer are the append and insert methods, which are overloaded so as to accept data of any type. Each effectively converts a given datum to a string and then appends or inserts the characters of that string to the string buffer. The append method always adds these characters at the end of the buffer; the insert method adds the characters at a specified point.

For example, if z refers to a string buffer object whose current contents are "start", then the method call z.append("le") would cause the string buffer to contain "startle", whereas z.insert(4, "le") would alter the string buffer to contain "starlet".

Every string buffer has a capacity. As long as the length of the character sequence contained in the string buffer does not exceed the capacity, it is not necessary to allocate a new internal buffer array. If the internal buffer overflows, it is automatically made larger. */ class SAL_WARN_UNUSED OStringBuffer { public: /** Constructs a string buffer with no characters in it and an initial capacity of 16 characters. */ OStringBuffer() : pData(NULL) , nCapacity( 16 ) { rtl_string_new_WithLength( &pData, nCapacity ); } /** Allocates a new string buffer that contains the same sequence of characters as the string buffer argument. @param value a OStringBuffer. */ OStringBuffer( const OStringBuffer & value ) : pData(NULL) , nCapacity( value.nCapacity ) { rtl_stringbuffer_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 OStringBuffer(int length) : pData(NULL) , nCapacity( length ) { rtl_string_new_WithLength( &pData, length ); } /** 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 string value. */ OStringBuffer(const OString& value) : pData(NULL) , nCapacity( value.getLength() + 16 ) { rtl_stringbuffer_newFromStr_WithLength( &pData, value.getStr(), value.getLength() ); } /** @overload @since LibreOffice 3.6 */ template< typename T > OStringBuffer( const T& value, typename internal::CharPtrDetector< T, internal::Dummy >::Type = internal::Dummy()) : pData(NULL) { sal_Int32 length = rtl_str_getLength( value ); nCapacity = length + 16; rtl_stringbuffer_newFromStr_WithLength( &pData, value, length ); } template< typename T > OStringBuffer( T& value, typename internal::NonConstCharArrayDetector< T, internal::Dummy >::Type = internal::Dummy()) : pData(NULL) { sal_Int32 length = rtl_str_getLength( value ); nCapacity = length + 16; rtl_stringbuffer_newFromStr_WithLength( &pData, value, length ); } /** Constructs a string buffer so that it represents the same sequence of characters as the string literal. If there are any embedded \0's in the string literal, the result is undefined. Use the overload that explicitly accepts length. @since LibreOffice 3.6 @param literal a string literal */ template< typename T > OStringBuffer( T& literal, typename internal::ConstCharArrayDetector< T, internal::Dummy >::Type = internal::Dummy()) : pData(NULL) , nCapacity( internal::ConstCharArrayDetector< T, void >::size - 1 + 16 ) { assert( strlen( literal ) == internal::ConstCharArrayDetector< T >::size - 1 ); rtl_string_newFromLiteral( &pData, literal, internal::ConstCharArrayDetector< T, void >::size - 1, 16 ); #ifdef RTL_STRING_UNITTEST rtl_string_unittest_const_literal = true; #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 length @param value a character array. @param length the number of character which should be copied. The character array length must be greater or equal than this value. */ OStringBuffer(const sal_Char * value, sal_Int32 length) : pData(NULL) , nCapacity( length + 16 ) { rtl_stringbuffer_newFromStr_WithLength( &pData, value, length ); } #ifdef RTL_FAST_STRING /** @overload @internal */ template< typename T1, typename T2 > OStringBuffer( const OStringConcat< T1, T2 >& c ) { const sal_Int32 l = c.length(); nCapacity = l + 16; pData = rtl_string_alloc( nCapacity ); char* end = c.addData( pData->buffer ); *end = '\0'; pData->length = end - pData->buffer; } #endif /** Assign to this a copy of value. */ OStringBuffer& operator = ( const OStringBuffer& value ) { if (this != &value) { rtl_stringbuffer_newFromStringBuffer(&pData, value.nCapacity, value.pData); nCapacity = value.nCapacity; } return *this; } /** Release the string data. */ ~OStringBuffer() { rtl_string_release( pData ); } /** Fill the string data in the new string and clear the buffer. This method is more efficient than the contructor of the string. It does not copy the buffer. @return the string previously contained in the buffer. */ OString makeStringAndClear() { OString aRet( pData ); rtl_string_new(&pData); nCapacity = 0; return aRet; } /** 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 SAL_THROW(()) { 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_stringbuffer_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_stringbuffer_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::OStringBuffer::operator [] instead") sal_Char charAt( sal_Int32 index ) { 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::OStringBuffer::operator [] instead") OStringBuffer & setCharAt(sal_Int32 index, sal_Char ch) { assert(index >= 0 && index < pData->length); pData->buffer[ index ] = ch; return *this; } /** Return a null terminated character array. */ const sal_Char* getStr() const { 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_Char & operator [](sal_Int32 index) { assert(index >= 0 && index < pData->length); return pData->buffer[index]; } /** Return a OString instance reflecting the current content of this OStringBuffer. */ const OString toString() const { return OString(pData->buffer, pData->length); } /** Appends the string to this string buffer. The characters of the String 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. */ OStringBuffer & append(const OString &str) { return append( str.getStr(), str.getLength() ); } /** 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. */ template< typename T > typename internal::CharPtrDetector< T, OStringBuffer& >::Type append( const T& str ) { return append( str, rtl_str_getLength( str ) ); } template< typename T > typename internal::NonConstCharArrayDetector< T, OStringBuffer& >::Type append( T& str ) { return append( str, rtl_str_getLength( str ) ); } /** @overload This function accepts an ASCII string literal as its argument. @since LibreOffice 3.6 */ template< typename T > typename internal::ConstCharArrayDetector< T, OStringBuffer& >::Type append( T& literal ) { RTL_STRING_CONST_FUNCTION assert( strlen( literal ) == internal::ConstCharArrayDetector< T >::size - 1 ); rtl_stringbuffer_insert( &pData, &nCapacity, getLength(), literal, internal::ConstCharArrayDetector< T, void >::size - 1 ); return *this; } /** 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. */ OStringBuffer & append( const sal_Char * str, sal_Int32 len) { // insert behind the last character rtl_stringbuffer_insert( &pData, &nCapacity, getLength(), str, len ); return *this; } #ifdef RTL_FAST_STRING /** @overload @internal */ template< typename T1, typename T2 > OStringBuffer& append( const OStringConcat< T1, T2 >& c ) { const int l = c.length(); if( l == 0 ) return *this; rtl_stringbuffer_ensureCapacity( &pData, &nCapacity, pData->length + l ); char* end = c.addData( pData->buffer + pData->length ); *end = '\0'; pData->length = end - pData->buffer; return *this; } #endif /** 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. */ OStringBuffer & append(sal_Bool b) { sal_Char sz[RTL_STR_MAX_VALUEOFBOOLEAN]; return append( sz, rtl_str_valueOfBoolean( sz, b ) ); } /** 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. */ OStringBuffer & append(sal_Char c) { return append( &c, 1 ); } /** 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. */ OStringBuffer & append(sal_Int32 i, sal_Int16 radix = 10 ) { sal_Char sz[RTL_STR_MAX_VALUEOFINT32]; return append( sz, rtl_str_valueOfInt32( sz, 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. */ OStringBuffer & append(sal_Int64 l, sal_Int16 radix = 10 ) { sal_Char sz[RTL_STR_MAX_VALUEOFINT64]; return append( sz, rtl_str_valueOfInt64( sz, 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. */ OStringBuffer & append(float f) { sal_Char sz[RTL_STR_MAX_VALUEOFFLOAT]; return append( sz, rtl_str_valueOfFloat( sz, 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. */ OStringBuffer & append(double d) { sal_Char sz[RTL_STR_MAX_VALUEOFDOUBLE]; return append( sz, rtl_str_valueOfDouble( sz, d ) ); } /** 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. */ OStringBuffer & insert(sal_Int32 offset, const OString & str) { return insert( offset, str.getStr(), str.getLength() ); } /** 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. */ template< typename T > typename internal::CharPtrDetector< T, OStringBuffer& >::Type insert( sal_Int32 offset, const T& str ) { return insert( offset, str, rtl_str_getLength( str ) ); } template< typename T > typename internal::NonConstCharArrayDetector< T, OStringBuffer& >::Type insert( sal_Int32 offset, T& str ) { return insert( offset, str, rtl_str_getLength( str ) ); } /** @overload This function accepts an ASCII string literal as its argument. @since LibreOffice 3.6 */ template< typename T > typename internal::ConstCharArrayDetector< T, OStringBuffer& >::Type insert( sal_Int32 offset, T& literal ) { RTL_STRING_CONST_FUNCTION assert( strlen( literal ) == internal::ConstCharArrayDetector< T >::size - 1 ); rtl_stringbuffer_insert( &pData, &nCapacity, offset, literal, internal::ConstCharArrayDetector< T, void >::size - 1 ); return *this; } /** 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. */ OStringBuffer & insert( sal_Int32 offset, const sal_Char * str, sal_Int32 len) { // insert behind the last character rtl_stringbuffer_insert( &pData, &nCapacity, offset, str, len ); return *this; } /** 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. */ OStringBuffer & insert(sal_Int32 offset, sal_Bool b) { sal_Char sz[RTL_STR_MAX_VALUEOFBOOLEAN]; return insert( offset, sz, rtl_str_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. */ OStringBuffer & insert(sal_Int32 offset, sal_Char 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. */ OStringBuffer & insert(sal_Int32 offset, sal_Int32 i, sal_Int16 radix = 10 ) { sal_Char sz[RTL_STR_MAX_VALUEOFINT32]; return insert( offset, sz, rtl_str_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. */ OStringBuffer & insert(sal_Int32 offset, sal_Int64 l, sal_Int16 radix = 10 ) { sal_Char sz[RTL_STR_MAX_VALUEOFINT64]; return insert( offset, sz, rtl_str_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. */ OStringBuffer insert(sal_Int32 offset, float f) { sal_Char sz[RTL_STR_MAX_VALUEOFFLOAT]; return insert( offset, sz, rtl_str_valueOfFloat( sz, f ) ); } /** 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. */ OStringBuffer & insert(sal_Int32 offset, double d) { sal_Char sz[RTL_STR_MAX_VALUEOFDOUBLE]; return insert( offset, sz, rtl_str_valueOfDouble( sz, d ) ); } /** 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 && <= getLength() && <= end @param start The beginning index, inclusive @param len The substring length @return this string buffer. */ OStringBuffer & remove( sal_Int32 start, sal_Int32 len ) { rtl_stringbuffer_remove( &pData, start, len ); return *this; } #ifdef LIBO_INTERNAL_ONLY // This is to complement the RTL_FAST_STRING operator+, which allows any combination of valid operands, // even two buffers. It's intentional it returns OString, just like the operator+ would in the fast variant. #ifndef RTL_FAST_STRING /** @internal @since LibreOffice 4.1 */ friend OString operator+( const OStringBuffer& str1, const OStringBuffer& str2 ) SAL_THROW(()) { return OString( str1.pData ).concat( str2.pData ); } #endif #endif private: /** A pointer to the data structur which contains the data. */ rtl_String * pData; /** The len of the pData->buffer. */ sal_Int32 nCapacity; }; #ifdef RTL_FAST_STRING /** @internal */ template<> struct ToStringHelper< OStringBuffer > { static int length( const OStringBuffer& s ) { return s.getLength(); } static char* addData( char* buffer, const OStringBuffer& s ) { return addDataHelper( buffer, s.getStr(), s.getLength()); } static const bool allowOStringConcat = true; static const bool allowOUStringConcat = false; }; #endif } #ifdef RTL_STRING_UNITTEST namespace rtl { typedef rtlunittest::OStringBuffer OStringBuffer; } #undef RTL_STRING_CONST_FUNCTION #endif #ifdef RTL_USING using ::rtl::OStringBuffer; #endif #endif /* __cplusplus */ #endif /* _RTL_STRBUF_HXX_ */ /* vim:set shiftwidth=4 softtabstop=4 expandtab: */