[XC] add IRootObjectProvider (#28310)

StephaneDelcroix · web-flow · commit 0fdb9ffcb756 · 2025-04-11T10:44:52.000-05:00
* [XC] add IRootObjectProvider this was never meant to be public, but it was. and people are using it - fixes #16881 * ignore case
diff --git a/src/Controls/src/Build.Tasks/NodeILExtensions.cs b/src/Controls/src/Build.Tasks/NodeILExtensions.cs
@@ -625,7 +625,8 @@ public static IEnumerable<Instruction> PushServiceProvider(this INode node, ILCo
 			//Add a SimpleValueTargetProvider and register it as IProvideValueTarget, IReferenceProvider and IProvideParentValues
 			if (createAllServices
 				|| requiredServices.Contains(module.ImportReference(context.Cache, ("Microsoft.Maui.Controls", "Microsoft.Maui.Controls.Xaml", "IProvideParentValues")), TypeRefComparer.Default)
-				|| requiredServices.Contains(module.ImportReference(context.Cache, ("Microsoft.Maui.Controls", "Microsoft.Maui.Controls.Xaml", "IReferenceProvider")), TypeRefComparer.Default))
+				|| requiredServices.Contains(module.ImportReference(context.Cache, ("Microsoft.Maui.Controls", "Microsoft.Maui.Controls.Xaml", "IReferenceProvider")), TypeRefComparer.Default)
+				|| requiredServices.Contains(module.ImportReference(context.Cache, ("Microsoft.Maui.Controls", "Microsoft.Maui.Controls.Xaml", "IRootObjectProvider")), TypeRefComparer.Default))
 			{
 				alreadyContainsProvideValueTarget = true;
 				var pushParentIl = node.PushParentObjectsArray(context).ToList();
@@ -644,9 +645,25 @@ public static IEnumerable<Instruction> PushServiceProvider(this INode node, ILCo
 					foreach (var instruction in PushNamescopes(node, context, module))
 						yield return instruction;
 
-					yield return Create(Ldc_I4_0); //don't ask
+					//rootObject
+					if (context.Root is VariableDefinition rootVariable)
+						yield return Create(Ldloc, rootVariable);
+					else if (context.Root is FieldReference rootField)
+					{
+						yield return Create(Ldarg_0);
+						yield return Create(Ldfld, rootField);
+					}
+					else
+						yield return Create(Ldnull);
+						
 					yield return Create(Newobj, module.ImportCtorReference(context.Cache,
-						("Microsoft.Maui.Controls.Xaml", "Microsoft.Maui.Controls.Xaml.Internals", "SimpleValueTargetProvider"), paramCount: 4));
+						type: ("Microsoft.Maui.Controls.Xaml", "Microsoft.Maui.Controls.Xaml.Internals", "SimpleValueTargetProvider"), 
+						parameterTypes: [
+							("mscorlib", "System", "Object[]"),
+							("mscorlib", "System", "Object"),
+							("Microsoft.Maui.Controls", "Microsoft.Maui.Controls.Internals", "INameScope[]"),
+							("mscorlib", "System", "Object"),
+						]));
 
 					//store the provider so we can register it again with a different key
 					yield return Create(Dup);
@@ -660,6 +677,12 @@ public static IEnumerable<Instruction> PushServiceProvider(this INode node, ILCo
 					yield return Create(Call, module.ImportMethodReference(context.Cache, ("mscorlib", "System", "Type"), methodName: "GetTypeFromHandle", parameterTypes: new[] { ("mscorlib", "System", "RuntimeTypeHandle") }, isStatic: true));
 					yield return Create(Ldloc, refProvider);
 					yield return Create(Callvirt, addService);
+					
+					yield return Create(Dup); //Keep the serviceProvider on the stack
+					yield return Create(Ldtoken, module.ImportReference(context.Cache, ("Microsoft.Maui.Controls", "Microsoft.Maui.Controls.Xaml", "IRootObjectProvider")));
+					yield return Create(Call, module.ImportMethodReference(context.Cache, ("mscorlib", "System", "Type"), methodName: "GetTypeFromHandle", parameterTypes: new[] { ("mscorlib", "System", "RuntimeTypeHandle") }, isStatic: true));
+					yield return Create(Ldloc, refProvider);
+					yield return Create(Callvirt, addService);
 				}
 			}
 
diff --git a/src/Controls/src/Build.Tasks/XamlCache.cs b/src/Controls/src/Build.Tasks/XamlCache.cs
@@ -3,6 +3,7 @@
 using Microsoft.Maui.Controls.XamlC;
 using Mono.Cecil;
 using Mono.Cecil.Cil;
