LibreOffice
LibreOffice 5.3 SDK C/C++ API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
rtl::OStringBuffer Class Reference

A string buffer implements a mutable sequence of characters. More...

#include <strbuf.hxx>

Public Member Functions

 OStringBuffer ()
 Constructs a string buffer with no characters in it and an initial capacity of 16 characters. More...
 
 OStringBuffer (const OStringBuffer &value)
 Allocates a new string buffer that contains the same sequence of characters as the string buffer argument. More...
 
 OStringBuffer (int length)
 Constructs a string buffer with no characters in it and an initial capacity specified by the length argument. More...
 
 OStringBuffer (const OString &value)
 Constructs a string buffer so that it represents the same sequence of characters as the string argument. More...
 
template<typename T >
 OStringBuffer (const T &value, typename libreoffice_internal::CharPtrDetector< T, libreoffice_internal::Dummy >::Type=libreoffice_internal::Dummy())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
template<typename T >
 OStringBuffer (T &value, typename libreoffice_internal::NonConstCharArrayDetector< T, libreoffice_internal::Dummy >::Type=libreoffice_internal::Dummy())
 
template<typename T >
 OStringBuffer (T &literal, typename libreoffice_internal::ConstCharArrayDetector< T, libreoffice_internal::Dummy >::Type=libreoffice_internal::Dummy())
 Constructs a string buffer so that it represents the same sequence of characters as the string literal. More...
 
 OStringBuffer (const sal_Char *value, sal_Int32 length)
 Constructs a string buffer so that it represents the same sequence of characters as the string argument. More...
 
OStringBufferoperator= (const OStringBuffer &value)
 Assign to this a copy of value. More...
 
OStringBufferoperator= (OString const &string)
 Assign from a string. More...
 
template<typename T >
libreoffice_internal::ConstCharArrayDetector
< T, OStringBuffer & >::Type 
operator= (T &literal)
 Assign from a string literal. More...
 
 ~OStringBuffer ()
 Release the string data. More...
 
OString makeStringAndClear ()
 Fill the string data in the new string and clear the buffer. More...
 
sal_Int32 getLength () const
 Returns the length (character count) of this string buffer. More...
 
bool isEmpty () const
 Checks if a string buffer is empty. More...
 
sal_Int32 getCapacity () const
 Returns the current capacity of the String buffer. More...
 
void ensureCapacity (sal_Int32 minimumCapacity)
 Ensures that the capacity of the buffer is at least equal to the specified minimum. More...
 
void setLength (sal_Int32 newLength)
 Sets the length of this String buffer. More...
 
sal_Char charAt (sal_Int32 index)
 Returns the character at a specific index in this string buffer. More...
 
OStringBuffersetCharAt (sal_Int32 index, sal_Char ch)
 The character at the specified index of this string buffer is set to ch. More...
 
const sal_ChargetStr () const
 Return a null terminated character array. More...
 
sal_Charoperator[] (sal_Int32 index)
 Access to individual characters. More...
 
const OString toString () const
 Return a OString instance reflecting the current content of this OStringBuffer. More...
 
OStringBufferappend (const OString &str)
 Appends the string to this string buffer. More...
 
template<typename T >
libreoffice_internal::CharPtrDetector
< T, OStringBuffer & >::Type 
append (const T &str)
 Appends the string representation of the char array argument to this string buffer. More...
 
template<typename T >
libreoffice_internal::NonConstCharArrayDetector
< T, OStringBuffer & >::Type 
append (T &str)
 
template<typename T >
libreoffice_internal::ConstCharArrayDetector
< T, OStringBuffer & >::Type 
append (T &literal)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function accepts an ASCII string literal as its argument. More...
 
OStringBufferappend (const sal_Char *str, sal_Int32 len)
 Appends the string representation of the char array argument to this string buffer. More...
 
OStringBufferappend (sal_Bool b)
 Appends the string representation of the sal_Bool argument to the string buffer. More...
 
OStringBufferappend (bool b)
 Appends the string representation of the bool argument to the string buffer. More...
 
OStringBufferappend (sal_Char c)
 Appends the string representation of the char argument to this string buffer. More...
 
OStringBufferappend (sal_Int32 i, sal_Int16 radix=10)
 Appends the string representation of the sal_Int32 argument to this string buffer. More...
 
