- add BLI_string_utf8.h for unicode functions.
[blender.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
30 #ifndef BLI_STRING_H
31 #define BLI_STRING_H
32
33 /** \file BLI_string.h
34  *  \ingroup bli
35  */
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
50         /**
51          * Duplicates the first @a len bytes of cstring @a str 
52          * into a newly mallocN'd string and returns it. @a str
53          * is assumed to be at least len bytes long.
54          * 
55          * @param str The string to be duplicated
56          * @param len The number of bytes to duplicate
57          * @retval Returns the duplicated string
58          */
59 char *BLI_strdupn(const char *str, const size_t len);
60
61         /**
62          * Appends the two strings, and returns new mallocN'ed string
63          * @param str1 first string for copy
64          * @param str2 second string for append
65          * @retval Returns dst
66          */
67 char *BLI_strdupcat(const char *str1, const char *str2);
68
69         /** 
70          * Like strncpy but ensures dst is always
71          * '\0' terminated.
72          * 
73          * @param dst Destination for copy
74          * @param src Source string to copy
75          * @param maxncpy Maximum number of characters to copy (generally
76          *   the size of dst)
77          * @retval Returns dst
78          */
79 char *BLI_strncpy(char *dst, const char *src, const size_t maxncpy);
80
81         /* Makes a copy of the text within the "" that appear after some text 'blahblah'
82          * i.e. for string 'pose["apples"]' with prefix 'pose[', it should grab "apples"
83          * 
84          *      - str: is the entire string to chop
85          *      - prefix: is the part of the string to leave out 
86          *
87          * Assume that the strings returned must be freed afterwards, and that the inputs will contain 
88          * data we want...
89          */
90 char *BLI_getQuotedStr(const char *str, const char *prefix);
91
92         /**
93          * Returns a copy of the cstring @a str into a newly mallocN'd
94          * string with all instances of oldText replaced with newText,
95          * and returns it.
96          * 
97          * @param str The string to replace occurances of oldText in
98          * @param oldText The text in the string to find and replace
99          * @param newText The text in the string to find and replace
100          * @retval Returns the duplicated string
101          */
102 char *BLI_replacestr(char *str, const char *oldText, const char *newText);
103
104         /* 
105          * Replacement for snprintf
106          */
107 size_t BLI_snprintf(char *buffer, size_t len, const char *format, ...)
108 #ifdef __GNUC__
109 __attribute__ ((format (printf, 3, 4)))
110 #endif
111 ;
112
113         /* 
114          * Print formatted string into a newly mallocN'd string
115          * and return it.
116          */
117 char *BLI_sprintfN(const char *format, ...)
118 #ifdef __GNUC__
119 __attribute__ ((format (printf, 1, 2)))
120 #endif
121 ;
122
123 size_t BLI_strescape(char *dst, const char *src, const size_t maxlen);
124
125         /**
126          * Compare two strings without regard to case.
127          * 
128          * @retval True if the strings are equal, false otherwise.
129          */
130 int BLI_strcaseeq(const char *a, const char *b);
131
132 char *BLI_strcasestr(const char *s, const char *find);
133 int BLI_strcasecmp(const char *s1, const char *s2);
134 int BLI_strncasecmp(const char *s1, const char *s2, size_t len);
135 int BLI_natstrcmp(const char *s1, const char *s2);
136 size_t BLI_strnlen(const char *str, size_t maxlen);
137
138 void BLI_timestr(double _time, char *str); /* time var is global */
139
140 void BLI_ascii_strtolower(char *str, int len);
141 void BLI_ascii_strtoupper(char *str, int len);
142
143 #ifdef __cplusplus
144 }
145 #endif
146
147 #endif