[Macros] Generalize `conformance` macros as `extension` macros #66967

hborla · 2023-06-28T00:05:02Z

This change adds a generalization of conformance macros as extension macros (swiftlang/swift-evolution#2090)

hborla · 2023-06-28T02:34:15Z

swiftlang/swift-syntax#1859

@swift-ci please smoke test

hborla · 2023-06-28T04:57:54Z

swiftlang/swift-syntax#1859

@swift-ci please smoke test

attribute.

hborla · 2023-06-28T07:43:17Z

swiftlang/swift-syntax#1859

@swift-ci please smoke test

bnbarham

There's various IDE tests that need to be updated as well:

test/IDE/complete_macros.swift
test/IDE/complete_macros_expanded.swift
test/IDE/complete_macro_attribute.swift
test/Index/index_macros.swift

I believe all but complete_macro_attribute.swift should work, getAttributeDeclParamCompletions needs to be updated for complete_macro_attribute.swift. Happy for this to be a separate PR as well, doesn't need to block this one.

bnbarham · 2023-06-28T17:24:44Z

lib/ASTGen/Sources/ASTGen/Macros.swift

@@ -60,14 +60,15 @@ enum MacroPluginKind: UInt8 {
 extension MacroRole {
  init(rawMacroRole: UInt8) {


Am I missing why swift_ASTGen_expandFreestandingMacro and swift_ASTGen_expandAttachedMacro can't just be updated to take a UInt32 instead?

They could but it's not necessary; swift::MacroRole can only represent 32 distinct roles (because we use it for bitmasking where one bit corresponds to one role)

Sure, it would just avoid the mapping is all 😅

We already do the exact same mapping for serialization::MacroRole. We can probably just have one RawMacroRole that does this mapping between uint32_t and uint8_t values for macro roles.

bnbarham · 2023-06-28T17:31:36Z

lib/Serialization/ModuleFormat.h

    BCArray<IdentifierIDField> // introduced names, where each is encoded as
                               //   - introduced kind
                               //   - base name
                               //   - # of argument labels + 1 (or 0 if none)
                               //   - argument labels
+                               // trialed by introduced conformances


Suggested change

// trialed by introduced conformances

// trailed by introduced conformances

bnbarham · 2023-06-28T17:34:35Z

test/Macros/macro_expand_extensions.swift

+  struct Local<Element> {}
+  // expected-error@-1{{local type cannot have attached extension macro}}
+}
+#endif


Could also test putting @DelegatedConformance on an extension fails?

bnbarham · 2023-06-28T17:55:46Z

test/Macros/macro_expand_extensions.swift

+// RUN: %target-codesign %t/main
+// RUN: %target-run %t/main | %FileCheck %s
+
+@attached(extension, conformances: P, names: named(requirement))


Could test for multiple conformances as well

....finally added in #67889 😅

DougGregor

This looks fantastic! Just a few comments, all of which can be follow-up PRs.

lib/AST/ASTPrinter.cpp

DougGregor · 2023-06-28T18:05:07Z

lib/AST/ConformanceLookupTable.cpp

@@ -286,6 +286,10 @@ void ConformanceLookupTable::updateLookupTable(NominalTypeDecl *nominal,
          ASTContext &ctx = nominal->getASTContext();
          (void)evaluateOrDefault(
              ctx.evaluator, ExpandConformanceMacros{nominal}, { });
+
+          // Expand extension macros.
+          (void)evaluateOrDefault(


This expansion is very "eager", in that we're expanding all extension macros even if they don't provide any conformances. I think it'll be okay for now.

DougGregor · 2023-06-28T18:10:05Z

lib/Sema/TypeCheckAttr.cpp

+      if (resolved->is<ErrorType>()) {
+        attr->setInvalid();
+      } else {
+        typeExpr->setType(MetatypeType::get(resolved));


We'll need to check that this refers to a protocol type (or, I suppose, a protocol composition type).

DougGregor · 2023-06-28T18:13:18Z

lib/Serialization/ModuleFormat.h

 };
-using MacroRoleField = BCFixed<3>;
+using MacroRoleField = BCFixed<4>;


I imagine a horrible hour of debugging behind this.

Yes, that is EXACTLY what happened 😂

…xtension macros.

module interfaces.

hborla · 2023-06-28T21:54:16Z

swiftlang/swift-syntax#1859

@swift-ci please smoke test

hborla · 2023-06-29T00:53:04Z

swiftlang/swift-syntax#1859

@swift-ci please smoke test macOS

hborla · 2023-06-29T04:14:44Z

swiftlang/swift-syntax#1859

@swift-ci please smoke test macOS

DougGregor · 2023-06-29T05:36:15Z

lib/AST/Attr.cpp

@@ -1371,6 +1371,13 @@ bool DeclAttribute::printImpl(ASTPrinter &Printer, const PrintOptions &Options,

  case DAK_MacroRole: {
    auto Attr = cast<MacroRoleAttr>(this);
+
+    // Suppress @attached(extension) if needed.
+    if (!Options.PrintExtensionMacroAttributes &&


Fantastic, thank you!

source location.

hborla · 2023-06-29T06:16:24Z

swiftlang/swift-syntax#1859

@swift-ci please smoke test

hborla · 2023-06-29T13:45:11Z

swiftlang/swift-syntax#1859

@swift-ci please smoke test Linux

hborla force-pushed the extension-macro branch 2 times, most recently from a69c99d to b8b71fb Compare June 28, 2023 02:25

hborla added 2 commits June 27, 2023 21:22

[Macros] Implement attached extension macros.

725374e

[Macros] Pass a qualified extended type to extension macro expansion.

d3e2562

hborla force-pushed the extension-macro branch from b8b71fb to d3e2562 Compare June 28, 2023 04:22

[Macros] Ban extension macros attached to local types.

095542a

[Macros] Allow extension macros to specify conformances in the attached

c867c7c

attribute.

hborla marked this pull request as ready for review June 28, 2023 07:43

hborla requested review from ahoppen, bnbarham, rintaro, slavapestov, xedin, CodaFi, DougGregor, zoecarver and tshortli as code owners June 28, 2023 07:43

This was referenced Jun 28, 2023

[Macros] Add attached extension macros. swiftlang/swift-syntax#1859

Merged

[5.9][Macros] Generalize conformance macros as extension macros #66982

Merged

bnbarham reviewed Jun 28, 2023

View reviewed changes

DougGregor approved these changes Jun 28, 2023

View reviewed changes

hborla added 2 commits June 28, 2023 13:56

[ASTGen] Sync PluginMessages.swift with the SwiftSyntax changes for e…

c3bdae6

…xtension macros.

[Macros] Allow @attached(extension) attributes to be suppressed in

81a1f64

module interfaces.

hborla changed the title ~~[Macros] Implement attached extension macros.~~ [Macros] Generalize conformance macros as extension macros Jun 28, 2023

DougGregor reviewed Jun 29, 2023

View reviewed changes

hborla added 2 commits June 28, 2023 22:56

[ASTGen] The 'extendedType' argument for attached macros does not have a

43e2026

source location.

[Macros] Add a macro plugin test for extension macros.

7e85ebd

hborla merged commit 7a46466 into swiftlang:main Jun 29, 2023

hborla deleted the extension-macro branch June 29, 2023 15:57

		@@ -60,14 +60,15 @@ enum MacroPluginKind: UInt8 {
		extension MacroRole {
		init(rawMacroRole: UInt8) {

	// trialed by introduced conformances
	// trailed by introduced conformances

[Macros] Generalize conformance macros as extension macros #66967

[Macros] Generalize conformance macros as extension macros #66967

Uh oh!

Conversation

hborla commented Jun 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hborla commented Jun 28, 2023

Uh oh!

hborla commented Jun 28, 2023

Uh oh!

hborla commented Jun 28, 2023

Uh oh!

bnbarham left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DougGregor left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hborla commented Jun 28, 2023

Uh oh!

hborla commented Jun 29, 2023

Uh oh!

hborla commented Jun 29, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hborla commented Jun 29, 2023

Uh oh!

hborla commented Jun 29, 2023

Uh oh!

Uh oh!

[Macros] Generalize `conformance` macros as `extension` macros #66967

[Macros] Generalize `conformance` macros as `extension` macros #66967

hborla commented Jun 28, 2023 •

edited

Loading