+using Mono.Cecil.Rocks;
 
 namespace Microsoft.Maui.Controls.Build.Tasks;
 
@@ -38,8 +39,13 @@ public TypeDefinition Resolve(TypeReference typeReference) =>
 	public FieldReference GetOrAddFieldReference((ModuleDefinition module, string fieldRefKey) key, Func<(ModuleDefinition module, string fieldRefKey), FieldReference> valueFactory) =>
 		GetOrAdd(_fieldReferenceCache, key, valueFactory);
 
-	public TypeReference GetOrAddTypeReference(ModuleDefinition module, (string assemblyName, string clrNamespace, string typeName) type) =>
-		GetOrAdd(_typeReferenceCache, (module, type.ToString()), x => x.module.ImportReference(x.module.GetTypeDefinition(this, type)));
+	public TypeReference GetOrAddTypeReference(ModuleDefinition module, (string assemblyName, string clrNamespace, string typeName) type) => GetOrAdd(_typeReferenceCache, (module, type.ToString()), x =>
+	{
+		if (type.typeName.EndsWith("[]", StringComparison.InvariantCultureIgnoreCase))
+			return x.module.GetTypeDefinition(this, (type.assemblyName, type.clrNamespace, type.typeName.Substring(0, type.typeName.Length-2))).MakeArrayType();
+		else
+			return x.module.ImportReference(x.module.GetTypeDefinition(this, type));
+	});
 
 	public TypeReference GetOrAddTypeReference(ModuleDefinition module, string typeKey, Func<(ModuleDefinition module, string typeKey), TypeReference> valueFactory) =>
 		GetOrAdd(_typeReferenceCache, (module, typeKey), valueFactory);
diff --git a/src/Controls/src/Xaml/PublicAPI/net-android/PublicAPI.Unshipped.txt b/src/Controls/src/Xaml/PublicAPI/net-android/PublicAPI.Unshipped.txt
@@ -8,3 +8,5 @@ Microsoft.Maui.Controls.Embedding.EmbeddingExtensions
 Microsoft.Maui.Controls.Xaml.Internals.ValueTargetProvider
 Microsoft.Maui.Controls.Xaml.Internals.ValueTargetProvider.ValueTargetProvider(object! targetObject, object! targetProperty) -> void
 Microsoft.Maui.Controls.Xaml.ResourceDictionaryHelpers
+~Microsoft.Maui.Controls.Xaml.Internals.SimpleValueTargetProvider.RootObject.get -> object
+~Microsoft.Maui.Controls.Xaml.Internals.SimpleValueTargetProvider.SimpleValueTargetProvider(object[] objectAndParents, object targetProperty, Microsoft.Maui.Controls.Internals.INameScope[] scopes, object rootObject) -> void
diff --git a/src/Controls/src/Xaml/PublicAPI/net-ios/PublicAPI.Unshipped.txt b/src/Controls/src/Xaml/PublicAPI/net-ios/PublicAPI.Unshipped.txt
@@ -8,3 +8,5 @@ Microsoft.Maui.Controls.Embedding.EmbeddingExtensions
 Microsoft.Maui.Controls.Xaml.Internals.ValueTargetProvider
 Microsoft.Maui.Controls.Xaml.Internals.ValueTargetProvider.ValueTargetProvider(object! targetObject, object! targetProperty) -> void
 Microsoft.Maui.Controls.Xaml.ResourceDictionaryHelpers
+~Microsoft.Maui.Controls.Xaml.Internals.SimpleValueTargetProvider.RootObject.get -> object
+~Microsoft.Maui.Controls.Xaml.Internals.SimpleValueTargetProvider.SimpleValueTargetProvider(object[] objectAndParents, object targetProperty, Microsoft.Maui.Controls.Internals.INameScope[] scopes, object rootObject) -> void
diff --git a/src/Controls/src/Xaml/PublicAPI/net-maccatalyst/PublicAPI.Unshipped.txt b/src/Controls/src/Xaml/PublicAPI/net-maccatalyst/PublicAPI.Unshipped.txt
@@ -8,3 +8,5 @@ Microsoft.Maui.Controls.Embedding.EmbeddingExtensions
 Microsoft.Maui.Controls.Xaml.Internals.ValueTargetProvider
 Microsoft.Maui.Controls.Xaml.Internals.ValueTargetProvider.ValueTargetProvider(object! targetObject, object! targetProperty) -> void
 Microsoft.Maui.Controls.Xaml.ResourceDictionaryHelpers
