Release version 2.5.1.
[bertos.git] / 2.5 / bertos / mware / formatwr.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 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  * \version $Id$
34  *
35  * \brief Basic "printf", "sprintf" and "fprintf" formatter.
36  *
37  * $WIZ$ module_name = "formatwr"
38  * $WIZ$ module_configuration = "bertos/cfg/cfg_formatwr.h"
39  * $WIZ$ module_depends = "hex"
40  * $WIZ$ module_harvard = "both"
41  */
42
43 #ifndef MWARE_FORMATWR_H
44 #define MWARE_FORMATWR_H
45
46 #include "cfg/cfg_formatwr.h"
47
48 #include <cpu/attr.h>    /* CPU_HARVARD */
49
50 #include <stdarg.h>      /* va_list */
51
52 /**
53  * \name _formatted_write() configuration
54  * $WIZ$ printf_list = "PRINTF_DISABLED", "PRINTF_NOMODIFIERS", "PRINTF_REDUCED", "PRINTF_NOFLOAT", "PRINTF_FULL"
55  * \{
56  */
57 #define PRINTF_DISABLED    0
58 #define PRINTF_NOMODIFIERS 1
59 #define PRINTF_REDUCED     2
60 #define PRINTF_NOFLOAT     3
61 #define PRINTF_FULL        4
62 /* \} */
63
64 #ifndef CONFIG_PRINTF_RETURN_COUNT
65         /** Enable/disable _formatted_write return value */
66         #define CONFIG_PRINTF_RETURN_COUNT 1
67 #endif
68
69 int
70 _formatted_write(
71         const char *format,
72         void put_char_func(char c, void *user_data),
73         void *user_data,
74         va_list ap);
75
76 #if CPU_HARVARD
77         #include <cpu/pgm.h>
78         int _formatted_write_P(
79                 const char * PROGMEM format,
80                 void put_char_func(char c, void *user_data),
81                 void *user_data,
82                 va_list ap);
83 #endif /* CPU_HARVARD */
84
85 int sprintf_testSetup(void);
86 int sprintf_testRun(void);
87 int sprintf_testTearDown(void);
88
89 #endif /* MWARE_FORMATWR_H */
90