[Rgen] Add the needed code to make the objc_msgSend signatures. by mandel-macaque · Pull Request #22029 · dotnet/macios

mandel-macaque · 2025-01-23T00:52:37Z

Add the code that will calculate the signature needed in the objc_msgSend which will be the method that calls the native objc message.

Extra context

When we create a binding for a native type we need to be able to send 'messages' to the objc objects. From a C# developer perspective a message can be considered a method. So for example, the following objc code:

[object foo:bar];

Can be translated to:

objc_msgSend(object, sel_getUid("foo:"), bar);

We can say this process is similar to reflection and the Invoke method. Our bindings provide methods around objc_msgsend which we use to send the messaged with the arguments needed by the message. For example, a property with a NSString backing fields defined as:

[Export ("text")]
public string? Text { get; set; }

Results in the following generated code:

[BindingImpl (BindingImplOptions.GeneratedCode | BindingImplOptions.Optimizable)]
public virtual string? Text {
	[Export ("text")]
	get {
		global::UIKit.UIApplication.EnsureUIThread ();
		if (IsDirectBinding) {
			return CFString.FromHandle (global::ObjCRuntime.Messaging.NativeHandle_objc_msgSend (this.Handle, Selector.GetHandle ("text")), false)!;
		} else {
			return CFString.FromHandle (global::ObjCRuntime.Messaging.NativeHandle_objc_msgSendSuper (this.SuperHandle, Selector.GetHandle ("text")), false)!;
		}
	}
	[Export ("setText:")]
	set {
		global::UIKit.UIApplication.EnsureUIThread ();
		var nsvalue = CFString.CreateNative (value);
		if (IsDirectBinding) {
			global::ObjCRuntime.Messaging.void_objc_msgSend_NativeHandle (this.Handle, Selector.GetHandle ("setText:"), nsvalue);
		} else {
			global::ObjCRuntime.Messaging.void_objc_msgSendSuper_NativeHandle (this.SuperHandle, Selector.GetHandle ("setText:"), nsvalue);
		}
		CFString.ReleaseNative (nsvalue);
	}
}

Our objc_msgSend method signatures are calculated based on the method parameters and live in the runtime. These objc_msgSend calls are generated by https://github.com/xamarin/xamarin-macios/blob/main/runtime/bindings-generator.cs#L20 For example a objc_msgSend signature for a method that takes a string and returns a string would be:

IntPtr_objc_msgSend_IntPtr

But this is a simplifications because there is a diff between sending a message to a super class (prefix super) or if it deals with a structure (stret).

More info can be found in the Apple documentation.

Add the code that will calculate the signature needed in the objc_msgSend which will be the method that calls the native objc message.

github-actions · 2025-01-23T00:56:47Z

⚠️ Your code has been reformatted. ⚠️

If this is not desired, add the actions-disable-autoformat label, and revert the reformatting commit.

If files unrelated to your change were modified, try reverting the reformatting commit + merging with the target branch (and push those changes).

github-actions · 2025-01-23T01:05:17Z

⚠️ Your code has been reformatted. ⚠️

If this is not desired, add the actions-disable-autoformat label, and revert the reformatting commit.

If files unrelated to your change were modified, try reverting the reformatting commit + merging with the target branch (and push those changes).

Copilot

Copilot reviewed 5 out of 18 changed files in this pull request and generated 6 comments.

Files not reviewed (13)

