2011-02-18 14:58:08 +01:00
|
|
|
/*
|
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
|
|
|
*/
|
|
|
|
|
2012-02-17 19:59:41 +01:00
|
|
|
#ifndef __BLI_DYNSTR_H__
|
|
|
|
#define __BLI_DYNSTR_H__
|
2002-10-12 13:37:38 +02:00
|
|
|
|
2011-02-18 14:58:08 +01:00
|
|
|
/** \file BLI_dynstr.h
|
|
|
|
* \ingroup bli
|
|
|
|
* \brief A dynamically sized string ADT.
|
|
|
|
* \section aboutdynstr Dynamic String
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
|
2008-12-29 14:38:08 +01:00
|
|
|
#include <stdarg.h>
|
|
|
|
|
2013-09-01 17:01:15 +02:00
|
|
|
#include "BLI_compiler_attrs.h"
|
|
|
|
|
2002-10-12 13:37:38 +02:00
|
|
|
struct DynStr;
|
|
|
|
|
2012-05-12 22:39:39 +02:00
|
|
|
/** The abstract DynStr type */
|
2002-10-12 13:37:38 +02:00
|
|
|
typedef struct DynStr DynStr;
|
|
|
|
|
2012-05-12 22:39:39 +02:00
|
|
|
/**
|
|
|
|
* Create a new DynStr.
|
|
|
|
*
|
|
|
|
* \return Pointer to a new DynStr.
|
|
|
|
*/
|
|
|
|
DynStr *BLI_dynstr_new(void);
|
2002-10-12 13:37:38 +02:00
|
|
|
|
2012-05-12 22:39:39 +02:00
|
|
|
/**
|
|
|
|
* Append a c-string to a DynStr.
|
|
|
|
*
|
|
|
|
* \param ds The DynStr to append to.
|
|
|
|
* \param cstr The c-string to append.
|
|
|
|
*/
|
|
|
|
void BLI_dynstr_append(DynStr *ds, const char *cstr);
|
2008-11-11 16:03:26 +01:00
|
|
|
|
2010-02-27 00:56:16 +01:00
|
|
|
/**
|
|
|
|
* Append a length clamped c-string to a DynStr.
|
|
|
|
*
|
2012-03-02 17:05:54 +01:00
|
|
|
* \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.
|
2010-02-27 00:56:16 +01:00
|
|
|
*/
|
2012-05-12 22:39:39 +02:00
|
|
|
void BLI_dynstr_nappend(DynStr *ds, const char *cstr, int len);
|
2010-02-27 00:56:16 +01:00
|
|
|
|
2012-05-12 22:39:39 +02: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.
|
|
|
|
*/
|
2013-09-01 17:01:15 +02:00
|
|
|
void BLI_dynstr_appendf(DynStr *ds, const char *format, ...) ATTR_PRINTF_FORMAT(2, 3);
|
|
|
|
void BLI_dynstr_vappendf(DynStr *ds, const char *format, va_list args) ATTR_PRINTF_FORMAT(2, 0);
|
2002-10-12 13:37:38 +02:00
|
|
|
|
2012-05-12 22:39:39 +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);
|
2002-10-12 13:37:38 +02:00
|
|
|
|
2012-05-12 22:39:39 +02:00
|
|
|
/**
|
|
|
|
* Get a DynStr's contents as a c-string.
|
|
|
|
* <i> The returned c-string should be freed
|
|
|
|
* using MEM_freeN. </i>
|
|
|
|
*
|
|
|
|
* \param ds The DynStr of interest.
|
|
|
|
* \return The contents of \a ds as a c-string.
|
|
|
|
*/
|
|
|
|
char *BLI_dynstr_get_cstring(DynStr *ds);
|
2002-10-12 13:37:38 +02:00
|
|
|
|
2011-12-20 03:54:25 +01:00
|
|
|
/**
|
|
|
|
* Get a DynStr's contents as a c-string.
|
|
|
|
* <i> The str argument must be allocated to be at
|
2011-12-20 11:05:58 +01:00
|
|
|
* least the size of BLI_dynstr_get_len(ds) + 1. </i>
|
2011-12-20 03:54:25 +01:00
|
|
|
*
|
2012-03-02 17:05:54 +01:00
|
|
|
* \param ds The DynStr of interest.
|
|
|
|
* \param str The string to fill.
|
2011-12-20 03:54:25 +01:00
|
|
|
*/
|
2012-05-12 22:39:39 +02:00
|
|
|
void BLI_dynstr_get_cstring_ex(DynStr *ds, char *str);
|
2011-12-20 03:54:25 +01:00
|
|
|
|
2012-05-12 22:39:39 +02:00
|
|
|
/**
|
|
|
|
* Free the DynStr
|
|
|
|
*
|
|
|
|
* \param ds The DynStr to free.
|
|
|
|
*/
|
|
|
|
void BLI_dynstr_free(DynStr *ds);
|
2002-10-12 13:37:38 +02:00
|
|
|
|
|
|
|
#endif
|
2002-10-30 03:07:20 +01:00
|
|
|
|