2002-10-12 13:37:38 +02:00
|
|
|
/**
|
|
|
|
* @file BLI_dynstr.h
|
|
|
|
*
|
|
|
|
* A dynamically sized string ADT.
|
|
|
|
* This ADT is designed purely for dynamic string creation
|
|
|
|
* through appending, not for general usage, the intent is
|
|
|
|
* to build up dynamic strings using a DynStr object, then
|
|
|
|
* convert it to a c-string and work with that.
|
|
|
|
*
|
|
|
|
* $Id$
|
|
|
|
*
|
2008-01-07 20:13:47 +01:00
|
|
|
* ***** BEGIN GPL LICENSE BLOCK *****
|
2002-10-12 13:37:38 +02:00
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU General Public License
|
|
|
|
* as published by the Free Software Foundation; either version 2
|
2008-01-07 20:13:47 +01:00
|
|
|
* of the License, or (at your option) any later version.
|
2002-10-12 13:37:38 +02:00
|
|
|
*
|
|
|
|
* This program 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 General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, write to the Free Software Foundation,
|
2010-02-12 14:34:04 +01:00
|
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
2002-10-12 13:37:38 +02:00
|
|
|
*
|
|
|
|
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
|
|
|
|
* All rights reserved.
|
|
|
|
*
|
|
|
|
* The Original Code is: all of this file.
|
|
|
|
*
|
|
|
|
* Contributor(s): none yet.
|
|
|
|
*
|
2008-01-07 20:13:47 +01:00
|
|
|
* ***** END GPL LICENSE BLOCK *****
|
2002-10-12 13:37:38 +02:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef BLI_DYNSTR_H
|
|
|
|
#define BLI_DYNSTR_H
|
|
|
|
|
2008-12-29 14:38:08 +01:00
|
|
|
#include <stdarg.h>
|
|
|
|
|
2002-10-12 13:37:38 +02:00
|
|
|
struct DynStr;
|
|
|
|
|
|
|
|
/** The abstract DynStr type */
|
|
|
|
typedef struct DynStr DynStr;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Create a new DynStr.
|
|
|
|
*
|
|
|
|
* @return Pointer to a new DynStr.
|
|
|
|
*/
|
|
|
|
DynStr* BLI_dynstr_new (void);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Append a c-string to a DynStr.
|
|
|
|
*
|
|
|
|
* @param ds The DynStr to append to.
|
|
|
|
* @param cstr The c-string to append.
|
|
|
|
*/
|
2008-11-11 16:03:26 +01:00
|
|
|
void BLI_dynstr_append (DynStr *ds, const char *cstr);
|
|
|
|
|
2010-02-27 00:56:16 +01:00
|
|
|
/**
|
|
|
|
* Append a length clamped c-string to a DynStr.
|
|
|
|
*
|
|
|
|
* @param ds The DynStr to append to.
|
|
|
|
* @param cstr The c-string to append.
|
|
|
|
* @param len The maximum length of the c-string to copy.
|
|
|
|
*/
|
|
|
|
void BLI_dynstr_nappend (DynStr *ds, const char *cstr, int len);
|
|
|
|
|
2008-11-11 16:03:26 +01:00
|
|
|
/**
|
|
|
|
* Append a c-string to a DynStr, but with formatting like printf.
|
|
|
|
*
|
|
|
|
* @param ds The DynStr to append to.
|
|
|
|
* @param format The printf format string to use.
|
|
|
|
*/
|
2010-12-04 12:44:56 +01:00
|
|
|
void BLI_dynstr_appendf (DynStr *ds, const char *format, ...)
|
|
|
|
#ifdef __GNUC__
|
|
|
|
__attribute__ ((format (printf, 2, 3)));
|
|
|
|
#endif
|
|
|
|
;
|
2008-12-29 14:38:08 +01:00
|
|
|
void BLI_dynstr_vappendf (DynStr *ds, const char *format, va_list args);
|
2002-10-12 13:37:38 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Find the length of a DynStr.
|
|
|
|
*
|
|
|
|
* @param ds The DynStr of interest.
|
|
|
|
* @return The length of @a ds.
|
|
|
|
*/
|
|
|
|
int BLI_dynstr_get_len (DynStr *ds);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get a DynStr's contents as a c-string.
|
|
|
|
* <i> The returned c-string should be free'd
|
2008-11-11 16:03:26 +01:00
|
|
|
* using MEM_freeN. </i>
|
2002-10-12 13:37:38 +02:00
|
|
|
*
|
|
|
|
* @param ds The DynStr of interest.
|
|
|
|
* @return The contents of @a ds as a c-string.
|
|
|
|
*/
|
|
|
|
char* BLI_dynstr_get_cstring (DynStr *ds);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Free the DynStr
|
|
|
|
*
|
|
|
|
* @param ds The DynStr to free.
|
|
|
|
*/
|
|
|
|
void BLI_dynstr_free (DynStr *ds);
|
|
|
|
|
|
|
|
#endif
|
2002-10-30 03:07:20 +01:00
|
|
|
|