+~Microsoft.Maui.Controls.Xaml.Internals.SimpleValueTargetProvider.RootObject.get -> object
+~Microsoft.Maui.Controls.Xaml.Internals.SimpleValueTargetProvider.SimpleValueTargetProvider(object[] objectAndParents, object targetProperty, Microsoft.Maui.Controls.Internals.INameScope[] scopes, object rootObject) -> void
diff --git a/src/Controls/src/Xaml/PublicAPI/net-tizen/PublicAPI.Unshipped.txt b/src/Controls/src/Xaml/PublicAPI/net-tizen/PublicAPI.Unshipped.txt
@@ -8,3 +8,5 @@ Microsoft.Maui.Controls.Embedding.EmbeddingExtensions
 Microsoft.Maui.Controls.Xaml.Internals.ValueTargetProvider
 Microsoft.Maui.Controls.Xaml.Internals.ValueTargetProvider.ValueTargetProvider(object! targetObject, object! targetProperty) -> void
 Microsoft.Maui.Controls.Xaml.ResourceDictionaryHelpers
+~Microsoft.Maui.Controls.Xaml.Internals.SimpleValueTargetProvider.RootObject.get -> object
+~Microsoft.Maui.Controls.Xaml.Internals.SimpleValueTargetProvider.SimpleValueTargetProvider(object[] objectAndParents, object targetProperty, Microsoft.Maui.Controls.Internals.INameScope[] scopes, object rootObject) -> void
diff --git a/src/Controls/src/Xaml/PublicAPI/net-windows/PublicAPI.Unshipped.txt b/src/Controls/src/Xaml/PublicAPI/net-windows/PublicAPI.Unshipped.txt
@@ -8,3 +8,5 @@ Microsoft.Maui.Controls.Embedding.EmbeddingExtensions
 Microsoft.Maui.Controls.Xaml.Internals.ValueTargetProvider
 Microsoft.Maui.Controls.Xaml.Internals.ValueTargetProvider.ValueTargetProvider(object! targetObject, object! targetProperty) -> void
 Microsoft.Maui.Controls.Xaml.ResourceDictionaryHelpers
+~Microsoft.Maui.Controls.Xaml.Internals.SimpleValueTargetProvider.RootObject.get -> object
+~Microsoft.Maui.Controls.Xaml.Internals.SimpleValueTargetProvider.SimpleValueTargetProvider(object[] objectAndParents, object targetProperty, Microsoft.Maui.Controls.Internals.INameScope[] scopes, object rootObject) -> void
diff --git a/src/Controls/src/Xaml/PublicAPI/net/PublicAPI.Unshipped.txt b/src/Controls/src/Xaml/PublicAPI/net/PublicAPI.Unshipped.txt
@@ -1,4 +1,5 @@
 #nullable enable
+~Microsoft.Maui.Controls.Xaml.Internals.SimpleValueTargetProvider.RootObject.get -> object
 ~Microsoft.Maui.Controls.Xaml.TemplateBindingExtension.TypedBinding.get -> Microsoft.Maui.Controls.Internals.TypedBindingBase
 ~Microsoft.Maui.Controls.Xaml.TemplateBindingExtension.TypedBinding.set -> void
 ~static Microsoft.Maui.Controls.Embedding.EmbeddingExtensions.UseMauiEmbeddedApp<TApp>(this Microsoft.Maui.Hosting.MauiAppBuilder builder, System.Func<System.IServiceProvider, TApp> implementationFactory) -> Microsoft.Maui.Hosting.MauiAppBuilder
@@ -8,3 +9,4 @@ Microsoft.Maui.Controls.Embedding.EmbeddingExtensions
 Microsoft.Maui.Controls.Xaml.Internals.ValueTargetProvider
 Microsoft.Maui.Controls.Xaml.Internals.ValueTargetProvider.ValueTargetProvider(object! targetObject, object! targetProperty) -> void
 Microsoft.Maui.Controls.Xaml.ResourceDictionaryHelpers
+~Microsoft.Maui.Controls.Xaml.Internals.SimpleValueTargetProvider.SimpleValueTargetProvider(object[] objectAndParents, object targetProperty, Microsoft.Maui.Controls.Internals.INameScope[] scopes, object rootObject) -> void
diff --git a/src/Controls/src/Xaml/PublicAPI/netstandard/PublicAPI.Unshipped.txt b/src/Controls/src/Xaml/PublicAPI/netstandard/PublicAPI.Unshipped.txt
@@ -8,3 +8,5 @@ Microsoft.Maui.Controls.Embedding.EmbeddingExtensions
 Microsoft.Maui.Controls.Xaml.Internals.ValueTargetProvider
 Microsoft.Maui.Controls.Xaml.Internals.ValueTargetProvider.ValueTargetProvider(object! targetObject, object! targetProperty) -> void
 Microsoft.Maui.Controls.Xaml.ResourceDictionaryHelpers
