diff --git a/lib/common/cmp_debug.c b/lib/common/cmp_debug.c new file mode 100644 index 0000000000000000000000000000000000000000..db1645d40c8a4bef8d44cb91c91949fa33dded0f --- /dev/null +++ b/lib/common/cmp_debug.c @@ -0,0 +1,87 @@ +/** + * @file cmp_debug.c + * @author Dominik Loidolt (dominik.loidolt@univie.ac.at) + * @date 2024 + * + * @copyright GPLv2 + * This program is free software; you can redistribute it and/or modify it + * under the terms and conditions of the GNU General Public License, + * version 2, as published by the Free Software Foundation. + * + * This program is distributed in the hope it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * @brief compression/decompression debugging printing functions + */ + + +#ifndef ICU_ASW +# include <stdio.h> +#endif +#include <string.h> +#include <stdarg.h> + +#include "cmp_debug.h" +#include "compiler.h" +#include "vsnprintf.h" + + +/** + * @brief outputs a debug string + * + * This function outputs a string for debugging purposes + * + * @param str The string to output + */ + +static void cmp_debug_puts(const char *str) +{ +#ifdef ICU_ASW + /* XXX adapt it to your needs */ + /* asw_puts(str); */ + (void)str; +#else + fputs(str, stderr); + fputs("\n", stderr); +#endif +} + + +/** + * @brief implements debug printing + * + * This function formats a string and prints it for debugging. It uses a static + * buffer to format the string + * + * @param fmt pointer to a null-terminated byte string specifying how to + * interpret the data + * @param ... arguments specifying data to print + */ + +void cmp_debug_print_impl(const char *fmt, ...) +{ + static char print_buffer[PRINT_BUFFER_SIZE]; + int len; + va_list args; + + va_start(args, fmt); + len = my_vsnprintf(print_buffer, sizeof(print_buffer)-1, fmt, args); + va_end(args); + + if (len < 0) { + const char str[] = "my_snprintf is broken"; + + compile_time_assert(sizeof(str) <= sizeof(print_buffer), CMP_DEBUG_PRINT_BUFFER_SIZE_TO_SMALL); + memcpy(print_buffer, str, sizeof(str)); + } + if ((size_t)len >= sizeof(print_buffer)-1) { + const char str[] = "cmp_debug print_buffer too small"; + + compile_time_assert(sizeof(str) <= sizeof(print_buffer), CMP_DEBUG_PRINT_BUFFER_SIZE_TO_SMALL); + memcpy(print_buffer, str, sizeof(str)); + } + + cmp_debug_puts(print_buffer); +} diff --git a/lib/common/cmp_debug.h b/lib/common/cmp_debug.h index f95dc2e96964cef2ba81c41f8d1675740606c42a..df599117bf614d4f09b377e0e8d74c84db94d52d 100644 --- a/lib/common/cmp_debug.h +++ b/lib/common/cmp_debug.h @@ -13,7 +13,7 @@ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for * more details. * - * @brief compression/decompression debugging defines + * @brief compression/decompression debugging printing functions */ #ifndef CMP_DEBUG_H @@ -26,17 +26,16 @@ # define DEBUGLEVEL 0 #endif -#if !defined(ICU_ASW) && (defined(DEBUG) || DEBUGLEVEL > 0) - #include <stdio.h> - __extension__ - #define debug_print(...) \ - do { \ - fprintf(stderr, __VA_ARGS__); \ - fprintf(stderr, "\n"); \ - } while (0) + +#define PRINT_BUFFER_SIZE 256 + +__extension__ +#if (defined(DEBUG) || DEBUGLEVEL > 0) +# define debug_print(...) cmp_debug_print_impl(__VA_ARGS__) #else - #define debug_print(...) \ - do {} while (0) +# define debug_print(...) do {} while (0) #endif +void cmp_debug_print_impl(const char *fmt, ...); + #endif /* CMP_DEBUG_H */ diff --git a/lib/common/compiler.h b/lib/common/compiler.h index 983ffa46d046fa6bafbf102a8271387741ea0c6c..dc6e7a90ab577f01f4918d82576bba0144a54ffa 100644 --- a/lib/common/compiler.h +++ b/lib/common/compiler.h @@ -37,13 +37,6 @@ #endif -/** - * Compile time check usable outside of function scope. - * Stolen from Linux (hpi_internal.h) - */ -#define compile_time_assert(cond, msg) typedef char ASSERT_##msg[(cond) ? 1 : -1] - - /** * same with the stuff below */ @@ -127,7 +120,7 @@ * It also tries to prevent the actual use of the "unused" variables. */ -#if GNUC_PREREQ(4, 5) +#if GNUC_PREREQ(4, 5) || defined(__clang__) #define UNUSED __attribute__((unused)) \ __attribute__((deprecated ("parameter declared as UNUSED"))) #elif defined(__GNUC__) @@ -154,4 +147,11 @@ #endif +/** + * Compile time check usable outside of function scope. + * Stolen from Linux (hpi_internal.h) + */ +#define compile_time_assert(cond, msg) UNUSED typedef char ASSERT_##msg[(cond) ? 1 : -1] + + #endif /* COMPILER_H */ diff --git a/lib/common/meson.build b/lib/common/meson.build index c4d8b68cca24c0148eddfc042604639d236760dd..f24b91bfd2db2b20694b5f6fd2312f2a448e26a9 100644 --- a/lib/common/meson.build +++ b/lib/common/meson.build @@ -1,6 +1,8 @@ common_sources = files([ 'cmp_data_types.c', + 'cmp_debug.c', 'cmp_entity.c', 'cmp_max_used_bits.c', - 'cmp_support.c' + 'cmp_support.c', + 'vsnprintf.c' ]) diff --git a/lib/common/vsnprintf.c b/lib/common/vsnprintf.c new file mode 100644 index 0000000000000000000000000000000000000000..ef5cc57887f13a8a4ae200ea77043c11992efd6d --- /dev/null +++ b/lib/common/vsnprintf.c @@ -0,0 +1,885 @@ +/* + * @author (c) Marco Paland (info@paland.com) + * 2014-2019, PALANDesign Hannover, Germany + * + * @license The MIT License (MIT) + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + * + * @brief Tiny vsnprintf implementation, optimized for speed on embedded systems + * with a very limited resources. These routines are thread safe and + * reentrant! + */ + +#include <stdbool.h> +#include <stdint.h> +#include <stddef.h> +#include <stdarg.h> +#include <math.h> + +#include "vsnprintf.h" + +#define PRINTF_DISABLE_SUPPORT_EXPONENTIAL + +/* + * define this globally (e.g. gcc -DPRINTF_INCLUDE_CONFIG_H ...) to include the + * printf_config.h header file + * default: undefined + */ +#ifdef PRINTF_INCLUDE_CONFIG_H +#include "printf_config.h" +#endif + + +/* + * 'ntoa' conversion buffer size, this must be big enough to hold one converted + * numeric number including padded zeros (dynamically created on stack) + * default: 32 byte + */ +#ifndef PRINTF_NTOA_BUFFER_SIZE +#define PRINTF_NTOA_BUFFER_SIZE 32U +#endif + +/* + * 'ftoa' conversion buffer size, this must be big enough to hold one converted + * float number including padded zeros (dynamically created on stack) + * default: 32 byte + */ +#ifndef PRINTF_FTOA_BUFFER_SIZE +#define PRINTF_FTOA_BUFFER_SIZE 32U +#endif + +/* + * support for the floating point type (%f) + * default: activated + */ +#ifndef PRINTF_DISABLE_SUPPORT_FLOAT +#define PRINTF_SUPPORT_FLOAT +#endif + +/* + * support for exponential floating point notation (%e/%g) + * default: + */ +#ifndef PRINTF_DISABLE_SUPPORT_EXPONENTIAL +#define PRINTF_SUPPORT_EXPONENTIAL +#endif + +/* + * define the default floating point precision + * default: 6 digits + */ +#ifndef PRINTF_DEFAULT_FLOAT_PRECISION +#define PRINTF_DEFAULT_FLOAT_PRECISION 6U +#endif + +/* + * define the largest float suitable to print with %f + * default: 1e9 + */ +#ifndef PRINTF_MAX_FLOAT +#define PRINTF_MAX_FLOAT 1e9 +#endif + +/* + * support for the long long types (%llu or %p) + * default: activated + */ +#ifndef PRINTF_DISABLE_SUPPORT_LONG_LONG +#define PRINTF_SUPPORT_LONG_LONG +#endif + +/* + * support for the ptrdiff_t type (%t) + * ptrdiff_t is normally defined in <stddef.h> as long or long long type + * default: activated + */ +#ifndef PRINTF_DISABLE_SUPPORT_PTRDIFF_T +#define PRINTF_SUPPORT_PTRDIFF_T +#endif + + +/* internal flag definitions */ +#define FLAGS_ZEROPAD (1U << 0U) +#define FLAGS_LEFT (1U << 1U) +#define FLAGS_PLUS (1U << 2U) +#define FLAGS_SPACE (1U << 3U) +#define FLAGS_HASH (1U << 4U) +#define FLAGS_UPPERCASE (1U << 5U) +#define FLAGS_CHAR (1U << 6U) +#define FLAGS_SHORT (1U << 7U) +#define FLAGS_LONG (1U << 8U) +#define FLAGS_LONG_LONG (1U << 9U) +#define FLAGS_PRECISION (1U << 10U) +#define FLAGS_ADAPT_EXP (1U << 11U) + + +/* import float.h for DBL_MAX */ +#if defined(PRINTF_SUPPORT_FLOAT) +#include <float.h> +#endif + + +/* output function type */ +typedef void (*out_fct_type)(char character, void* buffer, size_t idx, size_t maxlen); + + +/* wrapper (used as buffer) for output function type */ +typedef struct { + void (*fct)(char character, void* arg); + void* arg; +} out_fct_wrap_type; + + +/* internal buffer output */ +static inline void _out_buffer(char character, void* buffer, size_t idx, size_t maxlen) +{ + if (idx < maxlen) { + ((char*)buffer)[idx] = character; + } +} + +/* internal null output */ +static inline void _out_null(char character, void* buffer, size_t idx, size_t maxlen) +{ + (void)character; (void)buffer; (void)idx; (void)maxlen; +} + + +/* + * internal secure strlen + * @returns The length of the string (excluding the terminating 0) limited by 'maxsize' + */ +static inline unsigned int _strnlen_s(const char* str, size_t maxsize) +{ + const char* s; + for (s = str; *s && maxsize--; ++s); + return (unsigned int)(s - str); +} + + +/* + * internal test if char is a digit (0-9) + * @returns true if char is a digit + */ +static inline bool _is_digit(char ch) +{ + return (ch >= '0') && (ch <= '9'); +} + + +/* internal ASCII string to unsigned int conversion */ +static unsigned int _atoi(const char** str) +{ + unsigned int i = 0U; + while (_is_digit(**str)) { + i = i * 10U + (unsigned int)(*((*str)++) - '0'); + } + return i; +} + + +/* output the specified string in reverse, taking care of any zero-padding */ +static size_t _out_rev(out_fct_type out, char* buffer, size_t idx, size_t maxlen, const char* buf, size_t len, unsigned int width, unsigned int flags) +{ + const size_t start_idx = idx; + + /* pad spaces up to given width */ + if (!(flags & FLAGS_LEFT) && !(flags & FLAGS_ZEROPAD)) { + size_t i; + for (i = len; i < width; i++) { + out(' ', buffer, idx++, maxlen); + } + } + + /* reverse string */ + while (len) { + out(buf[--len], buffer, idx++, maxlen); + } + + /* append pad spaces up to given width */ + if (flags & FLAGS_LEFT) { + while (idx - start_idx < width) { + out(' ', buffer, idx++, maxlen); + } + } + + return idx; +} + + +/* internal itoa format */ +static size_t _ntoa_format(out_fct_type out, char* buffer, size_t idx, size_t maxlen, char* buf, size_t len, bool negative, unsigned int base, unsigned int prec, unsigned int width, unsigned int flags) +{ + /* pad leading zeros */ + if (!(flags & FLAGS_LEFT)) { + if (width && (flags & FLAGS_ZEROPAD) && (negative || (flags & (FLAGS_PLUS | FLAGS_SPACE)))) { + width--; + } + while ((len < prec) && (len < PRINTF_NTOA_BUFFER_SIZE)) { + buf[len++] = '0'; + } + while ((flags & FLAGS_ZEROPAD) && (len < width) && (len < PRINTF_NTOA_BUFFER_SIZE)) { + buf[len++] = '0'; + } + } + + /* handle hash */ + if (flags & FLAGS_HASH) { + if (!(flags & FLAGS_PRECISION) && len && ((len == prec) || (len == width))) { + len--; + if (len && (base == 16U)) { + len--; + } + } + if ((base == 16U) && !(flags & FLAGS_UPPERCASE) && (len < PRINTF_NTOA_BUFFER_SIZE)) { + buf[len++] = 'x'; + } + else if ((base == 16U) && (flags & FLAGS_UPPERCASE) && (len < PRINTF_NTOA_BUFFER_SIZE)) { + buf[len++] = 'X'; + } + else if ((base == 2U) && (len < PRINTF_NTOA_BUFFER_SIZE)) { + buf[len++] = 'b'; + } + if (len < PRINTF_NTOA_BUFFER_SIZE) { + buf[len++] = '0'; + } + } + + if (len < PRINTF_NTOA_BUFFER_SIZE) { + if (negative) { + buf[len++] = '-'; + } + else if (flags & FLAGS_PLUS) { + buf[len++] = '+'; /* ignore the space if the '+' exists */ + } + else if (flags & FLAGS_SPACE) { + buf[len++] = ' '; + } + } + + return _out_rev(out, buffer, idx, maxlen, buf, len, width, flags); +} + + +/* internal itoa for 'long' type */ +static size_t _ntoa_long(out_fct_type out, char* buffer, size_t idx, size_t maxlen, unsigned long value, bool negative, unsigned long base, unsigned int prec, unsigned int width, unsigned int flags) +{ + char buf[PRINTF_NTOA_BUFFER_SIZE]; + size_t len = 0U; + + /* no hash for 0 values */ + if (!value) { + flags &= ~FLAGS_HASH; + } + + /* write if precision != 0 and value is != 0 */ + if (!(flags & FLAGS_PRECISION) || value) { + do { + const char digit = (char)(value % base); + buf[len++] = digit < 10 ? '0' + digit : (flags & FLAGS_UPPERCASE ? 'A' : 'a') + digit - 10; + value /= base; + } while (value && (len < PRINTF_NTOA_BUFFER_SIZE)); + } + + return _ntoa_format(out, buffer, idx, maxlen, buf, len, negative, (unsigned int)base, prec, width, flags); +} + + +/* internal itoa for 'long long' type */ +#if defined(PRINTF_SUPPORT_LONG_LONG) +static size_t _ntoa_long_long(out_fct_type out, char* buffer, size_t idx, size_t maxlen, unsigned long long value, bool negative, unsigned long long base, unsigned int prec, unsigned int width, unsigned int flags) +{ + char buf[PRINTF_NTOA_BUFFER_SIZE]; + size_t len = 0U; + + /* no hash for 0 values */ + if (!value) { + flags &= ~FLAGS_HASH; + } + + /* write if precision != 0 and value is != 0 */ + if (!(flags & FLAGS_PRECISION) || value) { + do { + const char digit = (char)(value % base); + buf[len++] = digit < 10 ? '0' + digit : (flags & FLAGS_UPPERCASE ? 'A' : 'a') + digit - 10; + value /= base; + } while (value && (len < PRINTF_NTOA_BUFFER_SIZE)); + } + + return _ntoa_format(out, buffer, idx, maxlen, buf, len, negative, (unsigned int)base, prec, width, flags); +} +#endif /* PRINTF_SUPPORT_LONG_LONG */ + + +#if defined(PRINTF_SUPPORT_FLOAT) + +#if defined(PRINTF_SUPPORT_EXPONENTIAL) +/* forward declaration so that _ftoa can switch to exp notation for values > PRINTF_MAX_FLOAT */ +static size_t _etoa(out_fct_type out, char* buffer, size_t idx, size_t maxlen, double value, unsigned int prec, unsigned int width, unsigned int flags); +#endif + + +/* internal ftoa for fixed decimal floating point */ +static size_t _ftoa(out_fct_type out, char* buffer, size_t idx, size_t maxlen, double value, unsigned int prec, unsigned int width, unsigned int flags) +{ + char buf[PRINTF_FTOA_BUFFER_SIZE]; + size_t len = 0U; + double diff = 0.0; + bool negative = false; + int whole; + double tmp; + unsigned long frac; + + /* powers of 10 */ + static const double pow10[] = { 1, 10, 100, 1000, 10000, 100000, 1000000, 10000000, 100000000, 1000000000 }; + + /* test for special values */ + if (isnan(value)) + return _out_rev(out, buffer, idx, maxlen, "nan", 3, width, flags); + if (value < -DBL_MAX) + return _out_rev(out, buffer, idx, maxlen, "fni-", 4, width, flags); + if (value > DBL_MAX) + return _out_rev(out, buffer, idx, maxlen, (flags & FLAGS_PLUS) ? "fni+" : "fni", (flags & FLAGS_PLUS) ? 4U : 3U, width, flags); + + /* test for very large values */ + /* standard printf behavior is to print EVERY whole number digit -- which could be 100s of characters overflowing your buffers == bad */ + if ((value > PRINTF_MAX_FLOAT) || (value < -PRINTF_MAX_FLOAT)) { +#if defined(PRINTF_SUPPORT_EXPONENTIAL) + return _etoa(out, buffer, idx, maxlen, value, prec, width, flags); +#else + return 0U; +#endif + } + + /* test for negative */ + if (value < 0) { + negative = true; + value = 0 - value; + } + + /* set default precision, if not set explicitly */ + if (!(flags & FLAGS_PRECISION)) { + prec = PRINTF_DEFAULT_FLOAT_PRECISION; + } + /* limit precision to 9, cause a prec >= 10 can lead to overflow errors */ + while ((len < PRINTF_FTOA_BUFFER_SIZE) && (prec > 9U)) { + buf[len++] = '0'; + prec--; + } + + whole = (int)value; + tmp = (value - whole) * pow10[prec]; + frac = (unsigned long)tmp; + diff = tmp - (double)frac; + + if (diff > 0.5) { + ++frac; + /* handle rollover, e.g. case 0.99 with prec 1 is 1.0 */ + if ((double)frac >= pow10[prec]) { + frac = 0; + ++whole; + } + } + else if (diff < 0.5) { + } + else if ((frac == 0U) || (frac & 1U)) { + /* if halfway, round up if odd OR if last digit is 0 */ + ++frac; + } + + if (prec == 0U) { + diff = value - (double)whole; + if ((!(diff < 0.5) || (diff > 0.5)) && (whole & 1)) { + /* exactly 0.5 and ODD, then round up */ + /* 1.5 -> 2, but 2.5 -> 2 */ + ++whole; + } + } + else { + unsigned int count = prec; + /* now do fractional part, as an unsigned number */ + while (len < PRINTF_FTOA_BUFFER_SIZE) { + --count; + buf[len++] = (char)(48U + (frac % 10U)); + if (!(frac /= 10U)) { + break; + } + } + /* add extra 0s */ + while ((len < PRINTF_FTOA_BUFFER_SIZE) && (count-- > 0U)) { + buf[len++] = '0'; + } + if (len < PRINTF_FTOA_BUFFER_SIZE) { + /* add decimal */ + buf[len++] = '.'; + } + } + + /* do whole part, number is reversed */ + while (len < PRINTF_FTOA_BUFFER_SIZE) { + buf[len++] = (char)(48 + (whole % 10)); + if (!(whole /= 10)) { + break; + } + } + + /* pad leading zeros */ + if (!(flags & FLAGS_LEFT) && (flags & FLAGS_ZEROPAD)) { + if (width && (negative || (flags & (FLAGS_PLUS | FLAGS_SPACE)))) { + width--; + } + while ((len < width) && (len < PRINTF_FTOA_BUFFER_SIZE)) { + buf[len++] = '0'; + } + } + + if (len < PRINTF_FTOA_BUFFER_SIZE) { + if (negative) { + buf[len++] = '-'; + } + else if (flags & FLAGS_PLUS) { + buf[len++] = '+'; /* ignore the space if the '+' exists */ + } + else if (flags & FLAGS_SPACE) { + buf[len++] = ' '; + } + } + + return _out_rev(out, buffer, idx, maxlen, buf, len, width, flags); +} + + +#if defined(PRINTF_SUPPORT_EXPONENTIAL) +/* internal ftoa variant for exponential floating-point type, contributed by Martijn Jasperse <m.jasperse@gmail.com> */ +static size_t _etoa(out_fct_type out, char* buffer, size_t idx, size_t maxlen, double value, unsigned int prec, unsigned int width, unsigned int flags) +{ + const bool negative = value < 0; + union { + uint64_t U; + double F; + } conv; + int exp2, expval; + double z, z2; + unsigned int minwidth, fwidth; + size_t start_idx; + + /* check for NaN and special values */ + if ((value != value || (value > DBL_MAX) || (value < -DBL_MAX)) { + return _ftoa(out, buffer, idx, maxlen, value, prec, width, flags); + } + + /* determine the sign */ + if (value < 0) { + value = -value; + } + + /* default precision */ + if (!(flags & FLAGS_PRECISION)) { + prec = PRINTF_DEFAULT_FLOAT_PRECISION; + } + + /* determine the decimal exponent */ + /* based on the algorithm by David Gay (https://www.ampl.com/netlib/fp/dtoa.c) */ + conv.F = value; + exp2 = (int)((conv.U >> 52U) & 0x07FFU) - 1023; /* effectively log2 */ + conv.U = (conv.U & ((1ULL << 52U) - 1U)) | (1023ULL << 52U); /* drop the exponent so conv.F is now in [1,2) */ + /* now approximate log10 from the log2 integer part and an expansion of ln around 1.5 */ + expval = (int)(0.1760912590558 + exp2 * 0.301029995663981 + (conv.F - 1.5) * 0.289529654602168); + /* now we want to compute 10^expval but we want to be sure it won't overflow */ + exp2 = (int)(expval * 3.321928094887362 + 0.5); + z = expval * 2.302585092994046 - exp2 * 0.6931471805599453; + z2 = z * z; + conv.U = (uint64_t)(exp2 + 1023) << 52U; + /* compute exp(z) using continued fractions, see https://en.wikipedia.org/wiki/Exponential_function#Continued_fractions_for_ex */ + conv.F *= 1 + 2 * z / (2 - z + (z2 / (6 + (z2 / (10 + z2 / 14))))); + /* correct for rounding errors */ + if (value < conv.F) { + expval--; + conv.F /= 10; + } + + /* the exponent format is "%+03d" and largest value is "307", so set aside 4-5 characters */ + minwidth = ((expval < 100) && (expval > -100)) ? 4U : 5U; + + /* in "%g" mode, "prec" is the number of *significant figures* not decimals */ + if (flags & FLAGS_ADAPT_EXP) { + /* do we want to fall-back to "%f" mode? */ + if ((value >= 1e-4) && (value < 1e6)) { + if ((int)prec > expval) { + prec = (unsigned)((int)prec - expval - 1); + } + else { + prec = 0; + } + flags |= FLAGS_PRECISION; /* make sure _ftoa respects precision */ + /* no characters in exponent */ + minwidth = 0U; + expval = 0; + } + else { + /* we use one sigfig for the whole part */ + if ((prec > 0) && (flags & FLAGS_PRECISION)) { + --prec; + } + } + } + + /* will everything fit? */ + fwidth = width; + if (width > minwidth) { + /* we didn't fall-back so subtract the characters required for the exponent */ + fwidth -= minwidth; + } else { + /* not enough characters, so go back to default sizing */ + fwidth = 0U; + } + if ((flags & FLAGS_LEFT) && minwidth) { + /* if we're padding on the right, DON'T pad the floating part */ + fwidth = 0U; + } + + /* rescale the float value */ + if (expval) { + value /= conv.F; + } + + /* output the floating part */ + start_idx = idx; + idx = _ftoa(out, buffer, idx, maxlen, negative ? -value : value, prec, fwidth, flags & ~FLAGS_ADAPT_EXP); + + /* output the exponent part */ + if (minwidth) { + /* output the exponential symbol */ + out((flags & FLAGS_UPPERCASE) ? 'E' : 'e', buffer, idx++, maxlen); + /* output the exponent value */ + idx = _ntoa_long(out, buffer, idx, maxlen, (expval < 0) ? -expval : expval, expval < 0, 10, 0, minwidth-1, FLAGS_ZEROPAD | FLAGS_PLUS); + /* might need to right-pad spaces */ + if (flags & FLAGS_LEFT) { + while (idx - start_idx < width) out(' ', buffer, idx++, maxlen); + } + } + return idx; +} +#endif /* PRINTF_SUPPORT_EXPONENTIAL */ +#endif /* PRINTF_SUPPORT_FLOAT */ + + +/* internal vsnprintf */ +static int _vsnprintf(out_fct_type out, char* buffer, const size_t maxlen, const char* format, va_list va) +{ + unsigned int flags, width, precision, n; + size_t idx = 0U; + + if (!buffer) { + /* use null output function */ + out = _out_null; + } + + while (*format) + { + /* format specifier? %[flags][width][.precision][length] */ + if (*format != '%') { + /* no */ + out(*format, buffer, idx++, maxlen); + format++; + continue; + } + else { + /* yes, evaluate it */ + format++; + } + + /* evaluate flags */ + flags = 0U; + do { + switch (*format) { + case '0': flags |= FLAGS_ZEROPAD; format++; n = 1U; break; + case '-': flags |= FLAGS_LEFT; format++; n = 1U; break; + case '+': flags |= FLAGS_PLUS; format++; n = 1U; break; + case ' ': flags |= FLAGS_SPACE; format++; n = 1U; break; + case '#': flags |= FLAGS_HASH; format++; n = 1U; break; + default : n = 0U; break; + } + } while (n); + + /* evaluate width field */ + width = 0U; + if (_is_digit(*format)) { + width = _atoi(&format); + } + else if (*format == '*') { + const int w = va_arg(va, int); + if (w < 0) { + flags |= FLAGS_LEFT; /* reverse padding */ + width = (unsigned int)-w; + } + else { + width = (unsigned int)w; + } + format++; + } + + /* evaluate precision field */ + precision = 0U; + if (*format == '.') { + flags |= FLAGS_PRECISION; + format++; + if (_is_digit(*format)) { + precision = _atoi(&format); + } + else if (*format == '*') { + const int prec = (int)va_arg(va, int); + precision = prec > 0 ? (unsigned int)prec : 0U; + format++; + } + } + + /* evaluate length field */ + switch (*format) { + case 'l' : + flags |= FLAGS_LONG; + format++; + if (*format == 'l') { + flags |= FLAGS_LONG_LONG; + format++; + } + break; + case 'h' : + flags |= FLAGS_SHORT; + format++; + if (*format == 'h') { + flags |= FLAGS_CHAR; + format++; + } + break; +#if defined(PRINTF_SUPPORT_PTRDIFF_T) + case 't' : + flags |= (sizeof(ptrdiff_t) == sizeof(long) ? FLAGS_LONG : FLAGS_LONG_LONG); + format++; + break; +#endif + case 'j' : + flags |= (sizeof(intmax_t) == sizeof(long) ? FLAGS_LONG : FLAGS_LONG_LONG); + format++; + break; + case 'z' : + flags |= (sizeof(size_t) == sizeof(long) ? FLAGS_LONG : FLAGS_LONG_LONG); + format++; + break; + default : + break; + } + + /* evaluate specifier */ + switch (*format) { + case 'd' : + case 'i' : + case 'u' : + case 'x' : + case 'X' : + case 'o' : + case 'b' : { + /* set the base */ + unsigned int base; + if (*format == 'x' || *format == 'X') { + base = 16U; + } + else if (*format == 'o') { + base = 8U; + } + else if (*format == 'b') { + base = 2U; + } + else { + base = 10U; + flags &= ~FLAGS_HASH; /* no hash for dec format */ + } + /* uppercase */ + if (*format == 'X') { + flags |= FLAGS_UPPERCASE; + } + + /* no plus or space flag for u, x, X, o, b */ + if ((*format != 'i') && (*format != 'd')) { + flags &= ~(FLAGS_PLUS | FLAGS_SPACE); + } + + /* ignore '0' flag when precision is given */ + if (flags & FLAGS_PRECISION) { + flags &= ~FLAGS_ZEROPAD; + } + + /* convert the integer */ + if ((*format == 'i') || (*format == 'd')) { + /* signed */ + if (flags & FLAGS_LONG_LONG) { +#if defined(PRINTF_SUPPORT_LONG_LONG) + const long long value = va_arg(va, long long); + idx = _ntoa_long_long(out, buffer, idx, maxlen, (unsigned long long)(value > 0 ? value : 0 - value), value < 0, base, precision, width, flags); +#endif + } + else if (flags & FLAGS_LONG) { + const long value = va_arg(va, long); + idx = _ntoa_long(out, buffer, idx, maxlen, (unsigned long)(value > 0 ? value : 0 - value), value < 0, base, precision, width, flags); + } + else { + const int value = (flags & FLAGS_CHAR) ? (char)va_arg(va, int) : (flags & FLAGS_SHORT) ? (short int)va_arg(va, int) : va_arg(va, int); + idx = _ntoa_long(out, buffer, idx, maxlen, (unsigned int)(value > 0 ? value : 0 - value), value < 0, base, precision, width, flags); + } + } + else { + /* unsigned */ + if (flags & FLAGS_LONG_LONG) { +#if defined(PRINTF_SUPPORT_LONG_LONG) + idx = _ntoa_long_long(out, buffer, idx, maxlen, va_arg(va, unsigned long long), false, base, precision, width, flags); +#endif + } + else if (flags & FLAGS_LONG) { + idx = _ntoa_long(out, buffer, idx, maxlen, va_arg(va, unsigned long), false, base, precision, width, flags); + } + else { + const unsigned int value = (flags & FLAGS_CHAR) ? (unsigned char)va_arg(va, unsigned int) : (flags & FLAGS_SHORT) ? (unsigned short int)va_arg(va, unsigned int) : va_arg(va, unsigned int); + idx = _ntoa_long(out, buffer, idx, maxlen, value, false, base, precision, width, flags); + } + } + format++; + break; + } +#if defined(PRINTF_SUPPORT_FLOAT) + case 'f' : + case 'F' : + if (*format == 'F') flags |= FLAGS_UPPERCASE; + idx = _ftoa(out, buffer, idx, maxlen, va_arg(va, double), precision, width, flags); + format++; + break; +#if defined(PRINTF_SUPPORT_EXPONENTIAL) + case 'e': + case 'E': + case 'g': + case 'G': + if ((*format == 'g')||(*format == 'G')) flags |= FLAGS_ADAPT_EXP; + if ((*format == 'E')||(*format == 'G')) flags |= FLAGS_UPPERCASE; + idx = _etoa(out, buffer, idx, maxlen, va_arg(va, double), precision, width, flags); + format++; + break; +#endif /* PRINTF_SUPPORT_EXPONENTIAL */ +#endif /* PRINTF_SUPPORT_FLOAT */ + case 'c' : { + unsigned int l = 1U; + /* pre padding */ + if (!(flags & FLAGS_LEFT)) { + while (l++ < width) { + out(' ', buffer, idx++, maxlen); + } + } + /* char output */ + out((char)va_arg(va, int), buffer, idx++, maxlen); + /* post padding */ + if (flags & FLAGS_LEFT) { + while (l++ < width) { + out(' ', buffer, idx++, maxlen); + } + } + format++; + break; + } + + case 's' : { + const char* p = va_arg(va, char*); + unsigned int l = _strnlen_s(p, precision ? precision : (size_t)-1); + /* pre padding */ + if (flags & FLAGS_PRECISION) { + l = (l < precision ? l : precision); + } + if (!(flags & FLAGS_LEFT)) { + while (l++ < width) { + out(' ', buffer, idx++, maxlen); + } + } + /* string output */ + while ((*p != 0) && (!(flags & FLAGS_PRECISION) || precision--)) { + out(*(p++), buffer, idx++, maxlen); + } + /* post padding */ + if (flags & FLAGS_LEFT) { + while (l++ < width) { + out(' ', buffer, idx++, maxlen); + } + } + format++; + break; + } + + case 'p' : { + width = sizeof(void*) * 2U; + flags |= FLAGS_ZEROPAD | FLAGS_UPPERCASE; +#if defined(PRINTF_SUPPORT_LONG_LONG) + if (sizeof(uintptr_t) == sizeof(long long)) { + idx = _ntoa_long_long(out, buffer, idx, maxlen, (uintptr_t)va_arg(va, void*), false, 16U, precision, width, flags); + } + else { +#endif + idx = _ntoa_long(out, buffer, idx, maxlen, (unsigned long)((uintptr_t)va_arg(va, void*)), false, 16U, precision, width, flags); +#if defined(PRINTF_SUPPORT_LONG_LONG) + } +#endif + format++; + break; + } + + case '%' : + out('%', buffer, idx++, maxlen); + format++; + break; + + default : + out(*format, buffer, idx++, maxlen); + format++; + break; + } + } + + /* termination */ + out((char)0, buffer, idx < maxlen ? idx : maxlen - 1U, maxlen); + + /* return written chars without terminating \0 */ + return (int)idx; +} + + +/** + * @brief Custom vsnprintf function + * + * This function attempts to write to a buffer with a given size + * It is a wrapper around the a vsnprintf function + * + * @param buffer buffer to write the output + * @param count maximum number of characters to write + * @param format format string + * @param va variable argument list + * + * @return The number of characters written, or a negative value if an error occurs + */ + +int my_vsnprintf(char* buffer, size_t count, const char* format, va_list va) +{ + return _vsnprintf(_out_buffer, buffer, count, format, va); +} + diff --git a/lib/common/vsnprintf.h b/lib/common/vsnprintf.h new file mode 100644 index 0000000000000000000000000000000000000000..8b04ab66f6073027359eb37053a0184a53e5b079 --- /dev/null +++ b/lib/common/vsnprintf.h @@ -0,0 +1,25 @@ +/** + * @file vsnprintf.h + * @author Dominik Loidolt (dominik.loidolt@univie.ac.at) + * @date 2024 + * + * @copyright GPLv2 + * This program is free software; you can redistribute it and/or modify it + * under the terms and conditions of the GNU General Public License, + * version 2, as published by the Free Software Foundation. + * + * This program is distributed in the hope it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * @brief Tiny vsnprintf implementation + */ + + +#ifndef VSNPRINTF_H +#define VSNPRINTF_H + +int my_vsnprintf(char* buffer, size_t count, const char* format, va_list va); + +#endif /* VSNPRINTF_H */