[thirdparty/glibc.git] / string / string.h

/* Copyright (C) 1991, 92, 93, 95, 96, 97 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 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.  */

/*
 *	ISO C 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) || defined (__USE_XOPEN)
extern __ptr_t memccpy __P ((__ptr_t __dest, __const __ptr_t __src,
			     int __c, size_t __n));
#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));

#ifdef __USE_GNU
/* The following functions are equivalent to the both above but they
   take the locale they use for the collation as an extra argument.
   This is not standardsized but something like will come.  */
# include <xlocale.h>

/* Compare the collated forms of S1 and S2 using rules from L.  */
extern int __strcoll_l __P ((__const char *__s1, __const char *__s2,
			     __locale_t __l));
/* Put a transformation of SRC into no more than N bytes of DEST.  */
extern size_t __strxfrm_l __P ((char *__dest, __const char *__src, size_t __n,
				__locale_t __l));
#endif

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

/* Return a malloc'd copy of at most N bytes of STRING.  The
   resultant string is terminated even if no null terminator
   appears before STRING[N].  */
extern char *__strndup __P ((__const char *__string, size_t __n));
#if defined(__USE_GNU)
extern char *strndup __P ((__const char *__string, size_t __n));
#endif

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

/* Return an alloca'd copy of at most N bytes of string.  */
#define strndupa(s, n)							      \
  (__extension__							      \
    ({									      \
      __const char *__old = (s);					      \
      size_t __len = strnlen (__old, (n));				      \
      char *__new = __builtin_alloca (__len + 1);			      \
      __new[__len] = '\0';						      \
      memcpy (__new, __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 occurrence in S of any character in ACCEPT.  */
extern char *strpbrk __P ((__const char *__s, __const char *__accept));
/* Find the first occurrence 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));

#if defined __USE_POSIX || defined __USE_MISC
/* Divide S into tokens separated by characters in DELIM.  Information
   passed between calls are stored in SAVE_PTR.  */
extern char *strtok_r __P ((char *__s, __const char *__delim,
			    char **__save_ptr));
#endif

#ifdef __USE_GNU
/* Find the first occurrence 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 = (__const char *) 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_MISC
/* 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, size_t __buflen));
extern char *strerror_r __P ((int __errnum, char *__buf, size_t __buflen));
#endif

#if defined(__USE_BSD) || defined(__USE_XOPEN_EXTENDED)
/* 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));

/* 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));

/* 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));

/* 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));
extern int strncasecmp __P ((__const char *__s1, __const char *__s2,
			     size_t __n));
#endif /* Use BSD or X/Open Unix.  */

#ifdef	__USE_BSD
/* 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));
extern char *strsep __P ((char **__stringp, __const char *__delim));
#endif

#ifdef	__USE_GNU
/* 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

#ifdef	__USE_MISC
/* Return the file name within directory of FILENAME.  */
extern char *basename __P ((__const char *__filename));
#endif

__END_DECLS

#endif /* string.h  */
Commit	Line	Data
df4ef2ab	1	/* Copyright (C) 1991, 92, 93, 95, 96, 97 Free Software Foundation, Inc.
ba1ffaa1	2	This file is part of the GNU C Library.
28f540f4	3
ba1ffaa1 UD	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.
28f540f4	8
ba1ffaa1 UD	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.
28f540f4	13
ba1ffaa1 UD	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 not,
	16	write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
	17	Boston, MA 02111-1307, USA. */
28f540f4 RM	18
28f540f4 RM	19	/*
ba1ffaa1	20	* ISO C Standard: 4.11 STRING HANDLING <string.h>
28f540f4 RM	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));
2c6fe0bd	49	#if defined (__USE_SVID) \|\| defined (__USE_BSD) \|\| defined (__USE_XOPEN)
28f540f4 RM	50	extern __ptr_t memccpy __P ((__ptr_t __dest, __const __ptr_t __src,
28f540f4 RM	51	int __c, size_t __n));
28f540f4 RM	52	#endif /* SVID. */
	53
	54
	55	/* Set N bytes of S to C. */
	56	extern __ptr_t memset __P ((__ptr_t __s, int __c, size_t __n));
	57
	58	/* Compare N bytes of S1 and S2. */
	59	extern int memcmp __P ((__const __ptr_t __s1, __const __ptr_t __s2,
	60	size_t __n));
	61
	62	/* Search N bytes of S for C. */
	63	extern __ptr_t memchr __P ((__const __ptr_t __s, int __c, size_t __n));
	64
	65
	66	/* Copy SRC to DEST. */
	67	extern char strcpy __P ((char __dest, __const char *__src));
	68	/* Copy no more than N characters of SRC to DEST. */
	69	extern char strncpy __P ((char __dest, __const char *__src, size_t __n));
	70
	71	/* Append SRC onto DEST. */
	72	extern char strcat __P ((char __dest, __const char *__src));
	73	/* Append no more than N characters from SRC onto DEST. */
	74	extern char strncat __P ((char __dest, __const char *__src, size_t __n));
	75
	76	/* Compare S1 and S2. */
	77	extern int strcmp __P ((__const char __s1, __const char __s2));
	78	/* Compare N characters of S1 and S2. */
	79	extern int strncmp __P ((__const char __s1, __const char __s2, size_t __n));
	80
	81	/* Compare the collated forms of S1 and S2. */
	82	extern int strcoll __P ((__const char __s1, __const char __s2));
	83	/* Put a transformation of SRC into no more than N bytes of DEST. */
	84	extern size_t strxfrm __P ((char __dest, __const char __src, size_t __n));
	85
c84142e8 UD	86	#ifdef __USE_GNU
	87	/* The following functions are equivalent to the both above but they
	88	take the locale they use for the collation as an extra argument.
	89	This is not standardsized but something like will come. */
	90	# include <xlocale.h>
	91
	92	/* Compare the collated forms of S1 and S2 using rules from L. */
	93	extern int __strcoll_l __P ((__const char __s1, __const char __s2,
	94	__locale_t __l));
	95	/* Put a transformation of SRC into no more than N bytes of DEST. */
	96	extern size_t __strxfrm_l __P ((char __dest, __const char __src, size_t __n,
	97	__locale_t __l));
	98	#endif
	99
2c6fe0bd	100	#if defined(__USE_SVID) \|\| defined(__USE_BSD) \|\| defined(__USE_XOPEN_EXTENDED)
28f540f4	101	/* Duplicate S, returning an identical malloc'd string. */
6dbe2837	102	extern char __strdup __P ((__const char __s));
28f540f4 RM	103	extern char strdup __P ((__const char __s));
	104	#endif
	105
6dbe2837 RM	106	/* Return a malloc'd copy of at most N bytes of STRING. The
	107	resultant string is terminated even if no null terminator
	108	appears before STRING[N]. */
ce7a5ef4	109	extern char __strndup __P ((__const char __string, size_t __n));
6d52618b	110	#if defined(__USE_GNU)
6dbe2837	111	extern char strndup __P ((__const char __string, size_t __n));
6d52618b	112	#endif
6dbe2837	113
036cc82f RM	114	#if defined (__USE_GNU) && defined (__GNUC__)
	115	/* Duplicate S, returning an identical alloca'd string. */
	116	#define strdupa(s) \
	117	(__extension__ \
	118	({ \
	119	__const char *__old = (s); \
	120	size_t __len = strlen (__old) + 1; \
	121	char *__new = __builtin_alloca (__len); \
	122	memcpy (__new, __old, __len); \
	123	}))
	124
6dbe2837 RM	125	/* Return an alloca'd copy of at most N bytes of string. */
6dbe2837 RM	126	#define strndupa(s, n) \
036cc82f RM	127	(__extension__ \
	128	({ \
	129	__const char *__old = (s); \
	130	size_t __len = strnlen (__old, (n)); \
	131	char *__new = __builtin_alloca (__len + 1); \
	132	__new[__len] = '\0'; \
	133	memcpy (__new, __old, __len); \
	134	}))
02ac66c5 RM	135	#endif
02ac66c5 RM	136
28f540f4 RM	137	/* Find the first occurrence of C in S. */
	138	extern char strchr __P ((__const char __s, int __c));
	139	/* Find the last occurrence of C in S. */
	140	extern char strrchr __P ((__const char __s, int __c));
	141
	142	/* Return the length of the initial segment of S which
	143	consists entirely of characters not in REJECT. */
	144	extern size_t strcspn __P ((__const char __s, __const char __reject));
	145	/* Return the length of the initial segment of S which
	146	consists entirely of characters in ACCEPT. */
	147	extern size_t strspn __P ((__const char __s, __const char __accept));
6d52618b	148	/* Find the first occurrence in S of any character in ACCEPT. */
28f540f4	149	extern char strpbrk __P ((__const char __s, __const char *__accept));
6d52618b	150	/* Find the first occurrence of NEEDLE in HAYSTACK. */
28f540f4 RM	151	extern char strstr __P ((__const char __haystack, __const char *__needle));
	152	/* Divide S into tokens separated by characters in DELIM. */
	153	extern char strtok __P ((char __s, __const char *__delim));
	154
19361cb7	155	#if defined __USE_POSIX \|\| defined __USE_MISC
59dd8641 RM	156	/* Divide S into tokens separated by characters in DELIM. Information
	157	passed between calls are stored in SAVE_PTR. */
	158	extern char strtok_r __P ((char __s, __const char *__delim,
	159	char **__save_ptr));
9d187dd4	160	#endif
59dd8641	161
9d187dd4	162	#ifdef __USE_GNU
6d52618b	163	/* Find the first occurrence of NEEDLE in HAYSTACK.
28f540f4 RM	164	NEEDLE is NEEDLELEN bytes long;
	165	HAYSTACK is HAYSTACKLEN bytes long. */
	166	extern __ptr_t memmem __P ((__const __ptr_t __haystack, size_t __haystacklen,
	167	__const __ptr_t __needle, size_t __needlelen));
	168	#endif
	169
8d71c7b0	170
28f540f4 RM	171	/* Return the length of S. */
	172	extern size_t strlen __P ((__const char *__s));
	173
8d71c7b0 RM	174	#ifdef __USE_GNU
	175	/* Find the length of STRING, but scan at most MAXLEN characters.
	176	If no '\0' terminator is found in that many characters, return MAXLEN. */
	177	extern size_t strnlen __P ((__const char *__string, size_t __maxlen));
	178
	179	#ifdef __OPTIMIZE__
	180	extern __inline size_t
	181	strnlen (__const char *__string, size_t __maxlen)
	182	{
df4ef2ab	183	__const char __end = (__const char ) memchr (__string, '\0', __maxlen);
8d71c7b0 RM	184	return __end ? __end - __string : __maxlen;
	185	}
	186	#endif
	187	#endif
	188
	189
60478656	190	/* Return a string describing the meaning of the `errno' code in ERRNUM. */
28f540f4	191	extern char *strerror __P ((int __errnum));
19361cb7	192	#ifdef __USE_MISC
60478656 RM	193	/* Reentrant version of `strerror'. If a temporary buffer is required, at
60478656 RM	194	most BUFLEN bytes of BUF will be used. */
47707456	195	extern char __strerror_r __P ((int __errnum, char __buf, size_t __buflen));
9f447fb3	196	extern char strerror_r __P ((int __errnum, char __buf, size_t __buflen));
60478656	197	#endif
28f540f4	198
2c6fe0bd	199	#if defined(__USE_BSD) \|\| defined(__USE_XOPEN_EXTENDED)
28f540f4 RM	200	/* Copy N bytes of SRC to DEST (like memmove, but args reversed). */
	201	extern void bcopy __P ((__const __ptr_t __src, __ptr_t __dest, size_t __n));
	202
	203	/* Set N bytes of S to 0. */
	204	extern void bzero __P ((__ptr_t __s, size_t __n));
	205
	206	/* Compare N bytes of S1 and S2 (same as memcmp). */
	207	extern int bcmp __P ((__const __ptr_t __s1, __const __ptr_t __s2, size_t __n));
	208
2c6fe0bd UD	209	/* Find the first occurrence of C in S (same as strchr). */
	210	extern char index __P ((__const char __s, int __c));
	211
	212	/* Find the last occurrence of C in S (same as strrchr). */
	213	extern char rindex __P ((__const char __s, int __c));
	214
28f540f4 RM	215	/* Return the position of the first bit set in I, or 0 if none are set.
	216	The least-significant bit is position 1, the most-significant 32. */
	217	extern int ffs __P ((int __i));
	218
	219	/* Compare S1 and S2, ignoring case. */
3ec41e03	220	extern int __strcasecmp __P ((__const char __s1, __const char __s2));
28f540f4 RM	221	extern int strcasecmp __P ((__const char __s1, __const char __s2));
28f540f4 RM	222
6e86a7c2	223	/* Compare no more than N chars of S1 and S2, ignoring case. */
bba7bb78 RM	224	extern int __strncasecmp __P ((__const char __s1, __const char __s2,
bba7bb78 RM	225	size_t __n));
6e86a7c2 RM	226	extern int strncasecmp __P ((__const char __s1, __const char __s2,
6e86a7c2 RM	227	size_t __n));
2c6fe0bd	228	#endif /* Use BSD or X/Open Unix. */
6e86a7c2	229
2c6fe0bd	230	#ifdef __USE_BSD
28f540f4 RM	231	/* Return the next DELIM-delimited token from *STRINGP,
28f540f4 RM	232	terminating it with a '\0', and update STRINGP to point past it. /
d68171ed	233	extern char __strsep __P ((char __stringp, __const char __delim));
28f540f4 RM	234	extern char strsep __P ((char __stringp, __const char __delim));
	235	#endif
	236
28f540f4	237	#ifdef __USE_GNU
28f540f4 RM	238	/* Return a string describing the meaning of the signal number in SIG. */
	239	extern char *strsignal __P ((int __sig));
	240
	241	/* Copy SRC to DEST, returning the address of the terminating '\0' in DEST. */
3ec41e03	242	extern char __stpcpy __P ((char __dest, __const char *__src));
28f540f4 RM	243	extern char stpcpy __P ((char __dest, __const char *__src));
	244
	245	/* Copy no more than N characters of SRC to DEST, returning the address of
	246	the last character written into DEST. */
3ec41e03	247	extern char __stpncpy __P ((char __dest, __const char *__src, size_t __n));
28f540f4 RM	248	extern char stpncpy __P ((char __dest, __const char *__src, size_t __n));
28f540f4 RM	249
28f540f4 RM	250	/* Sautee STRING briskly. */
	251	extern char strfry __P ((char __string));
	252
	253	/* Frobnicate N bytes of S. */
	254	extern __ptr_t memfrob __P ((__ptr_t __s, size_t __n));
	255	#endif
	256
84724245 RM	257	#ifdef __USE_MISC
84724245 RM	258	/* Return the file name within directory of FILENAME. */
036cc82f	259	extern char basename __P ((__const char __filename));
84724245 RM	260	#endif
84724245 RM	261
28f540f4 RM	262	__END_DECLS
	263
	264	#endif /* string.h */