X-Git-Url: http://git.subgeniuskitty.com/vvhitespace/.git/blobdiff_plain/32c440bf6f1f2199c3e925f32bd3b621039605e6..2612f47f558e9201f0aeaf7655661574066e0243:/stdlib/README.md diff --git a/stdlib/README.md b/stdlib/README.md index 2639a41..ee4670b 100644 --- a/stdlib/README.md +++ b/stdlib/README.md @@ -1,5 +1,14 @@ +# Overview # + +This folder contains a library of useful functions written in VVhitespace. +Standard include guards are used with `cpp` to include the stdlib in user +programs. For an example, see `examples/hello-stdlib`. + # Reservations # +Since all labels share a global namespace, the standard library makes the +following reservations: + ## Label ## 00000000 0xxxxxxx - reserved for stdlib function entry points @@ -16,9 +25,22 @@ The following labels are entry points to stdlib functions. Read the header comment for each function to learn the call and return stack. - stdio.pvvs: - 1000 - print string from stack - 1001 - print string from heap + 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) + 010xxx - math functions + 10000 ----- random (math.pvvs) + 10001 ----- absolute value (math.pvvs) + 011xxx - unassigned + 100xxx - unassigned + 101xxx - unassigned + 110xxx - unassigned + 111xxx - conversion functions + 1xxxxxx - reserved for less common entry points + 1000000 ----- print sign of number (stdio.pvvs) + 1000001 ----- print magnitude of number (stdio.pvvs) # Misc # @@ -27,3 +49,4 @@ private label space associated with it, formed as follows: 00001000 xxxxxxxx - for use by 1000 00001001 xxxxxxxx - for use by 1001 + ...etc