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 COULD have been written into the buffer, not counting the terminating 82 * null character. A value equal or larger than count indicates truncation. Only when the returned value 83 * is non-negative and less than count, the string has been completely written. 84 */ 85 #define snprintf snprintf_ 86 #define vsnprintf vsnprintf_ 87 int snprintf_(char* buffer, size_t count, const char* format, ...); 88 int vsnprintf_(char* buffer, size_t count, const char* format, va_list va); 89 90 91 /** 92 * Tiny vprintf implementation 93 * \param format A string that specifies the format of the output 94 * \param va A value identifying a variable arguments list 95 * \return The number of characters that are WRITTEN into the buffer, not counting the terminating null character 96 */ 97 #define vprintf vprintf_ 98 int vprintf_(const char* format, va_list va); 99 100 101 /** 102 * printf with output function 103 * You may use this as dynamic alternative to printf() with its fixed _putchar() output 104 * \param out An output function which takes one character and an argument pointer 105 * \param arg An argument pointer for user data passed to output function 106 * \param format A string that specifies the format of the output 107 * \return The number of characters that are sent to the output function, not counting the terminating null character 108 */ 109 int fctprintf(void (*out)(char character, void* arg), void* arg, const char* format, ...); 110 111 112 #ifdef __cplusplus 113 } 114 #endif 115 116 117 #endif // _PRINTF_H_ 118