4 * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
5 * This file is part of DevLib - See README.devlib for information.
10 * \brief Basic "printf", "sprintf" and "fprintf" formatter.
12 * This module is 100% reentrant and can be adapted to user-defined routines
13 * that needs formatters with special properties like different output
14 * channels or new format specifiers.
16 * To reduce size in applications not using real numbers or long integers
17 * the formatter may be compiled to exclude certain parts. This is
18 * controlled by giving a -D option a compilation time:
21 * -D CONFIG_PRINTF=PRINTF_FULL Full ANSI printf formatter
22 * -D CONFIG_PRINTF=PRINTF_NOFLOAT Exclude support for floats
23 * -D CONFIG_PRINTF=PRINTF_REDUCED Simplified formatter (see below)
24 * -D CONFIG_PRINTF=PRINTF_NOMODIFIERS Exclude 'l' and 'h' modifiers in reduced version
25 * -D CONFIG_PRINTF=PRINTF_DISABLED No formatter at all
28 * Code size on AVR4 with GCC 3.4.1 (-O2):
29 * PRINTF_FULL 2912byte (0xB60)
30 * PRINTF_NOFLOAT 1684byte (0x694)
31 * PRINTF_REDUCED 924byte (0x39C)
32 * PRINTF_NOMODIFIERS 416byte (0x1A0)
34 * Code/data size in words on DSP56K with CodeWarrior 6.0:
36 * PRINTF_NOFLOAT 795/45
37 * PRINTF_REDUCED 482/0
38 * PRINTF_NOMODIFIERS 301/0
40 * The reduced version of formatter is suitable when program size is critical
41 * rather than formatting power. This routine uses less than 20 bytes of
42 * stack space which makes it practical even in systems with less than 256
45 * The only formatting specifiers supported by the reduced formatter are:
47 * %% %c %s %d %o %x %X and %hd %ho %hx %hX %ld %lo %lx %lX
50 * It means that real variables are not supported as well as field
51 * width and precision arguments.
56 *#* Revision 1.18 2006/07/19 12:56:27 bernie
57 *#* Convert to new Doxygen style.
59 *#* Revision 1.17 2005/11/04 17:43:27 bernie
60 *#* Fix for LP64 architectures; Add some more tests.
62 *#* Revision 1.16 2005/07/19 07:25:46 bernie
63 *#* Use appconfig.h instead of cfg/config.h.
65 *#* Revision 1.15 2005/04/11 19:10:28 bernie
66 *#* Include top-level headers from cfg/ subdir.
68 *#* Revision 1.14 2005/03/01 23:26:22 bernie
69 *#* Use shared hextab.
71 *#* Revision 1.13 2005/02/18 12:33:25 bernie
74 *#* Revision 1.12 2005/02/16 20:28:03 bernie
77 *#* Revision 1.11 2005/02/16 16:51:29 bernie
78 *#* Simplify float code.
80 *#* Revision 1.10 2004/10/26 09:01:35 bernie
83 *#* Revision 1.9 2004/09/14 21:06:23 bernie
86 *#* Revision 1.8 2004/08/25 14:12:09 rasky
87 *#* Aggiornato il comment block dei log RCS
91 #include <mware/pgm.h>
92 #include <mware/hex.h>
93 #include <cfg/debug.h> /* ASSERT */
94 #include <appconfig.h> /* CONFIG_ macros */
96 #ifndef CONFIG_PRINTF_N_FORMATTER
97 /** Disable the arcane %n formatter. */
98 #define CONFIG_PRINTF_N_FORMATTER 0
101 #ifndef CONFIG_PRINTF_OCTAL_FORMATTER
102 /** Disable the %o formatter. */
103 #define CONFIG_PRINTF_OCTAL_FORMATTER 0
106 /* True if we must keep a count of the number of characters we print. */
107 #define CONFIG_PRINTF_COUNT_CHARS (CONFIG_PRINTF_RETURN_COUNT || CONFIG_PRINTF_N_FORMATTER)
111 #if CONFIG_PRINTF > PRINTF_NOFLOAT
114 /* Maximum precision for floating point values */
115 typedef long double max_float_t;
117 /*bernie: save some memory, who cares about floats with lots of decimals? */
118 #define FRMWRI_BUFSIZE 134
119 #warning 134 is too much, the code must be fixed to have a lower precision limit
122 * Conservative estimate. Should be (probably) 12 (which is the size necessary
123 * to represent (2^32-1) in octal plus the sign bit.
125 #define FRMWRI_BUFSIZE 16
128 /* Probably useful for fancy microcontrollers such as the PIC, nobody knows. */
129 #ifndef MEM_ATTRIBUTE
130 #define MEM_ATTRIBUTE
133 #if CONFIG_PRINTF > PRINTF_NOMODIFIERS
134 #define IS_SHORT (h_modifier || (sizeof(int) == 2 && !l_modifier))
136 #define IS_SHORT (sizeof(int) == 2)
137 #endif /* CONFIG_PRINTF > PRINTF_NOMODIFIERS */
140 #if CONFIG_PRINTF > PRINTF_NOFLOAT
142 static char *float_conversion(MEM_ATTRIBUTE max_float_t value,
143 MEM_ATTRIBUTE short nr_of_digits,
144 MEM_ATTRIBUTE char *buf,
145 MEM_ATTRIBUTE char format_flag,
146 MEM_ATTRIBUTE char g_flag,
147 MEM_ATTRIBUTE bool alternate_flag)
149 MEM_ATTRIBUTE char *cp;
150 MEM_ATTRIBUTE char *buf_pointer;
151 MEM_ATTRIBUTE short n, i, dec_point_pos, integral_10_log;
158 while (value >= 1e11) /* To speed up things a bit */
161 integral_10_log += 10;
169 else if (value) /* Not just 0.0 */
171 while (value <= 1e-10) /* To speed up things a bit */
174 integral_10_log -= 10;
184 if (integral_10_log < nr_of_digits && integral_10_log >= -4)
187 nr_of_digits -= integral_10_log;
191 /* %#G - No removal of trailing zeros */
194 /* %G - Removal of trailing zeros */
195 alternate_flag = true;
205 /* Less than one... */
206 if (integral_10_log < 0)
208 *buf_pointer++ = '0';
209 if ((n = nr_of_digits) || alternate_flag)
210 *buf_pointer++ = '.';
212 while (--i > integral_10_log && nr_of_digits)
214 *buf_pointer++ = '0';
217 if (integral_10_log < (-n - 1))
218 /* Nothing more to do */
224 dec_point_pos = - integral_10_log;
229 while (i <= nr_of_digits )
231 value -= (max_float_t)(n = (short)value); /* n=Digit value=Remainder */
232 value *= 10; /* Prepare for next shot */
233 *buf_pointer++ = n + '0';
234 if ( ! i++ && (nr_of_digits || alternate_flag))
235 *buf_pointer++ = '.';
238 /* Rounding possible */
242 cp = buf_pointer - 1;
247 if ( (*cp += n) == ('9' + 1) )
255 } while (cp-- > buf);
264 if (*(cp - 1) == '.')
289 /* %G - Remove trailing zeros */
292 while (*(buf_pointer - 1) == '0')
294 if (*(buf_pointer - 1) == '.')
301 *buf_pointer++ = format_flag;
302 if (integral_10_log < 0)
304 *buf_pointer++ = '-';
305 integral_10_log = -integral_10_log;
308 *buf_pointer++ = '+';
314 *buf_pointer++ = (integral_10_log % 10) + '0';
315 integral_10_log /= 10;
316 } while ( integral_10_log || n < 2 );
317 for ( i = n ; n > 0 ; n-- )
318 *(buf_pointer - 11 - i + n) = *(buf_pointer - n);
321 return (buf_pointer);
324 #endif /* CONFIG_PRINTF > PRINTF_NOFLOAT */
327 * This routine forms the core and entry of the formatter.
329 * The conversion performed conforms to the ANSI specification for "printf".
332 PGM_FUNC(_formatted_write)(const char * PGM_ATTR format,
333 void put_one_char(char, void *),
334 void *secret_pointer,
337 #if CONFIG_PRINTF > PRINTF_REDUCED
338 MEM_ATTRIBUTE static char bad_conversion[] = "???";
339 MEM_ATTRIBUTE static char null_pointer[] = "<NULL>";
341 MEM_ATTRIBUTE int precision;
343 #if CONFIG_PRINTF_COUNT_CHARS
344 MEM_ATTRIBUTE int nr_of_chars;
346 MEM_ATTRIBUTE int field_width;
347 MEM_ATTRIBUTE char format_flag;
348 enum PLUS_SPACE_FLAGS {
349 PSF_NONE, PSF_PLUS, PSF_MINUS
353 #if CONFIG_PRINTF_OCTAL_FORMATTER
357 MEM_ATTRIBUTE struct {
358 enum PLUS_SPACE_FLAGS plus_space_flag : 2;
359 #if CONFIG_PRINTF_OCTAL_FORMATTER
360 enum DIV_FACTOR div_factor : 2;
362 enum DIV_FACTOR div_factor : 1;
364 bool left_adjust : 1;
365 bool l_L_modifier : 1;
367 bool alternate_flag : 1;
368 bool nonzero_value : 1;
374 MEM_ATTRIBUTE unsigned long ulong;
376 #if CONFIG_PRINTF > PRINTF_NOFLOAT
377 MEM_ATTRIBUTE max_float_t fvalue;
380 MEM_ATTRIBUTE char *buf_pointer;
381 MEM_ATTRIBUTE char *ptr;
382 MEM_ATTRIBUTE const char *hex;
383 MEM_ATTRIBUTE char buf[FRMWRI_BUFSIZE];
385 #if CONFIG_PRINTF_COUNT_CHARS
388 for (;;) /* Until full format string read */
390 while ((format_flag = PGM_READ_CHAR(format++)) != '%') /* Until '%' or '\0' */
393 #if CONFIG_PRINTF_RETURN_COUNT
394 return (nr_of_chars);
398 put_one_char(format_flag, secret_pointer);
399 #if CONFIG_PRINTF_COUNT_CHARS
403 if (PGM_READ_CHAR(format) == '%') /* %% prints as % */
406 put_one_char('%', secret_pointer);
407 #if CONFIG_PRINTF_COUNT_CHARS
413 flags.left_adjust = false;
414 flags.alternate_flag = false;
415 flags.plus_space_flag = PSF_NONE;
416 flags.zeropad = false;
418 flags.progmem = false;
420 ptr = buf_pointer = &buf[0];
423 /* check for leading '-', '+', ' ','#' or '0' flags */
426 switch (PGM_READ_CHAR(format))
429 if (flags.plus_space_flag)
432 flags.plus_space_flag = PSF_PLUS;
435 flags.left_adjust = true;
438 flags.alternate_flag = true;
441 flags.zeropad = true;
449 /* Optional field width (may be '*') */
450 if (PGM_READ_CHAR(format) == '*')
452 field_width = va_arg(ap, int);
455 field_width = -field_width;
456 flags.left_adjust = true;
463 while (PGM_READ_CHAR(format) >= '0' && PGM_READ_CHAR(format) <= '9')
464 field_width = field_width * 10 + (PGM_READ_CHAR(format++) - '0');
467 if (flags.left_adjust)
468 flags.zeropad = false;
470 /* Optional precision (or '*') */
471 if (PGM_READ_CHAR(format) == '.')
473 if (PGM_READ_CHAR(++format) == '*')
475 precision = va_arg(ap, int);
481 while (PGM_READ_CHAR(format) >= '0' && PGM_READ_CHAR(format) <= '9')
482 precision = precision * 10 + (PGM_READ_CHAR(format++) - '0');
488 /* At this point, "left_adjust" is nonzero if there was
489 * a sign, "zeropad" is 1 if there was a leading zero
490 * and 0 otherwise, "field_width" and "precision"
491 * contain numbers corresponding to the digit strings
492 * before and after the decimal point, respectively,
493 * and "plus_space_flag" is either 0 (no flag) or
494 * contains a plus or space character. If there was no
495 * decimal point, "precision" will be -1.
498 flags.l_L_modifier = false;
499 flags.h_modifier = false;
501 /* Optional 'l','L' r 'h' modifier? */
502 switch (PGM_READ_CHAR(format))
506 flags.l_L_modifier = true;
510 flags.h_modifier = true;
516 * At exit from the following switch, we will emit
517 * the characters starting at "buf_pointer" and
520 switch (format_flag = PGM_READ_CHAR(format++))
522 #if CONFIG_PRINTF_N_FORMATTER
524 if (sizeof(short) != sizeof(int))
526 if (sizeof(int) != sizeof(long))
529 *va_arg(ap, short *) = nr_of_chars;
530 else if (flags.l_L_modifier)
531 *va_arg(ap, long *) = nr_of_chars;
533 *va_arg(ap, int *) = nr_of_chars;
538 *va_arg(ap, short *) = nr_of_chars;
540 *va_arg(ap, int *) = nr_of_chars;
545 if (flags.l_L_modifier)
546 *va_arg(ap, long *) = nr_of_chars;
548 *va_arg(ap, int *) = nr_of_chars;
553 buf[0] = va_arg(ap, int);
557 /* Custom formatter for strings in program memory. */
560 flags.progmem = true;
565 if ( !(buf_pointer = va_arg(ap, char *)) )
566 buf_pointer = null_pointer;
571 * Move `ptr' to the last character of the
572 * string that will be actually printed.
578 for (n=0; pgm_read_char(ptr) && n < precision; n++)
583 for (n=0; *ptr && n < precision; n++)
587 #if CONFIG_PRINTF_OCTAL_FORMATTER
589 if (flags.alternate_flag && !precision)
597 if (format_flag == 'p')
598 #if defined(__AVR__) || defined(__I196__) /* 16bit pointers */
599 ulong = (unsigned long)(unsigned short)va_arg(ap, char *);
600 #else /* 32bit pointers */
601 ulong = (unsigned long)va_arg(ap, char *);
602 #endif /* 32bit pointers */
603 else if (flags.l_L_modifier)
604 ulong = va_arg(ap, unsigned long);
605 else if (flags.h_modifier)
606 ulong = (unsigned long)(unsigned short)va_arg(ap, unsigned int);
608 ulong = va_arg(ap, unsigned int);
611 #if CONFIG_PRINTF_OCTAL_FORMATTER
612 (format_flag == 'o') ? DIV_OCT :
614 (format_flag == 'u') ? DIV_DEC : DIV_HEX;
615 flags.plus_space_flag = PSF_NONE;
616 goto INTEGRAL_CONVERSION;
620 if (flags.l_L_modifier)
621 ulong = (unsigned long)(long)va_arg(ap, long);
623 ulong = (unsigned long)(long)va_arg(ap, int);
626 if ((signed long)ulong < 0)
628 flags.plus_space_flag = PSF_MINUS;
629 ulong = (unsigned long)(-((signed long)ulong));
632 flags.div_factor = DIV_DEC;
634 /* Now convert to digits */
636 ptr = buf_pointer = &buf[FRMWRI_BUFSIZE - 1];
637 flags.nonzero_value = (ulong != 0);
639 /* No char if zero and zero precision */
640 if (precision != 0 || flags.nonzero_value)
642 switch (flags.div_factor)
646 *--buf_pointer = hex[ulong % 10];
652 *--buf_pointer = hex[ulong % 16];
655 #if CONFIG_PRINTF_OCTAL_FORMATTER
658 *--buf_pointer = hex[ulong % 8];
665 /* "precision" takes precedence */
668 precision = field_width - (flags.plus_space_flag != PSF_NONE);
669 while (precision > (int)(ptr - buf_pointer))
670 *--buf_pointer = '0';
672 if (flags.alternate_flag && flags.nonzero_value)
674 if (format_flag == 'x' || format_flag == 'X')
676 *--buf_pointer = format_flag;
677 *--buf_pointer = '0';
679 #if CONFIG_PRINTF_OCTAL_FORMATTER
680 else if ((format_flag == 'o') && (*buf_pointer != '0'))
682 *--buf_pointer = '0';
686 ASSERT(buf_pointer >= buf);
689 #if CONFIG_PRINTF > PRINTF_NOFLOAT
698 goto FLOATING_CONVERSION;
710 if (sizeof(double) != sizeof(max_float_t))
712 fvalue = flags.l_L_modifier ?
713 va_arg(ap,max_float_t) : va_arg(ap,double);
716 fvalue = va_arg(ap,max_float_t);
720 flags.plus_space_flag = PSF_MINUS;
723 ptr = float_conversion (fvalue,
725 buf_pointer += field_width,
728 flags.alternate_flag);
731 precision = field_width - (flags.plus_space_flag != PSF_NONE);
732 while (precision > ptr - buf_pointer)
733 *--buf_pointer = '0';
737 #endif /* CONFIG_PRINTF <= PRINTF_NOFLOAT */
739 case '\0': /* Really bad place to find NUL in */
743 /* Undefined conversion! */
744 ptr = buf_pointer = bad_conversion;
745 ptr += sizeof(bad_conversion) - 1;
751 * This part emittes the formatted string to "put_one_char".
754 /* If field_width == 0 then nothing should be written. */
755 precision = ptr - buf_pointer;
757 if ( precision > field_width)
763 n = field_width - precision - (flags.plus_space_flag != PSF_NONE);
766 /* emit any leading pad characters */
767 if (!flags.left_adjust)
770 put_one_char(' ', secret_pointer);
771 #if CONFIG_PRINTF_COUNT_CHARS
776 /* emit flag characters (if any) */
777 if (flags.plus_space_flag)
779 put_one_char(flags.plus_space_flag == PSF_PLUS ? '+' : '-', secret_pointer);
780 #if CONFIG_PRINTF_COUNT_CHARS
788 while (--precision >= 0)
790 put_one_char(pgm_read_char(buf_pointer++), secret_pointer);
791 #if CONFIG_PRINTF_COUNT_CHARS
797 #endif /* CPU_HARVARD */
799 /* emit the string itself */
800 while (--precision >= 0)
802 put_one_char(*buf_pointer++, secret_pointer);
803 #if CONFIG_PRINTF_COUNT_CHARS
809 /* emit trailing space characters */
810 if (flags.left_adjust)
813 put_one_char(' ', secret_pointer);
814 #if CONFIG_PRINTF_COUNT_CHARS
820 #else /* PRINTF_REDUCED starts here */
822 #if CONFIG_PRINTF > PRINTF_NOMODIFIERS
823 char l_modifier, h_modifier;
824 unsigned long u_val, div_val;
826 unsigned int u_val, div_val;
827 #endif /* CONFIG_PRINTF > PRINTF_NOMODIFIERS */
830 unsigned int nr_of_chars, base;
835 for (;;) /* Until full format string read */
837 while ((format_flag = PGM_READ_CHAR(format++)) != '%') /* Until '%' or '\0' */
840 return (nr_of_chars);
841 put_one_char(format_flag, secret_pointer);
845 #if CONFIG_PRINTF > PRINTF_NOMODIFIERS
846 /*=================================*/
847 /* Optional 'l' or 'h' modifiers ? */
848 /*=================================*/
849 l_modifier = h_modifier = 0;
850 switch (PGM_READ_CHAR(format))
862 #endif /* CONFIG_PRINTF > PRINTF_NOMODIFIERS */
864 switch (format_flag = PGM_READ_CHAR(format++))
867 format_flag = va_arg(ap, int);
869 put_one_char(format_flag, secret_pointer);
874 ptr = va_arg(ap, char *);
875 while ((format_flag = *ptr++))
877 put_one_char(format_flag, secret_pointer);
887 div_val = 0x40000000;
888 goto CONVERSION_LOOP;
895 div_val = 1000000000;
896 goto CONVERSION_LOOP;
904 div_val = 0x10000000;
907 #if CONFIG_PRINTF > PRINTF_NOMODIFIERS
909 u_val = (format_flag == 'd') ?
910 (short)va_arg(ap, int) : (unsigned short)va_arg(ap, int);
912 u_val = va_arg(ap, long);
914 u_val = (format_flag == 'd') ?
915 va_arg(ap,int) : va_arg(ap,unsigned int);
916 #else /* CONFIG_PRINTF > PRINTF_NOMODIFIERS */
917 u_val = va_arg(ap,int);
918 #endif /* CONFIG_PRINTF > PRINTF_NOMODIFIERS */
919 if (format_flag == 'd')
921 if (((int)u_val) < 0)
924 put_one_char('-', secret_pointer);
928 while (div_val > 1 && div_val > u_val)
934 outChar = (u_val / div_val) + '0';
937 if (format_flag == 'x')
938 outChar += 'a'-'9'-1;
940 outChar += 'A'-'9'-1;
942 put_one_char(outChar, secret_pointer);
949 } /* end switch(format_flag...) */
951 #endif /* CONFIG_PRINTF > PRINTF_REDUCED */
954 #endif /* CONFIG_PRINTF */