include/string.h

   1 /*
   2  * Copyright (c) 2000, 2007, 2010 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   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.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  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.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*-
  24  * Copyright (c) 1990, 1993
  25  *      The Regents of the University of California.  All rights reserved.
  26  *
  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.
  54  *
  55  *      @(#)string.h    8.1 (Berkeley) 6/2/93
  56  */
  57
  58 #ifndef _STRING_H_
  59 #define _STRING_H_
  60
  61 #include <_types.h>
  62
  63 #include <sys/cdefs.h>
  64 #include <Availability.h>
  65
  66 #ifndef _SIZE_T
  67 #define _SIZE_T
  68 typedef __darwin_size_t         size_t;
  69 #endif
  70
  71 #ifndef NULL
  72 #define NULL __DARWIN_NULL
  73 #endif /* ! NULL */
  74
  75
  76
  77 /* ANSI-C */
  78
  79 __BEGIN_DECLS
  80 void    *memchr(const void *, int, size_t);
  81 int      memcmp(const void *, const void *, size_t);
  82 void    *memcpy(void *, const void *, size_t);
  83 void    *memmove(void *, const void *, size_t);
  84 void    *memset(void *, int, size_t);
  85 char    *strcat(char *, const char *);
  86 char    *strchr(const char *, int);
  87 int      strcmp(const char *, const char *);
  88 int      strcoll(const char *, const char *);
  89 char    *strcpy(char *, const char *);
  90 size_t   strcspn(const char *, const char *);
  91 //Begin-Libc
  92 #ifndef LIBC_ALIAS_STRERROR
  93 //End-Libc
  94 char    *strerror(int) __DARWIN_ALIAS(strerror);
  95 //Begin-Libc
  96 #else /* LIBC_ALIAS_STRERROR */
  97 char    *strerror(int) LIBC_ALIAS(strerror);
  98 #endif /* !LIBC_ALIAS_STRERROR */
  99 //End-Libc
 100 size_t   strlen(const char *);
 101 char    *strncat(char *, const char *, size_t);
 102 int      strncmp(const char *, const char *, size_t);
 103 char    *strncpy(char *, const char *, size_t);
 104 char    *strpbrk(const char *, const char *);
 105 char    *strrchr(const char *, int);
 106 size_t   strspn(const char *, const char *);
 107 char    *strstr(const char *, const char *);
 108 char    *strtok(char *, const char *);
 109 size_t   strxfrm(char *, const char *, size_t);
 110 __END_DECLS
 111
 112
 113
 114 /* Additional functionality provided by:
 115  * POSIX.1c-1995,
 116  * POSIX.1i-1995,
 117  * and the omnibus ISO/IEC 9945-1: 1996
 118  */
 119
 120 #if __DARWIN_C_LEVEL >= 199506L
 121 __BEGIN_DECLS
 122 char    *strtok_r(char *, const char *, char **);
 123 __END_DECLS
 124 #endif /* __DARWIN_C_LEVEL >= 199506L */
 125
 126
 127
 128 /* Additional functionality provided by:
 129  * POSIX.1-2001
 130  */
 131
 132 #if __DARWIN_C_LEVEL >= 200112L
 133 __BEGIN_DECLS
 134 int      strerror_r(int, char *, size_t);
 135 char    *strdup(const char *);
 136 void    *memccpy(void *, const void *, int, size_t);
 137 __END_DECLS
 138 #endif /* __DARWIN_C_LEVEL >= 200112L */
 139
 140
 141
 142 /* Additional functionality provided by:
 143  * POSIX.1-2008
 144  */
 145
 146 #if __DARWIN_C_LEVEL >= 200809L
 147 __BEGIN_DECLS
 148 char    *stpcpy(char *, const char *);
 149 char    *stpncpy(char *, const char *, size_t) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
 150 char    *strndup(const char *, size_t) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
 151 size_t   strnlen(const char *, size_t) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
 152 char    *strsignal(int sig);
 153 __END_DECLS
 154 #endif /* __DARWIN_C_LEVEL >= 200809L */
 155
 156
 157
 158 /* Darwin extensions */
 159
 160 #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
 161 #ifndef _SSIZE_T
 162 #define _SSIZE_T
 163 typedef __darwin_ssize_t        ssize_t;
 164 #endif
 165
 166 __BEGIN_DECLS
 167 void    *memmem(const void *, size_t, const void *, size_t) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
 168 void     memset_pattern4(void *, const void *, size_t) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_3_0);
 169 void     memset_pattern8(void *, const void *, size_t) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_3_0);
 170 void     memset_pattern16(void *, const void *, size_t) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_3_0);
 171
 172 char    *strcasestr(const char *, const char *);
 173 char    *strnstr(const char *, const char *, size_t);
 174 size_t   strlcat(char *, const char *, size_t);
 175 size_t   strlcpy(char *, const char *, size_t);
 176 void     strmode(int, char *);
 177 char    *strsep(char **, const char *);
 178
 179 /* SUS places swab() in unistd.h.  It is listed here for source compatibility */
 180 void     swab(const void * __restrict, void * __restrict, ssize_t);
 181 __END_DECLS
 182
 183 /* Some functions historically defined in string.h were placed in strings.h
 184  * by SUS.  We are using "strings.h" instead of <strings.h> to avoid an issue
 185  * where /Developer/Headers/FlatCarbon/Strings.h could be included instead on
 186  * case-insensitive file systems.
 187  */
 188 #include "strings.h"
 189 #endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
 190
 191
 192 #ifdef _USE_EXTENDED_LOCALES_
 193 #include <xlocale/_string.h>
 194 #endif /* _USE_EXTENDED_LOCALES_ */
 195
 196 #if defined (__GNUC__) && _FORTIFY_SOURCE > 0 && !defined (__cplusplus)
 197 /* Security checking functions.  */
 198 #include <secure/_string.h>
 199 #endif
 200
 201 #endif /* _STRING_H_ */