[glibc.git] / string / string.h

/* Copyright (C) 1991, 92, 93, 95, 96 Free Software Foundation, Inc.
This file is part of the GNU C Library.

The GNU C Library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.

The GNU C Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Library General Public License for more details.

You should have received a copy of the GNU Library General Public
License along with the GNU C Library; see the file COPYING.LIB.  If
not, write to the, 1992 Free Software Foundation, Inc., 675 Mass Ave,
Cambridge, MA 02139, USA.  */

/*
 *	ANSI Standard: 4.11 STRING HANDLING	<string.h>
 */

#ifndef	_STRING_H

#define	_STRING_H	1
#include <features.h>

__BEGIN_DECLS

/* Get size_t and NULL from <stddef.h>.  */
#define	__need_size_t
#define	__need_NULL
#include <stddef.h>


/* Copy N bytes of SRC to DEST.  */
extern __ptr_t memcpy __P ((__ptr_t __dest, __const __ptr_t __src,
			    size_t __n));
/* Copy N bytes of SRC to DEST, guaranteeing
   correct behavior for overlapping strings.  */
extern __ptr_t memmove __P ((__ptr_t __dest, __const __ptr_t __src,
			     size_t __n));

/* Copy no more than N bytes of SRC to DEST, stopping when C is found.
   Return the position in DEST one byte past where C was copied,
   or NULL if C was not found in the first N bytes of SRC.  */
extern __ptr_t __memccpy __P ((__ptr_t __dest, __const __ptr_t __src,
			       int __c, size_t __n));
#if defined (__USE_SVID) || defined (__USE_BSD)
extern __ptr_t memccpy __P ((__ptr_t __dest, __const __ptr_t __src,
			     int __c, size_t __n));
#ifdef	__OPTIMIZE__
#define	memccpy(dest, src, c, n) __memccpy((dest), (src), (c), (n))
#endif /* Optimizing.  */
#endif /* SVID.  */


/* Set N bytes of S to C.  */
extern __ptr_t memset __P ((__ptr_t __s, int __c, size_t __n));

/* Compare N bytes of S1 and S2.  */
extern int memcmp __P ((__const __ptr_t __s1, __const __ptr_t __s2,
			size_t __n));

/* Search N bytes of S for C.  */
extern __ptr_t memchr __P ((__const __ptr_t __s, int __c, size_t __n));


/* Copy SRC to DEST.  */
extern char *strcpy __P ((char *__dest, __const char *__src));
/* Copy no more than N characters of SRC to DEST.  */
extern char *strncpy __P ((char *__dest, __const char *__src, size_t __n));

/* Append SRC onto DEST.  */
extern char *strcat __P ((char *__dest, __const char *__src));
/* Append no more than N characters from SRC onto DEST.  */
extern char *strncat __P ((char *__dest, __const char *__src, size_t __n));

/* Compare S1 and S2.  */
extern int strcmp __P ((__const char *__s1, __const char *__s2));
/* Compare N characters of S1 and S2.  */
extern int strncmp __P ((__const char *__s1, __const char *__s2, size_t __n));

/* Compare the collated forms of S1 and S2.  */
extern int strcoll __P ((__const char *__s1, __const char *__s2));
/* Put a transformation of SRC into no more than N bytes of DEST.  */
extern size_t strxfrm __P ((char *__dest, __const char *__src, size_t __n));

#if defined (__USE_SVID) || defined (__USE_BSD)
/* Duplicate S, returning an identical malloc'd string.  */
extern char *strdup __P ((__const char *__s));
#endif

#if defined (__USE_GNU) && defined (__GNUC__)
/* Duplicate S, returning an identical alloca'd string.  */
#define strdupa(s)							      \
({									      \
    const char *__old = (s);						      \
    size_t __len = strlen (__old) + 1;					      \
    memcpy (__builtin_alloca (__len), __old, __len);			      \
})
#endif

/* Find the first occurrence of C in S.  */
extern char *strchr __P ((__const char *__s, int __c));
/* Find the last occurrence of C in S.  */
extern char *strrchr __P ((__const char *__s, int __c));

/* Return the length of the initial segment of S which
   consists entirely of characters not in REJECT.  */
extern size_t strcspn __P ((__const char *__s, __const char *__reject));
/* Return the length of the initial segment of S which
   consists entirely of characters in ACCEPT.  */
extern size_t strspn __P ((__const char *__s, __const char *__accept));
/* Find the first occurence in S of any character in ACCEPT.  */
extern char *strpbrk __P ((__const char *__s, __const char *__accept));
/* Find the first occurence of NEEDLE in HAYSTACK.  */
extern char *strstr __P ((__const char *__haystack, __const char *__needle));
/* Divide S into tokens separated by characters in DELIM.  */
extern char *strtok __P ((char *__s, __const char *__delim));

