Merge branch 'improve-manifest-file-generation-dpiawareness-fix' into 'main'

Improve manifest file generation + dpiAwareness fix

See merge request Sharpmake/sharpmake!632

Author: jspelletier

Sharpmake.Generators/VisualStudio/ProjectOptionsGenerator.Template.cs

@@ -0,0 +1,33 @@
+// Copyright (c) Ubisoft. All Rights Reserved.
+// Licensed under the Apache 2.0 License. See LICENSE.md in the project root for license information.
+
+namespace Sharpmake.Generators.VisualStudio
+{
+    public partial class ProjectOptionsGenerator
+    {
+        public static class Template
+        {
+            public static class Manifest
+            {
+                // Manifest file contents copied from example on msdn page here:
+                // https://learn.microsoft.com/en-us/windows/win32/hidpi/setting-the-default-dpi-awareness-for-a-process#setting-default-awareness-with-the-application-manifest
+                public const string FileBegin = @"<?xml version=""1.0"" encoding=""utf-8"" standalone=""yes""?>
+<assembly xmlns=""urn:schemas-microsoft-com:asm.v1"" manifestVersion=""1.0"">
+  <application xmlns=""urn:schemas-microsoft-com:asm.v3"">
+    <windowsSettings>";
+
+                // Include both dpiAware and dpiAwareness values for "backwards compatibility", though it should be good enough to just specify dpiAwareness = PerMonitorV2
+                // See msdn link above for more info on the dpiAwareness configuration values.
+                public const string DPIAwarenessSettings = @"
+      <dpiAware xmlns=""http://schemas.microsoft.com/SMI/2005/WindowsSettings"">true/PM</dpiAware>
+      <dpiAwareness xmlns=""http://schemas.microsoft.com/SMI/2016/WindowsSettings"">PerMonitorV2,PerMonitor</dpiAwareness>
+";
+
+                public const string FileEnd =
+@"    </windowsSettings>
+  </application>
+</assembly>";
+            }
+        }
+    }
+}

Sharpmake.Generators/VisualStudio/ProjectOptionsGenerator.cs

@@ -22,7 +22,7 @@ internal enum ProjectOptionGenerationLevel
         All,
     }
 
