Added random number generator to VVS 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
19## Heap ##
20
21 The first 256 heap addresses are reserved when using the stdlib.
22
23# Entry Points #
24
25The following labels are entry points to stdlib functions. Read the
26header comment for each function to learn the call and return stack.
27
3625ff3a
AT
28 000xxx - reserved
29 001xxx - print functions
30 1000 ----- print string from stack (stdio.pvvs)
31 1001 ----- print string from heap (stdio.pvvs)
32 1010 ----- print number from stack (stdio.pvvs)
33 010xxx - math functions
2612f47f 34 10000 ----- random (math.pvvs)
3625ff3a
AT
35 10001 ----- absolute value (math.pvvs)
36 011xxx - unassigned
37 100xxx - unassigned
38 101xxx - unassigned
39 110xxx - unassigned
40 111xxx - conversion functions
41 1xxxxxx - reserved for less common entry points
42 1000000 ----- print sign of number (stdio.pvvs)
43 1000001 ----- print magnitude of number (stdio.pvvs)
32c440bf
AT
44
45# Misc #
46
47By convention, each public stdlib label will have 8 bits of
48private label space associated with it, formed as follows:
49
50 00001000 xxxxxxxx - for use by 1000
51 00001001 xxxxxxxx - for use by 1001
92a92075 52 ...etc