From 34a95f255f9d557dadb18e98663cb7aa01da3288 Mon Sep 17 00:00:00 2001 From: Marshall Lochbaum Date: Thu, 1 Apr 2021 07:25:14 -0400 Subject: Update formatter information --- docs/implementation/vm.html | 5 +++-- implementation/vm.md | 6 ++++-- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/implementation/vm.html b/docs/implementation/vm.html index 75e71ad1..450c9663 100644 --- a/docs/implementation/vm.html +++ b/docs/implementation/vm.html @@ -541,11 +541,12 @@

The following steps give a working BQN system, assuming a working VM and core runtime:

The compiler takes the runtime as 𝕨 and source code as 𝕩. To evaluate BQN source code, convert it into a BQN string (rank-1 array of characters), pass this string and runtime to the compiler, and evaluate the result as bytecode. Results can be formatted with the formatter for use in a REPL, or used from the implementation language.

+

Two formatter arguments Glyph and FmtNum are not part of the runtime. Glyph assumes 𝕩 is a primitive and returns the character (not string) that represents it, and FmtNum assumes 𝕩 is a number and returns a string representing it.

Testing

I recommend roughly the following sequence of tests to get everything working smoothly. It can be very difficult to figure out where in a VM things went wrong, so it's important to work methodically and make sure each component is all right before moving to the next.

Because the compiler works almost entirely with lists of numbers, a correct fill implementation is not needed to run the compiler. Instead, you can define Fill as 0⊘⊢ and _fillBy_ as {𝔽} to always use a fill element of 0.

diff --git a/implementation/vm.md b/implementation/vm.md index 4b416c69..2a35601b 100644 --- a/implementation/vm.md +++ b/implementation/vm.md @@ -180,12 +180,14 @@ BQN sources are compiled with [cjs.bqn](../src/cjs.bqn), which runs under [dzaim The following steps give a working BQN system, assuming a working VM and core runtime: * Evaluate the bytecode `$ src/cjs.bqn r`, passing the core runtime `provide` in the constants array. The result is a BQN list of a full runtime, and a function `SetPrims`. -* Optionally, call `SetPrims` on a two-element list containing `Decompose` and `PrimInd`. +* Optionally, call `SetPrims` on a two-element list `⟨Decompose, PrimInd⟩`. * Evaluate the bytecode `$ src/cjs.bqn c`, which uses primitives from the runtime in its constants array. This is the compiler. -* Evaluate the bytecode `$ src/cjs.bqn fmt`. This returns a 1-modifier. Call it on an operand function that formats atoms to obtain the formatter. +* Evaluate the bytecode `$ src/cjs.bqn f`. This returns a 1-modifier. To obtain the formatter, call it on a four-element operand list `⟨Type, Decompose, Glyph, FmtNum⟩`. The compiler takes the runtime as `𝕨` and source code as `𝕩`. To evaluate BQN source code, convert it into a BQN string (rank-1 array of characters), pass this string and runtime to the compiler, and evaluate the result as bytecode. Results can be formatted with the formatter for use in a REPL, or used from the implementation language. +Two formatter arguments `Glyph` and `FmtNum` are not part of the runtime. `Glyph` assumes `𝕩` is a primitive and returns the character (not string) that represents it, and `FmtNum` assumes `𝕩` is a number and returns a string representing it. + ### Testing I recommend roughly the following sequence of tests to get everything working smoothly. It can be very difficult to figure out where in a VM things went wrong, so it's important to work methodically and make sure each component is all right before moving to the next. -- cgit v1.2.3