bbc-basic: Don't try to add "deb-src" entries in Dockerfile.

Apparently that wasn't necessary, and indeed broke the build, on other
systems.

bbc-basic: Create a suitable Dockerfile and adapt "run" script.

The dockerfile uses the Ubuntu source package of Brandy to build a
text-only version for testing.  The "run" script no longer depends on
the existence of sbrandy in a particular place in my home directory.

bbc-basic: Minor README updates.

bbc-basic: Refer to the trees we use for hash-maps as "crit-bit trees".

That seems to be the generic term, with PATRICIA being a particular
early implementaion.

bbc-basic: Replace PROCmake_macro with FNas_macro.

FNas_macro makes a copy of its argument, converted into a macro, by
analogy with FNas_list and FNas_vector.

bbc-basic: Change how empty collections work.

Rather that recognising them by address, they now have a special bit
set in their type words.  That means that adding metadata to an empty
collection doesn't cause it to cease being properly empty.

bbc-basic: Remove unused PROClist_to_array and FNarray_to_list.

bbc-basic: Upgrade to the gensym-based 'or'.

bbc-basic: Allow metadata on non-function types.

This is currently broken, but it passes all the tests, so I'll need
some better tests.

bbc-basic: Add 'seq' core function.

bbc-basic: Add 'string?', 'number?', 'fn?', and 'macro?' core functions.

bbc-basic: Implement 'conj' core function.

bbc-basic: Add 'time-ms' core function.

It uses TIME, since that's easily available on all platforms.

bbc-basic: Add step A to the RISC OS tokenizing script.

bbc-basic: Pass '-path' to Brandy so self-hosting tests find libraries.

bbc-basic: Enlarge the reader token buffer again.

The later self-hosting steps are quite large.

bbc-basic: Stub implementations of optional step A core functions.

These need to be present (but not functional) for the self-hosted mal to work.

bbc-basic: Simplify type codes.

Z%(x,2) and Z%(x,3) are always pointers or nil, so there's no need to
record whether they're used: FNgc_mark can just unconditionally mark
them.  This means that the only interesting question is whether Z%(x,1)
is a pointer, a string, or something else, which can be encoded in two
bits.  This still leaves us using five bits for the type code, but I
think the avoidance of special-case code is worth spending a bit on.

bbc-basic: Simplify 'first' and 'rest'.

Rather than special-casing the empty list/vector, arrange that the
dedicated empty list/vector objects have the correct values in their
first and rest pointers.  Still dithering about whether to do that
to 'nil' as well.

This does mean that the internal FNfirst and FNrest don't error on an
empty list any more.  Nothing should have depended on that, but it might
mask some bugs.

bbc-basic: Add the README file that I've had kicking around for a while.

bbc-basic: Increase reader token buffer again to 1024.

Running the self-hosting tests looks to require this.

bbc-basic: Add '*host-language*' and a startup banner.

bbc-basic: Metadata support, including 'meta' and 'with-meta'.

bbc-basic: Redesign storage of functions to use two cells.

Functions were the only type using all three columns of Z%().  By
reducing that to two (at the expense of spreading a function over two
cells), we make space for storing a metadata pointer in Z%(x,3) of all
types.

bbc-basic: Add 'readline' core function.

bbc-basic: Beginning of step A.

bbc-basic: Make sure that '&' parameters are in a list, not a vector.

bbc-basic: Add 'dissoc' and 'vals' core functions.

bbc-basic: Add 'assoc' and 'keys' core functions.

'hash-map' is now implemented in terms of 'assoc'.

bbc-basic: Add 'get' and 'contains?' core functions.

bbc-basic: Adjust heap size so that step 8 doesn't suffer a stack overflow.

bbc-basic: PATRICIA hashmaps now mostly working.  Stack overflow in step 8.

bbc-basic: PATRICIA hashmaps now working up to step 2.

bbc-basic: Start of conversion to PATRICIA hashmaps: single-element hash-maps.

Not very useful, but enough to pass step 1.

bbc-basic: Rework of type identifiers to be more semantically useful.

Now the bottom four bits indicate the semantics of the various columns
of Z%, so the garbage collector can operate with no knowledge of any
specific types.  Instead, it can directly tell which fields need
followed when marking, and which represent strings to be freed.

bbc-basic: Implement 'hash-map' and 'map?' core functions.

bbc-basic: Correct error for core function argument not being a string.

bbc-basic: Make FNhashmap_contains, FNhashmap_get, and FNenv_find iterative.

Since BASIC doesn't do tail-call optimisation, we were needlessly
burning a lot of stack.

Now passes all tests (including deferrable and optional) up to step 8.

bbc-basic: Enlarge token buffer to 512 entries.

core.mal needed more than the 255 we allowed before.

bbc-basic: Add support for hash-maps to FNeval_ast (deferred from step 2).

bbc-basic: Simplify reader-macro code using FNalloc_list2.

bbc-basic: Add support for '^' reader macro.

bbc-basic: Reading and printing support for hash-maps (deferred from step 1).

bbc-basic: '*ARGV*' support when running under RISC OS.

