Eremey Valetov 99eb992ead Add DOS build script, compiler/DOS test harnesses, FreeDOS package, CI
- build_dos.sh: Linux-friendly cross-compile to DOS via OpenWatcom V2.
  OpenWatcom's wmake on Linux can't apply the .c.obj implicit rule for
  subdirectory paths, and Makefile.dos / Makefile.dos16 rely on DOS-
  only commands like 'del'.  Script invokes wcc / wcc386 directly,
  tracks 16-bit vs 32-bit mode via a stamp file (auto-cleans on
  switch), generates a wlink directive file (the brace-delimited file
  list wouldn't survive shell quoting), and supports clean.  The DOS
  Makefiles still work on Windows / DOS hosts.

- tests/run_compiler_tests.sh: AOT compiler harness.  For each .bas
  in tests/programs/, compiles via gwbasic-compile -c, runs the
  resulting executable, normalizes output and diffs against the
  golden file from tests/expected/.  Skip list covers chain/common
  multi-file flows, hardware/timing-dependent programs, unnumbered
  direct-mode programs (compiler requires line numbers), and
  misc_stmts/run_file (interpreter-vs-compiler ON ERROR divergence).
  Result: 56/56 pass.

- tests/run_dos_smoke.sh + dos_smoke.bas + expected: runs gwbasic16.exe
  under DOSBox-X (flatpak) with a program that exercises arithmetic,
  strings, control flow, GOSUB, FOR/NEXT, DATA/READ, DEF FN, OPEN/
  PRINT#/CLOSE, and diffs against the interpreter's golden output.
  Uses $HOME for the staging dir (DOSBox-X flatpak doesn't see /tmp).

- pkg/GWBASIC.LSM + pkg/build_pkg.sh: FreeDOS submission package.
  Produces dist/gwbasic-<VERSION>.zip with the standard FreeDOS
  layout (APPINFO/GWBASIC.LSM, BIN/GWBASIC.EXE, DOC/GWBASIC/{README,
  CHANGES,LICENSE} with CRLF, SOURCE/GWBASIC/<full source>).  Source
  tree is filtered through git ls-files to exclude build artifacts.

- docs/Makefile: standard Sphinx Makefile so 'cd docs && make html'
  works as documented in README.md.

- .github/workflows/ci.yml: split into two jobs.  build-and-test now
  also runs the compiler harness.  New dos-cross-compile job caches
  ~/openwatcom-v2, downloads the OpenWatcom V2 snapshot if not
  cached, builds both 16-bit and 32-bit DOS binaries, asserts size
  bounds, and uploads them as artifacts.

- .gitignore: ignore .dos_build_mode (script's stamp), .link_dir/
  (transient wlink directive dir), dist/ (package output).
2026-05-03 12:26:09 -04:00

GW-BASIC 2026

A portable C reimplementation of Microsoft GW-BASIC, using the original 8088 assembly source (released by Microsoft in 2020) as the authoritative reference.

This is not a transpilation -- it reimplements the algorithms in clean C11 with modern data structures while targeting bug-compatible behavior.

Building

cmake -B build && cmake --build build

Requires a C11 compiler and CMake 3.10+. PulseAudio (libpulse-simple) is optional -- detected at build time for SOUND/BEEP/PLAY support.

Builds three targets:

  • gwbasic -- the interpreter
  • gwbasic-compile -- the ahead-of-time compiler
  • libgwrt.a -- runtime library for compiled programs

Usage

Interactive mode launches the authentic GW-BASIC full-screen editor:

$ ./gwbasic
GW-BASIC 2026 0.17.0
(C) Eremey Valetov 2026. MIT License.
Based on Microsoft GW-BASIC assembly source.
Ok
PRINT 2+2
 4
Ok

Run a program file (ASCII or binary tokenized):

./gwbasic tests/programs/prime_sieve.bas

Compile to a native executable:

./gwbasic-compile tests/programs/fibonacci.bas -c --runtime .

Ahead-of-Time Compiler

gwbasic-compile translates BASIC programs to C source, then invokes GCC to produce native executables linked against libgwrt.a.

Pipeline: .bas → tokenizer → analysis → C codegen → gcc → native binary.

56 of 56 eligible test programs compile via gwbasic-compile and produce output matching the interpreter's golden files. Run bash tests/run_compiler_tests.sh to verify.

# Generate C source
./gwbasic-compile myprog.bas -o myprog.c

# Compile to executable (automatic)
./gwbasic-compile myprog.bas -c --runtime /path/to/gw-basic-2026

Jupyter Kernel

A Jupyter notebook kernel for GW-BASIC with inline Sixel graphics rendering, INPUT support, and Pygments syntax highlighting.

pip install -e .
gwbasickernel-install --user
jupyter notebook  # select "GW-BASIC 2026" kernel

What Works

100% token coverage -- all 144 GW-BASIC tokens are implemented.

Data types: INTEGER (%), SINGLE (!), DOUBLE (#), STRING ($)

Operators: + - * / ^ \ MOD AND OR XOR EQV IMP NOT < = > <= >= <>

Statements:

Category Statements
Output PRINT, LPRINT, LLIST, PRINT USING, WRITE, CLS
Variables LET, DIM, ERASE, SWAP, DEFINT/SNG/DBL/STR
Control flow GOTO, GOSUB/RETURN, FOR/NEXT, IF/THEN/ELSE, WHILE/WEND, ON...GOTO/GOSUB
Input INPUT, LINE INPUT, DATA/READ/RESTORE, INKEY$
Program RUN, CONT, STOP, END, NEW, LIST, CLEAR, AUTO, RENUM, DELETE, EDIT
Sequential I/O OPEN, CLOSE, PRINT#, WRITE#, INPUT#, LINE INPUT#
Random-access I/O FIELD, LSET, RSET, PUT, GET, CVI/CVS/CVD, MKI$/MKS$/MKD$
Program I/O SAVE (binary/ASCII), LOAD (auto-detects), MERGE, CHAIN, COMMON
Event trapping ON TIMER(n) GOSUB, TIMER ON/OFF/STOP, ON KEY(n) GOSUB
Error handling ON ERROR GOTO, RESUME, ERROR, ERR, ERL
User functions DEF FN, RANDOMIZE
File management KILL, NAME, FILES, MKDIR, RMDIR, CHDIR, SHELL, ENVIRON
Date/time DATE$, TIME$, TIMER
Screen LOCATE, COLOR, WIDTH, SCREEN, KEY ON/OFF/LIST
Graphics PSET, PRESET, LINE, CIRCLE, DRAW, PAINT, GET/PUT (sprites), VIEW, WINDOW, PALETTE, PMAP
Sound SOUND, BEEP, PLAY (MML)
Memory DEF SEG, PEEK, POKE, BSAVE, BLOAD
Hardware I/O OUT, INP, WAIT, MOTOR, STICK, STRIG

Tests

72 interpreter tests, 14 kernel tests, 56 compiler tests -- all passing.

bash tests/run_tests.sh              # interpreter
python -m gwbasickernel.test_kernel  # Jupyter kernel

DOS / FreeDOS

Cross-compiles to DOS with OpenWatcom V2:

wmake -f Makefile.dos16   # 16-bit real-mode (128KB standalone, no extender)
wmake -f Makefile.dos     # 32-bit DOS/4GW  (175KB, requires DOS4GW.EXE)

The 16-bit build runs on FreeDOS, MS-DOS, and compatible systems without a DOS extender. See Getting Started for details.

Documentation

Full Sphinx documentation in docs/:

cd docs && pip install -r requirements.txt && make html

License

MIT License. See LICENSE.

Description
Portable C reimplementation of Microsoft GW-BASIC, with an ahead-of-time compiler. Mirror of github.com/evvaletov/gw-basic-2026.
Readme 446 KiB
Languages
C 83.3%
BASIC 6.5%
Python 5.4%
Shell 4.3%
CMake 0.4%