| 1 | @ (c) 2020 Aaron Taylor <ataylor at subgeniuskitty dot com> |
| 2 | @ See LICENSE.txt file for copyright and license details. |
| 3 | |
| 4 | #ifndef VVS_STDLIB_DEBUG |
| 5 | #define VVS_STDLIB_DEBUG |
| 6 | |
| 7 | @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ |
| 8 | @ Some of the subroutines in this file duplicate other stdlib subroutines. |
| 9 | @ This is to avoid outside dependencies and allow debugging of stdlib code. |
| 10 | @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ |
| 11 | |
| 12 | @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ |
| 13 | @ Name: |
| 14 | @ dumpheap (111000) |
| 15 | @ Description: |
| 16 | @ Dumps the heap from 'startaddr' to 'endaddr'. |
| 17 | @ This subroutine stomps on heap[1] after printing the first heap location. |
| 18 | @ If you dump starting from heap[0], then heap[1] will print inaccurately. |
| 19 | @ Starting the dump from any other location will work without error. |
| 20 | @ TODO: Should I use heap[0] and DIE rather than RTS? |
| 21 | @ At the moment, the ability to continue is too useful to me. |
| 22 | @ If it's useful to me, it's probably useful to other people. |
| 23 | @ For now, leave dumpheap as-is. |
| 24 | @ Call Stack: |
| 25 | @ endaddr |
| 26 | @ startaddr <-- TOS |
| 27 | @ Return Stack: |
| 28 | @ <empty> |
| 29 | @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ |
| 30 | NSSVTTTSSSN | Mark: 111000 (debug:dumpheap) |
| 31 | |
| 32 | @ Prepare a numeric address and value on the stack |
| 33 | SNS | DUP |
| 34 | SNS | DUP |
| 35 | TTT | LOAD |
| 36 | SNT | SWAP |
| 37 | |
| 38 | @ Print output line for this memory location |
| 39 | NSTTTTSTTN | JSR > 111011 (debug:printmagnitude) |
| 40 | SSSTSSTN | PUSH ASCII '\t' |
| 41 | SSSTTTSTSN | PUSH ASCII ':' |
| 42 | TNSS | PUTC |
| 43 | TNSS | PUTC |
| 44 | SNS | DUP |
| 45 | NSTTTTSTSN | JSR > 111010 (debug:printsign) |
| 46 | NSTTTTSTTN | JSR > 111011 (debug:printmagnitude) |
| 47 | SSSTSTSN | PUSH ASCII '\n' |
| 48 | TNSS | PUTC |
| 49 | |
| 50 | @ Figure out if the loop is complete. |
| 51 | SSSTN | PUSH 1 (ptr) |
| 52 | SNT | SWAP |
| 53 | TTS | STORE |
| 54 | SNS | DUP |
| 55 | SSSTN | PUSH 1 (ptr) |
| 56 | TTT | LOAD |
| 57 | TSST | SUBTRACT |
| 58 | NTSSSTTTSSSSSSSSSSSN | BRZ > 00111000 00000000 |
| 59 | SSSTN | PUSH 1 (ptr) |
| 60 | TTT | LOAD |
| 61 | SSSTN | PUSH 1 |
| 62 | TSSS | ADD |
| 63 | NSNTTTSSSN | JMP > 111000 (dump heap) |
| 64 | |
| 65 | @ Clean up and return |
| 66 | NSSVSSTTTSSSSSSSSSSSN | Mark: 00111000 00000000 |
| 67 | SNN | DROP |
| 68 | NTN | RTS |
| 69 | |
| 70 | @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ |
| 71 | @ Name: |
| 72 | @ dumpstack (111001) |
| 73 | @ Description: |
| 74 | @ Dumps 'count' entries from the stack. |
| 75 | @ Call Stack: |
| 76 | @ count <-- TOS |
| 77 | @ Return Stack: |
| 78 | @ <empty> |
| 79 | @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ |
| 80 | NSSVTTTSSTN | Mark: 111001 (debug:dumpstack) |
| 81 | |
| 82 | @ Orient the user |
| 83 | SSSSSSSSSN | PUSH ASCII '\0' |
| 84 | SSSSSSTSTSN | PUSH ASCII '\n' |
| 85 | SSSSTTTSTSN | PUSH ASCII ':' |
| 86 | SSSTSTSSTTN | PUSH ASCII 'S' |
| 87 | SSSTSSTTTTN | PUSH ASCII 'O' |
| 88 | SSSTSTSTSSN | PUSH ASCII 'T' |
| 89 | NSTTTTTSSN | JSR > 111100 (debug:printstring) |
| 90 | |
| 91 | @ Print output line for the current TOS. |
| 92 | NSSVSSTTTSSTSSSSSSSTN | Mark: 00111001 00000001 |
| 93 | SNS | DUP |
| 94 | NSTTTTSTTN | JSR > 111011 (debug:printmagnitude) |
| 95 | SSSTSSTN | PUSH ASCII '\t' |
| 96 | SSSTTTSTSN | PUSH ASCII ':' |
| 97 | TNSS | PUTC |
| 98 | TNSS | PUTC |
| 99 | SNT | SWAP |
| 100 | SNS | DUP |
| 101 | NSTTTTSTSN | JSR > 111010 (debug:printsign) |
| 102 | NSTTTTSTTN | JSR > 111011 (debug:printmagnitude) |
| 103 | SSSTSTSN | PUSH ASCII '\n' |
| 104 | TNSS | PUTC |
| 105 | |
| 106 | @ Figure out if the loop is complete. |
| 107 | SSSTN | PUSH 1 |
| 108 | TSST | SUBTRACT |
| 109 | SNS | DUP |
| 110 | NTSSSTTTSSTSSSSSSSSN | BRZ > 00111001 00000000 |
| 111 | NSNSSTTTSSTSSSSSSSTN | JMP > 00111001 00000001 |
| 112 | |
| 113 | @ Clean up and return |
| 114 | NSSVSSTTTSSTSSSSSSSSN | Mark: 00111001 00000000 |
| 115 | SNN | DROP |
| 116 | NTN | RTS |
| 117 | |
| 118 | @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ |
| 119 | @ Name: |
| 120 | @ printsign (111010) |
| 121 | @ Description: |
| 122 | @ Prints the sign of 'number'. |
| 123 | @ Call Stack: |
| 124 | @ number <-- TOS |
| 125 | @ Return Stack: |
| 126 | @ <empty> |
| 127 | @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ |
| 128 | NSSVTTTSTSN | Mark: 111010 (debug:printsign) |
| 129 | NTTSSTTTSTSSSSSSSSTN | BMI > 00111010 00000001 |
| 130 | SSSTSTSTTN | PUSH ASCII '+' |
| 131 | NSNSSTTTSTSSSSSSSTSN | JMP > 00111010 00000010 |
| 132 | NSSVSSTTTSTSSSSSSSSTN | Mark: 00111010 00000001 |
| 133 | SSSTSTTSTN | PUSH ASCII '-' |
| 134 | NSSVSSTTTSTSSSSSSSTSN | Mark: 00111010 00000010 |
| 135 | TNSS | PUTC |
| 136 | NTN | RTS |
| 137 | |
| 138 | @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ |
| 139 | @ Name: |
| 140 | @ printmagnitude (111011) |
| 141 | @ Description: |
| 142 | @ Prints the magnitude of 'number'. |
| 143 | @ Call Stack: |
| 144 | @ number <-- TOS |
| 145 | @ Return Stack: |
| 146 | @ <empty> |
| 147 | @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ |
| 148 | NSSVTTTSTTN | Mark: 111011 (debug:printmagnitude) |
| 149 | |
| 150 | @ Extract the magnitude of the number. |
| 151 | SNS | DUP |
| 152 | NTTSSTTTSTTSSSSSSSSN | BMI > 00111011 00000000 |
| 153 | NSNSSTTTSTTSSSSSSSTN | JMP > 00111011 00000001 |
| 154 | NSSVSSTTTSTTSSSSSSSSN | Mark: 00111011 00000000 |
| 155 | SSTTN | PUSH -1 |
| 156 | TSSN | MULTIPLY |
| 157 | NSSVSSTTTSTTSSSSSSSTN | Mark: 00111011 00000001 |
| 158 | |
| 159 | @ Prepare for building a string on the stack. |
| 160 | SSSSN | PUSH ASCII '\0' |
| 161 | SNT | SWAP |
| 162 | |
| 163 | @ Pick off one digit on each pass through this loop. |
| 164 | NSSVSSTTTSTTSSSSSSTSN | Mark: 00111011 00000010 |
| 165 | SNS | DUP |
| 166 | |
| 167 | @ Mod-off a digit, convert to ASCII, store on stack as part of the string. |
| 168 | SSSTSTSN | PUSH +10 |
| 169 | TSTT | MODULO |
| 170 | SSSTTSSSSN | PUSH ASCII '0' |
| 171 | TSSS | ADD |
| 172 | SNT | SWAP |
| 173 | |
| 174 | @ Divide down to next digit and keep looping if number != 0 yet. |
| 175 | SSSTSTSN | PUSH +10 |
| 176 | TSTS | DIVIDE |
| 177 | SNS | DUP |
| 178 | NTSSSTTTSTTSSSSSSTTN | BRZ > 00111011 00000011 |
| 179 | NSNSSTTTSTTSSSSSSTSN | JMP > 00111011 00000010 |
| 180 | |
| 181 | @ Print the string we have built on the stack. |
| 182 | NSSVSSTTTSTTSSSSSSTTN | Mark: 00111011 00000011 |
| 183 | SNN | DROP |
| 184 | NSTTTTTSSN | JSR > 111100 (debug:printstring) |
| 185 | NTN | RTS |
| 186 | |
| 187 | @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ |
| 188 | @ Name: |
| 189 | @ printstring (111100) |
| 190 | @ Description: |
| 191 | @ Prints a null-terminated string from the stack. |
| 192 | @ Call Stack: |
| 193 | @ null-terminator (ASCII '\0') |
| 194 | @ char n |
| 195 | @ ... |
| 196 | @ char 2 |
| 197 | @ char 1 <-- TOS |
| 198 | @ Return Stack: |
| 199 | @ <empty> |
| 200 | @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ |
| 201 | NSSVTTTTSSN | Mark: 111100 (debug:printstring) |
| 202 | SNS | DUP |
| 203 | NTSSSTTTTSSSSSSSSSTN | BRZ > 00111100 00000001 |
| 204 | TNSS | Print character |
| 205 | NSNTTTTSSN | JMP > 111100 |
| 206 | NSSVSSTTTTSSSSSSSSSTN | Mark: 00111100 00000001 |
| 207 | SNN | DROP |
| 208 | NTN | RTS |
| 209 | |
| 210 | @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ |
| 211 | @ Name: |
| 212 | @ printsignednumber (111101) |
| 213 | @ Description: |
| 214 | @ Prints 'number' from the stack in sign-magnitude format. |
| 215 | @ Leading zeros are suppressed. |
| 216 | @ Call Stack: |
| 217 | @ number <-- TOS |
| 218 | @ Return Stack: |
| 219 | @ <empty> |
| 220 | @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ |
| 221 | NSSVTTTTSTN | Mark: 111101 (debug:printsignednumber) |
| 222 | SNS | DUP |
| 223 | NSTTTTSTSN | JSR > 111010 (debug:printsign) |
| 224 | NSTTTTSTTN | JSR > 111011 (debug:printmagnitude) |
| 225 | NTN | RTS |
| 226 | |
| 227 | @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ |
| 228 | @ Name: |
| 229 | @ stdlib_version (111110) |
| 230 | @ Description: |
| 231 | @ Returns the version of the stdlib. |
| 232 | @ The version number should be a monotonically increasing integer. |
| 233 | @ Call Stack: |
| 234 | @ <empty> <-- TOS |
| 235 | @ Return Stack: |
| 236 | @ version_number <-- TOS |
| 237 | @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ |
| 238 | NSSVTTTTTSN | Mark: 111110 (debug:printsignednumber) |
| 239 | SSSTN | PUSH 1 (version) |
| 240 | NTN | RTS |
| 241 | |
| 242 | #endif |