WebSVN – Kolibri OS – Diff – /programs/develop/libraries/kolibri-libc/include/string.h


/* String handling 
 
   This file is part of the Public Domain C Library (PDCLib).
   Permission is granted to use, modify, and / or redistribute at will.
*/
 
#ifndef _STRING_H_
#define _STRING_H_
 
#include 
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* String function conventions */
 
/*
   In any of the following functions taking a size_t n to specify the length of
   an array or size of a memory region, n may be 0, but the pointer arguments to
   the call shall still be valid unless otherwise stated.
*/
 
/* Copying functions */
 
extern void* _FUNC(memccpy)(void *restrict dest, const void *restrict src, int c, size_t n);
 
/* Copy a number of n characters from the memory area pointed to by s2 to the
   area pointed to by s1. If the two areas overlap, behaviour is undefined.
   Returns the value of s1.
*/
 
 
#ifdef __TINYC__
extern void* memcpy(void* s1, const void* s2, size_t n);
 
extern void* memset(void* s, int c, size_t n);
extern void* memmove(void* s1, const void* s2, size_t n);
#else
extern void* _FUNC(memcpy)(void* s1, const void* s2, size_t n);
extern void* _FUNC(memset)(void* s, int c, size_t n);
extern void* _FUNC(memmove)(void* s1, const void* s2, size_t n);
#endif
 
/* Copy the character array s2 (including terminating '\0' byte) into the
   character array s1.
   Returns the value of s1.
*/
extern char* _FUNC(strcpy)(char*  s1, const char* s2);
 
/* Copy a maximum of n characters from the character array s2 into the character
   array s1. If s2 is shorter than n characters, '\0' bytes will be appended to
   the copy in s1 until n characters have been written. If s2 is longer than n
   characters, NO terminating '\0' will be written to s1. If the arrays overlap,
   behaviour is undefined.
   Returns the value of s1.
*/
extern char* _FUNC(strncpy)(char* s1, const char* s2, size_t n);
 
/* Concatenation functions */
 
/* Append the contents of the character array s2 (including terminating '\0') to
   the character array s1 (first character of s2 overwriting the '\0' of s1). If
   the arrays overlap, behaviour is undefined.
   Returns the value of s1.
*/
extern char* _FUNC(strcat)(char* s1, const char* s2);
 
/* Append a maximum of n characters from the character array s2 to the character
   array s1 (first character of s2 overwriting the '\0' of s1). A terminating
   '\0' is ALWAYS appended, even if the full n characters have already been
   written. If the arrays overlap, behaviour is undefined.
   Returns the value of s1.
*/
extern char* _FUNC(strncat)(char* s1, const char* s2, size_t n);
 
/* Comparison functions */
 
/* Compare the first n characters of the memory areas pointed to by s1 and s2.
   Returns 0 if s1 == s2, a negative number if s1 < s2, and a positive number if
   s1 > s2.
*/
extern int _FUNC(memcmp)(const void * s1, const void* s2, size_t n);
 
/* Compare the character arrays s1 and s2.
   Returns 0 if s1 == s2, a negative number if s1 < s2, and a positive number if
   s1 > s2.
*/
extern int _FUNC(strcmp)(const char * s1, const char* s2);
 
/* Compare the character arrays s1 and s2, interpreted as specified by the
   LC_COLLATE category of the current locale.
   Returns 0 if s1 == s2, a negative number if s1 < s2, and a positive number if
   s1 > s2.
   TODO: Currently a dummy wrapper for strcmp() as PDCLib does not yet support
   locales.
*/
extern int _FUNC(strcoll)(const char* s1, const char* s2);
 
/* Compare no more than the first n characters of the character arrays s1 and
   s2.
   Returns 0 if s1 == s2, a negative number if s1 < s2, and a positive number if
   s1 > s2.
*/
extern int _FUNC(strncmp)(const char* s1, const char* s2, size_t n);
 
/* Transform the character array s2 as appropriate for the LC_COLLATE setting of
   the current locale. If length of resulting string is less than n, store it in
   the character array pointed to by s1. Return the length of the resulting
   string.
*/
extern size_t _FUNC(strxfrm)(char* s1, const char* s2, size_t n);
 
/* Search functions */
 
/* Search the first n characters in the memory area pointed to by s for the
   character c (interpreted as unsigned char).
   Returns a pointer to the first instance found, or NULL.
*/
extern void* _FUNC(memchr)(const void* s, int c, size_t n);
 
