[RGen] Generate the StrongDelegates property for a WeakDelegate. #23232

mandel-macaque · 2025-06-28T01:12:50Z

This commit allows to generate the strong delegate for a weak delegate in a bindings. The API provides two ways to configure the strong property:

StrongDelegateType: provide a Type for the new property.
StrongDelegateName: Allow to choose the generated property name. If empty the name will be the name of the WeakDelefate with the Weak prefix removed.

We have some tests updates:

Remove the warnings from the tests. Some are due to the API being experimenta, other due to a rename. We will remove all errors in a comming PR.
Remove the strong delegate property from the test source since it is now generated.

This completes the work for support properties (so far).

WeakDelegate properties are marched as a ArgumentSemantic.Weak which in a normal case would mean that we do not mark them as dirty, but that is not the case for eak delegates since we do know we provide a strong delegate in the class. For example bgen will generate the following for a weak delegate: ```csharp [BindingImpl (BindingImplOptions.GeneratedCode | BindingImplOptions.Optimizable)] object? __mt_WeakDataSource_var; [BindingImpl (BindingImplOptions.GeneratedCode | BindingImplOptions.Optimizable)] public virtual NSObject? WeakDataSource { [Export ("dataSource", ArgumentSemantic.Weak)] get { global::UIKit.UIApplication.EnsureUIThread (); NSObject? ret; if (IsDirectBinding) { ret = Runtime.GetNSObject (global::ObjCRuntime.Messaging.NativeHandle_objc_msgSend (this.Handle, Selector.GetHandle ("dataSource")), false)!; } else { ret = Runtime.GetNSObject (global::ObjCRuntime.Messaging.NativeHandle_objc_msgSendSuper (this.SuperHandle, Selector.GetHandle ("dataSource")), false)!; } MarkDirty (); __mt_WeakDataSource_var = ret; return ret!; } [Export ("setDataSource:", ArgumentSemantic.Weak)] set { global::UIKit.UIApplication.EnsureUIThread (); var value__handle__ = value.GetHandle (); if (IsDirectBinding) { global::ObjCRuntime.Messaging.void_objc_msgSend_NativeHandle (this.Handle, Selector.GetHandle ("setDataSource:"), value__handle__); } else { global::ObjCRuntime.Messaging.void_objc_msgSendSuper_NativeHandle (this.SuperHandle, Selector.GetHandle ("setDataSource:"), value__handle__); } GC.KeepAlive (value); MarkDirty (); __mt_WeakDataSource_var = value; } } ``` And the followign for the strong delegate: ```csharp [BindingImpl (BindingImplOptions.GeneratedCode | BindingImplOptions.Optimizable)] public IQLPreviewControllerDataSource DataSource { get { return (WeakDataSource as IQLPreviewControllerDataSource)!; } set { var rvalue = value as NSObject; if (!(value is null) && rvalue is null) throw new ArgumentException ("The object passed of type " + value.GetType () + " does not derive from NSObject"); WeakDataSource = rvalue; } } ``` With this commit the same happens for rgen. This is not the complete fix because we will need to still generate the strong delegate in rgen, that will happen in follow up change (needs a new flag/api to mark the property).

This commit allows to generate the strong delegate for a weak delegate in a bindings. The API provides two ways to configure the strong property: 1. StrongDelegateType: provide a Type for the new property. 2. StrongDelegateName: Allow to choose the generated property name. If empty the name will be the name of the WeakDelefate with the Weak prefix removed. We have some tests updates: 1. Remove the warnings from the tests. Some are due to the API being experimenta, other due to a rename. We will remove all errors in a comming PR. 2. Remove the strong delegate property from the test source since it is now generated. This completes the work for support properties (so far).

Copilot

Pull Request Overview

This PR adds support for generating a “strong” wrapper property for any weak delegate in the binding generator. It introduces two new configuration options (StrongDelegateType and StrongDelegateName), implements the ToStrongDelegate transformation, updates the emitter to output the new property, and adjusts many tests to account for the generated code.

Added StrongDelegateType/StrongDelegateName in ExportData and ExportAttribute to configure strong-delegate generation
Implemented Property.ToStrongDelegate() and updated ClassEmitter to emit the new property
Updated tests (GeneralPropertyTests, *ExpectedPropertyTests.cs, etc.) to cover and reflect the new strong-delegate behavior and silenced APL0003 warnings

