clang-tools 6.0.0

NonConstParameterCheck.h
Go to the documentation of this file.
1 //===--- NonConstParameterCheck.h - clang-tidy-------------------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9
10 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_NON_CONST_PARAMETER_H
11 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_NON_CONST_PARAMETER_H
12
13 #include "../ClangTidy.h"
14
15 namespace clang {
16 namespace tidy {
17 namespace readability {
18
19 /// Warn when a pointer function parameter can be const.
20 ///
21 /// For the user-facing documentation see:
22 /// http://clang.llvm.org/extra/clang-tidy/checks/readability-non-const-parameter.html
23 class NonConstParameterCheck : public ClangTidyCheck {
24 public:
25 NonConstParameterCheck(StringRef Name, ClangTidyContext *Context)
26 : ClangTidyCheck(Name, Context) {}
27 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
28 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
29 void onEndOfTranslationUnit() override;
30
31 private:
32 /// Parameter info.
33 struct ParmInfo {
34 /// Is function parameter referenced?
35 bool IsReferenced;
36
37 /// Can function parameter be const?
38 bool CanBeConst;
39 };
40
41 /// Track all nonconst integer/float parameters.
42 std::map<const ParmVarDecl *, ParmInfo> Parameters;
43
44 /// Add function parameter.
45 void addParm(const ParmVarDecl *Parm);
46
47 /// Set IsReferenced.
48 void setReferenced(const DeclRefExpr *Ref);
49
50 /// Set CanNotBeConst.
51 /// Visits sub expressions recursively. If a DeclRefExpr is found
52 /// and CanNotBeConst is true the Parameter is marked as not-const.
53 /// The CanNotBeConst is updated as sub expressions are visited.
54 void markCanNotBeConst(const Expr *E, bool CanNotBeConst);
55
56 /// Diagnose non const parameters.
57 void diagnoseNonConstParameters();
58 };
59
60 } // namespace readability
61 } // namespace tidy
62 } // namespace clang
63
64 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_NON_CONST_PARAMETER_H
clang::tidy::readability::NonConstParameterCheck::NonConstParameterCheck
NonConstParameterCheck(StringRef Name, ClangTidyContext *Context)
Definition: NonConstParameterCheck.h:25
Name
StringHandle Name
Definition: PreprocessorTracker.cpp:525
clang::tidy::readability::NonConstParameterCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: NonConstParameterCheck.cpp:20
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidy.h:127
clang::tidy::readability::NonConstParameterCheck::onEndOfTranslationUnit
void onEndOfTranslationUnit() override
Definition: NonConstParameterCheck.cpp:124
clang::tidy::readability::NonConstParameterCheck
Warn when a pointer function parameter can be const.
Definition: NonConstParameterCheck.h:23
clang
Definition: AndroidTidyModule.cpp:28
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:104
clang::tidy::readability::NonConstParameterCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: NonConstParameterCheck.cpp:41