[RGen] Add support to inline protocol factory methods as constructors. #23812

mandel-macaque · 2025-09-12T18:27:12Z

This change allows to inline the factory methods found in protocols as constructors.

This allows to convert the method marked as factories in a protocol into constructors, later we can use this conversion to inline the factory methods as constructors in the classes that implement a protocol with factories.

This change allows to inline the factory methods found in protocols as constructors.

rolfbjarne · 2025-09-16T07:09:40Z

tests/rgen/Microsoft.Macios.Generator.Tests/Classes/Data/InlineProtocolConstructors.cs

+[BindingType<ObjCBindings.Protocol>]
+public partial interface IMyNSCoding {
+
+	[Export<Method> ("initWithCoder:", Flags = Method.Factory)]
+	public virtual partial IMyNSCoding CreateWithCoder (NSObject coder);
+}
+
+[SupportedOSPlatform ("macos")]
+[SupportedOSPlatform ("ios")]
+[SupportedOSPlatform ("tvos")]
+[SupportedOSPlatform ("maccatalyst13.1")]
+[BindingType<Class>]
+public partial class InlineProtocolConstructors : IMyNSCoding {
+	// we are testing that the protocol constructor is added.  
+}


What happens in this case (the class already has a constructor with the same selector or even just overload)?

[BindingType<ObjCBindings.Protocol>] public partial interface IMyNSCoding { [Export<Method> ("initWithCoder:", Flags = Method.Factory)] public virtual partial IMyNSCoding CreateWithCoder (NSObject coder); } [BindingType<Class>] public partial class InlineProtocolConstructors1 : IMyNSCoding { // we are testing that the protocol constructor is added. [Export<Method> ("initWithCoder:")] public partial InlineProtocolConstructors1 (NSObject coder); } [BindingType<Class>] public partial class InlineProtocolConstructors2 : IMyNSCoding { // we are testing that the protocol constructor is added. [Export<Method> ("initWithWhatever:")] public partial InlineProtocolConstructors2 (NSObject whatever); }

In either case, I think you'll have to just not inline the constructor.

We already do that, if you check there is a dict that will merge constructors and will ignore those coming from the protocol that have the same selector.

Nevertheless the review is valid, I will add those test cases to show we already do that.

If a protocola and a class have constructors that are overloaded, detect that and use the one in the class instead of inlining the protocol one.

vs-mobiletools-engineering-service2 · 2025-09-16T15:26:19Z

✅ [PR Build #88b25b0] Build passed (Detect API changes) ✅

Pipeline on Agent
Hash: 88b25b0243c58f858646e6cc7b23bf03d3339c72 [PR build]

vs-mobiletools-engineering-service2 · 2025-09-16T15:52:23Z

✅ API diff for current PR / commit

.NET ( No breaking changes )

iOS: vsdrops gist ( No breaking changes )
tvOS: vsdrops gist ( No breaking changes )
MacCatalyst: vsdrops gist ( No breaking changes )
macOS: vsdrops gist ( No breaking changes )

✅ API diff vs stable

.NET ( No breaking changes )

iOS: vsdrops gist ( No breaking changes )
tvOS: vsdrops gist ( No breaking changes )
MacCatalyst: vsdrops gist ( No breaking changes )
macOS: vsdrops gist ( No breaking changes )

ℹ️ Generator diff

Generator Diff: vsdrops (html) vsdrops (raw diff) gist (raw diff) - Please review changes)

Pipeline on Agent
Hash: 88b25b0243c58f858646e6cc7b23bf03d3339c72 [PR build]

vs-mobiletools-engineering-service2 · 2025-09-16T15:53:11Z

✅ [CI Build #88b25b0] Build passed (Build packages) ✅

Pipeline on Agent
Hash: 88b25b0243c58f858646e6cc7b23bf03d3339c72 [PR build]

vs-mobiletools-engineering-service2 · 2025-09-16T16:25:12Z

✅ [CI Build #88b25b0] Build passed (Build macOS tests) ✅

Pipeline on Agent
Hash: 88b25b0243c58f858646e6cc7b23bf03d3339c72 [PR build]

vs-mobiletools-engineering-service2 · 2025-09-16T16:39:42Z

💻 [CI Build #88b25b0] Tests on macOS X64 - Mac Sonoma (14) passed 💻

✅ All tests on macOS X64 - Mac Sonoma (14) passed.

Pipeline on Agent
Hash: 88b25b0243c58f858646e6cc7b23bf03d3339c72 [PR build]

vs-mobiletools-engineering-service2 · 2025-09-16T16:46:11Z

❌ [CI Build #88b25b0] Tests on macOS arm64 - Mac Sequoia (15) failed ❌

Failed tests are:

monotouch-test

Pipeline on Agent
Hash: 88b25b0243c58f858646e6cc7b23bf03d3339c72 [PR build]

vs-mobiletools-engineering-service2 · 2025-09-16T16:46:41Z

💻 [CI Build #88b25b0] Tests on macOS M1 - Mac Monterey (12) passed 💻

✅ All tests on macOS M1 - Mac Monterey (12) passed.

Pipeline on Agent
Hash: 88b25b0243c58f858646e6cc7b23bf03d3339c72 [PR build]

vs-mobiletools-engineering-service2 · 2025-09-16T16:47:03Z

💻 [CI Build #88b25b0] Tests on macOS M1 - Mac Ventura (13) passed 💻

✅ All tests on macOS M1 - Mac Ventura (13) passed.

Pipeline on Agent
Hash: 88b25b0243c58f858646e6cc7b23bf03d3339c72 [PR build]

vs-mobiletools-engineering-service2 · 2025-09-16T18:26:31Z

🚀 [CI Build #88b25b0] Test results 🚀

Test results

✅ All tests passed on VSTS: test results.

🎉 All 115 tests passed 🎉

Tests counts

✅ cecil: All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (iOS): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (MacCatalyst): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (macOS): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (Multiple platforms): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (tvOS): All 1 tests passed. Html Report (VSDrops) Download
✅ framework: All 2 tests passed. Html Report (VSDrops) Download
✅ fsharp: All 4 tests passed. Html Report (VSDrops) Download
✅ generator: All 5 tests passed. Html Report (VSDrops) Download
✅ interdependent-binding-projects: All 4 tests passed. Html Report (VSDrops) Download
✅ introspection: All 4 tests passed. Html Report (VSDrops) Download
✅ linker: All 44 tests passed. Html Report (VSDrops) Download
✅ monotouch (iOS): All 8 tests passed. Html Report (VSDrops) Download
✅ monotouch (MacCatalyst): All 11 tests passed. Html Report (VSDrops) Download
✅ monotouch (macOS): All 9 tests passed. Html Report (VSDrops) Download
✅ monotouch (tvOS): All 8 tests passed. Html Report (VSDrops) Download
✅ msbuild: All 2 tests passed. Html Report (VSDrops) Download
✅ windows: All 3 tests passed. Html Report (VSDrops) Download
✅ xcframework: All 4 tests passed. Html Report (VSDrops) Download
✅ xtro: All 1 tests passed. Html Report (VSDrops) Download

Pipeline on Agent
Hash: 88b25b0243c58f858646e6cc7b23bf03d3339c72 [PR build]

mandel-macaque added 3 commits September 12, 2025 12:46

[RGen] Add support to inline protocol factory methods as constructors.

cbba4a3

This change allows to inline the factory methods found in protocols as constructors.

Avoid issues with duplicated selectors.

0ced42c

This comment has been minimized.

Sign in to view

dalexsoto approved these changes Sep 15, 2025

View reviewed changes

Base automatically changed from dev/mandel/method-to-constructor to main September 15, 2025 14:58

mandel-macaque and others added 2 commits September 15, 2025 18:02

Merge branch 'main' into dev/mandel/inline-factory-method-constructor

03997f0

Auto-format source code

3775c99

This comment has been minimized.

Sign in to view

rolfbjarne requested changes Sep 16, 2025

View reviewed changes

mandel-macaque and others added 3 commits September 16, 2025 10:02

Merge branch 'main' into dev/mandel/inline-factory-method-constructor

0871fdc

Deal with overloaded constructors.

4631f37

If a protocola and a class have constructors that are overloaded, detect that and use the one in the class instead of inlining the protocol one.

Auto-format source code

88b25b0

rolfbjarne approved these changes Sep 16, 2025

View reviewed changes

This comment has been minimized.

Sign in to view

mandel-macaque merged commit 7eb6a1e into main Sep 16, 2025
38 of 40 checks passed

mandel-macaque deleted the dev/mandel/inline-factory-method-constructor branch September 16, 2025 19:04

[RGen] Add support to inline protocol factory methods as constructors. #23812

[RGen] Add support to inline protocol factory methods as constructors. #23812

Uh oh!

Conversation

mandel-macaque commented Sep 12, 2025

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

rolfbjarne Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

mandel-macaque Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

vs-mobiletools-engineering-service2 commented Sep 16, 2025

✅ [PR Build #88b25b0] Build passed (Detect API changes) ✅

Uh oh!

This comment has been minimized.

This comment has been minimized.

vs-mobiletools-engineering-service2 commented Sep 16, 2025

✅ API diff for current PR / commit

✅ API diff vs stable

ℹ️ Generator diff

Uh oh!

vs-mobiletools-engineering-service2 commented Sep 16, 2025

✅ [CI Build #88b25b0] Build passed (Build packages) ✅

Uh oh!

This comment has been minimized.

vs-mobiletools-engineering-service2 commented Sep 16, 2025

✅ [CI Build #88b25b0] Build passed (Build macOS tests) ✅

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

vs-mobiletools-engineering-service2 commented Sep 16, 2025

💻 [CI Build #88b25b0] Tests on macOS X64 - Mac Sonoma (14) passed 💻

Uh oh!

This comment has been minimized.

vs-mobiletools-engineering-service2 commented Sep 16, 2025

❌ [CI Build #88b25b0] Tests on macOS arm64 - Mac Sequoia (15) failed ❌

Uh oh!

vs-mobiletools-engineering-service2 commented Sep 16, 2025

💻 [CI Build #88b25b0] Tests on macOS M1 - Mac Monterey (12) passed 💻

Uh oh!

vs-mobiletools-engineering-service2 commented Sep 16, 2025

💻 [CI Build #88b25b0] Tests on macOS M1 - Mac Ventura (13) passed 💻

Uh oh!

This comment has been minimized.

vs-mobiletools-engineering-service2 commented Sep 16, 2025

🚀 [CI Build #88b25b0] Test results 🚀

Test results

Tests counts

Uh oh!