Tue, 28 Mar 2023 21:00:33 +0200
allow NULL for allocator and comparator
/* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ /** * \file printf.h * \brief Wrapper for write functions with a printf-like interface. * \author Mike Becker * \author Olaf Wintermann * \version 3.0 * \copyright 2-Clause BSD License */ #ifndef UCX_PRINTF_H #define UCX_PRINTF_H #include "common.h" #include "string.h" #include <stdarg.h> #ifdef __cplusplus extern "C" { #endif /** * A \c fprintf 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 */ __attribute__((__nonnull__(1, 2, 3), __format__(printf, 3, 4))) int cx_fprintf( void *stream, cx_write_func wfc, char const *fmt, ... ); /** * A \c vfprintf 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 ap argument list * @return the total number of bytes written * @see cx_fprintf() */ __attribute__((__nonnull__)) int cx_vfprintf( void *stream, cx_write_func wfc, char const *fmt, va_list ap ); /** * A \c asprintf like function which allocates space for a string * the result is written to. * * \note The resulting string is guaranteed to be zero-terminated. * * @param allocator the CxAllocator used for allocating the string * @param fmt format string * @param ... additional arguments * @return the formatted string * @see cx_strfree_a() */ __attribute__((__nonnull__(1, 2), __format__(printf, 2, 3))) cxmutstr cx_asprintf_a( CxAllocator *allocator, char const *fmt, ... ); /** * A \c asprintf like function which allocates space for a string * the result is written to. * * \note The resulting string is guaranteed to be zero-terminated. * * @param fmt format string * @param ... additional arguments * @return the formatted string * @see cx_strfree() */ #define cx_asprintf(fmt, ...) \ cx_asprintf_a(cxDefaultAllocator, fmt, __VA_ARGS__) /** * A \c vasprintf like function which allocates space for a string * the result is written to. * * \note The resulting string is guaranteed to be zero-terminated. * * @param allocator the CxAllocator used for allocating the string * @param fmt format string * @param ap argument list * @return the formatted string * @see cx_asprintf_a() */ __attribute__((__nonnull__)) cxmutstr cx_vasprintf_a( CxAllocator *allocator, char const *fmt, va_list ap ); /** * A \c vasprintf like function which allocates space for a string * the result is written to. * * \note The resulting string is guaranteed to be zero-terminated. * * @param fmt format string * @param ap argument list * @return the formatted string * @see cx_asprintf() */ #define cx_vasprintf(fmt, ap) cx_vasprintf_a(cxDefaultAllocator, fmt, ap) /** * A \c printf like function which writes the output to a CxBuffer. * * @param buffer a pointer to the buffer the data is written to * @param fmt the format string * @param ... additional arguments * @return the total number of bytes written * @see ucx_fprintf() */ #define cx_bprintf(buffer, fmt, ...) cx_fprintf((CxBuffer*)buffer, \ (cx_write_func) cxBufferWrite, fmt, __VA_ARGS__) #ifdef __cplusplus } // extern "C" #endif #endif //UCX_PRINTF_H