Skip to content

Commit 3141b5a

Browse files
hamishknighthamishknight
committed
[AST] NFC: Introduce PrintOptions::forDebugging 
1 parent 4183eca commit 3141b5a

14 files changed

+66
-109
lines changed

‎include/swift/AST/PrintOptions.h‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -694,6 +694,13 @@ struct PrintOptions {
694694
return result;
695695
}
696696

697+
/// Print options suitable for debug printing.
698+
static PrintOptions forDebugging() {
699+
PrintOptions result;
700+
result.PrintTypesForDebugging = true;
701+
return result;
702+
}
703+
697704
/// Retrieve the set of options suitable for diagnostics printing.
698705
static PrintOptions printForDiagnostics(AccessLevel accessFilter,
699706
bool printFullConvention) {

‎include/swift/Sema/ConstraintSystem.h‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6223,8 +6223,7 @@ class TypeVariableBinding {
62236223
fixForHole(ConstraintSystem &cs) const;
62246224

62256225
void print(llvm::raw_ostream &Out, SourceManager *, unsigned indent) const {
6226-
PrintOptions PO;
6227-
PO.PrintTypesForDebugging = true;
6226+
PrintOptions PO = PrintOptions::forDebugging();
62286227
Out << "type variable binding " << TypeVar->getString(PO)
62296228
<< " := " << Binding.BindingType->getString(PO);
62306229
}

‎lib/AST/ASTDumper.cpp‎

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3398,13 +3398,11 @@ class PrintExpr : public ExprVisitor<PrintExpr, void, Label>,
33983398
/// FIXME: This should use ExprWalker to print children.
33993399

34003400
void printCommon(Expr *E, const char *C, Label label) {
3401-
PrintOptions PO;
3402-
PO.PrintTypesForDebugging = true;
3403-
34043401
printHead(C, ExprColor, label);
34053402

34063403
printFlag(E->isImplicit(), "implicit", ExprModifierColor);
3407-
printTypeField(GetTypeOfExpr(E), Label::always("type"), PO, TypeColor);
3404+
printTypeField(GetTypeOfExpr(E), Label::always("type"),
3405+
PrintOptions::forDebugging(), TypeColor);
34083406

34093407
// If we have a source range and an ASTContext, print the source range.
34103408
if (auto Ty = GetTypeOfExpr(E)) {
@@ -4054,10 +4052,8 @@ class PrintExpr : public ExprVisitor<PrintExpr, void, Label>,
40544052
void visitForceTryExpr(ForceTryExpr *E, Label label) {
40554053
printCommon(E, "force_try_expr", label);
40564054

4057-
PrintOptions PO;
4058-
PO.PrintTypesForDebugging = true;
4059-
printTypeField(E->getThrownError(), Label::always("thrown_error"), PO,
4060-
TypeColor);
4055+
printTypeField(E->getThrownError(), Label::always("thrown_error"),
4056+
PrintOptions::forDebugging(), TypeColor);
40614057

40624058
printRec(E->getSubExpr(), Label::optional("sub_expr"));
40634059
printFoot();
@@ -4066,10 +4062,8 @@ class PrintExpr : public ExprVisitor<PrintExpr, void, Label>,
40664062
void visitOptionalTryExpr(OptionalTryExpr *E, Label label) {
40674063
printCommon(E, "optional_try_expr", label);
40684064

4069-
PrintOptions PO;
4070-
PO.PrintTypesForDebugging = true;
4071-
printTypeField(E->getThrownError(), Label::always("thrown_error"), PO,
4072-
TypeColor);
4065+
printTypeField(E->getThrownError(), Label::always("thrown_error"),
4066+
PrintOptions::forDebugging(), TypeColor);
40734067

40744068
printRec(E->getSubExpr(), Label::optional("sub_expr"));
40754069
printFoot();
@@ -4553,10 +4547,8 @@ class PrintExpr : public ExprVisitor<PrintExpr, void, Label>,
45534547
void visitTypeValueExpr(TypeValueExpr *E, Label label) {
45544548
printCommon(E, "type_value_expr", label);
45554549

4556-
PrintOptions PO;
4557-
PO.PrintTypesForDebugging = true;
4558-
printTypeField(E->getParamType(), Label::always("param_type"), PO,
4559-
TypeColor);
4550+
printTypeField(E->getParamType(), Label::always("param_type"),
4551+
PrintOptions::forDebugging(), TypeColor);
45604552

45614553
printFoot();
45624554
}

‎lib/Sema/CSBindings.cpp‎

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2174,13 +2174,8 @@ void PotentialBindings::reset() {
21742174
AssociatedCodeCompletionToken = ASTNode();
21752175
}
21762176

2177-
void PotentialBindings::dump(ConstraintSystem &cs,
2178-
TypeVariableType *typeVar,
2179-
llvm::raw_ostream &out,
2180-
unsigned indent) const {
2181-
PrintOptions PO;
2182-
PO.PrintTypesForDebugging = true;
2183-
2177+
void PotentialBindings::dump(ConstraintSystem &cs, TypeVariableType *typeVar,
2178+
llvm::raw_ostream &out, unsigned indent) const {
21842179
out << "Potential bindings for ";
21852180
typeVar->getImpl().print(out);
21862181
out << "\n";
@@ -2202,16 +2197,17 @@ void PotentialBindings::dump(ConstraintSystem &cs,
22022197
[](auto lhs, auto rhs) {
22032198
return lhs.first->getID() < rhs.first->getID();
22042199
});
2205-
interleave(adjacentVars,
2206-
[&](std::pair<TypeVariableType *, Constraint *> pair) {
2207-
out << pair.first->getString(PO);
2208-
if (pair.first->getImpl().getFixedType(/*record=*/nullptr))
2209-
out << " (fixed)";
2210-
out << " via ";
2211-
pair.second->print(out, &cs.getASTContext().SourceMgr, indent,
2212-
/*skipLocator=*/true);
2213-
},
2214-
[&out]() { out << ", "; });
2200+
interleave(
2201+
adjacentVars,
2202+
[&](std::pair<TypeVariableType *, Constraint *> pair) {
2203+
out << pair.first->getString(PrintOptions::forDebugging());
2204+
if (pair.first->getImpl().getFixedType(/*record=*/nullptr))
2205+
out << " (fixed)";
2206+
out << " via ";
2207+
pair.second->print(out, &cs.getASTContext().SourceMgr, indent,
2208+
/*skipLocator=*/true);
2209+
},
2210+
[&out]() { out << ", "; });
22152211
out << "] ";
22162212
}
22172213
}
@@ -2295,8 +2291,7 @@ static std::string getCollectionLiteralAsString(KnownProtocolKind KPK) {
22952291
}
22962292

22972293
void BindingSet::dump(llvm::raw_ostream &out, unsigned indent) const {
2298-
PrintOptions PO;
2299-
PO.PrintTypesForDebugging = true;
2294+
PrintOptions PO = PrintOptions::forDebugging();
23002295

23012296
if (auto typeVar = getTypeVariable()) {
23022297
typeVar->getImpl().print(out);
@@ -2991,8 +2986,7 @@ bool TypeVariableBinding::attempt(ConstraintSystem &cs) const {
29912986

29922987
if (result.isFailure()) {
29932988
if (cs.isDebugMode()) {
2994-
PrintOptions PO;
2995-
PO.PrintTypesForDebugging = true;
2989+
PrintOptions PO = PrintOptions::forDebugging();
29962990

29972991
llvm::errs().indent(cs.solverState->getCurrentIndent())
29982992
<< "(failed to establish binding " << TypeVar->getString(PO)

‎lib/Sema/CSOptimizer.cpp‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1738,13 +1738,11 @@ static void determineBestChoicesInContext(
17381738
});
17391739

17401740
if (cs.isDebugMode()) {
1741-
PrintOptions PO;
1742-
PO.PrintTypesForDebugging = true;
17431741

17441742
llvm::errs().indent(cs.solverState->getCurrentIndent())
17451743
<< "<<< Disjunction "
17461744
<< disjunction->getNestedConstraints()[0]->getFirstType()->getString(
1747-
PO)
1745+
PrintOptions::forDebugging())
17481746
<< " with score " << bestScore << "\n";
17491747
}
17501748

@@ -1774,8 +1772,7 @@ static void determineBestChoicesInContext(
17741772
}
17751773

17761774
if (cs.isDebugMode() && bestOverallScore > 0) {
1777-
PrintOptions PO;
1778-
PO.PrintTypesForDebugging = true;
1775+
PrintOptions PO = PrintOptions::forDebugging();
17791776

17801777
auto getLogger = [&](unsigned extraIndent = 0) -> llvm::raw_ostream & {
17811778
return llvm::errs().indent(cs.solverState->getCurrentIndent() +

‎lib/Sema/CSSimplify.cpp‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13439,12 +13439,9 @@ bool ConstraintSystem::simplifyAppliedOverloadsImpl(
1343913439
// If we have a common result type, bind the expected result type to it.
1344013440
if (commonResultType && !commonResultType->is<ErrorType>()) {
1344113441
if (isDebugMode()) {
13442-
PrintOptions PO;
13443-
PO.PrintTypesForDebugging = true;
1344413442
llvm::errs().indent(solverState ? solverState->getCurrentIndent() : 0)
13445-
<< "(common result type for $T" << fnTypeVar->getID() << " is "
13446-
<< commonResultType.getString(PO)
13447-
<< ")\n";
13443+
<< "(common result type for $T" << fnTypeVar->getID() << " is "
13444+
<< commonResultType.getString(PrintOptions::forDebugging()) << ")\n";
1344813445
}
1344913446

1345013447
// Introduction of a `Bind` constraint here could result in the disconnect

‎lib/Sema/CSStep.cpp‎

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -280,13 +280,11 @@ StepResult ComponentStep::take(bool prevFailed) {
280280
CS.collectDisjunctions(disjunctions);
281281
std::vector<std::string> overloadDisjunctions;
282282
for (const auto &disjunction : disjunctions) {
283-
PrintOptions PO;
284-
PO.PrintTypesForDebugging = true;
285-
286283
auto constraints = disjunction->getNestedConstraints();
287284
if (constraints[0]->getKind() == ConstraintKind::BindOverload)
288285
overloadDisjunctions.push_back(
289-
constraints[0]->getFirstType()->getString(PO));
286+
constraints[0]->getFirstType()->getString(
287+
PrintOptions::forDebugging()));
290288
}
291289

292290
if (!potentialBindings.empty() || !overloadDisjunctions.empty()) {
@@ -357,14 +355,11 @@ StepResult ComponentStep::take(bool prevFailed) {
357355
// we can't solve this system unless we have free type variables
358356
// allowed in the solution.
359357
if (CS.isDebugMode()) {
360-
PrintOptions PO;
361-
PO.PrintTypesForDebugging = true;
362-
363358
auto &log = getDebugLogger();
364359
log << "(failed due to free variables:";
365360
for (auto *typeVar : CS.getTypeVariables()) {
366361
if (!typeVar->getImpl().hasRepresentativeOrFixed()) {
367-
log << " " << typeVar->getString(PO);
362+
log << " " << typeVar->getString(PrintOptions::forDebugging());
368363
}
369364
}
370365
log << ")\n";

‎lib/Sema/CSStep.h‎

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -407,15 +407,12 @@ class ComponentStep final : public SolverStep {
407407
auto &log = getDebugLogger();
408408
log << "Type variables in scope = "
409409
<< "[";
410-
auto typeVars = CS.getTypeVariables();
411-
PrintOptions PO;
412-
PO.PrintTypesForDebugging = true;
413-
interleave(typeVars, [&](TypeVariableType *typeVar) {
414-
Type(typeVar).print(log, PO);
415-
},
416-
[&] {
417-
log << ", ";
418-
});
410+
interleave(
411+
CS.getTypeVariables(),
412+
[&](TypeVariableType *typeVar) {
413+
Type(typeVar).print(log, PrintOptions::forDebugging());
414+
},
415+
[&] { log << ", "; });
419416
log << "]" << '\n';
420417
}
421418

@@ -553,9 +550,8 @@ class TypeVariableStep final : public BindingStep<TypeVarBindingProducer> {
553550
StepResult resume(bool prevFailed) override;
554551

555552
void print(llvm::raw_ostream &Out) override {
556-
PrintOptions PO;
557-
PO.PrintTypesForDebugging = true;
558-
Out << "TypeVariableStep for " << TypeVar->getString(PO) << '\n';
553+
Out << "TypeVariableStep for ";
554+
Out << TypeVar->getString(PrintOptions::forDebugging()) << '\n';
559555
}
560556

561557
protected:

‎lib/Sema/CSTrail.cpp‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -577,8 +577,7 @@ void SolverTrail::Change::undo(ConstraintSystem &cs) const {
577577
void SolverTrail::Change::dump(llvm::raw_ostream &out,
578578
ConstraintSystem &cs,
579579
unsigned indent) const {
580-
PrintOptions PO;
581-
PO.PrintTypesForDebugging = true;
580+
PrintOptions PO = PrintOptions::forDebugging();
582581

583582
out.indent(indent);
584583

@@ -887,8 +886,7 @@ void SolverTrail::dumpActiveScopeChanges(llvm::raw_ostream &out,
887886
llvm::set_subtract(removedConstraints, intersects);
888887

889888
// Print out Changes.
890-
PrintOptions PO;
891-
PO.PrintTypesForDebugging = true;
889+
PrintOptions PO = PrintOptions::forDebugging();
892890
out.indent(indent);
893891
out << "(Changes:\n";
894892
if (!addedTypeVars.empty()) {

‎lib/Sema/Constraint.cpp‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -338,8 +338,7 @@ ProtocolDecl *Constraint::getProtocol() const {
338338
void Constraint::print(llvm::raw_ostream &Out, SourceManager *sm,
339339
unsigned indent, bool skipLocator) const {
340340
// Print all type variables as $T0 instead of _ here.
341-
PrintOptions PO;
342-
PO.PrintTypesForDebugging = true;
341+
PrintOptions PO = PrintOptions::forDebugging();
343342

344343
if (Kind == ConstraintKind::Disjunction ||
345344
Kind == ConstraintKind::Conjunction) {

0 commit comments

Comments
 (0)