2011-02-18 14:58:08 +01:00
|
|
|
/*
|
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.
|
|
|
|
*/
|
2018-06-17 16:32:54 +02:00
|
|
|
|
2012-02-17 19:59:41 +01:00
|
|
|
#pragma once
|
2002-10-12 13:37:38 +02:00
|
|
|
|
2019-02-17 22:08:12 +01:00
|
|
|
/** \file
|
|
|
|
* \ingroup bli
|
|
|
|
* \brief A dynamically sized string ADT.
|
|
|
|
* \section aboutdynstr Dynamic String
|
2011-02-18 14:58:08 +01:00
|
|
|
* 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"
|
|
|
|
|
2020-03-02 15:04:53 +01:00
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
|
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;
|
|
|
|
|
2014-06-14 10:40:48 +02:00
|
|
|
DynStr *BLI_dynstr_new(void) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
|
2017-04-24 10:42:10 +02:00
|
|
|
DynStr *BLI_dynstr_new_memarena(void) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
|
|
|
|
|
2014-06-14 10:40:48 +02:00
|
|
|
void BLI_dynstr_append(DynStr *__restrict ds, const char *cstr) ATTR_NONNULL();
|
|
|
|
void BLI_dynstr_nappend(DynStr *__restrict ds, const char *cstr, int len) ATTR_NONNULL();
|
2002-10-12 13:37:38 +02:00
|
|
|
|
2014-06-14 10:40:48 +02:00
|
|
|
void BLI_dynstr_appendf(DynStr *__restrict ds, const char *__restrict format, ...)
|
|
|
|
ATTR_PRINTF_FORMAT(2, 3) ATTR_NONNULL(1, 2);
|
|
|
|
void BLI_dynstr_vappendf(DynStr *__restrict ds, const char *__restrict format, va_list args)
|
|
|
|
ATTR_PRINTF_FORMAT(2, 0) ATTR_NONNULL(1, 2);
|
2008-11-11 16:03:26 +01:00
|
|
|
|
2014-07-17 10:56:13 +02:00
|
|
|
int BLI_dynstr_get_len(DynStr *ds) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
|
2014-06-14 10:40:48 +02:00
|
|
|
char *BLI_dynstr_get_cstring(DynStr *ds) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
|
2020-09-04 20:59:13 +02:00
|
|
|
void BLI_dynstr_get_cstring_ex(DynStr *__restrict ds, char *__restrict rets) ATTR_NONNULL();
|
2017-04-24 10:42:10 +02:00
|
|
|
|
|
|
|
void BLI_dynstr_clear(DynStr *ds) ATTR_NONNULL();
|
2014-06-14 10:40:48 +02:00
|
|
|
void BLI_dynstr_free(DynStr *ds) ATTR_NONNULL();
|
2002-10-30 03:07:20 +01:00
|
|
|
|
2020-03-02 15:04:53 +01:00
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|