Add support for Project Specific RegisterTaskObject. (#199)

Context: dotnet/maui#11605
Context: dotnet/maui#11387 (comment)
Context: http://github.com/xamarin/xamarin-android/commit/8bc7a3e84f95e70fe12790ac31ecd97957771cb2
In dotnet/maui#11605, when `$(AndroidEnableMarshalMethods)`=True
(dotnet/android@8bc7a3e8), the build may fail if the `.sln`
contains more than one Android "App" project. We tracked this down
to "undesired sharing" between project builds; the `obj` provided to
[`IBuildEngine4.RegisterTaskObject()`][0] can be visible across
project builds. Consider [`<GeneratePackageManagerJava/>`][1]:
var marshalMethodsState = BuildEngine4.GetRegisteredTaskObjectAssemblyLocal<MarshalMethodsState> (".:!MarshalMethods!:.", RegisteredTaskObjectLifetime.Build);
Further consider a `.sln` with two "App" projects, as the "App"
project build hits `<GeneratePackageManagerJava/>`.
The lifetime of `.Build` is *not* tied to the the `Build` target of a
given `.csproj`; rather, it's for the *build process*. This can
result in:
1. `dotnet build Project.sln` is run; `Project.sln` references
`App1.csproj` and `App2.csproj`.
2. `App1.csproj` is built.
3. `App1.csproj` calls `<GeneratePackageManagerJava/>`.
4. `App2.csproj` is later built as part in the process, and *also*
calls `<GeneratePackageManagerJava/>`.
In particular note the key within `<GeneratePackageManagerJava/>`:
`".:!MarshalMethods!:."`. This value is unchanged, and means that
that when `App2.csproj` is built, it will be using the same key as
was used with `App1.csproj`, and thus could be inadvertently using
data intended for `App1.csproj`!
This would result build errors:
…\Xamarin.Android.Common.targets(1717,3): error XAGPM7009: System.InvalidOperationException: Unable to translate assembly name 'Xamarin.AndroidX.Activity' to its index
…\Xamarin.Android.Common.targets(1717,3): error XAGPM7009: at Xamarin.Android.Tasks.MarshalMethodsNativeAssemblyGenerator.WriteNativeMethods(LlvmIrGenerator generator, Dictionary`2 asmNameToIndex, LlvmIrVariableReference get_function_pointer_ref)
…\Xamarin.Android.Common.targets(1717,3): error XAGPM7009: at Xamarin.Android.Tasks.MarshalMethodsNativeAssemblyGenerator.Write(LlvmIrGenerator generator)
…\Xamarin.Android.Common.targets(1717,3): error XAGPM7009: at Xamarin.Android.Tasks.LLVMIR.LlvmIrComposer.Write(AndroidTargetArch arch, StreamWriter output, String fileName)
…\Xamarin.Android.Common.targets(1717,3): error XAGPM7009: at Xamarin.Android.Tasks.GeneratePackageManagerJava.AddEnvironment()
…\Xamarin.Android.Common.targets(1717,3): error XAGPM7009: at Xamarin.Android.Tasks.GeneratePackageManagerJava.RunTask()
The sharing of `RegisterTaskObject` data across project builds is
rarely desirable. There are a few instances where it is safe to share
the registered objects between projects, e.g. `java` version
information (keyed on `java` path). However, most of the time it is
specific to the project that is being built. Historically we have
probably got away with this because "most" users only have one project.
Update the `MSBuildExtensions` extension methods to include an
additional `RegisterTaskObjectKeyFlags` parameter:
[Flags]
public enum RegisterTaskObjectKeyFlags {
None = 0,
IncludeProjectFile = 1 << 0,
}
Allowing:
var marshalMethodsState = BuildEngine4.GetRegisteredTaskObjectAssemblyLocal<MarshalMethodsState> (
".:!MarshalMethods!:.",
RegisteredTaskObjectLifetime.Build,
RegisterTaskObjectKeyFlags.IncludeProjectFile
);
When `RegisterTaskObjectKeyFlags.IncludeProjectFile` is specified,
then [`IBuildEngine.ProjectFileOfTaskNode`][2] is used as part of
the key with `RegisterTaskObject()`. This helps ensure that builds
in different `.csproj` files will result in different keys.
The previous `MSBuildExtensions.GetRegisteredTaskObjectAssemblyLocal()`
and related overloads have been updated so that
`RegisterTaskObjectKeyFlags.IncludeProjectFile` is used by default.
[0]: https://learn.microsoft.com/en-us/dotnet/api/microsoft.build.framework.ibuildengine4.registertaskobject?view=msbuild-17-netcore
[1]: https://github.com/xamarin/xamarin-android/blob/c92ae5eb9fdcb3a2fd7c20f5b42dddf8b3ea781a/src/Xamarin.Android.Build.Tasks/Tasks/GeneratePackageManagerJava.cs#L407
[2]: https://learn.microsoft.com/en-us/dotnet/api/microsoft.build.framework.ibuildengine.projectfileoftasknode?view=msbuild-17-netcore

Author: dellis1972

src/Microsoft.Android.Build.BaseTasks/MSBuildExtensions.cs

@@ -13,6 +13,12 @@
 
 namespaceMicrosoft.Android.Build.Tasks
 {
+[Flags]
+publicenumRegisterTaskObjectKeyFlags{
+None=0,
+IncludeProjectFile=1<<0,
+}
+
 publicstaticclassMSBuildExtensions
 {
 publicstaticvoidLogDebugMessage(thisTaskLoggingHelperlog,stringmessage,paramsobject[]messageArgs)
@@ -252,34 +258,80 @@ public static void SetDestinationSubPath (this ITaskItem assembly)
 /// <summary>
 /// IBuildEngine4.RegisterTaskObject, but adds the current assembly path into the key
 /// </summary>
+[Obsolete("Use RegisterTaskObjectAssemblyLocal (engine, key, value, allowEarlyCollection, lifetime, flags) instead.")]
 publicstaticvoidRegisterTaskObjectAssemblyLocal(thisIBuildEngine4engine,objectkey,objectvalue,RegisteredTaskObjectLifetimelifetime,boolallowEarlyCollection=false)=>
-engine.RegisterTaskObject((AssemblyLocation,key),value,lifetime,allowEarlyCollection);
+RegisterTaskObjectAssemblyLocal(engine,key,value,lifetime,allowEarlyCollection:false,flags:RegisterTaskObjectKeyFlags.IncludeProjectFile);
+
+/// <summary>
+/// IBuildEngine4.RegisterTaskObject, but adds the current assembly path into the key
+/// </summary>
+publicstaticvoidRegisterTaskObjectAssemblyLocal(thisIBuildEngine4engine,objectkey,objectvalue,RegisteredTaskObjectLifetimelifetime,boolallowEarlyCollection=false,RegisterTaskObjectKeyFlagsflags=RegisterTaskObjectKeyFlags.IncludeProjectFile)=>
+engine.RegisterTaskObject(engine.GetKey(AssemblyLocation,key,flags),value,lifetime,allowEarlyCollection);
 
 /// <summary>
 /// IBuildEngine4.GetRegisteredTaskObject, but adds the current assembly path into the key
 /// </summary>
+[Obsolete("Use GetRegisteredTaskObjectAssemblyLocal (engine, key, lifetime, flags) instead.")]
 publicstaticobjectGetRegisteredTaskObjectAssemblyLocal(thisIBuildEngine4engine,objectkey,RegisteredTaskObjectLifetimelifetime)=>
-engine.GetRegisteredTaskObject((AssemblyLocation,key),lifetime);
+GetRegisteredTaskObjectAssemblyLocal(engine,key,lifetime,flags:RegisterTaskObjectKeyFlags.IncludeProjectFile);
+
+/// <summary>
+/// IBuildEngine4.GetRegisteredTaskObject, but adds the current assembly path into the key
+/// </summary>
+publicstaticobjectGetRegisteredTaskObjectAssemblyLocal(thisIBuildEngine4engine,objectkey,RegisteredTaskObjectLifetimelifetime,RegisterTaskObjectKeyFlagsflags=RegisterTaskObjectKeyFlags.IncludeProjectFile)=>
+engine.GetRegisteredTaskObject(engine.GetKey(AssemblyLocation,key,flags),lifetime);
+
 
 /// <summary>
 /// Generic version of IBuildEngine4.GetRegisteredTaskObject, but adds the current assembly path into the key
 /// </summary>
+[Obsolete("Use GetRegisteredTaskObjectAssemblyLocal<T> (engine, key, lifetime, flags) instead.")]
 publicstaticTGetRegisteredTaskObjectAssemblyLocal<T>(thisIBuildEngine4engine,objectkey,RegisteredTaskObjectLifetimelifetime)
-whereT:class=>
-engine.GetRegisteredTaskObject((AssemblyLocation,key),lifetime)asT;
+whereT:class=>GetRegisteredTaskObjectAssemblyLocal<T>(engine,key,lifetime,flags:RegisterTaskObjectKeyFlags.IncludeProjectFile);
 
+/// <summary>
+/// Generic version of IBuildEngine4.GetRegisteredTaskObject, but adds the current assembly path into the key
+/// </summary>
+publicstaticTGetRegisteredTaskObjectAssemblyLocal<T>(thisIBuildEngine4engine,objectkey,RegisteredTaskObjectLifetimelifetime,RegisterTaskObjectKeyFlagsflags=RegisterTaskObjectKeyFlags.IncludeProjectFile)
+whereT:class=>
+engine.GetRegisteredTaskObject(engine.GetKey(AssemblyLocation,key,flags),lifetime)asT;
 
 /// <summary>
 /// IBuildEngine4.UnregisterTaskObject, but adds the current assembly path into the key
 /// </summary>
+[Obsolete("Use UnregisterTaskObjectAssemblyLocal (engine, key, lifetime, flags) instead.")]
 publicstaticobjectUnregisterTaskObjectAssemblyLocal(thisIBuildEngine4engine,objectkey,RegisteredTaskObjectLifetimelifetime)=>
-engine.UnregisterTaskObject((AssemblyLocation,key),lifetime);
+UnregisterTaskObjectAssemblyLocal(engine,key,lifetime,flags:RegisterTaskObjectKeyFlags.IncludeProjectFile);
+
+/// <summary>
+/// IBuildEngine4.UnregisterTaskObject, but adds the current assembly path into the key
+/// </summary>
+publicstaticobjectUnregisterTaskObjectAssemblyLocal(thisIBuildEngine4engine,objectkey,RegisteredTaskObjectLifetimelifetime,RegisterTaskObjectKeyFlagsflags=RegisterTaskObjectKeyFlags.IncludeProjectFile)=>
+engine.UnregisterTaskObject(engine.GetKey(AssemblyLocation,key,flags),lifetime);
 
 /// <summary>
 /// Generic version of IBuildEngine4.UnregisterTaskObject, but adds the current assembly path into the key
 /// </summary>
+[Obsolete("Use UnregisterTaskObjectAssemblyLocal<T> (engine, key, lifetime, flags) instead.")]
 publicstaticTUnregisterTaskObjectAssemblyLocal<T>(thisIBuildEngine4engine,objectkey,RegisteredTaskObjectLifetimelifetime)
+whereT:class=>UnregisterTaskObjectAssemblyLocal<T>(engine,key,lifetime,flags:RegisterTaskObjectKeyFlags.IncludeProjectFile);
+
+/// <summary>
+/// Generic version of IBuildEngine4.UnregisterTaskObject, but adds the current assembly path into the key
+/// </summary>
+publicstaticTUnregisterTaskObjectAssemblyLocal<T>(thisIBuildEngine4engine,objectkey,RegisteredTaskObjectLifetimelifetime,RegisterTaskObjectKeyFlagsflags=RegisterTaskObjectKeyFlags.IncludeProjectFile)
 whereT:class=>
-engine.UnregisterTaskObject((AssemblyLocation,key),lifetime)asT;
+engine.UnregisterTaskObject(engine.GetKey(AssemblyLocation,key,flags),lifetime)asT;
+
+/// <summary>
+/// Method to calculate the key for the RegisterTaskObject. This is based on the
+/// RegisterTaskObjectKeyFlags which are passed.
+/// </summary>
+staticobjectGetKey(thisIBuildEngine4engine,stringlocation,objectkey,RegisterTaskObjectKeyFlagsflags)
+{
+return((flags&RegisterTaskObjectKeyFlags.IncludeProjectFile)!=0)
+?(location,key,engine.ProjectFileOfTaskNode)
+:(location,key,string.Empty);
+}
 }
 }