[vvhitespace] / stdlib / stdio.pvvs

@ (c) 2020 Aaron Taylor <ataylor at subgeniuskitty dot com>
@ See LICENSE.txt file for copyright and license details.

#ifndef VVS_STDLIB_STDIO
#define VVS_STDLIB_STDIO

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@ Name:
@   printstackstring (1000100)
@ Description:
@   Prints a null-terminated string from the stack.
@ Call Stack:
@   null-terminator (ASCII '\0')
@   char n
@   ...
@   char 2
@   char 1 <-- TOS
@ Return Stack:
@   <empty>
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
NSSVTSSSTSSN            | Mark: 1000100 (print string from stack)
SNS                     | DUP
NTSSTSSSTSSSSSSSSSTN    | BRZ > 01000100 00000001
TNSS                    | Print character
NSNTSSSTSSN             | JMP > 1000100
NSSVSTSSSTSSSSSSSSSTN   | Mark: 01000100 00000001
SNN                     | DROP
NTN                     | RTS

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@ Name:
@   printheapstring (1000101)
@ Description:
@   Prints a null-terminated string from the heap.
@ Call Stack:
@   pointer to first character  <-- TOS
@ Return Stack:
@   <empty>
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
NSSVTSSSTSTN            | Mark: 1000101 (print string from heap)
SNS                     | DUP
TTT                     | LOAD
SNS                     | DUP
NTSSTSSSTSTSSSSSSSTN    | BRZ > 01000101 00000001
TNSS                    | Print character
SSSTN                   | Push +1
TSSS                    | ADD
NSNTSSSTSTN             | JMP > 1000101
NSSVSTSSSTSTSSSSSSSTN   | Mark: 01000101 00000001
SNN                     | DROP
SNN                     | DROP
NTN                     | RTS

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@ Name:
@   printstacknumber (1001)
@ Description:
@   Prints 'number' from the stack in sign-magnitude format.
@   Leading zeros are suppressed.
@ Call Stack:
@   number  <-- TOS
@ Return Stack:
@   <empty>
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
NSSVTSSTN               | Mark: 1001 (print number from stack)
SNS                     | DUP
NSTTSSSSTSN             | JSR > 1000010 (printstacknumbersign)
NSTTSSSSTTN             | JSR > 1000011 (printstacknumbermagnitude)
NTN                     | RTS

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@ Name:
@   printstacknumbersign (1000010)
@ Description:
@   Prints the sign of 'number' from the stack.
@ Call Stack:
@   number  <-- TOS
@ Return Stack:
@   <empty>
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
NSSVTSSSSTSN            | Mark: 1000010 (print sign of number from stack)
NTTSTSSSSTSSSSSSSSTN    | BMI > 01000010 00000001
SSSTSTSTTN              | PUSH ASCII '+'
NSNSTSSSSTSSSSSSSTSN    | JMP > 01000010 00000010
NSSVSTSSSSTSSSSSSSSTN   | Mark: 01000010 00000001
SSSTSTTSTN              | PUSH ASCII '-'
NSSVSTSSSSTSSSSSSSTSN   | Mark: 01000010 00000010
TNSS                    | PUTC
NTN                     | RTS

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@ Name:
@   printstacknumbermagnitude (1000011)
@ Description:
@   Prints the magnitude of 'number' from the stack.
@ Call Stack:
@   number  <-- TOS
@ Return Stack:
@   <empty>
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
#include <math.pvvs>
NSSVTSSSSTTN            | Mark: 1000011 (print magnitude of number from stack)

@ Catch -(2^63) as a special case since its absolute value will overflow
@ a twos-complement 64-bit word.
SNS                     | DUP
SSTTSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSN | -(2^63)
TSST                    | SUBTRACT
NTSSTSSSSTTSSSSSSTSN    | BRZ > 01000011 00000010

@ No special case applies. Prepare for computation by converting the number
@ to absolute value and preparing a string on the stack.
NSTTSSSTN               | JSR > 10001 (absolute value)
SSSSN                   | PUSH ASCII '\0'
SNT                     | SWAP

@ Pick off one digit on each pass through this loop.
NSSVSTSSSSTTSSSSSSSSN   | Mark: 01000011 00000000
SNS                     | DUP

@ Mod-off a digit, convert to ASCII, store on stack as part of the string.
SSSTSTSN                | PUSH +10
TSTT                    | MODULO
SSSTTSSSSN              | PUSH ASCII '0'
TSSS                    | ADD
SNT                     | SWAP

@ Divide down to next digit and keep looping if number != 0 yet.
SSSTSTSN                | PUSH +10
TSTS                    | DIVIDE
SNS                     | DUP
NTSSTSSSSTTSSSSSSSTN    | BRZ > 01000011 00000001
NSNSTSSSSTTSSSSSSSSN    | JMP > 01000011 00000000

@ Print the string we have built on the stack.
NSSVSTSSSSTTSSSSSSSTN   | Mark: 01000011 00000001
SNN                     | DROP
NSTTSSSTSSN             | JSR > 1000100 (print string from stack)
NTN                     | RTS

