blob: 146635b887029b63ec604aaa38202b13104c8240 [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 Kremenek02087932010-07-16 02:11:22 +000052static PrintfSpecifierResult ParsePrintfSpecifier(FormatStringHandler &H,
Ted Kremenek1de17072010-02-04 20:46:58 +000053 const char *&Beg,
Ted Kremenek4a49d982010-02-26 19:18:41 +000054 const char *E,
Hans Wennborg23926bd2011-12-15 10:25:47 +000055 unsigned &argIndex,
Jordan Rose510260c2012-09-13 02:11:03 +000056 const LangOptions &LO,
Fariborz Jahanian6485fe42014-09-09 23:10:54 +000057 const TargetInfo &Target,
58 bool Warn) {
Ted Kremenekc8b188d2010-02-16 01:46:59 +000059
Ted Kremenekf03e6d852010-07-20 20:04:27 +000060 using namespace clang::analyze_format_string;
Ted Kremenek176f7d62010-01-29 02:13:53 +000061 using namespace clang::analyze_printf;
Ted Kremenekc8b188d2010-02-16 01:46:59 +000062
Ted Kremeneka2e77b42010-01-27 23:43:25 +000063 const char *I = Beg;
Craig Topper25542942014-05-20 04:30:07 +000064 const char *Start = nullptr;
Ted Kremeneka2e77b42010-01-27 23:43:25 +000065 UpdateOnReturn <const char*> UpdateBeg(Beg, I);
66
67 // Look for a '%' character that indicates the start of a format specifier.
Ted Kremenekb5c98ef2010-01-28 23:56:52 +000068 for ( ; I != E ; ++I) {
Ted Kremeneka2e77b42010-01-27 23:43:25 +000069 char c = *I;
Ted Kremeneka2e77b42010-01-27 23:43:25 +000070 if (c == '\0') {
71 // Detect spurious null characters, which are likely errors.
72 H.HandleNullChar(I);
73 return true;
74 }
75 if (c == '%') {
Ted Kremenekb5c98ef2010-01-28 23:56:52 +000076 Start = I++; // Record the start of the format specifier.
Ted Kremeneka2e77b42010-01-27 23:43:25 +000077 break;
78 }
79 }
Ted Kremenekc8b188d2010-02-16 01:46:59 +000080
Ted Kremeneka2e77b42010-01-27 23:43:25 +000081 // No format specifier found?
82 if (!Start)
83 return false;
Ted Kremenekc8b188d2010-02-16 01:46:59 +000084
Ted Kremeneka2e77b42010-01-27 23:43:25 +000085 if (I == E) {
86 // No more characters left?
Fariborz Jahanian6485fe42014-09-09 23:10:54 +000087 if (Warn)
88 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremeneka2e77b42010-01-27 23:43:25 +000089 return true;
90 }
Ted Kremenekc8b188d2010-02-16 01:46:59 +000091
Ted Kremenek02087932010-07-16 02:11:22 +000092 PrintfSpecifier FS;
Ted Kremenekd1668192010-02-27 01:41:03 +000093 if (ParseArgPosition(H, FS, Start, I, E))
94 return true;
95
96 if (I == E) {
97 // No more characters left?
Fariborz Jahanian6485fe42014-09-09 23:10:54 +000098 if (Warn)
99 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremenekd1668192010-02-27 01:41:03 +0000100 return true;
101 }
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000102
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000103 // Look for flags (if any).
104 bool hasMore = true;
105 for ( ; I != E; ++I) {
106 switch (*I) {
107 default: hasMore = false; break;
NAKAMURA Takumif9cbcc42011-01-27 07:10:08 +0000108 case '\'':
Ted Kremeneka322cae2011-01-08 05:28:38 +0000109 // FIXME: POSIX specific. Always accept?
110 FS.setHasThousandsGrouping(I);
111 break;
Tom Careb49ec692010-06-17 19:00:27 +0000112 case '-': FS.setIsLeftJustified(I); break;
113 case '+': FS.setHasPlusPrefix(I); break;
114 case ' ': FS.setHasSpacePrefix(I); break;
115 case '#': FS.setHasAlternativeForm(I); break;
116 case '0': FS.setHasLeadingZeros(I); break;
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000117 }
118 if (!hasMore)
119 break;
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000120 }
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000121
122 if (I == E) {
123 // No more characters left?
Fariborz Jahanian6485fe42014-09-09 23:10:54 +0000124 if (Warn)
125 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000126 return true;
127 }
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000128
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000129 // Look for the field width (if any).
Ted Kremenekd1668192010-02-27 01:41:03 +0000130 if (ParseFieldWidth(H, FS, Start, I, E,
Craig Topper25542942014-05-20 04:30:07 +0000131 FS.usesPositionalArg() ? nullptr : &argIndex))
Ted Kremenekd1668192010-02-27 01:41:03 +0000132 return true;
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000133
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000134 if (I == E) {
135 // No more characters left?
Fariborz Jahanian6485fe42014-09-09 23:10:54 +0000136 if (Warn)
137 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000138 return true;
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000139 }
140
141 // Look for the precision (if any).
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000142 if (*I == '.') {
Ted Kremenekc22f78d2010-01-29 03:16:21 +0000143 ++I;
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000144 if (I == E) {
Fariborz Jahanian6485fe42014-09-09 23:10:54 +0000145 if (Warn)
146 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000147 return true;
148 }
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000149
Ted Kremenekd1668192010-02-27 01:41:03 +0000150 if (ParsePrecision(H, FS, Start, I, E,
Craig Topper25542942014-05-20 04:30:07 +0000151 FS.usesPositionalArg() ? nullptr : &argIndex))
Ted Kremenekd1668192010-02-27 01:41:03 +0000152 return true;
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000153
154 if (I == E) {
155 // No more characters left?
Fariborz Jahanian6485fe42014-09-09 23:10:54 +0000156 if (Warn)
157 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000158 return true;
159 }
160 }
161
162 // Look for the length modifier.
Hans Wennborg23926bd2011-12-15 10:25:47 +0000163 if (ParseLengthModifier(FS, I, E, LO) && I == E) {
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000164 // No more characters left?
Fariborz Jahanian6485fe42014-09-09 23:10:54 +0000165 if (Warn)
166 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000167 return true;
168 }
Ted Kremenek2a0cd592010-02-09 00:04:09 +0000169
Ted Kremenek23a71a12010-01-29 20:29:53 +0000170 if (*I == '\0') {
Ted Kremenek2a0cd592010-02-09 00:04:09 +0000171 // Detect spurious null characters, which are likely errors.
172 H.HandleNullChar(I);
173 return true;
Ted Kremenek23a71a12010-01-29 20:29:53 +0000174 }
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000175
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000176 // Finally, look for the conversion specifier.
Ted Kremenekfee0e962010-01-28 02:46:17 +0000177 const char *conversionPosition = I++;
Ted Kremenek94af5752010-01-29 02:40:24 +0000178 ConversionSpecifier::Kind k = ConversionSpecifier::InvalidSpecifier;
Ted Kremenekfee0e962010-01-28 02:46:17 +0000179 switch (*conversionPosition) {
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000180 default:
Ted Kremenek94af5752010-01-29 02:40:24 +0000181 break;
Ted Kremenekc06ead62010-01-28 00:55:28 +0000182 // C99: 7.19.6.1 (section 8).
Ted Kremenek74a4ce72010-02-24 00:05:54 +0000183 case '%': k = ConversionSpecifier::PercentArg; break;
184 case 'A': k = ConversionSpecifier::AArg; break;
185 case 'E': k = ConversionSpecifier::EArg; break;
186 case 'F': k = ConversionSpecifier::FArg; break;
187 case 'G': k = ConversionSpecifier::GArg; break;
188 case 'X': k = ConversionSpecifier::XArg; break;
189 case 'a': k = ConversionSpecifier::aArg; break;
Ted Kremenekab0fe8a2010-07-20 20:03:49 +0000190 case 'c': k = ConversionSpecifier::cArg; break;
Ted Kremenekfee0e962010-01-28 02:46:17 +0000191 case 'd': k = ConversionSpecifier::dArg; break;
Ted Kremenek74a4ce72010-02-24 00:05:54 +0000192 case 'e': k = ConversionSpecifier::eArg; break;
193 case 'f': k = ConversionSpecifier::fArg; break;
194 case 'g': k = ConversionSpecifier::gArg; break;
Ted Kremenekfee0e962010-01-28 02:46:17 +0000195 case 'i': k = ConversionSpecifier::iArg; break;
Ted Kremenek516ef222010-07-20 20:04:10 +0000196 case 'n': k = ConversionSpecifier::nArg; break;
Ted Kremenekfee0e962010-01-28 02:46:17 +0000197 case 'o': k = ConversionSpecifier::oArg; break;
David Majnemer3cba4952013-08-21 21:54:46 +0000198 case 'p': k = ConversionSpecifier::pArg; break;
199 case 's': k = ConversionSpecifier::sArg; break;
Ted Kremenekfee0e962010-01-28 02:46:17 +0000200 case 'u': k = ConversionSpecifier::uArg; break;
201 case 'x': k = ConversionSpecifier::xArg; break;
Ted Kremeneka322cae2011-01-08 05:28:38 +0000202 // POSIX specific.
Ted Kremenek74a4ce72010-02-24 00:05:54 +0000203 case 'C': k = ConversionSpecifier::CArg; break;
Ted Kremenek348d1492010-07-20 20:04:15 +0000204 case 'S': k = ConversionSpecifier::SArg; break;
Ted Kremenekc06ead62010-01-28 00:55:28 +0000205 // Objective-C.
Ted Kremenek23a71a12010-01-29 20:29:53 +0000206 case '@': k = ConversionSpecifier::ObjCObjArg; break;
Ted Kremenek2a0cd592010-02-09 00:04:09 +0000207 // Glibc specific.
Ted Kremenek23a71a12010-01-29 20:29:53 +0000208 case 'm': k = ConversionSpecifier::PrintErrno; break;
Hans Wennborgc597b4c2014-09-07 03:03:51 +0000209 // Apple-specific.
Jordan Rose510260c2012-09-13 02:11:03 +0000210 case 'D':
211 if (Target.getTriple().isOSDarwin())
212 k = ConversionSpecifier::DArg;
213 break;
214 case 'O':
215 if (Target.getTriple().isOSDarwin())
216 k = ConversionSpecifier::OArg;
217 break;
218 case 'U':
219 if (Target.getTriple().isOSDarwin())
220 k = ConversionSpecifier::UArg;
221 break;
Hans Wennborgc597b4c2014-09-07 03:03:51 +0000222 // MS specific.
223 case 'Z':
224 if (Target.getTriple().isOSMSVCRT())
225 k = ConversionSpecifier::ZArg;
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000226 }
Ted Kremenekf03e6d852010-07-20 20:04:27 +0000227 PrintfConversionSpecifier CS(conversionPosition, k);
Ted Kremenek4a49d982010-02-26 19:18:41 +0000228 FS.setConversionSpecifier(CS);
Ted Kremenekd1668192010-02-27 01:41:03 +0000229 if (CS.consumesDataArgument() && !FS.usesPositionalArg())
Ted Kremenek4a49d982010-02-26 19:18:41 +0000230 FS.setArgIndex(argIndex++);
Ted Kremenek94af5752010-01-29 02:40:24 +0000231
232 if (k == ConversionSpecifier::InvalidSpecifier) {
Ted Kremenek4a49d982010-02-26 19:18:41 +0000233 // Assume the conversion takes one argument.
Ted Kremenek9e618ed2010-12-02 20:57:51 +0000234 return !H.HandleInvalidPrintfConversionSpecifier(FS, Start, I - Start);
Ted Kremenek94af5752010-01-29 02:40:24 +0000235 }
Ted Kremenek02087932010-07-16 02:11:22 +0000236 return PrintfSpecifierResult(Start, FS);
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000237}
238
Ted Kremenek02087932010-07-16 02:11:22 +0000239bool clang::analyze_format_string::ParsePrintfString(FormatStringHandler &H,
240 const char *I,
Hans Wennborg23926bd2011-12-15 10:25:47 +0000241 const char *E,
Jordan Rose510260c2012-09-13 02:11:03 +0000242 const LangOptions &LO,
243 const TargetInfo &Target) {
Ted Kremenek4a49d982010-02-26 19:18:41 +0000244
245 unsigned argIndex = 0;
246
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000247 // Keep looking for a format specifier until we have exhausted the string.
248 while (I != E) {
Hans Wennborg23926bd2011-12-15 10:25:47 +0000249 const PrintfSpecifierResult &FSR = ParsePrintfSpecifier(H, I, E, argIndex,
Fariborz Jahanian6485fe42014-09-09 23:10:54 +0000250 LO, Target, true);
Ted Kremenek94af5752010-01-29 02:40:24 +0000251 // Did a fail-stop error of any kind occur when parsing the specifier?
252 // If so, don't do any more processing.
253 if (FSR.shouldStop())
Dmitri Gribenko76bb5cabfa2012-09-10 21:20:09 +0000254 return true;
Ted Kremenek94af5752010-01-29 02:40:24 +0000255 // Did we exhaust the string or encounter an error that
256 // we can recover from?
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000257 if (!FSR.hasValue())
Ted Kremenek94af5752010-01-29 02:40:24 +0000258 continue;
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000259 // We have a format specifier. Pass it to the callback.
Ted Kremenek02087932010-07-16 02:11:22 +0000260 if (!H.HandlePrintfSpecifier(FSR.getValue(), FSR.getStart(),
Ted Kremenekfee0e962010-01-28 02:46:17 +0000261 I - FSR.getStart()))
Ted Kremenek23a71a12010-01-29 20:29:53 +0000262 return true;
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000263 }
264 assert(I == E && "Format string not exhausted");
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000265 return false;
266}
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000267
Fariborz Jahanian6485fe42014-09-09 23:10:54 +0000268bool clang::analyze_format_string::ParseFormatStringHasSArg(const char *I,
269 const char *E,
270 const LangOptions &LO,
271 const TargetInfo &Target) {
272
273 unsigned argIndex = 0;
274
275 // Keep looking for a %s format specifier until we have exhausted the string.
276 FormatStringHandler H;
277 while (I != E) {
278 const PrintfSpecifierResult &FSR = ParsePrintfSpecifier(H, I, E, argIndex,
279 LO, Target, false);
280 // Did a fail-stop error of any kind occur when parsing the specifier?
281 // If so, don't do any more processing.
282 if (FSR.shouldStop())
283 return false;
284 // Did we exhaust the string or encounter an error that
285 // we can recover from?
286 if (!FSR.hasValue())
287 continue;
288 const analyze_printf::PrintfSpecifier &FS = FSR.getValue();
289 // Return true if this a %s format specifier.
290 if (FS.getConversionSpecifier().getKind() == ConversionSpecifier::Kind::sArg)
291 return true;
292 }
293 return false;
294}
295
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000296//===----------------------------------------------------------------------===//
Ted Kremenek02087932010-07-16 02:11:22 +0000297// Methods on PrintfSpecifier.
Tom Careb7042702010-06-09 04:11:11 +0000298//===----------------------------------------------------------------------===//
299
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000300ArgType PrintfSpecifier::getArgType(ASTContext &Ctx,
301 bool IsObjCLiteral) const {
Ted Kremenekf03e6d852010-07-20 20:04:27 +0000302 const PrintfConversionSpecifier &CS = getConversionSpecifier();
NAKAMURA Takumif9cbcc42011-01-27 07:10:08 +0000303
Ted Kremenek79db7b72010-01-29 22:59:32 +0000304 if (!CS.consumesDataArgument())
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000305 return ArgType::Invalid();
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000306
Ted Kremenek5f0c0662010-08-24 22:24:51 +0000307 if (CS.getKind() == ConversionSpecifier::cArg)
308 switch (LM.getKind()) {
Hans Wennborg1b231582014-09-04 21:39:52 +0000309 case LengthModifier::None:
310 return Ctx.IntTy;
Hans Wennborga5b1aa92011-12-09 12:22:12 +0000311 case LengthModifier::AsLong:
Hans Wennborg68f42b92014-09-04 21:39:46 +0000312 case LengthModifier::AsWide:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000313 return ArgType(ArgType::WIntTy, "wint_t");
Hans Wennborg1b231582014-09-04 21:39:52 +0000314 case LengthModifier::AsShort:
315 if (Ctx.getTargetInfo().getTriple().isOSMSVCRT())
316 return Ctx.IntTy;
Ted Kremenek5f0c0662010-08-24 22:24:51 +0000317 default:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000318 return ArgType::Invalid();
Ted Kremenek5f0c0662010-08-24 22:24:51 +0000319 }
NAKAMURA Takumif9cbcc42011-01-27 07:10:08 +0000320
Ted Kremenek79db7b72010-01-29 22:59:32 +0000321 if (CS.isIntArg())
Tom Careb7042702010-06-09 04:11:11 +0000322 switch (LM.getKind()) {
323 case LengthModifier::AsLongDouble:
Ted Kremenek6fa57272012-01-24 21:29:54 +0000324 // GNU extension.
325 return Ctx.LongLongTy;
David Majnemer3cba4952013-08-21 21:54:46 +0000326 case LengthModifier::None:
327 return Ctx.IntTy;
328 case LengthModifier::AsInt32:
329 return ArgType(Ctx.IntTy, "__int32");
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000330 case LengthModifier::AsChar: return ArgType::AnyCharTy;
Tom Careb7042702010-06-09 04:11:11 +0000331 case LengthModifier::AsShort: return Ctx.ShortTy;
332 case LengthModifier::AsLong: return Ctx.LongTy;
Hans Wennborg9bc9bcc2012-02-16 16:34:54 +0000333 case LengthModifier::AsLongLong:
334 case LengthModifier::AsQuad:
335 return Ctx.LongLongTy;
David Majnemer3cba4952013-08-21 21:54:46 +0000336 case LengthModifier::AsInt64:
337 return ArgType(Ctx.LongLongTy, "__int64");
Hans Wennborg772e9272011-12-07 10:33:11 +0000338 case LengthModifier::AsIntMax:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000339 return ArgType(Ctx.getIntMaxType(), "intmax_t");
Hans Wennborg27541db2011-10-27 08:29:09 +0000340 case LengthModifier::AsSizeT:
341 // FIXME: How to get the corresponding signed version of size_t?
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000342 return ArgType();
David Majnemer3cba4952013-08-21 21:54:46 +0000343 case LengthModifier::AsInt3264:
David Majnemera39da8e2013-08-22 07:53:21 +0000344 return Ctx.getTargetInfo().getTriple().isArch64Bit()
345 ? ArgType(Ctx.LongLongTy, "__int64")
346 : ArgType(Ctx.IntTy, "__int32");
Hans Wennborg772e9272011-12-07 10:33:11 +0000347 case LengthModifier::AsPtrDiff:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000348 return ArgType(Ctx.getPointerDiffType(), "ptrdiff_t");
Hans Wennborg23926bd2011-12-15 10:25:47 +0000349 case LengthModifier::AsAllocate:
Hans Wennborg6073e312012-01-12 17:11:12 +0000350 case LengthModifier::AsMAllocate:
Hans Wennborg68f42b92014-09-04 21:39:46 +0000351 case LengthModifier::AsWide:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000352 return ArgType::Invalid();
Ted Kremenek79db7b72010-01-29 22:59:32 +0000353 }
354
355 if (CS.isUIntArg())
Tom Careb7042702010-06-09 04:11:11 +0000356 switch (LM.getKind()) {
357 case LengthModifier::AsLongDouble:
Ted Kremenek6fa57272012-01-24 21:29:54 +0000358 // GNU extension.
359 return Ctx.UnsignedLongLongTy;
David Majnemer3cba4952013-08-21 21:54:46 +0000360 case LengthModifier::None:
361 return Ctx.UnsignedIntTy;
362 case LengthModifier::AsInt32:
363 return ArgType(Ctx.UnsignedIntTy, "unsigned __int32");
Tom Careb7042702010-06-09 04:11:11 +0000364 case LengthModifier::AsChar: return Ctx.UnsignedCharTy;
365 case LengthModifier::AsShort: return Ctx.UnsignedShortTy;
366 case LengthModifier::AsLong: return Ctx.UnsignedLongTy;
Hans Wennborg9bc9bcc2012-02-16 16:34:54 +0000367 case LengthModifier::AsLongLong:
368 case LengthModifier::AsQuad:
369 return Ctx.UnsignedLongLongTy;
David Majnemer3cba4952013-08-21 21:54:46 +0000370 case LengthModifier::AsInt64:
371 return ArgType(Ctx.UnsignedLongLongTy, "unsigned __int64");
Hans Wennborg772e9272011-12-07 10:33:11 +0000372 case LengthModifier::AsIntMax:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000373 return ArgType(Ctx.getUIntMaxType(), "uintmax_t");
Tom Careb7042702010-06-09 04:11:11 +0000374 case LengthModifier::AsSizeT:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000375 return ArgType(Ctx.getSizeType(), "size_t");
David Majnemer3cba4952013-08-21 21:54:46 +0000376 case LengthModifier::AsInt3264:
377 return Ctx.getTargetInfo().getTriple().isArch64Bit()
David Majnemera39da8e2013-08-22 07:53:21 +0000378 ? ArgType(Ctx.UnsignedLongLongTy, "unsigned __int64")
379 : ArgType(Ctx.UnsignedIntTy, "unsigned __int32");
Tom Careb7042702010-06-09 04:11:11 +0000380 case LengthModifier::AsPtrDiff:
Ted Kremenek79db7b72010-01-29 22:59:32 +0000381 // FIXME: How to get the corresponding unsigned
382 // version of ptrdiff_t?
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000383 return ArgType();
Hans Wennborg23926bd2011-12-15 10:25:47 +0000384 case LengthModifier::AsAllocate:
Hans Wennborg6073e312012-01-12 17:11:12 +0000385 case LengthModifier::AsMAllocate:
Hans Wennborg68f42b92014-09-04 21:39:46 +0000386 case LengthModifier::AsWide:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000387 return ArgType::Invalid();
Ted Kremenek79db7b72010-01-29 22:59:32 +0000388 }
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000389
Ted Kremenek016b6052010-02-01 23:23:50 +0000390 if (CS.isDoubleArg()) {
Tom Careb7042702010-06-09 04:11:11 +0000391 if (LM.getKind() == LengthModifier::AsLongDouble)
Ted Kremenek016b6052010-02-01 23:23:50 +0000392 return Ctx.LongDoubleTy;
Ted Kremenek9ff02052010-01-30 01:02:18 +0000393 return Ctx.DoubleTy;
Ted Kremenek016b6052010-02-01 23:23:50 +0000394 }
Ted Kremenek4a49d982010-02-26 19:18:41 +0000395
Hans Wennborgabc1e222012-08-07 09:13:19 +0000396 if (CS.getKind() == ConversionSpecifier::nArg) {
397 switch (LM.getKind()) {
398 case LengthModifier::None:
399 return ArgType::PtrTo(Ctx.IntTy);
400 case LengthModifier::AsChar:
401 return ArgType::PtrTo(Ctx.SignedCharTy);
402 case LengthModifier::AsShort:
403 return ArgType::PtrTo(Ctx.ShortTy);
404 case LengthModifier::AsLong:
405 return ArgType::PtrTo(Ctx.LongTy);
406 case LengthModifier::AsLongLong:
407 case LengthModifier::AsQuad:
408 return ArgType::PtrTo(Ctx.LongLongTy);
409 case LengthModifier::AsIntMax:
410 return ArgType::PtrTo(ArgType(Ctx.getIntMaxType(), "intmax_t"));
411 case LengthModifier::AsSizeT:
412 return ArgType(); // FIXME: ssize_t
413 case LengthModifier::AsPtrDiff:
414 return ArgType::PtrTo(ArgType(Ctx.getPointerDiffType(), "ptrdiff_t"));
415 case LengthModifier::AsLongDouble:
416 return ArgType(); // FIXME: Is this a known extension?
417 case LengthModifier::AsAllocate:
418 case LengthModifier::AsMAllocate:
David Majnemer3cba4952013-08-21 21:54:46 +0000419 case LengthModifier::AsInt32:
420 case LengthModifier::AsInt3264:
421 case LengthModifier::AsInt64:
Hans Wennborg68f42b92014-09-04 21:39:46 +0000422 case LengthModifier::AsWide:
Hans Wennborgabc1e222012-08-07 09:13:19 +0000423 return ArgType::Invalid();
424 }
425 }
426
Ted Kremenek74a4ce72010-02-24 00:05:54 +0000427 switch (CS.getKind()) {
Hans Wennborg0c353262011-12-09 15:57:33 +0000428 case ConversionSpecifier::sArg:
Nico Weber496cdc22012-01-31 01:43:25 +0000429 if (LM.getKind() == LengthModifier::AsWideChar) {
430 if (IsObjCLiteral)
Jordan Rose0e5badd2012-12-05 18:44:49 +0000431 return ArgType(Ctx.getPointerType(Ctx.UnsignedShortTy.withConst()),
432 "const unichar *");
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000433 return ArgType(ArgType::WCStrTy, "wchar_t *");
Nico Weber496cdc22012-01-31 01:43:25 +0000434 }
Hans Wennborg68f42b92014-09-04 21:39:46 +0000435 if (LM.getKind() == LengthModifier::AsWide)
436 return ArgType(ArgType::WCStrTy, "wchar_t *");
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000437 return ArgType::CStrTy;
Ted Kremenek348d1492010-07-20 20:04:15 +0000438 case ConversionSpecifier::SArg:
Nico Weber496cdc22012-01-31 01:43:25 +0000439 if (IsObjCLiteral)
Jordan Rose0e5badd2012-12-05 18:44:49 +0000440 return ArgType(Ctx.getPointerType(Ctx.UnsignedShortTy.withConst()),
441 "const unichar *");
Hans Wennborg1b231582014-09-04 21:39:52 +0000442 if (Ctx.getTargetInfo().getTriple().isOSMSVCRT() &&
443 LM.getKind() == LengthModifier::AsShort)
444 return ArgType::CStrTy;
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000445 return ArgType(ArgType::WCStrTy, "wchar_t *");
Ted Kremenek74a4ce72010-02-24 00:05:54 +0000446 case ConversionSpecifier::CArg:
Nico Weber496cdc22012-01-31 01:43:25 +0000447 if (IsObjCLiteral)
Jordan Rose0e5badd2012-12-05 18:44:49 +0000448 return ArgType(Ctx.UnsignedShortTy, "unichar");
Hans Wennborg1b231582014-09-04 21:39:52 +0000449 if (Ctx.getTargetInfo().getTriple().isOSMSVCRT() &&
450 LM.getKind() == LengthModifier::AsShort)
451 return Ctx.IntTy;
Hans Wennborg0d81e012013-05-10 10:08:40 +0000452 return ArgType(Ctx.WideCharTy, "wchar_t");
Ted Kremenek1ce32be2010-07-20 20:04:04 +0000453 case ConversionSpecifier::pArg:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000454 return ArgType::CPointerTy;
Ted Kremenek9b1f3d42012-01-25 00:04:09 +0000455 case ConversionSpecifier::ObjCObjArg:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000456 return ArgType::ObjCPointerTy;
Ted Kremenek74a4ce72010-02-24 00:05:54 +0000457 default:
458 break;
459 }
Ted Kremenek4a49d982010-02-26 19:18:41 +0000460
Ted Kremenek79db7b72010-01-29 22:59:32 +0000461 // FIXME: Handle other cases.
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000462 return ArgType();
Ted Kremenek79db7b72010-01-29 22:59:32 +0000463}
464
Hans Wennborgd99d6882012-02-15 09:59:46 +0000465bool PrintfSpecifier::fixType(QualType QT, const LangOptions &LangOpt,
466 ASTContext &Ctx, bool IsObjCLiteral) {
Hans Wennborgebcd1c72012-07-30 17:11:32 +0000467 // %n is different from other conversion specifiers; don't try to fix it.
468 if (CS.getKind() == ConversionSpecifier::nArg)
469 return false;
470
Jordan Rose68f6d3b2012-05-30 21:53:13 +0000471 // Handle Objective-C objects first. Note that while the '%@' specifier will
472 // not warn for structure pointer or void pointer arguments (because that's
473 // how CoreFoundation objects are implemented), we only show a fixit for '%@'
474 // if we know it's an object (block, id, class, or __attribute__((NSObject))).
475 if (QT->isObjCRetainableType()) {
476 if (!IsObjCLiteral)
477 return false;
478
479 CS.setKind(ConversionSpecifier::ObjCObjArg);
480
481 // Disable irrelevant flags
482 HasThousandsGrouping = false;
483 HasPlusPrefix = false;
484 HasSpacePrefix = false;
485 HasAlternativeForm = false;
486 HasLeadingZeroes = false;
487 Precision.setHowSpecified(OptionalAmount::NotSpecified);
488 LM.setKind(LengthModifier::None);
489
490 return true;
491 }
492
493 // Handle strings next (char *, wchar_t *)
Tom Careb7042702010-06-09 04:11:11 +0000494 if (QT->isPointerType() && (QT->getPointeeType()->isAnyCharacterType())) {
Ted Kremenek563e3ed2010-07-20 20:03:58 +0000495 CS.setKind(ConversionSpecifier::sArg);
Tom Careb7042702010-06-09 04:11:11 +0000496
Tom Care00554632010-06-11 04:22:02 +0000497 // Disable irrelevant flags
498 HasAlternativeForm = 0;
499 HasLeadingZeroes = 0;
500
Tom Careb7042702010-06-09 04:11:11 +0000501 // Set the long length modifier for wide characters
502 if (QT->getPointeeType()->isWideCharType())
503 LM.setKind(LengthModifier::AsWideChar);
Hans Wennborg2027de32011-12-09 10:51:29 +0000504 else
505 LM.setKind(LengthModifier::None);
Tom Careb7042702010-06-09 04:11:11 +0000506
507 return true;
508 }
509
Jordan Rose614e72b2012-06-04 22:49:02 +0000510 // If it's an enum, get its underlying type.
511 if (const EnumType *ETy = QT->getAs<EnumType>())
512 QT = ETy->getDecl()->getIntegerType();
513
Tom Careb7042702010-06-09 04:11:11 +0000514 // We can only work with builtin types.
Tom Careb7042702010-06-09 04:11:11 +0000515 const BuiltinType *BT = QT->getAs<BuiltinType>();
John McCall59207972011-10-18 22:28:37 +0000516 if (!BT)
517 return false;
Tom Care00554632010-06-11 04:22:02 +0000518
Tom Careb7042702010-06-09 04:11:11 +0000519 // Set length modifier
520 switch (BT->getKind()) {
Eli Friedman7ec652a2011-04-27 22:06:20 +0000521 case BuiltinType::Bool:
522 case BuiltinType::WChar_U:
523 case BuiltinType::WChar_S:
524 case BuiltinType::Char16:
525 case BuiltinType::Char32:
526 case BuiltinType::UInt128:
527 case BuiltinType::Int128:
Anton Korobeynikovf0c267e2011-10-14 23:23:15 +0000528 case BuiltinType::Half:
John McCall59207972011-10-18 22:28:37 +0000529 // Various types which are non-trivial to correct.
Eli Friedman7ec652a2011-04-27 22:06:20 +0000530 return false;
531
John McCall59207972011-10-18 22:28:37 +0000532#define SIGNED_TYPE(Id, SingletonId)
533#define UNSIGNED_TYPE(Id, SingletonId)
534#define FLOATING_TYPE(Id, SingletonId)
535#define BUILTIN_TYPE(Id, SingletonId) \
536 case BuiltinType::Id:
537#include "clang/AST/BuiltinTypes.def"
Eli Friedman7ec652a2011-04-27 22:06:20 +0000538 // Misc other stuff which doesn't make sense here.
539 return false;
540
541 case BuiltinType::UInt:
542 case BuiltinType::Int:
543 case BuiltinType::Float:
544 case BuiltinType::Double:
Tom Care00554632010-06-11 04:22:02 +0000545 LM.setKind(LengthModifier::None);
Tom Careb7042702010-06-09 04:11:11 +0000546 break;
Tom Care00554632010-06-11 04:22:02 +0000547
Ted Kremenek12a37de2010-10-21 04:00:58 +0000548 case BuiltinType::Char_U:
549 case BuiltinType::UChar:
550 case BuiltinType::Char_S:
551 case BuiltinType::SChar:
552 LM.setKind(LengthModifier::AsChar);
553 break;
554
555 case BuiltinType::Short:
556 case BuiltinType::UShort:
557 LM.setKind(LengthModifier::AsShort);
558 break;
559
Tom Careb7042702010-06-09 04:11:11 +0000560 case BuiltinType::Long:
561 case BuiltinType::ULong:
562 LM.setKind(LengthModifier::AsLong);
563 break;
564
565 case BuiltinType::LongLong:
566 case BuiltinType::ULongLong:
567 LM.setKind(LengthModifier::AsLongLong);
568 break;
569
570 case BuiltinType::LongDouble:
571 LM.setKind(LengthModifier::AsLongDouble);
572 break;
573 }
574
Hans Wennborgf99d04f2011-10-18 08:10:06 +0000575 // Handle size_t, ptrdiff_t, etc. that have dedicated length modifiers in C99.
Richard Smith2bf7fdb2013-01-02 11:42:31 +0000576 if (isa<TypedefType>(QT) && (LangOpt.C99 || LangOpt.CPlusPlus11))
Hans Wennborg08574d32012-07-27 19:17:46 +0000577 namedTypeToLengthModifier(QT, LM);
Hans Wennborgf99d04f2011-10-18 08:10:06 +0000578
Jordan Roseaa7a3b32013-01-17 18:47:16 +0000579 // If fixing the length modifier was enough, we might be done.
Jordan Rose92303592012-09-08 04:00:03 +0000580 if (hasValidLengthModifier(Ctx.getTargetInfo())) {
Jordan Roseaa7a3b32013-01-17 18:47:16 +0000581 // If we're going to offer a fix anyway, make sure the sign matches.
582 switch (CS.getKind()) {
583 case ConversionSpecifier::uArg:
584 case ConversionSpecifier::UArg:
585 if (QT->isSignedIntegerType())
586 CS.setKind(clang::analyze_format_string::ConversionSpecifier::dArg);
587 break;
588 case ConversionSpecifier::dArg:
589 case ConversionSpecifier::DArg:
590 case ConversionSpecifier::iArg:
Jordan Rose1eb34292013-01-17 22:34:10 +0000591 if (QT->isUnsignedIntegerType() && !HasPlusPrefix)
Jordan Roseaa7a3b32013-01-17 18:47:16 +0000592 CS.setKind(clang::analyze_format_string::ConversionSpecifier::uArg);
593 break;
594 default:
595 // Other specifiers do not have signed/unsigned variants.
596 break;
597 }
598
Jordan Rose92303592012-09-08 04:00:03 +0000599 const analyze_printf::ArgType &ATR = getArgType(Ctx, IsObjCLiteral);
600 if (ATR.isValid() && ATR.matchesType(Ctx, QT))
601 return true;
602 }
Hans Wennborgd99d6882012-02-15 09:59:46 +0000603
Tom Careb7042702010-06-09 04:11:11 +0000604 // Set conversion specifier and disable any flags which do not apply to it.
Ted Kremenek12a37de2010-10-21 04:00:58 +0000605 // Let typedefs to char fall through to int, as %c is silly for uint8_t.
Jordan Rose6aaa87e2012-12-05 18:44:37 +0000606 if (!isa<TypedefType>(QT) && QT->isCharType()) {
Ted Kremenekab0fe8a2010-07-20 20:03:49 +0000607 CS.setKind(ConversionSpecifier::cArg);
Ted Kremenek12a37de2010-10-21 04:00:58 +0000608 LM.setKind(LengthModifier::None);
Tom Careb7042702010-06-09 04:11:11 +0000609 Precision.setHowSpecified(OptionalAmount::NotSpecified);
610 HasAlternativeForm = 0;
611 HasLeadingZeroes = 0;
Tom Careb49ec692010-06-17 19:00:27 +0000612 HasPlusPrefix = 0;
Tom Careb7042702010-06-09 04:11:11 +0000613 }
614 // Test for Floating type first as LongDouble can pass isUnsignedIntegerType
Douglas Gregor49b4d732010-06-22 23:07:26 +0000615 else if (QT->isRealFloatingType()) {
Tom Careb7042702010-06-09 04:11:11 +0000616 CS.setKind(ConversionSpecifier::fArg);
617 }
Tom Careb7042702010-06-09 04:11:11 +0000618 else if (QT->isSignedIntegerType()) {
619 CS.setKind(ConversionSpecifier::dArg);
620 HasAlternativeForm = 0;
621 }
Douglas Gregorb4e3533ce2010-06-09 05:25:34 +0000622 else if (QT->isUnsignedIntegerType()) {
Hans Wennborgd99d6882012-02-15 09:59:46 +0000623 CS.setKind(ConversionSpecifier::uArg);
Tom Careb7042702010-06-09 04:11:11 +0000624 HasAlternativeForm = 0;
Tom Careb49ec692010-06-17 19:00:27 +0000625 HasPlusPrefix = 0;
Chad Rosier6fdf38b2011-08-17 23:08:45 +0000626 } else {
David Blaikie83d382b2011-09-23 05:06:16 +0000627 llvm_unreachable("Unexpected type");
Tom Careb7042702010-06-09 04:11:11 +0000628 }
629
630 return true;
631}
632
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000633void PrintfSpecifier::toString(raw_ostream &os) const {
Tom Careb7042702010-06-09 04:11:11 +0000634 // Whilst some features have no defined order, we are using the order
NAKAMURA Takumi7c288862011-01-27 07:09:49 +0000635 // appearing in the C99 standard (ISO/IEC 9899:1999 (E) 7.19.6.1)
Tom Careb7042702010-06-09 04:11:11 +0000636 os << "%";
637
638 // Positional args
639 if (usesPositionalArg()) {
640 os << getPositionalArgIndex() << "$";
641 }
642
643 // Conversion flags
644 if (IsLeftJustified) os << "-";
645 if (HasPlusPrefix) os << "+";
646 if (HasSpacePrefix) os << " ";
647 if (HasAlternativeForm) os << "#";
648 if (HasLeadingZeroes) os << "0";
649
650 // Minimum field width
651 FieldWidth.toString(os);
652 // Precision
653 Precision.toString(os);
654 // Length modifier
655 os << LM.toString();
656 // Conversion specifier
657 os << CS.toString();
658}
Tom Careb49ec692010-06-17 19:00:27 +0000659
Ted Kremenek02087932010-07-16 02:11:22 +0000660bool PrintfSpecifier::hasValidPlusPrefix() const {
Tom Careb49ec692010-06-17 19:00:27 +0000661 if (!HasPlusPrefix)
662 return true;
663
664 // The plus prefix only makes sense for signed conversions
665 switch (CS.getKind()) {
666 case ConversionSpecifier::dArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000667 case ConversionSpecifier::DArg:
Tom Careb49ec692010-06-17 19:00:27 +0000668 case ConversionSpecifier::iArg:
669 case ConversionSpecifier::fArg:
670 case ConversionSpecifier::FArg:
671 case ConversionSpecifier::eArg:
672 case ConversionSpecifier::EArg:
673 case ConversionSpecifier::gArg:
674 case ConversionSpecifier::GArg:
675 case ConversionSpecifier::aArg:
676 case ConversionSpecifier::AArg:
677 return true;
678
679 default:
680 return false;
681 }
682}
683
Ted Kremenek02087932010-07-16 02:11:22 +0000684bool PrintfSpecifier::hasValidAlternativeForm() const {
Tom Careb49ec692010-06-17 19:00:27 +0000685 if (!HasAlternativeForm)
686 return true;
687
Anders Carlssona369f8d2010-11-21 18:34:21 +0000688 // Alternate form flag only valid with the oxXaAeEfFgG conversions
Tom Careb49ec692010-06-17 19:00:27 +0000689 switch (CS.getKind()) {
690 case ConversionSpecifier::oArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000691 case ConversionSpecifier::OArg:
Tom Careb49ec692010-06-17 19:00:27 +0000692 case ConversionSpecifier::xArg:
Anders Carlssona369f8d2010-11-21 18:34:21 +0000693 case ConversionSpecifier::XArg:
Tom Careb49ec692010-06-17 19:00:27 +0000694 case ConversionSpecifier::aArg:
695 case ConversionSpecifier::AArg:
696 case ConversionSpecifier::eArg:
697 case ConversionSpecifier::EArg:
698 case ConversionSpecifier::fArg:
699 case ConversionSpecifier::FArg:
700 case ConversionSpecifier::gArg:
701 case ConversionSpecifier::GArg:
702 return true;
703
704 default:
705 return false;
706 }
707}
708
Ted Kremenek02087932010-07-16 02:11:22 +0000709bool PrintfSpecifier::hasValidLeadingZeros() const {
Tom Careb49ec692010-06-17 19:00:27 +0000710 if (!HasLeadingZeroes)
711 return true;
712
713 // Leading zeroes flag only valid with the diouxXaAeEfFgG conversions
714 switch (CS.getKind()) {
715 case ConversionSpecifier::dArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000716 case ConversionSpecifier::DArg:
Tom Careb49ec692010-06-17 19:00:27 +0000717 case ConversionSpecifier::iArg:
718 case ConversionSpecifier::oArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000719 case ConversionSpecifier::OArg:
Tom Careb49ec692010-06-17 19:00:27 +0000720 case ConversionSpecifier::uArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000721 case ConversionSpecifier::UArg:
Tom Careb49ec692010-06-17 19:00:27 +0000722 case ConversionSpecifier::xArg:
723 case ConversionSpecifier::XArg:
724 case ConversionSpecifier::aArg:
725 case ConversionSpecifier::AArg:
726 case ConversionSpecifier::eArg:
727 case ConversionSpecifier::EArg:
728 case ConversionSpecifier::fArg:
729 case ConversionSpecifier::FArg:
730 case ConversionSpecifier::gArg:
731 case ConversionSpecifier::GArg:
732 return true;
733
734 default:
735 return false;
736 }
737}
738
Ted Kremenek02087932010-07-16 02:11:22 +0000739bool PrintfSpecifier::hasValidSpacePrefix() const {
Tom Careb49ec692010-06-17 19:00:27 +0000740 if (!HasSpacePrefix)
741 return true;
742
743 // The space prefix only makes sense for signed conversions
744 switch (CS.getKind()) {
745 case ConversionSpecifier::dArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000746 case ConversionSpecifier::DArg:
Tom Careb49ec692010-06-17 19:00:27 +0000747 case ConversionSpecifier::iArg:
748 case ConversionSpecifier::fArg:
749 case ConversionSpecifier::FArg:
750 case ConversionSpecifier::eArg:
751 case ConversionSpecifier::EArg:
752 case ConversionSpecifier::gArg:
753 case ConversionSpecifier::GArg:
754 case ConversionSpecifier::aArg:
755 case ConversionSpecifier::AArg:
756 return true;
757
758 default:
759 return false;
760 }
761}
762
Ted Kremenek02087932010-07-16 02:11:22 +0000763bool PrintfSpecifier::hasValidLeftJustified() const {
Tom Careb49ec692010-06-17 19:00:27 +0000764 if (!IsLeftJustified)
765 return true;
766
767 // The left justified flag is valid for all conversions except n
768 switch (CS.getKind()) {
Ted Kremenek516ef222010-07-20 20:04:10 +0000769 case ConversionSpecifier::nArg:
Tom Careb49ec692010-06-17 19:00:27 +0000770 return false;
771
772 default:
773 return true;
774 }
775}
776
Ted Kremenekbf4832c2011-01-08 05:28:46 +0000777bool PrintfSpecifier::hasValidThousandsGroupingPrefix() const {
778 if (!HasThousandsGrouping)
779 return true;
NAKAMURA Takumif9cbcc42011-01-27 07:10:08 +0000780
Ted Kremenekbf4832c2011-01-08 05:28:46 +0000781 switch (CS.getKind()) {
782 case ConversionSpecifier::dArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000783 case ConversionSpecifier::DArg:
Ted Kremenekbf4832c2011-01-08 05:28:46 +0000784 case ConversionSpecifier::iArg:
785 case ConversionSpecifier::uArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000786 case ConversionSpecifier::UArg:
Ted Kremenekbf4832c2011-01-08 05:28:46 +0000787 case ConversionSpecifier::fArg:
788 case ConversionSpecifier::FArg:
789 case ConversionSpecifier::gArg:
790 case ConversionSpecifier::GArg:
791 return true;
792 default:
793 return false;
794 }
795}
796
Ted Kremenek02087932010-07-16 02:11:22 +0000797bool PrintfSpecifier::hasValidPrecision() const {
Tom Careb49ec692010-06-17 19:00:27 +0000798 if (Precision.getHowSpecified() == OptionalAmount::NotSpecified)
799 return true;
800
801 // Precision is only valid with the diouxXaAeEfFgGs conversions
802 switch (CS.getKind()) {
803 case ConversionSpecifier::dArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000804 case ConversionSpecifier::DArg:
Tom Careb49ec692010-06-17 19:00:27 +0000805 case ConversionSpecifier::iArg:
806 case ConversionSpecifier::oArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000807 case ConversionSpecifier::OArg:
Tom Careb49ec692010-06-17 19:00:27 +0000808 case ConversionSpecifier::uArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000809 case ConversionSpecifier::UArg:
Tom Careb49ec692010-06-17 19:00:27 +0000810 case ConversionSpecifier::xArg:
811 case ConversionSpecifier::XArg:
812 case ConversionSpecifier::aArg:
813 case ConversionSpecifier::AArg:
814 case ConversionSpecifier::eArg:
815 case ConversionSpecifier::EArg:
816 case ConversionSpecifier::fArg:
817 case ConversionSpecifier::FArg:
818 case ConversionSpecifier::gArg:
819 case ConversionSpecifier::GArg:
Ted Kremenek563e3ed2010-07-20 20:03:58 +0000820 case ConversionSpecifier::sArg:
Tom Careb49ec692010-06-17 19:00:27 +0000821 return true;
822
823 default:
824 return false;
825 }
826}
Ted Kremenek02087932010-07-16 02:11:22 +0000827bool PrintfSpecifier::hasValidFieldWidth() const {
Tom Careb49ec692010-06-17 19:00:27 +0000828 if (FieldWidth.getHowSpecified() == OptionalAmount::NotSpecified)
829 return true;
830
831 // The field width is valid for all conversions except n
832 switch (CS.getKind()) {
Ted Kremenek516ef222010-07-20 20:04:10 +0000833 case ConversionSpecifier::nArg:
Tom Careb49ec692010-06-17 19:00:27 +0000834 return false;
835
836 default:
837 return true;
838 }
839}