clang-tidy/google/TodoCommentCheck.h

0001 //===--- TodoCommentCheck.h - clang-tidy ------------------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_TODOCOMMENTCHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_TODOCOMMENTCHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013
0014 namespace clang::tidy::google::readability {
0015
0016 /// Finds TODO comments without a username or bug number.
0017 ///
0018 /// Corresponding cpplint.py check: 'readability/todo'
0019 ///
0020 /// For the user-facing documentation see:
0021 /// http://clang.llvm.org/extra/clang-tidy/checks/google/readability-todo.html
0022 class TodoCommentCheck : public ClangTidyCheck {
0023 public:
0024   TodoCommentCheck(StringRef Name, ClangTidyContext *Context);
0025   ~TodoCommentCheck();
0026
0027   void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
0028                            Preprocessor *ModuleExpanderPP) override;
0029
0030 private:
0031   class TodoCommentHandler;
0032   std::unique_ptr<TodoCommentHandler> Handler;
0033 };
0034
0035 } // namespace clang::tidy::google::readability
0036
0037 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_TODOCOMMENTCHECK_H