d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
3d8fce2701
freebsd-dev/include/string.h

145 lines
4.9 KiB
C
Raw Normal View History

BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
/*-
* 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.
Remove the Berkeley clause 3's. Add a few $FreeBSD$
2010-02-16 19:39:50 +00:00
* 3. Neither the name of the University nor the names of its contributors
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
* 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.
*
Fixed some style bugs: - rev.1.6: corrupt tab before strlcpy. - rev.1.7: "From: " in vendor id. - rev.1.8: unsorted prototype for strccasestr.
2001-10-10 07:34:47 +00:00
* @(#)string.h 8.1 (Berkeley) 6/2/93
Add a new libc function, strnstr(3), which allows one to limit the number of characters that are searched. This is especially useful with file operations and non-NUL terminated strings. Silence from: -audit, -hackers MFC after: 5 days
2001-10-09 01:29:56 +00:00
* $FreeBSD$
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
*/
#ifndef _STRING_H_
#define _STRING_H_
o Move some function prototypes from <string.h> to the newly rewritten <strings.h>, based on POSIX.1-2001's requirements. o Add 'restrict' qualifier (spelled '__restrict') to functions in <string.h>, as per C99 and POSIX.1-2001. o Properly expose new POSIX.1-2001 functions in <string.h>.
2002-04-04 05:41:57 +00:00
#include <sys/cdefs.h>
Change the definition of NULL on ia64 (for LP64 compilations) from an int constant to a long constant. This change improves consistency in the following two ways: 1. The first 8 arguments are always passed in registers on ia64, which by virtue of the generated code implicitly widens ints to longs and allows the use of an 32-bit integral type for 64-bit arguments. Subsequent arguments are passed onto the memory stack, which does not exhibit the same behaviour and consequently do not allow this. In practice this means that variadic functions taking pointers and given NULL (without cast) work as long as the NULL is passed in one of the first 8 arguments. A SIGSEGV is more likely the result if such would be done for stack-based arguments. This is due to the fact that the upper 4 bytes remain undefined. 2. All 64-bit platforms that FreeBSD supports, with the obvious exception of ia64, allow 32-bit integral types (specifically NULL) when 64-bit pointers are expected in variadic functions by way of how the compiler generates code. As such, code that works correctly (whether rightfully so or not) on any platform other than ia64, may fail on ia64. To more easily allow tweaking of the definition of NULL, this commit removes the 12 definitions in the various headers and puts it in a new header that can be included whenever NULL is to be made visible. This commit fixes GNOME, emacs, xemacs and a whole bunch of ports that I don't particularly care about at this time...
2003-12-07 21:10:06 +00:00
#include <sys/_null.h>
o Merge <machine/ansi.h> and <machine/types.h> into a new header called <machine/_types.h>. o <machine/ansi.h> will continue to live so it can define MD clock macros, which are only MD because of gratuitous differences between architectures. o Change all headers to make use of this. This mainly involves changing: #ifdef _BSD_FOO_T_ typedef _BSD_FOO_T_ foo_t; #undef _BSD_FOO_T_ #endif to: #ifndef _FOO_T_DECLARED typedef __foo_t foo_t; #define _FOO_T_DECLARED #endif Concept by: bde Reviewed by: jake, obrien
2002-08-21 16:20:02 +00:00
#include <sys/_types.h>
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
o Move some function prototypes from <string.h> to the newly rewritten <strings.h>, based on POSIX.1-2001's requirements. o Add 'restrict' qualifier (spelled '__restrict') to functions in <string.h>, as per C99 and POSIX.1-2001. o Properly expose new POSIX.1-2001 functions in <string.h>.
2002-04-04 05:41:57 +00:00
/*
* Prototype functions which were historically defined in <string.h>, but
* are required by POSIX to be prototyped in <strings.h>.
*/
#if __BSD_VISIBLE
#include <strings.h>
#endif
o Merge <machine/ansi.h> and <machine/types.h> into a new header called <machine/_types.h>. o <machine/ansi.h> will continue to live so it can define MD clock macros, which are only MD because of gratuitous differences between architectures. o Change all headers to make use of this. This mainly involves changing: #ifdef _BSD_FOO_T_ typedef _BSD_FOO_T_ foo_t; #undef _BSD_FOO_T_ #endif to: #ifndef _FOO_T_DECLARED typedef __foo_t foo_t; #define _FOO_T_DECLARED #endif Concept by: bde Reviewed by: jake, obrien
2002-08-21 16:20:02 +00:00
#ifndef _SIZE_T_DECLARED
typedef __size_t size_t;
#define _SIZE_T_DECLARED
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
#endif
__BEGIN_DECLS
Namespace: memccpy() and memchr() are XSI, and memrchr() is a BSD extension.
2009-03-14 19:03:34 +00:00
#if __XSI_VISIBLE >= 600
Correct visibility conditionals for memccpy(), strdup(), and strtok_r(). Merge conditional prototypes into the regular block.
2002-10-14 20:38:40 +00:00
void *memccpy(void * __restrict, const void * __restrict, int, size_t);
#endif
Mark functions pure where applicable. A notable exclusion is strcoll(), which is not strictly pure because it calls malloc()/free() in some cases.
2004-07-23 02:20:05 +00:00
void *memchr(const void *, int, size_t) __pure;
Namespace: memccpy() and memchr() are XSI, and memrchr() is a BSD extension.
2009-03-14 19:03:34 +00:00
#if __BSD_VISIBLE
Add memrchr(3). Obtained from: OpenBSD
2008-04-10 00:12:44 +00:00
void *memrchr(const void *, int, size_t) __pure;
Namespace: memccpy() and memchr() are XSI, and memrchr() is a BSD extension.
2009-03-14 19:03:34 +00:00
#endif
Mark functions pure where applicable. A notable exclusion is strcoll(), which is not strictly pure because it calls malloc()/free() in some cases.
2004-07-23 02:20:05 +00:00
int memcmp(const void *, const void *, size_t) __pure;
o Move some function prototypes from <string.h> to the newly rewritten <strings.h>, based on POSIX.1-2001's requirements. o Add 'restrict' qualifier (spelled '__restrict') to functions in <string.h>, as per C99 and POSIX.1-2001. o Properly expose new POSIX.1-2001 functions in <string.h>.
2002-04-04 05:41:57 +00:00
void *memcpy(void * __restrict, const void * __restrict, size_t);
Appropriate namespace protection for memmem(3). Submitted by: wollman MFC after: 3 days
2005-08-25 19:46:38 +00:00
#if __BSD_VISIBLE
Mark memmem() __pure.
2009-02-28 05:08:35 +00:00
void *memmem(const void *, size_t, const void *, size_t) __pure;
Appropriate namespace protection for memmem(3). Submitted by: wollman MFC after: 3 days
2005-08-25 19:46:38 +00:00
#endif
Breath deep and take __P out of the system include files. # This appears to not break X11, but I'm having problems compiling the # glide part of the server with or without this patch, so I can't tell # for sure.
2002-03-23 17:24:55 +00:00
void *memmove(void *, const void *, size_t);
void *memset(void *, int, size_t);
include: Remove checks for __BSD_VISIBLE where redundant with __XSI_VISIBLE or __POSIX_VISIBLE. Whenever <sys/cdefs.h> sets __BSD_VISIBLE to non-zero, it also sets __POSIX_VISIBLE and __XSI_VISIBLE to the newest version supported. No functional change is intended.
2014-05-11 13:48:21 +00:00
#if __POSIX_VISIBLE >= 200809
- Add getdelim(), getline(), stpncpy(), strnlen(), wcsnlen(), wcscasecmp(), and wcsncasecmp(). - Make some previously non-standard extensions visible if POSIX_VISIBLE >= 200809. - Use restrict qualifiers in stpcpy(). - Declare off_t and size_t in stdio.h. - Bump __FreeBSD_version in case the new symbols (particularly getline()) cause issues with ports. Reviewed by: standards@
2009-02-28 06:00:58 +00:00
char *stpcpy(char * __restrict, const char * __restrict);
char *stpncpy(char * __restrict, const char * __restrict, size_t);
#endif
Correct visibility conditionals for memccpy(), strdup(), and strtok_r(). Merge conditional prototypes into the regular block.
2002-10-14 20:38:40 +00:00
#if __BSD_VISIBLE
Mark functions pure where applicable. A notable exclusion is strcoll(), which is not strictly pure because it calls malloc()/free() in some cases.
2004-07-23 02:20:05 +00:00
char *strcasestr(const char *, const char *) __pure;
Correct visibility conditionals for memccpy(), strdup(), and strtok_r(). Merge conditional prototypes into the regular block.
2002-10-14 20:38:40 +00:00
#endif
o Move some function prototypes from <string.h> to the newly rewritten <strings.h>, based on POSIX.1-2001's requirements. o Add 'restrict' qualifier (spelled '__restrict') to functions in <string.h>, as per C99 and POSIX.1-2001. o Properly expose new POSIX.1-2001 functions in <string.h>.
2002-04-04 05:41:57 +00:00
char *strcat(char * __restrict, const char * __restrict);
Mark functions pure where applicable. A notable exclusion is strcoll(), which is not strictly pure because it calls malloc()/free() in some cases.
2004-07-23 02:20:05 +00:00
char *strchr(const char *, int) __pure;
FreeBSD uses #if __BSD_VISIBLE to hide non-standard functions, fix this. Noticed by: kib Approved by: kib
2013-02-14 19:26:58 +00:00
#if __BSD_VISIBLE
Add strchrnul(), a GNU function similar to strchr(), except that it returns a pointer to the end of the string, rather than NULL, if the character was not found. Approved by: theraven
2013-02-13 15:46:33 +00:00
char *strchrnul(const char*, int) __pure;
#endif
Mark functions pure where applicable. A notable exclusion is strcoll(), which is not strictly pure because it calls malloc()/free() in some cases.
2004-07-23 02:20:05 +00:00
int strcmp(const char *, const char *) __pure;
Breath deep and take __P out of the system include files. # This appears to not break X11, but I'm having problems compiling the # glide part of the server with or without this patch, so I can't tell # for sure.
2002-03-23 17:24:55 +00:00
int strcoll(const char *, const char *);
o Move some function prototypes from <string.h> to the newly rewritten <strings.h>, based on POSIX.1-2001's requirements. o Add 'restrict' qualifier (spelled '__restrict') to functions in <string.h>, as per C99 and POSIX.1-2001. o Properly expose new POSIX.1-2001 functions in <string.h>.
2002-04-04 05:41:57 +00:00
char *strcpy(char * __restrict, const char * __restrict);
Mark functions pure where applicable. A notable exclusion is strcoll(), which is not strictly pure because it calls malloc()/free() in some cases.
2004-07-23 02:20:05 +00:00
size_t strcspn(const char *, const char *) __pure;
Correct visibility conditionals for memccpy(), strdup(), and strtok_r(). Merge conditional prototypes into the regular block.
2002-10-14 20:38:40 +00:00
#if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
Add a function attribute called `__malloc_like', which informs gcc that the annotated function returns a pointer that doesn't alias any extant pointer. This results in a 50%+ speedup in microbenchmarks such as the following: char *cp = malloc(1), *buf = malloc(BUF); for (i = 0; i < BUF; i++) buf[i] = *cp; In real programs, your mileage will vary. Note that gcc already performs this optimization automatically for any function called `malloc', `calloc', `strdup', or `strndup' unless -fno-builtins is used.
2009-01-31 18:27:02 +00:00
char *strdup(const char *) __malloc_like;
Correct visibility conditionals for memccpy(), strdup(), and strtok_r(). Merge conditional prototypes into the regular block.
2002-10-14 20:38:40 +00:00
#endif
Breath deep and take __P out of the system include files. # This appears to not break X11, but I'm having problems compiling the # glide part of the server with or without this patch, so I can't tell # for sure.
2002-03-23 17:24:55 +00:00
char *strerror(int);
Correct visibility conditionals for memccpy(), strdup(), and strtok_r(). Merge conditional prototypes into the regular block.
2002-10-14 20:38:40 +00:00
#if __POSIX_VISIBLE >= 200112
int strerror_r(int, char *, size_t);
#endif
#if __BSD_VISIBLE
Add restrict qualifiers to the parameters to strlcpy() and strlcat(). The annotation mainly just serves as a hint that they're not intended for use with overlapping strings.
2009-02-28 05:15:02 +00:00
size_t strlcat(char * __restrict, const char * __restrict, size_t);
size_t strlcpy(char * __restrict, const char * __restrict, size_t);
Correct visibility conditionals for memccpy(), strdup(), and strtok_r(). Merge conditional prototypes into the regular block.
2002-10-14 20:38:40 +00:00
#endif
Mark functions pure where applicable. A notable exclusion is strcoll(), which is not strictly pure because it calls malloc()/free() in some cases.
2004-07-23 02:20:05 +00:00
size_t strlen(const char *) __pure;
Correct visibility conditionals for memccpy(), strdup(), and strtok_r(). Merge conditional prototypes into the regular block.
2002-10-14 20:38:40 +00:00
#if __BSD_VISIBLE
Revert last revision, strmode() should be moved to <unistd.h> to be properly fixed.
2005-11-24 08:30:44 +00:00
void strmode(int, char *);
Correct visibility conditionals for memccpy(), strdup(), and strtok_r(). Merge conditional prototypes into the regular block.
2002-10-14 20:38:40 +00:00
#endif
o Move some function prototypes from <string.h> to the newly rewritten <strings.h>, based on POSIX.1-2001's requirements. o Add 'restrict' qualifier (spelled '__restrict') to functions in <string.h>, as per C99 and POSIX.1-2001. o Properly expose new POSIX.1-2001 functions in <string.h>.
2002-04-04 05:41:57 +00:00
char *strncat(char * __restrict, const char * __restrict, size_t);
Mark functions pure where applicable. A notable exclusion is strcoll(), which is not strictly pure because it calls malloc()/free() in some cases.
2004-07-23 02:20:05 +00:00
int strncmp(const char *, const char *, size_t) __pure;
o Move some function prototypes from <string.h> to the newly rewritten <strings.h>, based on POSIX.1-2001's requirements. o Add 'restrict' qualifier (spelled '__restrict') to functions in <string.h>, as per C99 and POSIX.1-2001. o Properly expose new POSIX.1-2001 functions in <string.h>.
2002-04-04 05:41:57 +00:00
char *strncpy(char * __restrict, const char * __restrict, size_t);
include: Remove checks for __BSD_VISIBLE where redundant with __XSI_VISIBLE or __POSIX_VISIBLE. Whenever <sys/cdefs.h> sets __BSD_VISIBLE to non-zero, it also sets __POSIX_VISIBLE and __XSI_VISIBLE to the newest version supported. No functional change is intended.
2014-05-11 13:48:21 +00:00
#if __POSIX_VISIBLE >= 200809
Add a function attribute called `__malloc_like', which informs gcc that the annotated function returns a pointer that doesn't alias any extant pointer. This results in a 50%+ speedup in microbenchmarks such as the following: char *cp = malloc(1), *buf = malloc(BUF); for (i = 0; i < BUF; i++) buf[i] = *cp; In real programs, your mileage will vary. Note that gcc already performs this optimization automatically for any function called `malloc', `calloc', `strdup', or `strndup' unless -fno-builtins is used.
2009-01-31 18:27:02 +00:00
char *strndup(const char *, size_t) __malloc_like;
- Add getdelim(), getline(), stpncpy(), strnlen(), wcsnlen(), wcscasecmp(), and wcsncasecmp(). - Make some previously non-standard extensions visible if POSIX_VISIBLE >= 200809. - Use restrict qualifiers in stpcpy(). - Declare off_t and size_t in stdio.h. - Bump __FreeBSD_version in case the new symbols (particularly getline()) cause issues with ports. Reviewed by: standards@
2009-02-28 06:00:58 +00:00
size_t strnlen(const char *, size_t) __pure;
#endif
#if __BSD_VISIBLE
Mark functions pure where applicable. A notable exclusion is strcoll(), which is not strictly pure because it calls malloc()/free() in some cases.
2004-07-23 02:20:05 +00:00
char *strnstr(const char *, const char *, size_t) __pure;
Correct visibility conditionals for memccpy(), strdup(), and strtok_r(). Merge conditional prototypes into the regular block.
2002-10-14 20:38:40 +00:00
#endif
Mark functions pure where applicable. A notable exclusion is strcoll(), which is not strictly pure because it calls malloc()/free() in some cases.
2004-07-23 02:20:05 +00:00
char *strpbrk(const char *, const char *) __pure;
char *strrchr(const char *, int) __pure;
Correct visibility conditionals for memccpy(), strdup(), and strtok_r(). Merge conditional prototypes into the regular block.
2002-10-14 20:38:40 +00:00
#if __BSD_VISIBLE
char *strsep(char **, const char *);
- Add getdelim(), getline(), stpncpy(), strnlen(), wcsnlen(), wcscasecmp(), and wcsncasecmp(). - Make some previously non-standard extensions visible if POSIX_VISIBLE >= 200809. - Use restrict qualifiers in stpcpy(). - Declare off_t and size_t in stdio.h. - Bump __FreeBSD_version in case the new symbols (particularly getline()) cause issues with ports. Reviewed by: standards@
2009-02-28 06:00:58 +00:00
#endif
include: Remove checks for __BSD_VISIBLE where redundant with __XSI_VISIBLE or __POSIX_VISIBLE. Whenever <sys/cdefs.h> sets __BSD_VISIBLE to non-zero, it also sets __POSIX_VISIBLE and __XSI_VISIBLE to the newest version supported. No functional change is intended.
2014-05-11 13:48:21 +00:00
#if __POSIX_VISIBLE >= 200809
Correct visibility conditionals for memccpy(), strdup(), and strtok_r(). Merge conditional prototypes into the regular block.
2002-10-14 20:38:40 +00:00
char *strsignal(int);
#endif
Mark functions pure where applicable. A notable exclusion is strcoll(), which is not strictly pure because it calls malloc()/free() in some cases.
2004-07-23 02:20:05 +00:00
size_t strspn(const char *, const char *) __pure;
char *strstr(const char *, const char *) __pure;
o Move some function prototypes from <string.h> to the newly rewritten <strings.h>, based on POSIX.1-2001's requirements. o Add 'restrict' qualifier (spelled '__restrict') to functions in <string.h>, as per C99 and POSIX.1-2001. o Properly expose new POSIX.1-2001 functions in <string.h>.
2002-04-04 05:41:57 +00:00
char *strtok(char * __restrict, const char * __restrict);
Correct visibility conditionals for memccpy(), strdup(), and strtok_r(). Merge conditional prototypes into the regular block.
2002-10-14 20:38:40 +00:00
#if __POSIX_VISIBLE >= 199506 || __XSI_VISIBLE >= 500
o Move some function prototypes from <string.h> to the newly rewritten <strings.h>, based on POSIX.1-2001's requirements. o Add 'restrict' qualifier (spelled '__restrict') to functions in <string.h>, as per C99 and POSIX.1-2001. o Properly expose new POSIX.1-2001 functions in <string.h>.
2002-04-04 05:41:57 +00:00
char *strtok_r(char *, const char *, char **);
#endif
Correct visibility conditionals for memccpy(), strdup(), and strtok_r(). Merge conditional prototypes into the regular block.
2002-10-14 20:38:40 +00:00
size_t strxfrm(char * __restrict, const char * __restrict, size_t);
o Move some function prototypes from <string.h> to the newly rewritten <strings.h>, based on POSIX.1-2001's requirements. o Add 'restrict' qualifier (spelled '__restrict') to functions in <string.h>, as per C99 and POSIX.1-2001. o Properly expose new POSIX.1-2001 functions in <string.h>.
2002-04-04 05:41:57 +00:00
#if __BSD_VISIBLE
According to the information on: http://www.opengroup.org/onlinepubs/009695399/functions/swab.html the prototype for swab() should be in <unistd.h> and not in <string.h>. Move it, and update to match SUS. Leave the prototype in string.h for now, for backwards compat. PR: 74751 Submitted by: Craig Rodrigues <rodrigc@crodrigues.org> Discussed with: das
2004-12-10 15:24:40 +00:00
#ifndef _SWAB_DECLARED
#define _SWAB_DECLARED
#ifndef _SSIZE_T_DECLARED
typedef __ssize_t ssize_t;
#define _SSIZE_T_DECLARED
#endif /* _SIZE_T_DECLARED */
void swab(const void * __restrict, void * __restrict, ssize_t);
#endif /* _SWAB_DECLARED */
#endif /* __BSD_VISIBLE */
Reapply 227753 (xlocale cleanup), plus some fixes so that it passes build universe with gcc. Approved by: dim (mentor)
2012-03-04 15:31:13 +00:00
Correctly expose xlocale functions if people include the headers in the wrong order (as some ports apparently do). Approved by: dim (mentor)
2012-03-28 12:11:54 +00:00
#if __POSIX_VISIBLE >= 200809 || defined(_XLOCALE_H_)
Reapply 227753 (xlocale cleanup), plus some fixes so that it passes build universe with gcc. Approved by: dim (mentor)
2012-03-04 15:31:13 +00:00
#include <xlocale/_string.h>
#endif
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
__END_DECLS
#endif /* _STRING_H_ */
Reference in New Issue Copy Permalink