1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
/**
* slibc — Yet another C library
* Copyright © 2015 Mattias Andrée (maandree@member.fsf.org)
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef _STRINGS_H
#define _STRINGS_H
#include <slibc/version.h>
#include <slibc/features.h>
#define __NEED_size_t
#define __NEED_locale_t
#include <bits/types.h>
/**
* Override a memory segment with zeroes.
*
* @etymology (B)uffer: (zero) out.
*
* @param segment The memory segment to override.
* @param size The size of the memory segment.
*/
void bzero(void*, size_t)
__deprecated("Use 'memset', 'explicit_bzero' or 'secure_free' instead.");
#if defined(__SLIBC_SOURCE) || defined(__BSD_SOURCE)
/**
* Override a memory segment with zeroes.
*
* Unlike `bzero` and `memset`, calls to this function
* cannot be removed, as an optimisation, by the compiler.
*
* @etymology (Explicit) version of (`bzero`).
*
* @param segment The memory segment to override.
* @param size The size of the memory segment.
*/
void explicit_bzero(void*, size_t);
#endif
/**
* Copy a memory segment to another, possibly overlapping, segment.
*
* @etymology (B)uffer: (copy).
*
* @param whence The source memory segment.
* @param whither The destination memory segment.
* @param size The number of bytes to copy.
*/
void bcopy(const void*, void*, size_t)
__deprecated("Use 'memmove', or similar function, instead, but be aware of reordered parameters.");
/**
* This function is identical to `memcmp`.
*
* @etymology (B)uffer: (c)o(mp)are.
*/
int bcmp(const void*, const void*, size_t)
__deprecated("Use 'memcmp' instead.")
__GCC_ONLY(__attribute__((__warn_unused_result__, __pure__)));
/**
* Compare two strings alphabetically in a case insensitive manner.
* Be aware, only ASCII characters are case insensitive, non-ASCII
* characters are case sensitive.
*
* @etymology (Str)ing-function: (case) insensitive (c)o(mp)arison.
*
* @param a A negative value is returned if this is the lesser.
* @param b A positive value is returned if this is the lesser.
* @return Zero is returned if `a` and `b` are equal, otherwise,
* see the specifications for `a` and `b`.
*/
int strcasecmp(const char*, const char*)
__GCC_ONLY(__attribute__((__warn_unused_result__, __nonnull__, __pure__)));
/**
* Compare two strings alphabetically in a case insensitive manner.
* Be aware, only ASCII characters are case insensitive, non-ASCII
* characters are case sensitive.
*
* @etymology (Str)ing-function: (n)-bytes, (case) insensitive (c)o(mp)arison.
*
* @param a A negative value is returned if this is the lesser.
* @param b A positive value is returned if this is the lesser.
* @param length The maximum number of characters to compare.
* @return Zero is returned if `a` and `b` are equal, otherwise,
* see the specifications for `a` and `b`.
*/
int strncasecmp(const char*, const char*, size_t)
__GCC_ONLY(__attribute__((__warn_unused_result__, __nonnull__, __pure__)));
/**
* Compare two strings alphabetically in a case insensitive manner.
* Be aware, only ASCII characters are case insensitive, non-ASCII
* characters are case sensitive.
*
* @etymology (`strcasecmp`) variant with (l)ocale-consideration.
*
* @param a A negative value is returned if this is the lesser.
* @param b A positive value is returned if this is the lesser.
* @param locale The locale.
* @return Zero is returned if `a` and `b` are equal, otherwise,
* see the specifications for `a` and `b`.
*/
int strcasecmp_l(const char*, const char*, locale_t) /* TODO */
__GCC_ONLY(__attribute__((__warn_unused_result__, __nonnull__, __pure__)));
/**
* Compare two strings alphabetically in a case insensitive manner.
* Be aware, only ASCII characters are case insensitive, non-ASCII
* characters are case sensitive.
*
* @etymology (`strncasecmp`) variant with (l)ocale-consideration.
*
* @param a A negative value is returned if this is the lesser.
* @param b A positive value is returned if this is the lesser.
* @param length The maximum number of characters to compare.
* @param locale The locale.
* @return Zero is returned if `a` and `b` are equal, otherwise,
* see the specifications for `a` and `b`.
*/
int strncasecmp_l(const char*, const char*, size_t, locale_t) /* TODO */
__GCC_ONLY(__attribute__((__warn_unused_result__, __nonnull__, __pure__)));
/**
* This function is identical to `strchr`.
*
* This is a deprecated BSD extension.
*
* @etymology (Index) of character.
*/
char* index(const char*, int)
__deprecated("Use 'strchr' instead.")
__GCC_ONLY(__attribute__((__warn_unused_result__, __nonnull__, __pure__)));
#ifdef __CONST_CORRECT
# define index(...) (__const_correct(index, __VA_ARGS__))
#endif
/**
* This function is identical to `strrchr`.
*
* This is a deprecated BSD extension.
*
* @etymology (R)ight-most (index) of character.
*/
char* rindex(const char*, int)
__deprecated("Use 'strrchr' instead.")
__GCC_ONLY(__attribute__((__warn_unused_result__, __nonnull__, __pure__)));
#ifdef __CONST_CORRECT
# define rindex(...) (__const_correct(rindex, __VA_ARGS__))
#endif
/**
* Find the first set bit in an integer.
*
* @etymology (F)ind (f)irst (s)et bit on `int`.
*
* @param i The integer.
* @return The value of the least significant set bit, zero if none.
*/
int ffs(int)
__GCC_ONLY(__attribute__((__warn_unused_result__, __const__)));
/**
* Find the first set bit in an integer.
*
* @etymology (F)ind (f)irst (s)et bit on `(l)ong int`.
*
* @param i The integer.
* @return The value of the least significant set bit, zero if none.
*/
int ffsl(long)
__GCC_ONLY(__attribute__((__warn_unused_result__, __const__)));
/**
* Find the first set bit in an integer.
*
* @etymology (F)ind (f)irst (s)et bit on `(l)ong (l)ong int`.
*
* @param i The integer.
* @return The value of the least significant set bit, zero if none.
*/
int ffsll(long long)
__GCC_ONLY(__attribute__((__warn_unused_result__, __const__)));
#endif
|
