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
|
/**
* slibc — Yet another C library
* Copyright © 2015, 2016 Mattias Andrée (m@maandree.se)
*
* 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/>.
*/
#include <slibc-print.h>
#include <stdarg.h>
/**
* An almost fully generic `printf`-function.
*
* @param write_function Function used to write the string. `NULL` if
* it shall not be printed but only measured.
* @param extension_function Function used to extend the functions formatting codes.
* `NULL` if not extensions are to be used.
* @param maximum_length The maximum amount of bytes to write, including the
* NUL byte, ignored if `limited_length` is zero.
* @param limited_length Whether `maximum_length` shall be used.
* @param actual_length Output parameter for the length of the printed string,
* this includes any text that was truncated but not the
* NUL character. Must not be `NULL`.
* @param terminate Whether a NUL character shall be printed at the end.
* @param data Data to pass to `write_function` and
* `extension_function`, it should contain
* the print-sink, and any state data neccessary
* since the functions may be called multiple times.
* @param format The formatting-string, see `fprintf` for details.
* @param ... The formatting-arguments.
* @return Zero on success, -1 on error. On error, `errno`
* is set to indicate the error.
*
* @throws Any error thrown by `write_function` or `extension_function`.
* @throws EINVAL `format` contained unsupported formatting codes.
*
* @since Always.
*/
int generic_printf(generic_printf_write_func_t write_function, generic_printf_ext_func_t extension_function,
size_t maximum_length, int limited_length, size_t* restrict actual_length, int terminate,
void* data, const char* format, ...)
{
int r;
va_list args;
va_start(args, format);
r = vgeneric_printf(write_function, extension_function, maximum_length,
limited_length, actual_length, terminate, data, format, args);
va_end(args);
return r;
}
/**
* Variant of `generic_printf` that uses `va_list`
* instead of variadic arguments.
*
* @param write_function Function used to write the string. `NULL` if
* it shall not be printed but only measured.
* @param extension_function Function used to extend the functions formatting codes.
* `NULL` if not extensions are to be used.
* @param maximum_length The maximum amount of bytes to write, including the
* NUL byte, ignored if `limited_length` is zero.
* @param limited_length Whether `maximum_length` shall be used.
* @param actual_length Output parameter for the length of the printed string,
* this includes any text that was truncated but not the
* NUL character. Must not be `NULL`.
* @param terminate Whether a NUL character shall be printed at the end.
* @param data Data to pass to `write_function` and
* `extension_function`, it should contain
* the print-sink, and any state data neccessary
* since the functions may be called multiple times.
* @param format The formatting-string, see `fprintf` for details.
* @param args The formatting-arguments.
* @return Zero on success, -1 on error. On error, `errno`
* is set to indicate the error.
*
* @throws Any error thrown by `write_function` or `extension_function`.
* @throws EINVAL `format` contained unsupported formatting codes.
*
* @since Always.
*/
int vgeneric_printf(generic_printf_write_func_t write_function, generic_printf_ext_func_t extension_function,
size_t maximum_length, int limited_length, size_t* restrict actual_length, int terminate,
void* data, const char* format, va_list args)
{
/* TODO vgeneric_printf */
return 0;
(void) write_function;
(void) extension_function;
(void) maximum_length;
(void) limited_length;
(void) actual_length;
(void) terminate;
(void) data;
(void) format;
(void) args;
}
/**
* Variant of `generic_printf` uses `wchar_t` instead of `char`;
*
* @param write_function Function used to write the string. `NULL` if
* it shall not be printed but only measured.
* @param extension_function Function used to extend the functions formatting codes.
* `NULL` if not extensions are to be used.
* @param maximum_length The maximum amount of wide characters to write,
* including the NUL wide character, ignored if
* `limited_length` is zero.
* @param limited_length Whether `maximum_length` shall be used.
* @param actual_length Output parameter for the length of the printed string,
* this includes any text that was truncated but not the
* NUL character. Must not be `NULL`.
* @param terminate Whether a NUL character shall be printed at the end.
* @param data Data to pass to `write_function` and
* `extension_function`, it should contain
* the print-sink, and any state data neccessary
* since the functions may be called multiple times.
* @param format The formatting-string, see `fprintf` for details.
* @param ... The formatting-arguments.
* @return Zero on success, -1 on error. On error, `errno`
* is set to indicate the error.
*
* @throws Any error thrown by `write_function` or `extension_function`.
* @throws EINVAL `format` contained unsupported formatting codes.
*
* @since Always.
*/
int generic_wprintf(generic_wprintf_write_func_t write_function, generic_wprintf_ext_func_t extension_function,
size_t maximum_length, int limited_length, size_t* restrict actual_length, int terminate,
void* data, const wchar_t* format, ...)
{
int r;
va_list args;
va_start(args, format);
r = vgeneric_wprintf(write_function, extension_function, maximum_length,
limited_length, actual_length, terminate, data, format, args);
va_end(args);
return r;
}
/**
* Variant of `generic_wprintf` that uses `va_list`
* instead of variadic arguments.
*
* @param write_function Function used to write the string. `NULL` if
* it shall not be printed but only measured.
* @param extension_function Function used to extend the functions formatting codes.
* `NULL` if not extensions are to be used.
* @param maximum_length The maximum amount of wide characters to write,
* including the NUL wide character, ignored if
* `limited_length` is zero.
* @param limited_length Whether `maximum_length` shall be used.
* @param actual_length Output parameter for the length of the printed string,
* this includes any text that was truncated but not the
* NUL character. Must not be `NULL`.
* @param terminate Whether a NUL character shall be printed at the end.
* @param data Data to pass to `write_function` and
* `extension_function`, it should contain
* the print-sink, and any state data neccessary
* since the functions may be called multiple times.
* @param format The formatting-string, see `fprintf` for details.
* @param ... The formatting-arguments.
* @return Zero on success, -1 on error. On error, `errno`
* is set to indicate the error.
*
* @throws Any error thrown by `write_function` or `extension_function`.
* @throws EINVAL `format` contained unsupported formatting codes.
*
* @since Always.
*/
int vgeneric_wprintf(generic_wprintf_write_func_t write_function, generic_wprintf_ext_func_t extension_function,
size_t maximum_length, int limited_length, size_t* restrict actual_length, int terminate,
void* data, const wchar_t* format, va_list args)
{
/* TODO vgeneric_wprintf */
return 0;
(void) write_function;
(void) extension_function;
(void) maximum_length;
(void) limited_length;
(void) actual_length;
(void) terminate;
(void) data;
(void) format;
(void) args;
}
|