@ Replace the number on the stack with its decimal ASCII representation.
NSSVSTSSSSTTSSSSSSTSN   | BRZ > 01000011 00000010
SNN                     | DROP
A"-9223372036854775808"
NSNSTSSSSTTSSSSSSSTN    | JMP > 01000011 00000001

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@ Name:
@   printf
@ Description:
@   If printing a static string (i.e. no substitutions), pass
@     'number of substitutions' as 0, immediately followed by 'string word 1'.
@   If printing a string from the heap instead of stack, pass an empty string
@     on the stack followed by a pointer to the first word of the
@     null-terminated string on the heap.
@     For example:
@         pointer
@         ASCII '\0'
@         substitution n
@         <remainder of call stack is unchanged>
@   Maximum substitutions determined by upper heap limit in stackrotate and
@     stackrotatereverse subroutines.
@ Call Stack:
@   ACSII '\0'
@   string word n
@   ...
@   string word 1
@   substitution n
@   ...
@   substitution 1
@   number of substitutions  <-- TOS
@ Return Stack:
@   <empty>
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
#include <stack.pvvs>
NSSVTSSSN               | Mark: 1000 (printf)

@ If the stack contains an empty string (i.e. just an ASCII '\0'), the next
@ word is a pointer we must use to load the string from the heap.
@ This will leave the stack looking exactly like the example call stack above.
@ Do the test this way so we can keep the code inline.
SNS                     | DUP
SSSTSN                  | PUSH 2
TSSS                    | ADD
NSTTTSSN                | JSR > 1100 (deepdup)
SSTTN                   | PUSH -1
TSSN                    | MULTIPLY
NTTSSSSTSSSSSSSSSSTN    | BMI > 00001000 00000001
SNS                     | DUP
SSSTSN                  | PUSH 2
TSSS                    | ADD
NSTTSTTN                | JSR > 1011 (stackrotatereverse)
SNN                     | DROP
SNS                     | DUP
SSSTSN                  | PUSH 2
TSSS                    | ADD
NSTTSTTN                | JSR > 1011 (stackrotatereverse)
NSTSSSSTSSSTSSSTTSSN    | JSR > 00001000 10001100 (printf_deepslurp)

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@ The rest of printf parses a string according to the following information.
@   ASCII '\ ':
@       ASCII '\ ': putchar '\ '
@       ASCII '%': putchar '%'
@       ASCII 'n': putchar '\n'
@       ASCII 't': putchar '\t'
@   ASCII '%':
@       ASCII 'c': (print character)
@       ASCII 's': (print string)
@       ASCII 'd': (print decimal digit)
@       ASCII 'u': (print abs(integer), w/o sign)
@       ASCII 'i': (print integer w/sign)
@   ASCII '\0':
@       cleanup and exit
@   default:
@       putchar
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

@@@@@@@@@@@@@@@@@@@@
@ The next block tests the char against all possible level 1 branches (see above).
@ If there is a match, execution jumps to the appropriate level 2 branch label.
@ If no match is found, print the character and move on.
@@@@@@@@@@@@@@@@@@@@
NSSVSSSSTSSSSSSSSSSTN   | Mark: 00001000 00000001
@ Move the next character of the string to TOS.
NSTSSSSTSSSTSSSTSTTN    | JSR > 00001000 10001011 (next char to TOS)
@ TOS is an ASCII '\ '. Jump to process the possible level 2 branches.
SNS                     | DUP
SSSTSTTTSSN             | PUSH ASCII slash
TSST                    | SUBTRACT
NTSSSSSTSSSSSSSSSTSN    | BRZ > 00001000 00000010
@ TOS is an ASCII '%'. Jump to process the possible level 2 branches.
SNS                     | DUP
SSSTSSTSTN              | PUSH ASCII '%'
TSST                    | SUBTRACT
NTSSSSSTSSSSSSSSSTTN    | BRZ > 00001000 00000011
@ TOS is an ASCII "\0". Jump to clean-up-and-exit.
SNS                     | DUP
NTSSSSSTSSSSSSSSSSSN    | BRZ > 00001000 00000000
@ TOS is a normal character. Print it and loop again.
TNSS                    | PUTC
NSNSSSSTSSSSSSSSSSTN    | JMP > 00001000 00000001

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@ Level 2 - ASCII '\ ' - Escapes
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

@@@@@@@@@@@@@@@@@@@@
@ The level 1 match was an ASCII '\ '.
@ Now look for level 2 matches that trigger a character substitution (n -> newline, etc).
@ If no matches are found, print the character directly (e.g. "\%" -> '%')
@ When finished, loop back to testing level 1 branches.
@@@@@@@@@@@@@@@@@@@@
NSSVSSSSTSSSSSSSSSTSN   | Mark: 00001000 00000010
SNN                     | DROP
@ Move the next character of the string to TOS.
NSTSSSSTSSSTSSSTSTTN    | JSR > 00001000 10001011 (next char to TOS)
@ Check for ASCII '\n'
SNS                     | DUP
SSSTTSTTTSN             | PUSH ASCII 'n'
TSST                    | SUBTRACT
NTSSSSSTSSSSSSSSTSSN    | BRZ > 00001000 00000100
@ Check for ASCII '\t'
SNS                     | DUP
SSSTTTSTSSN             | PUSH ASCII 't'
TSST                    | SUBTRACT
NTSSSSSTSSSSSSSSTSTN    | BRZ > 00001000 00000101
@ No substitution necessary. Print literally.
TNSS                    | PUTC
NSNSSSSTSSSSSSSSSSTN    | JMP > 00001000 00000001

@@@@@@@@@@@@@@@@@@@@
@ These are utility labels to output the appropriate non-printable ASCII character.
@ After output, they loop back to testing level 1 branches.
@@@@@@@@@@@@@@@@@@@@

