etienneb updated this revision to Diff 56781.
etienneb marked 3 inline comments as done.
etienneb added a comment.
add unittests
http://reviews.llvm.org/D19941
Files:
include/clang/Tooling/Fixit.h
lib/Tooling/CMakeLists.txt
lib/Tooling/Fixit.cpp
unittests/Tooling/CMakeLists.txt
unittests/Tooling/FixitTest.cpp
Index: unittests/Tooling/FixitTest.cpp
===================================================================
--- /dev/null
+++ unittests/Tooling/FixitTest.cpp
@@ -0,0 +1,163 @@
+//===- unittest/Tooling/FixitTest.cpp ------------------------------------===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#include "TestVisitor.h"
+#include "clang/Basic/Diagnostic.h"
+#include "clang/Tooling/Fixit.h"
+
+using namespace clang;
+
+namespace {
+
+struct CallsVisitor : TestVisitor<CallsVisitor> {
+ bool VisitCallExpr(CallExpr *Expr) {
+ OnCall(Expr, Context);
+ return true;
+ }
+
+ std::function<void(CallExpr *, ASTContext *Context)> OnCall;
+};
+
+std::string LocationToString(SourceLocation Loc, ASTContext *Context) {
+ return Loc.printToString(Context->getSourceManager());
+}
+
+TEST(FixitTest, getText) {
+ CallsVisitor Visitor;
+
+ Visitor.OnCall = [&](CallExpr *CE, ASTContext *Context) {
+ EXPECT_EQ("foo(x, y)", tooling::fixit::getText(*CE, *Context));
+ EXPECT_EQ("foo(x, y)",
+ tooling::fixit::getText(CE->getSourceRange(), *Context));
+
+ Expr *P0 = CE->getArg(0);
+ Expr *P1 = CE->getArg(1);
+ EXPECT_EQ("x", tooling::fixit::getText(*P0, *Context));
+ EXPECT_EQ("y", tooling::fixit::getText(*P1, *Context));
+ };
+ Visitor.runOver("void foo(int x, int y) { foo(x, y); }");
+
+ Visitor.OnCall = [&](CallExpr *CE, ASTContext *Context) {
+ EXPECT_EQ("APPLY(foo, x, y)", tooling::fixit::getText(*CE, *Context));
+ };
+ Visitor.runOver("#define APPLY(f, x, y) f(x, y)\n"
+ "void foo(int x, int y) { APPLY(foo, x, y); }");
+}
+
+TEST(FixitTest, createRemoval) {
+ CallsVisitor Visitor;
+
+ Visitor.OnCall = [&](CallExpr *CE, ASTContext *Context) {
+ FixItHint Hint = tooling::fixit::createRemoval(*CE);
+ EXPECT_EQ("foo(x, y)",
+ tooling::fixit::getText(Hint.RemoveRange.getAsRange(), *Context));
+ EXPECT_TRUE(Hint.InsertFromRange.isInvalid());
+ EXPECT_TRUE(Hint.CodeToInsert.empty());
+
+ Expr *P0 = CE->getArg(0);
+ FixItHint Hint0 = tooling::fixit::createRemoval(*P0);
+ EXPECT_EQ(
+ "x", tooling::fixit::getText(Hint0.RemoveRange.getAsRange(), *Context));
+ EXPECT_TRUE(Hint0.InsertFromRange.isInvalid());
+ EXPECT_TRUE(Hint0.CodeToInsert.empty());
+
+ Expr *P1 = CE->getArg(1);
+ FixItHint Hint1 = tooling::fixit::createRemoval(*P1);
+ EXPECT_EQ(
+ "y", tooling::fixit::getText(Hint1.RemoveRange.getAsRange(), *Context));
+ EXPECT_TRUE(Hint1.InsertFromRange.isInvalid());
+ EXPECT_TRUE(Hint1.CodeToInsert.empty());
+ };
+ Visitor.runOver("void foo(int x, int y) { foo(x, y); }");
+}
+
+TEST(FixitTest, createRemovalWithMacro) {
+ CallsVisitor Visitor;
+
+ Visitor.OnCall = [&](CallExpr *CE, ASTContext *Context) {
+ FixItHint Hint = tooling::fixit::createRemoval(*CE);
+ EXPECT_EQ("FOO",
+ tooling::fixit::getText(Hint.RemoveRange.getAsRange(), *Context));
+ EXPECT_TRUE(Hint.InsertFromRange.isInvalid());
+ EXPECT_TRUE(Hint.CodeToInsert.empty());
+
+ Expr *P0 = CE->getArg(0);
+ FixItHint Hint0 = tooling::fixit::createRemoval(*P0);
+ EXPECT_EQ("input.cc:2:26 <Spelling=input.cc:1:17>",
+ LocationToString(Hint0.RemoveRange.getBegin(), Context));
+ EXPECT_EQ("input.cc:2:26 <Spelling=input.cc:1:17>",
+ LocationToString(Hint0.RemoveRange.getEnd(), Context));
+ EXPECT_TRUE(Hint0.InsertFromRange.isInvalid());
+ EXPECT_TRUE(Hint0.CodeToInsert.empty());
+
+ Expr *P1 = CE->getArg(1);
+ FixItHint Hint1 = tooling::fixit::createRemoval(*P1);
+ EXPECT_EQ("input.cc:2:26 <Spelling=input.cc:1:20>",
+ LocationToString(Hint1.RemoveRange.getBegin(), Context));
+ EXPECT_EQ("input.cc:2:26 <Spelling=input.cc:1:20>",
+ LocationToString(Hint1.RemoveRange.getEnd(), Context));
+ EXPECT_TRUE(Hint1.InsertFromRange.isInvalid());
+ EXPECT_TRUE(Hint1.CodeToInsert.empty());
+ };
+ Visitor.runOver("#define FOO foo(1, 1)\n"
+ "void foo(int x, int y) { FOO; }");
+}
+
+TEST(FixitTest, createReplacement) {
+ CallsVisitor Visitor;
+
+ Visitor.OnCall = [&](CallExpr *CE, ASTContext *Context) {
+ Expr *P0 = CE->getArg(0);
+ Expr *P1 = CE->getArg(1);
+ FixItHint Hint0 = tooling::fixit::createReplacement(*P0, *P1, *Context);
+ FixItHint Hint1 = tooling::fixit::createReplacement(*P1, *P0, *Context);
+
+ // Validate Hint0 fields.
+ EXPECT_EQ(
+ "x", tooling::fixit::getText(Hint0.RemoveRange.getAsRange(), *Context));
+ EXPECT_TRUE(Hint0.InsertFromRange.isInvalid());
+ EXPECT_EQ(Hint0.CodeToInsert, "y");
+
+ // Validate Hint1 fields.
+ EXPECT_EQ(
+ "y", tooling::fixit::getText(Hint1.RemoveRange.getAsRange(), *Context));
+ EXPECT_TRUE(Hint1.InsertFromRange.isInvalid());
+ EXPECT_EQ(Hint1.CodeToInsert, "x");
+ };
+
+ Visitor.runOver("void foo(int x, int y) { foo(x, y); }");
+
+ Visitor.runOver("#define APPLY(f, x, y) f(x, y)\n"
+ "void foo(int x, int y) { APPLY(foo, x, y); }");
+
+ Visitor.runOver("#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");
+}
+
+TEST(FixitTest, createReplacementWithMacro) {
+ CallsVisitor Visitor;
+
+ Visitor.OnCall = [&](CallExpr *CE, ASTContext *Context) {
+ Expr *P0 = CE->getArg(0);
+ Expr *P1 = CE->getArg(1);
+ FixItHint Hint = tooling::fixit::createReplacement(*P0, *P1, *Context);
+ EXPECT_EQ("input.cc:2:26 <Spelling=input.cc:1:17>",
+ LocationToString(Hint.RemoveRange.getBegin(), Context));
+ EXPECT_EQ("input.cc:2:26 <Spelling=input.cc:1:17>",
+ LocationToString(Hint.RemoveRange.getEnd(), Context));
+ EXPECT_TRUE(Hint.InsertFromRange.isInvalid());
+ EXPECT_TRUE(Hint.CodeToInsert.empty());
+ };
+
+ Visitor.runOver("#define FOO foo(1, 1)\n"
+ "void foo(int x, int y) { FOO; }");
+}
+
+} // end anonymous namespace
Index: unittests/Tooling/CMakeLists.txt
===================================================================
--- unittests/Tooling/CMakeLists.txt
+++ unittests/Tooling/CMakeLists.txt
@@ -12,18 +12,19 @@
add_clang_unittest(ToolingTests
CommentHandlerTest.cpp
CompilationDatabaseTest.cpp
+ FixitTest.cpp
LookupTest.cpp
- ToolingTest.cpp
+ QualTypeNamesTest.cpp
RecursiveASTVisitorTest.cpp
RecursiveASTVisitorTestCallVisitor.cpp
RecursiveASTVisitorTestDeclVisitor.cpp
RecursiveASTVisitorTestExprVisitor.cpp
RecursiveASTVisitorTestTypeLocVisitor.cpp
- RefactoringTest.cpp
- RewriterTest.cpp
RefactoringCallbacksTest.cpp
+ RefactoringTest.cpp
ReplacementsYamlTest.cpp
- QualTypeNamesTest.cpp
+ RewriterTest.cpp
+ ToolingTest.cpp
)
target_link_libraries(ToolingTests
Index: lib/Tooling/Fixit.cpp
===================================================================
--- /dev/null
+++ lib/Tooling/Fixit.cpp
@@ -0,0 +1,31 @@
+//===--- FixIt.cpp - FixIt Hint utilities -----------------------*- C++ -*-===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// This file contains implementations of utitilies to ease source code rewriting
+// by providing helper functions related to FixItHint.
+//
+//===----------------------------------------------------------------------===//
+#include "clang/Tooling/Fixit.h"
+#include "clang/Lex/Lexer.h"
+
+namespace clang {
+namespace tooling {
+namespace fixit {
+
+namespace internal {
+StringRef getText(SourceRange Range, const ASTContext &Context) {
+ return Lexer::getSourceText(CharSourceRange::getTokenRange(Range),
+ Context.getSourceManager(),
+ Context.getLangOpts());
+}
+} // end namespace internal
+
+} // end namespace fixit
+} // end namespace tooling
+} // end namespace clang
Index: lib/Tooling/CMakeLists.txt
===================================================================
--- lib/Tooling/CMakeLists.txt
+++ lib/Tooling/CMakeLists.txt
@@ -7,6 +7,7 @@
CommonOptionsParser.cpp
CompilationDatabase.cpp
FileMatchTrie.cpp
+ Fixit.cpp
JSONCompilationDatabase.cpp
Refactoring.cpp
RefactoringCallbacks.cpp
Index: include/clang/Tooling/Fixit.h
===================================================================
--- /dev/null
+++ include/clang/Tooling/Fixit.h
@@ -0,0 +1,72 @@
+//===--- FixIt.h - FixIt Hint utilities -------------------------*- C++ -*-===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// This file implements functions to ease source rewriting from AST-nodes.
+//
+// Example swapping A and B expressions:
+//
+// Expr *A, *B;
+// tooling::fixit::createReplacement(*A, *B);
+// tooling::fixit::createReplacement(*B, *A);
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_CLANG_TOOLING_FIXIT_H
+#define LLVM_CLANG_TOOLING_FIXIT_H
+
+#include "clang/AST/ASTContext.h"
+
+namespace clang {
+namespace tooling {
+namespace fixit {
+
+namespace internal {
+StringRef getText(SourceRange Range, const ASTContext &Context);
+
+/// \brief Returns the SourceRange of a SourceRange. This identity function is
+/// used by the following template abstractions.
+inline SourceRange getSourceRange(const SourceRange &Range) { return Range; }
+
+/// \brief Returns the SourceRange of the token at Location \p Loc.
+inline SourceRange getSourceRange(const SourceLocation &Loc) {
+ return SourceRange(Loc);
+}
+
+/// \brief Returns the SourceRange of an given Node. \p Node is typically a
+/// 'Stmt', 'Expr' or a 'Decl'.
+template <typename T> SourceRange getSourceRange(const T &Node) {
+ return Node.getSourceRange();
+}
+} // end namespace internal
+
+// \brief Returns a textual representation of \p Node.
+template <typename T>
+StringRef getText(const T &Node, const ASTContext &Context) {
+ return internal::getText(internal::getSourceRange(Node), Context);
+}
+
+// \brief Returns a FixItHint to remove \p Node.
+// TODO: Add support for related syntactical elements (i.e. comments, ...).
+template <typename T> FixItHint createRemoval(const T &Node) {
+ return FixItHint::CreateRemoval(internal::getSourceRange(Node));
+}
+
+// \brief Returns a FixItHint to replace \p Destination by \p Source.
+template <typename D, typename S>
+FixItHint createReplacement(const D &Destination, const S &Source,
+ const ASTContext &Context) {
+ return FixItHint::CreateReplacement(internal::getSourceRange(Destination),
+ getText(Source, Context));
+}
+
+} // end namespace fixit
+} // end namespace tooling
+} // end namespace clang
+
+#endif // LLVM_CLANG_TOOLING_FIXINT_H
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
