gfx/text.c

   1 /*!
   2  * \file
   3  * <!--
   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.
   7  * -->
   8  *
   9  * \brief Text graphic routines
  10  *
  11  * \version $Id$
  12  * \author Bernardo Innocenti <bernie@develer.com>
  13  * \author Stefano Fedrigo <aleph@develer.com>
  14  */
  15
  16 /*#*
  17  *#* $Log$
  18  *#* Revision 1.7  2006/03/20 17:51:55  bernie
  19  *#* Cleanups.
  20  *#*
  21  *#* Revision 1.6  2006/03/13 02:05:54  bernie
  22  *#* Mark slow paths as UNLIKELY.
  23  *#*
  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.
  26  *#*
  27  *#* Revision 1.4  2006/02/15 09:10:15  bernie
  28  *#* Implement prop fonts; Fix algo styles.
  29  *#*
  30  *#* Revision 1.3  2006/02/10 12:31:55  bernie
  31  *#* Add multiple font support in bitmaps.
  32  *#*
  33  *#* Revision 1.2  2005/11/04 18:17:45  bernie
  34  *#* Fix header guards and includes for new location of gfx module.
  35  *#*
  36  *#* Revision 1.1  2005/11/04 18:11:35  bernie
  37  *#* Move graphics stuff from mware/ to gfx/.
  38  *#*
  39  *#* Revision 1.13  2005/11/04 16:20:02  bernie
  40  *#* Fix reference to README.devlib in header.
  41  *#*
  42  *#* Revision 1.12  2005/04/11 19:10:28  bernie
  43  *#* Include top-level headers from cfg/ subdir.
  44  *#*
  45  *#* Revision 1.11  2005/01/20 18:46:31  aleph
  46  *#* Fix progmem includes.
  47  *#*
  48  *#* Revision 1.10  2005/01/08 09:20:12  bernie
  49  *#* Really make it work on both architectures.
  50  *#*
  51  *#* Revision 1.9  2004/12/31 16:44:29  bernie
  52  *#* Sanitize for non-Harvard processors.
  53  *#*
  54  *#* Revision 1.8  2004/11/16 21:16:28  bernie
  55  *#* Update to new naming scheme in mware/gfx.c.
  56  *#*
  57  *#* Revision 1.7  2004/09/20 03:28:28  bernie
  58  *#* Fix header.
  59  *#*
  60  *#* Revision 1.6  2004/09/14 20:57:15  bernie
  61  *#* Use debug.h instead of kdebug.h.
  62  *#*
  63  *#* Revision 1.5  2004/09/06 21:51:26  bernie
  64  *#* Extend interface to allow any algorithmic style.
  65  *#*
  66  *#* Revision 1.2  2004/06/03 11:27:09  bernie
  67  *#* Add dual-license information.
  68  *#*
  69  *#* Revision 1.1  2004/05/23 15:43:16  bernie
  70  *#* Import mware modules.
  71  *#*
  72  *#* Revision 1.17  2004/05/15 16:57:01  aleph
  73  *#* Fixes for non-DEBUG build
  74  *#*
  75  *#* Revision 1.16  2004/04/03 20:42:49  aleph
  76  *#* Add text_clear()
  77  *#*
  78  *#* Revision 1.15  2004/03/24 15:03:45  bernie
  79  *#* Use explicit include paths; clean Doxygen comments
  80  *#*
  81  *#* Revision 1.14  2004/03/19 16:52:28  bernie
  82  *#* Move printf() like functions from text.c to text_format.c and add PROGMEM versions.
  83  *#*
  84  *#* Revision 1.13  2004/03/17 18:23:32  bernie
  85  *#* Oops.
  86  *#*
  87  *#* Revision 1.12  2004/03/17 18:03:22  bernie
  88  *#* Make diagnostic message shorter
  89  *#*
  90  *#* Revision 1.11  2004/03/13 22:52:54  aleph
  91  *#* documentation fixes
  92  *#*/
  93
  94 #include <gfx/gfx.h>
  95 #include <gfx/font.h>
  96 #include <gfx/text.h>
  97 #include <gfx/text.h>
  98
  99 #include <gfx/gfx_p.h> // FIXME: BM_DRAWPIXEL
 100
 101 #include <cfg/debug.h>
 102
 103
 104 /*! ANSI escape sequences flag: true for ESC state on */
 105 static bool ansi_mode = false;
 106
 107
 108 /*!
 109  * Move (imaginary) cursor to column and row specified.
 110  * Next text write will start a that row and col.
 111  */
 112 void text_moveto(struct Bitmap *bm, int row, int col)
 113 {
 114         ASSERT(col >= 0);
 115         ASSERT(col < bm->width / bm->font->width);
 116         ASSERT(row >= 0);
 117         ASSERT(row < bm->height / bm->font->height);
 118
 119         bm->penX = col * bm->font->width;
 120         bm->penY = row * bm->font->height;
 121 }
 122
 123
 124 /*!
 125  * Move (imaginary) cursor to coordinates specified.
 126  */
 127 void text_setcoord(struct Bitmap *bm, int x, int y)
 128 {
 129         bm->penX = x;
 130         bm->penY = y;
 131 }
 132
 133
 134 /*!
 135  * Render char \a c on Bitmap \a bm.
 136  */
 137 static int text_putglyph(char c, struct Bitmap *bm)
 138 {
 139         const uint8_t * PROGMEM glyph;  /* font is in progmem */
 140         uint8_t glyph_width, glyph_height, glyph_height_bytes;
 141         unsigned char index = (unsigned char)c;
 142
 143         /* Check for out of range char and replace with '?' or first char in font. */
 144         if (UNLIKELY(!FONT_HAS_GLYPH(bm->font, index)))
 145         {
 146                 kprintf("Illegal char '%c' (0x%02x)\n", index, index);
 147                 if (FONT_HAS_GLYPH(bm->font, '?'))
 148                         index = '?';
 149                 else
 150                         index = bm->font->first;
 151         }
 152
 153         /* Make character relative to font start */
 154         index -= bm->font->first;
 155
 156         glyph_height = bm->font->height;
 157         // FIXME: for vertical fonts only
 158         glyph_height_bytes = ROUND_UP2(glyph_height, 8);
 159
 160         if (bm->font->offset)
 161         {
 162                 /* Proportional font */
 163                 glyph_width = bm->font->widths[index]; /* TODO: optimize away */
 164                 glyph = bm->font->glyph + bm->font->offset[index];
 165         }
 166         else
 167         {
 168                 /*
 169                  * Fixed-width font: compute the first column of pixels
 170                  * of the selected glyph using the character code to index
 171                  * the glyph array.
 172                  */
 173                 glyph_width = bm->font->width;
 174
 175                 //For horizontal fonts
 176                 //glyph = bm->font->glyph + index * (((glyph_width + 7) / 8) * glyph_height);
 177                 glyph = bm->font->glyph + index * glyph_height_bytes * glyph_width;
 178         }
 179
 180         /* Slow path for styled glyphs */
 181         if (UNLIKELY(bm->styles))
 182         {
 183                 uint8_t styles = bm->styles;
 184                 uint8_t prev_dots = 0, italic_prev_dots = 0;
 185                 uint8_t dots;
 186                 uint8_t row, col;
 187
 188                 /* This style alone could be handled by the fast path too */
 189                 if (bm->styles & STYLEF_CONDENSED)
 190                         --glyph_width;
 191
 192                 if (bm->styles & STYLEF_EXPANDED)
 193                         glyph_width *= 2;
 194
 195                 /* Check if glyph fits in the bitmap. */
 196                 if ((bm->penX < 0) || (bm->penX + glyph_width > bm->width)
 197                         || (bm->penY < 0) || (bm->penY + glyph_height > bm->height))
 198                 {
 199                         kprintf("bad coords x=%d y=%d\n", bm->penX, bm->penY);
 200                         return 0;
 201                 }
 202
 203                 for (row = 0; row < glyph_height_bytes; ++row)
 204                 {
 205                         /* For each dot column in the glyph... */
 206                         for (col = 0; col < glyph_width; ++col)
 207                         {
 208                                 uint8_t src_col = col;
 209                                 uint8_t i;
 210
 211                                 /* Expanded style: advances only once every two columns. */
 212                                 if (styles & STYLEF_EXPANDED)
 213                                         src_col /= 2;
 214
 215                                 /* Fetch a column of dots from glyph. */
 216                                 dots = PGM_READ_CHAR(glyph + src_col * glyph_height_bytes + row);
 217
 218                                 /* Italic: get lower 4 dots from previous column */
 219                                 if (styles & STYLEF_ITALIC)
 220                                 {
 221                                         uint8_t new_dots = dots;
 222                                         dots = (dots & 0xF0) | italic_prev_dots;
 223                                         italic_prev_dots = new_dots & 0x0F;
 224                                 }
 225
 226                                 /* Bold: "or" pixels with the previous column */
 227                                 if (styles & STYLEF_BOLD)
 228                                 {
 229                                         uint8_t new_dots = dots;
 230                                         dots |= prev_dots;
 231                                         prev_dots = new_dots;
 232                                 }
 233
 234                                 /* Underlined: turn on base pixel */
 235                                 if ((styles & STYLEF_UNDERLINE)
 236                                         && (row == glyph_height_bytes - 1))
 237                                         dots |= (1 << (glyph_height - row * 8 - 1));
 238
 239                                 /* Inverted: invert pixels */
 240                                 if (styles & STYLEF_INVERT)
 241                                         dots = ~dots;
 242
 243                                 /* Output dots */
 244                                 for (i = 0; i < 8 && (row * 8) + i < glyph_height; ++i)
 245                                         BM_DRAWPIXEL(bm, bm->penX + col, bm->penY + row * 8 + i, dots & (1<<i));
 246                         }
 247                 }
 248         }
 249         else
 250         {
 251                 /* No style: fast vanilla copy of glyph to bitmap */
 252                 gfx_blitRaster(bm, bm->penX, bm->penY, glyph, glyph_width, glyph_height, glyph_height_bytes);
 253         }
 254
 255         /* Update current pen position */
 256         bm->penX += glyph_width;
 257
 258         return c;
 259 }
 260
 261
 262 /*!
 263  * Render char \c c, with (currently) limited ANSI escapes
 264  * emulation support and '\n' for newline.
 265  */
 266 int text_putchar(char c, struct Bitmap *bm)
 267 {
 268         /* Handle ANSI escape sequences */
 269         if (UNLIKELY(ansi_mode))
 270         {
 271                 switch (c)
 272                 {
 273                 case ANSI_ESC_CLEARSCREEN:
 274                         gfx_bitmapClear(bm);
 275                         bm->penX = 0;
 276                         bm->penY = 0;
 277                         text_style(bm, 0, STYLEF_MASK);
 278                         break;
 279                 DB(default:
 280                         kprintf("Unknown ANSI esc code: %x\n", c);)
 281                 }
 282                 ansi_mode = false;
 283         }
 284         else if (c == '\033')  /* Enter ANSI ESC mode */
 285         {
 286                 ansi_mode = true;
 287         }
 288         else if (c == '\n')  /* Go one line down on a line-feed */
 289         {
 290                 if (bm->penY + bm->font->height < bm->height)
 291                 {
 292                         bm->penY += bm->font->height;
 293                         bm->penX = 0;
 294                 }
 295         }
 296         else
 297         {
 298                 text_putglyph(c, bm);
 299         }
 300         return c;
 301 }
 302
 303
 304 /*!
 305  * Clear the screen and reset cursor position
 306  */
 307 void text_clear(struct Bitmap *bmp)
 308 {
 309         text_putchar('\x1b', bmp);
 310         text_putchar('c', bmp);
 311 }
 312
 313
 314 void text_clearLine(struct Bitmap *bm, int line)
 315 {
 316         gfx_rectClear(bm, 0, line * bm->font->height, bm->width, (line + 1) * bm->font->height);
 317 }
 318
 319
 320 /**
 321  * Set/clear algorithmic font style bits.
 322  *
 323  * \param bm     Pointer to Bitmap to affect.
 324  * \param flags  Style flags to set
 325  * \param mask   Mask of flags to modify
 326  * \return       Old style flags
 327  *
 328  * Examples:
 329  * Turn on bold, leave other styles alone
 330  *   \code text_style(bm, STYLEF_BOLD, STYLEF_BOLD); \endcode
 331  *
 332  * Turn off bold and turn on italic, leave others as they are
 333  *   \code text_style(bm, STYLEF_ITALIC, STYLEF_BOLD | STYLEF_ITALIC); \endcode
 334  *
 335  * Query current style without chaning it
 336  *   \code style = text_style(bm, 0, 0); \endcode
 337  *
 338  * Reset all styles (plain text)
 339  *   \code text_style(bm, 0, STYLE_MASK); \endcode
 340  */
 341 uint8_t text_style(struct Bitmap *bm, uint8_t flags, uint8_t mask)
 342 {
 343         uint8_t old = bm->styles;
 344         bm->styles = (bm->styles & ~mask) | flags;
 345         return old;
 346 }