4 * Copyright 2003, 2004, 2005 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.
9 * \brief Text graphic routines (interface)
11 * \author Bernardo Innocenti <bernie@develer.com>
12 * \author Stefano Fedrigo <aleph@develer.com>
18 *#* Revision 1.7 2006/07/19 12:56:26 bernie
19 *#* Convert to new Doxygen style.
21 *#* Revision 1.6 2006/04/27 05:39:24 bernie
22 *#* Enhance text rendering to arbitrary x,y coords.
24 *#* Revision 1.5 2006/04/11 00:08:24 bernie
25 *#* text_offset(): New function, but I'm not quite confident with the design.
27 *#* Revision 1.4 2006/03/07 22:18:04 bernie
28 *#* Correctly compute text width for prop fonts; Make styles a per-bitmap attribute.
30 *#* Revision 1.3 2006/02/10 12:26:19 bernie
31 *#* Add STYLEF_TALL (unimplemented).
33 *#* Revision 1.2 2005/11/04 18:17:45 bernie
34 *#* Fix header guards and includes for new location of gfx module.
36 *#* Revision 1.1 2005/11/04 18:11:35 bernie
37 *#* Move graphics stuff from mware/ to gfx/.
39 *#* Revision 1.11 2005/04/11 19:10:28 bernie
40 *#* Include top-level headers from cfg/ subdir.
42 *#* Revision 1.10 2005/03/01 23:26:46 bernie
43 *#* Use new CPU-neutral program-memory API.
45 *#* Revision 1.9 2004/12/31 16:44:29 bernie
46 *#* Sanitize for non-Harvard processors.
48 *#* Revision 1.8 2004/10/03 20:43:37 bernie
49 *#* Import changes from project_ks.
51 *#* Revision 1.7 2004/09/20 03:28:49 bernie
52 *#* Fix header; Conditionalize AVR-specific code.
54 *#* Revision 1.6 2004/09/14 20:57:30 bernie
57 *#* Revision 1.5 2004/09/06 21:51:26 bernie
58 *#* Extend interface to allow any algorithmic style.
60 *#* Revision 1.4 2004/08/25 14:12:09 rasky
61 *#* Aggiornato il comment block dei log RCS
63 *#* Revision 1.3 2004/08/05 18:46:44 bernie
64 *#* Documentation improvements.
66 *#* Revision 1.2 2004/06/03 11:27:09 bernie
67 *#* Add dual-license information.
74 #include <cfg/compiler.h>
75 #include <cfg/macros.h> /* BV() */
76 #include <cfg/cpu.h> /* CPU_HARVARD */
77 #include <gfx/gfx.h> /* coord_t */
86 #define STYLEF_BOLD BV(0)
87 #define STYLEF_ITALIC BV(1)
88 #define STYLEF_UNDERLINE BV(2)
89 #define STYLEF_INVERT BV(3)
90 #define STYLEF_EXPANDED BV(4)
91 #define STYLEF_CONDENSED BV(5)
92 #define STYLEF_STRIKEOUT BV(6) /*<! Not implemented */
93 #define STYLEF_TALL BV(7) /*<! Not implemented */
96 (STYLEF_BOLD | STYLEF_ITALIC | STYLEF_UNDERLINE \
97 | STYLEF_INVERT | STYLEF_EXPANDED | STYLEF_CONDENSED \
98 | STYLEF_STRIKEOUT | STYLEF_TALL)
102 * \name Formatting flags for text rendering
103 * \see text_xprintf()
106 #define TEXT_NORMAL 0 /**< Normal mode */
107 #define TEXT_FILL BV(13) /**< Fill rest of line with spaces */
108 #define TEXT_CENTER BV(14) /**< Center string in line */
109 #define TEXT_RIGHT BV(15) /**< Right aligned */
112 /** Escape sequences codes */
113 #define ANSI_ESC_CLEARSCREEN 'c'
119 /* Low-level text functions (mware/text.c) */
120 void text_moveTo(struct Bitmap *bm, int col, int row);
121 void text_setCoord(struct Bitmap *bm, int x, int y);
122 int text_putchar(char c, struct Bitmap *bm);
123 uint8_t text_style(struct Bitmap *bm, uint8_t flags, uint8_t mask);
124 void text_clear(struct Bitmap *bm);
125 void text_clearLine(struct Bitmap *bm, int line);
127 /* Text formatting functions (mware/text_format.c) */
128 int text_puts(const char *str, struct Bitmap *bm);
129 int text_vprintf(struct Bitmap *bm, const char *fmt, va_list ap);
130 int text_printf(struct Bitmap *bm, const char *fmt, ...) FORMAT(__printf__, 2, 3);
131 int text_xyvprintf(struct Bitmap *bm, coord_t x, coord_t y, uint16_t mode, const char *fmt, va_list ap);
132 int text_xyprintf(struct Bitmap *bm, coord_t x, coord_t col, uint16_t mode, const char *fmt, ...) FORMAT(__printf__, 5, 6);
133 int text_xprintf(struct Bitmap *bm, uint8_t row, uint8_t col, uint16_t mode, const char *fmt, ...) FORMAT(__printf__, 5, 6);
134 int text_vwidthf(struct Bitmap *bm, const char * fmt, va_list ap);
135 int text_widthf(struct Bitmap *bm, const char * fmt, ...) FORMAT(__printf__, 2, 3);
137 /* Text formatting functions for program-memory strings (mware/text_format.c) */
139 #include <mware/pgm.h>
140 int text_puts_P(const char * PROGMEM str, struct Bitmap *bm);
141 int text_vprintf_P(struct Bitmap *bm, const char * PROGMEM fmt, va_list ap);
142 int text_printf_P(struct Bitmap *bm, const char * PROGMEM fmt, ...) FORMAT(__printf__, 2, 3);
143 int text_xprintf_P(struct Bitmap *bm, uint8_t row, uint8_t col, uint16_t mode, const char * PROGMEM fmt, ...) FORMAT(__printf__, 5, 6);
144 int text_vwidthf_P(struct Bitmap *bm, const char * PROGMEM fmt, va_list ap);
145 int text_widthf_P(struct Bitmap *bm, const char * PROGMEM fmt, ...);
146 #endif /* CPU_HARVARD */
148 #endif /* GFX_TEXT_H */