2.5: Error reporting
[blender-staging.git] / source / blender / blenlib / BLI_dynstr.h
1 /**
2  * @file BLI_dynstr.h
3  * 
4  * A dynamically sized string ADT.
5  * This ADT is designed purely for dynamic string creation
6  * through appending, not for general usage, the intent is
7  * to build up dynamic strings using a DynStr object, then
8  * convert it to a c-string and work with that.
9  * 
10  * $Id$
11  *
12  * ***** BEGIN GPL LICENSE BLOCK *****
13  *
14  * This program is free software; you can redistribute it and/or
15  * modify it under the terms of the GNU General Public License
16  * as published by the Free Software Foundation; either version 2
17  * of the License, or (at your option) any later version.
18  *
19  * This program is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU General Public License for more details.
23  *
24  * You should have received a copy of the GNU General Public License
25  * along with this program; if not, write to the Free Software Foundation,
26  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
27  *
28  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
29  * All rights reserved.
30  *
31  * The Original Code is: all of this file.
32  *
33  * Contributor(s): none yet.
34  *
35  * ***** END GPL LICENSE BLOCK *****
36  */
37  
38 #ifndef BLI_DYNSTR_H
39 #define BLI_DYNSTR_H
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 c-string to a DynStr, but with formatting like printf.
65          * 
66          * @param ds The DynStr to append to.
67          * @param format The printf format string to use.
68          */
69 void    BLI_dynstr_appendf                              (DynStr *ds, const char *format, ...);
70 void    BLI_dynstr_vappendf                             (DynStr *ds, const char *format, va_list args);
71
72         /**
73          * Find the length of a DynStr.
74          * 
75          * @param ds The DynStr of interest.
76          * @return The length of @a ds.
77          */
78 int             BLI_dynstr_get_len                              (DynStr *ds);
79
80         /**
81          * Get a DynStr's contents as a c-string.
82          * <i> The returned c-string should be free'd
83          * using MEM_freeN. </i>
84          * 
85          * @param ds The DynStr of interest.
86          * @return The contents of @a ds as a c-string.
87          */
88 char*   BLI_dynstr_get_cstring                  (DynStr *ds);
89
90         /**
91          * Free the DynStr
92          * 
93          * @param ds The DynStr to free.
94          */
95 void    BLI_dynstr_free                                 (DynStr *ds);
96
97 #endif
98