X-Git-Url: http://git.subgeniuskitty.com/vvhitespace/.git/blobdiff_plain/3625ff3a8ea0b61d744da30237e6ffc993a585fb..0425a4c688d837e65ccbece82a8987ac41dcee3f:/stdlib/README.md

diff --git a/stdlib/README.md b/stdlib/README.md
index 3bff980..00d0fb5 100644
--- a/stdlib/README.md
+++ b/stdlib/README.md
@@ -16,9 +16,15 @@ following reservations:
     0xxxxxxx xxxxxxxx - reserved for private use by stdlib
     1xxxxxxx xxxxxxxx - available for use in user programs
 
-## Heap ##
+## Heap and Pointers ##
 
-    The first 256 heap addresses are reserved when using the stdlib.
+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.
 
 # Entry Points #
 
@@ -31,15 +37,29 @@ header comment for each function to learn the call and return stack.
            1001 ----- print string from heap        (stdio.pvvs)
            1010 ----- print number from stack       (stdio.pvvs)
          010xxx - math functions
+          10000 ----- random                        (math.pvvs)
           10001 ----- absolute value                (math.pvvs)
-         011xxx - unassigned
-         100xxx - unassigned
+         011xxx - heap functions
+          11000 ----- memset                        (heap.pvvs)
+          11001 ----- memcpy                        (heap.pvvs)
+          11010 ----- memrand                       (heap.pvvs)
+          11011 ----- memcmp                        (heap.pvvs)
+          11100 ----- memsrch                       (heap.pvvs)
+          11101 ----- <empty>
+          11110 ----- slurp                         (heap.pvvs)
+          11111 ----- spew                          (heap.pvvs)
+         100xxx - string functions
+         100000 ----- strlen                        (string.pvvs)
          101xxx - unassigned
-         110xxx - unassigned
-         111xxx - conversion functions
+         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)
 
 # Misc #