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