Source generate the license file loading

This commit is contained in:
ds5678 2025-04-08 12:18:46 -07:00
parent 06b6ae8171
commit 5b8fdabbc9
5 changed files with 132 additions and 29 deletions

View File

@ -162,6 +162,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AssetRipper.SmartEnums", "S
EndProject EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AssetRipper.Processing.SourceGenerator", "Source\AssetRipper.Processing.SourceGenerator\AssetRipper.Processing.SourceGenerator.csproj", "{6679D5D0-8D40-44AC-9D20-0FD1303D45A2}" Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AssetRipper.Processing.SourceGenerator", "Source\AssetRipper.Processing.SourceGenerator\AssetRipper.Processing.SourceGenerator.csproj", "{6679D5D0-8D40-44AC-9D20-0FD1303D45A2}"
EndProject EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AssetRipper.GUI.Licensing.SourceGenerator", "Source\AssetRipper.GUI.Licensing.SourceGenerator\AssetRipper.GUI.Licensing.SourceGenerator.csproj", "{6B3DD564-FD57-4EAA-8696-A15A5A6FFF29}"
EndProject
Global Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU Debug|Any CPU = Debug|Any CPU
@ -340,6 +342,10 @@ Global
{6679D5D0-8D40-44AC-9D20-0FD1303D45A2}.Debug|Any CPU.Build.0 = Debug|Any CPU {6679D5D0-8D40-44AC-9D20-0FD1303D45A2}.Debug|Any CPU.Build.0 = Debug|Any CPU
{6679D5D0-8D40-44AC-9D20-0FD1303D45A2}.Release|Any CPU.ActiveCfg = Release|Any CPU {6679D5D0-8D40-44AC-9D20-0FD1303D45A2}.Release|Any CPU.ActiveCfg = Release|Any CPU
{6679D5D0-8D40-44AC-9D20-0FD1303D45A2}.Release|Any CPU.Build.0 = Release|Any CPU {6679D5D0-8D40-44AC-9D20-0FD1303D45A2}.Release|Any CPU.Build.0 = Release|Any CPU
{6B3DD564-FD57-4EAA-8696-A15A5A6FFF29}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{6B3DD564-FD57-4EAA-8696-A15A5A6FFF29}.Debug|Any CPU.Build.0 = Debug|Any CPU
{6B3DD564-FD57-4EAA-8696-A15A5A6FFF29}.Release|Any CPU.ActiveCfg = Release|Any CPU
{6B3DD564-FD57-4EAA-8696-A15A5A6FFF29}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection EndGlobalSection
GlobalSection(SolutionProperties) = preSolution GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE HideSolutionNode = FALSE

View File

@ -0,0 +1,24 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<IsAotCompatible>false</IsAotCompatible>
<AppendTargetFrameworkToOutputPath>true</AppendTargetFrameworkToOutputPath>
<EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.11.0">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.13.0" />
<PackageReference Include="SourceGenerator.Foundations" Version="2.0.13" />
</ItemGroup>
<ItemGroup>
<!-- Generator dependencies -->
<PackageReference Include="AssetRipper.Text.SourceGeneration" Version="1.2.2" PrivateAssets="all" GeneratePathProperty="true" />
</ItemGroup>
</Project>

View File