src/rgen/Microsoft.Macios.Transformer/Microsoft.Macios.Transformer.csproj: Language not supported
src/rgen/Microsoft.Macios.Generator/Emitters/BindingSyntaxFactory.cs: Evaluated as low risk
src/rgen/Microsoft.Macios.Generator/DataModel/TypeInfoComparer.cs: Evaluated as low risk
src/rgen/Microsoft.Macios.Generator/Formatters/TypeInfoFormatter.cs: Evaluated as low risk
src/rgen/Microsoft.Macios.Generator/DataModel/TypeInfo.Generator.cs: Evaluated as low risk
tests/rgen/Microsoft.Macios.Generator.Tests/TestDataFactory.cs: Evaluated as low risk
src/rgen/Microsoft.Macios.Generator/Emitters/BindingSyntaxFactory.Dlfcn.cs: Evaluated as low risk
tests/rgen/Microsoft.Macios.Generator.Tests/DataModel/TypeInfoComparerTests.cs: Evaluated as low risk
src/rgen/Microsoft.Macios.Generator/Formatters/ParameterFormatter.cs: Evaluated as low risk
src/rgen/Microsoft.Macios.Generator/DataModel/Property.cs: Evaluated as low risk
src/rgen/Microsoft.Macios.Generator/DataModel/TypeInfo.cs: Evaluated as low risk
src/rgen/Microsoft.Macios.Generator/Extensions/SpecialTypeExtensions.cs: Evaluated as low risk
tests/rgen/Microsoft.Macios.Generator.Tests/Emitters/GetObjCMessageSendMethodNameTests.cs: Evaluated as low risk

github-actions · 2025-01-23T01:15:56Z

⚠️ Your code has been reformatted. ⚠️

If this is not desired, add the actions-disable-autoformat label, and revert the reformatting commit.

If files unrelated to your change were modified, try reverting the reformatting commit + merging with the target branch (and push those changes).

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

jonathanpeppers

Just a minor issue with a comment, I think. Not a blocker. 👍

jonathanpeppers · 2025-01-23T14:24:20Z

+			ExportData<ObjCBindings.Property> property => property.Flags.HasFlag (ObjCBindings.Property
+				.CustomMarshalDirective),
+			ExportData<ObjCBindings.Method> method => method.Flags.HasFlag (
+				ObjCBindings.Property.CustomMarshalDirective),


I remembered HasFlag had a performance issue, but it's ok to use now in .NET 5+:

Suggest Enum.HasFlag on modern frameworks. runtime#55455

jonathanpeppers · 2025-01-23T14:25:32Z

 	/// <summary>
 	/// Type of the parameter.
 	/// </summary>
