1/* Check calls to formatted I/O functions (-Wformat). 2 Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 3 2001, 2002, 2003, 2004, 2007, 2008 Free Software Foundation, Inc. 4 5This file is part of GCC. 6 7GCC is free software; you can redistribute it and/or modify it under 8the terms of the GNU General Public License as published by the Free 9Software Foundation; either version 3, or (at your option) any later 10version. 11 12GCC is distributed in the hope that it will be useful, but WITHOUT ANY 13WARRANTY; without even the implied warranty of MERCHANTABILITY or 14FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 15for more details. 16 17You should have received a copy of the GNU General Public License 18along with GCC; see the file COPYING3. If not see 19<http://www.gnu.org/licenses/>. */ 20 21#ifndef GCC_C_FORMAT_H 22#define GCC_C_FORMAT_H 23 24/* The meaningfully distinct length modifiers for format checking recognized 25 by GCC. */ 26enum format_lengths 27{ 28 FMT_LEN_none, 29 FMT_LEN_hh, 30 FMT_LEN_h, 31 FMT_LEN_l, 32 FMT_LEN_ll, 33 FMT_LEN_L, 34 FMT_LEN_z, 35 FMT_LEN_t, 36 FMT_LEN_j, 37 FMT_LEN_H, 38 FMT_LEN_D, 39 FMT_LEN_DD, 40 FMT_LEN_MAX 41}; 42 43 44/* The standard versions in which various format features appeared. */ 45enum format_std_version 46{ 47 STD_C89, 48 STD_C94, 49 STD_C9L, /* C99, but treat as C89 if -Wno-long-long. */ 50 STD_C99, 51 STD_EXT 52}; 53 54/* Flags that may apply to a particular kind of format checked by GCC. */ 55enum 56{ 57 /* This format converts arguments of types determined by the 58 format string. */ 59 FMT_FLAG_ARG_CONVERT = 1, 60 /* The scanf allocation 'a' kludge applies to this format kind. */ 61 FMT_FLAG_SCANF_A_KLUDGE = 2, 62 /* A % during parsing a specifier is allowed to be a modified % rather 63 that indicating the format is broken and we are out-of-sync. */ 64 FMT_FLAG_FANCY_PERCENT_OK = 4, 65 /* With $ operand numbers, it is OK to reference the same argument more 66 than once. */ 67 FMT_FLAG_DOLLAR_MULTIPLE = 8, 68 /* This format type uses $ operand numbers (strfmon doesn't). */ 69 FMT_FLAG_USE_DOLLAR = 16, 70 /* Zero width is bad in this type of format (scanf). */ 71 FMT_FLAG_ZERO_WIDTH_BAD = 32, 72 /* Empty precision specification is OK in this type of format (printf). */ 73 FMT_FLAG_EMPTY_PREC_OK = 64, 74 /* Gaps are allowed in the arguments with $ operand numbers if all 75 arguments are pointers (scanf). */ 76 FMT_FLAG_DOLLAR_GAP_POINTER_OK = 128 77 /* Not included here: details of whether width or precision may occur 78 (controlled by width_char and precision_char); details of whether 79 '*' can be used for these (width_type and precision_type); details 80 of whether length modifiers can occur (length_char_specs). */ 81}; 82 83/* Structure describing a length modifier supported in format checking, and 84 possibly a doubled version such as "hh". */ 85typedef struct 86{ 87 /* Name of the single-character length modifier. If prefixed by 88 a zero character, it describes a multi character length 89 modifier, like I64, I32, etc. */ 90 const char *name; 91 /* Index into a format_char_info.types array. */ 92 enum format_lengths index; 93 /* Standard version this length appears in. */ 94 enum format_std_version std; 95 /* Same, if the modifier can be repeated, or NULL if it can't. */ 96 const char *double_name; 97 enum format_lengths double_index; 98 enum format_std_version double_std; 99 100 /* If this flag is set, just scalar width identity is checked, and 101 not the type identity itself. */ 102 int scalar_identity_flag; 103} format_length_info; 104 105 106/* Structure describing the combination of a conversion specifier 107 (or a set of specifiers which act identically) and a length modifier. */ 108typedef struct 109{ 110 /* The standard version this combination of length and type appeared in. 111 This is only relevant if greater than those for length and type 112 individually; otherwise it is ignored. */ 113 enum format_std_version std; 114 /* The name to use for the type, if different from that generated internally 115 (e.g., "signed size_t"). */ 116 const char *name; 117 /* The type itself. */ 118 tree *type; 119} format_type_detail; 120 121 122/* Macros to fill out tables of these. */ 123#define NOARGUMENTS { T89_V, BADLEN, BADLEN, BADLEN, BADLEN, BADLEN, BADLEN, BADLEN, BADLEN } 124#define BADLEN { STD_C89, NULL, NULL } 125#define NOLENGTHS { BADLEN, BADLEN, BADLEN, BADLEN, BADLEN, BADLEN, BADLEN, BADLEN, BADLEN } 126 127 128/* Structure describing a format conversion specifier (or a set of specifiers 129 which act identically), and the length modifiers used with it. */ 130typedef struct format_char_info 131{ 132 const char *format_chars; 133 int pointer_count; 134 enum format_std_version std; 135 /* Types accepted for each length modifier. */ 136 format_type_detail types[FMT_LEN_MAX]; 137 /* List of other modifier characters allowed with these specifiers. 138 This lists flags, and additionally "w" for width, "p" for precision 139 (right precision, for strfmon), "#" for left precision (strfmon), 140 "a" for scanf "a" allocation extension (not applicable in C99 mode), 141 "*" for scanf suppression, and "E" and "O" for those strftime 142 modifiers. */ 143 const char *flag_chars; 144 /* List of additional flags describing these conversion specifiers. 145 "c" for generic character pointers being allowed, "2" for strftime 146 two digit year formats, "3" for strftime formats giving two digit 147 years in some locales, "4" for "2" which becomes "3" with an "E" modifier, 148 "o" if use of strftime "O" is a GNU extension beyond C99, 149 "W" if the argument is a pointer which is dereferenced and written into, 150 "R" if the argument is a pointer which is dereferenced and read from, 151 "i" for printf integer formats where the '0' flag is ignored with 152 precision, and "[" for the starting character of a scanf scanset. */ 153 const char *flags2; 154 /* If this format conversion character consumes more than one argument, 155 CHAIN points to information about the next argument. For later 156 arguments, only POINTER_COUNT, TYPES, and the "c", "R", and "W" flags 157 in FLAGS2 are used. */ 158 const struct format_char_info *chain; 159} format_char_info; 160 161 162/* Structure describing a flag accepted by some kind of format. */ 163typedef struct 164{ 165 /* The flag character in question (0 for end of array). */ 166 int flag_char; 167 /* Zero if this entry describes the flag character in general, or a 168 nonzero character that may be found in flags2 if it describes the 169 flag when used with certain formats only. If the latter, only 170 the first such entry found that applies to the current conversion 171 specifier is used; the values of 'name' and 'long_name' it supplies 172 will be used, if non-NULL and the standard version is higher than 173 the unpredicated one, for any pedantic warning. For example, 'o' 174 for strftime formats (meaning 'O' is an extension over C99). */ 175 int predicate; 176 /* Nonzero if the next character after this flag in the format should 177 be skipped ('=' in strfmon), zero otherwise. */ 178 int skip_next_char; 179 /* The name to use for this flag in diagnostic messages. For example, 180 N_("'0' flag"), N_("field width"). */ 181 const char *name; 182 /* Long name for this flag in diagnostic messages; currently only used for 183 "ISO C does not support ...". For example, N_("the 'I' printf flag"). */ 184 const char *long_name; 185 /* The standard version in which it appeared. */ 186 enum format_std_version std; 187} format_flag_spec; 188 189 190/* Structure describing a combination of flags that is bad for some kind 191 of format. */ 192typedef struct 193{ 194 /* The first flag character in question (0 for end of array). */ 195 int flag_char1; 196 /* The second flag character. */ 197 int flag_char2; 198 /* Nonzero if the message should say that the first flag is ignored with 199 the second, zero if the combination should simply be objected to. */ 200 int ignored; 201 /* Zero if this entry applies whenever this flag combination occurs, 202 a nonzero character from flags2 if it only applies in some 203 circumstances (e.g. 'i' for printf formats ignoring 0 with precision). */ 204 int predicate; 205} format_flag_pair; 206 207 208/* Structure describing a particular kind of format processed by GCC. */ 209typedef struct 210{ 211 /* The name of this kind of format, for use in diagnostics. Also 212 the name of the attribute (without preceding and following __). */ 213 const char *name; 214 /* Specifications of the length modifiers accepted; possibly NULL. */ 215 const format_length_info *length_char_specs; 216 /* Details of the conversion specification characters accepted. */ 217 const format_char_info *conversion_specs; 218 /* String listing the flag characters that are accepted. */ 219 const char *flag_chars; 220 /* String listing modifier characters (strftime) accepted. May be NULL. */ 221 const char *modifier_chars; 222 /* Details of the flag characters, including pseudo-flags. */ 223 const format_flag_spec *flag_specs; 224 /* Details of bad combinations of flags. */ 225 const format_flag_pair *bad_flag_pairs; 226 /* Flags applicable to this kind of format. */ 227 int flags; 228 /* Flag character to treat a width as, or 0 if width not used. */ 229 int width_char; 230 /* Flag character to treat a left precision (strfmon) as, 231 or 0 if left precision not used. */ 232 int left_precision_char; 233 /* Flag character to treat a precision (for strfmon, right precision) as, 234 or 0 if precision not used. */ 235 int precision_char; 236 /* If a flag character has the effect of suppressing the conversion of 237 an argument ('*' in scanf), that flag character, otherwise 0. */ 238 int suppression_char; 239 /* Flag character to treat a length modifier as (ignored if length 240 modifiers not used). Need not be placed in flag_chars for conversion 241 specifiers, but is used to check for bad combinations such as length 242 modifier with assignment suppression in scanf. */ 243 int length_code_char; 244 /* Assignment-allocation flag character ('m' in scanf), otherwise 0. */ 245 int alloc_char; 246 /* Pointer to type of argument expected if '*' is used for a width, 247 or NULL if '*' not used for widths. */ 248 tree *width_type; 249 /* Pointer to type of argument expected if '*' is used for a precision, 250 or NULL if '*' not used for precisions. */ 251 tree *precision_type; 252} format_kind_info; 253 254#define T_I &integer_type_node 255#define T89_I { STD_C89, NULL, T_I } 256#define T_L &long_integer_type_node 257#define T89_L { STD_C89, NULL, T_L } 258#define T_LL &long_long_integer_type_node 259#define T9L_LL { STD_C9L, NULL, T_LL } 260#define TEX_LL { STD_EXT, NULL, T_LL } 261#define T_S &short_integer_type_node 262#define T89_S { STD_C89, NULL, T_S } 263#define T_UI &unsigned_type_node 264#define T89_UI { STD_C89, NULL, T_UI } 265#define T_UL &long_unsigned_type_node 266#define T89_UL { STD_C89, NULL, T_UL } 267#define T_ULL &long_long_unsigned_type_node 268#define T9L_ULL { STD_C9L, NULL, T_ULL } 269#define TEX_ULL { STD_EXT, NULL, T_ULL } 270#define T_US &short_unsigned_type_node 271#define T89_US { STD_C89, NULL, T_US } 272#define T_F &float_type_node 273#define T89_F { STD_C89, NULL, T_F } 274#define T99_F { STD_C99, NULL, T_F } 275#define T_D &double_type_node 276#define T89_D { STD_C89, NULL, T_D } 277#define T99_D { STD_C99, NULL, T_D } 278#define T_LD &long_double_type_node 279#define T89_LD { STD_C89, NULL, T_LD } 280#define T99_LD { STD_C99, NULL, T_LD } 281#define T_C &char_type_node 282#define T89_C { STD_C89, NULL, T_C } 283#define T_SC &signed_char_type_node 284#define T99_SC { STD_C99, NULL, T_SC } 285#define T_UC &unsigned_char_type_node 286#define T99_UC { STD_C99, NULL, T_UC } 287#define T_V &void_type_node 288#define T89_V { STD_C89, NULL, T_V } 289#define T_W &wchar_type_node 290#define T94_W { STD_C94, "wchar_t", T_W } 291#define TEX_W { STD_EXT, "wchar_t", T_W } 292#define T_WI &wint_type_node 293#define T94_WI { STD_C94, "wint_t", T_WI } 294#define TEX_WI { STD_EXT, "wint_t", T_WI } 295#define T_ST &size_type_node 296#define T99_ST { STD_C99, "size_t", T_ST } 297#define T_SST &signed_size_type_node 298#define T99_SST { STD_C99, "signed size_t", T_SST } 299#define T_PD &ptrdiff_type_node 300#define T99_PD { STD_C99, "ptrdiff_t", T_PD } 301#define T_UPD &unsigned_ptrdiff_type_node 302#define T99_UPD { STD_C99, "unsigned ptrdiff_t", T_UPD } 303#define T_IM &intmax_type_node 304#define T99_IM { STD_C99, "intmax_t", T_IM } 305#define T_UIM &uintmax_type_node 306#define T99_UIM { STD_C99, "uintmax_t", T_UIM } 307#define T_D32 &dfloat32_type_node 308#define TEX_D32 { STD_EXT, "_Decimal32", T_D32 } 309#define T_D64 &dfloat64_type_node 310#define TEX_D64 { STD_EXT, "_Decimal64", T_D64 } 311#define T_D128 &dfloat128_type_node 312#define TEX_D128 { STD_EXT, "_Decimal128", T_D128 } 313 314/* Structure describing how format attributes such as "printf" are 315 interpreted as "gnu_printf" or "ms_printf" on a particular system. 316 TARGET_OVERRIDES_FORMAT_ATTRIBUTES is used to specify target-specific 317 defaults. */ 318typedef struct 319{ 320 /* The name of the to be copied format attribute. */ 321 const char *named_attr_src; 322 /* The name of the to be overridden format attribute. */ 323 const char *named_attr_dst; 324} target_ovr_attr; 325 326#endif /* GCC_C_FORMAT_H */ 327