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.12 2006/05/25 23:35:22 bernie
19 *#* Implement correct and faster clipping for algo text.
21 *#* Revision 1.11 2006/05/15 07:21:06 bernie
24 *#* Revision 1.10 2006/04/27 05:39:23 bernie
25 *#* Enhance text rendering to arbitrary x,y coords.
27 *#* Revision 1.9 2006/04/11 00:08:24 bernie
28 *#* text_offset(): New function, but I'm not quite confident with the design.
30 *#* Revision 1.8 2006/03/22 09:50:37 bernie
31 *#* Use the same format for fonts and rasters.
33 *#* Revision 1.7 2006/03/20 17:51:55 bernie
36 *#* Revision 1.6 2006/03/13 02:05:54 bernie
37 *#* Mark slow paths as UNLIKELY.
39 *#* Revision 1.5 2006/03/07 22:18:04 bernie
40 *#* Correctly compute text width for prop fonts; Make styles a per-bitmap attribute.
42 *#* Revision 1.4 2006/02/15 09:10:15 bernie
43 *#* Implement prop fonts; Fix algo styles.
45 *#* Revision 1.3 2006/02/10 12:31:55 bernie
46 *#* Add multiple font support in bitmaps.
48 *#* Revision 1.2 2005/11/04 18:17:45 bernie
49 *#* Fix header guards and includes for new location of gfx module.
51 *#* Revision 1.1 2005/11/04 18:11:35 bernie
52 *#* Move graphics stuff from mware/ to gfx/.
54 *#* Revision 1.13 2005/11/04 16:20:02 bernie
55 *#* Fix reference to README.devlib in header.
57 *#* Revision 1.12 2005/04/11 19:10:28 bernie
58 *#* Include top-level headers from cfg/ subdir.
60 *#* Revision 1.11 2005/01/20 18:46:31 aleph
61 *#* Fix progmem includes.
63 *#* Revision 1.10 2005/01/08 09:20:12 bernie
64 *#* Really make it work on both architectures.
66 *#* Revision 1.9 2004/12/31 16:44:29 bernie
67 *#* Sanitize for non-Harvard processors.
69 *#* Revision 1.8 2004/11/16 21:16:28 bernie
70 *#* Update to new naming scheme in mware/gfx.c.
72 *#* Revision 1.7 2004/09/20 03:28:28 bernie
75 *#* Revision 1.6 2004/09/14 20:57:15 bernie
76 *#* Use debug.h instead of kdebug.h.
78 *#* Revision 1.5 2004/09/06 21:51:26 bernie
79 *#* Extend interface to allow any algorithmic style.
81 *#* Revision 1.2 2004/06/03 11:27:09 bernie
82 *#* Add dual-license information.
84 *#* Revision 1.1 2004/05/23 15:43:16 bernie
85 *#* Import mware modules.
87 *#* Revision 1.17 2004/05/15 16:57:01 aleph
88 *#* Fixes for non-DEBUG build
90 *#* Revision 1.16 2004/04/03 20:42:49 aleph
93 *#* Revision 1.15 2004/03/24 15:03:45 bernie
94 *#* Use explicit include paths; clean Doxygen comments
96 *#* Revision 1.14 2004/03/19 16:52:28 bernie
97 *#* Move printf() like functions from text.c to text_format.c and add PROGMEM versions.
99 *#* Revision 1.13 2004/03/17 18:23:32 bernie
102 *#* Revision 1.12 2004/03/17 18:03:22 bernie
103 *#* Make diagnostic message shorter
105 *#* Revision 1.11 2004/03/13 22:52:54 aleph
106 *#* documentation fixes
110 #include <gfx/font.h>
111 #include <gfx/text.h>
112 #include <gfx/text.h>
114 #include <gfx/gfx_p.h> // FIXME: BM_DRAWPIXEL
116 #include <cfg/debug.h>
120 * ANSI escape sequences flag: true for ESC state on.
122 * \todo Move to Bitmap.flags.
124 static bool ansi_mode = false;
127 * Move (imaginary) cursor to coordinates specified.
129 void text_setCoord(struct Bitmap *bm, int x, int y)
137 * Move (imaginary) cursor to column and row specified.
138 * Next text write will start a that row and col.
140 void text_moveTo(struct Bitmap *bm, int row, int col)
143 ASSERT(col < bm->width / bm->font->width);
145 ASSERT(row < bm->height / bm->font->height);
147 text_setCoord(bm, col * bm->font->width, row * bm->font->height);
152 * Render char \a c on Bitmap \a bm.
154 static int text_putglyph(char c, struct Bitmap *bm)
156 const uint8_t * PROGMEM glyph; /* font is in progmem */
157 uint8_t glyph_width, glyph_height, glyph_height_bytes;
158 unsigned char index = (unsigned char)c;
160 /* Check for out of range char and replace with '?' or first char in font. */
161 if (UNLIKELY(!FONT_HAS_GLYPH(bm->font, index)))
163 kprintf("Illegal char '%c' (0x%02x)\n", index, index);
164 if (FONT_HAS_GLYPH(bm->font, '?'))
167 index = bm->font->first;
170 /* Make character relative to font start */
171 index -= bm->font->first;
173 glyph_height = bm->font->height;
174 // FIXME: for vertical fonts only
175 glyph_height_bytes = (glyph_height + 7) / 8;
177 if (bm->font->offset)
179 /* Proportional font */
180 glyph_width = bm->font->widths[index]; /* TODO: optimize away */
181 glyph = bm->font->glyph + bm->font->offset[index];
186 * Fixed-width font: compute the first column of pixels
187 * of the selected glyph using the character code to index
190 glyph_width = bm->font->width;
192 //For horizontal fonts
193 //glyph = bm->font->glyph + index * (((glyph_width + 7) / 8) * glyph_height);
194 glyph = bm->font->glyph + index * glyph_height_bytes * glyph_width;
197 /* Slow path for styled glyphs */
198 if (UNLIKELY(bm->styles))
200 uint8_t styles = bm->styles;
201 uint8_t prev_dots = 0, italic_prev_dots = 0;
203 uint8_t row, col, row_bit;
206 * To avoid repeating clipping and other expensive computations,
207 * we cluster calls to gfx_blitRaster() using a small buffer.
209 #define CONFIG_TEXT_RENDER_OPTIMIZE 1
210 #if CONFIG_TEXT_RENDER_OPTIMIZE
211 #define RENDER_BUF_WIDTH 12
212 #define RENDER_BUF_HEIGHT 8
213 uint8_t render_buf[RAST_SIZE(RENDER_BUF_WIDTH, RENDER_BUF_HEIGHT)];
214 uint8_t render_xpos = 0;
217 /* This style alone could be handled by the fast path too */
218 if (bm->styles & STYLEF_CONDENSED)
221 if (bm->styles & STYLEF_EXPANDED)
224 for (row = 0, row_bit = 0; row < glyph_height_bytes; ++row, row_bit += 8)
226 /* For each dot column in the glyph... */
227 for (col = 0; col < glyph_width; ++col)
229 uint8_t src_col = col;
231 /* Expanded style: advances only once every two columns. */
232 if (styles & STYLEF_EXPANDED)
235 /* Fetch a column of dots from glyph. */
236 dots = PGM_READ_CHAR(RAST_ADDR(glyph, src_col, row_bit, glyph_width));
238 /* Italic: get lower 4 dots from previous column */
239 if (styles & STYLEF_ITALIC)
241 uint8_t new_dots = dots;
242 dots = (dots & 0xF0) | italic_prev_dots;
243 italic_prev_dots = new_dots & 0x0F;
246 /* Bold: "or" pixels with the previous column */
247 if (styles & STYLEF_BOLD)
249 uint8_t new_dots = dots;
251 prev_dots = new_dots;
254 /* Underlined: turn on base pixel */
255 if ((styles & STYLEF_UNDERLINE)
256 && (row == glyph_height_bytes - 1))
257 dots |= (1 << (glyph_height - row_bit - 1));
259 /* Inverted: invert pixels */
260 if (styles & STYLEF_INVERT)
264 #if CONFIG_TEXT_RENDER_OPTIMIZE
265 render_buf[render_xpos++] = dots;
266 if (render_xpos == RENDER_BUF_WIDTH)
268 gfx_blitRaster(bm, bm->penX + col - render_xpos + 1, bm->penY + row_bit,
269 render_buf, render_xpos,
270 MIN((uint8_t)RENDER_BUF_HEIGHT, (uint8_t)(glyph_height - row_bit)),
275 gfx_blitRaster(bm, bm->penX + col, bm->penY + row_bit,
276 &dots, 1, MIN((uint8_t)8, glyph_height - row_bit), 1);
280 #if CONFIG_TEXT_RENDER_OPTIMIZE
281 /* Flush out rest of render buffer */
282 if (render_xpos != 0)
284 gfx_blitRaster(bm, bm->penX + col - render_xpos, bm->penY + row_bit,
285 render_buf, render_xpos,
286 MIN((uint8_t)RENDER_BUF_HEIGHT, (uint8_t)(glyph_height - row_bit)),
295 /* No style: fast vanilla copy of glyph to bitmap */
296 gfx_blitRaster(bm, bm->penX, bm->penY, glyph, glyph_width, glyph_height, glyph_width);
299 /* Update current pen position */
300 bm->penX += glyph_width;
307 * Render char \c c, with (currently) limited ANSI escapes
308 * emulation support and '\n' for newline.
310 int text_putchar(char c, struct Bitmap *bm)
312 /* Handle ANSI escape sequences */
313 if (UNLIKELY(ansi_mode))
317 case ANSI_ESC_CLEARSCREEN:
321 text_style(bm, 0, STYLEF_MASK);
324 kprintf("Unknown ANSI esc code: %x\n", c);)
328 else if (c == '\033') /* Enter ANSI ESC mode */
332 else if (c == '\n') /* Go one line down on a line-feed */
334 if (bm->penY + bm->font->height < bm->height)
336 bm->penY += bm->font->height;
342 text_putglyph(c, bm);
349 * Clear the screen and reset cursor position
351 void text_clear(struct Bitmap *bmp)
353 text_putchar('\x1b', bmp);
354 text_putchar('c', bmp);
358 void text_clearLine(struct Bitmap *bm, int line)
360 gfx_rectClear(bm, 0, line * bm->font->height, bm->width, (line + 1) * bm->font->height);
365 * Set/clear algorithmic font style bits.
367 * \param bm Pointer to Bitmap to affect.
368 * \param flags Style flags to set
369 * \param mask Mask of flags to modify
370 * \return Old style flags
373 * Turn on bold, leave other styles alone
374 * \code text_style(bm, STYLEF_BOLD, STYLEF_BOLD); \endcode
376 * Turn off bold and turn on italic, leave others as they are
377 * \code text_style(bm, STYLEF_ITALIC, STYLEF_BOLD | STYLEF_ITALIC); \endcode
379 * Query current style without chaning it
380 * \code style = text_style(bm, 0, 0); \endcode
382 * Reset all styles (plain text)
383 * \code text_style(bm, 0, STYLE_MASK); \endcode
385 uint8_t text_style(struct Bitmap *bm, uint8_t flags, uint8_t mask)
387 uint8_t old = bm->styles;
388 bm->styles = (bm->styles & ~mask) | flags;