style cleanup
[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 struct DynStr;
44
45         /** The abstract DynStr type */
46 typedef struct DynStr DynStr;
47
48         /**
49          * Create a new DynStr.
50          * 
51          * \return Pointer to a new DynStr.
52          */
53 DynStr* BLI_dynstr_new                                  (void);
54
55         /**
56          * Append a c-string to a DynStr.
57          * 
58          * \param ds The DynStr to append to.
59          * \param cstr The c-string to append.
60          */
61 void    BLI_dynstr_append                               (DynStr *ds, const char *cstr);
62
63 /**
64  * Append a length clamped c-string to a DynStr.
65  *
66  * \param ds The DynStr to append to.
67  * \param cstr The c-string to append.
68  * \param len The maximum length of the c-string to copy.
69  */
70 void    BLI_dynstr_nappend                              (DynStr *ds, const char *cstr, int len);
71
72         /**
73          * Append a c-string to a DynStr, but with formatting like printf.
74          * 
75          * \param ds The DynStr to append to.
76          * \param format The printf format string to use.
77          */
78 void    BLI_dynstr_appendf                              (DynStr *ds, const char *format, ...)
79 #ifdef __GNUC__
80 __attribute__ ((format (printf, 2, 3)))
81 #endif
82 ;
83 void    BLI_dynstr_vappendf                             (DynStr *ds, const char *format, va_list args);
84
85         /**
86          * Find the length of a DynStr.
87          * 
88          * \param ds The DynStr of interest.
89          * \return The length of \a ds.
90          */
91 int             BLI_dynstr_get_len                              (DynStr *ds);
92
93         /**
94          * Get a DynStr's contents as a c-string.
95          * <i> The returned c-string should be freed
96          * using MEM_freeN. </i>
97          * 
98          * \param ds The DynStr of interest.
99          * \return The contents of \a ds as a c-string.
100          */
101 char*   BLI_dynstr_get_cstring                  (DynStr *ds);
102
103 /**
104  * Get a DynStr's contents as a c-string.
105  * <i> The str argument must be allocated to be at
106  * least the size of BLI_dynstr_get_len(ds) + 1. </i>
107  *
108  * \param ds The DynStr of interest.
109  * \param str The string to fill.
110  * \return The contents of \a ds as a c-string.
111  */
112 void    BLI_dynstr_get_cstring_ex               (DynStr *ds, char *str);
113
114         /**
115          * Free the DynStr
116          * 
117          * \param ds The DynStr to free.
118          */
119 void    BLI_dynstr_free                                 (DynStr *ds);
120
121 #endif
122