1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/cx/printf.h Sat Nov 05 17:17:17 2022 +0100
1.3 @@ -0,0 +1,144 @@
1.4 +/*
1.5 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
1.6 + *
1.7 + * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
1.8 + *
1.9 + * Redistribution and use in source and binary forms, with or without
1.10 + * modification, are permitted provided that the following conditions are met:
1.11 + *
1.12 + * 1. Redistributions of source code must retain the above copyright
1.13 + * notice, this list of conditions and the following disclaimer.
1.14 + *
1.15 + * 2. Redistributions in binary form must reproduce the above copyright
1.16 + * notice, this list of conditions and the following disclaimer in the
1.17 + * documentation and/or other materials provided with the distribution.
1.18 + *
1.19 + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
1.20 + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1.21 + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1.22 + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
1.23 + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
1.24 + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
1.25 + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
1.26 + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
1.27 + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
1.28 + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1.29 + * POSSIBILITY OF SUCH DAMAGE.
1.30 + */
1.31 +/**
1.32 + * \file printf.h
1.33 + * \brief Wrapper for write functions with a printf-like interface.
1.34 + * \author Mike Becker
1.35 + * \author Olaf Wintermann
1.36 + * \version 3.0
1.37 + * \copyright 2-Clause BSD License
1.38 + */
1.39 +
1.40 +#ifndef UCX_PRINTF_H
1.41 +#define UCX_PRINTF_H
1.42 +
1.43 +#include "common.h"
1.44 +#include "string.h"
1.45 +#include <stdarg.h>
1.46 +
1.47 +#ifdef __cplusplus
1.48 +extern "C" {
1.49 +#endif
1.50 +
1.51 +/**
1.52 + * A \c fprintf like function which writes the output to a stream by
1.53 + * using a write_func.
1.54 + *
1.55 + * @param stream the stream the data is written to
1.56 + * @param wfc the write function
1.57 + * @param fmt format string
1.58 + * @param ... additional arguments
1.59 + * @return the total number of bytes written
1.60 + */
1.61 +int cx_fprintf(void *stream, cx_write_func wfc, char const *fmt, ...);
1.62 +
1.63 +/**
1.64 + * A \c vfprintf like function which writes the output to a stream by
1.65 + * using a write_func.
1.66 + *
1.67 + * @param stream the stream the data is written to
1.68 + * @param wfc the write function
1.69 + * @param fmt format string
1.70 + * @param ap argument list
1.71 + * @return the total number of bytes written
1.72 + * @see cx_fprintf()
1.73 + */
1.74 +int cx_vfprintf(void *stream, cx_write_func wfc, char const *fmt, va_list ap);
1.75 +
1.76 +/**
1.77 + * A \c asprintf like function which allocates space for a string
1.78 + * the result is written to.
1.79 + *
1.80 + * \note The resulting string is guaranteed to be zero-terminated.
1.81 + *
1.82 + * @param allocator the CxAllocator used for allocating the string
1.83 + * @param fmt format string
1.84 + * @param ... additional arguments
1.85 + * @return the formatted string
1.86 + * @see cx_strfree_a()
1.87 + */
1.88 +cxmutstr cx_asprintf_a(CxAllocator *allocator, char const *fmt, ...);
1.89 +
1.90 +/**
1.91 + * A \c asprintf like function which allocates space for a string
1.92 + * the result is written to.
1.93 + *
1.94 + * \note The resulting string is guaranteed to be zero-terminated.
1.95 + *
1.96 + * @param fmt format string
1.97 + * @param ... additional arguments
1.98 + * @return the formatted string
1.99 + * @see cx_strfree()
1.100 + */
1.101 +#define cx_asprintf(fmt, ...) \
1.102 + cx_asprintf_a(cxDefaultAllocator, fmt, __VA_ARGS__)
1.103 +
1.104 +/**
1.105 +* A \c vasprintf like function which allocates space for a string
1.106 + * the result is written to.
1.107 + *
1.108 + * \note The resulting string is guaranteed to be zero-terminated.
1.109 + *
1.110 + * @param allocator the CxAllocator used for allocating the string
1.111 + * @param fmt format string
1.112 + * @param ap argument list
1.113 + * @return the formatted string
1.114 + * @see cx_asprintf_a()
1.115 + */
1.116 +cxmutstr cx_vasprintf_a(CxAllocator *allocator, char const *fmt, va_list ap);
1.117 +
1.118 +/**
1.119 +* A \c vasprintf like function which allocates space for a string
1.120 + * the result is written to.
1.121 + *
1.122 + * \note The resulting string is guaranteed to be zero-terminated.
1.123 + *
1.124 + * @param fmt format string
1.125 + * @param ap argument list
1.126 + * @return the formatted string
1.127 + * @see cx_asprintf()
1.128 + */
1.129 +#define cx_vasprintf(fmt, ap) cx_vasprintf_a(cxDefaultAllocator, fmt, ap)
1.130 +
1.131 +/**
1.132 + * A \c printf like function which writes the output to a CxBuffer.
1.133 + *
1.134 + * @param buffer the buffer the data is written to
1.135 + * @param fmt the format string
1.136 + * @param ... additional arguments
1.137 + * @return the total number of bytes written
1.138 + * @see ucx_fprintf()
1.139 + */
1.140 +#define cx_bprintf(buffer, fmt, ...) cx_fprintf((CxBuffer*)buffer, \
1.141 + (cx_write_func) cxBufferWrite, fmt, __VA_ARGS__)
1.142 +
1.143 +#ifdef __cplusplus
1.144 +} // extern "C"
1.145 +#endif
1.146 +
1.147 +#endif //UCX_PRINTF_H
