print.c
Go to the documentation of this file.
/* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
/* standard libraries */
#include <stdint.h> // standard integer types
#include <stdlib.h> // standard definitions
#include <stdbool.h> // boolean types
#include <stdarg.h> // variadic utilities
#include <math.h> // mathematics utilities to handle floating points
/* own libraries */
#include "print.h" // printing utilities
uint8_t print_error;
static void print_printed(size_t* length, size_t printed)
{
if (NULL==length) { // check if total is provided
return;
}
if (*length>SIZE_MAX-printed) { // prevent integer overflow
*length = SIZE_MAX; // set to maximum
print_error |= PRINT_ERROR_MAX; // set error
} else {
*length += printed; // save printed length
}
}
static size_t print_char(char** str, size_t* size, char c)
{
size_t length = 1; // remember how many characters have been printed or should have been added on string (normally just one)
if (0==c) { // don't print string termination character
length = 0; // remember we didn't print anything
} else if (NULL==str || NULL==*str || NULL==size) { // character should not be saved on string
length = putc(c); // print on user define output
} else if (*size>1) { // there is enough space in the string to store the character
**str = c; // add provided character to string
*str += 1; // go to next character on string
*size -= 1; // remember we used one character on string
} else { // string is reached its end
print_error |= PRINT_ERROR_TRUNCATED; // indicate we did not save the character
}
return length;
}
static size_t print_string(char** str, size_t* size, const char* s)
{
size_t length = 0; // number of characters printed
while (*s) { // stop at end of string
print_printed(&length, print_char(str, size, *(s++))); // print character
}
return length;
}
static size_t print_unsigned(char** str, size_t* size, uint64_t u, uint32_t padding, bool sign) {
char number[20] = {0}; // construct the number in reverse order (20 chars are required to store UINT64_MAX)
uint8_t digits = 0; // to count the number of digits
size_t length = 0; // number of characters printed
do {
number[digits++] = '0'+(u%10); // store digit
u /= 10; // go to next digit
} while (u>0);
if (sign) { // print sign
print_printed(&length, print_char(str, size, '+')); // we only have positive numbers
}
for (uint32_t zeros = digits; zeros<padding; zeros++) { // print padding 0's
print_printed(&length, print_char(str, size, '0')); // print 0
}
for (uint8_t digit = 0; digit < digits; digit++) { // go through all digits
print_printed(&length, print_char(str, size, number[digits-digit-1])); // print digit (in reverse order)
}
return length; // return number of characters printed
}
static size_t print_signed(char** str, size_t* size, int64_t d, uint32_t padding, bool sign) {
size_t length = 0; // number of characters printed
if (d<0) {
print_printed(&length, print_char(str, size, '-')); // print sign
print_printed(&length, print_unsigned(str, size, (uint64_t)-d, padding, false)); // print number (casting because there is one more negative value then positive value)
} else {
print_printed(&length, print_unsigned(str, size, d, padding, sign)); // print number
}
return length; // return number of characters printed
}
static size_t print_float(char** str, size_t* size, double f, uint32_t padding, uint32_t fractional, bool sign) {
size_t length = 0; // number of characters printed
if (isnan(f)) { // not a number
print_printed(&length, print_string(str, size, "NaN")); // print NaN
} else if (isinf(f)) { // infinite
if (-1==isinf(f)) {
print_printed(&length, print_char(str, size, '-')); // print sign
} else if (sign) {
print_printed(&length, print_char(str, size, '+')); // print sign
}
print_printed(&length, print_string(str, size, "inf")); // print inf
} else if (isnormal(f)) { // it should be not 0
if (f<0) {
print_printed(&length, print_char(str, size, '-')); // print sign
} else if (sign) {
print_printed(&length, print_char(str, size, '+')); // print sign
}
double f_abs = fabs(f); // only work using the absolute value now that the sign is printed
// get the exponent
int8_t exponent = 0; // exponent min/max for double is 37
if (f_abs<1.0) {
while (f_abs<pow(10.0, exponent-1)) { // find negative exponent, base 10
exponent -= 1; // decrement in deci
}
if (padding) { // respect padding wish
exponent -= padding;
}
} else {
while (f_abs>=pow(10.0, exponent)) { // find the positive exponent, base 10
exponent += 3; // increment in kilo
}
if (padding) { // respect padding wish
exponent -= padding;
} else {
exponent -= 3;
}
}
// print integer part
f_abs /= pow(10.0, exponent); // convert to scientific format
print_printed(&length, print_unsigned(str, size, f_abs, padding, false)); // print integer part as scientific number
// print fractional part
if (fractional) {
print_printed(&length, print_char(str, size, '.')); // print decimal point
f_abs -= (uint64_t)f_abs; // remove integer part
for (uint32_t frac=0; frac<fractional; frac++) { // print fractional parts
f_abs *= 10.0;
print_printed(&length, print_unsigned(str, size, f_abs, 0, false));
f_abs -= (uint64_t)f_abs;
}
}
// print exponent
if (exponent) {
print_printed(&length, print_char(str, size, 'E')); // print exponent mark
print_printed(&length, print_signed(str, size, exponent, 0, false));
}
} else { // f=0
// print sign
if (f<0) {
print_printed(&length, print_char(str, size, '-')); // print sign
} else if (sign) {
print_printed(&length, print_char(str, size, '+')); // print sign
}
print_printed(&length, print_unsigned(str, size, 0, padding, false)); // print integer part
if (fractional) {
print_printed(&length, print_char(str, size, '.')); // print decimal point
print_printed(&length, print_unsigned(str, size, 0, fractional, false)); // print fractional part
}
}
return length; // return number of characters printed
}
static size_t print_nibble(char** str, size_t* size, uint8_t nibble, bool upcase) {
size_t length = 0; // number of characters printed
nibble &= 0x0f; // ensure we only have a nibble
if (nibble<10) {
print_printed(&length, print_char(str, size, '0'+nibble));
} else if (upcase) {
print_printed(&length, print_char(str, size, 'A'+nibble-10));
} else {
print_printed(&length, print_char(str, size, 'a'+nibble-10));
}
return length; // return number of characters printed
}
static size_t print_hex(char** str, size_t* size, uint64_t hex, uint32_t padding, bool prefix, bool upcase) {
size_t length = 0; // number of characters printed
if (prefix) { // print 0x prefix
print_printed(&length, print_char(str, size, '0'));
print_printed(&length, print_char(str, size, 'x'));
}
uint8_t digits = 0; // number of digits to print
// figure out number of digits to print
if (hex>0xffffffffffffffUL) {
digits = 16;
} else if (hex>0xffffffffffffUL) {
digits = 14;
} else if (hex>0xffffffffffUL) {
digits = 12;
} else if (hex>0xffffffffUL) {
digits = 10;
} else if (hex>0xffffffUL) {
digits = 8;
} else if (hex>0xffffUL) {
digits = 6;
} else if (hex>0xffUL) {
digits = 4;
} else {
digits = 2;
}
for (uint32_t zeros = digits; zeros<padding; zeros++) { // print padding 0's
print_printed(&length, print_char(str, size, '0')); // print 0
}
for (uint8_t digit = 0; digit < digits; digit++) { // go through all digits
print_printed(&length, print_nibble(str, size, hex>>((digits-digit-1)*4), upcase)); // print nibble (in reverse order)
}
return length; // return number of characters printed
}
static size_t print_bits(char** str, size_t* size, uint64_t u, uint32_t padding, bool prefix) {
char bits[64] = {0}; // construct the bit string in reverse order
uint8_t digits = 0; // to count the number of digits
size_t length = 0; // number of characters printed
do {
bits[digits++] = '0'+(u&0x1); // store bit
u >>= 1; // go to next bit
} while (u>0);
if (digits>sizeof(bits)) { // prevent buffer underflow
return 0;
}
if (prefix) { // print prefix
print_printed(&length, print_char(str, size, '0'));
print_printed(&length, print_char(str, size, 'b'));
}
for (uint32_t zeros = digits; zeros<padding; zeros++) { // print padding 0's
print_printed(&length, print_char(str, size, '0')); // print 0
}
for (uint8_t digit = 0; digit < digits; digit++) { // go through all bits
print_printed(&length, print_char(str, size, bits[digits-digit-1])); // print bit (in reverse order)
}
return length; // return number of characters printed
}
static size_t vsnprintf(char** str, size_t* size, const char *format, va_list va)
{
size_t length = 0; // total number of characters printed
uint32_t padding = 0; // number of padding 0's
uint32_t fractional = 0; // number or fractional digits for floating point numbers
bool sign = false; // if sign needs to be printed
while (*format) { // go through format string
padding = 0; // reset padding
sign = false; // reset sign
if ('%'!=*format) { // check for format specifier prefix
print_printed(&length, print_char(str, size, *format++)); // print character (no interpretation needed)
} else {
format++; // go to format specifier
if (0==*format) { // end of string detected
print_error |= PRINT_ERROR_MALFORMED; // set error
goto end;
}
// check if sign need to be printed
if ('+'==*format) { // sign required
sign = true; // remember sign is required
format++; // go to padding number
if (0==*format) { // end of string detected
print_error |= PRINT_ERROR_MALFORMED; // set error
goto end;
}
}
// check padding
if ('0'==*format) { // padding required
padding = 0; // reset padding
format++; // go to padding number
while (*format>='0' && *format<='9') {
if (padding>UINT32_MAX/10) { // check for overflow
print_error |= PRINT_ERROR_UNSUPPORTED; // set error
goto end;
}
padding *= 10; // go to next magnitude
if (padding>UINT32_MAX-(*format-'0')) { // check for overflow
print_error |= PRINT_ERROR_UNSUPPORTED; // set error
goto end;
}
padding += *format-'0'; // save digit
format++; // go to next character
}
if (0==*format) { // end of string detected
print_error |= PRINT_ERROR_MALFORMED; // set error
goto end;
}
}
// check fractional
if ('.'==*format) { // fractional required
fractional = 0; // reset fractional
format++; // go to fractional number
while (*format>='0' && *format<='9') {
if (fractional>UINT32_MAX/10) { // check for overflow
print_error |= PRINT_ERROR_UNSUPPORTED; // set error
goto end;
}
fractional *= 10; // go to next magnitude
if (fractional>UINT32_MAX-(*format-'0')) { // check for overflow
print_error |= PRINT_ERROR_UNSUPPORTED; // set error
goto end;
}
fractional += *format-'0'; // save digit
format++; // go to next character
}
if (0==*format) { // end of string detected
print_error |= PRINT_ERROR_MALFORMED; // set error
goto end;
}
} else {
fractional = 2; // default fractional precision
}
// check format specifier
switch (*format) {
case 'c': // for char, unsigned char
print_printed(&length, print_char(str, size, (char)(va_arg(va,int)))); // needs casting because the returned value is promoted
break;
case 's': // for strings
print_printed(&length, print_string(str, size, va_arg(va,char*)));
break;
case 'u': // for uint8_t, uint16_t, uint32_t, unsigned int, unsigned long
print_printed(&length, print_unsigned(str, size, va_arg(va,uint32_t), padding, sign));
break;
case 'U': // for uint64_t, unsigned long long
print_printed(&length, print_unsigned(str, size, va_arg(va,uint64_t), padding, sign));
break;
case 'd': // for int8_t, int16_t, int32_t, int, long
print_printed(&length, print_signed(str, size, va_arg(va,int32_t), padding, sign));
break;
case 'D': // for int64_t, long long
print_printed(&length, print_signed(str, size, va_arg(va,int64_t), padding, sign));
break;
case 'f':
print_printed(&length, print_float(str, size, va_arg(va,double), padding, fractional, sign));
break;
case 'x': // for uint8_t, uint16_t, uint32_t downcase hexadecimal
print_printed(&length, print_hex(str, size, va_arg(va,uint32_t), padding, sign, false));
break;
case 'X': // for uint64_t downcase hexadecimal
print_printed(&length, print_hex(str, size, va_arg(va,uint64_t), padding, sign, false));
break;
case 'h': // for uint8_t, uint16_t, uint32_t upcase hexadecimal
print_printed(&length, print_hex(str, size, va_arg(va,uint32_t), padding, sign, true));
break;
case 'H': // for uint64_t upcase hexadecimal
print_printed(&length, print_hex(str, size, va_arg(va,uint64_t), padding, sign, true));
break;
case 'b': // for uint8_t, uint16_t, uint32_t bits
print_printed(&length, print_bits(str, size, va_arg(va,uint32_t), padding, sign));
break;
case 'B': // for uint64_t bits
print_printed(&length, print_bits(str, size, va_arg(va,uint64_t), padding, sign));
break;
default:
print_error |= PRINT_ERROR_UNSUPPORTED; // set error
print_printed(&length, print_char(str, size, *format)); // print character (unknown format specifier)
}
format++; // go to next character
}
}
end:
if (NULL!=str && NULL!=*str && NULL!=size) { // when working on a string
**str='\0'; // enforce null termination
if (*size>0) {
*size -= 1; // remember we used memory
} else {
print_error |= PRINT_ERROR_TRUNCATED; // indicate we truncated the string
}
}
return length; // return number of characters it should have written (not including the '\0' null termination character)
}
size_t printf(const char *format, ...)
{
print_error = PRINT_ERROR_NONE; // clear error
va_list arglist;
va_start(arglist, format);
size_t length = vsnprintf(NULL, NULL, format, arglist);
va_end(arglist);
return length;
}
size_t snprintf(char* str, size_t size, const char* format, ...)
{
print_error = PRINT_ERROR_NONE; // clear error
va_list arglist;
va_start(arglist, format);
size_t length = vsnprintf(&str, &size, format, arglist);
va_end(arglist);
return length;
}
print_error
uint8_t print_error
flags to indicate which error(s) occurred within printf or snprintf
Definition: print.c:30
PRINT_ERROR_UNSUPPORTED
#define PRINT_ERROR_UNSUPPORTED
input format string is not supported
Definition: print.h:41
PRINT_ERROR_MAX
#define PRINT_ERROR_MAX
maximum returned printed length reached but more has been printed
Definition: print.h:42
print_float
static size_t print_float(char **str, size_t *size, double f, uint32_t padding, uint32_t fractional, bool sign)
print floating number
Definition: print.c:143
PRINT_ERROR_MALFORMED
#define PRINT_ERROR_MALFORMED
input format string is malformed
Definition: print.h:40
print_signed
static size_t print_signed(char **str, size_t *size, int64_t d, uint32_t padding, bool sign)
print signed integer
Definition: print.c:123
print_char
static size_t print_char(char **str, size_t *size, char c)
print character
Definition: print.c:55
vsnprintf
static size_t vsnprintf(char **str, size_t *size, const char *format, va_list va)
print format string on string or user output
Definition: print.c:316
PRINT_ERROR_TRUNCATED
#define PRINT_ERROR_TRUNCATED
output string size is not large enough to include complete printed string
Definition: print.h:43
print_string
static size_t print_string(char **str, size_t *size, const char *s)
print string
Definition: print.c:78
PRINT_ERROR_NONE
#define PRINT_ERROR_NONE
no error occurred
Definition: print.h:39
print_nibble
static size_t print_nibble(char **str, size_t *size, uint8_t nibble, bool upcase)
print nibble (half-byte)
Definition: print.c:221
print_hex
static size_t print_hex(char **str, size_t *size, uint64_t hex, uint32_t padding, bool prefix, bool upcase)
print hex value
Definition: print.c:243
snprintf
size_t snprintf(char *str, size_t size, const char *format,...)
print format string on string or user output
Definition: print.c:458
printf
size_t printf(const char *format,...)
print format string on user output
Definition: print.c:448
print.h
printing utilities to replace the large printf from the standard library (API)
print_printed
static void print_printed(size_t *length, size_t printed)
add printed length to total printed length, and sets error if maximum size is exceeded ...
Definition: print.c:36
putc
size_t putc(char c)
print a single character on user output
Definition: application.c:64
print_bits
static size_t print_bits(char **str, size_t *size, uint64_t u, uint32_t padding, bool prefix)
print bits
Definition: print.c:285
print_unsigned
static size_t print_unsigned(char **str, size_t *size, uint64_t u, uint32_t padding, bool sign)
print unsigned integer
Definition: print.c:95