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.9 2006/04/27 05:39:24 bernie
19 *#* Enhance text rendering to arbitrary x,y coords.
21 *#* Revision 1.8 2006/03/22 09:50:11 bernie
22 *#* Don't use C99 stuff.
24 *#* Revision 1.7 2006/03/20 17:51:55 bernie
27 *#* Revision 1.6 2006/03/13 02:05:54 bernie
28 *#* Mark slow paths as UNLIKELY.
30 *#* Revision 1.5 2006/03/07 22:18:04 bernie
31 *#* Correctly compute text width for prop fonts; Make styles a per-bitmap attribute.
33 *#* Revision 1.4 2006/02/10 12:31:33 bernie
34 *#* Add multiple font support in bitmaps.
36 *#* Revision 1.3 2005/11/27 23:31:58 bernie
39 *#* Revision 1.2 2005/11/04 18:17:45 bernie
40 *#* Fix header guards and includes for new location of gfx module.
42 *#* Revision 1.1 2005/11/04 18:11:35 bernie
43 *#* Move graphics stuff from mware/ to gfx/.
45 *#* Revision 1.10 2005/11/04 16:20:02 bernie
46 *#* Fix reference to README.devlib in header.
48 *#* Revision 1.9 2004/12/31 17:47:45 bernie
49 *#* Rename UNUSED() to UNUSED_ARG().
51 *#* Revision 1.8 2004/11/16 21:16:56 bernie
52 *#* Update to new naming scheme in mware/gfx.c.
54 *#* Revision 1.7 2004/10/03 19:05:04 bernie
55 *#* text_widthf(), text_vwidthf(): New functions.
57 *#* Revision 1.6 2004/09/14 20:59:04 bernie
58 *#* text_xprintf(): Support all styles; Pixel-wise text centering.
60 *#* Revision 1.5 2004/08/25 14:12:09 rasky
61 *#* Aggiornato il comment block dei log RCS
63 *#* Revision 1.4 2004/08/05 18:46:44 bernie
64 *#* Documentation improvements.
66 *#* Revision 1.3 2004/08/03 15:57:18 aleph
67 *#* Add include to fix warning for vsprintf()
69 *#* Revision 1.2 2004/06/03 11:27:09 bernie
70 *#* Add dual-license information.
72 *#* Revision 1.1 2004/05/23 15:43:16 bernie
73 *#* Import mware modules.
75 *#* Revision 1.2 2004/03/26 18:50:50 bernie
76 *#* Move _PROGMEM stuff to compiler.h
78 *#* Revision 1.1 2004/03/19 16:52:28 bernie
79 *#* Move printf() like functions from text.c to text_format.c and add PROGMEM versions.
85 #include <mware/formatwr.h> /* _formatted_write() */
89 #include <stdio.h> /* vsprintf() */
91 #include <string.h> /* strlen() */
94 * Render string \a str in Bitmap \a bm at current cursor position
96 * \note Text formatting functions are also available with an _P suffix
97 * accepting the source string from program memory. This feature
98 * is only available (and useful) on Harvard microprocessors such
101 * \see text_putchar()
103 int PGM_FUNC(text_puts)(const char * PGM_ATTR str, struct Bitmap *bm)
107 while ((c = PGM_READ_CHAR(str++)))
115 * vprintf()-like formatter to render text in a Bitmap.
117 * Perform vprintf()-like formatting on the \a fmt format string using the
118 * variable-argument list \a ap.
119 * Render the resulting string in Bitmap \a bm starting at the current
122 * \see text_puts() text_putchar() text_printf()
124 int PGM_FUNC(text_vprintf)(struct Bitmap *bm, const char * PGM_ATTR fmt, va_list ap)
126 return PGM_FUNC(_formatted_write)(fmt, (void (*)(char, void *))text_putchar, bm, ap);
130 * printf()-like formatter to render text in a Bitmap.
132 * Perform printf()-like formatting on the \a fmt format string.
133 * Render the resulting string in Bitmap \a bm starting at the
134 * current cursor position.
136 * \see text_puts() text_putchar() text_vprintf()
138 int PGM_FUNC(text_printf)(struct Bitmap *bm, const char * PGM_ATTR fmt, ...)
144 len = PGM_FUNC(text_vprintf)(bm, fmt, ap);
151 * Render text with vprintf()-like formatting at a specified pixel position.
153 * \see text_xyprintf()
155 int PGM_FUNC(text_xyvprintf)(struct Bitmap *bm,
156 coord_t x, coord_t y, uint16_t style, const char * PGM_ATTR fmt, va_list ap)
159 uint8_t oldstyle = 0;
161 text_setCoord(bm, x, y);
163 if (style & STYLEF_MASK)
164 oldstyle = text_style(bm, style, STYLEF_MASK);
166 if (style & (TEXT_CENTER | TEXT_RIGHT))
168 uint8_t pad = bm->width - PGM_FUNC(text_vwidthf)(bm, fmt, ap);
170 if (style & TEXT_CENTER)
173 if (style & TEXT_FILL)
174 gfx_rectFillC(bm, 0, y, pad, y + bm->font->height,
175 (style & STYLEF_INVERT) ? 0xFF : 0x00);
177 text_setCoord(bm, pad, y);
180 len = PGM_FUNC(text_vprintf)(bm, fmt, ap);
182 if (style & TEXT_FILL)
183 gfx_rectFillC(bm, bm->penX, y, bm->width, y + bm->font->height,
184 (style & STYLEF_INVERT) ? 0xFF : 0x00);
186 /* Restore old style */
187 if (style & STYLEF_MASK)
188 text_style(bm, oldstyle, STYLEF_MASK);
195 * Render text with printf()-like formatting at a specified pixel position.
197 * \param bm Bitmap where to render the text
198 * \param x [pixels] Initial X coordinate of text.
199 * \param y [pixels] Coordinate of top border of text.
200 * \param style Formatting style to use. In addition to any STYLEF_
201 * flag, it can be TEXT_NORMAL, TEXT_FILL, TEXT_INVERT or
202 * TEXT_RIGHT, or a combination of these flags ORed together.
203 * \param fmt String possibly containing printf() formatting commands.
205 * \see text_puts() text_putchar() text_printf() text_vprintf()
206 * \see text_moveTo() text_style()
208 int PGM_FUNC(text_xyprintf)(struct Bitmap *bm,
209 coord_t x, coord_t y, uint16_t style, const char * PGM_ATTR fmt, ...)
215 len = PGM_FUNC(text_xyvprintf)(bm, x, y, style, fmt, ap);
223 * Render text with printf()-like formatting at a specified row/column position.
225 * \see text_xyprintf()
227 int PGM_FUNC(text_xprintf)(struct Bitmap *bm,
228 uint8_t row, uint8_t col, uint16_t style, const char * PGM_ATTR fmt, ...)
234 len = PGM_FUNC(text_xyvprintf)(
235 bm, col * bm->font->width, row * bm->font->height,
250 * Compute width in pixels of a character.
252 * Compute the on screen width of a character, taking the
253 * current style and font into account.
255 * The width is accumulated in the WidthData structure
256 * passed as second argument.
258 * This is a formatted_write() callback used by text_vwidthf()
259 * to compute the length of a formatted string.
261 static int text_charWidth(int c, struct TextWidthData *twd)
263 unsigned char index = (unsigned char)c;
264 Bitmap *bm = twd->bitmap;
268 if (UNLIKELY(!FONT_HAS_GLYPH(bm->font, index)))
270 if (!FONT_HAS_GLYPH(bm->font, '?'))
273 index = bm->font->first;
276 /* Make character relative to font start */
277 index -= bm->font->first;
279 if (bm->font->offset)
280 /* Proportional font */
281 glyph_width = bm->font->widths[index]; /* TODO: optimize away */
283 /* Fixed width font */
284 glyph_width = bm->font->width;
286 if (bm->styles & STYLEF_CONDENSED)
289 if (bm->styles & STYLEF_EXPANDED)
292 twd->width += glyph_width;
298 * Return the width in pixels of a vprintf()-formatted string.
300 int PGM_FUNC(text_vwidthf)(
301 UNUSED_ARG(struct Bitmap *, bm),
302 const char * PGM_ATTR fmt,
305 /* Fixed font with no styles affecting the width? */
306 if (!bm->font->offset && !(bm->styles & (STYLEF_CONDENSED | STYLEF_EXPANDED)))
307 return PGM_FUNC(vsprintf)(NULL, fmt, ap) * bm->font->width;
310 struct TextWidthData twd;
313 _formatted_write(fmt, (void (*)(char, void *))text_charWidth, &twd, ap);
320 * Return the width in pixels of a printf()-formatted string.
322 int PGM_FUNC(text_widthf)(struct Bitmap *bm, const char * PGM_ATTR fmt, ...)
328 width = PGM_FUNC(text_vwidthf)(bm, fmt, ap);