OStringBufferappend (sal_Int64 l, sal_Int16 radix=10)
 Appends the string representation of the long argument to this string buffer. More...
 
OStringBufferappend (float f)
 Appends the string representation of the float argument to this string buffer. More...
 
OStringBufferappend (double d)
 Appends the string representation of the double argument to this string buffer. More...
 
char * appendUninitialized (sal_Int32 length)
 Unsafe way to make space for a fixed amount of characters to be appended into this OStringBuffer. More...
 
OStringBufferinsert (sal_Int32 offset, const OString &str)
 Inserts the string into this string buffer. More...
 
template<typename T >
libreoffice_internal::CharPtrDetector
< T, OStringBuffer & >::Type 
insert (sal_Int32 offset, const T &str)
 Inserts the string representation of the char array argument into this string buffer. More...
 
template<typename T >
libreoffice_internal::NonConstCharArrayDetector
< T, OStringBuffer & >::Type 
insert (sal_Int32 offset, T &str)
 
template<typename T >
libreoffice_internal::ConstCharArrayDetector
< T, OStringBuffer & >::Type 
insert (sal_Int32 offset, T &literal)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function accepts an ASCII string literal as its argument. More...
 
OStringBufferinsert (sal_Int32 offset, const sal_Char *str, sal_Int32 len)
 Inserts the string representation of the char array argument into this string buffer. More...
 
OStringBufferinsert (sal_Int32 offset, sal_Bool b)
 Inserts the string representation of the sal_Bool argument into this string buffer. More...
 
OStringBufferinsert (sal_Int32 offset, bool b)
 Inserts the string representation of the bool argument into this string buffer. More...
 
OStringBufferinsert (sal_Int32 offset, sal_Char c)
 Inserts the string representation of the char argument into this string buffer. More...
 
OStringBufferinsert (sal_Int32 offset, sal_Int32 i, sal_Int16 radix=10)
 Inserts the string representation of the second sal_Int32 argument into this string buffer. More...
 
OStringBufferinsert (sal_Int32 offset, sal_Int64 l, sal_Int16 radix=10)
 Inserts the string representation of the long argument into this string buffer. More...
 
OStringBuffer insert (sal_Int32 offset, float f)
 Inserts the string representation of the float argument into this string buffer. More...
 
OStringBufferinsert (sal_Int32 offset, double d)
 Inserts the string representation of the double argument into this string buffer. More...
 
OStringBufferremove (sal_Int32 start, sal_Int32 len)
 Removes the characters in a substring of this sequence. More...
 

Detailed Description

A string buffer implements a mutable sequence of characters.

Constructor & Destructor Documentation

rtl::OStringBuffer::OStringBuffer ( )
inline

Constructs a string buffer with no characters in it and an initial capacity of 16 characters.

rtl::OStringBuffer::OStringBuffer ( const OStringBuffer value)
inline

Allocates a new string buffer that contains the same sequence of characters as the string buffer argument.

Parameters
valuea OStringBuffer.
rtl::OStringBuffer::OStringBuffer ( int  length)
inlineexplicit

Constructs a string buffer with no characters in it and an initial capacity specified by the length argument.

Parameters
lengththe initial capacity.
rtl::OStringBuffer::OStringBuffer ( const OString value)
inline

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.

Parameters
valuethe initial string value.
template<typename T >
rtl::OStringBuffer::OStringBuffer ( const T &  value,
typename libreoffice_internal::CharPtrDetector< T, libreoffice_internal::Dummy >::Type  = libreoffice_internal::Dummy() 
)
inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since
LibreOffice 3.6
template<typename T >
rtl::OStringBuffer::OStringBuffer ( T &  value,
typename libreoffice_internal::NonConstCharArrayDetector< T, libreoffice_internal::Dummy >::Type  = libreoffice_internal::Dummy() 
)
inline
template<typename T >
rtl::OStringBuffer::OStringBuffer ( T &  literal,
typename libreoffice_internal::ConstCharArrayDetector< T, libreoffice_internal::Dummy >::Type  = libreoffice_internal::Dummy() 
)
inline

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
Parameters
literala string literal
rtl::OStringBuffer::OStringBuffer ( const sal_Char value,
sal_Int32  length 
)
inline

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

