blob: 3745c7bb4681139d92ad19165b6d3e7fdca45e94 [file] [log] [blame]
//===--- ForRangeCopyCheck.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 performance {
/// A check that detects copied loop variables and suggests using const
/// references.
/// For the user-facing documentation see:
class ForRangeCopyCheck : public ClangTidyCheck {
ForRangeCopyCheck(StringRef Name, ClangTidyContext *Context);
void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
void registerMatchers(ast_matchers::MatchFinder *Finder) override;
void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
// Checks if the loop variable is a const value and expensive to copy. If so
// suggests it be converted to a const reference.
bool handleConstValueCopy(const VarDecl &LoopVar, ASTContext &Context);
// Checks if the loop variable is a non-const value and whether only
// const methods are invoked on it or whether it is only used as a const
// reference argument. If so it suggests it be made a const reference.
bool handleCopyIsOnlyConstReferenced(const VarDecl &LoopVar,
const CXXForRangeStmt &ForRange,
ASTContext &Context);
const bool WarnOnAllAutoCopies;
const std::vector<std::string> AllowedTypes;
} // namespace performance
} // namespace tidy
} // namespace clang