blob: ada4a41b7f8665448c5fc8d69b3517caff2f97f3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
/**
* @file BLI_dynstr.h
*
* A dynamically sized string ADT.
* 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.
*
* $Id$
*
* ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
*
* 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
* of the License, or (at your option) any later version. The Blender
* Foundation also sells licenses for use in proprietary software under
* the Blender License. See http://www.blender.org/BL/ for information
* about this.
*
* 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,
* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved.
*
* The Original Code is: all of this file.
*
* Contributor(s): none yet.
*
* ***** END GPL/BL DUAL LICENSE BLOCK *****
*/
#ifndef BLI_DYNSTR_H
#define BLI_DYNSTR_H
struct DynStr;
/** The abstract DynStr type */
typedef struct DynStr DynStr;
/**
* Create a new DynStr.
*
* @return Pointer to a new DynStr.
*/
DynStr* BLI_dynstr_new (void);
/**
* Append a c-string to a DynStr.
*
* @param ds The DynStr to append to.
* @param cstr The c-string to append.
*/
void BLI_dynstr_append (DynStr *ds, char *cstr);
/**
* Find the length of a DynStr.
*
* @param ds The DynStr of interest.
* @return The length of @a ds.
*/
int BLI_dynstr_get_len (DynStr *ds);
/**
* Get a DynStr's contents as a c-string.
* <i> The returned c-string should be free'd
* using BLI_freeN. </i>
*
* @param ds The DynStr of interest.
* @return The contents of @a ds as a c-string.
*/
char* BLI_dynstr_get_cstring (DynStr *ds);
/**
* Free the DynStr
*
* @param ds The DynStr to free.
*/
void BLI_dynstr_free (DynStr *ds);
#endif
|