Parameters
valuea character array.
lengththe number of character which should be copied. The character array length must be greater or equal than this value.
rtl::OStringBuffer::~OStringBuffer ( )
inline

Release the string data.

Member Function Documentation

OStringBuffer& rtl::OStringBuffer::append ( const OString str)
inline

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.

Parameters
stra string.
Returns
this string buffer.
template<typename T >
libreoffice_internal::CharPtrDetector< T, OStringBuffer& >::Type rtl::OStringBuffer::append ( const T &  str)
inline

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.

Parameters
strthe characters to be appended.
Returns
this string buffer.
template<typename T >
libreoffice_internal::NonConstCharArrayDetector< T, OStringBuffer& >::Type rtl::OStringBuffer::append ( T &  str)
inline
template<typename T >
libreoffice_internal::ConstCharArrayDetector< T, OStringBuffer& >::Type rtl::OStringBuffer::append ( T &  literal)
inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function accepts an ASCII string literal as its argument.

Since
LibreOffice 3.6
OStringBuffer& rtl::OStringBuffer::append ( const sal_Char str,
sal_Int32  len 
)
inline

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.

Parameters
strthe characters to be appended; must be non-null, and must point to at least len characters
lenthe number of characters to append; must be non-negative
Returns
this string buffer.
OStringBuffer& rtl::OStringBuffer::append ( sal_Bool  b)
inline

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.

Parameters
ba sal_Bool.
Returns
this string buffer.
OStringBuffer& rtl::OStringBuffer::append ( bool  b)
inline

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.

Parameters
ba bool.
Returns
this string buffer.
Since
LibreOffice 4.3
OStringBuffer& rtl::OStringBuffer::append ( sal_Char  c)
inline

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.

Parameters
ca char.
Returns
this string buffer.
OStringBuffer& rtl::OStringBuffer::append ( sal_Int32  i,
sal_Int16  radix = 10 
)
inline

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.

Parameters
ian sal_Int32.
radixthe radix
Returns
this string buffer.
OStringBuffer& rtl::OStringBuffer::append ( sal_Int64  l,
sal_Int16  radix = 10 
)
inline

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.

Parameters
la long.
radixthe radix
Returns
this string buffer.
OStringBuffer& rtl::OStringBuffer::append ( float  f)
inline

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.

Parameters
fa float.
Returns
this string buffer.
OStringBuffer& rtl::OStringBuffer::append ( double  d)
inline

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.

Parameters
da double.
Returns
this string buffer.
char* rtl::OStringBuffer::appendUninitialized ( sal_Int32  length)
inline

Unsafe way to make space for a fixed amount of characters to be appended into this OStringBuffer.

A call to this function must immediately be followed by code that completely fills the uninitialized block pointed to by the return value.

Parameters
lengththe length of the uninitialized block of char entities; must be non-negative
Returns
a pointer to the start of the uninitialized block; only valid until this OStringBuffer's capacity changes
Since
LibreOffice 4.4
sal_Char rtl::OStringBuffer::charAt ( sal_Int32  index)
inline

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.

Parameters
indexthe index of the desired character.
Returns
the character at the specified index of this string buffer.
void rtl::OStringBuffer::ensureCapacity ( sal_Int32  minimumCapacity)
inline

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.

Parameters
minimumCapacitythe minimum desired capacity.
sal_Int32 rtl::OStringBuffer::getCapacity ( ) const
inline

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.

Returns
the current capacity of this string buffer.
sal_Int32 rtl::OStringBuffer::getLength ( ) const
inline

Returns the length (character count) of this string buffer.

Returns
the number of characters in this string buffer.
const sal_Char* rtl::OStringBuffer::getStr ( ) const
inline

Return a null terminated character array.

OStringBuffer& rtl::OStringBuffer::insert ( sal_Int32  offset,
const OString str 
)
inline

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.

Parameters
offsetthe offset.
stra string.
Returns
this string buffer.
template<typename T >
libreoffice_internal::CharPtrDetector< T, OStringBuffer& >::Type rtl::OStringBuffer::insert ( sal_Int32  offset,
const T &  str 
)
inline

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.

