gfx/text.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 1999 Bernardo Innocenti <bernie@develer.com>
  31  * This file is part of DevLib - See README.devlib for information.
  32  * -->
  33  *
  34  * \brief Text graphic routines (interface)
  35  *
  36  * \author Bernardo Innocenti <bernie@develer.com>
  37  * \author Stefano Fedrigo <aleph@develer.com>
  38  * \version $Id$
  39  */
  40
  41 /*#*
  42  *#* $Log$
  43  *#* Revision 1.8  2006/09/13 13:58:55  bernie
  44  *#* text_moveTo(): Swap parameters.
  45  *#*
  46  *#* Revision 1.7  2006/07/19 12:56:26  bernie
  47  *#* Convert to new Doxygen style.
  48  *#*
  49  *#* Revision 1.6  2006/04/27 05:39:24  bernie
  50  *#* Enhance text rendering to arbitrary x,y coords.
  51  *#*
  52  *#* Revision 1.5  2006/04/11 00:08:24  bernie
  53  *#* text_offset(): New function, but I'm not quite confident with the design.
  54  *#*
  55  *#* Revision 1.4  2006/03/07 22:18:04  bernie
  56  *#* Correctly compute text width for prop fonts; Make styles a per-bitmap attribute.
  57  *#*
  58  *#* Revision 1.3  2006/02/10 12:26:19  bernie
  59  *#* Add STYLEF_TALL (unimplemented).
  60  *#*
  61  *#* Revision 1.2  2005/11/04 18:17:45  bernie
  62  *#* Fix header guards and includes for new location of gfx module.
  63  *#*
  64  *#* Revision 1.1  2005/11/04 18:11:35  bernie
  65  *#* Move graphics stuff from mware/ to gfx/.
  66  *#*
  67  *#* Revision 1.11  2005/04/11 19:10:28  bernie
  68  *#* Include top-level headers from cfg/ subdir.
  69  *#*
  70  *#* Revision 1.10  2005/03/01 23:26:46  bernie
  71  *#* Use new CPU-neutral program-memory API.
  72  *#*
  73  *#* Revision 1.9  2004/12/31 16:44:29  bernie
  74  *#* Sanitize for non-Harvard processors.
  75  *#*
  76  *#* Revision 1.8  2004/10/03 20:43:37  bernie
  77  *#* Import changes from project_ks.
  78  *#*
  79  *#* Revision 1.7  2004/09/20 03:28:49  bernie
  80  *#* Fix header; Conditionalize AVR-specific code.
  81  *#*
  82  *#* Revision 1.6  2004/09/14 20:57:30  bernie
  83  *#* Reformat.
  84  *#*
  85  *#* Revision 1.5  2004/09/06 21:51:26  bernie
  86  *#* Extend interface to allow any algorithmic style.
  87  *#*
  88  *#* Revision 1.4  2004/08/25 14:12:09  rasky
  89  *#* Aggiornato il comment block dei log RCS
  90  *#*
  91  *#* Revision 1.3  2004/08/05 18:46:44  bernie
  92  *#* Documentation improvements.
  93  *#*
  94  *#* Revision 1.2  2004/06/03 11:27:09  bernie
  95  *#* Add dual-license information.
  96  *#*
  97  *#*/
  98
  99 #ifndef GFX_TEXT_H
 100 #define GFX_TEXT_H
 101
 102 #include <cfg/compiler.h>
 103 #include <cfg/macros.h> /* BV() */
 104 #include <cfg/cpu.h> /* CPU_HARVARD */
 105 #include <gfx/gfx.h> /* coord_t */
 106
 107 #include <stdarg.h>
 108
 109 /**
 110  * \name Style flags
 111  * \see text_style()
 112  * \{
 113  */
 114 #define STYLEF_BOLD        BV(0)
 115 #define STYLEF_ITALIC      BV(1)
 116 #define STYLEF_UNDERLINE   BV(2)
 117 #define STYLEF_INVERT      BV(3)
 118 #define STYLEF_EXPANDED    BV(4)
 119 #define STYLEF_CONDENSED   BV(5)
 120 #define STYLEF_STRIKEOUT   BV(6)  /*<! Not implemented */
 121 #define STYLEF_TALL        BV(7)  /*<! Not implemented */
 122
 123 #define STYLEF_MASK \
 124         (STYLEF_BOLD | STYLEF_ITALIC | STYLEF_UNDERLINE \
 125         | STYLEF_INVERT | STYLEF_EXPANDED | STYLEF_CONDENSED \
 126         | STYLEF_STRIKEOUT | STYLEF_TALL)
 127 /*\}*/
 128
 129 /**
 130  * \name Formatting flags for text rendering
 131  * \see text_xprintf()
 132  * \{
 133  */
 134 #define TEXT_NORMAL   0       /**< Normal mode */
 135 #define TEXT_FILL     BV(13)  /**< Fill rest of line with spaces */
 136 #define TEXT_CENTER   BV(14)  /**< Center string in line */
 137 #define TEXT_RIGHT    BV(15)  /**< Right aligned */
 138 /*\}*/
 139
 140 /** Escape sequences codes */
 141 #define ANSI_ESC_CLEARSCREEN 'c'
 142
 143
 144 /* Fwd decl */
 145 struct Bitmap;
 146
 147 /* Low-level text functions (mware/text.c) */
 148 void text_moveTo(struct Bitmap *bm, int row, int col);
 149 void text_setCoord(struct Bitmap *bm, int x, int y);
 150 int text_putchar(char c, struct Bitmap *bm);
 151 uint8_t text_style(struct Bitmap *bm, uint8_t flags, uint8_t mask);
 152 void text_clear(struct Bitmap *bm);
 153 void text_clearLine(struct Bitmap *bm, int line);
 154
 155 /* Text formatting functions (mware/text_format.c) */
 156 int text_puts(const char *str, struct Bitmap *bm);
 157 int text_vprintf(struct Bitmap *bm, const char *fmt, va_list ap);
 158 int text_printf(struct Bitmap *bm, const char *fmt, ...) FORMAT(__printf__, 2, 3);
 159 int text_xyvprintf(struct Bitmap *bm, coord_t x, coord_t y, uint16_t mode, const char *fmt, va_list ap);
 160 int text_xyprintf(struct Bitmap *bm, coord_t x, coord_t col, uint16_t mode, const char *fmt, ...) FORMAT(__printf__, 5, 6);
 161 int text_xprintf(struct Bitmap *bm, uint8_t row, uint8_t col, uint16_t mode, const char *fmt, ...) FORMAT(__printf__, 5, 6);
 162 int text_vwidthf(struct Bitmap *bm, const char * fmt, va_list ap);
 163 int text_widthf(struct Bitmap *bm, const char * fmt, ...) FORMAT(__printf__, 2, 3);
 164
 165 /* Text formatting functions for program-memory strings (mware/text_format.c) */
 166 #if CPU_HARVARD
 167 #include <mware/pgm.h>
 168 int text_puts_P(const char * PROGMEM str, struct Bitmap *bm);
 169 int text_vprintf_P(struct Bitmap *bm, const char * PROGMEM fmt, va_list ap);
 170 int text_printf_P(struct Bitmap *bm, const char * PROGMEM fmt, ...) FORMAT(__printf__, 2, 3);
 171 int text_xprintf_P(struct Bitmap *bm, uint8_t row, uint8_t col, uint16_t mode, const char * PROGMEM fmt, ...) FORMAT(__printf__, 5, 6);
 172 int text_vwidthf_P(struct Bitmap *bm, const char * PROGMEM fmt, va_list ap);
 173 int text_widthf_P(struct Bitmap *bm, const char * PROGMEM fmt, ...);
 174 #endif /* CPU_HARVARD */
 175
 176 #endif /* GFX_TEXT_H */