-    public class ProjectOptionsGenerator
+    public partial class ProjectOptionsGenerator
     {
         // Only MacOS have a subfolder, refer to https://developer.apple.com/library/archive/documentation/CoreFoundation/Conceptual/CFBundles/BundleTypes/BundleTypes.html
         private static readonly string AppleAppBinaryRootFolderForMac = "Contents" + XCodeProj.FolderSeparator + "MacOS" + XCodeProj.FolderSeparator;
@@ -1948,37 +1948,64 @@ private void GenerateManifestToolOptions(IGenerationContext context, ProjectOpti
 
             Strings manifestInputs = new Strings();
 
-            string vsManifestFilesPath = Util.SimplifyPath(Path.Combine(context.DevelopmentEnvironment.GetVisualStudioVCRootPath(), "Include", "Manifest"));
+            bool generateManifestFile = false;
 
             //EnableDpiAwareness
+            // Yes and PerMonitor both map to the same value, since dpi scaling really doesn't work well in windows 10+ without PerMonitorV2 specified.
+            // This should be safe for older versions too, according to msdn documentation (see link below): "On older versions of Windows, the newer <dpiAwareness> tag will be ignored."
+            // https://learn.microsoft.com/en-us/windows/win32/hidpi/setting-the-default-dpi-awareness-for-a-process#setting-default-awareness-with-the-application-manifest
             context.SelectOption
             (
             Options.Option(Options.Vc.ManifestTool.EnableDpiAwareness.Default, () => { context.Options["EnableDpiAwareness"] = FileGeneratorUtilities.RemoveLineTag; }),
-            Options.Option(Options.Vc.ManifestTool.EnableDpiAwareness.Yes, () => { context.Options["EnableDpiAwareness"] = "true"; manifestInputs.Add(Path.Combine(vsManifestFilesPath, "dpiaware.manifest")); }),
-            Options.Option(Options.Vc.ManifestTool.EnableDpiAwareness.PerMonitor, () => { context.Options["EnableDpiAwareness"] = "PerMonitorHighDPIAware"; manifestInputs.Add(Path.Combine(vsManifestFilesPath, "PerMonitorHighDPIAware.manifest")); }),
+            Options.Option(Options.Vc.ManifestTool.EnableDpiAwareness.Yes, () => { context.Options["EnableDpiAwareness"] = "PerMonitorHighDPIAware"; generateManifestFile = true; }),
+            Options.Option(Options.Vc.ManifestTool.EnableDpiAwareness.PerMonitor, () => { context.Options["EnableDpiAwareness"] = "PerMonitorHighDPIAware"; generateManifestFile = true; }),
             Options.Option(Options.Vc.ManifestTool.EnableDpiAwareness.No, () => { context.Options["EnableDpiAwareness"] = "false"; })
             );
 
-            if (context.Configuration.AdditionalManifestFiles.Count > 0)
+            if (generateManifestFile)
             {
-                context.Options["AdditionalManifestFiles"] = string.Join(";", Util.PathGetRelative(context.ProjectDirectory, context.Configuration.AdditionalManifestFiles));
-                manifestInputs.AddRange(context.Configuration.AdditionalManifestFiles);
+                var fileGenerator = new XmlFileGenerator();
+                fileGenerator.Write(Template.Manifest.FileBegin);
+                fileGenerator.Write(Template.Manifest.DPIAwarenessSettings);
+                fileGenerator.Write(Template.Manifest.FileEnd);
+
+                string projFilePath = context.Configuration.ProjectFullFileName;
+                projFilePath = projFilePath.Replace('.', '_');
+
+                FileInfo projectFileInfo = new FileInfo(projFilePath + ".manifest");
+                context.Builder.Context.WriteGeneratedFile(context.Project.GetType(), projectFileInfo, fileGenerator);
+               
+                manifestInputs.Add(projectFileInfo.FullName);
             }
-            else
-                context.Options["AdditionalManifestFiles"] = FileGeneratorUtilities.RemoveLineTag;
+
+            if (context.Configuration.AdditionalManifestFiles.Count > 0)
+                manifestInputs.AddRange(context.Configuration.AdditionalManifestFiles);
 
             if (manifestInputs.Count > 0)
             {
                 Options.Vc.Linker.EmbedManifest embedManifest = Options.GetObject<Options.Vc.Linker.EmbedManifest>(context.Configuration);
                 if (embedManifest == Options.Vc.Linker.EmbedManifest.No)
                     throw new NotImplementedException("Sharpmake does not support manifestinputs without embedding the manifest!");
 
-                var cmdManifests = manifestInputs.Select(p => Bff.CmdLineConvertIncludePathsFunc(context, optionsContext.Resolver, p, "/manifestinput:"));
+                if (context.Configuration.IsFastBuild)
+                {
+                    var cmdManifests = manifestInputs.Select(p => Bff.CmdLineConvertIncludePathsFunc(context, optionsContext.Resolver, p, "/manifestinput:"));
 
-                context.CommandLineOptions["ManifestInputs"] = string.Join($"'{Environment.NewLine}                            + ' ", cmdManifests);
+                    // With fastbuild, manifest references are added to the .bff file via command line
+                    context.Options["AdditionalManifestFiles"] = FileGeneratorUtilities.RemoveLineTag;
+                    context.CommandLineOptions["ManifestInputs"] = string.Join($"'{Environment.NewLine}                            + ' ", cmdManifests);
+                }
+                else
+                {
+                    // With msbuild, manifest references are added to the .vcxproj file via the AdditionalManifestFiles field
+                    // See VcxProj.cs -> Template.Project.ProjectConfigurationsManifestTool use
+                    context.Options["AdditionalManifestFiles"] = string.Join(";", Util.PathGetRelative(context.ProjectDirectory, manifestInputs));
+                    context.CommandLineOptions["ManifestInputs"] = FileGeneratorUtilities.RemoveLineTag;
+                }
             }
             else
             {
+                context.Options["AdditionalManifestFiles"] = FileGeneratorUtilities.RemoveLineTag;
                 context.CommandLineOptions["ManifestInputs"] = FileGeneratorUtilities.RemoveLineTag;
             }
         }