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