4 * This file is part of BeRTOS.
6 * Bertos is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * As a special exception, you may use this file as part of a free software
21 * library without restriction. Specifically, if other files instantiate
22 * templates or use macros or inline functions from this file, or you compile
23 * this file and link it with other files to produce an executable, this
24 * file does not by itself cause the resulting executable to be covered by
25 * the GNU General Public License. This exception does not however
26 * invalidate any other reasons why the executable file might be covered by
27 * the GNU General Public License.
29 * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
30 * Copyright 1999 Bernie Innocenti <bernie@codewiz.org>
35 * \author Bernie Innocenti <bernie@codewiz.org>
36 * \author Stefano Fedrigo <aleph@develer.com>
38 * \brief Text graphic routines
45 #include <gfx/gfx_p.h> // FIXME: BM_DRAWPIXEL
47 #include <cfg/debug.h>
51 * ANSI escape sequences flag: true for ESC state on.
53 * \todo Move to Bitmap.flags.
55 static bool ansi_mode = false;
58 * Move (imaginary) cursor to coordinates specified.
60 void text_setCoord(struct Bitmap *bm, int x, int y)
68 * Move (imaginary) cursor to column and row specified.
69 * Next text write will start a that row and col.
71 void text_moveTo(struct Bitmap *bm, int row, int col)
74 ASSERT(col < bm->width / bm->font->width);
76 ASSERT(row < bm->height / bm->font->height);
78 text_setCoord(bm, col * bm->font->width, row * bm->font->height);
83 * Render char \a c on Bitmap \a bm.
85 static int text_putglyph(char c, struct Bitmap *bm)
87 const uint8_t * PROGMEM glyph; /* font is in progmem */
88 uint8_t glyph_width, glyph_height, glyph_height_bytes;
89 unsigned char index = (unsigned char)c;
91 /* Check for out of range char and replace with '?' or first char in font. */
92 if (UNLIKELY(!FONT_HAS_GLYPH(bm->font, index)))
94 kprintf("Illegal char '%c' (0x%02x)\n", index, index);
95 if (FONT_HAS_GLYPH(bm->font, '?'))
98 index = bm->font->first;
101 /* Make character relative to font start */
102 index -= bm->font->first;
104 glyph_height = bm->font->height;
105 // FIXME: for vertical fonts only
106 glyph_height_bytes = (glyph_height + 7) / 8;
108 if (bm->font->offset)
110 /* Proportional font */
111 glyph_width = bm->font->widths[index]; /* TODO: optimize away */
112 glyph = bm->font->glyph + bm->font->offset[index];
117 * Fixed-width font: compute the first column of pixels
118 * of the selected glyph using the character code to index
121 glyph_width = bm->font->width;
123 //For horizontal fonts
124 //glyph = bm->font->glyph + index * (((glyph_width + 7) / 8) * glyph_height);
125 glyph = bm->font->glyph + index * glyph_height_bytes * glyph_width;
128 /* Slow path for styled glyphs */
129 if (UNLIKELY(bm->styles))
131 uint8_t styles = bm->styles;
132 uint8_t prev_dots = 0, italic_prev_dots = 0;
134 uint8_t row, col, row_bit;
137 * To avoid repeating clipping and other expensive computations,
138 * we cluster calls to gfx_blitRaster() using a small buffer.
140 #define CONFIG_TEXT_RENDER_OPTIMIZE 1
141 #if CONFIG_TEXT_RENDER_OPTIMIZE
142 #define RENDER_BUF_WIDTH 12
143 #define RENDER_BUF_HEIGHT 8
144 uint8_t render_buf[RAST_SIZE(RENDER_BUF_WIDTH, RENDER_BUF_HEIGHT)];
145 uint8_t render_xpos = 0;
148 /* This style alone could be handled by the fast path too */
149 if (bm->styles & STYLEF_CONDENSED)
152 if (bm->styles & STYLEF_EXPANDED)
155 for (row = 0, row_bit = 0; row < glyph_height_bytes; ++row, row_bit += 8)
157 /* For each dot column in the glyph... */
158 for (col = 0; col < glyph_width; ++col)
160 uint8_t src_col = col;
162 /* Expanded style: advances only once every two columns. */
163 if (styles & STYLEF_EXPANDED)
166 /* Fetch a column of dots from glyph. */
167 dots = PGM_READ_CHAR(RAST_ADDR(glyph, src_col, row_bit, glyph_width));
169 /* Italic: get lower 4 dots from previous column */
170 if (styles & STYLEF_ITALIC)
172 uint8_t new_dots = dots;
173 dots = (dots & 0xF0) | italic_prev_dots;
174 italic_prev_dots = new_dots & 0x0F;
177 /* Bold: "or" pixels with the previous column */
178 if (styles & STYLEF_BOLD)
180 uint8_t new_dots = dots;
182 prev_dots = new_dots;
185 /* Underlined: turn on base pixel */
186 if ((styles & STYLEF_UNDERLINE)
187 && (row == glyph_height_bytes - 1))
188 dots |= (1 << (glyph_height - row_bit - 1));
190 /* Inverted: invert pixels */
191 if (styles & STYLEF_INVERT)
195 #if CONFIG_TEXT_RENDER_OPTIMIZE
196 render_buf[render_xpos++] = dots;
197 if (render_xpos == RENDER_BUF_WIDTH)
199 gfx_blitRaster(bm, bm->penX + col - render_xpos + 1, bm->penY + row_bit,
200 render_buf, render_xpos,
201 MIN((uint8_t)RENDER_BUF_HEIGHT, (uint8_t)(glyph_height - row_bit)),
206 gfx_blitRaster(bm, bm->penX + col, bm->penY + row_bit,
207 &dots, 1, MIN((uint8_t)8, glyph_height - row_bit), 1);
211 #if CONFIG_TEXT_RENDER_OPTIMIZE
212 /* Flush out rest of render buffer */
213 if (render_xpos != 0)
215 gfx_blitRaster(bm, bm->penX + col - render_xpos, bm->penY + row_bit,
216 render_buf, render_xpos,
217 MIN((uint8_t)RENDER_BUF_HEIGHT, (uint8_t)(glyph_height - row_bit)),
226 /* No style: fast vanilla copy of glyph to bitmap */
227 gfx_blitRaster(bm, bm->penX, bm->penY, glyph, glyph_width, glyph_height, glyph_width);
230 /* Update current pen position */
231 bm->penX += glyph_width;
238 * Render char \c c, with (currently) limited ANSI escapes
239 * emulation support and '\n' for newline.
241 int text_putchar(char c, struct Bitmap *bm)
243 /* Handle ANSI escape sequences */
244 if (UNLIKELY(ansi_mode))
248 case ANSI_ESC_CLEARSCREEN:
252 text_style(bm, 0, STYLEF_MASK);
255 kprintf("Unknown ANSI esc code: %x\n", c);)
259 else if (c == '\033') /* Enter ANSI ESC mode */
263 else if (c == '\n') /* Go one line down on a line-feed */
265 if (bm->penY + bm->font->height < bm->height)
267 bm->penY += bm->font->height;
273 text_putglyph(c, bm);
280 * Clear the screen and reset cursor position
282 void text_clear(struct Bitmap *bmp)
284 text_putchar('\x1b', bmp);
285 text_putchar('c', bmp);
289 void text_clearLine(struct Bitmap *bm, int line)
291 gfx_rectClear(bm, 0, line * bm->font->height, bm->width, (line + 1) * bm->font->height);
296 * Set/clear algorithmic font style bits.
298 * \param bm Pointer to Bitmap to affect.
299 * \param flags Style flags to set
300 * \param mask Mask of flags to modify
301 * \return Old style flags
304 * Turn on bold, leave other styles alone
305 * \code text_style(bm, STYLEF_BOLD, STYLEF_BOLD); \endcode
307 * Turn off bold and turn on italic, leave others as they are
308 * \code text_style(bm, STYLEF_ITALIC, STYLEF_BOLD | STYLEF_ITALIC); \endcode
310 * Query current style without chaning it
311 * \code style = text_style(bm, 0, 0); \endcode
313 * Reset all styles (plain text)
314 * \code text_style(bm, 0, STYLE_MASK); \endcode
316 uint8_t text_style(struct Bitmap *bm, uint8_t flags, uint8_t mask)
318 uint8_t old = bm->styles;
319 bm->styles = (bm->styles & ~mask) | flags;