fcdev 0.1.0 → 0.2.0
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 +3 -2
- package/package.json +3 -3
- package/src/api/header-parser.mjs +78 -0
- package/src/api/index.mjs +128 -0
- package/src/build/bank-link-config.mjs +74 -0
- package/src/build/index.mjs +1 -0
- package/src/build/program-builder.mjs +5 -2
- package/src/cli/commands/api-command.mjs +62 -0
- package/src/cli/index.mjs +3 -0
- package/src/targets/target-registry.mjs +38 -0
- package/targets/nes/lib/fcnes.lib +0 -0
- package/targets/nes/lib/nes-font.o +0 -0
- package/targets/sb2000/api-reference.md +3295 -0
- package/targets/sb2000/api-unwrapped.json +36 -0
- package/targets/sb2000/asminc/sb2000.inc +203 -1
- package/targets/sb2000/include/sb2000-bank.h +74 -0
- package/targets/sb2000/include/sb2000-clock.h +68 -0
- package/targets/sb2000/include/sb2000-disk.h +141 -0
- package/targets/sb2000/include/sb2000-display.h +352 -0
- package/targets/sb2000/include/sb2000-file.h +273 -0
- package/targets/sb2000/include/sb2000-ime.h +158 -0
- package/targets/sb2000/include/sb2000-input.h +192 -0
- package/targets/sb2000/include/sb2000-math.h +228 -0
- package/targets/sb2000/include/sb2000-memory.h +115 -0
- package/targets/sb2000/include/sb2000-printer.h +116 -0
- package/targets/sb2000/include/sb2000-sound.h +134 -0
- package/targets/sb2000/include/sb2000-symbols.h +397 -1
- package/targets/sb2000/include/sb2000-system.h +219 -0
- package/targets/sb2000/include/sb2000-text.h +99 -0
- package/targets/sb2000/include/sb2000.h +13 -20
- package/targets/sb2000/lib/crt0.o +0 -0
- package/targets/sb2000/lib/sb2000.lib +0 -0
- package/targets/sb2000/lib-build.json +1 -1
- package/targets/sb2000/link-banked.cfg +42 -0
- package/targets/sb2000/src/crt0.s +89 -4
- package/targets/sb2000/src/lib/bank/sb-bank-current.c +18 -0
- package/targets/sb2000/src/lib/bank/sb-bank-select.c +21 -0
- package/targets/sb2000/src/lib/bank/sbi-bank-trampoline.s +46 -0
- package/targets/sb2000/src/lib/clock/sb-clock-get-date.c +17 -0
- package/targets/sb2000/src/lib/clock/sb-clock-get-time.c +17 -0
- package/targets/sb2000/src/lib/clock/sb-clock-set-date.c +21 -0
- package/targets/sb2000/src/lib/clock/sb-clock-set-time.c +17 -0
- package/targets/sb2000/src/lib/clock/sbi-date-from-fat.c +20 -0
- package/targets/sb2000/src/lib/clock/sbi-date-to-fat.c +24 -0
- package/targets/sb2000/src/lib/clock/sbi-time-from-fat.c +20 -0
- package/targets/sb2000/src/lib/clock/sbi-time-to-fat.c +19 -0
- package/targets/sb2000/src/lib/disk/sb-disk-format-track.c +18 -0
- package/targets/sb2000/src/lib/disk/sb-disk-free-bytes.c +38 -0
- package/targets/sb2000/src/lib/disk/sb-disk-init.c +16 -0
- package/targets/sb2000/src/lib/disk/sb-disk-read-sector.c +24 -0
- package/targets/sb2000/src/lib/disk/sb-disk-read-sectors.c +17 -0
- package/targets/sb2000/src/lib/disk/sb-disk-scan-track.c +27 -0
- package/targets/sb2000/src/lib/disk/sb-disk-start.c +16 -0
- package/targets/sb2000/src/lib/disk/sb-disk-stop.c +16 -0
- package/targets/sb2000/src/lib/disk/sb-disk-write-sector.c +19 -0
- package/targets/sb2000/src/lib/disk/sb-disk-write-sectors.c +17 -0
- package/targets/sb2000/src/lib/disk/sbi-disk-batch.c +23 -0
- package/targets/sb2000/src/lib/disk/sbi-disk-call.c +17 -0
- package/targets/sb2000/src/lib/disk/sbi-disk-set-position.c +18 -0
- package/targets/sb2000/src/lib/display/sb-cell-address.c +20 -0
- package/targets/sb2000/src/lib/display/sb-cells-copy.c +27 -0
- package/targets/sb2000/src/lib/display/sb-cells-fill.c +25 -0
- package/targets/sb2000/src/lib/display/sb-cells-rect.c +20 -0
- package/targets/sb2000/src/lib/display/sb-display-mode.c +16 -0
- package/targets/sb2000/src/lib/display/sb-glyph-address.c +28 -0
- package/targets/sb2000/src/lib/display/sb-image-fill-rect.c +26 -0
- package/targets/sb2000/src/lib/display/sb-image-load-raw.c +22 -0
- package/targets/sb2000/src/lib/display/sb-image-show-full.c +20 -0
- package/targets/sb2000/src/lib/display/sb-image-show.c +25 -0
- package/targets/sb2000/src/lib/display/sb-image-unpack-map.c +28 -0
- package/targets/sb2000/src/lib/display/sb-image-unpack-tiles.c +20 -0
- package/targets/sb2000/src/lib/display/sb-image-unpack-to-memory.c +22 -0
- package/targets/sb2000/src/lib/display/sb-palette-write.c +20 -0
- package/targets/sb2000/src/lib/display/sb-screen-clear.c +19 -0
- package/targets/sb2000/src/lib/display/sb-screen-flush.c +16 -0
- package/targets/sb2000/src/lib/display/sb-text-draw.c +22 -0
- package/targets/sb2000/src/lib/display/sb-text-field-ascii.c +25 -0
- package/targets/sb2000/src/lib/display/sb-text-field.c +25 -0
- package/targets/sb2000/src/lib/display/sb-text-to-memory.c +27 -0
- package/targets/sb2000/src/lib/display/sb-vram-bank.c +17 -0
- package/targets/sb2000/src/lib/display/sb-vram-fill.c +21 -0
- package/targets/sb2000/src/lib/display/sb-vram-load.c +21 -0
- package/targets/sb2000/src/lib/display/sb-window-compact.c +16 -0
- package/targets/sb2000/src/lib/display/sb-window-init.c +16 -0
- package/targets/sb2000/src/lib/display/sb-window-restore.c +17 -0
- package/targets/sb2000/src/lib/display/sb-window-save.c +21 -0
- package/targets/sb2000/src/lib/file/sb-dir-change.c +21 -0
- package/targets/sb2000/src/lib/file/sb-dir-current.c +27 -0
- package/targets/sb2000/src/lib/file/sb-dir-make.c +21 -0
- package/targets/sb2000/src/lib/file/sb-dir-open.c +61 -0
- package/targets/sb2000/src/lib/file/sb-dir-read.c +87 -0
- package/targets/sb2000/src/lib/file/sb-dir-remove.c +21 -0
- package/targets/sb2000/src/lib/file/sb-file-close.c +21 -0
- package/targets/sb2000/src/lib/file/sb-file-delete.c +21 -0
- package/targets/sb2000/src/lib/file/sb-file-get-attr.c +25 -0
- package/targets/sb2000/src/lib/file/sb-file-get-date.c +25 -0
- package/targets/sb2000/src/lib/file/sb-file-get-time.c +25 -0
- package/targets/sb2000/src/lib/file/sb-file-load.c +50 -0
- package/targets/sb2000/src/lib/file/sb-file-open.c +26 -0
- package/targets/sb2000/src/lib/file/sb-file-read.c +52 -0
- package/targets/sb2000/src/lib/file/sb-file-rename.c +30 -0
- package/targets/sb2000/src/lib/file/sb-file-save.c +31 -0
- package/targets/sb2000/src/lib/file/sb-file-set-attr.c +22 -0
- package/targets/sb2000/src/lib/file/sb-file-set-date.c +25 -0
- package/targets/sb2000/src/lib/file/sb-file-set-time.c +22 -0
- package/targets/sb2000/src/lib/file/sb-file-size.c +27 -0
- package/targets/sb2000/src/lib/file/sb-file-write-all.c +32 -0
- package/targets/sb2000/src/lib/file/sb-file-write.c +60 -0
- package/targets/sb2000/src/lib/file/sbi-dir-state.c +15 -0
- package/targets/sb2000/src/lib/file/sbi-dos-call.c +17 -0
- package/targets/sb2000/src/lib/file/sbi-load-sector.c +18 -0
- package/targets/sb2000/src/lib/file/sbi-select-handle.c +20 -0
- package/targets/sb2000/src/lib/file/sbi-set-path.c +26 -0
- package/targets/sb2000/src/lib/ime/sb-ime-get-method.c +17 -0
- package/targets/sb2000/src/lib/ime/sb-ime-get-state.c +18 -0
- package/targets/sb2000/src/lib/ime/sb-ime-hex.c +20 -0
- package/targets/sb2000/src/lib/ime/sb-ime-init.c +26 -0
- package/targets/sb2000/src/lib/ime/sb-ime-key-wait.c +19 -0
- package/targets/sb2000/src/lib/ime/sb-ime-key.c +19 -0
- package/targets/sb2000/src/lib/ime/sb-ime-parse.c +23 -0
- package/targets/sb2000/src/lib/ime/sb-ime-resume.c +16 -0
- package/targets/sb2000/src/lib/ime/sb-ime-select.c +19 -0
- package/targets/sb2000/src/lib/ime/sb-ime-set-state.c +18 -0
- package/targets/sb2000/src/lib/ime/sb-ime-set-width.c +16 -0
- package/targets/sb2000/src/lib/ime/sb-ime-suspend.c +16 -0
- package/targets/sb2000/src/lib/input/sb-break-disable.c +16 -0
- package/targets/sb2000/src/lib/input/sb-break-enable.c +16 -0
- package/targets/sb2000/src/lib/input/sb-key-count.c +17 -0
- package/targets/sb2000/src/lib/input/sb-key-flush.c +16 -0
- package/targets/sb2000/src/lib/input/sb-key-init.c +16 -0
- package/targets/sb2000/src/lib/input/sb-key-modifiers.c +16 -0
- package/targets/sb2000/src/lib/input/sb-key-poll.c +17 -0
- package/targets/sb2000/src/lib/input/sb-key-wait.c +17 -0
- package/targets/sb2000/src/lib/input/sb-keyboard-reset.c +17 -0
- package/targets/sb2000/src/lib/input/sb-mouse-buttons.c +21 -0
- package/targets/sb2000/src/lib/input/sb-mouse-position.c +18 -0
- package/targets/sb2000/src/lib/input/sb-mouse-reset.c +17 -0
- package/targets/sb2000/src/lib/input/sb-mouse-set-double-click.c +17 -0
- package/targets/sb2000/src/lib/input/sb-mouse-set-limits.c +26 -0
- package/targets/sb2000/src/lib/input/sb-mouse-set-position.c +18 -0
- package/targets/sb2000/src/lib/input/sb-pad-init.c +17 -0
- package/targets/sb2000/src/lib/input/sb-pad-poll.c +17 -0
- package/targets/sb2000/src/lib/input/sb-pad-state.c +16 -0
- package/targets/sb2000/src/lib/input/sb-pad-wait.c +17 -0
- package/targets/sb2000/src/lib/math/sb-float-add.c +19 -0
- package/targets/sb2000/src/lib/math/sb-float-div.c +19 -0
- package/targets/sb2000/src/lib/math/sb-float-from-text.c +18 -0
- package/targets/sb2000/src/lib/math/sb-float-mul.c +19 -0
- package/targets/sb2000/src/lib/math/sb-float-sub.c +19 -0
- package/targets/sb2000/src/lib/math/sb-float-to-text.c +19 -0
- package/targets/sb2000/src/lib/math/sb-int24-add.c +21 -0
- package/targets/sb2000/src/lib/math/sb-int24-div.c +26 -0
- package/targets/sb2000/src/lib/math/sb-int24-mul.c +20 -0
- package/targets/sb2000/src/lib/math/sb-int24-sub.c +21 -0
- package/targets/sb2000/src/lib/math/sb-int40-from-text.c +19 -0
- package/targets/sb2000/src/lib/math/sb-int40-to-text.c +27 -0
- package/targets/sb2000/src/lib/math/sb-line-step.c +21 -0
- package/targets/sb2000/src/lib/math/sb-math-div16.c +27 -0
- package/targets/sb2000/src/lib/math/sb-math-time-text.c +21 -0
- package/targets/sb2000/src/lib/math/sb-random-next.c +20 -0
- package/targets/sb2000/src/lib/math/sb-random-seed.c +19 -0
- package/targets/sb2000/src/lib/math/sb-random-warm-up.c +16 -0
- package/targets/sb2000/src/lib/math/sbi-peek.c +20 -0
- package/targets/sb2000/src/lib/math/sbi-poke.c +20 -0
- package/targets/sb2000/src/lib/memory/sb-address-to-far.c +20 -0
- package/targets/sb2000/src/lib/memory/sb-far-read-byte.c +17 -0
- package/targets/sb2000/src/lib/memory/sb-far-read.c +36 -0
- package/targets/sb2000/src/lib/memory/sb-far-write-byte.c +17 -0
- package/targets/sb2000/src/lib/memory/sb-far-write.c +36 -0
- package/targets/sb2000/src/lib/memory/sb-page-alloc.c +19 -0
- package/targets/sb2000/src/lib/memory/sb-page-free.c +19 -0
- package/targets/sb2000/src/lib/memory/sb-page-largest-free.c +17 -0
- package/targets/sb2000/src/lib/memory/sb-window-map-group.c +17 -0
- package/targets/sb2000/src/lib/memory/sb-window-map.c +18 -0
- package/targets/sb2000/src/lib/memory/sbi-far-copy-in.s +17 -0
- package/targets/sb2000/src/lib/memory/sbi-far-copy-out.s +17 -0
- package/targets/sb2000/src/lib/memory/sbi-far-read-byte.s +19 -0
- package/targets/sb2000/src/lib/memory/sbi-far-write-byte.s +17 -0
- package/targets/sb2000/src/lib/printer/sb-printer-carriage-return.c +16 -0
- package/targets/sb2000/src/lib/printer/sb-printer-feed.c +17 -0
- package/targets/sb2000/src/lib/printer/sb-printer-graphics-mode.c +16 -0
- package/targets/sb2000/src/lib/printer/sb-printer-home.c +16 -0
- package/targets/sb2000/src/lib/printer/sb-printer-init-port.c +16 -0
- package/targets/sb2000/src/lib/printer/sb-printer-page-left.c +16 -0
- package/targets/sb2000/src/lib/printer/sb-printer-page-length.c +17 -0
- package/targets/sb2000/src/lib/printer/sb-printer-position.c +18 -0
- package/targets/sb2000/src/lib/printer/sb-printer-reset.c +16 -0
- package/targets/sb2000/src/lib/printer/sb-printer-send-byte.c +18 -0
- package/targets/sb2000/src/lib/printer/sb-printer-text.c +29 -0
- package/targets/sb2000/src/lib/sb-internal.h +111 -0
- package/targets/sb2000/src/lib/sound/sb-sound-effect-from.c +19 -0
- package/targets/sb2000/src/lib/sound/sb-sound-play-from.c +18 -0
- package/targets/sb2000/src/lib/sound/sb-sound-play-wav-from.c +18 -0
- package/targets/sb2000/src/lib/sound/sb-sound-play-wav.c +16 -0
- package/targets/sb2000/src/lib/sound/sb-sound-repeat-wav-from.c +19 -0
- package/targets/sb2000/src/lib/sound/sb-sound-status.c +17 -0
- package/targets/sb2000/src/lib/sound/sb-sound-stop.c +16 -0
- package/targets/sb2000/src/lib/sound/sb-sound-tempo.c +17 -0
- package/targets/sb2000/src/lib/sound/sb-sound-transpose.c +17 -0
- package/targets/sb2000/src/lib/sound/sb-speech-off.c +16 -0
- package/targets/sb2000/src/lib/sound/sb-speech-send-entry-from.c +21 -0
- package/targets/sb2000/src/lib/sound/sb-speech-send-from.c +19 -0
- package/targets/sb2000/src/lib/sound/sb-speech-send.c +16 -0
- package/targets/sb2000/src/lib/system/sb-call-banked.c +19 -0
- package/targets/sb2000/src/lib/system/sb-context-restore.c +16 -0
- package/targets/sb2000/src/lib/system/sb-context-save.c +19 -0
- package/targets/sb2000/src/lib/system/sb-display-off.c +16 -0
- package/targets/sb2000/src/lib/system/sb-display-on.c +16 -0
- package/targets/sb2000/src/lib/system/sb-display-option.c +18 -0
- package/targets/sb2000/src/lib/system/sb-exec.c +22 -0
- package/targets/sb2000/src/lib/system/sb-irq-enable.c +19 -0
- package/targets/sb2000/src/lib/system/sb-irq-hook-reset.c +20 -0
- package/targets/sb2000/src/lib/system/sb-irq-hook-set.c +39 -0
- package/targets/sb2000/src/lib/system/sb-irq-mask.c +19 -0
- package/targets/sb2000/src/lib/system/sb-jump-banked.s +25 -0
- package/targets/sb2000/src/lib/system/sb-nmi-disable.c +16 -0
- package/targets/sb2000/src/lib/system/sb-nmi-enable.c +16 -0
- package/targets/sb2000/src/lib/system/sb-nmi-hook-reset.c +20 -0
- package/targets/sb2000/src/lib/system/sb-nmi-hook-set.c +33 -0
- package/targets/sb2000/src/lib/system/sb-nmi-service.c +19 -0
- package/targets/sb2000/src/lib/system/sb-stack-pointer.s +18 -0
- package/targets/sb2000/src/lib/system/sb-system-init.c +16 -0
- package/targets/sb2000/src/lib/system/sb-system-state.c +20 -0
- package/targets/sb2000/src/lib/system/sb-wait-frames.s +19 -0
- package/targets/sb2000/src/lib/system/sbi-exec-run.s +43 -0
- package/targets/sb2000/src/lib/system/sbi-interrupts-off.s +19 -0
- package/targets/sb2000/src/lib/system/sbi-interrupts-restore.s +17 -0
- package/targets/sb2000/src/lib/text/sb-beep.c +16 -0
- package/targets/sb2000/src/lib/text/sb-cursor-column.c +16 -0
- package/targets/sb2000/src/lib/text/sb-cursor-left.c +16 -0
- package/targets/sb2000/src/lib/text/sb-cursor-right.c +16 -0
- package/targets/sb2000/src/lib/text/sb-cursor-row.c +16 -0
- package/targets/sb2000/src/lib/text/sb-cursor-set-column.c +18 -0
- package/targets/sb2000/src/lib/text/sb-cursor-up.c +16 -0
- package/targets/sb2000/src/lib/text/sb-print-hex.c +22 -0
- package/targets/sb2000/src/lib/text/sb-print-uint.c +25 -0
- package/targets/sb2000/src/lib/text/sb-print.c +35 -0
- package/targets/sb2000/src/lib/text/sb-putc.c +26 -0
- package/targets/sb2000/src/sb2000.s +0 -3
- package/targets/sb2000/target.json +14 -0
package/README.md
CHANGED
|
@@ -23,6 +23,7 @@ fcdev disk src # 构建后把程序放进磁盘镜像(只有声明了
|
|
|
23
23
|
fcdev disasm game.nes # 反汇编成 ca65 源码,并回读校验
|
|
24
24
|
fcdev sync # 生成 IDE 的 C/C++ 配置
|
|
25
25
|
fcdev info --json # 显示目标、工具链与头文件目录
|
|
26
|
+
fcdev api sb_file_open # 查询目标的 C 接口文档(函数名、模块名、$功能号或关键词;不带词列出全部模块)
|
|
26
27
|
```
|
|
27
28
|
|
|
28
29
|
入口是 `main`(汇编程序写 `.export _main`)。产物放在项目根的 `build/<目标>/`,中间文件在 `build/obj/`。
|
|
@@ -62,14 +63,14 @@ fcdev disasm game.nes --cdl game.cdl --symbols sym.txt # 加 CDL 与符号文
|
|
|
62
63
|
| `toolchain` | 空 | 自备 cc65 的根目录,优先于平台包 |
|
|
63
64
|
| `firmware` | 无 | 固件(BIOS)文件;SB2000 运行时必填,fcdev 不提供任何 BIOS 或 ROM |
|
|
64
65
|
| `emulator` | 空 | 自备模拟器的路径,优先于平台包 |
|
|
65
|
-
| `targetOptions` | 空 | 目标专用选项,如 NES 的 `font`(是否链接 ASCII 字库,默认 `true
|
|
66
|
+
| `targetOptions` | 空 | 目标专用选项,如 NES 的 `font`(是否链接 ASCII 字库,默认 `true`)、SB2000 的 `banks`(大程序的库页个数,默认 0) |
|
|
66
67
|
|
|
67
68
|
## 目标
|
|
68
69
|
|
|
69
70
|
| 目标 | 产物 | 头文件 | 说明 |
|
|
70
71
|
| --- | --- | --- | --- |
|
|
71
72
|
| `nes` | `.nes` | `nes.h`(cc65)、`fcnes.h` | NROM,16K PRG 加 8K CHR;`fcnes.h` 提供调色板、文字显示与等待垂直消隐 |
|
|
72
|
-
| `sb2000` | `.EXE` | `sb2000.h` | 程序从 `$8000`
|
|
73
|
+
| `sb2000` | `.EXE` | `sb2000.h` | 程序从 `$8000` 起装入,默认最大 16K,设 `targetOptions.banks` 后可换页做到约 468K;C 栈在窗口顶端;运行库把 DOS 的系统调用封装成 180 多个 C 函数(文字、键盘手柄鼠标、文件目录、软驱、显示、声音、数学、打印机、输入法等),用 `fcdev api` 查询,整本文档见 `targets/sb2000/api-reference.md` |
|
|
73
74
|
|
|
74
75
|
## 限制
|
|
75
76
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "fcdev",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "6502 兼容机(NES、学习机等)的开发工具:用 cc65 构建 C 与汇编程序",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": "sungbin <sungbin@3578.cn>",
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
"targets"
|
|
35
35
|
],
|
|
36
36
|
"optionalDependencies": {
|
|
37
|
-
"@rujianjs/fcdev-cc65-win32-x64": "0.
|
|
38
|
-
"@rujianjs/fcdev-emulator-win32-x64": "0.
|
|
37
|
+
"@rujianjs/fcdev-cc65-win32-x64": "0.2.0",
|
|
38
|
+
"@rujianjs/fcdev-emulator-win32-x64": "0.2.0"
|
|
39
39
|
}
|
|
40
40
|
}
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
// ------------------------------------------------------------------------
|
|
2
|
+
// 名称:header-parser.mjs
|
|
3
|
+
// 说明:解析目标头文件里带文档注释的函数声明:说明、@param、@return、@syscall。
|
|
4
|
+
// 作者:sungbin
|
|
5
|
+
// 邮箱:sungbin@3578.cn
|
|
6
|
+
// 日期:2026-11-11
|
|
7
|
+
// 备注:头文件的文档注释是 C 接口文档的唯一来源,fcdev api 命令、API 参考文档的生成与接口检查都用这个解析器。
|
|
8
|
+
// 注释写法见 targets/sb2000/include/sb2000-file.h:首段是函数说明,@syscall 写对应的系统调用,@param 每个参数一行,@return 写返回值。
|
|
9
|
+
// ------------------------------------------------------------------------
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* @typedef {object} ApiFunction
|
|
13
|
+
* @property {string} name 函数名
|
|
14
|
+
* @property {string} header 所在头文件
|
|
15
|
+
* @property {string} signature 声明(不含分号,已压成一行)
|
|
16
|
+
* @property {string} returnType 返回类型文本
|
|
17
|
+
* @property {string[]} params 参数名
|
|
18
|
+
* @property {string} summary 说明首行
|
|
19
|
+
* @property {string} description 说明全文(@ 标签之前的部分,段落用换行连接)
|
|
20
|
+
* @property {string[]} paramDocs 文档里 @param 的参数名
|
|
21
|
+
* @property {Record<string, string>} paramText 每个 @param 的说明
|
|
22
|
+
* @property {boolean} hasReturnDoc 文档里有 @return
|
|
23
|
+
* @property {string} returnText @return 的说明
|
|
24
|
+
* @property {string[]} syscalls 文档里 @syscall 标签的内容
|
|
25
|
+
*/
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* 解析头文件里带文档注释的函数声明。
|
|
29
|
+
* @param {string} text 头文件内容
|
|
30
|
+
* @param {string} header 头文件名
|
|
31
|
+
* @returns {ApiFunction[]} 函数列表
|
|
32
|
+
*/
|
|
33
|
+
export function parseHeaderFunctions(text, header) {
|
|
34
|
+
const pattern = /\/\*\*((?:(?!\*\/)[\s\S])*)\*\/\s*((?:(?!\/\*)[^;{}#])*?\b(sb_\w+)\s*\(([^)]*)\))\s*;/g;
|
|
35
|
+
const functions = [];
|
|
36
|
+
for (const match of text.matchAll(pattern)) {
|
|
37
|
+
const [, rawDoc, declaration, name, rawParams] = match;
|
|
38
|
+
const docLines = rawDoc.split('\n').map((line) => line.replace(/^\s*\*?\s?/, '').trimEnd());
|
|
39
|
+
const params = rawParams.trim() === '' || rawParams.trim() === 'void'
|
|
40
|
+
? []
|
|
41
|
+
: rawParams.split(',').map((part) => /(\w+)\s*(?:\[[^\]]*\])?\s*$/.exec(part.trim())?.[1] ?? part.trim());
|
|
42
|
+
const firstTag = docLines.findIndex((line) => line.startsWith('@'));
|
|
43
|
+
const descriptionLines = (firstTag < 0 ? docLines : docLines.slice(0, firstTag)).join('\n').trim();
|
|
44
|
+
const paramText = {};
|
|
45
|
+
let returnText = '';
|
|
46
|
+
let current = null;
|
|
47
|
+
for (const line of docLines.slice(Math.max(firstTag, 0))) {
|
|
48
|
+
const paramMatch = /^@param\s+(\w+)\s*(.*)$/.exec(line);
|
|
49
|
+
if (paramMatch) {
|
|
50
|
+
paramText[paramMatch[1]] = paramMatch[2];
|
|
51
|
+
current = { kind: 'param', name: paramMatch[1] };
|
|
52
|
+
} else if (line.startsWith('@return')) {
|
|
53
|
+
returnText = line.slice('@return'.length).trim();
|
|
54
|
+
current = { kind: 'return' };
|
|
55
|
+
} else if (line.startsWith('@')) {
|
|
56
|
+
current = null;
|
|
57
|
+
} else if (current && line.trim() !== '') {
|
|
58
|
+
if (current.kind === 'param') paramText[current.name] += ` ${line.trim()}`;
|
|
59
|
+
else returnText += ` ${line.trim()}`;
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
functions.push({
|
|
63
|
+
name,
|
|
64
|
+
header,
|
|
65
|
+
signature: declaration.replace(/\s+/g, ' ').trim(),
|
|
66
|
+
returnType: declaration.slice(0, declaration.indexOf(name)).replace(/__fastcall__/g, '').trim(),
|
|
67
|
+
params,
|
|
68
|
+
summary: docLines.find((line) => line !== '' && !line.startsWith('@')) ?? '',
|
|
69
|
+
description: descriptionLines,
|
|
70
|
+
paramDocs: docLines.filter((line) => line.startsWith('@param ')).map((line) => line.split(/\s+/)[1]),
|
|
71
|
+
paramText,
|
|
72
|
+
hasReturnDoc: docLines.some((line) => line.startsWith('@return')),
|
|
73
|
+
returnText,
|
|
74
|
+
syscalls: docLines.filter((line) => line.startsWith('@syscall ')).map((line) => line.slice('@syscall '.length).trim()),
|
|
75
|
+
});
|
|
76
|
+
}
|
|
77
|
+
return functions;
|
|
78
|
+
}
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
// ------------------------------------------------------------------------
|
|
2
|
+
// 名称:index.mjs
|
|
3
|
+
// 说明:目标的 C 接口文档:从头文件读出函数列表,按名称、模块、系统调用号查询,格式化成文字。
|
|
4
|
+
// 作者:sungbin
|
|
5
|
+
// 邮箱:sungbin@3578.cn
|
|
6
|
+
// 日期:2026-11-11
|
|
7
|
+
// 备注:fcdev api 命令的实现;没有 include 目录或头文件里没有带文档注释的函数的目标,视为没有 API 文档。
|
|
8
|
+
// ------------------------------------------------------------------------
|
|
9
|
+
import { readdirSync, readFileSync } from 'node:fs';
|
|
10
|
+
import path from 'node:path';
|
|
11
|
+
import { parseHeaderFunctions } from './header-parser.mjs';
|
|
12
|
+
|
|
13
|
+
export { parseHeaderFunctions };
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* 读出目标全部带文档注释的函数。
|
|
17
|
+
* @param {{dir: string, include: string[]}} target 目标(loadTarget 的结果)
|
|
18
|
+
* @returns {import('./header-parser.mjs').ApiFunction[]} 函数列表,按头文件名与声明顺序
|
|
19
|
+
*/
|
|
20
|
+
export function loadTargetApi(target) {
|
|
21
|
+
const functions = [];
|
|
22
|
+
for (const includeDir of target.include) {
|
|
23
|
+
const dir = path.join(target.dir, includeDir);
|
|
24
|
+
let names;
|
|
25
|
+
try {
|
|
26
|
+
names = readdirSync(dir).filter((name) => name.endsWith('.h')).sort();
|
|
27
|
+
} catch {
|
|
28
|
+
continue;
|
|
29
|
+
}
|
|
30
|
+
for (const name of names) {
|
|
31
|
+
functions.push(...parseHeaderFunctions(readFileSync(path.join(dir, name), 'utf8').replace(/\r\n/g, '\n'), name));
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
return functions;
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* 头文件名对应的模块名:sb2000-file.h 的模块是 file。
|
|
39
|
+
* @param {string} header 头文件名
|
|
40
|
+
* @returns {string} 模块名
|
|
41
|
+
*/
|
|
42
|
+
export function moduleOf(header) {
|
|
43
|
+
return header.replace(/^[a-z0-9]+-/, '').replace(/\.h$/, '');
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
/**
|
|
47
|
+
* 按模块分组。
|
|
48
|
+
* @param {import('./header-parser.mjs').ApiFunction[]} functions 函数列表
|
|
49
|
+
* @returns {Map<string, import('./header-parser.mjs').ApiFunction[]>} 模块名到函数列表,保持头文件顺序
|
|
50
|
+
*/
|
|
51
|
+
export function groupByModule(functions) {
|
|
52
|
+
const groups = new Map();
|
|
53
|
+
for (const fn of functions) {
|
|
54
|
+
const key = moduleOf(fn.header);
|
|
55
|
+
groups.set(key, [...(groups.get(key) ?? []), fn]);
|
|
56
|
+
}
|
|
57
|
+
return groups;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* 查询函数。依次尝试:函数名完全相同;模块名(file 或 sb2000-file.h);系统调用号(如 $7B、$7B/$09,不分大小写);名称、说明里包含该词。
|
|
62
|
+
* @param {import('./header-parser.mjs').ApiFunction[]} functions 函数列表
|
|
63
|
+
* @param {string} query 查询词
|
|
64
|
+
* @returns {{kind: 'function'|'module'|'syscall'|'text'|'none', matches: import('./header-parser.mjs').ApiFunction[]}} 查询结果
|
|
65
|
+
*/
|
|
66
|
+
export function queryApi(functions, query) {
|
|
67
|
+
const word = query.trim();
|
|
68
|
+
const exact = functions.filter((fn) => fn.name === word);
|
|
69
|
+
if (exact.length > 0) return { kind: 'function', matches: exact };
|
|
70
|
+
const moduleName = moduleOf(word.includes('.h') ? word : `x-${word}.h`);
|
|
71
|
+
const byModule = functions.filter((fn) => moduleOf(fn.header) === moduleName);
|
|
72
|
+
if (byModule.length > 0) return { kind: 'module', matches: byModule };
|
|
73
|
+
const lower = word.toLowerCase();
|
|
74
|
+
if (/^\$?[0-9a-f]{2}(\/\$?[0-9a-f]{2})?$/.test(lower)) {
|
|
75
|
+
const [number, sub] = lower.replace(/\$/g, '').split('/');
|
|
76
|
+
const bySyscall = functions.filter((fn) => fn.syscalls.some((tag) => syscallMatches(tag, number, sub)));
|
|
77
|
+
if (bySyscall.length > 0) return { kind: 'syscall', matches: bySyscall };
|
|
78
|
+
}
|
|
79
|
+
const byText = functions.filter((fn) => fn.name.includes(lower) || fn.summary.toLowerCase().includes(lower));
|
|
80
|
+
return { kind: byText.length > 0 ? 'text' : 'none', matches: byText };
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* 一个 @syscall 标签是否涉及指定的功能号(与子功能)。标签可以是“$7B/$09”“$30/$04-$07”“$3C、$3D”“$7B/$01、$7B/$06”这样的写法。
|
|
85
|
+
* @param {string} tag 标签内容
|
|
86
|
+
* @param {string} number 功能号,两位十六进制小写
|
|
87
|
+
* @param {string} [sub] 子功能号,两位十六进制小写;省略时只比功能号
|
|
88
|
+
* @returns {boolean} 是否涉及
|
|
89
|
+
*/
|
|
90
|
+
export function syscallMatches(tag, number, sub) {
|
|
91
|
+
for (const part of tag.split('、')) {
|
|
92
|
+
const match = /\$([0-9A-Fa-f]{2})(?![0-9A-Fa-f])(?:\/\$([0-9A-Fa-f]{2})(?:-\$([0-9A-Fa-f]{2}))?)?/.exec(part);
|
|
93
|
+
if (!match || match[1].toLowerCase() !== number) continue;
|
|
94
|
+
if (sub === undefined || match[2] === undefined) return true;
|
|
95
|
+
const low = parseInt(match[2], 16);
|
|
96
|
+
const high = match[3] === undefined ? low : parseInt(match[3], 16);
|
|
97
|
+
const wanted = parseInt(sub, 16);
|
|
98
|
+
if (wanted >= low && wanted <= high) return true;
|
|
99
|
+
}
|
|
100
|
+
return false;
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
/**
|
|
104
|
+
* 格式化一个函数的完整文档。
|
|
105
|
+
* @param {import('./header-parser.mjs').ApiFunction} fn 函数
|
|
106
|
+
* @returns {string} 多行文字
|
|
107
|
+
*/
|
|
108
|
+
export function formatFunction(fn) {
|
|
109
|
+
const lines = [`${fn.signature};`, ` 所在:${fn.header}`];
|
|
110
|
+
if (fn.syscalls.length > 0) lines.push(` 系统调用:${fn.syscalls.join(';')}`);
|
|
111
|
+
lines.push('', ...fn.description.split('\n').map((line) => ` ${line}`.trimEnd()));
|
|
112
|
+
if (fn.params.length > 0) {
|
|
113
|
+
lines.push('', ' 参数:');
|
|
114
|
+
for (const param of fn.params) lines.push(` ${param} ${fn.paramText[param] ?? ''}`.trimEnd());
|
|
115
|
+
}
|
|
116
|
+
if (fn.hasReturnDoc) lines.push('', ` 返回:${fn.returnText}`);
|
|
117
|
+
return lines.join('\n');
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
/**
|
|
121
|
+
* 格式化函数的一行摘要。
|
|
122
|
+
* @param {import('./header-parser.mjs').ApiFunction} fn 函数
|
|
123
|
+
* @param {number} width 名称列宽
|
|
124
|
+
* @returns {string} 一行文字
|
|
125
|
+
*/
|
|
126
|
+
export function formatSummary(fn, width) {
|
|
127
|
+
return ` ${fn.name.padEnd(width)} ${fn.summary}`;
|
|
128
|
+
}
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
// ------------------------------------------------------------------------
|
|
2
|
+
// 名称:bank-link-config.mjs
|
|
3
|
+
// 说明:多页(换页)程序的链接配置:按库页个数把目标的链接配置模板展开成完整的链接配置,并给出这种程序用的打包选项。
|
|
4
|
+
// 作者:sungbin
|
|
5
|
+
// 邮箱:sungbin@3578.cn
|
|
6
|
+
// 日期:2026-11-11
|
|
7
|
+
// 备注:模板里写固定的部分与库页 generatedFrom 之前的库页,%BANK_MEMORY% 与 %BANK_SEGMENTS% 两行分别展开成
|
|
8
|
+
// 库页 generatedFrom 到 N 的内存区与段;定义见 docs/03-目标规范.md 第 2 节的 banked。
|
|
9
|
+
// ------------------------------------------------------------------------
|
|
10
|
+
import { readFileSync, writeFileSync } from 'node:fs';
|
|
11
|
+
import path from 'node:path';
|
|
12
|
+
import { FcdevError } from '../shared/index.mjs';
|
|
13
|
+
import { resolveTargetPath } from '../targets/index.mjs';
|
|
14
|
+
|
|
15
|
+
/** 模板里内存区的展开位置 */
|
|
16
|
+
const MEMORY_MARKER = '%BANK_MEMORY%';
|
|
17
|
+
|
|
18
|
+
/** 模板里段的展开位置 */
|
|
19
|
+
const SEGMENT_MARKER = '%BANK_SEGMENTS%';
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* 取程序的库页个数。
|
|
23
|
+
* @param {import('./build-plan.mjs').BuildPlan} plan 构建计划
|
|
24
|
+
* @returns {number} 库页个数;目标不支持多页或选项为 0 时为 0
|
|
25
|
+
*/
|
|
26
|
+
export function getBankCount(plan) {
|
|
27
|
+
const { banked } = plan.target;
|
|
28
|
+
return banked ? plan.targetOptions[banked.option] : 0;
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* 把模板展开成完整的链接配置。
|
|
33
|
+
* @param {string} template 链接配置模板
|
|
34
|
+
* @param {import('../targets/index.mjs').BankedSpec} banked 目标的多页定义
|
|
35
|
+
* @param {number} count 库页个数
|
|
36
|
+
* @returns {string} 链接配置
|
|
37
|
+
* @throws {FcdevError} 模板里缺少展开位置
|
|
38
|
+
*/
|
|
39
|
+
export function expandBankedLinkConfig(template, banked, count) {
|
|
40
|
+
const lines = template.split(/\r?\n/);
|
|
41
|
+
const generate = (pattern) => {
|
|
42
|
+
const generated = [];
|
|
43
|
+
for (let bank = banked.generatedFrom; bank <= count; bank += 1) generated.push(` ${pattern.replaceAll('{n}', String(bank))}`);
|
|
44
|
+
return generated;
|
|
45
|
+
};
|
|
46
|
+
const expand = (marker, pattern) => {
|
|
47
|
+
const index = lines.findIndex((line) => line.trim() === marker);
|
|
48
|
+
if (index < 0) throw new FcdevError(`链接配置模板里缺少 ${marker} 一行`, { code: 'TARGET_INVALID' });
|
|
49
|
+
lines.splice(index, 1, ...generate(pattern));
|
|
50
|
+
};
|
|
51
|
+
expand(MEMORY_MARKER, banked.memory);
|
|
52
|
+
expand(SEGMENT_MARKER, banked.segment);
|
|
53
|
+
return lines.join('\n');
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* 确定链接用的配置文件与打包选项:多页程序展开模板并写到中间文件目录,普通程序直接用目标的链接配置。
|
|
58
|
+
* @param {import('./build-plan.mjs').BuildPlan} plan 构建计划
|
|
59
|
+
* @param {string} toolchainHome 工具链根目录
|
|
60
|
+
* @returns {{linkConfig: string, packagerOptions: Record<string, unknown>}} 链接配置的路径与打包选项
|
|
61
|
+
*/
|
|
62
|
+
export function resolveLinkSetup(plan, toolchainHome) {
|
|
63
|
+
const { target } = plan;
|
|
64
|
+
const count = getBankCount(plan);
|
|
65
|
+
if (count === 0) {
|
|
66
|
+
return { linkConfig: resolveTargetPath(target, target.linkConfig, toolchainHome), packagerOptions: target.packagerOptions };
|
|
67
|
+
}
|
|
68
|
+
const template = readFileSync(resolveTargetPath(target, target.banked.linkConfig, toolchainHome), 'utf8');
|
|
69
|
+
const linkConfig = path.join(plan.objectDir, `${plan.programName}.cfg`);
|
|
70
|
+
writeFileSync(linkConfig, expandBankedLinkConfig(template, target.banked, count));
|
|
71
|
+
// 多页程序的大小由库页个数决定,不再用单页程序的大小上限检查
|
|
72
|
+
const { maxSize: _unused, ...packagerOptions } = target.packagerOptions;
|
|
73
|
+
return { linkConfig, packagerOptions };
|
|
74
|
+
}
|
package/src/build/index.mjs
CHANGED
|
@@ -11,6 +11,7 @@ import { createBuildPlan } from './build-plan.mjs';
|
|
|
11
11
|
import { buildProgram } from './program-builder.mjs';
|
|
12
12
|
|
|
13
13
|
export { createBuildPlan } from './build-plan.mjs';
|
|
14
|
+
export { expandBankedLinkConfig, getBankCount, resolveLinkSetup } from './bank-link-config.mjs';
|
|
14
15
|
export { parseDependencyFile } from './dependency-file.mjs';
|
|
15
16
|
export { buildDiskImage } from './disk-builder.mjs';
|
|
16
17
|
export { buildProgram } from './program-builder.mjs';
|
|
@@ -14,6 +14,7 @@ import { ensureDirectory, FcdevError, getModifiedTime, readJsonFile } from '../s
|
|
|
14
14
|
import { getPackager } from '../packagers/index.mjs';
|
|
15
15
|
import { resolveTargetPath } from '../targets/index.mjs';
|
|
16
16
|
import { getToolchainVersion, runTool } from '../toolchain/index.mjs';
|
|
17
|
+
import { resolveLinkSetup } from './bank-link-config.mjs';
|
|
17
18
|
import { parseDependencyFile } from './dependency-file.mjs';
|
|
18
19
|
import { getSourceLanguage } from './source-collector.mjs';
|
|
19
20
|
import { buildAssemblerArguments, buildCompilerArguments, buildLinkerArguments } from './tool-arguments.mjs';
|
|
@@ -117,6 +118,7 @@ async function runChecked(toolchain, tool, args, reporter, failureMessage) {
|
|
|
117
118
|
function describeToolFailure(output) {
|
|
118
119
|
if (/Unresolved external[^\w]*_?main\b/i.test(output)) return '没有找到 main:C 程序要定义 main,汇编程序要 .export _main';
|
|
119
120
|
if (/Duplicate external identifier[^\w]*_?main\b/i.test(output)) return '目录里有多个 main;若要单独构建一个程序,请指定文件名';
|
|
121
|
+
if (/Missing memory area assignment for segment .BANK\d+/.test(output)) return '库页个数不够:在 fcdev.json 的 targetOptions.banks 里加大库页个数';
|
|
120
122
|
return '';
|
|
121
123
|
}
|
|
122
124
|
|
|
@@ -193,8 +195,9 @@ export async function buildProgram(plan, toolchain, reporter = SILENT_REPORTER)
|
|
|
193
195
|
.filter(([key, value]) => value === true && target.options[key])
|
|
194
196
|
.flatMap(([key]) => target.options[key].links);
|
|
195
197
|
reporter.log('链接');
|
|
198
|
+
const linkSetup = resolveLinkSetup(plan, toolchain.home);
|
|
196
199
|
await runChecked(toolchain, 'ld65', buildLinkerArguments({
|
|
197
|
-
linkConfig:
|
|
200
|
+
linkConfig: linkSetup.linkConfig,
|
|
198
201
|
binaryFile,
|
|
199
202
|
mapFile: path.join(plan.objectDir, `${plan.programName}.map`),
|
|
200
203
|
debugFile: path.join(plan.objectDir, `${plan.programName}.dbg`),
|
|
@@ -203,7 +206,7 @@ export async function buildProgram(plan, toolchain, reporter = SILENT_REPORTER)
|
|
|
203
206
|
forceImports: target.forceImports,
|
|
204
207
|
}), reporter, `链接失败:${plan.programName}`);
|
|
205
208
|
|
|
206
|
-
const packaged = getPackager(target.packager)({ binaryFile, outputFile: plan.outputFile, options:
|
|
209
|
+
const packaged = getPackager(target.packager)({ binaryFile, outputFile: plan.outputFile, options: linkSetup.packagerOptions });
|
|
207
210
|
writeFileSync(stampFile, JSON.stringify({ fingerprint }));
|
|
208
211
|
return { programName: plan.programName, outputFile: packaged.outputFile, size: packaged.size, compiled, reused };
|
|
209
212
|
}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
// ------------------------------------------------------------------------
|
|
2
|
+
// 名称:api-command.mjs
|
|
3
|
+
// 说明:api 命令:查询目标的 C 接口文档(函数、模块、系统调用号)。
|
|
4
|
+
// 作者:sungbin
|
|
5
|
+
// 邮箱:sungbin@3578.cn
|
|
6
|
+
// 日期:2026-11-11
|
|
7
|
+
// 备注:文档来自目标头文件里的文档注释,所以随库更新,不另存一份。没有查询词时列出全部模块;--json 输出机器可读格式。
|
|
8
|
+
// ------------------------------------------------------------------------
|
|
9
|
+
import { formatFunction, formatSummary, groupByModule, loadTargetApi, queryApi } from '../../api/index.mjs';
|
|
10
|
+
import { loadProjectConfig } from '../../config/index.mjs';
|
|
11
|
+
import { FcdevError } from '../../shared/index.mjs';
|
|
12
|
+
import { loadTarget } from '../../targets/index.mjs';
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* 执行 api 命令。
|
|
16
|
+
* @param {{positionals: string[], options: {target?: string, json: boolean}, context: import('../index.mjs').CliContext}} input 参数、选项与运行环境
|
|
17
|
+
* @returns {Promise<number>} 退出码
|
|
18
|
+
*/
|
|
19
|
+
export async function runApiCommand({ positionals, options, context }) {
|
|
20
|
+
const config = loadProjectConfig(context.cwd, context.cwd);
|
|
21
|
+
const targetName = options.target ?? config.target;
|
|
22
|
+
if (!targetName) {
|
|
23
|
+
throw new FcdevError('没有指定目标', { code: 'TARGET_MISSING', hint: '在 fcdev.json 里写 "target",或用 --target <名> 指定' });
|
|
24
|
+
}
|
|
25
|
+
const target = loadTarget(targetName);
|
|
26
|
+
const functions = loadTargetApi(target);
|
|
27
|
+
if (functions.length === 0) {
|
|
28
|
+
throw new FcdevError(`目标 ${target.name} 没有 C 接口文档`, { code: 'API_MISSING', hint: '目前只有 sb2000 目标提供运行库函数的文档' });
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
const query = positionals.join(' ').trim();
|
|
32
|
+
if (query === '') {
|
|
33
|
+
const groups = groupByModule(functions);
|
|
34
|
+
if (options.json) {
|
|
35
|
+
const modules = [...groups].map(([name, items]) => ({ module: name, header: items[0].header, functions: items.map((fn) => fn.name) }));
|
|
36
|
+
context.stdout.write(`${JSON.stringify(modules, null, 2)}\n`);
|
|
37
|
+
return 0;
|
|
38
|
+
}
|
|
39
|
+
const lines = [`${target.title} 的 C 接口:${functions.length} 个函数,${groups.size} 个模块`, ''];
|
|
40
|
+
for (const [name, items] of groups) lines.push(` ${name.padEnd(10)} ${String(items.length).padStart(3)} 个函数 ${items[0].header}`);
|
|
41
|
+
lines.push('', '查询:fcdev api <函数名>(完整文档)、fcdev api <模块名>(函数列表)、fcdev api <$功能号>(用到该系统调用的函数)、fcdev api <词>(按名称与说明搜索)');
|
|
42
|
+
context.stdout.write(`${lines.join('\n')}\n`);
|
|
43
|
+
return 0;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
const { kind, matches } = queryApi(functions, query);
|
|
47
|
+
if (matches.length === 0) {
|
|
48
|
+
throw new FcdevError(`没有找到“${query}”`, { code: 'API_NOT_FOUND', hint: '不带查询词运行 fcdev api 可以看到全部模块' });
|
|
49
|
+
}
|
|
50
|
+
if (options.json) {
|
|
51
|
+
context.stdout.write(`${JSON.stringify(matches, null, 2)}\n`);
|
|
52
|
+
return 0;
|
|
53
|
+
}
|
|
54
|
+
if (kind === 'function') {
|
|
55
|
+
context.stdout.write(`${matches.map(formatFunction).join('\n\n')}\n`);
|
|
56
|
+
return 0;
|
|
57
|
+
}
|
|
58
|
+
const width = Math.max(...matches.map((fn) => fn.name.length));
|
|
59
|
+
const title = { module: `模块 ${query}`, syscall: `系统调用 ${query}`, text: `包含“${query}”` }[kind];
|
|
60
|
+
context.stdout.write(`${title}:${matches.length} 个函数\n${matches.map((fn) => formatSummary(fn, width)).join('\n')}\n`);
|
|
61
|
+
return 0;
|
|
62
|
+
}
|
package/src/cli/index.mjs
CHANGED
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
import { FcdevError, readJsonFile } from '../shared/index.mjs';
|
|
10
10
|
import { fileURLToPath } from 'node:url';
|
|
11
11
|
import { parseArguments } from './args-parser.mjs';
|
|
12
|
+
import { runApiCommand } from './commands/api-command.mjs';
|
|
12
13
|
import { runBuildCommand } from './commands/build-command.mjs';
|
|
13
14
|
import { runDebugCommand } from './commands/debug-command.mjs';
|
|
14
15
|
import { runDiskCommand } from './commands/disk-command.mjs';
|
|
@@ -27,6 +28,7 @@ import { runSyncCommand } from './commands/sync-command.mjs';
|
|
|
27
28
|
|
|
28
29
|
/** 命令表:命令名到处理函数 */
|
|
29
30
|
const COMMANDS = {
|
|
31
|
+
api: runApiCommand,
|
|
30
32
|
build: runBuildCommand,
|
|
31
33
|
debug: runDebugCommand,
|
|
32
34
|
disasm: runDisasmCommand,
|
|
@@ -49,6 +51,7 @@ const HELP_TEXT = `fcdev:6502 兼容机的开发工具
|
|
|
49
51
|
debug <命令> 把命令转发给模拟器的调试服务,如 debug run 60、debug shot out.png
|
|
50
52
|
sync 生成 IDE 的 C/C++ 配置
|
|
51
53
|
info [--json] 显示目标、工具链与头文件目录
|
|
54
|
+
api [词] [--json] 查询目标的 C 接口文档:函数名、模块名、$功能号或关键词;不带词列出全部模块
|
|
52
55
|
|
|
53
56
|
选项:
|
|
54
57
|
--target <名> 指定目标,覆盖 fcdev.json
|
|
@@ -23,6 +23,16 @@ const RUN_MODES = new Set(['rom', 'firmware-disk']);
|
|
|
23
23
|
/** 目标专用选项允许的类型 */
|
|
24
24
|
const OPTION_TYPES = new Set(['boolean', 'string', 'number']);
|
|
25
25
|
|
|
26
|
+
/**
|
|
27
|
+
* @typedef {object} BankedSpec 多页(换页)程序的定义
|
|
28
|
+
* @property {string} option 目标专用选项名,值为库页个数
|
|
29
|
+
* @property {string} linkConfig 链接配置模板(路径值),含 %BANK_MEMORY% 与 %BANK_SEGMENTS% 两行
|
|
30
|
+
* @property {number} generatedFrom 模板里已写出前面的库页,从这一页起由 fcdev 按个数生成
|
|
31
|
+
* @property {number} maxBanks 库页个数的上限
|
|
32
|
+
* @property {string} memory 一个库页的内存区行,{n} 换成库页号
|
|
33
|
+
* @property {string} segment 一个库页的段行,{n} 换成库页号
|
|
34
|
+
*/
|
|
35
|
+
|
|
26
36
|
/**
|
|
27
37
|
* @typedef {object} Target
|
|
28
38
|
* @property {string} name 标识
|
|
@@ -44,6 +54,7 @@ const OPTION_TYPES = new Set(['boolean', 'string', 'number']);
|
|
|
44
54
|
* @property {object|null} disk 磁盘镜像能力
|
|
45
55
|
* @property {object|null} run 运行方案
|
|
46
56
|
* @property {Record<string, {type: string, default: unknown, links: string[]}>} options 目标专用选项;布尔选项为 true 时额外链接 links 里的文件(路径值)
|
|
57
|
+
* @property {BankedSpec|null} banked 多页(换页)程序的定义;不支持时为 null
|
|
47
58
|
*/
|
|
48
59
|
|
|
49
60
|
/**
|
|
@@ -60,6 +71,28 @@ function requireStringArray(value, field, name) {
|
|
|
60
71
|
return value;
|
|
61
72
|
}
|
|
62
73
|
|
|
74
|
+
/**
|
|
75
|
+
* 校验并规范化多页程序的定义。
|
|
76
|
+
* @param {unknown} raw target.json 里的 banked;没有时为 undefined
|
|
77
|
+
* @param {string} name 目标名
|
|
78
|
+
* @param {Record<string, {type: string}>} options 已解析的目标专用选项
|
|
79
|
+
* @returns {BankedSpec|null} 多页定义;没有时为 null
|
|
80
|
+
* @throws {FcdevError} 字段缺失、类型不对,或对应的选项不是数字选项
|
|
81
|
+
*/
|
|
82
|
+
function parseBanked(raw, name, options) {
|
|
83
|
+
if (raw === undefined) return null;
|
|
84
|
+
const invalid = (reason) => new FcdevError(`目标 ${name} 的 banked ${reason}`, { code: 'TARGET_INVALID' });
|
|
85
|
+
if (typeof raw !== 'object' || raw === null || Array.isArray(raw)) throw invalid('必须是对象');
|
|
86
|
+
for (const field of ['option', 'linkConfig', 'memory', 'segment']) {
|
|
87
|
+
if (typeof raw[field] !== 'string' || raw[field] === '') throw invalid(`缺少字符串字段 ${field}`);
|
|
88
|
+
}
|
|
89
|
+
for (const field of ['generatedFrom', 'maxBanks']) {
|
|
90
|
+
if (!Number.isInteger(raw[field]) || raw[field] < 1) throw invalid(`的 ${field} 必须是不小于 1 的整数`);
|
|
91
|
+
}
|
|
92
|
+
if (options[raw.option]?.type !== 'number') throw invalid(`的 option(${raw.option})必须是 options 里的数字选项`);
|
|
93
|
+
return { option: raw.option, linkConfig: raw.linkConfig, generatedFrom: raw.generatedFrom, maxBanks: raw.maxBanks, memory: raw.memory, segment: raw.segment };
|
|
94
|
+
}
|
|
95
|
+
|
|
63
96
|
/**
|
|
64
97
|
* 校验并规范化目标定义。
|
|
65
98
|
* @param {unknown} raw target.json 的内容
|
|
@@ -95,6 +128,7 @@ export function parseTarget(raw, dir) {
|
|
|
95
128
|
}
|
|
96
129
|
options[key] = { type: spec.type, default: spec.default, links: spec.links ?? [] };
|
|
97
130
|
}
|
|
131
|
+
const banked = parseBanked(raw.banked, raw.name, options);
|
|
98
132
|
return {
|
|
99
133
|
name: raw.name,
|
|
100
134
|
title: raw.title,
|
|
@@ -115,6 +149,7 @@ export function parseTarget(raw, dir) {
|
|
|
115
149
|
disk: raw.disk ?? null,
|
|
116
150
|
run: raw.run ?? null,
|
|
117
151
|
options,
|
|
152
|
+
banked,
|
|
118
153
|
};
|
|
119
154
|
}
|
|
120
155
|
|
|
@@ -181,6 +216,9 @@ export function resolveTargetOptions(target, given) {
|
|
|
181
216
|
if (typeof value !== spec.type) {
|
|
182
217
|
throw new FcdevError(`目标 ${target.name} 的选项 ${key} 类型应为 ${spec.type}`, { code: 'TARGET_OPTION_INVALID' });
|
|
183
218
|
}
|
|
219
|
+
if (target.banked?.option === key && (!Number.isInteger(value) || value < 0 || value > target.banked.maxBanks)) {
|
|
220
|
+
throw new FcdevError(`目标 ${target.name} 的选项 ${key} 必须是 0 到 ${target.banked.maxBanks} 的整数`, { code: 'TARGET_OPTION_INVALID' });
|
|
221
|
+
}
|
|
184
222
|
result[key] = value;
|
|
185
223
|
}
|
|
186
224
|
return result;
|
|
Binary file
|
|
Binary file
|