xref: /freebsd/include/string.h (revision 7cd22ac43418da08448d0bab1009ff3cbda85120)
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  *	@(#)string.h	8.1 (Berkeley) 6/2/93
32  * $FreeBSD$
33  */
34 
35 #ifndef _STRING_H_
36 #define	_STRING_H_
37 
38 #include <sys/cdefs.h>
39 #include <sys/_null.h>
40 #include <sys/_types.h>
41 
42 /*
43  * Prototype functions which were historically defined in <string.h>, but
44  * are required by POSIX to be prototyped in <strings.h>.
45  */
46 #if __BSD_VISIBLE
47 #include <strings.h>
48 #endif
49 
50 #ifndef _SIZE_T_DECLARED
51 typedef	__size_t	size_t;
52 #define	_SIZE_T_DECLARED
53 #endif
54 
55 __BEGIN_DECLS
56 #if __XSI_VISIBLE >= 600
57 void	*memccpy(void * __restrict, const void * __restrict, int, size_t);
58 #endif
59 void	*memchr(const void *, int, size_t) __pure;
60 #if __BSD_VISIBLE
61 void	*memrchr(const void *, int, size_t) __pure;
62 #endif
63 int	 memcmp(const void *, const void *, size_t) __pure;
64 void	*memcpy(void * __restrict, const void * __restrict, size_t);
65 #if __BSD_VISIBLE
66 void	*memmem(const void *, size_t, const void *, size_t) __pure;
67 #endif
68 void	*memmove(void *, const void *, size_t);
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 #endif
82 int	 strcmp(const char *, const char *) __pure;
83 int	 strcoll(const char *, const char *);
84 char	*strcpy(char * __restrict, const char * __restrict);
85 size_t	 strcspn(const char *, const char *) __pure;
86 #if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
87 char	*strdup(const char *) __malloc_like;
88 #endif
89 char	*strerror(int);
90 #if __POSIX_VISIBLE >= 200112
91 int	 strerror_r(int, char *, size_t);
92 #endif
93 #if __BSD_VISIBLE
94 size_t	 strlcat(char * __restrict, const char * __restrict, size_t);
95 size_t	 strlcpy(char * __restrict, const char * __restrict, size_t);
96 #endif
97 size_t	 strlen(const char *) __pure;
98 #if __BSD_VISIBLE
99 
100 #ifndef _MODE_T_DECLARED
101 typedef	__mode_t	mode_t;
102 #define	_MODE_T_DECLARED
103 #endif
104 
105 void	 strmode(mode_t, char *);
106 #endif
107 char	*strncat(char * __restrict, const char * __restrict, size_t);
108 int	 strncmp(const char *, const char *, size_t) __pure;
109 char	*strncpy(char * __restrict, const char * __restrict, size_t);
110 #if __POSIX_VISIBLE >= 200809
111 char	*strndup(const char *, size_t) __malloc_like;
112 size_t	 strnlen(const char *, size_t) __pure;
113 #endif
114 #if __BSD_VISIBLE
115 char	*strnstr(const char *, const char *, size_t) __pure;
116 #endif
117 char	*strpbrk(const char *, const char *) __pure;
118 char	*strrchr(const char *, int) __pure;
119 #if __BSD_VISIBLE
120 char	*strsep(char **, const char *);
121 #endif
122 #if __POSIX_VISIBLE >= 200809
123 char	*strsignal(int);
124 #endif
125 size_t	 strspn(const char *, const char *) __pure;
126 char	*strstr(const char *, const char *) __pure;
127 char	*strtok(char * __restrict, const char * __restrict);
128 #if __POSIX_VISIBLE >= 199506 || __XSI_VISIBLE >= 500
129 char	*strtok_r(char *, const char *, char **);
130 #endif
131 size_t	 strxfrm(char * __restrict, const char * __restrict, size_t);
132 #if __BSD_VISIBLE
133 
134 #ifndef _SWAB_DECLARED
135 #define _SWAB_DECLARED
136 
137 #ifndef _SSIZE_T_DECLARED
138 typedef	__ssize_t	ssize_t;
139 #define	_SSIZE_T_DECLARED
140 #endif /* _SIZE_T_DECLARED */
141 
142 void	 swab(const void * __restrict, void * __restrict, ssize_t);
143 #endif /* _SWAB_DECLARED */
144 
145 int	 timingsafe_bcmp(const void *, const void *, size_t);
146 int	 timingsafe_memcmp(const void *, const void *, size_t);
147 #endif /* __BSD_VISIBLE */
148 
149 #if __POSIX_VISIBLE >= 200112 || defined(_XLOCALE_H_)
150 #include <xlocale/_string.h>
151 #endif
152 
153 #if __EXT1_VISIBLE
154 
155 #ifndef _RSIZE_T_DEFINED
156 #define _RSIZE_T_DEFINED
157 typedef size_t rsize_t;
158 #endif
159 
160 #ifndef _ERRNO_T_DEFINED
161 #define _ERRNO_T_DEFINED
162 typedef int errno_t;
163 #endif
164 
165 /* ISO/IEC 9899:2011 K.3.7.4.1.1 */
166 errno_t memset_s(void *, rsize_t, int, rsize_t);
167 #endif /* __EXT1_VISIBLE */
168 __END_DECLS
169 
170 #endif /* _STRING_H_ */
171