BLI_dynstr: add memarena-based version, and helper to clear without freeing.
[blender.git] / source / blender / blenlib / BLI_dynstr.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27  
28 #ifndef __BLI_DYNSTR_H__
29 #define __BLI_DYNSTR_H__
30
31 /** \file BLI_dynstr.h
32  *  \ingroup bli
33  *  \brief A dynamically sized string ADT.
34  *  \section aboutdynstr Dynamic String
35  * This ADT is designed purely for dynamic string creation
36  * through appending, not for general usage, the intent is
37  * to build up dynamic strings using a DynStr object, then
38  * convert it to a c-string and work with that.
39  */
40
41 #include <stdarg.h>
42
43 #include "BLI_compiler_attrs.h"
44
45 struct DynStr;
46 struct MemArena;
47
48 /** The abstract DynStr type */
49 typedef struct DynStr DynStr;
50
51 DynStr *BLI_dynstr_new(void) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
52 DynStr *BLI_dynstr_new_memarena(void) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
53
54 void    BLI_dynstr_append(DynStr *__restrict ds, const char *cstr) ATTR_NONNULL();
55 void    BLI_dynstr_nappend(DynStr *__restrict ds, const char *cstr, int len) ATTR_NONNULL();
56
57 void    BLI_dynstr_appendf(DynStr *__restrict ds, const char *__restrict format, ...) ATTR_PRINTF_FORMAT(2, 3) ATTR_NONNULL(1, 2);
58 void    BLI_dynstr_vappendf(DynStr *__restrict ds, const char *__restrict format, va_list args) ATTR_PRINTF_FORMAT(2, 0) ATTR_NONNULL(1, 2);
59
60 int     BLI_dynstr_get_len(DynStr *ds) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
61 char   *BLI_dynstr_get_cstring(DynStr *ds) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
62 void    BLI_dynstr_get_cstring_ex(DynStr *__restrict ds, char *__restrict str) ATTR_NONNULL();
63
64 void    BLI_dynstr_clear(DynStr *ds) ATTR_NONNULL();
65 void    BLI_dynstr_free(DynStr *ds) ATTR_NONNULL();
66
67 #endif  /* __BLI_DYNSTR_H__ */