Parameters
offsetthe offset.
stra character array.
Returns
this string buffer.
template<typename T >
libreoffice_internal::NonConstCharArrayDetector< T, OStringBuffer& >::Type rtl::OStringBuffer::insert ( sal_Int32  offset,
T &  str 
)
inline
template<typename T >
libreoffice_internal::ConstCharArrayDetector< T, OStringBuffer& >::Type rtl::OStringBuffer::insert ( sal_Int32  offset,
T &  literal 
)
inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function accepts an ASCII string literal as its argument.

Since
LibreOffice 3.6
OStringBuffer& rtl::OStringBuffer::insert ( sal_Int32  offset,
const sal_Char str,
sal_Int32  len 
)
inline

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.

Parameters
offsetthe offset.
stra character array.
lenthe number of characters to append.
Returns
this string buffer.
OStringBuffer& rtl::OStringBuffer::insert ( sal_Int32  offset,
sal_Bool  b 
)
inline

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.

Parameters
offsetthe offset.
ba sal_Bool.
Returns
this string buffer.
OStringBuffer& rtl::OStringBuffer::insert ( sal_Int32  offset,
bool  b 
)
inline

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 OString::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.

Parameters
offsetthe offset.
ba bool.
Returns
this string buffer.
Since
LibreOffice 4.3
OStringBuffer& rtl::OStringBuffer::insert ( sal_Int32  offset,
sal_Char  c 
)
inline

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.

Parameters
offsetthe offset.
ca char.
Returns
this string buffer.
OStringBuffer& rtl::OStringBuffer::insert ( sal_Int32  offset,
sal_Int32  i,
sal_Int16  radix = 10 
)
inline

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.

Parameters
offsetthe offset.
ian sal_Int32.
radixthe radix
Returns
this string buffer.
OStringBuffer& rtl::OStringBuffer::insert ( sal_Int32  offset,
sal_Int64  l,
sal_Int16  radix = 10 
)
inline

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.

Parameters
offsetthe offset.
la long.
radixthe radix
Returns
this string buffer.
OStringBuffer rtl::OStringBuffer::insert ( sal_Int32  offset,
float  f 
)
inline

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.

Parameters
offsetthe offset.
fa float.
Returns
this string buffer.
OStringBuffer& rtl::OStringBuffer::insert ( sal_Int32  offset,
double  d 
)
inline

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.

Parameters
offsetthe offset.
da double.
Returns
this string buffer.
bool rtl::OStringBuffer::isEmpty ( ) const
inline

Checks if a string buffer is empty.

Returns
true if the string buffer is empty; false, otherwise.
Since
LibreOffice 4.1
OString rtl::OStringBuffer::makeStringAndClear ( )
inline

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.

Returns
the string previously contained in the buffer.
OStringBuffer& rtl::OStringBuffer::operator= ( const OStringBuffer value)
inline

Assign to this a copy of value.

OStringBuffer& rtl::OStringBuffer::operator= ( OString const &  string)
inline

Assign from a string.

Since
LibreOffice 5.3
template<typename T >
libreoffice_internal::ConstCharArrayDetector<T, OStringBuffer &>::Type rtl::OStringBuffer::operator= ( T &  literal)
inline

Assign from a string literal.

Since
LibreOffice 5.3
sal_Char& rtl::OStringBuffer::operator[] ( sal_Int32  index)
inline

Access to individual characters.

Parameters
indexmust be non-negative and less than length.
Returns
a reference to the character at the given index.
Since
LibreOffice 3.5
OStringBuffer& rtl::OStringBuffer::remove ( sal_Int32  start,
sal_Int32  len 
)
inline

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

Parameters
startThe beginning index, inclusive
lenThe substring length
Returns
this string buffer.
OStringBuffer& rtl::OStringBuffer::setCharAt ( sal_Int32  index,
sal_Char  ch 
)
inline

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.

Parameters
indexthe index of the character to modify.
chthe new character.
void rtl::OStringBuffer::setLength ( sal_Int32  newLength)
inline

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 ('&#92;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.

Parameters
newLengththe new length of the buffer.
const OString rtl::OStringBuffer::toString ( ) const
inline

Return a OString instance reflecting the current content of this OStringBuffer.


The documentation for this class was generated from the following file: