Updated copiright notice.
[bertos.git] / mware / sprintf.c
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 2002, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
30  * This file is part of DevLib - See README.devlib for information.
31  * -->
32  *
33  * \brief sprintf() implementation based on _formatted_write()
34  *
35  * \version $Id$
36  * \author Bernardo Innocenti <bernie@develer.com>
37  */
38
39 /*#*
40  *#* $Log$
41  *#* Revision 1.11  2006/07/19 12:56:28  bernie
42  *#* Convert to new Doxygen style.
43  *#*
44  *#* Revision 1.10  2005/04/11 19:10:28  bernie
45  *#* Include top-level headers from cfg/ subdir.
46  *#*
47  *#* Revision 1.9  2005/02/18 12:48:01  bernie
48  *#* Fix bug with NULL buffers (caught with unit test).
49  *#*
50  *#* Revision 1.8  2005/02/18 12:34:29  bernie
51  *#* Include <mware/pgm.h> explicitly for non-Harvard archs.
52  *#*
53  *#* Revision 1.7  2004/12/31 17:47:45  bernie
54  *#* Rename UNUSED() to UNUSED_ARG().
55  *#*
56  *#* Revision 1.6  2004/11/16 21:15:19  bernie
57  *#* Fix off-by-one bug in [v]snprintf().
58  *#*
59  *#* Revision 1.5  2004/10/03 18:54:36  bernie
60  *#* sprintf(): Fix a serious bug; snprintf(): New function.
61  *#*
62  *#* Revision 1.4  2004/08/25 14:12:09  rasky
63  *#* Aggiornato il comment block dei log RCS
64  *#*
65  *#* Revision 1.3  2004/06/27 15:20:26  aleph
66  *#* Change UNUSED() macro to accept two arguments: type and name;
67  *#* Add macro GNUC_PREREQ to detect GCC version during build;
68  *#* Some spacing cleanups and typo fix
69  *#*
70  *#* Revision 1.2  2004/06/03 11:27:09  bernie
71  *#* Add dual-license information.
72  *#*/
73
74 #include <mware/formatwr.h>
75 #include <mware/pgm.h>
76 #include <cfg/compiler.h>
77
78 #include <stdio.h>
79
80
81 static void __str_put_char(char c, void *ptr)
82 {
83         /*
84          * This Does not work on Code Warrior. Hmm...
85          *      *(*((char **)ptr))++ = c;
86          */
87
88         **((char **)ptr) = c;
89         (*((char **)ptr))++;
90 }
91
92 static void __null_put_char(UNUSED_ARG(char, c), UNUSED_ARG(void *, ptr))
93 {
94         /* nop */
95 }
96
97
98 int PGM_FUNC(vsprintf)(char *str, const char * PGM_ATTR fmt, va_list ap)
99 {
100         int result;
101
102         if (str)
103         {
104                 result = PGM_FUNC(_formatted_write)(fmt, __str_put_char, &str, ap);
105
106                 /* Terminate string */
107                 *str = '\0';
108         }
109         else
110                 result = PGM_FUNC(_formatted_write)(fmt, __null_put_char, 0, ap);
111
112
113         return result;
114 }
115
116
117 int PGM_FUNC(sprintf)(char *str, const char * fmt, ...)
118 {
119         int result;
120         va_list ap;
121
122         va_start(ap, fmt);
123         result = PGM_FUNC(vsprintf)(str, fmt, ap);
124         va_end(ap);
125
126         return result;
127 }
128
129 /**
130  * State information for __sn_put_char()
131  */
132 struct __sn_state
133 {
134         char *str;
135         size_t len;
136 };
137
138 /**
139  * formatted_write() callback used [v]snprintf().
140  */
141 static void __sn_put_char(char c, void *ptr)
142 {
143         struct __sn_state *state = (struct __sn_state *)ptr;
144
145         if (state->len)
146         {
147                 --state->len;
148                 *state->str++ = c;
149         }
150 }
151
152
153 int PGM_FUNC(vsnprintf)(char *str, size_t size, const char * PGM_ATTR fmt, va_list ap)
154 {
155         int result = 0;
156
157         /* Make room for traling '\0'. */
158         if (size--)
159         {
160                 if (str)
161                 {
162                         struct __sn_state state;
163                         state.str = str;
164                         state.len = size;
165
166                         result = PGM_FUNC(_formatted_write)(fmt, __sn_put_char, &state, ap);
167
168                         /* Terminate string. */
169                         *state.str = '\0';
170                 }
171                 else
172                         result = PGM_FUNC(_formatted_write)(fmt, __null_put_char, 0, ap);
173         }
174
175         return result;
176 }
177
178
179 int PGM_FUNC(snprintf)(char *str, size_t size, const char * fmt, ...)
180 {
181         int result;
182         va_list ap;
183
184         va_start(ap, fmt);
185         result = PGM_FUNC(vsnprintf)(str, size, fmt, ap);
186         va_end(ap);
187
188         return result;
189 }