Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Window title not shown when packaged #309

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 9 additions & 23 deletions src/.nuspec/Uno.Resizetizer.targets
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,6 @@
AssemblyFile="$(_UnoResizetizerTaskAssemblyName)"
TaskName="Uno.Resizetizer.GenerateWasmSplashAssets_v0"/>

<UsingTask
AssemblyFile="$(_UnoResizetizerTaskAssemblyName)"
TaskName="Uno.Resizetizer.WindowIconGeneratorTask_V0"/>

<UsingTask
AssemblyFile="$(_UnoResizetizerTaskAssemblyName)"
TaskName="Uno.Resizetizer.CleanupAssetsTask_v0"/>
Expand Down Expand Up @@ -231,6 +227,8 @@
_ComputeAndroidResourcePaths;
$(UnoResizetizeCollectItemsAfterTargets);
UnoAssetsGeneration;
GenerateMSBuildEditorConfigFileShouldRun;
GenerateMSBuildEditorConfigFileCore;
</UnoResizetizeCollectItemsBeforeTargets>

<UnoResizetizeAfterTargets>
Expand Down Expand Up @@ -418,6 +416,7 @@
WriteOnlyWhenDifferent="true"/>

<ItemGroup>
<AdditionalFiles Include="$(_UnoResizetizerInputsFile)"/>
<FileWrites Include="$(_UnoResizetizerInputsFile)"/>
<FileWrites Include="$(_UnoSplashInputsFile)"/>
</ItemGroup>
Expand Down Expand Up @@ -589,25 +588,12 @@
</ItemGroup>
</Target>

<Target Name="_GenerateWindowUnoIconExtension"
Condition="'$(_UnoResizetizerIsCompatibleApp)' == 'True'"
BeforeTargets="Build;CoreCompile;XamlPreCompile"
Inputs="@(UnoIcon)"
Outputs="@(_WindowIconExtension)">

<PropertyGroup>
<WindowTitle Condition="'$(WindowTitle)' == ''">$([MSBuild]::ValueOrDefault('$(ApplicationTitle)', '$(AssemblyName)'))</WindowTitle>
</PropertyGroup>

<WindowIconGeneratorTask_v0
IntermediateOutputDirectory="$(_UnoResizetizerIntermediateOutputRoot)"
WindowTitle="$(WindowTitle)"
UnoIcons="@(UnoIcon)">
<Output ItemName="GeneratedFile"
TaskParameter="GeneratedClass"/>
<Output ItemName="FilesWrite"
TaskParameter="GeneratedClass"/>
</WindowIconGeneratorTask_v0>
<Target Name="SetUnoImage"
BeforeTargets="GenerateMSBuildEditorConfigFileShouldRun;GenerateMSBuildEditorConfigFileCore;ResolveFrameworkReferencesDesignTime;ResolveProjectReferencesDesignTime2;CollectAnalyzersDesignTime;GetAndroidDependencies">
<CreateProperty Value="@(UnoIcon, ',')">
<Output TaskParameter="Value"
PropertyName="UnoResizetizerIcon" />
</CreateProperty>
</Target>

<Target Name="_AddResizetizerWindowIconExtensions"
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<IsPackable>false</IsPackable>
<AssemblyName>Uno.Resizetizer</AssemblyName>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the assembly name be Uno.Resizetizer.Generators?

<DevelopmentDependency>true</DevelopmentDependency>
<BuildOutputTargetFolder>analyzers/dotnet/cs</BuildOutputTargetFolder>
<LangVersion>latest</LangVersion>
<IncludeBuildOutput>false</IncludeBuildOutput>
<PolySharpIncludeGeneratedTypes>
System.Runtime.CompilerServices.IsExternalInit;
System.Diagnostics.CodeAnalysis.NotNullWhenAttribute;
</PolySharpIncludeGeneratedTypes>
<EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="AvantiPoint.CodeGenHelpers" Version="1.6.20">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.4">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.10.0" />
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a too recent. We should really be using the oldest version we can and bump only if there is a specific new API we need

<PackageReference Include="PolySharp" Version="1.14.1">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
</ItemGroup>

</Project>
178 changes: 178 additions & 0 deletions src/Resizetizer/Resizetizer.Generators/WindowTitleGenerator.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,178 @@
using System;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading;
using CodeGenHelpers;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.Diagnostics;
using Microsoft.CodeAnalysis.Text;

namespace Resizetizer.Generators;

