dsh-stm32 0.1.0 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +127 -29
- package/README_EN.md +125 -29
- package/client/client.js +682 -0
- package/docs/development-notes.md +1385 -5
- package/docs/logic-audit.md +607 -0
- package/docs/reading-guide.md +738 -0
- package/lib/client.js +682 -0
- package/lib/commands/register.js +214 -12
- package/lib/data/chips.js +134 -4
- package/lib/data/clock-f1.js +158 -0
- package/lib/data/cmsis-sources.js +316 -0
- package/lib/data/f1-ram.generated.js +34 -0
- package/lib/data/firmware-packages.js +352 -0
- package/lib/data/install-guides.js +190 -0
- package/lib/data/search-roots.js +135 -15
- package/lib/data/stm32f1.js +186 -0
- package/lib/data/toolchain-config.js +310 -0
- package/lib/engine/build.js +121 -16
- package/lib/engine/cache.js +336 -0
- package/lib/engine/clock-plan.js +608 -0
- package/lib/engine/cmake-sources.js +428 -0
- package/lib/engine/code-patch.js +18 -6
- package/lib/engine/debug-session.js +163 -4
- package/lib/engine/debug.js +84 -19
- package/lib/engine/doctor.js +395 -4
- package/lib/engine/fetch.js +287 -0
- package/lib/engine/firmware-install.js +668 -0
- package/lib/engine/flash.js +145 -15
- package/lib/engine/fs-longpath.js +107 -0
- package/lib/engine/generate-cache.js +118 -0
- package/lib/engine/generate-script.js +30 -8
- package/lib/engine/generate.js +296 -14
- package/lib/engine/hal-chip.js +230 -0
- package/lib/engine/ioc-plan.js +47 -8
- package/lib/engine/msys2-install.js +1870 -0
- package/lib/engine/probe.js +57 -6
- package/lib/engine/project-export.js +129 -0
- package/lib/engine/register-clock.js +132 -0
- package/lib/engine/register-linker.js +129 -0
- package/lib/engine/register-template.js +449 -0
- package/lib/engine/regs.js +18 -4
- package/lib/engine/route-plan.js +553 -0
- package/lib/engine/scaffold.js +303 -72
- package/lib/engine/subprocess-runner.js +2 -0
- package/lib/engine/tar.js +250 -0
- package/lib/engine/text-file.js +150 -0
- package/lib/engine/thirdparty.js +243 -0
- package/lib/engine/tool-env.js +51 -0
- package/lib/engine/toolchain-gate.js +386 -0
- package/lib/engine/vscode-config.js +99 -0
- package/lib/engine/web-api.js +375 -0
- package/lib/engine/web-routes.js +100 -0
- package/lib/engine/xcube-catalog.js +102 -0
- package/lib/engine/xcube.js +254 -0
- package/lib/engine/zip.js +142 -0
- package/lib/index.js +44 -2
- package/lib/skill/stm32-workflow.js +3 -3
- package/lib/tools/build.js +55 -3
- package/lib/tools/cache.js +250 -0
- package/lib/tools/code-patch.js +29 -2
- package/lib/tools/debug-session.js +56 -14
- package/lib/tools/debug.js +43 -2
- package/lib/tools/doctor.js +16 -3
- package/lib/tools/env-install.js +472 -0
- package/lib/tools/env-probe.js +6 -2
- package/lib/tools/firmware-install.js +255 -0
- package/lib/tools/flash.js +41 -2
- package/lib/tools/generate.js +96 -10
- package/lib/tools/ioc-apply.js +27 -11
- package/lib/tools/ioc-inspect.js +4 -2
- package/lib/tools/ioc-plan.js +209 -11
- package/lib/tools/project-create.js +229 -21
- package/lib/tools/project-dir.js +95 -0
- package/lib/tools/project-export.js +100 -0
- package/lib/tools/regs.js +82 -7
- package/lib/tools/route-plan.js +467 -0
- package/package.json +11 -4
- package/templates/register/CMakeLists.txt +52 -0
- package/templates/register/Core/Src/main.c +72 -0
- package/templates/scaffold/openocd.cfg +8 -0
- package/templates/scaffold/vscode/launch.json +8 -6
- package/templates/scaffold/vscode/settings.json +5 -11
|
@@ -0,0 +1,250 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 最小的 tar.gz 解包器(只用 node:zlib,不依赖系统 tar.exe)。
|
|
3
|
+
*
|
|
4
|
+
* 为什么自己解:固件包要从 GitHub 拉两个子模块仓库的 tar.gz,机器上不保证有 tar
|
|
5
|
+
* (Windows 10 1803 之前没有,busybox 环境也没有)。node:zlib 一定有,且解包过程
|
|
6
|
+
* 可以在单测里用内存里造的 tar.gz 完整验证 —— 调外部命令就做不到这一点。
|
|
7
|
+
*
|
|
8
|
+
* 只支持 GitHub codeload 真正会发出的那几种条目:常规文件、目录(ustar 前缀)、
|
|
9
|
+
* pax 扩展头(x/g)与 GNU 长名(L/K)。符号链接、硬链接、设备、FIFO 一律不落盘,
|
|
10
|
+
* 只记进 skipped / skippedPaths —— 它们本来没有数据,写成 0 字节文件会被当成解包成功。
|
|
11
|
+
*/
|
|
12
|
+
import { mkdirSync, writeFileSync } from "node:fs";
|
|
13
|
+
import path from "node:path";
|
|
14
|
+
import { gunzipSync } from "node:zlib";
|
|
15
|
+
const BLOCK = 512;
|
|
16
|
+
const DEFAULT_MAX_BYTES = 512 * 1024 * 1024;
|
|
17
|
+
function readString(buffer, offset, length) {
|
|
18
|
+
const slice = buffer.subarray(offset, offset + length);
|
|
19
|
+
const end = slice.indexOf(0);
|
|
20
|
+
return (end === -1 ? slice : slice.subarray(0, end)).toString("utf8");
|
|
21
|
+
}
|
|
22
|
+
function readOctal(buffer, offset, length) {
|
|
23
|
+
const text = readString(buffer, offset, length).trim();
|
|
24
|
+
if (text === "")
|
|
25
|
+
return 0;
|
|
26
|
+
const value = Number.parseInt(text, 8);
|
|
27
|
+
return Number.isFinite(value) ? value : 0;
|
|
28
|
+
}
|
|
29
|
+
function isZeroBlock(block) {
|
|
30
|
+
for (let index = 0; index < block.length; index += 1) {
|
|
31
|
+
if (block[index] !== 0)
|
|
32
|
+
return false;
|
|
33
|
+
}
|
|
34
|
+
return true;
|
|
35
|
+
}
|
|
36
|
+
/** pax 扩展头:一串 长度 键=值 换行 记录。 */
|
|
37
|
+
function parsePax(data) {
|
|
38
|
+
const fields = new Map();
|
|
39
|
+
let offset = 0;
|
|
40
|
+
while (offset < data.length) {
|
|
41
|
+
const space = data.indexOf(0x20, offset);
|
|
42
|
+
if (space === -1)
|
|
43
|
+
break;
|
|
44
|
+
const length = Number.parseInt(data.subarray(offset, space).toString("utf8"), 10);
|
|
45
|
+
if (!Number.isFinite(length) || length <= 0)
|
|
46
|
+
break;
|
|
47
|
+
const record = data.subarray(space + 1, offset + length - 1).toString("utf8");
|
|
48
|
+
const equals = record.indexOf("=");
|
|
49
|
+
if (equals > 0)
|
|
50
|
+
fields.set(record.slice(0, equals), record.slice(equals + 1));
|
|
51
|
+
offset += length;
|
|
52
|
+
}
|
|
53
|
+
return fields;
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* 条目类型白名单:只有常规文件(0 / NUL / 空)与目录(5)会落盘,
|
|
57
|
+
* 其余(1 硬链接、2 符号链接、3/4 设备、6 FIFO、7 连续文件及其他未知类型)一律跳过。
|
|
58
|
+
*/
|
|
59
|
+
function entryKind(typeflag, fullName) {
|
|
60
|
+
if (typeflag === "5")
|
|
61
|
+
return "dir";
|
|
62
|
+
if (typeflag === "0" || typeflag === "\u0000" || typeflag === "") {
|
|
63
|
+
return fullName.endsWith("/") ? "dir" : "file";
|
|
64
|
+
}
|
|
65
|
+
return "other";
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* 相对路径安全检查:绝对路径、盘符、反斜杠、冒号、以及任何 . / .. 分段一律拒绝。
|
|
69
|
+
*
|
|
70
|
+
* 反斜杠必须单独挡:Windows 上 path.join 把 "\\" 当分隔符,条目名 "a\\..\\..\\x"
|
|
71
|
+
* 按 "/" 切分只是一段、不满足「分段等于 ..」的旧判定,规范化之后却能跳出目标目录。
|
|
72
|
+
*/
|
|
73
|
+
function isSafeRelative(rel) {
|
|
74
|
+
if (rel === "")
|
|
75
|
+
return false;
|
|
76
|
+
if (rel.includes("\\"))
|
|
77
|
+
return false;
|
|
78
|
+
if (rel.includes(":"))
|
|
79
|
+
return false;
|
|
80
|
+
if (rel.startsWith("/"))
|
|
81
|
+
return false;
|
|
82
|
+
const parts = rel.split("/");
|
|
83
|
+
return parts.every((part) => part !== "" && part !== "." && part !== "..");
|
|
84
|
+
}
|
|
85
|
+
function joinSafe(destRoot, rel) {
|
|
86
|
+
return path.join(destRoot, ...rel.split("/"));
|
|
87
|
+
}
|
|
88
|
+
/**
|
|
89
|
+
* 解包 tar.gz 到 destRoot。
|
|
90
|
+
*
|
|
91
|
+
* 只写 destRoot 内部:任何带上跳、绝对路径或反斜杠的条目都算坏包,整次失败(不部分成功),
|
|
92
|
+
* 这样调用方不会留下一个看起来解完了的半成品目录。
|
|
93
|
+
*/
|
|
94
|
+
export function extractTarGz(archive, destRoot, options = {}) {
|
|
95
|
+
const strip = Math.max(0, options.stripComponents ?? 0);
|
|
96
|
+
const maxBytes = options.maxBytes ?? DEFAULT_MAX_BYTES;
|
|
97
|
+
const mapPath = options.mapPath ?? ((rel) => rel);
|
|
98
|
+
const files = [];
|
|
99
|
+
const skippedPaths = [];
|
|
100
|
+
let skipped = 0;
|
|
101
|
+
let totalBytes = 0;
|
|
102
|
+
let pendingPath = "";
|
|
103
|
+
let pendingSize = 0;
|
|
104
|
+
// gzip 魔数先做显式检查(A32):代理/门户返回的 HTML 也能让 gunzip 抛错,
|
|
105
|
+
// 但直接拿魔数说"这不是 tar.gz"比把 zlib 的报错原文抛给用户更清楚,也挡住"空文件当成功"。
|
|
106
|
+
if (archive.length < 2 || archive[0] !== 0x1f || archive[1] !== 0x8b) {
|
|
107
|
+
return {
|
|
108
|
+
ok: false,
|
|
109
|
+
files,
|
|
110
|
+
totalBytes: 0,
|
|
111
|
+
skipped: 0,
|
|
112
|
+
skippedPaths: [],
|
|
113
|
+
error: "这不是合法的 tar.gz(前两个字节不是 gzip 魔数 1f 8b,多半是下载到了网页或错误页)",
|
|
114
|
+
};
|
|
115
|
+
}
|
|
116
|
+
let raw;
|
|
117
|
+
try {
|
|
118
|
+
raw = gunzipSync(archive);
|
|
119
|
+
}
|
|
120
|
+
catch (error) {
|
|
121
|
+
const message = error instanceof Error ? error.message : String(error);
|
|
122
|
+
return { ok: false, files, totalBytes: 0, skipped: 0, skippedPaths: [], error: "这不是合法的 tar.gz(" + message + ")" };
|
|
123
|
+
}
|
|
124
|
+
if (raw.length === 0) {
|
|
125
|
+
return { ok: false, files, totalBytes: 0, skipped: 0, skippedPaths: [], error: "解包结果是空归档(0 字节),不当作成功" };
|
|
126
|
+
}
|
|
127
|
+
// 两遍:先把所有条目校验完(路径安全 + 总量上限),全部通过才落盘。
|
|
128
|
+
// 否则踩到坏条目时前面已经写了一堆文件,调用方会留下一个看起来解完了的半成品目录。
|
|
129
|
+
const planned = [];
|
|
130
|
+
let offset = 0;
|
|
131
|
+
while (offset + BLOCK <= raw.length) {
|
|
132
|
+
const header = raw.subarray(offset, offset + BLOCK);
|
|
133
|
+
if (isZeroBlock(header))
|
|
134
|
+
break;
|
|
135
|
+
const name = readString(header, 0, 100);
|
|
136
|
+
const sizeField = readOctal(header, 124, 12);
|
|
137
|
+
const typeflag = String.fromCharCode(header[156] ?? 48);
|
|
138
|
+
const prefix = readString(header, 345, 155);
|
|
139
|
+
const dataStart = offset + BLOCK;
|
|
140
|
+
const dataEnd = dataStart + sizeField;
|
|
141
|
+
const data = raw.subarray(dataStart, Math.min(dataEnd, raw.length));
|
|
142
|
+
const padded = dataStart + Math.ceil(sizeField / BLOCK) * BLOCK;
|
|
143
|
+
if (typeflag === "x") {
|
|
144
|
+
const fields = parsePax(data);
|
|
145
|
+
pendingPath = fields.get("path") ?? "";
|
|
146
|
+
pendingSize = Number.parseInt(fields.get("size") ?? "0", 10);
|
|
147
|
+
offset = padded;
|
|
148
|
+
continue;
|
|
149
|
+
}
|
|
150
|
+
if (typeflag === "g") {
|
|
151
|
+
offset = padded;
|
|
152
|
+
continue;
|
|
153
|
+
}
|
|
154
|
+
if (typeflag === "L") {
|
|
155
|
+
// GNU 长文件名:数据就是下一个条目的完整名字。
|
|
156
|
+
pendingPath = data.toString("utf8").replace(/\u0000+$/u, "");
|
|
157
|
+
offset = padded;
|
|
158
|
+
continue;
|
|
159
|
+
}
|
|
160
|
+
if (typeflag === "K") {
|
|
161
|
+
// GNU 长链接名:数据是下一个条目的 linkname,条目本身不是普通文件,会在下面被跳过。
|
|
162
|
+
offset = padded;
|
|
163
|
+
continue;
|
|
164
|
+
}
|
|
165
|
+
let fullName = prefix === "" ? name : prefix + "/" + name;
|
|
166
|
+
let size = sizeField;
|
|
167
|
+
if (pendingPath !== "") {
|
|
168
|
+
fullName = pendingPath;
|
|
169
|
+
if (pendingSize > 0)
|
|
170
|
+
size = pendingSize;
|
|
171
|
+
pendingPath = "";
|
|
172
|
+
pendingSize = 0;
|
|
173
|
+
}
|
|
174
|
+
offset = padded;
|
|
175
|
+
// 声明的大小超出实际数据 = 包被截断;宁可整次失败,也不要写出半截文件当成功。
|
|
176
|
+
if (dataStart + size > raw.length) {
|
|
177
|
+
return {
|
|
178
|
+
ok: false,
|
|
179
|
+
files,
|
|
180
|
+
totalBytes,
|
|
181
|
+
skipped,
|
|
182
|
+
skippedPaths,
|
|
183
|
+
error: "压缩包在「" + fullName + "」处被截断(声明 " + String(size) + " 字节),已中止解包",
|
|
184
|
+
};
|
|
185
|
+
}
|
|
186
|
+
const parts = fullName.split("/").filter((part) => part !== "" && part !== ".");
|
|
187
|
+
const rel = parts.slice(Math.min(strip, parts.length)).join("/");
|
|
188
|
+
const kind = entryKind(typeflag, fullName);
|
|
189
|
+
if (kind === "other") {
|
|
190
|
+
skipped += 1;
|
|
191
|
+
skippedPaths.push(rel === "" ? fullName : rel);
|
|
192
|
+
continue;
|
|
193
|
+
}
|
|
194
|
+
if (rel === "") {
|
|
195
|
+
skipped += 1;
|
|
196
|
+
continue;
|
|
197
|
+
}
|
|
198
|
+
const mapped = mapPath(rel);
|
|
199
|
+
if (mapped === null) {
|
|
200
|
+
skipped += 1;
|
|
201
|
+
skippedPaths.push(rel);
|
|
202
|
+
continue;
|
|
203
|
+
}
|
|
204
|
+
// 目录条目本身不落盘(有文件落进来时 mkdir 会自己建)。
|
|
205
|
+
if (kind === "dir")
|
|
206
|
+
continue;
|
|
207
|
+
if (!isSafeRelative(mapped)) {
|
|
208
|
+
return {
|
|
209
|
+
ok: false,
|
|
210
|
+
files,
|
|
211
|
+
totalBytes,
|
|
212
|
+
skipped,
|
|
213
|
+
skippedPaths,
|
|
214
|
+
error: "压缩包里有可疑路径(" + mapped + "),已中止解包",
|
|
215
|
+
};
|
|
216
|
+
}
|
|
217
|
+
totalBytes += data.length;
|
|
218
|
+
if (totalBytes > maxBytes) {
|
|
219
|
+
return {
|
|
220
|
+
ok: false,
|
|
221
|
+
files,
|
|
222
|
+
totalBytes,
|
|
223
|
+
skipped,
|
|
224
|
+
skippedPaths,
|
|
225
|
+
error: "解包后超过 " + String(Math.round(maxBytes / 1024 / 1024)) + " MiB,已中止(防止压缩炸弹)",
|
|
226
|
+
};
|
|
227
|
+
}
|
|
228
|
+
planned.push({ mapped, data });
|
|
229
|
+
}
|
|
230
|
+
// 0 个可落盘条目也不是成功:上游仓改布局、proxy 页面骗过魔数、mapPath 把条目全过滤掉,
|
|
231
|
+
// 都会走到这里。返回 ok:true 会让上层把空目录当"装好了"。
|
|
232
|
+
if (planned.length === 0) {
|
|
233
|
+
return {
|
|
234
|
+
ok: false,
|
|
235
|
+
files,
|
|
236
|
+
totalBytes,
|
|
237
|
+
skipped,
|
|
238
|
+
skippedPaths,
|
|
239
|
+
error: "压缩包里没有可落盘的文件(" + String(skipped) + " 个条目被跳过),不当作成功",
|
|
240
|
+
};
|
|
241
|
+
}
|
|
242
|
+
mkdirSync(destRoot, { recursive: true });
|
|
243
|
+
for (const item of planned) {
|
|
244
|
+
const dest = joinSafe(destRoot, item.mapped);
|
|
245
|
+
mkdirSync(path.dirname(dest), { recursive: true });
|
|
246
|
+
writeFileSync(dest, item.data);
|
|
247
|
+
files.push({ path: item.mapped, bytes: item.data.length });
|
|
248
|
+
}
|
|
249
|
+
return { ok: true, files, totalBytes, skipped, skippedPaths, error: "" };
|
|
250
|
+
}
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 文本文件编码探测与「同编码写回」。
|
|
3
|
+
*
|
|
4
|
+
* 为什么需要:STM32 的 C 源码在国内经常是被 Keil 编辑过的 GB18030/GBK 文件。
|
|
5
|
+
* 以前 code_patch 用 readFileSync(path, "utf8") 读、writeFileSync(path, text, "utf8") 写,
|
|
6
|
+
* 一次补丁就会把用户的中文注释永久变成替换符(审计 B2)。这里把「怎么读、怎么按原编码写回」
|
|
7
|
+
* 收成一处,所有写用户源码的地方都走它。
|
|
8
|
+
*
|
|
9
|
+
* 写回策略:
|
|
10
|
+
* - UTF-8 / UTF-8 BOM:整份按 UTF-8 写回,BOM 原样保留(BOM 在字节层不动,见 replaceLineRange)。
|
|
11
|
+
* - GB18030:Node 只有解码器、没有编码器(TextEncoder 仅支持 UTF-8),所以不做整份重编码,
|
|
12
|
+
* 而是按行做**字节级拼接**:没改到的行原字节照抄,只把新增的行按 ASCII 编码插入。
|
|
13
|
+
* 新增内容含非 ASCII 时直接拒绝(宁可让调用方报错,也不把中文写坏)。
|
|
14
|
+
* - 识别不出来:一律拒绝改写。
|
|
15
|
+
*/
|
|
16
|
+
import fs from "node:fs";
|
|
17
|
+
const BOM_UTF8 = [0xef, 0xbb, 0xbf];
|
|
18
|
+
function decodesStrictly(buffer, label) {
|
|
19
|
+
try {
|
|
20
|
+
new TextDecoder(label, { fatal: true }).decode(buffer);
|
|
21
|
+
return true;
|
|
22
|
+
}
|
|
23
|
+
catch {
|
|
24
|
+
return false;
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
/** 探测顺序:BOM → 严格 UTF-8 → 严格 GB18030 → 认不出。 */
|
|
28
|
+
export function detectEncoding(buffer) {
|
|
29
|
+
if (buffer.length >= 3 && buffer[0] === BOM_UTF8[0] && buffer[1] === BOM_UTF8[1] && buffer[2] === BOM_UTF8[2]) {
|
|
30
|
+
return "utf8-bom";
|
|
31
|
+
}
|
|
32
|
+
if (buffer.length === 0)
|
|
33
|
+
return "utf8";
|
|
34
|
+
if (decodesStrictly(buffer, "utf-8"))
|
|
35
|
+
return "utf8";
|
|
36
|
+
if (decodesStrictly(buffer, "gb18030"))
|
|
37
|
+
return "gb18030";
|
|
38
|
+
return "unknown";
|
|
39
|
+
}
|
|
40
|
+
export function describeEncoding(encoding) {
|
|
41
|
+
if (encoding === "utf8")
|
|
42
|
+
return "UTF-8";
|
|
43
|
+
if (encoding === "utf8-bom")
|
|
44
|
+
return "UTF-8(带 BOM)";
|
|
45
|
+
if (encoding === "gb18030")
|
|
46
|
+
return "GB18030/GBK";
|
|
47
|
+
return "认不出";
|
|
48
|
+
}
|
|
49
|
+
/** 把字节解码成文本;utf8-bom 会去掉 BOM(写回时 BOM 在字节层保留)。 */
|
|
50
|
+
export function decodeText(buffer, encoding) {
|
|
51
|
+
if (encoding === "utf8-bom")
|
|
52
|
+
return buffer.subarray(3).toString("utf8");
|
|
53
|
+
if (encoding === "utf8")
|
|
54
|
+
return buffer.toString("utf8");
|
|
55
|
+
if (encoding === "gb18030") {
|
|
56
|
+
try {
|
|
57
|
+
return new TextDecoder("gb18030").decode(buffer);
|
|
58
|
+
}
|
|
59
|
+
catch {
|
|
60
|
+
return "";
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
return "";
|
|
64
|
+
}
|
|
65
|
+
export function isAscii(text) {
|
|
66
|
+
for (const ch of text) {
|
|
67
|
+
if (ch.codePointAt(0) !== undefined && ch.codePointAt(0) > 0x7f)
|
|
68
|
+
return false;
|
|
69
|
+
}
|
|
70
|
+
return true;
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* 把「要新写进文件的文本」按目标编码编成字节。
|
|
74
|
+
* GB18030 只允许纯 ASCII(Node 没有 GB18030 编码器,非 ASCII 无法无损写出)。
|
|
75
|
+
*/
|
|
76
|
+
export function encodeText(text, encoding) {
|
|
77
|
+
if (encoding === "utf8" || encoding === "utf8-bom") {
|
|
78
|
+
return { ok: true, bytes: Buffer.from(text, "utf8"), error: "" };
|
|
79
|
+
}
|
|
80
|
+
if (encoding === "gb18030") {
|
|
81
|
+
if (!isAscii(text)) {
|
|
82
|
+
return {
|
|
83
|
+
ok: false,
|
|
84
|
+
bytes: Buffer.alloc(0),
|
|
85
|
+
error: "这个文件是 GB18030/GBK 编码,而要写入的内容含非 ASCII 字符:Node 只有 GB18030 解码器、没有编码器,写出去会变成乱码或替换符,所以拒绝写入。请先把文件转成 UTF-8(VS Code 右下角编码 → 通过编码保存 → UTF-8),或把要写入的代码改成英文/纯 ASCII。",
|
|
86
|
+
};
|
|
87
|
+
}
|
|
88
|
+
return { ok: true, bytes: Buffer.from(text, "latin1"), error: "" };
|
|
89
|
+
}
|
|
90
|
+
return {
|
|
91
|
+
ok: false,
|
|
92
|
+
bytes: Buffer.alloc(0),
|
|
93
|
+
error: "这个文件的编码认不出来(既不是 UTF-8 也不是 GB18030),为避免写坏不做改动。",
|
|
94
|
+
};
|
|
95
|
+
}
|
|
96
|
+
export function readTextFile(absPath) {
|
|
97
|
+
let buffer;
|
|
98
|
+
try {
|
|
99
|
+
buffer = fs.readFileSync(absPath);
|
|
100
|
+
}
|
|
101
|
+
catch (error) {
|
|
102
|
+
const message = error instanceof Error ? error.message : String(error);
|
|
103
|
+
return { ok: false, text: "", encoding: "unknown", eol: "\n", bytes: 0, error: "读不了文件:" + message };
|
|
104
|
+
}
|
|
105
|
+
const encoding = detectEncoding(buffer);
|
|
106
|
+
if (encoding === "unknown") {
|
|
107
|
+
return {
|
|
108
|
+
ok: false,
|
|
109
|
+
text: "",
|
|
110
|
+
encoding,
|
|
111
|
+
eol: "\n",
|
|
112
|
+
bytes: buffer.length,
|
|
113
|
+
error: "这个文件的编码认不出来(既不是 UTF-8 也不是 GB18030),为避免写坏不做改动。",
|
|
114
|
+
};
|
|
115
|
+
}
|
|
116
|
+
const text = decodeText(buffer, encoding);
|
|
117
|
+
return { ok: true, text, encoding, eol: text.includes("\r\n") ? "\r\n" : "\n", bytes: buffer.length, error: "" };
|
|
118
|
+
}
|
|
119
|
+
/** 每个逻辑行(\n 分隔,与 text.split(/\r?\n/) 的行号一一对应)的起始字节偏移。 */
|
|
120
|
+
export function lineStarts(buffer) {
|
|
121
|
+
const starts = [0];
|
|
122
|
+
for (let index = 0; index < buffer.length; index += 1) {
|
|
123
|
+
if (buffer[index] === 0x0a)
|
|
124
|
+
starts.push(index + 1);
|
|
125
|
+
}
|
|
126
|
+
return starts;
|
|
127
|
+
}
|
|
128
|
+
/**
|
|
129
|
+
* 用「新行」替换 [startLine, endLine) 这些逻辑行,其余字节原样保留。
|
|
130
|
+
*
|
|
131
|
+
* startLine 是块内第一行的行号、endLine 是 END 行的行号时,正好是「替换 USER CODE 块内容」;
|
|
132
|
+
* startLine === endLine 时就是「在那一行之前插入」。
|
|
133
|
+
*/
|
|
134
|
+
export function replaceLineRange(original, startLine, endLine, newLines, eol, encoding) {
|
|
135
|
+
const starts = lineStarts(original);
|
|
136
|
+
const prefixEnd = starts[startLine] ?? original.length;
|
|
137
|
+
const suffixStart = starts[endLine] ?? original.length;
|
|
138
|
+
if (suffixStart < prefixEnd) {
|
|
139
|
+
return { ok: false, bytes: Buffer.alloc(0), error: "行范围不合法(endLine 在 startLine 之前)" };
|
|
140
|
+
}
|
|
141
|
+
const head = original.subarray(0, prefixEnd);
|
|
142
|
+
const tail = original.subarray(suffixStart);
|
|
143
|
+
if (newLines.length === 0) {
|
|
144
|
+
return { ok: true, bytes: Buffer.concat([head, tail]), error: "" };
|
|
145
|
+
}
|
|
146
|
+
const body = encodeText(newLines.join(eol), encoding);
|
|
147
|
+
if (!body.ok)
|
|
148
|
+
return body;
|
|
149
|
+
return { ok: true, bytes: Buffer.concat([head, body.bytes, Buffer.from(eol, "utf8"), tail]), error: "" };
|
|
150
|
+
}
|
|
@@ -0,0 +1,243 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* L1:第三方包索引(thirdparties/pdsc)的按需停放与「要不要加载」的判定。
|
|
3
|
+
*
|
|
4
|
+
* 背景(实测,见 docs/development-notes.md):
|
|
5
|
+
* CubeMX 每次无头启动都会扫 ~/.stm32cubemx/thirdparties/pdsc 里的 159 个 X-CUBE 包索引
|
|
6
|
+
* (11.6 MB),并在 change project 时再枚举一遍,纯 HAL 工程白花约 25 s
|
|
7
|
+
* (155.6 s → 130.3 s),产物字节完全一致(整树 sha256 相同)。
|
|
8
|
+
*
|
|
9
|
+
* 判定不靠猜关键词,而是靠包目录(src/engine/xcube-catalog.ts,由 CubeMX 的 pdsc 目录生成):
|
|
10
|
+
* Mcu.ThirdPartyNb=<n> / Mcu.ThirdParty0=STMicroelectronics.X-CUBE-ALGOBUILD.1.4.0
|
|
11
|
+
* 解析成 <vendor>.<pack>[.<version>],再跟本机索引对一遍 —— 既知道要不要索引,也知道本机有没有这个包。
|
|
12
|
+
*
|
|
13
|
+
* 保守原则:判断不了就保留(多花的 25 s 可以接受,漏加载包可能生成错代码)。
|
|
14
|
+
*/
|
|
15
|
+
import { existsSync, readdirSync, renameSync, rmdirSync } from "node:fs";
|
|
16
|
+
import { join } from "node:path";
|
|
17
|
+
import { describePack, listInstalledPacks, scanIocPacks, summarizePacks } from "./xcube.js";
|
|
18
|
+
/** 停放后的目录名(与 pdsc 同级)。 */
|
|
19
|
+
export const PARKED_NAME = "pdsc.dsh-parked";
|
|
20
|
+
function packWarnings(packs, pdscDir, installed) {
|
|
21
|
+
if (pdscDir === undefined)
|
|
22
|
+
return [];
|
|
23
|
+
if (installed === null) {
|
|
24
|
+
return ["读不到本机第三方包索引目录(" + pdscDir + "),没法判断工程要的包在不在本机"];
|
|
25
|
+
}
|
|
26
|
+
const out = [];
|
|
27
|
+
for (const pack of packs) {
|
|
28
|
+
if (pack.installed === "missing") {
|
|
29
|
+
out.push("工程要用 " + describePack(pack) +
|
|
30
|
+
",但本机第三方包索引里没有这个包(先在 CubeMX 的 Manage embedded software packages 里装上它,否则生成会报缺包):" +
|
|
31
|
+
pdscDir);
|
|
32
|
+
}
|
|
33
|
+
else if (pack.installed === "other-version") {
|
|
34
|
+
out.push("工程要用 " + describePack(pack) +
|
|
35
|
+
",本机索引里只有 " + pack.installedVersions.join("、") +
|
|
36
|
+
"(CubeMX 会按可用版本处理,必要时在它里面 Migrate)");
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
return out;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* 从 .ioc 正文判断本次生成要不要第三方包索引。
|
|
43
|
+
*
|
|
44
|
+
* 判定顺序:
|
|
45
|
+
* Mcu.ThirdPartyNb > 0 → 需要(并列出包名与本机安装情况)
|
|
46
|
+
* 正文里引用了目录里的包 → 需要(.ioc 没写 Nb 但确实用了包)
|
|
47
|
+
* 正文里出现目录里的包名(无 vendor)→ 需要(认不全,保守)
|
|
48
|
+
* Mcu.ThirdParty 行解析不了 → 需要(保守)
|
|
49
|
+
* Mcu.ThirdPartyNb = 0 且无包证据 → 不需要(可以停放,省约 25 s)
|
|
50
|
+
* 没有 Mcu.ThirdPartyNb 且无证据 → 需要(手写/旧版 .ioc,保守)
|
|
51
|
+
*/
|
|
52
|
+
export function needsThirdpartyPacks(iocText, options = {}) {
|
|
53
|
+
const pdscDir = options.pdscDir;
|
|
54
|
+
const installed = pdscDir === undefined ? null : listInstalledPacks(pdscDir);
|
|
55
|
+
const scan = scanIocPacks(iocText, { installed });
|
|
56
|
+
const evidence = [];
|
|
57
|
+
const push = (line) => {
|
|
58
|
+
if (evidence.length >= 3 || evidence.includes(line))
|
|
59
|
+
return;
|
|
60
|
+
evidence.push(line);
|
|
61
|
+
};
|
|
62
|
+
if (scan.nbLine !== null)
|
|
63
|
+
push(scan.nbLine);
|
|
64
|
+
for (const pack of scan.packs)
|
|
65
|
+
push(pack.raw);
|
|
66
|
+
for (const marker of scan.markers)
|
|
67
|
+
push(marker);
|
|
68
|
+
for (const bad of scan.malformed)
|
|
69
|
+
push(bad);
|
|
70
|
+
const warnings = packWarnings(scan.packs, pdscDir, installed);
|
|
71
|
+
const listed = summarizePacks(scan.packs);
|
|
72
|
+
const count = scan.thirdPartyNb;
|
|
73
|
+
if (count !== null && count > 0) {
|
|
74
|
+
return {
|
|
75
|
+
needed: true,
|
|
76
|
+
reason: "工程声明了 " + String(count) + " 个第三方包" + (listed === "" ? "" : "(" + listed + ")"),
|
|
77
|
+
evidence,
|
|
78
|
+
packs: scan.packs,
|
|
79
|
+
warnings,
|
|
80
|
+
};
|
|
81
|
+
}
|
|
82
|
+
if (scan.packs.length > 0) {
|
|
83
|
+
return {
|
|
84
|
+
needed: true,
|
|
85
|
+
reason: ".ioc 里引用了第三方包(" + listed + ")" +
|
|
86
|
+
(count === 0 ? ",但 Mcu.ThirdPartyNb=0(两处对不上,保守保留索引)" : ""),
|
|
87
|
+
evidence,
|
|
88
|
+
packs: scan.packs,
|
|
89
|
+
warnings,
|
|
90
|
+
};
|
|
91
|
+
}
|
|
92
|
+
if (scan.markers.length > 0) {
|
|
93
|
+
return { needed: true, reason: ".ioc 里出现了第三方包标记(X-CUBE/I-CUBE 等)", evidence, packs: [], warnings };
|
|
94
|
+
}
|
|
95
|
+
if (scan.malformed.length > 0) {
|
|
96
|
+
return { needed: true, reason: ".ioc 里有解析不了的 Mcu.ThirdParty 行,保守保留索引", evidence, packs: [], warnings };
|
|
97
|
+
}
|
|
98
|
+
if (count === 0) {
|
|
99
|
+
return { needed: false, reason: "工程没有第三方包(Mcu.ThirdPartyNb=0),本次生成不需要包索引", evidence: [], packs: [], warnings: [] };
|
|
100
|
+
}
|
|
101
|
+
return {
|
|
102
|
+
needed: true,
|
|
103
|
+
reason: ".ioc 里没有 Mcu.ThirdPartyNb,无法确认是否用第三方包,保守保留",
|
|
104
|
+
evidence: [],
|
|
105
|
+
packs: [],
|
|
106
|
+
warnings: [],
|
|
107
|
+
};
|
|
108
|
+
}
|
|
109
|
+
/** CubeMX 的用户级目录(~/.stm32cubemx)。显式 STM32CUBEMX_HOME 优先,便于测试与多机。 */
|
|
110
|
+
export function cubeMxUserHome(env) {
|
|
111
|
+
const explicit = env.STM32CUBEMX_HOME;
|
|
112
|
+
if (explicit !== undefined && explicit.trim() !== "")
|
|
113
|
+
return explicit.trim().replace(/\\/gu, "/");
|
|
114
|
+
const base = env.USERPROFILE ?? env.HOME;
|
|
115
|
+
if (base === undefined || base.trim() === "")
|
|
116
|
+
return null;
|
|
117
|
+
return base.trim().replace(/\\/gu, "/") + "/.stm32cubemx";
|
|
118
|
+
}
|
|
119
|
+
function dirIsEmpty(dir) {
|
|
120
|
+
try {
|
|
121
|
+
return readdirSync(dir).length === 0;
|
|
122
|
+
}
|
|
123
|
+
catch {
|
|
124
|
+
return false;
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* B11:把停放的索引逐项并回目标目录。
|
|
129
|
+
*
|
|
130
|
+
* 原来只肯在目标目录是空的时候整目录改名回去,CubeMX 一旦重建了一个非空 pdsc,
|
|
131
|
+
* 索引就只能靠用户手动合并(插件再也不会还原它)。这里逐项搬,搬不动的留在原地并报出来。
|
|
132
|
+
*/
|
|
133
|
+
function mergeDirectoryInto(from, to) {
|
|
134
|
+
let moved = 0;
|
|
135
|
+
let kept = 0;
|
|
136
|
+
let failed = 0;
|
|
137
|
+
let names = [];
|
|
138
|
+
try {
|
|
139
|
+
names = readdirSync(from);
|
|
140
|
+
}
|
|
141
|
+
catch {
|
|
142
|
+
return { moved, kept, failed };
|
|
143
|
+
}
|
|
144
|
+
for (const name of names) {
|
|
145
|
+
const src = join(from, name);
|
|
146
|
+
const dst = join(to, name);
|
|
147
|
+
if (existsSync(dst)) {
|
|
148
|
+
kept += 1;
|
|
149
|
+
continue;
|
|
150
|
+
}
|
|
151
|
+
try {
|
|
152
|
+
renameSync(src, dst);
|
|
153
|
+
moved += 1;
|
|
154
|
+
}
|
|
155
|
+
catch {
|
|
156
|
+
failed += 1;
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
if (failed === 0 && dirIsEmpty(from)) {
|
|
160
|
+
try {
|
|
161
|
+
rmdirSync(from);
|
|
162
|
+
}
|
|
163
|
+
catch {
|
|
164
|
+
// 删不掉空目录不影响结论
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
return { moved, kept, failed };
|
|
168
|
+
}
|
|
169
|
+
/**
|
|
170
|
+
* 把 <thirdparties>/pdsc 停放到 <thirdparties>/pdsc.dsh-parked。
|
|
171
|
+
*
|
|
172
|
+
* 只在确实需要停放时调用;失败一律返回 ok:false(调用方照常跑生成,只是没省下这 25 s)。
|
|
173
|
+
*/
|
|
174
|
+
export function parkThirdpartyDb(thirdpartiesDir) {
|
|
175
|
+
const dbPath = join(thirdpartiesDir, "pdsc");
|
|
176
|
+
const parkedPath = join(thirdpartiesDir, PARKED_NAME);
|
|
177
|
+
if (!existsSync(dbPath)) {
|
|
178
|
+
if (existsSync(parkedPath)) {
|
|
179
|
+
// 上次没还原(进程被杀):先还原,本次当作「无索引可停放」。
|
|
180
|
+
try {
|
|
181
|
+
renameSync(parkedPath, dbPath);
|
|
182
|
+
return { ok: false, detail: "发现上次停放的第三方包索引,已先还原(本次未再停放)" };
|
|
183
|
+
}
|
|
184
|
+
catch (error) {
|
|
185
|
+
return { ok: false, detail: "上次停放的第三方包索引还原失败:" + String(error.message) };
|
|
186
|
+
}
|
|
187
|
+
}
|
|
188
|
+
return { ok: false, detail: "没有第三方包索引目录(" + dbPath + "),无需停放" };
|
|
189
|
+
}
|
|
190
|
+
if (dirIsEmpty(dbPath)) {
|
|
191
|
+
return { ok: false, detail: "第三方包索引目录是空的(" + dbPath + "),无需停放" };
|
|
192
|
+
}
|
|
193
|
+
if (existsSync(parkedPath)) {
|
|
194
|
+
return {
|
|
195
|
+
ok: false,
|
|
196
|
+
detail: "停放位置已被占用(" + parkedPath + "),本次按原样加载;确认后可手动删除该目录",
|
|
197
|
+
};
|
|
198
|
+
}
|
|
199
|
+
try {
|
|
200
|
+
renameSync(dbPath, parkedPath);
|
|
201
|
+
}
|
|
202
|
+
catch (error) {
|
|
203
|
+
return { ok: false, detail: "停放第三方包索引失败:" + String(error.message) };
|
|
204
|
+
}
|
|
205
|
+
return {
|
|
206
|
+
ok: true,
|
|
207
|
+
detail: "已临时停放第三方包索引(" + parkedPath + "),生成结束后自动还原",
|
|
208
|
+
parkedPath,
|
|
209
|
+
dbPath,
|
|
210
|
+
restore: () => {
|
|
211
|
+
const notes = [];
|
|
212
|
+
if (!existsSync(parkedPath))
|
|
213
|
+
return notes;
|
|
214
|
+
if (existsSync(dbPath)) {
|
|
215
|
+
// 实测:CubeMX 运行中会自己新建一个**空的** pdsc 目录,必须删掉才能改名回去。
|
|
216
|
+
if (dirIsEmpty(dbPath)) {
|
|
217
|
+
try {
|
|
218
|
+
rmdirSync(dbPath);
|
|
219
|
+
}
|
|
220
|
+
catch (error) {
|
|
221
|
+
notes.push("还原第三方包索引失败(删不掉空目录 " + dbPath + "):" + String(error.message));
|
|
222
|
+
return notes;
|
|
223
|
+
}
|
|
224
|
+
}
|
|
225
|
+
else {
|
|
226
|
+
// CubeMX 运行中重建了非空 pdsc:逐项并回去,不让索引卡在 .dsh-parked 里。
|
|
227
|
+
const merged = mergeDirectoryInto(parkedPath, dbPath);
|
|
228
|
+
notes.push("CubeMX 运行中重新生成了 " + dbPath + "(非空),已把停放的索引并回 " + String(merged.moved) + " 项" +
|
|
229
|
+
(merged.kept === 0 ? "" : ";" + String(merged.kept) + " 项两边都有(保留现有的)") +
|
|
230
|
+
(merged.failed === 0 ? "" : ";" + String(merged.failed) + " 项没搬成,仍在 " + parkedPath));
|
|
231
|
+
return notes;
|
|
232
|
+
}
|
|
233
|
+
}
|
|
234
|
+
try {
|
|
235
|
+
renameSync(parkedPath, dbPath);
|
|
236
|
+
}
|
|
237
|
+
catch (error) {
|
|
238
|
+
notes.push("还原第三方包索引失败:" + String(error.message) + "(原索引在 " + parkedPath + ")");
|
|
239
|
+
}
|
|
240
|
+
return notes;
|
|
241
|
+
},
|
|
242
|
+
};
|
|
243
|
+
}
|