refactor: eliminate clang-tidy diagnostics

Author: gtaylor

.clang-tidy

@@ -9,14 +9,7 @@ Checks: >
   clang-analyzer-deadcode.*,
   cert-*-c,
   -cert-dcl37-c,
-  bugprone-narrowing-conversions,
-  bugprone-branch-clone,
-  bugprone-suspicious-memory-comparison,
-  bugprone-suspicious-realloc-usage,
-  bugprone-suspicious-string-compare,
-  bugprone-switch-missing-default-case,
-  bugprone-undefined-memory-manipulation,
-  bugprone-unused-return-value,
+  bugprone-*,
   misc-include-cleaner
 WarningsAsErrors: '*'
 HeaderFilterRegex: '^.*/src/(mux|btech)/.*'

CMakeLists.txt

@@ -405,6 +405,90 @@ if(BUILD_TESTING)
     "${CMAKE_SOURCE_DIR}/src")
   add_test(NAME btech_random COMMAND btech_random_test)
 
+  add_executable(btech_weapon_failure_test
+    tests/btech_weapon_failure.c
+    ${BTECH_SOURCE_DIR}/combat/mech_weapon_failure.c)
+  target_compile_definitions(btech_weapon_failure_test PRIVATE BTECH_INTERNAL=1)
+  target_link_libraries(btech_weapon_failure_test PRIVATE btmux_options)
+  target_include_directories(btech_weapon_failure_test PRIVATE
+    "${CMAKE_BINARY_DIR}/${BTECH_SOURCE_DIR}"
+    "${CMAKE_BINARY_DIR}"
+    ${BTECH_PRIVATE_INCLUDE_DIRS}
+    "${CMAKE_SOURCE_DIR}/src")
+  add_test(NAME btech_weapon_failure COMMAND btech_weapon_failure_test)
+
+  add_executable(btech_ammunition_decrement_test
+    tests/btech_ammunition_decrement.c
+    ${BTECH_SOURCE_DIR}/combat/mech_ammunition_decrement.c)
+  target_compile_definitions(btech_ammunition_decrement_test
+    PRIVATE BTECH_INTERNAL=1)
+  target_compile_options(btech_ammunition_decrement_test
+    PRIVATE -ffunction-sections)
+  target_link_options(btech_ammunition_decrement_test
+    PRIVATE -Wl,--gc-sections)
+  target_link_libraries(btech_ammunition_decrement_test PRIVATE btmux_options)
+  target_include_directories(btech_ammunition_decrement_test PRIVATE
+    "${CMAKE_BINARY_DIR}/${BTECH_SOURCE_DIR}"
+    "${CMAKE_BINARY_DIR}"
+    ${BTECH_PRIVATE_INCLUDE_DIRS}
+    "${CMAKE_SOURCE_DIR}/src")
+  add_test(NAME btech_ammunition_decrement
+    COMMAND btech_ammunition_decrement_test)
+
+  add_executable(btech_ammunition_check_test
+    tests/btech_ammunition_check.c
+    ${BTECH_SOURCE_DIR}/unit/mech_systems.c)
+  target_compile_definitions(btech_ammunition_check_test
+    PRIVATE BTECH_INTERNAL=1)
+  target_compile_options(btech_ammunition_check_test
+    PRIVATE -ffunction-sections)
+  target_link_options(btech_ammunition_check_test
+    PRIVATE -Wl,--gc-sections)
+  target_link_libraries(btech_ammunition_check_test PRIVATE btmux_options)
+  target_include_directories(btech_ammunition_check_test PRIVATE
+    "${CMAKE_BINARY_DIR}/${BTECH_SOURCE_DIR}"
+    "${CMAKE_BINARY_DIR}"
+    ${BTECH_PRIVATE_INCLUDE_DIRS}
+    "${CMAKE_SOURCE_DIR}/src")
+  add_test(NAME btech_ammunition_check COMMAND btech_ammunition_check_test)
+
+  add_executable(btech_normal_to_hit_test
+    tests/btech_normal_to_hit.c
+    ${BTECH_SOURCE_DIR}/combat/mech_bth.c)
+  target_compile_definitions(btech_normal_to_hit_test PRIVATE BTECH_INTERNAL=1)
+  target_compile_options(btech_normal_to_hit_test PRIVATE -ffunction-sections)
+  target_link_options(btech_normal_to_hit_test PRIVATE -Wl,--gc-sections)
+  target_link_libraries(btech_normal_to_hit_test PRIVATE btmux_options m)
+  target_include_directories(btech_normal_to_hit_test PRIVATE
+    "${CMAKE_BINARY_DIR}/${BTECH_SOURCE_DIR}"
+    "${CMAKE_BINARY_DIR}"
+    ${BTECH_PRIVATE_INCLUDE_DIRS}
+    "${CMAKE_SOURCE_DIR}/src")
+  add_test(NAME btech_normal_to_hit COMMAND btech_normal_to_hit_test)
+
+  add_executable(btech_damage_apply_test
+    tests/btech_damage_apply.c
+    ${BTECH_SOURCE_DIR}/combat/mech_damage.c)
+  target_compile_definitions(btech_damage_apply_test PRIVATE BTECH_INTERNAL=1)
+  target_compile_options(btech_damage_apply_test PRIVATE -ffunction-sections)
+  target_compile_options(btech_damage_apply_test PRIVATE
+    -Wno-missing-prototypes -Wno-strict-prototypes)
+  target_link_options(btech_damage_apply_test PRIVATE -Wl,--gc-sections)
+  target_link_libraries(btech_damage_apply_test PRIVATE btmux_options)
+  target_include_directories(btech_damage_apply_test PRIVATE
+    "${CMAKE_BINARY_DIR}/${BTECH_SOURCE_DIR}"
+    "${CMAKE_BINARY_DIR}"
+    ${BTECH_PRIVATE_INCLUDE_DIRS}
+    "${CMAKE_SOURCE_DIR}/src")
+  add_test(NAME btech_damage_apply COMMAND btech_damage_apply_test)
+
+  add_executable(checked_storage_test tests/checked_storage.c)
+  target_link_libraries(checked_storage_test
+    PRIVATE btmux_options btmux_checked_storage)
+  target_include_directories(checked_storage_test PRIVATE
+    "${CMAKE_SOURCE_DIR}/src")
+  add_test(NAME checked_storage COMMAND checked_storage_test)
+
   add_executable(btech_persistence_schema_test
     tests/btech_persistence_schema.c
     ${BTECH_SOURCE_DIR}/persistence/schema.c)
