src/cx/printf.h

Sun, 20 Nov 2022 16:28:03 +0100

author
Mike Becker <universe@uap-core.de>
date
Sun, 20 Nov 2022 16:28:03 +0100
changeset 622
3d93cd78aa20
parent 599
6536a9a75b71
child 635
d4845058239a
permissions
-rw-r--r--

#219 array list: implement compare member func

599
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1 /*
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
3 *
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
4 * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
5 *
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
6 * Redistribution and use in source and binary forms, with or without
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
7 * modification, are permitted provided that the following conditions are met:
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
8 *
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
9 * 1. Redistributions of source code must retain the above copyright
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
10 * notice, this list of conditions and the following disclaimer.
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
11 *
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
12 * 2. Redistributions in binary form must reproduce the above copyright
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
13 * notice, this list of conditions and the following disclaimer in the
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
14 * documentation and/or other materials provided with the distribution.
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
15 *
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
26 * POSSIBILITY OF SUCH DAMAGE.
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
27 */
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
28 /**
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
29 * \file printf.h
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
30 * \brief Wrapper for write functions with a printf-like interface.
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
31 * \author Mike Becker
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
32 * \author Olaf Wintermann
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
33 * \version 3.0
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
34 * \copyright 2-Clause BSD License
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
35 */
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
36
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
37 #ifndef UCX_PRINTF_H
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
38 #define UCX_PRINTF_H
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
39
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
40 #include "common.h"
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
41 #include "string.h"
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
42 #include <stdarg.h>
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
43
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
44 #ifdef __cplusplus
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
45 extern "C" {
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
46 #endif
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
47
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
48 /**
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
49 * A \c fprintf like function which writes the output to a stream by
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
50 * using a write_func.
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
51 *
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
52 * @param stream the stream the data is written to
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
53 * @param wfc the write function
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
54 * @param fmt format string
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
55 * @param ... additional arguments
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
56 * @return the total number of bytes written
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
57 */
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
58 int cx_fprintf(void *stream, cx_write_func wfc, char const *fmt, ...);
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
59
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
60 /**
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
61 * A \c vfprintf like function which writes the output to a stream by
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
62 * using a write_func.
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
63 *
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
64 * @param stream the stream the data is written to
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
65 * @param wfc the write function
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
66 * @param fmt format string
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
67 * @param ap argument list
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
68 * @return the total number of bytes written
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
69 * @see cx_fprintf()
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
70 */
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
71 int cx_vfprintf(void *stream, cx_write_func wfc, char const *fmt, va_list ap);
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
72
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
73 /**
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
74 * A \c asprintf like function which allocates space for a string
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
75 * the result is written to.
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
76 *
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
77 * \note The resulting string is guaranteed to be zero-terminated.
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
78 *
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
79 * @param allocator the CxAllocator used for allocating the string
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
80 * @param fmt format string
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
81 * @param ... additional arguments
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
82 * @return the formatted string
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
83 * @see cx_strfree_a()
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
84 */
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
85 cxmutstr cx_asprintf_a(CxAllocator *allocator, char const *fmt, ...);
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
86
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
87 /**
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
88 * A \c asprintf like function which allocates space for a string
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
89 * the result is written to.
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
90 *
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
91 * \note The resulting string is guaranteed to be zero-terminated.
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
92 *
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
93 * @param fmt format string
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
94 * @param ... additional arguments
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
95 * @return the formatted string
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
96 * @see cx_strfree()
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
97 */
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
98 #define cx_asprintf(fmt, ...) \
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
99 cx_asprintf_a(cxDefaultAllocator, fmt, __VA_ARGS__)
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
100
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
101 /**
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
102 * A \c vasprintf like function which allocates space for a string
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
103 * the result is written to.
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
104 *
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
105 * \note The resulting string is guaranteed to be zero-terminated.
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
106 *
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
107 * @param allocator the CxAllocator used for allocating the string
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
108 * @param fmt format string
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
109 * @param ap argument list
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
110 * @return the formatted string
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
111 * @see cx_asprintf_a()
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
112 */
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
113 cxmutstr cx_vasprintf_a(CxAllocator *allocator, char const *fmt, va_list ap);
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
114
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
115 /**
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
116 * A \c vasprintf like function which allocates space for a string
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
117 * the result is written to.
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
118 *
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
119 * \note The resulting string is guaranteed to be zero-terminated.
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
120 *
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
121 * @param fmt format string
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
122 * @param ap argument list
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
123 * @return the formatted string
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
124 * @see cx_asprintf()
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
125 */
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
126 #define cx_vasprintf(fmt, ap) cx_vasprintf_a(cxDefaultAllocator, fmt, ap)
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
127
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
128 /**
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
129 * A \c printf like function which writes the output to a CxBuffer.
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
130 *
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
131 * @param buffer the buffer the data is written to
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
132 * @param fmt the format string
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
133 * @param ... additional arguments
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
134 * @return the total number of bytes written
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
135 * @see ucx_fprintf()
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
136 */
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
137 #define cx_bprintf(buffer, fmt, ...) cx_fprintf((CxBuffer*)buffer, \
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
138 (cx_write_func) cxBufferWrite, fmt, __VA_ARGS__)
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
139
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
140 #ifdef __cplusplus
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
141 } // extern "C"
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
142 #endif
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
143
6536a9a75b71 #222 add printf-like functions
Mike Becker <universe@uap-core.de>
parents:
diff changeset
144 #endif //UCX_PRINTF_H

mercurial