implement xref and models check for gameobjects

AnakinRaW · AnakinRaW · commit b1c7990da762 · 2026-03-17T11:52:19.000+01:00
diff --git a/src/ModVerify/DefaultGameVerifiersProvider.cs b/src/ModVerify/DefaultGameVerifiersProvider.cs
@@ -2,6 +2,8 @@
 using System.Collections.Generic;
 using AET.ModVerify.Settings;
 using AET.ModVerify.Verifiers;
+using AET.ModVerify.Verifiers.CommandBar;
+using AET.ModVerify.Verifiers.GameObjects;
 using AET.ModVerify.Verifiers.GuiDialogs;
 using AET.ModVerify.Verifiers.SfxEvents;
 using PG.StarWarsGame.Engine;
@@ -11,14 +13,14 @@ namespace AET.ModVerify;
 public sealed class DefaultGameVerifiersProvider : IGameVerifiersProvider
 {
     public IEnumerable<GameVerifier> GetVerifiers(
-        IStarWarsGameEngine database, 
+        IStarWarsGameEngine gameEngine, 
         GameVerifySettings settings, 
         IServiceProvider serviceProvider)
     {
         //yield break;
-        yield return new ReferencedModelsVerifier(database, settings, serviceProvider);
-        yield return new SfxEventVerifier(database, settings, serviceProvider);
-        yield return new GuiDialogsVerifier(database, settings, serviceProvider);
-        yield return new CommandBarVerifier(database, settings, serviceProvider);
+        yield return new SfxEventVerifier(gameEngine, settings, serviceProvider);
+        yield return new GuiDialogsVerifier(gameEngine, settings, serviceProvider);
+        yield return new GameObjectTypeVerifier(gameEngine, settings, serviceProvider);
+        yield return new CommandBarVerifier(gameEngine, settings, serviceProvider);
     }
 }
diff --git a/src/ModVerify/GameVerifyPipeline.cs b/src/ModVerify/GameVerifyPipeline.cs
@@ -11,6 +11,7 @@
 using AET.ModVerify.Settings;
 using AET.ModVerify.Utilities;
 using AET.ModVerify.Verifiers;
+using AET.ModVerify.Verifiers.Engine;
 using AET.ModVerify.Verifiers.Utilities;
 using AnakinRaW.CommonUtilities.SimplePipeline;
 using AnakinRaW.CommonUtilities.SimplePipeline.Runners;
diff --git a/src/ModVerify/IGameVerifiersProvider.cs b/src/ModVerify/IGameVerifiersProvider.cs
@@ -9,7 +9,7 @@ namespace AET.ModVerify;
 public interface IGameVerifiersProvider
 {
     IEnumerable<GameVerifier> GetVerifiers(
-        IStarWarsGameEngine database, 
+        IStarWarsGameEngine gameEngine, 
         GameVerifySettings settings, 
         IServiceProvider serviceProvider);
 }
diff --git a/src/ModVerify/ModVerify.csproj.DotSettings b/src/ModVerify/ModVerify.csproj.DotSettings
@@ -4,8 +4,9 @@
 	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=reporting_005Creporters_005Cjson/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=reporting_005Creporters_005Ctext/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=reporting_005Csuppressions_005Cjson/@EntryIndexedValue">False</s:Boolean>
-	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=verifiers_005Ccommandbar/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=verifiers_005Ccommandbar/@EntryIndexedValue">False</s:Boolean>
 	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=verifiers_005Ccommons_005Caudio/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=verifiers_005Ccommons_005Cduplicates/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=verifiers_005Cdatabaseerror/@EntryIndexedValue">True</s:Boolean>
-	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=verifiers_005Cengine/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>
+	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=verifiers_005Cengine/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=verifiers_005Csfxevents/@EntryIndexedValue">False</s:Boolean></wpf:ResourceDictionary>
diff --git a/src/ModVerify/Verifiers/Engine/GameEngineErrorCollector.cs b/src/ModVerify/Verifiers/Engine/GameEngineErrorCollector.cs
@@ -6,7 +6,7 @@
 using AET.ModVerify.Settings;
 using PG.StarWarsGame.Engine;
 