+~Microsoft.Maui.Controls.Xaml.Internals.SimpleValueTargetProvider.RootObject.get -> object
+~Microsoft.Maui.Controls.Xaml.Internals.SimpleValueTargetProvider.SimpleValueTargetProvider(object[] objectAndParents, object targetProperty, Microsoft.Maui.Controls.Internals.INameScope[] scopes, object rootObject) -> void
diff --git a/src/Controls/src/Xaml/XamlServiceProvider.cs b/src/Controls/src/Xaml/XamlServiceProvider.cs
@@ -135,10 +135,11 @@ public ValueTargetProvider(object targetObject, object targetProperty)
 	}
 #nullable restore
 
-	public class SimpleValueTargetProvider : IProvideParentValues, IProvideValueTarget, IReferenceProvider
+	public class SimpleValueTargetProvider : IProvideParentValues, IProvideValueTarget, IReferenceProvider, IRootObjectProvider
 	{
 		readonly object[] objectAndParents;
 		readonly object targetProperty;
+		readonly object rootObject;
 		readonly INameScope[] scopes;
 
 		[Obsolete("Use the other ctor")]
@@ -147,7 +148,13 @@ public SimpleValueTargetProvider(object[] objectAndParents, object targetPropert
 		{
 		}
 
+		[Obsolete("Use the other ctor")]
 		public SimpleValueTargetProvider(object[] objectAndParents, object targetProperty, INameScope[] scopes, bool notused)
+			: this(objectAndParents, targetProperty, scopes, null)
+		{
+		}
+
+		public SimpleValueTargetProvider(object[] objectAndParents, object targetProperty, INameScope[] scopes, object rootObject)
 		{
 			if (objectAndParents == null)
 				throw new ArgumentNullException(nameof(objectAndParents));
@@ -157,8 +164,10 @@ public SimpleValueTargetProvider(object[] objectAndParents, object targetPropert
 			this.objectAndParents = objectAndParents;
 			this.targetProperty = targetProperty;
 			this.scopes = scopes;
+			this.rootObject = rootObject ?? objectAndParents[objectAndParents.Length - 1];
 		}
 
+		public object RootObject => rootObject;	
 		IEnumerable<object> IProvideParentValues.ParentObjects => objectAndParents;
 		object IProvideValueTarget.TargetObject => objectAndParents[0];
 		object IProvideValueTarget.TargetProperty => targetProperty;
diff --git a/src/Controls/tests/Xaml.UnitTests/ServiceProviderTests.xaml b/src/Controls/tests/Xaml.UnitTests/ServiceProviderTests.xaml
@@ -9,5 +9,6 @@
         <Label x:Name="label1" Text="{local:SPMarkup1}"/>
         <Label x:Name="label2" Text="{local:SPMarkup2}"/>
         <Label x:Name="label3" Text="{local:SPMarkup3}"/>
+        <Label x:Name="label4" Text="{local:SPMarkup4}"/>
     </StackLayout>
 </ContentPage>
diff --git a/src/Controls/tests/Xaml.UnitTests/ServiceProviderTests.xaml.cs b/src/Controls/tests/Xaml.UnitTests/ServiceProviderTests.xaml.cs
@@ -22,7 +22,7 @@ public object ProvideValue(IServiceProvider serviceProvider)
 		if (serviceProvider.GetService(typeof(IXamlTypeResolver)) != null)
 			services.Add("IXamlTypeResolver");
 		if (serviceProvider.GetService(typeof(IRootObjectProvider)) != null)
-			services.Add("IRootObjectProvider");
+			services.Add($"IRootObjectProvider({((IRootObjectProvider)serviceProvider.GetService(typeof(IRootObjectProvider))).RootObject.GetType().Name})");
 		if (serviceProvider.GetService(typeof(IXmlLineInfoProvider)) != null)
 			services.Add("IXmlLineInfoProvider");
 		if (serviceProvider.GetService(typeof(IValueConverterProvider)) != null)
@@ -32,7 +32,7 @@ public object ProvideValue(IServiceProvider serviceProvider)
 		if (serviceProvider.GetService(typeof(IReferenceProvider)) != null)
 			services.Add("IReferenceProvider");
 
-		return string.Join(",", services);
+		return string.Join(", ", services);
 	}
 }
 
@@ -48,6 +48,8 @@ public class SPMarkup2 : MarkupExtensionBase { }
 [RequireService([typeof(IXmlLineInfoProvider)])]
 public class SPMarkup3 : MarkupExtensionBase { }
 
+[RequireService([typeof(IRootObjectProvider)])]
+public class SPMarkup4 : MarkupExtensionBase { }
 
 
 public partial class ServiceProviderTests : ContentPage
@@ -65,17 +67,15 @@ public class Tests
 		[SetUp] public void Setup() => DispatcherProvider.SetCurrent(new DispatcherProviderStub());
 		[TearDown] public void TearDown() => DispatcherProvider.SetCurrent(null);
 
-		[TestCase(true)]
-		public void TestServiceProviders(bool useCompiledXaml)
+		[Test]
+		public void TestServiceProviders([Values]bool useCompiledXaml)
 		{
 			var page = new ServiceProviderTests(useCompiledXaml);
-			MockCompiler.Compile(typeof(ServiceProviderTests));
 
-			//IValueConverterProvider is builtin for free
 			Assert.AreEqual(null, page.label0.Text);
-			Assert.AreEqual("IProvideValueTarget,IValueConverterProvider", page.label1.Text);
-			Assert.AreEqual("IProvideValueTarget,IValueConverterProvider,IReferenceProvider", page.label2.Text);
-			Assert.AreEqual("IXmlLineInfoProvider,IValueConverterProvider", page.label3.Text);
+			Assert.That(page.label1.Text, Does.Contain("IProvideValueTarget"));
+			Assert.That(page.label3.Text, Does.Contain("IXmlLineInfoProvider"));
+			Assert.That(page.label4.Text, Does.Contain("IRootObjectProvider(ServiceProviderTests)")); //https://github.com/dotnet/maui/issues/16881
 		}
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -135,10 +135,11 @@ public ValueTargetProvider(object targetObject, object targetProperty)`
`135`	`135`	`}`
`136`	`136`	`#nullable restore`
`137`	`137`
`138`		`- public class SimpleValueTargetProvider : IProvideParentValues, IProvideValueTarget, IReferenceProvider`
	`138`	`+ public class SimpleValueTargetProvider : IProvideParentValues, IProvideValueTarget, IReferenceProvider, IRootObjectProvider`
