5 /* String handling <string.h>
7 This file is part of the Public Domain C Library (PDCLib).
8 Permission is granted to use, modify, and / or redistribute at will.
11 #ifndef _PDCLIB_STRING_H
12 #define _PDCLIB_STRING_H _PDCLIB_STRING_H
15 #define _PDCLIB_AUX_H _PDCLIB_AUX_H
16 #include <_PDCLIB_aux.h>
20 #define _PDCLIB_INT_H _PDCLIB_INT_H
21 #include <_PDCLIB_int.h>
24 typedef _PDCLIB_size_t size_t;
26 #define NULL _PDCLIB_NULL
28 /* String function conventions */
31 In any of the following functions taking a size_t n to specify the length of
32 an array or size of a memory region, n may be 0, but the pointer arguments to
33 the call shall still be valid unless otherwise stated.
36 /* Copying functions */
38 /* Copy a number of n characters from the memory area pointed to by s2 to the
39 area pointed to by s1. If the two areas overlap, behaviour is undefined.
40 Returns the value of s1.
42 void * memcpy( void * _PDCLIB_restrict s1, const void * _PDCLIB_restrict s2, size_t n );
44 /* Copy a number of n characters from the memory area pointed to by s2 to the
45 area pointed to by s1. The two areas may overlap.
46 Returns the value of s1.
48 void * memmove( void * _PDCLIB_restrict s1, const void * _PDCLIB_restrict s2, size_t n );
50 /* Copy the character array s2 (including terminating '\0' byte) into the
52 Returns the value of s1.
54 char * strcpy( char * _PDCLIB_restrict s1, const char * _PDCLIB_restrict s2 );
56 /* Copy a maximum of n characters from the character array s2 into the character
57 array s1. If s2 is shorter than n characters, '\0' bytes will be appended to
58 the copy in s1 until n characters have been written. If s2 is longer than n
59 characters, NO terminating '\0' will be written to s1. If the arrays overlap,
60 behaviour is undefined.
61 Returns the value of s1.
63 char * strncpy( char * _PDCLIB_restrict s1, const char * _PDCLIB_restrict s2, size_t n );
65 /* Concatenation functions */
67 /* Append the contents of the character array s2 (including terminating '\0') to
68 the character array s1 (first character of s2 overwriting the '\0' of s1). If
69 the arrays overlap, behaviour is undefined.
70 Returns the value of s1.
72 char * strcat( char * _PDCLIB_restrict s1, const char * _PDCLIB_restrict s2 );
74 /* Append a maximum of n characters from the character array s1 to the character
75 array s1 (first character of s2 overwriting the '\0' of s1). A terminating
76 '\0' is ALWAYS appended, even if the full n characters have already been
77 written. If the arrays overlap, behaviour is undefined.
78 Returns the value of s1.
80 char * strncat( char * _PDCLIB_restrict s1, const char * _PDCLIB_restrict s2, size_t n );
82 /* Comparison functions */
84 /* Compare the first n characters of the memory areas pointed to by s1 and s2.
85 Returns 0 if s1 == s2, a negative number if s1 < s2, and a positive number if
88 int memcmp( const void * s1, const void * s2, size_t n );
90 /* Compare the character arrays s1 and s2.
91 Returns 0 if s1 == s2, a negative number if s1 < s2, and a positive number if
94 int strcmp( const char * s1, const char * s2 );
96 /* Compare the character arrays s1 and s2, interpreted as specified by the
97 LC_COLLATE category of the current locale.
98 Returns 0 if s1 == s2, a negative number if s1 < s2, and a positive number if
100 TODO: Currently a dummy wrapper for strcmp() as PDCLib does not yet support
103 int strcoll( const char * s1, const char * s2 );
105 /* Compare no more than the first n characters of the character arrays s1 and
107 Returns 0 if s1 == s2, a negative number if s1 < s2, and a positive number if
110 int strncmp( const char * s1, const char * s2, size_t n );
112 /* Transform the character array s2 as appropriate for the LC_COLLATE setting of
113 the current locale. If length of resulting string is less than n, store it in
114 the character array pointed to by s1. Return the length of the resulting
117 size_t strxfrm( char * _PDCLIB_restrict s1, const char * _PDCLIB_restrict s2, size_t n );
119 /* Search functions */
121 /* Search the first n characters in the memory area pointed to by s for the
122 character c (interpreted as unsigned char).
123 Returns a pointer to the first instance found, or NULL.
125 void * memchr( const void * s, int c, size_t n );
127 /* Search the character array s (including terminating '\0') for the character c
128 (interpreted as char).
129 Returns a pointer to the first instance found, or NULL.
131 char * strchr( const char * s, int c );
133 /* Determine the length of the initial substring of character array s1 which
134 consists only of characters not from the character array s2.
135 Returns the length of that substring.
137 size_t strcspn( const char * s1, const char * s2 );
139 /* Search the character array s1 for any character from the character array s2.
140 Returns a pointer to the first occurrence, or NULL.
142 char * strpbrk( const char * s1, const char * s2 );
144 /* Search the character array s (including terminating '\0') for the character c
145 (interpreted as char).
146 Returns a pointer to the last instance found, or NULL.
148 char * strrchr( const char * s, int c );
150 /* Determine the length of the initial substring of character array s1 which
151 consists only of characters from the character array s2.
152 Returns the length of that substring.
154 size_t strspn( const char * s1, const char * s2 );
156 /* Search the character array s1 for the substring in character array s2.
157 Returns a pointer to that sbstring, or NULL. If s2 is of length zero,
160 char * strstr( const char * s1, const char * s2 );
162 /* In a series of subsequent calls, parse a C string into tokens.
163 On the first call to strtok(), the first argument is a pointer to the to-be-
164 parsed C string. On subsequent calls, the first argument is NULL unless you
165 want to start parsing a new string. s2 holds an array of seperator characters
166 which can differ from call to call. Leading seperators are skipped, the first
167 trailing seperator overwritten with '\0'.
168 Returns a pointer to the next token.
169 WARNING: This function uses static storage, and as such is not reentrant.
171 char * strtok( char * _PDCLIB_restrict s1, const char * _PDCLIB_restrict s2 );
173 /* Miscellaneous functions */
175 /* Write the character c (interpreted as unsigned char) to the first n
176 characters of the memory area pointed to by s.
179 void * memset( void * s, int c, size_t n );
181 /* Map an error number to a (locale-specific) error message string. Error
182 numbers are typically errno values, but any number is mapped to a message.
183 TODO: PDCLib does not yet support locales.
184 TODO: strerror() not yet implemented.
185 char * strerror( int errnum );
188 /* Returns the length of the string s (excluding terminating '\0').
190 size_t strlen( const char * s );