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