File: string_to_thing.h

package info (click to toggle)
libexplain 1.4.D001-12
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 42,148 kB
  • sloc: ansic: 156,027; makefile: 47,893; sh: 16,303; yacc: 1,898; awk: 245
file content (237 lines) | stat: -rw-r--r-- 6,873 bytes parent folder | download | duplicates (5)
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
/*
 * libexplain - Explain errno values returned by libc functions
 * Copyright (C) 2009, 2012, 2013 Peter Miller
 * Written by Peter Miller <pmiller@opensource.org.au>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef LIBEXPLAIN_STRING_TO_THING_H
#define LIBEXPLAIN_STRING_TO_THING_H

#include <libexplain/ac/stddef.h>
#include <libexplain/ac/sys/socket.h>
#include <libexplain/ac/stdio.h>
#include <libexplain/ac/unistd.h>

/**
  * The explain_string_to_thing function may be used to convert text to
  * a size_t value.
  *
  * @param text
  *    The text to be converted.
  * @returns
  *    On success, a size_t value.  On error, prints an error message
  *    and does not return.
  */
size_t explain_parse_size_t_or_die(const char *text);

/**
  * The explain_parse_ssize_t_or_die function may be used to convert text to
  * a ssize_t value.
  *
  * @param text
  *    The text to be converted.
  * @returns
  *    On success, a ssize_t value.  On error, prints an error message
  *    and does not return.
  */
ssize_t explain_parse_ssize_t_or_die(const char *text);

/**
  * The explain_string_to_thing function may be used to convert text to
  * a ptrdiff_t value.
  *
  * @param text
  *    The text to be converted.
  * @returns
  *    On success, a ptrdiff_t value.  On error, prints an error message
  *    and does not return.
  */
ptrdiff_t explain_parse_ptrdiff_t_or_die(const char *text);

/**
  * The explain_string_to_thing function may be used to convert text to
  * a off_t value.
  *
  * @param text
  *    The text to be converted.
  * @returns
  *    On success, a off_t value.  On error, prints an error message
  *    and does not return.
  */
off_t explain_parse_off_t_or_die(const char *text);

/**
  * The explain_string_to_thing function may be used to convert text to
  * a pointer value.
  *
  * @param text
  *    The text to be converted.
  * @returns
  *    On success, a pointer value.  On error, prints an error message
  *    and does not return.
  */
void *explain_parse_pointer_or_die(const char *text);

/**
  * The explain_parse_long_or_die function may be used to convert text to
  * a long value.
  *
  * @param text
  *    The text to be converted.
  * @returns
  *    On success, a pointer value.  On error, prints an error message
  *    and does not return.
  */
long explain_parse_long_or_die(const char *text);

/**
  * The explain_string_to_ulong function may be used to convert text to
  * an unsigned long value.
  *
  * @param text
  *    The text to be converted.
  * @returns
  *    On success, a pointer value.  On error, prints an error message
  *    and does not return.
  */
unsigned long explain_parse_ulong_or_die(const char *text);

/**
  * The explain_string_to_longlong function may be used to convert text
  * to a long long value.
  *
  * @param text
  *    The text to be converted.
  * @returns
  *    On success, a pointer value.  On error, prints an error message
  *    and does not return.
  */
long long explain_parse_longlong_or_die(const char *text);

/**
  * The explain_string_to_ulonglong function may be used to convert text
  * to an unsigned long long value.
  *
  * @param text
  *    The text to be converted.
  * @returns
  *    On success, a pointer value.  On error, prints an error message
  *    and does not return.
  */
unsigned long long explain_parse_ulonglong_or_die(const char *text);

/**
  * The explain_string_to_socklen_t function may be used to convert text
  * to a socklen_t value.
  *
  * @param text
  *    The text to be converted.
  * @returns
  *    On success, a pointer value.  On error, prints an error message
  *    and does not return.
  */
socklen_t explain_parse_socklen_t_or_die(const char *text);

/**
  * The explain_parse_int_or_die function may be used to convert text
  * to a int value.
  *
  * @param text
  *    The text to be converted.
  * @returns
  *    On success, a pointer value.  On error, prints an error message
  *    and does not return.
  */
int explain_parse_int_or_die(const char *text);

/**
  * The explain_string_to_uint function may be used to convert text to
  * an unsigned int value.
  *
  * @param text
  *    The text to be converted.
  * @returns
  *    On success, a pointer value.  On error, prints an error message
  *    and does not return.
  */
unsigned explain_parse_uint_or_die(const char *text);

/**
  * The explain_string_to_double function may be used to convert text to
  * a double-precision floating-point value.
  *
  * @param text
  *    The text to be converted.
  * @returns
  *    On success, a floating-point value.  On error, prints an error
  *    message and does not return.
  */
double explain_parse_double_or_die(const char *text);

/**
  * The explain_string_to_float function may be used to convert text to
  * a single-precision floating-point value.
  *
  * @param text
  *    The text to be converted.
  * @returns
  *    On success, a floating-point value.  On error, prints an error
  *    message and does not return.
  */
float explain_parse_float_or_die(const char *text);

/**
  * The explain_string_to_long_double function may be used to convert
  * text to a triple-precision floating-point value.
  *
  * @param text
  *    The text to be converted.
  * @returns
  *    On success, a floating-point value.  On error, prints an error
  *    message and does not return.
  */
long double explain_parse_long_double_or_die(const char *text);

/**
  * The explain_parse_uid_t_or_die function may be used to convert text
  * to a user ID.
  *
  * @param text
  *    The text to be converted.
  * @returns
  *    On success, a uid.  On error, prints an error message and does
  *    not return.
  */
uid_t explain_parse_uid_t_or_die(const char *text);

/**
  * The explain_parse_gid_t_or_die function may be used to convert text
  * to a group ID.
  *
  * @param text
  *    The text to be converted.
  * @returns
  *    On success, a gid.  On error, prints an error message and does
  *    not return.
  */
gid_t explain_parse_gid_t_or_die(const char *text);

int explain_parse_bool_or_die(const char * text);

FILE *explain_parse_stream_or_die(const char *text, const char *mode);

#endif /* LIBEXPLAIN_STRING_TO_THING_H */
/* vim: set ts=8 sw=4 et : */