[apple/libc.git] / include / string.h

/*
 * Copyright (c) 2000, 2007, 2010 Apple Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_LICENSE_HEADER_END@
 */
/*-
 * Copyright (c) 1990, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)string.h	8.1 (Berkeley) 6/2/93
 */

#ifndef _STRING_H_
#define	_STRING_H_

#include <_types.h>
#include <sys/cdefs.h>
#include <Availability.h>
#include <sys/_types/_size_t.h>
#include <sys/_types/_null.h>

/* ANSI-C */

__BEGIN_DECLS
void	*memchr(const void *, int, size_t);
int	 memcmp(const void *, const void *, size_t);
void	*memcpy(void *, const void *, size_t);
void	*memmove(void *, const void *, size_t);
void	*memset(void *, int, size_t);
char	*strcat(char *, const char *);
char	*strchr(const char *, int);
int	 strcmp(const char *, const char *);
int	 strcoll(const char *, const char *);
char	*strcpy(char *, const char *);
size_t	 strcspn(const char *, const char *);
//Begin-Libc
#ifndef LIBC_ALIAS_STRERROR
//End-Libc
char	*strerror(int) __DARWIN_ALIAS(strerror);
//Begin-Libc
#else /* LIBC_ALIAS_STRERROR */
char	*strerror(int) LIBC_ALIAS(strerror);
#endif /* !LIBC_ALIAS_STRERROR */
//End-Libc
size_t	 strlen(const char *);
char	*strncat(char *, const char *, size_t);
int	 strncmp(const char *, const char *, size_t);
char	*strncpy(char *, const char *, size_t);
char	*strpbrk(const char *, const char *);
char	*strrchr(const char *, int);
size_t	 strspn(const char *, const char *);
char	*strstr(const char *, const char *);
char	*strtok(char *, const char *);
size_t	 strxfrm(char *, const char *, size_t);
__END_DECLS


/* Additional functionality provided by:
 * POSIX.1c-1995,
 * POSIX.1i-1995,
 * and the omnibus ISO/IEC 9945-1: 1996
 */

#if __DARWIN_C_LEVEL >= 199506L
__BEGIN_DECLS
char	*strtok_r(char *, const char *, char **);
__END_DECLS
#endif /* __DARWIN_C_LEVEL >= 199506L */


/* Additional functionality provided by:
 * POSIX.1-2001
 */

#if __DARWIN_C_LEVEL >= 200112L
__BEGIN_DECLS
int	 strerror_r(int, char *, size_t);
char	*strdup(const char *);
void	*memccpy(void *, const void *, int, size_t);
__END_DECLS
#endif /* __DARWIN_C_LEVEL >= 200112L */


/* Additional functionality provided by:
 * POSIX.1-2008
 */

#if __DARWIN_C_LEVEL >= 200809L
__BEGIN_DECLS
char	*stpcpy(char *, const char *);
char    *stpncpy(char *, const char *, size_t) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
char	*strndup(const char *, size_t) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
size_t   strnlen(const char *, size_t) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
char	*strsignal(int sig);
__END_DECLS
#endif /* __DARWIN_C_LEVEL >= 200809L */

/* C11 Annex K */

#if defined(__STDC_WANT_LIB_EXT1__) && __STDC_WANT_LIB_EXT1__ >= 1
#include <sys/_types/_rsize_t.h>
#include <sys/_types/_errno_t.h>

__BEGIN_DECLS
errno_t	memset_s(void *, rsize_t, int, rsize_t) __OSX_AVAILABLE_STARTING(__MAC_10_9, __IPHONE_7_0);
__END_DECLS
#endif

/* Darwin extensions */

#if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
#include <sys/_types/_ssize_t.h>

__BEGIN_DECLS
void	*memmem(const void *, size_t, const void *, size_t) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
void     memset_pattern4(void *, const void *, size_t) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_3_0);
void     memset_pattern8(void *, const void *, size_t) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_3_0);
void     memset_pattern16(void *, const void *, size_t) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_3_0);

char	*strcasestr(const char *, const char *);
char	*strnstr(const char *, const char *, size_t);
size_t	 strlcat(char *, const char *, size_t);
size_t	 strlcpy(char *, const char *, size_t);
void	 strmode(int, char *);
char	*strsep(char **, const char *);

/* SUS places swab() in unistd.h.  It is listed here for source compatibility */
void	 swab(const void * __restrict, void * __restrict, ssize_t);
__END_DECLS

