a74629e589ca0605580bf9cae4f8cb1dd27ee2f6
[blender.git] / source / blender / blenlib / BLI_string.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_STRING_H__
29 #define __BLI_STRING_H__
30
31 /** \file BLI_string.h
32  *  \ingroup bli
33  */
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 /**
40  * Duplicates the cstring \a str into a newly mallocN'd
41  * string and returns it.
42  *
43  * \param str The string to be duplicated
44  * \retval Returns the duplicated string
45  */
46 char *BLI_strdup(const char *str)
47 #ifdef __GNUC__
48 __attribute__((warn_unused_result))
49 __attribute__((nonnull))
50 #endif
51 ;
52
53 /**
54  * Duplicates the first \a len bytes of cstring \a str
55  * into a newly mallocN'd string and returns it. \a str
56  * is assumed to be at least len bytes long.
57  *
58  * \param str The string to be duplicated
59  * \param len The number of bytes to duplicate
60  * \retval Returns the duplicated string
61  */
62 char *BLI_strdupn(const char *str, const size_t len)
63 #ifdef __GNUC__
64 __attribute__((warn_unused_result))
65 __attribute__((nonnull))
66 #endif
67 ;
68
69 /**
70  * Appends the two strings, and returns new mallocN'ed string
71  * \param str1 first string for copy
72  * \param str2 second string for append
73  * \retval Returns dst
74  */
75 char *BLI_strdupcat(const char *str1, const char *str2)
76 #ifdef __GNUC__
77 __attribute__((warn_unused_result))
78 __attribute__((nonnull))
79 #endif
80 ;
81
82 /**
83  * Like strncpy but ensures dst is always
84  * '\0' terminated.
85  *
86  * \param dst Destination for copy
87  * \param src Source string to copy
88  * \param maxncpy Maximum number of characters to copy (generally
89  *   the size of dst)
90  * \retval Returns dst
91  */
92 char *BLI_strncpy(char *dst, const char *src, const size_t maxncpy)
93 #ifdef __GNUC__
94 __attribute__((nonnull))
95 #endif
96 ;
97
98 /**
99  *Makes a copy of the text within the "" that appear after some text 'blahblah'
100  * i.e. for string 'pose["apples"]' with prefix 'pose[', it should grab "apples"
101  *
102  *  - str: is the entire string to chop
103  *      - prefix: is the part of the string to leave out
104  *
105  * Assume that the strings returned must be freed afterwards, and that the inputs will contain
106  * data we want...
107  */
108 char *BLI_str_quoted_substrN(const char *str, const char *prefix)
109 #ifdef __GNUC__
110 __attribute__((warn_unused_result))
111 __attribute__((nonnull))
112 #endif
113 ;
114
115 /**
116  * Returns a copy of the cstring \a str into a newly mallocN'd
117  * string with all instances of oldText replaced with newText,
118  * and returns it.
119  *
120  * \param str The string to replace occurrences of oldText in
121  * \param oldText The text in the string to find and replace
122  * \param newText The text in the string to find and replace
123  * \retval Returns the duplicated string
124  */
125 char *BLI_replacestr(char *str, const char *oldText, const char *newText)
126 #ifdef __GNUC__
127 __attribute__((warn_unused_result))
128 __attribute__((nonnull))
129 #endif
130 ;
131
132 /*
133  * Replacement for snprintf
134  */
135 size_t BLI_snprintf(char *buffer, size_t len, const char *format, ...)
136 #ifdef __GNUC__
137 __attribute__ ((format(printf, 3, 4)))
138 __attribute__((nonnull))
139 #endif
140 ;
141
142 /*
143  * Print formatted string into a newly mallocN'd string
144  * and return it.
145  */
146 char *BLI_sprintfN(const char *format, ...)
147 #ifdef __GNUC__
148 __attribute__ ((format(printf, 1, 2)))
149 __attribute__((warn_unused_result))
150 __attribute__((nonnull))
151 #endif
152 ;
153
154 size_t BLI_strescape(char *dst, const char *src, const size_t maxlen)
155 #ifdef __GNUC__
156 __attribute__((nonnull))
157 #endif
158 ;
159
160 /**
161  * Compare two strings without regard to case.
162  *
163  * \retval True if the strings are equal, false otherwise.
164  */
165 int BLI_strcaseeq(const char *a, const char *b)
166 #ifdef __GNUC__
167 __attribute__((warn_unused_result))
168 __attribute__((nonnull))
169 #endif
170 ;
171
172 char *BLI_strcasestr(const char *s, const char *find)
173 #ifdef __GNUC__
174 __attribute__((warn_unused_result))
175 __attribute__((nonnull))
176 #endif
177 ;
178 int BLI_strcasecmp(const char *s1, const char *s2)
179 #ifdef __GNUC__
180 __attribute__((warn_unused_result))
181 __attribute__((nonnull))
182 #endif
183 ;
184 int BLI_strncasecmp(const char *s1, const char *s2, size_t len)
185 #ifdef __GNUC__
186 __attribute__((warn_unused_result))
187 __attribute__((nonnull))
188 #endif
189 ;
190 int BLI_natstrcmp(const char *s1, const char *s2)
191 #ifdef __GNUC__
192 __attribute__((warn_unused_result))
193 __attribute__((nonnull))
194 #endif
195 ;
196 size_t BLI_strnlen(const char *str, size_t maxlen)
197 #ifdef __GNUC__
198 __attribute__((warn_unused_result))
199 __attribute__((nonnull))
200 #endif
201 ;
202 void BLI_timestr(double _time, char *str)
203 #ifdef __GNUC__
204 __attribute__((nonnull))
205 #endif
206 ; /* time var is global */
207
208 void BLI_ascii_strtolower(char *str, int len)
209 #ifdef __GNUC__
210 __attribute__((nonnull))
211 #endif
212 ;
213 void BLI_ascii_strtoupper(char *str, int len)
214 #ifdef __GNUC__
215 __attribute__((nonnull))
216 #endif
217 ;
218
219 #ifdef __cplusplus
220 }
221 #endif
222
223 #endif