@ Print a newline and loop for the next character.
NSSVSSSSTSSSSSSSSTSSN   | Mark: 00001000 00000100
SNN                     | DROP
SSSTSTSN                | PUSH ASCII '\n'
TNSS                    | PUTC
NSNSSSSTSSSSSSSSSSTN    | JMP > 00001000 00000001

@ Print a horizontal tab and loop for the next character.
NSSVSSSSTSSSSSSSSTSTN   | Mark: 00001000 00000101
SNN                     | DROP
SSSTSSTN                | PUSH ASCII '\t'
TNSS                    | PUTC
NSNSSSSTSSSSSSSSSSTN    | JMP > 00001000 00000001

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@ Level 2 - ASCII '%' - Substitutions
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

@@@@@@@@@@@@@@@@@@@@
@ The level 1 match was an ASCII '%'.
@ Now look for level 2 matches that trigger a substitution.
@ When finished, loop back to testing level 1 branches.
@@@@@@@@@@@@@@@@@@@@
NSSVSSSSTSSSSSSSSSTTN   | Mark: 00001000 00000011
SNN                     | DROP
@ Move the next character of the string to TOS.
NSTSSSSTSSSTSSSTSTTN    | JSR > 00001000 10001011 (next char to TOS)
@ Check for ASCII 'c' - Print character
SNS                     | DUP
SSSTTSSSTTN             | PUSH ASCII 'c'
TSST                    | SUBTRACT
NTSSSSSTSSSSSSSSTTSN    | BRZ > 00001000 00000110
@ Check for ASCII 's' - Print string
SNS                     | DUP
SSSTTTSSTTN             | PUSH ASCII 's'
TSST                    | SUBTRACT
NTSSSSSTSSSSSSSSTTTN    | BRZ > 00001000 00000111
@ Check for ASCII 'd' - Print decimal digit
SNS                     | DUP
SSSTTSSTSSN             | PUSH ASCII 'd'
TSST                    | SUBTRACT
NTSSSSSTSSSSSSSTSSSN    | BRZ > 00001000 00001000
@ Check for ASCII 'u' - Print unsigned number
SNS                     | DUP
SSSTTTSTSTN             | PUSH ASCII 'u'
TSST                    | SUBTRACT
NTSSSSSTSSSSSSSTSSTN    | BRZ > 00001000 00001001
@ Check for ASCII 'i' - Print signed number
SNS                     | DUP
SSSTTSTSSTN             | PUSH ASCII 'i'
TSST                    | SUBTRACT
NTSSSSSTSSSSSSSTSTSN    | BRZ > 00001000 00001010
@ Unrecognized substitution specifier.
@ For now, silently consume it and continue.
@ Do not increment the substitution counter.
@ TODO: Is this really what I want to do here?
SNN                     | DROP
NSNSSSSTSSSSSSSSSSTN    | JMP > 00001000 00000001


@@@@@@@@@@@@@@@@@@@@
@ These are utility labels to call the appropriate type of output subroutine.
@ After output, they decrement the substition counter and loop back to testing
@ level 1 branches.
@@@@@@@@@@@@@@@@@@@@

@ Print a character
NSSVSSSSTSSSSSSSSTTSN   | Mark: 00001000 00000110
SNN                     | DROP
SNT                     | SWAP
TNSS                    | PUTC
SSSTN                   | PUSH 1
TSST                    | SUBTRACT
NSNSSSSTSSSSSSSSSSTN    | JMP > 00001000 00000001
@ Print a string
NSSVSSSSTSSSSSSSSTTTN   | Mark: 00001000 00000111
SNN                     | DROP
SNT                     | SWAP
NSTTSSSTSTN             | JSR > 1000101 (print string from heap)
SSSTN                   | PUSH 1
TSST                    | SUBTRACT
NSNSSSSTSSSSSSSSSSTN    | JMP > 00001000 00000001
@ Print a decimal digit
NSSVSSSSTSSSSSSSTSSSN   | Mark: 00001000 00001000
SNN                     | DROP
SNT                     | SWAP
TNST                    | PUTDIGIT
SSSTN                   | PUSH 1
TSST                    | SUBTRACT
NSNSSSSTSSSSSSSSSSTN    | JMP > 00001000 00000001
@ Print an unsigned integer
NSSVSSSSTSSSSSSSTSSTN   | Mark: 00001000 00001001
SNN                     | DROP
SNT                     | SWAP
NSTTSSSSTTN             | JSR > 1000011 (print magnitude of number from stack)
SSSTN                   | PUSH 1
TSST                    | SUBTRACT
NSNSSSSTSSSSSSSSSSTN    | JMP > 00001000 00000001
@ Print a signed integer
NSSVSSSSTSSSSSSSTSTSN   | Mark: 00001000 00001010
SNN                     | DROP
SNT                     | SWAP
NSTTSSTN                | JSR > 1001 (print number from stack)
SSSTN                   | PUSH 1
TSST                    | SUBTRACT
NSNSSSSTSSSSSSSSSSTN    | JMP > 00001000 00000001

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@ These are misc labels associated with the printf function.
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

@ Found an ASCII "\0" when processing the format string. Clean up and exit.
NSSVSSSSTSSSSSSSSSSSN   | Mark: 00001000 00000000
SNN                     | DROP
SNN                     | DROP
NTN                     | RTS

