a1b2d28695
2008/04/01 12:34:04 thb 1.4.378.2: #i85898# Stripping all external header guards 2008/03/31 13:23:38 rt 1.4.378.1: #i87441# Change license header to LPGL v3.
122 lines
4.5 KiB
C
122 lines
4.5 KiB
C
/*************************************************************************
|
|
*
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
*
|
|
* Copyright 2008 by Sun Microsystems, Inc.
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* $RCSfile: strbuf.h,v $
|
|
* $Revision: 1.5 $
|
|
*
|
|
* This file is part of OpenOffice.org.
|
|
*
|
|
* OpenOffice.org is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License version 3
|
|
* only, as published by the Free Software Foundation.
|
|
*
|
|
* OpenOffice.org is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License version 3 for more details
|
|
* (a copy is included in the LICENSE file that accompanied this code).
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* version 3 along with OpenOffice.org. If not, see
|
|
* <http://www.openoffice.org/license.html>
|
|
* for a copy of the LGPLv3 License.
|
|
*
|
|
************************************************************************/
|
|
|
|
#ifndef _RTL_STRBUF_H_
|
|
#define _RTL_STRBUF_H_
|
|
|
|
#include <rtl/string.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** @HTML
|
|
Allocates a new <code>String</code> that contains characters from
|
|
the character array argument.
|
|
|
|
The <code>count</code> argument specifies
|
|
the length of the array. The initial capacity of the string buffer is
|
|
<code>16</code> plus the length of the string argument.
|
|
|
|
@param newStr out parameter, contains the new string. The reference count is 1.
|
|
@param value the initial value of the string.
|
|
@param count the length of value.
|
|
*/
|
|
void SAL_CALL rtl_stringbuffer_newFromStr_WithLength( rtl_String ** newStr,
|
|
const sal_Char * value,
|
|
sal_Int32 count);
|
|
|
|
/**
|
|
Allocates a new <code>String</code> that contains the same sequence of
|
|
characters as the string argument.
|
|
|
|
The initial capacity is the larger of:
|
|
<ul>
|
|
<li> The <code>bufferLen</code> argument.
|
|
<li> The <code>length</code> of the string argument.
|
|
</ul>
|
|
|
|
@param newStr out parameter, contains the new string. The reference count is 1.
|
|
@param capacity the initial len of the string buffer.
|
|
@param oldStr the initial value of the string.
|
|
@return the new capacity of the string buffer
|
|
*/
|
|
sal_Int32 SAL_CALL rtl_stringbuffer_newFromStringBuffer( rtl_String ** newStr,
|
|
sal_Int32 capacity,
|
|
rtl_String * olsStr );
|
|
|
|
/**
|
|
Ensures that the capacity of the buffer is at least equal to the
|
|
specified minimum.
|
|
|
|
If the current capacity of this string buffer is less than the
|
|
argument, then a new internal buffer is allocated with greater
|
|
capacity. The new capacity is the larger of:
|
|
<ul>
|
|
<li>The <code>minimumCapacity</code> argument.
|
|
<li>Twice the old capacity, plus <code>2</code>.
|
|
</ul>
|
|
If the <code>minimumCapacity</code> argument is nonpositive, this
|
|
method takes no action and simply returns.
|
|
|
|
@param capacity in: old capicity, out: new capacity.
|
|
@param minimumCapacity the minimum desired capacity.
|
|
*/
|
|
void SAL_CALL rtl_stringbuffer_ensureCapacity( /*inout*/rtl_String ** This,
|
|
/*inout*/sal_Int32* capacity,
|
|
sal_Int32 minimumCapacity);
|
|
|
|
|
|
/**
|
|
Inserts the string representation of the <code>char</code> 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
|
|
<code>offset</code>. The length of this string buffer increases by
|
|
the length of the argument.
|
|
|
|
@param capacity the capacity of the string buffer
|
|
@param offset the offset.
|
|
@param ch a character array.
|
|
@param len the number of characters to append.
|
|
@return this string buffer.
|
|
*/
|
|
void SAL_CALL rtl_stringbuffer_insert( /*inout*/rtl_String ** This,
|
|
/*inout*/sal_Int32 * capacity,
|
|
sal_Int32 offset,
|
|
const sal_Char * str,
|
|
sal_Int32 len);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _RTL_STRBUF_H_ */
|