ncurses 5.9 - patch 20121117
[ncurses.git] / ncurses / base / safe_sprintf.c
1 /****************************************************************************
2  * Copyright (c) 1998-2010,2012 Free Software Foundation, Inc.              *
3  *                                                                          *
4  * Permission is hereby granted, free of charge, to any person obtaining a  *
5  * copy of this software and associated documentation files (the            *
6  * "Software"), to deal in the Software without restriction, including      *
7  * without limitation the rights to use, copy, modify, merge, publish,      *
8  * distribute, distribute with modifications, sublicense, and/or sell       *
9  * copies of the Software, and to permit persons to whom the Software is    *
10  * furnished to do so, subject to the following conditions:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22  *                                                                          *
23  * Except as contained in this notice, the name(s) of the above copyright   *
24  * holders shall not be used in advertising or otherwise to promote the     *
25  * sale, use or other dealings in this Software without prior written       *
26  * authorization.                                                           *
27  ****************************************************************************/
28
29 /****************************************************************************
30  *  Author: Thomas E. Dickey <dickey@clark.net> 1997                        *
31  ****************************************************************************/
32
33 #include <curses.priv.h>
34 #include <ctype.h>
35
36 MODULE_ID("$Id: safe_sprintf.c,v 1.26 2012/02/22 22:40:24 tom Exp $")
37
38 #if USE_SAFE_SPRINTF
39
40 typedef enum {
41     Flags, Width, Prec, Type, Format
42 } PRINTF;
43
44 #define VA_INTGR(type) ival = va_arg(ap, type)
45 #define VA_FLOAT(type) fval = va_arg(ap, type)
46 #define VA_POINT(type) pval = (void *)va_arg(ap, type)
47
48 /*
49  * Scan a variable-argument list for printf to determine the number of
50  * characters that would be emitted.
51  */
52 static int
53 _nc_printf_length(const char *fmt, va_list ap)
54 {
55     size_t length = BUFSIZ;
56     char *buffer;
57     char *format;
58     int len = 0;
59     size_t fmt_len;
60     char fmt_arg[BUFSIZ];
61
62     if (fmt == 0 || *fmt == '\0')
63         return 0;
64     fmt_len = strlen(fmt) + 1;
65     if ((format = typeMalloc(char, fmt_len)) == 0)
66           return -1;
67     if ((buffer = typeMalloc(char, length)) == 0) {
68         free(format);
69         return -1;
70     }
71
72     while (*fmt != '\0') {
73         if (*fmt == '%') {
74             static char dummy[] = "";
75             PRINTF state = Flags;
76             char *pval = dummy; /* avoid const-cast */
77             double fval = 0.0;
78             int done = FALSE;
79             int ival = 0;
80             int prec = -1;
81             int type = 0;
82             int used = 0;
83             int width = -1;
84             size_t f = 0;
85
86             format[f++] = *fmt;
87             while (*++fmt != '\0' && len >= 0 && !done) {
88                 format[f++] = *fmt;
89
90                 if (isdigit(UChar(*fmt))) {
91                     int num = *fmt - '0';
92                     if (state == Flags && num != 0)
93                         state = Width;
94                     if (state == Width) {
95                         if (width < 0)
96                             width = 0;
97                         width = (width * 10) + num;
98                     } else if (state == Prec) {
99                         if (prec < 0)
100                             prec = 0;
101                         prec = (prec * 10) + num;
102                     }
103                 } else if (*fmt == '*') {
104                     VA_INTGR(int);
105                     if (state == Flags)
106                         state = Width;
107                     if (state == Width) {
108                         width = ival;
109                     } else if (state == Prec) {
110                         prec = ival;
111                     }
112                     _nc_SPRINTF(fmt_arg,
113                                 _nc_SLIMIT(sizeof(fmt_arg))
114                                 "%d", ival);
115                     fmt_len += strlen(fmt_arg);
116                     if ((format = _nc_doalloc(format, fmt_len)) == 0) {
117                         return -1;
118                     }
119                     --f;
120                     _nc_STRCPY(&format[f], fmt_arg, fmt_len - f);
121                     f = strlen(format);
122                 } else if (isalpha(UChar(*fmt))) {
123                     done = TRUE;
124                     switch (*fmt) {
125                     case 'Z':   /* FALLTHRU */
126                     case 'h':   /* FALLTHRU */
127                     case 'l':   /* FALLTHRU */
128                         done = FALSE;
129                         type = *fmt;
130                         break;
131                     case 'i':   /* FALLTHRU */
132                     case 'd':   /* FALLTHRU */
133                     case 'u':   /* FALLTHRU */
134                     case 'x':   /* FALLTHRU */
135                     case 'X':   /* FALLTHRU */
136                         if (type == 'l')
137                             VA_INTGR(long);
138                         else if (type == 'Z')
139                             VA_INTGR(size_t);
140                         else
141                             VA_INTGR(int);
142                         used = 'i';
143                         break;
144                     case 'f':   /* FALLTHRU */
145                     case 'e':   /* FALLTHRU */
146                     case 'E':   /* FALLTHRU */
147                     case 'g':   /* FALLTHRU */
148                     case 'G':   /* FALLTHRU */
149                         VA_FLOAT(double);
150                         used = 'f';
151                         break;
152                     case 'c':
153                         VA_INTGR(int);
154                         used = 'i';
155                         break;
156                     case 's':
157                         VA_POINT(char *);
158                         if (prec < 0)
159                             prec = strlen(pval);
160                         if (prec > (int) length) {
161                             length = length + prec;
162                             buffer = typeRealloc(char, length, buffer);
163                             if (buffer == 0) {
164                                 free(format);
165                                 return -1;
166                             }
167                         }
168                         used = 'p';
169                         break;
170                     case 'p':
171                         VA_POINT(void *);
172                         used = 'p';
173                         break;
174                     case 'n':
175                         VA_POINT(int *);
176                         used = 0;
177                         break;
178                     default:
179                         break;
180                     }
181                 } else if (*fmt == '.') {
182                     state = Prec;
183                 } else if (*fmt == '%') {
184                     done = TRUE;
185                     used = 'p';
186                 }
187             }
188             format[f] = '\0';
189             switch (used) {
190             case 'i':
191                 _nc_SPRINTF(buffer, _nc_SLIMIT(length) format, ival);
192                 break;
193             case 'f':
194                 _nc_SPRINTF(buffer, _nc_SLIMIT(length) format, fval);
195                 break;
196             default:
197                 _nc_SPRINTF(buffer, _nc_SLIMIT(length) format, pval);
198                 break;
199             }
200             len += (int) strlen(buffer);
201         } else {
202             fmt++;
203             len++;
204         }
205     }
206
207     free(buffer);
208     free(format);
209     return len;
210 }
211 #endif
212
213 #define my_buffer _nc_globals.safeprint_buf
214 #define my_length _nc_globals.safeprint_used
215
216 /*
217  * Wrapper for vsprintf that allocates a buffer big enough to hold the result.
218  */
219 NCURSES_EXPORT(char *)
220 NCURSES_SP_NAME(_nc_printf_string) (NCURSES_SP_DCLx
221                                     const char *fmt,
222                                     va_list ap)
223 {
224     char *result = 0;
225
226     if (fmt != 0) {
227 #if USE_SAFE_SPRINTF
228         va_list ap2;
229         int len;
230
231         begin_va_copy(ap2, ap);
232         len = _nc_printf_length(fmt, ap2);
233         end_va_copy(ap2);
234
235         if ((int) my_length < len + 1) {
236             my_length = 2 * (len + 1);
237             my_buffer = typeRealloc(char, my_length, my_buffer);
238         }
239         if (my_buffer != 0) {
240             *my_buffer = '\0';
241             if (len >= 0) {
242                 vsprintf(my_buffer, fmt, ap);
243             }
244             result = my_buffer;
245         }
246 #else
247 #define MyCols _nc_globals.safeprint_cols
248 #define MyRows _nc_globals.safeprint_rows
249
250         if (screen_lines(SP_PARM) > MyRows || screen_columns(SP_PARM) > MyCols) {
251             if (screen_lines(SP_PARM) > MyRows)
252                 MyRows = screen_lines(SP_PARM);
253             if (screen_columns(SP_PARM) > MyCols)
254                 MyCols = screen_columns(SP_PARM);
255             my_length = (size_t) (MyRows * (MyCols + 1)) + 1;
256             my_buffer = typeRealloc(char, my_length, my_buffer);
257         }
258
259         if (my_buffer != 0) {
260 # if HAVE_VSNPRINTF
261             vsnprintf(my_buffer, my_length, fmt, ap);   /* GNU extension */
262 # else
263             vsprintf(my_buffer, fmt, ap);       /* ANSI */
264 # endif
265             result = my_buffer;
266         }
267 #endif
268     } else if (my_buffer != 0) {        /* see _nc_freeall() */
269         free(my_buffer);
270         my_buffer = 0;
271         my_length = 0;
272     }
273     return result;
274 }
275
276 #if NCURSES_SP_FUNCS
277 NCURSES_EXPORT(char *)
278 _nc_printf_string(const char *fmt, va_list ap)
279 {
280     return NCURSES_SP_NAME(_nc_printf_string) (CURRENT_SCREEN, fmt, ap);
281 }
282 #endif