copying 2.5 over to trunk
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 #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
48         /**
49          * Duplicates the first @a len bytes of cstring @a str 
50          * into a newly mallocN'd string and returns it. @a str
51          * is assumed to be at least len bytes long.
52          * 
53          * @param str The string to be duplicated
54          * @param len The number of bytes to duplicate
55          * @retval Returns the duplicated string
56          */
57 char *BLI_strdupn(const char *str, int len);
58
59         /**
60          * Like strncpy but ensures dst is always
61          * '\0' terminated.
62          * 
63          * @param dst Destination for copy
64          * @param src Source string to copy
65          * @param maxncpy Maximum number of characters to copy (generally
66          *   the size of dst)
67          * @retval Returns dst
68          */
69 char *BLI_strncpy(char *dst, const char *src, int maxncpy);
70
71         /* 
72          * Replacement for snprintf
73          */
74 int BLI_snprintf(char *buffer, size_t count, const char *format, ...);
75
76         /* 
77          * Print formatted string into a newly mallocN'd string
78          * and return it.
79          */
80 char *BLI_sprintfN(const char *format, ...);
81
82         /**
83          * Compare two strings
84          * 
85          * @retval True if the strings are equal, false otherwise.
86          */
87 int BLI_streq(const char *a, const char *b);
88
89         /**
90          * Compare two strings without regard to case.
91          * 
92          * @retval True if the strings are equal, false otherwise.
93          */
94 int BLI_strcaseeq(const char *a, const char *b);
95
96 char *BLI_strcasestr(const char *s, const char *find);
97 int BLI_strcasecmp(const char *s1, const char *s2);
98 int BLI_strncasecmp(const char *s1, const char *s2, int n);
99 int BLI_natstrcmp(const char *s1, const char *s2);
100
101 void BLI_timestr(double _time, char *str); /* time var is global */
102
103 #ifdef __cplusplus
104 }
105 #endif
106
107 #endif