WebSVN – HelenOS – Diff – /trunk/uspace/lib/libc/include/string.h


/*
 * Copyright (c) 2005 Martin Decky
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
/** @addtogroup libc
 * @{
 */
/** @file
 */
 
#ifndef LIBC_STRING_H_
#define LIBC_STRING_H_
 
#include <mem.h>
#include <sys/types.h>
#include <bool.h>
 
#define U_SPECIAL      '?'
#define U_BOM          0xfeff
 
/** No size limit constant */
#define STR_NO_LIMIT  ((size_t) -1)
 
/** Maximum size of a string containing @c length characters */
#define STR_BOUNDS(length)  ((length) << 2)
 
extern wchar_t str_decode(const char *str, size_t *offset, size_t sz);
extern int chr_encode(const wchar_t ch, char *str, size_t *offset, size_t sz);
 
extern size_t str_size(const char *str);
extern size_t wstr_size(const wchar_t *str);
 
extern size_t str_lsize(const char *str, count_t max_len);
extern size_t wstr_lsize(const wchar_t *str, count_t max_len);
 
extern count_t str_length(const char *str);
extern count_t wstr_length(const wchar_t *wstr);
 
extern count_t str_nlength(const char *str, size_t size);
extern count_t wstr_nlength(const wchar_t *str, size_t size);
 
extern bool ascii_check(wchar_t ch);
extern bool chr_check(wchar_t ch);
 
extern int str_cmp(const char *s1, const char *s2);
extern int str_lcmp(const char *s1, const char *s2, count_t max_len);
 
extern void str_cpy(char *dest, size_t size, const char *src);
extern void str_ncpy(char *dest, size_t size, const char *src, size_t n);
extern void str_append(char *dest, size_t size, const char *src);
 
extern void wstr_nstr(char *dst, const wchar_t *src, size_t size);
 
extern const char *str_chr(const char *str, wchar_t ch);
extern const char *str_rchr(const char *str, wchar_t ch);
 
extern bool wstr_linsert(wchar_t *str, wchar_t ch, count_t pos, count_t max_pos);
extern bool wstr_remove(wchar_t *str, count_t pos);
 
extern char *str_dup(const char *);
 
/*
 * TODO: Get rid of this.
 */
 
extern int stricmp(const char *, const char *);
 
extern long int strtol(const char *, char **, int);
extern unsigned long strtoul(const char *, char **, int);
 
extern char * strtok_r(char *, const char *, char **);
extern char * strtok(char *, const char *);
 
#endif
 
/** @}
 */
 

Subversion Repositories HelenOS

(root)/trunk/uspace/lib/libc/include/string.h @ 4746 – Rev 4280 → 4365

