[ConstraintSystem] Remove parens in simplification printing.

Amritpan Kaur · amritpan · commit 60e880b42642 · 2022-11-09T09:33:39.000-08:00
diff --git a/include/swift/Sema/ConstraintSystem.h b/include/swift/Sema/ConstraintSystem.h
@@ -4431,9 +4431,9 @@ class ConstraintSystem {
     if (isDebugMode()) {
       auto &log = llvm::errs();
       log.indent(solverState ? solverState->getCurrentIndent() + 4 : 0)
-          << "(failed constraint ";
+          << "Failed constraint ";
       constraint->print(log, &getASTContext().SourceMgr);
-      log << ")\n";
+      log << "\n";
     }
   }
 
@@ -4455,7 +4455,7 @@ class ConstraintSystem {
 
     if (isDebugMode() && getPhase() == ConstraintSystemPhase::Solving) {
       auto &log = llvm::errs();
-      log.indent(solverState->getCurrentIndent() + 4) << "(added constraint: ";
+      log.indent(solverState->getCurrentIndent() + 4) << "Added constraint: ";
       constraint->print(log, &getASTContext().SourceMgr,
                         solverState->getCurrentIndent() + 4);
       log << ")\n";
@@ -4474,10 +4474,10 @@ class ConstraintSystem {
     if (isDebugMode() && getPhase() == ConstraintSystemPhase::Solving) {
       auto &log = llvm::errs();
       log.indent(solverState->getCurrentIndent() + 4)
-          << "(removed constraint: ";
+          << "Removed constraint: ";
       constraint->print(log, &getASTContext().SourceMgr,
                         solverState->getCurrentIndent() + 4);
-      log << ")\n";
+      log << "\n";
     }
 
     if (solverState)
diff --git a/lib/Sema/CSRanking.cpp b/lib/Sema/CSRanking.cpp
@@ -55,8 +55,8 @@ void ConstraintSystem::increaseScore(ScoreKind kind, unsigned value) {
   if (isDebugMode() && value > 0) {
     if (solverState)
       llvm::errs().indent(solverState->getCurrentIndent());
-    llvm::errs() << "(increasing '" << Score::getNameFor(kind) << "' score by "  << value 
-                 << ")\n";
+    llvm::errs() << "Increasing '" << Score::getNameFor(kind) << "' score by "  << value
+                 << "\n";
   }
 
   unsigned index = static_cast<unsigned>(kind);
@@ -73,7 +73,7 @@ bool ConstraintSystem::worseThanBestSolution() const {
 
   if (isDebugMode()) {
     llvm::errs().indent(solverState->getCurrentIndent())
-      << "(solution is worse than the best solution)\n";
+      << "Solution is worse than the best solution\n";
   }
 
   return true;
diff --git a/lib/Sema/CSSimplify.cpp b/lib/Sema/CSSimplify.cpp
@@ -11860,9 +11860,8 @@ bool ConstraintSystem::simplifyAppliedOverloadsImpl(
       PrintOptions PO;
       PO.PrintTypesForDebugging = true;
       llvm::errs().indent(solverState ? solverState->getCurrentIndent() : 0)
-        << "(common result type for $T" << fnTypeVar->getID() << " is "
-        << commonResultType.getString(PO)
-        << ")\n";
+          << "Common result type for $T" << fnTypeVar->getID() << " is "
+          << commonResultType.getString(PO) << "\n";
     }
 
     // Introduction of a `Bind` constraint here could result in the disconnect
diff --git a/lib/Sema/CSSolver.cpp b/lib/Sema/CSSolver.cpp
@@ -348,7 +348,7 @@ bool ConstraintSystem::simplify() {
     if (isDebugMode()) {
       auto &log = llvm::errs();
       log.indent(solverState->getCurrentIndent());
-      log << "(considering -> ";
+      log << "Considering -> ";
       constraint->print(log, &getASTContext().SourceMgr);
       log << "\n";
 
@@ -357,7 +357,7 @@ bool ConstraintSystem::simplify() {
       if (constraint->getKind() != ConstraintKind::Disjunction &&
           constraint->getKind() != ConstraintKind::Conjunction) {
         log.indent(solverState->getCurrentIndent() + 2)
-            << "(simplification result:\n";
+            << "Simplification result:\n";
       }
     }
 
@@ -367,8 +367,7 @@ bool ConstraintSystem::simplify() {
       retireFailedConstraint(constraint);
       if (isDebugMode()) {
         auto &log = llvm::errs();
-        log.indent(solverState->getCurrentIndent() + 2) << ")\n";
-        log.indent(solverState->getCurrentIndent() + 2) << "(outcome: error)\n";
+        log.indent(solverState->getCurrentIndent() + 2) << "Outcome: error\n";
       }
       break;
 
@@ -378,9 +377,8 @@ bool ConstraintSystem::simplify() {
       retireConstraint(constraint);
       if (isDebugMode()) {
         auto &log = llvm::errs();
-        log.indent(solverState->getCurrentIndent() + 2) << ")\n";
         log.indent(solverState->getCurrentIndent() + 2)
-            << "(outcome: simplified)\n";
+            << "Outcome: simplified\n";
       }
       break;
 
@@ -389,18 +387,12 @@ bool ConstraintSystem::simplify() {
         ++solverState->NumUnsimplifiedConstraints;
       if (isDebugMode()) {
         auto &log = llvm::errs();
-        log.indent(solverState->getCurrentIndent() + 2) << ")\n";
         log.indent(solverState->getCurrentIndent() + 2)
-            << "(outcome: unsolved)\n";
+            << "Outcome: unsolved\n";
       }
       break;
     }
 
-    if (isDebugMode()) {
-      auto &log = llvm::errs();
-      log.indent(solverState->getCurrentIndent()) << ")\n";
-    }
-
     // Check whether a constraint failed. If so, we're done.
     if (failedConstraint) {
       return true;
@@ -1658,9 +1650,9 @@ ConstraintSystem::filterDisjunction(
 
     if (isDebugMode()) {
       llvm::errs().indent(solverState ? solverState->getCurrentIndent() : 0)
-        << "(disabled disjunction term ";
+        << "Disabled disjunction term ";
       constraint->print(llvm::errs(), &ctx.SourceMgr);
-      llvm::errs() << ")\n";
+      llvm::errs() << "\n";
     }
 
     if (restoreOnFail)
@@ -1717,9 +1709,8 @@ ConstraintSystem::filterDisjunction(
 
     if (isDebugMode()) {
       llvm::errs().indent(solverState ? solverState->getCurrentIndent(): 0)
-        << "(introducing single enabled disjunction term ";
+        << "Introducing single enabled disjunction term ";
       choice->print(llvm::errs(), &ctx.SourceMgr);
-      llvm::errs() << ")\n";
     }
 
     simplifyDisjunctionChoice(choice);
diff --git a/lib/Sema/CSStep.cpp b/lib/Sema/CSStep.cpp
@@ -243,9 +243,9 @@ bool SplitterStep::mergePartialSolutions() const {
       solutionMemory += solution.getTotalMemory();
       if (CS.isDebugMode()) {
         auto &log = getDebugLogger();
-        log << "(composed solution:";
+        log << "<! Composed solution:";
         CS.CurrentScore.print(log);
-        log << ")\n";
+        log << ">\n";
       }
 
       // Save this solution.
@@ -352,9 +352,8 @@ StepResult ComponentStep::take(bool prevFailed) {
   auto bestBindings = CS.determineBestBindings([&](const BindingSet &bindings) {
     if (CS.isDebugMode() && bindings.hasViableBindings()) {
       bos.indent(CS.solverState->getCurrentIndent() + 2);
-      bos << "(";
       bindings.dump(bos, CS.solverState->getCurrentIndent() + 2);
-      bos << ")\n";
+      bos << "\n";
     }
   });
 
@@ -363,7 +362,7 @@ StepResult ComponentStep::take(bool prevFailed) {
   if (CS.isDebugMode()) {
     if (!potentialBindings.empty()) {
       auto &log = getDebugLogger();
-      log << "(Potential Binding(s): " << '\n';
+      log << "Potential Binding(s): " << '\n';
       log << potentialBindings;
     }
 
@@ -385,11 +384,6 @@ StepResult ComponentStep::take(bool prevFailed) {
       log << "Disjunction(s) = [";
       interleave(overloadDisjunctions, log, ", ");
       log << "]\n";
-
-      if (!potentialBindings.empty() || !overloadDisjunctions.empty()) {
-        auto &log = getDebugLogger();
-        log << ")\n";
-      }
     }
   }
 
@@ -479,9 +473,9 @@ StepResult ComponentStep::take(bool prevFailed) {
   auto solution = CS.finalize();
   if (CS.isDebugMode()) {
     auto &log = getDebugLogger();
-    log << "(found solution:";
+    log << "Found solution:";
     getCurrentScore().print(log);
-    log << ")\n";
+    log << "\n";
   }
 
   Solutions.push_back(std::move(solution));
@@ -500,8 +494,8 @@ StepResult ComponentStep::finalize(bool isSuccess) {
 
   if (CS.isDebugMode()) {
     auto &log = getDebugLogger();
-    log << (isSuccess ? "finished" : "failed") << " component #" << Index
-        << ")\n";
+    log << (isSuccess ? "Finished" : "Failed") << " component #" << Index
+        << "}\n";
   }
 
   // If we came either back to this step and previous
@@ -554,7 +548,7 @@ StepResult TypeVariableStep::resume(bool prevFailed) {
   ActiveChoice.reset();
 
   if (CS.isDebugMode())
-    getDebugLogger() << ")\n";
+    getDebugLogger() << "}\n";
 
   // Let's check if we should stop right before
   // attempting any new bindings.
@@ -600,7 +594,7 @@ StepResult DisjunctionStep::resume(bool prevFailed) {
   ActiveChoice.reset();
 
   if (CS.isDebugMode())
-    getDebugLogger() << ")\n";
+    getDebugLogger() << "}\n";
 
   // Attempt next disjunction choice (if any left).
   return take(prevFailed);
@@ -880,7 +874,7 @@ StepResult ConjunctionStep::resume(bool prevFailed) {
   if (Snapshot && Snapshot->isScoped()) {
     Snapshot.reset();
     if (CS.isDebugMode())
-      getDebugLogger() << ")\n";
+      getDebugLogger() << "}\n";
     
     return done(/*isSuccess=*/!prevFailed);
   }
@@ -893,7 +887,7 @@ StepResult ConjunctionStep::resume(bool prevFailed) {
   ActiveChoice.reset();
 
   if (CS.isDebugMode())
-    getDebugLogger() << ")\n";
+    getDebugLogger() << "}\n";
 
   // Check whether it makes sense to continue solving
   // this conjunction. Note that for conjunction constraint
@@ -961,7 +955,7 @@ StepResult ConjunctionStep::resume(bool prevFailed) {
     if (Conjunction->isIsolated()) {
       if (CS.isDebugMode()) {
         auto &log = getDebugLogger();
-        log << "(applying conjunction result to outer context\n";
+        log << "{Applying conjunction result to outer context\n";
       }
 
       assert(
diff --git a/lib/Sema/CSStep.h b/lib/Sema/CSStep.h
@@ -469,7 +469,7 @@ class ComponentStep final : public SolverStep {
     
     if (CS.isDebugMode()) {
       auto &log = getDebugLogger();
-      log << "(solving component #" << Index << '\n';
+      log << "{Solving component #" << Index << '\n';
     }
     
     ComponentScope = std::make_unique<Scope>(*this);
@@ -536,7 +536,9 @@ template <typename P> class BindingStep : public SolverStep {
 
       if (CS.isDebugMode()) {
         auto &log = getDebugLogger();
-        log << "(attempting ";
+        log << "{\n";
+        log.indent(CS.solverState->getCurrentIndent());
+        log << "Attempting ";
         choice->print(log, &CS.getASTContext().SourceMgr, CS.solverState->getCurrentIndent() + 2);
         log << '\n';
       }
@@ -557,7 +559,7 @@ template <typename P> class BindingStep : public SolverStep {
       }
 
       if (CS.isDebugMode())
-        getDebugLogger() << ")\n";
+        getDebugLogger() << "}\n";
 
       // If this binding didn't match, let's check if we've attempted
       // enough bindings to stop, because some producers might need
diff --git a/lib/Sema/ConstraintGraph.cpp b/lib/Sema/ConstraintGraph.cpp
@@ -1604,75 +1604,64 @@ void ConstraintGraph::dumpActiveScopeChanges(llvm::raw_ostream &out,
   PrintOptions PO;
   PO.PrintTypesForDebugging = true;
   out.indent(indent);
-  out << "(Changes:\n";
+  out << "Changes:\n";
   if (!tvWithboundTypes.empty()) {
     out.indent(indent + 2);
-    out << "(Newly Bound: \n";
+    out << "Newly Bound: \n";
     for (const auto &tvWithType : tvWithboundTypes) {
       out.indent(indent + 4);
       out << "> $T" << tvWithType.first->getImpl().getID() << " := ";
       tvWithType.second->print(out, PO);
       out << '\n';
     }
-    out.indent(indent + 2);
-    out << ")\n";
   }
   if (!addedTypeVars.empty()) {
     out.indent(indent + 2);
-    auto heading = (addedTypeVars.size() > 1) ? "(New Type Variables: \n"
-                                              : "(New Type Variable: \n";
+    auto heading = (addedTypeVars.size() > 1) ? "New Type Variables: \n"
+                                              : "New Type Variable: \n";
     out << heading;
     for (const auto &typeVar : addedTypeVars) {
       out.indent(indent + 4);
       out << "> $T" << typeVar->getImpl().getID();
       out << '\n';
     }
-    out.indent(indent + 2);
-    out << ")\n";
   }
   if (!equivTypeVars.empty()) {
     out.indent(indent + 2);
-    auto heading = (equivTypeVars.size() > 1) ? "(New Equivalences: \n"
-                                              : "(New Equivalence: \n";
+    auto heading = (equivTypeVars.size() > 1) ? "New Equivalences: \n"
+                                              : "New Equivalence: \n";
     out << heading;
     for (const auto &typeVar : equivTypeVars) {
       out.indent(indent + 4);
       out << "> $T" << typeVar->getImpl().getID();
       out << '\n';
     }
-    out.indent(indent + 2);
-    out << ")\n";
   }
   if (!addedConstraints.empty()) {
     out.indent(indent + 2);
-    auto heading = (addedConstraints.size() > 1) ? "(Added Constraints: \n"
-                                                 : "(Added Constraint: \n";
+    auto heading = (addedConstraints.size() > 1) ? "Added Constraints: \n"
+                                                 : "Added Constraint: \n";
     out << heading;
     for (const auto &constraint : addedConstraints) {
       out.indent(indent + 4);
       out << "> ";
       constraint->print(out, &CS.getASTContext().SourceMgr, indent + 6);
       out << '\n';
     }
-    out.indent(indent + 2);
-    out << ")\n";
   }
   if (!removedConstraints.empty()) {
     out.indent(indent + 2);
-    auto heading = (removedConstraints.size() > 1) ? "(Removed Constraints: \n"
-                                                   : "(Removed Constraint: \n";
+    auto heading = (removedConstraints.size() > 1) ? "Removed Constraints: \n"
+                                                   : "Removed Constraint: \n";
     out << heading;
     for (const auto &constraint : removedConstraints) {
       out.indent(indent + 4);
       out << "> ";
       constraint->print(out, &CS.getASTContext().SourceMgr, indent + 6);
       out << '\n';
     }
-    out.indent(indent + 2);
-    out << ")\n";
   }
-  out.indent(indent);
-  out << ")\n";
+  out << '\n';
 }
 
 void ConstraintGraph::printConnectedComponents(
diff --git a/lib/Sema/ConstraintSystem.cpp b/lib/Sema/ConstraintSystem.cpp
@@ -3576,7 +3576,7 @@ void ConstraintSystem::resolveOverload(ConstraintLocator *locator,
 
     auto &log = llvm::errs();
     log.indent(solverState ? solverState->getCurrentIndent() : 2);
-    log << "(overload set choice binding ";
+    log << "Overload set choice binding ";
     boundType->print(log, PO);
     log << " := ";
     adjustedRefType->print(log, PO);
@@ -3594,7 +3594,7 @@ void ConstraintSystem::resolveOverload(ConstraintLocator *locator,
           [&]() { log << ", "; });
       log << "]";
     }
-    log << ")\n";
+    log << "\n";
   }
 
   if (auto *decl = choice.getDeclOrNull()) {