@ Move the next string character to TOS.
@ Stack should look like the printf call stack, with num-of-subs at TOS.
NSSVSSSSTSSSTSSSTSTTN   | Mark: 00001000 10001011 (next char to TOS)
SNS                     | DUP
SSSTSN                  | PUSH 2
TSSS                    | ADD
NSTTSTTN                | JSR > 1011 (stackrotatereverse)
NTN                     | RTS

@ Slurps a string from the heap to the stack, storing it behind the substitutions.
@ Call Stack:
@   substitution n
@   ...
@   substitution 1
@   number of substitutions  <-- TOS
@   pointer to string
@ Return Stack:
@   ACSII '\0'
@   string word n
@   ...
@   string word 1
@   substitution n
@   ...
@   substitution 1
@   number of substitutions  <-- TOS
@ TODO: This, along with a deepspew, should probably be stdlib routines.
NSSVSSSSTSSSTSSSTTSSN   | Mark: 00001000 10001100 (printf_deepslurp)
SNS                     | DUP
@ Advance a duplicate copy of the pointer until it points to the null-terminator.
NSSVSSSSTSSSTSSSTTSTN   | Mark: 00001000 10001101
SNS                     | DUP
TTT                     | LOAD
NTSSSSSTSSSTSSSTTTSN    | BRZ > 00001000 10001110
SSSTN                   | PUSH 1
TSSS                    | ADD
NSNSSSSTSSSTSSSTTSTN    | JMP > 00001000 10001101
@ Load a character to the stack on each pass through this loop.
NSSVSSSSTSSSTSSSTTTSN   | Mark: 00001000 10001110
SNS                     | DUP
TTT                     | LOAD
SSSTSSN                 | PUSH 4
NSTTTSSN                | JSR > 1100 (deepdup)
SSSTSSN                 | PUSH 4
TSSS                    | ADD
NSTTSTSN                | JSR > 1010 (stackrotate)
@ Test for end of loop.
SNS                     | DUP
SSSTTN                  | PUSH 3
NSTTTSSN                | JSR > 1100 (deepdup)
TSST                    | SUBTRACT
NTSSSSSTSSSTSSSTTTTN    | BRZ > 00001000 10001111
@ Decrement pointer to end of string, loop again.
SSSTN                   | PUSH 1
TSST                    | SUBTRACT
NSNSSSSTSSSTSSSTTTSN    | JMP > 00001000 10001110
@ Clean up and return.
NSSVSSSSTSSSTSSSTTTTN   | Mark: 00001000 10001111
SNN                     | DROP
SNN                     | DROP
NTN                     | RTS

#endif
Commit	Line	Data
48f88489 AT	1	@ (c) 2020 Aaron Taylor <ataylor at subgeniuskitty dot com>
	2	@ See LICENSE.txt file for copyright and license details.
	3
8bed3ccd AT	4	#ifndef VVS_STDLIB_STDIO
	5	#define VVS_STDLIB_STDIO
	6
	7	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
bb21580a	8	@ Name:
b8b65c17	9	@ printstackstring (1000100)
8bed3ccd	10	@ Description:
bb21580a	11	@ Prints a null-terminated string from the stack.
8bed3ccd AT	12	@ Call Stack:
	13	@ null-terminator (ASCII '\0')
	14	@ char n
	15	@ ...
	16	@ char 2
	17	@ char 1 <-- TOS
	18	@ Return Stack:
	19	@ <empty>
	20	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
b8b65c17	21	NSSVTSSSTSSN \| Mark: 1000100 (print string from stack)
32c440bf	22	SNS \| DUP
b8b65c17	23	NTSSTSSSTSSSSSSSSSTN \| BRZ > 01000100 00000001
32c440bf	24	TNSS \| Print character
b8b65c17 AT	25	NSNTSSSTSSN \| JMP > 1000100
b8b65c17 AT	26	NSSVSTSSSTSSSSSSSSSTN \| Mark: 01000100 00000001
32c440bf AT	27	SNN \| DROP
	28	NTN \| RTS
	29
8bed3ccd	30	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
bb21580a	31	@ Name:
b8b65c17	32	@ printheapstring (1000101)
8bed3ccd	33	@ Description:
bb21580a	34	@ Prints a null-terminated string from the heap.
8bed3ccd AT	35	@ Call Stack:
	36	@ pointer to first character <-- TOS
	37	@ Return Stack:
	38	@ <empty>
	39	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
b8b65c17	40	NSSVTSSSTSTN \| Mark: 1000101 (print string from heap)
32c440bf AT	41	SNS \| DUP
	42	TTT \| LOAD
	43	SNS \| DUP
b8b65c17	44	NTSSTSSSTSTSSSSSSSTN \| BRZ > 01000101 00000001
32c440bf AT	45	TNSS \| Print character
	46	SSSTN \| Push +1
	47	TSSS \| ADD
b8b65c17 AT	48	NSNTSSSTSTN \| JMP > 1000101
b8b65c17 AT	49	NSSVSTSSSTSTSSSSSSSTN \| Mark: 01000101 00000001
32c440bf AT	50	SNN \| DROP
	51	SNN \| DROP
	52	NTN \| RTS
8bed3ccd	53
3625ff3a	54	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
bb21580a	55	@ Name:
23d17247	56	@ printstacknumber (1001)
3625ff3a	57	@ Description:
bb21580a	58	@ Prints 'number' from the stack in sign-magnitude format.
3625ff3a AT	59	@ Leading zeros are suppressed.
3625ff3a AT	60	@ Call Stack:
bb21580a	61	@ number <-- TOS
3625ff3a AT	62	@ Return Stack:
	63	@ <empty>
	64	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
