diff options
author | Jens-Heiner Rechtien <hr@openoffice.org> | 2000-09-18 14:18:43 +0000 |
---|---|---|
committer | Jens-Heiner Rechtien <hr@openoffice.org> | 2000-09-18 14:18:43 +0000 |
commit | 9399c662f36c385b0c705eb34e636a9aec450282 (patch) | |
tree | f502e9d9258960ff214ab90e98e31d0075e60196 /sal/inc/rtl/strbuf.h |
initial import
Diffstat (limited to 'sal/inc/rtl/strbuf.h')
-rw-r--r-- | sal/inc/rtl/strbuf.h | 152 |
1 files changed, 152 insertions, 0 deletions
diff --git a/sal/inc/rtl/strbuf.h b/sal/inc/rtl/strbuf.h new file mode 100644 index 000000000000..0c64f6794211 --- /dev/null +++ b/sal/inc/rtl/strbuf.h @@ -0,0 +1,152 @@ +/************************************************************************* + * + * $RCSfile: strbuf.h,v $ + * + * $Revision: 1.1.1.1 $ + * + * last change: $Author: hr $ $Date: 2000-09-18 15:17:14 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library 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 for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef _RTL_STRBUF_H_ +#define _RTL_STRBUF_H_ + +#ifndef _RTL_STRING_H_ +#include <rtl/string.h> +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * 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. + * <p> + * 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_ */ + + |