This uses OS_GetEnv to get the command line, and OS_GSTrans to split it
into words, discarding the usual prefix for a BASIC program.

bbc-basic: Move argv extraction into its own function.

That way it's not in the way as it gets more complicated.

bbc-basic: Nicer '*ARGV*' construction.

Now implementation-specific code constructs a list containing all the
arguments (including the mal script name) and then generic code stuffs
the tail of that list into '*ARGV*' and calls 'load-file' on the head.

This should make it practical to move the per-platform argv-gathering
code into a function.

bbc-basic: Handle command-line arguments under Brandy (deferred from step 6).

This includes running the file named by the first argument and stuffing
the rest into '*ARGV*'.  Doing this under RISC OS will be trickier
because we have to do word-splitting ourselves (and probably use
OS_GSTrans to provide quoting).

I think this is the first Brandy-specific code in mal.

bbc-basic: Add scripts to tokenize BASIC files for use under RISC OS.

There's an Obey file that gets BASIC to TEXTLOAD each source file and
the SAVE it out into the "riscos" directory.

bbc-basic: Always use the same interpretation of the GC mark bit.

We now always set it when marking and clear it when sweeping, rather
than inverting it on each GC pass.  This is slightly less confusing, and
also means the code matches the description of naïve mark-and-sweep in
Wikipedia.

bbc-basic: Fix tokenizer handling of comments.

Now newline correctly terminates comments, which means it has to be
treated differently from other whitespace.  Rather than returning
comments as a kind of token (and requiring the reader to skip them),
the tokenizer just consumes them as though they were whitespace.

bbc-basic: Make sure 'rest' always returns a list.

bbc-basic: Make 'first' and 'rest' work properly on nil values.

bbc-basic: Rename list-manipulating functions to match their mal counterparts.

FNlist_car becomes FNfirst
FNlist_cdr becomes FNrest
FNlist_nth becomes FNnth
FNlist_len becomes FNcount

This makes out terminology more mal-ish, and also avoids mentioning
lists in the names of functions that also work on vectors.  Note that in
edge cases (empty sequences, nil), these functions don't quite have
their mal semantics, so the core library still does some remapping.

bbc-basic: Add 'vector', 'vector?', and 'sequential?' core functions.

bbc-basic: Extend vector support throughout steps 2 to 9.

bbc-basic: Minimal support for vectors (read/print only, deferred from step 1).

A vector is just a list in a silly hat, or more precisely a special flag
in its head cell.  This means that all the list functions work on
vectors as well, but it may be necessary to rename them in order to
avoid confusion, since at least FNis_list needs to be more specific in
order for FNEVAL to work properly.

bbc-basic: Add 'symbol', 'keyword' and 'keyword?' core functions.

bbc-basic: Add minimal support for keywords (deferred from step 1).

They're implemented as prefixed strings, as suggested by the guide.

bbc-basic: Rework try*/catch*.