Reviewed Changes

Copilot reviewed 24 out of 24 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
tests/.../GeneralPropertyTests.cs	New theory testing `ToStrongDelegate` under various flags
tests/.../*ExpectedPropertyTests.cs	Updated expected generated code for array & strong props
src/.../Property.Generator.cs	Added `ToStrongDelegate` method
src/.../ClassEmitter.cs	Emits the strong-delegate property block
src/.../ExportData.cs & ExportAttribute.cs	Added `StrongDelegateType`/`StrongDelegateName` fields
src/.../TypeInfo.cs	Renamed `ToNonNullable()` → `WithNullable(bool)`

Comments suppressed due to low confidence (3)

tests/rgen/Microsoft.Macios.Generator.Tests/DataModel/PropertyTests/GeneralPropertyTests.cs:472

Add a test case for when StrongDelegateName is provided to ensure the generated property uses the custom name instead of just stripping the "Weak" prefix.

	[InlineData (true, true, true, true)] // isProperty, isWeakDelegate, hasStrongDelegateType, shouldChange

src/rgen/Microsoft.Macios.Generator/DataModel/TypeInfo.cs:566

The original ToNonNullable() method was removed; for backward compatibility it may be worth marking it [Obsolete] and forwarding to WithNullable(false) to avoid breaking existing code.

	public TypeInfo WithNullable (bool isNullable)

src/ObjCBindings/ExportAttribute.cs:82

[nitpick] There is a missing space before the { in StrongDelegateName{; update to StrongDelegateName { to match code style guidelines.

		public string? StrongDelegateName { get; set; } = null;

Copilot · 2025-06-28T01:13:54Z

src/rgen/Microsoft.Macios.Generator/DataModel/Property.Generator.cs

+
+		// update the return type, all the rest is the same
+		return this with {
+			Name = ExportPropertyData.Value.StrongDelegateName ?? Name.Remove (0, 4 /* "Weak".Length */),


Using a hard-coded 4 for the "Weak" prefix length is brittle; consider using "Weak".Length as a constant or checking Name.StartsWith("Weak") before removing to avoid mis-removal if the pattern changes.

Suggested change

Name = ExportPropertyData.Value.StrongDelegateName ?? Name.Remove (0, 4 /* "Weak".Length */),

Name = ExportPropertyData.Value.StrongDelegateName ?? (Name.StartsWith("Weak") ? Name.Remove(0, "Weak".Length) : Name),

vs-mobiletools-engineering-service2 · 2025-06-29T16:24:04Z

