andrew/akbasic
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
ad768892925d8f0bf217bcd1f2d06d63c951ca28
akbasic/tests/console_verbs.c

286 lines
10 KiB
C
Raw Normal View History

Finish the language: every remaining verb group, and the defects that blocked them Closes groups A, C, D, E, F, H and J of TODO.md section 4, plus RESTORE and RENUMBER, and closes section 6 -- all seventeen reference defects. Seven of those turned out to have been fixed or never ported and nobody had written it down; the audit records the evidence for each. Two of the seventeen were real. math_plus mutated its left operand when the operand was mutable, so A# + 1 could modify A#; it was gated on FOR/NEXT coverage because NEXT relied on the mutation, so tests/for_next.c came first and NEXT now writes the counter back itself. And the binary operators summed both numeric fields of their right operand, which no BASIC program can reach -- that one needed a test written against the value API. Writing the tests turned up eight defects nobody had listed. Seven are fixed: IF A = 2 THEN was a parse error; only == worked IF ... AND ... was a parse error, because a condition parsed as one relation IF A = 1 OR B = 2 THEN was silently always false, and so was IF A THEN EXIT before any NEXT restarted the program and exhausted the variable pool READ never found a DATA line above it, and swallowed the lines between PRINT 2 + 2 at the prompt was filed as program text instead of answering a short read discarded its bytes, so COPY produced empty files every verb taking an argument list said "peek() returned nil token!" on none The eighth is not fixed and cannot be quietly: a FOR whose step overshoots runs its body one extra time, and FOR I = 1 TO 1 runs it zero times. The two errors cancel for a step of 1, which is why neither was noticed. Correcting them changes the expected output of a checked-in acceptance file, and tests/reference/README.md forbids editing one to suit this interpreter. It is tests/for_semantics.c in AKBASIC_KNOWN_FAILING_TESTS, asserting the correct contract, and TODO.md items 19 and 20. Sprites are real libakgl actors with a renderfunc of their own, because akgl_actor_render draws every sprite square and an actor has no per-axis scale. Both are filed upstream. SPRSAV takes an image file, an SSHAPE handle or a 63-element integer array -- a string here cannot hold a zero byte. Verbs that need hardware that does not exist are refused by name with the reason rather than faked: SYS, HEADER, COLLECT, BACKUP, BOOT, FILTER, and DIRECTORY, which is refused for a missing libakstdlib wrapper filed upstream. 94 tests in the default build, 93 with SDL, 94 under ASan and UBSan, doxygen clean. The Go acceptance corpus stayed green throughout. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-07-31 21:50:37 -04:00
/**
* @file console_verbs.c
* @brief Tests the group E verbs: SLEEP, WAIT, KEY, WINDOW and the TI clock.
*
* The two that wait are the interesting ones, and what they have to prove is
* that they *do not block*: a held step still returns, so a bounded
* akbasic_runtime_run() comes back on time and a host keeps its frame rate.
* Section 1.6 is the rule and this is where it is checked for group E.
*/
#include <string.h>
#include <akbasic/error.h>
#include <akbasic/runtime.h>
#include "harness.h"
#include "testutil.h"
/** @brief Load a program and put the runtime in RUN mode without stepping it. */
static akerr_ErrorContext AKERR_NOIGNORE *load_program(const char *source)
{
PREPARE_ERROR(errctx);
PASS(errctx, harness_start(NULL));
PASS(errctx, akbasic_runtime_load(&HARNESS_RUNTIME, source));
PASS(errctx, akbasic_runtime_start(&HARNESS_RUNTIME, AKBASIC_MODE_RUN));
SUCCEED_RETURN(errctx);
}
/** @brief Run a program to completion in RUN mode. */
static akerr_ErrorContext AKERR_NOIGNORE *run_program(const char *source)
{
PREPARE_ERROR(errctx);
PASS(errctx, load_program(source));
PASS(errctx, akbasic_runtime_run(&HARNESS_RUNTIME, 0));
SUCCEED_RETURN(errctx);
}
/** @brief SLEEP holds the step loop until the host's clock passes its deadline. */
static void test_sleep(void)
{
TEST_REQUIRE_OK(load_program("1 PRINT \"BEFORE\"\n"
"2 SLEEP 5\n"
"3 PRINT \"AFTER\"\n"));
TEST_REQUIRE_OK(akbasic_runtime_settime(&HARNESS_RUNTIME, 1000));
/* Line 0, line 1, line 2 -- the SLEEP arms and the program stops advancing. */
TEST_REQUIRE_OK(akbasic_runtime_run(&HARNESS_RUNTIME, 3));
TEST_REQUIRE_STR(HARNESS_OUTPUT, "BEFORE\n");
TEST_REQUIRE(HARNESS_RUNTIME.console_state.sleeping, "SLEEP should be holding");
/*
* Twenty more steps with the clock standing still change nothing -- and,
* crucially, they *return*. A SLEEP that blocked would never get here.
*/
TEST_REQUIRE_OK(akbasic_runtime_run(&HARNESS_RUNTIME, 20));
TEST_REQUIRE_STR(HARNESS_OUTPUT, "BEFORE\n");
/* Past the deadline, it wakes. */
TEST_REQUIRE_OK(akbasic_runtime_settime(&HARNESS_RUNTIME, 6500));
TEST_REQUIRE_OK(akbasic_runtime_run(&HARNESS_RUNTIME, 2));
TEST_REQUIRE_STR(HARNESS_OUTPUT, "BEFORE\nAFTER\n");
TEST_REQUIRE(!HARNESS_RUNTIME.console_state.sleeping, "SLEEP should have finished");
harness_stop();
}
/** @brief A host that never sets a clock does not hang on SLEEP. */
static void test_sleep_without_a_clock(void)
{
TEST_REQUIRE_OK(run_program("1 SLEEP 10\n2 PRINT \"THROUGH\"\n"));
TEST_REQUIRE_STR(HARNESS_OUTPUT, "THROUGH\n");
harness_stop();
}
/** @brief SLEEP refuses a negative interval rather than waiting forever. */
static void test_sleep_refuses_negative(void)
{
TEST_REQUIRE_OK(run_program("10 SLEEP -1\n"));
TEST_REQUIRE(strstr(HARNESS_OUTPUT, "negative number of seconds") != NULL,
"SLEEP -1 should be refused, got \"%s\"", HARNESS_OUTPUT);
harness_stop();
}
/**
* @brief WAIT polls a byte and holds until it matches, without blocking.
*
* The address is a real one -- this test's own variable -- which is the only
* honest way to exercise it: on a C128 the byte is a hardware register, and here
* the only thing that can change it is something outside the program.
*/
static void test_wait(void)
{
static volatile uint8_t watched = 0;
char source[256];
watched = 0;
snprintf(source, sizeof(source),
"1 WAIT %llu, 1\n2 PRINT \"RELEASED\"\n",
(unsigned long long)(uintptr_t)&watched);
TEST_REQUIRE_OK(load_program(source));
TEST_REQUIRE_OK(akbasic_runtime_run(&HARNESS_RUNTIME, 4));
TEST_REQUIRE_STR(HARNESS_OUTPUT, "");
TEST_REQUIRE(HARNESS_RUNTIME.console_state.waiting, "WAIT should be holding");
/* Still returning, which is the whole point. */
TEST_REQUIRE_OK(akbasic_runtime_run(&HARNESS_RUNTIME, 20));
TEST_REQUIRE_STR(HARNESS_OUTPUT, "");
watched = 1;
TEST_REQUIRE_OK(akbasic_runtime_run(&HARNESS_RUNTIME, 2));
TEST_REQUIRE_STR(HARNESS_OUTPUT, "RELEASED\n");
harness_stop();
}
/** @brief KEY stores a macro per key, and bare KEY lists all eight. */
static void test_key(void)
{
TEST_REQUIRE_OK(run_program("10 KEY 1, \"RUN\"\n"
"20 KEY 3, \"LIST\"\n"
"30 KEY\n"));
TEST_REQUIRE(strstr(HARNESS_OUTPUT, "KEY 1, \"RUN\"") != NULL,
"KEY should list its macros, got \"%s\"", HARNESS_OUTPUT);
TEST_REQUIRE(strstr(HARNESS_OUTPUT, "KEY 3, \"LIST\"") != NULL,
"KEY should list its macros, got \"%s\"", HARNESS_OUTPUT);
TEST_REQUIRE(strstr(HARNESS_OUTPUT, "KEY 8, \"\"") != NULL,
"KEY should list undefined keys too, got \"%s\"", HARNESS_OUTPUT);
harness_stop();
TEST_REQUIRE_OK(run_program("10 KEY 9, \"NOPE\"\n"));
TEST_REQUIRE(strstr(HARNESS_OUTPUT, "outside 1..8") != NULL,
"KEY 9 should be refused, got \"%s\"", HARNESS_OUTPUT);
harness_stop();
}
/** @brief WINDOW refuses against a sink with no character grid, which is stdio. */
static void test_window_needs_a_grid(void)
{
TEST_REQUIRE_OK(run_program("10 WINDOW 1, 1, 20, 10\n"));
TEST_REQUIRE(strstr(HARNESS_OUTPUT, "character grid") != NULL,
"WINDOW against a stdio sink should refuse by name, got \"%s\"",
HARNESS_OUTPUT);
harness_stop();
/* An inside-out rectangle is refused before the device is even consulted. */
TEST_REQUIRE_OK(run_program("10 WINDOW 20, 10, 1, 1\n"));
TEST_REQUIRE(strstr(HARNESS_OUTPUT, "bottom right") != NULL,
"an inverted WINDOW should be refused, got \"%s\"", HARNESS_OUTPUT);
harness_stop();
}
Let a program ask how big the text grid is `RGR(1)` and `RGR(2)` gave the window in pixels and nothing gave columns, rows or the cell size -- so anything placing a character *and* a sprite at the same spot had to hardcode a number measured by hand against whatever font the host loaded. The Breakout in examples/ does exactly that, `CW# = 16`, and it is the one thing in that listing that breaks on a different font or window. **`RWINDOW` is BASIC 7.0's own answer and had never been implemented here.** `RWINDOW(0)` is the current text window's rows and `RWINDOW(1)` its columns. `RWINDOW(2)` reports a C128's 40 or 80 column screen mode, and this interpreter has neither -- refused by name, because answering 0 would be a plausible lie, which is worse than a refusal that says why. The cell size in pixels is `RGR(3)` and `RGR(4)`, beside the surface's own dimensions rather than on `RWINDOW`. Two reasons: a cell size is a fact about the surface, and `RWINDOW` reports the *window*, so dividing `RGR(1)` by a column count stops being right the moment a program calls `WINDOW`. Both read a new optional `grid` entry point on `akbasic_TextSink` -- columns, rows, cell width, cell height -- implemented by the akgl sink and forwarded by the tee, in the shape `moveto` and `window` already had. NULL everywhere else, so both verbs refuse by name against a sink with no grid. `akbasic_sink_init_ stdio()` clears it for the same reason it now clears the other two. Measured on the standalone build: `RGR(3)` answers 16 and `RWINDOW` answers 50 columns by 37 rows -- the three numbers the Breakout listing had written out as constants -- and `RWINDOW` follows a `WINDOW` call while `RGR(3)` does not. tests/console_verbs.c drives the answers through a stand-in sink with a grid, since the harness sink is stdio and has none; tests/graphics_verbs.c covers the new `RGR` fields, their refusal, and the moved range bound. The `c excerpt=` block in docs/10-embedding.md moves with the header, which is `docs_examples` doing its job. TODO.md section 6 item 31's second half, struck. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-02 00:05:17 -04:00
/*
* A grid a stdio sink does not have.
*
* `RWINDOW` and `RGR(3)`/`RGR(4)` read the sink's grid, and the harness sink is
* stdio, which has none -- so without a stand-in the only thing assertable here
* is the refusal. This is the akgl sink's shape without the SDL: the runtime
* asks through a function pointer and does not care who answers.
*
* Windowing changes the columns and rows and leaves the cell size alone, which
* is the distinction RWINDOW and RGR are split across, so the fake honours it.
*/
static int FAKE_COLUMNS = 50;
static int FAKE_ROWS = 37;
static akerr_ErrorContext AKERR_NOIGNORE *fake_grid(akbasic_TextSink *self, int *columns, int *rows, int *cellw, int *cellh)
{
PREPARE_ERROR(errctx);
(void)self;
FAIL_ZERO_RETURN(errctx, (columns != NULL && rows != NULL && cellw != NULL && cellh != NULL),
AKERR_NULLPOINTER, "NULL destination in fake grid");
*columns = FAKE_COLUMNS;
*rows = FAKE_ROWS;
*cellw = 16;
*cellh = 16;
SUCCEED_RETURN(errctx);
}
static akerr_ErrorContext AKERR_NOIGNORE *fake_window(akbasic_TextSink *self, int left, int top, int right, int bottom)
{
PREPARE_ERROR(errctx);
(void)self;
FAKE_COLUMNS = (right - left) + 1;
FAKE_ROWS = (bottom - top) + 1;
SUCCEED_RETURN(errctx);
}
/**
* @brief `RWINDOW` and the cell-size `RGR` fields report the grid.
*
* A program had no way to ask how big a character is, so anything placing a
* character *and* a sprite at the same spot hardcoded a cell size measured
* against whatever font the host loaded. The Breakout in `examples/` did, and it
* was the one thing in that listing that broke on a different window. TODO.md
* section 6 item 31.
*/
static void test_rwindow(void)
{
/* Without a grid, both refuse by name rather than answering something. */
TEST_REQUIRE_OK(run_program("10 PRINT RWINDOW(0)\n"));
TEST_REQUIRE(strstr(HARNESS_OUTPUT, "character grid") != NULL,
"RWINDOW against a stdio sink should refuse by name, got \"%s\"",
HARNESS_OUTPUT);
harness_stop();
FAKE_COLUMNS = 50;
FAKE_ROWS = 37;
TEST_REQUIRE_OK(load_program("10 PRINT RWINDOW(0)\n"
"20 PRINT RWINDOW(1)\n"
"30 PRINT RGR(3)\n"
"40 PRINT RGR(4)\n"));
HARNESS_SINK.grid = fake_grid;
TEST_REQUIRE_OK(akbasic_runtime_run(&HARNESS_RUNTIME, 0));
/* Rows first: that is RWINDOW's own order on a C128, and it is not obvious. */
TEST_REQUIRE_STR(HARNESS_OUTPUT, "37\n50\n16\n16\n");
harness_stop();
/* RWINDOW follows a WINDOW; the cell size does not, because windowing does
not change how big a character is. */
FAKE_COLUMNS = 50;
FAKE_ROWS = 37;
TEST_REQUIRE_OK(load_program("10 WINDOW 0, 0, 19, 4\n"
"20 PRINT RWINDOW(1)\n"
"30 PRINT RWINDOW(0)\n"
"40 PRINT RGR(3)\n"));
HARNESS_SINK.grid = fake_grid;
HARNESS_SINK.window = fake_window;
TEST_REQUIRE_OK(akbasic_runtime_run(&HARNESS_RUNTIME, 0));
TEST_REQUIRE_STR(HARNESS_OUTPUT, "20\n5\n16\n");
HARNESS_SINK.window = NULL;
harness_stop();
/*
* Field 2 is refused by name. A C128 answers 0 for 40-column mode and 1 for
* 80-column; this interpreter has neither, and answering 0 would be a
* plausible lie -- which is worse than a refusal that says why.
*/
FAKE_COLUMNS = 50;
FAKE_ROWS = 37;
TEST_REQUIRE_OK(load_program("10 PRINT RWINDOW(2)\n"));
HARNESS_SINK.grid = fake_grid;
TEST_REQUIRE_OK(akbasic_runtime_run(&HARNESS_RUNTIME, 0));
TEST_REQUIRE(strstr(HARNESS_OUTPUT, "40 or 80 column mode") != NULL,
"RWINDOW(2) should be refused by name, got \"%s\"", HARNESS_OUTPUT);
harness_stop();
TEST_REQUIRE_OK(load_program("10 PRINT RWINDOW(7)\n"));
HARNESS_SINK.grid = fake_grid;
TEST_REQUIRE_OK(akbasic_runtime_run(&HARNESS_RUNTIME, 0));
TEST_REQUIRE(strstr(HARNESS_OUTPUT, "outside 0..1") != NULL,
"RWINDOW(7) should be out of range, got \"%s\"", HARNESS_OUTPUT);
harness_stop();
}
Finish the language: every remaining verb group, and the defects that blocked them Closes groups A, C, D, E, F, H and J of TODO.md section 4, plus RESTORE and RENUMBER, and closes section 6 -- all seventeen reference defects. Seven of those turned out to have been fixed or never ported and nobody had written it down; the audit records the evidence for each. Two of the seventeen were real. math_plus mutated its left operand when the operand was mutable, so A# + 1 could modify A#; it was gated on FOR/NEXT coverage because NEXT relied on the mutation, so tests/for_next.c came first and NEXT now writes the counter back itself. And the binary operators summed both numeric fields of their right operand, which no BASIC program can reach -- that one needed a test written against the value API. Writing the tests turned up eight defects nobody had listed. Seven are fixed: IF A = 2 THEN was a parse error; only == worked IF ... AND ... was a parse error, because a condition parsed as one relation IF A = 1 OR B = 2 THEN was silently always false, and so was IF A THEN EXIT before any NEXT restarted the program and exhausted the variable pool READ never found a DATA line above it, and swallowed the lines between PRINT 2 + 2 at the prompt was filed as program text instead of answering a short read discarded its bytes, so COPY produced empty files every verb taking an argument list said "peek() returned nil token!" on none The eighth is not fixed and cannot be quietly: a FOR whose step overshoots runs its body one extra time, and FOR I = 1 TO 1 runs it zero times. The two errors cancel for a step of 1, which is why neither was noticed. Correcting them changes the expected output of a checked-in acceptance file, and tests/reference/README.md forbids editing one to suit this interpreter. It is tests/for_semantics.c in AKBASIC_KNOWN_FAILING_TESTS, asserting the correct contract, and TODO.md items 19 and 20. Sprites are real libakgl actors with a renderfunc of their own, because akgl_actor_render draws every sprite square and an actor has no per-axis scale. Both are filed upstream. SPRSAV takes an image file, an SSHAPE handle or a 63-element integer array -- a string here cannot hold a zero byte. Verbs that need hardware that does not exist are refused by name with the reason rather than faked: SYS, HEADER, COLLECT, BACKUP, BOOT, FILTER, and DIRECTORY, which is refused for a missing libakstdlib wrapper filed upstream. 94 tests in the default build, 93 with SDL, 94 under ASan and UBSan, doxygen clean. The Go acceptance corpus stayed green throughout. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-07-31 21:50:37 -04:00
/** @brief TI# counts jiffies and TI$ formats them, both from the host's clock. */
static void test_ti(void)
{
TEST_REQUIRE_OK(load_program("1 PRINT TI#\n2 PRINT TI$\n"));
/* 3661 seconds is 01:01:01, and 3661 * 60 jiffies. */
TEST_REQUIRE_OK(akbasic_runtime_settime(&HARNESS_RUNTIME, 3661000));
TEST_REQUIRE_OK(akbasic_runtime_run(&HARNESS_RUNTIME, 3));
TEST_REQUIRE_STR(HARNESS_OUTPUT, "219660\n010101\n");
harness_stop();
/* A host with no clock has a stopped one rather than a wrong one. */
TEST_REQUIRE_OK(run_program("1 PRINT TI$\n"));
TEST_REQUIRE_STR(HARNESS_OUTPUT, "000000\n");
harness_stop();
}
int main(void)
{
test_sleep();
test_sleep_without_a_clock();
test_sleep_refuses_negative();
test_wait();
test_key();
test_window_needs_a_grid();
Let a program ask how big the text grid is `RGR(1)` and `RGR(2)` gave the window in pixels and nothing gave columns, rows or the cell size -- so anything placing a character *and* a sprite at the same spot had to hardcode a number measured by hand against whatever font the host loaded. The Breakout in examples/ does exactly that, `CW# = 16`, and it is the one thing in that listing that breaks on a different font or window. **`RWINDOW` is BASIC 7.0's own answer and had never been implemented here.** `RWINDOW(0)` is the current text window's rows and `RWINDOW(1)` its columns. `RWINDOW(2)` reports a C128's 40 or 80 column screen mode, and this interpreter has neither -- refused by name, because answering 0 would be a plausible lie, which is worse than a refusal that says why. The cell size in pixels is `RGR(3)` and `RGR(4)`, beside the surface's own dimensions rather than on `RWINDOW`. Two reasons: a cell size is a fact about the surface, and `RWINDOW` reports the *window*, so dividing `RGR(1)` by a column count stops being right the moment a program calls `WINDOW`. Both read a new optional `grid` entry point on `akbasic_TextSink` -- columns, rows, cell width, cell height -- implemented by the akgl sink and forwarded by the tee, in the shape `moveto` and `window` already had. NULL everywhere else, so both verbs refuse by name against a sink with no grid. `akbasic_sink_init_ stdio()` clears it for the same reason it now clears the other two. Measured on the standalone build: `RGR(3)` answers 16 and `RWINDOW` answers 50 columns by 37 rows -- the three numbers the Breakout listing had written out as constants -- and `RWINDOW` follows a `WINDOW` call while `RGR(3)` does not. tests/console_verbs.c drives the answers through a stand-in sink with a grid, since the harness sink is stdio and has none; tests/graphics_verbs.c covers the new `RGR` fields, their refusal, and the moved range bound. The `c excerpt=` block in docs/10-embedding.md moves with the header, which is `docs_examples` doing its job. TODO.md section 6 item 31's second half, struck. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-02 00:05:17 -04:00
test_rwindow();
Finish the language: every remaining verb group, and the defects that blocked them Closes groups A, C, D, E, F, H and J of TODO.md section 4, plus RESTORE and RENUMBER, and closes section 6 -- all seventeen reference defects. Seven of those turned out to have been fixed or never ported and nobody had written it down; the audit records the evidence for each. Two of the seventeen were real. math_plus mutated its left operand when the operand was mutable, so A# + 1 could modify A#; it was gated on FOR/NEXT coverage because NEXT relied on the mutation, so tests/for_next.c came first and NEXT now writes the counter back itself. And the binary operators summed both numeric fields of their right operand, which no BASIC program can reach -- that one needed a test written against the value API. Writing the tests turned up eight defects nobody had listed. Seven are fixed: IF A = 2 THEN was a parse error; only == worked IF ... AND ... was a parse error, because a condition parsed as one relation IF A = 1 OR B = 2 THEN was silently always false, and so was IF A THEN EXIT before any NEXT restarted the program and exhausted the variable pool READ never found a DATA line above it, and swallowed the lines between PRINT 2 + 2 at the prompt was filed as program text instead of answering a short read discarded its bytes, so COPY produced empty files every verb taking an argument list said "peek() returned nil token!" on none The eighth is not fixed and cannot be quietly: a FOR whose step overshoots runs its body one extra time, and FOR I = 1 TO 1 runs it zero times. The two errors cancel for a step of 1, which is why neither was noticed. Correcting them changes the expected output of a checked-in acceptance file, and tests/reference/README.md forbids editing one to suit this interpreter. It is tests/for_semantics.c in AKBASIC_KNOWN_FAILING_TESTS, asserting the correct contract, and TODO.md items 19 and 20. Sprites are real libakgl actors with a renderfunc of their own, because akgl_actor_render draws every sprite square and an actor has no per-axis scale. Both are filed upstream. SPRSAV takes an image file, an SSHAPE handle or a 63-element integer array -- a string here cannot hold a zero byte. Verbs that need hardware that does not exist are refused by name with the reason rather than faked: SYS, HEADER, COLLECT, BACKUP, BOOT, FILTER, and DIRECTORY, which is refused for a missing libakstdlib wrapper filed upstream. 94 tests in the default build, 93 with SDL, 94 under ASan and UBSan, doxygen clean. The Go acceptance corpus stayed green throughout. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-07-31 21:50:37 -04:00
test_ti();
return akbasic_test_failures;
}
Reference in New Issue Copy Permalink