clang-tidy/misc/ConstCorrectnessCheck.h

0001 //===--- ConstCorrectnessCheck.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_MISC_CONSTCORRECTNESSCHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_CONSTCORRECTNESSCHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013 #include "clang/Analysis/Analyses/ExprMutationAnalyzer.h"
0014 #include "llvm/ADT/DenseSet.h"
0015
0016 namespace clang::tidy::misc {
0017
0018 /// This check warns on variables which could be declared const but are not.
0019 ///
0020 /// For the user-facing documentation see:
0021 /// http://clang.llvm.org/extra/clang-tidy/checks/misc/const-correctness.html
0022 class ConstCorrectnessCheck : public ClangTidyCheck {
0023 public:
0024   ConstCorrectnessCheck(StringRef Name, ClangTidyContext *Context);
0025
0026   // The rules for C and 'const' are different and incompatible for this check.
0027   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
0028     return LangOpts.CPlusPlus;
0029   }
0030   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
0031   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0032   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0033
0034 private:
0035   void registerScope(const Stmt *LocalScope, ASTContext *Context);
0036
0037   using MutationAnalyzer = std::unique_ptr<ExprMutationAnalyzer>;
0038   llvm::DenseMap<const Stmt *, MutationAnalyzer> ScopesCache;
0039   llvm::DenseSet<SourceLocation> TemplateDiagnosticsCache;
0040
0041   const bool AnalyzeValues;
0042   const bool AnalyzeReferences;
0043   const bool WarnPointersAsValues;
0044
0045   const bool TransformValues;
0046   const bool TransformReferences;
0047   const bool TransformPointersAsValues;
0048 };
0049
0050 } // namespace clang::tidy::misc
0051
0052 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_CONSTCORRECTNESSCHECK_H