Add missing header.
[bertos.git] / mware / text.h
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 devlib/README 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  2004/10/03 20:43:37  bernie
19  *#* Import changes from project_ks.
20  *#*
21  *#* Revision 1.7  2004/09/20 03:28:49  bernie
22  *#* Fix header; Conditionalize AVR-specific code.
23  *#*
24  *#* Revision 1.6  2004/09/14 20:57:30  bernie
25  *#* Reformat.
26  *#*
27  *#* Revision 1.5  2004/09/06 21:51:26  bernie
28  *#* Extend interface to allow any algorithmic style.
29  *#*
30  *#* Revision 1.4  2004/08/25 14:12:09  rasky
31  *#* Aggiornato il comment block dei log RCS
32  *#*
33  *#* Revision 1.3  2004/08/05 18:46:44  bernie
34  *#* Documentation improvements.
35  *#*
36  *#* Revision 1.2  2004/06/03 11:27:09  bernie
37  *#* Add dual-license information.
38  *#*
39  *#*/
40
41 #ifndef MWARE_TEXT_H
42 #define MWARE_TEXT_H
43
44 #include "compiler.h"
45 #include <stdarg.h>
46
47 /*!
48  * \name Style flags
49  * \see text_style()
50  * \{
51  */
52 #define STYLEF_BOLD        BV(0)
53 #define STYLEF_ITALIC      BV(1)
54 #define STYLEF_UNDERLINE   BV(2)
55 #define STYLEF_INVERT      BV(3)
56 #define STYLEF_EXPANDED    BV(4)
57 #define STYLEF_CONDENSED   BV(5)
58 #define STYLEF_STRIKEOUT   BV(6)  /*<! Not implemented */
59
60 #define STYLEF_MASK \
61         (STYLEF_BOLD | STYLEF_ITALIC | STYLEF_UNDERLINE | \
62         STYLEF_EXPANDED | STYLEF_CONDENSED | STYLEF_INVERT)
63 /*\}*/
64
65 /*!
66  * \name Formatting flags for text rendering
67  * \see text_xprintf()
68  * \{
69  */
70 #define TEXT_NORMAL   0       /*!< Normal mode */
71 #define TEXT_FILL     BV(7)   /*!< Fill rest of line with spaces */
72 #define TEXT_CENTER   BV(8)   /*!< Center string in line */
73 #define TEXT_RIGHT    BV(9)   /*!< Right aligned */
74 /*\}*/
75
76 /*! Escape sequences codes */
77 #define ANSI_ESC_CLEARSCREEN 'c'
78
79
80 /* Fwd decl */
81 struct Bitmap;
82
83 /* Low-level text functions (mware/text.c) */
84 void text_moveto(struct Bitmap *bm, int row, int col);
85 void text_setcoord(struct Bitmap *bm, int x, int y);
86 int text_putchar(char c, struct Bitmap *bm);
87 uint8_t text_style(uint8_t flags, uint8_t mask);
88 void text_clear(struct Bitmap *bm);
89 void text_clearLine(struct Bitmap *bm, int line);
90
91 /* Text formatting functions (mware/text_format.c) */
92 int text_puts(const char *str, struct Bitmap *bm);
93 int text_vprintf(struct Bitmap *bm, const char *fmt, va_list ap);
94 int text_printf(struct Bitmap *bm, const char *fmt, ...) FORMAT(__printf__, 2, 3);
95 int text_xprintf(struct Bitmap *bm, uint8_t row, uint8_t col, uint16_t mode, const char *fmt, ...) FORMAT(__printf__, 5, 6);
96 int text_vwidthf(struct Bitmap *bm, const char * fmt, va_list ap);
97 int text_widthf(struct Bitmap *bm, const char * fmt, ...) FORMAT(__printf__, 2, 3);
98
99 /* Text formatting functions for program-memory strings (mware/text_format.c) */
100 #if CPU_AVR
101 #include <avr/pgmspace.h>
102 int text_puts_P(const char * PROGMEM str, struct Bitmap *bm);
103 int text_vprintf_P(struct Bitmap *bm, const char * PROGMEM fmt, va_list ap);
104 int text_printf_P(struct Bitmap *bm, const char * PROGMEM fmt, ...) FORMAT(__printf__, 2, 3);
105 int text_xprintf_P(struct Bitmap *bm, uint8_t row, uint8_t col, uint16_t mode, const char * PROGMEM fmt, ...) FORMAT(__printf__, 5, 6);
106 int text_vwidthf_P(struct Bitmap *bm, const char * PROGMEM fmt, va_list ap);
107 int text_widthf_P(struct Bitmap *bm, const char * PROGMEM fmt, ...);
108 #endif /* CPU_AVR */
109
110 #endif /* MWARE_TEXT_H */