First version
[3rdparty/ote_partner/tlk.git] / include / printf.h
1 /*
2  * Copyright (c) 2008 Travis Geiselbrecht
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining
5  * a copy of this software and associated documentation files
6  * (the "Software"), to deal in the Software without restriction,
7  * including without limitation the rights to use, copy, modify, merge,
8  * publish, distribute, sublicense, and/or sell copies of the Software,
9  * and to permit persons to whom the Software is furnished to do so,
10  * subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be
13  * included in all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
18  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
19  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
20  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
21  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22  */
23 #ifndef __LIB_PRINTF_H
24 #define __LIB_PRINTF_H
25
26 #include <stdarg.h>
27 #include <compiler.h>
28 #include <debug.h>
29 #include <stddef.h>
30
31 #if defined(__cplusplus)
32 extern "C" {
33 #endif
34
35 #if !DISABLE_DEBUG_OUTPUT
36 #define printf(x...) _printf(x)
37 #else
38 static inline int __PRINTFLIKE(1, 2) printf(const char *fmt, ...) { return 0; }
39 #endif
40
41 int _printf(const char *fmt, ...) __PRINTFLIKE(1, 2);
42 int sprintf(char *str, const char *fmt, ...) __PRINTFLIKE(2, 3);
43 int snprintf(char *str, size_t len, const char *fmt, ...) __PRINTFLIKE(3, 4);
44 int vsprintf(char *str, const char *fmt, va_list ap);
45 int vsnprintf(char *str, size_t len, const char *fmt, va_list ap);
46
47 /* printf engine that parses the format string and generates output */
48
49 /* function pointer to pass the engine, 
50  * return code is remaining characters in destination (or INT_MAX for infinity)
51  */
52 typedef int (*_printf_engine_output_func)(char c, void *state);
53
54 int _printf_engine(_printf_engine_output_func out, void *state, const char *fmt, va_list ap);
55
56 #if defined(__cplusplus)
57 }
58 #endif
59
60 #endif