dav: comparison ucx/utils.h

-:5dbef9e07376
+:11dffb40cd91
 */
 /**
 * @file utils.h
 *
-* Common utilities like compare and copy functions.
+* Compare, copy and printf functions.
 *
 * @author Mike Becker
 * @author Olaf Wintermann
 */
 #ifdef	__cplusplus
 extern "C" {
 #endif
 #include "ucx.h"
+#include "string.h"
+#include "allocator.h"
+#include <stdint.h>
 #include <string.h>
+#include <stdarg.h>
 /**
 * Copies a string.
 * @param s the string to copy
 * @param data omitted
 * @return a pointer to a copy of the specified memory area that can
 * be passed to free(void*)
 */
 void *ucx_memcpy(void *m, void *n);
+/**
+* Reads data from a stream and writes it to another stream.
+*
+* @param src the source stream
+* @param dest the destination stream
+* @param rfnc the read function
+* @param wfnc the write function
+* @param buf a pointer to the copy buffer or <code>NULL</code> if a buffer
+* shall be implicitly created on the heap
+* @param bufsize the size of the copy buffer - if <code>NULL</code> was
+* provided for <code>buf</code>, this is the size of the buffer that shall be
+* implicitly created
+* @param n the maximum number of bytes that shall be copied
+* @return the total number of bytes copied
+*/
+size_t ucx_stream_copy(void *src, void *dest, read_func rfnc, write_func wfnc,
+char* buf, size_t bufsize, size_t n);
+/**
+* Shorthand for ucx_stream_copy using the default copy buffer.
+*
+* @param src the source stream
+* @param dest the destination stream
+* @param rfnc the read function
+* @param wfnc the write function
+* @return total number of bytes copied
+*/
+#define ucx_stream_hcopy(src,dest,rfnc,wfnc) ucx_stream_copy(\
+src, dest, (read_func)rfnc, (write_func)wfnc, NULL, 0x100, SIZE_MAX)
+/**
+* Shorthand for ucx_stream_copy using the default copy buffer and a copy limit.
+*
+* @param src the source stream
+* @param dest the destination stream
+* @param rfnc the read function
+* @param wfnc the write function
+* @param n maximum number of bytes that shall be copied
+* @return total number of bytes copied
+*/
+#define ucx_stream_ncopy(src,dest,rfnc,wfnc, n) ucx_stream_copy(\
+src, dest, (read_func)rfnc, (write_func)wfnc, NULL, 0x100, n)
 /**
 * Wraps the strcmp function.
 * @param s1 string one
 * @param s2 string two
 * @param data omitted
 * @param i2 pointer to integer two
 * @param data omitted
 * @return -1, if *i1 is less than *i2, 0 if both are equal,
 * 1 if *i1 is greater than *i2
 */
 int ucx_intcmp(void *i1, void *i2, void *data);
 /**
 * Compares two real numbers of type float.
 * @param f1 pointer to float one
 * @param f2 pointer to float two
-* @param if provided: a pointer to precision (default: 1e-6f)
+* @param data if provided: a pointer to precision (default: 1e-6f)
 * @return -1, if *f1 is less than *f2, 0 if both are equal,
 * 1 if *f1 is greater than *f2
 */
 int ucx_floatcmp(void *f1, void *f2, void *data);
 /**
 * Compares two real numbers of type double.
-* @param f1 pointer to double one
+* @param d1 pointer to double one
-* @param f2 pointer to double two
+* @param d2 pointer to double two
-* @param if provided: a pointer to precision (default: 1e-14)
+* @param data if provided: a pointer to precision (default: 1e-14)
 * @return -1, if *d1 is less than *d2, 0 if both are equal,
 * 1 if *d1 is greater than *d2
 */
 int ucx_doublecmp(void *d1, void *d2, void *data);
 /**
 * Compares two pointers.
 * @param ptr1 pointer one
 * @param n a pointer to the size_t containing the third parameter for memcmp
 * @return the result of memcmp(ptr1, ptr2, *n)
 */
 int ucx_memcmp(void *ptr1, void *ptr2, void *n);
+/**
+* A <code>printf()</code> like function which writes the output to a stream by
+* using a write_func().
+* @param stream the stream the data is written to
+* @param wfc the write function
+* @param fmt format string
+* @param ... additional arguments
+* @return the total number of bytes written
+*/
+int ucx_fprintf(void *stream, write_func wfc, const char *fmt, ...);
+/**
+* <code>va_list</code> version of ucx_fprintf().
+* @param stream the stream the data is written to
+* @param wfc the write function
+* @param fmt format string
+* @param ap argument list
+* @return the total number of bytes written
+* @see ucx_fprintf()
+*/
+int ucx_vfprintf(void *stream, write_func wfc, const char *fmt, va_list ap);
+/**
+* A <code>printf()</code> like function which allocates space for a sstr_t
+* the result is written to.
+*
+* <b>Attention</b>: The sstr_t data is allocated with the allocators
+* ucx_allocator_malloc() function. So it is implementation dependent, if
+* the returned sstr_t.ptr pointer must be passed to the allocators
+* ucx_allocator_free() function manually.
+*
+* <b>Note</b>: The sstr_t.ptr of the return value will <i>always</i> be
+* <code>NULL</code>-terminated.
+*
+* @param allocator the UcxAllocator used for allocating the result sstr_t
+* @param fmt format string
+* @param ... additional arguments
+* @return a sstr_t containing the formatted string
+*/
+sstr_t ucx_asprintf(UcxAllocator *allocator, const char *fmt, ...);
+/**
+* <code>va_list</code> version of ucx_asprintf().
+*
+* @param allocator the UcxAllocator used for allocating the result sstr_t
+* @param fmt format string
+* @param ap argument list
+* @return a sstr_t containing the formatted string
+* @see ucx_asprintf()
+*/
+sstr_t ucx_vasprintf(UcxAllocator *allocator, const char *fmt, va_list ap);
+/**
+* A <code>printf()</code> like function which writes the output to an
+* UcxBuffer.
+*
+* @param buffer the buffer the data is written to
+* @param ... format string and additional arguments
+* @return the total number of bytes written
+* @see ucx_fprintf()
+*/
+#define ucx_bprintf(buffer, ...) ucx_fprintf((UcxBuffer*)buffer, \
+(write_func)ucx_buffer_write, __VA_ARGS__)
 #ifdef	__cplusplus
 }
 #endif
 #endif	/* UCX_UTILS_H */

Mercurial > hg > dav / file comparison

comparison: ucx/utils.h

ucx/utils.h