xref: /freebsd/include/string.h (revision 783d3ff6d7fae619db8a7990b8a6387de0c677b5)
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 __BEGIN_DECLS
53 #if __XSI_VISIBLE >= 600
54 void	*memccpy(void * __restrict, const void * __restrict, int, size_t);
55 #endif
56 void	*memchr(const void *, int, size_t) __pure;
57 #if __BSD_VISIBLE
58 void	*memrchr(const void *, int, size_t) __pure;
59 #endif
60 int	 memcmp(const void *, const void *, size_t) __pure;
61 void	*memcpy(void * __restrict, const void * __restrict, size_t);
62 #if __BSD_VISIBLE
63 void	*memmem(const void *, size_t, const void *, size_t) __pure;
64 #endif
65 void	*memmove(void *, const void *, size_t);
66 #if __BSD_VISIBLE
67 void	*mempcpy(void * __restrict, const void * __restrict, size_t);
68 #endif
69 void	*memset(void *, int, size_t);
70 #if __POSIX_VISIBLE >= 200809
71 char	*stpcpy(char * __restrict, const char * __restrict);
72 char	*stpncpy(char * __restrict, const char * __restrict, size_t);
73 #endif
74 #if __BSD_VISIBLE
75 char	*strcasestr(const char *, const char *) __pure;
76 #endif
77 char	*strcat(char * __restrict, const char * __restrict);
78 char	*strchr(const char *, int) __pure;
79 #if __BSD_VISIBLE
80 char	*strchrnul(const char*, int) __pure;
81 int	 strverscmp(const char *, const char *) __pure;
82 #endif
83 int	 strcmp(const char *, const char *) __pure;
84 int	 strcoll(const char *, const char *);
85 char	*strcpy(char * __restrict, const char * __restrict);
86 size_t	 strcspn(const char *, const char *) __pure;
87 #if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
88 char	*strdup(const char *) __malloc_like;
89 #endif
90 char	*strerror(int);
91 #if __POSIX_VISIBLE >= 200112
92 int	 strerror_r(int, char *, size_t);
93 #endif
94 #if __BSD_VISIBLE
95 size_t	 strlcat(char * __restrict, const char * __restrict, size_t);
96 size_t	 strlcpy(char * __restrict, const char * __restrict, size_t);
97 #endif
98 size_t	 strlen(const char *) __pure;
99 #if __BSD_VISIBLE
100 
101 #ifndef _MODE_T_DECLARED
102 typedef	__mode_t	mode_t;
103 #define	_MODE_T_DECLARED
104 #endif
105 
106 void	 strmode(mode_t, char *);
107 #endif
108 char	*strncat(char * __restrict, const char * __restrict, size_t);
109 int	 strncmp(const char *, const char *, size_t) __pure;
110 char	*strncpy(char * __restrict, const char * __restrict, size_t);
111 #if __POSIX_VISIBLE >= 200809
112 char	*strndup(const char *, size_t) __malloc_like;
113 size_t	 strnlen(const char *, size_t) __pure;
114 #endif
115 #if __BSD_VISIBLE
116 char	*strnstr(const char *, const char *, size_t) __pure;
117 #endif
118 char	*strpbrk(const char *, const char *) __pure;
119 char	*strrchr(const char *, int) __pure;
120 #if __BSD_VISIBLE
121 char	*strsep(char **, const char *);
122 #endif
123 #if __POSIX_VISIBLE >= 200809
124 char	*strsignal(int);
125 #endif
126 size_t	 strspn(const char *, const char *) __pure;
127 char	*strstr(const char *, const char *) __pure;
128 char	*strtok(char * __restrict, const char * __restrict);
129 #if __POSIX_VISIBLE >= 199506 || __XSI_VISIBLE >= 500
130 char	*strtok_r(char *, const char *, char **);
131 #endif
132 size_t	 strxfrm(char * __restrict, const char * __restrict, size_t);
133 #if __BSD_VISIBLE
134 
135 #ifndef _SWAB_DECLARED
136 #define _SWAB_DECLARED
137 
138 #ifndef _SSIZE_T_DECLARED
139 typedef	__ssize_t	ssize_t;
140 #define	_SSIZE_T_DECLARED
141 #endif /* _SIZE_T_DECLARED */
142 
143 void	 swab(const void * __restrict, void * __restrict, ssize_t);
144 #endif /* _SWAB_DECLARED */
145 
146 int	 timingsafe_bcmp(const void *, const void *, size_t);
147 int	 timingsafe_memcmp(const void *, const void *, size_t);
148 #endif /* __BSD_VISIBLE */
149 
150 #if __POSIX_VISIBLE >= 200112 || defined(_XLOCALE_H_)
151 #include <xlocale/_string.h>
152 #endif
153 
154 #if __EXT1_VISIBLE
155 
156 #ifndef _RSIZE_T_DEFINED
157 #define _RSIZE_T_DEFINED
158 typedef size_t rsize_t;
159 #endif
160 
161 #ifndef _ERRNO_T_DEFINED
162 #define _ERRNO_T_DEFINED
163 typedef int errno_t;
164 #endif
165 
166 /* ISO/IEC 9899:2011 K.3.7.4.1.1 */
167 errno_t memset_s(void *, rsize_t, int, rsize_t);
168 #endif /* __EXT1_VISIBLE */
169 __END_DECLS
170 
171 #endif /* _STRING_H_ */
172