17
0
mirror of https://github.com/MaSzyna-EU07/maszyna.git synced 2026-10-17 03:59:19 +02:00

Fix/sonar maintainability rebased (#209)

* refactor(sonar): use override instead of redundant virtual (cpp:S3471)

* refactor(sonar): remove empty statements, one declaration per statement (cpp:S1116, cpp:S1659)

* refactor(sonar): drop redundant lambda return types (cpp:S3574)

* refactor(sonar): prefer using over typedef (cpp:S5416)

* refactor(sonar): use =default for trivial special members (cpp:S3490)

* refactor(sonar): use nullptr literal (cpp:S4962)

* refactor(sonar): remove redundant access specifiers (cpp:S3539)

* refactor(sonar): remove redundant casts (cpp:S1905)

* refactor(sonar): use std::scoped_lock instead of std::lock_guard (cpp:S5997)

* refactor(sonar): construct elements in place with emplace_back (cpp:S6003)

* refactor(sonar): make narrowing conversions explicit (cpp:S5276)

* refactor(sonar): mark unused parameters (cpp:S1172)

Unused names are commented out; parameters used only on some platforms
are marked [[maybe_unused]].

* refactor(sonar): declare non-mutating member functions const (cpp:S5817)

Virtual functions are left untouched so overrides keep matching.

* refactor(sonar): merge collapsible nested if statements (cpp:S1066)

Comments that preceded the inner if are kept above the merged statement.

* refactor(sonar): scope single-use variables in if init-statements (cpp:S6004)

* fix(sonar): give polymorphic base classes virtual destructors (cpp:S1235)

* refactor(sonar): use try_emplace for map insertion (cpp:S6030)

* refactor(sonar): use auto where the type is spelled out on the right (cpp:S5827)

* refactor(sonar): remove redundant parentheses (cpp:S1110)

* refactor(sonar): document intentionally empty functions (cpp:S1186)

* refactor(sonar): remove dead stores (cpp:S1854)

Side effects (e.g. LISTLINE++) are kept.

* refactor(sonar): remove unused variables, captures and private fields (cpp:S1481, cpp:S1068)

* refactor(sonar): use structured bindings for pair access (cpp:S6005)

* refactor(sonar): use range-based loops and ranges algorithms (cpp:S5566)

* refactor(sonar): split chained assignments (cpp:S1121)

* refactor(sonar): add default cases to switch statements (cpp:S3562)

* refactor(sonar): use std::size for array lengths (cpp:S7127)

* refactor(sonar): use std::ranges algorithms and std::erase(_if) (cpp:S6197)

* refactor(sonar): access static members through the class (cpp:S2209)

* refactor(sonar): add braces around nested if-else (cpp:S5261)

* refactor(sonar): avoid side effects inside typeid operands (cpp:S5279)

* refactor(sonar): drop top-level const from by-value return types (cpp:S5951)

* refactor(sonar): declare variables separately from their type definitions (cpp:S3646)

* refactor(sonar): declare loop counters in the for statement (cpp:S5955)

* refactor(sonar): rely on class template argument deduction (cpp:S6012)

* refactor(sonar): inherit base constructors instead of forwarding them (cpp:S5952)

* refactor(sonar): rename locals that shadow outer declarations (cpp:S1117)

Only local variables and definition parameters are renamed; shadowing
struct fields and enumerators in headers are left for a separate change.

* refactor(sonar): reduce enum qualification with using enum (cpp:S6177)

Applied only where no unqualified name in the block could be captured by
the introduced enumerators.

* refactor(sonar): mark converting constructors explicit (cpp:S1709)

sound_source and the gl::object conversion operators stay implicit; they
are relied upon by copy-list-initialisation and GL calls.

* refactor(sonar): initialise members in initialiser lists or declarations (cpp:S3230)

* refactor(sonar): make read-only local references and pointers const (cpp:S5350)

* refactor(sonar): take read-only pointer and reference parameters as const (cpp:S995)

TTrain command handlers keep their signature, it is fixed by the handler table.

* refactor(sonar): pass expensive-to-copy parameters by const reference (cpp:S1238)

Signatures declared in files touched by PR 206 (Driver.h, EU07.cpp) and
virtual overrides are left unchanged.

* refactor(sonar): use transparent comparators for string-keyed maps (cpp:S6045)

std::unordered_map instances and map types exposed in headers used by
other modules are left as they are.

* fix(sonar): do not use UI text as a printf format string (cpp:S5281)

Text lines containing '%' would otherwise be interpreted as format
specifiers by ImGui::TextColored.

* refactor(sonar): use std::bind_front for callbacks (cpp:S5995)

* refactor(sonar): drop const_cast on string literals passed to the Python C API (cpp:S859)

* refactor(sonar): take read-only string parameters as std::string_view (cpp:S6009)

The Windows messaging helpers keep std::string, they need c_str().

* refactor(sonar): make read-only global tables const (cpp:S5421)

Mutable global state (flags, timers, singletons) is left as is.

* refactor(sonar): replace single-case switch statements with if (cpp:S1301)

* refactor(sonar): format UUIDs and log timestamps with std::format (cpp:S6494, cpp:S5945)

* refactor(sonar): use std::array for local fixed-size arrays (cpp:S5945)

Arrays that are class members or part of headers are left unchanged.

* fix(sonar): test the bearing damage bit, not bit 0 (cpp:S872)

'DamageFlag & dtrain_bearing > 0' parsed as 'DamageFlag & (dtrain_bearing > 0)',
i.e. DamageFlag & 1, so bearing friction reacted to the wrong damage flag.

* refactor(sonar): assorted small fixes

- empty() instead of size() comparisons (cpp:S1155)
- member initialisers in declaration order (cpp:S3229)
- no redundant c_str() when a std::string is accepted (cpp:S7121)
- contains() on associative containers (cpp:S6171)
- const reference instead of a copying range-for (cpp:S6032)
- starts_with() for prefix checks (cpp:S6178)
- no std::move on temporaries (cpp:S5274)
- has_value() on std::optional (cpp:S7172)
- bool literals for bool members (cpp:S5820)
- inline only on the definition (cpp:S3548)
- explicit base access specifier (cpp:S5965)
- explicit element access instead of dereferencing an array (cpp:S7116)
- rely on the C++20 rewritten operator!= (cpp:S6186)

* refactor(sonar): more small fixes

- std::format instead of iostream manipulators in to_string/to_hex_str (cpp:S6495);
  output verified identical, negative hex values keep the unsigned form
- remove an empty compound statement (cpp:S108)
- drop an always-false unsigned < 0 branch (cpp:S1768)
- explicit lambda capture (cpp:S3608)
- std::make_unique (cpp:S5950)

* chore: strip stray carriage returns left in TTrain constructor comments

* fix: keep quantize() in its own value type

The S5276 change cast the result of the generic quantize<Type_>() to
unsigned int, which truncated float/double callers (shadow angle slider,
editor rotation snapping, AI speed control steps) and broke negative values.

* fix(sonar): use integer loop counters in segment sampling (cpp:S2193)

* refactor(sonar): clean up issues reported on PR 209

- remove locals left unused after the dead-store cleanup (cpp:S1481, cpp:S1854)
- unnamed unused parameter (cpp:S1172)
- single-use declarations moved into if init-statements (cpp:S6004)
- auto for casted initialisers (cpp:S5827)
- const references and pointers where nothing is modified (cpp:S5350)
- rename structured bindings shadowed by inner declarations (cpp:S1117)
This commit is contained in:
jerrrrycho
2026-10-11 13:22:33 +02:00
committed by GitHub
parent c26041f2e7
commit 6263fe539b
162 changed files with 4220 additions and 4598 deletions

View File

@@ -62,8 +62,7 @@ void ui::cameraview_panel::render()
ImGui::SetNextWindowSizeConstraints(ImVec2(200, 200), ImVec2(2500, 2500), cameraview_window_callback);
auto const panelname{(title.empty() ? m_name : title) + "###" + m_name};
if (ImGui::Begin(panelname.c_str(), &is_open)) {
if (auto const panelname{(title.empty() ? m_name : title) + "###" + m_name}; ImGui::Begin(panelname.c_str(), &is_open)) {
render_contents();
}
@@ -90,7 +89,7 @@ void ui::cameraview_panel::render_contents()
texture->bind(0);
{
std::lock_guard<std::mutex> lock(mutex);
std::scoped_lock lock(mutex);
if (image_ptr) {
glActiveTexture(GL_TEXTURE0);
@@ -123,8 +122,8 @@ void ui::cameraview_panel::capture_func()
piped_proc proc(cmdline);
size_t frame_size = Global.extcam_res.x * Global.extcam_res.y * 3;
uint8_t *read_buffer = new uint8_t[frame_size];
uint8_t *active_buffer = new uint8_t[frame_size];
auto read_buffer = new uint8_t[frame_size];
auto active_buffer = new uint8_t[frame_size];
size_t bufpos = 0;
@@ -142,7 +141,7 @@ void ui::cameraview_panel::capture_func()
bufpos = 0;
std::lock_guard<std::mutex> lock(mutex);
std::scoped_lock lock(mutex);
image_ptr = read_buffer;
read_buffer = active_buffer;
active_buffer = image_ptr;
@@ -151,7 +150,7 @@ void ui::cameraview_panel::capture_func()
notify_var.notify_one();
}
std::lock_guard<std::mutex> lock(mutex);
std::scoped_lock lock(mutex);
image_ptr = nullptr;
delete[] read_buffer;
delete[] active_buffer;
@@ -165,15 +164,15 @@ void ui::cameraview_panel::record_func()
if (!rec_name.empty()) {
const std::string magic{"{RECORD}"};
size_t pos = cmdline.find(magic);
if (pos != -1)
cmdline.replace(pos, magic.size(), rec_name);
size_t magicpos = cmdline.find(magic);
if (magicpos != -1)
cmdline.replace(magicpos, magic.size(), rec_name);
}
piped_proc proc(cmdline, true);
size_t frame_size = Global.extcam_res.x * Global.extcam_res.y * 3;
uint8_t *read_buffer = new uint8_t[frame_size];
auto read_buffer = new uint8_t[frame_size];
uint32_t last_cnt = 0;
size_t bufpos = frame_size;
@@ -181,7 +180,7 @@ void ui::cameraview_panel::record_func()
while (record_state == RUNNING) {
if (bufpos == frame_size)
{
std::unique_lock<std::mutex> lock(mutex);
std::unique_lock lock(mutex);
auto r = notify_var.wait_for(lock, std::chrono::milliseconds(50), [this, last_cnt]{return last_cnt != frame_cnt;});
last_cnt = frame_cnt;
if (!image_ptr || !r)

View File

@@ -5,7 +5,7 @@
map::objects map::Objects;
map::sorted_object_list map::objects::find_in_range(glm::vec3 from, float distance)
map::sorted_object_list map::objects::find_in_range(glm::vec3 from, float distance) const
{
sorted_object_list items;
@@ -25,7 +25,7 @@ map::sorted_object_list map::objects::find_in_range(glm::vec3 from, float distan
float dist = glm::distance2(entry_location, search_point);
if (dist < max_distance2)
{
items.emplace(dist, entry);
items.try_emplace(dist, entry);
}
}
@@ -48,7 +48,7 @@ map::sorted_object_list map::objects::find_in_range(glm::vec3 from, float distan
auto entry = std::make_shared<map::vehicle>();
entry->dynobj = dynobj;
entry->name = dynobj->name();
items.emplace(dist, std::move(entry));
items.try_emplace(dist, std::move(entry));
}
}

View File

@@ -29,7 +29,7 @@ struct semaphore : public map_object
std::vector<basic_event *> events;
TMemCell *memcell = nullptr;
virtual gfx::basic_vertex vertex() override {
gfx::basic_vertex vertex() override {
bool stop_signal = memcell->IsVelocity() && (memcell->Value1() == 0.0);
return gfx::basic_vertex(location, glm::vec3(),
(!stop_signal) ? glm::vec2(0.0f, 0.2f) : glm::vec2(0.2f, 0.4f));
@@ -45,9 +45,10 @@ struct launcher : public map_object
enum type_e {
track_switch,
level_crossing
} type;
};
type_e type;
virtual gfx::basic_vertex vertex() {
gfx::basic_vertex vertex() override {
return gfx::basic_vertex(location, glm::vec3(),
type == track_switch ? glm::vec2(0.4f, 0.6f) : glm::vec2(0.6f, 0.8f));
}
@@ -60,7 +61,7 @@ struct track_switch : public map_object
std::array<char[4], 4> preview;
std::array<TTrack*, 4> track = { nullptr };
virtual gfx::basic_vertex vertex() {
gfx::basic_vertex vertex() override {
return gfx::basic_vertex(location, glm::vec3(), glm::vec2(0.4f, 0.6f));
}
};
@@ -70,7 +71,7 @@ struct obstacle : public map_object
{
std::string model_name;
virtual gfx::basic_vertex vertex() {
gfx::basic_vertex vertex() override {
return gfx::basic_vertex(location, glm::vec3(), glm::vec2(0.8f, 1.0f));
}
};
@@ -87,7 +88,7 @@ struct objects
bool poi_dirty = true;
// returns objects in range from vec3, NaN in Y ignores it
sorted_object_list find_in_range(glm::vec3 from, float distance);
sorted_object_list find_in_range(glm::vec3 from, float distance) const;
};
extern objects Objects;

View File

@@ -19,7 +19,7 @@ void perfgraph_panel::render_contents() {
ImGui::EndCombo();
}
Timer::stopwatch *stopwatch = nullptr;
Timer::stopwatch const *stopwatch = nullptr;
if (current_timer == gfx_total)
stopwatch = &Timer::subsystem.gfx_total;
@@ -49,7 +49,7 @@ void perfgraph_panel::render_contents() {
if (!stopwatch)
return;
history[pos] = stopwatch->last().count() / 1000.0;
history[pos] = static_cast<float>(static_cast<double>(stopwatch->last().count()) / 1000.0);
const std::string label = std::to_string(history[pos]) + "ms";
pos++;
@@ -57,5 +57,5 @@ void perfgraph_panel::render_contents() {
pos = 0;
ImGui::SliderFloat(STR_C("Range"), &max, 0.1f, 250.0f);
ImGui::PlotLines("##timer", &history[0], history.size(), pos, label.c_str(), 0.0f, max, ImVec2(500, 200));
ImGui::PlotLines("##timer", &history[0], static_cast<int>(history.size()), static_cast<int>(pos), label.c_str(), 0.0f, max, ImVec2(500, 200));
}

View File

@@ -3,7 +3,7 @@
ui::popup::popup(ui_panel &panel) : m_parent(panel) {}
ui::popup::~popup() {}
ui::popup::~popup() = default;
bool ui::popup::render()
{

View File

@@ -11,7 +11,7 @@ class popup
static int id;
public:
popup(ui_panel &panel);
explicit popup(ui_panel &panel);
virtual ~popup();
virtual bool render();

View File

@@ -18,15 +18,16 @@ void ui::time_panel::render_contents()
if (ImGui::Button(STR_C("Apply")))
{
m_relay.post(user_command::setdatetime, (double)yearday, time * 60.0, 1, 0);
m_relay.post(user_command::setweather, fog, overcast, 1, 0);
m_relay.post(user_command::settemperature, temperature, overcast, 1, 0);
using enum user_command;
m_relay.post(setdatetime, (double)yearday, time * 60.0, 1, 0);
m_relay.post(setweather, fog, overcast, 1, 0);
m_relay.post(settemperature, temperature, overcast, 1, 0);
}
}
void ui::time_panel::open()
{
auto &data = simulation::Time.data();
auto const &data = simulation::Time.data();
time = (float)data.wHour + (float)data.wMinute / 60.0f;
yearday = simulation::Time.year_day();

View File

@@ -63,16 +63,16 @@ void trainingcard_panel::save_thread_func()
if (in_line.compare(0, magic.size(), magic) == 0)
{
temp << "<div><b>Miejsce: </b>" << (std::string(place.c_str())) << "</div><br />" << std::endl;
temp << "<div><b>Data: </b>" << (date) << "</div><br />" << std::endl;
temp << "<div><b>Czas: </b>" << (from) << " - " << (to) << "</div><br />" << std::endl;
temp << "<div><b>Imię (imiona) i nazwisko szkolonego: </b>" << (trainee_name) << "</div><br />" << std::endl;
temp << "<div><b>Data urodzenia: </b>" << (trainee_birthdate) << "</div><br />" << std::endl;
temp << "<div><b>Firma: </b>" << (trainee_company) << "</div><br />" << std::endl;
temp << "<div><b>Imię i nazwisko instruktora: </b>" << (instructor_name) << "</div><br />" << std::endl;
temp << "<div><b>Odcinek trasy: </b>" << (track_segment) << "</div><br />" << std::endl;
temp << "<div><b>Data: </b>" << date << "</div><br />" << std::endl;
temp << "<div><b>Czas: </b>" << from << " - " << to << "</div><br />" << std::endl;
temp << "<div><b>Imię (imiona) i nazwisko szkolonego: </b>" << trainee_name << "</div><br />" << std::endl;
temp << "<div><b>Data urodzenia: </b>" << trainee_birthdate << "</div><br />" << std::endl;
temp << "<div><b>Firma: </b>" << trainee_company << "</div><br />" << std::endl;
temp << "<div><b>Imię i nazwisko instruktora: </b>" << instructor_name << "</div><br />" << std::endl;
temp << "<div><b>Odcinek trasy: </b>" << track_segment << "</div><br />" << std::endl;
if (distance > 0.0f)
temp << "<div><b>Przebyta odległość: </b>" << std::round(distance) << " km</div><br />" << std::endl;
temp << "<div><b>Uwagi: </b><br />" << (remarks) << "</div>" << std::endl;
temp << "<div><b>Uwagi: </b><br />" << remarks << "</div>" << std::endl;
}
else
{
@@ -119,7 +119,7 @@ void trainingcard_panel::render_contents()
ImGui::EndPopup();
}
if (start_time_wall)
if (start_time_wall.has_value())
{
std::tm const tm = local_tm(*start_time_wall);
std::string rep = "Czas rozpoczęcia: " + std::to_string(tm.tm_year + 1900) + "-" + std::to_string(tm.tm_mon + 1) + "-" + std::to_string(tm.tm_mday) + " " + std::to_string(tm.tm_hour) +
@@ -154,7 +154,7 @@ void trainingcard_panel::render_contents()
ImGui::TextUnformatted("Uwagi");
ImGui::InputTextMultiline("##remarks", &remarks[0], remarks.size(), ImVec2(-1.0f, 200.0f));
if (!start_time_wall)
if (!start_time_wall.has_value())
{
if (ImGui::Button("Rozpocznij szkolenie"))
{
@@ -177,7 +177,7 @@ void trainingcard_panel::render_contents()
{
state.store(2);
if (simulation::Trains.sequence().size() > 0)
distance = simulation::Trains.sequence()[0]->Dynamic()->MoverParameters->DistCounter;
distance = static_cast<float>(simulation::Trains.sequence()[0]->Dynamic()->MoverParameters->DistCounter);
if (save_thread.joinable())
save_thread.join();
@@ -187,9 +187,9 @@ void trainingcard_panel::render_contents()
}
}
const std::string *trainingcard_panel::is_recording()
const std::string *trainingcard_panel::is_recording() const
{
if (!start_time_wall)
if (!start_time_wall.has_value())
return nullptr;
return &recording_timestamp;

View File

@@ -31,7 +31,7 @@ class trainingcard_panel : public ui_panel
~trainingcard_panel();
void render_contents() override;
const std::string *is_recording();
const std::string *is_recording() const;
std::string recording_timestamp;
};

View File

@@ -12,7 +12,7 @@ ui::vehiclelist_panel::vehiclelist_panel(ui_layer &parent)
void ui::vehiclelist_panel::render_contents()
{
if (m_first_show && Global.gui_trainingdefault) {
for (TDynamicObject *vehicle : simulation::Vehicles.sequence())
for (TDynamicObject const *vehicle : simulation::Vehicles.sequence())
{
if (!vehicle->Mechanik || vehicle->name() != ToLower(Global.local_start_vehicle))
continue;
@@ -26,7 +26,7 @@ void ui::vehiclelist_panel::render_contents()
return;
}
for (TDynamicObject *vehicle : simulation::Vehicles.sequence())
for (TDynamicObject const *vehicle : simulation::Vehicles.sequence())
{
if (!vehicle->Mechanik)
continue;
@@ -37,7 +37,7 @@ void ui::vehiclelist_panel::render_contents()
if (vehicle->Mechanik)
timetable = vehicle->Mechanik->TrainName() + ", ";
std::string label = std::string(name + ", " + timetable + std::to_string(speed) + " km/h###");
auto label = std::string(name + ", " + timetable + std::to_string(speed) + " km/h###");
ImGui::PushID(vehicle);
if (ImGui::Button(label.c_str())) {

View File

@@ -8,7 +8,7 @@ class vehiclelist_panel : public ui_panel
bool m_first_show = true;
public:
vehiclelist_panel(ui_layer &parent);
explicit vehiclelist_panel(ui_layer &parent);
void render_contents() override;
};