gfx/text.c

   1 /*!
   2  * \file
   3  * <!--
   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.
   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.1  2005/11/04 18:11:35  bernie
  19  *#* Move graphics stuff from mware/ to gfx/.
  20  *#*
  21  *#* Revision 1.13  2005/11/04 16:20:02  bernie
  22  *#* Fix reference to README.devlib in header.
  23  *#*
  24  *#* Revision 1.12  2005/04/11 19:10:28  bernie
  25  *#* Include top-level headers from cfg/ subdir.
  26  *#*
  27  *#* Revision 1.11  2005/01/20 18:46:31  aleph
  28  *#* Fix progmem includes.
  29  *#*
  30  *#* Revision 1.10  2005/01/08 09:20:12  bernie
  31  *#* Really make it work on both architectures.
  32  *#*
  33  *#* Revision 1.9  2004/12/31 16:44:29  bernie
  34  *#* Sanitize for non-Harvard processors.
  35  *#*
  36  *#* Revision 1.8  2004/11/16 21:16:28  bernie
  37  *#* Update to new naming scheme in mware/gfx.c.
  38  *#*
  39  *#* Revision 1.7  2004/09/20 03:28:28  bernie
  40  *#* Fix header.
  41  *#*
  42  *#* Revision 1.6  2004/09/14 20:57:15  bernie
  43  *#* Use debug.h instead of kdebug.h.
  44  *#*
  45  *#* Revision 1.5  2004/09/06 21:51:26  bernie
  46  *#* Extend interface to allow any algorithmic style.
  47  *#*
  48  *#* Revision 1.2  2004/06/03 11:27:09  bernie
  49  *#* Add dual-license information.
  50  *#*
  51  *#* Revision 1.1  2004/05/23 15:43:16  bernie
  52  *#* Import mware modules.
  53  *#*
  54  *#* Revision 1.17  2004/05/15 16:57:01  aleph
  55  *#* Fixes for non-DEBUG build
  56  *#*
  57  *#* Revision 1.16  2004/04/03 20:42:49  aleph
  58  *#* Add text_clear()
  59  *#*
  60  *#* Revision 1.15  2004/03/24 15:03:45  bernie
  61  *#* Use explicit include paths; clean Doxygen comments
  62  *#*
  63  *#* Revision 1.14  2004/03/19 16:52:28  bernie
  64  *#* Move printf() like functions from text.c to text_format.c and add PROGMEM versions.
  65  *#*
  66  *#* Revision 1.13  2004/03/17 18:23:32  bernie
  67  *#* Oops.
  68  *#*
  69  *#* Revision 1.12  2004/03/17 18:03:22  bernie
  70  *#* Make diagnostic message shorter
  71  *#*
  72  *#* Revision 1.11  2004/03/13 22:52:54  aleph
  73  *#* documentation fixes
  74  *#*/
  75
  76 #include "gfx.h"
  77 #include "font.h"
  78 #include "text.h"
  79
  80 #include <cfg/debug.h>
  81
  82
  83 /*!
  84  * Flags degli stili algoritmici
  85  *
  86  * La routine di rendering del testo e' in grado di applicare
  87  * delle semplici trasformazioni al font interno per generare
  88  * automaticamente degli stili predefiniti (bold, italic,
  89  * underline) a partire dal set di caratteri plain.
  90  */
  91 static uint8_t text_styles;
  92
  93 /*! ANSI escape sequences flag: true for ESC state on */
  94 static bool ansi_mode = false;
  95
  96
  97 /*!
  98  * Move (imaginary) cursor to column and row specified.
  99  * Next text write will start a that row and col.
 100  */
 101 void text_moveto(struct Bitmap *bm, int row, int col)
 102 {
 103         ASSERT(col >= 0);
 104         ASSERT(col < bm->width / FONT_WIDTH);
 105         ASSERT(row >= 0);
 106         ASSERT(row < bm->height / FONT_HEIGHT);
 107
 108         bm->penX = col * FONT_WIDTH;
 109         bm->penY = row * FONT_HEIGHT;
 110 }
 111
 112
 113 /*!
 114  * Move (imaginary) cursor to coordinates specified.
 115  */
 116 void text_setcoord(struct Bitmap *bm, int x, int y)
 117 {
 118         bm->penX = x;
 119         bm->penY = y;
 120 }
 121
 122
 123 /*!
 124  * Render char \a c on Bitmap \a bm
 125  */
 126 static int text_putglyph(char c, struct Bitmap *bm)
 127 {
 128         const uint8_t * PROGMEM glyph;  /* font is in progmem */
 129         uint8_t glyph_width;
 130         uint8_t i;
 131         uint8_t *buf;
 132
 133         /*
 134          * Il carattere da stampare viene usato come indice per prelevare
 135          * la prima colonna di dots del glyph all'interno del font.
 136          */
 137         glyph = font + (((unsigned char)c) * FONT_WIDTH);
 138         glyph_width = FONT_WIDTH;
 139
 140         if (text_styles & STYLEF_CONDENSED)
 141                 --glyph_width;
 142
 143         if (text_styles & STYLEF_EXPANDED)
 144                 glyph_width *= 2;
 145
 146         /* The y coord is rounded at multiples of 8 for simplicity */
 147         bm->penY &= ~((coord_t)7);
 148
 149         /* Check if glyph to write fits in the bitmap */
 150         if ((bm->penX < 0) || (bm->penX + glyph_width > bm->width) ||
 151                 (bm->penY < 0) || (bm->penY + FONT_HEIGHT > bm->height))
 152         {
 153                 DB(kprintf("bad coords x=%d y=%d\n", bm->penX, bm->penY);)
 154                 return 0;
 155         }
 156
 157         /* Locate position where to write in the raster */
 158         buf = bm->raster + bm->penY / 8 * bm->width + bm->penX;
 159
 160         bm->penX += glyph_width;
 161
 162         /* If some styles are set */
 163         if (text_styles)
 164         {
 165                 uint8_t prev_dots = 0, italic_prev_dots = 0, new_dots;
 166                 uint8_t dots;
 167
 168                 /* Per ogni colonna di dot del glyph... */
 169                 for (i = 0; i < glyph_width; ++i)
 170                 {
 171                         dots = PGM_READ_CHAR(glyph);
 172
 173                         /* Advance to next column in glyph.
 174                          * Expand: advances only once every two columns
 175                          */
 176                         if (!(text_styles & STYLEF_EXPANDED) || (i & 1))
 177                                 glyph++;
 178
 179                         /* Italic: get lower 4 dots from previous column */
 180                         if (text_styles & STYLEF_ITALIC)
 181                         {
 182                                 new_dots = dots;
 183                                 dots = (dots & 0xF0) | italic_prev_dots;
 184                                 italic_prev_dots = new_dots & 0x0F;
 185                         }
 186
 187                         /* Bold: "or" pixels with the previous column */
 188                         if (text_styles & STYLEF_BOLD)
 189                         {
 190                                 new_dots = dots;
 191                                 dots |= prev_dots;
 192                                 prev_dots = new_dots;
 193                         }
 194
 195                         /* Underlined: turn on base pixel */
 196                         if (text_styles & STYLEF_UNDERLINE)
 197                                 dots |= 0x80;
 198
 199                         /* Inverted: invert pixels */
 200                         if (text_styles & STYLEF_INVERT)
 201                                 dots = ~dots;
 202
 203                         /* Output dots */
 204                         *buf++ = dots;
 205                 }
 206         }
 207         else /* No style: fast vanilla copy of glyph to line buffer */
 208                 while (glyph_width--)
 209                         *buf++ = PGM_READ_CHAR(glyph++);
 210
 211         return c;
 212 }
 213
 214
 215 /*!
 216  * Render char \c c, with (currently) limited ANSI escapes
 217  * emulation support and '\n' for newline.
 218  */
 219 int text_putchar(char c, struct Bitmap *bm)
 220 {
 221         /* Handle ANSI escape sequences */
 222         if (ansi_mode)
 223         {
 224                 switch (c)
 225                 {
 226                 case ANSI_ESC_CLEARSCREEN:
 227                         gfx_bitmapClear(bm);
 228                         bm->penX = 0;
 229                         bm->penY = 0;
 230                         text_style(0, STYLEF_MASK);
 231                         break;
 232                 DB(default:
 233                         kprintf("Unknown ANSI esc code: %x\n", c);)
 234                 }
 235                 ansi_mode = false;
 236         }
 237         else if (c == '\033')  /* Enter ANSI ESC mode */
 238         {
 239                 ansi_mode = true;
 240         }
 241         else if (c == '\n')  /* Go one line down on a line-feed */
 242         {
 243                 if (bm->penY + FONT_HEIGHT < bm->height)
 244                 {
 245                         bm->penY += FONT_HEIGHT;
 246                         bm->penX = 0;
 247                 }
 248         }
 249         else
 250         {
 251                 text_putglyph(c, bm);
 252         }
 253         return c;
 254 }
 255
 256
 257 /*!
 258  * Clear the screen and reset cursor position
 259  */
 260 void text_clear(struct Bitmap *bmp)
 261 {
 262         text_putchar('\x1b', bmp);
 263         text_putchar('c', bmp);
 264 }
 265
 266
 267 void text_clearLine(struct Bitmap *bmp, int line)
 268 {
 269         gfx_rectClear(bmp, 0, line * FONT_HEIGHT, bmp->width, (line + 1) * FONT_HEIGHT);
 270 }
 271
 272
 273 /*!
 274  * Set/clear algorithmic font style bits.
 275  *
 276  * \param flags  Style flags to set
 277  * \param mask   Mask of flags to modify
 278  * \return       Old style flags
 279  *
 280  * Examples:
 281  * Turn on bold, leave other styles alone
 282  *   \code prt_style(STYLEF_BOLD, STYLEF_BOLD); \endcode
 283  *
 284  * Turn off bold and turn on italic, leave others as they are
 285  *   \code prt_style(STYLEF_ITALIC, STYLEF_BOLD | STYLEF_ITALIC); \endcode
 286  *
 287  * Query current style without chaning it
 288  *   \code style = prt_style(0, 0); \endcode
 289  *
 290  * Reset all styles (plain text)
 291  *   \code prt_style(0, STYLE_MASK); \endcode
 292  */
 293 uint8_t text_style(uint8_t flags, uint8_t mask)
 294 {
 295         uint8_t old = text_styles;
 296         text_styles = (text_styles & ~mask) | flags;
 297         return old;
 298 }