Mercurial > hg > toolkit / file comparison

comparison: ucx/ucx/utils.h

ucx/ucx/utils.h

changeset 157
0b33b9396851
child 162
18892c0a9adc
equal deleted inserted replaced
156:62f1a55535e7 157:0b33b9396851
1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 2017 Mike Becker, Olaf Wintermann All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
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 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 /**
30 * @file utils.h
31 *
32 * Compare, copy and printf functions.
33 *
34 * @author Mike Becker
35 * @author Olaf Wintermann
36 */
37
38 #ifndef UCX_UTILS_H
39 #define UCX_UTILS_H
40
41 #include "ucx.h"
42 #include "string.h"
43 #include "allocator.h"
44 #include <inttypes.h>
45 #include <string.h>
46 #include <stdarg.h>
47
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51
52 /**
53 * Default buffer size for ucx_stream_copy() and ucx_stream_ncopy().
54 */
55 #define UCX_STREAM_COPY_BUFSIZE 4096
56
57 /**
58 * Copies a string.
59 * @param s the string to copy
60 * @param data omitted
61 * @return a pointer to a copy of s1 that can be passed to free(void*)
62 */
63 void *ucx_strcpy(const void *s, void *data);
64
65 /**
66 * Copies a memory area.
67 * @param m a pointer to the memory area
68 * @param n a pointer to the size_t containing the size of the memory area
69 * @return a pointer to a copy of the specified memory area that can
70 * be passed to free(void*)
71 */
72 void *ucx_memcpy(const void *m, void *n);
73
74
75 /**
76 * Reads data from a stream and writes it to another stream.
77 *
78 * @param src the source stream
79 * @param dest the destination stream
80 * @param rfnc the read function
81 * @param wfnc the write function
82 * @param buf a pointer to the copy buffer or <code>NULL</code> if a buffer
83 * shall be implicitly created on the heap
84 * @param bufsize the size of the copy buffer - if <code>NULL</code> was
85 * provided for <code>buf</code>, this is the size of the buffer that shall be
86 * implicitly created
87 * @param n the maximum number of bytes that shall be copied
88 * @return the total number of bytes copied
89 */
90 size_t ucx_stream_bncopy(void *src, void *dest, read_func rfnc, write_func wfnc,
91 char* buf, size_t bufsize, size_t n);
92
93 /**
94 * Shorthand for an unbounded ucx_stream_bncopy call using a default buffer.
95 *
96 * @param src the source stream
97 * @param dest the destination stream
98 * @param rfnc the read function
99 * @param wfnc the write function
100 * @return total number of bytes copied
101 *
102 * @see #UCX_STREAM_COPY_BUFSIZE
103 */
104 #define ucx_stream_copy(src,dest,rfnc,wfnc) ucx_stream_bncopy(\
105 src, dest, (read_func)rfnc, (write_func)wfnc, \
106 NULL, UCX_STREAM_COPY_BUFSIZE, (size_t)-1)
107
108 /**
109 * Shorthand for ucx_stream_bncopy using a default copy buffer.
110 *
111 * @param src the source stream
112 * @param dest the destination stream
113 * @param rfnc the read function
114 * @param wfnc the write function
115 * @param n maximum number of bytes that shall be copied
116 * @return total number of bytes copied
117 */
118 #define ucx_stream_ncopy(src,dest,rfnc,wfnc, n) ucx_stream_bncopy(\
119 src, dest, (read_func)rfnc, (write_func)wfnc, \
120 NULL, UCX_STREAM_COPY_BUFSIZE, n)
121
122 /**
123 * Shorthand for an unbounded ucx_stream_bncopy call using the specified buffer.
124 *
125 * @param src the source stream
126 * @param dest the destination stream
127 * @param rfnc the read function
128 * @param wfnc the write function
129 * @param buf a pointer to the copy buffer or <code>NULL</code> if a buffer
130 * shall be implicitly created on the heap
131 * @param bufsize the size of the copy buffer - if <code>NULL</code> was
132 * provided for <code>buf</code>, this is the size of the buffer that shall be
133 * implicitly created
134 * @return total number of bytes copied
135 */
136 #define ucx_stream_bcopy(src,dest,rfnc,wfnc, buf, bufsize) ucx_stream_bncopy(\
137 src, dest, (read_func)rfnc, (write_func)wfnc, \
138 buf, bufsize, (size_t)-1)
139
140 /**
141 * Wraps the strcmp function.
142 * @param s1 string one
143 * @param s2 string two
144 * @param data omitted
145 * @return the result of strcmp(s1, s2)
146 */
147 int ucx_cmp_str(const void *s1, const void *s2, void *data);
148
149 /**
150 * Wraps the strncmp function.
151 * @param s1 string one
152 * @param s2 string two
153 * @param n a pointer to the size_t containing the third strncmp parameter
154 * @return the result of strncmp(s1, s2, *n)
155 */
156 int ucx_cmp_strn(const void *s1, const void *s2, void *n);
157
158 /**
159 * Wraps the sstrcmp function.
160 * @param s1 sstr one
161 * @param s2 sstr two
162 * @param data ignored
163 * @return the result of sstrcmp(s1, s2)
164 */
165 int ucx_cmp_sstr(const void *s1, const void *s2, void *data);
166
167 /**
168 * Compares two integers of type int.
169 * @param i1 pointer to integer one
170 * @param i2 pointer to integer two
171 * @param data omitted
172 * @return -1, if *i1 is less than *i2, 0 if both are equal,
173 * 1 if *i1 is greater than *i2
174 */
175 int ucx_cmp_int(const void *i1, const void *i2, void *data);
176
177 /**
178 * Compares two integers of type long int.
179 * @param i1 pointer to long integer one
180 * @param i2 pointer to long integer two
181 * @param data omitted
182 * @return -1, if *i1 is less than *i2, 0 if both are equal,
183 * 1 if *i1 is greater than *i2
184 */
185 int ucx_cmp_longint(const void *i1, const void *i2, void *data);
186
187
188 /**
189 * Distance function for integers of type int.
190 * @param i1 pointer to integer one
191 * @param i2 pointer to integer two
192 * @param data omitted
193 * @return i1 minus i2
194 */
195 intmax_t ucx_dist_int(const void *i1, const void *i2, void *data);
196
197 /**
198 * Distance function for integers of type long int.
199 * @param i1 pointer to long integer one
200 * @param i2 pointer to long integer two
201 * @param data omitted
202 * @return i1 minus i2
203 */
204 intmax_t ucx_dist_longint(const void *i1, const void *i2, void *data);
205
206 /**
207 * Compares two real numbers of type float.
208 * @param f1 pointer to float one
209 * @param f2 pointer to float two
210 * @param data if provided: a pointer to precision (default: 1e-6f)
211 * @return -1, if *f1 is less than *f2, 0 if both are equal,
212 * 1 if *f1 is greater than *f2
213 */
214
215 int ucx_cmp_float(const void *f1, const void *f2, void *data);
216
217 /**
218 * Compares two real numbers of type double.
219 * @param d1 pointer to double one
220 * @param d2 pointer to double two
221 * @param data if provided: a pointer to precision (default: 1e-14)
222 * @return -1, if *d1 is less than *d2, 0 if both are equal,
223 * 1 if *d1 is greater than *d2
224 */
225 int ucx_cmp_double(const void *d1, const void *d2, void *data);
226
227 /**
228 * Compares two pointers.
229 * @param ptr1 pointer one
230 * @param ptr2 pointer two
231 * @param data omitted
232 * @return -1 if ptr1 is less than ptr2, 0 if both are equal,
233 * 1 if ptr1 is greater than ptr2
234 */
235 int ucx_cmp_ptr(const void *ptr1, const void *ptr2, void *data);
236
237 /**
238 * Compares two memory areas.
239 * @param ptr1 pointer one
240 * @param ptr2 pointer two
241 * @param n a pointer to the size_t containing the third parameter for memcmp
242 * @return the result of memcmp(ptr1, ptr2, *n)
243 */
244 int ucx_cmp_mem(const void *ptr1, const void *ptr2, void *n);
245
246 /**
247 * A <code>printf()</code> like function which writes the output to a stream by
248 * using a write_func().
249 * @param stream the stream the data is written to
250 * @param wfc the write function
251 * @param fmt format string
252 * @param ... additional arguments
253 * @return the total number of bytes written
254 */
255 int ucx_fprintf(void *stream, write_func wfc, const char *fmt, ...);
256
257 /**
258 * <code>va_list</code> version of ucx_fprintf().
259 * @param stream the stream the data is written to
260 * @param wfc the write function
261 * @param fmt format string
262 * @param ap argument list
263 * @return the total number of bytes written
264 * @see ucx_fprintf()
265 */
266 int ucx_vfprintf(void *stream, write_func wfc, const char *fmt, va_list ap);
267
268 /**
269 * A <code>printf()</code> like function which allocates space for a sstr_t
270 * the result is written to.
271 *
272 * <b>Attention</b>: The sstr_t data is allocated with the allocators
273 * ucx_allocator_malloc() function. So it is implementation dependent, if
274 * the returned sstr_t.ptr pointer must be passed to the allocators
275 * ucx_allocator_free() function manually.
276 *
277 * <b>Note</b>: The sstr_t.ptr of the return value will <i>always</i> be
278 * <code>NULL</code>-terminated.
279 *
280 * @param allocator the UcxAllocator used for allocating the result sstr_t
281 * @param fmt format string
282 * @param ... additional arguments
283 * @return a sstr_t containing the formatted string
284 */
285 sstr_t ucx_asprintf(UcxAllocator *allocator, const char *fmt, ...);
286
287 /**
288 * <code>va_list</code> version of ucx_asprintf().
289 *
290 * @param allocator the UcxAllocator used for allocating the result sstr_t
291 * @param fmt format string
292 * @param ap argument list
293 * @return a sstr_t containing the formatted string
294 * @see ucx_asprintf()
295 */
296 sstr_t ucx_vasprintf(UcxAllocator *allocator, const char *fmt, va_list ap);
297
298 /** Shortcut for ucx_asprintf() with default allocator. */
299 #define ucx_sprintf(...) \
300 ucx_asprintf(ucx_default_allocator(), __VA_ARGS__)
301
302 /**
303 * A <code>printf()</code> like function which writes the output to a
304 * UcxBuffer.
305 *
306 * @param buffer the buffer the data is written to
307 * @param ... format string and additional arguments
308 * @return the total number of bytes written
309 * @see ucx_fprintf()
310 */
311 #define ucx_bprintf(buffer, ...) ucx_fprintf((UcxBuffer*)buffer, \
312 (write_func)ucx_buffer_write, __VA_ARGS__)
313
314 #ifdef __cplusplus
315 }
316 #endif
317
318 #endif /* UCX_UTILS_H */
319

Mercurial Repository: toolkit

mercurial