#ifdef	__USE_GNU
/* Find the first occurence of NEEDLE in HAYSTACK.
   NEEDLE is NEEDLELEN bytes long;
   HAYSTACK is HAYSTACKLEN bytes long.  */
extern __ptr_t memmem __P ((__const __ptr_t __haystack, size_t __haystacklen,
			    __const __ptr_t __needle, size_t __needlelen));
#endif


/* Return the length of S.  */
extern size_t strlen __P ((__const char *__s));

#ifdef	__USE_GNU
/* Find the length of STRING, but scan at most MAXLEN characters.
   If no '\0' terminator is found in that many characters, return MAXLEN.  */
extern size_t strnlen __P ((__const char *__string, size_t __maxlen));

#ifdef	__OPTIMIZE__
extern __inline size_t
strnlen (__const char *__string, size_t __maxlen)
{
  __const char *__end = memchr (__string, '\0', __maxlen);
  return __end ? __end - __string : __maxlen;
}
#endif
#endif


/* Return a string describing the meaning of the `errno' code in ERRNUM.  */
extern char *strerror __P ((int __errnum));
#ifdef	__USE_REENTRANT
/* Reentrant version of `strerror'.  If a temporary buffer is required, at
   most BUFLEN bytes of BUF will be used.  */
extern char *strerror_r __P ((int __errnum, char *__buf, int __buflen));
#endif

#ifdef	__USE_BSD
/* Find the first occurrence of C in S (same as strchr).  */
extern char *index __P ((__const char *__s, int __c));

/* Find the last occurrence of C in S (same as strrchr).  */
extern char *rindex __P ((__const char *__s, int __c));

/* Copy N bytes of SRC to DEST (like memmove, but args reversed).  */
extern void bcopy __P ((__const __ptr_t __src, __ptr_t __dest, size_t __n));

/* Set N bytes of S to 0.  */
extern void bzero __P ((__ptr_t __s, size_t __n));

/* Compare N bytes of S1 and S2 (same as memcmp).  */
extern int bcmp __P ((__const __ptr_t __s1, __const __ptr_t __s2, size_t __n));

/* Return the position of the first bit set in I, or 0 if none are set.
   The least-significant bit is position 1, the most-significant 32.  */
extern int ffs __P ((int __i));

/* Compare S1 and S2, ignoring case.  */
extern int __strcasecmp __P ((__const char *__s1, __const char *__s2));
extern int strcasecmp __P ((__const char *__s1, __const char *__s2));

/* Return the next DELIM-delimited token from *STRINGP,
   terminating it with a '\0', and update *STRINGP to point past it.  */
extern char *strsep __P ((char **__stringp, __const char *__delim));
#endif

#ifdef	__USE_GNU
/* Compare no more than N chars of S1 and S2, ignoring case.  */
extern int strncasecmp __P ((__const char *__s1, __const char *__s2,
			     size_t __n));

/* Return a string describing the meaning of the signal number in SIG.  */
extern char *strsignal __P ((int __sig));

/* Copy SRC to DEST, returning the address of the terminating '\0' in DEST.  */
extern char *__stpcpy __P ((char *__dest, __const char *__src));
extern char *stpcpy __P ((char *__dest, __const char *__src));

/* Copy no more than N characters of SRC to DEST, returning the address of
   the last character written into DEST.  */
extern char *__stpncpy __P ((char *__dest, __const char *__src, size_t __n));
extern char *stpncpy __P ((char *__dest, __const char *__src, size_t __n));

/* Sautee STRING briskly.  */
extern char *strfry __P ((char *__string));

/* Frobnicate N bytes of S.  */
extern __ptr_t memfrob __P ((__ptr_t __s, size_t __n));
#endif

__END_DECLS

