8e3ea0af88ab11d678ca77b033f8809814a639f2
[kopensolaris-gnu/glibc.git] / stdio-common / printf-parse.h
1 /* Internal header for parsing printf format strings.
2    Copyright (C) 1995, 1996 Free Software Foundation, Inc.
3    This file is part of th GNU C Library.
4
5    The GNU C Library is free software; you can redistribute it and/or
6    modify it under the terms of the GNU Library General Public License as
7    published by the Free Software Foundation; either version 2 of the
8    License, or (at your option) any later version.
9
10    The GNU C Library is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    Library General Public License for more details.
14
15    You should have received a copy of the GNU Library General Public
16    License along with the GNU C Library; see the file COPYING.LIB.  If not,
17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18    Boston, MA 02111-1307, USA.  */
19
20 #include <ctype.h>
21 #include <printf.h>
22 #include <string.h>
23 #include <stddef.h>
24
25 #define NDEBUG 1
26 #include <assert.h>
27
28 #ifndef MAX
29 #define MAX(a,b)        ({typeof(a) _a = (a); typeof(b) _b = (b);             \
30                           _a > _b ? _a : _b; })
31 #endif
32 #ifndef MIN
33 #define MIN(a,b)        ({typeof(a) _a = (a); typeof(b) _b = (b);             \
34                           _a < _b ? _a : _b; })
35 #endif
36
37 struct printf_spec
38   {
39     /* Information parsed from the format spec.  */
40     struct printf_info info;
41
42     /* Pointers into the format string for the end of this format
43        spec and the next (or to the end of the string if no more).  */
44     const char *end_of_fmt, *next_fmt;
45
46     /* Position of arguments for precision and width, or -1 if `info' has
47        the constant value.  */
48     int prec_arg, width_arg;
49
50     int data_arg;               /* Position of data argument.  */
51     int data_arg_type;          /* Type of first argument.  */
52     /* Number of arguments consumed by this format specifier.  */
53     size_t ndata_args;
54   };
55
56
57 /* The various kinds off arguments that can be passed to printf.  */
58 union printf_arg
59   {
60     unsigned char pa_char;
61     wchar_t pa_wchar;
62     short int pa_short_int;
63     int pa_int;
64     long int pa_long_int;
65     long long int pa_long_long_int;
66     unsigned short int pa_u_short_int;
67     unsigned int pa_u_int;
68     unsigned long int pa_u_long_int;
69     unsigned long long int pa_u_long_long_int;
70     float pa_float;
71     double pa_double;
72     long double pa_long_double;
73     const char *pa_string;
74     const wchar_t *pa_wstring;
75     void *pa_pointer;
76   };
77
78
79 /* Read a simple integer from a string and update the string pointer.
80    It is assumed that the first character is a digit.  */
81 static inline unsigned int
82 read_int (const UCHAR_T * *pstr)
83 {
84   unsigned int retval = **pstr - L_('0');
85
86   while (ISDIGIT (*++(*pstr)))
87     {
88       retval *= 10;
89       retval += **pstr - L_('0');
90     }
91
92   return retval;
93 }
94
95
96
97 /* Find the next spec in FORMAT, or the end of the string.  Returns
98    a pointer into FORMAT, to a '%' or a '\0'.  */
99 static inline const char *
100 find_spec (const char *format, mbstate_t *ps)
101 {
102   while (*format != '\0' && *format != '%')
103     {
104       int len;
105
106       /* Remove any hints of a wrong encoding.  */
107       ps->count = 0;
108       if (isascii (*format) || (len = mbrlen (format, MB_CUR_MAX, ps)) <= 0)
109         ++format;
110       else
111         format += len;
112     }
113   return format;
114 }
115
116
117 /* This is defined in reg-printf.c.  */
118 extern printf_arginfo_function **__printf_arginfo_table;
119
120
121 /* FORMAT must point to a '%' at the beginning of a spec.  Fills in *SPEC
122    with the parsed details.  POSN is the number of arguments already
123    consumed.  At most MAXTYPES - POSN types are filled in TYPES.  Return
124    the number of args consumed by this spec; *MAX_REF_ARG is updated so it
125    remains the highest argument index used.  */
126 static inline size_t
127 parse_one_spec (const UCHAR_T *format, size_t posn, struct printf_spec *spec,
128                 size_t *max_ref_arg, mbstate_t *ps)
129 {
130   unsigned int n;
131   size_t nargs = 0;
132
133   /* Skip the '%'.  */
134   ++format;
135
136   /* Clear information structure.  */
137   spec->data_arg = -1;
138   spec->info.alt = 0;
139   spec->info.space = 0;
140   spec->info.left = 0;
141   spec->info.showsign = 0;
142   spec->info.group = 0;
143   spec->info.pad = ' ';
144
145   /* Test for positional argument.  */
146   if (ISDIGIT (*format))
147     {
148       const UCHAR_T *begin = format;
149
150       n = read_int (&format);
151
152       if (n > 0 && *format == L_('$'))
153         /* Is positional parameter.  */
154         {
155           ++format;             /* Skip the '$'.  */
156           spec->data_arg = n - 1;
157           *max_ref_arg = MAX (*max_ref_arg, n);
158         }
159       else
160         /* Oops; that was actually the width and/or 0 padding flag.
161            Step back and read it again.  */
162         format = begin;
163     }
164
165   /* Check for spec modifiers.  */
166   while (*format == L_(' ') || *format == L_('+') || *format == L_('-') ||
167          *format == L_('#') || *format == L_('0') || *format == L_('\''))
168     switch (*format++)
169       {
170       case L_(' '):
171         /* Output a space in place of a sign, when there is no sign.  */
172         spec->info.space = 1;
173         break;
174       case L_('+'):
175         /* Always output + or - for numbers.  */
176         spec->info.showsign = 1;
177         break;
178       case L_('-'):
179         /* Left-justify things.  */
180         spec->info.left = 1;
181         break;
182       case L_('#'):
183         /* Use the "alternate form":
184            Hex has 0x or 0X, FP always has a decimal point.  */
185         spec->info.alt = 1;
186         break;
187       case L_('0'):
188         /* Pad with 0s.  */
189         spec->info.pad = '0';
190         break;
191       case L_('\''):
192         /* Show grouping in numbers if the locale information
193            indicates any.  */
194         spec->info.group = 1;
195         break;
196       }
197   if (spec->info.left)
198     spec->info.pad = ' ';
199
200   /* Get the field width.  */
201   spec->width_arg = -1;
202   spec->info.width = 0;
203   if (*format == L_('*'))
204     {
205       /* The field width is given in an argument.
206          A negative field width indicates left justification.  */
207       const UCHAR_T *begin = ++format;
208
209       if (ISDIGIT (*format))
210         {
211           /* The width argument might be found in a positional parameter.  */
212           n = read_int (&format);
213
214           if (n > 0 && *format == L_('$'))
215             {
216               spec->width_arg = n - 1;
217               *max_ref_arg = MAX (*max_ref_arg, n);
218               ++format;         /* Skip '$'.  */
219             }
220         }
221
222       if (spec->width_arg < 0)
223         {
224           /* Not in a positional parameter.  Consume one argument.  */
225           spec->width_arg = posn++;
226           ++nargs;
227           format = begin;       /* Step back and reread.  */
228         }
229     }
230   else if (ISDIGIT (*format))
231     /* Constant width specification.  */
232     spec->info.width = read_int (&format);
233
234   /* Get the precision.  */
235   spec->prec_arg = -1;
236   /* -1 means none given; 0 means explicit 0.  */
237   spec->info.prec = -1;
238   if (*format == L_('.'))
239     {
240       ++format;
241       if (*format == L_('*'))
242         {
243           /* The precision is given in an argument.  */
244           const UCHAR_T *begin = ++format;
245
246           if (ISDIGIT (*format))
247             {
248               n = read_int (&format);
249
250               if (n > 0 && *format == L_('$'))
251                 {
252                   spec->prec_arg = n - 1;
253                   *max_ref_arg = MAX (*max_ref_arg, n);
254                   ++format;
255                 }
256             }
257
258           if (spec->prec_arg < 0)
259             {
260               /* Not in a positional parameter.  */
261               spec->prec_arg = posn++;
262               ++nargs;
263               format = begin;
264             }
265         }
266       else if (ISDIGIT (*format))
267         spec->info.prec = read_int (&format);
268       else
269         /* "%.?" is treated like "%.0?".  */
270         spec->info.prec = 0;
271     }
272
273   /* Check for type modifiers.  */
274 #define is_longlong is_long_double
275   spec->info.is_long_double = 0;
276   spec->info.is_short = 0;
277   spec->info.is_long = 0;
278
279   if (*format == L_('h') || *format == L_('l') || *format == L_('L') ||
280       *format == L_('Z') || *format == L_('q'))
281     switch (*format++)
282       {
283       case L_('h'):
284         /* int's are short int's.  */
285         spec->info.is_short = 1;
286         break;
287       case L_('l'):
288         /* int's are long int's.  */
289         spec->info.is_long = 1;
290         if (*format != L_('l'))
291           break;
292         ++format;
293         /* FALLTHROUGH */
294       case L_('L'):
295         /* double's are long double's, and int's are long long int's.  */
296       case L_('q'):
297         /* 4.4 uses this for long long.  */
298         spec->info.is_long_double = 1;
299         break;
300       case L_('Z'):
301         /* int's are size_t's.  */
302         assert (sizeof(size_t) <= sizeof(unsigned long long int));
303         spec->info.is_longlong = sizeof(size_t) > sizeof(unsigned long int);
304         spec->info.is_long = sizeof(size_t) > sizeof(unsigned int);
305         break;
306       }
307
308   /* Get the format specification.  */
309   spec->info.spec = (wchar_t) *format++;
310   if (__printf_arginfo_table != NULL &&
311       __printf_arginfo_table[spec->info.spec] != NULL)
312     /* We don't try to get the types for all arguments if the format
313        uses more than one.  The normal case is covered though.  */
314     spec->ndata_args = (*__printf_arginfo_table[spec->info.spec])
315       (&spec->info, 1, &spec->data_arg_type);
316   else
317     {
318       /* Find the data argument types of a built-in spec.  */
319       spec->ndata_args = 1;
320
321       switch (spec->info.spec)
322         {
323         case L'i':
324         case L'd':
325         case L'u':
326         case L'o':
327         case L'X':
328         case L'x':
329           if (spec->info.is_longlong)
330             spec->data_arg_type = PA_INT|PA_FLAG_LONG_LONG;
331           else if (spec->info.is_long)
332             spec->data_arg_type = PA_INT|PA_FLAG_LONG;
333           else if (spec->info.is_short)
334             spec->data_arg_type = PA_INT|PA_FLAG_SHORT;
335           else
336             spec->data_arg_type = PA_INT;
337           break;
338         case L'e':
339         case L'E':
340         case L'f':
341         case L'g':
342         case L'G':
343           if (spec->info.is_long_double)
344             spec->data_arg_type = PA_DOUBLE|PA_FLAG_LONG_DOUBLE;
345           else
346             spec->data_arg_type = PA_DOUBLE;
347           break;
348         case L'c':
349           spec->data_arg_type = PA_CHAR;
350           break;
351         case L'C':
352           spec->data_arg_type = PA_WCHAR;
353           break;
354         case L's':
355           spec->data_arg_type = PA_STRING;
356           break;
357         case L'S':
358           spec->data_arg_type = PA_WSTRING;
359           break;
360         case L'p':
361           spec->data_arg_type = PA_POINTER;
362           break;
363         case L'n':
364           spec->data_arg_type = PA_INT|PA_FLAG_PTR;
365           break;
366
367         case L'm':
368         default:
369           /* An unknown spec will consume no args.  */
370           spec->ndata_args = 0;
371           break;
372         }
373
374       if (spec->data_arg == -1 && spec->ndata_args > 0)
375         {
376           /* There are args consumed, but no positional spec.
377              Use the next sequential arg position.  */
378           spec->data_arg = posn;
379           posn += spec->ndata_args;
380           nargs += spec->ndata_args;
381         }
382     }
383
384   if (spec->info.spec == L'\0')
385     /* Format ended before this spec was complete.  */
386     spec->end_of_fmt = spec->next_fmt = format - 1;
387   else
388     {
389       /* Find the next format spec.  */
390       spec->end_of_fmt = format;
391       spec->next_fmt = find_spec (format, ps);
392     }
393
394   return nargs;
395 }