blob: 08207910b831a5762d58388761d2e93dc2f5d4de [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,
57 const TargetInfo &Target) {
Ted Kremenekc8b188d2010-02-16 01:46:59 +000058
Ted Kremenekf03e6d852010-07-20 20:04:27 +000059 using namespace clang::analyze_format_string;
Ted Kremenek176f7d62010-01-29 02:13:53 +000060 using namespace clang::analyze_printf;
Ted Kremenekc8b188d2010-02-16 01:46:59 +000061
Ted Kremeneka2e77b42010-01-27 23:43:25 +000062 const char *I = Beg;
Ted Kremenekc8d9c012010-01-28 00:02:05 +000063 const char *Start = 0;
Ted Kremeneka2e77b42010-01-27 23:43:25 +000064 UpdateOnReturn <const char*> UpdateBeg(Beg, I);
65
66 // Look for a '%' character that indicates the start of a format specifier.
Ted Kremenekb5c98ef2010-01-28 23:56:52 +000067 for ( ; I != E ; ++I) {
Ted Kremeneka2e77b42010-01-27 23:43:25 +000068 char c = *I;
Ted Kremeneka2e77b42010-01-27 23:43:25 +000069 if (c == '\0') {
70 // Detect spurious null characters, which are likely errors.
71 H.HandleNullChar(I);
72 return true;
73 }
74 if (c == '%') {
Ted Kremenekb5c98ef2010-01-28 23:56:52 +000075 Start = I++; // Record the start of the format specifier.
Ted Kremeneka2e77b42010-01-27 23:43:25 +000076 break;
77 }
78 }
Ted Kremenekc8b188d2010-02-16 01:46:59 +000079
Ted Kremeneka2e77b42010-01-27 23:43:25 +000080 // No format specifier found?
81 if (!Start)
82 return false;
Ted Kremenekc8b188d2010-02-16 01:46:59 +000083
Ted Kremeneka2e77b42010-01-27 23:43:25 +000084 if (I == E) {
85 // No more characters left?
Ted Kremenek02087932010-07-16 02:11:22 +000086 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremeneka2e77b42010-01-27 23:43:25 +000087 return true;
88 }
Ted Kremenekc8b188d2010-02-16 01:46:59 +000089
Ted Kremenek02087932010-07-16 02:11:22 +000090 PrintfSpecifier FS;
Ted Kremenekd1668192010-02-27 01:41:03 +000091 if (ParseArgPosition(H, FS, Start, I, E))
92 return true;
93
94 if (I == E) {
95 // No more characters left?
Ted Kremenek02087932010-07-16 02:11:22 +000096 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremenekd1668192010-02-27 01:41:03 +000097 return true;
98 }
Ted Kremenekc8b188d2010-02-16 01:46:59 +000099
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000100 // Look for flags (if any).
101 bool hasMore = true;
102 for ( ; I != E; ++I) {
103 switch (*I) {
104 default: hasMore = false; break;
NAKAMURA Takumif9cbcc42011-01-27 07:10:08 +0000105 case '\'':
Ted Kremeneka322cae2011-01-08 05:28:38 +0000106 // FIXME: POSIX specific. Always accept?
107 FS.setHasThousandsGrouping(I);
108 break;
Tom Careb49ec692010-06-17 19:00:27 +0000109 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 Kremeneka2e77b42010-01-27 23:43:25 +0000114 }
115 if (!hasMore)
116 break;
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000117 }
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000118
119 if (I == E) {
120 // No more characters left?
Ted Kremenek02087932010-07-16 02:11:22 +0000121 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000122 return true;
123 }
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000124
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000125 // Look for the field width (if any).
Ted Kremenekd1668192010-02-27 01:41:03 +0000126 if (ParseFieldWidth(H, FS, Start, I, E,
127 FS.usesPositionalArg() ? 0 : &argIndex))
128 return true;
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000129
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000130 if (I == E) {
131 // No more characters left?
Ted Kremenek02087932010-07-16 02:11:22 +0000132 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000133 return true;
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000134 }
135
136 // Look for the precision (if any).
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000137 if (*I == '.') {
Ted Kremenekc22f78d2010-01-29 03:16:21 +0000138 ++I;
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000139 if (I == E) {
Ted Kremenek02087932010-07-16 02:11:22 +0000140 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000141 return true;
142 }
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000143
Ted Kremenekd1668192010-02-27 01:41:03 +0000144 if (ParsePrecision(H, FS, Start, I, E,
145 FS.usesPositionalArg() ? 0 : &argIndex))
146 return true;
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000147
148 if (I == E) {
149 // No more characters left?
Ted Kremenek02087932010-07-16 02:11:22 +0000150 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000151 return true;
152 }
153 }
154
155 // Look for the length modifier.
Hans Wennborg23926bd2011-12-15 10:25:47 +0000156 if (ParseLengthModifier(FS, I, E, LO) && I == E) {
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000157 // No more characters left?
Ted Kremenek02087932010-07-16 02:11:22 +0000158 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000159 return true;
160 }
Ted Kremenek2a0cd592010-02-09 00:04:09 +0000161
Ted Kremenek23a71a12010-01-29 20:29:53 +0000162 if (*I == '\0') {
Ted Kremenek2a0cd592010-02-09 00:04:09 +0000163 // Detect spurious null characters, which are likely errors.
164 H.HandleNullChar(I);
165 return true;
Ted Kremenek23a71a12010-01-29 20:29:53 +0000166 }
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000167
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000168 // Finally, look for the conversion specifier.
Ted Kremenekfee0e962010-01-28 02:46:17 +0000169 const char *conversionPosition = I++;
Ted Kremenek94af5752010-01-29 02:40:24 +0000170 ConversionSpecifier::Kind k = ConversionSpecifier::InvalidSpecifier;
Ted Kremenekfee0e962010-01-28 02:46:17 +0000171 switch (*conversionPosition) {
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000172 default:
Ted Kremenek94af5752010-01-29 02:40:24 +0000173 break;
Ted Kremenekc06ead62010-01-28 00:55:28 +0000174 // C99: 7.19.6.1 (section 8).
Ted Kremenek74a4ce72010-02-24 00:05:54 +0000175 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 Kremenekab0fe8a2010-07-20 20:03:49 +0000182 case 'c': k = ConversionSpecifier::cArg; break;
Ted Kremenekfee0e962010-01-28 02:46:17 +0000183 case 'd': k = ConversionSpecifier::dArg; break;
Ted Kremenek74a4ce72010-02-24 00:05:54 +0000184 case 'e': k = ConversionSpecifier::eArg; break;
185 case 'f': k = ConversionSpecifier::fArg; break;
186 case 'g': k = ConversionSpecifier::gArg; break;
Ted Kremenekfee0e962010-01-28 02:46:17 +0000187 case 'i': k = ConversionSpecifier::iArg; break;
Ted Kremenek516ef222010-07-20 20:04:10 +0000188 case 'n': k = ConversionSpecifier::nArg; break;
Ted Kremenekfee0e962010-01-28 02:46:17 +0000189 case 'o': k = ConversionSpecifier::oArg; break;
Ted Kremenek1ce32be2010-07-20 20:04:04 +0000190 case 'p': k = ConversionSpecifier::pArg; break;
Ted Kremenek563e3ed2010-07-20 20:03:58 +0000191 case 's': k = ConversionSpecifier::sArg; break;
Ted Kremenekfee0e962010-01-28 02:46:17 +0000192 case 'u': k = ConversionSpecifier::uArg; break;
193 case 'x': k = ConversionSpecifier::xArg; break;
Ted Kremeneka322cae2011-01-08 05:28:38 +0000194 // POSIX specific.
Ted Kremenek74a4ce72010-02-24 00:05:54 +0000195 case 'C': k = ConversionSpecifier::CArg; break;
Ted Kremenek348d1492010-07-20 20:04:15 +0000196 case 'S': k = ConversionSpecifier::SArg; break;
Ted Kremenekc06ead62010-01-28 00:55:28 +0000197 // Objective-C.
Ted Kremenek23a71a12010-01-29 20:29:53 +0000198 case '@': k = ConversionSpecifier::ObjCObjArg; break;
Ted Kremenek2a0cd592010-02-09 00:04:09 +0000199 // Glibc specific.
Ted Kremenek23a71a12010-01-29 20:29:53 +0000200 case 'm': k = ConversionSpecifier::PrintErrno; break;
Jordan Rose510260c2012-09-13 02:11:03 +0000201 // 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 Kremeneka2e77b42010-01-27 23:43:25 +0000214 }
Ted Kremenekf03e6d852010-07-20 20:04:27 +0000215 PrintfConversionSpecifier CS(conversionPosition, k);
Ted Kremenek4a49d982010-02-26 19:18:41 +0000216 FS.setConversionSpecifier(CS);
Ted Kremenekd1668192010-02-27 01:41:03 +0000217 if (CS.consumesDataArgument() && !FS.usesPositionalArg())
Ted Kremenek4a49d982010-02-26 19:18:41 +0000218 FS.setArgIndex(argIndex++);
Ted Kremenek94af5752010-01-29 02:40:24 +0000219
220 if (k == ConversionSpecifier::InvalidSpecifier) {
Ted Kremenek4a49d982010-02-26 19:18:41 +0000221 // Assume the conversion takes one argument.
Ted Kremenek9e618ed2010-12-02 20:57:51 +0000222 return !H.HandleInvalidPrintfConversionSpecifier(FS, Start, I - Start);
Ted Kremenek94af5752010-01-29 02:40:24 +0000223 }
Ted Kremenek02087932010-07-16 02:11:22 +0000224 return PrintfSpecifierResult(Start, FS);
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000225}
226
Ted Kremenek02087932010-07-16 02:11:22 +0000227bool clang::analyze_format_string::ParsePrintfString(FormatStringHandler &H,
228 const char *I,
Hans Wennborg23926bd2011-12-15 10:25:47 +0000229 const char *E,
Jordan Rose510260c2012-09-13 02:11:03 +0000230 const LangOptions &LO,
231 const TargetInfo &Target) {
Ted Kremenek4a49d982010-02-26 19:18:41 +0000232
233 unsigned argIndex = 0;
234
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000235 // Keep looking for a format specifier until we have exhausted the string.
236 while (I != E) {
Hans Wennborg23926bd2011-12-15 10:25:47 +0000237 const PrintfSpecifierResult &FSR = ParsePrintfSpecifier(H, I, E, argIndex,
Jordan Rose510260c2012-09-13 02:11:03 +0000238 LO, Target);
Ted Kremenek94af5752010-01-29 02:40:24 +0000239 // 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 Gribenko76bb5cabfa2012-09-10 21:20:09 +0000242 return true;
Ted Kremenek94af5752010-01-29 02:40:24 +0000243 // Did we exhaust the string or encounter an error that
244 // we can recover from?
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000245 if (!FSR.hasValue())
Ted Kremenek94af5752010-01-29 02:40:24 +0000246 continue;
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000247 // We have a format specifier. Pass it to the callback.
Ted Kremenek02087932010-07-16 02:11:22 +0000248 if (!H.HandlePrintfSpecifier(FSR.getValue(), FSR.getStart(),
Ted Kremenekfee0e962010-01-28 02:46:17 +0000249 I - FSR.getStart()))
Ted Kremenek23a71a12010-01-29 20:29:53 +0000250 return true;
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000251 }
252 assert(I == E && "Format string not exhausted");
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000253 return false;
254}
Ted Kremeneka2e77b42010-01-27 23:43:25 +0000255
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000256//===----------------------------------------------------------------------===//
Ted Kremenek02087932010-07-16 02:11:22 +0000257// Methods on PrintfSpecifier.
Tom Careb7042702010-06-09 04:11:11 +0000258//===----------------------------------------------------------------------===//
259
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000260ArgType PrintfSpecifier::getArgType(ASTContext &Ctx,
261 bool IsObjCLiteral) const {
Ted Kremenekf03e6d852010-07-20 20:04:27 +0000262 const PrintfConversionSpecifier &CS = getConversionSpecifier();
NAKAMURA Takumif9cbcc42011-01-27 07:10:08 +0000263
Ted Kremenek79db7b72010-01-29 22:59:32 +0000264 if (!CS.consumesDataArgument())
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000265 return ArgType::Invalid();
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000266
Ted Kremenek5f0c0662010-08-24 22:24:51 +0000267 if (CS.getKind() == ConversionSpecifier::cArg)
268 switch (LM.getKind()) {
269 case LengthModifier::None: return Ctx.IntTy;
Hans Wennborga5b1aa92011-12-09 12:22:12 +0000270 case LengthModifier::AsLong:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000271 return ArgType(ArgType::WIntTy, "wint_t");
Ted Kremenek5f0c0662010-08-24 22:24:51 +0000272 default:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000273 return ArgType::Invalid();
Ted Kremenek5f0c0662010-08-24 22:24:51 +0000274 }
NAKAMURA Takumif9cbcc42011-01-27 07:10:08 +0000275
Ted Kremenek79db7b72010-01-29 22:59:32 +0000276 if (CS.isIntArg())
Tom Careb7042702010-06-09 04:11:11 +0000277 switch (LM.getKind()) {
278 case LengthModifier::AsLongDouble:
Ted Kremenek6fa57272012-01-24 21:29:54 +0000279 // GNU extension.
280 return Ctx.LongLongTy;
Tom Careb7042702010-06-09 04:11:11 +0000281 case LengthModifier::None: return Ctx.IntTy;
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000282 case LengthModifier::AsChar: return ArgType::AnyCharTy;
Tom Careb7042702010-06-09 04:11:11 +0000283 case LengthModifier::AsShort: return Ctx.ShortTy;
284 case LengthModifier::AsLong: return Ctx.LongTy;
Hans Wennborg9bc9bcc2012-02-16 16:34:54 +0000285 case LengthModifier::AsLongLong:
286 case LengthModifier::AsQuad:
287 return Ctx.LongLongTy;
Hans Wennborg772e9272011-12-07 10:33:11 +0000288 case LengthModifier::AsIntMax:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000289 return ArgType(Ctx.getIntMaxType(), "intmax_t");
Hans Wennborg27541db2011-10-27 08:29:09 +0000290 case LengthModifier::AsSizeT:
291 // FIXME: How to get the corresponding signed version of size_t?
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000292 return ArgType();
Hans Wennborg772e9272011-12-07 10:33:11 +0000293 case LengthModifier::AsPtrDiff:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000294 return ArgType(Ctx.getPointerDiffType(), "ptrdiff_t");
Hans Wennborg23926bd2011-12-15 10:25:47 +0000295 case LengthModifier::AsAllocate:
Hans Wennborg6073e312012-01-12 17:11:12 +0000296 case LengthModifier::AsMAllocate:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000297 return ArgType::Invalid();
Ted Kremenek79db7b72010-01-29 22:59:32 +0000298 }
299
300 if (CS.isUIntArg())
Tom Careb7042702010-06-09 04:11:11 +0000301 switch (LM.getKind()) {
302 case LengthModifier::AsLongDouble:
Ted Kremenek6fa57272012-01-24 21:29:54 +0000303 // GNU extension.
304 return Ctx.UnsignedLongLongTy;
Tom Careb7042702010-06-09 04:11:11 +0000305 case LengthModifier::None: return Ctx.UnsignedIntTy;
306 case LengthModifier::AsChar: return Ctx.UnsignedCharTy;
307 case LengthModifier::AsShort: return Ctx.UnsignedShortTy;
308 case LengthModifier::AsLong: return Ctx.UnsignedLongTy;
Hans Wennborg9bc9bcc2012-02-16 16:34:54 +0000309 case LengthModifier::AsLongLong:
310 case LengthModifier::AsQuad:
311 return Ctx.UnsignedLongLongTy;
Hans Wennborg772e9272011-12-07 10:33:11 +0000312 case LengthModifier::AsIntMax:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000313 return ArgType(Ctx.getUIntMaxType(), "uintmax_t");
Tom Careb7042702010-06-09 04:11:11 +0000314 case LengthModifier::AsSizeT:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000315 return ArgType(Ctx.getSizeType(), "size_t");
Tom Careb7042702010-06-09 04:11:11 +0000316 case LengthModifier::AsPtrDiff:
Ted Kremenek79db7b72010-01-29 22:59:32 +0000317 // FIXME: How to get the corresponding unsigned
318 // version of ptrdiff_t?
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000319 return ArgType();
Hans Wennborg23926bd2011-12-15 10:25:47 +0000320 case LengthModifier::AsAllocate:
Hans Wennborg6073e312012-01-12 17:11:12 +0000321 case LengthModifier::AsMAllocate:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000322 return ArgType::Invalid();
Ted Kremenek79db7b72010-01-29 22:59:32 +0000323 }
Ted Kremenekc8b188d2010-02-16 01:46:59 +0000324
Ted Kremenek016b6052010-02-01 23:23:50 +0000325 if (CS.isDoubleArg()) {
Tom Careb7042702010-06-09 04:11:11 +0000326 if (LM.getKind() == LengthModifier::AsLongDouble)
Ted Kremenek016b6052010-02-01 23:23:50 +0000327 return Ctx.LongDoubleTy;
Ted Kremenek9ff02052010-01-30 01:02:18 +0000328 return Ctx.DoubleTy;
Ted Kremenek016b6052010-02-01 23:23:50 +0000329 }
Ted Kremenek4a49d982010-02-26 19:18:41 +0000330
Hans Wennborgabc1e222012-08-07 09:13:19 +0000331 if (CS.getKind() == ConversionSpecifier::nArg) {
332 switch (LM.getKind()) {
333 case LengthModifier::None:
334 return ArgType::PtrTo(Ctx.IntTy);
335 case LengthModifier::AsChar:
336 return ArgType::PtrTo(Ctx.SignedCharTy);
337 case LengthModifier::AsShort:
338 return ArgType::PtrTo(Ctx.ShortTy);
339 case LengthModifier::AsLong:
340 return ArgType::PtrTo(Ctx.LongTy);
341 case LengthModifier::AsLongLong:
342 case LengthModifier::AsQuad:
343 return ArgType::PtrTo(Ctx.LongLongTy);
344 case LengthModifier::AsIntMax:
345 return ArgType::PtrTo(ArgType(Ctx.getIntMaxType(), "intmax_t"));
346 case LengthModifier::AsSizeT:
347 return ArgType(); // FIXME: ssize_t
348 case LengthModifier::AsPtrDiff:
349 return ArgType::PtrTo(ArgType(Ctx.getPointerDiffType(), "ptrdiff_t"));
350 case LengthModifier::AsLongDouble:
351 return ArgType(); // FIXME: Is this a known extension?
352 case LengthModifier::AsAllocate:
353 case LengthModifier::AsMAllocate:
354 return ArgType::Invalid();
355 }
356 }
357
Ted Kremenek74a4ce72010-02-24 00:05:54 +0000358 switch (CS.getKind()) {
Hans Wennborg0c353262011-12-09 15:57:33 +0000359 case ConversionSpecifier::sArg:
Nico Weber496cdc22012-01-31 01:43:25 +0000360 if (LM.getKind() == LengthModifier::AsWideChar) {
361 if (IsObjCLiteral)
362 return Ctx.getPointerType(Ctx.UnsignedShortTy.withConst());
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000363 return ArgType(ArgType::WCStrTy, "wchar_t *");
Nico Weber496cdc22012-01-31 01:43:25 +0000364 }
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000365 return ArgType::CStrTy;
Ted Kremenek348d1492010-07-20 20:04:15 +0000366 case ConversionSpecifier::SArg:
Nico Weber496cdc22012-01-31 01:43:25 +0000367 if (IsObjCLiteral)
368 return Ctx.getPointerType(Ctx.UnsignedShortTy.withConst());
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000369 return ArgType(ArgType::WCStrTy, "wchar_t *");
Ted Kremenek74a4ce72010-02-24 00:05:54 +0000370 case ConversionSpecifier::CArg:
Nico Weber496cdc22012-01-31 01:43:25 +0000371 if (IsObjCLiteral)
372 return Ctx.UnsignedShortTy;
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000373 return ArgType(Ctx.WCharTy, "wchar_t");
Ted Kremenek1ce32be2010-07-20 20:04:04 +0000374 case ConversionSpecifier::pArg:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000375 return ArgType::CPointerTy;
Ted Kremenek9b1f3d42012-01-25 00:04:09 +0000376 case ConversionSpecifier::ObjCObjArg:
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000377 return ArgType::ObjCPointerTy;
Ted Kremenek74a4ce72010-02-24 00:05:54 +0000378 default:
379 break;
380 }
Ted Kremenek4a49d982010-02-26 19:18:41 +0000381
Ted Kremenek79db7b72010-01-29 22:59:32 +0000382 // FIXME: Handle other cases.
Hans Wennborgc3b3da02012-08-07 08:11:26 +0000383 return ArgType();
Ted Kremenek79db7b72010-01-29 22:59:32 +0000384}
385
Hans Wennborgd99d6882012-02-15 09:59:46 +0000386bool PrintfSpecifier::fixType(QualType QT, const LangOptions &LangOpt,
387 ASTContext &Ctx, bool IsObjCLiteral) {
Hans Wennborgebcd1c72012-07-30 17:11:32 +0000388 // %n is different from other conversion specifiers; don't try to fix it.
389 if (CS.getKind() == ConversionSpecifier::nArg)
390 return false;
391
Jordan Rose68f6d3b2012-05-30 21:53:13 +0000392 // Handle Objective-C objects first. Note that while the '%@' specifier will
393 // not warn for structure pointer or void pointer arguments (because that's
394 // how CoreFoundation objects are implemented), we only show a fixit for '%@'
395 // if we know it's an object (block, id, class, or __attribute__((NSObject))).
396 if (QT->isObjCRetainableType()) {
397 if (!IsObjCLiteral)
398 return false;
399
400 CS.setKind(ConversionSpecifier::ObjCObjArg);
401
402 // Disable irrelevant flags
403 HasThousandsGrouping = false;
404 HasPlusPrefix = false;
405 HasSpacePrefix = false;
406 HasAlternativeForm = false;
407 HasLeadingZeroes = false;
408 Precision.setHowSpecified(OptionalAmount::NotSpecified);
409 LM.setKind(LengthModifier::None);
410
411 return true;
412 }
413
414 // Handle strings next (char *, wchar_t *)
Tom Careb7042702010-06-09 04:11:11 +0000415 if (QT->isPointerType() && (QT->getPointeeType()->isAnyCharacterType())) {
Ted Kremenek563e3ed2010-07-20 20:03:58 +0000416 CS.setKind(ConversionSpecifier::sArg);
Tom Careb7042702010-06-09 04:11:11 +0000417
Tom Care00554632010-06-11 04:22:02 +0000418 // Disable irrelevant flags
419 HasAlternativeForm = 0;
420 HasLeadingZeroes = 0;
421
Tom Careb7042702010-06-09 04:11:11 +0000422 // Set the long length modifier for wide characters
423 if (QT->getPointeeType()->isWideCharType())
424 LM.setKind(LengthModifier::AsWideChar);
Hans Wennborg2027de32011-12-09 10:51:29 +0000425 else
426 LM.setKind(LengthModifier::None);
Tom Careb7042702010-06-09 04:11:11 +0000427
428 return true;
429 }
430
Jordan Rose614e72b2012-06-04 22:49:02 +0000431 // If it's an enum, get its underlying type.
432 if (const EnumType *ETy = QT->getAs<EnumType>())
433 QT = ETy->getDecl()->getIntegerType();
434
Tom Careb7042702010-06-09 04:11:11 +0000435 // We can only work with builtin types.
Tom Careb7042702010-06-09 04:11:11 +0000436 const BuiltinType *BT = QT->getAs<BuiltinType>();
John McCall59207972011-10-18 22:28:37 +0000437 if (!BT)
438 return false;
Tom Care00554632010-06-11 04:22:02 +0000439
Tom Careb7042702010-06-09 04:11:11 +0000440 // Set length modifier
441 switch (BT->getKind()) {
Eli Friedman7ec652a2011-04-27 22:06:20 +0000442 case BuiltinType::Bool:
443 case BuiltinType::WChar_U:
444 case BuiltinType::WChar_S:
445 case BuiltinType::Char16:
446 case BuiltinType::Char32:
447 case BuiltinType::UInt128:
448 case BuiltinType::Int128:
Anton Korobeynikovf0c267e2011-10-14 23:23:15 +0000449 case BuiltinType::Half:
John McCall59207972011-10-18 22:28:37 +0000450 // Various types which are non-trivial to correct.
Eli Friedman7ec652a2011-04-27 22:06:20 +0000451 return false;
452
John McCall59207972011-10-18 22:28:37 +0000453#define SIGNED_TYPE(Id, SingletonId)
454#define UNSIGNED_TYPE(Id, SingletonId)
455#define FLOATING_TYPE(Id, SingletonId)
456#define BUILTIN_TYPE(Id, SingletonId) \
457 case BuiltinType::Id:
458#include "clang/AST/BuiltinTypes.def"
Eli Friedman7ec652a2011-04-27 22:06:20 +0000459 // Misc other stuff which doesn't make sense here.
460 return false;
461
462 case BuiltinType::UInt:
463 case BuiltinType::Int:
464 case BuiltinType::Float:
465 case BuiltinType::Double:
Tom Care00554632010-06-11 04:22:02 +0000466 LM.setKind(LengthModifier::None);
Tom Careb7042702010-06-09 04:11:11 +0000467 break;
Tom Care00554632010-06-11 04:22:02 +0000468
Ted Kremenek12a37de2010-10-21 04:00:58 +0000469 case BuiltinType::Char_U:
470 case BuiltinType::UChar:
471 case BuiltinType::Char_S:
472 case BuiltinType::SChar:
473 LM.setKind(LengthModifier::AsChar);
474 break;
475
476 case BuiltinType::Short:
477 case BuiltinType::UShort:
478 LM.setKind(LengthModifier::AsShort);
479 break;
480
Tom Careb7042702010-06-09 04:11:11 +0000481 case BuiltinType::Long:
482 case BuiltinType::ULong:
483 LM.setKind(LengthModifier::AsLong);
484 break;
485
486 case BuiltinType::LongLong:
487 case BuiltinType::ULongLong:
488 LM.setKind(LengthModifier::AsLongLong);
489 break;
490
491 case BuiltinType::LongDouble:
492 LM.setKind(LengthModifier::AsLongDouble);
493 break;
494 }
495
Hans Wennborgf99d04f2011-10-18 08:10:06 +0000496 // Handle size_t, ptrdiff_t, etc. that have dedicated length modifiers in C99.
Hans Wennborg08574d32012-07-27 19:17:46 +0000497 if (isa<TypedefType>(QT) && (LangOpt.C99 || LangOpt.CPlusPlus0x))
498 namedTypeToLengthModifier(QT, LM);
Hans Wennborgf99d04f2011-10-18 08:10:06 +0000499
Hans Wennborgd99d6882012-02-15 09:59:46 +0000500 // If fixing the length modifier was enough, we are done.
Jordan Rose92303592012-09-08 04:00:03 +0000501 if (hasValidLengthModifier(Ctx.getTargetInfo())) {
502 const analyze_printf::ArgType &ATR = getArgType(Ctx, IsObjCLiteral);
503 if (ATR.isValid() && ATR.matchesType(Ctx, QT))
504 return true;
505 }
Hans Wennborgd99d6882012-02-15 09:59:46 +0000506
Tom Careb7042702010-06-09 04:11:11 +0000507 // Set conversion specifier and disable any flags which do not apply to it.
Ted Kremenek12a37de2010-10-21 04:00:58 +0000508 // Let typedefs to char fall through to int, as %c is silly for uint8_t.
Jordan Rose6aaa87e2012-12-05 18:44:37 +0000509 if (!isa<TypedefType>(QT) && QT->isCharType()) {
Ted Kremenekab0fe8a2010-07-20 20:03:49 +0000510 CS.setKind(ConversionSpecifier::cArg);
Ted Kremenek12a37de2010-10-21 04:00:58 +0000511 LM.setKind(LengthModifier::None);
Tom Careb7042702010-06-09 04:11:11 +0000512 Precision.setHowSpecified(OptionalAmount::NotSpecified);
513 HasAlternativeForm = 0;
514 HasLeadingZeroes = 0;
Tom Careb49ec692010-06-17 19:00:27 +0000515 HasPlusPrefix = 0;
Tom Careb7042702010-06-09 04:11:11 +0000516 }
517 // Test for Floating type first as LongDouble can pass isUnsignedIntegerType
Douglas Gregor49b4d732010-06-22 23:07:26 +0000518 else if (QT->isRealFloatingType()) {
Tom Careb7042702010-06-09 04:11:11 +0000519 CS.setKind(ConversionSpecifier::fArg);
520 }
Tom Careb7042702010-06-09 04:11:11 +0000521 else if (QT->isSignedIntegerType()) {
522 CS.setKind(ConversionSpecifier::dArg);
523 HasAlternativeForm = 0;
524 }
Douglas Gregorb4e3533ce2010-06-09 05:25:34 +0000525 else if (QT->isUnsignedIntegerType()) {
Hans Wennborgd99d6882012-02-15 09:59:46 +0000526 CS.setKind(ConversionSpecifier::uArg);
Tom Careb7042702010-06-09 04:11:11 +0000527 HasAlternativeForm = 0;
Tom Careb49ec692010-06-17 19:00:27 +0000528 HasPlusPrefix = 0;
Chad Rosier6fdf38b2011-08-17 23:08:45 +0000529 } else {
David Blaikie83d382b2011-09-23 05:06:16 +0000530 llvm_unreachable("Unexpected type");
Tom Careb7042702010-06-09 04:11:11 +0000531 }
532
533 return true;
534}
535
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000536void PrintfSpecifier::toString(raw_ostream &os) const {
Tom Careb7042702010-06-09 04:11:11 +0000537 // Whilst some features have no defined order, we are using the order
NAKAMURA Takumi7c288862011-01-27 07:09:49 +0000538 // appearing in the C99 standard (ISO/IEC 9899:1999 (E) 7.19.6.1)
Tom Careb7042702010-06-09 04:11:11 +0000539 os << "%";
540
541 // Positional args
542 if (usesPositionalArg()) {
543 os << getPositionalArgIndex() << "$";
544 }
545
546 // Conversion flags
547 if (IsLeftJustified) os << "-";
548 if (HasPlusPrefix) os << "+";
549 if (HasSpacePrefix) os << " ";
550 if (HasAlternativeForm) os << "#";
551 if (HasLeadingZeroes) os << "0";
552
553 // Minimum field width
554 FieldWidth.toString(os);
555 // Precision
556 Precision.toString(os);
557 // Length modifier
558 os << LM.toString();
559 // Conversion specifier
560 os << CS.toString();
561}
Tom Careb49ec692010-06-17 19:00:27 +0000562
Ted Kremenek02087932010-07-16 02:11:22 +0000563bool PrintfSpecifier::hasValidPlusPrefix() const {
Tom Careb49ec692010-06-17 19:00:27 +0000564 if (!HasPlusPrefix)
565 return true;
566
567 // The plus prefix only makes sense for signed conversions
568 switch (CS.getKind()) {
569 case ConversionSpecifier::dArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000570 case ConversionSpecifier::DArg:
Tom Careb49ec692010-06-17 19:00:27 +0000571 case ConversionSpecifier::iArg:
572 case ConversionSpecifier::fArg:
573 case ConversionSpecifier::FArg:
574 case ConversionSpecifier::eArg:
575 case ConversionSpecifier::EArg:
576 case ConversionSpecifier::gArg:
577 case ConversionSpecifier::GArg:
578 case ConversionSpecifier::aArg:
579 case ConversionSpecifier::AArg:
580 return true;
581
582 default:
583 return false;
584 }
585}
586
Ted Kremenek02087932010-07-16 02:11:22 +0000587bool PrintfSpecifier::hasValidAlternativeForm() const {
Tom Careb49ec692010-06-17 19:00:27 +0000588 if (!HasAlternativeForm)
589 return true;
590
Anders Carlssona369f8d2010-11-21 18:34:21 +0000591 // Alternate form flag only valid with the oxXaAeEfFgG conversions
Tom Careb49ec692010-06-17 19:00:27 +0000592 switch (CS.getKind()) {
593 case ConversionSpecifier::oArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000594 case ConversionSpecifier::OArg:
Tom Careb49ec692010-06-17 19:00:27 +0000595 case ConversionSpecifier::xArg:
Anders Carlssona369f8d2010-11-21 18:34:21 +0000596 case ConversionSpecifier::XArg:
Tom Careb49ec692010-06-17 19:00:27 +0000597 case ConversionSpecifier::aArg:
598 case ConversionSpecifier::AArg:
599 case ConversionSpecifier::eArg:
600 case ConversionSpecifier::EArg:
601 case ConversionSpecifier::fArg:
602 case ConversionSpecifier::FArg:
603 case ConversionSpecifier::gArg:
604 case ConversionSpecifier::GArg:
605 return true;
606
607 default:
608 return false;
609 }
610}
611
Ted Kremenek02087932010-07-16 02:11:22 +0000612bool PrintfSpecifier::hasValidLeadingZeros() const {
Tom Careb49ec692010-06-17 19:00:27 +0000613 if (!HasLeadingZeroes)
614 return true;
615
616 // Leading zeroes flag only valid with the diouxXaAeEfFgG conversions
617 switch (CS.getKind()) {
618 case ConversionSpecifier::dArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000619 case ConversionSpecifier::DArg:
Tom Careb49ec692010-06-17 19:00:27 +0000620 case ConversionSpecifier::iArg:
621 case ConversionSpecifier::oArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000622 case ConversionSpecifier::OArg:
Tom Careb49ec692010-06-17 19:00:27 +0000623 case ConversionSpecifier::uArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000624 case ConversionSpecifier::UArg:
Tom Careb49ec692010-06-17 19:00:27 +0000625 case ConversionSpecifier::xArg:
626 case ConversionSpecifier::XArg:
627 case ConversionSpecifier::aArg:
628 case ConversionSpecifier::AArg:
629 case ConversionSpecifier::eArg:
630 case ConversionSpecifier::EArg:
631 case ConversionSpecifier::fArg:
632 case ConversionSpecifier::FArg:
633 case ConversionSpecifier::gArg:
634 case ConversionSpecifier::GArg:
635 return true;
636
637 default:
638 return false;
639 }
640}
641
Ted Kremenek02087932010-07-16 02:11:22 +0000642bool PrintfSpecifier::hasValidSpacePrefix() const {
Tom Careb49ec692010-06-17 19:00:27 +0000643 if (!HasSpacePrefix)
644 return true;
645
646 // The space prefix only makes sense for signed conversions
647 switch (CS.getKind()) {
648 case ConversionSpecifier::dArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000649 case ConversionSpecifier::DArg:
Tom Careb49ec692010-06-17 19:00:27 +0000650 case ConversionSpecifier::iArg:
651 case ConversionSpecifier::fArg:
652 case ConversionSpecifier::FArg:
653 case ConversionSpecifier::eArg:
654 case ConversionSpecifier::EArg:
655 case ConversionSpecifier::gArg:
656 case ConversionSpecifier::GArg:
657 case ConversionSpecifier::aArg:
658 case ConversionSpecifier::AArg:
659 return true;
660
661 default:
662 return false;
663 }
664}
665
Ted Kremenek02087932010-07-16 02:11:22 +0000666bool PrintfSpecifier::hasValidLeftJustified() const {
Tom Careb49ec692010-06-17 19:00:27 +0000667 if (!IsLeftJustified)
668 return true;
669
670 // The left justified flag is valid for all conversions except n
671 switch (CS.getKind()) {
Ted Kremenek516ef222010-07-20 20:04:10 +0000672 case ConversionSpecifier::nArg:
Tom Careb49ec692010-06-17 19:00:27 +0000673 return false;
674
675 default:
676 return true;
677 }
678}
679
Ted Kremenekbf4832c2011-01-08 05:28:46 +0000680bool PrintfSpecifier::hasValidThousandsGroupingPrefix() const {
681 if (!HasThousandsGrouping)
682 return true;
NAKAMURA Takumif9cbcc42011-01-27 07:10:08 +0000683
Ted Kremenekbf4832c2011-01-08 05:28:46 +0000684 switch (CS.getKind()) {
685 case ConversionSpecifier::dArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000686 case ConversionSpecifier::DArg:
Ted Kremenekbf4832c2011-01-08 05:28:46 +0000687 case ConversionSpecifier::iArg:
688 case ConversionSpecifier::uArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000689 case ConversionSpecifier::UArg:
Ted Kremenekbf4832c2011-01-08 05:28:46 +0000690 case ConversionSpecifier::fArg:
691 case ConversionSpecifier::FArg:
692 case ConversionSpecifier::gArg:
693 case ConversionSpecifier::GArg:
694 return true;
695 default:
696 return false;
697 }
698}
699
Ted Kremenek02087932010-07-16 02:11:22 +0000700bool PrintfSpecifier::hasValidPrecision() const {
Tom Careb49ec692010-06-17 19:00:27 +0000701 if (Precision.getHowSpecified() == OptionalAmount::NotSpecified)
702 return true;
703
704 // Precision is only valid with the diouxXaAeEfFgGs conversions
705 switch (CS.getKind()) {
706 case ConversionSpecifier::dArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000707 case ConversionSpecifier::DArg:
Tom Careb49ec692010-06-17 19:00:27 +0000708 case ConversionSpecifier::iArg:
709 case ConversionSpecifier::oArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000710 case ConversionSpecifier::OArg:
Tom Careb49ec692010-06-17 19:00:27 +0000711 case ConversionSpecifier::uArg:
Jordan Rose510260c2012-09-13 02:11:03 +0000712 case ConversionSpecifier::UArg:
Tom Careb49ec692010-06-17 19:00:27 +0000713 case ConversionSpecifier::xArg:
714 case ConversionSpecifier::XArg:
715 case ConversionSpecifier::aArg:
716 case ConversionSpecifier::AArg:
717 case ConversionSpecifier::eArg:
718 case ConversionSpecifier::EArg:
719 case ConversionSpecifier::fArg:
720 case ConversionSpecifier::FArg:
721 case ConversionSpecifier::gArg:
722 case ConversionSpecifier::GArg:
Ted Kremenek563e3ed2010-07-20 20:03:58 +0000723 case ConversionSpecifier::sArg:
Tom Careb49ec692010-06-17 19:00:27 +0000724 return true;
725
726 default:
727 return false;
728 }
729}
Ted Kremenek02087932010-07-16 02:11:22 +0000730bool PrintfSpecifier::hasValidFieldWidth() const {
Tom Careb49ec692010-06-17 19:00:27 +0000731 if (FieldWidth.getHowSpecified() == OptionalAmount::NotSpecified)
732 return true;
733
734 // The field width is valid for all conversions except n
735 switch (CS.getKind()) {
Ted Kremenek516ef222010-07-20 20:04:10 +0000736 case ConversionSpecifier::nArg:
Tom Careb49ec692010-06-17 19:00:27 +0000737 return false;
738
739 default:
740 return true;
741 }
742}