[Generator(LanguageNames.CSharp)]
internal sealed class WindowTitleGenerator : IIncrementalGenerator
{
private const string UnoResizetizerIcon = nameof(UnoResizetizerIcon);
private const string IsUnoHead = nameof(IsUnoHead);

public void Initialize(IncrementalGeneratorInitializationContext context)
{
// Get the AnalyzerConfigOptionsProvider
var optionsProvider = context.AnalyzerConfigOptionsProvider;
var compilationProvider = context.CompilationProvider;
var additionalTextsProvider = context.AdditionalTextsProvider;

// Combine optionsProvider and compilationProvider
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's no longer incremental once you combine with compilationProvider.

Instead, use an assembly name provider:

var assemblyNameProvider = context.CompilationProvider.Select((compilation, _) => compilation.Assembly.Name);

var combinedProvider = additionalTextsProvider
.Combine(compilationProvider)
.Combine(optionsProvider);

// Define the source generator logic
var sourceCodeProvider = combinedProvider.Select(GenerateExtensionGenerationContext).Where(result => result != null);

// Register the source generator logic to add the generated source code
context.RegisterSourceOutput(sourceCodeProvider, (sourceContext, extensionContext) =>
{
if (!string.IsNullOrEmpty(extensionContext.WindowTitle))
{
GenerateLegacyNamespaceCompat();
GenerateWindowTitleExtension(extensionContext.RootNamespace, extensionContext.UnoIcon, extensionContext.WindowTitle);
}
});
}

static ExtensionGenerationContext GenerateExtensionGenerationContext(((AdditionalText, Compilation), AnalyzerConfigOptionsProvider) combined, CancellationToken cancellationToken)
{
var ((additionalText, compilation), options) = combined;
var additionalFile = additionalText;

if (!GetProperty(options.GlobalOptions, IsUnoHead))
{
return null;
}
else if (Path.GetFileName(additionalFile.Path).Equals("UnoImage.inputs", StringComparison.InvariantCultureIgnoreCase))
{
var text = additionalFile.GetText(cancellationToken);
var textContent = text?.ToString();
var unoIcon = ParseFile(textContent);

var rootNamespace = GetPropertyValue(options.GlobalOptions, "RootNamespace");
var iconName = Path.GetFileNameWithoutExtension(unoIcon);
var windowTitle = GetPropertyValue(options.GlobalOptions, "ApplicationTitle");
if (string.IsNullOrEmpty(windowTitle))
{
windowTitle = compilation.AssemblyName!;
}

return new ExtensionGenerationContext(rootNamespace, iconName, windowTitle);
}

return null;
}

internal record ExtensionGenerationContext(string RootNamespace, string UnoIcon, string WindowTitle);

private static string ParseFile(string content)
{
// Split the content into lines
var lines = content.Split(new[] { '\n', '\r' }, StringSplitOptions.RemoveEmptyEntries);

foreach (var line in lines)
{
// Split the line into key-value pairs
var properties = line.Split(';').Select(property => property.Split('=')).ToDictionary(parts => parts[0], parts => parts.Length > 1 ? parts[1] : null);

// Check if IsAppIcon is true
if (properties.TryGetValue("IsAppIcon", out var isAppIcon) && bool.TryParse(isAppIcon, out var isAppIconValue) && isAppIconValue)
{
// Return the file path
if (properties.TryGetValue("File", out var filePath))
{
return filePath;
}
}
}

// Return null if no app icon is found
return null;
}

private static ClassBuilder GenerateWindowTitleExtension(string rootNamespace, string iconName, string windowTitle)
{
var builder = CodeBuilder.Create(rootNamespace)
.AddClass("WindowExtensions")
.MakeStaticClass()
.WithSummary(@"Extension methods for the <see cref=""global::Microsoft.UI.Xaml.Window"" /> class.");

builder.AddMethod("SetWindowIcon")
.AddParameter("this global::Microsoft.UI.Xaml.Window", "window")
.MakeStaticMethod()
.MakePublicMethod()
.WithSummary(@"This will set the Window Icon for the given <see cref=""global::Microsoft.UI.Xaml.Window"" /> using the provided UnoIcon.")
.WithBody(w =>
{
w.AppendUnindentedLine("#if WINDOWS && !HAS_UNO");
w.AppendLine("var hWnd = global::WinRT.Interop.WindowNative.GetWindowHandle(window);");
w.NewLine();
w.AppendLine("// Retrieve the WindowId that corresponds to hWnd.");
w.AppendLine("global::Microsoft.UI.WindowId windowId = global::Microsoft.UI.Win32Interop.GetWindowIdFromWindow(hWnd);");
w.NewLine();
w.AppendLine("// Lastly, retrieve the AppWindow for the current (XAML) WinUI 3 window.");
w.AppendLine("global::Microsoft.UI.Windowing.AppWindow appWindow = global::Microsoft.UI.Windowing.AppWindow.GetFromWindowId(windowId);");
w.AppendLine($@"appWindow.SetIcon(""{iconName}.ico"");");
w.NewLine();
w.AppendLine("// Set the Window Title Only if it has the Default WinUI Desktop value and we are running Unpackaged");
// We're no longer checking for IsPackaged as this seems to be needed when Packaged as well.
w.If(@"appWindow.Title == ""WinUI Desktop""")
.WithBody(b =>
{
b.AppendLine($@"appWindow.Title = ""{windowTitle}"";");
})
.EndIf();
w.AppendUnindentedLine("#endif");
});

// NOTE: This method has been removed as it seems WinUI isn't setting the title when Packaged. Keeping in case we need this in the future.
//builder.AddMethod("IsPackaged")
// .WithReturnType("bool")
// .MakePrivateMethod()
// .MakeStaticMethod()
// .WithBody(w =>
// {
// using (w.Block("try"))
// {
// w.AppendLine("return global::Windows.ApplicationModel.Package.Current != null;");
// }
// using (w.Block("catch"))
// {
// w.AppendLine("return false;");
// }
// });

return builder;
}

private static string GetPropertyValue(AnalyzerConfigOptions options, string key) =>
options.TryGetValue($"build_property.{key}", out var value) ? value : string.Empty;

private static bool GetProperty(AnalyzerConfigOptions options, string key) =>
bool.TryParse(GetPropertyValue(options, key), out var result) && result;

private static bool HasUnoIcon(AnalyzerConfigOptions options, out string unoIcon)
{
unoIcon = GetPropertyValue(options, UnoResizetizerIcon);
return !string.IsNullOrEmpty(unoIcon) && !unoIcon.Contains(",");
}

private static ClassBuilder GenerateLegacyNamespaceCompat()
{
return CodeBuilder.Create("Uno.Resizetizer")
.AddClass("__LegacyResizetizerSupport__")
.WithSummary("This is added to ensure the Uno.Resizetizer namespace is present to avoid breaking any applications.")
.MakeStaticClass();
}

private static void AddSource(SourceProductionContext context, ClassBuilder builder) =>
context.AddSource($"{builder.FullyQualifiedName}.g.cs", SourceText.From(builder.Build(), Encoding.UTF8));
}
21 changes: 18 additions & 3 deletions src/Resizetizer/src/Resizetizer.csproj
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
Expand All @@ -21,7 +21,7 @@
</PropertyGroup>

