contrib/llvm/tools/clang/include/clang/Lex/PPCallbacks.h

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