✅ [CI Build #0ef187d] Build passed (Build packages) ✅

Pipeline on Agent
Hash: 0ef187d9df91ee6b6e110ce32cd13b65140598a0 [PR build]

vs-mobiletools-engineering-service2 · 2025-06-29T16:25:33Z

✅ [PR Build #0ef187d] Build passed (Detect API changes) ✅

Pipeline on Agent
Hash: 0ef187d9df91ee6b6e110ce32cd13b65140598a0 [PR build]

vs-mobiletools-engineering-service2 · 2025-06-29T16:51:46Z

❗ API diff for current PR / commit (Breaking changes)

.NET ( ❗ Breaking changes ❗ )

iOS: vsdrops gist ( ❗ Breaking changes ❗ )
tvOS: vsdrops gist ( ❗ Breaking changes ❗ )
MacCatalyst: vsdrops gist ( ❗ Breaking changes ❗ )
macOS: vsdrops gist ( ❗ 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: 0ef187d9df91ee6b6e110ce32cd13b65140598a0 [PR build]

vs-mobiletools-engineering-service2 · 2025-06-29T16:55:54Z

✅ [CI Build #0ef187d] Build passed (Build macOS tests) ✅

Pipeline on Agent
Hash: 0ef187d9df91ee6b6e110ce32cd13b65140598a0 [PR build]

vs-mobiletools-engineering-service2 · 2025-06-29T17:06:36Z

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

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

Pipeline on Agent
Hash: 0ef187d9df91ee6b6e110ce32cd13b65140598a0 [PR build]

vs-mobiletools-engineering-service2 · 2025-06-29T17:07:05Z

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

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

Pipeline on Agent
Hash: 0ef187d9df91ee6b6e110ce32cd13b65140598a0 [PR build]

vs-mobiletools-engineering-service2 · 2025-06-29T17:08:22Z

💻 [CI Build #0ef187d] Tests on macOS arm64 - Mac Sequoia (15) passed 💻

✅ All tests on macOS arm64 - Mac Sequoia (15) passed.

Pipeline on Agent
Hash: 0ef187d9df91ee6b6e110ce32cd13b65140598a0 [PR build]

vs-mobiletools-engineering-service2 · 2025-06-29T17:08:29Z

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

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

Pipeline on Agent
Hash: 0ef187d9df91ee6b6e110ce32cd13b65140598a0 [PR build]

vs-mobiletools-engineering-service2 · 2025-06-29T21:42:24Z

🔥 [CI Build #0ef187d] Test results 🔥

Test results

❌ Tests failed on VSTS: test results

1 tests crashed, 0 tests failed, 108 tests passed.

Failures

❌ monotouch tests (macOS) [attempt 2]

🔥 Failed catastrophically on VSTS: test results - monotouch_macos (no summary found).

Html Report (VSDrops) Download

Successes

✅ 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 10 tests passed. [attempt 2] Html Report (VSDrops) Download
✅ monotouch (MacCatalyst): All 11 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: 0ef187d9df91ee6b6e110ce32cd13b65140598a0 [PR build]

mandel-macaque · 2025-06-30T11:53:47Z

Mac OS failures are due to the bot disconnecting during the test execution. They are not related to the code changes.

mandel-macaque added 2 commits June 27, 2025 18:57

mandel-macaque requested a review from Copilot June 28, 2025 01:12

Copilot AI reviewed Jun 28, 2025

View reviewed changes

Auto-format source code

4abf827

This comment has been minimized.

Sign in to view

dalexsoto approved these changes Jun 28, 2025

View reviewed changes

Base automatically changed from dev/mandel/weak-delegate-property to main June 28, 2025 15:13

mandel-macaque added 2 commits June 28, 2025 11:34

Merge branch 'main' into dev/mandel/generate-strong-delegate

4a5c34d

Merge branch 'main' into dev/mandel/generate-strong-delegate

0ef187d

This comment has been minimized.

Sign in to view

mandel-macaque merged commit 4e4154d into main Jun 30, 2025
42 of 44 checks passed

mandel-macaque deleted the dev/mandel/generate-strong-delegate branch June 30, 2025 11:53

	Name = ExportPropertyData.Value.StrongDelegateName ?? Name.Remove (0, 4 /* "Weak".Length */),
	Name = ExportPropertyData.Value.StrongDelegateName ?? (Name.StartsWith("Weak") ? Name.Remove(0, "Weak".Length) : Name),

[RGen] Generate the StrongDelegates property for a WeakDelegate. #23232

[RGen] Generate the StrongDelegates property for a WeakDelegate. #23232

Uh oh!

Conversation

mandel-macaque commented Jun 28, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jun 28, 2025

Choose a reason for hiding this comment

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.

vs-mobiletools-engineering-service2 commented Jun 29, 2025

✅ [CI Build #0ef187d] Build passed (Build packages) ✅

Uh oh!

vs-mobiletools-engineering-service2 commented Jun 29, 2025

✅ [PR Build #0ef187d] Build passed (Detect API changes) ✅

Uh oh!

vs-mobiletools-engineering-service2 commented Jun 29, 2025

❗ API diff for current PR / commit (Breaking changes)

✅ API diff vs stable

ℹ️ Generator diff

Uh oh!

vs-mobiletools-engineering-service2 commented Jun 29, 2025

✅ [CI Build #0ef187d] Build passed (Build macOS tests) ✅

Uh oh!

vs-mobiletools-engineering-service2 commented Jun 29, 2025

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

Uh oh!

vs-mobiletools-engineering-service2 commented Jun 29, 2025

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

Uh oh!

vs-mobiletools-engineering-service2 commented Jun 29, 2025

💻 [CI Build #0ef187d] Tests on macOS arm64 - Mac Sequoia (15) passed 💻

Uh oh!

vs-mobiletools-engineering-service2 commented Jun 29, 2025

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

Uh oh!

This comment has been minimized.

vs-mobiletools-engineering-service2 commented Jun 29, 2025

🔥 [CI Build #0ef187d] Test results 🔥

Test results

Failures

❌ monotouch tests (macOS) [attempt 2]

Successes

Uh oh!

mandel-macaque commented Jun 30, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants