mware/text_format.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 devlib/README for information.
   7  * -->
   8  *
   9  * \brief printf-family routines for text output
  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.8  2004/11/16 21:16:56  bernie
  19  *#* Update to new naming scheme in mware/gfx.c.
  20  *#*
  21  *#* Revision 1.7  2004/10/03 19:05:04  bernie
  22  *#* text_widthf(), text_vwidthf(): New functions.
  23  *#*
  24  *#* Revision 1.6  2004/09/14 20:59:04  bernie
  25  *#* text_xprintf(): Support all styles; Pixel-wise text centering.
  26  *#*
  27  *#* Revision 1.5  2004/08/25 14:12:09  rasky
  28  *#* Aggiornato il comment block dei log RCS
  29  *#*
  30  *#* Revision 1.4  2004/08/05 18:46:44  bernie
  31  *#* Documentation improvements.
  32  *#*
  33  *#* Revision 1.3  2004/08/03 15:57:18  aleph
  34  *#* Add include to fix warning for vsprintf()
  35  *#*
  36  *#* Revision 1.2  2004/06/03 11:27:09  bernie
  37  *#* Add dual-license information.
  38  *#*
  39  *#* Revision 1.1  2004/05/23 15:43:16  bernie
  40  *#* Import mware modules.
  41  *#*
  42  *#* Revision 1.2  2004/03/26 18:50:50  bernie
  43  *#* Move _PROGMEM stuff to compiler.h
  44  *#*
  45  *#* Revision 1.1  2004/03/19 16:52:28  bernie
  46  *#* Move printf() like functions from text.c to text_format.c and add PROGMEM versions.
  47  *#*
  48  *#*/
  49
  50 #include "text.h"
  51 #include "formatwr.h" /* _formatted_write() */
  52 #include "font.h"
  53 #include "gfx.h"
  54 #include <stdio.h> /* vsprintf() */
  55 #include <stdarg.h>
  56 #include <string.h> /* strlen() */
  57
  58 /*!
  59  * Render string \a str in Bitmap \a bm at current cursor position
  60  *
  61  * \note Text formatting functions are also available with an _P suffix
  62  *       accepting the source string from program memory.  This feature
  63  *       is only available (and useful) on Harvard microprocessors such
  64  *       as the AVR.
  65  *
  66  * \see text_putchar()
  67  */
  68 int PGM_FUNC(text_puts)(const char * PGM_ATTR str, struct Bitmap *bm)
  69 {
  70         char c;
  71
  72         while ((c = PGM_READ_CHAR(str++)))
  73                 text_putchar(c, bm);
  74
  75         return 0;
  76 }
  77
  78
  79 /*!
  80  * vprintf()-like formatter to render text in a Bitmap.
  81  *
  82  * Perform vprintf()-like formatting on the \a fmt format string using the
  83  * variable-argument list \a ap.
  84  * Render the resulting string in Bitmap \a bm starting at the current
  85  * cursor position.
  86  *
  87  * \see text_puts() text_putchar() text_printf()
  88  */
  89 int PGM_FUNC(text_vprintf)(struct Bitmap *bm, const char * PGM_ATTR fmt, va_list ap)
  90 {
  91         return PGM_FUNC(_formatted_write)(fmt, (void (*)(char, void *))text_putchar, bm, ap);
  92 }
  93
  94 /*!
  95  * printf()-like formatter to render text in a Bitmap.
  96  *
  97  * Perform printf()-like formatting on the \a fmt format string.
  98  * Render the resulting string in Bitmap \a bm starting at the
  99  * current cursor position.
 100  *
 101  * \see text_puts() text_putchar() text_vprintf()
 102  */
 103 int PGM_FUNC(text_printf)(struct Bitmap *bm, const char * PGM_ATTR fmt, ...)
 104 {
 105         int len;
 106
 107         va_list ap;
 108         va_start(ap, fmt);
 109         len = PGM_FUNC(text_vprintf)(bm, fmt, ap);
 110         va_end(ap);
 111
 112         return len;
 113 }
 114
 115
 116 /*!
 117  * Render the result of printf()-like formatting in a specified position
 118  * of a Bitmap.
 119  *
 120  * \param bm Bitmap where to render the text
 121  * \param row   Starting row in character units (zero based)
 122  * \param col   Starting column in character units (zero based)
 123  * \param style Formatting style to use.  In addition to any STYLEF_
 124  *        flag, it can be TEXT_NORMAL, TEXT_FILL, TEXT_INVERT or
 125  *        TEXT_RIGHT, or a combination of these flags ORed together.
 126  * \param fmt  String possibly containing printf() formatting commands.
 127  *
 128  * \see text_puts() text_putchar() text_printf() text_vprintf()
 129  * \see text_moveto() text_style()
 130  */
 131 int PGM_FUNC(text_xprintf)(struct Bitmap *bm,
 132                 uint8_t row, uint8_t col, uint16_t style, const char * PGM_ATTR fmt, ...)
 133 {
 134         int len;
 135         uint8_t oldstyle = 0;
 136         va_list ap;
 137
 138         va_start(ap, fmt);
 139
 140         text_moveto(bm, row, col);
 141
 142         if (style & STYLEF_MASK)
 143                 oldstyle = text_style(style, STYLEF_MASK);
 144
 145         if (style & (TEXT_CENTER | TEXT_RIGHT))
 146         {
 147                 uint8_t pad = bm->width - PGM_FUNC(text_vwidthf)(bm, fmt, ap);
 148
 149                 if (style & TEXT_CENTER)
 150                         pad /= 2;
 151
 152                 if (style & TEXT_FILL)
 153                         gfx_rectFillC(bm, 0, row * FONT_HEIGHT, pad, (row + 1) * FONT_HEIGHT,
 154                                 (style & STYLEF_INVERT) ? 0xFF : 0x00);
 155
 156                 text_setcoord(bm, pad, row * FONT_HEIGHT);
 157         }
 158
 159         len = PGM_FUNC(text_vprintf)(bm, fmt, ap);
 160         va_end(ap);
 161
 162         if (style & TEXT_FILL)
 163                 gfx_rectFillC(bm, bm->penX, row * FONT_HEIGHT, bm->width, (row + 1) * FONT_HEIGHT,
 164                         (style & STYLEF_INVERT) ? 0xFF : 0x00);
 165
 166         /* Restore old style */
 167         if (style & STYLEF_MASK)
 168                 text_style(oldstyle, STYLEF_MASK);
 169
 170         return len;
 171 }
 172
 173
 174 /*!
 175  * Return the width in pixels of a vprintf()-formatted string.
 176  */
 177 int PGM_FUNC(text_vwidthf)(UNUSED(struct Bitmap *, bm), const char * PGM_ATTR fmt, va_list ap)
 178 {
 179         return PGM_FUNC(vsprintf)(NULL, fmt, ap) * FONT_WIDTH;
 180 }
 181
 182
 183 /*!
 184  * Return the width in pixels of a printf()-formatted string.
 185  */
 186 int PGM_FUNC(text_widthf)(struct Bitmap *bm, const char * PGM_ATTR fmt, ...)
 187 {
 188         int width;
 189
 190         va_list ap;
 191         va_start(ap, fmt);
 192         width = PGM_FUNC(text_vwidthf)(bm, fmt, ap);
 193         va_end(ap);
 194
 195         return width;
 196 }