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