xref: /freebsd/include/string.h (revision b64c5a0ace59af62eff52bfe110a521dc73c937b)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1990, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 #ifndef _STRING_H_
33 #define	_STRING_H_
34 
35 #include <sys/cdefs.h>
36 #include <sys/_null.h>
37 #include <sys/_types.h>
38 
39 /*
40  * Prototype functions which were historically defined in <string.h>, but
41  * are required by POSIX to be prototyped in <strings.h>.
42  */
43 #if __BSD_VISIBLE
44 #include <strings.h>
45 #endif
46 
47 #ifndef _SIZE_T_DECLARED
48 typedef	__size_t	size_t;
49 #define	_SIZE_T_DECLARED
50 #endif
51 
52 #if !defined(_STANDALONE) && defined(_FORTIFY_SOURCE) && _FORTIFY_SOURCE > 0
53 #include <ssp/string.h>
54 #endif
55 
56 __BEGIN_DECLS
57 #if __XSI_VISIBLE >= 600 || __ISO_C_VISIBLE >= 2023
58 void	*memccpy(void * __restrict, const void * __restrict, int, size_t);
59 #endif
60 void	*memchr(const void *, int, size_t) __pure;
61 #if __BSD_VISIBLE
62 void	*memrchr(const void *, int, size_t) __pure;
63 #endif
64 int	 memcmp(const void *, const void *, size_t) __pure;
65 void	*(memcpy)(void * __restrict, const void * __restrict, size_t);
66 #if __BSD_VISIBLE
67 void	*memmem(const void *, size_t, const void *, size_t) __pure;
68 #endif
69 void	*(memmove)(void *, const void *, size_t);
70 #if __BSD_VISIBLE
71 void	*(mempcpy)(void * __restrict, const void * __restrict, size_t);
72 #endif
73 void	*(memset)(void *, int, size_t);
74 #if __BSD_VISIBLE || __ISO_C_VISIBLE >= 2023
75 void	*memset_explicit(void *, int, size_t);
76 #endif
77 #if __POSIX_VISIBLE >= 200809
78 char	*(stpcpy)(char * __restrict, const char * __restrict);
79 char	*(stpncpy)(char * __restrict, const char * __restrict, size_t);
80 #endif
81 #if __BSD_VISIBLE
82 char	*strcasestr(const char *, const char *) __pure;
83 #endif
84 char	*(strcat)(char * __restrict, const char * __restrict);
85 char	*strchr(const char *, int) __pure;
86 #if __BSD_VISIBLE
87 char	*strchrnul(const char*, int) __pure;
88 int	 strverscmp(const char *, const char *) __pure;
89 #endif
90 int	 strcmp(const char *, const char *) __pure;
91 int	 strcoll(const char *, const char *);
92 char	*(strcpy)(char * __restrict, const char * __restrict);
93 size_t	 strcspn(const char *, const char *) __pure;
94 #if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE || __ISO_C_VISIBLE >= 2023
95 char	*strdup(const char *) __malloc_like;
96 #endif
97 char	*strerror(int);
98 #if __POSIX_VISIBLE >= 200112
99 int	 strerror_r(int, char *, size_t);
100 #endif
101 #if __BSD_VISIBLE
102 size_t	 (strlcat)(char * __restrict, const char * __restrict, size_t);
103 size_t	 (strlcpy)(char * __restrict, const char * __restrict, size_t);
104 #endif
105 size_t	 strlen(const char *) __pure;
106 #if __BSD_VISIBLE
107 
108 #ifndef _MODE_T_DECLARED
109 typedef	__mode_t	mode_t;
110 #define	_MODE_T_DECLARED
111 #endif
112 
113 void	 strmode(mode_t, char *);
114 #endif
115 char	*(strncat)(char * __restrict, const char * __restrict, size_t);
116 int	 strncmp(const char *, const char *, size_t) __pure;
117 char	*(strncpy)(char * __restrict, const char * __restrict, size_t);
118 #if __POSIX_VISIBLE >= 200809 || __ISO_C_VISIBLE >= 2023
119 char	*strndup(const char *, size_t) __malloc_like;
120 #endif
121 #if __POSIX_VISIBLE >= 200809
122 size_t	 strnlen(const char *, size_t) __pure;
123 #endif
124 #if __BSD_VISIBLE
125 char	*strnstr(const char *, const char *, size_t) __pure;
126 #endif
127 char	*strpbrk(const char *, const char *) __pure;
128 char	*strrchr(const char *, int) __pure;
129 #if __BSD_VISIBLE
130 char	*strsep(char **, const char *);
131 #endif
132 #if __POSIX_VISIBLE >= 200809
133 char	*strsignal(int);
134 #endif
135 size_t	 strspn(const char *, const char *) __pure;
136 char	*strstr(const char *, const char *) __pure;
137 char	*strtok(char * __restrict, const char * __restrict);
138 #if __POSIX_VISIBLE >= 199506 || __XSI_VISIBLE >= 500
139 char	*strtok_r(char *, const char *, char **);
140 #endif
141 size_t	 strxfrm(char * __restrict, const char * __restrict, size_t);
142 #if __BSD_VISIBLE
143 
144 #ifndef _SWAB_DECLARED
145 #define _SWAB_DECLARED
146 
147 #ifndef _SSIZE_T_DECLARED
148 typedef	__ssize_t	ssize_t;
149 #define	_SSIZE_T_DECLARED
150 #endif /* _SIZE_T_DECLARED */
151 
152 void	 swab(const void * __restrict, void * __restrict, ssize_t);
153 #endif /* _SWAB_DECLARED */
154 
155 int	 timingsafe_bcmp(const void *, const void *, size_t);
156 int	 timingsafe_memcmp(const void *, const void *, size_t);
157 #endif /* __BSD_VISIBLE */
158 
159 #if __POSIX_VISIBLE >= 200112 || defined(_XLOCALE_H_)
160 #include <xlocale/_string.h>
161 #endif
162 
163 #if __EXT1_VISIBLE
164 
165 #ifndef _RSIZE_T_DEFINED
166 #define _RSIZE_T_DEFINED
167 typedef size_t rsize_t;
168 #endif
169 
170 #ifndef _ERRNO_T_DEFINED
171 #define _ERRNO_T_DEFINED
172 typedef int errno_t;
173 #endif
174 
175 /* ISO/IEC 9899:2011 K.3.7.4.1.1 */
176 errno_t memset_s(void *, rsize_t, int, rsize_t);
177 #endif /* __EXT1_VISIBLE */
178 __END_DECLS
179 
180 #endif /* _STRING_H_ */
181