[msbuild] Add support for bundling original resources in libraries. Fixes #19028.

Make.config

@@ -313,9 +313,9 @@ MIN_TVOS_SIMULATOR_VERSION=15.0
 EXTRA_SIMULATORS=com.apple.pkg.iPhoneSimulatorSDK15_0 com.apple.pkg.AppleTVSimulatorSDK15_0 com.apple.pkg.WatchSimulatorSDK8_0
 
 INCLUDE_IOS=1
-INCLUDE_MAC=1
-INCLUDE_TVOS=1
-INCLUDE_MACCATALYST=1
+INCLUDE_MAC=
+INCLUDE_TVOS=
+INCLUDE_MACCATALYST=
 INCLUDE_DEVICE=1
 INCLUDE_XAMARIN_LEGACY=
 INCLUDE_HOTRESTART=1

dotnet/targets/Xamarin.Shared.Sdk.targets

@@ -233,6 +233,7 @@
 		<!-- outer build for multi-rid build -->
 		<BuildDependsOn Condition="'$(RuntimeIdentifiers)' != ''">
 			_ErrorRuntimeIdentifiersClash;
+			BuildOnlySettings;
 			_CollectBundleResources;
 			_RunRidSpecificBuild;
 			_DetectAppManifest;

msbuild/Xamarin.MacDev.Tasks/BundleResource.cs

@@ -5,8 +5,10 @@
 using System.Collections.Generic;
 
 using Microsoft.Build.Framework;
+using Microsoft.Build.Utilities;
 
 using Xamarin.Utils;