23d17247	65	NSSVTSSTN \| Mark: 1001 (print number from stack)
3625ff3a	66	SNS \| DUP
149f16fd AT	67	NSTTSSSSTSN \| JSR > 1000010 (printstacknumbersign)
149f16fd AT	68	NSTTSSSSTTN \| JSR > 1000011 (printstacknumbermagnitude)
3625ff3a AT	69	NTN \| RTS
	70
	71	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
bb21580a	72	@ Name:
ae1f85a1	73	@ printstacknumbersign (1000010)
3625ff3a	74	@ Description:
bb21580a	75	@ Prints the sign of 'number' from the stack.
3625ff3a	76	@ Call Stack:
bb21580a	77	@ number <-- TOS
3625ff3a AT	78	@ Return Stack:
	79	@ <empty>
	80	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
ae1f85a1 AT	81	NSSVTSSSSTSN \| Mark: 1000010 (print sign of number from stack)
ae1f85a1 AT	82	NTTSTSSSSTSSSSSSSSTN \| BMI > 01000010 00000001
3625ff3a	83	SSSTSTSTTN \| PUSH ASCII '+'
ae1f85a1 AT	84	NSNSTSSSSTSSSSSSSTSN \| JMP > 01000010 00000010
ae1f85a1 AT	85	NSSVSTSSSSTSSSSSSSSTN \| Mark: 01000010 00000001
3625ff3a	86	SSSTSTTSTN \| PUSH ASCII '-'
ae1f85a1	87	NSSVSTSSSSTSSSSSSSTSN \| Mark: 01000010 00000010
3625ff3a AT	88	TNSS \| PUTC
	89	NTN \| RTS
	90
	91	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
bb21580a	92	@ Name:
ae1f85a1	93	@ printstacknumbermagnitude (1000011)
3625ff3a	94	@ Description:
bb21580a	95	@ Prints the magnitude of 'number' from the stack.
3625ff3a	96	@ Call Stack:
bb21580a	97	@ number <-- TOS
3625ff3a AT	98	@ Return Stack:
	99	@ <empty>
	100	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
bb21580a	101	#include <math.pvvs>
ae1f85a1	102	NSSVTSSSSTTN \| Mark: 1000011 (print magnitude of number from stack)
3625ff3a	103
acd78c53 AT	104	@ Catch -(2^63) as a special case since its absolute value will overflow
	105	@ a twos-complement 64-bit word.
	106	SNS \| DUP
	107	SSTTSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSN \| -(2^63)
	108	TSST \| SUBTRACT
	109	NTSSTSSSSTTSSSSSSTSN \| BRZ > 01000011 00000010
	110
	111	@ No special case applies. Prepare for computation by converting the number
	112	@ to absolute value and preparing a string on the stack.
	113	NSTTSSSTN \| JSR > 10001 (absolute value)
3625ff3a AT	114	SSSSN \| PUSH ASCII '\0'
	115	SNT \| SWAP
	116
	117	@ Pick off one digit on each pass through this loop.
ae1f85a1	118	NSSVSTSSSSTTSSSSSSSSN \| Mark: 01000011 00000000
3625ff3a AT	119	SNS \| DUP
	120
	121	@ Mod-off a digit, convert to ASCII, store on stack as part of the string.
	122	SSSTSTSN \| PUSH +10
	123	TSTT \| MODULO
	124	SSSTTSSSSN \| PUSH ASCII '0'
	125	TSSS \| ADD
	126	SNT \| SWAP
	127
	128	@ Divide down to next digit and keep looping if number != 0 yet.
	129	SSSTSTSN \| PUSH +10
	130	TSTS \| DIVIDE
	131	SNS \| DUP
ae1f85a1 AT	132	NTSSTSSSSTTSSSSSSSTN \| BRZ > 01000011 00000001
ae1f85a1 AT	133	NSNSTSSSSTTSSSSSSSSN \| JMP > 01000011 00000000
3625ff3a AT	134
3625ff3a AT	135	@ Print the string we have built on the stack.
ae1f85a1	136	NSSVSTSSSSTTSSSSSSSTN \| Mark: 01000011 00000001
3625ff3a	137	SNN \| DROP
45abb94e	138	NSTTSSSTSSN \| JSR > 1000100 (print string from stack)
3625ff3a AT	139	NTN \| RTS
3625ff3a AT	140
acd78c53 AT	141	@ Replace the number on the stack with its decimal ASCII representation.
	142	NSSVSTSSSSTTSSSSSSTSN \| BRZ > 01000011 00000010
	143	SNN \| DROP
	144	A"-9223372036854775808"
	145	NSNSTSSSSTTSSSSSSSTN \| JMP > 01000011 00000001
	146
23d17247 AT	147	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	148	@ Name:
	149	@ printf
	150	@ Description:
	151	@ If printing a static string (i.e. no substitutions), pass
	152	@ 'number of substitutions' as 0, immediately followed by 'string word 1'.
	153	@ If printing a string from the heap instead of stack, pass an empty string
	154	@ on the stack followed by a pointer to the first word of the
	155	@ null-terminated string on the heap.
	156	@ For example:
	157	@ pointer
	158	@ ASCII '\0'
	159	@ substitution n
	160	@ <remainder of call stack is unchanged>