-	public string Name { get; }
+	public string FullyQualifiedName {


nitpick: is the summary comment here wrong now?

It is, fixing

vs-mobiletools-engineering-service2 · 2025-01-23T18:00:04Z

✅ [PR Build] Build passed (Build packages) ✅

Pipeline on Agent
Hash: 4427d37cc06bbf433825f7a6467615d9e5d74bdd [PR build]

vs-mobiletools-engineering-service2 · 2025-01-23T18:00:24Z

✅ [PR Build] Build passed (Detect API changes) ✅

Pipeline on Agent
Hash: 4427d37cc06bbf433825f7a6467615d9e5d74bdd [PR build]

vs-mobiletools-engineering-service2 · 2025-01-23T18:25:51Z

✅ [PR Build] Build passed (Build macOS tests) ✅

Pipeline on Agent
Hash: 4427d37cc06bbf433825f7a6467615d9e5d74bdd [PR build]

vs-mobiletools-engineering-service2 · 2025-01-23T18:30:53Z

✅ 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 (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 ❗ )

ℹ️ Generator diff

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

Pipeline on Agent
Hash: d52838baf4e7b660a1f4fa1ae29c07dc0b9ae767 [PR build]

vs-mobiletools-engineering-service2 · 2025-01-23T18:40:34Z

💻 [CI Build] Windows Integration Tests passed 💻

✅ All Windows Integration Tests passed.

Pipeline on Agent
Hash: 4427d37cc06bbf433825f7a6467615d9e5d74bdd [PR build]

vs-mobiletools-engineering-service2 · 2025-01-23T18:41:55Z

💻 [PR Build] Tests on macOS M1 - Mac Monterey (12) passed 💻

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

Pipeline on Agent
Hash: 4427d37cc06bbf433825f7a6467615d9e5d74bdd [PR build]

vs-mobiletools-engineering-service2 · 2025-01-23T18:42:28Z

💻 [PR Build] Tests on macOS arm64 - Mac Sequoia (15) passed 💻

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

Pipeline on Agent
Hash: 4427d37cc06bbf433825f7a6467615d9e5d74bdd [PR build]

vs-mobiletools-engineering-service2 · 2025-01-23T18:42:37Z

💻 [PR Build] Tests on macOS X64 - Mac Sonoma (14) passed 💻

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

Pipeline on Agent
Hash: 4427d37cc06bbf433825f7a6467615d9e5d74bdd [PR build]

vs-mobiletools-engineering-service2 · 2025-01-23T18:43:37Z

💻 [PR Build] Tests on macOS M1 - Mac Ventura (13) passed 💻

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

Pipeline on Agent
Hash: 4427d37cc06bbf433825f7a6467615d9e5d74bdd [PR build]

vs-mobiletools-engineering-service2 · 2025-01-23T20:36:22Z

🚀 [CI Build] Test results 🚀

Test results

✅ All tests passed on VSTS: test results.

🎉 All 120 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 6 tests passed. Html Report (VSDrops) Download
✅ linker: All 44 tests passed. Html Report (VSDrops) Download
✅ monotouch (iOS): All 10 tests passed. Html Report (VSDrops) Download
✅ monotouch (MacCatalyst): All 15 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
✅ xcframework: All 4 tests passed. Html Report (VSDrops) Download
✅ xtro: All 1 tests passed. Html Report (VSDrops) Download

Pipeline on Agent
Hash: d52838baf4e7b660a1f4fa1ae29c07dc0b9ae767 [PR build]

mandel-macaque and others added 2 commits January 22, 2025 19:26

[Rgen] Add the needed code to make the objc_msgSend signatures.

2706f5e

Add the code that will calculate the signature needed in the objc_msgSend which will be the method that calls the native objc message.

Auto-format source code

15a79c6

Undo evil formatting.

7b433d9

mandel-macaque added the actions-disable-autoformat Disable autoformatting C# code according to our style guidelines label Jan 23, 2025

Update the test data factory. Some special types are structs!

6ad32da

mandel-macaque force-pushed the dev/mandel/objc_msgSend_factory branch from 2a80edc to 6ad32da Compare January 23, 2025 01:11

mandel-macaque requested a review from Copilot January 23, 2025 01:11

Copilot AI reviewed Jan 23, 2025

View reviewed changes

Auto-format source code

db167d5

mandel-macaque and others added 2 commits January 22, 2025 20:20

bloody format tool.

66016ce

AI is good at typos.

d6c77b1

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

This comment has been minimized.

Sign in to view

jonathanpeppers approved these changes Jan 23, 2025

View reviewed changes

mandel-macaque commented Jan 23, 2025

View reviewed changes

Comment thread src/rgen/Microsoft.Macios.Generator/DataModel/TypeInfo.cs Outdated

Update src/rgen/Microsoft.Macios.Generator/DataModel/TypeInfo.cs

4427d37

mandel-macaque merged commit d52838b into main Jan 23, 2025

mandel-macaque deleted the dev/mandel/objc_msgSend_factory branch January 23, 2025 17:15

Uh oh!

Conversation

mandel-macaque commented Jan 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Extra context

Uh oh!

github-actions Bot commented Jan 23, 2025

⚠️ Your code has been reformatted. ⚠️

Uh oh!

github-actions Bot commented Jan 23, 2025

⚠️ Your code has been reformatted. ⚠️

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Jan 23, 2025

⚠️ Your code has been reformatted. ⚠️

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.

jonathanpeppers left a comment

Choose a reason for hiding this comment

Uh oh!

jonathanpeppers Jan 23, 2025

Choose a reason for hiding this comment

Uh oh!

jonathanpeppers Jan 23, 2025

Choose a reason for hiding this comment

Uh oh!

mandel-macaque Jan 23, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

vs-mobiletools-engineering-service2 commented Jan 23, 2025

✅ [PR Build] Build passed (Build packages) ✅

Uh oh!

vs-mobiletools-engineering-service2 commented Jan 23, 2025

✅ [PR Build] Build passed (Detect API changes) ✅

Uh oh!

This comment has been minimized.

This comment has been minimized.

vs-mobiletools-engineering-service2 commented Jan 23, 2025

✅ [PR Build] Build passed (Build macOS tests) ✅

Uh oh!

vs-mobiletools-engineering-service2 commented Jan 23, 2025

✅ API diff for current PR / commit

❗ API diff vs stable (Breaking changes)

ℹ️ Generator diff

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

mandel-macaque commented Jan 23, 2025 •

edited

Loading