blob: 39959e619096017b8dfcc2900a2b43c9e511bec0 [file] [log] [blame]
//===--- NonConstParameterCheck.h - clang-tidy-------------------*- C++ -*-===//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#include "../ClangTidyCheck.h"
namespace clang {
namespace tidy {
namespace readability {
/// Warn when a pointer function parameter can be const.
/// For the user-facing documentation see:
class NonConstParameterCheck : public ClangTidyCheck {
NonConstParameterCheck(StringRef Name, ClangTidyContext *Context)
: ClangTidyCheck(Name, Context) {}
void registerMatchers(ast_matchers::MatchFinder *Finder) override;
void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
void onEndOfTranslationUnit() override;
/// Parameter info.
struct ParmInfo {
/// Is function parameter referenced?
bool IsReferenced;
/// Can function parameter be const?
bool CanBeConst;
/// Track all nonconst integer/float parameters.
std::map<const ParmVarDecl *, ParmInfo> Parameters;
/// Add function parameter.
void addParm(const ParmVarDecl *Parm);
/// Set IsReferenced.
void setReferenced(const DeclRefExpr *Ref);
/// Set CanNotBeConst.
/// Visits sub expressions recursively. If a DeclRefExpr is found
/// and CanNotBeConst is true the Parameter is marked as not-const.
/// The CanNotBeConst is updated as sub expressions are visited.
void markCanNotBeConst(const Expr *E, bool CanNotBeConst);
/// Diagnose non const parameters.
void diagnoseNonConstParameters();
} // namespace readability
} // namespace tidy
} // namespace clang