@ -0,0 +1,86 @@
using AssetRipper.Text.SourceGeneration;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using SGF;
using System.CodeDom.Compiler;
using System.Collections.Immutable;
namespace AssetRipper.GUI.Licensing.SourceGenerator;
[IncrementalGenerator]
public sealed class LicensesGenerator() : IncrementalGenerator(nameof(LicensesGenerator))
{
public override void OnInitialize(SgfInitializationContext context)
{
IncrementalValueProvider<ImmutableArray<(string Name, string License)>> pipeline = context.AdditionalTextsProvider
.Where(static (text) => text.Path.EndsWith(".md"))
.Select(static (text, cancellationToken) =>
{
string name = Path.GetFileNameWithoutExtension(text.Path);
string? license = text.GetText(cancellationToken)?.ToString();
return (name, license);
})
.Where(static (pair) => pair.license != null)
.Collect()!;
context.RegisterSourceOutput(pipeline, GenerateCode);
}
private static void GenerateCode(SgfSourceProductionContext context, ImmutableArray<(string Name, string License)> array)
{
using StringWriter stringWriter = new();
using IndentedTextWriter writer = IndentedTextWriterFactory.Create(stringWriter);
writer.WriteGeneratedCodeWarning();
writer.WriteLineNoTabs();
writer.WriteLine("#nullable enable");
writer.WriteLineNoTabs();
writer.WriteFileScopedNamespace("AssetRipper.GUI.Licensing");
writer.WriteLineNoTabs();
writer.WriteLine("partial class Licenses");
using (new CurlyBrackets(writer))
{
List<(string, string)> sourceNames = new(array.Length);
foreach ((string name, string license) in array.OrderBy(pair => pair.Name))
{
string sourceName = name.Replace('.', '_').Replace('-', '_');
sourceNames.Add((name, sourceName));
writer.WriteLine($"private static global::System.ReadOnlySpan<byte> {sourceName}_span => {SymbolDisplay.FormatLiteral(license, true)}u8;");
writer.WriteLine($"private static string? {sourceName}_field;");
if (name != sourceName)
{
writer.WriteSummaryDocumentation(name);
}
writer.WriteLine($"public static string {sourceName} => {sourceName}_field ??= global::System.Text.Encoding.UTF8.GetString({sourceName}_span);");
writer.WriteLineNoTabs();
}
// Names list
writer.WriteLine("public static global::System.Collections.Generic.IReadOnlyList<string> Names { get; } =");
writer.WriteLine('[');
using (new Indented(writer))
{
foreach ((string name, _) in sourceNames)
{
writer.WriteLine($"{SymbolDisplay.FormatLiteral(name, true)},");
}
}
writer.WriteLine("];");
writer.WriteLineNoTabs();
// Get method
writer.WriteLine("public static string? TryLoad(string name) => name switch");
using (new CurlyBracketsWithSemicolon(writer))
{
foreach ((string name, string sourceName) in sourceNames)
{
writer.WriteLine($"{SymbolDisplay.FormatLiteral(name, true)} => {sourceName},");
}
writer.WriteLine($"_ => null,");
}
}
context.AddSource("Licenses.g.cs", stringWriter.ToString());
}
}

View File

@ -4,11 +4,16 @@
<IsTrimmable>true</IsTrimmable> <IsTrimmable>true</IsTrimmable>
<OutputPath>..\0Bins\Other\AssetRipper.GUI.Licensing\$(Configuration)\</OutputPath> <OutputPath>..\0Bins\Other\AssetRipper.GUI.Licensing\$(Configuration)\</OutputPath>
<IntermediateOutputPath>..\0Bins\obj\AssetRipper.GUI.Licensing\$(Configuration)\</IntermediateOutputPath> <IntermediateOutputPath>..\0Bins\obj\AssetRipper.GUI.Licensing\$(Configuration)\</IntermediateOutputPath>
<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
<None Remove="..\Licenses\*.md" /> <None Remove="..\Licenses\*.md" />
<EmbeddedResource Include="..\Licenses\*.md" /> <AdditionalFiles Include="..\Licenses\*.md" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\AssetRipper.GUI.Licensing.SourceGenerator\AssetRipper.GUI.Licensing.SourceGenerator.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
</ItemGroup> </ItemGroup>
</Project> </Project>

View File

@ -1,42 +1,24 @@
using System.Reflection; namespace AssetRipper.GUI.Licensing;
namespace AssetRipper.GUI.Licensing; public static partial class Licenses
public static class Licenses
{ {
private const string FilePrefix = "AssetRipper.GUI.Licensing.";
private static Assembly Assembly => typeof(Licenses).Assembly;
public static IReadOnlyList<string> Names { get; } = Assembly
.GetManifestResourceNames()
.Select(t => t.Substring(FilePrefix.Length, t.Length - FilePrefix.Length - 3))
.ToArray();
/// <summary> /// <summary>
/// Load a license file from the embedded resources. /// Load a license file.
/// </summary> /// </summary>
/// <param name="fileName">The name of the file without any extension.</param> /// <param name="name">The name of the license (without any extension).</param>
/// <returns>The loaded text.</returns> /// <returns>The loaded text.</returns>
public static string Load(string fileName) public static string Load(string name)
{ {
if (TryLoad(fileName, out string? license)) if (TryLoad(name, out string? license))
{ {
return license; return license;
} }
throw new LicenseNotFoundException(fileName); throw new LicenseNotFoundException(name);
} }
public static bool TryLoad(string fileName, [NotNullWhen(true)] out string? license) public static bool TryLoad(string name, [NotNullWhen(true)] out string? license)
{ {
using Stream? stream = Assembly.GetManifestResourceStream(FilePrefix + fileName + ".md"); license = TryLoad(name);
if (stream is null) return license is not null;
{
license = null;
return false;
}
license = new StreamReader(stream).ReadToEnd();
return true;
} }
} }