/* Some functions historically defined in string.h were placed in strings.h
 * by SUS.  We are using "strings.h" instead of <strings.h> to avoid an issue
 * where /Developer/Headers/FlatCarbon/Strings.h could be included instead on
 * case-insensitive file systems.
 */
#include "strings.h"
#endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */


#ifdef _USE_EXTENDED_LOCALES_
#include <xlocale/_string.h>
#endif /* _USE_EXTENDED_LOCALES_ */

#if defined (__GNUC__) && _FORTIFY_SOURCE > 0 && !defined (__cplusplus)
/* Security checking functions.  */
#include <secure/_string.h>
#endif

#endif /* _STRING_H_ */
Commit	Line	Data
e9ce8d39	1	/*
1f2f436a	2	* Copyright (c) 2000, 2007, 2010 Apple Inc. All rights reserved.
e9ce8d39 A	3	*
e9ce8d39 A	4	* @APPLE_LICENSE_HEADER_START@
224c7076	5	*
734aad71 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. Please obtain a copy of the License at
	10	* http://www.opensource.apple.com/apsl/ and read it before using this
	11	* file.
224c7076	12	*
734aad71 A	13	* The Original Code and all software distributed under the License are
734aad71 A	14	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
e9ce8d39 A	15	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
e9ce8d39 A	16	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
734aad71 A	17	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	18	* Please see the License for the specific language governing rights and
	19	* limitations under the License.
224c7076	20	*
e9ce8d39 A	21	* @APPLE_LICENSE_HEADER_END@
e9ce8d39 A	22	*/
5b2abdfb	23	/*-
e9ce8d39 A	24	* Copyright (c) 1990, 1993
	25	* The Regents of the University of California. All rights reserved.
	26	*
e9ce8d39 A	27	* Redistribution and use in source and binary forms, with or without
	28	* modification, are permitted provided that the following conditions
	29	* are met:
	30	* 1. Redistributions of source code must retain the above copyright
	31	* notice, this list of conditions and the following disclaimer.
	32	* 2. Redistributions in binary form must reproduce the above copyright
	33	* notice, this list of conditions and the following disclaimer in the
	34	* documentation and/or other materials provided with the distribution.
	35	* 3. All advertising materials mentioning features or use of this software
	36	* must display the following acknowledgement:
	37	* This product includes software developed by the University of
	38	* California, Berkeley and its contributors.
	39	* 4. Neither the name of the University nor the names of its contributors
	40	* may be used to endorse or promote products derived from this software
	41	* without specific prior written permission.
	42	*
	43	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	44	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	45	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	46	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	47	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	48	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	49	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	50	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	51	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	52	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	53	* SUCH DAMAGE.
5b2abdfb A	54	*
5b2abdfb A	55	* @(#)string.h 8.1 (Berkeley) 6/2/93
e9ce8d39 A	56	*/
e9ce8d39 A	57
5b2abdfb A	58	#ifndef _STRING_H_
5b2abdfb A	59	#define _STRING_H_
1f2f436a	60
3d9156a7	61	#include <_types.h>
1f2f436a A	62	#include <sys/cdefs.h>
1f2f436a A	63	#include <Availability.h>
6465356a A	64	#include <sys/_types/_size_t.h>
6465356a A	65	#include <sys/_types/_null.h>
1f2f436a A	66
1f2f436a A	67	/* ANSI-C */
e9ce8d39	68
5b2abdfb	69	__BEGIN_DECLS
9385eb3d A	70	void memchr(const void , int, size_t);
	71	int memcmp(const void , const void , size_t);
	72	void memcpy(void , const void *, size_t);
	73	void memmove(void , const void *, size_t);
	74	void memset(void , int, size_t);
9385eb3d A	75	char strcat(char , const char *);
	76	char strchr(const char , int);
	77	int strcmp(const char , const char );
	78	int strcoll(const char , const char );
	79	char strcpy(char , const char *);
	80	size_t strcspn(const char , const char );
224c7076 A	81	//Begin-Libc
	82	#ifndef LIBC_ALIAS_STRERROR
	83	//End-Libc
	84	char *strerror(int) __DARWIN_ALIAS(strerror);
	85	//Begin-Libc
	86	#else /* LIBC_ALIAS_STRERROR */
	87	char *strerror(int) LIBC_ALIAS(strerror);
	88	#endif /* !LIBC_ALIAS_STRERROR */
	89	//End-Libc
9385eb3d A	90	size_t strlen(const char *);
	91	char strncat(char , const char *, size_t);
	92	int strncmp(const char , const char , size_t);
	93	char strncpy(char , const char *, size_t);
