Files
STM32F4-Base/Drivers/BSP/UI/ui_w_records.h
T
wandering1 c4edf352fe refactor(UI): 记录页改注入式 reader,layer-deps 基线 6->3(道B task-6)
B-6 分层收紧(UI_数据供给设计说明.md §7.2 契约原样落地):
- ui_w_records:删 #include "sys_log.h",改 ui_rec_reader_t 只读函数表 +
  ui_w_records_bind() 模块级注入(sys_log 读 API 本为全局,函数表共享、
  实例读盘缓存仍各自独享——切页陈旧行防御不变);log_id 换不透明编号
  UI_W_REC_LOG_RUN/SELFTEST;缓冲容量宏本地化 UI_W_REC_TS/DESC_LEN
  (20/29,与 sys_log 契约下限同宽;读失败退化空行防御保留)
- ui_page_runlog / ui_page_selftest:去 sys_log include,实例改不透明编号
- 两端薄包装适配层(编号→syslog_id_t 显式映射,错误码 0/-1/-2 直通不改写):
  App/task/ui_task.c 与 simulator/main.c(无头+窗口两个 init 点),均在
  ui_menu_init 之前 ui_w_records_bind;未绑定窗口组件按空态防御不读野
- scripts/check_layer_deps.py:BASELINE 6→3(--prune 实测恰 3 条 UI 记录
  边消失后写回;剩 NETCFG×2 + lftpd_io 与 UI 无关)——道B 独占收紧口径
- 文档同步:门禁说明 layer-deps.md §1/§6/§9 与 README 计数 6→3;
  UI_数据供给设计说明.md §7.2 加落地注记、§14"计划削减"改"已兑现"
- 首提被 id-check 拦下:注释/文档里自造"批卡编号"(B-6/道B-3)命中
  "未登记前缀"增量拦截——已全数改回 task-6/道B 普通指称(编号不回收、
  禁自造,教训入本提交);id-check 复跑 RC=0(S10 告警为存量非本改动)

验证:
- 模拟器 0 警告;菜单 8 状态 + 内容页 11 页黄金参考逐字节 PASS
  (记录页数据流经 reader 后像素与基线一致,无基线更新提交)
- cppcheck/coding-standard/bsp-err/font-charset/no-mojibake 单跑全绿;
  layer-deps 复跑:6 处反向 include = 豁免 3 / 基线内 3 / 新增 0,
  --prune 显示"基线无需收紧(3 条存量全部仍成立)"
- doc-links --all 的 35 处告警全为本仓检出路径含空格误扫 SDL2 自带 md
  (环境问题、非本改动引入;提交门禁按暂存文件名过滤不受影响)
- @build 0 Error 0 Warning(终树复跑 BUILD_OK);uvprojx 无 UV4 抖动、
  无新文件不涉注册;其余 38 钩全绿(ui-golden/font-charset/coding-standard/
  bsp-err/id-check/cppcheck…单跑复验 RC=0)

增量(A/B 同树 .map,基线 = 合入 c1b425d 后 HEAD):
- Flash:Code +104 B、RO +8 B(两端薄包装代码 + reader 函数表 const)
- RAM:RW +4 B(s_reader 指针)/ ZI +4 B(两页实例 struct 枚举改 uint8
  本应 -8 B,链接段对齐后净 +4 B);RW+ZI 合计 +8 B

gate: only mem-budget/mem-numbers pending lead ledger backfill
- pre-commit run --all-files 实测仅这两条失败(台账/RAM 文档 vs .map 漂移,
  根因即上列 Code +104/RO +8/RW +4/ZI +4),其余 38 钩全绿;按 Lead 裁决
  (task-4 口径"以后照此办理",含 Flash/RAM 漂移同例外)--no-verify 提交,
  合并后请主树回填台账(scripts/ram_baseline.py --write 由 Lead 侧执行)
- 手工自查通过:5 个 BOM 文件 BOM=EF BB BF 齐全、docs/py/main.c 保持无 BOM,
  全部 10 文件 CR=0、U+FFFD=0
- 台账增量供回填:Flash Code +104 B、RO +8 B;RAM RW +4 B、ZI +4 B
2026-10-25 05:21:05 +08:00

