RepoMirrors
/
musl
mirror of git://git.musl-libc.org/musl
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
musl/include/string.h

106 lines
2.9 KiB
C
Raw Normal View History

initial check-in, version 0.5.0
2011-02-12 05:22:29 +00:00
#ifndef _STRING_H
#define _STRING_H
#ifdef __cplusplus
extern "C" {
#endif
default features: make musl usable without feature test macros the old behavior of exposing nothing except plain ISO C can be obtained by defining __STRICT_ANSI__ or using a compiler option (such as -std=c99) that predefines it. the new default featureset is POSIX with XSI plus _BSD_SOURCE. any explicit feature test macros will inhibit the default. installation docs have also been updated to reflect this change.
2012-09-08 03:13:55 +00:00
#include <features.h>
use restrict everywhere it's required by c99 and/or posix 2008 to deal with the fact that the public headers may be used with pre-c99 compilers, __restrict is used in place of restrict, and defined appropriately for any supported compiler. we also avoid the form [restrict] since older versions of gcc rejected it due to a bug in the original c99 standard, and instead use the form *restrict.
2012-09-07 02:44:55 +00:00
restore type of NULL to void * except when used in C++ programs unfortunately this eliminates the ability of the compiler to diagnose some dangerous/incorrect usage, but POSIX requires (as an extension to the C language, i.e. CX shaded) that NULL have type void *. plain C allows it to be defined as any null pointer constant. the definition 0L is preserved for C++ rather than reverting to plain 0 to avoid dangerous behavior in non-conforming programs which use NULL as a variadic sentinel. (it's impossible to use (void *)0 for C++ since C++ lacks the proper implicit pointer conversions, and other popular alternatives like the GCC __null extension seem non-conforming to the standard's requirements.)
2013-11-25 02:42:55 +00:00
#ifdef __cplusplus
use a common definition of NULL as 0L for C and C++ the historical mess of having different definitions for C and C++ comes from the historical C definition as (void *)0 and the fact that (void *)0 can't be used in C++ because it does not convert to other pointer types implicitly. however, using plain 0 in C++ exposed bugs in C++ programs that call variadic functions with NULL as an argument and (wrongly; this is UB) expect it to arrive as a null pointer. on 64-bit machines, the high bits end up containing junk. glibc dodges the issue by using a GCC extension __null to define NULL; this is observably non-conforming because a conforming application could observe the definition of NULL via stringizing and see that it is neither an integer constant expression with value zero nor such an expression cast to void. switching to 0L eliminates the issue and provides compatibility with broken applications, since on all musl targets, long and pointers have the same size, representation, and argument-passing convention. we could maintain separate C and C++ definitions of NULL (i.e. just use 0L on C++ and use (void *)0 on C) but after careful analysis, it seems extremely difficult for a C program to even determine whether NULL has integer or pointer type, much less depend in subtle, unintentional ways, on whether it does. C89 seems to have no way to make the distinction. on C99, the fact that (int)(void *)0 is not an integer constant expression, along with subtle VLA/sizeof semantics, can be used to make the distinction, but many compilers are non-conforming and give the wrong result to this test anyway. on C11, _Generic can trivially make the distinction, but it seems unlikely that code targetting C11 would be so backwards in caring which definition of NULL an implementation uses. as such, the simplest path of using the same definition for NULL in both C and C++ was chosen. the #undef directive was also removed so that the compiler can catch and give a warning or error on redefinition if buggy programs have defined their own versions of NULL prior to inclusion of standard headers.
2013-01-19 01:35:26 +00:00
#define NULL 0L
restore type of NULL to void * except when used in C++ programs unfortunately this eliminates the ability of the compiler to diagnose some dangerous/incorrect usage, but POSIX requires (as an extension to the C language, i.e. CX shaded) that NULL have type void *. plain C allows it to be defined as any null pointer constant. the definition 0L is preserved for C++ rather than reverting to plain 0 to avoid dangerous behavior in non-conforming programs which use NULL as a variadic sentinel. (it's impossible to use (void *)0 for C++ since C++ lacks the proper implicit pointer conversions, and other popular alternatives like the GCC __null extension seem non-conforming to the standard's requirements.)
2013-11-25 02:42:55 +00:00
#else
#define NULL ((void*)0)
#endif
initial check-in, version 0.5.0
2011-02-12 05:22:29 +00:00
#define __NEED_size_t
more locale_t interfaces (string stuff) and header updates this should be everything except for some functions where the non-_l version isn't even implemented yet (mainly some non-ISO-C wcs* functions).
2012-02-07 02:51:02 +00:00
#if defined(_POSIX_SOURCE) || defined(_POSIX_C_SOURCE) \
support _BSD_SOURCE feature test macro patch by Isaac Dunham. matched closely (maybe not exact) to glibc's idea of what _BSD_SOURCE should make visible.
2012-05-23 01:52:08 +00:00
|| defined(_XOPEN_SOURCE) || defined(_GNU_SOURCE) \
|| defined(_BSD_SOURCE)
more locale_t interfaces (string stuff) and header updates this should be everything except for some functions where the non-_l version isn't even implemented yet (mainly some non-ISO-C wcs* functions).
2012-02-07 02:51:02 +00:00
#define __NEED_locale_t
#endif
initial check-in, version 0.5.0
2011-02-12 05:22:29 +00:00
#include <bits/alltypes.h>
use restrict everywhere it's required by c99 and/or posix 2008 to deal with the fact that the public headers may be used with pre-c99 compilers, __restrict is used in place of restrict, and defined appropriately for any supported compiler. we also avoid the form [restrict] since older versions of gcc rejected it due to a bug in the original c99 standard, and instead use the form *restrict.
2012-09-07 02:44:55 +00:00
void *memcpy (void *__restrict, const void *__restrict, size_t);
initial check-in, version 0.5.0
2011-02-12 05:22:29 +00:00
void *memmove (void *, const void *, size_t);
void *memset (void *, int, size_t);
int memcmp (const void *, const void *, size_t);
void *memchr (const void *, int, size_t);
use restrict everywhere it's required by c99 and/or posix 2008 to deal with the fact that the public headers may be used with pre-c99 compilers, __restrict is used in place of restrict, and defined appropriately for any supported compiler. we also avoid the form [restrict] since older versions of gcc rejected it due to a bug in the original c99 standard, and instead use the form *restrict.
2012-09-07 02:44:55 +00:00
char *strcpy (char *__restrict, const char *__restrict);
char *strncpy (char *__restrict, const char *__restrict, size_t);
initial check-in, version 0.5.0
2011-02-12 05:22:29 +00:00
use restrict everywhere it's required by c99 and/or posix 2008 to deal with the fact that the public headers may be used with pre-c99 compilers, __restrict is used in place of restrict, and defined appropriately for any supported compiler. we also avoid the form [restrict] since older versions of gcc rejected it due to a bug in the original c99 standard, and instead use the form *restrict.
2012-09-07 02:44:55 +00:00
char *strcat (char *__restrict, const char *__restrict);
char *strncat (char *__restrict, const char *__restrict, size_t);
initial check-in, version 0.5.0
2011-02-12 05:22:29 +00:00
int strcmp (const char *, const char *);
int strncmp (const char *, const char *, size_t);
int strcoll (const char *, const char *);
use restrict everywhere it's required by c99 and/or posix 2008 to deal with the fact that the public headers may be used with pre-c99 compilers, __restrict is used in place of restrict, and defined appropriately for any supported compiler. we also avoid the form [restrict] since older versions of gcc rejected it due to a bug in the original c99 standard, and instead use the form *restrict.
2012-09-07 02:44:55 +00:00
size_t strxfrm (char *__restrict, const char *__restrict, size_t);
initial check-in, version 0.5.0
2011-02-12 05:22:29 +00:00
char *strchr (const char *, int);
char *strrchr (const char *, int);
size_t strcspn (const char *, const char *);
size_t strspn (const char *, const char *);
char *strpbrk (const char *, const char *);
char *strstr (const char *, const char *);
use restrict everywhere it's required by c99 and/or posix 2008 to deal with the fact that the public headers may be used with pre-c99 compilers, __restrict is used in place of restrict, and defined appropriately for any supported compiler. we also avoid the form [restrict] since older versions of gcc rejected it due to a bug in the original c99 standard, and instead use the form *restrict.
2012-09-07 02:44:55 +00:00
char *strtok (char *__restrict, const char *__restrict);
initial check-in, version 0.5.0
2011-02-12 05:22:29 +00:00
size_t strlen (const char *);
char *strerror (int);
support _BSD_SOURCE feature test macro patch by Isaac Dunham. matched closely (maybe not exact) to glibc's idea of what _BSD_SOURCE should make visible.
2012-05-23 01:52:08 +00:00
#if defined(_BSD_SOURCE) || defined(_GNU_SOURCE)
#include <strings.h>
#endif
initial check-in, version 0.5.0
2011-02-12 05:22:29 +00:00
more header cleanup and conformance fixes - string.h
2011-02-15 01:53:15 +00:00
#if defined(_POSIX_SOURCE) || defined(_POSIX_C_SOURCE) \
support _BSD_SOURCE feature test macro patch by Isaac Dunham. matched closely (maybe not exact) to glibc's idea of what _BSD_SOURCE should make visible.
2012-05-23 01:52:08 +00:00
|| defined(_XOPEN_SOURCE) || defined(_GNU_SOURCE) \
|| defined(_BSD_SOURCE)
use restrict everywhere it's required by c99 and/or posix 2008 to deal with the fact that the public headers may be used with pre-c99 compilers, __restrict is used in place of restrict, and defined appropriately for any supported compiler. we also avoid the form [restrict] since older versions of gcc rejected it due to a bug in the original c99 standard, and instead use the form *restrict.
2012-09-07 02:44:55 +00:00
char *strtok_r (char *__restrict, const char *__restrict, char **__restrict);
more header cleanup and conformance fixes - string.h
2011-02-15 01:53:15 +00:00
int strerror_r (int, char *, size_t);
use restrict everywhere it's required by c99 and/or posix 2008 to deal with the fact that the public headers may be used with pre-c99 compilers, __restrict is used in place of restrict, and defined appropriately for any supported compiler. we also avoid the form [restrict] since older versions of gcc rejected it due to a bug in the original c99 standard, and instead use the form *restrict.
2012-09-07 02:44:55 +00:00
char *stpcpy(char *__restrict, const char *__restrict);
char *stpncpy(char *__restrict, const char *__restrict, size_t);
initial check-in, version 0.5.0
2011-02-12 05:22:29 +00:00
size_t strnlen (const char *, size_t);
more header cleanup and conformance fixes - string.h
2011-02-15 01:53:15 +00:00
char *strdup (const char *);
char *strndup (const char *, size_t);
fix missing prototype for strsignal
2011-02-27 04:50:26 +00:00
char *strsignal(int);
more locale_t interfaces (string stuff) and header updates this should be everything except for some functions where the non-_l version isn't even implemented yet (mainly some non-ISO-C wcs* functions).
2012-02-07 02:51:02 +00:00
char *strerror_l (int, locale_t);
int strcoll_l (const char *, const char *, locale_t);
use restrict everywhere it's required by c99 and/or posix 2008 to deal with the fact that the public headers may be used with pre-c99 compilers, __restrict is used in place of restrict, and defined appropriately for any supported compiler. we also avoid the form [restrict] since older versions of gcc rejected it due to a bug in the original c99 standard, and instead use the form *restrict.
2012-09-07 02:44:55 +00:00
size_t strxfrm_l (char *__restrict, const char *__restrict, size_t, locale_t);
more header cleanup and conformance fixes - string.h
2011-02-15 01:53:15 +00:00
#endif
support _BSD_SOURCE feature test macro patch by Isaac Dunham. matched closely (maybe not exact) to glibc's idea of what _BSD_SOURCE should make visible.
2012-05-23 01:52:08 +00:00
#if defined(_XOPEN_SOURCE) || defined(_GNU_SOURCE) \
|| defined(_BSD_SOURCE)
use restrict everywhere it's required by c99 and/or posix 2008 to deal with the fact that the public headers may be used with pre-c99 compilers, __restrict is used in place of restrict, and defined appropriately for any supported compiler. we also avoid the form [restrict] since older versions of gcc rejected it due to a bug in the original c99 standard, and instead use the form *restrict.
2012-09-07 02:44:55 +00:00
void *memccpy (void *__restrict, const void *__restrict, int, size_t);
apply feature test protection to memccpy
2011-02-24 17:36:04 +00:00
#endif
strsep is BSD|GNU, not GNU-only; it's originally from BSD
2012-09-14 01:01:30 +00:00
#if defined(_GNU_SOURCE) || defined(_BSD_SOURCE)
char *strsep(char **, const char *);
more header cleanup and conformance fixes - string.h
2011-02-15 01:53:15 +00:00
size_t strlcat (char *, const char *, size_t);
size_t strlcpy (char *, const char *, size_t);
add explicit_bzero implementation maintainer's note: past sentiment was that, despite being imperfect and unable to force clearing of all possible copies of sensitive data (e.g. in registers, register spills, signal contexts left on the stack, etc.) this function would be added if major implementations agreed on it, which has happened -- several BSDs and glibc all include it.
2018-06-15 13:30:09 +00:00
void explicit_bzero (void *, size_t);
more header cleanup and conformance fixes - string.h
2011-02-15 01:53:15 +00:00
#endif
initial check-in, version 0.5.0
2011-02-12 05:22:29 +00:00
#ifdef _GNU_SOURCE
support _BSD_SOURCE feature test macro patch by Isaac Dunham. matched closely (maybe not exact) to glibc's idea of what _BSD_SOURCE should make visible.
2012-05-23 01:52:08 +00:00
#define strdupa(x) strcpy(alloca(strlen(x)+1),x)
add dummied strverscmp (obnoxious GNU function) programs that use this tend to horribly botch international text support, so it's questionable whether we want to support it even in the long term... for now, it's just a dummy that calls strcmp.
2011-09-12 02:45:56 +00:00
int strverscmp (const char *, const char *);
initial check-in, version 0.5.0
2011-02-12 05:22:29 +00:00
char *strchrnul(const char *, int);
prototype for gnu strcasestr (currently a stub)
2011-02-15 21:08:19 +00:00
char *strcasestr(const char *, const char *);
add memmem function (gnu extension) based on strstr. passes gnulib tests and a few quick checks of my own.
2012-10-16 03:02:57 +00:00
void *memmem(const void *, size_t, const void *, size_t);
implement memrchr (nonstandard) and optimize strrchr in terms of it
2011-04-13 12:36:29 +00:00
void *memrchr(const void *, int, size_t);
function signature fix: add const qualifier to mempcpy src arg
2011-04-26 16:28:41 +00:00
void *mempcpy(void *, const void *, size_t);
omit declaration of basename wrongly interpreted as prototype in C++ the non-prototype declaration of basename in string.h is an ugly compromise to avoid breaking 2 types of broken software: 1. programs which assume basename is declared in string.h and thus would suffer from dangerous pointer-truncation if an implicit declaration were used. 2. programs which include string.h with _GNU_SOURCE defined but then declare their own prototype for basename using the incorrect GNU signature for the function (which would clash with a correct prototype). however, since C++ does not have non-prototype declarations and interprets them as prototypes for a function with no arguments, we must omit it when compiling C++ code. thankfully, all known broken apps that suffer from the above issues are written in C, not C++.
2012-05-09 15:47:06 +00:00
#ifndef __cplusplus
replace prototype for basename in string.h with non-prototype declaration GNU programs may expect the GNU version of basename, which has a different prototype (argument is const-qualified) and prototype it themselves too. of course if they're expecting the GNU behavior for the function, they'll still run into problems, but at least this eliminates some compile-time failures.
2012-02-25 04:23:47 +00:00
char *basename();
initial check-in, version 0.5.0
2011-02-12 05:22:29 +00:00
#endif
omit declaration of basename wrongly interpreted as prototype in C++ the non-prototype declaration of basename in string.h is an ugly compromise to avoid breaking 2 types of broken software: 1. programs which assume basename is declared in string.h and thus would suffer from dangerous pointer-truncation if an implicit declaration were used. 2. programs which include string.h with _GNU_SOURCE defined but then declare their own prototype for basename using the incorrect GNU signature for the function (which would clash with a correct prototype). however, since C++ does not have non-prototype declarations and interprets them as prototypes for a function with no arguments, we must omit it when compiling C++ code. thankfully, all known broken apps that suffer from the above issues are written in C, not C++.
2012-05-09 15:47:06 +00:00
#endif
initial check-in, version 0.5.0
2011-02-12 05:22:29 +00:00
#ifdef __cplusplus
}
#endif
#endif