9385eb3d A	94	char strpbrk(const char , const char *);
	95	char strrchr(const char , int);
	96	size_t strspn(const char , const char );
	97	char strstr(const char , const char *);
	98	char strtok(char , const char *);
	99	size_t strxfrm(char , const char , size_t);
1f2f436a	100	__END_DECLS
e9ce8d39	101
1f2f436a A	102
	103
	104	/* Additional functionality provided by:
	105	* POSIX.1c-1995,
	106	* POSIX.1i-1995,
	107	* and the omnibus ISO/IEC 9945-1: 1996
	108	*/
	109
	110	#if __DARWIN_C_LEVEL >= 199506L
	111	__BEGIN_DECLS
59e0d9fe	112	char strtok_r(char , const char , char *);
1f2f436a A	113	__END_DECLS
	114	#endif /* __DARWIN_C_LEVEL >= 199506L */
	115
	116
	117
	118	/* Additional functionality provided by:
	119	* POSIX.1-2001
	120	*/
	121
	122	#if __DARWIN_C_LEVEL >= 200112L
	123	__BEGIN_DECLS
	124	int strerror_r(int, char *, size_t);
59e0d9fe	125	char strdup(const char );
1f2f436a A	126	void memccpy(void , const void *, int, size_t);
	127	__END_DECLS
	128	#endif /* __DARWIN_C_LEVEL >= 200112L */
	129
	130
	131
	132	/* Additional functionality provided by:
	133	* POSIX.1-2008
	134	*/
	135
	136	#if __DARWIN_C_LEVEL >= 200809L
	137	__BEGIN_DECLS
	138	char stpcpy(char , const char *);
	139	char stpncpy(char , const char *, size_t) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
	140	char strndup(const char , size_t) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
	141	size_t strnlen(const char *, size_t) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
	142	char *strsignal(int sig);
	143	__END_DECLS
	144	#endif /* __DARWIN_C_LEVEL >= 200809L */
	145
6465356a	146	/* C11 Annex K */
1f2f436a	147
6465356a A	148	#if defined(__STDC_WANT_LIB_EXT1__) && __STDC_WANT_LIB_EXT1__ >= 1
	149	#include <sys/_types/_rsize_t.h>
	150	#include <sys/_types/_errno_t.h>
	151
	152	__BEGIN_DECLS
	153	errno_t memset_s(void *, rsize_t, int, rsize_t) __OSX_AVAILABLE_STARTING(__MAC_10_9, __IPHONE_7_0);
	154	__END_DECLS
	155	#endif
1f2f436a A	156
	157	/* Darwin extensions */
	158
	159	#if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
6465356a	160	#include <sys/_types/_ssize_t.h>
1f2f436a A	161
	162	__BEGIN_DECLS
	163	void memmem(const void , size_t, const void *, size_t) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
	164	void memset_pattern4(void , const void , size_t) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_3_0);
	165	void memset_pattern8(void , const void , size_t) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_3_0);
	166	void memset_pattern16(void , const void , size_t) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_3_0);
	167
	168	char strcasestr(const char , const char *);
	169	char strnstr(const char , const char *, size_t);
9385eb3d A	170	size_t strlcat(char , const char , size_t);
	171	size_t strlcpy(char , const char , size_t);
	172	void strmode(int, char *);
9385eb3d	173	char strsep(char , const char );
1f2f436a A	174
1f2f436a A	175	/* SUS places swab() in unistd.h. It is listed here for source compatibility */
3d9156a7	176	void swab(const void * __restrict, void * __restrict, ssize_t);
5b2abdfb	177	__END_DECLS
e9ce8d39	178
1f2f436a A	179	/* Some functions historically defined in string.h were placed in strings.h
	180	* by SUS. We are using "strings.h" instead of <strings.h> to avoid an issue
	181	* where /Developer/Headers/FlatCarbon/Strings.h could be included instead on
	182	* case-insensitive file systems.
	183	*/
	184	#include "strings.h"
	185	#endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
	186
	187
3d9156a7 A	188	#ifdef _USE_EXTENDED_LOCALES_
	189	#include <xlocale/_string.h>
	190	#endif /* _USE_EXTENDED_LOCALES_ */
	191
224c7076 A	192	#if defined (__GNUC__) && _FORTIFY_SOURCE > 0 && !defined (__cplusplus)
	193	/* Security checking functions. */
	194	#include <secure/_string.h>
	195	#endif
	196
5b2abdfb	197	#endif /* _STRING_H_ */