/* Search the character array s (including terminating '\0') for the character c
   (interpreted as char).
   Returns a pointer to the first instance found, or NULL.
*/
extern char* _FUNC(strchr)(const char* s, int c);
 
/* Determine the length of the initial substring of character array s1 which
   consists only of characters not from the character array s2.
   Returns the length of that substring.
*/
extern size_t _FUNC(strcspn)(const char* s1, const char* s2);
 
/* Search the character array s1 for any character from the character array s2.
   Returns a pointer to the first occurrence, or NULL.
*/
extern char* _FUNC(strpbrk)(const char* s1, const char* s2);
 
/* Search the character array s (including terminating '\0') for the character c
   (interpreted as char).
   Returns a pointer to the last instance found, or NULL.
*/
extern char* _FUNC(strrchr)(const char * s, int c );
 
/* Determine the length of the initial substring of character array s1 which
   consists only of characters from the character array s2.
   Returns the length of that substring.
*/
extern size_t _FUNC(strspn)(const char * s1, const char * s2);
 
/* Search the character array s1 for the substring in character array s2.
   Returns a pointer to that sbstring, or NULL. If s2 is of length zero,
   returns s1.
*/
extern char* _FUNC(strstr)(const char * s1, const char * s2);
 
/* In a series of subsequent calls, parse a C string into tokens.
   On the first call to strtok(), the first argument is a pointer to the to-be-
   parsed C string. On subsequent calls, the first argument is NULL unless you
   want to start parsing a new string. s2 holds an array of separator characters
   which can differ from call to call. Leading separators are skipped, the first
   trailing separator overwritten with '\0'.
   Returns a pointer to the next token.
   WARNING: This function uses static storage, and as such is not reentrant.
*/
extern char* _FUNC(strtok)(char* s1, const char* s2);
 
 
 
 
 
 
 
 
 
/* Map an error number to a (locale-specific) error message string. Error
   numbers are typically errno values, but any number is mapped to a message.
   TODO: PDCLib does not yet support locales.
*/
extern char*  _FUNC(strerror)(int errnum);
 
/* Returns the length of the string s (excluding terminating '\0').*/
extern size_t _FUNC(strlen)(const char * s);
 
/* The function reverses the sequence of characters in the string pointed to by str. */
extern char* _FUNC(strrev)(char *str);
 
/* The strdup function executes the function pointed to by the str argument. */
extern char* _FUNC(strdup)(const char *str);
 
#endif

Subversion Repositories Kolibri OS

(root)/programs/develop/libraries/kolibri-libc/include/string.h – Rev 8687 → 8718