`139`	`139`	`{`
`140`	`140`	`readonly object[] objectAndParents;`
`141`	`141`	`readonly object targetProperty;`
	`142`	`+ readonly object rootObject;`
`142`	`143`	`readonly INameScope[] scopes;`
`143`	`144`
`144`	`145`	`[Obsolete("Use the other ctor")]`
`@@ -147,7 +148,13 @@ public SimpleValueTargetProvider(object[] objectAndParents, object targetPropert`
`147`	`148`	`{`
`148`	`149`	`}`
`149`	`150`
	`151`	`+ [Obsolete("Use the other ctor")]`
`150`	`152`	`public SimpleValueTargetProvider(object[] objectAndParents, object targetProperty, INameScope[] scopes, bool notused)`
	`153`	`+ : this(objectAndParents, targetProperty, scopes, null)`
	`154`	`+ {`
	`155`	`+ }`
	`156`	`+`
	`157`	`+ public SimpleValueTargetProvider(object[] objectAndParents, object targetProperty, INameScope[] scopes, object rootObject)`
`151`	`158`	`{`
`152`	`159`	`if (objectAndParents == null)`
`153`	`160`	`throw new ArgumentNullException(nameof(objectAndParents));`
`@@ -157,8 +164,10 @@ public SimpleValueTargetProvider(object[] objectAndParents, object targetPropert`
`157`	`164`	`this.objectAndParents = objectAndParents;`
`158`	`165`	`this.targetProperty = targetProperty;`
`159`	`166`	`this.scopes = scopes;`
	`167`	`+ this.rootObject = rootObject ?? objectAndParents[objectAndParents.Length - 1];`
`160`	`168`	`}`
`161`	`169`
	`170`	`+ public object RootObject => rootObject;`
`162`	`171`	`IEnumerable<object> IProvideParentValues.ParentObjects => objectAndParents;`
`163`	`172`	`object IProvideValueTarget.TargetObject => objectAndParents[0];`
`164`	`173`	`object IProvideValueTarget.TargetProperty => targetProperty;`