#endif /* string.h  */
Commit	Line	Data
02ac66c5	1	/* Copyright (C) 1991, 92, 93, 95, 96 Free Software Foundation, Inc.
28f540f4 RM	2	This file is part of the GNU C Library.
	3
	4	The GNU C Library is free software; you can redistribute it and/or
	5	modify it under the terms of the GNU Library General Public License as
	6	published by the Free Software Foundation; either version 2 of the
	7	License, or (at your option) any later version.
	8
	9	The GNU C Library is distributed in the hope that it will be useful,
	10	but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	12	Library General Public License for more details.
	13
	14	You should have received a copy of the GNU Library General Public
	15	License along with the GNU C Library; see the file COPYING.LIB. If
	16	not, write to the, 1992 Free Software Foundation, Inc., 675 Mass Ave,
	17	Cambridge, MA 02139, USA. */
	18
	19	/*
	20	* ANSI Standard: 4.11 STRING HANDLING <string.h>
	21	*/
	22
	23	#ifndef _STRING_H
	24
	25	#define _STRING_H 1
	26	#include <features.h>
	27
	28	__BEGIN_DECLS
	29
	30	/* Get size_t and NULL from <stddef.h>. */
	31	#define __need_size_t
	32	#define __need_NULL
	33	#include <stddef.h>
	34
	35
	36	/* Copy N bytes of SRC to DEST. */
	37	extern __ptr_t memcpy __P ((__ptr_t __dest, __const __ptr_t __src,
	38	size_t __n));
	39	/* Copy N bytes of SRC to DEST, guaranteeing
	40	correct behavior for overlapping strings. */
	41	extern __ptr_t memmove __P ((__ptr_t __dest, __const __ptr_t __src,
	42	size_t __n));
	43
	44	/* Copy no more than N bytes of SRC to DEST, stopping when C is found.
	45	Return the position in DEST one byte past where C was copied,
	46	or NULL if C was not found in the first N bytes of SRC. */
	47	extern __ptr_t __memccpy __P ((__ptr_t __dest, __const __ptr_t __src,
	48	int __c, size_t __n));
	49	#if defined (__USE_SVID) \|\| defined (__USE_BSD)
	50	extern __ptr_t memccpy __P ((__ptr_t __dest, __const __ptr_t __src,
	51	int __c, size_t __n));
	52	#ifdef __OPTIMIZE__
	53	#define memccpy(dest, src, c, n) __memccpy((dest), (src), (c), (n))
	54	#endif /* Optimizing. */
	55	#endif /* SVID. */
	56
	57
	58	/* Set N bytes of S to C. */
	59	extern __ptr_t memset __P ((__ptr_t __s, int __c, size_t __n));
	60
	61	/* Compare N bytes of S1 and S2. */
	62	extern int memcmp __P ((__const __ptr_t __s1, __const __ptr_t __s2,
	63	size_t __n));
	64
	65	/* Search N bytes of S for C. */
66	extern __ptr_t memchr __P ((__const __ptr_t __s, int __c, size_t __n));
67
68
69	/* Copy SRC to DEST. */
70	extern char strcpy __P ((char __dest, __const char *__src));
71	/* Copy no more than N characters of SRC to DEST. */
72	extern char strncpy __P ((char __dest, __const char *__src, size_t __n));
73
74	/* Append SRC onto DEST. */
75	extern char strcat __P ((char __dest, __const char *__src));
76	/* Append no more than N characters from SRC onto DEST. */
77	extern char strncat __P ((char __dest, __const char *__src, size_t __n));
78
79	/* Compare S1 and S2. */
80	extern int strcmp __P ((__const char __s1, __const char __s2));
81	/* Compare N characters of S1 and S2. */
82	extern int strncmp __P ((__const char __s1, __const char __s2, size_t __n));
83
84	/* Compare the collated forms of S1 and S2. */
85	extern int strcoll __P ((__const char __s1, __const char __s2));
86	/* Put a transformation of SRC into no more than N bytes of DEST. */
87	extern size_t strxfrm __P ((char __dest, __const char __src, size_t __n));
88
89	#if defined (__USE_SVID) \|\| defined (__USE_BSD)
90	/* Duplicate S, returning an identical malloc'd string. */
91	extern char strdup __P ((__const char __s));
92	#endif
93
02ac66c5 RM	94	#if defined (__USE_GNU) && defined (__GNUC__)
	95	/* Duplicate S, returning an identical alloca'd string. */
	96	#define strdupa(s) \
	97	({ \
	98	const char *__old = (s); \
	99	size_t __len = strlen (__old) + 1; \
	100	memcpy (__builtin_alloca (__len), __old, __len); \
	101	})
	102	#endif
	103
28f540f4 RM	104	/* Find the first occurrence of C in S. */
	105	extern char strchr __P ((__const char __s, int __c));
	106	/* Find the last occurrence of C in S. */
	107	extern char strrchr __P ((__const char __s, int __c));
	108
	109	/* Return the length of the initial segment of S which
	110	consists entirely of characters not in REJECT. */
	111	extern size_t strcspn __P ((__const char __s, __const char __reject));
	112	/* Return the length of the initial segment of S which
	113	consists entirely of characters in ACCEPT. */
	114	extern size_t strspn __P ((__const char __s, __const char __accept));
	115	/* Find the first occurence in S of any character in ACCEPT. */
	116	extern char strpbrk __P ((__const char __s, __const char *__accept));
	117	/* Find the first occurence of NEEDLE in HAYSTACK. */
	118	extern char strstr __P ((__const char __haystack, __const char *__needle));
	119	/* Divide S into tokens separated by characters in DELIM. */
	120	extern char strtok __P ((char __s, __const char *__delim));
	121
	122	#ifdef __USE_GNU
	123	/* Find the first occurence of NEEDLE in HAYSTACK.
	124	NEEDLE is NEEDLELEN bytes long;
	125	HAYSTACK is HAYSTACKLEN bytes long. */
	126	extern __ptr_t memmem __P ((__const __ptr_t __haystack, size_t __haystacklen,
	127	__const __ptr_t __needle, size_t __needlelen));
	128	#endif
	129
