69702f720264361f2237ea418bc45a4c0c12dade
[blender-staging.git] / source / blender / blenlib / BLI_string.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  *
29  * $Id$ 
30 */
31
32 #ifndef BLI_STRING_H
33 #define BLI_STRING_H
34
35 /** \file BLI_string.h
36  *  \ingroup bli
37  */
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43         /**
44          * Duplicates the cstring @a str into a newly mallocN'd
45          * string and returns it.
46          * 
47          * @param str The string to be duplicated
48          * @retval Returns the duplicated string
49          */
50 char *BLI_strdup(const char *str);
51
52         /**
53          * Duplicates the first @a len bytes of cstring @a str 
54          * into a newly mallocN'd string and returns it. @a str
55          * is assumed to be at least len bytes long.
56          * 
57          * @param str The string to be duplicated
58          * @param len The number of bytes to duplicate
59          * @retval Returns the duplicated string
60          */
61 char *BLI_strdupn(const char *str, const size_t len);
62
63         /**
64          * Appends the two strings, and returns new mallocN'ed string
65          * @param str1 first string for copy
66          * @param str2 second string for append
67          * @retval Returns dst
68          */
69 char *BLI_strdupcat(const char *str1, const char *str2);
70
71         /** 
72          * Like strncpy but ensures dst is always
73          * '\0' terminated.
74          * 
75          * @param dst Destination for copy
76          * @param src Source string to copy
77          * @param maxncpy Maximum number of characters to copy (generally
78          *   the size of dst)
79          * @retval Returns dst
80          */
81 char *BLI_strncpy(char *dst, const char *src, const size_t maxncpy);
82
83         /* Makes a copy of the text within the "" that appear after some text 'blahblah'
84          * i.e. for string 'pose["apples"]' with prefix 'pose[', it should grab "apples"
85          * 
86          *      - str: is the entire string to chop
87          *      - prefix: is the part of the string to leave out 
88          *
89          * Assume that the strings returned must be freed afterwards, and that the inputs will contain 
90          * data we want...
91          */
92 char *BLI_getQuotedStr(const char *str, const char *prefix);
93
94         /**
95          * Returns a copy of the cstring @a str into a newly mallocN'd
96          * string with all instances of oldText replaced with newText,
97          * and returns it.
98          * 
99          * @param str The string to replace occurances of oldText in
100          * @param oldText The text in the string to find and replace
101          * @param newText The text in the string to find and replace
102          * @retval Returns the duplicated string
103          */
104 char *BLI_replacestr(char *str, const char *oldText, const char *newText);
105
106         /* 
107          * Replacement for snprintf
108          */
109 size_t BLI_snprintf(char *buffer, size_t len, const char *format, ...)
110 #ifdef __GNUC__
111 __attribute__ ((format (printf, 3, 4)))
112 #endif
113 ;
114
115         /* 
116          * Print formatted string into a newly mallocN'd string
117          * and return it.
118          */
119 char *BLI_sprintfN(const char *format, ...)
120 #ifdef __GNUC__
121 __attribute__ ((format (printf, 1, 2)))
122 #endif
123 ;
124
125         /**
126          * Compare two strings
127          * 
128          * @retval True if the strings are equal, false otherwise.
129          */
130 int BLI_streq(const char *a, const char *b);
131
132         /**
133          * Compare two strings without regard to case.
134          * 
135          * @retval True if the strings are equal, false otherwise.
136          */
137 int BLI_strcaseeq(const char *a, const char *b);
138
139 char *BLI_strcasestr(const char *s, const char *find);
140 int BLI_strcasecmp(const char *s1, const char *s2);
141 int BLI_strncasecmp(const char *s1, const char *s2, size_t len);
142 int BLI_natstrcmp(const char *s1, const char *s2);
143 size_t BLI_strnlen(const char *str, size_t maxlen);
144
145 void BLI_timestr(double _time, char *str); /* time var is global */
146
147 int BLI_utf8_invalid_byte(const char *str, int length);
148 int BLI_utf8_invalid_strip(char *str, int length);
149
150 void BLI_ascii_strtolower(char *str, int len);
151 void BLI_ascii_strtoupper(char *str, int len);
152
153 #ifdef __cplusplus
154 }
155 #endif
156
157 #endif