Rev 4280		Rev 4365
1	/*	1	/*
2	* Copyright (c) 2005 Martin Decky	2	* Copyright (c) 2005 Martin Decky
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	13	* documentation and/or other materials provided with the distribution.
14	* - The name of the author may not be used to endorse or promote products	14	* - The name of the author may not be used to endorse or promote products
15	* derived from this software without specific prior written permission.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF	25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	/** @addtogroup libc	29	/** @addtogroup libc
30	* @{	30	* @{
31	*/	31	*/
32	/** @file	32	/** @file
33	*/	33	*/
34		34
35	#ifndef LIBC_STRING_H_	35	#ifndef LIBC_STRING_H_
36	#define LIBC_STRING_H_	36	#define LIBC_STRING_H_
37		37
38	#include <mem.h>	38	#include <mem.h>
39	#include <sys/types.h>	39	#include <sys/types.h>
40	#include <bool.h>	40	#include <bool.h>
41		41
42	#define U_SPECIAL '?'	42	#define U_SPECIAL '?'
43	#define U_BOM 0xfeff	43	#define U_BOM 0xfeff
44		44
45	/*< No size limit constant /	45	/** No size limit constant */
46	#define STR_NO_LIMIT ((size_t) -1)	46	#define STR_NO_LIMIT ((size_t) -1)
47		47
48	/*< Maximum size of a string containing @c length characters /	48	/** Maximum size of a string containing @c length characters */
49	#define STR_BOUNDS(length) ((length) << 2)	49	#define STR_BOUNDS(length) ((length) << 2)
50		50
51	extern wchar_t str_decode(const char str, size_t offset, size_t sz);	51	extern wchar_t str_decode(const char str, size_t offset, size_t sz);
52	extern int chr_encode(const wchar_t ch, char str, size_t offset, size_t sz);	52	extern int chr_encode(const wchar_t ch, char str, size_t offset, size_t sz);
53		53
54	extern size_t str_size(const char *str);	54	extern size_t str_size(const char *str);
55	extern size_t wstr_size(const wchar_t *str);	55	extern size_t wstr_size(const wchar_t *str);
56		56
57	extern size_t str_lsize(const char *str, count_t max_len);	57	extern size_t str_lsize(const char *str, count_t max_len);
58	extern size_t wstr_lsize(const wchar_t *str, count_t max_len);	58	extern size_t wstr_lsize(const wchar_t *str, count_t max_len);
59		59
60	extern count_t str_length(const char *str);	60	extern count_t str_length(const char *str);
61	extern count_t wstr_length(const wchar_t *wstr);	61	extern count_t wstr_length(const wchar_t *wstr);
62		62
63	extern count_t str_nlength(const char *str, size_t size);	63	extern count_t str_nlength(const char *str, size_t size);
64	extern count_t wstr_nlength(const wchar_t *str, size_t size);	64	extern count_t wstr_nlength(const wchar_t *str, size_t size);
65		65
66	extern bool ascii_check(wchar_t ch);	66	extern bool ascii_check(wchar_t ch);
67	extern bool chr_check(wchar_t ch);	67	extern bool chr_check(wchar_t ch);
68		68
69	extern int str_cmp(const char s1, const char s2);	69	extern int str_cmp(const char s1, const char s2);
70	extern int str_lcmp(const char s1, const char s2, count_t max_len);	70	extern int str_lcmp(const char s1, const char s2, count_t max_len);
71		71
72	extern void str_cpy(char dest, size_t size, const char src);	72	extern void str_cpy(char dest, size_t size, const char src);
73	extern void str_ncpy(char dest, size_t size, const char src, size_t n);	73	extern void str_ncpy(char dest, size_t size, const char src, size_t n);
74	extern void str_append(char dest, size_t size, const char src);	74	extern void str_append(char dest, size_t size, const char src);
75		75
76	extern void wstr_nstr(char dst, const wchar_t src, size_t size);	76	extern void wstr_nstr(char dst, const wchar_t src, size_t size);
77		77
78	extern const char str_chr(const char str, wchar_t ch);	78	extern const char str_chr(const char str, wchar_t ch);
79	extern const char str_rchr(const char str, wchar_t ch);	79	extern const char str_rchr(const char str, wchar_t ch);
80		80
81	extern bool wstr_linsert(wchar_t *str, wchar_t ch, count_t pos, count_t max_pos);	81	extern bool wstr_linsert(wchar_t *str, wchar_t ch, count_t pos, count_t max_pos);
82	extern bool wstr_remove(wchar_t *str, count_t pos);	82	extern bool wstr_remove(wchar_t *str, count_t pos);
83		83
84	extern char str_dup(const char );	84	extern char str_dup(const char );
85		85
86	/*	86	/*
87	* TODO: Get rid of this.	87	* TODO: Get rid of this.
88	*/	88	*/
89		89
90	extern int stricmp(const char , const char );	90	extern int stricmp(const char , const char );
91		91
92	extern long int strtol(const char , char *, int);	92	extern long int strtol(const char , char *, int);
93	extern unsigned long strtoul(const char , char *, int);	93	extern unsigned long strtoul(const char , char *, int);
94		94
95	extern char * strtok_r(char , const char , char **);	95	extern char * strtok_r(char , const char , char **);
96	extern char * strtok(char , const char );	96	extern char * strtok(char , const char );
97		97
98	#endif	98	#endif
99		99
100	/** @}	100	/** @}
101	*/	101	*/
102		102