X-Git-Url: http://git.subgeniuskitty.com/vvhitespace/.git/blobdiff_plain/bb21580a5abba6a1e6666e9fb363f68d40f785d7..45abb94e7cc7357b082f9ffda11077e2c606645e:/stdlib/README.md diff --git a/stdlib/README.md b/stdlib/README.md index cef4cd4..12a5ff6 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. @@ -45,14 +48,20 @@ header comment for each function to learn the call and return stack. 11101 ----- 11110 ----- slurp (heap.pvvs) 11111 ----- spew (heap.pvvs) - 100xxx - unassigned + 100xxx - string functions + 100000 ----- strlen (string.pvvs) 101xxx - unassigned 110xxx - conversion functions 111xxx - debug functions 111000 ----- dump heap (debug.pvvs) + 111001 ----- dump stack (debug.pvvs) 1xxxxxx - reserved for less common entry points - 1000000 ----- print sign of number (stdio.pvvs) - 1000001 ----- print magnitude of number (stdio.pvvs) + 1000000 ----- slurp registers (heap.pvvs) + 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 # @@ -62,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 `slurp` and `spew` 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 `spew` function uses `heap[0]` for storage.