X-Git-Url: http://git.subgeniuskitty.com/vvhitespace/.git/blobdiff_plain/87d274260407ab875b45626dbb4fd433020cf19a..45abb94e7cc7357b082f9ffda11077e2c606645e:/stdlib/README.md diff --git a/stdlib/README.md b/stdlib/README.md index 8babbde..12a5ff6 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 # @@ -38,14 +44,24 @@ header comment for each function to learn the call and return stack. 11001 ----- memcpy (heap.pvvs) 11010 ----- memrand (heap.pvvs) 11011 ----- memcmp (heap.pvvs) - 100xxx - unassigned + 11100 ----- memsrch (heap.pvvs) + 11101 ----- + 11110 ----- slurp (heap.pvvs) + 11111 ----- spew (heap.pvvs) + 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 #