cbprintf.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_SYS_CBPRINTF_H_
#define ZEPHYR_INCLUDE_SYS_CBPRINTF_H_
 
#include <stdarg.h>
#include <stddef.h>
#include <stdint.h>
#include <toolchain.h>
 
#ifdef CONFIG_CBPRINTF_LIBC_SUBSTS
#include <stdio.h>
#endif /* CONFIG_CBPRINTF_LIBC_SUBSTS */
 
/* Determine if _Generic is supported.
 * In general it's a C11 feature but it is supported in releases after:
 * - GCC 4.9.0 https://gcc.gnu.org/gcc-4.9/changes.html
 * - Clang 3.8 Introduced in 3.0 (https://releases.llvm.org/3.0/docs/ClangReleaseNotes.html)
 *   but with bug (http://www.open-std.org/jtc1/sc22/wg14/www/docs/summary.htm#dr_481)
 *   that was fixed in 3.8.
 *
 * @note Z_C_GENERIC is also set for C++ where functionality is implemented
 * using overloading and templates.
 */
#ifndef Z_C_GENERIC
#if defined(__cplusplus) || (((__STDC_VERSION__ >= 201112L) || \
        ((__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__) >= 40900) || \
        ((__clang_major__ * 10000 + __clang_minor__ * 100 + __clang_patchlevel__) >= 30800)))
#define Z_C_GENERIC 1
#else
#define Z_C_GENERIC 0
#endif
#endif
 
/* Z_C_GENERIC is used there */
#include <sys/cbprintf_internal.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifdef __xtensa__
#define CBPRINTF_PACKAGE_ALIGNMENT 16
#elif defined(CONFIG_X86) && !defined(CONFIG_64BIT)
/* sizeof(long double) is 12 on x86-32, which is not power of 2.
 * So set it manually.
 */
#define CBPRINTF_PACKAGE_ALIGNMENT \
        (IS_ENABLED(CONFIG_CBPRINTF_PACKAGE_LONGDOUBLE) ? \
                16 : MAX(sizeof(double), sizeof(long long)))
#else
#define CBPRINTF_PACKAGE_ALIGNMENT \
        (IS_ENABLED(CONFIG_CBPRINTF_PACKAGE_LONGDOUBLE) ? \
                sizeof(long double) : MAX(sizeof(double), sizeof(long long)))
#endif
 
#define CBPRINTF_PACKAGE_ADD_STRING_IDXS BIT(0)
 
#define CBPRINTF_MUST_RUNTIME_PACKAGE_CONST_CHAR BIT(0)
 
typedef int (*cbprintf_cb)(/* int c, void *ctx */);
 
typedef int (*cbvprintf_exteral_formatter_func)(cbprintf_cb out, void *ctx,
                                                const char *fmt, va_list ap);
 
#define CBPRINTF_MUST_RUNTIME_PACKAGE(skip, flags, ... /* fmt, ... */) \
        Z_CBPRINTF_MUST_RUNTIME_PACKAGE(skip, flags, __VA_ARGS__)
 
#define CBPRINTF_STATIC_PACKAGE(packaged, inlen, outlen, align_offset, flags, \
                                ... /* fmt, ... */) \
        Z_CBPRINTF_STATIC_PACKAGE(packaged, inlen, outlen, \
                                  align_offset, flags, __VA_ARGS__)
 
__printf_like(4, 5)
int cbprintf_package(void *packaged,
                     size_t len,
                     uint32_t flags,
                     const char *format,
                     ...);
 
int cbvprintf_package(void *packaged,
                      size_t len,
                      uint32_t flags,
                      const char *format,
                      va_list ap);
 
int cbprintf_fsc_package(void *in_packaged,
                         size_t in_len,
                         void *packaged,
                         size_t len);
 
int cbpprintf_external(cbprintf_cb out,
                       cbvprintf_exteral_formatter_func formatter,
                       void *ctx,
                       void *packaged);
 
__printf_like(3, 4)
int cbprintf(cbprintf_cb out, void *ctx, const char *format, ...);
 
int cbvprintf(cbprintf_cb out, void *ctx, const char *format, va_list ap);
 
static inline
int cbpprintf(cbprintf_cb out, void *ctx, void *packaged)
{
        return cbpprintf_external(out, cbvprintf, ctx, packaged);
}
 
#ifdef CONFIG_CBPRINTF_LIBC_SUBSTS
 
__printf_like(2, 3)
int fprintfcb(FILE * stream, const char *format, ...);
 
int vfprintfcb(FILE *stream, const char *format, va_list ap);
 
__printf_like(1, 2)
int printfcb(const char *format, ...);
 
int vprintfcb(const char *format, va_list ap);
 
__printf_like(3, 4)
int snprintfcb(char *str, size_t size, const char *format, ...);
 
int vsnprintfcb(char *str, size_t size, const char *format, va_list ap);
 
#endif /* CONFIG_CBPRINTF_LIBC_SUBSTS */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_SYS_CBPRINTF_H_ */