6cb31a3e AT	161	@ Maximum substitutions determined by upper heap limit in stackrotate and
6cb31a3e AT	162	@ stackrotatereverse subroutines.
23d17247 AT	163	@ Call Stack:
	164	@ ACSII '\0'
	165	@ string word n
	166	@ ...
	167	@ string word 1
	168	@ substitution n
	169	@ ...
	170	@ substitution 1
	171	@ number of substitutions <-- TOS
	172	@ Return Stack:
	173	@ <empty>
	174	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
149f16fd	175	#include <stack.pvvs>
23d17247 AT	176	NSSVTSSSN \| Mark: 1000 (printf)
23d17247 AT	177
23d17247 AT	178	@ If the stack contains an empty string (i.e. just an ASCII '\0'), the next
23d17247 AT	179	@ word is a pointer we must use to load the string from the heap.
6cb31a3e	180	@ This will leave the stack looking exactly like the example call stack above.
23d17247 AT	181	@ Do the test this way so we can keep the code inline.
23d17247 AT	182	SNS \| DUP
6cb31a3e AT	183	SSSTSN \| PUSH 2
	184	TSSS \| ADD
	185	NSTTTSSN \| JSR > 1100 (deepdup)
23d17247 AT	186	SSTTN \| PUSH -1
	187	TSSN \| MULTIPLY
	188	NTTSSSSTSSSSSSSSSSTN \| BMI > 00001000 00000001
6cb31a3e AT	189	SNS \| DUP
	190	SSSTSN \| PUSH 2
	191	TSSS \| ADD
	192	NSTTSTTN \| JSR > 1011 (stackrotatereverse)
23d17247 AT	193	SNN \| DROP
23d17247 AT	194	SNS \| DUP
6cb31a3e AT	195	SSSTSN \| PUSH 2
	196	TSSS \| ADD
	197	NSTTSTTN \| JSR > 1011 (stackrotatereverse)
	198	NSTSSSSTSSSTSSSTTSSN \| JSR > 00001000 10001100 (printf_deepslurp)
23d17247 AT	199
	200	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	201	@ The rest of printf parses a string according to the following information.
	202	@ ASCII '\ ':
	203	@ ASCII '\ ': putchar '\ '
	204	@ ASCII '%': putchar '%'
	205	@ ASCII 'n': putchar '\n'
	206	@ ASCII 't': putchar '\t'
	207	@ ASCII '%':
	208	@ ASCII 'c': (print character)
	209	@ ASCII 's': (print string)
	210	@ ASCII 'd': (print decimal digit)
	211	@ ASCII 'u': (print abs(integer), w/o sign)
	212	@ ASCII 'i': (print integer w/sign)
	213	@ ASCII '\0':
	214	@ cleanup and exit
	215	@ default:
	216	@ putchar
	217	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	218
	219	@@@@@@@@@@@@@@@@@@@@
6cb31a3e	220	@ The next block tests the char against all possible level 1 branches (see above).
23d17247 AT	221	@ If there is a match, execution jumps to the appropriate level 2 branch label.
	222	@ If no match is found, print the character and move on.
	223	@@@@@@@@@@@@@@@@@@@@
	224	NSSVSSSSTSSSSSSSSSSTN \| Mark: 00001000 00000001
6cb31a3e AT	225	@ Move the next character of the string to TOS.
6cb31a3e AT	226	NSTSSSSTSSSTSSSTSTTN \| JSR > 00001000 10001011 (next char to TOS)
23d17247 AT	227	@ TOS is an ASCII '\ '. Jump to process the possible level 2 branches.
	228	SNS \| DUP
	229	SSSTSTTTSSN \| PUSH ASCII slash
	230	TSST \| SUBTRACT
	231	NTSSSSSTSSSSSSSSSTSN \| BRZ > 00001000 00000010
	232	@ TOS is an ASCII '%'. Jump to process the possible level 2 branches.
	233	SNS \| DUP
	234	SSSTSSTSTN \| PUSH ASCII '%'
	235	TSST \| SUBTRACT
	236	NTSSSSSTSSSSSSSSSTTN \| BRZ > 00001000 00000011
	237	@ TOS is an ASCII "\0". Jump to clean-up-and-exit.
	238	SNS \| DUP
	239	NTSSSSSTSSSSSSSSSSSN \| BRZ > 00001000 00000000
	240	@ TOS is a normal character. Print it and loop again.
	241	TNSS \| PUTC
	242	NSNSSSSTSSSSSSSSSSTN \| JMP > 00001000 00000001
	243
	244	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	245	@ Level 2 - ASCII '\ ' - Escapes
	246	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	247
	248	@@@@@@@@@@@@@@@@@@@@
	249	@ The level 1 match was an ASCII '\ '.
	250	@ Now look for level 2 matches that trigger a character substitution (n -> newline, etc).
	251	@ If no matches are found, print the character directly (e.g. "\%" -> '%')
	252	@ When finished, loop back to testing level 1 branches.
	253	@@@@@@@@@@@@@@@@@@@@
	254	NSSVSSSSTSSSSSSSSSTSN \| Mark: 00001000 00000010
	255	SNN \| DROP
