blob: 3cc982d4d0c8db72fd131449c3d80cadcf6d4311 [file] [log] [blame]
Ted Kremenek02087932010-07-16 02:11:22 +00001//== PrintfFormatString.cpp - Analysis of printf format strings --*- C++ -*-==//
Ted Kremeneka2e77b42010-01-27 23:43:25 +00002//
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 Kremenek02087932010-07-16 02:11:22 +000015#include "clang/Analysis/Analyses/FormatString.h"
16#include "FormatStringParsing.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000017#include "clang/Basic/TargetInfo.h"
Ted Kremeneka2e77b42010-01-27 23:43:25 +000018
Hans Wennborgc3b3da02012-08-07 08:11:26 +000019using clang::analyze_format_string::ArgType;
Ted Kremenek02087932010-07-16 02:11:22 +000020using clang::analyze_format_string::FormatStringHandler;
21using clang::analyze_format_string::LengthModifier;
22using clang::analyze_format_string::OptionalAmount;
Ted Kremenekf03e6d852010-07-20 20:04:27 +000023using clang::analyze_format_string::ConversionSpecifier;
Ted Kremenek02087932010-07-16 02:11:22 +000024using clang::analyze_printf::PrintfSpecifier;
Ted Kremenekd1668192010-02-27 01:41:03 +000025
Ted Kremenekc22f78d2010-01-29 03:16:21 +000026using namespace clang;
Ted Kremeneka2e77b42010-01-27 23:43:25 +000027
Ted Kremenek02087932010-07-16 02:11:22 +000028typedef clang::analyze_format_string::SpecifierResult<PrintfSpecifier>
29 PrintfSpecifierResult;
Ted Kremenekc8b188d2010-02-16 01:46:59 +000030
31//===----------------------------------------------------------------------===//
32// Methods for parsing format strings.
33//===----------------------------------------------------------------------===//
Ted Kremeneka2e77b42010-01-27 23:43:25 +000034
Ted Kremenek02087932010-07-16 02:11:22 +000035using analyze_format_string::ParseNonPositionAmount;
Ted Kremenekc8b188d2010-02-16 01:46:59 +000036
Ted Kremenek02087932010-07-16 02:11:22 +000037static bool ParsePrecision(FormatStringHandler &H, PrintfSpecifier &FS,
Ted Kremenekd1668192010-02-27 01:41:03 +000038 const char *Start, const char *&Beg, const char *E,
39 unsigned *argIndex) {
40 if (argIndex) {
41 FS.setPrecision(ParseNonPositionAmount(Beg, E, *argIndex));
Chad Rosier6fdf38b2011-08-17 23:08:45 +000042 } else {
Ted Kremenekd1668192010-02-27 01:41:03 +000043 const OptionalAmount Amt = ParsePositionAmount(H, Start, Beg, E,
Ted Kremenek02087932010-07-16 02:11:22 +000044 analyze_format_string::PrecisionPos);
Ted Kremenekd1668192010-02-27 01:41:03 +000045 if (Amt.isInvalid())
46 return true;
47 FS.setPrecision(Amt);
48 }
49 return false;
50}
51
Ted Kremenek2b417712015-07-02 05:39:16 +000052static bool ParseObjCFlags(FormatStringHandler &H, PrintfSpecifier &FS,
53 const char *FlagBeg, const char *E, bool Warn) {
54 StringRef Flag(FlagBeg, E - FlagBeg);
55 // Currently there is only one flag.
56 if (Flag == "tt") {
57 FS.setHasObjCTechnicalTerm(FlagBeg);
58 return false;
59 }
60 // Handle either the case of no flag or an invalid flag.
61 if (Warn) {
62 if (Flag == "")
63 H.HandleEmptyObjCModifierFlag(FlagBeg, E - FlagBeg);
64 else
65 H.HandleInvalidObjCModifierFlag(FlagBeg, E - FlagBeg);
66 }
67 return true;
68}
69
Ted Kremenek02087932010-07-16 02:11:22 +000070static PrintfSpecifierResult ParsePrintfSpecifier(FormatStringHandler &H,
Ted Kremenek1de17072010-02-04 20:46:58 +000071 const char *&Beg,
Ted Kremenek4a49d982010-02-26 19:18:41 +000072 const char *E,
Hans Wennborg23926bd2011-12-15 10:25:47 +000073 unsigned &argIndex,
Jordan Rose510260c2012-09-13 02:11:03 +000074 const LangOptions &LO,
Fariborz Jahanian6485fe42014-09-09 23:10:54 +000075 const TargetInfo &Target,
Dimitry Andric6b5ed342015-02-19 22:32:33 +000076 bool Warn,
77 bool isFreeBSDKPrintf) {
Ted Kremenekc8b188d2010-02-16 01:46:59 +000078
Ted Kremenekf03e6d852010-07-20 20:04:27 +000079 using namespace clang::analyze_format_string;
Ted Kremenek176f7d62010-01-29 02:13:53 +000080 using namespace clang::analyze_printf;
Ted Kremenekc8b188d2010-02-16 01:46:59 +000081
Ted Kremeneka2e77b42010-01-27 23:43:25 +000082 const char *I = Beg;
Craig Topper25542942014-05-20 04:30:07 +000083 const char *Start = nullptr;
Ted Kremeneka2e77b42010-01-27 23:43:25 +000084 UpdateOnReturn <const char*> UpdateBeg(Beg, I);
85
86 // Look for a '%' character that indicates the start of a format specifier.
Ted Kremenekb5c98ef2010-01-28 23:56:52 +000087 for ( ; I != E ; ++I) {
Ted Kremeneka2e77b42010-01-27 23:43:25 +000088 char c = *I;
Ted Kremeneka2e77b42010-01-27 23:43:25 +000089 if (c == '\0') {
90 // Detect spurious null characters, which are likely errors.
91 H.HandleNullChar(I);
92 return true;
93 }
94 if (c == '%') {
Ted Kremenekb5c98ef2010-01-28 23:56:52 +000095 Start = I++; // Record the start of the format specifier.
Ted Kremeneka2e77b42010-01-27 23:43:25 +000096 break;
97 }
98 }
Ted Kremenekc8b188d2010-02-16 01:46:59 +000099
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000100 // No format specifier found?
101 if (!Start)
102 return false;
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000103
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000104 if (I == E) {
105 // No more characters left?
Fariborz Jahanian6485fe42014-09-09 23:10:54 +0000106 if (Warn)
107 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000108 return true;
109 }
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000110
Ted Kremenek02087932010-07-16 02:11:22 +0000111 PrintfSpecifier FS;
Ted Kremenekd1668192010-02-27 01:41:03 +0000112 if (ParseArgPosition(H, FS, Start, I, E))
113 return true;
114
115 if (I == E) {
116 // No more characters left?
Fariborz Jahanian6485fe42014-09-09 23:10:54 +0000117 if (Warn)
118 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremenekd1668192010-02-27 01:41:03 +0000119 return true;
120 }
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000121
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000122 // Look for flags (if any).
123 bool hasMore = true;
124 for ( ; I != E; ++I) {
125 switch (*I) {
126 default: hasMore = false; break;
NAKAMURA Takumif9cbcc42011-01-27 07:10:08 +0000127 case '\'':
Ted Kremeneka322cae2011-01-08 05:28:38 +0000128 // FIXME: POSIX specific. Always accept?
129 FS.setHasThousandsGrouping(I);
130 break;
Tom Careb49ec692010-06-17 19:00:27 +0000131 case '-': FS.setIsLeftJustified(I); break;
132 case '+': FS.setHasPlusPrefix(I); break;
133 case ' ': FS.setHasSpacePrefix(I); break;
134 case '#': FS.setHasAlternativeForm(I); break;
135 case '0': FS.setHasLeadingZeros(I); break;
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000136 }
137 if (!hasMore)
138 break;
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000139 }
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000140
141 if (I == E) {
142 // No more characters left?
Fariborz Jahanian6485fe42014-09-09 23:10:54 +0000143 if (Warn)
144 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000145 return true;
146 }
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000147
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000148 // Look for the field width (if any).
Ted Kremenekd1668192010-02-27 01:41:03 +0000149 if (ParseFieldWidth(H, FS, Start, I, E,
Craig Topper25542942014-05-20 04:30:07 +0000150 FS.usesPositionalArg() ? nullptr : &argIndex))
Ted Kremenekd1668192010-02-27 01:41:03 +0000151 return true;
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000152
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000153 if (I == E) {
154 // No more characters left?
Fariborz Jahanian6485fe42014-09-09 23:10:54 +0000155 if (Warn)
156 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000157 return true;
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000158 }
159
160 // Look for the precision (if any).
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000161 if (*I == '.') {
Ted Kremenekc22f78d2010-01-29 03:16:21 +0000162 ++I;
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000163 if (I == E) {
Fariborz Jahanian6485fe42014-09-09 23:10:54 +0000164 if (Warn)
165 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000166 return true;
167 }
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000168
Ted Kremenekd1668192010-02-27 01:41:03 +0000169 if (ParsePrecision(H, FS, Start, I, E,
Craig Topper25542942014-05-20 04:30:07 +0000170 FS.usesPositionalArg() ? nullptr : &argIndex))
Ted Kremenekd1668192010-02-27 01:41:03 +0000171 return true;
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000172
173 if (I == E) {
174 // No more characters left?
Fariborz Jahanian6485fe42014-09-09 23:10:54 +0000175 if (Warn)
176 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000177 return true;
178 }
179 }
180
181 // Look for the length modifier.
Hans Wennborg23926bd2011-12-15 10:25:47 +0000182 if (ParseLengthModifier(FS, I, E, LO) && I == E) {
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000183 // No more characters left?
Fariborz Jahanian6485fe42014-09-09 23:10:54 +0000184 if (Warn)
185 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000186 return true;
187 }
Ted Kremenek2a0cd592010-02-09 00:04:09 +0000188
Ted Kremenek2b417712015-07-02 05:39:16 +0000189 // Look for the Objective-C modifier flags, if any.
190 // We parse these here, even if they don't apply to
191 // the conversion specifier, and then emit an error
192 // later if the conversion specifier isn't '@'. This
193 // enables better recovery, and we don't know if
194 // these flags are applicable until later.
195 const char *ObjCModifierFlagsStart = nullptr,
196 *ObjCModifierFlagsEnd = nullptr;
197 if (*I == '[') {
198 ObjCModifierFlagsStart = I;
199 ++I;
200 auto flagStart = I;
201 for (;; ++I) {
202 ObjCModifierFlagsEnd = I;
203 if (I == E) {
204 if (Warn)
205 H.HandleIncompleteSpecifier(Start, E - Start);
206 return true;
207 }
208 // Did we find the closing ']'?
209 if (*I == ']') {
210 if (ParseObjCFlags(H, FS, flagStart, I, Warn))
211 return true;
212 ++I;
213 break;
214 }
215 // There are no separators defined yet for multiple
216 // Objective-C modifier flags. When those are
217 // defined, this is the place to check.
218 }
219 }
220
Ted Kremenek23a71a12010-01-29 20:29:53 +0000221 if (*I == '\0') {
Ted Kremenek2a0cd592010-02-09 00:04:09 +0000222 // Detect spurious null characters, which are likely errors.
223 H.HandleNullChar(I);
224 return true;
Ted Kremenek23a71a12010-01-29 20:29:53 +0000225 }
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000226
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000227 // Finally, look for the conversion specifier.
Ted Kremenekfee0e962010-01-28 02:46:17 +0000228 const char *conversionPosition = I++;
Ted Kremenek94af5752010-01-29 02:40:24 +0000229 ConversionSpecifier::Kind k = ConversionSpecifier::InvalidSpecifier;
Ted Kremenekfee0e962010-01-28 02:46:17 +0000230 switch (*conversionPosition) {
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000231 default:
Ted Kremenek94af5752010-01-29 02:40:24 +0000232 break;
Ted Kremenekc06ead62010-01-28 00:55:28 +0000233 // C99: 7.19.6.1 (section 8).
Ted Kremenek74a4ce72010-02-24 00:05:54 +0000234 case '%': k = ConversionSpecifier::PercentArg; break;
235 case 'A': k = ConversionSpecifier::AArg; break;
236 case 'E': k = ConversionSpecifier::EArg; break;
237 case 'F': k = ConversionSpecifier::FArg; break;
238 case 'G': k = ConversionSpecifier::GArg; break;
239 case 'X': k = ConversionSpecifier::XArg; break;
240 case 'a': k = ConversionSpecifier::aArg; break;
Ted Kremenekab0fe8a2010-07-20 20:03:49 +0000241 case 'c': k = ConversionSpecifier::cArg; break;
Ted Kremenekfee0e962010-01-28 02:46:17 +0000242 case 'd': k = ConversionSpecifier::dArg; break;
Ted Kremenek74a4ce72010-02-24 00:05:54 +0000243 case 'e': k = ConversionSpecifier::eArg; break;
244 case 'f': k = ConversionSpecifier::fArg; break;
245 case 'g': k = ConversionSpecifier::gArg; break;
Ted Kremenekfee0e962010-01-28 02:46:17 +0000246 case 'i': k = ConversionSpecifier::iArg; break;
Ted Kremenek516ef222010-07-20 20:04:10 +0000247 case 'n': k = ConversionSpecifier::nArg; break;
Ted Kremenekfee0e962010-01-28 02:46:17 +0000248 case 'o': k = ConversionSpecifier::oArg; break;
David Majnemer3cba4952013-08-21 21:54:46 +0000249 case 'p': k = ConversionSpecifier::pArg; break;
250 case 's': k = ConversionSpecifier::sArg; break;
Ted Kremenekfee0e962010-01-28 02:46:17 +0000251 case 'u': k = ConversionSpecifier::uArg; break;
252 case 'x': k = ConversionSpecifier::xArg; break;
Ted Kremeneka322cae2011-01-08 05:28:38 +0000253 // POSIX specific.
Ted Kremenek74a4ce72010-02-24 00:05:54 +0000254 case 'C': k = ConversionSpecifier::CArg; break;
Ted Kremenek348d1492010-07-20 20:04:15 +0000255 case 'S': k = ConversionSpecifier::SArg; break;
Ted Kremenekc06ead62010-01-28 00:55:28 +0000256 // Objective-C.
Ted Kremenek23a71a12010-01-29 20:29:53 +0000257 case '@': k = ConversionSpecifier::ObjCObjArg; break;
Ted Kremenek2a0cd592010-02-09 00:04:09 +0000258 // Glibc specific.
Ted Kremenek23a71a12010-01-29 20:29:53 +0000259 case 'm': k = ConversionSpecifier::PrintErrno; break;
Dimitry Andric6b5ed342015-02-19 22:32:33 +0000260 // FreeBSD kernel specific.
261 case 'b':
262 if (isFreeBSDKPrintf)
263 k = ConversionSpecifier::FreeBSDbArg; // int followed by char *
264 break;
265 case 'r':
266 if (isFreeBSDKPrintf)
267 k = ConversionSpecifier::FreeBSDrArg; // int
268 break;
269 case 'y':
270 if (isFreeBSDKPrintf)
271 k = ConversionSpecifier::FreeBSDyArg; // int
272 break;
Hans Wennborgc597b4c2014-09-07 03:03:51 +0000273 // Apple-specific.
Jordan Rose510260c2012-09-13 02:11:03 +0000274 case 'D':
Dimitry Andric6b5ed342015-02-19 22:32:33 +0000275 if (isFreeBSDKPrintf)
276 k = ConversionSpecifier::FreeBSDDArg; // void * followed by char *
277 else if (Target.getTriple().isOSDarwin())
Jordan Rose510260c2012-09-13 02:11:03 +0000278 k = ConversionSpecifier::DArg;
279 break;
280 case 'O':
281 if (Target.getTriple().isOSDarwin())
282 k = ConversionSpecifier::OArg;
283 break;
284 case 'U':
285 if (Target.getTriple().isOSDarwin())
286 k = ConversionSpecifier::UArg;
287 break;
Hans Wennborgc597b4c2014-09-07 03:03:51 +0000288 // MS specific.
289 case 'Z':
290 if (Target.getTriple().isOSMSVCRT())
291 k = ConversionSpecifier::ZArg;
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000292 }
Ted Kremenek2b417712015-07-02 05:39:16 +0000293
294 // Check to see if we used the Objective-C modifier flags with
295 // a conversion specifier other than '@'.
296 if (k != ConversionSpecifier::ObjCObjArg &&
297 k != ConversionSpecifier::InvalidSpecifier &&
298 ObjCModifierFlagsStart) {
299 H.HandleObjCFlagsWithNonObjCConversion(ObjCModifierFlagsStart,
300 ObjCModifierFlagsEnd + 1,
301 conversionPosition);
302 return true;
303 }
304
Ted Kremenekf03e6d852010-07-20 20:04:27 +0000305 PrintfConversionSpecifier CS(conversionPosition, k);
Ted Kremenek4a49d982010-02-26 19:18:41 +0000306 FS.setConversionSpecifier(CS);
Ted Kremenekd1668192010-02-27 01:41:03 +0000307 if (CS.consumesDataArgument() && !FS.usesPositionalArg())
Ted Kremenek4a49d982010-02-26 19:18:41 +0000308 FS.setArgIndex(argIndex++);
Dimitry Andric6b5ed342015-02-19 22:32:33 +0000309 // FreeBSD kernel specific.
310 if (k == ConversionSpecifier::FreeBSDbArg ||
311 k == ConversionSpecifier::FreeBSDDArg)
312 argIndex++;
Ted Kremenek94af5752010-01-29 02:40:24 +0000313
314 if (k == ConversionSpecifier::InvalidSpecifier) {
Bruno Cardoso Lopes0c18d032016-03-29 17:35:02 +0000315 unsigned Len = I - Start;
316 if (ParseUTF8InvalidSpecifier(Start, E, Len)) {
317 CS.setEndScanList(Start + Len);
318 FS.setConversionSpecifier(CS);
319 }
Ted Kremenek4a49d982010-02-26 19:18:41 +0000320 // Assume the conversion takes one argument.
Bruno Cardoso Lopes0c18d032016-03-29 17:35:02 +0000321 return !H.HandleInvalidPrintfConversionSpecifier(FS, Start, Len);
Ted Kremenek94af5752010-01-29 02:40:24 +0000322 }
Ted Kremenek02087932010-07-16 02:11:22 +0000323 return PrintfSpecifierResult(Start, FS);
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000324}
325
Ted Kremenek02087932010-07-16 02:11:22 +0000326bool clang::analyze_format_string::ParsePrintfString(FormatStringHandler &H,
327 const char *I,
Hans Wennborg23926bd2011-12-15 10:25:47 +0000328 const char *E,
Jordan Rose510260c2012-09-13 02:11:03 +0000329 const LangOptions &LO,
Dimitry Andric6b5ed342015-02-19 22:32:33 +0000330 const TargetInfo &Target,
331 bool isFreeBSDKPrintf) {
Ted Kremenek4a49d982010-02-26 19:18:41 +0000332
333 unsigned argIndex = 0;
334
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000335 // Keep looking for a format specifier until we have exhausted the string.
336 while (I != E) {
Hans Wennborg23926bd2011-12-15 10:25:47 +0000337 const PrintfSpecifierResult &FSR = ParsePrintfSpecifier(H, I, E, argIndex,
Dimitry Andric6b5ed342015-02-19 22:32:33 +0000338 LO, Target, true,
339 isFreeBSDKPrintf);
Ted Kremenek94af5752010-01-29 02:40:24 +0000340 // Did a fail-stop error of any kind occur when parsing the specifier?
341 // If so, don't do any more processing.
342 if (FSR.shouldStop())
Dmitri Gribenko76bb5cabfa2012-09-10 21:20:09 +0000343 return true;
Ted Kremenek94af5752010-01-29 02:40:24 +0000344 // Did we exhaust the string or encounter an error that
345 // we can recover from?
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000346 if (!FSR.hasValue())
Ted Kremenek94af5752010-01-29 02:40:24 +0000347 continue;
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000348 // We have a format specifier. Pass it to the callback.
Ted Kremenek02087932010-07-16 02:11:22 +0000349 if (!H.HandlePrintfSpecifier(FSR.getValue(), FSR.getStart(),
Ted Kremenekfee0e962010-01-28 02:46:17 +0000350 I - FSR.getStart()))
Ted Kremenek23a71a12010-01-29 20:29:53 +0000351 return true;
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000352 }
353 assert(I == E && "Format string not exhausted");
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000354 return false;
355}
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000356
Fariborz Jahanian6485fe42014-09-09 23:10:54 +0000357bool clang::analyze_format_string::ParseFormatStringHasSArg(const char *I,
358 const char *E,
359 const LangOptions &LO,
360 const TargetInfo &Target) {
361
362 unsigned argIndex = 0;
363
364 // Keep looking for a %s format specifier until we have exhausted the string.
365 FormatStringHandler H;
366 while (I != E) {
367 const PrintfSpecifierResult &FSR = ParsePrintfSpecifier(H, I, E, argIndex,
Dimitry Andric6b5ed342015-02-19 22:32:33 +0000368 LO, Target, false,
369 false);
Fariborz Jahanian6485fe42014-09-09 23:10:54 +0000370 // Did a fail-stop error of any kind occur when parsing the specifier?
371 // If so, don't do any more processing.
372 if (FSR.shouldStop())
373 return false;
374 // Did we exhaust the string or encounter an error that
375 // we can recover from?
376 if (!FSR.hasValue())
377 continue;
378 const analyze_printf::PrintfSpecifier &FS = FSR.getValue();
379 // Return true if this a %s format specifier.
380 if (FS.getConversionSpecifier().getKind() == ConversionSpecifier::Kind::sArg)
381 return true;
382 }
383 return false;
384}
385
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000386//===----------------------------------------------------------------------===//
Ted Kremenek02087932010-07-16 02:11:22 +0000387// Methods on PrintfSpecifier.
Tom Careb7042702010-06-09 04:11:11 +0000388//===----------------------------------------------------------------------===//
389
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000390ArgType PrintfSpecifier::getArgType(ASTContext &Ctx,
391 bool IsObjCLiteral) const {
Ted Kremenekf03e6d852010-07-20 20:04:27 +0000392 const PrintfConversionSpecifier &CS = getConversionSpecifier();
NAKAMURA Takumif9cbcc42011-01-27 07:10:08 +0000393
Ted Kremenek79db7b72010-01-29 22:59:32 +0000394 if (!CS.consumesDataArgument())
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000395 return ArgType::Invalid();
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000396
Ted Kremenek5f0c0662010-08-24 22:24:51 +0000397 if (CS.getKind() == ConversionSpecifier::cArg)
398 switch (LM.getKind()) {
Hans Wennborg1b231582014-09-04 21:39:52 +0000399 case LengthModifier::None:
400 return Ctx.IntTy;
Hans Wennborga5b1aa92011-12-09 12:22:12 +0000401 case LengthModifier::AsLong:
Hans Wennborg68f42b92014-09-04 21:39:46 +0000402 case LengthModifier::AsWide:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000403 return ArgType(ArgType::WIntTy, "wint_t");
Hans Wennborg1b231582014-09-04 21:39:52 +0000404 case LengthModifier::AsShort:
405 if (Ctx.getTargetInfo().getTriple().isOSMSVCRT())
406 return Ctx.IntTy;
Ted Kremenek5f0c0662010-08-24 22:24:51 +0000407 default:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000408 return ArgType::Invalid();
Ted Kremenek5f0c0662010-08-24 22:24:51 +0000409 }
NAKAMURA Takumif9cbcc42011-01-27 07:10:08 +0000410
Ted Kremenek79db7b72010-01-29 22:59:32 +0000411 if (CS.isIntArg())
Tom Careb7042702010-06-09 04:11:11 +0000412 switch (LM.getKind()) {
413 case LengthModifier::AsLongDouble:
Ted Kremenek6fa57272012-01-24 21:29:54 +0000414 // GNU extension.
415 return Ctx.LongLongTy;
David Majnemer3cba4952013-08-21 21:54:46 +0000416 case LengthModifier::None:
417 return Ctx.IntTy;
418 case LengthModifier::AsInt32:
419 return ArgType(Ctx.IntTy, "__int32");
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000420 case LengthModifier::AsChar: return ArgType::AnyCharTy;
Tom Careb7042702010-06-09 04:11:11 +0000421 case LengthModifier::AsShort: return Ctx.ShortTy;
422 case LengthModifier::AsLong: return Ctx.LongTy;
Hans Wennborg9bc9bcc2012-02-16 16:34:54 +0000423 case LengthModifier::AsLongLong:
424 case LengthModifier::AsQuad:
425 return Ctx.LongLongTy;
David Majnemer3cba4952013-08-21 21:54:46 +0000426 case LengthModifier::AsInt64:
427 return ArgType(Ctx.LongLongTy, "__int64");
Hans Wennborg772e9272011-12-07 10:33:11 +0000428 case LengthModifier::AsIntMax:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000429 return ArgType(Ctx.getIntMaxType(), "intmax_t");
Hans Wennborg27541db2011-10-27 08:29:09 +0000430 case LengthModifier::AsSizeT:
431 // FIXME: How to get the corresponding signed version of size_t?
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000432 return ArgType();
David Majnemer3cba4952013-08-21 21:54:46 +0000433 case LengthModifier::AsInt3264:
David Majnemera39da8e2013-08-22 07:53:21 +0000434 return Ctx.getTargetInfo().getTriple().isArch64Bit()
435 ? ArgType(Ctx.LongLongTy, "__int64")
436 : ArgType(Ctx.IntTy, "__int32");
Hans Wennborg772e9272011-12-07 10:33:11 +0000437 case LengthModifier::AsPtrDiff:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000438 return ArgType(Ctx.getPointerDiffType(), "ptrdiff_t");
Hans Wennborg23926bd2011-12-15 10:25:47 +0000439 case LengthModifier::AsAllocate:
Hans Wennborg6073e312012-01-12 17:11:12 +0000440 case LengthModifier::AsMAllocate:
Hans Wennborg68f42b92014-09-04 21:39:46 +0000441 case LengthModifier::AsWide:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000442 return ArgType::Invalid();
Ted Kremenek79db7b72010-01-29 22:59:32 +0000443 }
444
445 if (CS.isUIntArg())
Tom Careb7042702010-06-09 04:11:11 +0000446 switch (LM.getKind()) {
447 case LengthModifier::AsLongDouble:
Ted Kremenek6fa57272012-01-24 21:29:54 +0000448 // GNU extension.
449 return Ctx.UnsignedLongLongTy;
David Majnemer3cba4952013-08-21 21:54:46 +0000450 case LengthModifier::None:
451 return Ctx.UnsignedIntTy;
452 case LengthModifier::AsInt32:
453 return ArgType(Ctx.UnsignedIntTy, "unsigned __int32");
Tom Careb7042702010-06-09 04:11:11 +0000454 case LengthModifier::AsChar: return Ctx.UnsignedCharTy;
455 case LengthModifier::AsShort: return Ctx.UnsignedShortTy;
456 case LengthModifier::AsLong: return Ctx.UnsignedLongTy;
Hans Wennborg9bc9bcc2012-02-16 16:34:54 +0000457 case LengthModifier::AsLongLong:
458 case LengthModifier::AsQuad:
459 return Ctx.UnsignedLongLongTy;
David Majnemer3cba4952013-08-21 21:54:46 +0000460 case LengthModifier::AsInt64:
461 return ArgType(Ctx.UnsignedLongLongTy, "unsigned __int64");
Hans Wennborg772e9272011-12-07 10:33:11 +0000462 case LengthModifier::AsIntMax:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000463 return ArgType(Ctx.getUIntMaxType(), "uintmax_t");
Tom Careb7042702010-06-09 04:11:11 +0000464 case LengthModifier::AsSizeT:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000465 return ArgType(Ctx.getSizeType(), "size_t");
David Majnemer3cba4952013-08-21 21:54:46 +0000466 case LengthModifier::AsInt3264:
467 return Ctx.getTargetInfo().getTriple().isArch64Bit()
David Majnemera39da8e2013-08-22 07:53:21 +0000468 ? ArgType(Ctx.UnsignedLongLongTy, "unsigned __int64")
469 : ArgType(Ctx.UnsignedIntTy, "unsigned __int32");
Tom Careb7042702010-06-09 04:11:11 +0000470 case LengthModifier::AsPtrDiff:
Ted Kremenek79db7b72010-01-29 22:59:32 +0000471 // FIXME: How to get the corresponding unsigned
472 // version of ptrdiff_t?
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000473 return ArgType();
Hans Wennborg23926bd2011-12-15 10:25:47 +0000474 case LengthModifier::AsAllocate:
Hans Wennborg6073e312012-01-12 17:11:12 +0000475 case LengthModifier::AsMAllocate:
Hans Wennborg68f42b92014-09-04 21:39:46 +0000476 case LengthModifier::AsWide:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000477 return ArgType::Invalid();
Ted Kremenek79db7b72010-01-29 22:59:32 +0000478 }
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000479
Ted Kremenek016b6052010-02-01 23:23:50 +0000480 if (CS.isDoubleArg()) {
Tom Careb7042702010-06-09 04:11:11 +0000481 if (LM.getKind() == LengthModifier::AsLongDouble)
Ted Kremenek016b6052010-02-01 23:23:50 +0000482 return Ctx.LongDoubleTy;
Ted Kremenek9ff02052010-01-30 01:02:18 +0000483 return Ctx.DoubleTy;
Ted Kremenek016b6052010-02-01 23:23:50 +0000484 }
Ted Kremenek4a49d982010-02-26 19:18:41 +0000485
Hans Wennborgabc1e222012-08-07 09:13:19 +0000486 if (CS.getKind() == ConversionSpecifier::nArg) {
487 switch (LM.getKind()) {
488 case LengthModifier::None:
489 return ArgType::PtrTo(Ctx.IntTy);
490 case LengthModifier::AsChar:
491 return ArgType::PtrTo(Ctx.SignedCharTy);
492 case LengthModifier::AsShort:
493 return ArgType::PtrTo(Ctx.ShortTy);
494 case LengthModifier::AsLong:
495 return ArgType::PtrTo(Ctx.LongTy);
496 case LengthModifier::AsLongLong:
497 case LengthModifier::AsQuad:
498 return ArgType::PtrTo(Ctx.LongLongTy);
499 case LengthModifier::AsIntMax:
500 return ArgType::PtrTo(ArgType(Ctx.getIntMaxType(), "intmax_t"));
501 case LengthModifier::AsSizeT:
502 return ArgType(); // FIXME: ssize_t
503 case LengthModifier::AsPtrDiff:
504 return ArgType::PtrTo(ArgType(Ctx.getPointerDiffType(), "ptrdiff_t"));
505 case LengthModifier::AsLongDouble:
506 return ArgType(); // FIXME: Is this a known extension?
507 case LengthModifier::AsAllocate:
508 case LengthModifier::AsMAllocate:
David Majnemer3cba4952013-08-21 21:54:46 +0000509 case LengthModifier::AsInt32:
510 case LengthModifier::AsInt3264:
511 case LengthModifier::AsInt64:
Hans Wennborg68f42b92014-09-04 21:39:46 +0000512 case LengthModifier::AsWide:
Hans Wennborgabc1e222012-08-07 09:13:19 +0000513 return ArgType::Invalid();
514 }
515 }
516
Ted Kremenek74a4ce72010-02-24 00:05:54 +0000517 switch (CS.getKind()) {
Hans Wennborg0c353262011-12-09 15:57:33 +0000518 case ConversionSpecifier::sArg:
Nico Weber496cdc22012-01-31 01:43:25 +0000519 if (LM.getKind() == LengthModifier::AsWideChar) {
520 if (IsObjCLiteral)
Jordan Rose0e5badd2012-12-05 18:44:49 +0000521 return ArgType(Ctx.getPointerType(Ctx.UnsignedShortTy.withConst()),
522 "const unichar *");
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000523 return ArgType(ArgType::WCStrTy, "wchar_t *");
Nico Weber496cdc22012-01-31 01:43:25 +0000524 }
Hans Wennborg68f42b92014-09-04 21:39:46 +0000525 if (LM.getKind() == LengthModifier::AsWide)
526 return ArgType(ArgType::WCStrTy, "wchar_t *");
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000527 return ArgType::CStrTy;
Ted Kremenek348d1492010-07-20 20:04:15 +0000528 case ConversionSpecifier::SArg:
Nico Weber496cdc22012-01-31 01:43:25 +0000529 if (IsObjCLiteral)
Jordan Rose0e5badd2012-12-05 18:44:49 +0000530 return ArgType(Ctx.getPointerType(Ctx.UnsignedShortTy.withConst()),
531 "const unichar *");
Hans Wennborg1b231582014-09-04 21:39:52 +0000532 if (Ctx.getTargetInfo().getTriple().isOSMSVCRT() &&
533 LM.getKind() == LengthModifier::AsShort)
534 return ArgType::CStrTy;
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000535 return ArgType(ArgType::WCStrTy, "wchar_t *");
Ted Kremenek74a4ce72010-02-24 00:05:54 +0000536 case ConversionSpecifier::CArg:
Nico Weber496cdc22012-01-31 01:43:25 +0000537 if (IsObjCLiteral)
Jordan Rose0e5badd2012-12-05 18:44:49 +0000538 return ArgType(Ctx.UnsignedShortTy, "unichar");
Hans Wennborg1b231582014-09-04 21:39:52 +0000539 if (Ctx.getTargetInfo().getTriple().isOSMSVCRT() &&
540 LM.getKind() == LengthModifier::AsShort)
541 return Ctx.IntTy;
Hans Wennborg0d81e012013-05-10 10:08:40 +0000542 return ArgType(Ctx.WideCharTy, "wchar_t");
Ted Kremenek1ce32be2010-07-20 20:04:04 +0000543 case ConversionSpecifier::pArg:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000544 return ArgType::CPointerTy;
Ted Kremenek9b1f3d42012-01-25 00:04:09 +0000545 case ConversionSpecifier::ObjCObjArg:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000546 return ArgType::ObjCPointerTy;
Ted Kremenek74a4ce72010-02-24 00:05:54 +0000547 default:
548 break;
549 }
Ted Kremenek4a49d982010-02-26 19:18:41 +0000550
Ted Kremenek79db7b72010-01-29 22:59:32 +0000551 // FIXME: Handle other cases.
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000552 return ArgType();
Ted Kremenek79db7b72010-01-29 22:59:32 +0000553}
554
Hans Wennborgd99d6882012-02-15 09:59:46 +0000555bool PrintfSpecifier::fixType(QualType QT, const LangOptions &LangOpt,
556 ASTContext &Ctx, bool IsObjCLiteral) {
Hans Wennborgebcd1c72012-07-30 17:11:32 +0000557 // %n is different from other conversion specifiers; don't try to fix it.
558 if (CS.getKind() == ConversionSpecifier::nArg)
559 return false;
560
Jordan Rose68f6d3b2012-05-30 21:53:13 +0000561 // Handle Objective-C objects first. Note that while the '%@' specifier will
562 // not warn for structure pointer or void pointer arguments (because that's
563 // how CoreFoundation objects are implemented), we only show a fixit for '%@'
564 // if we know it's an object (block, id, class, or __attribute__((NSObject))).
565 if (QT->isObjCRetainableType()) {
566 if (!IsObjCLiteral)
567 return false;
568
569 CS.setKind(ConversionSpecifier::ObjCObjArg);
570
571 // Disable irrelevant flags
572 HasThousandsGrouping = false;
573 HasPlusPrefix = false;
574 HasSpacePrefix = false;
575 HasAlternativeForm = false;
576 HasLeadingZeroes = false;
577 Precision.setHowSpecified(OptionalAmount::NotSpecified);
578 LM.setKind(LengthModifier::None);
579
580 return true;
581 }
582
583 // Handle strings next (char *, wchar_t *)
Tom Careb7042702010-06-09 04:11:11 +0000584 if (QT->isPointerType() && (QT->getPointeeType()->isAnyCharacterType())) {
Ted Kremenek563e3ed2010-07-20 20:03:58 +0000585 CS.setKind(ConversionSpecifier::sArg);
Tom Careb7042702010-06-09 04:11:11 +0000586
Tom Care00554632010-06-11 04:22:02 +0000587 // Disable irrelevant flags
588 HasAlternativeForm = 0;
589 HasLeadingZeroes = 0;
590
Tom Careb7042702010-06-09 04:11:11 +0000591 // Set the long length modifier for wide characters
592 if (QT->getPointeeType()->isWideCharType())
593 LM.setKind(LengthModifier::AsWideChar);
Hans Wennborg2027de32011-12-09 10:51:29 +0000594 else
595 LM.setKind(LengthModifier::None);
Tom Careb7042702010-06-09 04:11:11 +0000596
597 return true;
598 }
599
Jordan Rose614e72b2012-06-04 22:49:02 +0000600 // If it's an enum, get its underlying type.
601 if (const EnumType *ETy = QT->getAs<EnumType>())
602 QT = ETy->getDecl()->getIntegerType();
603
Tom Careb7042702010-06-09 04:11:11 +0000604 // We can only work with builtin types.
Tom Careb7042702010-06-09 04:11:11 +0000605 const BuiltinType *BT = QT->getAs<BuiltinType>();
John McCall59207972011-10-18 22:28:37 +0000606 if (!BT)
607 return false;
Tom Care00554632010-06-11 04:22:02 +0000608
Tom Careb7042702010-06-09 04:11:11 +0000609 // Set length modifier
610 switch (BT->getKind()) {
Eli Friedman7ec652a2011-04-27 22:06:20 +0000611 case BuiltinType::Bool:
612 case BuiltinType::WChar_U:
613 case BuiltinType::WChar_S:
614 case BuiltinType::Char16:
615 case BuiltinType::Char32:
616 case BuiltinType::UInt128:
617 case BuiltinType::Int128:
Anton Korobeynikovf0c267e2011-10-14 23:23:15 +0000618 case BuiltinType::Half:
John McCall59207972011-10-18 22:28:37 +0000619 // Various types which are non-trivial to correct.
Eli Friedman7ec652a2011-04-27 22:06:20 +0000620 return false;
621
Alexey Bader954ba212016-04-08 13:40:33 +0000622#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
623 case BuiltinType::Id:
624#include "clang/AST/OpenCLImageTypes.def"
John McCall59207972011-10-18 22:28:37 +0000625#define SIGNED_TYPE(Id, SingletonId)
626#define UNSIGNED_TYPE(Id, SingletonId)
627#define FLOATING_TYPE(Id, SingletonId)
628#define BUILTIN_TYPE(Id, SingletonId) \
629 case BuiltinType::Id:
630#include "clang/AST/BuiltinTypes.def"
Eli Friedman7ec652a2011-04-27 22:06:20 +0000631 // Misc other stuff which doesn't make sense here.
632 return false;
633
634 case BuiltinType::UInt:
635 case BuiltinType::Int:
636 case BuiltinType::Float:
637 case BuiltinType::Double:
Tom Care00554632010-06-11 04:22:02 +0000638 LM.setKind(LengthModifier::None);
Tom Careb7042702010-06-09 04:11:11 +0000639 break;
Tom Care00554632010-06-11 04:22:02 +0000640
Ted Kremenek12a37de2010-10-21 04:00:58 +0000641 case BuiltinType::Char_U:
642 case BuiltinType::UChar:
643 case BuiltinType::Char_S:
644 case BuiltinType::SChar:
645 LM.setKind(LengthModifier::AsChar);
646 break;
647
648 case BuiltinType::Short:
649 case BuiltinType::UShort:
650 LM.setKind(LengthModifier::AsShort);
651 break;
652
Tom Careb7042702010-06-09 04:11:11 +0000653 case BuiltinType::Long:
654 case BuiltinType::ULong:
655 LM.setKind(LengthModifier::AsLong);
656 break;
657
658 case BuiltinType::LongLong:
659 case BuiltinType::ULongLong:
660 LM.setKind(LengthModifier::AsLongLong);
661 break;
662
663 case BuiltinType::LongDouble:
664 LM.setKind(LengthModifier::AsLongDouble);
665 break;
666 }
667
Hans Wennborgf99d04f2011-10-18 08:10:06 +0000668 // Handle size_t, ptrdiff_t, etc. that have dedicated length modifiers in C99.
Richard Smith2bf7fdb2013-01-02 11:42:31 +0000669 if (isa<TypedefType>(QT) && (LangOpt.C99 || LangOpt.CPlusPlus11))
Hans Wennborg08574d32012-07-27 19:17:46 +0000670 namedTypeToLengthModifier(QT, LM);
Hans Wennborgf99d04f2011-10-18 08:10:06 +0000671
Jordan Roseaa7a3b32013-01-17 18:47:16 +0000672 // If fixing the length modifier was enough, we might be done.
Jordan Rose92303592012-09-08 04:00:03 +0000673 if (hasValidLengthModifier(Ctx.getTargetInfo())) {
Jordan Roseaa7a3b32013-01-17 18:47:16 +0000674 // If we're going to offer a fix anyway, make sure the sign matches.
675 switch (CS.getKind()) {
676 case ConversionSpecifier::uArg:
677 case ConversionSpecifier::UArg:
678 if (QT->isSignedIntegerType())
679 CS.setKind(clang::analyze_format_string::ConversionSpecifier::dArg);
680 break;
681 case ConversionSpecifier::dArg:
682 case ConversionSpecifier::DArg:
683 case ConversionSpecifier::iArg:
Jordan Rose1eb34292013-01-17 22:34:10 +0000684 if (QT->isUnsignedIntegerType() && !HasPlusPrefix)
Jordan Roseaa7a3b32013-01-17 18:47:16 +0000685 CS.setKind(clang::analyze_format_string::ConversionSpecifier::uArg);
686 break;
687 default:
688 // Other specifiers do not have signed/unsigned variants.
689 break;
690 }
691
Jordan Rose92303592012-09-08 04:00:03 +0000692 const analyze_printf::ArgType &ATR = getArgType(Ctx, IsObjCLiteral);
693 if (ATR.isValid() && ATR.matchesType(Ctx, QT))
694 return true;
695 }
Hans Wennborgd99d6882012-02-15 09:59:46 +0000696
Tom Careb7042702010-06-09 04:11:11 +0000697 // Set conversion specifier and disable any flags which do not apply to it.
Ted Kremenek12a37de2010-10-21 04:00:58 +0000698 // Let typedefs to char fall through to int, as %c is silly for uint8_t.
Jordan Rose6aaa87e2012-12-05 18:44:37 +0000699 if (!isa<TypedefType>(QT) && QT->isCharType()) {
Ted Kremenekab0fe8a2010-07-20 20:03:49 +0000700 CS.setKind(ConversionSpecifier::cArg);
Ted Kremenek12a37de2010-10-21 04:00:58 +0000701 LM.setKind(LengthModifier::None);
Tom Careb7042702010-06-09 04:11:11 +0000702 Precision.setHowSpecified(OptionalAmount::NotSpecified);
703 HasAlternativeForm = 0;
704 HasLeadingZeroes = 0;
Tom Careb49ec692010-06-17 19:00:27 +0000705 HasPlusPrefix = 0;
Tom Careb7042702010-06-09 04:11:11 +0000706 }
707 // Test for Floating type first as LongDouble can pass isUnsignedIntegerType
Douglas Gregor49b4d732010-06-22 23:07:26 +0000708 else if (QT->isRealFloatingType()) {
Tom Careb7042702010-06-09 04:11:11 +0000709 CS.setKind(ConversionSpecifier::fArg);
710 }
Tom Careb7042702010-06-09 04:11:11 +0000711 else if (QT->isSignedIntegerType()) {
712 CS.setKind(ConversionSpecifier::dArg);
713 HasAlternativeForm = 0;
714 }
Douglas Gregorb4e3533ce2010-06-09 05:25:34 +0000715 else if (QT->isUnsignedIntegerType()) {
Hans Wennborgd99d6882012-02-15 09:59:46 +0000716 CS.setKind(ConversionSpecifier::uArg);
Tom Careb7042702010-06-09 04:11:11 +0000717 HasAlternativeForm = 0;
Tom Careb49ec692010-06-17 19:00:27 +0000718 HasPlusPrefix = 0;
Chad Rosier6fdf38b2011-08-17 23:08:45 +0000719 } else {
David Blaikie83d382b2011-09-23 05:06:16 +0000720 llvm_unreachable("Unexpected type");
Tom Careb7042702010-06-09 04:11:11 +0000721 }
722
723 return true;
724}
725
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000726void PrintfSpecifier::toString(raw_ostream &os) const {
Tom Careb7042702010-06-09 04:11:11 +0000727 // Whilst some features have no defined order, we are using the order
NAKAMURA Takumi7c288862011-01-27 07:09:49 +0000728 // appearing in the C99 standard (ISO/IEC 9899:1999 (E) 7.19.6.1)
Tom Careb7042702010-06-09 04:11:11 +0000729 os << "%";
730
731 // Positional args
732 if (usesPositionalArg()) {
733 os << getPositionalArgIndex() << "$";
734 }
735
736 // Conversion flags
737 if (IsLeftJustified) os << "-";
738 if (HasPlusPrefix) os << "+";
739 if (HasSpacePrefix) os << " ";
740 if (HasAlternativeForm) os << "#";
741 if (HasLeadingZeroes) os << "0";
742
743 // Minimum field width
744 FieldWidth.toString(os);
745 // Precision
746 Precision.toString(os);
747 // Length modifier
748 os << LM.toString();
749 // Conversion specifier
750 os << CS.toString();
751}
Tom Careb49ec692010-06-17 19:00:27 +0000752
Ted Kremenek02087932010-07-16 02:11:22 +0000753bool PrintfSpecifier::hasValidPlusPrefix() const {
Tom Careb49ec692010-06-17 19:00:27 +0000754 if (!HasPlusPrefix)
755 return true;
756
757 // The plus prefix only makes sense for signed conversions
758 switch (CS.getKind()) {
759 case ConversionSpecifier::dArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000760 case ConversionSpecifier::DArg:
Tom Careb49ec692010-06-17 19:00:27 +0000761 case ConversionSpecifier::iArg:
762 case ConversionSpecifier::fArg:
763 case ConversionSpecifier::FArg:
764 case ConversionSpecifier::eArg:
765 case ConversionSpecifier::EArg:
766 case ConversionSpecifier::gArg:
767 case ConversionSpecifier::GArg:
768 case ConversionSpecifier::aArg:
769 case ConversionSpecifier::AArg:
Dimitry Andric6b5ed342015-02-19 22:32:33 +0000770 case ConversionSpecifier::FreeBSDrArg:
771 case ConversionSpecifier::FreeBSDyArg:
Tom Careb49ec692010-06-17 19:00:27 +0000772 return true;
773
774 default:
775 return false;
776 }
777}
778
Ted Kremenek02087932010-07-16 02:11:22 +0000779bool PrintfSpecifier::hasValidAlternativeForm() const {
Tom Careb49ec692010-06-17 19:00:27 +0000780 if (!HasAlternativeForm)
781 return true;
782
Anders Carlssona369f8d2010-11-21 18:34:21 +0000783 // Alternate form flag only valid with the oxXaAeEfFgG conversions
Tom Careb49ec692010-06-17 19:00:27 +0000784 switch (CS.getKind()) {
785 case ConversionSpecifier::oArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000786 case ConversionSpecifier::OArg:
Tom Careb49ec692010-06-17 19:00:27 +0000787 case ConversionSpecifier::xArg:
Anders Carlssona369f8d2010-11-21 18:34:21 +0000788 case ConversionSpecifier::XArg:
Tom Careb49ec692010-06-17 19:00:27 +0000789 case ConversionSpecifier::aArg:
790 case ConversionSpecifier::AArg:
791 case ConversionSpecifier::eArg:
792 case ConversionSpecifier::EArg:
793 case ConversionSpecifier::fArg:
794 case ConversionSpecifier::FArg:
795 case ConversionSpecifier::gArg:
796 case ConversionSpecifier::GArg:
Dimitry Andric6b5ed342015-02-19 22:32:33 +0000797 case ConversionSpecifier::FreeBSDrArg:
798 case ConversionSpecifier::FreeBSDyArg:
Tom Careb49ec692010-06-17 19:00:27 +0000799 return true;
800
801 default:
802 return false;
803 }
804}
805
Ted Kremenek02087932010-07-16 02:11:22 +0000806bool PrintfSpecifier::hasValidLeadingZeros() const {
Tom Careb49ec692010-06-17 19:00:27 +0000807 if (!HasLeadingZeroes)
808 return true;
809
810 // Leading zeroes flag only valid with the diouxXaAeEfFgG conversions
811 switch (CS.getKind()) {
812 case ConversionSpecifier::dArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000813 case ConversionSpecifier::DArg:
Tom Careb49ec692010-06-17 19:00:27 +0000814 case ConversionSpecifier::iArg:
815 case ConversionSpecifier::oArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000816 case ConversionSpecifier::OArg:
Tom Careb49ec692010-06-17 19:00:27 +0000817 case ConversionSpecifier::uArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000818 case ConversionSpecifier::UArg:
Tom Careb49ec692010-06-17 19:00:27 +0000819 case ConversionSpecifier::xArg:
820 case ConversionSpecifier::XArg:
821 case ConversionSpecifier::aArg:
822 case ConversionSpecifier::AArg:
823 case ConversionSpecifier::eArg:
824 case ConversionSpecifier::EArg:
825 case ConversionSpecifier::fArg:
826 case ConversionSpecifier::FArg:
827 case ConversionSpecifier::gArg:
828 case ConversionSpecifier::GArg:
Dimitry Andric6b5ed342015-02-19 22:32:33 +0000829 case ConversionSpecifier::FreeBSDrArg:
830 case ConversionSpecifier::FreeBSDyArg:
Tom Careb49ec692010-06-17 19:00:27 +0000831 return true;
832
833 default:
834 return false;
835 }
836}
837
Ted Kremenek02087932010-07-16 02:11:22 +0000838bool PrintfSpecifier::hasValidSpacePrefix() const {
Tom Careb49ec692010-06-17 19:00:27 +0000839 if (!HasSpacePrefix)
840 return true;
841
842 // The space prefix only makes sense for signed conversions
843 switch (CS.getKind()) {
844 case ConversionSpecifier::dArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000845 case ConversionSpecifier::DArg:
Tom Careb49ec692010-06-17 19:00:27 +0000846 case ConversionSpecifier::iArg:
847 case ConversionSpecifier::fArg:
848 case ConversionSpecifier::FArg:
849 case ConversionSpecifier::eArg:
850 case ConversionSpecifier::EArg:
851 case ConversionSpecifier::gArg:
852 case ConversionSpecifier::GArg:
853 case ConversionSpecifier::aArg:
854 case ConversionSpecifier::AArg:
Dimitry Andric6b5ed342015-02-19 22:32:33 +0000855 case ConversionSpecifier::FreeBSDrArg:
856 case ConversionSpecifier::FreeBSDyArg:
Tom Careb49ec692010-06-17 19:00:27 +0000857 return true;
858
859 default:
860 return false;
861 }
862}
863
Ted Kremenek02087932010-07-16 02:11:22 +0000864bool PrintfSpecifier::hasValidLeftJustified() const {
Tom Careb49ec692010-06-17 19:00:27 +0000865 if (!IsLeftJustified)
866 return true;
867
868 // The left justified flag is valid for all conversions except n
869 switch (CS.getKind()) {
Ted Kremenek516ef222010-07-20 20:04:10 +0000870 case ConversionSpecifier::nArg:
Tom Careb49ec692010-06-17 19:00:27 +0000871 return false;
872
873 default:
874 return true;
875 }
876}
877
Ted Kremenekbf4832c2011-01-08 05:28:46 +0000878bool PrintfSpecifier::hasValidThousandsGroupingPrefix() const {
879 if (!HasThousandsGrouping)
880 return true;
NAKAMURA Takumif9cbcc42011-01-27 07:10:08 +0000881
Ted Kremenekbf4832c2011-01-08 05:28:46 +0000882 switch (CS.getKind()) {
883 case ConversionSpecifier::dArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000884 case ConversionSpecifier::DArg:
Ted Kremenekbf4832c2011-01-08 05:28:46 +0000885 case ConversionSpecifier::iArg:
886 case ConversionSpecifier::uArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000887 case ConversionSpecifier::UArg:
Ted Kremenekbf4832c2011-01-08 05:28:46 +0000888 case ConversionSpecifier::fArg:
889 case ConversionSpecifier::FArg:
890 case ConversionSpecifier::gArg:
891 case ConversionSpecifier::GArg:
892 return true;
893 default:
894 return false;
895 }
896}
897
Ted Kremenek02087932010-07-16 02:11:22 +0000898bool PrintfSpecifier::hasValidPrecision() const {
Tom Careb49ec692010-06-17 19:00:27 +0000899 if (Precision.getHowSpecified() == OptionalAmount::NotSpecified)
900 return true;
901
902 // Precision is only valid with the diouxXaAeEfFgGs conversions
903 switch (CS.getKind()) {
904 case ConversionSpecifier::dArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000905 case ConversionSpecifier::DArg:
Tom Careb49ec692010-06-17 19:00:27 +0000906 case ConversionSpecifier::iArg:
907 case ConversionSpecifier::oArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000908 case ConversionSpecifier::OArg:
Tom Careb49ec692010-06-17 19:00:27 +0000909 case ConversionSpecifier::uArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000910 case ConversionSpecifier::UArg:
Tom Careb49ec692010-06-17 19:00:27 +0000911 case ConversionSpecifier::xArg:
912 case ConversionSpecifier::XArg:
913 case ConversionSpecifier::aArg:
914 case ConversionSpecifier::AArg:
915 case ConversionSpecifier::eArg:
916 case ConversionSpecifier::EArg:
917 case ConversionSpecifier::fArg:
918 case ConversionSpecifier::FArg:
919 case ConversionSpecifier::gArg:
920 case ConversionSpecifier::GArg:
Ted Kremenek563e3ed2010-07-20 20:03:58 +0000921 case ConversionSpecifier::sArg:
Dimitry Andric6b5ed342015-02-19 22:32:33 +0000922 case ConversionSpecifier::FreeBSDrArg:
923 case ConversionSpecifier::FreeBSDyArg:
Tom Careb49ec692010-06-17 19:00:27 +0000924 return true;
925
926 default:
927 return false;
928 }
929}
Ted Kremenek02087932010-07-16 02:11:22 +0000930bool PrintfSpecifier::hasValidFieldWidth() const {
Tom Careb49ec692010-06-17 19:00:27 +0000931 if (FieldWidth.getHowSpecified() == OptionalAmount::NotSpecified)
932 return true;
933
934 // The field width is valid for all conversions except n
935 switch (CS.getKind()) {
Ted Kremenek516ef222010-07-20 20:04:10 +0000936 case ConversionSpecifier::nArg:
Tom Careb49ec692010-06-17 19:00:27 +0000937 return false;
938
939 default:
940 return true;
941 }
942}