Projection tooling for Swift interop in .NET 10

[kotlarmilos]

Overview

This issue tracks the progress of implementing and shipping the projection tooling for .NET 10. The primary goal is to release the projection tooling as an experimental NuGet CLI capable of generating bindings for a specific set of Swift frameworks, as defined in the use cases. It should follow general principles outlined in the Swift interop proposal.

Currently, the projection tooling is available as an experimental NuGet CLI in dotnet-experimental feed.

Workstream: Swift language features

Based on the selected frameworks, the following Swift language features are in use:

• Types
  • [Swift language features] Implement Swift structs in C# runtimelab#2822
  • [Swift language features] Implement Swift enums in C# runtimelab#2823
  • [Swift language features] Implement Swift protocols in C# runtimelab#2824
• Methods
  • [Swift language features] Implement Swift initializers in C# runtimelab#2825
  • [Swift language features] Implement Swift instance methods in C# runtimelab#2826
  • [Swift language features] Implement Swift static methods in C# runtimelab#2827
• [Swift language features] Implement Swift closures in C# runtimelab#2828
• [Swift language features] Implement common interfaces in projections (IEnumerable, ICollection, IDisposable) runtimelab#2829
• Built-in types
  • [Swift language features] Implement Swift primitive types in C# runtimelab#2830
  • [Swift language features] Implement Foundation.String in C# runtimelab#2831
  • [Swift language features] Implement unsafe pointers in C# runtimelab#2832
  • [Swift language features] Implement Swift.Array in C# runtimelab#2833
  • [Swift language features] Implement Swift.Set in C# runtimelab#2834
  • [Swift language features] Implement Any / Some in C# runtimelab#2835
• Swift code generation
  • [Swift language features] Implement Swift wrappers for enums runtimelab#2836
  • [Swift language features] Implement Swift wrappers for async runtimelab#2837

Workstream: Swift runtime features

To support the mentioned language features, the following runtime features are required:

• [Swift runtime features] Implement Swift metadata runtimelab#2838
• [Swift runtime features] Implement Swift conformance descriptors runtimelab#2839
• [Swift runtime features] Implement Swift witness tables runtimelab#2840
• [Swift runtime features] Implement Swift existential containers runtimelab#2841

Workstream: Projection tooling

To generate bindings, we need projection tooling that includes the following components (based on the current design):

• [Projection tooling] Design overall architecture of the projection tooling runtimelab#2846
• [Projection tooling] Implement ABI/MachO parser runtimelab#2845
• [Projection tooling] Implement demangler runtimelab#2844
• [Projection tooling] Implement bindings emitter: String-based / model-based runtimelab#2843
• [Projection tooling] Implement Swift type registrar runtimelab#2842

Workstream: Shipping

We need the following infrastructure:

• [Swift shipping] Implement tooling/bindings distribution using NuGet packages runtimelab#2849
• [Swift shipping] Implement testing framework runtimelab#2850
• [Swift shipping] Performance benchmarking framework for Swift projection tooling runtimelab#2586

Note

The projection tooling will be experimental in .NET 10.

[ghost]

Tagging subscribers to this area: @dotnet/area-meta
See info in area-owners.md if you want to be subscribed.

Issue Details

---

Description

This issue tracks the work for adapting the existing Binding Tools for Swift and shipping it as a product in .NET 9. The projection tooling consists of three main areas: Importing Swift into .NET, Exporting .NET to Swift, and distribution.

Below is a list of tasks that needs to be implemented. Please note that the breakdown of the issues does not impose hard deadlines. If some of the functionality does not get upstreamed for a particular preview version, this issue will be updated accordingly.

Tasks

.NET9 Preview 1

• Update documentation to specify tool's layout
• Update documentation to specify type representations
• Create a NuGet package for the BTfS
• Ensure that the NuGet package is shipped for supported platforms such as OSX and Apple mobile

.NET9 Preview 2

• Adapt the tool to work with the new runtime support
• Add Roslyn source generators to generate Swift metadata for selected assemblies

.NET9 Preview 3

TBD

Author:	kotlarmilos
Assignees:	kotlarmilos, stephen-hawley
Labels:	area-Meta, User Story
Milestone:	9.0.0

[stephen-hawley]

Might want to include "Update BTfS to run on .NET 7 and later" - I'm in the middle of that right now.