gptbot/0ad
1
0
Fork 0
forked from mirrors/0ad
Code Pull Requests Activity

Remove LoadScripts from CSimualation2

Browse Source 
`LoadScripts` and `LoadDefaultScripts` have to be called imediately
after the `CSimulation2` constructor.

By doing the necesarry work in the constructor and removing
`LoadScripts` and `LoadDefaultScripts` the interface of `CSimulation2`
is simplified.
This commit is contained in:
phosit
2025-11-21 18:57:53 +01:00
parent 0b83e24065
commit ba2351611c
13 changed files with 61 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files
source/graphics/tests/test_LOSTexture.h
+3 -3
View File
@@ -1,4 +1,4 @@
/* Copyright (C) 2025 Wildfire Games.
/* Copyright (C) 2026 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@@ -36,7 +36,7 @@ class TestLOSTexture : public CxxTest::TestSuite
public:
void test_basic()
{
CSimulation2 sim{nullptr, *g_ScriptContext, nullptr};
CSimulation2 sim{nullptr, *g_ScriptContext, nullptr, {}};
CLOSTexture tex(sim);
const ssize_t size = 8;
@@ -75,7 +75,7 @@ public:
void DISABLED_test_perf()
{
CSimulation2 sim{nullptr, *g_ScriptContext, nullptr};
CSimulation2 sim{nullptr, *g_ScriptContext, nullptr, {}};
CLOSTexture tex(sim);
const ssize_t size = 257;
source/graphics/tests/test_Model.h
+3 -3
View File
@@ -1,4 +1,4 @@
/* Copyright (C) 2025 Wildfire Games.
/* Copyright (C) 2026 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@@ -200,7 +200,7 @@ public:
TestLogger logger;
CMaterial material{};
CSimulation2 simulation{nullptr, *g_ScriptContext, nullptr};
CSimulation2 simulation{nullptr, *g_ScriptContext, nullptr, {}};
CTerrain terrain;
terrain.Initialize(4, nullptr);
@@ -266,7 +266,7 @@ public:
CSkeletonAnimManager skeletonAnimationManager{colladaManager};
CUnitManager unitManager;
CSimulation2 simulation{&unitManager, *g_ScriptContext, nullptr};
CSimulation2 simulation{&unitManager, *g_ScriptContext, nullptr, {}};
CObjectManager objectManager{
meshManager, skeletonAnimationManager, simulation};
unitManager.SetObjectManager(objectManager);
source/ps/Game.cpp
+2 -4
View File
@@ -1,4 +1,4 @@
/* Copyright (C) 2025 Wildfire Games.
/* Copyright (C) 2026 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@@ -80,7 +80,7 @@ const CStr CGame::EventNameSimulationUpdate = "SimulationUpdate";
CGame::CGame(bool replayLog, const SimulationDebugOptions debugOptions):
m_World(new CWorld(*this)),
m_Simulation2{new CSimulation2{&m_World->GetUnitManager(), *g_ScriptContext, &m_World->GetTerrain(),
debugOptions}},
CSimulation2::DEFAULT_SCRIPTS, debugOptions}},
// TODO: we need to remove that global dependency. Maybe the game view
// should be created outside only if needed.
m_GameView(CRenderer::IsInitialised() ? new CGameView(g_VideoMode.GetBackendDevice(), this) : nullptr),
@@ -106,8 +106,6 @@ CGame::CGame(bool replayLog, const SimulationDebugOptions debugOptions):
m_World->GetUnitManager().SetObjectManager(m_GameView->GetObjectManager());
m_TurnManager = new CLocalTurnManager(*m_Simulation2, GetReplayLogger()); // this will get replaced if we're a net server/client
m_Simulation2->LoadDefaultScripts();
}
/**
source/ps/GameSetup/GameSetup.cpp
+2 -3
View File
@@ -1,4 +1,4 @@
/* Copyright (C) 2025 Wildfire Games.
/* Copyright (C) 2026 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@@ -596,8 +596,7 @@ bool Init(const CmdLineArgs& args, int flags)
{
try
{
CSimulation2 sim{NULL, *g_ScriptContext, NULL};
sim.LoadDefaultScripts();
CSimulation2 sim{NULL, *g_ScriptContext, NULL, CSimulation2::DEFAULT_SCRIPTS};
std::ofstream f("entity.rng", std::ios_base::out | std::ios_base::trunc);
f << sim.GenerateSchema();
debug_printf("Generated entity.rng\n");
source/simulation2/Simulation2.cpp
+10 -23
View File
@@ -1,4 +1,4 @@
/* Copyright (C) 2025 Wildfire Games.
/* Copyright (C) 2026 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@@ -61,6 +61,7 @@
#include <cstddef>
#include <cstdint>
#include <fstream>
#include <functional>
#include <iomanip>
#include <js/CallArgs.h>
#include <js/RootingAPI.h>
@@ -73,7 +74,7 @@ class CSimulation2Impl
{
public:
CSimulation2Impl(CUnitManager* unitManager, ScriptContext& cx, CTerrain* terrain,
const SimulationDebugOptions debugOptions) :
const std::span<const wchar_t* const> scriptDirectories, const SimulationDebugOptions debugOptions) :
m_SimContext{terrain, unitManager},
m_ComponentManager{m_SimContext, cx},
m_InitAttributes{cx.GetGeneralJSContext()},
@@ -101,6 +102,9 @@ public:
m_OOSLogPath = createDateIndexSubdirectory(psLogDir() / "oos_logs");
debug_printf("Writing ooslogs to %s\n", m_OOSLogPath.string8().c_str());
}
std::ranges::for_each(scriptDirectories,
std::bind_front(LoadScripts, std::ref(m_ComponentManager), &m_LoadedScripts));
}
~CSimulation2Impl()
@@ -122,7 +126,6 @@ public:
componentManager.AddSystemComponents(skipScriptedComponents, skipAI);
}
static void LoadDefaultScripts(CComponentManager& componentManager, std::set<VfsPath>* loadedScripts);
static void LoadScripts(CComponentManager& componentManager, std::set<VfsPath>* loadedScripts, const VfsPath& path);
static bool LoadTriggerScripts(CComponentManager& componentManager, JS::HandleValue mapSettings, std::set<VfsPath>* loadedScripts);
Status ReloadChangedFile(const VfsPath& path);
@@ -200,13 +203,6 @@ public:
}
};
void CSimulation2Impl::LoadDefaultScripts(CComponentManager& componentManager, std::set<VfsPath>* loadedScripts)
{
LoadScripts(componentManager, loadedScripts, L"simulation/components/interfaces/");
LoadScripts(componentManager, loadedScripts, L"simulation/helpers/");
LoadScripts(componentManager, loadedScripts, L"simulation/components/");
}
void CSimulation2Impl::LoadScripts(CComponentManager& componentManager, std::set<VfsPath>* loadedScripts, const VfsPath& path)
{
VfsPaths pathnames;
@@ -419,7 +415,8 @@ void CSimulation2Impl::Update(int turnLength, const std::vector<SimulationComman
m_SecondaryComponentManager->LoadComponentTypes();
m_SecondaryLoadedScripts = std::make_unique<std::set<VfsPath>>();
LoadDefaultScripts(*m_SecondaryComponentManager, m_SecondaryLoadedScripts.get());
std::ranges::for_each(CSimulation2::DEFAULT_SCRIPTS, std::bind_front(LoadScripts,
std::ref(*m_SecondaryComponentManager), m_SecondaryLoadedScripts.get()));
ResetComponentState(*m_SecondaryComponentManager, false, false);
ScriptRequest rq(scriptInterface);
@@ -639,8 +636,8 @@ void CSimulation2Impl::DumpState()
////////////////////////////////////////////////////////////////
CSimulation2::CSimulation2(CUnitManager* unitManager, ScriptContext& cx, CTerrain* terrain,
const SimulationDebugOptions debugOptions) :
m(std::make_unique<CSimulation2Impl>(unitManager, cx, terrain, debugOptions))
const std::span<const wchar_t* const> scriptDirectories, const SimulationDebugOptions debugOptions) :
m(std::make_unique<CSimulation2Impl>(unitManager, cx, terrain, scriptDirectories, debugOptions))
{
}
@@ -756,16 +753,6 @@ float CSimulation2::GetLastFrameOffset() const
return m->m_LastFrameOffset;
}
void CSimulation2::LoadScripts(const VfsPath& path)
{
m->LoadScripts(m->m_ComponentManager, &m->m_LoadedScripts, path);
}
void CSimulation2::LoadDefaultScripts()
{
m->LoadDefaultScripts(m->m_ComponentManager, &m->m_LoadedScripts);
}
void CSimulation2::SetStartupScript(const std::string& code)
{
m->m_StartupScript = code;
source/simulation2/Simulation2.h
+12 -15
View File
@@ -1,4 +1,4 @@
/* Copyright (C) 2025 Wildfire Games.
/* Copyright (C) 2026 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@@ -25,9 +25,11 @@
#include "simulation2/system/DebugOptions.h"
#include "simulation2/system/Entity.h"
#include <array>
#include <js/TypeDecls.h>
#include <memory>
#include <ostream>
#include <span>
#include <string>
#include <unordered_map>
#include <utility>
@@ -60,26 +62,21 @@ public:
using std::runtime_error::runtime_error;
};
constexpr static auto DEFAULT_SCRIPTS{std::to_array({L"simulation/components/interfaces/",
L"simulation/helpers/", L"simulation/components/"})};
// TODO: CUnitManager should probably be handled automatically by this
// module, but for now we'll have it passed in externally instead
/**
* @param scriptDirectories All scripts in the specified directory
* (non-recursively) are loaded, so that they can register new
* component types and functions.
*/
CSimulation2(CUnitManager* unitManager, ScriptContext& cx, CTerrain* terrain,
const std::span<const wchar_t* const> scriptDirectories,
const SimulationDebugOptions debugOptions = {});
~CSimulation2();
/**
* Load all scripts in the specified directory (non-recursively),
* so they can register new component types and functions. This
* should be called immediately after constructing the CSimulation2 object.
* @return false on failure
*/
void LoadScripts(const VfsPath& path);
/**
* Call LoadScripts for each of the game's standard simulation script paths.
* @return false on failure
*/
void LoadDefaultScripts();
/**
* Loads the player settings script (called before map is loaded)
* @param newPlayers will delete all the existing player entities (if any) and create new ones
source/simulation2/components/tests/test_Pathfinder.h
+5 -9
View File
@@ -1,4 +1,4 @@
/* Copyright (C) 2025 Wildfire Games.
/* Copyright (C) 2026 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@@ -158,8 +158,7 @@ public:
{
CTerrain terrain;
CSimulation2 sim2{nullptr, *g_ScriptContext, &terrain};
sim2.LoadDefaultScripts();
CSimulation2 sim2{nullptr, *g_ScriptContext, &terrain, CSimulation2::DEFAULT_SCRIPTS};
sim2.ResetState();
std::unique_ptr<CMapReader> mapReader = std::make_unique<CMapReader>();
@@ -217,8 +216,7 @@ public:
CTerrain terrain;
terrain.Initialize(5, NULL);
CSimulation2 sim2{nullptr, *g_ScriptContext, &terrain};
sim2.LoadDefaultScripts();
CSimulation2 sim2{nullptr, *g_ScriptContext, &terrain, CSimulation2::DEFAULT_SCRIPTS};
sim2.ResetState();
const entity_pos_t range = entity_pos_t::FromInt(48);
@@ -272,8 +270,7 @@ public:
{
CTerrain terrain;
CSimulation2 sim2{nullptr, *g_ScriptContext, &terrain};
sim2.LoadDefaultScripts();
CSimulation2 sim2{nullptr, *g_ScriptContext, &terrain, CSimulation2::DEFAULT_SCRIPTS};
sim2.ResetState();
std::unique_ptr<CMapReader> mapReader = std::make_unique<CMapReader>();
@@ -329,8 +326,7 @@ public:
{
CTerrain terrain;
CSimulation2 sim2{nullptr, *g_ScriptContext, &terrain};
sim2.LoadDefaultScripts();
CSimulation2 sim2{nullptr, *g_ScriptContext, &terrain, CSimulation2::DEFAULT_SCRIPTS};
sim2.ResetState();
std::unique_ptr<CMapReader> mapReader = std::make_unique<CMapReader>();
source/simulation2/tests/test_CmpTemplateManager.h
+2 -3
View File
@@ -1,4 +1,4 @@
/* Copyright (C) 2025 Wildfire Games.
/* Copyright (C) 2026 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@@ -253,8 +253,7 @@ public:
{
CXeromycesEngine xeromycesEngine;
CTerrain dummy;
CSimulation2 sim{nullptr, *g_ScriptContext, &dummy};
sim.LoadDefaultScripts();
CSimulation2 sim{nullptr, *g_ScriptContext, &dummy, CSimulation2::DEFAULT_SCRIPTS};
sim.ResetState();
CmpPtr<ICmpTemplateManager> cmpTemplateManager(sim, SYSTEM_ENTITY);
source/simulation2/tests/test_Serializer.h
+2 -3
View File
@@ -1,4 +1,4 @@
/* Copyright (C) 2025 Wildfire Games.
/* Copyright (C) 2026 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@@ -901,8 +901,7 @@ public:
CTerrain terrain;
CSimulation2 sim2{nullptr, *g_ScriptContext, &terrain};
sim2.LoadDefaultScripts();
CSimulation2 sim2{nullptr, *g_ScriptContext, &terrain, CSimulation2::DEFAULT_SCRIPTS};
sim2.ResetState();
std::unique_ptr<CMapReader> mapReader = std::make_unique<CMapReader>();
source/simulation2/tests/test_Simulation2.h
+6 -9
View File
@@ -1,4 +1,4 @@
/* Copyright (C) 2025 Wildfire Games.
/* Copyright (C) 2026 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@@ -64,9 +64,8 @@ public:
void test_AddEntity()
{
CXeromycesEngine xeromycesEngine;
CSimulation2 sim{nullptr, *g_ScriptContext, &m_Terrain};
sim.LoadScripts(L"simulation/components/addentity/");
CSimulation2 sim{nullptr, *g_ScriptContext, &m_Terrain,
{{L"simulation/components/addentity/"}}};
sim.ResetState(true, true);
entity_id_t ent1 = sim.AddEntity(L"test1");
@@ -85,9 +84,8 @@ public:
void test_DestroyEntity()
{
CXeromycesEngine xeromycesEngine;
CSimulation2 sim{nullptr, *g_ScriptContext, &m_Terrain};
sim.LoadScripts(L"simulation/components/addentity/");
CSimulation2 sim{nullptr, *g_ScriptContext, &m_Terrain,
{{L"simulation/components/addentity/"}}};
sim.ResetState(true, true);
entity_id_t ent1 = sim.AddEntity(L"test1");
@@ -142,15 +140,14 @@ public:
void test_hotload_scripts()
{
CXeromycesEngine xeromycesEngine;
CSimulation2 sim{nullptr, *g_ScriptContext, &m_Terrain};
TS_ASSERT_OK(CreateDirectories(DataDir()/"mods"/"_test.sim"/"simulation"/"components"/"hotload"/"", 0700));
copyFile(L"simulation/components/test-hotload1.js", L"simulation/components/hotload/hotload.js");
TS_ASSERT_OK(g_VFS->RemoveFile(L"simulation/components/hotload/hotload.js"));
TS_ASSERT_OK(g_VFS->RepopulateDirectory(L"simulation/components/hotload/"));
sim.LoadScripts(L"simulation/components/hotload/");
CSimulation2 sim{nullptr, *g_ScriptContext, &m_Terrain, {{L"simulation/components/hotload/"}}};
sim.ResetState(true, true);
entity_id_t ent = sim.AddEntity(L"hotload");
source/tools/atlas/GameInterface/ActorViewer.cpp
+2 -10
View File
@@ -1,4 +1,4 @@
/* Copyright (C) 2025 Wildfire Games.
/* Copyright (C) 2026 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@@ -94,7 +94,7 @@ public:
MeshManager(ColladaManager),
SkeletonAnimManager(ColladaManager),
UnitManager(),
Simulation2{&UnitManager, *g_ScriptContext, &Terrain},
Simulation2{&UnitManager, *g_ScriptContext, &Terrain, CSimulation2::DEFAULT_SCRIPTS},
ObjectManager(MeshManager, SkeletonAnimManager, Simulation2),
LOSTexture(Simulation2),
TerritoryTexture(Simulation2),
@@ -320,14 +320,6 @@ ActorViewer::ActorViewer()
}
// Prepare the simulation
try
{
m.Simulation2.LoadDefaultScripts();
}
catch (const CSimulation2::LoadScriptError& e)
{
LOGERROR("%s", e.what());
}
m.Simulation2.ResetState();
// Set player data
source/tools/atlas/GameInterface/View.cpp
+11 -3
View File
@@ -1,4 +1,4 @@
/* Copyright (C) 2025 Wildfire Games.
/* Copyright (C) 2026 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@@ -29,6 +29,7 @@
#include "maths/Matrix3D.h"
#include "maths/Vector2D.h"
#include "ps/CStr.h"
#include "ps/CLogger.h"
#include "ps/ConfigDB.h"
#include "ps/Game.h"
#include "ps/VideoMode.h"
@@ -456,8 +457,15 @@ AtlasViewGame* AtlasView::GetView_Game()
AtlasViewActor* AtlasView::GetView_Actor()
{
if (! view_Actor)
view_Actor = new AtlasViewActor();
try
{
if (!view_Actor)
view_Actor = new AtlasViewActor();
}
catch (const CSimulation2::LoadScriptError& e)
{
LOGERROR("%s", e.what());
}
return view_Actor;
}
source/tools/lint/cppcheck/suppressions-list.txt
+1 -1
View File
@@ -65,6 +65,6 @@ unknownMacro:source/lib/sysdep/os/win/wfirmware.cpp
unknownMacro:source/lib/sysdep/os/win/wposix/wutsname.cpp
unknownMacro:source/ps/CStr.cpp
uninitvar:source/ps/Game.cpp:248
uninitvar:source/ps/Game.cpp:246
danglingLifetime:source/renderer/backend/gl/Device.cpp