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/Lex/DirectoryLookup.h"
  21 #include "clang/Lex/ModuleLoader.h"
  22 #include "clang/Lex/Pragma.h"
  23 #include "llvm/ADT/StringRef.h"
  24 #include <string>
  25
  26 namespace clang {
  27   class SourceLocation;
  28   class Token;
  29   class IdentifierInfo;
  30   class MacroDirective;
  31   class MacroArgs;
  32
  33 /// \brief This interface provides a way to observe the actions of the
  34 /// preprocessor as it does its thing.
  35 ///
  36 /// Clients can define their hooks here to implement preprocessor level tools.
  37 class PPCallbacks {
  38 public:
  39   virtual ~PPCallbacks();
  40
  41   enum FileChangeReason {
  42     EnterFile, ExitFile, SystemHeaderPragma, RenameFile
  43   };
  44
  45   /// \brief Callback invoked whenever a source file is entered or exited.
  46   ///
  47   /// \param Loc Indicates the new location.
  48   /// \param PrevFID the file that was exited if \p Reason is ExitFile.
  49   virtual void FileChanged(SourceLocation Loc, FileChangeReason Reason,
  50                            SrcMgr::CharacteristicKind FileType,
  51                            FileID PrevFID = FileID()) {
  52   }
  53
  54   /// \brief Callback invoked whenever a source file is skipped as the result
  55   /// of header guard optimization.
  56   ///
  57   /// \param ParentFile The file that \#included the skipped file.
  58   ///
  59   /// \param FilenameTok The token in ParentFile that indicates the
  60   /// skipped file.
  61   virtual void FileSkipped(const FileEntry &ParentFile,
  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, const std::string &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                              const std::string &Str) {
 167   }
 168
 169   /// \brief Callback invoked when a \#pragma detect_mismatch directive is
 170   /// read.
 171   virtual void PragmaDetectMismatch(SourceLocation Loc,
 172                                     const std::string &Name,
 173                                     const std::string &Value) {
 174   }
 175
 176   /// \brief Callback invoked when a \#pragma clang __debug directive is read.
 177   /// \param Loc The location of the debug directive.
 178   /// \param DebugType The identifier following __debug.
 179   virtual void PragmaDebug(SourceLocation Loc, StringRef DebugType) {
 180   }
 181
 182   /// \brief Determines the kind of \#pragma invoking a call to PragmaMessage.
 183   enum PragmaMessageKind {
 184     /// \brief \#pragma message has been invoked.
 185     PMK_Message,
 186
 187     /// \brief \#pragma GCC warning has been invoked.
 188     PMK_Warning,
 189
 190     /// \brief \#pragma GCC error has been invoked.
 191     PMK_Error
 192   };
 193
 194   /// \brief Callback invoked when a \#pragma message directive is read.
 195   /// \param Loc The location of the message directive.
 196   /// \param Namespace The namespace of the message directive.
 197   /// \param Kind The type of the message directive.
 198   /// \param Str The text of the message directive.
 199   virtual void PragmaMessage(SourceLocation Loc, StringRef Namespace,
 200                              PragmaMessageKind Kind, StringRef Str) {
 201   }
 202
 203   /// \brief Callback invoked when a \#pragma gcc dianostic push directive
 204   /// is read.
 205   virtual void PragmaDiagnosticPush(SourceLocation Loc,
 206                                     StringRef Namespace) {
 207   }
 208
 209   /// \brief Callback invoked when a \#pragma gcc dianostic pop directive
 210   /// is read.
 211   virtual void PragmaDiagnosticPop(SourceLocation Loc,
 212                                    StringRef Namespace) {
 213   }
 214
 215   /// \brief Callback invoked when a \#pragma gcc dianostic directive is read.
 216   virtual void PragmaDiagnostic(SourceLocation Loc, StringRef Namespace,
 217                                 diag::Severity mapping, StringRef Str) {}
 218
 219   /// \brief Called when an OpenCL extension is either disabled or
 220   /// enabled with a pragma.
 221   virtual void PragmaOpenCLExtension(SourceLocation NameLoc,
 222                                      const IdentifierInfo *Name,
 223                                      SourceLocation StateLoc, unsigned State) {
 224   }
 225
 226   /// \brief Callback invoked when a \#pragma warning directive is read.
 227   virtual void PragmaWarning(SourceLocation Loc, StringRef WarningSpec,
 228                              ArrayRef<int> Ids) {
 229   }
 230
 231   /// \brief Callback invoked when a \#pragma warning(push) directive is read.
 232   virtual void PragmaWarningPush(SourceLocation Loc, int Level) {
 233   }
 234
 235   /// \brief Callback invoked when a \#pragma warning(pop) directive is read.
 236   virtual void PragmaWarningPop(SourceLocation Loc) {
 237   }
 238
 239   /// \brief Called by Preprocessor::HandleMacroExpandedIdentifier when a
 240   /// macro invocation is found.
 241   virtual void MacroExpands(const Token &MacroNameTok, const MacroDirective *MD,
 242                             SourceRange Range, const MacroArgs *Args) {
 243   }
 244
 245   /// \brief Hook called whenever a macro definition is seen.
 246   virtual void MacroDefined(const Token &MacroNameTok,
 247                             const MacroDirective *MD) {
 248   }
 249
 250   /// \brief Hook called whenever a macro \#undef is seen.
 251   ///
 252   /// MD is released immediately following this callback.
 253   virtual void MacroUndefined(const Token &MacroNameTok,
 254                               const MacroDirective *MD) {
 255   }
 256
 257   /// \brief Hook called whenever the 'defined' operator is seen.
 258   /// \param MD The MacroDirective if the name was a macro, null otherwise.
 259   virtual void Defined(const Token &MacroNameTok, const MacroDirective *MD,
 260                        SourceRange Range) {
 261   }
 262
 263   /// \brief Hook called when a source range is skipped.
 264   /// \param Range The SourceRange that was skipped. The range begins at the
 265   /// \#if/\#else directive and ends after the \#endif/\#else directive.
 266   virtual void SourceRangeSkipped(SourceRange Range) {
 267   }
 268
 269   enum ConditionValueKind {
 270     CVK_NotEvaluated, CVK_False, CVK_True
 271   };
 272
 273   /// \brief Hook called whenever an \#if is seen.
 274   /// \param Loc the source location of the directive.
 275   /// \param ConditionRange The SourceRange of the expression being tested.
 276   /// \param ConditionValue The evaluated value of the condition.
 277   ///
 278   // FIXME: better to pass in a list (or tree!) of Tokens.
 279   virtual void If(SourceLocation Loc, SourceRange ConditionRange,
 280                   ConditionValueKind ConditionValue) {
 281   }
 282
 283   /// \brief Hook called whenever an \#elif is seen.
 284   /// \param Loc the source location of the directive.
 285   /// \param ConditionRange The SourceRange of the expression being tested.
 286   /// \param ConditionValue The evaluated value of the condition.
 287   /// \param IfLoc the source location of the \#if/\#ifdef/\#ifndef directive.
 288   // FIXME: better to pass in a list (or tree!) of Tokens.
 289   virtual void Elif(SourceLocation Loc, SourceRange ConditionRange,
 290                     ConditionValueKind ConditionValue, SourceLocation IfLoc) {
 291   }
 292
 293   /// \brief Hook called whenever an \#ifdef is seen.
 294   /// \param Loc the source location of the directive.
 295   /// \param MacroNameTok Information on the token being tested.
 296   /// \param MD The MacroDirective if the name was a macro, null otherwise.
 297   virtual void Ifdef(SourceLocation Loc, const Token &MacroNameTok,
 298                      const MacroDirective *MD) {
 299   }
 300
 301   /// \brief Hook called whenever an \#ifndef is seen.
 302   /// \param Loc the source location of the directive.
 303   /// \param MacroNameTok Information on the token being tested.
 304   /// \param MD The MacroDirective if the name was a macro, null otherwise.
 305   virtual void Ifndef(SourceLocation Loc, const Token &MacroNameTok,
 306                       const MacroDirective *MD) {
 307   }
 308
 309   /// \brief Hook called whenever an \#else is seen.
 310   /// \param Loc the source location of the directive.
 311   /// \param IfLoc the source location of the \#if/\#ifdef/\#ifndef directive.
 312   virtual void Else(SourceLocation Loc, SourceLocation IfLoc) {
 313   }
 314
 315   /// \brief Hook called whenever an \#endif is seen.
 316   /// \param Loc the source location of the directive.
 317   /// \param IfLoc the source location of the \#if/\#ifdef/\#ifndef directive.
 318   virtual void Endif(SourceLocation Loc, SourceLocation IfLoc) {
 319   }
 320 };
 321
 322 /// \brief Simple wrapper class for chaining callbacks.
 323 class PPChainedCallbacks : public PPCallbacks {
 324   virtual void anchor();
 325   PPCallbacks *First, *Second;
 326
 327 public:
 328   PPChainedCallbacks(PPCallbacks *_First, PPCallbacks *_Second)
 329     : First(_First), Second(_Second) {}
 330   ~PPChainedCallbacks() {
 331     delete Second;
 332     delete First;
 333   }
 334
 335   void FileChanged(SourceLocation Loc, FileChangeReason Reason,
 336                    SrcMgr::CharacteristicKind FileType,
 337                    FileID PrevFID) override {
 338     First->FileChanged(Loc, Reason, FileType, PrevFID);
 339     Second->FileChanged(Loc, Reason, FileType, PrevFID);
 340   }
 341
 342   void FileSkipped(const FileEntry &ParentFile,
 343                    const Token &FilenameTok,
 344                    SrcMgr::CharacteristicKind FileType) override {
 345     First->FileSkipped(ParentFile, FilenameTok, FileType);
 346     Second->FileSkipped(ParentFile, FilenameTok, FileType);
 347   }
 348
 349   bool FileNotFound(StringRef FileName,
 350                     SmallVectorImpl<char> &RecoveryPath) override {
 351     return First->FileNotFound(FileName, RecoveryPath) ||
 352            Second->FileNotFound(FileName, RecoveryPath);
 353   }
 354
 355   void InclusionDirective(SourceLocation HashLoc, const Token &IncludeTok,
 356                           StringRef FileName, bool IsAngled,
 357                           CharSourceRange FilenameRange, const FileEntry *File,
 358                           StringRef SearchPath, StringRef RelativePath,
 359                           const Module *Imported) override {
 360     First->InclusionDirective(HashLoc, IncludeTok, FileName, IsAngled,
 361                               FilenameRange, File, SearchPath, RelativePath,
 362                               Imported);
 363     Second->InclusionDirective(HashLoc, IncludeTok, FileName, IsAngled,
 364                                FilenameRange, File, SearchPath, RelativePath,
 365                                Imported);
 366   }
 367
 368   void moduleImport(SourceLocation ImportLoc, ModuleIdPath Path,
 369                     const Module *Imported) override {
 370     First->moduleImport(ImportLoc, Path, Imported);
 371     Second->moduleImport(ImportLoc, Path, Imported);
 372   }
 373
 374   void EndOfMainFile() override {
 375     First->EndOfMainFile();
 376     Second->EndOfMainFile();
 377   }
 378
 379   void Ident(SourceLocation Loc, const std::string &str) override {
 380     First->Ident(Loc, str);
 381     Second->Ident(Loc, str);
 382   }
 383
 384   void PragmaComment(SourceLocation Loc, const IdentifierInfo *Kind,
 385                      const std::string &Str) override {
 386     First->PragmaComment(Loc, Kind, Str);
 387     Second->PragmaComment(Loc, Kind, Str);
 388   }
 389
 390   void PragmaDetectMismatch(SourceLocation Loc, const std::string &Name,
 391                             const std::string &Value) override {
 392     First->PragmaDetectMismatch(Loc, Name, Value);
 393     Second->PragmaDetectMismatch(Loc, Name, Value);
 394   }
 395
 396   void PragmaMessage(SourceLocation Loc, StringRef Namespace,
 397                      PragmaMessageKind Kind, StringRef Str) override {
 398     First->PragmaMessage(Loc, Namespace, Kind, Str);
 399     Second->PragmaMessage(Loc, Namespace, Kind, Str);
 400   }
 401
 402   void PragmaDiagnosticPush(SourceLocation Loc, StringRef Namespace) override {
 403     First->PragmaDiagnosticPush(Loc, Namespace);
 404     Second->PragmaDiagnosticPush(Loc, Namespace);
 405   }
 406
 407   void PragmaDiagnosticPop(SourceLocation Loc, StringRef Namespace) override {
 408     First->PragmaDiagnosticPop(Loc, Namespace);
 409     Second->PragmaDiagnosticPop(Loc, Namespace);
 410   }
 411
 412   void PragmaDiagnostic(SourceLocation Loc, StringRef Namespace,
 413                         diag::Severity mapping, StringRef Str) override {
 414     First->PragmaDiagnostic(Loc, Namespace, mapping, Str);
 415     Second->PragmaDiagnostic(Loc, Namespace, mapping, Str);
 416   }
 417
 418   void PragmaOpenCLExtension(SourceLocation NameLoc, const IdentifierInfo *Name,
 419                              SourceLocation StateLoc, unsigned State) override {
 420     First->PragmaOpenCLExtension(NameLoc, Name, StateLoc, State);
 421     Second->PragmaOpenCLExtension(NameLoc, Name, StateLoc, State);
 422   }
 423
 424   void PragmaWarning(SourceLocation Loc, StringRef WarningSpec,
 425                      ArrayRef<int> Ids) override {
 426     First->PragmaWarning(Loc, WarningSpec, Ids);
 427     Second->PragmaWarning(Loc, WarningSpec, Ids);
 428   }
 429
 430   void PragmaWarningPush(SourceLocation Loc, int Level) override {
 431     First->PragmaWarningPush(Loc, Level);
 432     Second->PragmaWarningPush(Loc, Level);
 433   }
 434
 435   void PragmaWarningPop(SourceLocation Loc) override {
 436     First->PragmaWarningPop(Loc);
 437     Second->PragmaWarningPop(Loc);
 438   }
 439
 440   void MacroExpands(const Token &MacroNameTok, const MacroDirective *MD,
 441                     SourceRange Range, const MacroArgs *Args) override {
 442     First->MacroExpands(MacroNameTok, MD, Range, Args);
 443     Second->MacroExpands(MacroNameTok, MD, Range, Args);
 444   }
 445
 446   void MacroDefined(const Token &MacroNameTok, const MacroDirective *MD) override {
 447     First->MacroDefined(MacroNameTok, MD);
 448     Second->MacroDefined(MacroNameTok, MD);
 449   }
 450
 451   void MacroUndefined(const Token &MacroNameTok,
 452                       const MacroDirective *MD) override {
 453     First->MacroUndefined(MacroNameTok, MD);
 454     Second->MacroUndefined(MacroNameTok, MD);
 455   }
 456
 457   void Defined(const Token &MacroNameTok, const MacroDirective *MD,
 458                SourceRange Range) override {
 459     First->Defined(MacroNameTok, MD, Range);
 460     Second->Defined(MacroNameTok, MD, Range);
 461   }
 462
 463   void SourceRangeSkipped(SourceRange Range) override {
 464     First->SourceRangeSkipped(Range);
 465     Second->SourceRangeSkipped(Range);
 466   }
 467
 468   /// \brief Hook called whenever an \#if is seen.
 469   void If(SourceLocation Loc, SourceRange ConditionRange,
 470           ConditionValueKind ConditionValue) override {
 471     First->If(Loc, ConditionRange, ConditionValue);
 472     Second->If(Loc, ConditionRange, ConditionValue);
 473   }
 474
 475   /// \brief Hook called whenever an \#elif is seen.
 476   void Elif(SourceLocation Loc, SourceRange ConditionRange,
 477             ConditionValueKind ConditionValue, SourceLocation IfLoc) override {
 478     First->Elif(Loc, ConditionRange, ConditionValue, IfLoc);
 479     Second->Elif(Loc, ConditionRange, ConditionValue, IfLoc);
 480   }
 481
 482   /// \brief Hook called whenever an \#ifdef is seen.
 483   void Ifdef(SourceLocation Loc, const Token &MacroNameTok,
 484              const MacroDirective *MD) override {
 485     First->Ifdef(Loc, MacroNameTok, MD);
 486     Second->Ifdef(Loc, MacroNameTok, MD);
 487   }
 488
 489   /// \brief Hook called whenever an \#ifndef is seen.
 490   void Ifndef(SourceLocation Loc, const Token &MacroNameTok,
 491               const MacroDirective *MD) override {
 492     First->Ifndef(Loc, MacroNameTok, MD);
 493     Second->Ifndef(Loc, MacroNameTok, MD);
 494   }
 495
 496   /// \brief Hook called whenever an \#else is seen.
 497   void Else(SourceLocation Loc, SourceLocation IfLoc) override {
 498     First->Else(Loc, IfLoc);
 499     Second->Else(Loc, IfLoc);
 500   }
 501
 502   /// \brief Hook called whenever an \#endif is seen.
 503   void Endif(SourceLocation Loc, SourceLocation IfLoc) override {
 504     First->Endif(Loc, IfLoc);
 505     Second->Endif(Loc, IfLoc);
 506   }
 507 };
 508
 509 }  // end namespace clang
 510
 511 #endif