X-Git-Url: http://git.subgeniuskitty.com/vvhitespace/.git/blobdiff_plain/ae1f85a178241c826a0b6a72ace12049b9907561..23d1724712fae7dc9645d862d57d030cf3e2e764:/stdlib/README.md diff --git a/stdlib/README.md b/stdlib/README.md index c64be4b..3c92dde 100644 --- a/stdlib/README.md +++ b/stdlib/README.md @@ -19,6 +19,9 @@ following reservations: ## Heap and Pointers ## The first 16 heap addresses (`0-15`) are reserved when using the stdlib. +Within that reservation, heap[0] is used by `random` and heap[15] is used +by `spewreg`. The remaining 14 locations, heap[1]-heap[14] are used as +general-purpose registers. By convention, functions which return a pointer will use the address `0` to represent a `NULL` pointer. @@ -29,10 +32,10 @@ The following labels are entry points to stdlib functions. Read the header comment for each function to learn the call and return stack. 000xxx - reserved - 001xxx - print functions - 1000 ----- print string from stack (stdio.pvvs) - 1001 ----- print string from heap (stdio.pvvs) - 1010 ----- print number from stack (stdio.pvvs) + 001xxx - core functions + 1000 ----- printf (stdio.pvvs) + 1001 ----- print number from stack (stdio.pvvs) + 1010 ----- stackrotate (stack.pvvs) 010xxx - math functions 10000 ----- random (math.pvvs) 10001 ----- absolute value (math.pvvs) @@ -57,6 +60,8 @@ header comment for each function to learn the call and return stack. 1000001 ----- spew registers (heap.pvvs) 1000010 ----- print sign of number (stdio.pvvs) 1000011 ----- print magnitude of number (stdio.pvvs) + 1000100 ----- print string from stack (stdio.pvvs) + 1000101 ----- print string from heap (stdio.pvvs) # Misc # @@ -66,13 +71,3 @@ private label space associated with it, formed as follows: 00001000 xxxxxxxx - for use by 1000 00001001 xxxxxxxx - for use by 1001 ...etc - -# Slurp and Spew # - -The stdlib uses heap[1] to heap[15] as registers. - -The `slurpreg` and `spewreg` functions facilitate this by `spew`ing the stack -onto the heap's pseudo-registers or `slurp`ing the pseudo-registers back to the -stack. The functions preserve order in complementary fashion. - -The `spewreg` function uses `heap[0]` for storage.