[Constraint] Eliminate repetitive locators to make useful information easier to read.

Author: Amritpan Kaur

include/swift/Sema/Constraint.h

@@ -852,11 +852,10 @@ class Constraint final : public llvm::ilist_node<Constraint>,
   /// Clone the given constraint.
   Constraint *clone(ConstraintSystem &cs) const;
 
-  /// Prints constraint placed on type and constraint properties
+  /// Print constraint placed on type and constraint properties.
   ///
-  /// \c repeatedLocator checks if current locator is repeated in
-  /// preceding constraint and prevents repetitive locator printing.
-  void print(llvm::raw_ostream &Out, SourceManager *sm, bool repeatedLocator = false) const;
+  /// \c skipLocator skips printing of repetitive locators.
+  void print(llvm::raw_ostream &Out, SourceManager *sm, bool skipLocator = false) const;
 
   SWIFT_DEBUG_DUMPER(dump(SourceManager *SM));
 

lib/Sema/Constraint.cpp

@@ -322,12 +322,11 @@ Constraint *Constraint::clone(ConstraintSystem &cs) const {
   llvm_unreachable("Unhandled ConstraintKind in switch.");
 }
 
-void Constraint::print(llvm::raw_ostream &Out, SourceManager *sm, bool repeatedLocator) const {
+void Constraint::print(llvm::raw_ostream &Out, SourceManager *sm, bool skipLocator) const {
   // Print all type variables as $T0 instead of _ here.
   PrintOptions PO;
   PO.PrintTypesForDebugging = true;
 
-  ConstraintLocator *firstLocator;
   if (Kind == ConstraintKind::Disjunction ||
       Kind == ConstraintKind::Conjunction) {
     Out << (Kind == ConstraintKind::Disjunction ? "disjunction"
@@ -338,8 +337,8 @@ void Constraint::print(llvm::raw_ostream &Out, SourceManager *sm, bool repeatedL
     if (isIsolated())
       Out << " (isolated)";
 
-    firstLocator = Locator;
-    if (Locator) {
+    auto firstLocator = Locator;
+    if (firstLocator) {
       Out << " [[";
       Locator->dump(sm, Out);
       Out << "]]";
@@ -354,11 +353,8 @@ void Constraint::print(llvm::raw_ostream &Out, SourceManager *sm, bool repeatedL
                    Out << ">  [favored]  ";
                  else
                    Out << ">             ";
-                 if (constraint->getLocator() == firstLocator) {
-                   constraint->print(Out, sm, true);
-                 } else {
-                 constraint->print(Out, sm);
-                 }
+                 constraint->print(Out, sm,
+                   /*skipLocator=*/constraint->getLocator() == firstLocator);
                },
                [&] { Out << "\n"; });
     return;
@@ -528,7 +524,7 @@ void Constraint::print(llvm::raw_ostream &Out, SourceManager *sm, bool repeatedL
     fix->print(Out);
   }
 
-  if (Locator && !repeatedLocator) {
+  if (Locator && !skipLocator) {
     Out << " [[";
     Locator->dump(sm, Out);
     Out << "]];";