[ConstraintSystem] Add proper printing (name + locator) for fixes

Author: xedin

lib/Sema/CSFix.cpp

@@ -22,7 +22,10 @@
 #include "ConstraintSystem.h"
 #include "swift/AST/Expr.h"
 #include "swift/AST/Type.h"
+#include "swift/Basic/SourceManager.h"
+#include "llvm/ADT/SmallString.h"
 #include "llvm/Support/raw_ostream.h"
+#include <string>
 
 using namespace swift;
 using namespace constraints;
@@ -31,18 +34,30 @@ ConstraintFix::~ConstraintFix() {}
 
 Expr *ConstraintFix::getAnchor() const { return getLocator()->getAnchor(); }
 
-void ConstraintFix::dump() const { print(llvm::errs()); }
+void ConstraintFix::print(llvm::raw_ostream &Out, SourceManager *sm) const {
+  Out << "[fix: ";
+  Out << getName();
+  Out << ']';
+  Out << " @ ";
+  getLocator()->dump(sm, Out);
+}
+
+void ConstraintFix::dump(SourceManager *sm) const { print(llvm::errs(), sm); }
+
+std::string ForceDowncast::getName() const {
+  llvm::SmallString<16> name;
+  name += "force downcast (as! ";
+  name += DowncastTo->getString();
+  name += ")";
+  return name.c_str();
+}
 
 bool ForceDowncast::diagnose(Expr *expr, const Solution &solution) const {
   MissingExplicitConversionFailure failure(expr, solution, getLocator(),
                                            DowncastTo);
   return failure.diagnose();
 }
 
