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

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

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

/* 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
/* 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
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
b0d20a87	16	not, write to the Free Software Foundation, Inc., 675 Mass Ave,
28f540f4 RM	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));
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
	86	#if defined (__USE_SVID) \|\| defined (__USE_BSD)
	87	/* Duplicate S, returning an identical malloc'd string. */
6dbe2837	88	extern char __strdup __P ((__const char __s));
28f540f4 RM	89	extern char strdup __P ((__const char __s));
	90	#endif
	91
6dbe2837 RM	92	/* Return a malloc'd copy of at most N bytes of STRING. The
	93	resultant string is terminated even if no null terminator
	94	appears before STRING[N]. */
	95	extern char strndup __P ((__const char __string, size_t __n));
	96
036cc82f RM	97	#if defined (__USE_GNU) && defined (__GNUC__)
	98	/* Duplicate S, returning an identical alloca'd string. */
	99	#define strdupa(s) \
	100	(__extension__ \
	101	({ \
	102	__const char *__old = (s); \
	103	size_t __len = strlen (__old) + 1; \
	104	char *__new = __builtin_alloca (__len); \
	105	memcpy (__new, __old, __len); \
	106	}))
	107
6dbe2837 RM	108	/* Return an alloca'd copy of at most N bytes of string. */
6dbe2837 RM	109	#define strndupa(s, n) \
036cc82f RM	110	(__extension__ \
	111	({ \
	112	__const char *__old = (s); \
	113	size_t __len = strnlen (__old, (n)); \
	114	char *__new = __builtin_alloca (__len + 1); \
	115	__new[__len] = '\0'; \
	116	memcpy (__new, __old, __len); \
	117	}))
02ac66c5 RM	118	#endif
02ac66c5 RM	119
28f540f4 RM	120	/* Find the first occurrence of C in S. */
	121	extern char strchr __P ((__const char __s, int __c));
	122	/* Find the last occurrence of C in S. */
	123	extern char strrchr __P ((__const char __s, int __c));
	124
	125	/* Return the length of the initial segment of S which
	126	consists entirely of characters not in REJECT. */
	127	extern size_t strcspn __P ((__const char __s, __const char __reject));
	128	/* Return the length of the initial segment of S which
	129	consists entirely of characters in ACCEPT. */
	130	extern size_t strspn __P ((__const char __s, __const char __accept));
	131	/* Find the first occurence in S of any character in ACCEPT. */
	132	extern char strpbrk __P ((__const char __s, __const char *__accept));
	133	/* Find the first occurence of NEEDLE in HAYSTACK. */
	134	extern char strstr __P ((__const char __haystack, __const char *__needle));
	135	/* Divide S into tokens separated by characters in DELIM. */
	136	extern char strtok __P ((char __s, __const char *__delim));
	137
	138	#ifdef __USE_GNU
59dd8641 RM	139	/* Divide S into tokens separated by characters in DELIM. Information
	140	passed between calls are stored in SAVE_PTR. */
	141	extern char strtok_r __P ((char __s, __const char *__delim,
	142	char **__save_ptr));
	143
28f540f4 RM	144	/* Find the first occurence of NEEDLE in HAYSTACK.
	145	NEEDLE is NEEDLELEN bytes long;
	146	HAYSTACK is HAYSTACKLEN bytes long. */
	147	extern __ptr_t memmem __P ((__const __ptr_t __haystack, size_t __haystacklen,
	148	__const __ptr_t __needle, size_t __needlelen));
	149	#endif
	150
8d71c7b0	151
28f540f4 RM	152	/* Return the length of S. */
	153	extern size_t strlen __P ((__const char *__s));
	154
8d71c7b0 RM	155	#ifdef __USE_GNU
	156	/* Find the length of STRING, but scan at most MAXLEN characters.
	157	If no '\0' terminator is found in that many characters, return MAXLEN. */
	158	extern size_t strnlen __P ((__const char *__string, size_t __maxlen));
	159
	160	#ifdef __OPTIMIZE__
	161	extern __inline size_t
	162	strnlen (__const char *__string, size_t __maxlen)
	163	{
	164	__const char *__end = memchr (__string, '\0', __maxlen);
	165	return __end ? __end - __string : __maxlen;
	166	}
	167	#endif
	168	#endif
	169
	170
