blob: e409ab03653507934b8124cb3cccae6a4bb340a1 [file] [log] [blame]
Chris Lattner22eb9722006-06-18 05:43:12 +00001//===--- Preprocess.cpp - C Language Family Preprocessor Implementation ---===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner5b12ab82007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Chris Lattner22eb9722006-06-18 05:43:12 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This file implements the Preprocessor interface.
11//
12//===----------------------------------------------------------------------===//
13//
Chris Lattner22eb9722006-06-18 05:43:12 +000014// Options to support:
15// -H - Print the name of each header file used.
Chris Lattner1630c3c2009-02-06 06:45:26 +000016// -d[DNI] - Dump various things.
Chris Lattner22eb9722006-06-18 05:43:12 +000017// -fworking-directory - #line's with preprocessor's working dir.
18// -fpreprocessed
19// -dependency-file,-M,-MM,-MF,-MG,-MP,-MT,-MQ,-MD,-MMD
20// -W*
21// -w
22//
23// Messages to emit:
24// "Multiple include guards may be useful for:\n"
25//
Chris Lattner22eb9722006-06-18 05:43:12 +000026//===----------------------------------------------------------------------===//
27
28#include "clang/Lex/Preprocessor.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000029#include "clang/Basic/FileManager.h"
David Blaikie23430cc2014-08-11 21:29:24 +000030#include "clang/Basic/FileSystemStatCache.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000031#include "clang/Basic/SourceManager.h"
32#include "clang/Basic/TargetInfo.h"
33#include "clang/Lex/CodeCompletionHandler.h"
Douglas Gregor9882a5a2010-01-04 19:18:44 +000034#include "clang/Lex/ExternalPreprocessorSource.h"
Chris Lattner07b019a2006-10-22 07:28:56 +000035#include "clang/Lex/HeaderSearch.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000036#include "clang/Lex/LexDiagnostic.h"
37#include "clang/Lex/LiteralSupport.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000038#include "clang/Lex/MacroArgs.h"
Chris Lattner22eb9722006-06-18 05:43:12 +000039#include "clang/Lex/MacroInfo.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000040#include "clang/Lex/ModuleLoader.h"
Reid Kleckner738d48d2015-11-02 17:53:55 +000041#include "clang/Lex/PTHManager.h"
Chris Lattnerb8761832006-06-24 21:31:03 +000042#include "clang/Lex/Pragma.h"
Douglas Gregor7f6d60d2010-03-19 16:15:56 +000043#include "clang/Lex/PreprocessingRecord.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000044#include "clang/Lex/PreprocessorOptions.h"
Chris Lattner0b8cfc22006-06-28 06:49:17 +000045#include "clang/Lex/ScratchBuffer.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000046#include "llvm/ADT/APInt.h"
47#include "llvm/ADT/DenseMap.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000048#include "llvm/ADT/SmallString.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000049#include "llvm/ADT/SmallVector.h"
50#include "llvm/ADT/STLExtras.h"
51#include "llvm/ADT/StringRef.h"
Mehdi Amini9670f842016-07-18 19:02:11 +000052#include "llvm/ADT/StringSwitch.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000053#include "llvm/Support/Capacity.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000054#include "llvm/Support/ErrorHandling.h"
Chris Lattner8a7003c2007-07-16 06:48:38 +000055#include "llvm/Support/MemoryBuffer.h"
Benjamin Kramer89b422c2009-08-23 12:08:50 +000056#include "llvm/Support/raw_ostream.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000057#include <algorithm>
58#include <cassert>
59#include <memory>
60#include <string>
Benjamin Kramercfeacf52016-05-27 14:27:13 +000061#include <utility>
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000062#include <vector>
63
Chris Lattner22eb9722006-06-18 05:43:12 +000064using namespace clang;
65
John Brawn4d79ec72016-08-05 11:01:08 +000066LLVM_INSTANTIATE_REGISTRY(PragmaHandlerRegistry)
NAKAMURA Takumicacd94e2016-04-04 15:30:44 +000067
Chris Lattner22eb9722006-06-18 05:43:12 +000068//===----------------------------------------------------------------------===//
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +000069ExternalPreprocessorSource::~ExternalPreprocessorSource() { }
Chris Lattner22eb9722006-06-18 05:43:12 +000070
David Blaikiee3041682017-01-05 19:11:36 +000071Preprocessor::Preprocessor(std::shared_ptr<PreprocessorOptions> PPOpts,
Douglas Gregor1452ff12012-10-24 17:46:57 +000072 DiagnosticsEngine &diags, LangOptions &opts,
Duncan P. N. Exon Smith030d7d62017-03-20 17:58:26 +000073 SourceManager &SM, MemoryBufferCache &PCMCache,
74 HeaderSearch &Headers, ModuleLoader &TheModuleLoader,
David Blaikie687cd952013-01-16 23:13:36 +000075 IdentifierInfoLookup *IILookup, bool OwnsHeaders,
Alp Toker1ae02f62014-05-02 03:43:30 +000076 TranslationUnitKind TUKind)
Benjamin Kramercfeacf52016-05-27 14:27:13 +000077 : PPOpts(std::move(PPOpts)), Diags(&diags), LangOpts(opts), Target(nullptr),
Artem Belevichb5bc9232015-09-22 17:23:22 +000078 AuxTarget(nullptr), FileMgr(Headers.getFileMgr()), SourceMgr(SM),
Duncan P. N. Exon Smith030d7d62017-03-20 17:58:26 +000079 PCMCache(PCMCache), ScratchBuf(new ScratchBuffer(SourceMgr)),
80 HeaderInfo(Headers), TheModuleLoader(TheModuleLoader),
81 ExternalSource(nullptr), Identifiers(opts, IILookup),
Craig Topperbe250302014-09-12 05:19:24 +000082 PragmaHandlers(new PragmaNamespace(StringRef())),
Artem Belevichb5bc9232015-09-22 17:23:22 +000083 IncrementalProcessing(false), TUKind(TUKind), CodeComplete(nullptr),
84 CodeCompletionFile(nullptr), CodeCompletionOffset(0),
85 LastTokenWasAt(false), ModuleImportExpectsIdentifier(false),
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000086 CodeCompletionReached(false), CodeCompletionII(nullptr),
87 MainFileDir(nullptr), SkipMainFilePreamble(0, true), CurPPLexer(nullptr),
Richard Smithd1386302017-05-04 00:29:54 +000088 CurDirLookup(nullptr), CurLexerKind(CLK_Lexer),
89 CurLexerSubmodule(nullptr), Callbacks(nullptr),
90 CurSubmoduleState(&NullSubmoduleState), MacroArgCache(nullptr),
91 Record(nullptr), MIChainHead(nullptr), DeserialMIChainHead(nullptr) {
Daniel Dunbar0c6c9302009-11-11 21:44:21 +000092 OwnsHeaderSearch = OwnsHeaders;
Douglas Gregor83297df2011-09-01 23:39:15 +000093
Douglas Gregor83297df2011-09-01 23:39:15 +000094 CounterValue = 0; // __COUNTER__ starts at 0.
95
96 // Clear stats.
97 NumDirectives = NumDefined = NumUndefined = NumPragma = 0;
98 NumIf = NumElse = NumEndif = 0;
99 NumEnteredSourceFiles = 0;
100 NumMacroExpanded = NumFnMacroExpanded = NumBuiltinMacroExpanded = 0;
101 NumFastMacroExpanded = NumTokenPaste = NumFastTokenPaste = 0;
102 MaxIncludeStackDepth = 0;
103 NumSkipped = 0;
104
105 // Default to discarding comments.
106 KeepComments = false;
107 KeepMacroComments = false;
108 SuppressIncludeNotFoundError = false;
109
110 // Macro expansion is enabled.
111 DisableMacroExpansion = false;
David Blaikied5321242012-06-06 18:52:13 +0000112 MacroExpansionInDirectivesOverride = false;
Douglas Gregor83297df2011-09-01 23:39:15 +0000113 InMacroArgs = false;
Argyrios Kyrtzidisf1b64c62012-04-03 16:47:40 +0000114 InMacroArgPreExpansion = false;
Douglas Gregor83297df2011-09-01 23:39:15 +0000115 NumCachedTokenLexers = 0;
Jordan Rosede1a2922012-06-08 18:06:21 +0000116 PragmasEnabled = true;
Eric Christopher5e4696d2013-01-16 20:09:36 +0000117 ParsingIfOrElifDirective = false;
Jordan Rose324ec422013-01-31 19:26:01 +0000118 PreprocessedOutput = false;
Jordan Rosede1a2922012-06-08 18:06:21 +0000119
Douglas Gregor83297df2011-09-01 23:39:15 +0000120 CachedLexPos = 0;
Eric Christopher5e4696d2013-01-16 20:09:36 +0000121
Douglas Gregor83297df2011-09-01 23:39:15 +0000122 // We haven't read anything from the external source.
123 ReadMacrosFromExternalSource = false;
124
Douglas Gregor83297df2011-09-01 23:39:15 +0000125 // "Poison" __VA_ARGS__, which can only appear in the expansion of a macro.
126 // This gets unpoisoned where it is allowed.
127 (Ident__VA_ARGS__ = getIdentifierInfo("__VA_ARGS__"))->setIsPoisoned();
128 SetPoisonReason(Ident__VA_ARGS__,diag::ext_pp_bad_vaargs_use);
129
130 // Initialize the pragma handlers.
Douglas Gregor83297df2011-09-01 23:39:15 +0000131 RegisterBuiltinPragmas();
132
133 // Initialize builtin macros like __LINE__ and friends.
134 RegisterBuiltinMacros();
135
David Blaikiebbafb8a2012-03-11 07:00:24 +0000136 if(LangOpts.Borland) {
Douglas Gregor83297df2011-09-01 23:39:15 +0000137 Ident__exception_info = getIdentifierInfo("_exception_info");
138 Ident___exception_info = getIdentifierInfo("__exception_info");
139 Ident_GetExceptionInfo = getIdentifierInfo("GetExceptionInformation");
140 Ident__exception_code = getIdentifierInfo("_exception_code");
141 Ident___exception_code = getIdentifierInfo("__exception_code");
142 Ident_GetExceptionCode = getIdentifierInfo("GetExceptionCode");
143 Ident__abnormal_termination = getIdentifierInfo("_abnormal_termination");
144 Ident___abnormal_termination = getIdentifierInfo("__abnormal_termination");
145 Ident_AbnormalTermination = getIdentifierInfo("AbnormalTermination");
146 } else {
Craig Topperd2d442c2014-05-17 23:10:59 +0000147 Ident__exception_info = Ident__exception_code = nullptr;
148 Ident__abnormal_termination = Ident___exception_info = nullptr;
149 Ident___exception_code = Ident___abnormal_termination = nullptr;
150 Ident_GetExceptionInfo = Ident_GetExceptionCode = nullptr;
151 Ident_AbnormalTermination = nullptr;
Douglas Gregor89929282012-01-30 06:01:29 +0000152 }
Argyrios Kyrtzidis3c9aaf12012-06-02 18:08:09 +0000153}
154
155Preprocessor::~Preprocessor() {
156 assert(BacktrackPositions.empty() && "EnableBacktrack/Backtrack imbalance!");
157
Benjamin Kramer329c5962014-03-15 16:40:40 +0000158 IncludeMacroStack.clear();
Argyrios Kyrtzidis3c9aaf12012-06-02 18:08:09 +0000159
Richard Smith73a29662014-07-24 03:25:00 +0000160 // Destroy any macro definitions.
161 while (MacroInfoChain *I = MIChainHead) {
162 MIChainHead = I->Next;
163 I->~MacroInfoChain();
164 }
Argyrios Kyrtzidis3c9aaf12012-06-02 18:08:09 +0000165
166 // Free any cached macro expanders.
Nico Weber5f5b9412014-05-09 18:09:42 +0000167 // This populates MacroArgCache, so all TokenLexers need to be destroyed
168 // before the code below that frees up the MacroArgCache list.
David Blaikie6d5038c2014-08-29 19:36:52 +0000169 std::fill(TokenLexerCache, TokenLexerCache + NumCachedTokenLexers, nullptr);
Nico Weber5f5b9412014-05-09 18:09:42 +0000170 CurTokenLexer.reset();
Argyrios Kyrtzidis3c9aaf12012-06-02 18:08:09 +0000171
Richard Smith73a29662014-07-24 03:25:00 +0000172 while (DeserializedMacroInfoChain *I = DeserialMIChainHead) {
173 DeserialMIChainHead = I->Next;
174 I->~DeserializedMacroInfoChain();
175 }
Argyrios Kyrtzidisd48b91d2013-04-30 05:05:35 +0000176
Argyrios Kyrtzidis3c9aaf12012-06-02 18:08:09 +0000177 // Free any cached MacroArgs.
Nico Weber5f5b9412014-05-09 18:09:42 +0000178 for (MacroArgs *ArgList = MacroArgCache; ArgList;)
Argyrios Kyrtzidis3c9aaf12012-06-02 18:08:09 +0000179 ArgList = ArgList->deallocate();
180
Argyrios Kyrtzidis3c9aaf12012-06-02 18:08:09 +0000181 // Delete the header search info, if we own it.
182 if (OwnsHeaderSearch)
183 delete &HeaderInfo;
Argyrios Kyrtzidis3c9aaf12012-06-02 18:08:09 +0000184}
185
Artem Belevichb5bc9232015-09-22 17:23:22 +0000186void Preprocessor::Initialize(const TargetInfo &Target,
187 const TargetInfo *AuxTarget) {
Argyrios Kyrtzidis3c9aaf12012-06-02 18:08:09 +0000188 assert((!this->Target || this->Target == &Target) &&
189 "Invalid override of target information");
190 this->Target = &Target;
Artem Belevichb5bc9232015-09-22 17:23:22 +0000191
192 assert((!this->AuxTarget || this->AuxTarget == AuxTarget) &&
193 "Invalid override of aux target information.");
194 this->AuxTarget = AuxTarget;
195
Argyrios Kyrtzidis3c9aaf12012-06-02 18:08:09 +0000196 // Initialize information about built-ins.
Artem Belevichb5bc9232015-09-22 17:23:22 +0000197 BuiltinInfo.InitializeTarget(Target, AuxTarget);
Douglas Gregor89929282012-01-30 06:01:29 +0000198 HeaderInfo.setTarget(Target);
Douglas Gregor83297df2011-09-01 23:39:15 +0000199}
200
Ted Kremenekeeccb302014-08-27 15:14:15 +0000201void Preprocessor::InitializeForModelFile() {
202 NumEnteredSourceFiles = 0;
203
204 // Reset pragmas
David Blaikie9f0af9d2014-09-15 21:31:42 +0000205 PragmaHandlersBackup = std::move(PragmaHandlers);
Craig Topperbe250302014-09-12 05:19:24 +0000206 PragmaHandlers = llvm::make_unique<PragmaNamespace>(StringRef());
Ted Kremenekeeccb302014-08-27 15:14:15 +0000207 RegisterBuiltinPragmas();
208
209 // Reset PredefinesFileID
210 PredefinesFileID = FileID();
211}
212
213void Preprocessor::FinalizeForModelFile() {
214 NumEnteredSourceFiles = 1;
215
David Blaikie9f0af9d2014-09-15 21:31:42 +0000216 PragmaHandlers = std::move(PragmaHandlersBackup);
Ted Kremenekeeccb302014-08-27 15:14:15 +0000217}
218
Ted Kremeneka5c2c272009-02-12 03:26:59 +0000219void Preprocessor::setPTHManager(PTHManager* pm) {
220 PTH.reset(pm);
Douglas Gregord2eb58a2009-10-16 18:18:30 +0000221 FileMgr.addStatCache(PTH->createStatCache());
Ted Kremeneka5c2c272009-02-12 03:26:59 +0000222}
223
Chris Lattner146762e2007-07-20 16:59:19 +0000224void Preprocessor::DumpToken(const Token &Tok, bool DumpFlags) const {
Benjamin Kramer89b422c2009-08-23 12:08:50 +0000225 llvm::errs() << tok::getTokenName(Tok.getKind()) << " '"
226 << getSpelling(Tok) << "'";
Mike Stump11289f42009-09-09 15:08:12 +0000227
Chris Lattnerd01e2912006-06-18 16:22:51 +0000228 if (!DumpFlags) return;
Mike Stump11289f42009-09-09 15:08:12 +0000229
Benjamin Kramer89b422c2009-08-23 12:08:50 +0000230 llvm::errs() << "\t";
Chris Lattnerd01e2912006-06-18 16:22:51 +0000231 if (Tok.isAtStartOfLine())
Benjamin Kramer89b422c2009-08-23 12:08:50 +0000232 llvm::errs() << " [StartOfLine]";
Chris Lattnerd01e2912006-06-18 16:22:51 +0000233 if (Tok.hasLeadingSpace())
Benjamin Kramer89b422c2009-08-23 12:08:50 +0000234 llvm::errs() << " [LeadingSpace]";
Chris Lattner6e4bf522006-07-27 06:59:25 +0000235 if (Tok.isExpandDisabled())
Benjamin Kramer89b422c2009-08-23 12:08:50 +0000236 llvm::errs() << " [ExpandDisabled]";
Chris Lattnerd01e2912006-06-18 16:22:51 +0000237 if (Tok.needsCleaning()) {
Chris Lattner50b497e2006-06-18 16:32:35 +0000238 const char *Start = SourceMgr.getCharacterData(Tok.getLocation());
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000239 llvm::errs() << " [UnClean='" << StringRef(Start, Tok.getLength())
Benjamin Kramer89b422c2009-08-23 12:08:50 +0000240 << "']";
Chris Lattnerd01e2912006-06-18 16:22:51 +0000241 }
Mike Stump11289f42009-09-09 15:08:12 +0000242
Benjamin Kramer89b422c2009-08-23 12:08:50 +0000243 llvm::errs() << "\tLoc=<";
Chris Lattner615315f2007-12-09 20:31:55 +0000244 DumpLocation(Tok.getLocation());
Benjamin Kramer89b422c2009-08-23 12:08:50 +0000245 llvm::errs() << ">";
Chris Lattner615315f2007-12-09 20:31:55 +0000246}
247
248void Preprocessor::DumpLocation(SourceLocation Loc) const {
Chris Lattnerf1ca7d32009-01-27 07:57:44 +0000249 Loc.dump(SourceMgr);
Chris Lattnerd01e2912006-06-18 16:22:51 +0000250}
251
252void Preprocessor::DumpMacro(const MacroInfo &MI) const {
Benjamin Kramer89b422c2009-08-23 12:08:50 +0000253 llvm::errs() << "MACRO: ";
Chris Lattnerd01e2912006-06-18 16:22:51 +0000254 for (unsigned i = 0, e = MI.getNumTokens(); i != e; ++i) {
255 DumpToken(MI.getReplacementToken(i));
Benjamin Kramer89b422c2009-08-23 12:08:50 +0000256 llvm::errs() << " ";
Chris Lattnerd01e2912006-06-18 16:22:51 +0000257 }
Benjamin Kramer89b422c2009-08-23 12:08:50 +0000258 llvm::errs() << "\n";
Chris Lattnerd01e2912006-06-18 16:22:51 +0000259}
260
Chris Lattner22eb9722006-06-18 05:43:12 +0000261void Preprocessor::PrintStats() {
Benjamin Kramer89b422c2009-08-23 12:08:50 +0000262 llvm::errs() << "\n*** Preprocessor Stats:\n";
263 llvm::errs() << NumDirectives << " directives found:\n";
264 llvm::errs() << " " << NumDefined << " #define.\n";
265 llvm::errs() << " " << NumUndefined << " #undef.\n";
266 llvm::errs() << " #include/#include_next/#import:\n";
267 llvm::errs() << " " << NumEnteredSourceFiles << " source files entered.\n";
268 llvm::errs() << " " << MaxIncludeStackDepth << " max include stack depth\n";
269 llvm::errs() << " " << NumIf << " #if/#ifndef/#ifdef.\n";
270 llvm::errs() << " " << NumElse << " #else/#elif.\n";
271 llvm::errs() << " " << NumEndif << " #endif.\n";
272 llvm::errs() << " " << NumPragma << " #pragma.\n";
273 llvm::errs() << NumSkipped << " #if/#ifndef#ifdef regions skipped\n";
Chris Lattner22eb9722006-06-18 05:43:12 +0000274
Benjamin Kramer89b422c2009-08-23 12:08:50 +0000275 llvm::errs() << NumMacroExpanded << "/" << NumFnMacroExpanded << "/"
Ted Kremeneka0a3e9b2008-01-14 16:44:48 +0000276 << NumBuiltinMacroExpanded << " obj/fn/builtin macros expanded, "
277 << NumFastMacroExpanded << " on the fast path.\n";
Benjamin Kramer89b422c2009-08-23 12:08:50 +0000278 llvm::errs() << (NumFastTokenPaste+NumTokenPaste)
Ted Kremeneka0a3e9b2008-01-14 16:44:48 +0000279 << " token paste (##) operations performed, "
280 << NumFastTokenPaste << " on the fast path.\n";
Alexander Kornienko199cd942012-08-13 10:46:42 +0000281
282 llvm::errs() << "\nPreprocessor Memory: " << getTotalMemory() << "B total";
283
284 llvm::errs() << "\n BumpPtr: " << BP.getTotalMemory();
285 llvm::errs() << "\n Macro Expanded Tokens: "
286 << llvm::capacity_in_bytes(MacroExpandedTokens);
287 llvm::errs() << "\n Predefines Buffer: " << Predefines.capacity();
Richard Smith04765ae2015-05-21 01:20:10 +0000288 // FIXME: List information for all submodules.
289 llvm::errs() << "\n Macros: "
290 << llvm::capacity_in_bytes(CurSubmoduleState->Macros);
Alexander Kornienko199cd942012-08-13 10:46:42 +0000291 llvm::errs() << "\n #pragma push_macro Info: "
292 << llvm::capacity_in_bytes(PragmaPushMacroInfo);
293 llvm::errs() << "\n Poison Reasons: "
294 << llvm::capacity_in_bytes(PoisonReasons);
295 llvm::errs() << "\n Comment Handlers: "
296 << llvm::capacity_in_bytes(CommentHandlers) << "\n";
Chris Lattner22eb9722006-06-18 05:43:12 +0000297}
298
Kovarththanan Rajaratnamba2c6522010-03-13 10:17:05 +0000299Preprocessor::macro_iterator
300Preprocessor::macro_begin(bool IncludeExternalMacros) const {
301 if (IncludeExternalMacros && ExternalSource &&
Douglas Gregor9882a5a2010-01-04 19:18:44 +0000302 !ReadMacrosFromExternalSource) {
303 ReadMacrosFromExternalSource = true;
304 ExternalSource->ReadDefinedMacros();
305 }
Kovarththanan Rajaratnamba2c6522010-03-13 10:17:05 +0000306
Jordan Rosea46bfa62015-06-24 19:27:02 +0000307 // Make sure we cover all macros in visible modules.
308 for (const ModuleMacro &Macro : ModuleMacros)
309 CurSubmoduleState->Macros.insert(std::make_pair(Macro.II, MacroState()));
310
Richard Smith04765ae2015-05-21 01:20:10 +0000311 return CurSubmoduleState->Macros.begin();
Douglas Gregor9882a5a2010-01-04 19:18:44 +0000312}
313
Argyrios Kyrtzidise379ee32011-06-29 22:20:04 +0000314size_t Preprocessor::getTotalMemory() const {
Ted Kremenek182543a2011-07-26 21:17:24 +0000315 return BP.getTotalMemory()
Ted Kremenek8b77fe72011-07-27 18:41:23 +0000316 + llvm::capacity_in_bytes(MacroExpandedTokens)
Ted Kremenek182543a2011-07-26 21:17:24 +0000317 + Predefines.capacity() /* Predefines buffer. */
Richard Smith04765ae2015-05-21 01:20:10 +0000318 // FIXME: Include sizes from all submodules, and include MacroInfo sizes,
319 // and ModuleMacros.
320 + llvm::capacity_in_bytes(CurSubmoduleState->Macros)
Ted Kremenek8b77fe72011-07-27 18:41:23 +0000321 + llvm::capacity_in_bytes(PragmaPushMacroInfo)
322 + llvm::capacity_in_bytes(PoisonReasons)
323 + llvm::capacity_in_bytes(CommentHandlers);
Argyrios Kyrtzidise379ee32011-06-29 22:20:04 +0000324}
325
Kovarththanan Rajaratnamba2c6522010-03-13 10:17:05 +0000326Preprocessor::macro_iterator
327Preprocessor::macro_end(bool IncludeExternalMacros) const {
328 if (IncludeExternalMacros && ExternalSource &&
Douglas Gregor9882a5a2010-01-04 19:18:44 +0000329 !ReadMacrosFromExternalSource) {
330 ReadMacrosFromExternalSource = true;
331 ExternalSource->ReadDefinedMacros();
332 }
Kovarththanan Rajaratnamba2c6522010-03-13 10:17:05 +0000333
Richard Smith04765ae2015-05-21 01:20:10 +0000334 return CurSubmoduleState->Macros.end();
Douglas Gregor9882a5a2010-01-04 19:18:44 +0000335}
336
Dmitri Gribenko6743e042012-09-29 11:40:46 +0000337/// \brief Compares macro tokens with a specified token value sequence.
338static bool MacroDefinitionEquals(const MacroInfo *MI,
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000339 ArrayRef<TokenValue> Tokens) {
Dmitri Gribenko6743e042012-09-29 11:40:46 +0000340 return Tokens.size() == MI->getNumTokens() &&
341 std::equal(Tokens.begin(), Tokens.end(), MI->tokens_begin());
342}
343
344StringRef Preprocessor::getLastMacroWithSpelling(
345 SourceLocation Loc,
346 ArrayRef<TokenValue> Tokens) const {
347 SourceLocation BestLocation;
348 StringRef BestSpelling;
349 for (Preprocessor::macro_iterator I = macro_begin(), E = macro_end();
350 I != E; ++I) {
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +0000351 const MacroDirective::DefInfo
Richard Smithb8b2ed62015-04-23 18:18:26 +0000352 Def = I->second.findDirectiveAtLoc(Loc, SourceMgr);
Argyrios Kyrtzidis5c585252015-03-04 16:03:07 +0000353 if (!Def || !Def.getMacroInfo())
354 continue;
355 if (!Def.getMacroInfo()->isObjectLike())
Dmitri Gribenko6743e042012-09-29 11:40:46 +0000356 continue;
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +0000357 if (!MacroDefinitionEquals(Def.getMacroInfo(), Tokens))
Dmitri Gribenko6743e042012-09-29 11:40:46 +0000358 continue;
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +0000359 SourceLocation Location = Def.getLocation();
Dmitri Gribenko6743e042012-09-29 11:40:46 +0000360 // Choose the macro defined latest.
361 if (BestLocation.isInvalid() ||
362 (Location.isValid() &&
363 SourceMgr.isBeforeInTranslationUnit(BestLocation, Location))) {
364 BestLocation = Location;
365 BestSpelling = I->first->getName();
366 }
367 }
368 return BestSpelling;
369}
370
Douglas Gregor8d76cca2012-01-04 06:20:15 +0000371void Preprocessor::recomputeCurLexerKind() {
372 if (CurLexer)
373 CurLexerKind = CLK_Lexer;
374 else if (CurPTHLexer)
375 CurLexerKind = CLK_PTHLexer;
376 else if (CurTokenLexer)
377 CurLexerKind = CLK_TokenLexer;
378 else
379 CurLexerKind = CLK_CachingLexer;
380}
381
Kovarththanan Rajaratnamba2c6522010-03-13 10:17:05 +0000382bool Preprocessor::SetCodeCompletionPoint(const FileEntry *File,
Argyrios Kyrtzidis5cec2ae2011-09-04 03:32:15 +0000383 unsigned CompleteLine,
384 unsigned CompleteColumn) {
385 assert(File);
386 assert(CompleteLine && CompleteColumn && "Starts from 1:1");
387 assert(!CodeCompletionFile && "Already set");
388
Douglas Gregor53ad6b92009-12-02 06:49:09 +0000389 using llvm::MemoryBuffer;
390
Douglas Gregor53ad6b92009-12-02 06:49:09 +0000391 // Load the actual file's contents.
Douglas Gregor26266da2010-03-16 19:49:24 +0000392 bool Invalid = false;
393 const MemoryBuffer *Buffer = SourceMgr.getMemoryBufferForFile(File, &Invalid);
394 if (Invalid)
Douglas Gregor53ad6b92009-12-02 06:49:09 +0000395 return true;
396
397 // Find the byte position of the truncation point.
398 const char *Position = Buffer->getBufferStart();
Argyrios Kyrtzidis5cec2ae2011-09-04 03:32:15 +0000399 for (unsigned Line = 1; Line < CompleteLine; ++Line) {
Douglas Gregor53ad6b92009-12-02 06:49:09 +0000400 for (; *Position; ++Position) {
401 if (*Position != '\r' && *Position != '\n')
402 continue;
Kovarththanan Rajaratnamba2c6522010-03-13 10:17:05 +0000403
Douglas Gregor53ad6b92009-12-02 06:49:09 +0000404 // Eat \r\n or \n\r as a single line.
405 if ((Position[1] == '\r' || Position[1] == '\n') &&
406 Position[0] != Position[1])
407 ++Position;
408 ++Position;
409 break;
410 }
411 }
Kovarththanan Rajaratnamba2c6522010-03-13 10:17:05 +0000412
Argyrios Kyrtzidis5cec2ae2011-09-04 03:32:15 +0000413 Position += CompleteColumn - 1;
Argyrios Kyrtzidisee301f92014-10-18 06:23:50 +0000414
415 // If pointing inside the preamble, adjust the position at the beginning of
416 // the file after the preamble.
417 if (SkipMainFilePreamble.first &&
418 SourceMgr.getFileEntryForID(SourceMgr.getMainFileID()) == File) {
419 if (Position - Buffer->getBufferStart() < SkipMainFilePreamble.first)
420 Position = Buffer->getBufferStart() + SkipMainFilePreamble.first;
421 }
422
Argyrios Kyrtzidise62d6822014-10-18 06:19:36 +0000423 if (Position > Buffer->getBufferEnd())
424 Position = Buffer->getBufferEnd();
Kovarththanan Rajaratnamba2c6522010-03-13 10:17:05 +0000425
Argyrios Kyrtzidise62d6822014-10-18 06:19:36 +0000426 CodeCompletionFile = File;
427 CodeCompletionOffset = Position - Buffer->getBufferStart();
Argyrios Kyrtzidis5cec2ae2011-09-04 03:32:15 +0000428
Argyrios Kyrtzidise62d6822014-10-18 06:19:36 +0000429 std::unique_ptr<MemoryBuffer> NewBuffer =
430 MemoryBuffer::getNewUninitMemBuffer(Buffer->getBufferSize() + 1,
431 Buffer->getBufferIdentifier());
432 char *NewBuf = const_cast<char*>(NewBuffer->getBufferStart());
433 char *NewPos = std::copy(Buffer->getBufferStart(), Position, NewBuf);
434 *NewPos = '\0';
435 std::copy(Position, Buffer->getBufferEnd(), NewPos+1);
436 SourceMgr.overrideFileContents(File, std::move(NewBuffer));
Douglas Gregor53ad6b92009-12-02 06:49:09 +0000437
438 return false;
439}
440
Douglas Gregor11583702010-08-25 17:04:25 +0000441void Preprocessor::CodeCompleteNaturalLanguage() {
Douglas Gregor11583702010-08-25 17:04:25 +0000442 if (CodeComplete)
443 CodeComplete->CodeCompleteNaturalLanguage();
Argyrios Kyrtzidis5cec2ae2011-09-04 03:32:15 +0000444 setCodeCompletionReached();
Douglas Gregor11583702010-08-25 17:04:25 +0000445}
446
Benjamin Kramera197fb62010-02-27 17:05:45 +0000447/// getSpelling - This method is used to get the spelling of a token into a
448/// SmallVector. Note that the returned StringRef may not point to the
449/// supplied buffer if a copy can be avoided.
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000450StringRef Preprocessor::getSpelling(const Token &Tok,
451 SmallVectorImpl<char> &Buffer,
Douglas Gregor7bda4b82010-03-16 05:20:39 +0000452 bool *Invalid) const {
Abramo Bagnaraea4f7c72010-12-22 08:23:18 +0000453 // NOTE: this has to be checked *before* testing for an IdentifierInfo.
Jordan Rose7f43ddd2013-01-24 20:50:46 +0000454 if (Tok.isNot(tok::raw_identifier) && !Tok.hasUCN()) {
Abramo Bagnaraea4f7c72010-12-22 08:23:18 +0000455 // Try the fast path.
456 if (const IdentifierInfo *II = Tok.getIdentifierInfo())
457 return II->getName();
458 }
Benjamin Kramera197fb62010-02-27 17:05:45 +0000459
460 // Resize the buffer if we need to copy into it.
461 if (Tok.needsCleaning())
462 Buffer.resize(Tok.getLength());
463
464 const char *Ptr = Buffer.data();
Douglas Gregor7bda4b82010-03-16 05:20:39 +0000465 unsigned Len = getSpelling(Tok, Ptr, Invalid);
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000466 return StringRef(Ptr, Len);
Benjamin Kramera197fb62010-02-27 17:05:45 +0000467}
468
Chris Lattnerb94ec7b2006-07-14 06:54:10 +0000469/// CreateString - Plop the specified string into a scratch buffer and return a
470/// location for it. If specified, the source location provides a source
471/// location for the token.
Dmitri Gribenkob8e9e752012-09-24 21:07:17 +0000472void Preprocessor::CreateString(StringRef Str, Token &Tok,
Abramo Bagnarae398e602011-10-03 18:39:03 +0000473 SourceLocation ExpansionLocStart,
474 SourceLocation ExpansionLocEnd) {
Dmitri Gribenkob8e9e752012-09-24 21:07:17 +0000475 Tok.setLength(Str.size());
Mike Stump11289f42009-09-09 15:08:12 +0000476
Chris Lattner5a7971e2009-01-26 19:29:26 +0000477 const char *DestPtr;
Dmitri Gribenkob8e9e752012-09-24 21:07:17 +0000478 SourceLocation Loc = ScratchBuf->getToken(Str.data(), Str.size(), DestPtr);
Mike Stump11289f42009-09-09 15:08:12 +0000479
Abramo Bagnarae398e602011-10-03 18:39:03 +0000480 if (ExpansionLocStart.isValid())
481 Loc = SourceMgr.createExpansionLoc(Loc, ExpansionLocStart,
Dmitri Gribenkob8e9e752012-09-24 21:07:17 +0000482 ExpansionLocEnd, Str.size());
Chris Lattner5a7971e2009-01-26 19:29:26 +0000483 Tok.setLocation(Loc);
Mike Stump11289f42009-09-09 15:08:12 +0000484
Abramo Bagnaraea4f7c72010-12-22 08:23:18 +0000485 // If this is a raw identifier or a literal token, set the pointer data.
486 if (Tok.is(tok::raw_identifier))
487 Tok.setRawIdentifierData(DestPtr);
488 else if (Tok.isLiteral())
Chris Lattner5a7971e2009-01-26 19:29:26 +0000489 Tok.setLiteralData(DestPtr);
Chris Lattnerb94ec7b2006-07-14 06:54:10 +0000490}
491
Douglas Gregor2b82c2a2011-12-02 01:47:07 +0000492Module *Preprocessor::getCurrentModule() {
Richard Smithbbcc9f02016-08-26 00:14:38 +0000493 if (!getLangOpts().isCompilingModule())
Craig Topperd2d442c2014-05-17 23:10:59 +0000494 return nullptr;
495
David Blaikiebbafb8a2012-03-11 07:00:24 +0000496 return getHeaderSearchInfo().lookupModule(getLangOpts().CurrentModule);
Douglas Gregor2b82c2a2011-12-02 01:47:07 +0000497}
Chris Lattner8a7003c2007-07-16 06:48:38 +0000498
Chris Lattner1f1b0db2007-10-09 22:10:18 +0000499//===----------------------------------------------------------------------===//
500// Preprocessor Initialization Methods
501//===----------------------------------------------------------------------===//
502
Chris Lattner1f1b0db2007-10-09 22:10:18 +0000503/// EnterMainSourceFile - Enter the specified FileID as the main source file,
Nate Begemanf7c3ff62008-01-07 04:01:26 +0000504/// which implicitly adds the builtin defines etc.
Chris Lattnerfb24a3a2010-04-20 20:35:58 +0000505void Preprocessor::EnterMainSourceFile() {
Chris Lattner9ef847b2009-02-13 19:33:24 +0000506 // We do not allow the preprocessor to reenter the main file. Doing so will
507 // cause FileID's to accumulate information from both runs (e.g. #line
508 // information) and predefined macros aren't guaranteed to be set properly.
509 assert(NumEnteredSourceFiles == 0 && "Cannot reenter the main file!");
Chris Lattnerd32480d2009-01-17 06:22:33 +0000510 FileID MainFileID = SourceMgr.getMainFileID();
Mike Stump11289f42009-09-09 15:08:12 +0000511
Argyrios Kyrtzidis9afd4492012-01-05 21:36:25 +0000512 // If MainFileID is loaded it means we loaded an AST file, no need to enter
513 // a main file.
514 if (!SourceMgr.isLoadedFileID(MainFileID)) {
515 // Enter the main file source buffer.
Craig Topperd2d442c2014-05-17 23:10:59 +0000516 EnterSourceFile(MainFileID, nullptr, SourceLocation());
517
Argyrios Kyrtzidis9afd4492012-01-05 21:36:25 +0000518 // If we've been asked to skip bytes in the main file (e.g., as part of a
519 // precompiled preamble), do so now.
520 if (SkipMainFilePreamble.first > 0)
521 CurLexer->SkipBytes(SkipMainFilePreamble.first,
522 SkipMainFilePreamble.second);
523
524 // Tell the header info that the main file was entered. If the file is later
525 // #imported, it won't be re-entered.
526 if (const FileEntry *FE = SourceMgr.getFileEntryForID(MainFileID))
527 HeaderInfo.IncrementIncludeCount(FE);
528 }
Mike Stump11289f42009-09-09 15:08:12 +0000529
Benjamin Kramerd77adb52009-12-31 15:33:09 +0000530 // Preprocess Predefines to populate the initial preprocessor state.
Rafael Espindolad87f8d72014-08-27 20:03:29 +0000531 std::unique_ptr<llvm::MemoryBuffer> SB =
Chris Lattner58c79342010-04-05 22:42:27 +0000532 llvm::MemoryBuffer::getMemBufferCopy(Predefines, "<built-in>");
Douglas Gregor33551892010-08-26 14:07:34 +0000533 assert(SB && "Cannot create predefined source buffer");
David Blaikie50a5f972014-08-29 07:59:55 +0000534 FileID FID = SourceMgr.createFileID(std::move(SB));
Yaron Keren8b563662015-10-03 10:46:20 +0000535 assert(FID.isValid() && "Could not create FileID for predefines?");
Argyrios Kyrtzidis22c22f52013-02-01 16:36:07 +0000536 setPredefinesFileID(FID);
Mike Stump11289f42009-09-09 15:08:12 +0000537
Chris Lattner1f1b0db2007-10-09 22:10:18 +0000538 // Start parsing the predefines.
Craig Topperd2d442c2014-05-17 23:10:59 +0000539 EnterSourceFile(FID, nullptr, SourceLocation());
Chris Lattner1f1b0db2007-10-09 22:10:18 +0000540}
Chris Lattner8a7003c2007-07-16 06:48:38 +0000541
Daniel Dunbarcb9eaf52010-03-23 05:09:10 +0000542void Preprocessor::EndSourceFile() {
543 // Notify the client that we reached the end of the source file.
544 if (Callbacks)
545 Callbacks->EndOfMainFile();
546}
Chris Lattner677757a2006-06-28 05:26:32 +0000547
548//===----------------------------------------------------------------------===//
549// Lexer Event Handling.
550//===----------------------------------------------------------------------===//
551
Abramo Bagnaraea4f7c72010-12-22 08:23:18 +0000552/// LookUpIdentifierInfo - Given a tok::raw_identifier token, look up the
553/// identifier information for the token and install it into the token,
554/// updating the token kind accordingly.
555IdentifierInfo *Preprocessor::LookUpIdentifierInfo(Token &Identifier) const {
Alp Toker2d57cea2014-05-17 04:53:25 +0000556 assert(!Identifier.getRawIdentifier().empty() && "No raw identifier data!");
Mike Stump11289f42009-09-09 15:08:12 +0000557
Chris Lattnercefc7682006-07-08 08:28:12 +0000558 // Look up this token, see if it is a macro, or if it is a language keyword.
559 IdentifierInfo *II;
Jordan Rose7f43ddd2013-01-24 20:50:46 +0000560 if (!Identifier.needsCleaning() && !Identifier.hasUCN()) {
Chris Lattnercefc7682006-07-08 08:28:12 +0000561 // No cleaning needed, just use the characters from the lexed buffer.
Alp Toker2d57cea2014-05-17 04:53:25 +0000562 II = getIdentifierInfo(Identifier.getRawIdentifier());
Chris Lattnercefc7682006-07-08 08:28:12 +0000563 } else {
564 // Cleaning needed, alloca a buffer, clean into it, then use the buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000565 SmallString<64> IdentifierBuffer;
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000566 StringRef CleanedStr = getSpelling(Identifier, IdentifierBuffer);
Jordan Rose7f43ddd2013-01-24 20:50:46 +0000567
568 if (Identifier.hasUCN()) {
569 SmallString<64> UCNIdentifierBuffer;
570 expandUCNs(UCNIdentifierBuffer, CleanedStr);
571 II = getIdentifierInfo(UCNIdentifierBuffer);
572 } else {
573 II = getIdentifierInfo(CleanedStr);
574 }
Chris Lattnercefc7682006-07-08 08:28:12 +0000575 }
Abramo Bagnaraea4f7c72010-12-22 08:23:18 +0000576
577 // Update the token info (identifier info and appropriate token kind).
Chris Lattner8c204872006-10-14 05:19:21 +0000578 Identifier.setIdentifierInfo(II);
Abramo Bagnaraea4f7c72010-12-22 08:23:18 +0000579 Identifier.setKind(II->getTokenID());
580
Chris Lattnercefc7682006-07-08 08:28:12 +0000581 return II;
582}
583
John Wiegley1c0675e2011-04-28 01:08:34 +0000584void Preprocessor::SetPoisonReason(IdentifierInfo *II, unsigned DiagID) {
585 PoisonReasons[II] = DiagID;
586}
587
588void Preprocessor::PoisonSEHIdentifiers(bool Poison) {
589 assert(Ident__exception_code && Ident__exception_info);
590 assert(Ident___exception_code && Ident___exception_info);
591 Ident__exception_code->setIsPoisoned(Poison);
592 Ident___exception_code->setIsPoisoned(Poison);
593 Ident_GetExceptionCode->setIsPoisoned(Poison);
594 Ident__exception_info->setIsPoisoned(Poison);
595 Ident___exception_info->setIsPoisoned(Poison);
596 Ident_GetExceptionInfo->setIsPoisoned(Poison);
597 Ident__abnormal_termination->setIsPoisoned(Poison);
598 Ident___abnormal_termination->setIsPoisoned(Poison);
599 Ident_AbnormalTermination->setIsPoisoned(Poison);
600}
601
602void Preprocessor::HandlePoisonedIdentifier(Token & Identifier) {
603 assert(Identifier.getIdentifierInfo() &&
604 "Can't handle identifiers without identifier info!");
605 llvm::DenseMap<IdentifierInfo*,unsigned>::const_iterator it =
606 PoisonReasons.find(Identifier.getIdentifierInfo());
607 if(it == PoisonReasons.end())
608 Diag(Identifier, diag::err_pp_used_poisoned_id);
609 else
610 Diag(Identifier,it->second) << Identifier.getIdentifierInfo();
611}
Chris Lattnercefc7682006-07-08 08:28:12 +0000612
Richard Smith31d51842015-05-14 04:00:59 +0000613/// \brief Returns a diagnostic message kind for reporting a future keyword as
614/// appropriate for the identifier and specified language.
615static diag::kind getFutureCompatDiagKind(const IdentifierInfo &II,
616 const LangOptions &LangOpts) {
617 assert(II.isFutureCompatKeyword() && "diagnostic should not be needed");
618
619 if (LangOpts.CPlusPlus)
620 return llvm::StringSwitch<diag::kind>(II.getName())
621#define CXX11_KEYWORD(NAME, FLAGS) \
622 .Case(#NAME, diag::warn_cxx11_keyword)
623#include "clang/Basic/TokenKinds.def"
624 ;
625
626 llvm_unreachable(
627 "Keyword not known to come from a newer Standard or proposed Standard");
628}
629
Richard Smith3dba7eb2016-08-18 01:16:55 +0000630void Preprocessor::updateOutOfDateIdentifier(IdentifierInfo &II) const {
631 assert(II.isOutOfDate() && "not out of date");
632 getExternalSource()->updateOutOfDateIdentifier(II);
633}
634
Chris Lattner677757a2006-06-28 05:26:32 +0000635/// HandleIdentifier - This callback is invoked when the lexer reads an
636/// identifier. This callback looks up the identifier in the map and/or
637/// potentially macro expands it or turns it into a named token (like 'for').
Chris Lattnerad89ec02009-01-21 07:43:11 +0000638///
639/// Note that callers of this method are guarded by checking the
640/// IdentifierInfo's 'isHandleIdentifierCase' bit. If this method changes, the
641/// IdentifierInfo methods that compute these properties will need to change to
642/// match.
Eli Friedman0834a4b2013-09-19 00:41:32 +0000643bool Preprocessor::HandleIdentifier(Token &Identifier) {
Chris Lattner0f1f5052006-07-20 04:16:23 +0000644 assert(Identifier.getIdentifierInfo() &&
645 "Can't handle identifiers without identifier info!");
Mike Stump11289f42009-09-09 15:08:12 +0000646
Chris Lattnerc79f6fb2006-07-04 17:53:21 +0000647 IdentifierInfo &II = *Identifier.getIdentifierInfo();
Chris Lattner677757a2006-06-28 05:26:32 +0000648
Douglas Gregor935bc7a22011-10-27 09:33:13 +0000649 // If the information about this identifier is out of date, update it from
650 // the external source.
Douglas Gregor3f568c12012-06-29 18:27:59 +0000651 // We have to treat __VA_ARGS__ in a special way, since it gets
652 // serialized with isPoisoned = true, but our preprocessor may have
653 // unpoisoned it if we're defining a C99 macro.
Douglas Gregor935bc7a22011-10-27 09:33:13 +0000654 if (II.isOutOfDate()) {
Douglas Gregor3f568c12012-06-29 18:27:59 +0000655 bool CurrentIsPoisoned = false;
656 if (&II == Ident__VA_ARGS__)
657 CurrentIsPoisoned = Ident__VA_ARGS__->isPoisoned();
658
Richard Smith3dba7eb2016-08-18 01:16:55 +0000659 updateOutOfDateIdentifier(II);
Douglas Gregor935bc7a22011-10-27 09:33:13 +0000660 Identifier.setKind(II.getTokenID());
Douglas Gregor3f568c12012-06-29 18:27:59 +0000661
662 if (&II == Ident__VA_ARGS__)
663 II.setIsPoisoned(CurrentIsPoisoned);
Douglas Gregor935bc7a22011-10-27 09:33:13 +0000664 }
665
Chris Lattner677757a2006-06-28 05:26:32 +0000666 // If this identifier was poisoned, and if it was not produced from a macro
667 // expansion, emit an error.
Ted Kremeneka2c3c8d2008-11-19 22:43:49 +0000668 if (II.isPoisoned() && CurPPLexer) {
John Wiegley1c0675e2011-04-28 01:08:34 +0000669 HandlePoisonedIdentifier(Identifier);
Chris Lattner8ff71992006-07-06 05:17:39 +0000670 }
Mike Stump11289f42009-09-09 15:08:12 +0000671
Chris Lattner78186052006-07-09 00:45:31 +0000672 // If this is a macro to be expanded, do it.
Richard Smith20e883e2015-04-29 23:20:19 +0000673 if (MacroDefinition MD = getMacroDefinition(&II)) {
674 auto *MI = MD.getMacroInfo();
Richard Smithf5ec2ac2015-04-29 23:40:48 +0000675 assert(MI && "macro definition with no macro info?");
Abramo Bagnara123bec82012-01-01 22:01:04 +0000676 if (!DisableMacroExpansion) {
Richard Smith181879c2012-12-12 02:46:14 +0000677 if (!Identifier.isExpandDisabled() && MI->isEnabled()) {
Eli Friedman0834a4b2013-09-19 00:41:32 +0000678 // C99 6.10.3p10: If the preprocessing token immediately after the
679 // macro name isn't a '(', this macro should not be expanded.
680 if (!MI->isFunctionLike() || isNextPPTokenLParen())
681 return HandleMacroExpandedIdentifier(Identifier, MD);
Chris Lattner6e4bf522006-07-27 06:59:25 +0000682 } else {
683 // C99 6.10.3.4p2 says that a disabled macro may never again be
684 // expanded, even if it's in a context where it could be expanded in the
685 // future.
Chris Lattner146762e2007-07-20 16:59:19 +0000686 Identifier.setFlag(Token::DisableExpand);
Richard Smith181879c2012-12-12 02:46:14 +0000687 if (MI->isObjectLike() || isNextPPTokenLParen())
688 Diag(Identifier, diag::pp_disabled_macro_expansion);
Chris Lattner6e4bf522006-07-27 06:59:25 +0000689 }
690 }
Chris Lattner063400e2006-10-14 19:54:15 +0000691 }
Chris Lattner677757a2006-06-28 05:26:32 +0000692
Richard Smith31d51842015-05-14 04:00:59 +0000693 // If this identifier is a keyword in a newer Standard or proposed Standard,
694 // produce a warning. Don't warn if we're not considering macro expansion,
695 // since this identifier might be the name of a macro.
Richard Smith4dd85d62011-10-11 19:57:52 +0000696 // FIXME: This warning is disabled in cases where it shouldn't be, like
697 // "#define constexpr constexpr", "int constexpr;"
Richard Smith31d51842015-05-14 04:00:59 +0000698 if (II.isFutureCompatKeyword() && !DisableMacroExpansion) {
699 Diag(Identifier, getFutureCompatDiagKind(II, getLangOpts()))
700 << II.getName();
Richard Smith4dd85d62011-10-11 19:57:52 +0000701 // Don't diagnose this keyword again in this translation unit.
Richard Smith31d51842015-05-14 04:00:59 +0000702 II.setIsFutureCompatKeyword(false);
Richard Smith4dd85d62011-10-11 19:57:52 +0000703 }
704
Chris Lattner5b9f4892006-11-21 17:23:33 +0000705 // C++ 2.11p2: If this is an alternative representation of a C++ operator,
706 // then we act as if it is the actual operator and not the textual
707 // representation of it.
Fariborz Jahanian9e42a952010-09-03 17:33:04 +0000708 if (II.isCPlusPlusOperatorKeyword())
Craig Topperd2d442c2014-05-17 23:10:59 +0000709 Identifier.setIdentifierInfo(nullptr);
Chris Lattner5b9f4892006-11-21 17:23:33 +0000710
Chris Lattner677757a2006-06-28 05:26:32 +0000711 // If this is an extension token, diagnose its use.
Steve Naroffc84e8b72008-09-02 18:50:17 +0000712 // We avoid diagnosing tokens that originate from macro definitions.
Eli Friedman6bba2ad2009-04-28 03:59:15 +0000713 // FIXME: This warning is disabled in cases where it shouldn't be,
714 // like "#define TY typeof", "TY(1) x".
715 if (II.isExtensionToken() && !DisableMacroExpansion)
Chris Lattner53621a52007-06-13 20:44:40 +0000716 Diag(Identifier, diag::ext_token_used);
Douglas Gregoraf5c4842011-09-07 23:11:54 +0000717
Douglas Gregor594b8c92013-11-07 22:55:02 +0000718 // If this is the 'import' contextual keyword following an '@', note
Ted Kremenekc1e4dd02012-03-01 22:07:04 +0000719 // that the next token indicates a module name.
Douglas Gregor8d76cca2012-01-04 06:20:15 +0000720 //
Douglas Gregorc50d4922012-12-11 22:11:52 +0000721 // Note that we do not treat 'import' as a contextual
Ted Kremenekc1e4dd02012-03-01 22:07:04 +0000722 // keyword when we're in a caching lexer, because caching lexers only get
723 // used in contexts where import declarations are disallowed.
Richard Smith49cc1cc2016-08-18 21:59:42 +0000724 //
725 // Likewise if this is the C++ Modules TS import keyword.
726 if (((LastTokenWasAt && II.isModulesImport()) ||
727 Identifier.is(tok::kw_import)) &&
728 !InMacroArgs && !DisableMacroExpansion &&
729 (getLangOpts().Modules || getLangOpts().DebuggerSupport) &&
Douglas Gregor594b8c92013-11-07 22:55:02 +0000730 CurLexerKind != CLK_CachingLexer) {
Douglas Gregoraf5c4842011-09-07 23:11:54 +0000731 ModuleImportLoc = Identifier.getLocation();
Douglas Gregor1805b8a2011-11-30 04:26:53 +0000732 ModuleImportPath.clear();
733 ModuleImportExpectsIdentifier = true;
Douglas Gregoraf5c4842011-09-07 23:11:54 +0000734 CurLexerKind = CLK_LexAfterModuleImport;
735 }
Eli Friedman0834a4b2013-09-19 00:41:32 +0000736 return true;
Douglas Gregor08142532011-08-26 23:56:07 +0000737}
738
Eli Friedman0834a4b2013-09-19 00:41:32 +0000739void Preprocessor::Lex(Token &Result) {
Yaron Keren716f3a62015-09-29 16:51:08 +0000740 // We loop here until a lex function returns a token; this avoids recursion.
Eli Friedman0834a4b2013-09-19 00:41:32 +0000741 bool ReturnedToken;
742 do {
743 switch (CurLexerKind) {
744 case CLK_Lexer:
745 ReturnedToken = CurLexer->Lex(Result);
746 break;
747 case CLK_PTHLexer:
748 ReturnedToken = CurPTHLexer->Lex(Result);
749 break;
750 case CLK_TokenLexer:
751 ReturnedToken = CurTokenLexer->Lex(Result);
752 break;
753 case CLK_CachingLexer:
754 CachingLex(Result);
755 ReturnedToken = true;
756 break;
757 case CLK_LexAfterModuleImport:
758 LexAfterModuleImport(Result);
759 ReturnedToken = true;
760 break;
761 }
762 } while (!ReturnedToken);
Douglas Gregor594b8c92013-11-07 22:55:02 +0000763
Vassil Vassilev644ea612016-07-27 14:56:59 +0000764 if (Result.is(tok::code_completion))
765 setCodeCompletionIdentifierInfo(Result.getIdentifierInfo());
766
Douglas Gregor594b8c92013-11-07 22:55:02 +0000767 LastTokenWasAt = Result.is(tok::at);
Eli Friedman0834a4b2013-09-19 00:41:32 +0000768}
769
Douglas Gregorda82e702012-01-03 19:32:59 +0000770/// \brief Lex a token following the 'import' contextual keyword.
Douglas Gregor22d09742012-01-03 18:04:46 +0000771///
Douglas Gregoraf5c4842011-09-07 23:11:54 +0000772void Preprocessor::LexAfterModuleImport(Token &Result) {
773 // Figure out what kind of lexer we actually have.
Douglas Gregor8d76cca2012-01-04 06:20:15 +0000774 recomputeCurLexerKind();
Douglas Gregoraf5c4842011-09-07 23:11:54 +0000775
776 // Lex the next token.
777 Lex(Result);
778
Douglas Gregor08142532011-08-26 23:56:07 +0000779 // The token sequence
780 //
Douglas Gregor22d09742012-01-03 18:04:46 +0000781 // import identifier (. identifier)*
782 //
Douglas Gregorda82e702012-01-03 19:32:59 +0000783 // indicates a module import directive. We already saw the 'import'
784 // contextual keyword, so now we're looking for the identifiers.
Douglas Gregor1805b8a2011-11-30 04:26:53 +0000785 if (ModuleImportExpectsIdentifier && Result.getKind() == tok::identifier) {
786 // We expected to see an identifier here, and we did; continue handling
787 // identifiers.
788 ModuleImportPath.push_back(std::make_pair(Result.getIdentifierInfo(),
789 Result.getLocation()));
790 ModuleImportExpectsIdentifier = false;
791 CurLexerKind = CLK_LexAfterModuleImport;
Douglas Gregor08142532011-08-26 23:56:07 +0000792 return;
Douglas Gregor1805b8a2011-11-30 04:26:53 +0000793 }
Douglas Gregor08142532011-08-26 23:56:07 +0000794
Douglas Gregor1805b8a2011-11-30 04:26:53 +0000795 // If we're expecting a '.' or a ';', and we got a '.', then wait until we
Richard Smith49cc1cc2016-08-18 21:59:42 +0000796 // see the next identifier. (We can also see a '[[' that begins an
797 // attribute-specifier-seq here under the C++ Modules TS.)
Douglas Gregor1805b8a2011-11-30 04:26:53 +0000798 if (!ModuleImportExpectsIdentifier && Result.getKind() == tok::period) {
799 ModuleImportExpectsIdentifier = true;
800 CurLexerKind = CLK_LexAfterModuleImport;
801 return;
802 }
803
804 // If we have a non-empty module path, load the named module.
Sean Callanan87596492014-12-09 23:47:56 +0000805 if (!ModuleImportPath.empty()) {
Richard Smithbbcc9f02016-08-26 00:14:38 +0000806 // Under the Modules TS, the dot is just part of the module name, and not
807 // a real hierarachy separator. Flatten such module names now.
808 //
809 // FIXME: Is this the right level to be performing this transformation?
810 std::string FlatModuleName;
811 if (getLangOpts().ModulesTS) {
812 for (auto &Piece : ModuleImportPath) {
813 if (!FlatModuleName.empty())
814 FlatModuleName += ".";
815 FlatModuleName += Piece.first->getName();
816 }
817 SourceLocation FirstPathLoc = ModuleImportPath[0].second;
818 ModuleImportPath.clear();
819 ModuleImportPath.push_back(
820 std::make_pair(getIdentifierInfo(FlatModuleName), FirstPathLoc));
821 }
822
Sean Callanan87596492014-12-09 23:47:56 +0000823 Module *Imported = nullptr;
Richard Smith753e0072015-04-27 23:21:38 +0000824 if (getLangOpts().Modules) {
Sean Callanan87596492014-12-09 23:47:56 +0000825 Imported = TheModuleLoader.loadModule(ModuleImportLoc,
826 ModuleImportPath,
Richard Smith10434f32015-05-02 02:08:26 +0000827 Module::Hidden,
Sean Callanan87596492014-12-09 23:47:56 +0000828 /*IsIncludeDirective=*/false);
Richard Smitha7e2cc62015-05-01 01:53:09 +0000829 if (Imported)
830 makeModuleVisible(Imported, ModuleImportLoc);
Richard Smith753e0072015-04-27 23:21:38 +0000831 }
Sean Callanan87596492014-12-09 23:47:56 +0000832 if (Callbacks && (getLangOpts().Modules || getLangOpts().DebuggerSupport))
Argyrios Kyrtzidis19d78b72012-09-29 01:06:10 +0000833 Callbacks->moduleImport(ModuleImportLoc, ModuleImportPath, Imported);
834 }
Chris Lattner677757a2006-06-28 05:26:32 +0000835}
Douglas Gregorc6d5edd2009-07-02 17:08:52 +0000836
Richard Smitha7e2cc62015-05-01 01:53:09 +0000837void Preprocessor::makeModuleVisible(Module *M, SourceLocation Loc) {
Richard Smith04765ae2015-05-21 01:20:10 +0000838 CurSubmoduleState->VisibleModules.setVisible(
Richard Smitha7e2cc62015-05-01 01:53:09 +0000839 M, Loc, [](Module *) {},
840 [&](ArrayRef<Module *> Path, Module *Conflict, StringRef Message) {
841 // FIXME: Include the path in the diagnostic.
842 // FIXME: Include the import location for the conflicting module.
843 Diag(ModuleImportLoc, diag::warn_module_conflict)
844 << Path[0]->getFullModuleName()
845 << Conflict->getFullModuleName()
846 << Message;
847 });
848
849 // Add this module to the imports list of the currently-built submodule.
Richard Smithdbbc5232015-05-14 02:25:44 +0000850 if (!BuildingSubmoduleStack.empty() && M != BuildingSubmoduleStack.back().M)
Richard Smith38477db2015-05-02 00:45:56 +0000851 BuildingSubmoduleStack.back().M->Imports.insert(M);
Richard Smitha7e2cc62015-05-01 01:53:09 +0000852}
853
Andy Gibbs58905d22012-11-17 19:15:38 +0000854bool Preprocessor::FinishLexStringLiteral(Token &Result, std::string &String,
Andy Gibbsa8df57a2012-11-17 19:16:52 +0000855 const char *DiagnosticTag,
Andy Gibbs58905d22012-11-17 19:15:38 +0000856 bool AllowMacroExpansion) {
857 // We need at least one string literal.
858 if (Result.isNot(tok::string_literal)) {
Andy Gibbsa8df57a2012-11-17 19:16:52 +0000859 Diag(Result, diag::err_expected_string_literal)
860 << /*Source='in...'*/0 << DiagnosticTag;
Andy Gibbs58905d22012-11-17 19:15:38 +0000861 return false;
862 }
863
864 // Lex string literal tokens, optionally with macro expansion.
865 SmallVector<Token, 4> StrToks;
866 do {
867 StrToks.push_back(Result);
868
869 if (Result.hasUDSuffix())
870 Diag(Result, diag::err_invalid_string_udl);
871
872 if (AllowMacroExpansion)
873 Lex(Result);
874 else
875 LexUnexpandedToken(Result);
876 } while (Result.is(tok::string_literal));
877
878 // Concatenate and parse the strings.
Craig Topper9d5583e2014-06-26 04:58:39 +0000879 StringLiteralParser Literal(StrToks, *this);
Andy Gibbs58905d22012-11-17 19:15:38 +0000880 assert(Literal.isAscii() && "Didn't allow wide strings in");
881
882 if (Literal.hadError)
883 return false;
884
885 if (Literal.Pascal) {
Andy Gibbsa8df57a2012-11-17 19:16:52 +0000886 Diag(StrToks[0].getLocation(), diag::err_expected_string_literal)
887 << /*Source='in...'*/0 << DiagnosticTag;
Andy Gibbs58905d22012-11-17 19:15:38 +0000888 return false;
889 }
890
891 String = Literal.GetString();
892 return true;
893}
894
Reid Klecknerc0dca6d2014-02-12 23:50:26 +0000895bool Preprocessor::parseSimpleIntegerLiteral(Token &Tok, uint64_t &Value) {
896 assert(Tok.is(tok::numeric_constant));
897 SmallString<8> IntegerBuffer;
898 bool NumberInvalid = false;
899 StringRef Spelling = getSpelling(Tok, IntegerBuffer, &NumberInvalid);
900 if (NumberInvalid)
901 return false;
902 NumericLiteralParser Literal(Spelling, Tok.getLocation(), *this);
903 if (Literal.hadError || !Literal.isIntegerLiteral() || Literal.hasUDSuffix())
904 return false;
905 llvm::APInt APVal(64, 0);
906 if (Literal.GetIntegerValue(APVal))
907 return false;
908 Lex(Tok);
909 Value = APVal.getLimitedValue();
910 return true;
911}
912
Dmitri Gribenkoaab83832012-06-20 00:34:58 +0000913void Preprocessor::addCommentHandler(CommentHandler *Handler) {
Douglas Gregorc6d5edd2009-07-02 17:08:52 +0000914 assert(Handler && "NULL comment handler");
915 assert(std::find(CommentHandlers.begin(), CommentHandlers.end(), Handler) ==
916 CommentHandlers.end() && "Comment handler already registered");
917 CommentHandlers.push_back(Handler);
918}
919
Dmitri Gribenkoaab83832012-06-20 00:34:58 +0000920void Preprocessor::removeCommentHandler(CommentHandler *Handler) {
Douglas Gregorc6d5edd2009-07-02 17:08:52 +0000921 std::vector<CommentHandler *>::iterator Pos
922 = std::find(CommentHandlers.begin(), CommentHandlers.end(), Handler);
923 assert(Pos != CommentHandlers.end() && "Comment handler not registered");
924 CommentHandlers.erase(Pos);
925}
926
Chris Lattner87d02082010-01-18 22:35:47 +0000927bool Preprocessor::HandleComment(Token &result, SourceRange Comment) {
928 bool AnyPendingTokens = false;
Douglas Gregorc6d5edd2009-07-02 17:08:52 +0000929 for (std::vector<CommentHandler *>::iterator H = CommentHandlers.begin(),
930 HEnd = CommentHandlers.end();
Chris Lattner87d02082010-01-18 22:35:47 +0000931 H != HEnd; ++H) {
932 if ((*H)->HandleComment(*this, Comment))
933 AnyPendingTokens = true;
934 }
935 if (!AnyPendingTokens || getCommentRetentionState())
936 return false;
937 Lex(result);
938 return true;
Douglas Gregorc6d5edd2009-07-02 17:08:52 +0000939}
940
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +0000941ModuleLoader::~ModuleLoader() { }
Douglas Gregor08142532011-08-26 23:56:07 +0000942
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +0000943CommentHandler::~CommentHandler() { }
Douglas Gregor7f6d60d2010-03-19 16:15:56 +0000944
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +0000945CodeCompletionHandler::~CodeCompletionHandler() { }
Douglas Gregor3a7ad252010-08-24 19:08:16 +0000946
Argyrios Kyrtzidisf3d587e2012-12-04 07:27:05 +0000947void Preprocessor::createPreprocessingRecord() {
Douglas Gregor7f6d60d2010-03-19 16:15:56 +0000948 if (Record)
949 return;
950
Argyrios Kyrtzidisf3d587e2012-12-04 07:27:05 +0000951 Record = new PreprocessingRecord(getSourceManager());
Craig Topperb8a70532014-09-10 04:53:53 +0000952 addPPCallbacks(std::unique_ptr<PPCallbacks>(Record));
Douglas Gregor7f6d60d2010-03-19 16:15:56 +0000953}