2 Commits

Author	SHA1	Message	Date
raphael	29db1caedb	#6 SxFy codegen from YAML message catalog ... The bulk of the per-SxFy boilerplate — ~90 hand-written builders and parsers across 30+ message pairs — is now generated at build time from a single YAML catalog. Adding a new SECS-II message becomes a YAML edit; the C++ code is generated, not maintained. What changed ------------ data/messages.yaml The catalog. Describes every SxFy currently supported: stream, function, W-bit, builder name, optional parser name, and a recursive body shape grammar (scalar / list / list_of). Shapes carry SECS-II item types (ASCII, BINARY_BYTE, U4, F8, ITEM, ...) and optional C++ enum types for typed ack codes. Inner-most fields can be marked external_struct: true so structs already defined elsewhere (ReportData, CommandParameter) are referenced rather than redefined. tools/gen_messages.py Python codegen. Reads the catalog and emits one inline header. Handles nested shapes via depth-unique variable names in the generated IIFEs, so S6F11's three-level nesting compiles without lambda capture conflicts. Post-order traversal ensures inner structs are emitted before outer ones that reference them. Generates positional and (where applicable) struct builder overloads, plus struct-returning parsers for messages with a `parser:` entry. CMakeLists.txt Custom command runs gen_messages.py at configure/build time and emits ${CMAKE_BINARY_DIR}/generated/secsgem/gem/messages.hpp. Added to the secsgem target's include path so `#include "secsgem/gem/messages.hpp"` resolves to the generated file. Depends on the YAML + the script, so edits trigger regen automatically. Dockerfile Added python3 + python3-yaml to the toolchain image. include/secsgem/gem/messages_helpers.hpp (new) The small set of hand-written helpers the generated header relies on: scalar accessors (as_ascii / as_u4_scalar / ...), parse_u4_list_body, u4_list_item, ack_byte, ALED byte constants, and the two special-case messages whose shape doesn't fit the codegen schema (S1F4 needs per-row std::optional<Item> semantics; S5F6 needs a per-row ALCD callback). include/secsgem/gem/messages.hpp (deleted) The hand-written builder/parser file is gone. Its content now flows through the catalog + codegen. include/secsgem/gem/data_model.hpp Moved CommandParameter to namespace scope so it can be shared between the data model and the messages.yaml's external_struct entry. Added `using CommandParam = CommandParameter` for back-compat. apps/secs_server.cpp + apps/secs_client.cpp Updated the call sites that the codegen renamed or restructured: - parse_terminal_display() split into parse_s10f1 / parse_s10f3. - s1f14_establish_comms_ack now takes a McAck struct for the nested identity (mdln, softrev) — call site uses brace init. - S2F33/S2F35 parsers return strongly-typed entries (DefineReportEntry, LinkEventEntry); the server adapts these to the model's pair-based API at the call site. - S2F15 parser returns vector<EcSet>; iterate by .ecid/.value. - S5F3 parser returns EnableAlarmRequest{aled, alid}; bool comes from (aled & 0x80) != 0. - AlarmReport's is_set()/category() methods removed; callers use the raw alcd byte with bit math (alcd & 0x80, alcd & 0x7F). - s2f42_host_command_ack and s2f41_host_command always take their second list argument explicitly (no defaulted arg from codegen). tests/test_messages.cpp Updated to construct the generated typed structs (EcSet, StatusName, EnableAlarmRequest, CommandParameter, CommandParameterAck) and to read the new field names (.ecid/.value, .rptid/.vids, .ceid/.rptids, .name/.code). Coverage -------- Generated by codegen (44 SxFy in catalog): S1F1, S1F2, S1F3, S1F11, S1F12, S1F13, S1F14, S1F15, S1F16, S1F17, S1F18 S2F13, S2F14, S2F15, S2F16, S2F17, S2F18, S2F29, S2F30, S2F31, S2F32 S2F33, S2F34, S2F35, S2F36, S2F37, S2F38, S2F41, S2F42 S5F1, S5F2, S5F3, S5F4, S5F5 S6F11, S6F12 S7F3, S7F4, S7F5, S7F6, S7F19, S7F20 S10F1, S10F2, S10F3, S10F4 Hand-written (in messages_helpers.hpp): S1F4 list-of-optional-items shape (nullopt -> <L,0>) S5F6 per-row ALCD via callback Adding a new SxFy ----------------- Append a single entry to data/messages.yaml describing the body shape. The builder + parser appear in messages.hpp after the next build. The host command above for S2F41 (or any other added SxFy) requires no C++ changes if the body fits the recursive scalar/list/list_of grammar. Tests: 67 cases / 384 assertions still passing. Demo: byte-for-byte identical behaviour (Select, Establish, Online, S1F11/F3 namelist+values, S2F29 EC namelist, S2F33/F35/F37 dynamic event subscription, S2F41 START -> S6F11 emission, S5F5/F3 alarm directory + enable, S2F41 FAULT -> S5F1 alarm + S6F11, S7F19/F5 recipe ops, S10F1 terminal, S1F15 offline, Separate). Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>	2026-06-02 09:43:36 +02:00
raphael	b871cd9da2	Table/YAML-driven refactor (Layer 1 start) ... Move equipment capabilities and the E30 control state machine out of C++ code and into YAML data files; introduce a Router for SECS dispatch; consolidate small files. Behavioural changes: none. Demo identical (15 SxFy transactions + 3 equipment-initiated primaries), 67 test cases / 384 assertions still all green. Structural changes only. Why --- The previous server.cpp held the equipment data dictionary (3 SVIDs, 2 ECIDs, 3 CEIDs, 2 alarms, 2 recipes, 4 host commands) as imperative C++ in a 50-line `populate()` function, and routed inbound messages through a 150-line if-ladder. Adding a new SVID required a recompile. Adding a new state transition required editing two switch statements (`operator_*` and `on_host_request_*`). The control state machine's behavioural rules were spread across imperative code in two methods. This is exactly what implementation_plan.md calls out as the wrong shape: behavioural rules should live in versioned data, and every runtime/test/analyzer should read from that data rather than re-encode it. This commit starts that move. What's new ---------- data/equipment.yaml Equipment data dictionary. Declarative SVIDs / ECIDs / CEIDs / alarms / recipes / host commands. Host commands carry their HCACK ack code plus optional `emit_ceid` and `set_alarm` side-effects. Adding a new SVID or command is a YAML edit, no recompile. data/control_state.yaml The E30 §6.2 control state transition table as data. Each row is (from, on) -> (to [, then] [, ack]). `then` chains an auto-advance through the transient AttemptOnline state. The previous imperative switch is gone. include/secsgem/config/loader.hpp + src/config/loader.cpp yaml-cpp-backed loader. `load_control_state(path)` returns a ControlTransitionTable + initial state; `load_equipment(path, model)` populates the EquipmentDataModel and returns the device descriptor (id, MDLN, SOFTREV, optional auto-emit CEID). Surfaces config errors with file path + field name via ConfigError. include/secsgem/gem/router.hpp (header-only) Small (stream, function) -> handler map. Server registers all handlers once at startup, then the Connection's message handler is just `router.dispatch(msg)`. Unhandled primaries with W set get SxF0 by default. Replaces the if-ladder in secs_server.cpp. include/secsgem/gem/control_state.hpp + .cpp ControlTransitionTable is the new pure data type. ControlStateMachine is now a thin engine over the table: `fire(event)` looks up the row, optionally transitions, optionally chains a `then` transition, returns the ack code. Behaviour rules no longer live in C++ switches. The default in-code table matches data/control_state.yaml row for row; tests rely on it so they don't need the YAML file. include/secsgem/gem/data_model.hpp + .cpp `register_command(rcmd, CommandSpec)` replaces the function-handler signature. CommandSpec = (HostCmdAck, optional emit_ceid, optional set_alarm). `dispatch_command` returns a CommandResult so the server can fire the side-effects after S2F42 is sent. apps/secs_server.cpp No populate(), no if-ladder. Loads equipment.yaml + control_state.yaml at startup (clean error on bad config), wires the Router once, delegates dispatch. Sm change handler reads emit_on_control_change from the YAML. Welcome S10F3 removed for parity with config (a future YAML rule could re-introduce it declaratively). tests/test_loader.cpp (new) Verifies the YAML loader produces the same shape as the in-code default table, and that equipment.yaml populates every section (SVIDs/ECIDs/CEIDs/alarms/recipes/commands). SECSGEM_DATA_DIR CMake define points at ${CMAKE_SOURCE_DIR}/data so tests don't depend on cwd. CMakeLists.txt, Dockerfile find_package(yaml-cpp) and link. libyaml-cpp-dev added to the Ubuntu base image (yaml-cpp 0.8 ships the modern target name). File consolidation ------------------ Five small files removed; their content lives in fewer headers: - secs2/item.cpp -> inline in secs2/item.hpp - secs2/message.cpp -> inline in secs2/message.hpp - hsms/types.hpp -> merged into hsms/header.hpp - hsms/frame.hpp -> merged into hsms/header.hpp - hsms/frame.cpp -> merged into hsms/header.cpp hsms/header.hpp is now "the HSMS wire format" in one place: SType + status enums + Timers + Header + Frame + constants. All includers updated. Net effect ---------- Before: equipment data dictionary lived in 50 lines of imperative populate() inside secs_server.cpp; dispatch in a 20-branch if-ladder. After: equipment data dictionary lives in 47 lines of YAML; dispatch is a Router built once. Adding a new capability is now a YAML edit in the common case. Test count up to 67 cases / 384 assertions (+4 cases / +106 assertions) covering the loader and the new table-driven SM paths. What's NOT changed ------------------ The per-SxFy reply construction still lives in C++ (each message has a unique body shape). Moving those into YAML/JSON message-shape definitions is the next refactor step but requires a generic typed encoder/decoder driven by shape descriptors; out of scope here. Spooling, the S9 error stream, S1F19/F20, and the other gaps in COMPLIANCE.md remain unchanged. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>	2026-06-02 08:57:38 +02:00