mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-05-07 00:39:00 +08:00
be928718e3
### AutoSceneGenerator
- 引入保留成员名称集合（GeneratedMemberNames），包含：
- SceneKeyStr
- __autoSceneBehavior_Generated
- 实现 ReportGeneratedMemberConflicts 方法：
- 检测用户定义成员与生成成员冲突
- 提供清晰的诊断信息
- 在生成流程中集成冲突检测，避免重复成员导致的编译错误
### AutoRegisterExportedCollectionsGenerator
- 增强集合注册生成器的验证逻辑：
- 新增诊断 GF_AutoExport_006：导出集合成员必须为实例可读成员
- 新增诊断 GF_AutoExport_007：注册表成员必须为实例可读成员
- 实现 IsInstanceReadableMember 方法：
- 校验成员为非静态字段或可读属性
- 修复符号访问性检查：
- 确保注册方法对所有者类型可访问
- 优化生成逻辑：
- 过滤重复的部分类声明，仅生成一次源码
### Tests
- AutoSceneGenerator
- 覆盖保留成员冲突场景：
- SceneKeyStr 冲突
- __autoSceneBehavior_Generated 冲突
- AutoRegisterExportedCollectionsGenerator
- 覆盖完整验证逻辑：
- 不可读成员 → GF_AutoExport_006 / 007
- 方法不可访问 → GF_AutoExport_003
- 多个 partial class → 仅生成一个源文件
450 lines
21 KiB
C#
450 lines
21 KiB
C#
using GFramework.Godot.SourceGenerators.Registration;
|
|
using GFramework.Godot.SourceGenerators.Tests.Core;
|
|
|
|
namespace GFramework.Godot.SourceGenerators.Tests.Registration;
|
|
|
|
[TestFixture]
|
|
public class AutoRegisterExportedCollectionsGeneratorTests
|
|
{
|
|
[Test]
|
|
public async Task Generates_Batch_Registration_Method_For_Annotated_Collections()
|
|
{
|
|
const string source = """
|
|
#nullable enable
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using GFramework.Godot.SourceGenerators.Abstractions;
|
|
|
|
namespace GFramework.Godot.SourceGenerators.Abstractions
|
|
{
|
|
[AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
|
|
public sealed class AutoRegisterExportedCollectionsAttribute : Attribute { }
|
|
|
|
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, Inherited = false, AllowMultiple = false)]
|
|
public sealed class RegisterExportedCollectionAttribute : Attribute
|
|
{
|
|
public RegisterExportedCollectionAttribute(string registryMemberName, string registerMethodName) { }
|
|
}
|
|
}
|
|
|
|
namespace TestApp
|
|
{
|
|
public sealed class IntRegistry
|
|
{
|
|
public void Register(int value) { }
|
|
}
|
|
|
|
[AutoRegisterExportedCollections]
|
|
public partial class Bootstrapper<TReference, TNotNull, TValue, TUnmanaged>
|
|
where TReference : class?
|
|
where TNotNull : notnull
|
|
where TValue : struct
|
|
where TUnmanaged : unmanaged
|
|
{
|
|
private readonly IntRegistry? _registry = new();
|
|
|
|
[RegisterExportedCollection(nameof(_registry), nameof(IntRegistry.Register))]
|
|
public List<int>? Values { get; } = new();
|
|
}
|
|
}
|
|
""";
|
|
|
|
const string expected = """
|
|
// <auto-generated />
|
|
#nullable enable
|
|
|
|
namespace TestApp;
|
|
|
|
partial class Bootstrapper<TReference, TNotNull, TValue, TUnmanaged>
|
|
where TReference : class?
|
|
where TNotNull : notnull
|
|
where TValue : struct
|
|
where TUnmanaged : unmanaged
|
|
{
|
|
private void __RegisterExportedCollections_Generated()
|
|
{
|
|
if (this.Values is not null && this._registry is not null)
|
|
{
|
|
foreach (var __generatedItem in this.Values)
|
|
{
|
|
this._registry.Register(__generatedItem);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
""";
|
|
|
|
await GeneratorTest<AutoRegisterExportedCollectionsGenerator>.RunAsync(
|
|
source,
|
|
("TestApp_Bootstrapper.AutoRegisterExportedCollections.g.cs", expected));
|
|
}
|
|
|
|
[Test]
|
|
public async Task Reports_Diagnostic_When_Collection_Element_Type_Cannot_Be_Inferred()
|
|
{
|
|
const string source = """
|
|
using System;
|
|
using System.Collections;
|
|
using GFramework.Godot.SourceGenerators.Abstractions;
|
|
|
|
namespace GFramework.Godot.SourceGenerators.Abstractions
|
|
{
|
|
[AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
|
|
public sealed class AutoRegisterExportedCollectionsAttribute : Attribute { }
|
|
|
|
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, Inherited = false, AllowMultiple = false)]
|
|
public sealed class RegisterExportedCollectionAttribute : Attribute
|
|
{
|
|
public RegisterExportedCollectionAttribute(string registryMemberName, string registerMethodName) { }
|
|
}
|
|
}
|
|
|
|
namespace TestApp
|
|
{
|
|
public sealed class IntRegistry
|
|
{
|
|
public void Register(int value) { }
|
|
}
|
|
|
|
[AutoRegisterExportedCollections]
|
|
public partial class Bootstrapper
|
|
{
|
|
private readonly IntRegistry _registry = new();
|
|
|
|
[RegisterExportedCollection(nameof(_registry), nameof(IntRegistry.Register))]
|
|
public IEnumerable {|#0:Values|} { get; } = new ArrayList();
|
|
}
|
|
}
|
|
""";
|
|
|
|
var test = new CSharpSourceGeneratorTest<AutoRegisterExportedCollectionsGenerator, DefaultVerifier>
|
|
{
|
|
TestState =
|
|
{
|
|
Sources = { source }
|
|
},
|
|
DisabledDiagnostics = { "GF_Common_Trace_001" }
|
|
};
|
|
|
|
test.ExpectedDiagnostics.Add(new DiagnosticResult("GF_AutoExport_005", DiagnosticSeverity.Error)
|
|
.WithLocation(0)
|
|
.WithArguments("Values"));
|
|
|
|
await test.RunAsync();
|
|
}
|
|
|
|
[Test]
|
|
public async Task Generates_Batch_Registration_Method_When_Register_Method_Uses_Array_Parameter()
|
|
{
|
|
const string source = """
|
|
#nullable enable
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using GFramework.Godot.SourceGenerators.Abstractions;
|
|
|
|
namespace GFramework.Godot.SourceGenerators.Abstractions
|
|
{
|
|
[AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
|
|
public sealed class AutoRegisterExportedCollectionsAttribute : Attribute { }
|
|
|
|
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, Inherited = false, AllowMultiple = false)]
|
|
public sealed class RegisterExportedCollectionAttribute : Attribute
|
|
{
|
|
public RegisterExportedCollectionAttribute(string registryMemberName, string registerMethodName) { }
|
|
}
|
|
}
|
|
|
|
namespace TestApp
|
|
{
|
|
public sealed class ArrayRegistry
|
|
{
|
|
public void Register(int[] value) { }
|
|
}
|
|
|
|
[AutoRegisterExportedCollections]
|
|
public partial class Bootstrapper
|
|
{
|
|
private readonly ArrayRegistry _registry = new();
|
|
|
|
[RegisterExportedCollection(nameof(_registry), nameof(ArrayRegistry.Register))]
|
|
public List<int[]> Values { get; } = new();
|
|
}
|
|
}
|
|
""";
|
|
|
|
const string expected = """
|
|
// <auto-generated />
|
|
#nullable enable
|
|
|
|
namespace TestApp;
|
|
|
|
partial class Bootstrapper
|
|
{
|
|
private void __RegisterExportedCollections_Generated()
|
|
{
|
|
if (this.Values is not null && this._registry is not null)
|
|
{
|
|
foreach (var __generatedItem in this.Values)
|
|
{
|
|
this._registry.Register(__generatedItem);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
""";
|
|
|
|
await GeneratorTest<AutoRegisterExportedCollectionsGenerator>.RunAsync(
|
|
source,
|
|
("TestApp_Bootstrapper.AutoRegisterExportedCollections.g.cs", expected));
|
|
}
|
|
|
|
[Test]
|
|
public async Task Reports_Diagnostic_When_Collection_Member_Is_Not_Instance_Readable()
|
|
{
|
|
const string source = """
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using GFramework.Godot.SourceGenerators.Abstractions;
|
|
|
|
namespace GFramework.Godot.SourceGenerators.Abstractions
|
|
{
|
|
[AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
|
|
public sealed class AutoRegisterExportedCollectionsAttribute : Attribute { }
|
|
|
|
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, Inherited = false, AllowMultiple = false)]
|
|
public sealed class RegisterExportedCollectionAttribute : Attribute
|
|
{
|
|
public RegisterExportedCollectionAttribute(string registryMemberName, string registerMethodName) { }
|
|
}
|
|
}
|
|
|
|
namespace TestApp
|
|
{
|
|
public sealed class IntRegistry
|
|
{
|
|
public void Register(int value) { }
|
|
}
|
|
|
|
[AutoRegisterExportedCollections]
|
|
public partial class Bootstrapper
|
|
{
|
|
private readonly IntRegistry _registry = new();
|
|
|
|
[RegisterExportedCollection(nameof(_registry), nameof(IntRegistry.Register))]
|
|
public static List<int> {|#0:StaticValues|} = new();
|
|
|
|
[RegisterExportedCollection(nameof(_registry), nameof(IntRegistry.Register))]
|
|
public static List<int> {|#1:StaticPropertyValues|} { get; } = new();
|
|
|
|
[RegisterExportedCollection(nameof(_registry), nameof(IntRegistry.Register))]
|
|
public List<int> {|#2:WriteOnlyValues|} { set { } }
|
|
}
|
|
}
|
|
""";
|
|
|
|
var test = new CSharpSourceGeneratorTest<AutoRegisterExportedCollectionsGenerator, DefaultVerifier>
|
|
{
|
|
TestState =
|
|
{
|
|
Sources = { source }
|
|
},
|
|
DisabledDiagnostics = { "GF_Common_Trace_001" },
|
|
TestBehaviors = TestBehaviors.SkipGeneratedSourcesCheck
|
|
};
|
|
|
|
test.ExpectedDiagnostics.Add(new DiagnosticResult("GF_AutoExport_006", DiagnosticSeverity.Error)
|
|
.WithLocation(0)
|
|
.WithArguments("StaticValues"));
|
|
test.ExpectedDiagnostics.Add(new DiagnosticResult("GF_AutoExport_006", DiagnosticSeverity.Error)
|
|
.WithLocation(1)
|
|
.WithArguments("StaticPropertyValues"));
|
|
test.ExpectedDiagnostics.Add(new DiagnosticResult("GF_AutoExport_006", DiagnosticSeverity.Error)
|
|
.WithLocation(2)
|
|
.WithArguments("WriteOnlyValues"));
|
|
|
|
await test.RunAsync();
|
|
}
|
|
|
|
[Test]
|
|
public async Task Reports_Diagnostic_When_Registry_Member_Is_Not_Instance_Readable()
|
|
{
|
|
const string source = """
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using GFramework.Godot.SourceGenerators.Abstractions;
|
|
|
|
namespace GFramework.Godot.SourceGenerators.Abstractions
|
|
{
|
|
[AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
|
|
public sealed class AutoRegisterExportedCollectionsAttribute : Attribute { }
|
|
|
|
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, Inherited = false, AllowMultiple = false)]
|
|
public sealed class RegisterExportedCollectionAttribute : Attribute
|
|
{
|
|
public RegisterExportedCollectionAttribute(string registryMemberName, string registerMethodName) { }
|
|
}
|
|
}
|
|
|
|
namespace TestApp
|
|
{
|
|
public sealed class IntRegistry
|
|
{
|
|
public void Register(int value) { }
|
|
}
|
|
|
|
[AutoRegisterExportedCollections]
|
|
public partial class Bootstrapper
|
|
{
|
|
private static readonly IntRegistry {|#0:_registry|} = new();
|
|
|
|
[RegisterExportedCollection(nameof(_registry), nameof(IntRegistry.Register))]
|
|
public List<int> Values { get; } = new();
|
|
}
|
|
}
|
|
""";
|
|
|
|
var test = new CSharpSourceGeneratorTest<AutoRegisterExportedCollectionsGenerator, DefaultVerifier>
|
|
{
|
|
TestState =
|
|
{
|
|
Sources = { source }
|
|
},
|
|
DisabledDiagnostics = { "GF_Common_Trace_001" },
|
|
TestBehaviors = TestBehaviors.SkipGeneratedSourcesCheck
|
|
};
|
|
|
|
test.ExpectedDiagnostics.Add(new DiagnosticResult("GF_AutoExport_007", DiagnosticSeverity.Error)
|
|
.WithLocation(0)
|
|
.WithArguments("_registry", "Values"));
|
|
|
|
await test.RunAsync();
|
|
}
|
|
|
|
[Test]
|
|
public async Task Reports_Diagnostic_When_Register_Method_Is_Not_Accessible_From_Owner_Type()
|
|
{
|
|
const string source = """
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using GFramework.Godot.SourceGenerators.Abstractions;
|
|
|
|
namespace GFramework.Godot.SourceGenerators.Abstractions
|
|
{
|
|
[AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
|
|
public sealed class AutoRegisterExportedCollectionsAttribute : Attribute { }
|
|
|
|
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, Inherited = false, AllowMultiple = false)]
|
|
public sealed class RegisterExportedCollectionAttribute : Attribute
|
|
{
|
|
public RegisterExportedCollectionAttribute(string registryMemberName, string registerMethodName) { }
|
|
}
|
|
}
|
|
|
|
namespace TestApp
|
|
{
|
|
public sealed class IntRegistry
|
|
{
|
|
private void Register(int value) { }
|
|
}
|
|
|
|
[AutoRegisterExportedCollections]
|
|
public partial class Bootstrapper
|
|
{
|
|
private readonly IntRegistry _registry = new();
|
|
|
|
[RegisterExportedCollection(nameof(_registry), "Register")]
|
|
public List<int> {|#0:Values|} { get; } = new();
|
|
}
|
|
}
|
|
""";
|
|
|
|
var test = new CSharpSourceGeneratorTest<AutoRegisterExportedCollectionsGenerator, DefaultVerifier>
|
|
{
|
|
TestState =
|
|
{
|
|
Sources = { source }
|
|
},
|
|
DisabledDiagnostics = { "GF_Common_Trace_001" },
|
|
TestBehaviors = TestBehaviors.SkipGeneratedSourcesCheck
|
|
};
|
|
|
|
test.ExpectedDiagnostics.Add(new DiagnosticResult("GF_AutoExport_003", DiagnosticSeverity.Error)
|
|
.WithLocation(0)
|
|
.WithArguments("Register", "_registry", "Values"));
|
|
|
|
await test.RunAsync();
|
|
}
|
|
|
|
[Test]
|
|
public async Task Generates_Only_One_Source_When_Multiple_Partial_Declarations_Are_Annotated()
|
|
{
|
|
const string source = """
|
|
#nullable enable
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using GFramework.Godot.SourceGenerators.Abstractions;
|
|
|
|
namespace GFramework.Godot.SourceGenerators.Abstractions
|
|
{
|
|
[AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = true)]
|
|
public sealed class AutoRegisterExportedCollectionsAttribute : Attribute { }
|
|
|
|
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, Inherited = false, AllowMultiple = false)]
|
|
public sealed class RegisterExportedCollectionAttribute : Attribute
|
|
{
|
|
public RegisterExportedCollectionAttribute(string registryMemberName, string registerMethodName) { }
|
|
}
|
|
}
|
|
|
|
namespace TestApp
|
|
{
|
|
public sealed class IntRegistry
|
|
{
|
|
public void Register(int value) { }
|
|
}
|
|
|
|
[AutoRegisterExportedCollections]
|
|
public partial class Bootstrapper
|
|
{
|
|
private readonly IntRegistry? _registry = new();
|
|
}
|
|
|
|
[AutoRegisterExportedCollections]
|
|
public partial class Bootstrapper
|
|
{
|
|
[RegisterExportedCollection(nameof(_registry), nameof(IntRegistry.Register))]
|
|
public List<int>? Values { get; } = new();
|
|
}
|
|
}
|
|
""";
|
|
|
|
const string expected = """
|
|
// <auto-generated />
|
|
#nullable enable
|
|
|
|
namespace TestApp;
|
|
|
|
partial class Bootstrapper
|
|
{
|
|
private void __RegisterExportedCollections_Generated()
|
|
{
|
|
if (this.Values is not null && this._registry is not null)
|
|
{
|
|
foreach (var __generatedItem in this.Values)
|
|
{
|
|
this._registry.Register(__generatedItem);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
""";
|
|
|
|
await GeneratorTest<AutoRegisterExportedCollectionsGenerator>.RunAsync(
|
|
source,
|
|
("TestApp_Bootstrapper.AutoRegisterExportedCollections.g.cs", expected));
|
|
}
|
|
}
|