18
0
mirror of https://github.com/MaSzyna-EU07/maszyna.git synced 2026-11-18 00:05:59 +01:00

refactor(simulation): fix the Sonar remarks on the test mode code

- TController::TableCheck() calls TSpeedPos::Update() as it did before the
  test mode: the check for a signal passed at danger is a call of its own
  after it (CheckSignalPassedAtDanger), so the update lines nest no deeper
  than on master (S134). A switch is a track, so a signal's update never
  takes the switch-change branch and the check runs in the same place as
  before; the physicslogs of all 15 scenario cases are byte for byte the
  same.
- null_imgui_renderer is final (S1235), to_string(test_result) uses
  `using enum` (S6177), init_result_cell() is const (S5817),
  ConfigParseTest() takes a std::string_view (S6009) and the test settings
  struct is declared apart from its member (S3646).
This commit is contained in:
jerrrrycho
2026-11-08 09:35:59 +01:00
parent 6ccf4b14bf
commit 547706b54d
7 changed files with 31 additions and 27 deletions

View File

@@ -36,7 +36,7 @@ private:
};
// user interface backend which draws nothing: imgui still builds its frames, so the ui code runs as usual
class null_imgui_renderer : public imgui_renderer {
class null_imgui_renderer final : public imgui_renderer {
public:
bool Init() override { return true; }
void Shutdown() override { /* null implementation, nothing to do */ }

View File

@@ -45,19 +45,20 @@ test_manager &test()
std::string_view to_string(test_result const Result)
{
using enum test_result;
switch (Result)
{
case test_result::pass: return "pass";
case test_result::fail: return "fail";
case test_result::signal_passed_at_danger: return "signal passed at danger";
case test_result::timeout: return "timeout";
case test_result::standstill: return "standstill";
case test_result::error: return "error";
case pass: return "pass";
case fail: return "fail";
case signal_passed_at_danger: return "signal passed at danger";
case timeout: return "timeout";
case standstill: return "standstill";
case error: return "error";
}
return "unknown";
}
void test_manager::init_result_cell()
void test_manager::init_result_cell() const
{
auto cell { std::make_unique<TMemCell>(scene::node_data{0, -1, std::string(result_cell), "memcell"}) };
// neither of the reported values, so that a cell nobody wrote to says nothing

View File

@@ -39,7 +39,7 @@ public:
static constexpr double frame_step { 0.03 };
// creates the result cell; called with the other scripting interface cells, before the scenery is read
void init_result_cell();
void init_result_cell() const;
// the simulation is ready: start the clocks
void start();
// checks the end conditions after a simulation frame of Deltatime seconds

View File

@@ -456,10 +456,10 @@ bool global_settings::ConfigParseInput(cParser& Parser, const std::string& token
return false;
}
bool global_settings::ConfigParseTest(cParser& Parser, const std::string& token)
bool global_settings::ConfigParseTest(cParser& Parser, std::string_view const Token)
{
// integration test limits, usually given in the config block of a test scenery
if (token == "test.timeout")
if (Token == "test.timeout")
{
double value{ test.timeout };
ParseOne(Parser, value);
@@ -468,26 +468,26 @@ bool global_settings::ConfigParseTest(cParser& Parser, const std::string& token)
return true;
}
if (token == "test.standstill")
if (Token == "test.standstill")
{
ParseOne(Parser, test.standstill);
test.standstill = std::max(0.0, test.standstill);
return true;
}
if (token == "test.pass_on_standstill")
if (Token == "test.pass_on_standstill")
{
ParseOne(Parser, test.pass_on_standstill);
return true;
}
if (token == "test.fail_if_stop_overran")
if (Token == "test.fail_if_stop_overran")
{
ParseOne(Parser, test.fail_if_stop_overran);
return true;
}
if (token == "test.no_movement_before_pass")
if (Token == "test.no_movement_before_pass")
{
ParseOne(Parser, test.no_movement_before_pass);
return true;

View File

@@ -95,7 +95,8 @@ struct global_settings {
bool fail_if_stop_overran{ true }; // a train passing a signal at stop ends the test as failed; with false it's only logged
bool no_movement_before_pass{ true }; // a pass waits until every vehicle stands still; with false it ends the test at once
bool timeout_from_command_line{ false }; // --test-timeout given, the scenery doesn't override it
} test;
};
test_settings test;
bool editor_tracks{ false }; // F3 track workspace: draw and pick tracks without the scenery draw-range cap
int iConvertModels{ 0 }; // tworzenie plików binarnych
int iConvertIndexRange{ 1000 }; // range of duplicate vertex scan
@@ -387,7 +388,7 @@ struct global_settings {
bool ConfigParseNetwork(cParser& Parser, const std::string& token);
bool ConfigParseHardware(cParser& Parser, const std::string& token);
bool ConfigParseDebug(cParser& Parser, const std::string& token);
bool ConfigParseTest(cParser& Parser, const std::string& token);
bool ConfigParseTest(cParser& Parser, std::string_view Token);
bool ConfigParse_gfx( cParser &parser, std::string_view const Token );
// sends basic content of the class in legacy (text) format to provided stream
void

View File

@@ -768,7 +768,8 @@ void TController::TableCheck(double fDistance)
{ // aktualizacja rekordów z wyjątkiem ostatniego
if (sSpeedTable[i].iFlags & spEnabled) // jeśli pozycja istotna
{
if (UpdateSpeedPosition(sSpeedTable[i]))
auto const passedbefore { TestFlag( sSpeedTable[ i ].iFlags, spElapsed ) };
if (sSpeedTable[i].Update())
{
if( Global.iWriteLogEnabled & 8 ) {
WriteLog( "Speed table for " + OwnerName() + " detected switch change at " + sSpeedTable[ i ].trTrack->name() + " (generating fresh trace)" );
@@ -794,6 +795,8 @@ void TController::TableCheck(double fDistance)
// nie kontynuujemy pętli, trzeba doskanować ciąg dalszy
break;
}
// a switch is a track, the update of a signal never ends the loop above
CheckSignalPassedAtDanger( sSpeedTable[ i ], passedbefore );
if (sSpeedTable[i].iFlags & spTrack) // jeśli odcinek
{
if( sSpeedTable[ i ].fDist + sSpeedTable[ i ].trTrack->Length() < -fLength ) // a skład wyjechał całą długością poza
@@ -817,8 +820,10 @@ void TController::TableCheck(double fDistance)
}
}
}
// aktualizacja ostatniego; a signal at stop often is the last, the scan doesn't go past it
UpdateSpeedPosition(sSpeedTable[iLast]);
auto const lastpassedbefore { TestFlag( sSpeedTable[ iLast ].iFlags, spElapsed ) };
sSpeedTable[iLast].Update(); // aktualizacja ostatniego
// a signal at stop often is the last, the scan doesn't go past it
CheckSignalPassedAtDanger( sSpeedTable[ iLast ], lastpassedbefore );
// WriteLog("TableCheck: Upate last track. Dist=" + AnsiString(sSpeedTable[iLast].fDist));
if( sSpeedTable[ iLast ].fDist < fDistance ) {
TableTraceRoute( fDistance, pVehicles[ end::rear ] ); // doskanowanie dalszego odcinka
@@ -843,17 +848,14 @@ bool is_signal_at_stop( TSpeedPos const &Point )
} // namespace
bool TController::UpdateSpeedPosition( TSpeedPos &Point ) const
void TController::CheckSignalPassedAtDanger( TSpeedPos const &Point, bool const Passedbefore ) const
{
auto const passedbefore { TestFlag( Point.iFlags, spElapsed ) };
auto const switchchanged { Point.Update() };
if( false == passedbefore
if( false == Passedbefore
&& TestFlag( Point.iFlags, spElapsed )
&& is_signal_at_stop( Point )
&& ( mvOccupied->CategoryFlag & 1 ) != 0 ) { // railway only
simulation::test().signal_passed_at_danger( OwnerName(), Point.evEvent->m_name );
}
return switchchanged;
}
auto const passengerstopmaxdistance { 400.0 }; // maximum allowed distance between passenger stop point and consist head

View File

@@ -519,9 +519,9 @@ private:
bool TableNotFound( basic_event const *Event, double const Distance ) const;
void TableTraceRoute( double fDistance, TDynamicObject *pVehicle );
void TableCheck( double fDistance );
// updates a position of the speed table, returns true when a switch on it changed (TSpeedPos::Update).
// called after TSpeedPos::Update() of a position of the speed table, with its spElapsed flag from before it:
// reports the head of the train going past it, if it's a signal showing stop
bool UpdateSpeedPosition( TSpeedPos &Point ) const;
void CheckSignalPassedAtDanger( TSpeedPos const &Point, bool Passedbefore ) const;
TCommandType TableUpdate( double &fVelDes, double &fDist, double &fNext, double &fAcc );
bool TableUpdateStopPoint( TCommandType &Command, TSpeedPos &Point, double const Signaldistance );
bool TableUpdateEvent( double &Velocity, TCommandType &Command, TSpeedPos &Point, double &Signaldistance, int const Pointindex );