febd89cafe
This PR aims to expand the list of classes that are considered to be "strings" by `readability-string-compare` check. 1. Currently only `std::string;:compare` is checked, but `std::string_view` has a similar `compare` method. This PR enables checking of `std::string_view::compare` by default. 2. Some codebases use custom string-like classes that have public interfaces similar to `std::string` or `std::string_view`. Example: [TStringBase](https://github.com/yandex/yatool/blob/main/util/generic/strbase.h#L38), A new option, `readability-string-compare.StringClassNames`, is added to allow specifying a custom list of string-like classes. Related to, but does not solve #28396 (only adds support for custom string-like classes, not custom functions)
96 lines
3.6 KiB
C++
96 lines
3.6 KiB
C++
//===-- StringCompareCheck.cpp - clang-tidy--------------------------------===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "StringCompareCheck.h"
|
|
#include "../utils/OptionsUtils.h"
|
|
#include "clang/AST/ASTContext.h"
|
|
#include "clang/ASTMatchers/ASTMatchFinder.h"
|
|
#include "clang/ASTMatchers/ASTMatchers.h"
|
|
#include "clang/Tooling/FixIt.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
|
|
using namespace clang::ast_matchers;
|
|
namespace optutils = clang::tidy::utils::options;
|
|
|
|
namespace clang::tidy::readability {
|
|
|
|
static const StringRef CompareMessage = "do not use 'compare' to test equality "
|
|
"of strings; use the string equality "
|
|
"operator instead";
|
|
|
|
static const StringRef DefaultStringLikeClasses = "::std::basic_string;"
|
|
"::std::basic_string_view";
|
|
|
|
StringCompareCheck::StringCompareCheck(StringRef Name,
|
|
ClangTidyContext *Context)
|
|
: ClangTidyCheck(Name, Context),
|
|
StringLikeClasses(optutils::parseStringList(
|
|
Options.get("StringLikeClasses", DefaultStringLikeClasses))) {}
|
|
|
|
void StringCompareCheck::storeOptions(ClangTidyOptions::OptionMap &Opts) {
|
|
Options.store(Opts, "StringLikeClasses",
|
|
optutils::serializeStringList(StringLikeClasses));
|
|
}
|
|
|
|
void StringCompareCheck::registerMatchers(MatchFinder *Finder) {
|
|
if (StringLikeClasses.empty()) {
|
|
return;
|
|
}
|
|
const auto StrCompare = cxxMemberCallExpr(
|
|
callee(cxxMethodDecl(hasName("compare"), ofClass(cxxRecordDecl(hasAnyName(
|
|
StringLikeClasses))))),
|
|
hasArgument(0, expr().bind("str2")), argumentCountIs(1),
|
|
callee(memberExpr().bind("str1")));
|
|
|
|
// First and second case: cast str.compare(str) to boolean.
|
|
Finder->addMatcher(
|
|
traverse(TK_AsIs,
|
|
implicitCastExpr(hasImplicitDestinationType(booleanType()),
|
|
has(StrCompare))
|
|
.bind("match1")),
|
|
this);
|
|
|
|
// Third and fourth case: str.compare(str) == 0 and str.compare(str) != 0.
|
|
Finder->addMatcher(
|
|
binaryOperator(hasAnyOperatorName("==", "!="),
|
|
hasOperands(StrCompare.bind("compare"),
|
|
integerLiteral(equals(0)).bind("zero")))
|
|
.bind("match2"),
|
|
this);
|
|
}
|
|
|
|
void StringCompareCheck::check(const MatchFinder::MatchResult &Result) {
|
|
if (const auto *Matched = Result.Nodes.getNodeAs<Stmt>("match1")) {
|
|
diag(Matched->getBeginLoc(), CompareMessage);
|
|
return;
|
|
}
|
|
|
|
if (const auto *Matched = Result.Nodes.getNodeAs<Stmt>("match2")) {
|
|
const ASTContext &Ctx = *Result.Context;
|
|
|
|
if (const auto *Zero = Result.Nodes.getNodeAs<Stmt>("zero")) {
|
|
const auto *Str1 = Result.Nodes.getNodeAs<MemberExpr>("str1");
|
|
const auto *Str2 = Result.Nodes.getNodeAs<Stmt>("str2");
|
|
const auto *Compare = Result.Nodes.getNodeAs<Stmt>("compare");
|
|
|
|
auto Diag = diag(Matched->getBeginLoc(), CompareMessage);
|
|
|
|
if (Str1->isArrow())
|
|
Diag << FixItHint::CreateInsertion(Str1->getBeginLoc(), "*");
|
|
|
|
Diag << tooling::fixit::createReplacement(*Zero, *Str2, Ctx)
|
|
<< tooling::fixit::createReplacement(*Compare, *Str1->getBase(),
|
|
Ctx);
|
|
}
|
|
}
|
|
|
|
// FIXME: Add fixit to fix the code for case one and two (match1).
|
|
}
|
|
|
|
} // namespace clang::tidy::readability
|