aboutsummaryrefslogtreecommitdiff
path: root/clang/unittests/Tooling/FixItTest.cpp
blob: f556c249bb88861951df3f5bf2e689e1c78fc082 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
//===- unittest/Tooling/FixitTest.cpp ------------------------------------===//
//
// 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 "clang/Tooling/FixIt.h"
#include "clang/ASTMatchers/ASTMatchFinder.h"
#include "clang/ASTMatchers/ASTMatchers.h"
#include "clang/Testing/TestAST.h"
#include "gtest/gtest.h"

using namespace clang;

using tooling::fixit::getText;
using tooling::fixit::createRemoval;
using tooling::fixit::createReplacement;

namespace {

const CallExpr &onlyCall(ASTContext &Ctx) {
  using namespace ast_matchers;
  auto Calls = match(callExpr().bind(""), Ctx);
  EXPECT_EQ(Calls.size(), 1u);
  return *Calls.front().getNodeAs<CallExpr>("");
}

TEST(FixItTest, getText) {
  TestAST AST("void foo(int x, int y) { foo(x, y); }");
  const CallExpr &CE = onlyCall(AST.context());
  EXPECT_EQ("foo(x, y)", getText(CE, AST.context()));
  EXPECT_EQ("foo(x, y)", getText(CE.getSourceRange(), AST.context()));
  EXPECT_EQ("x", getText(*CE.getArg(0), AST.context()));
  EXPECT_EQ("y", getText(*CE.getArg(1), AST.context()));

  AST = TestAST("#define APPLY(f, x, y) f(x, y)\n"
                "void foo(int x, int y) { APPLY(foo, x, y); }");
  const CallExpr &CE2 = onlyCall(AST.context());
  EXPECT_EQ("APPLY(foo, x, y)", getText(CE2, AST.context()));
}

TEST(FixItTest, getTextWithMacro) {
  TestAST AST("#define F foo(\n"
              "#define OO x, y)\n"
              "void foo(int x, int y) { F OO ; }");
  const CallExpr &CE = onlyCall(AST.context());
  EXPECT_EQ("F OO", getText(CE, AST.context()));
  EXPECT_EQ("", getText(*CE.getArg(0), AST.context()));
  EXPECT_EQ("", getText(*CE.getArg(1), AST.context()));

  AST = TestAST("#define FOO(x, y) (void)x; (void)y; foo(x, y);\n"
                "void foo(int x, int y) { FOO(x,y) }");
  const CallExpr &CE2 = onlyCall(AST.context());
  EXPECT_EQ("", getText(CE2, AST.context()));
  EXPECT_EQ("x", getText(*CE2.getArg(0), AST.context()));
  EXPECT_EQ("y", getText(*CE2.getArg(1), AST.context()));
}

TEST(FixItTest, createRemoval) {
  TestAST AST("void foo(int x, int y) { foo(x, y); }");
  const CallExpr &CE = onlyCall(AST.context());

  FixItHint Hint = createRemoval(CE);
  EXPECT_EQ("foo(x, y)", getText(Hint.RemoveRange.getAsRange(), AST.context()));
  EXPECT_TRUE(Hint.InsertFromRange.isInvalid());
  EXPECT_TRUE(Hint.CodeToInsert.empty());

  FixItHint Hint0 = createRemoval(*CE.getArg(0));
  EXPECT_EQ("x", getText(Hint0.RemoveRange.getAsRange(), AST.context()));
  EXPECT_TRUE(Hint0.InsertFromRange.isInvalid());
  EXPECT_TRUE(Hint0.CodeToInsert.empty());

  FixItHint Hint1 = createRemoval(*CE.getArg(1));
  EXPECT_EQ("y", getText(Hint1.RemoveRange.getAsRange(), AST.context()));
  EXPECT_TRUE(Hint1.InsertFromRange.isInvalid());
  EXPECT_TRUE(Hint1.CodeToInsert.empty());

  AST = TestAST("void foo(int x, int y) { foo(x + y, y + x); }");
  const CallExpr &CE2 = onlyCall(AST.context());
  Hint0 = createRemoval(*CE2.getArg(0));
  EXPECT_EQ("x + y", getText(Hint0.RemoveRange.getAsRange(), AST.context()));

  Hint1 = createRemoval(*CE2.getArg(1));
  EXPECT_EQ("y + x", getText(Hint1.RemoveRange.getAsRange(), AST.context()));
}

TEST(FixItTest, createRemovalWithMacro) {
  TestAST AST("#define FOO foo(1, 1)\n"
              "void foo(int x, int y) { FOO; }");
  const CallExpr &CE = onlyCall(AST.context());
  FixItHint Hint = createRemoval(CE);
  EXPECT_EQ("FOO", getText(Hint.RemoveRange.getAsRange(), AST.context()));
  EXPECT_TRUE(Hint.InsertFromRange.isInvalid());
  EXPECT_TRUE(Hint.CodeToInsert.empty());

  FixItHint Hint0 = createRemoval(*CE.getArg(0));
  EXPECT_EQ("input.mm:2:26 <Spelling=input.mm:1:17>",
            Hint0.RemoveRange.getBegin().printToString(AST.sourceManager()));
  EXPECT_EQ("input.mm:2:26 <Spelling=input.mm:1:17>",
            Hint0.RemoveRange.getEnd().printToString(AST.sourceManager()));
  EXPECT_TRUE(Hint0.InsertFromRange.isInvalid());
  EXPECT_TRUE(Hint0.CodeToInsert.empty());

  FixItHint Hint1 = createRemoval(*CE.getArg(1));
  EXPECT_EQ("input.mm:2:26 <Spelling=input.mm:1:20>",
            Hint1.RemoveRange.getBegin().printToString(AST.sourceManager()));
  EXPECT_EQ("input.mm:2:26 <Spelling=input.mm:1:20>",
            Hint1.RemoveRange.getEnd().printToString(AST.sourceManager()));
  EXPECT_TRUE(Hint1.InsertFromRange.isInvalid());
  EXPECT_TRUE(Hint1.CodeToInsert.empty());

  AST = TestAST("#define FOO(x, y) (void)x; (void)y; foo(x, y);\n"
                "void foo(int x, int y) { FOO(x,y) }");
  const CallExpr &CE2 = onlyCall(AST.context());
  Hint = createRemoval(CE2);
  EXPECT_EQ("input.mm:2:26 <Spelling=input.mm:1:37>",
            Hint.RemoveRange.getBegin().printToString(AST.sourceManager()));
  EXPECT_EQ("input.mm:2:26 <Spelling=input.mm:1:45>",
            Hint.RemoveRange.getEnd().printToString(AST.sourceManager()));
  EXPECT_TRUE(Hint.InsertFromRange.isInvalid());
  EXPECT_TRUE(Hint.CodeToInsert.empty());
}

TEST(FixItTest, createReplacement) {
  for (const char *Code : {
           "void foo(int x, int y) { foo(x, y); }",

           "#define APPLY(f, x, y) f(x, y)\n"
           "void foo(int x, int y) { APPLY(foo, x, y); }",

           "#define APPLY(f, P) f(P)\n"
           "#define PAIR(x, y) x, y\n"
           "void foo(int x, int y) { APPLY(foo, PAIR(x, y)); }\n",
       }) {
    TestAST AST(Code);
    const CallExpr &CE = onlyCall(AST.context());
    const Expr *P0 = CE.getArg(0);
    const Expr *P1 = CE.getArg(1);
    FixItHint Hint0 = createReplacement(*P0, *P1, AST.context());
    FixItHint Hint1 = createReplacement(*P1, *P0, AST.context());

    // Validate Hint0 fields.
    EXPECT_EQ("x", getText(Hint0.RemoveRange.getAsRange(), AST.context()));
    EXPECT_TRUE(Hint0.InsertFromRange.isInvalid());
    EXPECT_EQ(Hint0.CodeToInsert, "y");

    // Validate Hint1 fields.
    EXPECT_EQ("y", getText(Hint1.RemoveRange.getAsRange(), AST.context()));
    EXPECT_TRUE(Hint1.InsertFromRange.isInvalid());
    EXPECT_EQ(Hint1.CodeToInsert, "x");
  }
}

TEST(FixItTest, createReplacementWithMacro) {
  TestAST AST("#define FOO foo(1, 1)\n"
              "void foo(int x, int y) { FOO; }");
  const CallExpr &CE = onlyCall(AST.context());
  FixItHint Hint =
      createReplacement(*CE.getArg(0), *CE.getArg(1), AST.context());
  EXPECT_EQ("input.mm:2:26 <Spelling=input.mm:1:17>",
            Hint.RemoveRange.getBegin().printToString(AST.sourceManager()));
  EXPECT_EQ("input.mm:2:26 <Spelling=input.mm:1:17>",
            Hint.RemoveRange.getEnd().printToString(AST.sourceManager()));
  EXPECT_TRUE(Hint.InsertFromRange.isInvalid());
  EXPECT_TRUE(Hint.CodeToInsert.empty());

  AST = TestAST("#define FOO(x, y) (void)x; (void)y; foo(x, y);\n"
                "void foo(int x, int y) { FOO(x,y) }");
  const CallExpr &CE2 = onlyCall(AST.context());
  Hint = createReplacement(*CE2.getArg(0), *CE2.getArg(1), AST.context());
  EXPECT_EQ("input.mm:2:26 <Spelling=input.mm:2:30>",
            Hint.RemoveRange.getEnd().printToString(AST.sourceManager()));
  EXPECT_EQ("input.mm:2:26 <Spelling=input.mm:2:30>",
            Hint.RemoveRange.getBegin().printToString(AST.sourceManager()));
  EXPECT_TRUE(Hint.InsertFromRange.isInvalid());
  EXPECT_EQ("y", Hint.CodeToInsert);

  AST = TestAST("void foo(int x, int y) { foo(x + y, y + x); }");
  const CallExpr &CE3 = onlyCall(AST.context());
  Hint = createReplacement(*CE3.getArg(0), *CE3.getArg(1), AST.context());
  EXPECT_EQ("x + y", getText(Hint.RemoveRange.getAsRange(), AST.context()));
  EXPECT_TRUE(Hint.InsertFromRange.isInvalid());
  EXPECT_EQ("y + x", Hint.CodeToInsert);
}

} // end anonymous namespace