8d71c7b0	130
28f540f4 RM	131	/* Return the length of S. */
	132	extern size_t strlen __P ((__const char *__s));
	133
8d71c7b0 RM	134	#ifdef __USE_GNU
	135	/* Find the length of STRING, but scan at most MAXLEN characters.
	136	If no '\0' terminator is found in that many characters, return MAXLEN. */
	137	extern size_t strnlen __P ((__const char *__string, size_t __maxlen));
	138
	139	#ifdef __OPTIMIZE__
	140	extern __inline size_t
	141	strnlen (__const char *__string, size_t __maxlen)
	142	{
	143	__const char *__end = memchr (__string, '\0', __maxlen);
	144	return __end ? __end - __string : __maxlen;
	145	}
	146	#endif
	147	#endif
	148
	149
60478656	150	/* Return a string describing the meaning of the `errno' code in ERRNUM. */
28f540f4	151	extern char *strerror __P ((int __errnum));
60478656 RM	152	#ifdef __USE_REENTRANT
	153	/* Reentrant version of `strerror'. If a temporary buffer is required, at
	154	most BUFLEN bytes of BUF will be used. */
	155	extern char strerror_r __P ((int __errnum, char __buf, int __buflen));
	156	#endif
28f540f4 RM	157
	158	#ifdef __USE_BSD
	159	/* Find the first occurrence of C in S (same as strchr). */
	160	extern char index __P ((__const char __s, int __c));
	161
	162	/* Find the last occurrence of C in S (same as strrchr). */
	163	extern char rindex __P ((__const char __s, int __c));
	164
	165	/* Copy N bytes of SRC to DEST (like memmove, but args reversed). */
	166	extern void bcopy __P ((__const __ptr_t __src, __ptr_t __dest, size_t __n));
	167
	168	/* Set N bytes of S to 0. */
	169	extern void bzero __P ((__ptr_t __s, size_t __n));
	170
	171	/* Compare N bytes of S1 and S2 (same as memcmp). */
	172	extern int bcmp __P ((__const __ptr_t __s1, __const __ptr_t __s2, size_t __n));
	173
	174	/* Return the position of the first bit set in I, or 0 if none are set.
	175	The least-significant bit is position 1, the most-significant 32. */
	176	extern int ffs __P ((int __i));
	177
	178	/* Compare S1 and S2, ignoring case. */
3ec41e03	179	extern int __strcasecmp __P ((__const char __s1, __const char __s2));
28f540f4 RM	180	extern int strcasecmp __P ((__const char __s1, __const char __s2));
	181
	182	/* Return the next DELIM-delimited token from *STRINGP,
	183	terminating it with a '\0', and update STRINGP to point past it. /
	184	extern char strsep __P ((char __stringp, __const char __delim));
	185	#endif
	186
28f540f4 RM	187	#ifdef __USE_GNU
	188	/* Compare no more than N chars of S1 and S2, ignoring case. */
	189	extern int strncasecmp __P ((__const char __s1, __const char __s2,
	190	size_t __n));
	191
	192	/* Return a string describing the meaning of the signal number in SIG. */
	193	extern char *strsignal __P ((int __sig));
	194
	195	/* Copy SRC to DEST, returning the address of the terminating '\0' in DEST. */
3ec41e03	196	extern char __stpcpy __P ((char __dest, __const char *__src));
28f540f4 RM	197	extern char stpcpy __P ((char __dest, __const char *__src));
	198
	199	/* Copy no more than N characters of SRC to DEST, returning the address of
	200	the last character written into DEST. */
3ec41e03	201	extern char __stpncpy __P ((char __dest, __const char *__src, size_t __n));
28f540f4 RM	202	extern char stpncpy __P ((char __dest, __const char *__src, size_t __n));
28f540f4 RM	203
28f540f4 RM	204	/* Sautee STRING briskly. */
	205	extern char strfry __P ((char __string));
	206
	207	/* Frobnicate N bytes of S. */
	208	extern __ptr_t memfrob __P ((__ptr_t __s, size_t __n));
	209	#endif
	210
	211	__END_DECLS
	212
	213	#endif /* string.h */