clang  9.0.0svn
PPCallbacks.h
Go to the documentation of this file.
1 //===--- PPCallbacks.h - Callbacks for Preprocessor actions -----*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 ///
9 /// \file
10 /// Defines the PPCallbacks interface.
11 ///
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_CLANG_LEX_PPCALLBACKS_H
15 #define LLVM_CLANG_LEX_PPCALLBACKS_H
16 
20 #include "clang/Lex/ModuleLoader.h"
21 #include "clang/Lex/Pragma.h"
22 #include "llvm/ADT/StringRef.h"
23 
24 namespace clang {
25  class Token;
26  class IdentifierInfo;
27  class MacroDefinition;
28  class MacroDirective;
29  class MacroArgs;
30 
31 /// This interface provides a way to observe the actions of the
32 /// preprocessor as it does its thing.
33 ///
34 /// Clients can define their hooks here to implement preprocessor level tools.
35 class PPCallbacks {
36 public:
37  virtual ~PPCallbacks();
38 
41  };
42 
43  /// Callback invoked whenever a source file is entered or exited.
44  ///
45  /// \param Loc Indicates the new location.
46  /// \param PrevFID the file that was exited if \p Reason is ExitFile.
47  virtual void FileChanged(SourceLocation Loc, FileChangeReason Reason,
49  FileID PrevFID = FileID()) {
50  }
51 
52  /// Callback invoked whenever a source file is skipped as the result
53  /// of header guard optimization.
54  ///
55  /// \param SkippedFile The file that is skipped instead of entering \#include
56  ///
57  /// \param FilenameTok The file name token in \#include "FileName" directive
58  /// or macro expanded file name token from \#include MACRO(PARAMS) directive.
59  /// Note that FilenameTok contains corresponding quotes/angles symbols.
60  virtual void FileSkipped(const FileEntry &SkippedFile,
61  const Token &FilenameTok,
62  SrcMgr::CharacteristicKind FileType) {
63  }
64 
65  /// Callback invoked whenever an inclusion directive results in a
66  /// file-not-found error.
67  ///
68  /// \param FileName The name of the file being included, as written in the
69  /// source code.
70  ///
71  /// \param RecoveryPath If this client indicates that it can recover from
72  /// this missing file, the client should set this as an additional header
73  /// search patch.
74  ///
75  /// \returns true to indicate that the preprocessor should attempt to recover
76  /// by adding \p RecoveryPath as a header search path.
77  virtual bool FileNotFound(StringRef FileName,
78  SmallVectorImpl<char> &RecoveryPath) {
79  return false;
80  }
81 
82  /// Callback invoked whenever an inclusion directive of
83  /// any kind (\c \#include, \c \#import, etc.) has been processed, regardless
84  /// of whether the inclusion will actually result in an inclusion.
85  ///
86  /// \param HashLoc The location of the '#' that starts the inclusion
87  /// directive.
88  ///
89  /// \param IncludeTok The token that indicates the kind of inclusion
90  /// directive, e.g., 'include' or 'import'.
91  ///
92  /// \param FileName The name of the file being included, as written in the
93  /// source code.
94  ///
95  /// \param IsAngled Whether the file name was enclosed in angle brackets;
96  /// otherwise, it was enclosed in quotes.
97  ///
98  /// \param FilenameRange The character range of the quotes or angle brackets
99  /// for the written file name.
100  ///
101  /// \param File The actual file that may be included by this inclusion
102  /// directive.
103  ///
104  /// \param SearchPath Contains the search path which was used to find the file
105  /// in the file system. If the file was found via an absolute include path,
106  /// SearchPath will be empty. For framework includes, the SearchPath and
107  /// RelativePath will be split up. For example, if an include of "Some/Some.h"
108  /// is found via the framework path
109  /// "path/to/Frameworks/Some.framework/Headers/Some.h", SearchPath will be
110  /// "path/to/Frameworks/Some.framework/Headers" and RelativePath will be
111  /// "Some.h".
112  ///
113  /// \param RelativePath The path relative to SearchPath, at which the include
114  /// file was found. This is equal to FileName except for framework includes.
115  ///
116  /// \param Imported The module, whenever an inclusion directive was
117  /// automatically turned into a module import or null otherwise.
118  ///
119  /// \param FileType The characteristic kind, indicates whether a file or
120  /// directory holds normal user code, system code, or system code which is
121  /// implicitly 'extern "C"' in C++ mode.
122  ///
123  virtual void InclusionDirective(SourceLocation HashLoc,
124  const Token &IncludeTok,
125  StringRef FileName,
126  bool IsAngled,
127  CharSourceRange FilenameRange,
128  const FileEntry *File,
129  StringRef SearchPath,
130  StringRef RelativePath,
131  const Module *Imported,
132  SrcMgr::CharacteristicKind FileType) {
133  }
134 
135  /// Callback invoked whenever there was an explicit module-import
136  /// syntax.
137  ///
138  /// \param ImportLoc The location of import directive token.
139  ///
140  /// \param Path The identifiers (and their locations) of the module
141  /// "path", e.g., "std.vector" would be split into "std" and "vector".
142  ///
143  /// \param Imported The imported module; can be null if importing failed.
144  ///
145  virtual void moduleImport(SourceLocation ImportLoc,
146  ModuleIdPath Path,
147  const Module *Imported) {
148  }
149 
150  /// Callback invoked when the end of the main file is reached.
151  ///
152  /// No subsequent callbacks will be made.
153  virtual void EndOfMainFile() {
154  }
155 
156  /// Callback invoked when a \#ident or \#sccs directive is read.
157  /// \param Loc The location of the directive.
158  /// \param str The text of the directive.
159  ///
160  virtual void Ident(SourceLocation Loc, StringRef str) {
161  }
162 
163  /// Callback invoked when start reading any pragma directive.
164  virtual void PragmaDirective(SourceLocation Loc,
165  PragmaIntroducerKind Introducer) {
166  }
167 
168  /// Callback invoked when a \#pragma comment directive is read.
170  StringRef Str) {
171  }
172 
173  /// Callback invoked when a \#pragma detect_mismatch directive is
174  /// read.
175  virtual void PragmaDetectMismatch(SourceLocation Loc, StringRef Name,
176  StringRef Value) {
177  }
178 
179  /// Callback invoked when a \#pragma clang __debug directive is read.
180  /// \param Loc The location of the debug directive.
181  /// \param DebugType The identifier following __debug.
182  virtual void PragmaDebug(SourceLocation Loc, StringRef DebugType) {
183  }
184 
185  /// Determines the kind of \#pragma invoking a call to PragmaMessage.
187  /// \#pragma message has been invoked.
189 
190  /// \#pragma GCC warning has been invoked.
192 
193  /// \#pragma GCC error has been invoked.
195  };
196 
197  /// Callback invoked when a \#pragma message directive is read.
198  /// \param Loc The location of the message directive.
199  /// \param Namespace The namespace of the message directive.
200  /// \param Kind The type of the message directive.
201  /// \param Str The text of the message directive.
202  virtual void PragmaMessage(SourceLocation Loc, StringRef Namespace,
203  PragmaMessageKind Kind, StringRef Str) {
204  }
205 
206  /// Callback invoked when a \#pragma gcc diagnostic push directive
207  /// is read.
209  StringRef Namespace) {
210  }
211 
212  /// Callback invoked when a \#pragma gcc diagnostic pop directive
213  /// is read.
215  StringRef Namespace) {
216  }
217 
218  /// Callback invoked when a \#pragma gcc diagnostic directive is read.
219  virtual void PragmaDiagnostic(SourceLocation Loc, StringRef Namespace,
220  diag::Severity mapping, StringRef Str) {}
221 
222  /// Called when an OpenCL extension is either disabled or
223  /// enabled with a pragma.
224  virtual void PragmaOpenCLExtension(SourceLocation NameLoc,
225  const IdentifierInfo *Name,
226  SourceLocation StateLoc, unsigned State) {
227  }
228 
229  /// Callback invoked when a \#pragma warning directive is read.
230  virtual void PragmaWarning(SourceLocation Loc, StringRef WarningSpec,
231  ArrayRef<int> Ids) {
232  }
233 
234  /// Callback invoked when a \#pragma warning(push) directive is read.
235  virtual void PragmaWarningPush(SourceLocation Loc, int Level) {
236  }
237 
238  /// Callback invoked when a \#pragma warning(pop) directive is read.
239  virtual void PragmaWarningPop(SourceLocation Loc) {
240  }
241 
242  /// Callback invoked when a \#pragma clang assume_nonnull begin directive
243  /// is read.
245 
246  /// Callback invoked when a \#pragma clang assume_nonnull end directive
247  /// is read.
249 
250  /// Called by Preprocessor::HandleMacroExpandedIdentifier when a
251  /// macro invocation is found.
252  virtual void MacroExpands(const Token &MacroNameTok,
253  const MacroDefinition &MD, SourceRange Range,
254  const MacroArgs *Args) {}
255 
256  /// Hook called whenever a macro definition is seen.
257  virtual void MacroDefined(const Token &MacroNameTok,
258  const MacroDirective *MD) {
259  }
260 
261  /// Hook called whenever a macro \#undef is seen.
262  /// \param MacroNameTok The active Token
263  /// \param MD A MacroDefinition for the named macro.
264  /// \param Undef New MacroDirective if the macro was defined, null otherwise.
265  ///
266  /// MD is released immediately following this callback.
267  virtual void MacroUndefined(const Token &MacroNameTok,
268  const MacroDefinition &MD,
269  const MacroDirective *Undef) {
270  }
271 
272  /// Hook called whenever the 'defined' operator is seen.
273  /// \param MD The MacroDirective if the name was a macro, null otherwise.
274  virtual void Defined(const Token &MacroNameTok, const MacroDefinition &MD,
275  SourceRange Range) {
276  }
277 
278  /// Hook called when a '__has_include' or '__has_include_next' directive is
279  /// read.
280  virtual void HasInclude(SourceLocation Loc, StringRef FileName, bool IsAngled,
281  const FileEntry *File,
282  SrcMgr::CharacteristicKind FileType) {}
283 
284  /// Hook called when a source range is skipped.
285  /// \param Range The SourceRange that was skipped. The range begins at the
286  /// \#if/\#else directive and ends after the \#endif/\#else directive.
287  /// \param EndifLoc The end location of the 'endif' token, which may precede
288  /// the range skipped by the directive (e.g excluding comments after an
289  /// 'endif').
290  virtual void SourceRangeSkipped(SourceRange Range, SourceLocation EndifLoc) {
291  }
292 
295  };
296 
297  /// Hook called whenever an \#if is seen.
298  /// \param Loc the source location of the directive.
299  /// \param ConditionRange The SourceRange of the expression being tested.
300  /// \param ConditionValue The evaluated value of the condition.
301  ///
302  // FIXME: better to pass in a list (or tree!) of Tokens.
303  virtual void If(SourceLocation Loc, SourceRange ConditionRange,
304  ConditionValueKind ConditionValue) {
305  }
306 
307  /// Hook called whenever an \#elif is seen.
308  /// \param Loc the source location of the directive.
309  /// \param ConditionRange The SourceRange of the expression being tested.
310  /// \param ConditionValue The evaluated value of the condition.
311  /// \param IfLoc the source location of the \#if/\#ifdef/\#ifndef directive.
312  // FIXME: better to pass in a list (or tree!) of Tokens.
313  virtual void Elif(SourceLocation Loc, SourceRange ConditionRange,
314  ConditionValueKind ConditionValue, SourceLocation IfLoc) {
315  }
316 
317  /// Hook called whenever an \#ifdef is seen.
318  /// \param Loc the source location of the directive.
319  /// \param MacroNameTok Information on the token being tested.
320  /// \param MD The MacroDefinition if the name was a macro, null otherwise.
321  virtual void Ifdef(SourceLocation Loc, const Token &MacroNameTok,
322  const MacroDefinition &MD) {
323  }
324 
325  /// Hook called whenever an \#ifndef is seen.
326  /// \param Loc the source location of the directive.
327  /// \param MacroNameTok Information on the token being tested.
328  /// \param MD The MacroDefiniton if the name was a macro, null otherwise.
329  virtual void Ifndef(SourceLocation Loc, const Token &MacroNameTok,
330  const MacroDefinition &MD) {
331  }
332 
333  /// Hook called whenever an \#else is seen.
334  /// \param Loc the source location of the directive.
335  /// \param IfLoc the source location of the \#if/\#ifdef/\#ifndef directive.
336  virtual void Else(SourceLocation Loc, SourceLocation IfLoc) {
337  }
338 
339  /// Hook called whenever an \#endif is seen.
340  /// \param Loc the source location of the directive.
341  /// \param IfLoc the source location of the \#if/\#ifdef/\#ifndef directive.
342  virtual void Endif(SourceLocation Loc, SourceLocation IfLoc) {
343  }
344 };
345 
346 /// Simple wrapper class for chaining callbacks.
348  virtual void anchor();
349  std::unique_ptr<PPCallbacks> First, Second;
350 
351 public:
352  PPChainedCallbacks(std::unique_ptr<PPCallbacks> _First,
353  std::unique_ptr<PPCallbacks> _Second)
354  : First(std::move(_First)), Second(std::move(_Second)) {}
355 
358  FileID PrevFID) override {
359  First->FileChanged(Loc, Reason, FileType, PrevFID);
360  Second->FileChanged(Loc, Reason, FileType, PrevFID);
361  }
362 
363  void FileSkipped(const FileEntry &SkippedFile,
364  const Token &FilenameTok,
365  SrcMgr::CharacteristicKind FileType) override {
366  First->FileSkipped(SkippedFile, FilenameTok, FileType);
367  Second->FileSkipped(SkippedFile, FilenameTok, FileType);
368  }
369 
370  bool FileNotFound(StringRef FileName,
371  SmallVectorImpl<char> &RecoveryPath) override {
372  return First->FileNotFound(FileName, RecoveryPath) ||
373  Second->FileNotFound(FileName, RecoveryPath);
374  }
375 
376  void InclusionDirective(SourceLocation HashLoc, const Token &IncludeTok,
377  StringRef FileName, bool IsAngled,
378  CharSourceRange FilenameRange, const FileEntry *File,
379  StringRef SearchPath, StringRef RelativePath,
380  const Module *Imported,
381  SrcMgr::CharacteristicKind FileType) override {
382  First->InclusionDirective(HashLoc, IncludeTok, FileName, IsAngled,
383  FilenameRange, File, SearchPath, RelativePath,
384  Imported, FileType);
385  Second->InclusionDirective(HashLoc, IncludeTok, FileName, IsAngled,
386  FilenameRange, File, SearchPath, RelativePath,
387  Imported, FileType);
388  }
389 
391  const Module *Imported) override {
392  First->moduleImport(ImportLoc, Path, Imported);
393  Second->moduleImport(ImportLoc, Path, Imported);
394  }
395 
396  void EndOfMainFile() override {
397  First->EndOfMainFile();
398  Second->EndOfMainFile();
399  }
400 
401  void Ident(SourceLocation Loc, StringRef str) override {
402  First->Ident(Loc, str);
403  Second->Ident(Loc, str);
404  }
405 
407  PragmaIntroducerKind Introducer) override {
408  First->PragmaDirective(Loc, Introducer);
409  Second->PragmaDirective(Loc, Introducer);
410  }
411 
413  StringRef Str) override {
414  First->PragmaComment(Loc, Kind, Str);
415  Second->PragmaComment(Loc, Kind, Str);
416  }
417 
418  void PragmaDetectMismatch(SourceLocation Loc, StringRef Name,
419  StringRef Value) override {
420  First->PragmaDetectMismatch(Loc, Name, Value);
421  Second->PragmaDetectMismatch(Loc, Name, Value);
422  }
423 
424  void PragmaDebug(SourceLocation Loc, StringRef DebugType) override {
425  First->PragmaDebug(Loc, DebugType);
426  Second->PragmaDebug(Loc, DebugType);
427  }
428 
429  void PragmaMessage(SourceLocation Loc, StringRef Namespace,
430  PragmaMessageKind Kind, StringRef Str) override {
431  First->PragmaMessage(Loc, Namespace, Kind, Str);
432  Second->PragmaMessage(Loc, Namespace, Kind, Str);
433  }
434 
435  void PragmaDiagnosticPush(SourceLocation Loc, StringRef Namespace) override {
436  First->PragmaDiagnosticPush(Loc, Namespace);
437  Second->PragmaDiagnosticPush(Loc, Namespace);
438  }
439 
440  void PragmaDiagnosticPop(SourceLocation Loc, StringRef Namespace) override {
441  First->PragmaDiagnosticPop(Loc, Namespace);
442  Second->PragmaDiagnosticPop(Loc, Namespace);
443  }
444 
445  void PragmaDiagnostic(SourceLocation Loc, StringRef Namespace,
446  diag::Severity mapping, StringRef Str) override {
447  First->PragmaDiagnostic(Loc, Namespace, mapping, Str);
448  Second->PragmaDiagnostic(Loc, Namespace, mapping, Str);
449  }
450 
451  void HasInclude(SourceLocation Loc, StringRef FileName, bool IsAngled,
452  const FileEntry *File,
453  SrcMgr::CharacteristicKind FileType) override {
454  First->HasInclude(Loc, FileName, IsAngled, File, FileType);
455  Second->HasInclude(Loc, FileName, IsAngled, File, FileType);
456  }
457 
459  SourceLocation StateLoc, unsigned State) override {
460  First->PragmaOpenCLExtension(NameLoc, Name, StateLoc, State);
461  Second->PragmaOpenCLExtension(NameLoc, Name, StateLoc, State);
462  }
463 
464  void PragmaWarning(SourceLocation Loc, StringRef WarningSpec,
465  ArrayRef<int> Ids) override {
466  First->PragmaWarning(Loc, WarningSpec, Ids);
467  Second->PragmaWarning(Loc, WarningSpec, Ids);
468  }
469 
470  void PragmaWarningPush(SourceLocation Loc, int Level) override {
471  First->PragmaWarningPush(Loc, Level);
472  Second->PragmaWarningPush(Loc, Level);
473  }
474 
475  void PragmaWarningPop(SourceLocation Loc) override {
476  First->PragmaWarningPop(Loc);
477  Second->PragmaWarningPop(Loc);
478  }
479 
481  First->PragmaAssumeNonNullBegin(Loc);
482  Second->PragmaAssumeNonNullBegin(Loc);
483  }
484 
486  First->PragmaAssumeNonNullEnd(Loc);
487  Second->PragmaAssumeNonNullEnd(Loc);
488  }
489 
490  void MacroExpands(const Token &MacroNameTok, const MacroDefinition &MD,
491  SourceRange Range, const MacroArgs *Args) override {
492  First->MacroExpands(MacroNameTok, MD, Range, Args);
493  Second->MacroExpands(MacroNameTok, MD, Range, Args);
494  }
495 
496  void MacroDefined(const Token &MacroNameTok,
497  const MacroDirective *MD) override {
498  First->MacroDefined(MacroNameTok, MD);
499  Second->MacroDefined(MacroNameTok, MD);
500  }
501 
502  void MacroUndefined(const Token &MacroNameTok,
503  const MacroDefinition &MD,
504  const MacroDirective *Undef) override {
505  First->MacroUndefined(MacroNameTok, MD, Undef);
506  Second->MacroUndefined(MacroNameTok, MD, Undef);
507  }
508 
509  void Defined(const Token &MacroNameTok, const MacroDefinition &MD,
510  SourceRange Range) override {
511  First->Defined(MacroNameTok, MD, Range);
512  Second->Defined(MacroNameTok, MD, Range);
513  }
514 
515  void SourceRangeSkipped(SourceRange Range, SourceLocation EndifLoc) override {
516  First->SourceRangeSkipped(Range, EndifLoc);
517  Second->SourceRangeSkipped(Range, EndifLoc);
518  }
519 
520  /// Hook called whenever an \#if is seen.
521  void If(SourceLocation Loc, SourceRange ConditionRange,
522  ConditionValueKind ConditionValue) override {
523  First->If(Loc, ConditionRange, ConditionValue);
524  Second->If(Loc, ConditionRange, ConditionValue);
525  }
526 
527  /// Hook called whenever an \#elif is seen.
528  void Elif(SourceLocation Loc, SourceRange ConditionRange,
529  ConditionValueKind ConditionValue, SourceLocation IfLoc) override {
530  First->Elif(Loc, ConditionRange, ConditionValue, IfLoc);
531  Second->Elif(Loc, ConditionRange, ConditionValue, IfLoc);
532  }
533 
534  /// Hook called whenever an \#ifdef is seen.
535  void Ifdef(SourceLocation Loc, const Token &MacroNameTok,
536  const MacroDefinition &MD) override {
537  First->Ifdef(Loc, MacroNameTok, MD);
538  Second->Ifdef(Loc, MacroNameTok, MD);
539  }
540 
541  /// Hook called whenever an \#ifndef is seen.
542  void Ifndef(SourceLocation Loc, const Token &MacroNameTok,
543  const MacroDefinition &MD) override {
544  First->Ifndef(Loc, MacroNameTok, MD);
545  Second->Ifndef(Loc, MacroNameTok, MD);
546  }
547 
548  /// Hook called whenever an \#else is seen.
549  void Else(SourceLocation Loc, SourceLocation IfLoc) override {
550  First->Else(Loc, IfLoc);
551  Second->Else(Loc, IfLoc);
552  }
553 
554  /// Hook called whenever an \#endif is seen.
555  void Endif(SourceLocation Loc, SourceLocation IfLoc) override {
556  First->Endif(Loc, IfLoc);
557  Second->Endif(Loc, IfLoc);
558  }
559 };
560 
561 } // end namespace clang
562 
563 #endif
void PragmaDiagnosticPush(SourceLocation Loc, StringRef Namespace) override
Callback invoked when a #pragma gcc diagnostic push directive is read.
Definition: PPCallbacks.h:435
virtual void Elif(SourceLocation Loc, SourceRange ConditionRange, ConditionValueKind ConditionValue, SourceLocation IfLoc)
Hook called whenever an #elif is seen.
Definition: PPCallbacks.h:313
virtual void PragmaDiagnosticPop(SourceLocation Loc, StringRef Namespace)
Callback invoked when a #pragma gcc diagnostic pop directive is read.
Definition: PPCallbacks.h:214
void MacroUndefined(const Token &MacroNameTok, const MacroDefinition &MD, const MacroDirective *Undef) override
Hook called whenever a macro #undef is seen.
Definition: PPCallbacks.h:502
#pragma GCC error has been invoked.
Definition: PPCallbacks.h:194
virtual void PragmaOpenCLExtension(SourceLocation NameLoc, const IdentifierInfo *Name, SourceLocation StateLoc, unsigned State)
Called when an OpenCL extension is either disabled or enabled with a pragma.
Definition: PPCallbacks.h:224
virtual void EndOfMainFile()
Callback invoked when the end of the main file is reached.
Definition: PPCallbacks.h:153
Defines the SourceManager interface.
void PragmaWarning(SourceLocation Loc, StringRef WarningSpec, ArrayRef< int > Ids) override
Callback invoked when a #pragma warning directive is read.
Definition: PPCallbacks.h:464
virtual void MacroUndefined(const Token &MacroNameTok, const MacroDefinition &MD, const MacroDirective *Undef)
Hook called whenever a macro #undef is seen.
Definition: PPCallbacks.h:267
A description of the current definition of a macro.
Definition: MacroInfo.h:564
void If(SourceLocation Loc, SourceRange ConditionRange, ConditionValueKind ConditionValue) override
Hook called whenever an #if is seen.
Definition: PPCallbacks.h:521
virtual void PragmaWarningPush(SourceLocation Loc, int Level)
Callback invoked when a #pragma warning(push) directive is read.
Definition: PPCallbacks.h:235
virtual void PragmaWarningPop(SourceLocation Loc)
Callback invoked when a #pragma warning(pop) directive is read.
Definition: PPCallbacks.h:239
void PragmaWarningPop(SourceLocation Loc) override
Callback invoked when a #pragma warning(pop) directive is read.
Definition: PPCallbacks.h:475
Severity
Enum values that allow the client to map NOTEs, WARNINGs, and EXTENSIONs to either Ignore (nothing)...
Definition: DiagnosticIDs.h:79
void Ifdef(SourceLocation Loc, const Token &MacroNameTok, const MacroDefinition &MD) override
Hook called whenever an #ifdef is seen.
Definition: PPCallbacks.h:535
CharacteristicKind
Indicates whether a file or directory holds normal user code, system code, or system code which is im...
Definition: SourceManager.h:77
This interface provides a way to observe the actions of the preprocessor as it does its thing...
Definition: PPCallbacks.h:35
virtual void MacroDefined(const Token &MacroNameTok, const MacroDirective *MD)
Hook called whenever a macro definition is seen.
Definition: PPCallbacks.h:257
virtual void Else(SourceLocation Loc, SourceLocation IfLoc)
Hook called whenever an #else is seen.
Definition: PPCallbacks.h:336
virtual void If(SourceLocation Loc, SourceRange ConditionRange, ConditionValueKind ConditionValue)
Hook called whenever an #if is seen.
Definition: PPCallbacks.h:303
One of these records is kept for each identifier that is lexed.
virtual void PragmaDebug(SourceLocation Loc, StringRef DebugType)
Callback invoked when a #pragma clang __debug directive is read.
Definition: PPCallbacks.h:182
LineState State
Definition: Format.h:2071
Token - This structure provides full information about a lexed token.
Definition: Token.h:34
virtual void Endif(SourceLocation Loc, SourceLocation IfLoc)
Hook called whenever an #endif is seen.
Definition: PPCallbacks.h:342
Describes a module or submodule.
Definition: Module.h:64
PPChainedCallbacks(std::unique_ptr< PPCallbacks > _First, std::unique_ptr< PPCallbacks > _Second)
Definition: PPCallbacks.h:352
void FileSkipped(const FileEntry &SkippedFile, const Token &FilenameTok, SrcMgr::CharacteristicKind FileType) override
Callback invoked whenever a source file is skipped as the result of header guard optimization.
Definition: PPCallbacks.h:363
PragmaIntroducerKind
Describes how the pragma was introduced, e.g., with #pragma, _Pragma, or __pragma.
Definition: Pragma.h:31
virtual void Defined(const Token &MacroNameTok, const MacroDefinition &MD, SourceRange Range)
Hook called whenever the &#39;defined&#39; operator is seen.
Definition: PPCallbacks.h:274
void Ifndef(SourceLocation Loc, const Token &MacroNameTok, const MacroDefinition &MD) override
Hook called whenever an #ifndef is seen.
Definition: PPCallbacks.h:542
return Out str()
PragmaMessageKind
Determines the kind of #pragma invoking a call to PragmaMessage.
Definition: PPCallbacks.h:186
virtual void PragmaAssumeNonNullBegin(SourceLocation Loc)
Callback invoked when a #pragma clang assume_nonnull begin directive is read.
Definition: PPCallbacks.h:244
#pragma GCC warning has been invoked.
Definition: PPCallbacks.h:191
virtual void PragmaWarning(SourceLocation Loc, StringRef WarningSpec, ArrayRef< int > Ids)
Callback invoked when a #pragma warning directive is read.
Definition: PPCallbacks.h:230
bool FileNotFound(StringRef FileName, SmallVectorImpl< char > &RecoveryPath) override
Callback invoked whenever an inclusion directive results in a file-not-found error.
Definition: PPCallbacks.h:370
Represents a character-granular source range.
void Ident(SourceLocation Loc, StringRef str) override
Callback invoked when a #ident or #sccs directive is read.
Definition: PPCallbacks.h:401
void PragmaWarningPush(SourceLocation Loc, int Level) override
Callback invoked when a #pragma warning(push) directive is read.
Definition: PPCallbacks.h:470
void FileChanged(SourceLocation Loc, FileChangeReason Reason, SrcMgr::CharacteristicKind FileType, FileID PrevFID) override
Callback invoked whenever a source file is entered or exited.
Definition: PPCallbacks.h:356
MacroArgs - An instance of this class captures information about the formal arguments specified to a ...
Definition: MacroArgs.h:29
void Elif(SourceLocation Loc, SourceRange ConditionRange, ConditionValueKind ConditionValue, SourceLocation IfLoc) override
Hook called whenever an #elif is seen.
Definition: PPCallbacks.h:528
virtual void HasInclude(SourceLocation Loc, StringRef FileName, bool IsAngled, const FileEntry *File, SrcMgr::CharacteristicKind FileType)
Hook called when a &#39;__has_include&#39; or &#39;__has_include_next&#39; directive is read.
Definition: PPCallbacks.h:280
void PragmaAssumeNonNullBegin(SourceLocation Loc) override
Callback invoked when a #pragma clang assume_nonnull begin directive is read.
Definition: PPCallbacks.h:480
virtual void FileChanged(SourceLocation Loc, FileChangeReason Reason, SrcMgr::CharacteristicKind FileType, FileID PrevFID=FileID())
Callback invoked whenever a source file is entered or exited.
Definition: PPCallbacks.h:47
void PragmaMessage(SourceLocation Loc, StringRef Namespace, PragmaMessageKind Kind, StringRef Str) override
Callback invoked when a #pragma message directive is read.
Definition: PPCallbacks.h:429
virtual void PragmaComment(SourceLocation Loc, const IdentifierInfo *Kind, StringRef Str)
Callback invoked when a #pragma comment directive is read.
Definition: PPCallbacks.h:169
virtual void PragmaDirective(SourceLocation Loc, PragmaIntroducerKind Introducer)
Callback invoked when start reading any pragma directive.
Definition: PPCallbacks.h:164
Simple wrapper class for chaining callbacks.
Definition: PPCallbacks.h:347
virtual void InclusionDirective(SourceLocation HashLoc, const Token &IncludeTok, StringRef FileName, bool IsAngled, CharSourceRange FilenameRange, const FileEntry *File, StringRef SearchPath, StringRef RelativePath, const Module *Imported, SrcMgr::CharacteristicKind FileType)
Callback invoked whenever an inclusion directive of any kind (#include, #import, etc.) has been processed, regardless of whether the inclusion will actually result in an inclusion.
Definition: PPCallbacks.h:123
Encapsulates changes to the "macros namespace" (the location where the macro name became active...
Definition: MacroInfo.h:290
Kind
virtual void Ident(SourceLocation Loc, StringRef str)
Callback invoked when a #ident or #sccs directive is read.
Definition: PPCallbacks.h:160
Encodes a location in the source.
void moduleImport(SourceLocation ImportLoc, ModuleIdPath Path, const Module *Imported) override
Callback invoked whenever there was an explicit module-import syntax.
Definition: PPCallbacks.h:390
virtual void MacroExpands(const Token &MacroNameTok, const MacroDefinition &MD, SourceRange Range, const MacroArgs *Args)
Called by Preprocessor::HandleMacroExpandedIdentifier when a macro invocation is found.
Definition: PPCallbacks.h:252
#pragma message has been invoked.
Definition: PPCallbacks.h:188
void PragmaDebug(SourceLocation Loc, StringRef DebugType) override
Callback invoked when a #pragma clang __debug directive is read.
Definition: PPCallbacks.h:424
void PragmaAssumeNonNullEnd(SourceLocation Loc) override
Callback invoked when a #pragma clang assume_nonnull end directive is read.
Definition: PPCallbacks.h:485
Cached information about one file (either on disk or in the virtual file system). ...
Definition: FileManager.h:59
virtual void moduleImport(SourceLocation ImportLoc, ModuleIdPath Path, const Module *Imported)
Callback invoked whenever there was an explicit module-import syntax.
Definition: PPCallbacks.h:145
void InclusionDirective(SourceLocation HashLoc, const Token &IncludeTok, StringRef FileName, bool IsAngled, CharSourceRange FilenameRange, const FileEntry *File, StringRef SearchPath, StringRef RelativePath, const Module *Imported, SrcMgr::CharacteristicKind FileType) override
Callback invoked whenever an inclusion directive of any kind (#include, #import, etc.) has been processed, regardless of whether the inclusion will actually result in an inclusion.
Definition: PPCallbacks.h:376
virtual void Ifdef(SourceLocation Loc, const Token &MacroNameTok, const MacroDefinition &MD)
Hook called whenever an #ifdef is seen.
Definition: PPCallbacks.h:321
void PragmaDirective(SourceLocation Loc, PragmaIntroducerKind Introducer) override
Callback invoked when start reading any pragma directive.
Definition: PPCallbacks.h:406
void MacroExpands(const Token &MacroNameTok, const MacroDefinition &MD, SourceRange Range, const MacroArgs *Args) override
Called by Preprocessor::HandleMacroExpandedIdentifier when a macro invocation is found.
Definition: PPCallbacks.h:490
void HasInclude(SourceLocation Loc, StringRef FileName, bool IsAngled, const FileEntry *File, SrcMgr::CharacteristicKind FileType) override
Hook called when a &#39;__has_include&#39; or &#39;__has_include_next&#39; directive is read.
Definition: PPCallbacks.h:451
virtual void PragmaMessage(SourceLocation Loc, StringRef Namespace, PragmaMessageKind Kind, StringRef Str)
Callback invoked when a #pragma message directive is read.
Definition: PPCallbacks.h:202
void PragmaComment(SourceLocation Loc, const IdentifierInfo *Kind, StringRef Str) override
Callback invoked when a #pragma comment directive is read.
Definition: PPCallbacks.h:412
void PragmaDiagnostic(SourceLocation Loc, StringRef Namespace, diag::Severity mapping, StringRef Str) override
Callback invoked when a #pragma gcc diagnostic directive is read.
Definition: PPCallbacks.h:445
An opaque identifier used by SourceManager which refers to a source file (MemoryBuffer) along with it...
void Defined(const Token &MacroNameTok, const MacroDefinition &MD, SourceRange Range) override
Hook called whenever the &#39;defined&#39; operator is seen.
Definition: PPCallbacks.h:509
void MacroDefined(const Token &MacroNameTok, const MacroDirective *MD) override
Hook called whenever a macro definition is seen.
Definition: PPCallbacks.h:496
Dataflow Directional Tag Classes.
void PragmaDiagnosticPop(SourceLocation Loc, StringRef Namespace) override
Callback invoked when a #pragma gcc diagnostic pop directive is read.
Definition: PPCallbacks.h:440
void PragmaDetectMismatch(SourceLocation Loc, StringRef Name, StringRef Value) override
Callback invoked when a #pragma detect_mismatch directive is read.
Definition: PPCallbacks.h:418
virtual void PragmaDetectMismatch(SourceLocation Loc, StringRef Name, StringRef Value)
Callback invoked when a #pragma detect_mismatch directive is read.
Definition: PPCallbacks.h:175
void PragmaOpenCLExtension(SourceLocation NameLoc, const IdentifierInfo *Name, SourceLocation StateLoc, unsigned State) override
Called when an OpenCL extension is either disabled or enabled with a pragma.
Definition: PPCallbacks.h:458
void EndOfMainFile() override
Callback invoked when the end of the main file is reached.
Definition: PPCallbacks.h:396
virtual bool FileNotFound(StringRef FileName, SmallVectorImpl< char > &RecoveryPath)
Callback invoked whenever an inclusion directive results in a file-not-found error.
Definition: PPCallbacks.h:77
virtual void Ifndef(SourceLocation Loc, const Token &MacroNameTok, const MacroDefinition &MD)
Hook called whenever an #ifndef is seen.
Definition: PPCallbacks.h:329
virtual void PragmaAssumeNonNullEnd(SourceLocation Loc)
Callback invoked when a #pragma clang assume_nonnull end directive is read.
Definition: PPCallbacks.h:248
Defines the clang::SourceLocation class and associated facilities.
void Endif(SourceLocation Loc, SourceLocation IfLoc) override
Hook called whenever an #endif is seen.
Definition: PPCallbacks.h:555
virtual void PragmaDiagnosticPush(SourceLocation Loc, StringRef Namespace)
Callback invoked when a #pragma gcc diagnostic push directive is read.
Definition: PPCallbacks.h:208
Defines the Diagnostic IDs-related interfaces.
virtual void PragmaDiagnostic(SourceLocation Loc, StringRef Namespace, diag::Severity mapping, StringRef Str)
Callback invoked when a #pragma gcc diagnostic directive is read.
Definition: PPCallbacks.h:219
void SourceRangeSkipped(SourceRange Range, SourceLocation EndifLoc) override
Hook called when a source range is skipped.
Definition: PPCallbacks.h:515
A trivial tuple used to represent a source range.
void Else(SourceLocation Loc, SourceLocation IfLoc) override
Hook called whenever an #else is seen.
Definition: PPCallbacks.h:549
virtual void FileSkipped(const FileEntry &SkippedFile, const Token &FilenameTok, SrcMgr::CharacteristicKind FileType)
Callback invoked whenever a source file is skipped as the result of header guard optimization.
Definition: PPCallbacks.h:60
virtual void SourceRangeSkipped(SourceRange Range, SourceLocation EndifLoc)
Hook called when a source range is skipped.
Definition: PPCallbacks.h:290