Rev 8687		Rev 8718
1	/* String handling	1	/* String handling
2		2
3	This file is part of the Public Domain C Library (PDCLib).	3	This file is part of the Public Domain C Library (PDCLib).
4	Permission is granted to use, modify, and / or redistribute at will.	4	Permission is granted to use, modify, and / or redistribute at will.
5	*/	5	*/
6		6
7	#ifndef _STRING_H_	7	#ifndef _STRING_H_
8	#define _STRING_H_	8	#define _STRING_H_
9		9
10	#include	10	#include
11		11
12	#ifdef __cplusplus	12	#ifdef __cplusplus
13	extern "C" {	13	extern "C" {
14	#endif	14	#endif
15		15
16	/* String function conventions */	16	/* String function conventions */
17		17
18	/*	18	/*
19	In any of the following functions taking a size_t n to specify the length of	19	In any of the following functions taking a size_t n to specify the length of
20	an array or size of a memory region, n may be 0, but the pointer arguments to	20	an array or size of a memory region, n may be 0, but the pointer arguments to
21	the call shall still be valid unless otherwise stated.	21	the call shall still be valid unless otherwise stated.
22	*/	22	*/
23		23
24	/* Copying functions */	24	/* Copying functions */
25		25
26	extern void* _FUNC(memccpy)(void restrict dest, const void restrict src, int c, size_t n);	26	extern void* _FUNC(memccpy)(void restrict dest, const void restrict src, int c, size_t n);
27		27
28	/* Copy a number of n characters from the memory area pointed to by s2 to the	28	/* Copy a number of n characters from the memory area pointed to by s2 to the
29	area pointed to by s1. If the two areas overlap, behaviour is undefined.	29	area pointed to by s1. If the two areas overlap, behaviour is undefined.
30	Returns the value of s1.	30	Returns the value of s1.
31	*/	31	*/
32	extern void* _FUNC(memcpy)(void* s1, const void* s2, size_t n);	-
33		32
34	/* Copy a number of n characters from the memory area pointed to by s2 to the	33	#ifdef __TINYC__
35	area pointed to by s1. The two areas may overlap.	34	extern void* memcpy(void* s1, const void* s2, size_t n);
36	Returns the value of s1.	-
37	*/	35	extern void* memset(void* s, int c, size_t n);
-		36	extern void* memmove(void* s1, const void* s2, size_t n);
-		37	#else
-		38	extern void* _FUNC(memcpy)(void* s1, const void* s2, size_t n);
-		39	extern void* _FUNC(memset)(void* s, int c, size_t n);
-		40	extern void* _FUNC(memmove)(void* s1, const void* s2, size_t n);
38	extern void* memmove(void* s1, const void* s2, size_t n);	41	#endif
39		42
40	/* Copy the character array s2 (including terminating '\0' byte) into the	43	/* Copy the character array s2 (including terminating '\0' byte) into the
41	character array s1.	44	character array s1.
42	Returns the value of s1.	45	Returns the value of s1.
43	*/	46	*/
44	extern char* _FUNC(strcpy)(char* s1, const char* s2);	47	extern char* _FUNC(strcpy)(char* s1, const char* s2);
45		48
46	/* Copy a maximum of n characters from the character array s2 into the character	49	/* Copy a maximum of n characters from the character array s2 into the character
47	array s1. If s2 is shorter than n characters, '\0' bytes will be appended to	50	array s1. If s2 is shorter than n characters, '\0' bytes will be appended to
48	the copy in s1 until n characters have been written. If s2 is longer than n	51	the copy in s1 until n characters have been written. If s2 is longer than n
49	characters, NO terminating '\0' will be written to s1. If the arrays overlap,	52	characters, NO terminating '\0' will be written to s1. If the arrays overlap,
50	behaviour is undefined.	53	behaviour is undefined.
51	Returns the value of s1.	54	Returns the value of s1.
52	*/	55	*/
53	extern char* _FUNC(strncpy)(char* s1, const char* s2, size_t n);	56	extern char* _FUNC(strncpy)(char* s1, const char* s2, size_t n);
54		57
55	/* Concatenation functions */	58	/* Concatenation functions */
56		59
57	/* Append the contents of the character array s2 (including terminating '\0') to	60	/* Append the contents of the character array s2 (including terminating '\0') to
58	the character array s1 (first character of s2 overwriting the '\0' of s1). If	61	the character array s1 (first character of s2 overwriting the '\0' of s1). If
59	the arrays overlap, behaviour is undefined.	62	the arrays overlap, behaviour is undefined.
60	Returns the value of s1.	63	Returns the value of s1.
61	*/	64	*/
62	extern char* _FUNC(strcat)(char* s1, const char* s2);	65	extern char* _FUNC(strcat)(char* s1, const char* s2);
63		66
64	/* Append a maximum of n characters from the character array s2 to the character	67	/* Append a maximum of n characters from the character array s2 to the character
65	array s1 (first character of s2 overwriting the '\0' of s1). A terminating	68	array s1 (first character of s2 overwriting the '\0' of s1). A terminating
66	'\0' is ALWAYS appended, even if the full n characters have already been	69	'\0' is ALWAYS appended, even if the full n characters have already been
67	written. If the arrays overlap, behaviour is undefined.	70	written. If the arrays overlap, behaviour is undefined.
68	Returns the value of s1.	71	Returns the value of s1.
69	*/	72	*/
70	extern char* _FUNC(strncat)(char* s1, const char* s2, size_t n);	73	extern char* _FUNC(strncat)(char* s1, const char* s2, size_t n);
71		74
72	/* Comparison functions */	75	/* Comparison functions */
73		76
74	/* Compare the first n characters of the memory areas pointed to by s1 and s2.	77	/* Compare the first n characters of the memory areas pointed to by s1 and s2.
75	Returns 0 if s1 == s2, a negative number if s1 < s2, and a positive number if	78	Returns 0 if s1 == s2, a negative number if s1 < s2, and a positive number if
76	s1 > s2.	79	s1 > s2.
77	*/	80	*/
78	extern int _FUNC(memcmp)(const void * s1, const void* s2, size_t n);	81	extern int _FUNC(memcmp)(const void * s1, const void* s2, size_t n);
79		82
80	/* Compare the character arrays s1 and s2.	83	/* Compare the character arrays s1 and s2.
81	Returns 0 if s1 == s2, a negative number if s1 < s2, and a positive number if	84	Returns 0 if s1 == s2, a negative number if s1 < s2, and a positive number if
82	s1 > s2.	85	s1 > s2.
83	*/	86	*/
84	extern int _FUNC(strcmp)(const char * s1, const char* s2);	87	extern int _FUNC(strcmp)(const char * s1, const char* s2);
85		88
86	/* Compare the character arrays s1 and s2, interpreted as specified by the	89	/* Compare the character arrays s1 and s2, interpreted as specified by the
87	LC_COLLATE category of the current locale.	90	LC_COLLATE category of the current locale.
88	Returns 0 if s1 == s2, a negative number if s1 < s2, and a positive number if	91	Returns 0 if s1 == s2, a negative number if s1 < s2, and a positive number if
89	s1 > s2.	92	s1 > s2.
90	TODO: Currently a dummy wrapper for strcmp() as PDCLib does not yet support	93	TODO: Currently a dummy wrapper for strcmp() as PDCLib does not yet support
91	locales.	94	locales.
92	*/	95	*/
93	extern int _FUNC(strcoll)(const char* s1, const char* s2);	96	extern int _FUNC(strcoll)(const char* s1, const char* s2);
94		97
95	/* Compare no more than the first n characters of the character arrays s1 and	98	/* Compare no more than the first n characters of the character arrays s1 and
96	s2.	99	s2.
97	Returns 0 if s1 == s2, a negative number if s1 < s2, and a positive number if	100	Returns 0 if s1 == s2, a negative number if s1 < s2, and a positive number if
98	s1 > s2.	101	s1 > s2.
99	*/	102	*/
100	extern int _FUNC(strncmp)(const char* s1, const char* s2, size_t n);	103	extern int _FUNC(strncmp)(const char* s1, const char* s2, size_t n);
101		104
102	/* Transform the character array s2 as appropriate for the LC_COLLATE setting of	105	/* Transform the character array s2 as appropriate for the LC_COLLATE setting of
103	the current locale. If length of resulting string is less than n, store it in	106	the current locale. If length of resulting string is less than n, store it in
104	the character array pointed to by s1. Return the length of the resulting	107	the character array pointed to by s1. Return the length of the resulting
105	string.	108	string.
106	*/	109	*/
107	extern size_t _FUNC(strxfrm)(char* s1, const char* s2, size_t n);	110	extern size_t _FUNC(strxfrm)(char* s1, const char* s2, size_t n);
108		111
109	/* Search functions */	112	/* Search functions */
110		113
111	/* Search the first n characters in the memory area pointed to by s for the	114	/* Search the first n characters in the memory area pointed to by s for the
112	character c (interpreted as unsigned char).	115	character c (interpreted as unsigned char).
113	Returns a pointer to the first instance found, or NULL.	116	Returns a pointer to the first instance found, or NULL.
114	*/	117	*/
115	extern void* _FUNC(memchr)(const void* s, int c, size_t n);	118	extern void* _FUNC(memchr)(const void* s, int c, size_t n);
116		119
117	/* Search the character array s (including terminating '\0') for the character c	120	/* Search the character array s (including terminating '\0') for the character c
118	(interpreted as char).	121	(interpreted as char).
119	Returns a pointer to the first instance found, or NULL.	122	Returns a pointer to the first instance found, or NULL.
120	*/	123	*/
121	extern char* _FUNC(strchr)(const char* s, int c);	124	extern char* _FUNC(strchr)(const char* s, int c);
122		125
123	/* Determine the length of the initial substring of character array s1 which	126	/* Determine the length of the initial substring of character array s1 which
124	consists only of characters not from the character array s2.	127	consists only of characters not from the character array s2.
125	Returns the length of that substring.	128	Returns the length of that substring.
126	*/	129	*/
127	extern size_t _FUNC(strcspn)(const char* s1, const char* s2);	130	extern size_t _FUNC(strcspn)(const char* s1, const char* s2);
128		131
129	/* Search the character array s1 for any character from the character array s2.	132	/* Search the character array s1 for any character from the character array s2.
130	Returns a pointer to the first occurrence, or NULL.	133	Returns a pointer to the first occurrence, or NULL.
131	*/	134	*/
132	extern char* _FUNC(strpbrk)(const char* s1, const char* s2);	135	extern char* _FUNC(strpbrk)(const char* s1, const char* s2);
133		136
134	/* Search the character array s (including terminating '\0') for the character c	137	/* Search the character array s (including terminating '\0') for the character c
135	(interpreted as char).	138	(interpreted as char).
136	Returns a pointer to the last instance found, or NULL.	139	Returns a pointer to the last instance found, or NULL.
137	*/	140	*/
138	extern char* _FUNC(strrchr)(const char * s, int c );	141	extern char* _FUNC(strrchr)(const char * s, int c );
139		142
140	/* Determine the length of the initial substring of character array s1 which	143	/* Determine the length of the initial substring of character array s1 which
141	consists only of characters from the character array s2.	144	consists only of characters from the character array s2.
142	Returns the length of that substring.	145	Returns the length of that substring.
143	*/	146	*/
144	extern size_t _FUNC(strspn)(const char * s1, const char * s2);	147	extern size_t _FUNC(strspn)(const char * s1, const char * s2);
145		148
146	/* Search the character array s1 for the substring in character array s2.	149	/* Search the character array s1 for the substring in character array s2.
147	Returns a pointer to that sbstring, or NULL. If s2 is of length zero,	150	Returns a pointer to that sbstring, or NULL. If s2 is of length zero,
148	returns s1.	151	returns s1.
149	*/	152	*/
150	extern char* _FUNC(strstr)(const char * s1, const char * s2);	153	extern char* _FUNC(strstr)(const char * s1, const char * s2);
151		154
152	/* In a series of subsequent calls, parse a C string into tokens.	155	/* In a series of subsequent calls, parse a C string into tokens.
153	On the first call to strtok(), the first argument is a pointer to the to-be-	156	On the first call to strtok(), the first argument is a pointer to the to-be-
154	parsed C string. On subsequent calls, the first argument is NULL unless you	157	parsed C string. On subsequent calls, the first argument is NULL unless you
155	want to start parsing a new string. s2 holds an array of separator characters	158	want to start parsing a new string. s2 holds an array of separator characters
156	which can differ from call to call. Leading separators are skipped, the first	159	which can differ from call to call. Leading separators are skipped, the first
157	trailing separator overwritten with '\0'.	160	trailing separator overwritten with '\0'.
158	Returns a pointer to the next token.	161	Returns a pointer to the next token.
159	WARNING: This function uses static storage, and as such is not reentrant.	162	WARNING: This function uses static storage, and as such is not reentrant.
160	*/	163	*/
161	extern char* _FUNC(strtok)(char* s1, const char* s2);	164	extern char* _FUNC(strtok)(char* s1, const char* s2);
162		-
163	/* Miscellaneous functions */	-
164		-
165	/* Write the character c (interpreted as unsigned char) to the first n	-
166	characters of the memory area pointed to by s.	-
167	Returns s.	-
168	*/	-
169	extern void* _FUNC(memset)(void* s, int c, size_t n);	-
170		165
171	/* Map an error number to a (locale-specific) error message string. Error	166	/* Map an error number to a (locale-specific) error message string. Error
172	numbers are typically errno values, but any number is mapped to a message.	167	numbers are typically errno values, but any number is mapped to a message.
173	TODO: PDCLib does not yet support locales.	168	TODO: PDCLib does not yet support locales.
174	*/	169	*/
175	extern char* _FUNC(strerror)(int errnum);	170	extern char* _FUNC(strerror)(int errnum);
176		171
177	/* Returns the length of the string s (excluding terminating '\0').*/	172	/* Returns the length of the string s (excluding terminating '\0').*/
178	extern size_t _FUNC(strlen)(const char * s);	173	extern size_t _FUNC(strlen)(const char * s);
179		174
180	/* The function reverses the sequence of characters in the string pointed to by str. */	175	/* The function reverses the sequence of characters in the string pointed to by str. */
181	extern char* _FUNC(strrev)(char *str);	176	extern char* _FUNC(strrev)(char *str);
182		177
183	/* The strdup function executes the function pointed to by the str argument. */	178	/* The strdup function executes the function pointed to by the str argument. */
184	extern char* _FUNC(strdup)(const char *str);	179	extern char* _FUNC(strdup)(const char *str);
185		180
186	#endif	181	#endif