@@ -640,7 +724,8 @@ if(BUILD_TESTING)
   add_test(NAME help_frontmatter_parse COMMAND help_frontmatter_parse_test)
 
   add_executable(help_render_test tests/help_render.c
-    ${MUX_SOURCE_DIR}/help/help_render.c)
+    ${MUX_SOURCE_DIR}/help/help_render.c
+    ${MUX_SOURCE_DIR}/support/array_sort.c)
   target_link_libraries(help_render_test PRIVATE btmux_options cmark)
   target_include_directories(help_render_test PRIVATE
     "${CMAKE_BINARY_DIR}"
@@ -649,7 +734,8 @@ if(BUILD_TESTING)
 
   add_executable(help_index_integration_test tests/help_index_integration.c
     ${MUX_SOURCE_DIR}/help/help_frontmatter.c
-    ${MUX_SOURCE_DIR}/help/help_index.c)
+    ${MUX_SOURCE_DIR}/help/help_index.c
+    ${MUX_SOURCE_DIR}/support/array_sort.c)
   target_link_libraries(help_index_integration_test PRIVATE btmux_options tomlc17)
   target_include_directories(help_index_integration_test PRIVATE
     "${CMAKE_BINARY_DIR}"

README.md

@@ -4,13 +4,13 @@ It comes with a real-time combat system with AI, a unit repair system, economic
 ## Status
 
 StompyMUX is an occasionally developed modernization fork of [BattletechMUX](https://sourceforge.net/projects/btonline-btech/).
-Our foundations are built from more than [three decades of contributions](./docs/content/en/docs/history.md).
+Our foundations are built from more than [three decades of contributions](./docs/content/docs/history.md).
 While the features in this codebase are very well fleshed out, we may occasionally break things, including backwards compatibility!
 
 ## Getting involved
 
 Contributions are welcomed.
-See the [Contributing](./docs/content/en/docs/contributing.md) guide.
+See the [Contributing](./docs/content/docs/contributing.md) guide.
 Visit our [Discord server](https://discord.gg/TJzQByY2nC) to reach the rest of the developer community.
 
 ## Support

TODO

@@ -3,6 +3,7 @@
 ## General hygeine
 
 * Eliminate conditional compilation
+* .clang-format: Langauge=C instead of Cpp
 * Doxygen comment all public functions in headers with @param[in] and @param[out]
 * Doxygen comment all static and private functions?
 * Look into clang-tidy/clangd readability-identifier-naming and VariableCase + FunctionCase
@@ -39,4 +40,8 @@
 * What is CharacterXpRanking?
 * Add `-fhardened` to CMake for mux and btech. May require disabling debug builds.
 * remove MechRuntimeState.unused
-* Replace CVS headers
+* Replace CVS headers
+* Unused terrain types?
+* Autopilot bug fixing and testing
+* Complete Autopilot placeholders
+* LOS bug fixing and testing

game/stompymux.toml

@@ -3,7 +3,7 @@
 # From within this file, you can change much about the way your game behaves.
 # Some directives are clearly labeled and described, others are not. Others
 # aren't even listed in this file. For a complete list with descriptions,
-# please see docs/content/en/docs/configuration/stompymux-toml.md.
+# please see docs/content/docs/configuration/stompymux-toml.md.
 # ----------------------------------------------------------------------------
 
 # Include the stock command and flag aliases. Add local

justfile

@@ -9,7 +9,7 @@ stylua := env("STYLUA", "stylua")
 
 default: checks install
 
-ci: check-mux-source-size fmt-check build test
+ci: check-mux-source-size fmt-check build test tidy-check
 
 agent-checks: ci
 
@@ -37,6 +37,9 @@ fmt-check: fmt-check-c fmt-check-lua
 tidy:
     {{run_clang_tidy}} -clang-tidy-binary {{clang_tidy}} -quiet -fix -p {{build_dir}} -j "$(nproc)" '^.*/src/(mux|btech)/.*[.]c$'
 
+tidy-check:
+    {{run_clang_tidy}} -clang-tidy-binary {{clang_tidy}} -quiet -p {{build_dir}} -j "$(nproc)" '^.*/src/(mux|btech)/.*[.]c$'
+
 build:
     cmake -S . -B {{build_dir}} -DCMAKE_C_COMPILER=clang-22 -DCMAKE_BUILD_TYPE={{build_type}} -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
     cmake --build {{build_dir}} -j "$(nproc)"

src/btech/CMakeLists.txt

@@ -5,6 +5,7 @@ set(BTECH_SOURCES
   autopilot/autopilot_navigation.c
   autopilot/autopilot_pathfinding.c
   autopilot/autopilot_autogun.c
+  autopilot/autopilot_autogun_fire.c
   autopilot/autopilot_sensor_policy.c
   autopilot/autopilot_weapon_profile.c
   autopilot/autopilot_target_scoring.c
@@ -35,6 +36,7 @@ set(BTECH_SOURCES
   character/pcombat.c
   combat/artillery.c
   combat/bsuit.c
+  combat/bsuit_swarm.c
   combat/bsuit_hide.c
   combat/crit.c
   combat/crit_weapons.c
@@ -51,7 +53,10 @@ set(BTECH_SOURCES
   combat/mech_bth_movement.c
   combat/mech_combat.c
   combat/mech_fire_command.c
+  combat/mech_weapon_failure.c
+  combat/mech_ammunition_decrement.c
   combat/mech_fire_resolution.c
+  combat/mech_fire_preparation.c
   combat/mech_hit_resolution.c
   combat/mech_terrain_effects.c
   combat/mech_combat_misc.c
@@ -176,6 +181,7 @@ set(BTECH_SOURCES
   persistence/schema_v2.c
   persistence/snapshot_store.c
   persistence/snapshot_store_objects.c
+  persistence/snapshot_store_auxiliary.c
   persistence/special_restore.c
   persistence/validation.c
   repair/mech_tech.c
@@ -202,10 +208,14 @@ set(BTECH_SOURCES
   scripting/registry_values.c
   scripting/value_catalog.c
   scripting/repair_map_values.c
+  scripting/repair_damage_values.c
   scripting/unit_query_values.c
+  scripting/unit_battle_value_values.c
   scripting/unit_query_reports.c
   scripting/unit_values.c
   scripting/world_values.c
+  scripting/world_map_values.c
+  scripting/world_part_cost_values.c
   sensors/los_trace.c
   sensors/mech_c3.c
   sensors/mech_c3_misc.c
@@ -230,6 +240,7 @@ set(BTECH_SOURCES
   ui/mech_maps.c
   ui/mech_lrs_map.c
   ui/mech_tactical_map.c
+  ui/mech_tactical_overlays.c
   ui/mech_tactical_layout.c
   ui/mech_tactical_style.c
   ui/mech_tactical_command.c
@@ -287,6 +298,7 @@ set(BTECH_SOURCES
   unit/template_internals.c
   unit/template_inventory.c
   unit/template_load.c
+  unit/template_load_helpers.c
   unit/template_legacy_load.c
   unit/template_registry.c
   unit/template_save.c)

src/btech/autopilot/ai_simulation.c

@@ -10,6 +10,7 @@
 #include "command_handlers_api.h"
 #include "equipment_types.h"
 #include "map_conditions_api.h"
+#include "map_coordinates.h"
 #include "map_terrain.h"
 #include "map_units_api.h"
 #include "mech_classification_api.h"
@@ -95,8 +96,13 @@ int ai_crash(BattleMap *map, Mech *mech, LocationSimulation *location) {
   float target_speed = location->ds;
   if (mech_class(mech) != CLASS_MW && mech_movement_type(mech) != MOVE_VTOL &&
       (mech_movement_type(mech) != MOVE_FLY || mech_is_landed(mech)))
-    target_speed = mech_terrain_speed(mech, target_speed, maximum_speed,
-                                      location->t, location->e);
+    target_speed = mech_terrain_speed(&(MechTerrainSpeedRequest){
+        .mech = mech,
+        .current_speed = target_speed,
+        .maximum_speed = maximum_speed,
+        .terrain = location->t,
+        .elevation = location->e,
+    });
   if (heading_changed) {
     const int slowdown =
         btech_context_movement_slowdown_mode(mech_context(mech));
@@ -135,12 +141,10 @@ int ai_crash(BattleMap *map, Mech *mech, LocationSimulation *location) {
     }
   }
 
-  float x_delta = 0.0F;
-  float y_delta = 0.0F;
-  FindComponents(location->s * (float)MOVE_MOD, location->h, &x_delta,
-                 &y_delta);
-  location->fx += x_delta;
-  location->fy += y_delta;
+  MapRealPosition delta = map_vector_components(&(MapPolarVector){
+      .magnitude = location->s * (float)MOVE_MOD, .bearing = location->h});
+  location->fx += delta.x;
+  location->fy += delta.y;
   location->lx = location->x;
   location->ly = location->y;
   RealCoordToMapCoord(&location->x, &location->y, location->fx, location->fy);

src/btech/autopilot/autopilot.h

@@ -6,6 +6,7 @@
 #include <time.h>
 
 #include "btech_event.h"
+#include "map_coordinates.h"
 #include "mech_events.h"
 #include "mux/server/platform.h"
 #include "mux/support/doubly_linked_list.h"
@@ -56,7 +57,7 @@ constexpr int AUTOPILOT_FOLLOW_TICK = 4;
       */
 
 #define AUTOPILOT_STARTUP_TICK                                                 \
-  STARTUP_TIME + AUTOPILOT_NC_DELAY /* Delay for startup */
+  (STARTUP_TIME + AUTOPILOT_NC_DELAY) /* Delay for startup */
 
 /* Defines for the autogun/autosensor stuff */
 constexpr int AUTO_GUN_TICK = 1;          /* Every second */
@@ -387,10 +388,15 @@ void auto_leave_event(MuxEvent *muxevent);
 void auto_enter_event(MuxEvent *muxevent);
 void auto_command_roam(Autopilot *autopilot, Mech *mech);
 void auto_astar_roam_event(MuxEvent *muxevent);
-void speed_up_if_neccessary(Autopilot *autopilot, Mech *mech, int target_x,
-                            int target_y, int bearing);
-int slow_down_if_neccessary(Autopilot *autopilot, Mech *mech, float range,
-                            int bearing, int target_x, int target_y);
+typedef struct AutopilotApproachRequest {
+  Autopilot *autopilot;
+  Mech *mech;
+  MapHexPosition target;
+  int bearing;
+  float range;
+} AutopilotApproachRequest;
+void autopilot_speed_up_for_target(const AutopilotApproachRequest *request);
+bool autopilot_slow_down_for_target(const AutopilotApproachRequest *request);
 void update_wanted_heading(Autopilot *autopilot, Mech *mech, int bearing);
 
 /* From autopilot_ai.c */