blob: b628bf4f4a0f1fb025a93881c27b85e089f0bec7 [file] [log] [blame]
//===--- VirtualNearMissCheck.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"
#include "llvm/ADT/DenseMap.h"
namespace clang {
namespace tidy {
namespace bugprone {
/// Checks for near miss of virtual methods.
/// For a method in a derived class, this check looks for virtual method with a
/// very similar name and an identical signature defined in a base class.
/// For the user-facing documentation see:
class VirtualNearMissCheck : public ClangTidyCheck {
VirtualNearMissCheck(StringRef Name, ClangTidyContext *Context)
: ClangTidyCheck(Name, Context) {}
void registerMatchers(ast_matchers::MatchFinder *Finder) override;
void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
/// Check if the given method is possible to be overridden by some other
/// method. Operators and destructors are excluded.
/// Results are memoized in PossibleMap.
bool isPossibleToBeOverridden(const CXXMethodDecl *BaseMD);
/// Check if the given base method is overridden by some methods in the given
/// derived class.
/// Results are memoized in OverriddenMap.
bool isOverriddenByDerivedClass(const CXXMethodDecl *BaseMD,
const CXXRecordDecl *DerivedRD);
/// Key: the unique ID of a method.
/// Value: whether the method is possible to be overridden.
llvm::DenseMap<const CXXMethodDecl *, bool> PossibleMap;
/// Key: <unique ID of base method, name of derived class>
/// Value: whether the base method is overridden by some method in the derived
/// class.
llvm::DenseMap<std::pair<const CXXMethodDecl *, const CXXRecordDecl *>, bool>
const unsigned EditDistanceThreshold = 1;
} // namespace bugprone
} // namespace tidy
} // namespace clang