Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
cb748c3
[clang-tidy] Add modernize-use-span-first-last check
hjanuschka Nov 29, 2024
ec5a6b0
format
hjanuschka Nov 29, 2024
5cf1b7c
format
hjanuschka Nov 29, 2024
b357f8c
format
hjanuschka Nov 29, 2024
42d1df2
format
hjanuschka Nov 29, 2024
04f3edc
format
hjanuschka Nov 29, 2024
2f9cc3e
format
hjanuschka Nov 29, 2024
24690e3
up
hjanuschka Nov 29, 2024
39833d4
up
hjanuschka Nov 29, 2024
964fadc
format
hjanuschka Nov 29, 2024
79afa9e
format
hjanuschka Nov 29, 2024
31d300f
format
hjanuschka Nov 29, 2024
c7fd4d5
format
hjanuschka Nov 29, 2024
4a9fc6e
Update clang-tools-extra/clang-tidy/readability/UseSpanFirstLastCheck…
hjanuschka Dec 2, 2024
3f604e5
Update clang-tools-extra/clang-tidy/readability/UseSpanFirstLastCheck.h
hjanuschka Dec 2, 2024
7e2aaa4
feed
hjanuschka Dec 2, 2024
b2e82cf
Merge branch 'subspan' of github.com:hjanuschka/llvm-project into sub…
hjanuschka Dec 2, 2024
c707971
up
hjanuschka Dec 2, 2024
cd2fce3
feedback
hjanuschka Dec 2, 2024
72610ac
feedback
hjanuschka Dec 2, 2024
b565ef7
feedback
hjanuschka Dec 2, 2024
3e9b0c6
feedback
hjanuschka Dec 3, 2024
2c65d52
feedback
hjanuschka Dec 3, 2024
8c16f74
up
hjanuschka Dec 4, 2024
514ac50
up
hjanuschka Dec 5, 2024
86b467b
up
hjanuschka Dec 5, 2024
6ab0051
up
hjanuschka Dec 5, 2024
39da599
up
hjanuschka Dec 11, 2024
8ba6771
feedback
hjanuschka Dec 11, 2024
79702fb
feedback
hjanuschka Dec 11, 2024
0a1d6cb
feedback
hjanuschka Dec 14, 2024
3354841
feedback
hjanuschka Dec 14, 2024
1fc1375
feedback
hjanuschka Dec 20, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
145 changes: 57 additions & 88 deletions clang-tools-extra/clang-tidy/readability/UseSpanFirstLastCheck.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -18,108 +18,77 @@ using namespace clang::ast_matchers;
namespace clang::tidy::readability {

void UseSpanFirstLastCheck::registerMatchers(MatchFinder *Finder) {
// Match span::subspan calls
const auto HasSpanType =
hasType(hasUnqualifiedDesugaredType(recordType(hasDeclaration(
classTemplateSpecializationDecl(hasName("::std::span"))))));

Finder->addMatcher(cxxMemberCallExpr(callee(memberExpr(hasDeclaration(
cxxMethodDecl(hasName("subspan"))))),
on(expr(HasSpanType)))
.bind("subspan"),
this);
// Match span.subspan(0, n) -> first(n)
Finder->addMatcher(
cxxMemberCallExpr(
callee(memberExpr(hasDeclaration(cxxMethodDecl(hasName("subspan"))))),
on(expr(HasSpanType).bind("span_object")),
hasArgument(0, integerLiteral(equals(0))),
hasArgument(1, expr().bind("count")), argumentCountIs(2))
.bind("first_subspan"),
this);

// Match span.subspan(size() - n) -> last(n)
const auto SizeCall = cxxMemberCallExpr(
callee(memberExpr(hasDeclaration(cxxMethodDecl(hasName("size"))))));

Finder->addMatcher(
cxxMemberCallExpr(
callee(memberExpr(hasDeclaration(cxxMethodDecl(hasName("subspan"))))),
on(expr(HasSpanType).bind("span_object")),
hasArgument(0, binaryOperator(hasOperatorName("-"), hasLHS(SizeCall),
hasRHS(expr().bind("count")))),
argumentCountIs(1))
.bind("last_subspan"),
this);
}

void UseSpanFirstLastCheck::check(const MatchFinder::MatchResult &Result) {
const auto *Call = Result.Nodes.getNodeAs<CXXMemberCallExpr>("subspan");
if (!Call)
const auto *SpanObj = Result.Nodes.getNodeAs<Expr>("span_object");
if (!SpanObj)
return;

handleSubspanCall(Result, Call);
}
StringRef SpanText = Lexer::getSourceText(
CharSourceRange::getTokenRange(SpanObj->getSourceRange()),
*Result.SourceManager, Result.Context->getLangOpts());

void UseSpanFirstLastCheck::handleSubspanCall(
const MatchFinder::MatchResult &Result, const CXXMemberCallExpr *Call) {
unsigned NumArgs = Call->getNumArgs();
if (NumArgs == 0 || NumArgs > 2)
return;
if (const auto *FirstCall =
Result.Nodes.getNodeAs<CXXMemberCallExpr>("first_subspan")) {
const auto *Count = Result.Nodes.getNodeAs<Expr>("count");
if (!Count)
return;

const Expr *Offset = Call->getArg(0);
const Expr *Count = NumArgs > 1 ? Call->getArg(1) : nullptr;
auto &Context = *Result.Context;

class SubspanVisitor : public RecursiveASTVisitor<SubspanVisitor> {
public:
SubspanVisitor(const ASTContext &Context) : Context(Context) {}

TraversalKind getTraversalKind() const {
return TK_IgnoreUnlessSpelledInSource;
}

bool VisitIntegerLiteral(IntegerLiteral *IL) {
if (IL->getValue() == 0)
IsZeroOffset = true;
return true;
}

bool VisitBinaryOperator(BinaryOperator *BO) {
if (BO->getOpcode() == BO_Sub) {
if (const auto *SizeCall = dyn_cast<CXXMemberCallExpr>(BO->getLHS())) {
if (SizeCall->getMethodDecl()->getName() == "size") {
IsSizeMinusN = true;
SizeMinusArg = BO->getRHS();
}
}
}
return true;
}

bool IsZeroOffset = false;
bool IsSizeMinusN = false;
const Expr *SizeMinusArg = nullptr;

private:
const ASTContext &Context;
};

SubspanVisitor Visitor(Context);
Visitor.TraverseStmt(const_cast<Expr *>(Offset->IgnoreImpCasts()));

// Build replacement text
std::string Replacement;
if (Visitor.IsZeroOffset && Count) {
// subspan(0, count) -> first(count)
const StringRef CountStr = Lexer::getSourceText(
StringRef CountText = Lexer::getSourceText(
CharSourceRange::getTokenRange(Count->getSourceRange()),
Context.getSourceManager(), Context.getLangOpts());
const auto *Base =
cast<CXXMemberCallExpr>(Call)->getImplicitObjectArgument();
const StringRef BaseStr = Lexer::getSourceText(
CharSourceRange::getTokenRange(Base->getSourceRange()),
Context.getSourceManager(), Context.getLangOpts());
Replacement = BaseStr.str() + ".first(" + CountStr.str() + ")";
} else if (Visitor.IsSizeMinusN && Visitor.SizeMinusArg) {
// subspan(size() - n) -> last(n)
const StringRef ArgStr = Lexer::getSourceText(
CharSourceRange::getTokenRange(Visitor.SizeMinusArg->getSourceRange()),
Context.getSourceManager(), Context.getLangOpts());
const auto *Base =
cast<CXXMemberCallExpr>(Call)->getImplicitObjectArgument();
const StringRef BaseStr = Lexer::getSourceText(
CharSourceRange::getTokenRange(Base->getSourceRange()),
Context.getSourceManager(), Context.getLangOpts());
Replacement = BaseStr.str() + ".last(" + ArgStr.str() + ")";
*Result.SourceManager, Result.Context->getLangOpts());

std::string Replacement =
SpanText.str() + ".first(" + CountText.str() + ")";

diag(FirstCall->getBeginLoc(), "prefer 'span::first()' over 'subspan()'")
<< FixItHint::CreateReplacement(FirstCall->getSourceRange(),
Replacement);
}

if (!Replacement.empty()) {
if (Visitor.IsZeroOffset && Count) {
diag(Call->getBeginLoc(), "prefer 'span::first()' over 'subspan()'")
<< FixItHint::CreateReplacement(Call->getSourceRange(), Replacement);
} else {
diag(Call->getBeginLoc(), "prefer 'span::last()' over 'subspan()'")
<< FixItHint::CreateReplacement(Call->getSourceRange(), Replacement);
}
if (const auto *LastCall =
Result.Nodes.getNodeAs<CXXMemberCallExpr>("last_subspan")) {
const auto *Count = Result.Nodes.getNodeAs<Expr>("count");
if (!Count)
return;

StringRef CountText = Lexer::getSourceText(
CharSourceRange::getTokenRange(Count->getSourceRange()),
*Result.SourceManager, Result.Context->getLangOpts());

std::string Replacement = SpanText.str() + ".last(" + CountText.str() + ")";

diag(LastCall->getBeginLoc(), "prefer 'span::last()' over 'subspan()'")
<< FixItHint::CreateReplacement(LastCall->getSourceRange(),
Replacement);
}
}

} // namespace clang::tidy::readability
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,6 @@ class UseSpanFirstLastCheck : public ClangTidyCheck {
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
return LangOpts.CPlusPlus20;
}

private:
void handleSubspanCall(const ast_matchers::MatchFinder::MatchResult &Result,
const CXXMemberCallExpr *Call);
};

} // namespace clang::tidy::readability
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,10 @@ void testTemplate() {

auto sub4 = s.subspan(1, 2); // No warning
auto sub5 = s.subspan(2); // No warning

auto complex = s.subspan(0 + (s.size() - 2), 3); // No warning

auto complex2 = s.subspan(100 + (s.size() - 2)); // No warning
}

// Test instantiation
Expand Down