Fixing a label I missed when moving functions in the stdlib.
[vvhitespace] / stdlib / README.md
CommitLineData
92a92075
AT
1# Overview #
2
3This folder contains a library of useful functions written in VVhitespace.
4Standard include guards are used with `cpp` to include the stdlib in user
5programs. For an example, see `examples/hello-stdlib`.
6
32c440bf
AT
7# Reservations #
8
92a92075
AT
9Since all labels share a global namespace, the standard library makes the
10following reservations:
11
32c440bf
AT
12## Label ##
13
14 00000000 0xxxxxxx - reserved for stdlib function entry points
15 00000000 1xxxxxxx - unassigned
16 0xxxxxxx xxxxxxxx - reserved for private use by stdlib
17 1xxxxxxx xxxxxxxx - available for use in user programs
18
bb21580a 19## Heap and Pointers ##
32c440bf 20
bb21580a 21The first 16 heap addresses (`0-15`) are reserved when using the stdlib.
0425a4c6
AT
22Within that reservation, heap[0] is used by `random` and heap[15] is used
23by `spewreg`. The remaining 14 locations, heap[1]-heap[14] are used as
24general-purpose registers.
bb21580a
AT
25
26By convention, functions which return a pointer will use the address `0` to
27represent a `NULL` pointer.
32c440bf
AT
28
29# Entry Points #
30
31The following labels are entry points to stdlib functions. Read the
32header comment for each function to learn the call and return stack.
33
3625ff3a
AT
34 000xxx - reserved
35 001xxx - print functions
36 1000 ----- print string from stack (stdio.pvvs)
37 1001 ----- print string from heap (stdio.pvvs)
38 1010 ----- print number from stack (stdio.pvvs)
39 010xxx - math functions
2612f47f 40 10000 ----- random (math.pvvs)
3625ff3a 41 10001 ----- absolute value (math.pvvs)
3695b659
AT
42 011xxx - heap functions
43 11000 ----- memset (heap.pvvs)
3d75b928 44 11001 ----- memcpy (heap.pvvs)
d63de3fa 45 11010 ----- memrand (heap.pvvs)
87d27426 46 11011 ----- memcmp (heap.pvvs)
fd04fb41 47 11100 ----- memsrch (heap.pvvs)
bb21580a
AT
48 11101 ----- <empty>
49 11110 ----- slurp (heap.pvvs)
50 11111 ----- spew (heap.pvvs)
ae1f85a1
AT
51 100xxx - string functions
52 100000 ----- strlen (string.pvvs)
3625ff3a 53 101xxx - unassigned
1a56830d
AT
54 110xxx - conversion functions
55 111xxx - debug functions
56 111000 ----- dump heap (debug.pvvs)
ae1f85a1 57 111001 ----- dump stack (debug.pvvs)
3625ff3a 58 1xxxxxx - reserved for less common entry points
ae1f85a1
AT
59 1000000 ----- slurp registers (heap.pvvs)
60 1000001 ----- spew registers (heap.pvvs)
61 1000010 ----- print sign of number (stdio.pvvs)
62 1000011 ----- print magnitude of number (stdio.pvvs)
b8b65c17
AT
63 1000100 ----- print string from stack (stdio.pvvs)
64 1000101 ----- print string from heap (stdio.pvvs)
32c440bf
AT
65
66# Misc #
67
68By convention, each public stdlib label will have 8 bits of
69private label space associated with it, formed as follows:
70
71 00001000 xxxxxxxx - for use by 1000
72 00001001 xxxxxxxx - for use by 1001
92a92075 73 ...etc