Skip to content

Commit cc23c25

Browse files
hamishknighthamishknight
authored
Merge pull request #80535 from hamishknight/cap-req
[Sema] Requestify PatternBindingDecl capture computation
2 parents 91e730a + 0a78fb3 commit cc23c25

File tree

11 files changed

+123
-57
lines changed

11 files changed

+123
-57
lines changed

‎include/swift/AST/Decl.h‎

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2284,6 +2284,7 @@ class PatternBindingEntry {
22842284
// Flags::Checked.
22852285
friend class PatternBindingEntryRequest;
22862286
friend class PatternBindingCheckedAndContextualizedInitRequest;
2287+
friend class PatternBindingCaptureInfoRequest;
22872288

22882289
bool isFullyValidated() const {
22892290
return InitContextAndFlags.getInt().contains(
@@ -2432,8 +2433,20 @@ class PatternBindingEntry {
24322433
/// from the source range.
24332434
SourceRange getSourceRange(bool omitAccessors = false) const;
24342435

2435-
CaptureInfo getCaptureInfo() const { return Captures; }
2436-
void setCaptureInfo(CaptureInfo captures) { Captures = captures; }
2436+
/// Retrieve the computed capture info, or \c nullopt if it hasn't been
2437+
/// computed yet.
2438+
std::optional<CaptureInfo> getCachedCaptureInfo() const {
2439+
if (!Captures.hasBeenComputed())
2440+
return std::nullopt;
2441+
2442+
return Captures;
2443+
}
2444+
2445+
void setCaptureInfo(CaptureInfo captures) {
2446+
ASSERT(!Captures.hasBeenComputed());
2447+
ASSERT(captures.hasBeenComputed());
2448+
Captures = captures;
2449+
}
24372450

24382451
private:
24392452
SourceLoc getLastAccessorEndLoc() const;
@@ -2457,6 +2470,7 @@ class PatternBindingDecl final : public Decl,
24572470
friend class Decl;
24582471
friend class PatternBindingEntryRequest;
24592472
friend class PatternBindingCheckedAndContextualizedInitRequest;
2473+
friend class PatternBindingCaptureInfoRequest;
24602474

24612475
SourceLoc StaticLoc; ///< Location of the 'static/class' keyword, if present.
24622476
SourceLoc VarLoc; ///< Location of the 'var' keyword.
@@ -2636,13 +2650,9 @@ class PatternBindingDecl final : public Decl,
26362650
getMutablePatternList()[i].setInitContext(init);
26372651
}
26382652

2639-
CaptureInfo getCaptureInfo(unsigned i) const {
2640-
return getPatternList()[i].getCaptureInfo();
2641-
}
2642-
2643-
void setCaptureInfo(unsigned i, CaptureInfo captures) {
2644-
getMutablePatternList()[i].setCaptureInfo(captures);
2645-
}
2653+
/// Retrieve the capture info for the initializer at the given index,
2654+
/// computing if needed.
2655+
CaptureInfo getCaptureInfo(unsigned i) const;
26462656

26472657
/// Given that this PBD is the parent pattern for the specified VarDecl,
26482658
/// return the entry of the VarDecl in our PatternList. For example, in:

‎include/swift/AST/TypeCheckRequests.h‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5134,6 +5134,26 @@ class ParamCaptureInfoRequest :
51345134
void cacheResult(CaptureInfo value) const;
51355135
};
51365136

5137+
class PatternBindingCaptureInfoRequest
5138+
: public SimpleRequest<PatternBindingCaptureInfoRequest,
5139+
CaptureInfo(PatternBindingDecl *, unsigned),
5140+
RequestFlags::SeparatelyCached> {
5141+
public:
5142+
using SimpleRequest::SimpleRequest;
5143+
5144+
private:
5145+
friend SimpleRequest;
5146+
5147+
CaptureInfo evaluate(Evaluator &evaluator, PatternBindingDecl *PBD,
5148+
unsigned idx) const;
5149+
5150+
public:
5151+
// Separate caching.
5152+
bool isCached() const { return true; }
5153+
std::optional<CaptureInfo> getCachedResult() const;
5154+
void cacheResult(CaptureInfo info) const;
5155+
};
5156+
51375157
class SuppressesConformanceRequest
51385158
: public SimpleRequest<SuppressesConformanceRequest,
51395159
bool(NominalTypeDecl *decl, KnownProtocolKind kp),

‎include/swift/AST/TypeCheckerTypeIDZone.def‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -608,6 +608,9 @@ SWIFT_REQUEST(TypeChecker, CaptureInfoRequest,
608608
SWIFT_REQUEST(TypeChecker, ParamCaptureInfoRequest,
609609
CaptureInfo(ParamDecl *),
610610
SeparatelyCached, NoLocationInfo)
611+
SWIFT_REQUEST(TypeChecker, PatternBindingCaptureInfoRequest,
612+
CaptureInfo(PatternBindingDecl *, unsigned),
613+
SeparatelyCached, NoLocationInfo)
611614
SWIFT_REQUEST(TypeChecker, CustomDerivativesRequest,
612615
CustomDerivativesResult(SourceFile *),
613616
Cached, NoLocationInfo)

‎lib/AST/Decl.cpp‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2291,6 +2291,13 @@ PatternBindingDecl *PatternBindingDecl::createDeserialized(
22912291
return PBD;
22922292
}
22932293

2294+
CaptureInfo PatternBindingDecl::getCaptureInfo(unsigned i) const {
2295+
auto *mutableThis = const_cast<PatternBindingDecl *>(this);
2296+
PatternBindingCaptureInfoRequest req(mutableThis, i);
2297+
return evaluateOrDefault(getASTContext().evaluator, req,
2298+
CaptureInfo::empty());
2299+
}
2300+
22942301
PatternBindingInitializer *
22952302
PatternBindingInitializer::createDeserialized(PatternBindingDecl *PBD,
22962303
unsigned index) {

‎lib/AST/TypeCheckRequests.cpp‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2744,6 +2744,23 @@ void ParamCaptureInfoRequest::cacheResult(CaptureInfo info) const {
27442744
param->setDefaultArgumentCaptureInfo(info);
27452745
}
27462746

2747+
//----------------------------------------------------------------------------//
2748+
// PatternBindingCaptureInfoRequest caching.
2749+
//----------------------------------------------------------------------------//
2750+
2751+
std::optional<CaptureInfo>
2752+
PatternBindingCaptureInfoRequest::getCachedResult() const {
2753+
auto *PBD = std::get<0>(getStorage());
2754+
auto idx = std::get<1>(getStorage());
2755+
return PBD->getPatternList()[idx].getCachedCaptureInfo();
2756+
}
2757+
2758+
void PatternBindingCaptureInfoRequest::cacheResult(CaptureInfo info) const {
2759+
auto *PBD = std::get<0>(getStorage());
2760+
auto idx = std::get<1>(getStorage());
2761+
PBD->getMutablePatternList()[idx].setCaptureInfo(info);
2762+
}
2763+
27472764
//----------------------------------------------------------------------------//
27482765
// SemanticAvailableAttrRequest computation.
27492766
//----------------------------------------------------------------------------//

‎lib/Sema/TypeCheckCaptures.cpp‎

Lines changed: 22 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -856,43 +856,30 @@ CaptureInfo ParamCaptureInfoRequest::evaluate(Evaluator &evaluator,
856856
return finder.getCaptureInfo();
857857
}
858858

859-
static bool isLazy(PatternBindingDecl *PBD) {
860-
if (auto var = PBD->getSingleVar())
861-
return var->getAttrs().hasAttribute<LazyAttr>();
862-
return false;
863-
}
864-
865-
void TypeChecker::checkPatternBindingCaptures(IterableDeclContext *DC) {
866-
for (auto member : DC->getMembers()) {
867-
// Ignore everything other than PBDs.
868-
auto *PBD = dyn_cast<PatternBindingDecl>(member);
869-
if (!PBD) continue;
870-
// Walk the initializers for all properties declared in the type with
871-
// an initializer.
872-
for (unsigned i : range(PBD->getNumPatternEntries())) {
873-
if (PBD->isInitializerSubsumed(i))
874-
continue;
859+
CaptureInfo PatternBindingCaptureInfoRequest::evaluate(Evaluator &evaluator,
860+
PatternBindingDecl *PBD,
861+
unsigned int idx) const {
862+
auto *init = PBD->getExecutableInit(idx);
863+
if (!init)
864+
return CaptureInfo::empty();
875865

876-
auto *init = PBD->getInit(i);
877-
if (init == nullptr)
878-
continue;
866+
// Only have captures when we have a PatternBindingInitializer context, i.e
867+
// local variables don't have captures.
868+
auto *DC = PBD->getInitContext(idx);
869+
if (!DC)
870+
return CaptureInfo::empty();
879871

880-
auto *DC = PBD->getInitContext(i);
881-
FindCapturedVars finder(init->getLoc(),
882-
DC,
883-
/*NoEscape=*/false,
884-
/*ObjC=*/false,
885-
/*IsGenericFunction*/false);
886-
init->walk(finder);
887-
888-
auto &ctx = DC->getASTContext();
889-
if (finder.getDynamicSelfCaptureLoc().isValid() && !isLazy(PBD)) {
890-
ctx.Diags.diagnose(finder.getDynamicSelfCaptureLoc(),
891-
diag::dynamic_self_stored_property_init);
892-
}
872+
FindCapturedVars finder(init->getLoc(), DC,
873+
/*NoEscape=*/false,
874+
/*ObjC=*/false,
875+
/*IsGenericFunction*/ false);
876+
init->walk(finder);
893877

894-
auto captures = finder.getCaptureInfo();
895-
PBD->setCaptureInfo(i, captures);
896-
}
878+
auto &ctx = DC->getASTContext();
879+
if (finder.getDynamicSelfCaptureLoc().isValid()) {
880+
ctx.Diags.diagnose(finder.getDynamicSelfCaptureLoc(),
881+
diag::dynamic_self_stored_property_init);
897882
}
883+
884+
return finder.getCaptureInfo();
898885
}

‎lib/Sema/TypeCheckDeclPrimary.cpp‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3233,8 +3233,6 @@ class DeclChecker : public DeclVisitor<DeclChecker> {
32333233
diagnoseMissingExplicitSendable(ED);
32343234
checkAccessControl(ED);
32353235

3236-
TypeChecker::checkPatternBindingCaptures(ED);
3237-
32383236
auto &DE = Ctx.Diags;
32393237
if (auto rawTy = ED->getRawType()) {
32403238
// The raw type must be one of the blessed literal convertible types.
@@ -3304,8 +3302,6 @@ class DeclChecker : public DeclVisitor<DeclChecker> {
33043302
visit(Member);
33053303
}
33063304

3307-
TypeChecker::checkPatternBindingCaptures(SD);
3308-
33093305
checkInheritanceClause(SD);
33103306
diagnoseMissingExplicitSendable(SD);
33113307

@@ -3487,8 +3483,6 @@ class DeclChecker : public DeclVisitor<DeclChecker> {
34873483
for (Decl *Member : CD->getABIMembers())
34883484
visit(Member);
34893485

3490-
TypeChecker::checkPatternBindingCaptures(CD);
3491-
34923486
// If this class requires all of its stored properties to have
34933487
// in-class initializers, diagnose this now.
34943488
if (CD->requiresStoredPropertyInits())
@@ -4071,8 +4065,6 @@ class DeclChecker : public DeclVisitor<DeclChecker> {
40714065
for (Decl *Member : ED->getMembers())
40724066
visit(Member);
40734067

4074-
TypeChecker::checkPatternBindingCaptures(ED);
4075-
40764068
TypeChecker::checkConformancesInContext(ED);
40774069

40784070
checkAccessControl(ED);

‎lib/Sema/TypeCheckStorage.cpp‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -619,6 +619,9 @@ static void checkAndContextualizePatternBindingInit(PatternBindingDecl *binding,
619619
auto *init = binding->getInit(i);
620620
TypeChecker::contextualizeExpr(init, initContext);
621621
}
622+
623+
// Compute captures in case diagnostics are emitted.
624+
(void)binding->getCaptureInfo(i);
622625
}
623626

624627
Expr *PatternBindingCheckedAndContextualizedInitRequest::evaluate(

‎lib/Sema/TypeChecker.h‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -798,9 +798,6 @@ bool typeCheckForEachPreamble(DeclContext *dc, ForEachStmt *stmt);
798798
/// Compute the set of captures for the given closure.
799799
void computeCaptures(AbstractClosureExpr *ACE);
800800

801-
/// Check for invalid captures from stored property initializers.
802-
void checkPatternBindingCaptures(IterableDeclContext *DC);
803-
804801
/// Update the DeclContexts for AST nodes in a given DeclContext. This is
805802
/// necessary after type-checking since autoclosures may have been introduced.
806803
void contextualizeExpr(Expr *E, DeclContext *DC);

‎test/Macros/Inputs/syntax_macro_definitions.swift‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2134,6 +2134,20 @@ public struct VarValueMacro: DeclarationMacro, PeerMacro {
21342134
}
21352135
}
21362136

2137+
struct StoredPropertyMacro: DeclarationMacro {
2138+
public static func expansion(
2139+
of node: some FreestandingMacroExpansionSyntax,
2140+
in context: some MacroExpansionContext
2141+
) throws -> [DeclSyntax] {
2142+
guard let argument = node.arguments.first?.expression else {
2143+
fatalError("boom")
2144+
}
2145+
return [
2146+
"var storedProperty = \(argument)"
2147+
]
2148+
}
2149+
}
2150+
21372151
public struct GenericToVoidMacro: ExpressionMacro {
21382152
public static func expansion(
21392153
of node: some FreestandingMacroExpansionSyntax,

0 commit comments

Comments
 (0)