projects
/
vvhitespace
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
tags
|
clone url
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Added stdlib_test for memcmp subroutine.
[vvhitespace]
/
stdlib
/
README.md
diff --git
a/stdlib/README.md
b/stdlib/README.md
index
c64be4b
..
f077799
100644
(file)
--- a/
stdlib/README.md
+++ b/
stdlib/README.md
@@
-2,7
+2,8
@@
This folder contains a library of useful functions written in VVhitespace.
Standard include guards are used with `cpp` to include the stdlib in user
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`.
+programs. For an example, see `examples/hello-stdlib`. This also means
+`cpp` syntax must be respected.
# Reservations #
# Reservations #
@@
-12,13
+13,16
@@
following reservations:
## Label ##
00000000 0xxxxxxx - reserved for stdlib function entry points
## Label ##
00000000 0xxxxxxx - reserved for stdlib function entry points
- 00000000 1xxxxxxx -
unassigned
+ 00000000 1xxxxxxx -
available for use in user programs
0xxxxxxx xxxxxxxx - reserved for private use by stdlib
1xxxxxxx xxxxxxxx - available for use in user programs
## Heap and Pointers ##
The first 16 heap addresses (`0-15`) are reserved when using the stdlib.
0xxxxxxx xxxxxxxx - reserved for private use by stdlib
1xxxxxxx xxxxxxxx - available for use in user programs
## 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 the block
+heap[1]-heap[15] by the stack rotation subroutines which time-share
+pseudo-registers between the various stdlib subroutines.
By convention, functions which return a pointer will use the address `0` to
represent a `NULL` pointer.
By convention, functions which return a pointer will use the address `0` to
represent a `NULL` pointer.
@@
-29,10
+33,12
@@
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
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)
+ 1011 ----- stackrotatereverse (stack.pvvs)
+ 1100 ----- deepdup (stack.pvvs)
010xxx - math functions
10000 ----- random (math.pvvs)
10001 ----- absolute value (math.pvvs)
010xxx - math functions
10000 ----- random (math.pvvs)
10001 ----- absolute value (math.pvvs)
@@
-47,32
+53,45
@@
header comment for each function to learn the call and return stack.
11111 ----- spew (heap.pvvs)
100xxx - string functions
100000 ----- strlen (string.pvvs)
11111 ----- spew (heap.pvvs)
100xxx - string functions
100000 ----- strlen (string.pvvs)
- 101xxx - unassigned
+ 101xxx - logic functions
+ 101000 ----- not (logic.pvvs)
+ 101001 ----- and (logic.pvvs)
+ 101010 ----- or (logic.pvvs)
+ 101011 ----- xor (logic.pvvs)
+ 101100 ----- rshift (logic.pvvs)
+ 101101 ----- lshift (logic.pvvs)
110xxx - conversion functions
111xxx - debug functions
111000 ----- dump heap (debug.pvvs)
111001 ----- dump stack (debug.pvvs)
110xxx - conversion functions
111xxx - debug functions
111000 ----- dump heap (debug.pvvs)
111001 ----- dump stack (debug.pvvs)
+ 111010 ----- print sign (debug.pvvs)
+ 111011 ----- print magnitude (debug.pvvs)
+ 111100 ----- print string (debug.pvvs)
1xxxxxx - reserved for less common entry points
1xxxxxx - reserved for less common entry points
- 1000000 -----
slurp registers (heap
.pvvs)
- 1000001 -----
spew registers (heap
.pvvs)
+ 1000000 -----
lowbitand (logic
.pvvs)
+ 1000001 -----
isnegative (math
.pvvs)
1000010 ----- print sign of number (stdio.pvvs)
1000011 ----- print magnitude of number (stdio.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 #
# Misc #
-By convention, each public stdlib label will have 8 bits of
-private label space associated with it, formed as follows:
+## Private Label Space ##
+
+By convention, each public stdlib label will have 8 bits of private label space
+associated with it, formed as follows:
00001000 xxxxxxxx - for use by 1000
00001001 xxxxxxxx - for use by 1001
...etc
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.
+## Extending Heap Reservation ##
-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 fash
ion.
+By default, the stdlib uses the first 16 heap addresses. All heap access (other
+than heap[0] as a seed) occurs through `stackrotate` and `stackrotatereverse`.
+
Edit these functions to increase the stdlib's heap reservat
ion.
-The `spewreg` function uses `heap[0]` for storage.
+The remainder of the stdlib is written to automatically use the new allocation.
+Functions like `printf`, for example, allow more substitutions when the heap
+allocation is increased.