Files
gw-basic-2026/docs/development.md
Eremey Valetov 70ffd39562 v0.17.0: BIOS-routed TUI on DOS, version banner, compiler PulseAudio link
QA findings from a multi-round review of the FreeDOS submission prep work:

- TUI rendering refactor: src/tui.c emitted ANSI escape sequences via
  printf, which displays as raw text on bare FreeDOS (no ANSI.SYS).
  Add four HAL ops (tui_enter, tui_leave, render_run, set_cursor_shape)
  and route per-cell rendering through them.  POSIX backend keeps the
  ANSI path; DOS backend drives BIOS INT 10h via the existing
  bios_set_cursor / bios_write_char helpers.  The TUI's logical cursor
  goes through the saved orig_locate to avoid recursing through the
  swapped-in gw_hal->locate.

- DOS extended-key mapping: dos_getch returns 0x100 | scancode for
  arrows / F-keys; tui_read_key wasn't translating those to its TK_*
  constants, so the editor never saw arrow keys or F1-F10 on DOS.
  Add a __MSDOS__-conditional translation table in tui_read_key.

- Version banner: GW_VERSION was still 0.16.0 even though the v0.17.0
  release prep was already in CHANGES.TXT.  Bump.

- Compiler PulseAudio link: gwbasic-compile -c hardcoded
  '-lgwrt -lm -lpthread' on the gcc command line.  When libgwrt was
  built against libpulse-simple (the default on any host with the
  PulseAudio dev headers installed), the compile workflow failed with
  'undefined reference to pa_simple_drain'.  CMake now passes
  GWRT_HAS_PULSEAUDIO to gwbasic-compile when libpulse is present, and
  the compiler appends -lpulse-simple to the link line.

- FRE("") garbage collection: the interpreter skipped strpool_gc with a
  comment 'unsafe during expression eval', but that's exactly what real
  GW-BASIC's FRE("") does (and the AOT compiler path already did).  Add
  the GC call; strpool_pin/unpin is the existing escape hatch if a
  caller has live pool pointers on the C stack.  Fixes the string_gc
  compat test.

- Test harness normalization: run_tests.sh stripped trailing whitespace
  on the actual output but not the expected file, causing spurious
  mismatches against golden files captured from real GWBASIC.EXE.
  Normalize both sides identically.  Fixes the peek_gfx mismatch.

- Print_using: snprintf into mantissa[32] with %.*f and an unbounded
  dec triggered a -Wformat-truncation warning.  Clamp dec to 20 (IEEE
  double has at most ~17 significant decimal digits).

- Doc/version consistency: 16-bit binary size reported as 127KB in one
  place and 128KB in three; standardize on 128KB.  HAL backend count
  said '1 file' but is now 2.  CI test count said 'all 66 test
  programs' but is 72.  Add a v0.17.0 row to the development.md table.
  Update getting-started.md DOS section to match the BIOS-rendering
  reality and add a manual TUI verification checklist.

- dos_init now writes back BIOS-reported cols/rows to dos_hal struct
  fields (forward-declared so dos_init can reference it).

After these changes: 72/72 interpreter tests pass, compat 68/68
matched, no warnings on the Linux build.
2026-05-03 12:25:41 -04:00

3.5 KiB

Development

Development History

Version Commit Description
0.1.0 d8e8375 Expression calculator with direct mode
0.2.0 6162595 Variables, arrays, program storage, control flow
0.3.0 c2d73e9 File I/O, PRINT USING, SAVE/LOAD, MID$ assignment, graphics stubs
0.4.0 df5c308 CHAIN, RUN "file", random-access I/O (FIELD/PUT/GET), CVI/CVS/CVD/MKI$/MKS$/MKD$
0.5.0 ad21350 Full-screen TUI editor, KEY statement, Ctrl+Break, Sixel graphics, SOUND/BEEP/PLAY, DOSBox-X compat testing, project rename
0.6.0 ece018d DATE$/TIME$/TIMER, FILES, SHELL, CHDIR, MKDIR, RMDIR
0.7.0 da6b513 AUTO, RENUM (with GOTO/GOSUB patching), DELETE, COMMON, LIST range fix
0.8.0 c68167c Dynamic TUI screen buffer, --full flag, LPRINT/LLIST with --lpt
0.9.0 2a8f98b EDIT statement, ON TIMER/ON KEY event trapping, F-key escape parser fixes
0.10.0 Binary tokenized SAVE/LOAD, INKEY$ extended key sequences, golden-file regression tests, classic BASIC programs
0.11.0 DEF SEG / PEEK / POKE virtual memory, GET/PUT graphics sprites, PRINT USING fixes
0.12.0 BSAVE/BLOAD, TUI ANSI 16-color rendering, CGA graphics framebuffer PEEK/POKE, keyboard shift flags
0.13.0 VIEW/WINDOW/PALETTE graphics, PMAP function, MBF float format for CVS/CVD/MKS$/MKD$
0.14.0 MBF binary file compatibility (IEEE↔MBF at save/load boundary), fix binary loader null-byte truncation, fix DRAW M/S/A bugs, add TA/=var;/X substring
0.15.0 Hardware I/O simulator, gap-fill (100% token coverage), string pool + compacting GC, Jupyter kernel (Sixel graphics, INPUT, Pygments), ahead-of-time compiler Phase 1
0.16.0 AOT compiler: all eligible tests pass (100%). CHAIN/COMMON/RUN "file" via runtime delegation, token embedding, string comparison, division-by-zero detection, FIELD read-back, graphics, file I/O delegation, RNG matching, dead code elimination
0.17.0 981aeab Compiler memory safety (--warn, --safe, --safe=sanitize); 16-bit real-mode DOS target (Makefile.dos16, far-heap TUI screen buffer); 32-bit DOS/4GW target (Makefile.dos); FreeDOS 1.4 compatibility

Tests

72 automated test programs in tests/programs/, plus 4 classic interactive programs in tests/classic/ (Hamurabi, Lunar Lander, Gunner, Diamond from David Ahl's BASIC Computer Games). 14 Jupyter kernel tests. 56 compiler tests (eligible numbered programs compiled to native executables via gwbasic-compile; run bash tests/run_compiler_tests.sh).

Run the full automated suite:

bash tests/run_tests.sh              # interpreter (72 tests)
python -m gwbasickernel.test_kernel  # Jupyter kernel (14 tests)

Each interpreter test has a 5-second timeout. 68 tests have .expected golden files for output regression detection. Tests without golden comparison: datetime, on_timer, timer_stop (timing-dependent), color_test (visual).

Compatibility Testing

Compare output against real GWBASIC.EXE running under DOSBox-X:

# Generate .expected files from GWBASIC.EXE (requires DOSBox-X Flatpak)
bash tests/run_compat.sh --generate

# Compare gwbasic output against .expected
bash tests/run_compat.sh

CI

GitHub Actions runs on every push to main and on pull requests. The workflow builds the project with PulseAudio support and runs all 72 test programs.

See .github/workflows/ci.yml.