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