4 * Copyright 2003, 2004, 2005 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 Text graphic routines
12 * \author Bernardo Innocenti <bernie@develer.com>
13 * \author Stefano Fedrigo <aleph@develer.com>
18 *#* Revision 1.11 2006/05/15 07:21:06 bernie
21 *#* Revision 1.10 2006/04/27 05:39:23 bernie
22 *#* Enhance text rendering to arbitrary x,y coords.
24 *#* Revision 1.9 2006/04/11 00:08:24 bernie
25 *#* text_offset(): New function, but I'm not quite confident with the design.
27 *#* Revision 1.8 2006/03/22 09:50:37 bernie
28 *#* Use the same format for fonts and rasters.
30 *#* Revision 1.7 2006/03/20 17:51:55 bernie
33 *#* Revision 1.6 2006/03/13 02:05:54 bernie
34 *#* Mark slow paths as UNLIKELY.
36 *#* Revision 1.5 2006/03/07 22:18:04 bernie
37 *#* Correctly compute text width for prop fonts; Make styles a per-bitmap attribute.
39 *#* Revision 1.4 2006/02/15 09:10:15 bernie
40 *#* Implement prop fonts; Fix algo styles.
42 *#* Revision 1.3 2006/02/10 12:31:55 bernie
43 *#* Add multiple font support in bitmaps.
45 *#* Revision 1.2 2005/11/04 18:17:45 bernie
46 *#* Fix header guards and includes for new location of gfx module.
48 *#* Revision 1.1 2005/11/04 18:11:35 bernie
49 *#* Move graphics stuff from mware/ to gfx/.
51 *#* Revision 1.13 2005/11/04 16:20:02 bernie
52 *#* Fix reference to README.devlib in header.
54 *#* Revision 1.12 2005/04/11 19:10:28 bernie
55 *#* Include top-level headers from cfg/ subdir.
57 *#* Revision 1.11 2005/01/20 18:46:31 aleph
58 *#* Fix progmem includes.
60 *#* Revision 1.10 2005/01/08 09:20:12 bernie
61 *#* Really make it work on both architectures.
63 *#* Revision 1.9 2004/12/31 16:44:29 bernie
64 *#* Sanitize for non-Harvard processors.
66 *#* Revision 1.8 2004/11/16 21:16:28 bernie
67 *#* Update to new naming scheme in mware/gfx.c.
69 *#* Revision 1.7 2004/09/20 03:28:28 bernie
72 *#* Revision 1.6 2004/09/14 20:57:15 bernie
73 *#* Use debug.h instead of kdebug.h.
75 *#* Revision 1.5 2004/09/06 21:51:26 bernie
76 *#* Extend interface to allow any algorithmic style.
78 *#* Revision 1.2 2004/06/03 11:27:09 bernie
79 *#* Add dual-license information.
81 *#* Revision 1.1 2004/05/23 15:43:16 bernie
82 *#* Import mware modules.
84 *#* Revision 1.17 2004/05/15 16:57:01 aleph
85 *#* Fixes for non-DEBUG build
87 *#* Revision 1.16 2004/04/03 20:42:49 aleph
90 *#* Revision 1.15 2004/03/24 15:03:45 bernie
91 *#* Use explicit include paths; clean Doxygen comments
93 *#* Revision 1.14 2004/03/19 16:52:28 bernie
94 *#* Move printf() like functions from text.c to text_format.c and add PROGMEM versions.
96 *#* Revision 1.13 2004/03/17 18:23:32 bernie
99 *#* Revision 1.12 2004/03/17 18:03:22 bernie
100 *#* Make diagnostic message shorter
102 *#* Revision 1.11 2004/03/13 22:52:54 aleph
103 *#* documentation fixes
107 #include <gfx/font.h>
108 #include <gfx/text.h>
109 #include <gfx/text.h>
111 #include <gfx/gfx_p.h> // FIXME: BM_DRAWPIXEL
113 #include <cfg/debug.h>
117 * ANSI escape sequences flag: true for ESC state on.
119 * \todo Move to Bitmap.flags.
121 static bool ansi_mode = false;
124 * Move (imaginary) cursor to coordinates specified.
126 void text_setCoord(struct Bitmap *bm, int x, int y)
134 * Move (imaginary) cursor to column and row specified.
135 * Next text write will start a that row and col.
137 void text_moveTo(struct Bitmap *bm, int row, int col)
140 ASSERT(col < bm->width / bm->font->width);
142 ASSERT(row < bm->height / bm->font->height);
144 text_setCoord(bm, col * bm->font->width, row * bm->font->height);
149 * Render char \a c on Bitmap \a bm.
151 static int text_putglyph(char c, struct Bitmap *bm)
153 const uint8_t * PROGMEM glyph; /* font is in progmem */
154 uint8_t glyph_width, glyph_height, glyph_height_bytes;
155 unsigned char index = (unsigned char)c;
157 /* Check for out of range char and replace with '?' or first char in font. */
158 if (UNLIKELY(!FONT_HAS_GLYPH(bm->font, index)))
160 kprintf("Illegal char '%c' (0x%02x)\n", index, index);
161 if (FONT_HAS_GLYPH(bm->font, '?'))
164 index = bm->font->first;
167 /* Make character relative to font start */
168 index -= bm->font->first;
170 glyph_height = bm->font->height;
171 // FIXME: for vertical fonts only
172 glyph_height_bytes = ROUND_UP2(glyph_height, 8);
174 if (bm->font->offset)
176 /* Proportional font */
177 glyph_width = bm->font->widths[index]; /* TODO: optimize away */
178 glyph = bm->font->glyph + bm->font->offset[index];
183 * Fixed-width font: compute the first column of pixels
184 * of the selected glyph using the character code to index
187 glyph_width = bm->font->width;
189 //For horizontal fonts
190 //glyph = bm->font->glyph + index * (((glyph_width + 7) / 8) * glyph_height);
191 glyph = bm->font->glyph + index * glyph_height_bytes * glyph_width;
194 /* Slow path for styled glyphs */
195 if (UNLIKELY(bm->styles))
197 uint8_t styles = bm->styles;
198 uint8_t prev_dots = 0, italic_prev_dots = 0;
202 /* This style alone could be handled by the fast path too */
203 if (bm->styles & STYLEF_CONDENSED)
206 if (bm->styles & STYLEF_EXPANDED)
209 /* Check if glyph fits in the bitmap. */
210 if ((bm->penX < 0) || (bm->penX + glyph_width > bm->width)
211 || (bm->penY < 0) || (bm->penY + glyph_height > bm->height))
213 kprintf("bad coords x=%d y=%d\n", bm->penX, bm->penY);
217 for (row = 0; row < glyph_height_bytes; ++row)
219 /* For each dot column in the glyph... */
220 for (col = 0; col < glyph_width; ++col)
222 uint8_t src_col = col;
225 /* Expanded style: advances only once every two columns. */
226 if (styles & STYLEF_EXPANDED)
229 /* Fetch a column of dots from glyph. */
230 dots = PGM_READ_CHAR(RAST_ADDR(glyph, src_col, row * 8, glyph_width));
232 /* Italic: get lower 4 dots from previous column */
233 if (styles & STYLEF_ITALIC)
235 uint8_t new_dots = dots;
236 dots = (dots & 0xF0) | italic_prev_dots;
237 italic_prev_dots = new_dots & 0x0F;
240 /* Bold: "or" pixels with the previous column */
241 if (styles & STYLEF_BOLD)
243 uint8_t new_dots = dots;
245 prev_dots = new_dots;
248 /* Underlined: turn on base pixel */
249 if ((styles & STYLEF_UNDERLINE)
250 && (row == glyph_height_bytes - 1))
251 dots |= (1 << (glyph_height - row * 8 - 1));
253 /* Inverted: invert pixels */
254 if (styles & STYLEF_INVERT)
258 for (i = 0; i < 8 && (row * 8) + i < glyph_height; ++i)
259 BM_DRAWPIXEL(bm, bm->penX + col, bm->penY + row * 8 + i, dots & (1<<i));
265 /* No style: fast vanilla copy of glyph to bitmap */
266 gfx_blitRaster(bm, bm->penX, bm->penY, glyph, glyph_width, glyph_height, glyph_width);
269 /* Update current pen position */
270 bm->penX += glyph_width;
277 * Render char \c c, with (currently) limited ANSI escapes
278 * emulation support and '\n' for newline.
280 int text_putchar(char c, struct Bitmap *bm)
282 /* Handle ANSI escape sequences */
283 if (UNLIKELY(ansi_mode))
287 case ANSI_ESC_CLEARSCREEN:
291 text_style(bm, 0, STYLEF_MASK);
294 kprintf("Unknown ANSI esc code: %x\n", c);)
298 else if (c == '\033') /* Enter ANSI ESC mode */
302 else if (c == '\n') /* Go one line down on a line-feed */
304 if (bm->penY + bm->font->height < bm->height)
306 bm->penY += bm->font->height;
312 text_putglyph(c, bm);
319 * Clear the screen and reset cursor position
321 void text_clear(struct Bitmap *bmp)
323 text_putchar('\x1b', bmp);
324 text_putchar('c', bmp);
328 void text_clearLine(struct Bitmap *bm, int line)
330 gfx_rectClear(bm, 0, line * bm->font->height, bm->width, (line + 1) * bm->font->height);
335 * Set/clear algorithmic font style bits.
337 * \param bm Pointer to Bitmap to affect.
338 * \param flags Style flags to set
339 * \param mask Mask of flags to modify
340 * \return Old style flags
343 * Turn on bold, leave other styles alone
344 * \code text_style(bm, STYLEF_BOLD, STYLEF_BOLD); \endcode
346 * Turn off bold and turn on italic, leave others as they are
347 * \code text_style(bm, STYLEF_ITALIC, STYLEF_BOLD | STYLEF_ITALIC); \endcode
349 * Query current style without chaning it
350 * \code style = text_style(bm, 0, 0); \endcode
352 * Reset all styles (plain text)
353 * \code text_style(bm, 0, STYLE_MASK); \endcode
355 uint8_t text_style(struct Bitmap *bm, uint8_t flags, uint8_t mask)
357 uint8_t old = bm->styles;
358 bm->styles = (bm->styles & ~mask) | flags;