printf.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 // \author (c) Marco Paland (info@paland.com)
3 // 2014-2019, PALANDesign Hannover, Germany
4 //
5 // \license The MIT License (MIT)
6 //
7 // Permission is hereby granted, free of charge, to any person obtaining a copy
8 // of this software and associated documentation files (the "Software"), to deal
9 // in the Software without restriction, including without limitation the rights
10 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 // copies of the Software, and to permit persons to whom the Software is
12 // furnished to do so, subject to the following conditions:
13 //
14 // The above copyright notice and this permission notice shall be included in
15 // all copies or substantial portions of the Software.
16 //
17 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 // THE SOFTWARE.
24 //
25 // \brief Tiny printf, sprintf and snprintf implementation, optimized for speed on
26 // embedded systems with a very limited resources.
27 // Use this instead of bloated standard/newlib printf.
28 // These routines are thread safe and reentrant.
29 //
30 ///////////////////////////////////////////////////////////////////////////////
31
32 #ifndef _PRINTF_H_
33 #define _PRINTF_H_
34
35 #include <stdarg.h>
36 #include <stddef.h>
37
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43
44 /**
45 * Output a character to a custom device like UART, used by the printf() function
46 * This function is declared here only. You have to write your custom implementation somewhere
47 * \param character Character to output
48 */
49 void _putchar(char character);
50
51
52 /**
53 * Tiny printf implementation
54 * You have to implement _putchar if you use printf()
55 * To avoid conflicts with the regular printf() API it is overridden by macro defines
56 * and internal underscore-appended functions like printf_() are used
57 * \param format A string that specifies the format of the output
58 * \return The number of characters that are written into the array, not counting the terminating null character
59 */
60 #define printf printf_
61 int printf_(const char* format, ...);
62
63
64 /**
65 * Tiny sprintf implementation
66 * Due to security reasons (buffer overflow) YOU SHOULD CONSIDER USING (V)SNPRINTF INSTEAD!
67 * \param buffer A pointer to the buffer where to store the formatted string. MUST be big enough to store the output!
68 * \param format A string that specifies the format of the output
69 * \return The number of characters that are WRITTEN into the buffer, not counting the terminating null character
70 */
71 #define sprintf sprintf_
72 int sprintf_(char* buffer, const char* format, ...);
73
74
75 /**
76 * Tiny snprintf/vsnprintf implementation
77 * \param buffer A pointer to the buffer where to store the formatted string
78 * \param count The maximum number of characters to store in the buffer, including a terminating null character
79 * \param format A string that specifies the format of the output
80 * \param va A value identifying a variable arguments list
81 * \return The number of characters that are WRITTEN into the buffer, not counting the terminating null character
82 * If the formatted string is truncated the buffer size (count) is returned
83 */
84 #define snprintf snprintf_
85 #define vsnprintf vsnprintf_
86 int snprintf_(char* buffer, size_t count, const char* format, ...);
87 int vsnprintf_(char* buffer, size_t count, const char* format, va_list va);
88
89
90 /**
91 * Tiny vprintf implementation
92 * \param format A string that specifies the format of the output
93 * \param va A value identifying a variable arguments list
94 * \return The number of characters that are WRITTEN into the buffer, not counting the terminating null character
95 */
96 #define vprintf vprintf_
97 int vprintf_(const char* format, va_list va);
98
99
100 /**
101 * printf with output function
102 * You may use this as dynamic alternative to printf() with its fixed _putchar() output
103 * \param out An output function which takes one character and an argument pointer
104 * \param arg An argument pointer for user data passed to output function
105 * \param format A string that specifies the format of the output
106 * \return The number of characters that are sent to the output function, not counting the terminating null character
107 */
108 int fctprintf(void (*out)(char character, void* arg), void* arg, const char* format, ...);
109
110
111 /**
112 * vprintf with output function
113 * You may use this as dynamic alternative to vprintf() with its fixed _putchar() output
114 * \param out An output function which takes one character and an argument pointer
115 * \param arg An argument pointer for user data passed to output function
116 * \param format A string that specifies the format of the output
117 * \param va A value identifying a variable arguments list
118 * \return The number of characters that are sent to the output function, not counting the terminating null character
119 */
120 int fctvprintf(void (*out)(char character, void* arg), void* arg, const char* format, va_list va);
121
122 #ifdef __cplusplus
123 }
124 #endif
125
126
127 #endif // _PRINTF_H_
buffer
void * buffer
Definition: i2c_example_cargo.c:40
_putchar
void _putchar(char character)
fctvprintf
int fctvprintf(void(*out)(char character, void *arg), void *arg, const char *format, va_list va)
Definition: printf.c:915
vprintf_
int vprintf_(const char *format, va_list va)
Definition: printf.c:892
fctprintf
int fctprintf(void(*out)(char character, void *arg), void *arg, const char *format,...)
Definition: printf.c:905
printf_
int printf_(const char *format,...)
Definition: printf.c:861
sprintf_
int sprintf_(char *buffer, const char *format,...)
Definition: printf.c:872
vsnprintf_
int vsnprintf_(char *buffer, size_t count, const char *format, va_list va)
Definition: printf.c:899
snprintf_
int snprintf_(char *buffer, size_t count, const char *format,...)
Definition: printf.c:882