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