This separates out the trying part into its own function, which
returns any exception that got thrown, or returns the result if no
exception occurred.  This has two significant advantages.  First, it
means that the shadow stack gets reset before the 'catch*' clause it
run, so unrechable objects allocated by the failed code become
collectable.  Second, it makes it possible (not that I've done so) to
adjust the code to cope with ARM BBC BASIC's failure to restore LOCAL
variables before running an ON ERROR LOCAL handler.  FNtry can now
safely assume that none of _its_ LOCAL variables will be corrupted
because the ones that matter are unique to FNtry, and any FNtry called
further down the stack will not propagate or raise an exception.

bbc-basic: Tolerable shadow-stack handling in 'try*'.

Now catching an exception doesn't leak memory.  It's still a slight
mess, though, since memory allocated in the "try" part is retained
until the end of the "catch".

bbc-basic: Make FNgc_save/PROCgc_restore more useful and less confusing.

FNgc_save now creates a new stack frame, so PROCgc_restore precisely
reverses the effect of FNgc_save (along with freeing any stack frames
pushed since FNgc_save).  This means it doesn't surprisingly destroy the
current stack frame.  This requires changes to each step file to adjust
the REPL to these new semantics.

bbc-basic: Add 'nil?', 'true?', 'false?', 'symbol?' core functions.

All mandatory tests for step 9 now pass, but I think the interaction
between exception handling and GC still needs investigation.

bbc-basic: Implement 'map' core function.

bbc-basic: Add 'apply' core function.

bbc-basic: Start of step 9: add 'try*' form and 'throw'.

I haven't attempted to get the interaction with the garbage-collector
right, so it's almost certainly terribly wrong.

bbc-basic: Adjust error message from FNenv_get to match tests.

The step 9 tests define the precise text of the message when a symbol
isn't found in an environment, so follow them.

bbc-basic: Make FNlist_nth fail correctly when passed an empty list.

It failed before, but not with the correct error, and the step 9 tests
depend on the correct error.

bbc-basic: Define 'cond' and 'or' macros at startup, completing step 8.

bbc-basic: Add support for variadic functions (deferred from step 4).

bbc-basic: Add 'nth', 'first', and 'rest' core functions.

bbc-basic: Mandatory parts of step 8 completed.

That's macro expansion and the 'macroexpand' special form.

bbc-basic: Have FNenv_find return nil on failure rather then erroring.

This matches the mal implementation and makes the code for
FNis_macro_call a little less hairy.  It doesn't seem to have broken
anything.

bbc-basic: Start of step 8: minimal support for 'defmacro!'.

Nothing yet treats macros any differently from ordinary functions.

bbc-basic: Implement 'concat' and 'quasiquote'.  Step 7 done.

bbc-basic: Add 'quote'.

bbc-basic: Start of step 7: implement 'cons'.

bbc-basic: Implement 'swap!'.  That's step 6 done.

bbc-basic: In the 'apply' step of FNEVAL, use car% if we have it.

In most cases, it already contains the target function, so there's no
need to extract that from ast% again.

bbc-basic: Abolish "malio" abstraction.

When I started this port, it looked like it might be necessary to jump
through silly hoops to get Brandy (and maybe ARM BBC BASIC V) to
communicate with the mal test harness.  In practice, though, that hasn't
been necessary: Brandy's "simpletext" interface works well enough and I
expect RISC OS's I/O redirection will be good enough if I ever try to
test on RISC OS.

bbc-basic: Substantial redesign of how core functions work.

FNcore_call now takes a mal list of arguments rather than an array.
FNcore_assert_args has become FNcore_prepare_args and now handles
unboxing arguments where that's sensible.

This should make 'swap!' and 'apply' easier to write in that it won't be
necessary to convert argument lists repeatedly between lists and arrays.
Finally, it avoids the silly situation where args%() was (accidentally,
but necessarily) one element larger than needed to hold the actual list
of arguments.

bbc-basic: Add -quit to the Brandy command line so that it exits spontaneously.

bbc-basic: Align the spec of FNlist_nth with 'nth'.

It now counts from zero (like BBC BASIC arrays) rather than 1 (like BBC
BASIC strings).

bbc-basic: Expect to find Brandy in $HOME rather than /tmp.

Should slightly reduce how often I have to recompile it.

bbc-basic: Slightly increase test timeout.

40 seconds wasn't enough if I was running Firefox at the time.

bbc-basic: Add support for validating functions and optional trailing arguments.

This is necessary for 'swap!', but not dependent on how I end up
implementing it.

bbc-basic: Basic support for atoms.  'swap!' is still missing.

Trying to implement 'swap!' has caused me to suspect I have some
fundamental structural deficiencies to address, so I might have to do
that next.

bbc-basic: Define 'load-file' at startup.

Its definition includes a string, so start putting the startup forms in
DATA statements.  That way they can just be pasted in without further
escaping.  No useful initial form starts with a quotation mark or
contains a comma, so quoting them is never necessary in a DATA
statement.

bbc-basic: Implement the printing functions deferred from step 4.

That's 'pr-str', 'str', 'prn' (full version), and 'println'.

bbc-basic: Add 'read-string', 'slurp', and 'eval' functions.

The Guide would have me implement 'eval' in the main program, but
without function pointers all core functions have to appear in
FNcore_call, so I've put it there instead.

bbc-basic: Start step 6.

bbc-basic: Fix FNenv_find and FNenv_get so they can return nil properly.

Using FNhashmap_get meant that FNenv_find couldn't tell the difference
between failing to find an entry, and finding an entry containing nil.
Now it uses FNhashmap_contains to check whether the value is present
first.  This makes it much clearer why FNenv_find and FNenv_get are
strctured the way they are.

bbc-basic: Add FNhashmap_contains, being the internal version of contains?.

bbc-basic: Add string support (deferred from step 1).

Strings are internally like symbols, but with special reading and
printing rules.  This will serve until we need strings over 255
characters long (the longest that ARM BBC BASIC V can handle natively).

bbc-basic: Add the print_readably% parameter to FNpr_str (deferred from step 1).

This is a pre-requisite for string support.

bbc-basic: Specify the file name at the top of each library file.

This means that they can be saved using "SAVE" without a filename, which
will make tokenising them a little less painful.  I haven't done this to
the step files because those have "." in their canonical names, which
turns into "/" on RISC OS, so there's no good name to put in the
comment.

bbc-basic: Add Emacs local variables lists to stop it inserting tabs.

Tab characters are harmful to BBC BASIC programs, so it's particularly
unhelpful that Emacs' "indent-relative" function inserts them.  Add file
variables lists to all BBC BASIC source files to disable this behaviour.

bbc-basic: Remove all tab (HT) characters from BASIC source.

While Brandy treats tab characters in its source file as spaces, ARM BBC
BASIC seems to get rather confused by them.  To avoid this, untabify all
of our BBC BASIC sources.

bbc-basic: Increase test timeout to 40 seconds.

The default of 20 seconds was slightly too short for the step 5 tests.

bbc-basic: Suppress debugging PRINT statements in the garbage collector.

It seems to work properly now, but I'll keep them commented out in case
it stops.

bbc-basic: Make step 5 mostly work.

It now has minimal shadow-stack handling to interface with the garbage
collector.  This involved adding a procedure to the garbage collector to
tell it that only two values (ast% and val%) in the current stack frame
are live, so the rest can usefully be collected.