xref: /openbsd-src/include/string.h (revision 4af81b37ced6d7e969e2e8eba245210dae4b89d1)
1 /*	$OpenBSD: string.h,v 1.34 2024/08/03 20:13:23 guenther Exp $	*/
2 /*	$NetBSD: string.h,v 1.6 1994/10/26 00:56:30 cgd Exp $	*/
3 
4 /*-
5  * Copyright (c) 1990 The Regents of the University of California.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  *	@(#)string.h	5.10 (Berkeley) 3/9/91
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  * POSIX mandates that certain string functions not present in ISO C
44  * be prototyped in strings.h.  Historically, we've included them here.
45  */
46 #if __BSD_VISIBLE
47 #include <strings.h>
48 #endif
49 
50 #ifndef	_SIZE_T_DEFINED_
51 #define	_SIZE_T_DEFINED_
52 typedef	__size_t	size_t;
53 #endif
54 
55 #if __POSIX_VISIBLE >= 200809
56 #ifndef _LOCALE_T_DEFINED_
57 #define _LOCALE_T_DEFINED_
58 typedef void	*locale_t;
59 #endif
60 #endif
61 
62 __BEGIN_DECLS
63 void	*memchr(const void *, int, size_t);
64 int	 memcmp(const void *, const void *, size_t);
65 void	*memcpy(void *__restrict, const void *__restrict, size_t)
66 		__attribute__ ((__bounded__(__buffer__,1,3)))
67 		__attribute__ ((__bounded__(__buffer__,2,3)));
68 void	*memmove(void *, const void *, size_t)
69 		__attribute__ ((__bounded__(__buffer__,1,3)))
70 		__attribute__ ((__bounded__(__buffer__,2,3)));
71 void	*memset(void *, int, size_t)
72 		__attribute__ ((__bounded__(__buffer__,1,3)));
73 char	*strcat(char *__restrict, const char *__restrict);
74 char	*strchr(const char *, int);
75 int	 strcmp(const char *, const char *);
76 int	 strcoll(const char *, const char *);
77 char	*strcpy(char *__restrict, const char *__restrict);
78 size_t	 strcspn(const char *, const char *);
79 char	*strerror(int);
80 size_t	 strlen(const char *);
81 char	*strncat(char *__restrict, const char *__restrict, size_t)
82 		__attribute__ ((__bounded__(__string__,1,3)));
83 int	 strncmp(const char *, const char *, size_t);
84 char	*strncpy(char *__restrict, const char *__restrict, size_t)
85 		__attribute__ ((__bounded__(__string__,1,3)));
86 char	*strpbrk(const char *, const char *);
87 char	*strrchr(const char *, int);
88 size_t	 strspn(const char *, const char *);
89 char	*strstr(const char *, const char *);
90 char	*strtok(char *__restrict, const char *__restrict);
91 char	*strtok_r(char *__restrict, const char *__restrict, char **__restrict);
92 size_t	 strxfrm(char *__restrict, const char *__restrict, size_t)
93 		__attribute__ ((__bounded__(__string__,1,3)));
94 
95 #if __XPG_VISIBLE
96 void	*memccpy(void *__restrict, const void *__restrict, int, size_t)
97 		__attribute__ ((__bounded__(__buffer__,1,4)));
98 #endif
99 
100 #if __POSIX_VISIBLE >= 200112
101 int	 strerror_r(int, char *, size_t)
102 	    __attribute__ ((__bounded__(__string__,2,3)));
103 #endif
104 
105 #if __XPG_VISIBLE >= 420 || __POSIX_VISIBLE >= 200809
106 char	*strdup(const char *);
107 #endif
108 
109 #if __POSIX_VISIBLE >= 200809
110 char	*stpcpy(char *__restrict, const char *__restrict);
111 char	*stpncpy(char *__restrict, const char *__restrict, size_t);
112 int	 strcoll_l(const char *, const char *, locale_t);
113 char	*strerror_l(int, locale_t);
114 char	*strndup(const char *, size_t);
115 size_t	 strnlen(const char *, size_t);
116 char	*strsignal(int);
117 size_t	 strxfrm_l(char *__restrict, const char *__restrict, size_t, locale_t)
118 		__attribute__ ((__bounded__(__string__,1,3)));
119 #endif
120 
121 #if __POSIX_VISIBLE >= 202405 || __BSD_VISIBLE
122 void	*memmem(const void *, size_t, const void *, size_t);
123 size_t	 strlcat(char *__restrict, const char *__restrict, size_t)
124 		__attribute__ ((__bounded__(__string__,1,3)));
125 size_t	 strlcpy(char *__restrict, const char *__restrict, size_t)
126 		__attribute__ ((__bounded__(__string__,1,3)));
127 #endif
128 
129 #if __BSD_VISIBLE
130 void	 explicit_bzero(void *, size_t)
131 		__attribute__ ((__bounded__(__buffer__,1,2)));
132 void	*memrchr(const void *, int, size_t);
133 char	*strcasestr(const char *, const char *);
134 void	 strmode(__mode_t, char *);
135 char	*strsep(char **, const char *);
136 int	 timingsafe_bcmp(const void *, const void *, size_t);
137 int	 timingsafe_memcmp(const void *, const void *, size_t);
138 #endif
139 __END_DECLS
140 
141 #endif /* _STRING_H_ */
142