[IDE] Add swift-refactor option to output as plain text

Current modes are:
  1. output the whole rewritten buffer, with RUN and CHECK lines removed
  2. output each replacement in JSON

To make each refactoring (rather than the whole file) easier to test,
add a plain text output option that can be easily checked with
FileCheck.

Author: bnbarham

include/swift/IDE/Utils.h

@@ -547,6 +547,7 @@ class EditorConsumerInsertStream: public raw_ostream {
   }
 };
 
+/// Outputs replacements as JSON, see `writeEditsInJson`
 class SourceEditJsonConsumer : public SourceEditConsumer {
   struct Implementation;
   Implementation &Impl;
@@ -556,6 +557,25 @@ class SourceEditJsonConsumer : public SourceEditConsumer {
   void accept(SourceManager &SM, RegionType RegionType, ArrayRef<Replacement> Replacements) override;
 };
 
+/// Outputs replacements to `OS` in the form
+/// ```
+/// // </path/to/file> [startLine:startCol, endLine:endCol)
+/// text
+/// to
+/// replace
+///
+/// ```
+class SourceEditTextConsumer : public SourceEditConsumer {
+  llvm::raw_ostream &OS;
+
+public:
+  SourceEditTextConsumer(llvm::raw_ostream &OS);
+
+  void accept(SourceManager &SM, RegionType RegionType,
+              ArrayRef<Replacement> Replacements) override;
+};
+
+/// Outputs the rewritten buffer to `OS` with RUN and CHECK lines removed
 class SourceEditOutputConsumer : public SourceEditConsumer {
   struct Implementation;
   Implementation &Impl;

lib/IDE/Utils.cpp

@@ -1018,6 +1018,26 @@ accept(SourceManager &SM, RegionType Type, ArrayRef<Replacement> Replacements) {
     Impl.accept(SM, Replacement.Range, Replacement.Text);
   }
 }
+
+swift::ide::SourceEditTextConsumer::
+SourceEditTextConsumer(llvm::raw_ostream &OS) : OS(OS) { }
+
+void swift::ide::SourceEditTextConsumer::
+accept(SourceManager &SM, RegionType Type, ArrayRef<Replacement> Replacements) {
+  for (const auto &Replacement: Replacements) {
+    CharSourceRange Range = Replacement.Range;
+    unsigned BufID = SM.findBufferContainingLoc(Range.getStart());
+    auto Path(SM.getIdentifierForBuffer(BufID));
+    auto Start = SM.getLineAndColumnInBuffer(Range.getStart());
+    auto End = SM.getLineAndColumnInBuffer(Range.getEnd());
+
+    OS << "// " << Path.str() << " ";
+    OS << "[" << Start.first << ":" << Start.second << ", ";
+    OS << End.first << ":" << End.second << ")\n";
+    OS << Replacement.Text << "\n";
+  }
+}
+
 namespace {
 class ClangFileRewriterHelper {
   unsigned InterestedId;

tools/swift-refactor/swift-refactor.cpp

@@ -112,10 +112,21 @@ static llvm::cl::opt<bool>
 IsNonProtocolType("is-non-protocol-type",
                   llvm::cl::desc("The symbol being renamed is a type and not a protocol"));
 
-static llvm::cl::opt<bool>
-DumpInJson("dump-json",
-            llvm::cl::desc("Whether to dump refactoring edits in json"),
-            llvm::cl::init(false));
+enum class DumpType {
+  REWRITTEN,
+  JSON,
+  TEXT
+};
+static llvm::cl::opt<DumpType> DumpIn(
+    llvm::cl::desc("Dump edits to stdout as:"),
+    llvm::cl::init(DumpType::REWRITTEN),
+    llvm::cl::values(
+        clEnumValN(DumpType::REWRITTEN, "dump-rewritten",
+                   "rewritten file"),
+        clEnumValN(DumpType::JSON, "dump-json",
+                   "JSON"),
+        clEnumValN(DumpType::TEXT, "dump-text",
+                   "text")));
 
 static llvm::cl::opt<bool>
 AvailableActions("actions",
@@ -373,12 +384,19 @@ int main(int argc, char *argv[]) {
   RefactoringConfig.PreferredName = options::NewName;
   std::string Error;
   std::unique_ptr<SourceEditConsumer> pConsumer;
-  if (options::DumpInJson)
-    pConsumer.reset(new SourceEditJsonConsumer(llvm::outs()));
-  else
+  switch (options::DumpIn) {
+  case options::DumpType::REWRITTEN:
     pConsumer.reset(new SourceEditOutputConsumer(SF->getASTContext().SourceMgr,
-                                                      BufferID,
-                                                      llvm::outs()));
+                                                 BufferID,
+                                                 llvm::outs()));
+    break;
+  case options::DumpType::JSON:
+    pConsumer.reset(new SourceEditJsonConsumer(llvm::outs()));
+    break;
+  case options::DumpType::TEXT:
+    pConsumer.reset(new SourceEditTextConsumer(llvm::outs()));
+    break;
+  }
 
   return refactorSwiftModule(CI.getMainModule(), RefactoringConfig, *pConsumer,
                              PrintDiags);