PPCallbacks.h revision 0b9e736308af5397f558ffc8e780c438c2fdb563
1de73296d6b56abe70b08654342e136c2612d1dbdJason Evans//===--- PPCallbacks.h - Callbacks for Preprocessor actions -----*- C++ -*-===// 2de73296d6b56abe70b08654342e136c2612d1dbdJason Evans// 3de73296d6b56abe70b08654342e136c2612d1dbdJason Evans// The LLVM Compiler Infrastructure 4de73296d6b56abe70b08654342e136c2612d1dbdJason Evans// 5de73296d6b56abe70b08654342e136c2612d1dbdJason Evans// This file is distributed under the University of Illinois Open Source 6de73296d6b56abe70b08654342e136c2612d1dbdJason Evans// License. See LICENSE.TXT for details. 7de73296d6b56abe70b08654342e136c2612d1dbdJason Evans// 8de73296d6b56abe70b08654342e136c2612d1dbdJason Evans//===----------------------------------------------------------------------===// 9de73296d6b56abe70b08654342e136c2612d1dbdJason Evans// 10de73296d6b56abe70b08654342e136c2612d1dbdJason Evans// This file defines the PPCallbacks interface. 11de73296d6b56abe70b08654342e136c2612d1dbdJason Evans// 12de73296d6b56abe70b08654342e136c2612d1dbdJason Evans//===----------------------------------------------------------------------===// 13de73296d6b56abe70b08654342e136c2612d1dbdJason Evans 14de73296d6b56abe70b08654342e136c2612d1dbdJason Evans#ifndef LLVM_CLANG_LEX_PPCALLBACKS_H 15de73296d6b56abe70b08654342e136c2612d1dbdJason Evans#define LLVM_CLANG_LEX_PPCALLBACKS_H 16de73296d6b56abe70b08654342e136c2612d1dbdJason Evans 17de73296d6b56abe70b08654342e136c2612d1dbdJason Evans#include "clang/Lex/DirectoryLookup.h" 18de73296d6b56abe70b08654342e136c2612d1dbdJason Evans#include "clang/Basic/SourceLocation.h" 19de73296d6b56abe70b08654342e136c2612d1dbdJason Evans#include <string> 20de73296d6b56abe70b08654342e136c2612d1dbdJason Evans 21de73296d6b56abe70b08654342e136c2612d1dbdJason Evansnamespace clang { 22de73296d6b56abe70b08654342e136c2612d1dbdJason Evans class SourceLocation; 23de73296d6b56abe70b08654342e136c2612d1dbdJason Evans 24de73296d6b56abe70b08654342e136c2612d1dbdJason Evans/// PPCallbacks - This interface provides a way to observe the actions of the 25de73296d6b56abe70b08654342e136c2612d1dbdJason Evans/// preprocessor as it does its thing. Clients can define their hooks here to 26de73296d6b56abe70b08654342e136c2612d1dbdJason Evans/// implement preprocessor level tools. 27de73296d6b56abe70b08654342e136c2612d1dbdJason Evansclass PPCallbacks { 28de73296d6b56abe70b08654342e136c2612d1dbdJason Evanspublic: 29de73296d6b56abe70b08654342e136c2612d1dbdJason Evans virtual ~PPCallbacks(); 30de73296d6b56abe70b08654342e136c2612d1dbdJason Evans 31de73296d6b56abe70b08654342e136c2612d1dbdJason Evans enum FileChangeReason { 32de73296d6b56abe70b08654342e136c2612d1dbdJason Evans EnterFile, ExitFile, SystemHeaderPragma, RenameFile 33de73296d6b56abe70b08654342e136c2612d1dbdJason Evans }; 34de73296d6b56abe70b08654342e136c2612d1dbdJason Evans 35de73296d6b56abe70b08654342e136c2612d1dbdJason Evans /// FileChanged - This callback is invoked whenever a source file is 36de73296d6b56abe70b08654342e136c2612d1dbdJason Evans /// entered or exited. The SourceLocation indicates the new location, and 37de73296d6b56abe70b08654342e136c2612d1dbdJason Evans /// EnteringFile indicates whether this is because we are entering a new 38de73296d6b56abe70b08654342e136c2612d1dbdJason Evans /// #include'd file (when true) or whether we're exiting one because we ran 39de73296d6b56abe70b08654342e136c2612d1dbdJason Evans /// off the end (when false). 40de73296d6b56abe70b08654342e136c2612d1dbdJason Evans virtual void FileChanged(SourceLocation Loc, FileChangeReason Reason, 41de73296d6b56abe70b08654342e136c2612d1dbdJason Evans SrcMgr::Characteristic_t FileType) { 42de73296d6b56abe70b08654342e136c2612d1dbdJason Evans } 43de73296d6b56abe70b08654342e136c2612d1dbdJason Evans 44de73296d6b56abe70b08654342e136c2612d1dbdJason Evans /// Ident - This callback is invoked when a #ident or #sccs directive is read. 45de73296d6b56abe70b08654342e136c2612d1dbdJason Evans /// 46de73296d6b56abe70b08654342e136c2612d1dbdJason Evans virtual void Ident(SourceLocation Loc, const std::string &str) { 47de73296d6b56abe70b08654342e136c2612d1dbdJason Evans } 48de73296d6b56abe70b08654342e136c2612d1dbdJason Evans 49de73296d6b56abe70b08654342e136c2612d1dbdJason Evans}; 50de73296d6b56abe70b08654342e136c2612d1dbdJason Evans 51de73296d6b56abe70b08654342e136c2612d1dbdJason Evans} // end namespace clang 52de73296d6b56abe70b08654342e136c2612d1dbdJason Evans 53de73296d6b56abe70b08654342e136c2612d1dbdJason Evans#endif 54de73296d6b56abe70b08654342e136c2612d1dbdJason Evans