| [2] | 1 | /* Copyright (C) 1991-1993,1995-1999,2000,2001 Free Software Foundation, Inc. |
|---|
| 2 | This file is part of the GNU C Library. |
|---|
| 3 | |
|---|
| 4 | The GNU C Library is free software; you can redistribute it and/or |
|---|
| 5 | modify it under the terms of the GNU Lesser General Public |
|---|
| 6 | License as published by the Free Software Foundation; either |
|---|
| 7 | version 2.1 of the License, or (at your option) any later version. |
|---|
| 8 | |
|---|
| 9 | The GNU C Library is distributed in the hope that it will be useful, |
|---|
| 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
|---|
| 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|---|
| 12 | Lesser General Public License for more details. |
|---|
| 13 | |
|---|
| 14 | You should have received a copy of the GNU Lesser General Public |
|---|
| 15 | License along with the GNU C Library; if not, write to the Free |
|---|
| 16 | Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
|---|
| 17 | 02111-1307 USA. */ |
|---|
| 18 | |
|---|
| 19 | /* March 11, 2001 Manuel Novoa III |
|---|
| 20 | * |
|---|
| 21 | * Modified as appropriate for my new stdio lib. |
|---|
| 22 | */ |
|---|
| 23 | |
|---|
| 24 | #ifndef _PRINTF_H |
|---|
| 25 | |
|---|
| 26 | #define _PRINTF_H 1 |
|---|
| 27 | #include <features.h> |
|---|
| 28 | |
|---|
| 29 | __BEGIN_DECLS |
|---|
| 30 | |
|---|
| 31 | #define __need_FILE |
|---|
| 32 | #include <stdio.h> |
|---|
| 33 | #define __need_size_t |
|---|
| 34 | #define __need_wchar_t |
|---|
| 35 | #include <stddef.h> |
|---|
| 36 | |
|---|
| 37 | /* WARNING -- This is definitely nonportable... but it seems to work |
|---|
| 38 | * with gcc, which is currently the only "supported" compiler. |
|---|
| 39 | * The library code uses bitmasks for space-efficiency (you can't |
|---|
| 40 | * set/test multiple bitfields in one operation). Unfortunatly, we |
|---|
| 41 | * need to support bitfields since that's what glibc uses. So, we take |
|---|
| 42 | * advantage of how gcc lays out bitfields to create an appropriate |
|---|
| 43 | * mapping. By defining __PRINTF_INFO_NO_BITFIELD we access the |
|---|
| 44 | * bitfields using bitmasks in a single flag variable. |
|---|
| 45 | * |
|---|
| 46 | * WARNING -- This may very well fail if built with -fpack-struct!!! |
|---|
| 47 | * |
|---|
| 48 | * TODO -- Add a validation test. |
|---|
| 49 | * TODO -- Add an option to build in a shim translation function if |
|---|
| 50 | * the bitfield<->bitmask mapping fails. |
|---|
| 51 | */ |
|---|
| 52 | /* #define __PRINTF_INFO_NO_BITFIELD */ |
|---|
| 53 | #include <endian.h> |
|---|
| 54 | |
|---|
| 55 | struct printf_info |
|---|
| 56 | { |
|---|
| 57 | int prec; /* Precision. */ |
|---|
| 58 | int width; /* Width. */ |
|---|
| 59 | #ifdef __UCLIBC_HAS_WCHAR__ |
|---|
| 60 | wchar_t spec; /* Format letter. */ |
|---|
| 61 | #else |
|---|
| 62 | int spec; |
|---|
| 63 | #endif |
|---|
| 64 | #ifndef __PRINTF_INFO_NO_BITFIELD |
|---|
| 65 | #if __BYTE_ORDER == __LITTLE_ENDIAN |
|---|
| 66 | unsigned int space:1; /* Space flag. */ |
|---|
| 67 | unsigned int showsign:1; /* + flag. */ |
|---|
| 68 | unsigned int extra:1; /* For special use. */ |
|---|
| 69 | unsigned int left:1; /* - flag. */ |
|---|
| 70 | unsigned int alt:1; /* # flag. */ |
|---|
| 71 | unsigned int group:1; /* ' flag. */ |
|---|
| 72 | unsigned int i18n:1; /* I flag. */ |
|---|
| 73 | unsigned int wide:1; /* Nonzero for wide character streams. */ |
|---|
| 74 | unsigned int is_char:1; /* hh flag. */ |
|---|
| 75 | unsigned int is_short:1; /* h flag. */ |
|---|
| 76 | unsigned int is_long:1; /* l flag. */ |
|---|
| 77 | unsigned int is_long_double:1;/* L flag. */ |
|---|
| 78 | |
|---|
| 79 | #elif __BYTE_ORDER == __BIG_ENDIAN |
|---|
| 80 | |
|---|
| 81 | unsigned int __padding:20;/* non-gnu -- total of 32 bits on 32bit arch */ |
|---|
| 82 | unsigned int is_long_double:1;/* L flag. */ |
|---|
| 83 | unsigned int is_long:1; /* l flag. */ |
|---|
| 84 | unsigned int is_short:1; /* h flag. */ |
|---|
| 85 | unsigned int is_char:1; /* hh flag. */ |
|---|
| 86 | unsigned int wide:1; /* Nonzero for wide character streams. */ |
|---|
| 87 | unsigned int i18n:1; /* I flag. */ |
|---|
| 88 | unsigned int group:1; /* ' flag. */ |
|---|
| 89 | unsigned int alt:1; /* # flag. */ |
|---|
| 90 | unsigned int left:1; /* - flag. */ |
|---|
| 91 | unsigned int extra:1; /* For special use. */ |
|---|
| 92 | unsigned int showsign:1; /* + flag. */ |
|---|
| 93 | unsigned int space:1; /* Space flag. */ |
|---|
| 94 | |
|---|
| 95 | #else |
|---|
| 96 | #error unsupported byte order! |
|---|
| 97 | #endif |
|---|
| 98 | |
|---|
| 99 | #define PRINT_INFO_FLAG_VAL(INFO_PTR,BITFIELD) (INFO_PTR)->BITFIELD |
|---|
| 100 | #define PRINT_INFO_SET_FLAG(INFO_PTR,BITFIELD) (INFO_PTR)->BITFIELD = 1 |
|---|
| 101 | #define PRINT_INFO_CLR_FLAG(INFO_PTR,BITFIELD) (INFO_PTR)->BITFIELD = 0 |
|---|
| 102 | #define PRINT_INFO_SET_extra(INFO_PTR,VAL) (INFO_PTR)->extra = (VAL) |
|---|
| 103 | |
|---|
| 104 | #else /* __PRINTF_INFO_NO_BITFIELD */ |
|---|
| 105 | |
|---|
| 106 | unsigned int _flags; /* non-gnu */ |
|---|
| 107 | #define __PRINT_INFO_FLAG_space (1<<0) |
|---|
| 108 | #define __PRINT_INFO_FLAG_showsign (1<<1) |
|---|
| 109 | #define __PRINT_INFO_FLAG_extra (1<<2) |
|---|
| 110 | #define __PRINT_INFO_FLAG_left (1<<3) |
|---|
| 111 | #define __PRINT_INFO_FLAG_alt (1<<4) |
|---|
| 112 | #define __PRINT_INFO_FLAG_group (1<<5) |
|---|
| 113 | #define __PRINT_INFO_FLAG_i18n (1<<6) |
|---|
| 114 | #define __PRINT_INFO_FLAG_wide (1<<7) |
|---|
| 115 | |
|---|
| 116 | #define __PRINT_INFO_FLAG_is_char (1<<8) |
|---|
| 117 | #define __PRINT_INFO_FLAG_is_short (1<<9) |
|---|
| 118 | #define __PRINT_INFO_FLAG_is_long (1<<10) |
|---|
| 119 | #define __PRINT_INFO_FLAG_is_long_double (1<<11) |
|---|
| 120 | |
|---|
| 121 | #if defined(__STDC__) && __STDC__ |
|---|
| 122 | #define PRINT_INFO_FLAG_VAL(INFO_PTR,BITFIELD) \ |
|---|
| 123 | ((INFO_PTR)->_flags & __PRINT_INFO_FLAG_##BITFIELD) |
|---|
| 124 | #define PRINT_INFO_SET_FLAG(INFO_PTR,BITFIELD) \ |
|---|
| 125 | ((INFO_PTR)->_flags |= __PRINT_INFO_FLAG_##BITFIELD) |
|---|
| 126 | #define PRINT_INFO_CLR_FLAG(INFO_PTR,BITFIELD) \ |
|---|
| 127 | ((INFO_PTR)->_flags &= ~__PRINT_INFO_FLAG_##BITFIELD) |
|---|
| 128 | #else |
|---|
| 129 | #define PRINT_INFO_FLAG_VAL(INFO_PTR,BITFIELD) \ |
|---|
| 130 | ((INFO_PTR)->_flags & __PRINT_INFO_FLAG_/**/BITFIELD) |
|---|
| 131 | #define PRINT_INFO_SET_FLAG(INFO_PTR,BITFIELD) \ |
|---|
| 132 | ((INFO_PTR)->_flags |= __PRINT_INFO_FLAG_/**/BITFIELD) |
|---|
| 133 | #define PRINT_INFO_CLR_FLAG(INFO_PTR,BITFIELD) \ |
|---|
| 134 | ((INFO_PTR)->_flags &= ~__PRINT_INFO_FLAG_/**/BITFIELD) |
|---|
| 135 | #endif |
|---|
| 136 | #define PRINT_INFO_SET_extra(INFO_PTR,VAL) \ |
|---|
| 137 | ((INFO_PTR)->_flags |= (((INFO_PTR)->_flags & ~1) | ((VAL) & 1))) |
|---|
| 138 | #endif /* __PRINTF_INFO_NO_BITFIELD */ |
|---|
| 139 | #ifdef __UCLIBC_HAS_WCHAR__ |
|---|
| 140 | wchar_t pad; /* Padding character. */ |
|---|
| 141 | #else |
|---|
| 142 | int pad; |
|---|
| 143 | #endif |
|---|
| 144 | }; |
|---|
| 145 | |
|---|
| 146 | |
|---|
| 147 | /* Type of a printf specifier-handler function. |
|---|
| 148 | STREAM is the FILE on which to write output. |
|---|
| 149 | INFO gives information about the format specification. |
|---|
| 150 | ARGS is a vector of pointers to the argument data; |
|---|
| 151 | the number of pointers will be the number returned |
|---|
| 152 | by the associated arginfo function for the same INFO. |
|---|
| 153 | |
|---|
| 154 | The function should return the number of characters written, |
|---|
| 155 | or -1 for errors. */ |
|---|
| 156 | |
|---|
| 157 | typedef int (*printf_function) (FILE *__stream, |
|---|
| 158 | __const struct printf_info *__info, |
|---|
| 159 | __const void *__const *__args); |
|---|
| 160 | |
|---|
| 161 | /* Type of a printf specifier-arginfo function. |
|---|
| 162 | INFO gives information about the format specification. |
|---|
| 163 | N, ARGTYPES, and return value are as for parse_printf_format. */ |
|---|
| 164 | |
|---|
| 165 | typedef int printf_arginfo_function (__const struct printf_info *__info, |
|---|
| 166 | size_t __n, int *__argtypes); |
|---|
| 167 | |
|---|
| 168 | |
|---|
| 169 | /* Register FUNC to be called to format SPEC specifiers; ARGINFO must be |
|---|
| 170 | specified to determine how many arguments a SPEC conversion requires and |
|---|
| 171 | what their types are. */ |
|---|
| 172 | |
|---|
| 173 | extern int register_printf_function (int __spec, printf_function __func, |
|---|
| 174 | printf_arginfo_function __arginfo); |
|---|
| 175 | |
|---|
| 176 | |
|---|
| 177 | /* Parse FMT, and fill in N elements of ARGTYPES with the |
|---|
| 178 | types needed for the conversions FMT specifies. Returns |
|---|
| 179 | the number of arguments required by FMT. |
|---|
| 180 | |
|---|
| 181 | The ARGINFO function registered with a user-defined format is passed a |
|---|
| 182 | `struct printf_info' describing the format spec being parsed. A width |
|---|
| 183 | or precision of INT_MIN means a `*' was used to indicate that the |
|---|
| 184 | width/precision will come from an arg. The function should fill in the |
|---|
| 185 | array it is passed with the types of the arguments it wants, and return |
|---|
| 186 | the number of arguments it wants. */ |
|---|
| 187 | |
|---|
| 188 | extern size_t parse_printf_format (__const char *__restrict __fmt, size_t __n, |
|---|
| 189 | int *__restrict __argtypes) __THROW; |
|---|
| 190 | |
|---|
| 191 | |
|---|
| 192 | /* Codes returned by `parse_printf_format' for basic types. |
|---|
| 193 | |
|---|
| 194 | These values cover all the standard format specifications. |
|---|
| 195 | Users can add new values after PA_LAST for their own types. */ |
|---|
| 196 | |
|---|
| 197 | /* WARNING -- The above is not entirely true, even for glibc. |
|---|
| 198 | * As far as the library code is concerned, such args are treated |
|---|
| 199 | * as 'your type' pointers if qualified by PA_FLAG_PTR. If they |
|---|
| 200 | * aren't qualified as pointers, I _think_ glibc just ignores them |
|---|
| 201 | * and carries on. I think it should be treated as an error. */ |
|---|
| 202 | |
|---|
| 203 | enum |
|---|
| 204 | { /* C type: */ |
|---|
| 205 | PA_INT, /* int */ |
|---|
| 206 | PA_CHAR, /* int, cast to char */ |
|---|
| 207 | PA_WCHAR, /* wide char */ |
|---|
| 208 | PA_STRING, /* const char *, a '\0'-terminated string */ |
|---|
| 209 | PA_WSTRING, /* const wchar_t *, wide character string */ |
|---|
| 210 | PA_POINTER, /* void * */ |
|---|
| 211 | PA_FLOAT, /* float */ |
|---|
| 212 | PA_DOUBLE, /* double */ |
|---|
| 213 | __PA_NOARG, /* non-glibc -- signals non-arg width or prec */ |
|---|
| 214 | PA_LAST |
|---|
| 215 | }; |
|---|
| 216 | |
|---|
| 217 | /* Flag bits that can be set in a type returned by `parse_printf_format'. */ |
|---|
| 218 | /* WARNING -- These differ in value from what glibc uses. */ |
|---|
| 219 | #define PA_FLAG_MASK (0xff00) |
|---|
| 220 | #define __PA_FLAG_CHAR (0x0100) /* non-gnu -- to deal with hh */ |
|---|
| 221 | #define PA_FLAG_SHORT (0x0200) |
|---|
| 222 | #define PA_FLAG_LONG (0x0400) |
|---|
| 223 | #define PA_FLAG_LONG_LONG (0x0800) |
|---|
| 224 | #define PA_FLAG_LONG_DOUBLE PA_FLAG_LONG_LONG |
|---|
| 225 | #define PA_FLAG_PTR (0x1000) /* TODO -- make dynamic??? */ |
|---|
| 226 | |
|---|
| 227 | #define __PA_INTMASK (0x0f00) /* non-gnu -- all int flags */ |
|---|
| 228 | |
|---|
| 229 | #if 0 |
|---|
| 230 | /* Function which can be registered as `printf'-handlers. */ |
|---|
| 231 | |
|---|
| 232 | /* Print floating point value using using abbreviations for the orders |
|---|
| 233 | of magnitude used for numbers ('k' for kilo, 'm' for mega etc). If |
|---|
| 234 | the format specifier is a uppercase character powers of 1000 are |
|---|
| 235 | used. Otherwise powers of 1024. */ |
|---|
| 236 | extern int printf_size (FILE *__restrict __fp, |
|---|
| 237 | __const struct printf_info *__info, |
|---|
| 238 | __const void *__const *__restrict __args) __THROW; |
|---|
| 239 | |
|---|
| 240 | /* This is the appropriate argument information function for `printf_size'. */ |
|---|
| 241 | extern int printf_size_info (__const struct printf_info *__restrict |
|---|
| 242 | __info, size_t __n, int *__restrict __argtypes) |
|---|
| 243 | __THROW; |
|---|
| 244 | |
|---|
| 245 | #endif |
|---|
| 246 | |
|---|
| 247 | __END_DECLS |
|---|
| 248 | |
|---|
| 249 | #endif /* printf.h */ |
|---|