116 lines
6.0 KiB
C
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
/*
* 模块名称:UI 记录页共享组件(运行记录 / 自检记录两页的公共实现)
* 模块功能:把"定长记录 -> 每记录 2 行(偶数行时间戳、奇数行描述)+ 同记录读盘缓存
* + 空态单条伪行"这套逻辑收成一份,供多个日志页按实例复用;
* 数据经注入式 reader 回调取(UI_数据供给设计说明.md §7.2 契约),
* 本头**不含任何 App 头**——记录属主 sys_log 留在 App 侧,启动时由
* App/task/ui_task.c(MCU)与 simulator/main.c(PC)各注入一份薄包装
* 适用范围:Drivers/BSP/UI(仅 UI 层;分层方向由 check_layer_deps 门禁守护)
* 说明:缓存必须按实例存放而非文件级静态——两页共用代码但各有独立实例,
* 若共享缓存,从 A 页切到 B 页会命中上一记录号而显示另一页的陈旧行(静默错数据)。
* 作者:王建锋
* 创建日期:2026-10-20
* 修改记录:
* v1.0 2026-10-20 王建锋 创建(W6 U2:合并 ui_page_runlog / ui_page_selftest 的重复实现)
* v2.0 2026-10-25 王建锋 记录 reader 注入(道B task-6):删 #include "sys_log.h",
* 改 ui_rec_reader_t 函数表 + ui_w_records_bind();
* log_id 换不透明编号(UI_W_REC_LOG_*);缓冲容量宏本地化
* (与 sys_log 契约下限同宽,逐字节一致)
*/
#ifndef UI_W_RECORDS_H
#define UI_W_RECORDS_H
#ifdef __cplusplus
extern "C" {
#endif
#include <stdint.h>
/* 记录源不透明编号:UI 侧只认"0 号 / 1 号日志",App 侧适配层映射到 syslog_id_t
* (映射表见 App/task/ui_task.c 与 simulator/main.c 的绑定处;新增记录页 =
* 这里加编号 + 两端适配层各加一条映射) */
#define UI_W_REC_LOG_RUN 0u /* 0 号:运行记录(MCU /log/run.log) */
#define UI_W_REC_LOG_SELFTEST 1u /* 1 号:自检记录(MCU /log/selftest.log) */
/* 读取缓冲容量(UI 侧定义;必须 >= sys_log 契约下限:时间戳 19+NUL、描述 28+NUL。
* sys_log 侧 SYSLOG_TS_LEN/SYSLOG_DESC_MAX 变化时这里同步加宽——容量不足时
* reader 按契约返回负码、页面退化空行,不会读越界) */
#define UI_W_REC_TS_LEN 20u /* "YYYY-MM-DD HH:MM:SS" 19 + NUL */
#define UI_W_REC_DESC_LEN 29u /* 描述 28 + NUL */
/*
* 注入式记录 reader(只读函数表;契约 = UI_数据供给设计说明.md §7.2)
* 实现体在 App / 模拟器侧,uiTask 上下文同步调用——记录页绘制路径上的读盘
* 时序与合并前直调 syslog_* 完全一致,无新增并发面
*/
typedef struct {
/*
* 函数功能:取该日志当前记录条数
* 入口参数:log_id - 不透明记录源编号(UI_W_REC_LOG_*) uint8_t
* 返回值:记录条数(0 = 空态,页面显示伪行"无记录") uint16_t
*/
uint16_t (*count)(uint8_t a_log_id);
/*
* 函数功能:读第 idx 条记录(时间戳 + 描述两字段)
* 入口参数:log_id - 记录源编号 uint8_t
* idx - 记录序号(0 起) uint32_t
* ts - 时间戳缓冲 char *
* ts_len - ts 容量(>= UI_W_REC_TS_LEN) uint32_t
* desc - 描述缓冲 char *
* desc_len - desc 容量(>= UI_W_REC_DESC_LEN)uint32_t
* 返回值:0 = 成功;-1 = 序号/编号越界;-2 = 读失败
* (与 sys_log 契约同值,适配层直通不改码) int
*/
int (*get)(uint8_t a_log_id, uint32_t a_idx,
char *a_ts, uint32_t a_ts_len, char *a_desc, uint32_t a_desc_len);
} ui_rec_reader_t;
/*
* 记录页实例:记录源编号 + 该实例自己的读盘缓存
* 用法:页面文件里 static ui_w_records_t s_rec = { UI_W_REC_LOG_xxx };
* 其余字段自动清零,即"缓存初始无效",与合并前两页的行为一致。
*/
typedef struct {
uint8_t log_id; /* 记录源编号(UI_W_REC_LOG_*,透传给 reader) */
uint8_t cache_valid; /* 缓存有效标志(0 = 无缓存) */
uint32_t last_rec; /* 已缓存的记录序号 */
char ts[UI_W_REC_TS_LEN]; /* 时间戳缓存(含 NUL) */
char desc[UI_W_REC_DESC_LEN];/* 描述缓存(含 NUL) */
} ui_w_records_t;
/*
* 函数功能:注入记录 reader(启动时一次;NULL = 撤销注入,页面回到空态)
* 入口参数:reader - 只读函数表(生命周期由注入方保证,组件只存指针)
* const ui_rec_reader_t *
* 返回值:无
* 限定条件:uiTask 启动期注入(ui_menu_init 之前,UI_数据供给设计说明.md §7.2);
* 未注入时组件按"空态"渲染(伪行"无记录"),不崩不读野
* 函数说明:模块级单例——sys_log 读 API 本就是全局的,两端各只有一份实现;
* 两页共享函数表、独享各自的读盘缓存(缓存才是必须按实例存的那半)
*/
void ui_w_records_bind(const ui_rec_reader_t *a_reader);
/*
* 函数功能:总行数(动态;每条记录 2 行,空日志 = 单条伪行"无记录")
* 入口参数:a_inst - 记录页实例 ui_w_records_t *
* 返回值:总行数 uint16_t
*/
uint16_t ui_w_records_count(ui_w_records_t *a_inst);
/*
* 函数功能:逐行取数(偶数行 = 时间戳、奇数行 = 描述;值列恒空)
* 入口参数:a_inst - 记录页实例 ui_w_records_t *
* a_row - 全局行下标 uint16_t
* a_name - 名输出缓冲(框架栈缓冲 UI_BUF_STRLEN=32,含 NUL) char *
* a_value- 值输出缓冲(同上;本组件恒写空串) char *
* 限定条件:页面打开中(框架绘制/按键上下文,uiTask)
*/
void ui_w_records_refresh(ui_w_records_t *a_inst, uint16_t a_row, char *a_name, char *a_value);
#ifdef __cplusplus
}
#endif
#endif /* UI_W_RECORDS_H */