-namespace AET.ModVerify.Verifiers;
+namespace AET.ModVerify.Verifiers.Engine;
 
 public sealed class GameEngineErrorCollector(
     IGameEngineErrorCollection errorCollection,
diff --git a/src/ModVerify/Verifiers/GameObjects/CommandBar/CommandBarVerifier.Components.cs b/src/ModVerify/Verifiers/GameObjects/CommandBar/CommandBarVerifier.Components.cs
@@ -1,16 +1,17 @@
-﻿using AET.ModVerify.Reporting;
+﻿using System;
+using System.Linq;
+using AET.ModVerify.Reporting;
 using PG.StarWarsGame.Engine.CommandBar;
 using PG.StarWarsGame.Engine.CommandBar.Components;
-using System;
-using System.Linq;
 
-namespace AET.ModVerify.Verifiers;
+namespace AET.ModVerify.Verifiers.CommandBar;
 
 partial class CommandBarVerifier
 {
     private void VerifyCommandBarComponents()
     {
-        var occupiedComponentIds = SupportedCommandBarComponentData.GetComponentIdsForEngine(Repository.EngineType).Keys
+        var occupiedComponentIds = SupportedCommandBarComponentData
+            .GetComponentIdsForEngine(Repository.EngineType).Keys
             .ToDictionary(value => value, _ => false);
 
         foreach (var component in GameEngine.CommandBar.Components)
@@ -32,7 +33,7 @@ private void VerifyCommandBarComponents()
             if (alreadyOccupied)
             {
                 AddError(VerificationError.Create(VerifierChain,
-                    CommandBarDuplicateComponent,
+                    VerifierErrorCodes.Duplicate,
                     $"The CommandBar component '{component.Name}' with ID '{component.Id}' already exists.",
                     VerificationSeverity.Warning,
                     component.Name));
diff --git a/src/ModVerify/Verifiers/GameObjects/CommandBar/CommandBarVerifier.Groups.cs b/src/ModVerify/Verifiers/GameObjects/CommandBar/CommandBarVerifier.Groups.cs
@@ -4,7 +4,7 @@
 using PG.StarWarsGame.Engine.CommandBar;
 using PG.StarWarsGame.Engine.CommandBar.Components;
 
-namespace AET.ModVerify.Verifiers;
+namespace AET.ModVerify.Verifiers.CommandBar;
 
 partial class CommandBarVerifier
 {
diff --git a/src/ModVerify/Verifiers/GameObjects/CommandBar/CommandBarVerifier.cs b/src/ModVerify/Verifiers/GameObjects/CommandBar/CommandBarVerifier.cs
@@ -3,23 +3,25 @@
 using AET.ModVerify.Settings;
 using PG.StarWarsGame.Engine;
 
-namespace AET.ModVerify.Verifiers;
+namespace AET.ModVerify.Verifiers.CommandBar;
 
 public partial class CommandBarVerifier(IStarWarsGameEngine gameEngine, GameVerifySettings settings, IServiceProvider serviceProvider)
     : GameVerifier(null, gameEngine, settings, serviceProvider)
 {
     public const string CommandBarNoShellsGroup = "CMDBAR00";
     public const string CommandBarManyShellsGroup = "CMDBAR01";
     public const string CommandBarNoShellsComponentInShellGroup = "CMDBAR02";
-    public const string CommandBarDuplicateComponent = "CMDBAR03";
-    public const string CommandBarUnsupportedComponent = "CMDBAR04";
-    public const string CommandBarShellNoModel = "CMDBAR05";
+    public const string CommandBarUnsupportedComponent = "CMDBAR03";
+    public const string CommandBarShellNoModel = "CMDBAR04";
 
     public override string FriendlyName => "CommandBar";
 
     public override void Verify(CancellationToken token)
     {
+        OnProgress(0.0, "Verifying CommandBar Shell");
         VerifyCommandBarShellsGroups();
+        OnProgress(0.5d, "Verifying CommandBar components");
         VerifyCommandBarComponents();
+        OnProgress(1.0d, null);
     }
 }
diff --git a/src/ModVerify/Verifiers/GameObjects/GameObjectTypeVerifier.Models.cs b/src/ModVerify/Verifiers/GameObjects/GameObjectTypeVerifier.Models.cs
@@ -0,0 +1,13 @@
+﻿using PG.StarWarsGame.Engine.GameObjects;
+using System.Threading;
+
+namespace AET.ModVerify.Verifiers.GameObjects;
+
+public sealed partial class GameObjectTypeVerifier
+{
+    private void VerifyModels(GameObject gameObject, string[] context, CancellationToken token)
+    {
+        foreach (var model in GameEngine.GameObjectTypeManager.GetModels(gameObject))
+            _singleModelVerifier.Verify(model, context, token);
+    }
+}
diff --git a/src/ModVerify/Verifiers/GameObjects/GameObjectTypeVerifier.XRef.cs b/src/ModVerify/Verifiers/GameObjects/GameObjectTypeVerifier.XRef.cs
@@ -0,0 +1,21 @@
+﻿using AET.ModVerify.Reporting;
+using PG.StarWarsGame.Engine.GameObjects;
+
+namespace AET.ModVerify.Verifiers.GameObjects;
+
+public sealed partial class GameObjectTypeVerifier
+{
+    private void VerifyXRefs(GameObject gameObject, string[] context)
+    {
+        if (!string.IsNullOrEmpty(gameObject.VariantOfExistingTypeName) && gameObject.VariantOfExistingType is null)
+        {
+            AddError(VerificationError.Create(
+                VerifierChain, 
+                VerifierErrorCodes.MissingXRef,
+                $"Missing base type '{gameObject.VariantOfExistingTypeName}' for GameObject '{gameObject.Name}'",
+                VerificationSeverity.Critical, 
+                context,
+                gameObject.VariantOfExistingTypeName));
+        }
+    }
+}
diff --git a/src/ModVerify/Verifiers/GameObjects/GameObjectTypeVerifier.cs b/src/ModVerify/Verifiers/GameObjects/GameObjectTypeVerifier.cs
@@ -2,26 +2,40 @@
 using System.Threading;
 using AET.ModVerify.Settings;
 using AET.ModVerify.Verifiers.Commons;
-using AET.ModVerify.Verifiers.Utilities;
 using PG.StarWarsGame.Engine;
+using PG.StarWarsGame.Engine.GameObjects;
 
 namespace AET.ModVerify.Verifiers.GameObjects;
 
-public sealed class GameObjectTypeVerifier(
-    IGameVerifierInfo? parent,
-    IStarWarsGameEngine gameEngine,
-    GameVerifySettings settings,
-    IServiceProvider serviceProvider)
-    : GameVerifier(parent, gameEngine, settings, serviceProvider)
+// TODO: Add GameObjectTypeVerifier and check that LandModelTerrainOverride is correct (all keys correct, no dups)
+public sealed partial class GameObjectTypeVerifier : NamedGameEntityVerifier<GameObject>
 {
+    private readonly SingleModelVerifier _singleModelVerifier;
+
     public override string FriendlyName => "GameObjectType Verifier";
 
-    public override void Verify(CancellationToken token)
+    public override IGameManager<GameObject> GameManager => GameEngine.GameObjectTypeManager;
+
+    public override string EntityTypeName => "GameObjectType";
+
+    public GameObjectTypeVerifier(
+        IStarWarsGameEngine gameEngine,
+        GameVerifySettings settings,
+        IServiceProvider serviceProvider) 
+        : base(gameEngine, settings, serviceProvider)
+    {
+        _singleModelVerifier = new SingleModelVerifier(this, gameEngine, settings, serviceProvider);
+    }
+
+    protected override void VerifyEntity(GameObject entity, string[] context, double progress, CancellationToken token)
+    {
+        VerifyXRefs(entity, context);
+        VerifyModels(entity, context, token);
+    }
+
+    protected override void PostEntityVerify(CancellationToken token)
     {
-        var context = IDuplicateVerificationContext.CreateForNamedXmlObjects(GameEngine.GameObjectTypeManager, "GameObjectType");
-        var verifier = new DuplicateVerifier(this, GameEngine, Settings, Services);
-        verifier.Verify(context, [], token);
-        foreach (var error in verifier.VerifyErrors)
-            AddError(error);
+        foreach (var modelError in _singleModelVerifier.VerifyErrors)
+            AddError(modelError);
     }
-}
+}
diff --git a/src/ModVerify/Verifiers/GameVerifierBase.cs b/src/ModVerify/Verifiers/GameVerifierBase.cs
@@ -8,6 +8,8 @@
 using System.Collections.Generic;
 using System.IO.Abstractions;
 using AET.ModVerify.Progress;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Logging.Abstractions;
 using PG.StarWarsGame.Engine;
 
 namespace AET.ModVerify.Verifiers;
@@ -22,6 +24,7 @@ public abstract class GameVerifierBase : IGameVerifierInfo
     protected readonly IFileSystem FileSystem;
     protected readonly IServiceProvider Services;
     protected readonly GameVerifySettings Settings;
+    protected readonly ILogger Logger;
 
     public IReadOnlyCollection<VerificationError> VerifyErrors => [.. _verifyErrors.Keys];
 
@@ -45,6 +48,7 @@ protected GameVerifierBase(
     {
         if (serviceProvider == null) 
             throw new ArgumentNullException(nameof(serviceProvider));
+        Logger = serviceProvider.GetService<ILoggerFactory>()?.CreateLogger(GetType()) ?? NullLogger.Instance;
         FileSystem = serviceProvider.GetRequiredService<IFileSystem>();
         Services = serviceProvider ?? throw new ArgumentNullException(nameof(serviceProvider));
         Parent = parent;
diff --git a/src/ModVerify/Verifiers/NamedGameEntityVerifier.cs b/src/ModVerify/Verifiers/NamedGameEntityVerifier.cs
@@ -0,0 +1,70 @@
+﻿using System;
+using System.Threading;
+using AET.ModVerify.Settings;
+using AET.ModVerify.Verifiers.Commons;
+using AET.ModVerify.Verifiers.Utilities;
+using Microsoft.Extensions.Logging;
+using PG.StarWarsGame.Engine;
+using PG.StarWarsGame.Files.XML.Data;
+
+namespace AET.ModVerify.Verifiers;
+
+public abstract partial class NamedGameEntityVerifier<T>(
+    IStarWarsGameEngine gameEngine,
+    GameVerifySettings settings,
+    IServiceProvider serviceProvider) 
+    : GameVerifier(null, gameEngine, settings, serviceProvider)
+    where T : NamedXmlObject
+{
+    public abstract IGameManager<T> GameManager { get; }
+
+    public abstract string EntityTypeName { get; }
+
+    public sealed override void Verify(CancellationToken token)
+    {
+        OnProgress(0.0, $"Verifying GameManager for '{EntityTypeName}'");
+        PreEntityVerify(token);
+        OnProgress(0.5, null);
+
+        var numEntities = GameEngine.GameObjectTypeManager.Entries.Count;
+        double counter = 0;
+        var context = new string[1];
+        foreach (var gameEntity in GameManager.Entries)
+        {
+            LogVerifyingEntityTypeName(Logger, EntityTypeName, gameEntity.Name);
+            var progress = 0.5 + ++counter / numEntities * 0.5;
+            OnProgress(progress, $"{EntityTypeName} - '{gameEntity.Name}'");
+            context[0] = gameEntity.Name;
+            VerifyEntity(gameEntity, context, progress, token);
+        }
+
+        PostEntityVerify(token);
+    }
+
+    protected virtual void PostEntityVerify(CancellationToken token)
+    {
+    }
+
+    protected abstract void VerifyEntity(T entity, string[] context, double progress, CancellationToken token);
+
+    protected virtual void PreEntityVerify(CancellationToken token)
+    {
+        VerifyDuplicates(token);
+    }
+
+    private void VerifyDuplicates(CancellationToken token)
+    {
+        LogCheckingEntityTypeForDuplicateEntries(Logger, EntityTypeName);
+        var context = IDuplicateVerificationContext.CreateForNamedXmlObjects(GameManager, EntityTypeName);
+        var verifier = new DuplicateVerifier(this, GameEngine, Settings, Services);
+        verifier.Verify(context, [], token);
+        foreach (var error in verifier.VerifyErrors)
+            AddError(error);
+    }
+
+    [LoggerMessage(LogLevel.Trace, "Verifying {entityType} - '{name}'")]
+    static partial void LogVerifyingEntityTypeName(ILogger? logger, string entityType, string name);
+
+    [LoggerMessage(LogLevel.Debug, "Checking {entityType} for duplicate entries")]
+    static partial void LogCheckingEntityTypeForDuplicateEntries(ILogger logger, string entityType);
+}
diff --git a/src/ModVerify/Verifiers/ReferencedModelsVerifier.cs b/src/ModVerify/Verifiers/ReferencedModelsVerifier.cs
diff --git a/src/ModVerify/Verifiers/SfxEvents/SfxEventVerifier.Duplicates.cs b/src/ModVerify/Verifiers/SfxEvents/SfxEventVerifier.Duplicates.cs
diff --git a/src/ModVerify/Verifiers/SfxEvents/SfxEventVerifier.Samples.cs b/src/ModVerify/Verifiers/SfxEvents/SfxEventVerifier.Samples.cs
diff --git a/src/ModVerify/Verifiers/SfxEvents/SfxEventVerifier.XRef.cs b/src/ModVerify/Verifiers/SfxEvents/SfxEventVerifier.XRef.cs
diff --git a/src/ModVerify/Verifiers/SfxEvents/SfxEventVerifier.cs b/src/ModVerify/Verifiers/SfxEvents/SfxEventVerifier.cs

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ namespace AET.ModVerify;`
`9`	`9`	`public interface IGameVerifiersProvider`
`10`	`10`	`{`
`11`	`11`	`IEnumerable<GameVerifier> GetVerifiers(`
`12`		`- IStarWarsGameEngine database,`
	`12`	`+ IStarWarsGameEngine gameEngine,`
`13`	`13`	`GameVerifySettings settings,`
`14`	`14`	`IServiceProvider serviceProvider);`
`15`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`using PG.StarWarsGame.Engine.CommandBar;`
`5`	`5`	`using PG.StarWarsGame.Engine.CommandBar.Components;`
`6`	`6`
`7`		`-namespace AET.ModVerify.Verifiers;`
	`7`	`+namespace AET.ModVerify.Verifiers.CommandBar;`
`8`	`8`
`9`	`9`	`partial class CommandBarVerifier`
`10`	`10`	`{`