4 * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
5 * Copyright 1999 Bernardo Innocenti <bernie@develer.com>
6 * This file is part of DevLib - See README.devlib for information.
9 * \brief printf-family routines for text output
12 * \author Bernardo Innocenti <bernie@develer.com>
13 * \author Stefano Fedrigo <aleph@develer.com>
18 *#* Revision 1.7 2006/03/20 17:51:55 bernie
21 *#* Revision 1.6 2006/03/13 02:05:54 bernie
22 *#* Mark slow paths as UNLIKELY.
24 *#* Revision 1.5 2006/03/07 22:18:04 bernie
25 *#* Correctly compute text width for prop fonts; Make styles a per-bitmap attribute.
27 *#* Revision 1.4 2006/02/10 12:31:33 bernie
28 *#* Add multiple font support in bitmaps.
30 *#* Revision 1.3 2005/11/27 23:31:58 bernie
33 *#* Revision 1.2 2005/11/04 18:17:45 bernie
34 *#* Fix header guards and includes for new location of gfx module.
36 *#* Revision 1.1 2005/11/04 18:11:35 bernie
37 *#* Move graphics stuff from mware/ to gfx/.
39 *#* Revision 1.10 2005/11/04 16:20:02 bernie
40 *#* Fix reference to README.devlib in header.
42 *#* Revision 1.9 2004/12/31 17:47:45 bernie
43 *#* Rename UNUSED() to UNUSED_ARG().
45 *#* Revision 1.8 2004/11/16 21:16:56 bernie
46 *#* Update to new naming scheme in mware/gfx.c.
48 *#* Revision 1.7 2004/10/03 19:05:04 bernie
49 *#* text_widthf(), text_vwidthf(): New functions.
51 *#* Revision 1.6 2004/09/14 20:59:04 bernie
52 *#* text_xprintf(): Support all styles; Pixel-wise text centering.
54 *#* Revision 1.5 2004/08/25 14:12:09 rasky
55 *#* Aggiornato il comment block dei log RCS
57 *#* Revision 1.4 2004/08/05 18:46:44 bernie
58 *#* Documentation improvements.
60 *#* Revision 1.3 2004/08/03 15:57:18 aleph
61 *#* Add include to fix warning for vsprintf()
63 *#* Revision 1.2 2004/06/03 11:27:09 bernie
64 *#* Add dual-license information.
66 *#* Revision 1.1 2004/05/23 15:43:16 bernie
67 *#* Import mware modules.
69 *#* Revision 1.2 2004/03/26 18:50:50 bernie
70 *#* Move _PROGMEM stuff to compiler.h
72 *#* Revision 1.1 2004/03/19 16:52:28 bernie
73 *#* Move printf() like functions from text.c to text_format.c and add PROGMEM versions.
79 #include <mware/formatwr.h> /* _formatted_write() */
83 #include <stdio.h> /* vsprintf() */
85 #include <string.h> /* strlen() */
88 * Render string \a str in Bitmap \a bm at current cursor position
90 * \note Text formatting functions are also available with an _P suffix
91 * accepting the source string from program memory. This feature
92 * is only available (and useful) on Harvard microprocessors such
97 int PGM_FUNC(text_puts)(const char * PGM_ATTR str, struct Bitmap *bm)
101 while ((c = PGM_READ_CHAR(str++)))
109 * vprintf()-like formatter to render text in a Bitmap.
111 * Perform vprintf()-like formatting on the \a fmt format string using the
112 * variable-argument list \a ap.
113 * Render the resulting string in Bitmap \a bm starting at the current
116 * \see text_puts() text_putchar() text_printf()
118 int PGM_FUNC(text_vprintf)(struct Bitmap *bm, const char * PGM_ATTR fmt, va_list ap)
120 return PGM_FUNC(_formatted_write)(fmt, (void (*)(char, void *))text_putchar, bm, ap);
124 * printf()-like formatter to render text in a Bitmap.
126 * Perform printf()-like formatting on the \a fmt format string.
127 * Render the resulting string in Bitmap \a bm starting at the
128 * current cursor position.
130 * \see text_puts() text_putchar() text_vprintf()
132 int PGM_FUNC(text_printf)(struct Bitmap *bm, const char * PGM_ATTR fmt, ...)
138 len = PGM_FUNC(text_vprintf)(bm, fmt, ap);
146 * Render the result of printf()-like formatting in a specified position
149 * \param bm Bitmap where to render the text
150 * \param row Starting row in character units (zero based)
151 * \param col Starting column in character units (zero based)
152 * \param style Formatting style to use. In addition to any STYLEF_
153 * flag, it can be TEXT_NORMAL, TEXT_FILL, TEXT_INVERT or
154 * TEXT_RIGHT, or a combination of these flags ORed together.
155 * \param fmt String possibly containing printf() formatting commands.
157 * \see text_puts() text_putchar() text_printf() text_vprintf()
158 * \see text_moveto() text_style()
160 int PGM_FUNC(text_xprintf)(struct Bitmap *bm,
161 uint8_t row, uint8_t col, uint16_t style, const char * PGM_ATTR fmt, ...)
164 uint8_t oldstyle = 0;
169 text_moveto(bm, row, col);
171 if (style & STYLEF_MASK)
172 oldstyle = text_style(bm, style, STYLEF_MASK);
174 if (style & (TEXT_CENTER | TEXT_RIGHT))
176 uint8_t pad = bm->width - PGM_FUNC(text_vwidthf)(bm, fmt, ap);
178 if (style & TEXT_CENTER)
181 if (style & TEXT_FILL)
182 gfx_rectFillC(bm, 0, row * bm->font->height, pad, (row + 1) * bm->font->height,
183 (style & STYLEF_INVERT) ? 0xFF : 0x00);
185 text_setcoord(bm, pad, row * bm->font->height);
188 len = PGM_FUNC(text_vprintf)(bm, fmt, ap);
191 if (style & TEXT_FILL)
192 gfx_rectFillC(bm, bm->penX, row * bm->font->height, bm->width, (row + 1) * bm->font->height,
193 (style & STYLEF_INVERT) ? 0xFF : 0x00);
195 /* Restore old style */
196 if (style & STYLEF_MASK)
197 text_style(bm, oldstyle, STYLEF_MASK);
210 * Compute width in pixels of a character.
212 * Compute the on screen width of a character, taking the
213 * current style and font into account.
215 * The width is accumulated in the WidthData structure
216 * passed as second argument.
218 * This is a formatted_write() callback used by text_vwidthf()
219 * to compute the length of a formatted string.
221 static int text_charWidth(int c, struct TextWidthData *twd)
223 unsigned char index = (unsigned char)c;
224 Bitmap *bm = twd->bitmap;
228 if (UNLIKELY(!FONT_HAS_GLYPH(bm->font, index)))
230 if (!FONT_HAS_GLYPH(bm->font, '?'))
233 index = bm->font->first;
236 /* Make character relative to font start */
237 index -= bm->font->first;
239 if (bm->font->offset)
240 /* Proportional font */
241 glyph_width = bm->font->widths[index]; /* TODO: optimize away */
243 /* Fixed width font */
244 glyph_width = bm->font->width;
246 if (bm->styles & STYLEF_CONDENSED)
249 if (bm->styles & STYLEF_EXPANDED)
252 twd->width += glyph_width;
258 * Return the width in pixels of a vprintf()-formatted string.
260 int PGM_FUNC(text_vwidthf)(
261 UNUSED_ARG(struct Bitmap *, bm),
262 const char * PGM_ATTR fmt,
265 /* Fixed font with no styles affecting the width? */
266 if (!bm->font->offset && !(bm->styles & (STYLEF_CONDENSED | STYLEF_EXPANDED)))
267 return PGM_FUNC(vsprintf)(NULL, fmt, ap) * bm->font->width;
270 struct TextWidthData twd = { bm, 0 };
271 _formatted_write(fmt, (void (*)(char, void *))text_charWidth, &twd, ap);
278 * Return the width in pixels of a printf()-formatted string.
280 int PGM_FUNC(text_widthf)(struct Bitmap *bm, const char * PGM_ATTR fmt, ...)
286 width = PGM_FUNC(text_vwidthf)(bm, fmt, ap);