Add dump() method for SourceRange

[hamzasood]

This seems like a reasonable addition. Maybe it could also provide print and printToString to more closely match the SourceLocation API?

[steveire]

Add dump() and supporting methods to SourceRange

[steveire]

Thanks, I've done that now.

[a_sidorin]

Hello Stephen,
These methods will be really useful.

lib/Basic/SourceLocation.cpp

90

I think we should print both locations on the same line, without adding a newline after the start SLoc.

92

print() shouldn't add a newline, it is up to dump() methods.

[rsmith]

lib/Basic/SourceLocation.cpp

89–93

It would seem somewhat more natural to dump SourceRanges the same way we dump them in -ast-dump. (That is: use angle brackets, no newline, and omit the file name / line number / column number on the end location if it's the same as on the start location.)

[steveire]

Add dump() and supporting methods to SourceRange

[steveire]

Add dump() and supporting methods to SourceRange

[steveire]

unittests/Basic/SourceManagerTest.cpp

189

I don't know how to resolve this TODO, and somehow test a range between two files.

include/clang/Basic/SourceLocation.h

public:
 
   bool operator==(const SourceRange &X) const {
     return B == X.B && E == X.E;
   }
 
   bool operator!=(const SourceRange &X) const {
     return B != X.B || E != X.E;
   }
+
+  void print(raw_ostream &OS, const SourceManager &SM) const;
+  std::string printToString(const SourceManager &SM) const;
+  void dump(const SourceManager &SM) const;
 };
 
 /// Represents a character-granular source range.
 ///
 /// The underlying SourceRange can either specify the starting/ending character
 /// of the range, or it can specify the start of the range and the start of the
 /// last token of the range (a "token range").  In the token range case, the
 /// size of the last token must be measured to determine the actual end of the

lib/Basic/SourceLocation.cpp

SourceLocation::printToString(const SourceManager &SM) const {
   return OS.str();
 }
 
 LLVM_DUMP_METHOD void SourceLocation::dump(const SourceManager &SM) const {
   print(llvm::errs(), SM);
   llvm::errs() << '\n';
 }
 
+LLVM_DUMP_METHOD void SourceRange::dump(const SourceManager &SM) const {
+  print(llvm::errs(), SM);
+  llvm::errs() << '\n';
+}
+
+static PresumedLoc printDifference(raw_ostream &OS, const SourceManager &SM, SourceLocation Loc, PresumedLoc Previous)
+{
+  if (Loc.isFileID()) {
+
+    PresumedLoc PLoc = SM.getPresumedLoc(Loc);
+
+    if (PLoc.isInvalid()) {
+      OS << "<invalid sloc>";
+      return Previous;
+    }
+
+    if (Previous.isInvalid() || strcmp(PLoc.getFilename(), Previous.getFilename()) != 0) {
+      OS << PLoc.getFilename() << ':' << PLoc.getLine()
+         << ':' << PLoc.getColumn();
+    } else if (Previous.isInvalid() || PLoc.getLine() != Previous.getLine()) {
+      OS << "line" << ':' << PLoc.getLine()
+         << ':' << PLoc.getColumn();
+    } else {
+      OS << "col" << ':' << PLoc.getColumn();
+    }
+    return PLoc;
+  }
+  auto printedLoc = printDifference(OS, SM, SM.getExpansionLoc(Loc), Previous);
+
+  OS << " <Spelling=";
+  printedLoc = printDifference(OS, SM, SM.getSpellingLoc(Loc), printedLoc);
+  OS << '>';
+  return printedLoc;
+}
+
+void SourceRange::print(raw_ostream &OS, const SourceManager &SM) const {
+
+  OS << '<';
+  auto printedLoc = printDifference(OS, SM, B, {});
+  if (B != E) {
+    OS << ", ";
+    printDifference(OS, SM, E, printedLoc);
+  }
+  OS << '>';
+}
+
+LLVM_DUMP_METHOD std::string
+SourceRange::printToString(const SourceManager &SM) const {
+  std::string S;
+  llvm::raw_string_ostream OS(S);
+  print(OS, SM);
+  return OS.str();
+}
+
 //===----------------------------------------------------------------------===//
 // FullSourceLoc
 //===----------------------------------------------------------------------===//
 
 FileID FullSourceLoc::getFileID() const {
   assert(isValid());
   return SrcMgr->getFileID(*this);
 }

