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.17 2005/11/04 17:43:27 bernie
57 *#* Fix for LP64 architectures; Add some more tests.
59 *#* Revision 1.16 2005/07/19 07:25:46 bernie
60 *#* Use appconfig.h instead of cfg/config.h.
62 *#* Revision 1.15 2005/04/11 19:10:28 bernie
63 *#* Include top-level headers from cfg/ subdir.
65 *#* Revision 1.14 2005/03/01 23:26:22 bernie
66 *#* Use shared hextab.
68 *#* Revision 1.13 2005/02/18 12:33:25 bernie
71 *#* Revision 1.12 2005/02/16 20:28:03 bernie
74 *#* Revision 1.11 2005/02/16 16:51:29 bernie
75 *#* Simplify float code.
77 *#* Revision 1.10 2004/10/26 09:01:35 bernie
80 *#* Revision 1.9 2004/09/14 21:06:23 bernie
83 *#* Revision 1.8 2004/08/25 14:12:09 rasky
84 *#* Aggiornato il comment block dei log RCS
88 #include <mware/pgm.h>
89 #include <mware/hex.h>
90 #include <cfg/debug.h> /* ASSERT */
91 #include <appconfig.h> /* CONFIG_ macros */
93 #ifndef CONFIG_PRINTF_N_FORMATTER
94 /*! Disable the arcane %n formatter. */
95 #define CONFIG_PRINTF_N_FORMATTER 0
98 #ifndef CONFIG_PRINTF_OCTAL_FORMATTER
99 /*! Disable the %o formatter. */
100 #define CONFIG_PRINTF_OCTAL_FORMATTER 0
103 /* True if we must keep a count of the number of characters we print. */
104 #define CONFIG_PRINTF_COUNT_CHARS (CONFIG_PRINTF_RETURN_COUNT || CONFIG_PRINTF_N_FORMATTER)
108 #if CONFIG_PRINTF > PRINTF_NOFLOAT
111 /* Maximum precision for floating point values */
112 typedef long double max_float_t;
114 /*bernie: save some memory, who cares about floats with lots of decimals? */
115 #define FRMWRI_BUFSIZE 134
116 #warning 134 is too much, the code must be fixed to have a lower precision limit
119 * Conservative estimate. Should be (probably) 12 (which is the size necessary
120 * to represent (2^32-1) in octal plus the sign bit.
122 #define FRMWRI_BUFSIZE 16
125 /* Probably useful for fancy microcontrollers such as the PIC, nobody knows. */
126 #ifndef MEM_ATTRIBUTE
127 #define MEM_ATTRIBUTE
130 #if CONFIG_PRINTF > PRINTF_NOMODIFIERS
131 #define IS_SHORT (h_modifier || (sizeof(int) == 2 && !l_modifier))
133 #define IS_SHORT (sizeof(int) == 2)
134 #endif /* CONFIG_PRINTF > PRINTF_NOMODIFIERS */
137 #if CONFIG_PRINTF > PRINTF_NOFLOAT
139 static char *float_conversion(MEM_ATTRIBUTE max_float_t value,
140 MEM_ATTRIBUTE short nr_of_digits,
141 MEM_ATTRIBUTE char *buf,
142 MEM_ATTRIBUTE char format_flag,
143 MEM_ATTRIBUTE char g_flag,
144 MEM_ATTRIBUTE bool alternate_flag)
146 MEM_ATTRIBUTE char *cp;
147 MEM_ATTRIBUTE char *buf_pointer;
148 MEM_ATTRIBUTE short n, i, dec_point_pos, integral_10_log;
155 while (value >= 1e11) /* To speed up things a bit */
158 integral_10_log += 10;
166 else if (value) /* Not just 0.0 */
168 while (value <= 1e-10) /* To speed up things a bit */
171 integral_10_log -= 10;
181 if (integral_10_log < nr_of_digits && integral_10_log >= -4)
184 nr_of_digits -= integral_10_log;
188 /* %#G - No removal of trailing zeros */
191 /* %G - Removal of trailing zeros */
192 alternate_flag = true;
202 /* Less than one... */
203 if (integral_10_log < 0)
205 *buf_pointer++ = '0';
206 if ((n = nr_of_digits) || alternate_flag)
207 *buf_pointer++ = '.';
209 while (--i > integral_10_log && nr_of_digits)
211 *buf_pointer++ = '0';
214 if (integral_10_log < (-n - 1))
215 /* Nothing more to do */
221 dec_point_pos = - integral_10_log;
226 while (i <= nr_of_digits )
228 value -= (max_float_t)(n = (short)value); /* n=Digit value=Remainder */
229 value *= 10; /* Prepare for next shot */
230 *buf_pointer++ = n + '0';
231 if ( ! i++ && (nr_of_digits || alternate_flag))
232 *buf_pointer++ = '.';
235 /* Rounding possible */
239 cp = buf_pointer - 1;
244 if ( (*cp += n) == ('9' + 1) )
252 } while (cp-- > buf);
261 if (*(cp - 1) == '.')
286 /* %G - Remove trailing zeros */
289 while (*(buf_pointer - 1) == '0')
291 if (*(buf_pointer - 1) == '.')
298 *buf_pointer++ = format_flag;
299 if (integral_10_log < 0)
301 *buf_pointer++ = '-';
302 integral_10_log = -integral_10_log;
305 *buf_pointer++ = '+';
311 *buf_pointer++ = (integral_10_log % 10) + '0';
312 integral_10_log /= 10;
313 } while ( integral_10_log || n < 2 );
314 for ( i = n ; n > 0 ; n-- )
315 *(buf_pointer - 11 - i + n) = *(buf_pointer - n);
318 return (buf_pointer);
321 #endif /* CONFIG_PRINTF > PRINTF_NOFLOAT */
324 * This routine forms the core and entry of the formatter.
326 * The conversion performed conforms to the ANSI specification for "printf".
329 PGM_FUNC(_formatted_write)(const char * PGM_ATTR format,
330 void put_one_char(char, void *),
331 void *secret_pointer,
334 #if CONFIG_PRINTF > PRINTF_REDUCED
335 MEM_ATTRIBUTE static char bad_conversion[] = "???";
336 MEM_ATTRIBUTE static char null_pointer[] = "<NULL>";
338 MEM_ATTRIBUTE int precision;
340 #if CONFIG_PRINTF_COUNT_CHARS
341 MEM_ATTRIBUTE int nr_of_chars;
343 MEM_ATTRIBUTE int field_width;
344 MEM_ATTRIBUTE char format_flag;
345 enum PLUS_SPACE_FLAGS {
346 PSF_NONE, PSF_PLUS, PSF_MINUS
350 #if CONFIG_PRINTF_OCTAL_FORMATTER
354 MEM_ATTRIBUTE struct {
355 enum PLUS_SPACE_FLAGS plus_space_flag : 2;
356 #if CONFIG_PRINTF_OCTAL_FORMATTER
357 enum DIV_FACTOR div_factor : 2;
359 enum DIV_FACTOR div_factor : 1;
361 bool left_adjust : 1;
362 bool l_L_modifier : 1;
364 bool alternate_flag : 1;
365 bool nonzero_value : 1;
371 MEM_ATTRIBUTE unsigned long ulong;
373 #if CONFIG_PRINTF > PRINTF_NOFLOAT
374 MEM_ATTRIBUTE max_float_t fvalue;
377 MEM_ATTRIBUTE char *buf_pointer;
378 MEM_ATTRIBUTE char *ptr;
379 MEM_ATTRIBUTE const char *hex;
380 MEM_ATTRIBUTE char buf[FRMWRI_BUFSIZE];
382 #if CONFIG_PRINTF_COUNT_CHARS
385 for (;;) /* Until full format string read */
387 while ((format_flag = PGM_READ_CHAR(format++)) != '%') /* Until '%' or '\0' */
390 #if CONFIG_PRINTF_RETURN_COUNT
391 return (nr_of_chars);
395 put_one_char(format_flag, secret_pointer);
396 #if CONFIG_PRINTF_COUNT_CHARS
400 if (PGM_READ_CHAR(format) == '%') /* %% prints as % */
403 put_one_char('%', secret_pointer);
404 #if CONFIG_PRINTF_COUNT_CHARS
410 flags.left_adjust = false;
411 flags.alternate_flag = false;
412 flags.plus_space_flag = PSF_NONE;
413 flags.zeropad = false;
415 flags.progmem = false;
417 ptr = buf_pointer = &buf[0];
420 /* check for leading '-', '+', ' ','#' or '0' flags */
423 switch (PGM_READ_CHAR(format))
426 if (flags.plus_space_flag)
429 flags.plus_space_flag = PSF_PLUS;
432 flags.left_adjust = true;
435 flags.alternate_flag = true;
438 flags.zeropad = true;
446 /* Optional field width (may be '*') */
447 if (PGM_READ_CHAR(format) == '*')
449 field_width = va_arg(ap, int);
452 field_width = -field_width;
453 flags.left_adjust = true;
460 while (PGM_READ_CHAR(format) >= '0' && PGM_READ_CHAR(format) <= '9')
461 field_width = field_width * 10 + (PGM_READ_CHAR(format++) - '0');
464 if (flags.left_adjust)
465 flags.zeropad = false;
467 /* Optional precision (or '*') */
468 if (PGM_READ_CHAR(format) == '.')
470 if (PGM_READ_CHAR(++format) == '*')
472 precision = va_arg(ap, int);
478 while (PGM_READ_CHAR(format) >= '0' && PGM_READ_CHAR(format) <= '9')
479 precision = precision * 10 + (PGM_READ_CHAR(format++) - '0');
485 /* At this point, "left_adjust" is nonzero if there was
486 * a sign, "zeropad" is 1 if there was a leading zero
487 * and 0 otherwise, "field_width" and "precision"
488 * contain numbers corresponding to the digit strings
489 * before and after the decimal point, respectively,
490 * and "plus_space_flag" is either 0 (no flag) or
491 * contains a plus or space character. If there was no
492 * decimal point, "precision" will be -1.
495 flags.l_L_modifier = false;
496 flags.h_modifier = false;
498 /* Optional 'l','L' r 'h' modifier? */
499 switch (PGM_READ_CHAR(format))
503 flags.l_L_modifier = true;
507 flags.h_modifier = true;
513 * At exit from the following switch, we will emit
514 * the characters starting at "buf_pointer" and
517 switch (format_flag = PGM_READ_CHAR(format++))
519 #if CONFIG_PRINTF_N_FORMATTER
521 if (sizeof(short) != sizeof(int))
523 if (sizeof(int) != sizeof(long))
526 *va_arg(ap, short *) = nr_of_chars;
527 else if (flags.l_L_modifier)
528 *va_arg(ap, long *) = nr_of_chars;
530 *va_arg(ap, int *) = nr_of_chars;
535 *va_arg(ap, short *) = nr_of_chars;
537 *va_arg(ap, int *) = nr_of_chars;
542 if (flags.l_L_modifier)
543 *va_arg(ap, long *) = nr_of_chars;
545 *va_arg(ap, int *) = nr_of_chars;
550 buf[0] = va_arg(ap, int);
554 /* Custom formatter for strings in program memory. */
557 flags.progmem = true;
562 if ( !(buf_pointer = va_arg(ap, char *)) )
563 buf_pointer = null_pointer;
568 * Move `ptr' to the last character of the
569 * string that will be actually printed.
575 for (n=0; pgm_read_char(ptr) && n < precision; n++)
580 for (n=0; *ptr && n < precision; n++)
584 #if CONFIG_PRINTF_OCTAL_FORMATTER
586 if (flags.alternate_flag && !precision)
594 if (format_flag == 'p')
595 #if defined(__AVR__) || defined(__I196__) /* 16bit pointers */
596 ulong = (unsigned long)(unsigned short)va_arg(ap, char *);
597 #else /* 32bit pointers */
598 ulong = (unsigned long)va_arg(ap, char *);
599 #endif /* 32bit pointers */
600 else if (flags.l_L_modifier)
601 ulong = va_arg(ap, unsigned long);
602 else if (flags.h_modifier)
603 ulong = (unsigned long)(unsigned short)va_arg(ap, unsigned int);
605 ulong = va_arg(ap, unsigned int);
608 #if CONFIG_PRINTF_OCTAL_FORMATTER
609 (format_flag == 'o') ? DIV_OCT :
611 (format_flag == 'u') ? DIV_DEC : DIV_HEX;
612 flags.plus_space_flag = PSF_NONE;
613 goto INTEGRAL_CONVERSION;
617 if (flags.l_L_modifier)
618 ulong = (unsigned long)(long)va_arg(ap, long);
620 ulong = (unsigned long)(long)va_arg(ap, int);
623 if ((signed long)ulong < 0)
625 flags.plus_space_flag = PSF_MINUS;
626 ulong = (unsigned long)(-((signed long)ulong));
629 flags.div_factor = DIV_DEC;
631 /* Now convert to digits */
633 ptr = buf_pointer = &buf[FRMWRI_BUFSIZE - 1];
634 flags.nonzero_value = (ulong != 0);
636 /* No char if zero and zero precision */
637 if (precision != 0 || flags.nonzero_value)
639 switch (flags.div_factor)
643 *--buf_pointer = hex[ulong % 10];
649 *--buf_pointer = hex[ulong % 16];
652 #if CONFIG_PRINTF_OCTAL_FORMATTER
655 *--buf_pointer = hex[ulong % 8];
662 /* "precision" takes precedence */
665 precision = field_width - (flags.plus_space_flag != PSF_NONE);
666 while (precision > (int)(ptr - buf_pointer))
667 *--buf_pointer = '0';
669 if (flags.alternate_flag && flags.nonzero_value)
671 if (format_flag == 'x' || format_flag == 'X')
673 *--buf_pointer = format_flag;
674 *--buf_pointer = '0';
676 #if CONFIG_PRINTF_OCTAL_FORMATTER
677 else if ((format_flag == 'o') && (*buf_pointer != '0'))
679 *--buf_pointer = '0';
683 ASSERT(buf_pointer >= buf);
686 #if CONFIG_PRINTF > PRINTF_NOFLOAT
695 goto FLOATING_CONVERSION;
707 if (sizeof(double) != sizeof(max_float_t))
709 fvalue = flags.l_L_modifier ?
710 va_arg(ap,max_float_t) : va_arg(ap,double);
713 fvalue = va_arg(ap,max_float_t);
717 flags.plus_space_flag = PSF_MINUS;
720 ptr = float_conversion (fvalue,
722 buf_pointer += field_width,
725 flags.alternate_flag);
728 precision = field_width - (flags.plus_space_flag != PSF_NONE);
729 while (precision > ptr - buf_pointer)
730 *--buf_pointer = '0';
734 #endif /* CONFIG_PRINTF <= PRINTF_NOFLOAT */
736 case '\0': /* Really bad place to find NUL in */
740 /* Undefined conversion! */
741 ptr = buf_pointer = bad_conversion;
742 ptr += sizeof(bad_conversion) - 1;
748 * This part emittes the formatted string to "put_one_char".
751 /* If field_width == 0 then nothing should be written. */
752 precision = ptr - buf_pointer;
754 if ( precision > field_width)
760 n = field_width - precision - (flags.plus_space_flag != PSF_NONE);
763 /* emit any leading pad characters */
764 if (!flags.left_adjust)
767 put_one_char(' ', secret_pointer);
768 #if CONFIG_PRINTF_COUNT_CHARS
773 /* emit flag characters (if any) */
774 if (flags.plus_space_flag)
776 put_one_char(flags.plus_space_flag == PSF_PLUS ? '+' : '-', secret_pointer);
777 #if CONFIG_PRINTF_COUNT_CHARS
785 while (--precision >= 0)
787 put_one_char(pgm_read_char(buf_pointer++), secret_pointer);
788 #if CONFIG_PRINTF_COUNT_CHARS
794 #endif /* CPU_HARVARD */
796 /* emit the string itself */
797 while (--precision >= 0)
799 put_one_char(*buf_pointer++, secret_pointer);
800 #if CONFIG_PRINTF_COUNT_CHARS
806 /* emit trailing space characters */
807 if (flags.left_adjust)
810 put_one_char(' ', secret_pointer);
811 #if CONFIG_PRINTF_COUNT_CHARS
817 #else /* PRINTF_REDUCED starts here */
819 #if CONFIG_PRINTF > PRINTF_NOMODIFIERS
820 char l_modifier, h_modifier;
821 unsigned long u_val, div_val;
823 unsigned int u_val, div_val;
824 #endif /* CONFIG_PRINTF > PRINTF_NOMODIFIERS */
827 unsigned int nr_of_chars, base;
832 for (;;) /* Until full format string read */
834 while ((format_flag = PGM_READ_CHAR(format++)) != '%') /* Until '%' or '\0' */
837 return (nr_of_chars);
838 put_one_char(format_flag, secret_pointer);
842 #if CONFIG_PRINTF > PRINTF_NOMODIFIERS
843 /*=================================*/
844 /* Optional 'l' or 'h' modifiers ? */
845 /*=================================*/
846 l_modifier = h_modifier = 0;
847 switch (PGM_READ_CHAR(format))
859 #endif /* CONFIG_PRINTF > PRINTF_NOMODIFIERS */
861 switch (format_flag = PGM_READ_CHAR(format++))
864 format_flag = va_arg(ap, int);
866 put_one_char(format_flag, secret_pointer);
871 ptr = va_arg(ap, char *);
872 while ((format_flag = *ptr++))
874 put_one_char(format_flag, secret_pointer);
884 div_val = 0x40000000;
885 goto CONVERSION_LOOP;
892 div_val = 1000000000;
893 goto CONVERSION_LOOP;
901 div_val = 0x10000000;
904 #if CONFIG_PRINTF > PRINTF_NOMODIFIERS
906 u_val = (format_flag == 'd') ?
907 (short)va_arg(ap, int) : (unsigned short)va_arg(ap, int);
909 u_val = va_arg(ap, long);
911 u_val = (format_flag == 'd') ?
912 va_arg(ap,int) : va_arg(ap,unsigned int);
913 #else /* CONFIG_PRINTF > PRINTF_NOMODIFIERS */
914 u_val = va_arg(ap,int);
915 #endif /* CONFIG_PRINTF > PRINTF_NOMODIFIERS */
916 if (format_flag == 'd')
918 if (((int)u_val) < 0)
921 put_one_char('-', secret_pointer);
925 while (div_val > 1 && div_val > u_val)
931 outChar = (u_val / div_val) + '0';
934 if (format_flag == 'x')
935 outChar += 'a'-'9'-1;
937 outChar += 'A'-'9'-1;
939 put_one_char(outChar, secret_pointer);
946 } /* end switch(format_flag...) */
948 #endif /* CONFIG_PRINTF > PRINTF_REDUCED */
951 #endif /* CONFIG_PRINTF */