clang  8.0.0svn
Preprocessor.h
Go to the documentation of this file.
1 //===- Preprocessor.h - C Language Family Preprocessor ----------*- C++ -*-===//
2 //
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 /// \file
11 /// Defines the clang::Preprocessor interface.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #ifndef LLVM_CLANG_LEX_PREPROCESSOR_H
16 #define LLVM_CLANG_LEX_PREPROCESSOR_H
17 
18 #include "clang/Basic/Builtins.h"
19 #include "clang/Basic/Diagnostic.h"
21 #include "clang/Basic/LLVM.h"
23 #include "clang/Basic/Module.h"
26 #include "clang/Basic/TokenKinds.h"
27 #include "clang/Lex/Lexer.h"
28 #include "clang/Lex/MacroInfo.h"
29 #include "clang/Lex/ModuleLoader.h"
30 #include "clang/Lex/ModuleMap.h"
31 #include "clang/Lex/PPCallbacks.h"
32 #include "clang/Lex/PTHLexer.h"
33 #include "clang/Lex/Token.h"
34 #include "clang/Lex/TokenLexer.h"
35 #include "llvm/ADT/ArrayRef.h"
36 #include "llvm/ADT/DenseMap.h"
37 #include "llvm/ADT/FoldingSet.h"
38 #include "llvm/ADT/None.h"
39 #include "llvm/ADT/Optional.h"
40 #include "llvm/ADT/PointerUnion.h"
41 #include "llvm/ADT/STLExtras.h"
42 #include "llvm/ADT/SmallPtrSet.h"
43 #include "llvm/ADT/SmallVector.h"
44 #include "llvm/ADT/StringRef.h"
45 #include "llvm/ADT/TinyPtrVector.h"
46 #include "llvm/ADT/iterator_range.h"
47 #include "llvm/Support/Allocator.h"
48 #include "llvm/Support/Casting.h"
49 #include "llvm/Support/Registry.h"
50 #include <cassert>
51 #include <cstddef>
52 #include <cstdint>
53 #include <memory>
54 #include <map>
55 #include <string>
56 #include <utility>
57 #include <vector>
58 
59 namespace llvm {
60 
61 template<unsigned InternalLen> class SmallString;
62 
63 } // namespace llvm
64 
65 namespace clang {
66 
67 class CodeCompletionHandler;
68 class CommentHandler;
69 class DirectoryEntry;
70 class DirectoryLookup;
71 class ExternalPreprocessorSource;
72 class FileEntry;
73 class FileManager;
74 class HeaderSearch;
75 class MacroArgs;
76 class MemoryBufferCache;
77 class PragmaHandler;
78 class PragmaNamespace;
79 class PreprocessingRecord;
80 class PreprocessorLexer;
81 class PreprocessorOptions;
82 class PTHManager;
83 class ScratchBuffer;
84 class TargetInfo;
85 
86 /// Stores token information for comparing actual tokens with
87 /// predefined values. Only handles simple tokens and identifiers.
88 class TokenValue {
90  IdentifierInfo *II;
91 
92 public:
93  TokenValue(tok::TokenKind Kind) : Kind(Kind), II(nullptr) {
94  assert(Kind != tok::raw_identifier && "Raw identifiers are not supported.");
95  assert(Kind != tok::identifier &&
96  "Identifiers should be created by TokenValue(IdentifierInfo *)");
97  assert(!tok::isLiteral(Kind) && "Literals are not supported.");
98  assert(!tok::isAnnotation(Kind) && "Annotations are not supported.");
99  }
100 
101  TokenValue(IdentifierInfo *II) : Kind(tok::identifier), II(II) {}
102 
103  bool operator==(const Token &Tok) const {
104  return Tok.getKind() == Kind &&
105  (!II || II == Tok.getIdentifierInfo());
106  }
107 };
108 
109 /// Context in which macro name is used.
110 enum MacroUse {
111  // other than #define or #undef
112  MU_Other = 0,
113 
114  // macro name specified in #define
116 
117  // macro name specified in #undef
119 };
120 
121 /// Engages in a tight little dance with the lexer to efficiently
122 /// preprocess tokens.
123 ///
124 /// Lexers know only about tokens within a single source file, and don't
125 /// know anything about preprocessor-level issues like the \#include stack,
126 /// token expansion, etc.
130 
131  std::shared_ptr<PreprocessorOptions> PPOpts;
132  DiagnosticsEngine *Diags;
133  LangOptions &LangOpts;
134  const TargetInfo *Target = nullptr;
135  const TargetInfo *AuxTarget = nullptr;
136  FileManager &FileMgr;
137  SourceManager &SourceMgr;
138  MemoryBufferCache &PCMCache;
139  std::unique_ptr<ScratchBuffer> ScratchBuf;
140  HeaderSearch &HeaderInfo;
141  ModuleLoader &TheModuleLoader;
142 
143  /// External source of macros.
144  ExternalPreprocessorSource *ExternalSource;
145 
146  /// An optional PTHManager object used for getting tokens from
147  /// a token cache rather than lexing the original source file.
148  std::unique_ptr<PTHManager> PTH;
149 
150  /// A BumpPtrAllocator object used to quickly allocate and release
151  /// objects internal to the Preprocessor.
152  llvm::BumpPtrAllocator BP;
153 
154  /// Identifiers for builtin macros and other builtins.
155  IdentifierInfo *Ident__LINE__, *Ident__FILE__; // __LINE__, __FILE__
156  IdentifierInfo *Ident__DATE__, *Ident__TIME__; // __DATE__, __TIME__
157  IdentifierInfo *Ident__INCLUDE_LEVEL__; // __INCLUDE_LEVEL__
158  IdentifierInfo *Ident__BASE_FILE__; // __BASE_FILE__
159  IdentifierInfo *Ident__TIMESTAMP__; // __TIMESTAMP__
160  IdentifierInfo *Ident__COUNTER__; // __COUNTER__
161  IdentifierInfo *Ident_Pragma, *Ident__pragma; // _Pragma, __pragma
162  IdentifierInfo *Ident__identifier; // __identifier
163  IdentifierInfo *Ident__VA_ARGS__; // __VA_ARGS__
164  IdentifierInfo *Ident__VA_OPT__; // __VA_OPT__
165  IdentifierInfo *Ident__has_feature; // __has_feature
166  IdentifierInfo *Ident__has_extension; // __has_extension
167  IdentifierInfo *Ident__has_builtin; // __has_builtin
168  IdentifierInfo *Ident__has_attribute; // __has_attribute
169  IdentifierInfo *Ident__has_include; // __has_include
170  IdentifierInfo *Ident__has_include_next; // __has_include_next
171  IdentifierInfo *Ident__has_warning; // __has_warning
172  IdentifierInfo *Ident__is_identifier; // __is_identifier
173  IdentifierInfo *Ident__building_module; // __building_module
174  IdentifierInfo *Ident__MODULE__; // __MODULE__
175  IdentifierInfo *Ident__has_cpp_attribute; // __has_cpp_attribute
176  IdentifierInfo *Ident__has_c_attribute; // __has_c_attribute
177  IdentifierInfo *Ident__has_declspec; // __has_declspec_attribute
178  IdentifierInfo *Ident__is_target_arch; // __is_target_arch
179  IdentifierInfo *Ident__is_target_vendor; // __is_target_vendor
180  IdentifierInfo *Ident__is_target_os; // __is_target_os
181  IdentifierInfo *Ident__is_target_environment; // __is_target_environment
182 
183  SourceLocation DATELoc, TIMELoc;
184 
185  // Next __COUNTER__ value, starts at 0.
186  unsigned CounterValue = 0;
187 
188  enum {
189  /// Maximum depth of \#includes.
190  MaxAllowedIncludeStackDepth = 200
191  };
192 
193  // State that is set before the preprocessor begins.
194  bool KeepComments : 1;
195  bool KeepMacroComments : 1;
196  bool SuppressIncludeNotFoundError : 1;
197 
198  // State that changes while the preprocessor runs:
199  bool InMacroArgs : 1; // True if parsing fn macro invocation args.
200 
201  /// Whether the preprocessor owns the header search object.
202  bool OwnsHeaderSearch : 1;
203 
204  /// True if macro expansion is disabled.
205  bool DisableMacroExpansion : 1;
206 
207  /// Temporarily disables DisableMacroExpansion (i.e. enables expansion)
208  /// when parsing preprocessor directives.
209  bool MacroExpansionInDirectivesOverride : 1;
210 
212 
213  /// Whether we have already loaded macros from the external source.
214  mutable bool ReadMacrosFromExternalSource : 1;
215 
216  /// True if pragmas are enabled.
217  bool PragmasEnabled : 1;
218 
219  /// True if the current build action is a preprocessing action.
220  bool PreprocessedOutput : 1;
221 
222  /// True if we are currently preprocessing a #if or #elif directive
223  bool ParsingIfOrElifDirective;
224 
225  /// True if we are pre-expanding macro arguments.
226  bool InMacroArgPreExpansion;
227 
228  /// Mapping/lookup information for all identifiers in
229  /// the program, including program keywords.
230  mutable IdentifierTable Identifiers;
231 
232  /// This table contains all the selectors in the program.
233  ///
234  /// Unlike IdentifierTable above, this table *isn't* populated by the
235  /// preprocessor. It is declared/expanded here because its role/lifetime is
236  /// conceptually similar to the IdentifierTable. In addition, the current
237  /// control flow (in clang::ParseAST()), make it convenient to put here.
238  ///
239  /// FIXME: Make sure the lifetime of Identifiers/Selectors *isn't* tied to
240  /// the lifetime of the preprocessor.
241  SelectorTable Selectors;
242 
243  /// Information about builtins.
245 
246  /// Tracks all of the pragmas that the client registered
247  /// with this preprocessor.
248  std::unique_ptr<PragmaNamespace> PragmaHandlers;
249 
250  /// Pragma handlers of the original source is stored here during the
251  /// parsing of a model file.
252  std::unique_ptr<PragmaNamespace> PragmaHandlersBackup;
253 
254  /// Tracks all of the comment handlers that the client registered
255  /// with this preprocessor.
256  std::vector<CommentHandler *> CommentHandlers;
257 
258  /// True if we want to ignore EOF token and continue later on (thus
259  /// avoid tearing the Lexer and etc. down).
260  bool IncrementalProcessing = false;
261 
262  /// The kind of translation unit we are processing.
263  TranslationUnitKind TUKind;
264 
265  /// The code-completion handler.
266  CodeCompletionHandler *CodeComplete = nullptr;
267 
268  /// The file that we're performing code-completion for, if any.
269  const FileEntry *CodeCompletionFile = nullptr;
270 
271  /// The offset in file for the code-completion point.
272  unsigned CodeCompletionOffset = 0;
273 
274  /// The location for the code-completion point. This gets instantiated
275  /// when the CodeCompletionFile gets \#include'ed for preprocessing.
276  SourceLocation CodeCompletionLoc;
277 
278  /// The start location for the file of the code-completion point.
279  ///
280  /// This gets instantiated when the CodeCompletionFile gets \#include'ed
281  /// for preprocessing.
282  SourceLocation CodeCompletionFileLoc;
283 
284  /// The source location of the \c import contextual keyword we just
285  /// lexed, if any.
286  SourceLocation ModuleImportLoc;
287 
288  /// The module import path that we're currently processing.
290 
291  /// Whether the last token we lexed was an '@'.
292  bool LastTokenWasAt = false;
293 
294  /// Whether the module import expects an identifier next. Otherwise,
295  /// it expects a '.' or ';'.
296  bool ModuleImportExpectsIdentifier = false;
297 
298  /// The source location of the currently-active
299  /// \#pragma clang arc_cf_code_audited begin.
300  SourceLocation PragmaARCCFCodeAuditedLoc;
301 
302  /// The source location of the currently-active
303  /// \#pragma clang assume_nonnull begin.
304  SourceLocation PragmaAssumeNonNullLoc;
305 
306  /// True if we hit the code-completion point.
307  bool CodeCompletionReached = false;
308 
309  /// The code completion token containing the information
310  /// on the stem that is to be code completed.
311  IdentifierInfo *CodeCompletionII = nullptr;
312 
313  /// Range for the code completion token.
314  SourceRange CodeCompletionTokenRange;
315 
316  /// The directory that the main file should be considered to occupy,
317  /// if it does not correspond to a real file (as happens when building a
318  /// module).
319  const DirectoryEntry *MainFileDir = nullptr;
320 
321  /// The number of bytes that we will initially skip when entering the
322  /// main file, along with a flag that indicates whether skipping this number
323  /// of bytes will place the lexer at the start of a line.
324  ///
325  /// This is used when loading a precompiled preamble.
326  std::pair<int, bool> SkipMainFilePreamble;
327 
328 public:
333  bool FoundElse;
335 
337  bool FoundNonSkipPortion, bool FoundElse,
338  SourceLocation ElseLoc)
339  : HashTokenLoc(HashTokenLoc), IfTokenLoc(IfTokenLoc),
340  FoundNonSkipPortion(FoundNonSkipPortion), FoundElse(FoundElse),
341  ElseLoc(ElseLoc) {}
342  };
343 
344 private:
345  friend class ASTReader;
346  friend class MacroArgs;
347 
348  class PreambleConditionalStackStore {
349  enum State {
350  Off = 0,
351  Recording = 1,
352  Replaying = 2,
353  };
354 
355  public:
356  PreambleConditionalStackStore() = default;
357 
358  void startRecording() { ConditionalStackState = Recording; }
359  void startReplaying() { ConditionalStackState = Replaying; }
360  bool isRecording() const { return ConditionalStackState == Recording; }
361  bool isReplaying() const { return ConditionalStackState == Replaying; }
362 
363  ArrayRef<PPConditionalInfo> getStack() const {
364  return ConditionalStack;
365  }
366 
367  void doneReplaying() {
368  ConditionalStack.clear();
369  ConditionalStackState = Off;
370  }
371 
372  void setStack(ArrayRef<PPConditionalInfo> s) {
373  if (!isRecording() && !isReplaying())
374  return;
375  ConditionalStack.clear();
376  ConditionalStack.append(s.begin(), s.end());
377  }
378 
379  bool hasRecordedPreamble() const { return !ConditionalStack.empty(); }
380 
381  bool reachedEOFWhileSkipping() const { return SkipInfo.hasValue(); }
382 
383  void clearSkipInfo() { SkipInfo.reset(); }
384 
386 
387  private:
388  SmallVector<PPConditionalInfo, 4> ConditionalStack;
389  State ConditionalStackState = Off;
390  } PreambleConditionalStack;
391 
392  /// The current top of the stack that we're lexing from if
393  /// not expanding a macro and we are lexing directly from source code.
394  ///
395  /// Only one of CurLexer, CurPTHLexer, or CurTokenLexer will be non-null.
396  std::unique_ptr<Lexer> CurLexer;
397 
398  /// The current top of stack that we're lexing from if
399  /// not expanding from a macro and we are lexing from a PTH cache.
400  ///
401  /// Only one of CurLexer, CurPTHLexer, or CurTokenLexer will be non-null.
402  std::unique_ptr<PTHLexer> CurPTHLexer;
403 
404  /// The current top of the stack what we're lexing from
405  /// if not expanding a macro.
406  ///
407  /// This is an alias for either CurLexer or CurPTHLexer.
408  PreprocessorLexer *CurPPLexer = nullptr;
409 
410  /// Used to find the current FileEntry, if CurLexer is non-null
411  /// and if applicable.
412  ///
413  /// This allows us to implement \#include_next and find directory-specific
414  /// properties.
415  const DirectoryLookup *CurDirLookup = nullptr;
416 
417  /// The current macro we are expanding, if we are expanding a macro.
418  ///
419  /// One of CurLexer and CurTokenLexer must be null.
420  std::unique_ptr<TokenLexer> CurTokenLexer;
421 
422  /// The kind of lexer we're currently working with.
423  enum CurLexerKind {
424  CLK_Lexer,
425  CLK_PTHLexer,
426  CLK_TokenLexer,
427  CLK_CachingLexer,
428  CLK_LexAfterModuleImport
429  } CurLexerKind = CLK_Lexer;
430 
431  /// If the current lexer is for a submodule that is being built, this
432  /// is that submodule.
433  Module *CurLexerSubmodule = nullptr;
434 
435  /// Keeps track of the stack of files currently
436  /// \#included, and macros currently being expanded from, not counting
437  /// CurLexer/CurTokenLexer.
438  struct IncludeStackInfo {
439  enum CurLexerKind CurLexerKind;
440  Module *TheSubmodule;
441  std::unique_ptr<Lexer> TheLexer;
442  std::unique_ptr<PTHLexer> ThePTHLexer;
443  PreprocessorLexer *ThePPLexer;
444  std::unique_ptr<TokenLexer> TheTokenLexer;
445  const DirectoryLookup *TheDirLookup;
446 
447  // The following constructors are completely useless copies of the default
448  // versions, only needed to pacify MSVC.
449  IncludeStackInfo(enum CurLexerKind CurLexerKind, Module *TheSubmodule,
450  std::unique_ptr<Lexer> &&TheLexer,
451  std::unique_ptr<PTHLexer> &&ThePTHLexer,
452  PreprocessorLexer *ThePPLexer,
453  std::unique_ptr<TokenLexer> &&TheTokenLexer,
454  const DirectoryLookup *TheDirLookup)
455  : CurLexerKind(std::move(CurLexerKind)),
456  TheSubmodule(std::move(TheSubmodule)), TheLexer(std::move(TheLexer)),
457  ThePTHLexer(std::move(ThePTHLexer)),
458  ThePPLexer(std::move(ThePPLexer)),
459  TheTokenLexer(std::move(TheTokenLexer)),
460  TheDirLookup(std::move(TheDirLookup)) {}
461  };
462  std::vector<IncludeStackInfo> IncludeMacroStack;
463 
464  /// Actions invoked when some preprocessor activity is
465  /// encountered (e.g. a file is \#included, etc).
466  std::unique_ptr<PPCallbacks> Callbacks;
467 
468  struct MacroExpandsInfo {
469  Token Tok;
470  MacroDefinition MD;
471  SourceRange Range;
472 
473  MacroExpandsInfo(Token Tok, MacroDefinition MD, SourceRange Range)
474  : Tok(Tok), MD(MD), Range(Range) {}
475  };
476  SmallVector<MacroExpandsInfo, 2> DelayedMacroExpandsCallbacks;
477 
478  /// Information about a name that has been used to define a module macro.
479  struct ModuleMacroInfo {
480  /// The most recent macro directive for this identifier.
481  MacroDirective *MD;
482 
483  /// The active module macros for this identifier.
484  llvm::TinyPtrVector<ModuleMacro *> ActiveModuleMacros;
485 
486  /// The generation number at which we last updated ActiveModuleMacros.
487  /// \see Preprocessor::VisibleModules.
488  unsigned ActiveModuleMacrosGeneration = 0;
489 
490  /// Whether this macro name is ambiguous.
491  bool IsAmbiguous = false;
492 
493  /// The module macros that are overridden by this macro.
494  llvm::TinyPtrVector<ModuleMacro *> OverriddenMacros;
495 
496  ModuleMacroInfo(MacroDirective *MD) : MD(MD) {}
497  };
498 
499  /// The state of a macro for an identifier.
500  class MacroState {
501  mutable llvm::PointerUnion<MacroDirective *, ModuleMacroInfo *> State;
502 
503  ModuleMacroInfo *getModuleInfo(Preprocessor &PP,
504  const IdentifierInfo *II) const {
505  if (II->isOutOfDate())
506  PP.updateOutOfDateIdentifier(const_cast<IdentifierInfo&>(*II));
507  // FIXME: Find a spare bit on IdentifierInfo and store a
508  // HasModuleMacros flag.
509  if (!II->hasMacroDefinition() ||
510  (!PP.getLangOpts().Modules &&
511  !PP.getLangOpts().ModulesLocalVisibility) ||
512  !PP.CurSubmoduleState->VisibleModules.getGeneration())
513  return nullptr;
514 
515  auto *Info = State.dyn_cast<ModuleMacroInfo*>();
516  if (!Info) {
517  Info = new (PP.getPreprocessorAllocator())
518  ModuleMacroInfo(State.get<MacroDirective *>());
519  State = Info;
520  }
521 
522  if (PP.CurSubmoduleState->VisibleModules.getGeneration() !=
523  Info->ActiveModuleMacrosGeneration)
524  PP.updateModuleMacroInfo(II, *Info);
525  return Info;
526  }
527 
528  public:
529  MacroState() : MacroState(nullptr) {}
530  MacroState(MacroDirective *MD) : State(MD) {}
531 
532  MacroState(MacroState &&O) noexcept : State(O.State) {
533  O.State = (MacroDirective *)nullptr;
534  }
535 
536  MacroState &operator=(MacroState &&O) noexcept {
537  auto S = O.State;
538  O.State = (MacroDirective *)nullptr;
539  State = S;
540  return *this;
541  }
542 
543  ~MacroState() {
544  if (auto *Info = State.dyn_cast<ModuleMacroInfo*>())
545  Info->~ModuleMacroInfo();
546  }
547 
548  MacroDirective *getLatest() const {
549  if (auto *Info = State.dyn_cast<ModuleMacroInfo*>())
550  return Info->MD;
551  return State.get<MacroDirective*>();
552  }
553 
554  void setLatest(MacroDirective *MD) {
555  if (auto *Info = State.dyn_cast<ModuleMacroInfo*>())
556  Info->MD = MD;
557  else
558  State = MD;
559  }
560 
561  bool isAmbiguous(Preprocessor &PP, const IdentifierInfo *II) const {
562  auto *Info = getModuleInfo(PP, II);
563  return Info ? Info->IsAmbiguous : false;
564  }
565 
567  getActiveModuleMacros(Preprocessor &PP, const IdentifierInfo *II) const {
568  if (auto *Info = getModuleInfo(PP, II))
569  return Info->ActiveModuleMacros;
570  return None;
571  }
572 
573  MacroDirective::DefInfo findDirectiveAtLoc(SourceLocation Loc,
574  SourceManager &SourceMgr) const {
575  // FIXME: Incorporate module macros into the result of this.
576  if (auto *Latest = getLatest())
577  return Latest->findDirectiveAtLoc(Loc, SourceMgr);
578  return {};
579  }
580 
581  void overrideActiveModuleMacros(Preprocessor &PP, IdentifierInfo *II) {
582  if (auto *Info = getModuleInfo(PP, II)) {
583  Info->OverriddenMacros.insert(Info->OverriddenMacros.end(),
584  Info->ActiveModuleMacros.begin(),
585  Info->ActiveModuleMacros.end());
586  Info->ActiveModuleMacros.clear();
587  Info->IsAmbiguous = false;
588  }
589  }
590 
591  ArrayRef<ModuleMacro*> getOverriddenMacros() const {
592  if (auto *Info = State.dyn_cast<ModuleMacroInfo*>())
593  return Info->OverriddenMacros;
594  return None;
595  }
596 
597  void setOverriddenMacros(Preprocessor &PP,
598  ArrayRef<ModuleMacro *> Overrides) {
599  auto *Info = State.dyn_cast<ModuleMacroInfo*>();
600  if (!Info) {
601  if (Overrides.empty())
602  return;
603  Info = new (PP.getPreprocessorAllocator())
604  ModuleMacroInfo(State.get<MacroDirective *>());
605  State = Info;
606  }
607  Info->OverriddenMacros.clear();
608  Info->OverriddenMacros.insert(Info->OverriddenMacros.end(),
609  Overrides.begin(), Overrides.end());
610  Info->ActiveModuleMacrosGeneration = 0;
611  }
612  };
613 
614  /// For each IdentifierInfo that was associated with a macro, we
615  /// keep a mapping to the history of all macro definitions and #undefs in
616  /// the reverse order (the latest one is in the head of the list).
617  ///
618  /// This mapping lives within the \p CurSubmoduleState.
619  using MacroMap = llvm::DenseMap<const IdentifierInfo *, MacroState>;
620 
621  struct SubmoduleState;
622 
623  /// Information about a submodule that we're currently building.
624  struct BuildingSubmoduleInfo {
625  /// The module that we are building.
626  Module *M;
627 
628  /// The location at which the module was included.
629  SourceLocation ImportLoc;
630 
631  /// Whether we entered this submodule via a pragma.
632  bool IsPragma;
633 
634  /// The previous SubmoduleState.
635  SubmoduleState *OuterSubmoduleState;
636 
637  /// The number of pending module macro names when we started building this.
638  unsigned OuterPendingModuleMacroNames;
639 
640  BuildingSubmoduleInfo(Module *M, SourceLocation ImportLoc, bool IsPragma,
641  SubmoduleState *OuterSubmoduleState,
642  unsigned OuterPendingModuleMacroNames)
643  : M(M), ImportLoc(ImportLoc), IsPragma(IsPragma),
644  OuterSubmoduleState(OuterSubmoduleState),
645  OuterPendingModuleMacroNames(OuterPendingModuleMacroNames) {}
646  };
647  SmallVector<BuildingSubmoduleInfo, 8> BuildingSubmoduleStack;
648 
649  /// Information about a submodule's preprocessor state.
650  struct SubmoduleState {
651  /// The macros for the submodule.
652  MacroMap Macros;
653 
654  /// The set of modules that are visible within the submodule.
655  VisibleModuleSet VisibleModules;
656 
657  // FIXME: CounterValue?
658  // FIXME: PragmaPushMacroInfo?
659  };
660  std::map<Module *, SubmoduleState> Submodules;
661 
662  /// The preprocessor state for preprocessing outside of any submodule.
663  SubmoduleState NullSubmoduleState;
664 
665  /// The current submodule state. Will be \p NullSubmoduleState if we're not
666  /// in a submodule.
667  SubmoduleState *CurSubmoduleState;
668 
669  /// The set of known macros exported from modules.
670  llvm::FoldingSet<ModuleMacro> ModuleMacros;
671 
672  /// The names of potential module macros that we've not yet processed.
673  llvm::SmallVector<const IdentifierInfo *, 32> PendingModuleMacroNames;
674 
675  /// The list of module macros, for each identifier, that are not overridden by
676  /// any other module macro.
677  llvm::DenseMap<const IdentifierInfo *, llvm::TinyPtrVector<ModuleMacro *>>
678  LeafModuleMacros;
679 
680  /// Macros that we want to warn because they are not used at the end
681  /// of the translation unit.
682  ///
683  /// We store just their SourceLocations instead of
684  /// something like MacroInfo*. The benefit of this is that when we are
685  /// deserializing from PCH, we don't need to deserialize identifier & macros
686  /// just so that we can report that they are unused, we just warn using
687  /// the SourceLocations of this set (that will be filled by the ASTReader).
688  /// We are using SmallPtrSet instead of a vector for faster removal.
689  using WarnUnusedMacroLocsTy = llvm::SmallPtrSet<SourceLocation, 32>;
690  WarnUnusedMacroLocsTy WarnUnusedMacroLocs;
691 
692  /// A "freelist" of MacroArg objects that can be
693  /// reused for quick allocation.
694  MacroArgs *MacroArgCache = nullptr;
695 
696  /// For each IdentifierInfo used in a \#pragma push_macro directive,
697  /// we keep a MacroInfo stack used to restore the previous macro value.
698  llvm::DenseMap<IdentifierInfo *, std::vector<MacroInfo *>>
699  PragmaPushMacroInfo;
700 
701  // Various statistics we track for performance analysis.
702  unsigned NumDirectives = 0;
703  unsigned NumDefined = 0;
704  unsigned NumUndefined = 0;
705  unsigned NumPragma = 0;
706  unsigned NumIf = 0;
707  unsigned NumElse = 0;
708  unsigned NumEndif = 0;
709  unsigned NumEnteredSourceFiles = 0;
710  unsigned MaxIncludeStackDepth = 0;
711  unsigned NumMacroExpanded = 0;
712  unsigned NumFnMacroExpanded = 0;
713  unsigned NumBuiltinMacroExpanded = 0;
714  unsigned NumFastMacroExpanded = 0;
715  unsigned NumTokenPaste = 0;
716  unsigned NumFastTokenPaste = 0;
717  unsigned NumSkipped = 0;
718 
719  /// The predefined macros that preprocessor should use from the
720  /// command line etc.
721  std::string Predefines;
722 
723  /// The file ID for the preprocessor predefines.
724  FileID PredefinesFileID;
725 
726  /// The file ID for the PCH through header.
727  FileID PCHThroughHeaderFileID;
728 
729  /// Whether tokens are being skipped until a #pragma hdrstop is seen.
730  bool SkippingUntilPragmaHdrStop = false;
731 
732  /// Whether tokens are being skipped until the through header is seen.
733  bool SkippingUntilPCHThroughHeader = false;
734 
735  /// \{
736  /// Cache of macro expanders to reduce malloc traffic.
737  enum { TokenLexerCacheSize = 8 };
738  unsigned NumCachedTokenLexers;
739  std::unique_ptr<TokenLexer> TokenLexerCache[TokenLexerCacheSize];
740  /// \}
741 
742  /// Keeps macro expanded tokens for TokenLexers.
743  //
744  /// Works like a stack; a TokenLexer adds the macro expanded tokens that is
745  /// going to lex in the cache and when it finishes the tokens are removed
746  /// from the end of the cache.
747  SmallVector<Token, 16> MacroExpandedTokens;
748  std::vector<std::pair<TokenLexer *, size_t>> MacroExpandingLexersStack;
749 
750  /// A record of the macro definitions and expansions that
751  /// occurred during preprocessing.
752  ///
753  /// This is an optional side structure that can be enabled with
754  /// \c createPreprocessingRecord() prior to preprocessing.
755  PreprocessingRecord *Record = nullptr;
756 
757  /// Cached tokens state.
759 
760  /// Cached tokens are stored here when we do backtracking or
761  /// lookahead. They are "lexed" by the CachingLex() method.
763 
764  /// The position of the cached token that CachingLex() should
765  /// "lex" next.
766  ///
767  /// If it points beyond the CachedTokens vector, it means that a normal
768  /// Lex() should be invoked.
769  CachedTokensTy::size_type CachedLexPos = 0;
770 
771  /// Stack of backtrack positions, allowing nested backtracks.
772  ///
773  /// The EnableBacktrackAtThisPos() method pushes a position to
774  /// indicate where CachedLexPos should be set when the BackTrack() method is
775  /// invoked (at which point the last position is popped).
776  std::vector<CachedTokensTy::size_type> BacktrackPositions;
777 
778  struct MacroInfoChain {
779  MacroInfo MI;
780  MacroInfoChain *Next;
781  };
782 
783  /// MacroInfos are managed as a chain for easy disposal. This is the head
784  /// of that list.
785  MacroInfoChain *MIChainHead = nullptr;
786 
787  void updateOutOfDateIdentifier(IdentifierInfo &II) const;
788 
789 public:
790  Preprocessor(std::shared_ptr<PreprocessorOptions> PPOpts,
792  MemoryBufferCache &PCMCache,
793  HeaderSearch &Headers, ModuleLoader &TheModuleLoader,
794  IdentifierInfoLookup *IILookup = nullptr,
795  bool OwnsHeaderSearch = false,
797 
798  ~Preprocessor();
799 
800  /// Initialize the preprocessor using information about the target.
801  ///
802  /// \param Target is owned by the caller and must remain valid for the
803  /// lifetime of the preprocessor.
804  /// \param AuxTarget is owned by the caller and must remain valid for
805  /// the lifetime of the preprocessor.
806  void Initialize(const TargetInfo &Target,
807  const TargetInfo *AuxTarget = nullptr);
808 
809  /// Initialize the preprocessor to parse a model file
810  ///
811  /// To parse model files the preprocessor of the original source is reused to
812  /// preserver the identifier table. However to avoid some duplicate
813  /// information in the preprocessor some cleanup is needed before it is used
814  /// to parse model files. This method does that cleanup.
815  void InitializeForModelFile();
816 
817  /// Cleanup after model file parsing
818  void FinalizeForModelFile();
819 
820  /// Retrieve the preprocessor options used to initialize this
821  /// preprocessor.
822  PreprocessorOptions &getPreprocessorOpts() const { return *PPOpts; }
823 
824  DiagnosticsEngine &getDiagnostics() const { return *Diags; }
825  void setDiagnostics(DiagnosticsEngine &D) { Diags = &D; }
826 
827  const LangOptions &getLangOpts() const { return LangOpts; }
828  const TargetInfo &getTargetInfo() const { return *Target; }
829  const TargetInfo *getAuxTargetInfo() const { return AuxTarget; }
830  FileManager &getFileManager() const { return FileMgr; }
831  SourceManager &getSourceManager() const { return SourceMgr; }
832  MemoryBufferCache &getPCMCache() const { return PCMCache; }
833  HeaderSearch &getHeaderSearchInfo() const { return HeaderInfo; }
834 
835  IdentifierTable &getIdentifierTable() { return Identifiers; }
836  const IdentifierTable &getIdentifierTable() const { return Identifiers; }
837  SelectorTable &getSelectorTable() { return Selectors; }
839  llvm::BumpPtrAllocator &getPreprocessorAllocator() { return BP; }
840 
841  void setPTHManager(PTHManager* pm);
842 
843  PTHManager *getPTHManager() { return PTH.get(); }
844 
846  ExternalSource = Source;
847  }
848 
850  return ExternalSource;
851  }
852 
853  /// Retrieve the module loader associated with this preprocessor.
854  ModuleLoader &getModuleLoader() const { return TheModuleLoader; }
855 
857  return TheModuleLoader.HadFatalFailure;
858  }
859 
860  /// True if we are currently preprocessing a #if or #elif directive
862  return ParsingIfOrElifDirective;
863  }
864 
865  /// Control whether the preprocessor retains comments in output.
866  void SetCommentRetentionState(bool KeepComments, bool KeepMacroComments) {
867  this->KeepComments = KeepComments | KeepMacroComments;
868  this->KeepMacroComments = KeepMacroComments;
869  }
870 
871  bool getCommentRetentionState() const { return KeepComments; }
872 
873  void setPragmasEnabled(bool Enabled) { PragmasEnabled = Enabled; }
874  bool getPragmasEnabled() const { return PragmasEnabled; }
875 
876  void SetSuppressIncludeNotFoundError(bool Suppress) {
877  SuppressIncludeNotFoundError = Suppress;
878  }
879 
881  return SuppressIncludeNotFoundError;
882  }
883 
884  /// Sets whether the preprocessor is responsible for producing output or if
885  /// it is producing tokens to be consumed by Parse and Sema.
886  void setPreprocessedOutput(bool IsPreprocessedOutput) {
887  PreprocessedOutput = IsPreprocessedOutput;
888  }
889 
890  /// Returns true if the preprocessor is responsible for generating output,
891  /// false if it is producing tokens to be consumed by Parse and Sema.
892  bool isPreprocessedOutput() const { return PreprocessedOutput; }
893 
894  /// Return true if we are lexing directly from the specified lexer.
895  bool isCurrentLexer(const PreprocessorLexer *L) const {
896  return CurPPLexer == L;
897  }
898 
899  /// Return the current lexer being lexed from.
900  ///
901  /// Note that this ignores any potentially active macro expansions and _Pragma
902  /// expansions going on at the time.
903  PreprocessorLexer *getCurrentLexer() const { return CurPPLexer; }
904 
905  /// Return the current file lexer being lexed from.
906  ///
907  /// Note that this ignores any potentially active macro expansions and _Pragma
908  /// expansions going on at the time.
909  PreprocessorLexer *getCurrentFileLexer() const;
910 
911  /// Return the submodule owning the file being lexed. This may not be
912  /// the current module if we have changed modules since entering the file.
913  Module *getCurrentLexerSubmodule() const { return CurLexerSubmodule; }
914 
915  /// Returns the FileID for the preprocessor predefines.
916  FileID getPredefinesFileID() const { return PredefinesFileID; }
917 
918  /// \{
919  /// Accessors for preprocessor callbacks.
920  ///
921  /// Note that this class takes ownership of any PPCallbacks object given to
922  /// it.
923  PPCallbacks *getPPCallbacks() const { return Callbacks.get(); }
924  void addPPCallbacks(std::unique_ptr<PPCallbacks> C) {
925  if (Callbacks)
926  C = llvm::make_unique<PPChainedCallbacks>(std::move(C),
927  std::move(Callbacks));
928  Callbacks = std::move(C);
929  }
930  /// \}
931 
932  bool isMacroDefined(StringRef Id) {
933  return isMacroDefined(&Identifiers.get(Id));
934  }
935  bool isMacroDefined(const IdentifierInfo *II) {
936  return II->hasMacroDefinition() &&
937  (!getLangOpts().Modules || (bool)getMacroDefinition(II));
938  }
939 
940  /// Determine whether II is defined as a macro within the module M,
941  /// if that is a module that we've already preprocessed. Does not check for
942  /// macros imported into M.
944  if (!II->hasMacroDefinition())
945  return false;
946  auto I = Submodules.find(M);
947  if (I == Submodules.end())
948  return false;
949  auto J = I->second.Macros.find(II);
950  if (J == I->second.Macros.end())
951  return false;
952  auto *MD = J->second.getLatest();
953  return MD && MD->isDefined();
954  }
955 
957  if (!II->hasMacroDefinition())
958  return {};
959 
960  MacroState &S = CurSubmoduleState->Macros[II];
961  auto *MD = S.getLatest();
962  while (MD && isa<VisibilityMacroDirective>(MD))
963  MD = MD->getPrevious();
964  return MacroDefinition(dyn_cast_or_null<DefMacroDirective>(MD),
965  S.getActiveModuleMacros(*this, II),
966  S.isAmbiguous(*this, II));
967  }
968 
970  SourceLocation Loc) {
971  if (!II->hadMacroDefinition())
972  return {};
973 
974  MacroState &S = CurSubmoduleState->Macros[II];
976  if (auto *MD = S.getLatest())
977  DI = MD->findDirectiveAtLoc(Loc, getSourceManager());
978  // FIXME: Compute the set of active module macros at the specified location.
979  return MacroDefinition(DI.getDirective(),
980  S.getActiveModuleMacros(*this, II),
981  S.isAmbiguous(*this, II));
982  }
983 
984  /// Given an identifier, return its latest non-imported MacroDirective
985  /// if it is \#define'd and not \#undef'd, or null if it isn't \#define'd.
987  if (!II->hasMacroDefinition())
988  return nullptr;
989 
990  auto *MD = getLocalMacroDirectiveHistory(II);
991  if (!MD || MD->getDefinition().isUndefined())
992  return nullptr;
993 
994  return MD;
995  }
996 
997  const MacroInfo *getMacroInfo(const IdentifierInfo *II) const {
998  return const_cast<Preprocessor*>(this)->getMacroInfo(II);
999  }
1000 
1002  if (!II->hasMacroDefinition())
1003  return nullptr;
1004  if (auto MD = getMacroDefinition(II))
1005  return MD.getMacroInfo();
1006  return nullptr;
1007  }
1008 
1009  /// Given an identifier, return the latest non-imported macro
1010  /// directive for that identifier.
1011  ///
1012  /// One can iterate over all previous macro directives from the most recent
1013  /// one.
1014  MacroDirective *getLocalMacroDirectiveHistory(const IdentifierInfo *II) const;
1015 
1016  /// Add a directive to the macro directive history for this identifier.
1017  void appendMacroDirective(IdentifierInfo *II, MacroDirective *MD);
1019  SourceLocation Loc) {
1020  DefMacroDirective *MD = AllocateDefMacroDirective(MI, Loc);
1021  appendMacroDirective(II, MD);
1022  return MD;
1023  }
1025  MacroInfo *MI) {
1026  return appendDefMacroDirective(II, MI, MI->getDefinitionLoc());
1027  }
1028 
1029  /// Set a MacroDirective that was loaded from a PCH file.
1030  void setLoadedMacroDirective(IdentifierInfo *II, MacroDirective *ED,
1031  MacroDirective *MD);
1032 
1033  /// Register an exported macro for a module and identifier.
1034  ModuleMacro *addModuleMacro(Module *Mod, IdentifierInfo *II, MacroInfo *Macro,
1035  ArrayRef<ModuleMacro *> Overrides, bool &IsNew);
1036  ModuleMacro *getModuleMacro(Module *Mod, IdentifierInfo *II);
1037 
1038  /// Get the list of leaf (non-overridden) module macros for a name.
1040  if (II->isOutOfDate())
1041  updateOutOfDateIdentifier(const_cast<IdentifierInfo&>(*II));
1042  auto I = LeafModuleMacros.find(II);
1043  if (I != LeafModuleMacros.end())
1044  return I->second;
1045  return None;
1046  }
1047 
1048  /// \{
1049  /// Iterators for the macro history table. Currently defined macros have
1050  /// IdentifierInfo::hasMacroDefinition() set and an empty
1051  /// MacroInfo::getUndefLoc() at the head of the list.
1052  using macro_iterator = MacroMap::const_iterator;
1053 
1054  macro_iterator macro_begin(bool IncludeExternalMacros = true) const;
1055  macro_iterator macro_end(bool IncludeExternalMacros = true) const;
1056 
1057  llvm::iterator_range<macro_iterator>
1058  macros(bool IncludeExternalMacros = true) const {
1059  macro_iterator begin = macro_begin(IncludeExternalMacros);
1060  macro_iterator end = macro_end(IncludeExternalMacros);
1061  return llvm::make_range(begin, end);
1062  }
1063 
1064  /// \}
1065 
1066  /// Return the name of the macro defined before \p Loc that has
1067  /// spelling \p Tokens. If there are multiple macros with same spelling,
1068  /// return the last one defined.
1069  StringRef getLastMacroWithSpelling(SourceLocation Loc,
1070  ArrayRef<TokenValue> Tokens) const;
1071 
1072  const std::string &getPredefines() const { return Predefines; }
1073 
1074  /// Set the predefines for this Preprocessor.
1075  ///
1076  /// These predefines are automatically injected when parsing the main file.
1077  void setPredefines(const char *P) { Predefines = P; }
1078  void setPredefines(StringRef P) { Predefines = P; }
1079 
1080  /// Return information about the specified preprocessor
1081  /// identifier token.
1082  IdentifierInfo *getIdentifierInfo(StringRef Name) const {
1083  return &Identifiers.get(Name);
1084  }
1085 
1086  /// Add the specified pragma handler to this preprocessor.
1087  ///
1088  /// If \p Namespace is non-null, then it is a token required to exist on the
1089  /// pragma line before the pragma string starts, e.g. "STDC" or "GCC".
1090  void AddPragmaHandler(StringRef Namespace, PragmaHandler *Handler);
1092  AddPragmaHandler(StringRef(), Handler);
1093  }
1094 
1095  /// Remove the specific pragma handler from this preprocessor.
1096  ///
1097  /// If \p Namespace is non-null, then it should be the namespace that
1098  /// \p Handler was added to. It is an error to remove a handler that
1099  /// has not been registered.
1100  void RemovePragmaHandler(StringRef Namespace, PragmaHandler *Handler);
1102  RemovePragmaHandler(StringRef(), Handler);
1103  }
1104 
1105  /// Install empty handlers for all pragmas (making them ignored).
1106  void IgnorePragmas();
1107 
1108  /// Add the specified comment handler to the preprocessor.
1109  void addCommentHandler(CommentHandler *Handler);
1110 
1111  /// Remove the specified comment handler.
1112  ///
1113  /// It is an error to remove a handler that has not been registered.
1114  void removeCommentHandler(CommentHandler *Handler);
1115 
1116  /// Set the code completion handler to the given object.
1118  CodeComplete = &Handler;
1119  }
1120 
1121  /// Retrieve the current code-completion handler.
1123  return CodeComplete;
1124  }
1125 
1126  /// Clear out the code completion handler.
1128  CodeComplete = nullptr;
1129  }
1130 
1131  /// Hook used by the lexer to invoke the "natural language" code
1132  /// completion point.
1133  void CodeCompleteNaturalLanguage();
1134 
1135  /// Set the code completion token for filtering purposes.
1137  CodeCompletionII = Filter;
1138  }
1139 
1140  /// Set the code completion token range for detecting replacement range later
1141  /// on.
1143  const SourceLocation End) {
1144  CodeCompletionTokenRange = {Start, End};
1145  }
1147  return CodeCompletionTokenRange;
1148  }
1149 
1150  /// Get the code completion token for filtering purposes.
1152  if (CodeCompletionII)
1153  return CodeCompletionII->getName();
1154  return {};
1155  }
1156 
1157  /// Retrieve the preprocessing record, or NULL if there is no
1158  /// preprocessing record.
1159  PreprocessingRecord *getPreprocessingRecord() const { return Record; }
1160 
1161  /// Create a new preprocessing record, which will keep track of
1162  /// all macro expansions, macro definitions, etc.
1163  void createPreprocessingRecord();
1164 
1165  /// Returns true if the FileEntry is the PCH through header.
1166  bool isPCHThroughHeader(const FileEntry *FE);
1167 
1168  /// True if creating a PCH with a through header.
1169  bool creatingPCHWithThroughHeader();
1170 
1171  /// True if using a PCH with a through header.
1172  bool usingPCHWithThroughHeader();
1173 
1174  /// True if creating a PCH with a #pragma hdrstop.
1175  bool creatingPCHWithPragmaHdrStop();
1176 
1177  /// True if using a PCH with a #pragma hdrstop.
1178  bool usingPCHWithPragmaHdrStop();
1179 
1180  /// Skip tokens until after the #include of the through header or
1181  /// until after a #pragma hdrstop.
1182  void SkipTokensWhileUsingPCH();
1183 
1184  /// Process directives while skipping until the through header or
1185  /// #pragma hdrstop is found.
1186  void HandleSkippedDirectiveWhileUsingPCH(Token &Result,
1187  SourceLocation HashLoc);
1188 
1189  /// Enter the specified FileID as the main source file,
1190  /// which implicitly adds the builtin defines etc.
1191  void EnterMainSourceFile();
1192 
1193  /// Inform the preprocessor callbacks that processing is complete.
1194  void EndSourceFile();
1195 
1196  /// Add a source file to the top of the include stack and
1197  /// start lexing tokens from it instead of the current buffer.
1198  ///
1199  /// Emits a diagnostic, doesn't enter the file, and returns true on error.
1200  bool EnterSourceFile(FileID FID, const DirectoryLookup *Dir,
1201  SourceLocation Loc);
1202 
1203  /// Add a Macro to the top of the include stack and start lexing
1204  /// tokens from it instead of the current buffer.
1205  ///
1206  /// \param Args specifies the tokens input to a function-like macro.
1207  /// \param ILEnd specifies the location of the ')' for a function-like macro
1208  /// or the identifier for an object-like macro.
1209  void EnterMacro(Token &Tok, SourceLocation ILEnd, MacroInfo *Macro,
1210  MacroArgs *Args);
1211 
1212  /// Add a "macro" context to the top of the include stack,
1213  /// which will cause the lexer to start returning the specified tokens.
1214  ///
1215  /// If \p DisableMacroExpansion is true, tokens lexed from the token stream
1216  /// will not be subject to further macro expansion. Otherwise, these tokens
1217  /// will be re-macro-expanded when/if expansion is enabled.
1218  ///
1219  /// If \p OwnsTokens is false, this method assumes that the specified stream
1220  /// of tokens has a permanent owner somewhere, so they do not need to be
1221  /// copied. If it is true, it assumes the array of tokens is allocated with
1222  /// \c new[] and the Preprocessor will delete[] it.
1223 private:
1224  void EnterTokenStream(const Token *Toks, unsigned NumToks,
1225  bool DisableMacroExpansion, bool OwnsTokens);
1226 
1227 public:
1228  void EnterTokenStream(std::unique_ptr<Token[]> Toks, unsigned NumToks,
1229  bool DisableMacroExpansion) {
1230  EnterTokenStream(Toks.release(), NumToks, DisableMacroExpansion, true);
1231  }
1232 
1233  void EnterTokenStream(ArrayRef<Token> Toks, bool DisableMacroExpansion) {
1234  EnterTokenStream(Toks.data(), Toks.size(), DisableMacroExpansion, false);
1235  }
1236 
1237  /// Pop the current lexer/macro exp off the top of the lexer stack.
1238  ///
1239  /// This should only be used in situations where the current state of the
1240  /// top-of-stack lexer is known.
1241  void RemoveTopOfLexerStack();
1242 
1243  /// From the point that this method is called, and until
1244  /// CommitBacktrackedTokens() or Backtrack() is called, the Preprocessor
1245  /// keeps track of the lexed tokens so that a subsequent Backtrack() call will
1246  /// make the Preprocessor re-lex the same tokens.
1247  ///
1248  /// Nested backtracks are allowed, meaning that EnableBacktrackAtThisPos can
1249  /// be called multiple times and CommitBacktrackedTokens/Backtrack calls will
1250  /// be combined with the EnableBacktrackAtThisPos calls in reverse order.
1251  ///
1252  /// NOTE: *DO NOT* forget to call either CommitBacktrackedTokens or Backtrack
1253  /// at some point after EnableBacktrackAtThisPos. If you don't, caching of
1254  /// tokens will continue indefinitely.
1255  ///
1256  void EnableBacktrackAtThisPos();
1257 
1258  /// Disable the last EnableBacktrackAtThisPos call.
1259  void CommitBacktrackedTokens();
1260 
1262  CachedTokensTy::size_type Begin, End;
1263  };
1264 
1265 private:
1266  /// A range of cached tokens that should be erased after lexing
1267  /// when backtracking requires the erasure of such cached tokens.
1268  Optional<CachedTokensRange> CachedTokenRangeToErase;
1269 
1270 public:
1271  /// Returns the range of cached tokens that were lexed since
1272  /// EnableBacktrackAtThisPos() was previously called.
1273  CachedTokensRange LastCachedTokenRange();
1274 
1275  /// Erase the range of cached tokens that were lexed since
1276  /// EnableBacktrackAtThisPos() was previously called.
1277  void EraseCachedTokens(CachedTokensRange TokenRange);
1278 
1279  /// Make Preprocessor re-lex the tokens that were lexed since
1280  /// EnableBacktrackAtThisPos() was previously called.
1281  void Backtrack();
1282 
1283  /// True if EnableBacktrackAtThisPos() was called and
1284  /// caching of tokens is on.
1285  bool isBacktrackEnabled() const { return !BacktrackPositions.empty(); }
1286 
1287  /// Lex the next token for this preprocessor.
1288  void Lex(Token &Result);
1289 
1290  void LexAfterModuleImport(Token &Result);
1291 
1292  void makeModuleVisible(Module *M, SourceLocation Loc);
1293 
1295  return CurSubmoduleState->VisibleModules.getImportLoc(M);
1296  }
1297 
1298  /// Lex a string literal, which may be the concatenation of multiple
1299  /// string literals and may even come from macro expansion.
1300  /// \returns true on success, false if a error diagnostic has been generated.
1301  bool LexStringLiteral(Token &Result, std::string &String,
1302  const char *DiagnosticTag, bool AllowMacroExpansion) {
1303  if (AllowMacroExpansion)
1304  Lex(Result);
1305  else
1306  LexUnexpandedToken(Result);
1307  return FinishLexStringLiteral(Result, String, DiagnosticTag,
1308  AllowMacroExpansion);
1309  }
1310 
1311  /// Complete the lexing of a string literal where the first token has
1312  /// already been lexed (see LexStringLiteral).
1313  bool FinishLexStringLiteral(Token &Result, std::string &String,
1314  const char *DiagnosticTag,
1315  bool AllowMacroExpansion);
1316 
1317  /// Lex a token. If it's a comment, keep lexing until we get
1318  /// something not a comment.
1319  ///
1320  /// This is useful in -E -C mode where comments would foul up preprocessor
1321  /// directive handling.
1322  void LexNonComment(Token &Result) {
1323  do
1324  Lex(Result);
1325  while (Result.getKind() == tok::comment);
1326  }
1327 
1328  /// Just like Lex, but disables macro expansion of identifier tokens.
1329  void LexUnexpandedToken(Token &Result) {
1330  // Disable macro expansion.
1331  bool OldVal = DisableMacroExpansion;
1332  DisableMacroExpansion = true;
1333  // Lex the token.
1334  Lex(Result);
1335 
1336  // Reenable it.
1337  DisableMacroExpansion = OldVal;
1338  }
1339 
1340  /// Like LexNonComment, but this disables macro expansion of
1341  /// identifier tokens.
1343  do
1344  LexUnexpandedToken(Result);
1345  while (Result.getKind() == tok::comment);
1346  }
1347 
1348  /// Parses a simple integer literal to get its numeric value. Floating
1349  /// point literals and user defined literals are rejected. Used primarily to
1350  /// handle pragmas that accept integer arguments.
1351  bool parseSimpleIntegerLiteral(Token &Tok, uint64_t &Value);
1352 
1353  /// Disables macro expansion everywhere except for preprocessor directives.
1355  DisableMacroExpansion = true;
1356  MacroExpansionInDirectivesOverride = true;
1357  }
1358 
1359  /// Peeks ahead N tokens and returns that token without consuming any
1360  /// tokens.
1361  ///
1362  /// LookAhead(0) returns the next token that would be returned by Lex(),
1363  /// LookAhead(1) returns the token after it, etc. This returns normal
1364  /// tokens after phase 5. As such, it is equivalent to using
1365  /// 'Lex', not 'LexUnexpandedToken'.
1366  const Token &LookAhead(unsigned N) {
1367  if (CachedLexPos + N < CachedTokens.size())
1368  return CachedTokens[CachedLexPos+N];
1369  else
1370  return PeekAhead(N+1);
1371  }
1372 
1373  /// When backtracking is enabled and tokens are cached,
1374  /// this allows to revert a specific number of tokens.
1375  ///
1376  /// Note that the number of tokens being reverted should be up to the last
1377  /// backtrack position, not more.
1378  void RevertCachedTokens(unsigned N) {
1379  assert(isBacktrackEnabled() &&
1380  "Should only be called when tokens are cached for backtracking");
1381  assert(signed(CachedLexPos) - signed(N) >= signed(BacktrackPositions.back())
1382  && "Should revert tokens up to the last backtrack position, not more");
1383  assert(signed(CachedLexPos) - signed(N) >= 0 &&
1384  "Corrupted backtrack positions ?");
1385  CachedLexPos -= N;
1386  }
1387 
1388  /// Enters a token in the token stream to be lexed next.
1389  ///
1390  /// If BackTrack() is called afterwards, the token will remain at the
1391  /// insertion point.
1392  void EnterToken(const Token &Tok) {
1393  EnterCachingLexMode();
1394  CachedTokens.insert(CachedTokens.begin()+CachedLexPos, Tok);
1395  }
1396 
1397  /// We notify the Preprocessor that if it is caching tokens (because
1398  /// backtrack is enabled) it should replace the most recent cached tokens
1399  /// with the given annotation token. This function has no effect if
1400  /// backtracking is not enabled.
1401  ///
1402  /// Note that the use of this function is just for optimization, so that the
1403  /// cached tokens doesn't get re-parsed and re-resolved after a backtrack is
1404  /// invoked.
1405  void AnnotateCachedTokens(const Token &Tok) {
1406  assert(Tok.isAnnotation() && "Expected annotation token");
1407  if (CachedLexPos != 0 && isBacktrackEnabled())
1408  AnnotatePreviousCachedTokens(Tok);
1409  }
1410 
1411  /// Get the location of the last cached token, suitable for setting the end
1412  /// location of an annotation token.
1414  assert(CachedLexPos != 0);
1415  return CachedTokens[CachedLexPos-1].getLastLoc();
1416  }
1417 
1418  /// Whether \p Tok is the most recent token (`CachedLexPos - 1`) in
1419  /// CachedTokens.
1420  bool IsPreviousCachedToken(const Token &Tok) const;
1421 
1422  /// Replace token in `CachedLexPos - 1` in CachedTokens by the tokens
1423  /// in \p NewToks.
1424  ///
1425  /// Useful when a token needs to be split in smaller ones and CachedTokens
1426  /// most recent token must to be updated to reflect that.
1427  void ReplacePreviousCachedToken(ArrayRef<Token> NewToks);
1428 
1429  /// Replace the last token with an annotation token.
1430  ///
1431  /// Like AnnotateCachedTokens(), this routine replaces an
1432  /// already-parsed (and resolved) token with an annotation
1433  /// token. However, this routine only replaces the last token with
1434  /// the annotation token; it does not affect any other cached
1435  /// tokens. This function has no effect if backtracking is not
1436  /// enabled.
1438  assert(Tok.isAnnotation() && "Expected annotation token");
1439  if (CachedLexPos != 0 && isBacktrackEnabled())
1440  CachedTokens[CachedLexPos-1] = Tok;
1441  }
1442 
1443  /// Enter an annotation token into the token stream.
1444  void EnterAnnotationToken(SourceRange Range, tok::TokenKind Kind,
1445  void *AnnotationVal);
1446 
1447  /// Update the current token to represent the provided
1448  /// identifier, in order to cache an action performed by typo correction.
1449  void TypoCorrectToken(const Token &Tok) {
1450  assert(Tok.getIdentifierInfo() && "Expected identifier token");
1451  if (CachedLexPos != 0 && isBacktrackEnabled())
1452  CachedTokens[CachedLexPos-1] = Tok;
1453  }
1454 
1455  /// Recompute the current lexer kind based on the CurLexer/CurPTHLexer/
1456  /// CurTokenLexer pointers.
1457  void recomputeCurLexerKind();
1458 
1459  /// Returns true if incremental processing is enabled
1460  bool isIncrementalProcessingEnabled() const { return IncrementalProcessing; }
1461 
1462  /// Enables the incremental processing
1463  void enableIncrementalProcessing(bool value = true) {
1464  IncrementalProcessing = value;
1465  }
1466 
1467  /// Specify the point at which code-completion will be performed.
1468  ///
1469  /// \param File the file in which code completion should occur. If
1470  /// this file is included multiple times, code-completion will
1471  /// perform completion the first time it is included. If NULL, this
1472  /// function clears out the code-completion point.
1473  ///
1474  /// \param Line the line at which code completion should occur
1475  /// (1-based).
1476  ///
1477  /// \param Column the column at which code completion should occur
1478  /// (1-based).
1479  ///
1480  /// \returns true if an error occurred, false otherwise.
1481  bool SetCodeCompletionPoint(const FileEntry *File,
1482  unsigned Line, unsigned Column);
1483 
1484  /// Determine if we are performing code completion.
1485  bool isCodeCompletionEnabled() const { return CodeCompletionFile != nullptr; }
1486 
1487  /// Returns the location of the code-completion point.
1488  ///
1489  /// Returns an invalid location if code-completion is not enabled or the file
1490  /// containing the code-completion point has not been lexed yet.
1491  SourceLocation getCodeCompletionLoc() const { return CodeCompletionLoc; }
1492 
1493  /// Returns the start location of the file of code-completion point.
1494  ///
1495  /// Returns an invalid location if code-completion is not enabled or the file
1496  /// containing the code-completion point has not been lexed yet.
1498  return CodeCompletionFileLoc;
1499  }
1500 
1501  /// Returns true if code-completion is enabled and we have hit the
1502  /// code-completion point.
1503  bool isCodeCompletionReached() const { return CodeCompletionReached; }
1504 
1505  /// Note that we hit the code-completion point.
1507  assert(isCodeCompletionEnabled() && "Code-completion not enabled!");
1508  CodeCompletionReached = true;
1509  // Silence any diagnostics that occur after we hit the code-completion.
1510  getDiagnostics().setSuppressAllDiagnostics(true);
1511  }
1512 
1513  /// The location of the currently-active \#pragma clang
1514  /// arc_cf_code_audited begin.
1515  ///
1516  /// Returns an invalid location if there is no such pragma active.
1518  return PragmaARCCFCodeAuditedLoc;
1519  }
1520 
1521  /// Set the location of the currently-active \#pragma clang
1522  /// arc_cf_code_audited begin. An invalid location ends the pragma.
1524  PragmaARCCFCodeAuditedLoc = Loc;
1525  }
1526 
1527  /// The location of the currently-active \#pragma clang
1528  /// assume_nonnull begin.
1529  ///
1530  /// Returns an invalid location if there is no such pragma active.
1532  return PragmaAssumeNonNullLoc;
1533  }
1534 
1535  /// Set the location of the currently-active \#pragma clang
1536  /// assume_nonnull begin. An invalid location ends the pragma.
1538  PragmaAssumeNonNullLoc = Loc;
1539  }
1540 
1541  /// Set the directory in which the main file should be considered
1542  /// to have been found, if it is not a real file.
1543  void setMainFileDir(const DirectoryEntry *Dir) {
1544  MainFileDir = Dir;
1545  }
1546 
1547  /// Instruct the preprocessor to skip part of the main source file.
1548  ///
1549  /// \param Bytes The number of bytes in the preamble to skip.
1550  ///
1551  /// \param StartOfLine Whether skipping these bytes puts the lexer at the
1552  /// start of a line.
1553  void setSkipMainFilePreamble(unsigned Bytes, bool StartOfLine) {
1554  SkipMainFilePreamble.first = Bytes;
1555  SkipMainFilePreamble.second = StartOfLine;
1556  }
1557 
1558  /// Forwarding function for diagnostics. This emits a diagnostic at
1559  /// the specified Token's location, translating the token's start
1560  /// position in the current buffer into a SourcePosition object for rendering.
1561  DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID) const {
1562  return Diags->Report(Loc, DiagID);
1563  }
1564 
1565  DiagnosticBuilder Diag(const Token &Tok, unsigned DiagID) const {
1566  return Diags->Report(Tok.getLocation(), DiagID);
1567  }
1568 
1569  /// Return the 'spelling' of the token at the given
1570  /// location; does not go up to the spelling location or down to the
1571  /// expansion location.
1572  ///
1573  /// \param buffer A buffer which will be used only if the token requires
1574  /// "cleaning", e.g. if it contains trigraphs or escaped newlines
1575  /// \param invalid If non-null, will be set \c true if an error occurs.
1577  SmallVectorImpl<char> &buffer,
1578  bool *invalid = nullptr) const {
1579  return Lexer::getSpelling(loc, buffer, SourceMgr, LangOpts, invalid);
1580  }
1581 
1582  /// Return the 'spelling' of the Tok token.
1583  ///
1584  /// The spelling of a token is the characters used to represent the token in
1585  /// the source file after trigraph expansion and escaped-newline folding. In
1586  /// particular, this wants to get the true, uncanonicalized, spelling of
1587  /// things like digraphs, UCNs, etc.
1588  ///
1589  /// \param Invalid If non-null, will be set \c true if an error occurs.
1590  std::string getSpelling(const Token &Tok, bool *Invalid = nullptr) const {
1591  return Lexer::getSpelling(Tok, SourceMgr, LangOpts, Invalid);
1592  }
1593 
1594  /// Get the spelling of a token into a preallocated buffer, instead
1595  /// of as an std::string.
1596  ///
1597  /// The caller is required to allocate enough space for the token, which is
1598  /// guaranteed to be at least Tok.getLength() bytes long. The length of the
1599  /// actual result is returned.
1600  ///
1601  /// Note that this method may do two possible things: it may either fill in
1602  /// the buffer specified with characters, or it may *change the input pointer*
1603  /// to point to a constant buffer with the data already in it (avoiding a
1604  /// copy). The caller is not allowed to modify the returned buffer pointer
1605  /// if an internal buffer is returned.
1606  unsigned getSpelling(const Token &Tok, const char *&Buffer,
1607  bool *Invalid = nullptr) const {
1608  return Lexer::getSpelling(Tok, Buffer, SourceMgr, LangOpts, Invalid);
1609  }
1610 
1611  /// Get the spelling of a token into a SmallVector.
1612  ///
1613  /// Note that the returned StringRef may not point to the
1614  /// supplied buffer if a copy can be avoided.
1615  StringRef getSpelling(const Token &Tok,
1616  SmallVectorImpl<char> &Buffer,
1617  bool *Invalid = nullptr) const;
1618 
1619  /// Relex the token at the specified location.
1620  /// \returns true if there was a failure, false on success.
1621  bool getRawToken(SourceLocation Loc, Token &Result,
1622  bool IgnoreWhiteSpace = false) {
1623  return Lexer::getRawToken(Loc, Result, SourceMgr, LangOpts, IgnoreWhiteSpace);
1624  }
1625 
1626  /// Given a Token \p Tok that is a numeric constant with length 1,
1627  /// return the character.
1628  char
1630  bool *Invalid = nullptr) const {
1631  assert(Tok.is(tok::numeric_constant) &&
1632  Tok.getLength() == 1 && "Called on unsupported token");
1633  assert(!Tok.needsCleaning() && "Token can't need cleaning with length 1");
1634 
1635  // If the token is carrying a literal data pointer, just use it.
1636  if (const char *D = Tok.getLiteralData())
1637  return *D;
1638 
1639  // Otherwise, fall back on getCharacterData, which is slower, but always
1640  // works.
1641  return *SourceMgr.getCharacterData(Tok.getLocation(), Invalid);
1642  }
1643 
1644  /// Retrieve the name of the immediate macro expansion.
1645  ///
1646  /// This routine starts from a source location, and finds the name of the
1647  /// macro responsible for its immediate expansion. It looks through any
1648  /// intervening macro argument expansions to compute this. It returns a
1649  /// StringRef that refers to the SourceManager-owned buffer of the source
1650  /// where that macro name is spelled. Thus, the result shouldn't out-live
1651  /// the SourceManager.
1653  return Lexer::getImmediateMacroName(Loc, SourceMgr, getLangOpts());
1654  }
1655 
1656  /// Plop the specified string into a scratch buffer and set the
1657  /// specified token's location and length to it.
1658  ///
1659  /// If specified, the source location provides a location of the expansion
1660  /// point of the token.
1661  void CreateString(StringRef Str, Token &Tok,
1662  SourceLocation ExpansionLocStart = SourceLocation(),
1663  SourceLocation ExpansionLocEnd = SourceLocation());
1664 
1665  /// Split the first Length characters out of the token starting at TokLoc
1666  /// and return a location pointing to the split token. Re-lexing from the
1667  /// split token will return the split token rather than the original.
1668  SourceLocation SplitToken(SourceLocation TokLoc, unsigned Length);
1669 
1670  /// Computes the source location just past the end of the
1671  /// token at this source location.
1672  ///
1673  /// This routine can be used to produce a source location that
1674  /// points just past the end of the token referenced by \p Loc, and
1675  /// is generally used when a diagnostic needs to point just after a
1676  /// token where it expected something different that it received. If
1677  /// the returned source location would not be meaningful (e.g., if
1678  /// it points into a macro), this routine returns an invalid
1679  /// source location.
1680  ///
1681  /// \param Offset an offset from the end of the token, where the source
1682  /// location should refer to. The default offset (0) produces a source
1683  /// location pointing just past the end of the token; an offset of 1 produces
1684  /// a source location pointing to the last character in the token, etc.
1686  return Lexer::getLocForEndOfToken(Loc, Offset, SourceMgr, LangOpts);
1687  }
1688 
1689  /// Returns true if the given MacroID location points at the first
1690  /// token of the macro expansion.
1691  ///
1692  /// \param MacroBegin If non-null and function returns true, it is set to
1693  /// begin location of the macro.
1695  SourceLocation *MacroBegin = nullptr) const {
1696  return Lexer::isAtStartOfMacroExpansion(loc, SourceMgr, LangOpts,
1697  MacroBegin);
1698  }
1699 
1700  /// Returns true if the given MacroID location points at the last
1701  /// token of the macro expansion.
1702  ///
1703  /// \param MacroEnd If non-null and function returns true, it is set to
1704  /// end location of the macro.
1706  SourceLocation *MacroEnd = nullptr) const {
1707  return Lexer::isAtEndOfMacroExpansion(loc, SourceMgr, LangOpts, MacroEnd);
1708  }
1709 
1710  /// Print the token to stderr, used for debugging.
1711  void DumpToken(const Token &Tok, bool DumpFlags = false) const;
1712  void DumpLocation(SourceLocation Loc) const;
1713  void DumpMacro(const MacroInfo &MI) const;
1714  void dumpMacroInfo(const IdentifierInfo *II);
1715 
1716  /// Given a location that specifies the start of a
1717  /// token, return a new location that specifies a character within the token.
1719  unsigned Char) const {
1720  return Lexer::AdvanceToTokenCharacter(TokStart, Char, SourceMgr, LangOpts);
1721  }
1722 
1723  /// Increment the counters for the number of token paste operations
1724  /// performed.
1725  ///
1726  /// If fast was specified, this is a 'fast paste' case we handled.
1727  void IncrementPasteCounter(bool isFast) {
1728  if (isFast)
1729  ++NumFastTokenPaste;
1730  else
1731  ++NumTokenPaste;
1732  }
1733 
1734  void PrintStats();
1735 
1736  size_t getTotalMemory() const;
1737 
1738  /// When the macro expander pastes together a comment (/##/) in Microsoft
1739  /// mode, this method handles updating the current state, returning the
1740  /// token on the next source line.
1741  void HandleMicrosoftCommentPaste(Token &Tok);
1742 
1743  //===--------------------------------------------------------------------===//
1744  // Preprocessor callback methods. These are invoked by a lexer as various
1745  // directives and events are found.
1746 
1747  /// Given a tok::raw_identifier token, look up the
1748  /// identifier information for the token and install it into the token,
1749  /// updating the token kind accordingly.
1750  IdentifierInfo *LookUpIdentifierInfo(Token &Identifier) const;
1751 
1752 private:
1753  llvm::DenseMap<IdentifierInfo*,unsigned> PoisonReasons;
1754 
1755 public:
1756  /// Specifies the reason for poisoning an identifier.
1757  ///
1758  /// If that identifier is accessed while poisoned, then this reason will be
1759  /// used instead of the default "poisoned" diagnostic.
1760  void SetPoisonReason(IdentifierInfo *II, unsigned DiagID);
1761 
1762  /// Display reason for poisoned identifier.
1763  void HandlePoisonedIdentifier(Token & Identifier);
1764 
1766  if(IdentifierInfo * II = Identifier.getIdentifierInfo()) {
1767  if(II->isPoisoned()) {
1768  HandlePoisonedIdentifier(Identifier);
1769  }
1770  }
1771  }
1772 
1773 private:
1774  /// Identifiers used for SEH handling in Borland. These are only
1775  /// allowed in particular circumstances
1776  // __except block
1777  IdentifierInfo *Ident__exception_code,
1778  *Ident___exception_code,
1779  *Ident_GetExceptionCode;
1780  // __except filter expression
1781  IdentifierInfo *Ident__exception_info,
1782  *Ident___exception_info,
1783  *Ident_GetExceptionInfo;
1784  // __finally
1785  IdentifierInfo *Ident__abnormal_termination,
1786  *Ident___abnormal_termination,
1787  *Ident_AbnormalTermination;
1788 
1789  const char *getCurLexerEndPos();
1790  void diagnoseMissingHeaderInUmbrellaDir(const Module &Mod);
1791 
1792 public:
1793  void PoisonSEHIdentifiers(bool Poison = true); // Borland
1794 
1795  /// Callback invoked when the lexer reads an identifier and has
1796  /// filled in the tokens IdentifierInfo member.
1797  ///
1798  /// This callback potentially macro expands it or turns it into a named
1799  /// token (like 'for').
1800  ///
1801  /// \returns true if we actually computed a token, false if we need to
1802  /// lex again.
1803  bool HandleIdentifier(Token &Identifier);
1804 
1805  /// Callback invoked when the lexer hits the end of the current file.
1806  ///
1807  /// This either returns the EOF token and returns true, or
1808  /// pops a level off the include stack and returns false, at which point the
1809  /// client should call lex again.
1810  bool HandleEndOfFile(Token &Result, bool isEndOfMacro = false);
1811 
1812  /// Callback invoked when the current TokenLexer hits the end of its
1813  /// token stream.
1814  bool HandleEndOfTokenLexer(Token &Result);
1815 
1816  /// Callback invoked when the lexer sees a # token at the start of a
1817  /// line.
1818  ///
1819  /// This consumes the directive, modifies the lexer/preprocessor state, and
1820  /// advances the lexer(s) so that the next token read is the correct one.
1821  void HandleDirective(Token &Result);
1822 
1823  /// Ensure that the next token is a tok::eod token.
1824  ///
1825  /// If not, emit a diagnostic and consume up until the eod.
1826  /// If \p EnableMacros is true, then we consider macros that expand to zero
1827  /// tokens as being ok.
1828  void CheckEndOfDirective(const char *DirType, bool EnableMacros = false);
1829 
1830  /// Read and discard all tokens remaining on the current line until
1831  /// the tok::eod token is found.
1832  void DiscardUntilEndOfDirective();
1833 
1834  /// Returns true if the preprocessor has seen a use of
1835  /// __DATE__ or __TIME__ in the file so far.
1836  bool SawDateOrTime() const {
1837  return DATELoc != SourceLocation() || TIMELoc != SourceLocation();
1838  }
1839  unsigned getCounterValue() const { return CounterValue; }
1840  void setCounterValue(unsigned V) { CounterValue = V; }
1841 
1842  /// Retrieves the module that we're currently building, if any.
1843  Module *getCurrentModule();
1844 
1845  /// Allocate a new MacroInfo object with the provided SourceLocation.
1846  MacroInfo *AllocateMacroInfo(SourceLocation L);
1847 
1848  /// Turn the specified lexer token into a fully checked and spelled
1849  /// filename, e.g. as an operand of \#include.
1850  ///
1851  /// The caller is expected to provide a buffer that is large enough to hold
1852  /// the spelling of the filename, but is also expected to handle the case
1853  /// when this method decides to use a different buffer.
1854  ///
1855  /// \returns true if the input filename was in <>'s or false if it was
1856  /// in ""'s.
1857  bool GetIncludeFilenameSpelling(SourceLocation Loc,StringRef &Buffer);
1858 
1859  /// Given a "foo" or <foo> reference, look up the indicated file.
1860  ///
1861  /// Returns null on failure. \p isAngled indicates whether the file
1862  /// reference is for system \#include's or not (i.e. using <> instead of "").
1863  const FileEntry *LookupFile(SourceLocation FilenameLoc, StringRef Filename,
1864  bool isAngled, const DirectoryLookup *FromDir,
1865  const FileEntry *FromFile,
1866  const DirectoryLookup *&CurDir,
1867  SmallVectorImpl<char> *SearchPath,
1868  SmallVectorImpl<char> *RelativePath,
1869  ModuleMap::KnownHeader *SuggestedModule,
1870  bool *IsMapped, bool SkipCache = false);
1871 
1872  /// Get the DirectoryLookup structure used to find the current
1873  /// FileEntry, if CurLexer is non-null and if applicable.
1874  ///
1875  /// This allows us to implement \#include_next and find directory-specific
1876  /// properties.
1877  const DirectoryLookup *GetCurDirLookup() { return CurDirLookup; }
1878 
1879  /// Return true if we're in the top-level file, not in a \#include.
1880  bool isInPrimaryFile() const;
1881 
1882  /// Handle cases where the \#include name is expanded
1883  /// from a macro as multiple tokens, which need to be glued together.
1884  ///
1885  /// This occurs for code like:
1886  /// \code
1887  /// \#define FOO <x/y.h>
1888  /// \#include FOO
1889  /// \endcode
1890  /// because in this case, "<x/y.h>" is returned as 7 tokens, not one.
1891  ///
1892  /// This code concatenates and consumes tokens up to the '>' token. It
1893  /// returns false if the > was found, otherwise it returns true if it finds
1894  /// and consumes the EOD marker.
1895  bool ConcatenateIncludeName(SmallString<128> &FilenameBuffer,
1896  SourceLocation &End);
1897 
1898  /// Lex an on-off-switch (C99 6.10.6p2) and verify that it is
1899  /// followed by EOD. Return true if the token is not a valid on-off-switch.
1900  bool LexOnOffSwitch(tok::OnOffSwitch &Result);
1901 
1902  bool CheckMacroName(Token &MacroNameTok, MacroUse isDefineUndef,
1903  bool *ShadowFlag = nullptr);
1904 
1905  void EnterSubmodule(Module *M, SourceLocation ImportLoc, bool ForPragma);
1906  Module *LeaveSubmodule(bool ForPragma);
1907 
1908 private:
1909  friend void TokenLexer::ExpandFunctionArguments();
1910 
1911  void PushIncludeMacroStack() {
1912  assert(CurLexerKind != CLK_CachingLexer && "cannot push a caching lexer");
1913  IncludeMacroStack.emplace_back(CurLexerKind, CurLexerSubmodule,
1914  std::move(CurLexer), std::move(CurPTHLexer),
1915  CurPPLexer, std::move(CurTokenLexer),
1916  CurDirLookup);
1917  CurPPLexer = nullptr;
1918  }
1919 
1920  void PopIncludeMacroStack() {
1921  CurLexer = std::move(IncludeMacroStack.back().TheLexer);
1922  CurPTHLexer = std::move(IncludeMacroStack.back().ThePTHLexer);
1923  CurPPLexer = IncludeMacroStack.back().ThePPLexer;
1924  CurTokenLexer = std::move(IncludeMacroStack.back().TheTokenLexer);
1925  CurDirLookup = IncludeMacroStack.back().TheDirLookup;
1926  CurLexerSubmodule = IncludeMacroStack.back().TheSubmodule;
1927  CurLexerKind = IncludeMacroStack.back().CurLexerKind;
1928  IncludeMacroStack.pop_back();
1929  }
1930 
1931  void PropagateLineStartLeadingSpaceInfo(Token &Result);
1932 
1933  /// Determine whether we need to create module macros for #defines in the
1934  /// current context.
1935  bool needModuleMacros() const;
1936 
1937  /// Update the set of active module macros and ambiguity flag for a module
1938  /// macro name.
1939  void updateModuleMacroInfo(const IdentifierInfo *II, ModuleMacroInfo &Info);
1940 
1941  DefMacroDirective *AllocateDefMacroDirective(MacroInfo *MI,
1942  SourceLocation Loc);
1943  UndefMacroDirective *AllocateUndefMacroDirective(SourceLocation UndefLoc);
1944  VisibilityMacroDirective *AllocateVisibilityMacroDirective(SourceLocation Loc,
1945  bool isPublic);
1946 
1947  /// Lex and validate a macro name, which occurs after a
1948  /// \#define or \#undef.
1949  ///
1950  /// \param MacroNameTok Token that represents the name defined or undefined.
1951  /// \param IsDefineUndef Kind if preprocessor directive.
1952  /// \param ShadowFlag Points to flag that is set if macro name shadows
1953  /// a keyword.
1954  ///
1955  /// This emits a diagnostic, sets the token kind to eod,
1956  /// and discards the rest of the macro line if the macro name is invalid.
1957  void ReadMacroName(Token &MacroNameTok, MacroUse IsDefineUndef = MU_Other,
1958  bool *ShadowFlag = nullptr);
1959 
1960  /// ReadOptionalMacroParameterListAndBody - This consumes all (i.e. the
1961  /// entire line) of the macro's tokens and adds them to MacroInfo, and while
1962  /// doing so performs certain validity checks including (but not limited to):
1963  /// - # (stringization) is followed by a macro parameter
1964  /// \param MacroNameTok - Token that represents the macro name
1965  /// \param ImmediatelyAfterHeaderGuard - Macro follows an #ifdef header guard
1966  ///
1967  /// Either returns a pointer to a MacroInfo object OR emits a diagnostic and
1968  /// returns a nullptr if an invalid sequence of tokens is encountered.
1969  MacroInfo *ReadOptionalMacroParameterListAndBody(
1970  const Token &MacroNameTok, bool ImmediatelyAfterHeaderGuard);
1971 
1972  /// The ( starting an argument list of a macro definition has just been read.
1973  /// Lex the rest of the parameters and the closing ), updating \p MI with
1974  /// what we learn and saving in \p LastTok the last token read.
1975  /// Return true if an error occurs parsing the arg list.
1976  bool ReadMacroParameterList(MacroInfo *MI, Token& LastTok);
1977 
1978  /// We just read a \#if or related directive and decided that the
1979  /// subsequent tokens are in the \#if'd out portion of the
1980  /// file. Lex the rest of the file, until we see an \#endif. If \p
1981  /// FoundNonSkipPortion is true, then we have already emitted code for part of
1982  /// this \#if directive, so \#else/\#elif blocks should never be entered. If
1983  /// \p FoundElse is false, then \#else directives are ok, if not, then we have
1984  /// already seen one so a \#else directive is a duplicate. When this returns,
1985  /// the caller can lex the first valid token.
1986  void SkipExcludedConditionalBlock(SourceLocation HashTokenLoc,
1987  SourceLocation IfTokenLoc,
1988  bool FoundNonSkipPortion, bool FoundElse,
1989  SourceLocation ElseLoc = SourceLocation());
1990 
1991  /// A fast PTH version of SkipExcludedConditionalBlock.
1992  void PTHSkipExcludedConditionalBlock();
1993 
1994  /// Information about the result for evaluating an expression for a
1995  /// preprocessor directive.
1996  struct DirectiveEvalResult {
1997  /// Whether the expression was evaluated as true or not.
1998  bool Conditional;
1999 
2000  /// True if the expression contained identifiers that were undefined.
2001  bool IncludedUndefinedIds;
2002  };
2003 
2004  /// Evaluate an integer constant expression that may occur after a
2005  /// \#if or \#elif directive and return a \p DirectiveEvalResult object.
2006  ///
2007  /// If the expression is equivalent to "!defined(X)" return X in IfNDefMacro.
2008  DirectiveEvalResult EvaluateDirectiveExpression(IdentifierInfo *&IfNDefMacro);
2009 
2010  /// Install the standard preprocessor pragmas:
2011  /// \#pragma GCC poison/system_header/dependency and \#pragma once.
2012  void RegisterBuiltinPragmas();
2013 
2014  /// Register builtin macros such as __LINE__ with the identifier table.
2015  void RegisterBuiltinMacros();
2016 
2017  /// If an identifier token is read that is to be expanded as a macro, handle
2018  /// it and return the next token as 'Tok'. If we lexed a token, return true;
2019  /// otherwise the caller should lex again.
2020  bool HandleMacroExpandedIdentifier(Token &Identifier, const MacroDefinition &MD);
2021 
2022  /// Cache macro expanded tokens for TokenLexers.
2023  //
2024  /// Works like a stack; a TokenLexer adds the macro expanded tokens that is
2025  /// going to lex in the cache and when it finishes the tokens are removed
2026  /// from the end of the cache.
2027  Token *cacheMacroExpandedTokens(TokenLexer *tokLexer,
2028  ArrayRef<Token> tokens);
2029 
2030  void removeCachedMacroExpandedTokensOfLastLexer();
2031 
2032  /// Determine whether the next preprocessor token to be
2033  /// lexed is a '('. If so, consume the token and return true, if not, this
2034  /// method should have no observable side-effect on the lexed tokens.
2035  bool isNextPPTokenLParen();
2036 
2037  /// After reading "MACRO(", this method is invoked to read all of the formal
2038  /// arguments specified for the macro invocation. Returns null on error.
2039  MacroArgs *ReadMacroCallArgumentList(Token &MacroName, MacroInfo *MI,
2040  SourceLocation &MacroEnd);
2041 
2042  /// If an identifier token is read that is to be expanded
2043  /// as a builtin macro, handle it and return the next token as 'Tok'.
2044  void ExpandBuiltinMacro(Token &Tok);
2045 
2046  /// Read a \c _Pragma directive, slice it up, process it, then
2047  /// return the first token after the directive.
2048  /// This assumes that the \c _Pragma token has just been read into \p Tok.
2049  void Handle_Pragma(Token &Tok);
2050 
2051  /// Like Handle_Pragma except the pragma text is not enclosed within
2052  /// a string literal.
2053  void HandleMicrosoft__pragma(Token &Tok);
2054 
2055  /// Add a lexer to the top of the include stack and
2056  /// start lexing tokens from it instead of the current buffer.
2057  void EnterSourceFileWithLexer(Lexer *TheLexer, const DirectoryLookup *Dir);
2058 
2059  /// Add a lexer to the top of the include stack and
2060  /// start getting tokens from it using the PTH cache.
2061  void EnterSourceFileWithPTH(PTHLexer *PL, const DirectoryLookup *Dir);
2062 
2063  /// Set the FileID for the preprocessor predefines.
2064  void setPredefinesFileID(FileID FID) {
2065  assert(PredefinesFileID.isInvalid() && "PredefinesFileID already set!");
2066  PredefinesFileID = FID;
2067  }
2068 
2069  /// Set the FileID for the PCH through header.
2070  void setPCHThroughHeaderFileID(FileID FID);
2071 
2072  /// Returns true if we are lexing from a file and not a
2073  /// pragma or a macro.
2074  static bool IsFileLexer(const Lexer* L, const PreprocessorLexer* P) {
2075  return L ? !L->isPragmaLexer() : P != nullptr;
2076  }
2077 
2078  static bool IsFileLexer(const IncludeStackInfo& I) {
2079  return IsFileLexer(I.TheLexer.get(), I.ThePPLexer);
2080  }
2081 
2082  bool IsFileLexer() const {
2083  return IsFileLexer(CurLexer.get(), CurPPLexer);
2084  }
2085 
2086  //===--------------------------------------------------------------------===//
2087  // Caching stuff.
2088  void CachingLex(Token &Result);
2089 
2090  bool InCachingLexMode() const {
2091  // If the Lexer pointers are 0 and IncludeMacroStack is empty, it means
2092  // that we are past EOF, not that we are in CachingLex mode.
2093  return !CurPPLexer && !CurTokenLexer && !CurPTHLexer &&
2094  !IncludeMacroStack.empty();
2095  }
2096 
2097  void EnterCachingLexMode();
2098 
2099  void ExitCachingLexMode() {
2100  if (InCachingLexMode())
2101  RemoveTopOfLexerStack();
2102  }
2103 
2104  const Token &PeekAhead(unsigned N);
2105  void AnnotatePreviousCachedTokens(const Token &Tok);
2106 
2107  //===--------------------------------------------------------------------===//
2108  /// Handle*Directive - implement the various preprocessor directives. These
2109  /// should side-effect the current preprocessor object so that the next call
2110  /// to Lex() will return the appropriate token next.
2111  void HandleLineDirective();
2112  void HandleDigitDirective(Token &Tok);
2113  void HandleUserDiagnosticDirective(Token &Tok, bool isWarning);
2114  void HandleIdentSCCSDirective(Token &Tok);
2115  void HandleMacroPublicDirective(Token &Tok);
2116  void HandleMacroPrivateDirective();
2117 
2118  // File inclusion.
2119  void HandleIncludeDirective(SourceLocation HashLoc,
2120  Token &Tok,
2121  const DirectoryLookup *LookupFrom = nullptr,
2122  const FileEntry *LookupFromFile = nullptr,
2123  bool isImport = false);
2124  void HandleIncludeNextDirective(SourceLocation HashLoc, Token &Tok);
2125  void HandleIncludeMacrosDirective(SourceLocation HashLoc, Token &Tok);
2126  void HandleImportDirective(SourceLocation HashLoc, Token &Tok);
2127  void HandleMicrosoftImportDirective(Token &Tok);
2128 
2129 public:
2130  /// Check that the given module is available, producing a diagnostic if not.
2131  /// \return \c true if the check failed (because the module is not available).
2132  /// \c false if the module appears to be usable.
2133  static bool checkModuleIsAvailable(const LangOptions &LangOpts,
2134  const TargetInfo &TargetInfo,
2135  DiagnosticsEngine &Diags, Module *M);
2136 
2137  // Module inclusion testing.
2138  /// Find the module that owns the source or header file that
2139  /// \p Loc points to. If the location is in a file that was included
2140  /// into a module, or is outside any module, returns nullptr.
2141  Module *getModuleForLocation(SourceLocation Loc);
2142 
2143  /// We want to produce a diagnostic at location IncLoc concerning a
2144  /// missing module import.
2145  ///
2146  /// \param IncLoc The location at which the missing import was detected.
2147  /// \param M The desired module.
2148  /// \param MLoc A location within the desired module at which some desired
2149  /// effect occurred (eg, where a desired entity was declared).
2150  ///
2151  /// \return A file that can be #included to import a module containing MLoc.
2152  /// Null if no such file could be determined or if a #include is not
2153  /// appropriate.
2154  const FileEntry *getModuleHeaderToIncludeForDiagnostics(SourceLocation IncLoc,
2155  Module *M,
2156  SourceLocation MLoc);
2157 
2158  bool isRecordingPreamble() const {
2159  return PreambleConditionalStack.isRecording();
2160  }
2161 
2162  bool hasRecordedPreamble() const {
2163  return PreambleConditionalStack.hasRecordedPreamble();
2164  }
2165 
2167  return PreambleConditionalStack.getStack();
2168  }
2169 
2171  PreambleConditionalStack.setStack(s);
2172  }
2173 
2176  PreambleConditionalStack.startReplaying();
2177  PreambleConditionalStack.setStack(s);
2178  PreambleConditionalStack.SkipInfo = SkipInfo;
2179  }
2180 
2182  return PreambleConditionalStack.SkipInfo;
2183  }
2184 
2185 private:
2186  /// After processing predefined file, initialize the conditional stack from
2187  /// the preamble.
2188  void replayPreambleConditionalStack();
2189 
2190  // Macro handling.
2191  void HandleDefineDirective(Token &Tok, bool ImmediatelyAfterHeaderGuard);
2192  void HandleUndefDirective();
2193 
2194  // Conditional Inclusion.
2195  void HandleIfdefDirective(Token &Result, const Token &HashToken,
2196  bool isIfndef, bool ReadAnyTokensBeforeDirective);
2197  void HandleIfDirective(Token &IfToken, const Token &HashToken,
2198  bool ReadAnyTokensBeforeDirective);
2199  void HandleEndifDirective(Token &EndifToken);
2200  void HandleElseDirective(Token &Result, const Token &HashToken);
2201  void HandleElifDirective(Token &ElifToken, const Token &HashToken);
2202 
2203  // Pragmas.
2204  void HandlePragmaDirective(SourceLocation IntroducerLoc,
2205  PragmaIntroducerKind Introducer);
2206 
2207 public:
2208  void HandlePragmaOnce(Token &OnceTok);
2209  void HandlePragmaMark();
2210  void HandlePragmaPoison();
2211  void HandlePragmaSystemHeader(Token &SysHeaderTok);
2212  void HandlePragmaDependency(Token &DependencyTok);
2213  void HandlePragmaPushMacro(Token &Tok);
2214  void HandlePragmaPopMacro(Token &Tok);
2215  void HandlePragmaIncludeAlias(Token &Tok);
2216  void HandlePragmaModuleBuild(Token &Tok);
2217  void HandlePragmaHdrstop(Token &Tok);
2218  IdentifierInfo *ParsePragmaPushOrPopMacro(Token &Tok);
2219 
2220  // Return true and store the first token only if any CommentHandler
2221  // has inserted some tokens and getCommentRetentionState() is false.
2222  bool HandleComment(Token &result, SourceRange Comment);
2223 
2224  /// A macro is used, update information about macros that need unused
2225  /// warnings.
2226  void markMacroAsUsed(MacroInfo *MI);
2227 };
2228 
2229 /// Abstract base class that describes a handler that will receive
2230 /// source ranges for each of the comments encountered in the source file.
2232 public:
2233  virtual ~CommentHandler();
2234 
2235  // The handler shall return true if it has pushed any tokens
2236  // to be read using e.g. EnterToken or EnterTokenStream.
2237  virtual bool HandleComment(Preprocessor &PP, SourceRange Comment) = 0;
2238 };
2239 
2240 /// Registry of pragma handlers added by plugins
2241 using PragmaHandlerRegistry = llvm::Registry<PragmaHandler>;
2242 
2243 } // namespace clang
2244 
2245 #endif // LLVM_CLANG_LEX_PREPROCESSOR_H
IdentifierInfo * get(StringRef Name) override
get - Return the identifier token info for the specified named identifier.
Definition: PTHLexer.cpp:599
PreambleSkipInfo(SourceLocation HashTokenLoc, SourceLocation IfTokenLoc, bool FoundNonSkipPortion, bool FoundElse, SourceLocation ElseLoc)
Definition: Preprocessor.h:336
A set of visible modules.
Definition: Module.h:589
llvm::BumpPtrAllocator & getPreprocessorAllocator()
Definition: Preprocessor.h:839
void setCodeCompletionTokenRange(const SourceLocation Start, const SourceLocation End)
Set the code completion token range for detecting replacement range later on.
Lexer - This provides a simple interface that turns a text buffer into a stream of tokens...
Definition: Lexer.h:77
SelectorTable & getSelectorTable()
Definition: Preprocessor.h:837
Holds information about both target-independent and target-specific builtins, allowing easy queries b...
Definition: Builtins.h:68
Implements support for file system lookup, file system caching, and directory search management...
Definition: FileManager.h:116
IdentifierInfo * getIdentifierInfo(StringRef Name) const
Return information about the specified preprocessor identifier token.
std::string getSpelling(const Token &Tok, bool *Invalid=nullptr) const
Return the &#39;spelling&#39; of the Tok token.
MemoryBufferCache & getPCMCache() const
Definition: Preprocessor.h:832
DominatorTree GraphTraits specialization so the DominatorTree can be iterable by generic graph iterat...
Definition: Dominators.h:30
const Token & LookAhead(unsigned N)
Peeks ahead N tokens and returns that token without consuming any tokens.
void MaybeHandlePoisonedIdentifier(Token &Identifier)
bool is(tok::TokenKind K) const
is/isNot - Predicates to check if this token is a specific kind, as in "if (Tok.is(tok::l_brace)) {...
Definition: Token.h:95
Defines the SourceManager interface.
static const Builtin::Info BuiltinInfo[]
Definition: Builtins.cpp:21
bool LexStringLiteral(Token &Result, std::string &String, const char *DiagnosticTag, bool AllowMacroExpansion)
Lex a string literal, which may be the concatenation of multiple string literals and may even come fr...
FileManager & getFileManager() const
Definition: Preprocessor.h:830
Defines the clang::Module class, which describes a module in the source code.
bool isCodeCompletionReached() const
Returns true if code-completion is enabled and we have hit the code-completion point.
SourceLocation getPragmaARCCFCodeAuditedLoc() const
The location of the currently-active #pragma clang arc_cf_code_audited begin.
StringRef P
const char * getCharacterData(SourceLocation SL, bool *Invalid=nullptr) const
Return a pointer to the start of the specified location in the appropriate spelling MemoryBuffer...
Defines the clang::MacroInfo and clang::MacroDirective classes.
A description of the current definition of a macro.
Definition: MacroInfo.h:564
bool isOutOfDate() const
Determine whether the information for this identifier is out of date with respect to the external sou...
DiagnosticBuilder Report(SourceLocation Loc, unsigned DiagID)
Issue the message to the client.
Definition: Diagnostic.h:1294
A directive for an undefined macro.
Definition: MacroInfo.h:429
PreprocessorOptions - This class is used for passing the various options used in preprocessor initial...
void setCodeCompletionIdentifierInfo(IdentifierInfo *Filter)
Set the code completion token for filtering purposes.
void setCodeCompletionReached()
Note that we hit the code-completion point.
bool hadModuleLoaderFatalFailure() const
Definition: Preprocessor.h:856
const DefInfo findDirectiveAtLoc(SourceLocation L, SourceManager &SM) const
Find macro definition active in the specified source location.
Definition: MacroInfo.cpp:203
void EnterToken(const Token &Tok)
Enters a token in the token stream to be lexed next.
Manage memory buffers across multiple users.
bool getRawToken(SourceLocation Loc, Token &Result, bool IgnoreWhiteSpace=false)
Relex the token at the specified location.
bool operator==(const Token &Tok) const
Definition: Preprocessor.h:103
Builtin::Context & getBuiltinInfo()
Definition: Preprocessor.h:838
void setPredefines(const char *P)
Set the predefines for this Preprocessor.
SourceLocation getCodeCompletionFileLoc() const
Returns the start location of the file of code-completion point.
char getSpellingOfSingleCharacterNumericConstant(const Token &Tok, bool *Invalid=nullptr) const
Given a Token Tok that is a numeric constant with length 1, return the character. ...
This interface provides a way to observe the actions of the preprocessor as it does its thing...
Definition: PPCallbacks.h:36
bool isAnnotation() const
Return true if this is any of tok::annot_* kind tokens.
Definition: Token.h:118
const MacroDirective * getPrevious() const
Get previous definition of the macro with the same name.
Definition: MacroInfo.h:329
tok::TokenKind getKind() const
Definition: Token.h:90
TokenValue(tok::TokenKind Kind)
Definition: Preprocessor.h:93
SourceLocation getLocForEndOfToken(SourceLocation Loc, unsigned Offset=0)
Computes the source location just past the end of the token at this source location.
DefMacroDirective * appendDefMacroDirective(IdentifierInfo *II, MacroInfo *MI, SourceLocation Loc)
One of these records is kept for each identifier that is lexed.
ArrayRef< PPConditionalInfo > getPreambleConditionalStack() const
Represents a macro directive exported by a module.
Definition: MacroInfo.h:488
A directive for a defined macro or a macro imported from a module.
Definition: MacroInfo.h:406
This table allows us to fully hide how we implement multi-keyword caching.
LineState State
Definition: Format.h:2031
const TargetInfo & getTargetInfo() const
Definition: Preprocessor.h:828
Token - This structure provides full information about a lexed token.
Definition: Token.h:35
void SetCommentRetentionState(bool KeepComments, bool KeepMacroComments)
Control whether the preprocessor retains comments in output.
Definition: Preprocessor.h:866
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
Definition: LangOptions.h:50
const LangOptions & getLangOpts() const
Definition: Preprocessor.h:827
Describes a module or submodule.
Definition: Module.h:65
bool isPragmaLexer() const
isPragmaLexer - Returns true if this Lexer is being used to lex a pragma.
Definition: Lexer.h:184
A directive for setting the module visibility of a macro.
Definition: MacroInfo.h:444
bool isInvalid() const
void SetSuppressIncludeNotFoundError(bool Suppress)
Definition: Preprocessor.h:876
SourceLocation AdvanceToTokenCharacter(SourceLocation TokStart, unsigned Char) const
Given a location that specifies the start of a token, return a new location that specifies a characte...
MacroUse
Context in which macro name is used.
Definition: Preprocessor.h:110
llvm::Registry< PragmaHandler > PragmaHandlerRegistry
Registry of pragma handlers added by plugins.
Module * getCurrentLexerSubmodule() const
Return the submodule owning the file being lexed.
Definition: Preprocessor.h:913
StringRef getSpelling(SourceLocation loc, SmallVectorImpl< char > &buffer, bool *invalid=nullptr) const
Return the &#39;spelling&#39; of the token at the given location; does not go up to the spelling location or ...
A record of the steps taken while preprocessing a source file, including the various preprocessing di...
HeaderSearch & getHeaderSearchInfo() const
Definition: Preprocessor.h:833
uint32_t Offset
Definition: CacheTokens.cpp:43
const FormatToken & Tok
Forward-declares and imports various common LLVM datatypes that clang wants to use unqualified...
void LexNonComment(Token &Result)
Lex a token.
Concrete class used by the front-end to report problems and issues.
Definition: Diagnostic.h:149
bool isMacroDefined(const IdentifierInfo *II)
Definition: Preprocessor.h:935
bool isMacroDefinedInLocalModule(const IdentifierInfo *II, Module *M)
Determine whether II is defined as a macro within the module M, if that is a module that we&#39;ve alread...
Definition: Preprocessor.h:943
Defines the Diagnostic-related interfaces.
const TargetInfo * getAuxTargetInfo() const
Definition: Preprocessor.h:829
TokenLexer - This implements a lexer that returns tokens from a macro body or token stream instead of...
Definition: TokenLexer.h:31
void setCodeCompletionHandler(CodeCompletionHandler &Handler)
Set the code completion handler to the given object.
void setPreprocessedOutput(bool IsPreprocessedOutput)
Sets whether the preprocessor is responsible for producing output or if it is producing tokens to be ...
Definition: Preprocessor.h:886
PragmaIntroducerKind
Describes how the pragma was introduced, e.g., with #pragma, _Pragma, or __pragma.
Definition: Pragma.h:32
void LexUnexpandedToken(Token &Result)
Just like Lex, but disables macro expansion of identifier tokens.
Encapsulates the information needed to find the file referenced by a #include or #include_next, (sub-)framework lookup, etc.
Definition: HeaderSearch.h:148
A little helper class used to produce diagnostics.
Definition: Diagnostic.h:1042
void clearCodeCompletionHandler()
Clear out the code completion handler.
StringRef Filename
Definition: Format.cpp:1602
Provides lookups to, and iteration over, IdentiferInfo objects.
Exposes information about the current target.
Definition: TargetInfo.h:54
const IdentifierTable & getIdentifierTable() const
Definition: Preprocessor.h:836
bool isCodeCompletionEnabled() const
Determine if we are performing code completion.
Abstract interface for external sources of preprocessor information.
Defines the clang::LangOptions interface.
unsigned getCounterValue() const
SourceLocation End
const DefMacroDirective * getDirective() const
Definition: MacroInfo.h:350
int Id
Definition: ASTDiff.cpp:191
void AnnotateCachedTokens(const Token &Tok)
We notify the Preprocessor that if it is caching tokens (because backtrack is enabled) it should repl...
const AnnotatedLine * Line
bool isDefined() const
Definition: MacroInfo.h:385
void SetMacroExpansionOnlyInDirectives()
Disables macro expansion everywhere except for preprocessor directives.
bool isCurrentLexer(const PreprocessorLexer *L) const
Return true if we are lexing directly from the specified lexer.
Definition: Preprocessor.h:895
Implements an efficient mapping from strings to IdentifierInfo nodes.
MacroArgs - An instance of this class captures information about the formal arguments specified to a ...
Definition: MacroArgs.h:30
void RevertCachedTokens(unsigned N)
When backtracking is enabled and tokens are cached, this allows to revert a specific number of tokens...
A class for tracking whether we&#39;re inside a VA_OPT during a traversal of the tokens of a variadic mac...
SourceLocation getLocation() const
Return a source location identifier for the specified offset in the current file. ...
Definition: Token.h:124
#define bool
Definition: stdbool.h:31
DefInfo getDefinition()
Traverses the macro directives history and returns the next macro definition directive along with inf...
Definition: MacroInfo.cpp:179
SourceLocation Begin
void IncrementPasteCounter(bool isFast)
Increment the counters for the number of token paste operations performed.
Stores token information for comparing actual tokens with predefined values.
Definition: Preprocessor.h:88
llvm::Optional< PreambleSkipInfo > getPreambleSkipInfo() const
DiagnosticBuilder Diag(const Token &Tok, unsigned DiagID) const
void setPragmaAssumeNonNullLoc(SourceLocation Loc)
Set the location of the currently-active #pragma clang assume_nonnull begin.
const MacroInfo * getMacroInfo(const IdentifierInfo *II) const
Definition: Preprocessor.h:997
bool getCommentRetentionState() const
Definition: Preprocessor.h:871
Defines the clang::IdentifierInfo, clang::IdentifierTable, and clang::Selector interfaces.
TokenValue(IdentifierInfo *II)
Definition: Preprocessor.h:101
PPCallbacks * getPPCallbacks() const
Definition: Preprocessor.h:923
const SourceManager & SM
Definition: Format.cpp:1472
DirectoryLookup - This class represents one entry in the search list that specifies the search order ...
bool isRecordingPreamble() const
const DirectoryLookup * GetCurDirLookup()
Get the DirectoryLookup structure used to find the current FileEntry, if CurLexer is non-null and if ...
SourceManager & getSourceManager() const
Definition: Preprocessor.h:831
MacroDirective * getLocalMacroDirective(const IdentifierInfo *II) const
Given an identifier, return its latest non-imported MacroDirective if it is #define&#39;d and not #undef&#39;...
Definition: Preprocessor.h:986
ExternalPreprocessorSource * getExternalSource() const
Definition: Preprocessor.h:849
Encapsulates changes to the "macros namespace" (the location where the macro name became active...
Definition: MacroInfo.h:291
Kind
void TypoCorrectToken(const Token &Tok)
Update the current token to represent the provided identifier, in order to cache an action performed ...
void setExternalSource(ExternalPreprocessorSource *Source)
Definition: Preprocessor.h:845
Encodes a location in the source.
IdentifierInfo & get(StringRef Name)
Return the identifier token info for the specified named identifier.
bool isAnnotation(TokenKind K)
Return true if this is any of tok::annot_* kinds.
Definition: TokenKinds.h:95
void setPragmaARCCFCodeAuditedLoc(SourceLocation Loc)
Set the location of the currently-active #pragma clang arc_cf_code_audited begin. ...
MacroDefinition getMacroDefinition(const IdentifierInfo *II)
Definition: Preprocessor.h:956
IdentifierInfo * getIdentifierInfo() const
Definition: Token.h:177
IdentifierTable & getIdentifierTable()
Definition: Preprocessor.h:835
void setPragmasEnabled(bool Enabled)
Definition: Preprocessor.h:873
Cached information about one file (either on disk or in the virtual file system). ...
Definition: FileManager.h:59
CodeCompletionHandler * getCodeCompletionHandler() const
Retrieve the current code-completion handler.
bool isAtStartOfMacroExpansion(SourceLocation loc, SourceLocation *MacroBegin=nullptr) const
Returns true if the given MacroID location points at the first token of the macro expansion...
bool isLiteral(TokenKind K)
Return true if this is a "literal" kind, like a numeric constant, string, etc.
Definition: TokenKinds.h:87
bool isPoisoned() const
Return true if this token has been poisoned.
bool SawDateOrTime() const
Returns true if the preprocessor has seen a use of DATE or TIME in the file so far.
TokenKind
Provides a simple uniform namespace for tokens from all C languages.
Definition: TokenKinds.h:25
void enableIncrementalProcessing(bool value=true)
Enables the incremental processing.
MacroDefinition getMacroDefinitionAtLoc(const IdentifierInfo *II, SourceLocation Loc)
Definition: Preprocessor.h:969
PreprocessorLexer * getCurrentLexer() const
Return the current lexer being lexed from.
Definition: Preprocessor.h:903
bool isAtEndOfMacroExpansion(SourceLocation loc, SourceLocation *MacroEnd=nullptr) const
Returns true if the given MacroID location points at the last token of the macro expansion.
void ReplaceLastTokenWithAnnotation(const Token &Tok)
Replace the last token with an annotation token.
SourceLocation getPragmaAssumeNonNullLoc() const
The location of the currently-active #pragma clang assume_nonnull begin.
SourceLocation getCodeCompletionLoc() const
Returns the location of the code-completion point.
const MacroInfo * getMacroInfo() const
Definition: MacroInfo.h:391
StringRef getName() const
Return the actual identifier string.
bool isMacroDefined(StringRef Id)
Definition: Preprocessor.h:932
An opaque identifier used by SourceManager which refers to a source file (MemoryBuffer) along with it...
bool isBacktrackEnabled() const
True if EnableBacktrackAtThisPos() was called and caching of tokens is on.
bool hadMacroDefinition() const
Returns true if this identifier was #defined to some value at any moment.
Dataflow Directional Tag Classes.
void EnterTokenStream(ArrayRef< Token > Toks, bool DisableMacroExpansion)
SmallVector< Token, 4 > CachedTokens
A set of tokens that has been cached for later parsing.
Definition: DeclSpec.h:1128
void EnterTokenStream(std::unique_ptr< Token[]> Toks, unsigned NumToks, bool DisableMacroExpansion)
SourceRange getCodeCompletionTokenRange() const
PreprocessingRecord * getPreprocessingRecord() const
Retrieve the preprocessing record, or NULL if there is no preprocessing record.
Reads an AST files chain containing the contents of a translation unit.
Definition: ASTReader.h:355
PragmaHandler - Instances of this interface defined to handle the various pragmas that the language f...
Definition: Pragma.h:59
llvm::iterator_range< macro_iterator > macros(bool IncludeExternalMacros=true) const
SourceLocation getLastCachedTokenLocation() const
Get the location of the last cached token, suitable for setting the end location of an annotation tok...
StringRef getCodeCompletionFilter()
Get the code completion token for filtering purposes.
Abstract interface for a module loader.
Definition: ModuleLoader.h:74
unsigned getLength() const
Definition: Token.h:127
Encapsulates the data about a macro definition (e.g.
Definition: MacroInfo.h:40
OnOffSwitch
Defines the possible values of an on-off-switch (C99 6.10.6p2).
Definition: TokenKinds.h:49
const char * getLiteralData() const
getLiteralData - For a literal token (numeric constant, string, etc), this returns a pointer to the s...
Definition: Token.h:215
bool getPragmasEnabled() const
Definition: Preprocessor.h:874
unsigned getSpelling(const Token &Tok, const char *&Buffer, bool *Invalid=nullptr) const
Get the spelling of a token into a preallocated buffer, instead of as an std::string.
SourceLocation getDefinitionLoc() const
Return the location that the macro was defined at.
Definition: MacroInfo.h:124
ModuleLoader & getModuleLoader() const
Retrieve the module loader associated with this preprocessor.
Definition: Preprocessor.h:854
void LexUnexpandedNonComment(Token &Result)
Like LexNonComment, but this disables macro expansion of identifier tokens.
PreprocessorOptions & getPreprocessorOpts() const
Retrieve the preprocessor options used to initialize this preprocessor.
Definition: Preprocessor.h:822
Cached information about one directory (either on disk or in the virtual file system).
Definition: FileManager.h:45
Defines the PPCallbacks interface.
Defines the clang::TokenKind enum and support functions.
DefMacroDirective * appendDefMacroDirective(IdentifierInfo *II, MacroInfo *MI)
SourceLocation getModuleImportLoc(Module *M) const
Defines the clang::SourceLocation class and associated facilities.
void RemovePragmaHandler(PragmaHandler *Handler)
FileID getPredefinesFileID() const
Returns the FileID for the preprocessor predefines.
Definition: Preprocessor.h:916
DiagnosticsEngine & getDiagnostics() const
Definition: Preprocessor.h:824
void setMainFileDir(const DirectoryEntry *Dir)
Set the directory in which the main file should be considered to have been found, if it is not a real...
static bool isMacroDefined(const Sema &S, SourceLocation Loc, StringRef Name)
TranslationUnitKind
Describes the kind of translation unit being processed.
Definition: LangOptions.h:329
bool hasRecordedPreamble() const
const std::string & getPredefines() const
bool needsCleaning() const
Return true if this token has trigraphs or escaped newlines in it.
Definition: Token.h:283
void setPredefines(StringRef P)
ArrayRef< ModuleMacro * > getLeafModuleMacros(const IdentifierInfo *II) const
Get the list of leaf (non-overridden) module macros for a name.
bool isIncrementalProcessingEnabled() const
Returns true if incremental processing is enabled.
The translation unit is a complete translation unit.
Definition: LangOptions.h:331
StringRef getImmediateMacroName(SourceLocation Loc)
Retrieve the name of the immediate macro expansion.
MacroMap::const_iterator macro_iterator
Abstract base class that describes a handler that will receive source ranges for each of the comments...
void setCounterValue(unsigned V)
bool isParsingIfOrElifDirective() const
True if we are currently preprocessing a if or #elif directive.
Definition: Preprocessor.h:861
void setSkipMainFilePreamble(unsigned Bytes, bool StartOfLine)
Instruct the preprocessor to skip part of the main source file.
A trivial tuple used to represent a source range.
bool GetSuppressIncludeNotFoundError()
Definition: Preprocessor.h:880
void setReplayablePreambleConditionalStack(ArrayRef< PPConditionalInfo > s, llvm::Optional< PreambleSkipInfo > SkipInfo)
MacroInfo * getMacroInfo(const IdentifierInfo *II)
Callback handler that receives notifications when performing code completion within the preprocessor...
A header that is known to reside within a given module, whether it was included or excluded...
Definition: ModuleMap.h:149
bool isPreprocessedOutput() const
Returns true if the preprocessor is responsible for generating output, false if it is producing token...
Definition: Preprocessor.h:892
PTHManager * getPTHManager()
Definition: Preprocessor.h:843
bool hasMacroDefinition() const
Return true if this identifier is #defined to some other value.
DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID) const
Forwarding function for diagnostics.
void addPPCallbacks(std::unique_ptr< PPCallbacks > C)
Definition: Preprocessor.h:924
void setRecordedPreambleConditionalStack(ArrayRef< PPConditionalInfo > s)
This class handles loading and caching of source files into memory.
Defines enum values for all the target-independent builtin functions.
An RAII class that tracks when the Preprocessor starts and stops lexing the definition of a (ISO C/C+...
void AddPragmaHandler(PragmaHandler *Handler)
Engages in a tight little dance with the lexer to efficiently preprocess tokens.
Definition: Preprocessor.h:127
void setDiagnostics(DiagnosticsEngine &D)
Definition: Preprocessor.h:825