xref: /llvm-project/clang-tools-extra/clang-tidy/readability/MisplacedArrayIndexCheck.cpp (revision 2946cd701067404b99c39fb29dc9c74bd7193eb3)
1 //===--- MisplacedArrayIndexCheck.cpp - clang-tidy-------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "MisplacedArrayIndexCheck.h"
10 #include "clang/AST/ASTContext.h"
11 #include "clang/ASTMatchers/ASTMatchFinder.h"
12 #include "clang/Lex/Lexer.h"
13 #include "clang/Tooling/FixIt.h"
14 
15 using namespace clang::ast_matchers;
16 
17 namespace clang {
18 namespace tidy {
19 namespace readability {
20 
21 void MisplacedArrayIndexCheck::registerMatchers(MatchFinder *Finder) {
22   Finder->addMatcher(arraySubscriptExpr(hasLHS(hasType(isInteger())),
23                                         hasRHS(hasType(isAnyPointer())))
24                          .bind("expr"),
25                      this);
26 }
27 
28 void MisplacedArrayIndexCheck::check(const MatchFinder::MatchResult &Result) {
29   const auto *ArraySubscriptE =
30       Result.Nodes.getNodeAs<ArraySubscriptExpr>("expr");
31 
32   auto Diag = diag(ArraySubscriptE->getBeginLoc(), "confusing array subscript "
33                                                    "expression, usually the "
34                                                    "index is inside the []");
35 
36   // Only try to fixit when LHS and RHS can be swapped directly without changing
37   // the logic.
38   const Expr *RHSE = ArraySubscriptE->getRHS()->IgnoreParenImpCasts();
39   if (!isa<StringLiteral>(RHSE) && !isa<DeclRefExpr>(RHSE) &&
40       !isa<MemberExpr>(RHSE))
41     return;
42 
43   const StringRef LText = tooling::fixit::getText(
44       ArraySubscriptE->getLHS()->getSourceRange(), *Result.Context);
45   const StringRef RText = tooling::fixit::getText(
46       ArraySubscriptE->getRHS()->getSourceRange(), *Result.Context);
47 
48   Diag << FixItHint::CreateReplacement(
49       ArraySubscriptE->getLHS()->getSourceRange(), RText);
50   Diag << FixItHint::CreateReplacement(
51       ArraySubscriptE->getRHS()->getSourceRange(), LText);
52 }
53 
54 } // namespace readability
55 } // namespace tidy
56 } // namespace clang
57