6cb31a3e AT	256	@ Move the next character of the string to TOS.
6cb31a3e AT	257	NSTSSSSTSSSTSSSTSTTN \| JSR > 00001000 10001011 (next char to TOS)
23d17247 AT	258	@ Check for ASCII '\n'
	259	SNS \| DUP
	260	SSSTTSTTTSN \| PUSH ASCII 'n'
	261	TSST \| SUBTRACT
	262	NTSSSSSTSSSSSSSSTSSN \| BRZ > 00001000 00000100
	263	@ Check for ASCII '\t'
	264	SNS \| DUP
08a3a286	265	SSSTTTSTSSN \| PUSH ASCII 't'
23d17247 AT	266	TSST \| SUBTRACT
	267	NTSSSSSTSSSSSSSSTSTN \| BRZ > 00001000 00000101
	268	@ No substitution necessary. Print literally.
	269	TNSS \| PUTC
	270	NSNSSSSTSSSSSSSSSSTN \| JMP > 00001000 00000001
	271
	272	@@@@@@@@@@@@@@@@@@@@
	273	@ These are utility labels to output the appropriate non-printable ASCII character.
	274	@ After output, they loop back to testing level 1 branches.
	275	@@@@@@@@@@@@@@@@@@@@
	276
	277	@ Print a newline and loop for the next character.
	278	NSSVSSSSTSSSSSSSSTSSN \| Mark: 00001000 00000100
	279	SNN \| DROP
	280	SSSTSTSN \| PUSH ASCII '\n'
	281	TNSS \| PUTC
	282	NSNSSSSTSSSSSSSSSSTN \| JMP > 00001000 00000001
	283
	284	@ Print a horizontal tab and loop for the next character.
	285	NSSVSSSSTSSSSSSSSTSTN \| Mark: 00001000 00000101
	286	SNN \| DROP
	287	SSSTSSTN \| PUSH ASCII '\t'
	288	TNSS \| PUTC
	289	NSNSSSSTSSSSSSSSSSTN \| JMP > 00001000 00000001
	290
	291	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	292	@ Level 2 - ASCII '%' - Substitutions
	293	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	294
	295	@@@@@@@@@@@@@@@@@@@@
	296	@ The level 1 match was an ASCII '%'.
	297	@ Now look for level 2 matches that trigger a substitution.
	298	@ When finished, loop back to testing level 1 branches.
	299	@@@@@@@@@@@@@@@@@@@@
	300	NSSVSSSSTSSSSSSSSSTTN \| Mark: 00001000 00000011
	301	SNN \| DROP
6cb31a3e AT	302	@ Move the next character of the string to TOS.
6cb31a3e AT	303	NSTSSSSTSSSTSSSTSTTN \| JSR > 00001000 10001011 (next char to TOS)
23d17247 AT	304	@ Check for ASCII 'c' - Print character
	305	SNS \| DUP
	306	SSSTTSSSTTN \| PUSH ASCII 'c'
	307	TSST \| SUBTRACT
	308	NTSSSSSTSSSSSSSSTTSN \| BRZ > 00001000 00000110
	309	@ Check for ASCII 's' - Print string
	310	SNS \| DUP
	311	SSSTTTSSTTN \| PUSH ASCII 's'
	312	TSST \| SUBTRACT
	313	NTSSSSSTSSSSSSSSTTTN \| BRZ > 00001000 00000111
	314	@ Check for ASCII 'd' - Print decimal digit
	315	SNS \| DUP
	316	SSSTTSSTSSN \| PUSH ASCII 'd'
	317	TSST \| SUBTRACT
	318	NTSSSSSTSSSSSSSTSSSN \| BRZ > 00001000 00001000
	319	@ Check for ASCII 'u' - Print unsigned number
	320	SNS \| DUP
	321	SSSTTTSTSTN \| PUSH ASCII 'u'
	322	TSST \| SUBTRACT
	323	NTSSSSSTSSSSSSSTSSTN \| BRZ > 00001000 00001001
	324	@ Check for ASCII 'i' - Print signed number
	325	SNS \| DUP
	326	SSSTTSTSSTN \| PUSH ASCII 'i'
	327	TSST \| SUBTRACT
	328	NTSSSSSTSSSSSSSTSTSN \| BRZ > 00001000 00001010
	329	@ Unrecognized substitution specifier.
	330	@ For now, silently consume it and continue.
	331	@ Do not increment the substitution counter.
	332	@ TODO: Is this really what I want to do here?
	333	SNN \| DROP
	334	NSNSSSSTSSSSSSSSSSTN \| JMP > 00001000 00000001
	335
	336
	337	@@@@@@@@@@@@@@@@@@@@
	338	@ These are utility labels to call the appropriate type of output subroutine.
6cb31a3e AT	339	@ After output, they decrement the substition counter and loop back to testing
6cb31a3e AT	340	@ level 1 branches.
23d17247 AT	341	@@@@@@@@@@@@@@@@@@@@
	342
	343	@ Print a character
	344	NSSVSSSSTSSSSSSSSTTSN \| Mark: 00001000 00000110
	345	SNN \| DROP
6cb31a3e	346	SNT \| SWAP
23d17247	347	TNSS \| PUTC
6cb31a3e AT	348	SSSTN \| PUSH 1
6cb31a3e AT	349	TSST \| SUBTRACT
23d17247 AT	350	NSNSSSSTSSSSSSSSSSTN \| JMP > 00001000 00000001
	351	@ Print a string
	352	NSSVSSSSTSSSSSSSSTTTN \| Mark: 00001000 00000111
	353	SNN \| DROP
