mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-05-07 08:44:29 +08:00
- 新增 AutoRegisterExportedCollections 生成器文档 - 新增 AutoScene 生成器文档 - 新增 AutoUiPage 生成器文档 - 新增完整的源码生成器索引文档 - 详细介绍各生成器的使用方法和参数说明 - 提供生成代码示例和诊断信息说明 - 包含性能优势和使用示例章节
274 lines
12 KiB
C#
274 lines
12 KiB
C#
using GFramework.Godot.SourceGenerators.Behavior;
|
|
using GFramework.Godot.SourceGenerators.Tests.Core;
|
|
|
|
namespace GFramework.Godot.SourceGenerators.Tests.Behavior;
|
|
|
|
[TestFixture]
|
|
public class AutoUiPageGeneratorTests
|
|
{
|
|
[Test]
|
|
public async Task Generates_Ui_Page_Behavior_Boilerplate()
|
|
{
|
|
const string source = """
|
|
using System;
|
|
using GFramework.Godot.SourceGenerators.Abstractions.UI;
|
|
using Godot;
|
|
|
|
namespace GFramework.Godot.SourceGenerators.Abstractions.UI
|
|
{
|
|
[AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
|
|
public sealed class AutoUiPageAttribute : Attribute
|
|
{
|
|
public AutoUiPageAttribute(string key, string layerName) { }
|
|
}
|
|
}
|
|
|
|
namespace Godot
|
|
{
|
|
public class Node { }
|
|
public class CanvasItem : Node { }
|
|
public class Control : CanvasItem { }
|
|
}
|
|
|
|
namespace GFramework.Game.Abstractions.Enums
|
|
{
|
|
public enum UiLayer
|
|
{
|
|
Page,
|
|
Overlay,
|
|
Modal
|
|
}
|
|
}
|
|
|
|
namespace GFramework.Game.Abstractions.UI
|
|
{
|
|
public interface IUiPageBehavior { }
|
|
}
|
|
|
|
namespace GFramework.Godot.UI
|
|
{
|
|
using GFramework.Game.Abstractions.Enums;
|
|
using GFramework.Game.Abstractions.UI;
|
|
using Godot;
|
|
|
|
public static class UiPageBehaviorFactory
|
|
{
|
|
public static IUiPageBehavior Create<T>(T owner, string key, UiLayer layer)
|
|
where T : CanvasItem
|
|
{
|
|
return null!;
|
|
}
|
|
}
|
|
}
|
|
|
|
namespace TestApp
|
|
{
|
|
[AutoUiPage("MainMenu", "Page")]
|
|
public partial class MainMenu : Control
|
|
{
|
|
}
|
|
}
|
|
""";
|
|
|
|
const string expected = """
|
|
// <auto-generated />
|
|
#nullable enable
|
|
|
|
namespace TestApp;
|
|
|
|
partial class MainMenu
|
|
{
|
|
private global::GFramework.Game.Abstractions.UI.IUiPageBehavior? __autoUiPageBehavior_Generated;
|
|
|
|
public static string UiKeyStr => "MainMenu";
|
|
|
|
public global::GFramework.Game.Abstractions.UI.IUiPageBehavior GetPage()
|
|
{
|
|
return __autoUiPageBehavior_Generated ??= global::GFramework.Godot.UI.UiPageBehaviorFactory.Create(this, UiKeyStr, global::GFramework.Game.Abstractions.Enums.UiLayer.Page);
|
|
}
|
|
}
|
|
|
|
""";
|
|
|
|
await GeneratorTest<AutoUiPageGenerator>.RunAsync(
|
|
source,
|
|
("TestApp_MainMenu.AutoUiPage.g.cs", expected));
|
|
}
|
|
|
|
[Test]
|
|
public async Task Reports_Diagnostic_When_AutoUiPage_Attribute_Arguments_Are_Invalid()
|
|
{
|
|
const string source = """
|
|
using System;
|
|
using GFramework.Godot.SourceGenerators.Abstractions.UI;
|
|
using Godot;
|
|
|
|
namespace GFramework.Godot.SourceGenerators.Abstractions.UI
|
|
{
|
|
[AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
|
|
public sealed class AutoUiPageAttribute : Attribute
|
|
{
|
|
public AutoUiPageAttribute(string key) { }
|
|
}
|
|
}
|
|
|
|
namespace Godot
|
|
{
|
|
public class Node { }
|
|
public class CanvasItem : Node { }
|
|
public class Control : CanvasItem { }
|
|
}
|
|
|
|
namespace GFramework.Game.Abstractions.Enums
|
|
{
|
|
public enum UiLayer
|
|
{
|
|
Page
|
|
}
|
|
}
|
|
|
|
namespace GFramework.Game.Abstractions.UI
|
|
{
|
|
public interface IUiPageBehavior { }
|
|
}
|
|
|
|
namespace GFramework.Godot.UI
|
|
{
|
|
using GFramework.Game.Abstractions.Enums;
|
|
using GFramework.Game.Abstractions.UI;
|
|
using Godot;
|
|
|
|
public static class UiPageBehaviorFactory
|
|
{
|
|
public static IUiPageBehavior Create<T>(T owner, string key, UiLayer layer)
|
|
where T : CanvasItem
|
|
{
|
|
return null!;
|
|
}
|
|
}
|
|
}
|
|
|
|
namespace TestApp
|
|
{
|
|
[{|#0:AutoUiPage("MainMenu")|}]
|
|
public partial class MainMenu : Control
|
|
{
|
|
}
|
|
}
|
|
""";
|
|
|
|
var test = new CSharpSourceGeneratorTest<AutoUiPageGenerator, DefaultVerifier>
|
|
{
|
|
TestState =
|
|
{
|
|
Sources = { source }
|
|
},
|
|
DisabledDiagnostics = { "GF_Common_Trace_001" },
|
|
TestBehaviors = TestBehaviors.SkipGeneratedSourcesCheck
|
|
};
|
|
|
|
test.ExpectedDiagnostics.Add(new DiagnosticResult("GF_AutoBehavior_004", DiagnosticSeverity.Error)
|
|
.WithLocation(0)
|
|
.WithArguments(
|
|
"AutoUiPageAttribute",
|
|
"MainMenu",
|
|
"a string key argument and a string UiLayer name argument"));
|
|
|
|
await test.RunAsync();
|
|
}
|
|
|
|
[Test]
|
|
public async Task Generates_Type_Constraints_For_ClassNullable_NotNull_And_Unmanaged()
|
|
{
|
|
const string source = """
|
|
#nullable enable
|
|
using System;
|
|
using GFramework.Godot.SourceGenerators.Abstractions.UI;
|
|
using Godot;
|
|
|
|
namespace GFramework.Godot.SourceGenerators.Abstractions.UI
|
|
{
|
|
[AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
|
|
public sealed class AutoUiPageAttribute : Attribute
|
|
{
|
|
public AutoUiPageAttribute(string key, string layerName) { }
|
|
}
|
|
}
|
|
|
|
namespace Godot
|
|
{
|
|
public class Node { }
|
|
public class CanvasItem : Node { }
|
|
public class Control : CanvasItem { }
|
|
}
|
|
|
|
namespace GFramework.Game.Abstractions.Enums
|
|
{
|
|
public enum UiLayer
|
|
{
|
|
Page
|
|
}
|
|
}
|
|
|
|
namespace GFramework.Game.Abstractions.UI
|
|
{
|
|
public interface IUiPageBehavior { }
|
|
}
|
|
|
|
namespace GFramework.Godot.UI
|
|
{
|
|
using GFramework.Game.Abstractions.Enums;
|
|
using GFramework.Game.Abstractions.UI;
|
|
using Godot;
|
|
|
|
public static class UiPageBehaviorFactory
|
|
{
|
|
public static IUiPageBehavior Create<T>(T owner, string key, UiLayer layer)
|
|
where T : CanvasItem
|
|
{
|
|
return null!;
|
|
}
|
|
}
|
|
}
|
|
|
|
namespace TestApp
|
|
{
|
|
[AutoUiPage("MainMenu", "Page")]
|
|
public partial class MainMenu<TReference, TNotNull, TUnmanaged> : Control
|
|
where TReference : class?
|
|
where TNotNull : notnull
|
|
where TUnmanaged : unmanaged
|
|
{
|
|
}
|
|
}
|
|
""";
|
|
|
|
const string expected = """
|
|
// <auto-generated />
|
|
#nullable enable
|
|
|
|
namespace TestApp;
|
|
|
|
partial class MainMenu<TReference, TNotNull, TUnmanaged>
|
|
where TReference : class?
|
|
where TNotNull : notnull
|
|
where TUnmanaged : unmanaged
|
|
{
|
|
private global::GFramework.Game.Abstractions.UI.IUiPageBehavior? __autoUiPageBehavior_Generated;
|
|
|
|
public static string UiKeyStr => "MainMenu";
|
|
|
|
public global::GFramework.Game.Abstractions.UI.IUiPageBehavior GetPage()
|
|
{
|
|
return __autoUiPageBehavior_Generated ??= global::GFramework.Godot.UI.UiPageBehaviorFactory.Create(this, UiKeyStr, global::GFramework.Game.Abstractions.Enums.UiLayer.Page);
|
|
}
|
|
}
|
|
|
|
""";
|
|
|
|
await GeneratorTest<AutoUiPageGenerator>.RunAsync(
|
|
source,
|
|
("TestApp_MainMenu.AutoUiPage.g.cs", expected));
|
|
}
|
|
}
|