xref: /aosp_15_r20/external/mesa3d/src/util/u_printf.h (revision 6104692788411f58d303aa86923a9ff6ecaded22)
1 //
2 // Copyright 2020 Serge Martin
3 //
4 // Permission is hereby granted, free of charge, to any person obtaining a
5 // copy of this software and associated documentation files (the "Software"),
6 // to deal in the Software without restriction, including without limitation
7 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 // and/or sell copies of the Software, and to permit persons to whom the
9 // Software is furnished to do so, subject to the following conditions:
10 //
11 // The above copyright notice and this permission notice shall be included in
12 // all copies or substantial portions of the Software.
13 //
14 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 // OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 // OTHER DEALINGS IN THE SOFTWARE.
21 //
22 #ifndef U_PRINTF_H
23 #define U_PRINTF_H
24 
25 #include <stdarg.h>
26 #include <stddef.h>
27 #include <stdio.h>
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
33 typedef struct u_printf_info {
34    unsigned num_args;
35    unsigned *arg_sizes;
36    unsigned string_size;
37    char *strings;
38 } u_printf_info;
39 
40 const char *util_printf_prev_tok(const char *str);
41 
42 /* find next valid printf specifier in a C string wrapper */
43 size_t util_printf_next_spec_pos(const char *str, size_t pos);
44 
45 /* Return the length of the string that would be generated by a printf-style
46  * format and argument list, not including the \0 byte.
47  * The untouched_args parameter is left untouched so it can be re-used by the
48  * caller in a vsnprintf() call or similar.
49  */
50 size_t u_printf_length(const char *fmt, va_list untouched_args);
51 
52 void u_printf(FILE *out, const char *buffer, size_t buffer_size,
53               const u_printf_info*, unsigned info_size);
54 
55 void u_printf_ptr(FILE *out, const char *buffer, size_t buffer_size,
56                   const u_printf_info **info, unsigned info_size);
57 
58 #ifdef __cplusplus
59 }
60 #endif
61 
62 #endif
63