clang-tools-extra/clang-tidy/misc/ConstCorrectnessCheck.h

   1 //===--- ConstCorrectnessCheck.h - clang-tidy -------------------*- 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 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_CONSTCORRECTNESSCHECK_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_CONSTCORRECTNESSCHECK_H
  11
  12 #include "../ClangTidyCheck.h"
  13 #include "clang/Analysis/Analyses/ExprMutationAnalyzer.h"
  14 #include "llvm/ADT/DenseSet.h"
  15
  16 namespace clang::tidy::misc {
  17
  18 /// This check warns on variables which could be declared const but are not.
  19 ///
  20 /// For the user-facing documentation see:
  21 /// http://clang.llvm.org/extra/clang-tidy/checks/misc/const-correctness.html
  22 class ConstCorrectnessCheck : public ClangTidyCheck {
  23 public:
  24   ConstCorrectnessCheck(StringRef Name, ClangTidyContext *Context);
  25
  26   // The rules for C and 'const' are different and incompatible for this check.
  27   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
  28     return LangOpts.CPlusPlus;
  29   }
  30   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
  31   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  32   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  33
  34 private:
  35   void registerScope(const CompoundStmt *LocalScope, ASTContext *Context);
  36
  37   using MutationAnalyzer = std::unique_ptr<ExprMutationAnalyzer>;
  38   llvm::DenseMap<const CompoundStmt *, MutationAnalyzer> ScopesCache;
  39   llvm::DenseSet<SourceLocation> TemplateDiagnosticsCache;
  40
  41   const bool AnalyzeValues;
  42   const bool AnalyzeReferences;
  43   const bool WarnPointersAsValues;
  44
  45   const bool TransformValues;
  46   const bool TransformReferences;
  47   const bool TransformPointersAsValues;
  48 };
  49
  50 } // namespace clang::tidy::misc
  51
  52 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_CONSTCORRECTNESSCHECK_H