unittests/Basic/SourceManagerTest.cpp

TEST_F(SourceManagerTest, getColumnNumber) {
   Invalid = false;
   SourceMgr.getColumnNumber(FileID(), 1, &Invalid);
   EXPECT_TRUE(Invalid);
 
   // Test with no invalid flag.
   EXPECT_EQ(1U, SourceMgr.getColumnNumber(MainFileID, 0, nullptr));
 }
 
+TEST_F(SourceManagerTest, locationPrintTest) {
+  const char *header =
+    "#define IDENTITY(x) x\n";
+
+  const char *Source =
+    "int x;\n"
+    "include \"test-header.h\"\n"
+    "IDENTITY(int y);\n"
+    "int z;";
+
+  std::unique_ptr<llvm::MemoryBuffer> HeaderBuf =
+      llvm::MemoryBuffer::getMemBuffer(header);
+  std::unique_ptr<llvm::MemoryBuffer> Buf =
+      llvm::MemoryBuffer::getMemBuffer(Source);
+
+  const FileEntry *sourceFile = FileMgr.getVirtualFile("/mainFile.cpp",
+                                                 Buf->getBufferSize(), 0);
+  SourceMgr.overrideFileContents(sourceFile, std::move(Buf));
+
+
+  const FileEntry *headerFile = FileMgr.getVirtualFile("/test-header.h",
+                                                 HeaderBuf->getBufferSize(), 0);
+  SourceMgr.overrideFileContents(headerFile, std::move(HeaderBuf));
+
+  FileID MainFileID = SourceMgr.getOrCreateFileID(sourceFile, SrcMgr::C_User);
+  SourceMgr.setMainFileID(MainFileID);
+
+  auto beginLoc = SourceMgr.getLocForStartOfFile(MainFileID);
+  auto endLoc = SourceMgr.getLocForEndOfFile(MainFileID);
+
+  auto beginEOLLoc = SourceMgr.translateLineCol(MainFileID, 1, 7);
+
+  // TODO: How do I get a loc in another file?
+  auto headerLoc = SourceMgr.getSpellingLoc(SourceMgr.translateLineCol(MainFileID, 3, 5));
+
+  EXPECT_EQ(beginLoc.printToString(SourceMgr), "/mainFile.cpp:1:1");
+  EXPECT_EQ(endLoc.printToString(SourceMgr), "/mainFile.cpp:4:7");
+
+  EXPECT_EQ(beginEOLLoc.printToString(SourceMgr), "/mainFile.cpp:1:7");
+  EXPECT_EQ(headerLoc.printToString(SourceMgr), "TODO");
+
+  EXPECT_EQ(SourceRange(beginLoc, beginLoc).printToString(SourceMgr), "</mainFile.cpp:1:1>");
+  EXPECT_EQ(SourceRange(beginLoc, beginEOLLoc).printToString(SourceMgr), "</mainFile.cpp:1:1, col:7>");
+  EXPECT_EQ(SourceRange(beginLoc, endLoc).printToString(SourceMgr), "</mainFile.cpp:1:1, line:4:7>");
+  EXPECT_EQ(SourceRange(beginLoc, headerLoc).printToString(SourceMgr), "</mainFile.cpp:1:1, TODO>");
+}
+
 #if defined(LLVM_ON_UNIX)
 
 TEST_F(SourceManagerTest, getMacroArgExpandedLocation) {
   const char *header =
     "#define FM(x,y) x\n";
 
   const char *main =
     "#include \"/test-header.h\"\n"