-void ForceDowncast::print(llvm::raw_ostream &Out) const {
-  Out << "[fix: force downcast (as! " << DowncastTo->getString() << ")]";
-}
-
 ForceDowncast *ForceDowncast::create(ConstraintSystem &cs, Type toType,
                                      ConstraintLocator *locator) {
   return new (cs.getAllocator()) ForceDowncast(toType, locator);

lib/Sema/CSFix.h

@@ -24,12 +24,16 @@
 #include "llvm/ADT/ArrayRef.h"
 #include "llvm/ADT/SmallVector.h"
 #include "llvm/Support/TrailingObjects.h"
+#include <string>
 
 namespace llvm {
 class raw_ostream;
 }
 
 namespace swift {
+
+class SourceManager;
+
 namespace constraints {
 
 class ConstraintSystem;
@@ -78,12 +82,16 @@ class ConstraintFix {
 
   FixKind getKind() const { return Kind; }
 
+  virtual std::string getName() const = 0;
+
   /// Diagnose a failure associated with this fix given
   /// root expression and information from well-formed solution.
   virtual bool diagnose(Expr *root, const Solution &solution) const = 0;
-  virtual void print(llvm::raw_ostream &Out) const = 0;
 
-  LLVM_ATTRIBUTE_DEPRECATED(void dump() const LLVM_ATTRIBUTE_USED,
+  void print(llvm::raw_ostream &Out, SourceManager *sm) const;
+
+  LLVM_ATTRIBUTE_DEPRECATED(void dump(SourceManager *sm)
+                                const LLVM_ATTRIBUTE_USED,
                             "only for use within the debugger");
 
   /// Retrieve anchor expression associated with this fix.
@@ -101,8 +109,8 @@ class ForceDowncast final : public ConstraintFix {
       : ConstraintFix(FixKind::ForceDowncast, locator), DowncastTo(toType) {}
 
 public:
+  std::string getName() const override;
   bool diagnose(Expr *root, const Solution &solution) const override;
-  void print(llvm::raw_ostream &Out) const override;
 
   static ForceDowncast *create(ConstraintSystem &cs, Type toType,
                                ConstraintLocator *locator);
@@ -114,10 +122,9 @@ class ForceOptional final : public ConstraintFix {
       : ConstraintFix(FixKind::ForceOptional, locator) {}
 
 public:
+  std::string getName() const override { return "force optional"; }
+
   bool diagnose(Expr *root, const Solution &solution) const override;
-  void print(llvm::raw_ostream &Out) const override {
-    Out << "[fix: force optional]";
-  }
 
   static ForceOptional *create(ConstraintSystem &cs,
                                ConstraintLocator *locator);
@@ -134,11 +141,12 @@ class UnwrapOptionalBase final : public ConstraintFix {
   }
 
 public:
-  bool diagnose(Expr *root, const Solution &solution) const override;
-  void print(llvm::raw_ostream &Out) const override {
-    Out << "[fix: unwrap optional base of member lookup]";
+  std::string getName() const override {
+    return "unwrap optional base of member lookup";
   }
 
+  bool diagnose(Expr *root, const Solution &solution) const override;
+
   static UnwrapOptionalBase *create(ConstraintSystem &cs, DeclName member,
                                     ConstraintLocator *locator);
 
@@ -153,10 +161,9 @@ class AddAddressOf final : public ConstraintFix {
       : ConstraintFix(FixKind::AddressOf, locator) {}
 
 public:
+  std::string getName() const override { return "add address-of"; }
+
   bool diagnose(Expr *root, const Solution &solution) const override;
-  void print(llvm::raw_ostream &Out) const override {
-    Out << "[fix: add address-of]";
-  }
 
   static AddAddressOf *create(ConstraintSystem &cs, ConstraintLocator *locator);
 };
@@ -167,10 +174,9 @@ class CoerceToCheckedCast final : public ConstraintFix {
       : ConstraintFix(FixKind::CoerceToCheckedCast, locator) {}
 
 public:
+  std::string getName() const override { return "as to as!"; }
+
   bool diagnose(Expr *root, const Solution &solution) const override;
-  void print(llvm::raw_ostream &Out) const override {
-    Out << "[fix: as to as!]";
-  }
 
   static CoerceToCheckedCast *create(ConstraintSystem &cs,
                                      ConstraintLocator *locator);
@@ -187,10 +193,9 @@ class MarkExplicitlyEscaping final : public ConstraintFix {
         ConvertTo(convertingTo) {}
 
 public:
+  std::string getName() const override { return "add @escaping"; }
+
   bool diagnose(Expr *root, const Solution &solution) const override;
-  void print(llvm::raw_ostream &Out) const override {
-    Out << "[fix: add @escaping]";
-  }
 
   static MarkExplicitlyEscaping *create(ConstraintSystem &cs,
                                         ConstraintLocator *locator,
@@ -215,14 +220,13 @@ class RelabelArguments final
   }
 
 public:
+  std::string getName() const override { return "re-label argument(s)"; }
+
   ArrayRef<Identifier> getLabels() const {
     return {getTrailingObjects<Identifier>(), NumLabels};
   }
 
   bool diagnose(Expr *root, const Solution &solution) const override;
-  void print(llvm::raw_ostream &Out) const override {
-    Out << "[fix: re-label argument(s)]";
-  }
 
   static RelabelArguments *create(ConstraintSystem &cs,
                                   llvm::ArrayRef<Identifier> correctLabels,
@@ -245,11 +249,12 @@ class MissingConformance final : public ConstraintFix {
         NonConformingType(type), Protocol(protocol) {}
 
 public:
-  bool diagnose(Expr *root, const Solution &solution) const override;
-  void print(llvm::raw_ostream &Out) const override {
-    Out << "[fix: add missing protocol conformance]";
+  std::string getName() const override {
+    return "add missing protocol conformance";
   }
 
+  bool diagnose(Expr *root, const Solution &solution) const override;
+
   static MissingConformance *create(ConstraintSystem &cs, Type type,
                                     ProtocolDecl *protocol,
                                     ConstraintLocator *locator);

lib/Sema/CSSimplify.cpp

@@ -4908,9 +4908,7 @@ bool ConstraintSystem::recordFix(ConstraintFix *fix) {
     auto &log = ctx.TypeCheckerDebug->getStream();
     log.indent(solverState ? solverState->depth * 2 + 2 : 0)
       << "(attempting fix ";
-    fix->print(log);
-    log << " @";
-    getConstraintLocator(fix->getLocator())->dump(&ctx.SourceMgr, log);
+    fix->print(log, &ctx.SourceMgr);
     log << ")\n";
   }
 

lib/Sema/Constraint.cpp

@@ -390,7 +390,7 @@ void Constraint::print(llvm::raw_ostream &Out, SourceManager *sm) const {
 
   if (auto *fix = getFix()) {
     Out << ' ';
-    fix->print(Out);
+    fix->print(Out, sm);
   }
 
   if (Locator) {

lib/Sema/TypeCheckConstraints.cpp

@@ -3357,9 +3357,7 @@ void Solution::dump(raw_ostream &out) const {
     out << "\nFixes:\n";
     for (auto *fix : Fixes) {
       out.indent(2);
-      fix->print(out);
-      out << " @ ";
-      fix->getLocator()->dump(sm, out);
+      fix->print(out, &ctx.SourceMgr);
       out << "\n";
     }
   }
@@ -3554,9 +3552,7 @@ void ConstraintSystem::print(raw_ostream &out) {
     out << "\nFixes:\n";
     for (auto *fix : Fixes) {
       out.indent(2);
-      fix->print(out);
-      out << " @ ";
-      fix->getLocator()->dump(&getTypeChecker().Context.SourceMgr, out);
+      fix->print(out, &getTypeChecker().Context.SourceMgr);
       out << "\n";
     }
   }