1 /* |
|
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
|
3 * |
|
4 * Copyright 2016 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 #ifdef __cplusplus |
|
42 extern "C" { |
|
43 #endif |
|
44 |
|
45 #include "ucx.h" |
|
46 #include "string.h" |
|
47 #include "allocator.h" |
|
48 #include <inttypes.h> |
|
49 #include <string.h> |
|
50 #include <stdarg.h> |
|
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(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(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_strcmp(void *s1, 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_strncmp(void *s1, void *s2, void *n); |
|
157 |
|
158 /** |
|
159 * Compares two integers of type int. |
|
160 * @param i1 pointer to integer one |
|
161 * @param i2 pointer to integer two |
|
162 * @param data omitted |
|
163 * @return -1, if *i1 is less than *i2, 0 if both are equal, |
|
164 * 1 if *i1 is greater than *i2 |
|
165 */ |
|
166 int ucx_intcmp(void *i1, void *i2, void *data); |
|
167 |
|
168 /** |
|
169 * Compares two real numbers of type float. |
|
170 * @param f1 pointer to float one |
|
171 * @param f2 pointer to float two |
|
172 * @param data if provided: a pointer to precision (default: 1e-6f) |
|
173 * @return -1, if *f1 is less than *f2, 0 if both are equal, |
|
174 * 1 if *f1 is greater than *f2 |
|
175 */ |
|
176 |
|
177 int ucx_floatcmp(void *f1, void *f2, void *data); |
|
178 |
|
179 /** |
|
180 * Compares two real numbers of type double. |
|
181 * @param d1 pointer to double one |
|
182 * @param d2 pointer to double two |
|
183 * @param data if provided: a pointer to precision (default: 1e-14) |
|
184 * @return -1, if *d1 is less than *d2, 0 if both are equal, |
|
185 * 1 if *d1 is greater than *d2 |
|
186 */ |
|
187 int ucx_doublecmp(void *d1, void *d2, void *data); |
|
188 |
|
189 /** |
|
190 * Compares two pointers. |
|
191 * @param ptr1 pointer one |
|
192 * @param ptr2 pointer two |
|
193 * @param data omitted |
|
194 * @return -1 if ptr1 is less than ptr2, 0 if both are equal, |
|
195 * 1 if ptr1 is greater than ptr2 |
|
196 */ |
|
197 int ucx_ptrcmp(void *ptr1, void *ptr2, void *data); |
|
198 |
|
199 /** |
|
200 * Compares two memory areas. |
|
201 * @param ptr1 pointer one |
|
202 * @param ptr2 pointer two |
|
203 * @param n a pointer to the size_t containing the third parameter for memcmp |
|
204 * @return the result of memcmp(ptr1, ptr2, *n) |
|
205 */ |
|
206 int ucx_memcmp(void *ptr1, void *ptr2, void *n); |
|
207 |
|
208 /** |
|
209 * A <code>printf()</code> like function which writes the output to a stream by |
|
210 * using a write_func(). |
|
211 * @param stream the stream the data is written to |
|
212 * @param wfc the write function |
|
213 * @param fmt format string |
|
214 * @param ... additional arguments |
|
215 * @return the total number of bytes written |
|
216 */ |
|
217 int ucx_fprintf(void *stream, write_func wfc, const char *fmt, ...); |
|
218 |
|
219 /** |
|
220 * <code>va_list</code> version of ucx_fprintf(). |
|
221 * @param stream the stream the data is written to |
|
222 * @param wfc the write function |
|
223 * @param fmt format string |
|
224 * @param ap argument list |
|
225 * @return the total number of bytes written |
|
226 * @see ucx_fprintf() |
|
227 */ |
|
228 int ucx_vfprintf(void *stream, write_func wfc, const char *fmt, va_list ap); |
|
229 |
|
230 /** |
|
231 * A <code>printf()</code> like function which allocates space for a sstr_t |
|
232 * the result is written to. |
|
233 * |
|
234 * <b>Attention</b>: The sstr_t data is allocated with the allocators |
|
235 * ucx_allocator_malloc() function. So it is implementation dependent, if |
|
236 * the returned sstr_t.ptr pointer must be passed to the allocators |
|
237 * ucx_allocator_free() function manually. |
|
238 * |
|
239 * <b>Note</b>: The sstr_t.ptr of the return value will <i>always</i> be |
|
240 * <code>NULL</code>-terminated. |
|
241 * |
|
242 * @param allocator the UcxAllocator used for allocating the result sstr_t |
|
243 * @param fmt format string |
|
244 * @param ... additional arguments |
|
245 * @return a sstr_t containing the formatted string |
|
246 */ |
|
247 sstr_t ucx_asprintf(UcxAllocator *allocator, const char *fmt, ...); |
|
248 |
|
249 /** |
|
250 * <code>va_list</code> version of ucx_asprintf(). |
|
251 * |
|
252 * @param allocator the UcxAllocator used for allocating the result sstr_t |
|
253 * @param fmt format string |
|
254 * @param ap argument list |
|
255 * @return a sstr_t containing the formatted string |
|
256 * @see ucx_asprintf() |
|
257 */ |
|
258 sstr_t ucx_vasprintf(UcxAllocator *allocator, const char *fmt, va_list ap); |
|
259 |
|
260 /** Shortcut for ucx_asprintf() with default allocator. */ |
|
261 #define ucx_sprintf(...) \ |
|
262 ucx_asprintf(ucx_default_allocator(), __VA_ARGS__) |
|
263 |
|
264 /** |
|
265 * A <code>printf()</code> like function which writes the output to a |
|
266 * UcxBuffer. |
|
267 * |
|
268 * @param buffer the buffer the data is written to |
|
269 * @param ... format string and additional arguments |
|
270 * @return the total number of bytes written |
|
271 * @see ucx_fprintf() |
|
272 */ |
|
273 #define ucx_bprintf(buffer, ...) ucx_fprintf((UcxBuffer*)buffer, \ |
|
274 (write_func)ucx_buffer_write, __VA_ARGS__) |
|
275 |
|
276 #ifdef __cplusplus |
|
277 } |
|
278 #endif |
|
279 |
|
280 #endif /* UCX_UTILS_H */ |
|
281 |
|