Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 1 | //== PrintfFormatString.cpp - Analysis of printf format strings --*- C++ -*-==// |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
| 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
| 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
| 9 | // |
| 10 | // Handling of format string in printf and friends. The structure of format |
| 11 | // strings for fprintf() are described in C99 7.19.6.1. |
| 12 | // |
| 13 | //===----------------------------------------------------------------------===// |
| 14 | |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 15 | #include "clang/Analysis/Analyses/FormatString.h" |
| 16 | #include "FormatStringParsing.h" |
Chandler Carruth | 55fc873 | 2012-12-04 09:13:33 +0000 | [diff] [blame] | 17 | #include "clang/Basic/TargetInfo.h" |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 18 | |
Hans Wennborg | f3749f4 | 2012-08-07 08:11:26 +0000 | [diff] [blame] | 19 | using clang::analyze_format_string::ArgType; |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 20 | using clang::analyze_format_string::FormatStringHandler; |
| 21 | using clang::analyze_format_string::LengthModifier; |
| 22 | using clang::analyze_format_string::OptionalAmount; |
Ted Kremenek | 6ecb950 | 2010-07-20 20:04:27 +0000 | [diff] [blame] | 23 | using clang::analyze_format_string::ConversionSpecifier; |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 24 | using clang::analyze_printf::PrintfSpecifier; |
Ted Kremenek | efaff19 | 2010-02-27 01:41:03 +0000 | [diff] [blame] | 25 | |
Ted Kremenek | 808015a | 2010-01-29 03:16:21 +0000 | [diff] [blame] | 26 | using namespace clang; |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 27 | |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 28 | typedef clang::analyze_format_string::SpecifierResult<PrintfSpecifier> |
| 29 | PrintfSpecifierResult; |
Ted Kremenek | 4e4b30e | 2010-02-16 01:46:59 +0000 | [diff] [blame] | 30 | |
| 31 | //===----------------------------------------------------------------------===// |
| 32 | // Methods for parsing format strings. |
| 33 | //===----------------------------------------------------------------------===// |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 34 | |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 35 | using analyze_format_string::ParseNonPositionAmount; |
Ted Kremenek | 4e4b30e | 2010-02-16 01:46:59 +0000 | [diff] [blame] | 36 | |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 37 | static bool ParsePrecision(FormatStringHandler &H, PrintfSpecifier &FS, |
Ted Kremenek | efaff19 | 2010-02-27 01:41:03 +0000 | [diff] [blame] | 38 | const char *Start, const char *&Beg, const char *E, |
| 39 | unsigned *argIndex) { |
| 40 | if (argIndex) { |
| 41 | FS.setPrecision(ParseNonPositionAmount(Beg, E, *argIndex)); |
Chad Rosier | 3060178 | 2011-08-17 23:08:45 +0000 | [diff] [blame] | 42 | } else { |
Ted Kremenek | efaff19 | 2010-02-27 01:41:03 +0000 | [diff] [blame] | 43 | const OptionalAmount Amt = ParsePositionAmount(H, Start, Beg, E, |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 44 | analyze_format_string::PrecisionPos); |
Ted Kremenek | efaff19 | 2010-02-27 01:41:03 +0000 | [diff] [blame] | 45 | if (Amt.isInvalid()) |
| 46 | return true; |
| 47 | FS.setPrecision(Amt); |
| 48 | } |
| 49 | return false; |
| 50 | } |
| 51 | |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 52 | static PrintfSpecifierResult ParsePrintfSpecifier(FormatStringHandler &H, |
Ted Kremenek | 74d56a1 | 2010-02-04 20:46:58 +0000 | [diff] [blame] | 53 | const char *&Beg, |
Ted Kremenek | 7f70dc8 | 2010-02-26 19:18:41 +0000 | [diff] [blame] | 54 | const char *E, |
Hans Wennborg | d02deeb | 2011-12-15 10:25:47 +0000 | [diff] [blame] | 55 | unsigned &argIndex, |
Jordan Rose | 275b6f5 | 2012-09-13 02:11:03 +0000 | [diff] [blame] | 56 | const LangOptions &LO, |
| 57 | const TargetInfo &Target) { |
Ted Kremenek | 4e4b30e | 2010-02-16 01:46:59 +0000 | [diff] [blame] | 58 | |
Ted Kremenek | 6ecb950 | 2010-07-20 20:04:27 +0000 | [diff] [blame] | 59 | using namespace clang::analyze_format_string; |
Ted Kremenek | 4b220fa | 2010-01-29 02:13:53 +0000 | [diff] [blame] | 60 | using namespace clang::analyze_printf; |
Ted Kremenek | 4e4b30e | 2010-02-16 01:46:59 +0000 | [diff] [blame] | 61 | |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 62 | const char *I = Beg; |
Ted Kremenek | c7ae51a | 2010-01-28 00:02:05 +0000 | [diff] [blame] | 63 | const char *Start = 0; |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 64 | UpdateOnReturn <const char*> UpdateBeg(Beg, I); |
| 65 | |
| 66 | // Look for a '%' character that indicates the start of a format specifier. |
Ted Kremenek | e729acb | 2010-01-28 23:56:52 +0000 | [diff] [blame] | 67 | for ( ; I != E ; ++I) { |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 68 | char c = *I; |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 69 | if (c == '\0') { |
| 70 | // Detect spurious null characters, which are likely errors. |
| 71 | H.HandleNullChar(I); |
| 72 | return true; |
| 73 | } |
| 74 | if (c == '%') { |
Ted Kremenek | e729acb | 2010-01-28 23:56:52 +0000 | [diff] [blame] | 75 | Start = I++; // Record the start of the format specifier. |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 76 | break; |
| 77 | } |
| 78 | } |
Ted Kremenek | 4e4b30e | 2010-02-16 01:46:59 +0000 | [diff] [blame] | 79 | |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 80 | // No format specifier found? |
| 81 | if (!Start) |
| 82 | return false; |
Ted Kremenek | 4e4b30e | 2010-02-16 01:46:59 +0000 | [diff] [blame] | 83 | |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 84 | if (I == E) { |
| 85 | // No more characters left? |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 86 | H.HandleIncompleteSpecifier(Start, E - Start); |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 87 | return true; |
| 88 | } |
Ted Kremenek | 4e4b30e | 2010-02-16 01:46:59 +0000 | [diff] [blame] | 89 | |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 90 | PrintfSpecifier FS; |
Ted Kremenek | efaff19 | 2010-02-27 01:41:03 +0000 | [diff] [blame] | 91 | if (ParseArgPosition(H, FS, Start, I, E)) |
| 92 | return true; |
| 93 | |
| 94 | if (I == E) { |
| 95 | // No more characters left? |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 96 | H.HandleIncompleteSpecifier(Start, E - Start); |
Ted Kremenek | efaff19 | 2010-02-27 01:41:03 +0000 | [diff] [blame] | 97 | return true; |
| 98 | } |
Ted Kremenek | 4e4b30e | 2010-02-16 01:46:59 +0000 | [diff] [blame] | 99 | |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 100 | // Look for flags (if any). |
| 101 | bool hasMore = true; |
| 102 | for ( ; I != E; ++I) { |
| 103 | switch (*I) { |
| 104 | default: hasMore = false; break; |
NAKAMURA Takumi | dfbb02a | 2011-01-27 07:10:08 +0000 | [diff] [blame] | 105 | case '\'': |
Ted Kremenek | bd18d45 | 2011-01-08 05:28:38 +0000 | [diff] [blame] | 106 | // FIXME: POSIX specific. Always accept? |
| 107 | FS.setHasThousandsGrouping(I); |
| 108 | break; |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 109 | case '-': FS.setIsLeftJustified(I); break; |
| 110 | case '+': FS.setHasPlusPrefix(I); break; |
| 111 | case ' ': FS.setHasSpacePrefix(I); break; |
| 112 | case '#': FS.setHasAlternativeForm(I); break; |
| 113 | case '0': FS.setHasLeadingZeros(I); break; |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 114 | } |
| 115 | if (!hasMore) |
| 116 | break; |
Ted Kremenek | 4e4b30e | 2010-02-16 01:46:59 +0000 | [diff] [blame] | 117 | } |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 118 | |
| 119 | if (I == E) { |
| 120 | // No more characters left? |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 121 | H.HandleIncompleteSpecifier(Start, E - Start); |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 122 | return true; |
| 123 | } |
Ted Kremenek | 4e4b30e | 2010-02-16 01:46:59 +0000 | [diff] [blame] | 124 | |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 125 | // Look for the field width (if any). |
Ted Kremenek | efaff19 | 2010-02-27 01:41:03 +0000 | [diff] [blame] | 126 | if (ParseFieldWidth(H, FS, Start, I, E, |
| 127 | FS.usesPositionalArg() ? 0 : &argIndex)) |
| 128 | return true; |
Ted Kremenek | 4e4b30e | 2010-02-16 01:46:59 +0000 | [diff] [blame] | 129 | |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 130 | if (I == E) { |
| 131 | // No more characters left? |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 132 | H.HandleIncompleteSpecifier(Start, E - Start); |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 133 | return true; |
Ted Kremenek | 4e4b30e | 2010-02-16 01:46:59 +0000 | [diff] [blame] | 134 | } |
| 135 | |
| 136 | // Look for the precision (if any). |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 137 | if (*I == '.') { |
Ted Kremenek | 808015a | 2010-01-29 03:16:21 +0000 | [diff] [blame] | 138 | ++I; |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 139 | if (I == E) { |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 140 | H.HandleIncompleteSpecifier(Start, E - Start); |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 141 | return true; |
| 142 | } |
Ted Kremenek | 4e4b30e | 2010-02-16 01:46:59 +0000 | [diff] [blame] | 143 | |
Ted Kremenek | efaff19 | 2010-02-27 01:41:03 +0000 | [diff] [blame] | 144 | if (ParsePrecision(H, FS, Start, I, E, |
| 145 | FS.usesPositionalArg() ? 0 : &argIndex)) |
| 146 | return true; |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 147 | |
| 148 | if (I == E) { |
| 149 | // No more characters left? |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 150 | H.HandleIncompleteSpecifier(Start, E - Start); |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 151 | return true; |
| 152 | } |
| 153 | } |
| 154 | |
| 155 | // Look for the length modifier. |
Hans Wennborg | d02deeb | 2011-12-15 10:25:47 +0000 | [diff] [blame] | 156 | if (ParseLengthModifier(FS, I, E, LO) && I == E) { |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 157 | // No more characters left? |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 158 | H.HandleIncompleteSpecifier(Start, E - Start); |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 159 | return true; |
| 160 | } |
Ted Kremenek | df17f9d | 2010-02-09 00:04:09 +0000 | [diff] [blame] | 161 | |
Ted Kremenek | 4dcb18f | 2010-01-29 20:29:53 +0000 | [diff] [blame] | 162 | if (*I == '\0') { |
Ted Kremenek | df17f9d | 2010-02-09 00:04:09 +0000 | [diff] [blame] | 163 | // Detect spurious null characters, which are likely errors. |
| 164 | H.HandleNullChar(I); |
| 165 | return true; |
Ted Kremenek | 4dcb18f | 2010-01-29 20:29:53 +0000 | [diff] [blame] | 166 | } |
Ted Kremenek | 4e4b30e | 2010-02-16 01:46:59 +0000 | [diff] [blame] | 167 | |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 168 | // Finally, look for the conversion specifier. |
Ted Kremenek | a8d8fec | 2010-01-28 02:46:17 +0000 | [diff] [blame] | 169 | const char *conversionPosition = I++; |
Ted Kremenek | 26ac2e0 | 2010-01-29 02:40:24 +0000 | [diff] [blame] | 170 | ConversionSpecifier::Kind k = ConversionSpecifier::InvalidSpecifier; |
Ted Kremenek | a8d8fec | 2010-01-28 02:46:17 +0000 | [diff] [blame] | 171 | switch (*conversionPosition) { |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 172 | default: |
Ted Kremenek | 26ac2e0 | 2010-01-29 02:40:24 +0000 | [diff] [blame] | 173 | break; |
Ted Kremenek | c7cbb9b | 2010-01-28 00:55:28 +0000 | [diff] [blame] | 174 | // C99: 7.19.6.1 (section 8). |
Ted Kremenek | 87260c7 | 2010-02-24 00:05:54 +0000 | [diff] [blame] | 175 | case '%': k = ConversionSpecifier::PercentArg; break; |
| 176 | case 'A': k = ConversionSpecifier::AArg; break; |
| 177 | case 'E': k = ConversionSpecifier::EArg; break; |
| 178 | case 'F': k = ConversionSpecifier::FArg; break; |
| 179 | case 'G': k = ConversionSpecifier::GArg; break; |
| 180 | case 'X': k = ConversionSpecifier::XArg; break; |
| 181 | case 'a': k = ConversionSpecifier::aArg; break; |
Ted Kremenek | 92a6feb | 2010-07-20 20:03:49 +0000 | [diff] [blame] | 182 | case 'c': k = ConversionSpecifier::cArg; break; |
Ted Kremenek | a8d8fec | 2010-01-28 02:46:17 +0000 | [diff] [blame] | 183 | case 'd': k = ConversionSpecifier::dArg; break; |
Ted Kremenek | 87260c7 | 2010-02-24 00:05:54 +0000 | [diff] [blame] | 184 | case 'e': k = ConversionSpecifier::eArg; break; |
| 185 | case 'f': k = ConversionSpecifier::fArg; break; |
| 186 | case 'g': k = ConversionSpecifier::gArg; break; |
Ted Kremenek | a8d8fec | 2010-01-28 02:46:17 +0000 | [diff] [blame] | 187 | case 'i': k = ConversionSpecifier::iArg; break; |
Ted Kremenek | 35d353b | 2010-07-20 20:04:10 +0000 | [diff] [blame] | 188 | case 'n': k = ConversionSpecifier::nArg; break; |
Ted Kremenek | a8d8fec | 2010-01-28 02:46:17 +0000 | [diff] [blame] | 189 | case 'o': k = ConversionSpecifier::oArg; break; |
David Majnemer | 47ad6ce | 2013-08-21 21:54:46 +0000 | [diff] [blame] | 190 | case 'p': k = ConversionSpecifier::pArg; break; |
| 191 | case 's': k = ConversionSpecifier::sArg; break; |
Ted Kremenek | a8d8fec | 2010-01-28 02:46:17 +0000 | [diff] [blame] | 192 | case 'u': k = ConversionSpecifier::uArg; break; |
| 193 | case 'x': k = ConversionSpecifier::xArg; break; |
Ted Kremenek | bd18d45 | 2011-01-08 05:28:38 +0000 | [diff] [blame] | 194 | // POSIX specific. |
Ted Kremenek | 87260c7 | 2010-02-24 00:05:54 +0000 | [diff] [blame] | 195 | case 'C': k = ConversionSpecifier::CArg; break; |
Ted Kremenek | de183a4 | 2010-07-20 20:04:15 +0000 | [diff] [blame] | 196 | case 'S': k = ConversionSpecifier::SArg; break; |
Ted Kremenek | c7cbb9b | 2010-01-28 00:55:28 +0000 | [diff] [blame] | 197 | // Objective-C. |
Ted Kremenek | 4dcb18f | 2010-01-29 20:29:53 +0000 | [diff] [blame] | 198 | case '@': k = ConversionSpecifier::ObjCObjArg; break; |
Ted Kremenek | df17f9d | 2010-02-09 00:04:09 +0000 | [diff] [blame] | 199 | // Glibc specific. |
Ted Kremenek | 4dcb18f | 2010-01-29 20:29:53 +0000 | [diff] [blame] | 200 | case 'm': k = ConversionSpecifier::PrintErrno; break; |
Jordan Rose | 275b6f5 | 2012-09-13 02:11:03 +0000 | [diff] [blame] | 201 | // Apple-specific |
| 202 | case 'D': |
| 203 | if (Target.getTriple().isOSDarwin()) |
| 204 | k = ConversionSpecifier::DArg; |
| 205 | break; |
| 206 | case 'O': |
| 207 | if (Target.getTriple().isOSDarwin()) |
| 208 | k = ConversionSpecifier::OArg; |
| 209 | break; |
| 210 | case 'U': |
| 211 | if (Target.getTriple().isOSDarwin()) |
| 212 | k = ConversionSpecifier::UArg; |
| 213 | break; |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 214 | } |
Ted Kremenek | 6ecb950 | 2010-07-20 20:04:27 +0000 | [diff] [blame] | 215 | PrintfConversionSpecifier CS(conversionPosition, k); |
Ted Kremenek | 7f70dc8 | 2010-02-26 19:18:41 +0000 | [diff] [blame] | 216 | FS.setConversionSpecifier(CS); |
Ted Kremenek | efaff19 | 2010-02-27 01:41:03 +0000 | [diff] [blame] | 217 | if (CS.consumesDataArgument() && !FS.usesPositionalArg()) |
Ted Kremenek | 7f70dc8 | 2010-02-26 19:18:41 +0000 | [diff] [blame] | 218 | FS.setArgIndex(argIndex++); |
Ted Kremenek | 26ac2e0 | 2010-01-29 02:40:24 +0000 | [diff] [blame] | 219 | |
| 220 | if (k == ConversionSpecifier::InvalidSpecifier) { |
Ted Kremenek | 7f70dc8 | 2010-02-26 19:18:41 +0000 | [diff] [blame] | 221 | // Assume the conversion takes one argument. |
Ted Kremenek | 7966297 | 2010-12-02 20:57:51 +0000 | [diff] [blame] | 222 | return !H.HandleInvalidPrintfConversionSpecifier(FS, Start, I - Start); |
Ted Kremenek | 26ac2e0 | 2010-01-29 02:40:24 +0000 | [diff] [blame] | 223 | } |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 224 | return PrintfSpecifierResult(Start, FS); |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 225 | } |
| 226 | |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 227 | bool clang::analyze_format_string::ParsePrintfString(FormatStringHandler &H, |
| 228 | const char *I, |
Hans Wennborg | d02deeb | 2011-12-15 10:25:47 +0000 | [diff] [blame] | 229 | const char *E, |
Jordan Rose | 275b6f5 | 2012-09-13 02:11:03 +0000 | [diff] [blame] | 230 | const LangOptions &LO, |
| 231 | const TargetInfo &Target) { |
Ted Kremenek | 7f70dc8 | 2010-02-26 19:18:41 +0000 | [diff] [blame] | 232 | |
| 233 | unsigned argIndex = 0; |
| 234 | |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 235 | // Keep looking for a format specifier until we have exhausted the string. |
| 236 | while (I != E) { |
Hans Wennborg | d02deeb | 2011-12-15 10:25:47 +0000 | [diff] [blame] | 237 | const PrintfSpecifierResult &FSR = ParsePrintfSpecifier(H, I, E, argIndex, |
Jordan Rose | 275b6f5 | 2012-09-13 02:11:03 +0000 | [diff] [blame] | 238 | LO, Target); |
Ted Kremenek | 26ac2e0 | 2010-01-29 02:40:24 +0000 | [diff] [blame] | 239 | // Did a fail-stop error of any kind occur when parsing the specifier? |
| 240 | // If so, don't do any more processing. |
| 241 | if (FSR.shouldStop()) |
Dmitri Gribenko | 1ad23d6 | 2012-09-10 21:20:09 +0000 | [diff] [blame] | 242 | return true; |
Ted Kremenek | 26ac2e0 | 2010-01-29 02:40:24 +0000 | [diff] [blame] | 243 | // Did we exhaust the string or encounter an error that |
| 244 | // we can recover from? |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 245 | if (!FSR.hasValue()) |
Ted Kremenek | 26ac2e0 | 2010-01-29 02:40:24 +0000 | [diff] [blame] | 246 | continue; |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 247 | // We have a format specifier. Pass it to the callback. |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 248 | if (!H.HandlePrintfSpecifier(FSR.getValue(), FSR.getStart(), |
Ted Kremenek | a8d8fec | 2010-01-28 02:46:17 +0000 | [diff] [blame] | 249 | I - FSR.getStart())) |
Ted Kremenek | 4dcb18f | 2010-01-29 20:29:53 +0000 | [diff] [blame] | 250 | return true; |
Ted Kremenek | 4e4b30e | 2010-02-16 01:46:59 +0000 | [diff] [blame] | 251 | } |
| 252 | assert(I == E && "Format string not exhausted"); |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 253 | return false; |
| 254 | } |
Ted Kremenek | 8f0a1c7 | 2010-01-27 23:43:25 +0000 | [diff] [blame] | 255 | |
Ted Kremenek | 4e4b30e | 2010-02-16 01:46:59 +0000 | [diff] [blame] | 256 | //===----------------------------------------------------------------------===// |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 257 | // Methods on PrintfSpecifier. |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 258 | //===----------------------------------------------------------------------===// |
| 259 | |
Hans Wennborg | f3749f4 | 2012-08-07 08:11:26 +0000 | [diff] [blame] | 260 | ArgType PrintfSpecifier::getArgType(ASTContext &Ctx, |
| 261 | bool IsObjCLiteral) const { |
Ted Kremenek | 6ecb950 | 2010-07-20 20:04:27 +0000 | [diff] [blame] | 262 | const PrintfConversionSpecifier &CS = getConversionSpecifier(); |
NAKAMURA Takumi | dfbb02a | 2011-01-27 07:10:08 +0000 | [diff] [blame] | 263 | |
Ted Kremenek | 33567d2 | 2010-01-29 22:59:32 +0000 | [diff] [blame] | 264 | if (!CS.consumesDataArgument()) |
Hans Wennborg | f3749f4 | 2012-08-07 08:11:26 +0000 | [diff] [blame] | 265 | return ArgType::Invalid(); |
Ted Kremenek | 4e4b30e | 2010-02-16 01:46:59 +0000 | [diff] [blame] | 266 | |
Ted Kremenek | 9325eaf | 2010-08-24 22:24:51 +0000 | [diff] [blame] | 267 | if (CS.getKind() == ConversionSpecifier::cArg) |
| 268 | switch (LM.getKind()) { |
| 269 | case LengthModifier::None: return Ctx.IntTy; |
Hans Wennborg | f4f0c60 | 2011-12-09 12:22:12 +0000 | [diff] [blame] | 270 | case LengthModifier::AsLong: |
Hans Wennborg | f3749f4 | 2012-08-07 08:11:26 +0000 | [diff] [blame] | 271 | return ArgType(ArgType::WIntTy, "wint_t"); |
Ted Kremenek | 9325eaf | 2010-08-24 22:24:51 +0000 | [diff] [blame] | 272 | default: |
Hans Wennborg | f3749f4 | 2012-08-07 08:11:26 +0000 | [diff] [blame] | 273 | return ArgType::Invalid(); |
Ted Kremenek | 9325eaf | 2010-08-24 22:24:51 +0000 | [diff] [blame] | 274 | } |
NAKAMURA Takumi | dfbb02a | 2011-01-27 07:10:08 +0000 | [diff] [blame] | 275 | |
Ted Kremenek | 33567d2 | 2010-01-29 22:59:32 +0000 | [diff] [blame] | 276 | if (CS.isIntArg()) |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 277 | switch (LM.getKind()) { |
| 278 | case LengthModifier::AsLongDouble: |
Ted Kremenek | 9d24c2c | 2012-01-24 21:29:54 +0000 | [diff] [blame] | 279 | // GNU extension. |
| 280 | return Ctx.LongLongTy; |
David Majnemer | 47ad6ce | 2013-08-21 21:54:46 +0000 | [diff] [blame] | 281 | case LengthModifier::None: |
| 282 | return Ctx.IntTy; |
| 283 | case LengthModifier::AsInt32: |
| 284 | return ArgType(Ctx.IntTy, "__int32"); |
Hans Wennborg | f3749f4 | 2012-08-07 08:11:26 +0000 | [diff] [blame] | 285 | case LengthModifier::AsChar: return ArgType::AnyCharTy; |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 286 | case LengthModifier::AsShort: return Ctx.ShortTy; |
| 287 | case LengthModifier::AsLong: return Ctx.LongTy; |
Hans Wennborg | 32addd5 | 2012-02-16 16:34:54 +0000 | [diff] [blame] | 288 | case LengthModifier::AsLongLong: |
| 289 | case LengthModifier::AsQuad: |
| 290 | return Ctx.LongLongTy; |
David Majnemer | 47ad6ce | 2013-08-21 21:54:46 +0000 | [diff] [blame] | 291 | case LengthModifier::AsInt64: |
| 292 | return ArgType(Ctx.LongLongTy, "__int64"); |
Hans Wennborg | a792aff | 2011-12-07 10:33:11 +0000 | [diff] [blame] | 293 | case LengthModifier::AsIntMax: |
Hans Wennborg | f3749f4 | 2012-08-07 08:11:26 +0000 | [diff] [blame] | 294 | return ArgType(Ctx.getIntMaxType(), "intmax_t"); |
Hans Wennborg | 29e97cb | 2011-10-27 08:29:09 +0000 | [diff] [blame] | 295 | case LengthModifier::AsSizeT: |
| 296 | // FIXME: How to get the corresponding signed version of size_t? |
Hans Wennborg | f3749f4 | 2012-08-07 08:11:26 +0000 | [diff] [blame] | 297 | return ArgType(); |
David Majnemer | 47ad6ce | 2013-08-21 21:54:46 +0000 | [diff] [blame] | 298 | case LengthModifier::AsInt3264: |
David Majnemer | df72071 | 2013-08-22 07:53:21 +0000 | [diff] [blame] | 299 | return Ctx.getTargetInfo().getTriple().isArch64Bit() |
| 300 | ? ArgType(Ctx.LongLongTy, "__int64") |
| 301 | : ArgType(Ctx.IntTy, "__int32"); |
Hans Wennborg | a792aff | 2011-12-07 10:33:11 +0000 | [diff] [blame] | 302 | case LengthModifier::AsPtrDiff: |
Hans Wennborg | f3749f4 | 2012-08-07 08:11:26 +0000 | [diff] [blame] | 303 | return ArgType(Ctx.getPointerDiffType(), "ptrdiff_t"); |
Hans Wennborg | d02deeb | 2011-12-15 10:25:47 +0000 | [diff] [blame] | 304 | case LengthModifier::AsAllocate: |
Hans Wennborg | 37969b7 | 2012-01-12 17:11:12 +0000 | [diff] [blame] | 305 | case LengthModifier::AsMAllocate: |
Hans Wennborg | f3749f4 | 2012-08-07 08:11:26 +0000 | [diff] [blame] | 306 | return ArgType::Invalid(); |
Ted Kremenek | 33567d2 | 2010-01-29 22:59:32 +0000 | [diff] [blame] | 307 | } |
| 308 | |
| 309 | if (CS.isUIntArg()) |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 310 | switch (LM.getKind()) { |
| 311 | case LengthModifier::AsLongDouble: |
Ted Kremenek | 9d24c2c | 2012-01-24 21:29:54 +0000 | [diff] [blame] | 312 | // GNU extension. |
| 313 | return Ctx.UnsignedLongLongTy; |
David Majnemer | 47ad6ce | 2013-08-21 21:54:46 +0000 | [diff] [blame] | 314 | case LengthModifier::None: |
| 315 | return Ctx.UnsignedIntTy; |
| 316 | case LengthModifier::AsInt32: |
| 317 | return ArgType(Ctx.UnsignedIntTy, "unsigned __int32"); |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 318 | case LengthModifier::AsChar: return Ctx.UnsignedCharTy; |
| 319 | case LengthModifier::AsShort: return Ctx.UnsignedShortTy; |
| 320 | case LengthModifier::AsLong: return Ctx.UnsignedLongTy; |
Hans Wennborg | 32addd5 | 2012-02-16 16:34:54 +0000 | [diff] [blame] | 321 | case LengthModifier::AsLongLong: |
| 322 | case LengthModifier::AsQuad: |
| 323 | return Ctx.UnsignedLongLongTy; |
David Majnemer | 47ad6ce | 2013-08-21 21:54:46 +0000 | [diff] [blame] | 324 | case LengthModifier::AsInt64: |
| 325 | return ArgType(Ctx.UnsignedLongLongTy, "unsigned __int64"); |
Hans Wennborg | a792aff | 2011-12-07 10:33:11 +0000 | [diff] [blame] | 326 | case LengthModifier::AsIntMax: |
Hans Wennborg | f3749f4 | 2012-08-07 08:11:26 +0000 | [diff] [blame] | 327 | return ArgType(Ctx.getUIntMaxType(), "uintmax_t"); |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 328 | case LengthModifier::AsSizeT: |
Hans Wennborg | f3749f4 | 2012-08-07 08:11:26 +0000 | [diff] [blame] | 329 | return ArgType(Ctx.getSizeType(), "size_t"); |
David Majnemer | 47ad6ce | 2013-08-21 21:54:46 +0000 | [diff] [blame] | 330 | case LengthModifier::AsInt3264: |
| 331 | return Ctx.getTargetInfo().getTriple().isArch64Bit() |
David Majnemer | df72071 | 2013-08-22 07:53:21 +0000 | [diff] [blame] | 332 | ? ArgType(Ctx.UnsignedLongLongTy, "unsigned __int64") |
| 333 | : ArgType(Ctx.UnsignedIntTy, "unsigned __int32"); |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 334 | case LengthModifier::AsPtrDiff: |
Ted Kremenek | 33567d2 | 2010-01-29 22:59:32 +0000 | [diff] [blame] | 335 | // FIXME: How to get the corresponding unsigned |
| 336 | // version of ptrdiff_t? |
Hans Wennborg | f3749f4 | 2012-08-07 08:11:26 +0000 | [diff] [blame] | 337 | return ArgType(); |
Hans Wennborg | d02deeb | 2011-12-15 10:25:47 +0000 | [diff] [blame] | 338 | case LengthModifier::AsAllocate: |
Hans Wennborg | 37969b7 | 2012-01-12 17:11:12 +0000 | [diff] [blame] | 339 | case LengthModifier::AsMAllocate: |
Hans Wennborg | f3749f4 | 2012-08-07 08:11:26 +0000 | [diff] [blame] | 340 | return ArgType::Invalid(); |
Ted Kremenek | 33567d2 | 2010-01-29 22:59:32 +0000 | [diff] [blame] | 341 | } |
Ted Kremenek | 4e4b30e | 2010-02-16 01:46:59 +0000 | [diff] [blame] | 342 | |
Ted Kremenek | f911eba | 2010-02-01 23:23:50 +0000 | [diff] [blame] | 343 | if (CS.isDoubleArg()) { |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 344 | if (LM.getKind() == LengthModifier::AsLongDouble) |
Ted Kremenek | f911eba | 2010-02-01 23:23:50 +0000 | [diff] [blame] | 345 | return Ctx.LongDoubleTy; |
Ted Kremenek | c9a89fe | 2010-01-30 01:02:18 +0000 | [diff] [blame] | 346 | return Ctx.DoubleTy; |
Ted Kremenek | f911eba | 2010-02-01 23:23:50 +0000 | [diff] [blame] | 347 | } |
Ted Kremenek | 7f70dc8 | 2010-02-26 19:18:41 +0000 | [diff] [blame] | 348 | |
Hans Wennborg | f7158fa | 2012-08-07 09:13:19 +0000 | [diff] [blame] | 349 | if (CS.getKind() == ConversionSpecifier::nArg) { |
| 350 | switch (LM.getKind()) { |
| 351 | case LengthModifier::None: |
| 352 | return ArgType::PtrTo(Ctx.IntTy); |
| 353 | case LengthModifier::AsChar: |
| 354 | return ArgType::PtrTo(Ctx.SignedCharTy); |
| 355 | case LengthModifier::AsShort: |
| 356 | return ArgType::PtrTo(Ctx.ShortTy); |
| 357 | case LengthModifier::AsLong: |
| 358 | return ArgType::PtrTo(Ctx.LongTy); |
| 359 | case LengthModifier::AsLongLong: |
| 360 | case LengthModifier::AsQuad: |
| 361 | return ArgType::PtrTo(Ctx.LongLongTy); |
| 362 | case LengthModifier::AsIntMax: |
| 363 | return ArgType::PtrTo(ArgType(Ctx.getIntMaxType(), "intmax_t")); |
| 364 | case LengthModifier::AsSizeT: |
| 365 | return ArgType(); // FIXME: ssize_t |
| 366 | case LengthModifier::AsPtrDiff: |
| 367 | return ArgType::PtrTo(ArgType(Ctx.getPointerDiffType(), "ptrdiff_t")); |
| 368 | case LengthModifier::AsLongDouble: |
| 369 | return ArgType(); // FIXME: Is this a known extension? |
| 370 | case LengthModifier::AsAllocate: |
| 371 | case LengthModifier::AsMAllocate: |
David Majnemer | 47ad6ce | 2013-08-21 21:54:46 +0000 | [diff] [blame] | 372 | case LengthModifier::AsInt32: |
| 373 | case LengthModifier::AsInt3264: |
| 374 | case LengthModifier::AsInt64: |
Hans Wennborg | f7158fa | 2012-08-07 09:13:19 +0000 | [diff] [blame] | 375 | return ArgType::Invalid(); |
| 376 | } |
| 377 | } |
| 378 | |
Ted Kremenek | 87260c7 | 2010-02-24 00:05:54 +0000 | [diff] [blame] | 379 | switch (CS.getKind()) { |
Hans Wennborg | 6308218 | 2011-12-09 15:57:33 +0000 | [diff] [blame] | 380 | case ConversionSpecifier::sArg: |
Nico Weber | 339b907 | 2012-01-31 01:43:25 +0000 | [diff] [blame] | 381 | if (LM.getKind() == LengthModifier::AsWideChar) { |
| 382 | if (IsObjCLiteral) |
Jordan Rose | 2cd3440 | 2012-12-05 18:44:49 +0000 | [diff] [blame] | 383 | return ArgType(Ctx.getPointerType(Ctx.UnsignedShortTy.withConst()), |
| 384 | "const unichar *"); |
Hans Wennborg | f3749f4 | 2012-08-07 08:11:26 +0000 | [diff] [blame] | 385 | return ArgType(ArgType::WCStrTy, "wchar_t *"); |
Nico Weber | 339b907 | 2012-01-31 01:43:25 +0000 | [diff] [blame] | 386 | } |
Hans Wennborg | f3749f4 | 2012-08-07 08:11:26 +0000 | [diff] [blame] | 387 | return ArgType::CStrTy; |
Ted Kremenek | de183a4 | 2010-07-20 20:04:15 +0000 | [diff] [blame] | 388 | case ConversionSpecifier::SArg: |
Nico Weber | 339b907 | 2012-01-31 01:43:25 +0000 | [diff] [blame] | 389 | if (IsObjCLiteral) |
Jordan Rose | 2cd3440 | 2012-12-05 18:44:49 +0000 | [diff] [blame] | 390 | return ArgType(Ctx.getPointerType(Ctx.UnsignedShortTy.withConst()), |
| 391 | "const unichar *"); |
Hans Wennborg | f3749f4 | 2012-08-07 08:11:26 +0000 | [diff] [blame] | 392 | return ArgType(ArgType::WCStrTy, "wchar_t *"); |
Ted Kremenek | 87260c7 | 2010-02-24 00:05:54 +0000 | [diff] [blame] | 393 | case ConversionSpecifier::CArg: |
Nico Weber | 339b907 | 2012-01-31 01:43:25 +0000 | [diff] [blame] | 394 | if (IsObjCLiteral) |
Jordan Rose | 2cd3440 | 2012-12-05 18:44:49 +0000 | [diff] [blame] | 395 | return ArgType(Ctx.UnsignedShortTy, "unichar"); |
Hans Wennborg | 15f92ba | 2013-05-10 10:08:40 +0000 | [diff] [blame] | 396 | return ArgType(Ctx.WideCharTy, "wchar_t"); |
Ted Kremenek | 6693205 | 2010-07-20 20:04:04 +0000 | [diff] [blame] | 397 | case ConversionSpecifier::pArg: |
Hans Wennborg | f3749f4 | 2012-08-07 08:11:26 +0000 | [diff] [blame] | 398 | return ArgType::CPointerTy; |
Ted Kremenek | e6ca97f | 2012-01-25 00:04:09 +0000 | [diff] [blame] | 399 | case ConversionSpecifier::ObjCObjArg: |
Hans Wennborg | f3749f4 | 2012-08-07 08:11:26 +0000 | [diff] [blame] | 400 | return ArgType::ObjCPointerTy; |
Ted Kremenek | 87260c7 | 2010-02-24 00:05:54 +0000 | [diff] [blame] | 401 | default: |
| 402 | break; |
| 403 | } |
Ted Kremenek | 7f70dc8 | 2010-02-26 19:18:41 +0000 | [diff] [blame] | 404 | |
Ted Kremenek | 33567d2 | 2010-01-29 22:59:32 +0000 | [diff] [blame] | 405 | // FIXME: Handle other cases. |
Hans Wennborg | f3749f4 | 2012-08-07 08:11:26 +0000 | [diff] [blame] | 406 | return ArgType(); |
Ted Kremenek | 33567d2 | 2010-01-29 22:59:32 +0000 | [diff] [blame] | 407 | } |
| 408 | |
Hans Wennborg | be6126a | 2012-02-15 09:59:46 +0000 | [diff] [blame] | 409 | bool PrintfSpecifier::fixType(QualType QT, const LangOptions &LangOpt, |
| 410 | ASTContext &Ctx, bool IsObjCLiteral) { |
Hans Wennborg | cec9ce4 | 2012-07-30 17:11:32 +0000 | [diff] [blame] | 411 | // %n is different from other conversion specifiers; don't try to fix it. |
| 412 | if (CS.getKind() == ConversionSpecifier::nArg) |
| 413 | return false; |
| 414 | |
Jordan Rose | 153acdb | 2012-05-30 21:53:13 +0000 | [diff] [blame] | 415 | // Handle Objective-C objects first. Note that while the '%@' specifier will |
| 416 | // not warn for structure pointer or void pointer arguments (because that's |
| 417 | // how CoreFoundation objects are implemented), we only show a fixit for '%@' |
| 418 | // if we know it's an object (block, id, class, or __attribute__((NSObject))). |
| 419 | if (QT->isObjCRetainableType()) { |
| 420 | if (!IsObjCLiteral) |
| 421 | return false; |
| 422 | |
| 423 | CS.setKind(ConversionSpecifier::ObjCObjArg); |
| 424 | |
| 425 | // Disable irrelevant flags |
| 426 | HasThousandsGrouping = false; |
| 427 | HasPlusPrefix = false; |
| 428 | HasSpacePrefix = false; |
| 429 | HasAlternativeForm = false; |
| 430 | HasLeadingZeroes = false; |
| 431 | Precision.setHowSpecified(OptionalAmount::NotSpecified); |
| 432 | LM.setKind(LengthModifier::None); |
| 433 | |
| 434 | return true; |
| 435 | } |
| 436 | |
| 437 | // Handle strings next (char *, wchar_t *) |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 438 | if (QT->isPointerType() && (QT->getPointeeType()->isAnyCharacterType())) { |
Ted Kremenek | 99196b1 | 2010-07-20 20:03:58 +0000 | [diff] [blame] | 439 | CS.setKind(ConversionSpecifier::sArg); |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 440 | |
Tom Care | 876e994 | 2010-06-11 04:22:02 +0000 | [diff] [blame] | 441 | // Disable irrelevant flags |
| 442 | HasAlternativeForm = 0; |
| 443 | HasLeadingZeroes = 0; |
| 444 | |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 445 | // Set the long length modifier for wide characters |
| 446 | if (QT->getPointeeType()->isWideCharType()) |
| 447 | LM.setKind(LengthModifier::AsWideChar); |
Hans Wennborg | 117348c | 2011-12-09 10:51:29 +0000 | [diff] [blame] | 448 | else |
| 449 | LM.setKind(LengthModifier::None); |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 450 | |
| 451 | return true; |
| 452 | } |
| 453 | |
Jordan Rose | 033a9c0 | 2012-06-04 22:49:02 +0000 | [diff] [blame] | 454 | // If it's an enum, get its underlying type. |
| 455 | if (const EnumType *ETy = QT->getAs<EnumType>()) |
| 456 | QT = ETy->getDecl()->getIntegerType(); |
| 457 | |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 458 | // We can only work with builtin types. |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 459 | const BuiltinType *BT = QT->getAs<BuiltinType>(); |
John McCall | 2dde35b | 2011-10-18 22:28:37 +0000 | [diff] [blame] | 460 | if (!BT) |
| 461 | return false; |
Tom Care | 876e994 | 2010-06-11 04:22:02 +0000 | [diff] [blame] | 462 | |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 463 | // Set length modifier |
| 464 | switch (BT->getKind()) { |
Eli Friedman | 06d88ec | 2011-04-27 22:06:20 +0000 | [diff] [blame] | 465 | case BuiltinType::Bool: |
| 466 | case BuiltinType::WChar_U: |
| 467 | case BuiltinType::WChar_S: |
| 468 | case BuiltinType::Char16: |
| 469 | case BuiltinType::Char32: |
| 470 | case BuiltinType::UInt128: |
| 471 | case BuiltinType::Int128: |
Anton Korobeynikov | aa4a99b | 2011-10-14 23:23:15 +0000 | [diff] [blame] | 472 | case BuiltinType::Half: |
John McCall | 2dde35b | 2011-10-18 22:28:37 +0000 | [diff] [blame] | 473 | // Various types which are non-trivial to correct. |
Eli Friedman | 06d88ec | 2011-04-27 22:06:20 +0000 | [diff] [blame] | 474 | return false; |
| 475 | |
John McCall | 2dde35b | 2011-10-18 22:28:37 +0000 | [diff] [blame] | 476 | #define SIGNED_TYPE(Id, SingletonId) |
| 477 | #define UNSIGNED_TYPE(Id, SingletonId) |
| 478 | #define FLOATING_TYPE(Id, SingletonId) |
| 479 | #define BUILTIN_TYPE(Id, SingletonId) \ |
| 480 | case BuiltinType::Id: |
| 481 | #include "clang/AST/BuiltinTypes.def" |
Eli Friedman | 06d88ec | 2011-04-27 22:06:20 +0000 | [diff] [blame] | 482 | // Misc other stuff which doesn't make sense here. |
| 483 | return false; |
| 484 | |
| 485 | case BuiltinType::UInt: |
| 486 | case BuiltinType::Int: |
| 487 | case BuiltinType::Float: |
| 488 | case BuiltinType::Double: |
Tom Care | 876e994 | 2010-06-11 04:22:02 +0000 | [diff] [blame] | 489 | LM.setKind(LengthModifier::None); |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 490 | break; |
Tom Care | 876e994 | 2010-06-11 04:22:02 +0000 | [diff] [blame] | 491 | |
Ted Kremenek | 4d8ae4d | 2010-10-21 04:00:58 +0000 | [diff] [blame] | 492 | case BuiltinType::Char_U: |
| 493 | case BuiltinType::UChar: |
| 494 | case BuiltinType::Char_S: |
| 495 | case BuiltinType::SChar: |
| 496 | LM.setKind(LengthModifier::AsChar); |
| 497 | break; |
| 498 | |
| 499 | case BuiltinType::Short: |
| 500 | case BuiltinType::UShort: |
| 501 | LM.setKind(LengthModifier::AsShort); |
| 502 | break; |
| 503 | |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 504 | case BuiltinType::Long: |
| 505 | case BuiltinType::ULong: |
| 506 | LM.setKind(LengthModifier::AsLong); |
| 507 | break; |
| 508 | |
| 509 | case BuiltinType::LongLong: |
| 510 | case BuiltinType::ULongLong: |
| 511 | LM.setKind(LengthModifier::AsLongLong); |
| 512 | break; |
| 513 | |
| 514 | case BuiltinType::LongDouble: |
| 515 | LM.setKind(LengthModifier::AsLongDouble); |
| 516 | break; |
| 517 | } |
| 518 | |
Hans Wennborg | a7da215 | 2011-10-18 08:10:06 +0000 | [diff] [blame] | 519 | // Handle size_t, ptrdiff_t, etc. that have dedicated length modifiers in C99. |
Richard Smith | 80ad52f | 2013-01-02 11:42:31 +0000 | [diff] [blame] | 520 | if (isa<TypedefType>(QT) && (LangOpt.C99 || LangOpt.CPlusPlus11)) |
Hans Wennborg | 4684778 | 2012-07-27 19:17:46 +0000 | [diff] [blame] | 521 | namedTypeToLengthModifier(QT, LM); |
Hans Wennborg | a7da215 | 2011-10-18 08:10:06 +0000 | [diff] [blame] | 522 | |
Jordan Rose | 242ae3d | 2013-01-17 18:47:16 +0000 | [diff] [blame] | 523 | // If fixing the length modifier was enough, we might be done. |
Jordan Rose | bbb6bb4 | 2012-09-08 04:00:03 +0000 | [diff] [blame] | 524 | if (hasValidLengthModifier(Ctx.getTargetInfo())) { |
Jordan Rose | 242ae3d | 2013-01-17 18:47:16 +0000 | [diff] [blame] | 525 | // If we're going to offer a fix anyway, make sure the sign matches. |
| 526 | switch (CS.getKind()) { |
| 527 | case ConversionSpecifier::uArg: |
| 528 | case ConversionSpecifier::UArg: |
| 529 | if (QT->isSignedIntegerType()) |
| 530 | CS.setKind(clang::analyze_format_string::ConversionSpecifier::dArg); |
| 531 | break; |
| 532 | case ConversionSpecifier::dArg: |
| 533 | case ConversionSpecifier::DArg: |
| 534 | case ConversionSpecifier::iArg: |
Jordan Rose | cdbe1e0 | 2013-01-17 22:34:10 +0000 | [diff] [blame] | 535 | if (QT->isUnsignedIntegerType() && !HasPlusPrefix) |
Jordan Rose | 242ae3d | 2013-01-17 18:47:16 +0000 | [diff] [blame] | 536 | CS.setKind(clang::analyze_format_string::ConversionSpecifier::uArg); |
| 537 | break; |
| 538 | default: |
| 539 | // Other specifiers do not have signed/unsigned variants. |
| 540 | break; |
| 541 | } |
| 542 | |
Jordan Rose | bbb6bb4 | 2012-09-08 04:00:03 +0000 | [diff] [blame] | 543 | const analyze_printf::ArgType &ATR = getArgType(Ctx, IsObjCLiteral); |
| 544 | if (ATR.isValid() && ATR.matchesType(Ctx, QT)) |
| 545 | return true; |
| 546 | } |
Hans Wennborg | be6126a | 2012-02-15 09:59:46 +0000 | [diff] [blame] | 547 | |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 548 | // Set conversion specifier and disable any flags which do not apply to it. |
Ted Kremenek | 4d8ae4d | 2010-10-21 04:00:58 +0000 | [diff] [blame] | 549 | // Let typedefs to char fall through to int, as %c is silly for uint8_t. |
Jordan Rose | ff7be48 | 2012-12-05 18:44:37 +0000 | [diff] [blame] | 550 | if (!isa<TypedefType>(QT) && QT->isCharType()) { |
Ted Kremenek | 92a6feb | 2010-07-20 20:03:49 +0000 | [diff] [blame] | 551 | CS.setKind(ConversionSpecifier::cArg); |
Ted Kremenek | 4d8ae4d | 2010-10-21 04:00:58 +0000 | [diff] [blame] | 552 | LM.setKind(LengthModifier::None); |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 553 | Precision.setHowSpecified(OptionalAmount::NotSpecified); |
| 554 | HasAlternativeForm = 0; |
| 555 | HasLeadingZeroes = 0; |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 556 | HasPlusPrefix = 0; |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 557 | } |
| 558 | // Test for Floating type first as LongDouble can pass isUnsignedIntegerType |
Douglas Gregor | 0c293ea | 2010-06-22 23:07:26 +0000 | [diff] [blame] | 559 | else if (QT->isRealFloatingType()) { |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 560 | CS.setKind(ConversionSpecifier::fArg); |
| 561 | } |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 562 | else if (QT->isSignedIntegerType()) { |
| 563 | CS.setKind(ConversionSpecifier::dArg); |
| 564 | HasAlternativeForm = 0; |
| 565 | } |
Douglas Gregor | c8c4b40 | 2010-06-09 05:25:34 +0000 | [diff] [blame] | 566 | else if (QT->isUnsignedIntegerType()) { |
Hans Wennborg | be6126a | 2012-02-15 09:59:46 +0000 | [diff] [blame] | 567 | CS.setKind(ConversionSpecifier::uArg); |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 568 | HasAlternativeForm = 0; |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 569 | HasPlusPrefix = 0; |
Chad Rosier | 3060178 | 2011-08-17 23:08:45 +0000 | [diff] [blame] | 570 | } else { |
David Blaikie | b219cfc | 2011-09-23 05:06:16 +0000 | [diff] [blame] | 571 | llvm_unreachable("Unexpected type"); |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 572 | } |
| 573 | |
| 574 | return true; |
| 575 | } |
| 576 | |
Chris Lattner | 5f9e272 | 2011-07-23 10:55:15 +0000 | [diff] [blame] | 577 | void PrintfSpecifier::toString(raw_ostream &os) const { |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 578 | // Whilst some features have no defined order, we are using the order |
NAKAMURA Takumi | 0099530 | 2011-01-27 07:09:49 +0000 | [diff] [blame] | 579 | // appearing in the C99 standard (ISO/IEC 9899:1999 (E) 7.19.6.1) |
Tom Care | 3bfc5f4 | 2010-06-09 04:11:11 +0000 | [diff] [blame] | 580 | os << "%"; |
| 581 | |
| 582 | // Positional args |
| 583 | if (usesPositionalArg()) { |
| 584 | os << getPositionalArgIndex() << "$"; |
| 585 | } |
| 586 | |
| 587 | // Conversion flags |
| 588 | if (IsLeftJustified) os << "-"; |
| 589 | if (HasPlusPrefix) os << "+"; |
| 590 | if (HasSpacePrefix) os << " "; |
| 591 | if (HasAlternativeForm) os << "#"; |
| 592 | if (HasLeadingZeroes) os << "0"; |
| 593 | |
| 594 | // Minimum field width |
| 595 | FieldWidth.toString(os); |
| 596 | // Precision |
| 597 | Precision.toString(os); |
| 598 | // Length modifier |
| 599 | os << LM.toString(); |
| 600 | // Conversion specifier |
| 601 | os << CS.toString(); |
| 602 | } |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 603 | |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 604 | bool PrintfSpecifier::hasValidPlusPrefix() const { |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 605 | if (!HasPlusPrefix) |
| 606 | return true; |
| 607 | |
| 608 | // The plus prefix only makes sense for signed conversions |
| 609 | switch (CS.getKind()) { |
| 610 | case ConversionSpecifier::dArg: |
Jordan Rose | 275b6f5 | 2012-09-13 02:11:03 +0000 | [diff] [blame] | 611 | case ConversionSpecifier::DArg: |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 612 | case ConversionSpecifier::iArg: |
| 613 | case ConversionSpecifier::fArg: |
| 614 | case ConversionSpecifier::FArg: |
| 615 | case ConversionSpecifier::eArg: |
| 616 | case ConversionSpecifier::EArg: |
| 617 | case ConversionSpecifier::gArg: |
| 618 | case ConversionSpecifier::GArg: |
| 619 | case ConversionSpecifier::aArg: |
| 620 | case ConversionSpecifier::AArg: |
| 621 | return true; |
| 622 | |
| 623 | default: |
| 624 | return false; |
| 625 | } |
| 626 | } |
| 627 | |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 628 | bool PrintfSpecifier::hasValidAlternativeForm() const { |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 629 | if (!HasAlternativeForm) |
| 630 | return true; |
| 631 | |
Anders Carlsson | 2e6c19a | 2010-11-21 18:34:21 +0000 | [diff] [blame] | 632 | // Alternate form flag only valid with the oxXaAeEfFgG conversions |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 633 | switch (CS.getKind()) { |
| 634 | case ConversionSpecifier::oArg: |
Jordan Rose | 275b6f5 | 2012-09-13 02:11:03 +0000 | [diff] [blame] | 635 | case ConversionSpecifier::OArg: |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 636 | case ConversionSpecifier::xArg: |
Anders Carlsson | 2e6c19a | 2010-11-21 18:34:21 +0000 | [diff] [blame] | 637 | case ConversionSpecifier::XArg: |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 638 | case ConversionSpecifier::aArg: |
| 639 | case ConversionSpecifier::AArg: |
| 640 | case ConversionSpecifier::eArg: |
| 641 | case ConversionSpecifier::EArg: |
| 642 | case ConversionSpecifier::fArg: |
| 643 | case ConversionSpecifier::FArg: |
| 644 | case ConversionSpecifier::gArg: |
| 645 | case ConversionSpecifier::GArg: |
| 646 | return true; |
| 647 | |
| 648 | default: |
| 649 | return false; |
| 650 | } |
| 651 | } |
| 652 | |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 653 | bool PrintfSpecifier::hasValidLeadingZeros() const { |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 654 | if (!HasLeadingZeroes) |
| 655 | return true; |
| 656 | |
| 657 | // Leading zeroes flag only valid with the diouxXaAeEfFgG conversions |
| 658 | switch (CS.getKind()) { |
| 659 | case ConversionSpecifier::dArg: |
Jordan Rose | 275b6f5 | 2012-09-13 02:11:03 +0000 | [diff] [blame] | 660 | case ConversionSpecifier::DArg: |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 661 | case ConversionSpecifier::iArg: |
| 662 | case ConversionSpecifier::oArg: |
Jordan Rose | 275b6f5 | 2012-09-13 02:11:03 +0000 | [diff] [blame] | 663 | case ConversionSpecifier::OArg: |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 664 | case ConversionSpecifier::uArg: |
Jordan Rose | 275b6f5 | 2012-09-13 02:11:03 +0000 | [diff] [blame] | 665 | case ConversionSpecifier::UArg: |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 666 | case ConversionSpecifier::xArg: |
| 667 | case ConversionSpecifier::XArg: |
| 668 | case ConversionSpecifier::aArg: |
| 669 | case ConversionSpecifier::AArg: |
| 670 | case ConversionSpecifier::eArg: |
| 671 | case ConversionSpecifier::EArg: |
| 672 | case ConversionSpecifier::fArg: |
| 673 | case ConversionSpecifier::FArg: |
| 674 | case ConversionSpecifier::gArg: |
| 675 | case ConversionSpecifier::GArg: |
| 676 | return true; |
| 677 | |
| 678 | default: |
| 679 | return false; |
| 680 | } |
| 681 | } |
| 682 | |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 683 | bool PrintfSpecifier::hasValidSpacePrefix() const { |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 684 | if (!HasSpacePrefix) |
| 685 | return true; |
| 686 | |
| 687 | // The space prefix only makes sense for signed conversions |
| 688 | switch (CS.getKind()) { |
| 689 | case ConversionSpecifier::dArg: |
Jordan Rose | 275b6f5 | 2012-09-13 02:11:03 +0000 | [diff] [blame] | 690 | case ConversionSpecifier::DArg: |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 691 | case ConversionSpecifier::iArg: |
| 692 | case ConversionSpecifier::fArg: |
| 693 | case ConversionSpecifier::FArg: |
| 694 | case ConversionSpecifier::eArg: |
| 695 | case ConversionSpecifier::EArg: |
| 696 | case ConversionSpecifier::gArg: |
| 697 | case ConversionSpecifier::GArg: |
| 698 | case ConversionSpecifier::aArg: |
| 699 | case ConversionSpecifier::AArg: |
| 700 | return true; |
| 701 | |
| 702 | default: |
| 703 | return false; |
| 704 | } |
| 705 | } |
| 706 | |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 707 | bool PrintfSpecifier::hasValidLeftJustified() const { |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 708 | if (!IsLeftJustified) |
| 709 | return true; |
| 710 | |
| 711 | // The left justified flag is valid for all conversions except n |
| 712 | switch (CS.getKind()) { |
Ted Kremenek | 35d353b | 2010-07-20 20:04:10 +0000 | [diff] [blame] | 713 | case ConversionSpecifier::nArg: |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 714 | return false; |
| 715 | |
| 716 | default: |
| 717 | return true; |
| 718 | } |
| 719 | } |
| 720 | |
Ted Kremenek | 65197b4 | 2011-01-08 05:28:46 +0000 | [diff] [blame] | 721 | bool PrintfSpecifier::hasValidThousandsGroupingPrefix() const { |
| 722 | if (!HasThousandsGrouping) |
| 723 | return true; |
NAKAMURA Takumi | dfbb02a | 2011-01-27 07:10:08 +0000 | [diff] [blame] | 724 | |
Ted Kremenek | 65197b4 | 2011-01-08 05:28:46 +0000 | [diff] [blame] | 725 | switch (CS.getKind()) { |
| 726 | case ConversionSpecifier::dArg: |
Jordan Rose | 275b6f5 | 2012-09-13 02:11:03 +0000 | [diff] [blame] | 727 | case ConversionSpecifier::DArg: |
Ted Kremenek | 65197b4 | 2011-01-08 05:28:46 +0000 | [diff] [blame] | 728 | case ConversionSpecifier::iArg: |
| 729 | case ConversionSpecifier::uArg: |
Jordan Rose | 275b6f5 | 2012-09-13 02:11:03 +0000 | [diff] [blame] | 730 | case ConversionSpecifier::UArg: |
Ted Kremenek | 65197b4 | 2011-01-08 05:28:46 +0000 | [diff] [blame] | 731 | case ConversionSpecifier::fArg: |
| 732 | case ConversionSpecifier::FArg: |
| 733 | case ConversionSpecifier::gArg: |
| 734 | case ConversionSpecifier::GArg: |
| 735 | return true; |
| 736 | default: |
| 737 | return false; |
| 738 | } |
| 739 | } |
| 740 | |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 741 | bool PrintfSpecifier::hasValidPrecision() const { |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 742 | if (Precision.getHowSpecified() == OptionalAmount::NotSpecified) |
| 743 | return true; |
| 744 | |
| 745 | // Precision is only valid with the diouxXaAeEfFgGs conversions |
| 746 | switch (CS.getKind()) { |
| 747 | case ConversionSpecifier::dArg: |
Jordan Rose | 275b6f5 | 2012-09-13 02:11:03 +0000 | [diff] [blame] | 748 | case ConversionSpecifier::DArg: |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 749 | case ConversionSpecifier::iArg: |
| 750 | case ConversionSpecifier::oArg: |
Jordan Rose | 275b6f5 | 2012-09-13 02:11:03 +0000 | [diff] [blame] | 751 | case ConversionSpecifier::OArg: |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 752 | case ConversionSpecifier::uArg: |
Jordan Rose | 275b6f5 | 2012-09-13 02:11:03 +0000 | [diff] [blame] | 753 | case ConversionSpecifier::UArg: |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 754 | case ConversionSpecifier::xArg: |
| 755 | case ConversionSpecifier::XArg: |
| 756 | case ConversionSpecifier::aArg: |
| 757 | case ConversionSpecifier::AArg: |
| 758 | case ConversionSpecifier::eArg: |
| 759 | case ConversionSpecifier::EArg: |
| 760 | case ConversionSpecifier::fArg: |
| 761 | case ConversionSpecifier::FArg: |
| 762 | case ConversionSpecifier::gArg: |
| 763 | case ConversionSpecifier::GArg: |
Ted Kremenek | 99196b1 | 2010-07-20 20:03:58 +0000 | [diff] [blame] | 764 | case ConversionSpecifier::sArg: |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 765 | return true; |
| 766 | |
| 767 | default: |
| 768 | return false; |
| 769 | } |
| 770 | } |
Ted Kremenek | 826a345 | 2010-07-16 02:11:22 +0000 | [diff] [blame] | 771 | bool PrintfSpecifier::hasValidFieldWidth() const { |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 772 | if (FieldWidth.getHowSpecified() == OptionalAmount::NotSpecified) |
| 773 | return true; |
| 774 | |
| 775 | // The field width is valid for all conversions except n |
| 776 | switch (CS.getKind()) { |
Ted Kremenek | 35d353b | 2010-07-20 20:04:10 +0000 | [diff] [blame] | 777 | case ConversionSpecifier::nArg: |
Tom Care | e4ee966 | 2010-06-17 19:00:27 +0000 | [diff] [blame] | 778 | return false; |
| 779 | |
| 780 | default: |
| 781 | return true; |
| 782 | } |
| 783 | } |