6cb31a3e	354	SNT \| SWAP
23d17247	355	NSTTSSSTSTN \| JSR > 1000101 (print string from heap)
6cb31a3e AT	356	SSSTN \| PUSH 1
6cb31a3e AT	357	TSST \| SUBTRACT
23d17247 AT	358	NSNSSSSTSSSSSSSSSSTN \| JMP > 00001000 00000001
	359	@ Print a decimal digit
	360	NSSVSSSSTSSSSSSSTSSSN \| Mark: 00001000 00001000
	361	SNN \| DROP
6cb31a3e	362	SNT \| SWAP
23d17247	363	TNST \| PUTDIGIT
6cb31a3e AT	364	SSSTN \| PUSH 1
6cb31a3e AT	365	TSST \| SUBTRACT
23d17247 AT	366	NSNSSSSTSSSSSSSSSSTN \| JMP > 00001000 00000001
	367	@ Print an unsigned integer
	368	NSSVSSSSTSSSSSSSTSSTN \| Mark: 00001000 00001001
	369	SNN \| DROP
6cb31a3e	370	SNT \| SWAP
23d17247	371	NSTTSSSSTTN \| JSR > 1000011 (print magnitude of number from stack)
6cb31a3e AT	372	SSSTN \| PUSH 1
6cb31a3e AT	373	TSST \| SUBTRACT
23d17247 AT	374	NSNSSSSTSSSSSSSSSSTN \| JMP > 00001000 00000001
	375	@ Print a signed integer
	376	NSSVSSSSTSSSSSSSTSTSN \| Mark: 00001000 00001010
	377	SNN \| DROP
6cb31a3e	378	SNT \| SWAP
23d17247	379	NSTTSSTN \| JSR > 1001 (print number from stack)
6cb31a3e AT	380	SSSTN \| PUSH 1
6cb31a3e AT	381	TSST \| SUBTRACT
23d17247 AT	382	NSNSSSSTSSSSSSSSSSTN \| JMP > 00001000 00000001
	383
	384	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	385	@ These are misc labels associated with the printf function.
	386	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	387
6cb31a3e AT	388	@ Found an ASCII "\0" when processing the format string. Clean up and exit.
	389	NSSVSSSSTSSSSSSSSSSSN \| Mark: 00001000 00000000
	390	SNN \| DROP
2da74194	391	SNN \| DROP
6cb31a3e AT	392	NTN \| RTS
	393
	394	@ Move the next string character to TOS.
	395	@ Stack should look like the printf call stack, with num-of-subs at TOS.
	396	NSSVSSSSTSSSTSSSTSTTN \| Mark: 00001000 10001011 (next char to TOS)
	397	SNS \| DUP
	398	SSSTSN \| PUSH 2
23d17247	399	TSSS \| ADD
6cb31a3e	400	NSTTSTTN \| JSR > 1011 (stackrotatereverse)
23d17247 AT	401	NTN \| RTS
23d17247 AT	402
6cb31a3e AT	403	@ Slurps a string from the heap to the stack, storing it behind the substitutions.
	404	@ Call Stack:
	405	@ substitution n
	406	@ ...
	407	@ substitution 1
	408	@ number of substitutions <-- TOS
	409	@ pointer to string
	410	@ Return Stack:
	411	@ ACSII '\0'
	412	@ string word n
	413	@ ...
	414	@ string word 1
	415	@ substitution n
	416	@ ...
	417	@ substitution 1
	418	@ number of substitutions <-- TOS
	419	@ TODO: This, along with a deepspew, should probably be stdlib routines.
	420	NSSVSSSSTSSSTSSSTTSSN \| Mark: 00001000 10001100 (printf_deepslurp)
	421	SNS \| DUP
	422	@ Advance a duplicate copy of the pointer until it points to the null-terminator.
	423	NSSVSSSSTSSSTSSSTTSTN \| Mark: 00001000 10001101
	424	SNS \| DUP
	425	TTT \| LOAD
	426	NTSSSSSTSSSTSSSTTTSN \| BRZ > 00001000 10001110
	427	SSSTN \| PUSH 1
	428	TSSS \| ADD
	429	NSNSSSSTSSSTSSSTTSTN \| JMP > 00001000 10001101
	430	@ Load a character to the stack on each pass through this loop.
	431	NSSVSSSSTSSSTSSSTTTSN \| Mark: 00001000 10001110
	432	SNS \| DUP
	433	TTT \| LOAD
	434	SSSTSSN \| PUSH 4
	435	NSTTTSSN \| JSR > 1100 (deepdup)
	436	SSSTSSN \| PUSH 4
	437	TSSS \| ADD
	438	NSTTSTSN \| JSR > 1010 (stackrotate)
	439	@ Test for end of loop.
	440	SNS \| DUP
	441	SSSTTN \| PUSH 3
	442	NSTTTSSN \| JSR > 1100 (deepdup)
	443	TSST \| SUBTRACT
	444	NTSSSSSTSSSTSSSTTTTN \| BRZ > 00001000 10001111
	445	@ Decrement pointer to end of string, loop again.
	446	SSSTN \| PUSH 1
	447	TSST \| SUBTRACT
	448	NSNSSSSTSSSTSSSTTTSN \| JMP > 00001000 10001110
	449	@ Clean up and return.
	450	NSSVSSSSTSSSTSSSTTTTN \| Mark: 00001000 10001111
	451	SNN \| DROP
23d17247 AT	452	SNN \| DROP
	453	NTN \| RTS
	454
8bed3ccd	455	#endif