60478656	171	/* Return a string describing the meaning of the `errno' code in ERRNUM. */
28f540f4	172	extern char *strerror __P ((int __errnum));
60478656 RM	173	#ifdef __USE_REENTRANT
	174	/* Reentrant version of `strerror'. If a temporary buffer is required, at
	175	most BUFLEN bytes of BUF will be used. */
9f447fb3	176	extern char strerror_r __P ((int __errnum, char __buf, size_t __buflen));
60478656	177	#endif
28f540f4 RM	178
	179	#ifdef __USE_BSD
	180	/* Find the first occurrence of C in S (same as strchr). */
	181	extern char index __P ((__const char __s, int __c));
	182
	183	/* Find the last occurrence of C in S (same as strrchr). */
	184	extern char rindex __P ((__const char __s, int __c));
	185
	186	/* Copy N bytes of SRC to DEST (like memmove, but args reversed). */
	187	extern void bcopy __P ((__const __ptr_t __src, __ptr_t __dest, size_t __n));
	188
	189	/* Set N bytes of S to 0. */
	190	extern void bzero __P ((__ptr_t __s, size_t __n));
	191
	192	/* Compare N bytes of S1 and S2 (same as memcmp). */
	193	extern int bcmp __P ((__const __ptr_t __s1, __const __ptr_t __s2, size_t __n));
	194
	195	/* Return the position of the first bit set in I, or 0 if none are set.
	196	The least-significant bit is position 1, the most-significant 32. */
	197	extern int ffs __P ((int __i));
	198
	199	/* Compare S1 and S2, ignoring case. */
3ec41e03	200	extern int __strcasecmp __P ((__const char __s1, __const char __s2));
28f540f4 RM	201	extern int strcasecmp __P ((__const char __s1, __const char __s2));
28f540f4 RM	202
6e86a7c2	203	/* Compare no more than N chars of S1 and S2, ignoring case. */
bba7bb78 RM	204	extern int __strncasecmp __P ((__const char __s1, __const char __s2,
bba7bb78 RM	205	size_t __n));
6e86a7c2 RM	206	extern int strncasecmp __P ((__const char __s1, __const char __s2,
	207	size_t __n));
	208
28f540f4 RM	209	/* Return the next DELIM-delimited token from *STRINGP,
	210	terminating it with a '\0', and update STRINGP to point past it. /
	211	extern char strsep __P ((char __stringp, __const char __delim));
	212	#endif
	213
28f540f4	214	#ifdef __USE_GNU
28f540f4 RM	215	/* Return a string describing the meaning of the signal number in SIG. */
	216	extern char *strsignal __P ((int __sig));
	217
	218	/* Copy SRC to DEST, returning the address of the terminating '\0' in DEST. */
3ec41e03	219	extern char __stpcpy __P ((char __dest, __const char *__src));
28f540f4 RM	220	extern char stpcpy __P ((char __dest, __const char *__src));
	221
	222	/* Copy no more than N characters of SRC to DEST, returning the address of
	223	the last character written into DEST. */
3ec41e03	224	extern char __stpncpy __P ((char __dest, __const char *__src, size_t __n));
28f540f4 RM	225	extern char stpncpy __P ((char __dest, __const char *__src, size_t __n));
28f540f4 RM	226
28f540f4 RM	227	/* Sautee STRING briskly. */
	228	extern char strfry __P ((char __string));
	229
	230	/* Frobnicate N bytes of S. */
	231	extern __ptr_t memfrob __P ((__ptr_t __s, size_t __n));
	232	#endif
	233
84724245 RM	234	#ifdef __USE_MISC
84724245 RM	235	/* Return the file name within directory of FILENAME. */
036cc82f	236	extern char basename __P ((__const char __filename));
84724245 RM	237	#endif
84724245 RM	238
28f540f4 RM	239	__END_DECLS
	240
	241	#endif /* string.h */