+using Xamarin.MacDev.Tasks;
 
 namespace Xamarin.MacDev {
 	public static class BundleResource {
@@ -56,66 +58,152 @@ public static IList<string> SplitResourcePrefixes (string prefix)
 				.ToList ();
 		}
 
-		public static string GetVirtualProjectPath (string projectDir, ITaskItem item, bool isVSBuild)
+		static void Log (Task? task, string msg)
+		{
+			if (task is not null) {
+				task.Log.LogMessage (MessageImportance.Low, msg);
+			} else {
+				Console.WriteLine (msg);
+			}
+		}
+
+		public static string GetVirtualProjectPath (XamarinTask task, string projectDir, ITaskItem item)
+		{
+			return GetVirtualProjectPath (task, projectDir, item, !string.IsNullOrEmpty (task.SessionId));
+		}
+
+		public static string GetVirtualProjectPath (XamarinToolTask task, string projectDir, ITaskItem item)
+		{
+			return GetVirtualProjectPath (task, projectDir, item, !string.IsNullOrEmpty (task.SessionId));
+		}
+
+		public static string GetVirtualProjectPath (Task task, string projectDir, ITaskItem item, bool isVSBuild)
 		{
 			var link = item.GetMetadata ("Link");
 
 			// Note: if the Link metadata exists, then it will be the equivalent of the ProjectVirtualPath
 			if (!string.IsNullOrEmpty (link)) {
-				if (Path.DirectorySeparatorChar != '\\')
+				if (Path.DirectorySeparatorChar != '\\') {
+					Log (task, $"GetVirtualProjectPath ({projectDir}, {item.ItemSpec}, {isVSBuild}) => Link={link.Replace ('\\', '/')} (original {link})");
 					return link.Replace ('\\', '/');
+				}
 
+				Log (task, $"GetVirtualProjectPath ({projectDir}, {item.ItemSpec}, {isVSBuild}) => Link={link.Replace ('\\', '/')}");
 				return link;
 			}
 
-			// HACK: This is for Visual Studio iOS projects
+			var isDefaultItem = item.GetMetadata ("IsDefaultItem") == "true";
+			var localMSBuildProjectFullPath = item.GetMetadata ("LocalMSBuildProjectFullPath");
+			var localDefiningProjectFullPath = item.GetMetadata ("LocalDefiningProjectFullPath").Replace ('\\', '/');
+			string path;
+			string baseDir;
+
+			string rv;
+
+			if (string.IsNullOrEmpty (localDefiningProjectFullPath)) {
+				task.Log.LogError ($"The item {item.ItemSpec} does not have a 'LocalDefiningProjectFullPath' value set.");
+				return "placeholder";
+			}
+
+			if (string.IsNullOrEmpty (localMSBuildProjectFullPath)) {
+				task.Log.LogError ($"The item {item.ItemSpec} does not have a 'LocalMSBuildProjectFullPath' value set.");
+				return "placeholder";
+			}
+
 			if (isVSBuild) {
-				if (item.GetMetadata ("DefiningProjectFullPath") != item.GetMetadata ("MSBuildProjectFullPath")) {
-					return item.GetMetadata ("FullPath").Replace (item.GetMetadata ("DefiningProjectDirectory"), string.Empty);
+				// 'path' is full path on Windows
+				path = PathUtils.PathCombineWindows (projectDir, item.ItemSpec);
+
+				// 'baseDir' is the base directory in Windows
+				if (isDefaultItem) {
+					baseDir = Path.GetDirectoryName (localMSBuildProjectFullPath);
 				} else {
-					return item.ItemSpec;
+					baseDir = Path.GetDirectoryName (localDefiningProjectFullPath);
 				}
-			}
 
-			var isDefaultItem = item.GetMetadata ("IsDefaultItem") == "true";
-			var definingProjectFullPath = item.GetMetadata (isDefaultItem ? "MSBuildProjectFullPath" : "DefiningProjectFullPath");
-			var path = item.GetMetadata ("FullPath");
-			string baseDir;
-
-			if (!string.IsNullOrEmpty (definingProjectFullPath)) {
-				baseDir = Path.GetDirectoryName (definingProjectFullPath);
+				rv = PathUtils.AbsoluteToRelativeWindows (baseDir, path);
+				// Make it a mac-style path
+				rv = rv.Replace ('\\', '/');
+
+				Log (task, $"GetVirtualProjectPath\n" +
+						$"\t\t\t{projectDir}\n" +
+						$"\t\t\t{item.ItemSpec}\n" +
+						$"\t\t\t{isVSBuild}\n" +
+						$"\t\t\t\tisDefaultItem={isDefaultItem}\n" +
+						$"\t\t\t\tLocalMSBuildProjectFullPath={localMSBuildProjectFullPath}\n" +
+						$"\t\t\t\tLocalDefiningProjectFullPath={localDefiningProjectFullPath}\n" +
+						$"\t\t\t\tpath={path}\n" +
+						$"\t\t\t\tbaseDir={baseDir}\n" +
+						$"\t\t\t\t ==> {rv}");
 			} else {
-				baseDir = projectDir;
+				path = Path.Combine (projectDir, item.ItemSpec);
+
+				if (isDefaultItem) {
+					baseDir = Path.GetDirectoryName (localMSBuildProjectFullPath);
+				} else if (!string.IsNullOrEmpty (localDefiningProjectFullPath)) {
+					baseDir = Path.GetDirectoryName (localDefiningProjectFullPath);
+				} else {
+					baseDir = projectDir;
+				}
+
+				var originalBaseDir = baseDir;
+				var originalPath = path;
+
+				baseDir = PathUtils.ResolveSymbolicLinks (baseDir);
+				path = PathUtils.ResolveSymbolicLinks (path);
+
+				rv = PathUtils.AbsoluteToRelative (baseDir, path);
+				Log (task, $"GetVirtualProjectPath\n" +
+						$"\t\t\t{projectDir}\n" +
+						$"\t\t\t{item.ItemSpec}\n" +
+						$"\t\t\t{isVSBuild}\n" +
+						$"\t\t\t\tisDefaultItem={isDefaultItem}\n" +
+						$"\t\t\t\tLocalMSBuildProjectFullPath={localMSBuildProjectFullPath}\n" +
+						$"\t\t\t\tLocalDefiningProjectFullPath={localDefiningProjectFullPath}\n" +
+						$"\t\t\t\tpath={path} ({originalPath})\n" +
+						$"\t\t\t\tbaseDir={baseDir} ({originalBaseDir})\n" +
+						$"\t\t\t\t ==> {rv}");
 			}
 
-			baseDir = PathUtils.ResolveSymbolicLinks (baseDir);
-			path = PathUtils.ResolveSymbolicLinks (path);
+			return rv;
+		}
 
-			return PathUtils.AbsoluteToRelative (baseDir, path);
+		static bool GetISVSBuild (Task task)
+		{
+			if (task is XamarinTask xt)
+				return !string.IsNullOrEmpty (xt.SessionId);
+			if (task is XamarinToolTask xtt)
+				return !string.IsNullOrEmpty (xtt.SessionId);
+			return false;
 		}
 
-		public static string GetLogicalName (string projectDir, IList<string> prefixes, ITaskItem item, bool isVSBuild)
+		public static string GetLogicalName (Task task, string projectDir, IList<string> prefixes, ITaskItem item)
 		{
 			var logicalName = item.GetMetadata ("LogicalName");
 
 			if (!string.IsNullOrEmpty (logicalName)) {
-				if (Path.DirectorySeparatorChar != '\\')
+				if (Path.DirectorySeparatorChar != '\\') {
+					task?.Log.LogMessage (MessageImportance.Low, $"GetLogicalName ({projectDir}, {string.Join (";", prefixes)}, {item.ItemSpec}) => has LogicalName={logicalName.Replace ('\\', '/')} (original {logicalName})");
 					return logicalName.Replace ('\\', '/');
-
+				}
+				task?.Log.LogMessage (MessageImportance.Low, $"GetLogicalName ({projectDir}, {string.Join (";", prefixes)}, {item.ItemSpec}) => has LogicalName={logicalName}");
 				return logicalName;
 			}
 
-			var vpath = GetVirtualProjectPath (projectDir, item, isVSBuild);
+			var vpath = GetVirtualProjectPath (task, projectDir, item, GetISVSBuild (task));
 			int matchlen = 0;
 
 			foreach (var prefix in prefixes) {
 				if (vpath.StartsWith (prefix, StringComparison.OrdinalIgnoreCase) && prefix.Length > matchlen)
 					matchlen = prefix.Length;
 			}
 
-			if (matchlen > 0)
+			if (matchlen > 0) {
+				task?.Log.LogMessage (MessageImportance.Low, $"GetLogicalName ({projectDir}, {string.Join (";", prefixes)}, {item.ItemSpec}) => has LogicalName={vpath.Substring (matchlen)} with vpath {vpath} substring {matchlen}");
 				return vpath.Substring (matchlen);
+			}
 
+			task?.Log.LogMessage (MessageImportance.Low, $"GetLogicalName ({projectDir}, {string.Join (";", prefixes)}, {item.ItemSpec}) => has LogicalName={vpath.Substring (matchlen)} with vpath {vpath}");
 			return vpath;
 		}
 	}

msbuild/Xamarin.MacDev.Tasks/Tasks/ACTool.cs

@@ -62,7 +62,7 @@ bool IsMessagesExtension {
 
 		protected override void AppendCommandLineArguments (IDictionary<string, string?> environment, CommandLineArgumentBuilder args, ITaskItem [] items)
 		{
-			var assetDirs = new HashSet<string> (items.Select (x => BundleResource.GetVirtualProjectPath (ProjectDir, x, !string.IsNullOrEmpty (SessionId))));
+			var assetDirs = new HashSet<string> (items.Select (x => BundleResource.GetVirtualProjectPath (this, ProjectDir, x)));
 
 			if (!string.IsNullOrEmpty (XSAppIconAssets)) {
 				int index = XSAppIconAssets.IndexOf (".xcassets" + Path.DirectorySeparatorChar, StringComparison.Ordinal);
@@ -210,7 +210,7 @@ public override bool Execute ()
 			var specs = new PArray ();
 
 			for (int i = 0; i < ImageAssets.Length; i++) {
-				var vpath = BundleResource.GetVirtualProjectPath (ProjectDir, ImageAssets [i], !string.IsNullOrEmpty (SessionId));
+				var vpath = BundleResource.GetVirtualProjectPath (this, ProjectDir, ImageAssets [i]);
 
 				// Ignore MacOS .DS_Store files...
 				if (Path.GetFileName (vpath).Equals (".DS_Store", StringComparison.OrdinalIgnoreCase))
@@ -251,7 +251,7 @@ public override bool Execute ()
 				items.Clear ();
 
 				for (int i = 0; i < ImageAssets.Length; i++) {
-					var vpath = BundleResource.GetVirtualProjectPath (ProjectDir, ImageAssets [i], !string.IsNullOrEmpty (SessionId));
+					var vpath = BundleResource.GetVirtualProjectPath (this, ProjectDir, ImageAssets [i]);
 					var clone = false;
 					ITaskItem item;
 
@@ -302,7 +302,7 @@ public override bool Execute ()
 
 			// Note: `items` contains only the Contents.json files at this point
 			for (int i = 0; i < items.Count; i++) {
-				var vpath = BundleResource.GetVirtualProjectPath (ProjectDir, items [i], !string.IsNullOrEmpty (SessionId));
+				var vpath = BundleResource.GetVirtualProjectPath (this, ProjectDir, items [i]);
 				var path = items [i].GetMetadata ("FullPath");
 
 				// get the parent (which will typically be .appiconset, .launchimage, .imageset, .iconset, etc)

msbuild/Xamarin.MacDev.Tasks/Tasks/CollectBundleResources.cs

@@ -1,6 +1,8 @@
 using System;
+using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Collections.Generic;
+using System.Linq;
 
 using Microsoft.Build.Framework;
 using Microsoft.Build.Utilities;
@@ -31,6 +33,8 @@ public class CollectBundleResources : XamarinTask, ICancelableTask {
 		[Output]
 		public ITaskItem [] BundleResourcesWithLogicalNames { get; set; } = Array.Empty<ITaskItem> ();
 
+		public ITaskItem [] UnpackedResources { get; set; } = Array.Empty<ITaskItem> ();
+
 		#endregion
 
 		static bool CanOptimize (string path)
@@ -68,37 +72,8 @@ bool ExecuteImpl ()
 			var bundleResources = new List<ITaskItem> ();
 
 			foreach (var item in BundleResources) {
-				// Skip anything with the PublishFolderType metadata, these are copied directly to the ResolvedFileToPublish item group instead.
-				var publishFolderType = item.GetMetadata ("PublishFolderType");
-				if (!string.IsNullOrEmpty (publishFolderType))
-					continue;
-
-				var logicalName = BundleResource.GetLogicalName (ProjectDir, prefixes, item, !string.IsNullOrEmpty (SessionId));
-				// We need a physical path here, ignore the Link element
-				var path = item.GetMetadata ("FullPath");
-
-				if (!File.Exists (path)) {
-					Log.LogError (MSBStrings.E0099, logicalName, path);
-					continue;
-				}
-
-				if (logicalName.StartsWith (".." + Path.DirectorySeparatorChar, StringComparison.Ordinal)) {
-					Log.LogError (null, null, null, item.ItemSpec, 0, 0, 0, 0, MSBStrings.E0100, logicalName);
-					continue;
-				}
-
-				if (logicalName == "Info.plist") {
-					Log.LogWarning (null, null, null, item.ItemSpec, 0, 0, 0, 0, MSBStrings.E0101);
+				if (!TryCreateItemWithLogicalName (this, item, ProjectDir, prefixes, SessionId, out var bundleResource))
 					continue;
-				}
-
-				if (BundleResource.IsIllegalName (logicalName, out var illegal)) {
-					Log.LogError (null, null, null, item.ItemSpec, 0, 0, 0, 0, MSBStrings.E0102, illegal);
-					continue;
-				}
-
-				var bundleResource = new TaskItem (item);
-				bundleResource.SetMetadata ("LogicalName", logicalName);
 
 				bool optimize = false;
 
@@ -122,11 +97,51 @@ bool ExecuteImpl ()
 				bundleResources.Add (bundleResource);
 			}
 
+			bundleResources.AddRange (UnpackedResources);
+
 			BundleResourcesWithLogicalNames = bundleResources.ToArray ();
 
 			return !Log.HasLoggedErrors;
 		}
 
+		public static bool TryCreateItemWithLogicalName (Task task, ITaskItem item, string projectDir, IList<string> prefixes, string sessionId, [NotNullWhen (true)] out TaskItem? itemWithLogicalName)
+		{
+			itemWithLogicalName = null;
+
+			// Skip anything with the PublishFolderType metadata, these are copied directly to the ResolvedFileToPublish item group instead.
+			var publishFolderType = item.GetMetadata ("PublishFolderType");
+			if (!string.IsNullOrEmpty (publishFolderType))
+				return false;
+
+			var logicalName = BundleResource.GetLogicalName (task, projectDir, prefixes, item);
+			// We need a physical path here, ignore the Link element
+			var path = item.GetMetadata ("FullPath");
+
+			if (!File.Exists (path)) {
+				task.Log.LogError (MSBStrings.E0099, logicalName, path);
+				return false;
+			}
+
+			if (logicalName.StartsWith (".." + Path.DirectorySeparatorChar, StringComparison.Ordinal)) {
+				task.Log.LogError (null, null, null, item.ItemSpec, 0, 0, 0, 0, MSBStrings.E0100, logicalName);
+				return false;
+			}
+
+			if (logicalName == "Info.plist") {
+				task.Log.LogWarning (null, null, null, item.ItemSpec, 0, 0, 0, 0, MSBStrings.E0101);
+				return false;
+			}
+
+			if (BundleResource.IsIllegalName (logicalName, out var illegal)) {
+				task.Log.LogError (null, null, null, item.ItemSpec, 0, 0, 0, 0, MSBStrings.E0102, illegal);
+				return false;
+			}
+
+			itemWithLogicalName = new TaskItem (item);
+			itemWithLogicalName.SetMetadata ("LogicalName", logicalName);
+			return true;
+		}
+
 		public void Cancel ()
 		{
 			if (ShouldExecuteRemotely ())