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