<PropertyGroup>
<AssemblyName>Uno.Resizetizer_v0</AssemblyName>
<AssemblyName>Uno.Resizetizer_v0</AssemblyName>
<RepositoryCommit>$(GITVERSION_SHA)</RepositoryCommit>
<PackageId>Uno.Resizetizer</PackageId>
<Description>Uno Platform package support for images.</Description>
Expand All @@ -44,7 +44,7 @@
<PackageReference Include="SkiaSharp.NativeAssets.macOS" Version="$(_SkiaSharpVersion)" />
<PackageReference Include="SkiaSharp.NativeAssets.Linux.NoDependencies" Version="$(_SkiaSharpVersion)" />
<PackageReference Include="SkiaSharp.HarfBuzz" Version="$(_SkiaSharpVersion)" />
<PackageReference Include="ExCSS" Version="4.2.3" />
<PackageReference Include="ExCSS" Version="4.2.3" />
<PackageReference Include="Svg.Skia" Version="$(SvgSkiaPackageVersion)" />
<PackageReference Include="Svg.Custom" Version="$(SvgSkiaPackageVersion)" />
<PackageReference Include="Svg.Model" Version="$(SvgSkiaPackageVersion)" />
Expand Down Expand Up @@ -72,6 +72,12 @@
<None Include="$(UnoNuspecDirectory)Uno.Resizetizer.windows.skia.targets" LinkBase="build" Pack="true" PackagePath="build/$(PackageId).windows.skia.targets" CopyToOutputDirectory="PreserveNewest" />
</ItemGroup>

<ItemGroup>
<ProjectReference Include="..\Resizetizer.Generators\Resizetizer.Generators.csproj">
<ReferenceOutputAssembly>false</ReferenceOutputAssembly>
</ProjectReference>
</ItemGroup>

<Import Project="../Directory.UnoMetadata.targets" />

<!-- Gets the Runtime Assets that need to be copied to the NuGet -->
Expand Down Expand Up @@ -119,4 +125,13 @@
Condition="Exists('$(NuGetPackageRoot)$(PackageId.ToLowerInvariant())') And '$(OS)' != 'Windows_NT'" />
</Target>

<Target Name="BundleGenerators" BeforeTargets="Pack;_LoadPackInputItems;_GetPackageFiles">
<ItemGroup>
<None Include="..\Resizetizer.Generators\bin\$(Configuration)\netstandard2.0\Uno.Resizetizer.dll"
Pack="true"
PackagePath="analyzers\dotnet\cs\Uno.Resizetizer.dll"
Visible="false" />
</ItemGroup>
</Target>

</Project>
Loading
Loading