Filling in branch from trunk
[blender.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/BL DUAL 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. The Blender
18  * Foundation also sells licenses for use in proprietary software under
19  * the Blender License.  See http://www.blender.org/BL/ for information
20  * about this.
21  *
22  * This program is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25  * GNU General Public License for more details.
26  *
27  * You should have received a copy of the GNU General Public License
28  * along with this program; if not, write to the Free Software Foundation,
29  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
30  *
31  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
32  * All rights reserved.
33  *
34  * The Original Code is: all of this file.
35  *
36  * Contributor(s): none yet.
37  *
38  * ***** END GPL/BL DUAL LICENSE BLOCK *****
39  */
40  
41 #ifndef BLI_DYNSTR_H
42 #define BLI_DYNSTR_H
43
44 struct DynStr;
45
46         /** The abstract DynStr type */
47 typedef struct DynStr DynStr;
48
49         /**
50          * Create a new DynStr.
51          * 
52          * @return Pointer to a new DynStr.
53          */
54 DynStr* BLI_dynstr_new                                  (void);
55
56         /**
57          * Append a c-string to a DynStr.
58          * 
59          * @param ds The DynStr to append to.
60          * @param cstr The c-string to append.
61          */
62 void    BLI_dynstr_append                               (DynStr *ds, char *cstr);
63
64         /**
65          * Find the length of a DynStr.
66          * 
67          * @param ds The DynStr of interest.
68          * @return The length of @a ds.
69          */
70 int             BLI_dynstr_get_len                              (DynStr *ds);
71
72         /**
73          * Get a DynStr's contents as a c-string.
74          * <i> The returned c-string should be free'd
75          * using BLI_freeN. </i>
76          * 
77          * @param ds The DynStr of interest.
78          * @return The contents of @a ds as a c-string.
79          */
80 char*   BLI_dynstr_get_cstring                  (DynStr *ds);
81
82         /**
83          * Free the DynStr
84          * 
85          * @param ds The DynStr to free.
86          */
87 void    BLI_dynstr_free                                 (DynStr *ds);
88
89 #endif
90