Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 1 | //===--- Preprocess.cpp - C Language Family Preprocessor Implementation ---===// |
| 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
Chris Lattner | 0bc735f | 2007-12-29 19:59:25 +0000 | [diff] [blame] | 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
| 9 | // |
| 10 | // This file implements the Preprocessor interface. |
| 11 | // |
| 12 | //===----------------------------------------------------------------------===// |
| 13 | // |
| 14 | // Options to support: |
| 15 | // -H - Print the name of each header file used. |
Chris Lattner | f73903a | 2009-02-06 06:45:26 +0000 | [diff] [blame] | 16 | // -d[DNI] - Dump various things. |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 17 | // -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 | // |
| 26 | //===----------------------------------------------------------------------===// |
| 27 | |
| 28 | #include "clang/Lex/Preprocessor.h" |
Chris Lattner | 23f77e5 | 2009-12-15 01:51:03 +0000 | [diff] [blame] | 29 | #include "MacroArgs.h" |
Douglas Gregor | 88a3586 | 2010-01-04 19:18:44 +0000 | [diff] [blame] | 30 | #include "clang/Lex/ExternalPreprocessorSource.h" |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 31 | #include "clang/Lex/HeaderSearch.h" |
| 32 | #include "clang/Lex/MacroInfo.h" |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 33 | #include "clang/Lex/Pragma.h" |
Douglas Gregor | 94dc8f6 | 2010-03-19 16:15:56 +0000 | [diff] [blame] | 34 | #include "clang/Lex/PreprocessingRecord.h" |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 35 | #include "clang/Lex/ScratchBuffer.h" |
Chris Lattner | 500d329 | 2009-01-29 05:15:15 +0000 | [diff] [blame] | 36 | #include "clang/Lex/LexDiagnostic.h" |
Douglas Gregor | f44e854 | 2010-08-24 19:08:16 +0000 | [diff] [blame] | 37 | #include "clang/Lex/CodeCompletionHandler.h" |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 38 | #include "clang/Basic/SourceManager.h" |
Ted Kremenek | 337edcd | 2009-02-12 03:26:59 +0000 | [diff] [blame] | 39 | #include "clang/Basic/FileManager.h" |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 40 | #include "clang/Basic/TargetInfo.h" |
Chris Lattner | 2db78dd | 2008-10-05 20:40:30 +0000 | [diff] [blame] | 41 | #include "llvm/ADT/APFloat.h" |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 42 | #include "llvm/ADT/SmallVector.h" |
Chris Lattner | 97ba77c | 2007-07-16 06:48:38 +0000 | [diff] [blame] | 43 | #include "llvm/Support/MemoryBuffer.h" |
Benjamin Kramer | 6cb7c1a | 2009-08-23 12:08:50 +0000 | [diff] [blame] | 44 | #include "llvm/Support/raw_ostream.h" |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 45 | using namespace clang; |
| 46 | |
| 47 | //===----------------------------------------------------------------------===// |
Douglas Gregor | 88a3586 | 2010-01-04 19:18:44 +0000 | [diff] [blame] | 48 | ExternalPreprocessorSource::~ExternalPreprocessorSource() { } |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 49 | |
| 50 | Preprocessor::Preprocessor(Diagnostic &diags, const LangOptions &opts, |
Daniel Dunbar | 444be73 | 2009-11-13 05:51:54 +0000 | [diff] [blame] | 51 | const TargetInfo &target, SourceManager &SM, |
Ted Kremenek | 72b1b15 | 2009-01-15 18:47:46 +0000 | [diff] [blame] | 52 | HeaderSearch &Headers, |
Daniel Dunbar | 5814e65 | 2009-11-11 21:44:21 +0000 | [diff] [blame] | 53 | IdentifierInfoLookup* IILookup, |
| 54 | bool OwnsHeaders) |
Chris Lattner | 836040f | 2009-03-13 21:17:43 +0000 | [diff] [blame] | 55 | : Diags(&diags), Features(opts), Target(target),FileMgr(Headers.getFileMgr()), |
Chris Lattner | 39b49bc | 2010-11-23 08:35:12 +0000 | [diff] [blame^] | 56 | SourceMgr(SM), |
Argyrios Kyrtzidis | 389db16 | 2010-11-03 22:45:23 +0000 | [diff] [blame] | 57 | HeaderInfo(Headers), ExternalSource(0), |
Douglas Gregor | f44e854 | 2010-08-24 19:08:16 +0000 | [diff] [blame] | 58 | Identifiers(opts, IILookup), BuiltinInfo(Target), CodeComplete(0), |
| 59 | CodeCompletionFile(0), SkipMainFilePreamble(0, true), CurPPLexer(0), |
Ted Kremenek | 9714a23 | 2010-10-19 22:15:20 +0000 | [diff] [blame] | 60 | CurDirLookup(0), Callbacks(0), MacroArgCache(0), Record(0), MIChainHead(0), |
| 61 | MICache(0) { |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 62 | ScratchBuf = new ScratchBuffer(SourceMgr); |
Chris Lattner | c1f9d82 | 2009-04-13 01:29:17 +0000 | [diff] [blame] | 63 | CounterValue = 0; // __COUNTER__ starts at 0. |
Daniel Dunbar | 5814e65 | 2009-11-11 21:44:21 +0000 | [diff] [blame] | 64 | OwnsHeaderSearch = OwnsHeaders; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 65 | |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 66 | // Clear stats. |
| 67 | NumDirectives = NumDefined = NumUndefined = NumPragma = 0; |
| 68 | NumIf = NumElse = NumEndif = 0; |
| 69 | NumEnteredSourceFiles = 0; |
| 70 | NumMacroExpanded = NumFnMacroExpanded = NumBuiltinMacroExpanded = 0; |
| 71 | NumFastMacroExpanded = NumTokenPaste = NumFastTokenPaste = 0; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 72 | MaxIncludeStackDepth = 0; |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 73 | NumSkipped = 0; |
| 74 | |
| 75 | // Default to discarding comments. |
| 76 | KeepComments = false; |
| 77 | KeepMacroComments = false; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 78 | |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 79 | // Macro expansion is enabled. |
| 80 | DisableMacroExpansion = false; |
| 81 | InMacroArgs = false; |
Chris Lattner | 6cfe759 | 2008-03-09 02:26:03 +0000 | [diff] [blame] | 82 | NumCachedTokenLexers = 0; |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 83 | |
Argyrios Kyrtzidis | 03db1b3 | 2008-08-10 13:15:22 +0000 | [diff] [blame] | 84 | CachedLexPos = 0; |
| 85 | |
Douglas Gregor | 88a3586 | 2010-01-04 19:18:44 +0000 | [diff] [blame] | 86 | // We haven't read anything from the external source. |
| 87 | ReadMacrosFromExternalSource = false; |
Kovarththanan Rajaratnam | 1935754 | 2010-03-13 10:17:05 +0000 | [diff] [blame] | 88 | |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 89 | // "Poison" __VA_ARGS__, which can only appear in the expansion of a macro. |
| 90 | // This gets unpoisoned where it is allowed. |
| 91 | (Ident__VA_ARGS__ = getIdentifierInfo("__VA_ARGS__"))->setIsPoisoned(); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 92 | |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 93 | // Initialize the pragma handlers. |
Argyrios Kyrtzidis | 9b36c3f | 2010-07-13 09:07:17 +0000 | [diff] [blame] | 94 | PragmaHandlers = new PragmaNamespace(llvm::StringRef()); |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 95 | RegisterBuiltinPragmas(); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 96 | |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 97 | // Initialize builtin macros like __LINE__ and friends. |
| 98 | RegisterBuiltinMacros(); |
| 99 | } |
| 100 | |
| 101 | Preprocessor::~Preprocessor() { |
Argyrios Kyrtzidis | 2174a4f | 2008-08-23 12:12:06 +0000 | [diff] [blame] | 102 | assert(BacktrackPositions.empty() && "EnableBacktrack/Backtrack imbalance!"); |
| 103 | |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 104 | while (!IncludeMacroStack.empty()) { |
| 105 | delete IncludeMacroStack.back().TheLexer; |
Chris Lattner | 6cfe759 | 2008-03-09 02:26:03 +0000 | [diff] [blame] | 106 | delete IncludeMacroStack.back().TheTokenLexer; |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 107 | IncludeMacroStack.pop_back(); |
| 108 | } |
Chris Lattner | cc1a875 | 2007-10-07 08:44:20 +0000 | [diff] [blame] | 109 | |
| 110 | // Free any macro definitions. |
Ted Kremenek | 2a6b03a | 2010-10-19 21:30:11 +0000 | [diff] [blame] | 111 | for (MacroInfoChain *I = MIChainHead ; I ; I = I->Next) |
Ted Kremenek | af8fa25 | 2010-10-19 18:16:54 +0000 | [diff] [blame] | 112 | I->MI.Destroy(); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 113 | |
Chris Lattner | 9594acf | 2007-07-15 00:25:26 +0000 | [diff] [blame] | 114 | // Free any cached macro expanders. |
Chris Lattner | 6cfe759 | 2008-03-09 02:26:03 +0000 | [diff] [blame] | 115 | for (unsigned i = 0, e = NumCachedTokenLexers; i != e; ++i) |
| 116 | delete TokenLexerCache[i]; |
Kovarththanan Rajaratnam | 1935754 | 2010-03-13 10:17:05 +0000 | [diff] [blame] | 117 | |
Chris Lattner | 23f77e5 | 2009-12-15 01:51:03 +0000 | [diff] [blame] | 118 | // Free any cached MacroArgs. |
| 119 | for (MacroArgs *ArgList = MacroArgCache; ArgList; ) |
| 120 | ArgList = ArgList->deallocate(); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 121 | |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 122 | // Release pragma information. |
| 123 | delete PragmaHandlers; |
| 124 | |
| 125 | // Delete the scratch buffer info. |
| 126 | delete ScratchBuf; |
Chris Lattner | eb50ed8 | 2008-03-14 06:07:05 +0000 | [diff] [blame] | 127 | |
Daniel Dunbar | 5814e65 | 2009-11-11 21:44:21 +0000 | [diff] [blame] | 128 | // Delete the header search info, if we own it. |
| 129 | if (OwnsHeaderSearch) |
| 130 | delete &HeaderInfo; |
| 131 | |
Chris Lattner | eb50ed8 | 2008-03-14 06:07:05 +0000 | [diff] [blame] | 132 | delete Callbacks; |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 133 | } |
| 134 | |
Ted Kremenek | 337edcd | 2009-02-12 03:26:59 +0000 | [diff] [blame] | 135 | void Preprocessor::setPTHManager(PTHManager* pm) { |
| 136 | PTH.reset(pm); |
Douglas Gregor | 52e7108 | 2009-10-16 18:18:30 +0000 | [diff] [blame] | 137 | FileMgr.addStatCache(PTH->createStatCache()); |
Ted Kremenek | 337edcd | 2009-02-12 03:26:59 +0000 | [diff] [blame] | 138 | } |
| 139 | |
Chris Lattner | d217773 | 2007-07-20 16:59:19 +0000 | [diff] [blame] | 140 | void Preprocessor::DumpToken(const Token &Tok, bool DumpFlags) const { |
Benjamin Kramer | 6cb7c1a | 2009-08-23 12:08:50 +0000 | [diff] [blame] | 141 | llvm::errs() << tok::getTokenName(Tok.getKind()) << " '" |
| 142 | << getSpelling(Tok) << "'"; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 143 | |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 144 | if (!DumpFlags) return; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 145 | |
Benjamin Kramer | 6cb7c1a | 2009-08-23 12:08:50 +0000 | [diff] [blame] | 146 | llvm::errs() << "\t"; |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 147 | if (Tok.isAtStartOfLine()) |
Benjamin Kramer | 6cb7c1a | 2009-08-23 12:08:50 +0000 | [diff] [blame] | 148 | llvm::errs() << " [StartOfLine]"; |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 149 | if (Tok.hasLeadingSpace()) |
Benjamin Kramer | 6cb7c1a | 2009-08-23 12:08:50 +0000 | [diff] [blame] | 150 | llvm::errs() << " [LeadingSpace]"; |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 151 | if (Tok.isExpandDisabled()) |
Benjamin Kramer | 6cb7c1a | 2009-08-23 12:08:50 +0000 | [diff] [blame] | 152 | llvm::errs() << " [ExpandDisabled]"; |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 153 | if (Tok.needsCleaning()) { |
| 154 | const char *Start = SourceMgr.getCharacterData(Tok.getLocation()); |
Benjamin Kramer | 476d8b8 | 2010-08-11 14:47:12 +0000 | [diff] [blame] | 155 | llvm::errs() << " [UnClean='" << llvm::StringRef(Start, Tok.getLength()) |
Benjamin Kramer | 6cb7c1a | 2009-08-23 12:08:50 +0000 | [diff] [blame] | 156 | << "']"; |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 157 | } |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 158 | |
Benjamin Kramer | 6cb7c1a | 2009-08-23 12:08:50 +0000 | [diff] [blame] | 159 | llvm::errs() << "\tLoc=<"; |
Chris Lattner | c3d8d57 | 2007-12-09 20:31:55 +0000 | [diff] [blame] | 160 | DumpLocation(Tok.getLocation()); |
Benjamin Kramer | 6cb7c1a | 2009-08-23 12:08:50 +0000 | [diff] [blame] | 161 | llvm::errs() << ">"; |
Chris Lattner | c3d8d57 | 2007-12-09 20:31:55 +0000 | [diff] [blame] | 162 | } |
| 163 | |
| 164 | void Preprocessor::DumpLocation(SourceLocation Loc) const { |
Chris Lattner | b9c3f96 | 2009-01-27 07:57:44 +0000 | [diff] [blame] | 165 | Loc.dump(SourceMgr); |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 166 | } |
| 167 | |
| 168 | void Preprocessor::DumpMacro(const MacroInfo &MI) const { |
Benjamin Kramer | 6cb7c1a | 2009-08-23 12:08:50 +0000 | [diff] [blame] | 169 | llvm::errs() << "MACRO: "; |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 170 | for (unsigned i = 0, e = MI.getNumTokens(); i != e; ++i) { |
| 171 | DumpToken(MI.getReplacementToken(i)); |
Benjamin Kramer | 6cb7c1a | 2009-08-23 12:08:50 +0000 | [diff] [blame] | 172 | llvm::errs() << " "; |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 173 | } |
Benjamin Kramer | 6cb7c1a | 2009-08-23 12:08:50 +0000 | [diff] [blame] | 174 | llvm::errs() << "\n"; |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 175 | } |
| 176 | |
| 177 | void Preprocessor::PrintStats() { |
Benjamin Kramer | 6cb7c1a | 2009-08-23 12:08:50 +0000 | [diff] [blame] | 178 | llvm::errs() << "\n*** Preprocessor Stats:\n"; |
| 179 | llvm::errs() << NumDirectives << " directives found:\n"; |
| 180 | llvm::errs() << " " << NumDefined << " #define.\n"; |
| 181 | llvm::errs() << " " << NumUndefined << " #undef.\n"; |
| 182 | llvm::errs() << " #include/#include_next/#import:\n"; |
| 183 | llvm::errs() << " " << NumEnteredSourceFiles << " source files entered.\n"; |
| 184 | llvm::errs() << " " << MaxIncludeStackDepth << " max include stack depth\n"; |
| 185 | llvm::errs() << " " << NumIf << " #if/#ifndef/#ifdef.\n"; |
| 186 | llvm::errs() << " " << NumElse << " #else/#elif.\n"; |
| 187 | llvm::errs() << " " << NumEndif << " #endif.\n"; |
| 188 | llvm::errs() << " " << NumPragma << " #pragma.\n"; |
| 189 | llvm::errs() << NumSkipped << " #if/#ifndef#ifdef regions skipped\n"; |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 190 | |
Benjamin Kramer | 6cb7c1a | 2009-08-23 12:08:50 +0000 | [diff] [blame] | 191 | llvm::errs() << NumMacroExpanded << "/" << NumFnMacroExpanded << "/" |
Ted Kremenek | bdd30c2 | 2008-01-14 16:44:48 +0000 | [diff] [blame] | 192 | << NumBuiltinMacroExpanded << " obj/fn/builtin macros expanded, " |
| 193 | << NumFastMacroExpanded << " on the fast path.\n"; |
Benjamin Kramer | 6cb7c1a | 2009-08-23 12:08:50 +0000 | [diff] [blame] | 194 | llvm::errs() << (NumFastTokenPaste+NumTokenPaste) |
Ted Kremenek | bdd30c2 | 2008-01-14 16:44:48 +0000 | [diff] [blame] | 195 | << " token paste (##) operations performed, " |
| 196 | << NumFastTokenPaste << " on the fast path.\n"; |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 197 | } |
| 198 | |
Kovarththanan Rajaratnam | 1935754 | 2010-03-13 10:17:05 +0000 | [diff] [blame] | 199 | Preprocessor::macro_iterator |
| 200 | Preprocessor::macro_begin(bool IncludeExternalMacros) const { |
| 201 | if (IncludeExternalMacros && ExternalSource && |
Douglas Gregor | 88a3586 | 2010-01-04 19:18:44 +0000 | [diff] [blame] | 202 | !ReadMacrosFromExternalSource) { |
| 203 | ReadMacrosFromExternalSource = true; |
| 204 | ExternalSource->ReadDefinedMacros(); |
| 205 | } |
Kovarththanan Rajaratnam | 1935754 | 2010-03-13 10:17:05 +0000 | [diff] [blame] | 206 | |
| 207 | return Macros.begin(); |
Douglas Gregor | 88a3586 | 2010-01-04 19:18:44 +0000 | [diff] [blame] | 208 | } |
| 209 | |
Kovarththanan Rajaratnam | 1935754 | 2010-03-13 10:17:05 +0000 | [diff] [blame] | 210 | Preprocessor::macro_iterator |
| 211 | Preprocessor::macro_end(bool IncludeExternalMacros) const { |
| 212 | if (IncludeExternalMacros && ExternalSource && |
Douglas Gregor | 88a3586 | 2010-01-04 19:18:44 +0000 | [diff] [blame] | 213 | !ReadMacrosFromExternalSource) { |
| 214 | ReadMacrosFromExternalSource = true; |
| 215 | ExternalSource->ReadDefinedMacros(); |
| 216 | } |
Kovarththanan Rajaratnam | 1935754 | 2010-03-13 10:17:05 +0000 | [diff] [blame] | 217 | |
| 218 | return Macros.end(); |
Douglas Gregor | 88a3586 | 2010-01-04 19:18:44 +0000 | [diff] [blame] | 219 | } |
| 220 | |
Kovarththanan Rajaratnam | 1935754 | 2010-03-13 10:17:05 +0000 | [diff] [blame] | 221 | bool Preprocessor::SetCodeCompletionPoint(const FileEntry *File, |
| 222 | unsigned TruncateAtLine, |
Douglas Gregor | 2968442 | 2009-12-02 06:49:09 +0000 | [diff] [blame] | 223 | unsigned TruncateAtColumn) { |
| 224 | using llvm::MemoryBuffer; |
| 225 | |
| 226 | CodeCompletionFile = File; |
| 227 | |
| 228 | // Okay to clear out the code-completion point by passing NULL. |
| 229 | if (!CodeCompletionFile) |
| 230 | return false; |
| 231 | |
| 232 | // Load the actual file's contents. |
Douglas Gregor | aa38c3d | 2010-03-16 19:49:24 +0000 | [diff] [blame] | 233 | bool Invalid = false; |
| 234 | const MemoryBuffer *Buffer = SourceMgr.getMemoryBufferForFile(File, &Invalid); |
| 235 | if (Invalid) |
Douglas Gregor | 2968442 | 2009-12-02 06:49:09 +0000 | [diff] [blame] | 236 | return true; |
| 237 | |
| 238 | // Find the byte position of the truncation point. |
| 239 | const char *Position = Buffer->getBufferStart(); |
| 240 | for (unsigned Line = 1; Line < TruncateAtLine; ++Line) { |
| 241 | for (; *Position; ++Position) { |
| 242 | if (*Position != '\r' && *Position != '\n') |
| 243 | continue; |
Kovarththanan Rajaratnam | 1935754 | 2010-03-13 10:17:05 +0000 | [diff] [blame] | 244 | |
Douglas Gregor | 2968442 | 2009-12-02 06:49:09 +0000 | [diff] [blame] | 245 | // Eat \r\n or \n\r as a single line. |
| 246 | if ((Position[1] == '\r' || Position[1] == '\n') && |
| 247 | Position[0] != Position[1]) |
| 248 | ++Position; |
| 249 | ++Position; |
| 250 | break; |
| 251 | } |
| 252 | } |
Kovarththanan Rajaratnam | 1935754 | 2010-03-13 10:17:05 +0000 | [diff] [blame] | 253 | |
Douglas Gregor | b760fe8 | 2009-12-08 21:45:46 +0000 | [diff] [blame] | 254 | Position += TruncateAtColumn - 1; |
Kovarththanan Rajaratnam | 1935754 | 2010-03-13 10:17:05 +0000 | [diff] [blame] | 255 | |
Douglas Gregor | 2968442 | 2009-12-02 06:49:09 +0000 | [diff] [blame] | 256 | // Truncate the buffer. |
Douglas Gregor | b760fe8 | 2009-12-08 21:45:46 +0000 | [diff] [blame] | 257 | if (Position < Buffer->getBufferEnd()) { |
Chris Lattner | a0a270c | 2010-04-05 22:42:27 +0000 | [diff] [blame] | 258 | llvm::StringRef Data(Buffer->getBufferStart(), |
| 259 | Position-Buffer->getBufferStart()); |
Kovarththanan Rajaratnam | 1935754 | 2010-03-13 10:17:05 +0000 | [diff] [blame] | 260 | MemoryBuffer *TruncatedBuffer |
Chris Lattner | a0a270c | 2010-04-05 22:42:27 +0000 | [diff] [blame] | 261 | = MemoryBuffer::getMemBufferCopy(Data, Buffer->getBufferIdentifier()); |
Douglas Gregor | 2968442 | 2009-12-02 06:49:09 +0000 | [diff] [blame] | 262 | SourceMgr.overrideFileContents(File, TruncatedBuffer); |
| 263 | } |
| 264 | |
| 265 | return false; |
| 266 | } |
| 267 | |
Douglas Gregor | 109ae73 | 2009-12-03 17:05:59 +0000 | [diff] [blame] | 268 | bool Preprocessor::isCodeCompletionFile(SourceLocation FileLoc) const { |
Douglas Gregor | 2968442 | 2009-12-02 06:49:09 +0000 | [diff] [blame] | 269 | return CodeCompletionFile && FileLoc.isFileID() && |
| 270 | SourceMgr.getFileEntryForID(SourceMgr.getFileID(FileLoc)) |
| 271 | == CodeCompletionFile; |
| 272 | } |
| 273 | |
Douglas Gregor | 55817af | 2010-08-25 17:04:25 +0000 | [diff] [blame] | 274 | void Preprocessor::CodeCompleteNaturalLanguage() { |
| 275 | SetCodeCompletionPoint(0, 0, 0); |
| 276 | getDiagnostics().setSuppressAllDiagnostics(true); |
| 277 | if (CodeComplete) |
| 278 | CodeComplete->CodeCompleteNaturalLanguage(); |
| 279 | } |
| 280 | |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 281 | |
Benjamin Kramer | 51f5fe3 | 2010-02-27 17:05:45 +0000 | [diff] [blame] | 282 | /// getSpelling - This method is used to get the spelling of a token into a |
| 283 | /// SmallVector. Note that the returned StringRef may not point to the |
| 284 | /// supplied buffer if a copy can be avoided. |
| 285 | llvm::StringRef Preprocessor::getSpelling(const Token &Tok, |
Douglas Gregor | 50f6af7 | 2010-03-16 05:20:39 +0000 | [diff] [blame] | 286 | llvm::SmallVectorImpl<char> &Buffer, |
| 287 | bool *Invalid) const { |
Benjamin Kramer | 51f5fe3 | 2010-02-27 17:05:45 +0000 | [diff] [blame] | 288 | // Try the fast path. |
| 289 | if (const IdentifierInfo *II = Tok.getIdentifierInfo()) |
| 290 | return II->getName(); |
| 291 | |
| 292 | // Resize the buffer if we need to copy into it. |
| 293 | if (Tok.needsCleaning()) |
| 294 | Buffer.resize(Tok.getLength()); |
| 295 | |
| 296 | const char *Ptr = Buffer.data(); |
Douglas Gregor | 50f6af7 | 2010-03-16 05:20:39 +0000 | [diff] [blame] | 297 | unsigned Len = getSpelling(Tok, Ptr, Invalid); |
Benjamin Kramer | 51f5fe3 | 2010-02-27 17:05:45 +0000 | [diff] [blame] | 298 | return llvm::StringRef(Ptr, Len); |
| 299 | } |
| 300 | |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 301 | /// CreateString - Plop the specified string into a scratch buffer and return a |
| 302 | /// location for it. If specified, the source location provides a source |
| 303 | /// location for the token. |
Chris Lattner | 47246be | 2009-01-26 19:29:26 +0000 | [diff] [blame] | 304 | void Preprocessor::CreateString(const char *Buf, unsigned Len, Token &Tok, |
| 305 | SourceLocation InstantiationLoc) { |
| 306 | Tok.setLength(Len); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 307 | |
Chris Lattner | 47246be | 2009-01-26 19:29:26 +0000 | [diff] [blame] | 308 | const char *DestPtr; |
| 309 | SourceLocation Loc = ScratchBuf->getToken(Buf, Len, DestPtr); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 310 | |
Chris Lattner | 47246be | 2009-01-26 19:29:26 +0000 | [diff] [blame] | 311 | if (InstantiationLoc.isValid()) |
Chris Lattner | e7fb484 | 2009-02-15 20:52:18 +0000 | [diff] [blame] | 312 | Loc = SourceMgr.createInstantiationLoc(Loc, InstantiationLoc, |
| 313 | InstantiationLoc, Len); |
Chris Lattner | 47246be | 2009-01-26 19:29:26 +0000 | [diff] [blame] | 314 | Tok.setLocation(Loc); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 315 | |
Chris Lattner | 47246be | 2009-01-26 19:29:26 +0000 | [diff] [blame] | 316 | // If this is a literal token, set the pointer data. |
| 317 | if (Tok.isLiteral()) |
| 318 | Tok.setLiteralData(DestPtr); |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 319 | } |
| 320 | |
| 321 | |
Chris Lattner | 97ba77c | 2007-07-16 06:48:38 +0000 | [diff] [blame] | 322 | |
Chris Lattner | 53b0dab | 2007-10-09 22:10:18 +0000 | [diff] [blame] | 323 | //===----------------------------------------------------------------------===// |
| 324 | // Preprocessor Initialization Methods |
| 325 | //===----------------------------------------------------------------------===// |
| 326 | |
Chris Lattner | 53b0dab | 2007-10-09 22:10:18 +0000 | [diff] [blame] | 327 | |
| 328 | /// EnterMainSourceFile - Enter the specified FileID as the main source file, |
Nate Begeman | 6b61602 | 2008-01-07 04:01:26 +0000 | [diff] [blame] | 329 | /// which implicitly adds the builtin defines etc. |
Chris Lattner | e127a0d | 2010-04-20 20:35:58 +0000 | [diff] [blame] | 330 | void Preprocessor::EnterMainSourceFile() { |
Chris Lattner | 05db427 | 2009-02-13 19:33:24 +0000 | [diff] [blame] | 331 | // We do not allow the preprocessor to reenter the main file. Doing so will |
| 332 | // cause FileID's to accumulate information from both runs (e.g. #line |
| 333 | // information) and predefined macros aren't guaranteed to be set properly. |
| 334 | assert(NumEnteredSourceFiles == 0 && "Cannot reenter the main file!"); |
Chris Lattner | 2b2453a | 2009-01-17 06:22:33 +0000 | [diff] [blame] | 335 | FileID MainFileID = SourceMgr.getMainFileID(); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 336 | |
Chris Lattner | 53b0dab | 2007-10-09 22:10:18 +0000 | [diff] [blame] | 337 | // Enter the main file source buffer. |
Chris Lattner | e127a0d | 2010-04-20 20:35:58 +0000 | [diff] [blame] | 338 | EnterSourceFile(MainFileID, 0, SourceLocation()); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 339 | |
Douglas Gregor | f4f6c9d | 2010-07-26 21:36:20 +0000 | [diff] [blame] | 340 | // If we've been asked to skip bytes in the main file (e.g., as part of a |
| 341 | // precompiled preamble), do so now. |
| 342 | if (SkipMainFilePreamble.first > 0) |
| 343 | CurLexer->SkipBytes(SkipMainFilePreamble.first, |
| 344 | SkipMainFilePreamble.second); |
| 345 | |
Chris Lattner | b283298 | 2007-11-15 19:07:47 +0000 | [diff] [blame] | 346 | // Tell the header info that the main file was entered. If the file is later |
| 347 | // #imported, it won't be re-entered. |
Chris Lattner | 2b2453a | 2009-01-17 06:22:33 +0000 | [diff] [blame] | 348 | if (const FileEntry *FE = SourceMgr.getFileEntryForID(MainFileID)) |
Chris Lattner | b283298 | 2007-11-15 19:07:47 +0000 | [diff] [blame] | 349 | HeaderInfo.IncrementIncludeCount(FE); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 350 | |
Benjamin Kramer | ffd6e39 | 2009-12-31 15:33:09 +0000 | [diff] [blame] | 351 | // Preprocess Predefines to populate the initial preprocessor state. |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 352 | llvm::MemoryBuffer *SB = |
Chris Lattner | a0a270c | 2010-04-05 22:42:27 +0000 | [diff] [blame] | 353 | llvm::MemoryBuffer::getMemBufferCopy(Predefines, "<built-in>"); |
Douglas Gregor | 043266b | 2010-08-26 14:07:34 +0000 | [diff] [blame] | 354 | assert(SB && "Cannot create predefined source buffer"); |
Chris Lattner | 2b2453a | 2009-01-17 06:22:33 +0000 | [diff] [blame] | 355 | FileID FID = SourceMgr.createFileIDForMemBuffer(SB); |
| 356 | assert(!FID.isInvalid() && "Could not create FileID for predefines?"); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 357 | |
Chris Lattner | 53b0dab | 2007-10-09 22:10:18 +0000 | [diff] [blame] | 358 | // Start parsing the predefines. |
Chris Lattner | e127a0d | 2010-04-20 20:35:58 +0000 | [diff] [blame] | 359 | EnterSourceFile(FID, 0, SourceLocation()); |
Chris Lattner | 53b0dab | 2007-10-09 22:10:18 +0000 | [diff] [blame] | 360 | } |
Chris Lattner | 97ba77c | 2007-07-16 06:48:38 +0000 | [diff] [blame] | 361 | |
Daniel Dunbar | dbd8209 | 2010-03-23 05:09:10 +0000 | [diff] [blame] | 362 | void Preprocessor::EndSourceFile() { |
| 363 | // Notify the client that we reached the end of the source file. |
| 364 | if (Callbacks) |
| 365 | Callbacks->EndOfMainFile(); |
| 366 | } |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 367 | |
| 368 | //===----------------------------------------------------------------------===// |
| 369 | // Lexer Event Handling. |
| 370 | //===----------------------------------------------------------------------===// |
| 371 | |
| 372 | /// LookUpIdentifierInfo - Given a tok::identifier token, look up the |
| 373 | /// identifier information for the token and install it into the token. |
Chris Lattner | d217773 | 2007-07-20 16:59:19 +0000 | [diff] [blame] | 374 | IdentifierInfo *Preprocessor::LookUpIdentifierInfo(Token &Identifier, |
Daniel Dunbar | c322209 | 2009-11-05 01:53:52 +0000 | [diff] [blame] | 375 | const char *BufPtr) const { |
Chris Lattner | 22f6bbc | 2007-10-09 18:02:16 +0000 | [diff] [blame] | 376 | assert(Identifier.is(tok::identifier) && "Not an identifier!"); |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 377 | assert(Identifier.getIdentifierInfo() == 0 && "Identinfo already exists!"); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 378 | |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 379 | // Look up this token, see if it is a macro, or if it is a language keyword. |
| 380 | IdentifierInfo *II; |
| 381 | if (BufPtr && !Identifier.needsCleaning()) { |
| 382 | // No cleaning needed, just use the characters from the lexed buffer. |
Daniel Dunbar | 3da736c | 2009-11-05 01:53:39 +0000 | [diff] [blame] | 383 | II = getIdentifierInfo(llvm::StringRef(BufPtr, Identifier.getLength())); |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 384 | } else { |
| 385 | // Cleaning needed, alloca a buffer, clean into it, then use the buffer. |
Kovarththanan Rajaratnam | 1935754 | 2010-03-13 10:17:05 +0000 | [diff] [blame] | 386 | llvm::SmallString<64> IdentifierBuffer; |
Benjamin Kramer | ddeea56 | 2010-02-27 13:44:12 +0000 | [diff] [blame] | 387 | llvm::StringRef CleanedStr = getSpelling(Identifier, IdentifierBuffer); |
| 388 | II = getIdentifierInfo(CleanedStr); |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 389 | } |
| 390 | Identifier.setIdentifierInfo(II); |
| 391 | return II; |
| 392 | } |
| 393 | |
| 394 | |
| 395 | /// HandleIdentifier - This callback is invoked when the lexer reads an |
| 396 | /// identifier. This callback looks up the identifier in the map and/or |
| 397 | /// potentially macro expands it or turns it into a named token (like 'for'). |
Chris Lattner | 6a170eb | 2009-01-21 07:43:11 +0000 | [diff] [blame] | 398 | /// |
| 399 | /// Note that callers of this method are guarded by checking the |
| 400 | /// IdentifierInfo's 'isHandleIdentifierCase' bit. If this method changes, the |
| 401 | /// IdentifierInfo methods that compute these properties will need to change to |
| 402 | /// match. |
Chris Lattner | d217773 | 2007-07-20 16:59:19 +0000 | [diff] [blame] | 403 | void Preprocessor::HandleIdentifier(Token &Identifier) { |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 404 | assert(Identifier.getIdentifierInfo() && |
| 405 | "Can't handle identifiers without identifier info!"); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 406 | |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 407 | IdentifierInfo &II = *Identifier.getIdentifierInfo(); |
| 408 | |
| 409 | // If this identifier was poisoned, and if it was not produced from a macro |
| 410 | // expansion, emit an error. |
Ted Kremenek | 1a53157 | 2008-11-19 22:43:49 +0000 | [diff] [blame] | 411 | if (II.isPoisoned() && CurPPLexer) { |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 412 | if (&II != Ident__VA_ARGS__) // We warn about __VA_ARGS__ with poisoning. |
| 413 | Diag(Identifier, diag::err_pp_used_poisoned_id); |
| 414 | else |
| 415 | Diag(Identifier, diag::ext_pp_bad_vaargs_use); |
| 416 | } |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 417 | |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 418 | // If this is a macro to be expanded, do it. |
Chris Lattner | cc1a875 | 2007-10-07 08:44:20 +0000 | [diff] [blame] | 419 | if (MacroInfo *MI = getMacroInfo(&II)) { |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 420 | if (!DisableMacroExpansion && !Identifier.isExpandDisabled()) { |
| 421 | if (MI->isEnabled()) { |
| 422 | if (!HandleMacroExpandedIdentifier(Identifier, MI)) |
| 423 | return; |
| 424 | } else { |
| 425 | // C99 6.10.3.4p2 says that a disabled macro may never again be |
| 426 | // expanded, even if it's in a context where it could be expanded in the |
| 427 | // future. |
Chris Lattner | d217773 | 2007-07-20 16:59:19 +0000 | [diff] [blame] | 428 | Identifier.setFlag(Token::DisableExpand); |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 429 | } |
| 430 | } |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 431 | } |
| 432 | |
| 433 | // C++ 2.11p2: If this is an alternative representation of a C++ operator, |
| 434 | // then we act as if it is the actual operator and not the textual |
| 435 | // representation of it. |
Fariborz Jahanian | afbc681 | 2010-09-03 17:33:04 +0000 | [diff] [blame] | 436 | if (II.isCPlusPlusOperatorKeyword()) |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 437 | Identifier.setIdentifierInfo(0); |
| 438 | |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 439 | // If this is an extension token, diagnose its use. |
Steve Naroff | b4eaf9c | 2008-09-02 18:50:17 +0000 | [diff] [blame] | 440 | // We avoid diagnosing tokens that originate from macro definitions. |
Eli Friedman | 2962f4d | 2009-04-28 03:59:15 +0000 | [diff] [blame] | 441 | // FIXME: This warning is disabled in cases where it shouldn't be, |
| 442 | // like "#define TY typeof", "TY(1) x". |
| 443 | if (II.isExtensionToken() && !DisableMacroExpansion) |
Reid Spencer | 5f016e2 | 2007-07-11 17:01:13 +0000 | [diff] [blame] | 444 | Diag(Identifier, diag::ext_token_used); |
| 445 | } |
Douglas Gregor | 2e22253 | 2009-07-02 17:08:52 +0000 | [diff] [blame] | 446 | |
| 447 | void Preprocessor::AddCommentHandler(CommentHandler *Handler) { |
| 448 | assert(Handler && "NULL comment handler"); |
| 449 | assert(std::find(CommentHandlers.begin(), CommentHandlers.end(), Handler) == |
| 450 | CommentHandlers.end() && "Comment handler already registered"); |
| 451 | CommentHandlers.push_back(Handler); |
| 452 | } |
| 453 | |
| 454 | void Preprocessor::RemoveCommentHandler(CommentHandler *Handler) { |
| 455 | std::vector<CommentHandler *>::iterator Pos |
| 456 | = std::find(CommentHandlers.begin(), CommentHandlers.end(), Handler); |
| 457 | assert(Pos != CommentHandlers.end() && "Comment handler not registered"); |
| 458 | CommentHandlers.erase(Pos); |
| 459 | } |
| 460 | |
Chris Lattner | 046c227 | 2010-01-18 22:35:47 +0000 | [diff] [blame] | 461 | bool Preprocessor::HandleComment(Token &result, SourceRange Comment) { |
| 462 | bool AnyPendingTokens = false; |
Douglas Gregor | 2e22253 | 2009-07-02 17:08:52 +0000 | [diff] [blame] | 463 | for (std::vector<CommentHandler *>::iterator H = CommentHandlers.begin(), |
| 464 | HEnd = CommentHandlers.end(); |
Chris Lattner | 046c227 | 2010-01-18 22:35:47 +0000 | [diff] [blame] | 465 | H != HEnd; ++H) { |
| 466 | if ((*H)->HandleComment(*this, Comment)) |
| 467 | AnyPendingTokens = true; |
| 468 | } |
| 469 | if (!AnyPendingTokens || getCommentRetentionState()) |
| 470 | return false; |
| 471 | Lex(result); |
| 472 | return true; |
Douglas Gregor | 2e22253 | 2009-07-02 17:08:52 +0000 | [diff] [blame] | 473 | } |
| 474 | |
| 475 | CommentHandler::~CommentHandler() { } |
Douglas Gregor | 94dc8f6 | 2010-03-19 16:15:56 +0000 | [diff] [blame] | 476 | |
Douglas Gregor | f44e854 | 2010-08-24 19:08:16 +0000 | [diff] [blame] | 477 | CodeCompletionHandler::~CodeCompletionHandler() { } |
| 478 | |
Douglas Gregor | 94dc8f6 | 2010-03-19 16:15:56 +0000 | [diff] [blame] | 479 | void Preprocessor::createPreprocessingRecord() { |
| 480 | if (Record) |
| 481 | return; |
| 482 | |
Douglas Gregor | b9e1b75 | 2010-03-19 17:12:43 +0000 | [diff] [blame] | 483 | Record = new PreprocessingRecord; |
| 484 | addPPCallbacks(Record); |
Douglas Gregor | 94dc8f6 | 2010-03-19 16:15:56 +0000 | [diff] [blame] | 485 | } |