Merge branch 'master' of github.com:RfidResearchGroup/proxmark3
[RRG-proxmark3.git] / armsrc / nprintf.h
blob5c83384b729689cbb5ed5a7f6507e9f788d602a6
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:
14 // The above copyright notice and this permission notice shall be included in
15 // all copies or substantial portions of the Software.
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.
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.
30 ///////////////////////////////////////////////////////////////////////////////
32 #ifndef _PRINTF_H_
33 #define _PRINTF_H_
35 #include <stdbool.h>
36 #include <stdint.h>
37 #include <stddef.h>
38 #include <stdarg.h>
40 /**
41 * Output a character to a custom device like UART, used by the printf() function
42 * This function is declared here only. You have to write your custom implementation somewhere
43 * \param character Character to output
45 void _putchar(char character);
48 /**
49 * Tiny printf implementation
50 * You have to implement _putchar if you use printf()
51 * To avoid conflicts with the regular printf() API it is overridden by macro defines
52 * and internal underscore-appended functions like printf_() are used
53 * \param format A string that specifies the format of the output
54 * \return The number of characters that are written into the array, not counting the terminating null character
56 #define printf printf_
57 int printf_(const char *format, ...);
60 /**
61 * Tiny sprintf implementation
62 * Due to security reasons (buffer overflow) YOU SHOULD CONSIDER USING (V)SNPRINTF INSTEAD!
63 * \param buffer A pointer to the buffer where to store the formatted string. MUST be big enough to store the output!
64 * \param format A string that specifies the format of the output
65 * \return The number of characters that are WRITTEN into the buffer, not counting the terminating null character
67 #define sprintf sprintf_
68 int sprintf_(char *buffer, const char *format, ...);
71 /**
72 * Tiny snprintf/vsnprintf implementation
73 * \param buffer A pointer to the buffer where to store the formatted string
74 * \param count The maximum number of characters to store in the buffer, including a terminating null character
75 * \param format A string that specifies the format of the output
76 * \param va A value identifying a variable arguments list
77 * \return The number of characters that COULD have been written into the buffer, not counting the terminating
78 * null character. A value equal or larger than count indicates truncation. Only when the returned value
79 * is non-negative and less than count, the string has been completely written.
81 #define snprintf snprintf_
82 #define vsnprintf vsnprintf_
83 int snprintf_(char *buffer, size_t count, const char *format, ...);
84 int vsnprintf_(char *buffer, size_t count, const char *format, va_list va);
87 /**
88 * Tiny vprintf implementation
89 * \param format A string that specifies the format of the output
90 * \param va A value identifying a variable arguments list
91 * \return The number of characters that are WRITTEN into the buffer, not counting the terminating null character
93 #define vprintf vprintf_
94 int vprintf_(const char *format, va_list va);
97 /**
98 * printf with output function
99 * You may use this as dynamic alternative to printf() with its fixed _putchar() output
100 * \param out An output function which takes one character and an argument pointer
101 * \param arg An argument pointer for user data passed to output function
102 * \param format A string that specifies the format of the output
103 * \return The number of characters that are sent to the output function, not counting the terminating null character
105 int fctprintf(void (*out)(char character, void *arg), void *arg, const char *format, ...);
107 #endif // _PRINTF_H_