api/printf_8h_source.html

/*

 * 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.

 */


#ifndef UCX_PRINTF_H

#define UCX_PRINTF_H


#include "common.h"

#include "string.h"

#include <stdarg.h>


#define CX_PRINTF_ARGS(fmt_idx, arg_idx) \

    __attribute__((__format__(printf, fmt_idx, arg_idx)))


CX_EXPORT extern const unsigned cx_printf_sbo_size;


CX_EXTERN CX_NONNULL_ARG(1, 2, 3) CX_PRINTF_ARGS(3, 4) CX_CSTR_ARG(3)

int cx_fprintf(void *stream, cx_write_func wfc, const char *fmt, ...);


CX_EXTERN CX_NONNULL CX_CSTR_ARG(3)

int cx_vfprintf(void *stream, cx_write_func wfc, const char *fmt, va_list ap);


CX_EXTERN CX_NONNULL_ARG(1, 2) CX_PRINTF_ARGS(2, 3) CX_CSTR_ARG(2)

cxmutstr cx_asprintf_a(const CxAllocator *allocator, const char *fmt, ...);


#define cx_asprintf(fmt, ...) cx_asprintf_a(cxDefaultAllocator, fmt, __VA_ARGS__)


CX_EXTERN CX_NONNULL CX_CSTR_ARG(2)

cxmutstr cx_vasprintf_a(const CxAllocator *allocator, const char *fmt, va_list ap);


#define cx_vasprintf(fmt, ap) cx_vasprintf_a(cxDefaultAllocator, fmt, ap)


#define cx_bprintf(buffer, fmt, ...) cx_fprintf((void*)buffer, cxBufferWriteFunc, fmt, __VA_ARGS__)


#define cx_sprintf(str, len, fmt, ...) cx_sprintf_a(cxDefaultAllocator, str, len, fmt, __VA_ARGS__)


CX_EXTERN CX_NONNULL_ARG(1, 2, 3, 4) CX_PRINTF_ARGS(4, 5) CX_CSTR_ARG(4)

int cx_sprintf_a(const CxAllocator *alloc, char **str, size_t *len, const char *fmt, ...);


#define cx_vsprintf(str, len, fmt, ap) cx_vsprintf_a(cxDefaultAllocator, str, len, fmt, ap)


CX_EXTERN CX_NONNULL  CX_CSTR_ARG(4) CX_ACCESS_RW(2) CX_ACCESS_RW(3)

int cx_vsprintf_a(const CxAllocator *alloc, char **str, size_t *len, const char *fmt, va_list ap);


#define cx_sprintf_s(buf, len, str, fmt, ...) cx_sprintf_sa(cxDefaultAllocator, buf, len, str, fmt, __VA_ARGS__)


CX_EXTERN CX_NONNULL_ARG(1, 2, 4, 5) CX_PRINTF_ARGS(5, 6) CX_CSTR_ARG(5)

CX_ACCESS_RW(2) CX_ACCESS_RW(3) CX_ACCESS_RW(4)

int cx_sprintf_sa(const CxAllocator *alloc, char *buf, size_t *len, char **str, const char *fmt, ...);


#define cx_vsprintf_s(buf, len, str, fmt, ap) cx_vsprintf_sa(cxDefaultAllocator, buf, len, str, fmt, ap)


CX_EXTERN CX_NONNULL CX_CSTR_ARG(5)

int cx_vsprintf_sa(const CxAllocator *alloc, char *buf, size_t *len, char **str, const char *fmt, va_list ap);


#endif //UCX_PRINTF_H

CxAllocator
struct cx_allocator_s CxAllocator
High-Level type alias for the allocator type.
Definition allocator.h:80

common.h
Common definitions and feature checks.

CX_CSTR_ARG
#define CX_CSTR_ARG(idx)
No support for null_terminated_string_arg in clang or GCC below 14.
Definition common.h:211

cx_write_func
size_t(* cx_write_func)(const void *, size_t, size_t, void *)
Function pointer compatible with fwrite-like functions.
Definition common.h:325

CX_EXPORT
#define CX_EXPORT
Only used for building Windows DLLs.
Definition common.h:289

CX_NONNULL
#define CX_NONNULL
All pointer arguments must be non-NULL.
Definition common.h:141

CX_NONNULL_ARG
#define CX_NONNULL_ARG(...)
The specified pointer arguments must be non-NULL.
Definition common.h:146

CX_EXTERN
#define CX_EXTERN
Declares a function with external linkage.
Definition common.h:297

CX_ACCESS_RW
#define CX_ACCESS_RW(...)
Specifies that the function will read and write through the given pointer.
Definition common.h:238

CX_PRINTF_ARGS
#define CX_PRINTF_ARGS(fmt_idx, arg_idx)
Attribute for printf-like functions.
Definition printf.h:48

cx_vsprintf_sa
int cx_vsprintf_sa(const CxAllocator *alloc, char *buf, size_t *len, char **str, const char *fmt, va_list ap)
An sprintf like function which allocates a new string when the buffer is not large enough.

cx_printf_sbo_size
const unsigned cx_printf_sbo_size
The maximum string length that fits into stack memory.

cx_vfprintf
int cx_vfprintf(void *stream, cx_write_func wfc, const char *fmt, va_list ap)
A vfprintf like function which writes the output to a stream by using a write_func.

cx_asprintf_a
cxmutstr cx_asprintf_a(const CxAllocator *allocator, const char *fmt,...)
An asprintf like function which allocates space for a string the result is written to.

cx_vasprintf_a
cxmutstr cx_vasprintf_a(const CxAllocator *allocator, const char *fmt, va_list ap)
A vasprintf like function which allocates space for a string the result is written to.

cx_vsprintf_a
int cx_vsprintf_a(const CxAllocator *alloc, char **str, size_t *len, const char *fmt, va_list ap)
An sprintf like function which reallocates the string when the buffer is not large enough.

cx_fprintf
int cx_fprintf(void *stream, cx_write_func wfc, const char *fmt,...)
A fprintf like function which writes the output to a stream by using a write_func.

cx_sprintf_a
int cx_sprintf_a(const CxAllocator *alloc, char **str, size_t *len, const char *fmt,...)
An sprintf like function which reallocates the string when the buffer is not large enough.

cx_sprintf_sa
int cx_sprintf_sa(const CxAllocator *alloc, char *buf, size_t *len, char **str, const char *fmt,...)
An sprintf like function which allocates a new string when the buffer is not large enough.

string.h
Strings that know their length.

cxmutstr
struct cx_mutstr_s cxmutstr
A mutable string.
Definition string.h:74