[NFC] DiagnosticVerifier: Cache computed column numbers for actual fix-its

Author: AnthonyLatsis

include/swift/Frontend/DiagnosticVerifier.h

@@ -45,21 +45,39 @@ struct LineColumnRange {
   LineColumnRange() : StartCol(NoValue), EndCol(NoValue) {}
 };
 
+class CapturedFixItInfo final {
+  DiagnosticInfo::FixIt FixIt;
+  mutable LineColumnRange LineColRange;
+
+public:
+  CapturedFixItInfo(DiagnosticInfo::FixIt FixIt) : FixIt(FixIt) {}
+
+  CharSourceRange &getSourceRange() { return FixIt.getRange(); }
+  const CharSourceRange &getSourceRange() const { return FixIt.getRange(); }
+
+  StringRef getText() const { return FixIt.getText(); }
+
+  /// Obtain the line-column range corresponding to the fix-it's
+  /// replacement range.
+  const LineColumnRange &getLineColumnRange(const SourceManager &SM,
+                                            unsigned BufferID) const;
+};
+
 struct CapturedDiagnosticInfo {
   llvm::SmallString<128> Message;
   llvm::SmallString<32> FileName;
   DiagnosticKind Classification;
   SourceLoc Loc;
   unsigned Line;
   unsigned Column;
-  SmallVector<DiagnosticInfo::FixIt, 2> FixIts;
+  SmallVector<CapturedFixItInfo, 2> FixIts;
   SmallVector<std::string, 1> EducationalNotes;
 
   CapturedDiagnosticInfo(llvm::SmallString<128> Message,
                          llvm::SmallString<32> FileName,
                          DiagnosticKind Classification, SourceLoc Loc,
                          unsigned Line, unsigned Column,
-                         SmallVector<DiagnosticInfo::FixIt, 2> FixIts,
+                         SmallVector<CapturedFixItInfo, 2> FixIts,
                          SmallVector<std::string, 1> EducationalNotes)
       : Message(Message), FileName(FileName), Classification(Classification),
         Loc(Loc), Line(Line), Column(Column), FixIts(FixIts),
@@ -113,7 +131,7 @@ class DiagnosticVerifier : public DiagnosticConsumer {
                      const CapturedDiagnosticInfo &D, unsigned BufferID) const;
 
   // Render the verifier syntax for a given set of fix-its.
-  std::string renderFixits(ArrayRef<DiagnosticInfo::FixIt> fixits,
+  std::string renderFixits(ArrayRef<CapturedFixItInfo> ActualFixIts,
                            unsigned BufferID) const;
 
   void printRemainingDiagnostics() const;

lib/Frontend/DiagnosticVerifier.cpp

@@ -35,6 +35,22 @@ struct ExpectedFixIt {
 };
 } // end namespace swift
 
+const LineColumnRange &
+CapturedFixItInfo::getLineColumnRange(const SourceManager &SM,
+                                      unsigned BufferID) const {
+  if (LineColRange.StartCol == LineColumnRange::NoValue) {
+    LineColRange.StartCol =
+        SM.getColumnInBuffer(getSourceRange().getStart(), BufferID);
+  }
+
+  if (LineColRange.EndCol == LineColumnRange::NoValue) {
+    LineColRange.EndCol =
+        SM.getColumnInBuffer(getSourceRange().getEnd(), BufferID);
+  }
+
+  return LineColRange;
+}
+
 namespace {
 
 static constexpr StringLiteral fixitExpectationNoneString("none");
@@ -246,11 +262,10 @@ bool DiagnosticVerifier::checkForFixIt(const ExpectedFixIt &Expected,
     if (ActualFixIt.getText() != Expected.Text)
       continue;
 
-    CharSourceRange Range = ActualFixIt.getRange();
-    if (SM.getColumnInBuffer(Range.getStart(), BufferID) !=
-        Expected.Range.StartCol)
+    LineColumnRange ActualRange = ActualFixIt.getLineColumnRange(SM, BufferID);
+    if (ActualRange.StartCol != Expected.Range.StartCol)
       continue;
-    if (SM.getColumnInBuffer(Range.getEnd(), BufferID) != Expected.Range.EndCol)
+    if (ActualRange.EndCol != Expected.Range.EndCol)
       continue;
 
     return true;
@@ -260,31 +275,29 @@ bool DiagnosticVerifier::checkForFixIt(const ExpectedFixIt &Expected,
 }
 
 std::string
-DiagnosticVerifier::renderFixits(ArrayRef<DiagnosticInfo::FixIt> fixits,
+DiagnosticVerifier::renderFixits(ArrayRef<CapturedFixItInfo> ActualFixIts,
                                  unsigned BufferID) const {
   std::string Result;
   llvm::raw_string_ostream OS(Result);
-  interleave(fixits,
-             [&](const DiagnosticInfo::FixIt &ActualFixIt) {
-               CharSourceRange Range = ActualFixIt.getRange();
-
-               OS << "{{"
-                  << SM.getColumnInBuffer(Range.getStart(), BufferID)
-                  << '-'
-                  << SM.getColumnInBuffer(Range.getEnd(), BufferID)
-                  << '=';
-
-               for (auto C : ActualFixIt.getText()) {
-                 if (C == '\n')
-                   OS << "\\n";
-                 else if (C == '}' || C == '\\')
-                   OS << '\\' << C;
-                 else
-                   OS << C;
-               }
-               OS << "}}";
-             },
-             [&] { OS << ' '; });
+  interleave(
+      ActualFixIts,
+      [&](const CapturedFixItInfo &ActualFixIt) {
+        LineColumnRange ActualRange =
+            ActualFixIt.getLineColumnRange(SM, BufferID);
+
+        OS << "{{" << ActualRange.StartCol << '-' << ActualRange.EndCol << '=';
+
+        for (auto C : ActualFixIt.getText()) {
+          if (C == '\n')
+            OS << "\\n";
+          else if (C == '}' || C == '\\')
+            OS << '\\' << C;
+          else
+            OS << C;
+        }
+        OS << "}}";
+      },
+      [&] { OS << ' '; });
   return OS.str();
 }
 
@@ -628,8 +641,7 @@ DiagnosticVerifier::Result DiagnosticVerifier::verifyFile(unsigned BufferID) {
     };
 
     auto makeActualFixitsPhrase =
-        [&](ArrayRef<DiagnosticInfo::FixIt> actualFixits)
-        -> ActualFixitsPhrase {
+        [&](ArrayRef<CapturedFixItInfo> actualFixits) -> ActualFixitsPhrase {
       std::string actualFixitsStr = renderFixits(actualFixits, BufferID);
 
       return ActualFixitsPhrase{(Twine("actual fix-it") +
@@ -933,8 +945,10 @@ void DiagnosticVerifier::printRemainingDiagnostics() const {
 /// file.
 void DiagnosticVerifier::handleDiagnostic(SourceManager &SM,
                                           const DiagnosticInfo &Info) {
-  SmallVector<DiagnosticInfo::FixIt, 2> fixIts;
-  std::copy(Info.FixIts.begin(), Info.FixIts.end(), std::back_inserter(fixIts));
+  SmallVector<CapturedFixItInfo, 2> fixIts;
+  for (const auto &fixIt : Info.FixIts) {
+    fixIts.emplace_back(fixIt);
+  }
 
   llvm::SmallVector<std::string, 1> eduNotes;
   for (auto &notePath : Info.EducationalNotePaths) {
@@ -968,11 +982,11 @@ void DiagnosticVerifier::handleDiagnostic(SourceManager &SM,
 
     capturedDiag.Loc = correctSM.getLocForForeignLoc(capturedDiag.Loc, SM);
     for (auto &fixIt : capturedDiag.FixIts) {
-      auto newStart = correctSM.getLocForForeignLoc(fixIt.getRange().getStart(),
-                                                    SM);
-      auto &mutableRange = fixIt.getRange();
+      auto newStart =
+          correctSM.getLocForForeignLoc(fixIt.getSourceRange().getStart(), SM);
+      auto &mutableRange = fixIt.getSourceRange();
       mutableRange =
-          CharSourceRange(newStart, fixIt.getRange().getByteLength());
+          CharSourceRange(newStart, fixIt.getSourceRange().getByteLength());
     }
   }
 }