fcdev 0.1.0 → 0.3.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 +21 -2
- package/docs/01-/350/275/257/344/273/266/346/236/266/346/236/204/350/256/276/350/256/241.md +164 -0
- package/docs/02-/345/221/275/344/273/244/350/241/214/344/270/216/346/236/204/345/273/272.md +157 -0
- package/docs/03-/347/233/256/346/240/207/350/247/204/350/214/203.md +123 -0
- package/docs/04-cc65/345/267/245/345/205/267/351/223/276.md +51 -0
- package/docs/05-/346/250/241/346/213/237/345/231/250/344/270/216/350/260/203/350/257/225.md +100 -0
- package/docs/06-/345/217/215/346/261/207/347/274/226.md +103 -0
- package/docs/07-/345/210/233/345/273/272/345/214/205/344/270/216/346/250/241/346/235/277.md +74 -0
- package/docs/08-/346/265/213/350/257/225/344/270/216/351/252/214/350/257/201.md +72 -0
- package/docs/09-/345/217/221/345/270/203.md +67 -0
- package/docs/10-VS Code/346/211/251/345/261/225.md" +131 -0
- package/docs/nes/01-NES/347/233/256/346/240/207.md +52 -0
- package/docs/sb2000/01-/345/274/200/345/217/221/346/214/207/345/215/227.md +252 -0
- package/docs/sb2000/02-/347/263/273/347/273/237/350/260/203/347/224/250/346/211/213/345/206/214.md +797 -0
- package/docs/sb2000/03-/347/241/254/344/273/266/350/257/264/346/230/216.md +27 -0
- package/docs//345/276/205/345/212/236/345/244/207/345/277/230.md +46 -0
- package/docs//347/274/272/351/231/267/350/256/260/345/275/225.md +10 -0
- package/package.json +4 -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/commands/docs-command.mjs +58 -0
- package/src/cli/index.mjs +6 -0
- package/src/docs/doc-index.mjs +101 -0
- package/src/docs/doc-topics.mjs +38 -0
- package/src/docs/index.mjs +10 -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
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# SB2000 硬件说明
|
|
2
|
+
|
|
3
|
+
本文是 SB2000(小霸王学生电脑)硬件行为的结论,来源是模拟器源码(fcdev 仓库 `virtuanes/VirtuaNES/NES/Mapper/MapperSB2K.cpp` 等)和实际运行观察。“已确认”指来自模拟器源码或实际运行,真机均未测试;程序接口见 [系统调用手册](02-系统调用手册.md)。
|
|
4
|
+
|
|
5
|
+
| 项目 | 结论 | 状态 |
|
|
6
|
+
| --- | --- | --- |
|
|
7
|
+
| CPU | 标准 6502(含非官方指令),不是新指令集;“6576”是映射器 ASIC 的工作模式 | 已确认 |
|
|
8
|
+
| 进入 6576 模式 | 依次向 `$4031` 写入 `$65`、`$76`;BIOS 启动后自行完成 | 已确认 |
|
|
9
|
+
| 返回 FC 兼容模式 | 向 `$4301` 写 `$55`:复位 6576、`RAM 启动`,`$8000` 以上改走 MMC3 仿真 | 已确认 |
|
|
10
|
+
| 程序窗口 | `$4040-$4047` 各选一个 4K 页,对应 `$8000-$FFFF` 的 8 个窗口;值小于 `$80` 是 BIOS ROM 页(512KB,共 128 页),不小于 `$80` 是扩展 RAM 页(512KB) | 已确认 |
|
|
11
|
+
| 启动后的窗口 | `$C000-$FFFF` 固定为 ROM 第 4-7 页,`$8000-$BFFF` 由 BIOS 换页 | 已确认 |
|
|
12
|
+
| 向量 | NMI `$C084`,RESET `$C000`,IRQ `$C12B`(ROM 偏移 `$7FFA` 起) | 已确认 |
|
|
13
|
+
| 内部 RAM | 6576 模式下 `$0000-$1FFF` 为 8K 且不镜像;`$5000-$5FFF` 为 2K 工作 RAM,`$6000-$7FFF` 为 8K 扩展 RAM | 已确认 |
|
|
14
|
+
| DMA | `$4048-$404F`;写 `$4048` 的最高位启动;源为 ROM 或扩展 RAM,目的为工作 RAM 或显存 | 已确认 |
|
|
15
|
+
| 软驱控制器 | `$4200-$4207`;1.44MB(每道 18 扇区、2 面、80 道),LBA = 磁道×36 + 磁头×18 + 扇区 − 1 | 已确认 |
|
|
16
|
+
| 键盘 | 经 `$4020-$4022` 串行收发,扫描码与 DirectInput 的 DIK 值一致 | 已确认 |
|
|
17
|
+
| 显存 | 512KB,经 `$4300` 选 32KB 的 bank | 已确认 |
|
|
18
|
+
| 中断屏蔽与状态 | `$4032` 读写屏蔽寄存器:写入值中为 1 的位屏蔽(禁止)该中断源,同时把 `$4033` 里对应的待处理标志清除(`$4033 &= ~写入值`),为 0 的位允许该中断源。位 7 定时器、位 6 鼠标、位 5 键盘、位 3 软驱,复位时为 `$FF`(全部屏蔽);`$4033` 只读,位含义相同,为 1 表示该源有待处理中断 | 已确认(模拟器源码) |
|
|
19
|
+
| 并口打印机 | 模拟器实现了 Epson ESC/P 虪拟打印机(`LPT.cpp`)。数据写 `$4025`;写 `$4016` 的位 0 为 #选中打印机、位 1 为 #换行、位 2 为复位;写 `$4026` 的位 2 为 #选通(strobe);读 `$4017` 位 2 为出错、位 3 为 #忙;读 `$4026` 位 3、4、5 依次是应答、缺纸、已选中(模拟器里状态固定为“不忙、已应答、有纸、已选中、无错”)。收到 `ESC @`(`$1B $40`)开始一页,弹出“Print to...”对话框,可选系统打印机或输出 PDF、PNG 文件;收到换页 `$0C`、复位或约 6 秒没有数据就结束这一页 | 已确认(模拟器源码) |
|
|
20
|
+
| 语音端口 `$4302` | 读:位 7 为 1 表示可以接收下一个字节(缓冲未满),语音播完时低 4 位为 `$F`。写:把一个语音数据字节送进环形缓冲,由模拟器的 LPC 语音线程解码播放。`$4026` 位 6 的上升沿复位语音(清缓冲)。BIOS 的 `$74`、`$75`(`API_74_PORT4302_CONTROL`、`API_75_PORT4302_SEND`)就是操作它 | 已确认(模拟器源码);`$74`、`$75` 的发送序列与“播完”结束都已实测(见 [系统调用手册](02-系统调用手册.md) 5.13 节);模拟器曾缺 `case 0x4302:`,已修复 |
|
|
21
|
+
|
|
22
|
+
## 软件环境
|
|
23
|
+
|
|
24
|
+
| 项目 | 结论 | 状态 |
|
|
25
|
+
| --- | --- | --- |
|
|
26
|
+
| 版本 | `SB-DOS V2.00`,`SUBOR 1989-1998`,启动后依次询问日期与时间,提示符 `A:\>` | 已确认 |
|
|
27
|
+
| 软盘格式 | 标准 1.44MB FAT12(本工具生成的镜像能被 `dir` 读出并运行 `ATTRIB.EXE`、`EDIT.EXE`) | 已确认 |
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# 待办备忘
|
|
2
|
+
|
|
3
|
+
已确定以后再做的事项。做完一项,就把它写进对应的文档,并从本文删掉。
|
|
4
|
+
|
|
5
|
+
## 1. 发布
|
|
6
|
+
|
|
7
|
+
| 事项 | 说明 |
|
|
8
|
+
| --- | --- |
|
|
9
|
+
| 发布四个 npm 包 | 由用户登录 npm 后按 [09-发布](09-发布.md) 的顺序执行 |
|
|
10
|
+
| `darwin-arm64`、`linux-x64` 平台包 | 构建脚本已写,需要在这些系统上运行并验证后再发布;模拟器只支持 Windows,不做这两个系统的模拟器包 |
|
|
11
|
+
|
|
12
|
+
## 2. VS Code 扩展
|
|
13
|
+
|
|
14
|
+
扩展的智能感知与 ca65 语法高亮已完成,见 [10-VS Code扩展](10-VS%20Code扩展.md)。发布到 VS Code 市场需要发布者账号,由用户操作,本仓库只负责生成 `.vsix`。下面是还没做的功能:
|
|
15
|
+
|
|
16
|
+
| 功能 | 说明 |
|
|
17
|
+
| --- | --- |
|
|
18
|
+
| 任务 | 任务提供者 `fcdev`:构建、运行;问题匹配器识别 `cc65`、`ca65` 的 `文件(行): Error: 信息`,报错可跳转到源码行 |
|
|
19
|
+
| 命令 | 新建项目(调用 `create-fcdev`)、构建当前文件、构建当前目录、构建项目、运行、切换目标;状态栏显示当前目标 |
|
|
20
|
+
| 找工具 | 项目里没有安装 `fcdev` 时提示一键安装;现在只在日志里写明原因 |
|
|
21
|
+
| 调试 | 首版不做;调试适配器协议(DAP)另写设计 |
|
|
22
|
+
| 真实 VS Code 里的显示效果 | 扩展已做完,类型检查、测试与构建通过;悬停、补全、高亮在真实 VS Code 里的显示效果待用户核对 |
|
|
23
|
+
|
|
24
|
+
## 3. 模拟器
|
|
25
|
+
|
|
26
|
+
| 事项 | 说明 |
|
|
27
|
+
| --- | --- |
|
|
28
|
+
| 内核集成进 VS Code 面板 | 只要调试服务协议不变,`fcdev` 不用改 |
|
|
29
|
+
|
|
30
|
+
## 4. 目标
|
|
31
|
+
|
|
32
|
+
| 事项 | 说明 |
|
|
33
|
+
| --- | --- |
|
|
34
|
+
| 步步高、裕兴的目标 | 缺少资料,动手前先用资料与模拟器确认程序格式、内存布局、系统调用与固件要求 |
|
|
35
|
+
| NES 的其他映射器 | 现在只支持 `nes.cfg` 的 NROM |
|
|
36
|
+
| SB2000 的退出码 | `main` 的返回值没有实现为退出码:`$6308` 是运行库显示消息用的 `LIB_GROUP`,DOS 外壳不读取程序返回时的它,系统里没有退出码这个约定;要不要提供自己的约定(如写到某个 ERAM 单元)以后再定 |
|
|
37
|
+
| SB2000 没封装的系统调用 | 见 [api-reference.md](../targets/sb2000/api-reference.md) 末尾的覆盖表与 `api-unwrapped.json`:文件系统内部步骤、`$41`-`$44`、`$31`、`$34`、`$66`、`$65` 与 `$6D` 的部分子功能、`$74`/`$75` 的 NMI 发送与播放列表等;有需要时再封装并补测试 |
|
|
38
|
+
|
|
39
|
+
## 5. 反汇编
|
|
40
|
+
|
|
41
|
+
| 事项 | 说明 |
|
|
42
|
+
| --- | --- |
|
|
43
|
+
| 其他映射器 | 现在只支持 NROM 与平铺二进制;其他映射器需要目标提供地址映射 |
|
|
44
|
+
| 跳转表识别 | 例程内联的跳转表(如 `RTS` 跳转表)追踪不到,这部分按数据输出 |
|
|
45
|
+
| 地址表与字符串识别 | 现在没追到的字节都是 `ByteTable` |
|
|
46
|
+
| SB2000 固件页的 CDL 验证 | 没有做;模拟器自带 CDL 只对 SB2K 映射器有效 |
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# 缺陷记录
|
|
2
|
+
|
|
3
|
+
发现的缺陷及修复情况。发现缺陷时先登记,修复后填写修复说明。
|
|
4
|
+
|
|
5
|
+
| 编号 | 发现日期 | 缺陷 | 影响 | 状态 | 修复说明 |
|
|
6
|
+
| --- | --- | --- | --- | --- | --- |
|
|
7
|
+
| B001 | 2026-11-10 | 根 `.gitignore` 的 `build/` 规则把 `packages/fcdev/src/build/`(构建核心的 7 个源文件)排除在版本库之外,`git ls-files` 里没有它们 | 已提交的仓库缺少构建核心,别人克隆后无法使用 `fcdev build`;发布时因为 `files` 白名单仍会打进包,所以现有包内容不受影响 | 已修复 | 把 `.gitignore` 里的 `build/` 改为只忽略仓库根的 `/build/` 与各包根目录下的 `packages/*/build/`;修改后 `git check-ignore` 不再匹配 `packages/fcdev/src/build/`,该目录显示为未跟踪,需要用户自己暂存并提交 |
|
|
8
|
+
| B002 | 2026-11-10 | [virtuanes/README.md](https://gitee.com/sungbin/fcdev/blob/master/virtuanes/README.md) 的目录图根写成 `emulator/`,一处链接指向不存在的文件 | 链接失效,目录图与实际不符 | 已修复 | 目录图改为 `virtuanes/`,删掉失效链接与不属于本仓库的说明 |
|
|
9
|
+
| B003 | 2026-11-10 | `fcdev` 接受 `--verbose` 选项,但没有任何命令使用它 | 选项无效果;文档与帮助文字都没有提到它 | 待修复 | |
|
|
10
|
+
| B004 | 2026-11-12 | `npm run check` 里需要启动模拟器的 SB2000 测试(`sb2000-library.test.mjs`)偶发失败:有时报“调试命令 run 300 超过 120000 毫秒没有应答”,有时报“等待调试服务就绪超时”,失败的用例每次不同;单独重跑通过 | 全量检查偶发 1 个失败,与代码改动无关 | 待修复 | |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "fcdev",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.0",
|
|
4
4
|
"description": "6502 兼容机(NES、学习机等)的开发工具:用 cc65 构建 C 与汇编程序",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": "sungbin <sungbin@3578.cn>",
|
|
@@ -30,11 +30,12 @@
|
|
|
30
30
|
},
|
|
31
31
|
"files": [
|
|
32
32
|
"bin",
|
|
33
|
+
"docs",
|
|
33
34
|
"src",
|
|
34
35
|
"targets"
|
|
35
36
|
],
|
|
36
37
|
"optionalDependencies": {
|
|
37
|
-
"@rujianjs/fcdev-cc65-win32-x64": "0.
|
|
38
|
-
"@rujianjs/fcdev-emulator-win32-x64": "0.
|
|
38
|
+
"@rujianjs/fcdev-cc65-win32-x64": "0.3.0",
|
|
39
|
+
"@rujianjs/fcdev-emulator-win32-x64": "0.3.0"
|
|
39
40
|
}
|
|
40
41
|
}
|
|
@@ -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
|
+
}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
// ------------------------------------------------------------------------
|
|
2
|
+
// 名称:docs-command.mjs
|
|
3
|
+
// 说明:docs 命令:列出开发文档的主题,查询某份文档的本机路径与在线地址。
|
|
4
|
+
// 作者:sungbin
|
|
5
|
+
// 邮箱:sungbin@3578.cn
|
|
6
|
+
// 日期:2026-11-11
|
|
7
|
+
// 备注:只读、不联网、不需要 fcdev.json;--json 输出机器可读格式。
|
|
8
|
+
// ------------------------------------------------------------------------
|
|
9
|
+
import { existsSync } from 'node:fs';
|
|
10
|
+
import { docsDirectory, listDocs, queryDocs } from '../../docs/index.mjs';
|
|
11
|
+
import { FcdevError } from '../../shared/index.mjs';
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* 执行 docs 命令。
|
|
15
|
+
* @param {{positionals: string[], options: {json: boolean}, context: import('../index.mjs').CliContext}} input 参数、选项与运行环境
|
|
16
|
+
* @returns {Promise<number>} 退出码
|
|
17
|
+
*/
|
|
18
|
+
export async function runDocsCommand({ positionals, options, context }) {
|
|
19
|
+
const directory = docsDirectory();
|
|
20
|
+
if (!existsSync(directory)) {
|
|
21
|
+
throw new FcdevError(`找不到文档目录:${directory}`, { code: 'DOCS_MISSING', hint: '这份 fcdev 不带文档,请改读在线文档,地址见 package.json 的 repository' });
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
const query = positionals.join(' ').trim();
|
|
25
|
+
if (query === '') {
|
|
26
|
+
const docs = listDocs();
|
|
27
|
+
if (options.json) {
|
|
28
|
+
context.stdout.write(`${JSON.stringify(docs, null, 2)}\n`);
|
|
29
|
+
return 0;
|
|
30
|
+
}
|
|
31
|
+
const width = Math.max(...docs.map((doc) => doc.topic.length));
|
|
32
|
+
const lines = [`fcdev 开发文档:${docs.length} 份`, `本机目录:${directory}`, ''];
|
|
33
|
+
for (const doc of docs) lines.push(` ${doc.topic.padEnd(width)} ${doc.title}:${doc.summary}`);
|
|
34
|
+
lines.push('', '查询:fcdev docs <主题>(本机路径与在线地址)、fcdev docs <词>(按主题、文件名、标题与说明搜索)');
|
|
35
|
+
context.stdout.write(`${lines.join('\n')}\n`);
|
|
36
|
+
return 0;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
const { kind, matches } = queryDocs(query);
|
|
40
|
+
if (matches.length === 0) {
|
|
41
|
+
throw new FcdevError(`没有找到“${query}”`, { code: 'DOCS_NOT_FOUND', hint: '不带查询词运行 fcdev docs 可以看到全部主题' });
|
|
42
|
+
}
|
|
43
|
+
if (options.json) {
|
|
44
|
+
context.stdout.write(`${JSON.stringify(matches, null, 2)}\n`);
|
|
45
|
+
return 0;
|
|
46
|
+
}
|
|
47
|
+
if (matches.length === 1) {
|
|
48
|
+
const [doc] = matches;
|
|
49
|
+
context.stdout.write(`${doc.title}(主题 ${doc.topic})\n说明:${doc.summary}\n本机:${doc.localPath}\n在线:${doc.onlineUrl}\n`);
|
|
50
|
+
return 0;
|
|
51
|
+
}
|
|
52
|
+
const width = Math.max(...matches.map((doc) => doc.topic.length));
|
|
53
|
+
const lines = [`包含“${query}”的文档:${matches.length} 份(${kind === 'file' ? '按文件名' : '按关键词'})`];
|
|
54
|
+
for (const doc of matches) lines.push(` ${doc.topic.padEnd(width)} ${doc.title}:${doc.summary}`);
|
|
55
|
+
lines.push('', '用 fcdev docs <主题> 查看某份文档的本机路径与在线地址');
|
|
56
|
+
context.stdout.write(`${lines.join('\n')}\n`);
|
|
57
|
+
return 0;
|
|
58
|
+
}
|
package/src/cli/index.mjs
CHANGED
|
@@ -9,10 +9,12 @@
|
|
|
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';
|
|
15
16
|
import { runDisasmCommand } from './commands/disasm-command.mjs';
|
|
17
|
+
import { runDocsCommand } from './commands/docs-command.mjs';
|
|
16
18
|
import { runInfoCommand } from './commands/info-command.mjs';
|
|
17
19
|
import { runRunCommand } from './commands/run-command.mjs';
|
|
18
20
|
import { runSyncCommand } from './commands/sync-command.mjs';
|
|
@@ -27,10 +29,12 @@ import { runSyncCommand } from './commands/sync-command.mjs';
|
|
|
27
29
|
|
|
28
30
|
/** 命令表:命令名到处理函数 */
|
|
29
31
|
const COMMANDS = {
|
|
32
|
+
api: runApiCommand,
|
|
30
33
|
build: runBuildCommand,
|
|
31
34
|
debug: runDebugCommand,
|
|
32
35
|
disasm: runDisasmCommand,
|
|
33
36
|
disk: runDiskCommand,
|
|
37
|
+
docs: runDocsCommand,
|
|
34
38
|
info: runInfoCommand,
|
|
35
39
|
run: runRunCommand,
|
|
36
40
|
sync: runSyncCommand,
|
|
@@ -49,6 +53,8 @@ const HELP_TEXT = `fcdev:6502 兼容机的开发工具
|
|
|
49
53
|
debug <命令> 把命令转发给模拟器的调试服务,如 debug run 60、debug shot out.png
|
|
50
54
|
sync 生成 IDE 的 C/C++ 配置
|
|
51
55
|
info [--json] 显示目标、工具链与头文件目录
|
|
56
|
+
api [词] [--json] 查询目标的 C 接口文档:函数名、模块名、$功能号或关键词;不带词列出全部模块
|
|
57
|
+
docs [词] [--json] 查询开发文档:主题名或关键词,给出本机路径与在线地址;不带词列出全部主题
|
|
52
58
|
|
|
53
59
|
选项:
|
|
54
60
|
--target <名> 指定目标,覆盖 fcdev.json
|