[vvhitespace] / stdlib / logic.pvvs

#ifndef VVS_STDLIB_LOGIC
#define VVS_STDLIB_LOGIC

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@ These subroutines assume they are running on the official VVS interpreter
@ which internally uses a twos-complement representation.
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@ Name:
@   not (101000)
@ Description:
@   Performs a bitwise NOT on the TOS word.
@ Call Stack:
@   X
@ Return Stack:
@   NOT(X)
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
NSSVTSTSSSN             | Mark: 101000 (not)
@ In twos-complement, NOT(X) = (-X)-1
SSTTN                   | PUSH -1
TSSN                    | MULTIPLY
SSSTN                   | PUSH 1
TSST                    | SUBTRACT
NTN                     | RTS

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@ Name:
@   and (101001)
@ Description:
@   Performs a bitwise AND on the TOS word.
@ Call Stack:
@   X
@   Y
@ Return Stack:
@   X ^ Y
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
NSSVTSTSSTN             | Mark: 101001 (and)

@ Prepare the stack for computation.
SSSSN                   | PUSH 0 (result)
SSSTTTTTTN              | PUSH 63 (shift counter)

@ Loop through the bits one at a time.
NSSVSSTSTSSTSSSSSSSSN   | Mark: 00101001 00000000
@ Prepare copy of X for the AND
SNS                     | DUP
SSSTSTN                 | PUSH 5
NSTTTSSN                | JSR > 1100 (deepdup)
SNT                     | SWAP
NSTTSTTSSN              | JSR > 101100 (rshift)
@ Prepare copy of Y for the AND
SSSTSSN                 | PUSH 4
NSTTTSSN                | JSR > 1100 (deepdup)
SSSTTN                  | PUSH 3
NSTTTSSN                | JSR > 1100 (deepdup)
NSTTSTTSSN              | JSR > 101100 (rshift)
@ Do the AND and store in result.
NSTTSSSSSSN             | JSR > 1000000 (lowbitand)
SSSTTN                  | PUSH 3
NSTTSTTN                | JSR > 1011 (stackrotatereverse)
SSSTN                   | PUSH 1
NSTTSTTSTN              | JSR > 101101 (lshift)
TSSS                    | ADD
SSSTSN                  | PUSH 2
NSTTSTSN                | JSR > 1010 (stackrotate)
@ Test for end of loop.
SNS                     | DUP
NTSSSTSTSSTSSSSSSSTN    | BRZ > 00101001 00000001
@ Decrement the counter and loop again.
SSSTN                   | PUSH 1
TSST                    | SUBTRACT
NSNSSTSTSSTSSSSSSSSN    | JMP > 00101001 00000000

@ Clean up and return.
NSSVSSTSTSSTSSSSSSSTN   | Mark: 00101001 00000001
SNN                     | DROP
SNT                     | SWAP
SNN                     | DROP
SNT                     | SWAP
SNN                     | DROP
NTN                     | RTS

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@ Name:
@   or (101010)
@ Description:
@   Performs a bitwise OR on the TOS word.
@ Call Stack:
@   X
@   Y
@ Return Stack:
@   X v Y
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
NSSVTSTSTSN             | Mark: 101010 (or)
NSTTSTSSSN              | JSR > 101000 (not)
SNT                     | SWAP
NSTTSTSSSN              | JSR > 101000 (not)
NSTTSTSSTN              | JSR > 101001 (and)
NSTTSTSSSN              | JSR > 101000 (not)
NTN                     | RTS

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@ Name:
@   xor (101011)
@ Description:
@   Performs a bitwise XOR on the TOS word.
@ Call Stack:
@   X
@   Y
@ Return Stack:
@   X xor Y
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
NSSVTSTSTTN             | Mark: 101011 (xor)
SNS                     | DUP
SSSTTN                  | PUSH 3
NSTTTSSN                | JSR > 1100 (deepdup)
NSTTSTSTSN              | JSR > 101010 (or)
SNT                     | SWAP
SSSTTN                  | PUSH 3
NSTTSTTN                | JSR > 1011 (stackrotatereverse)
NSTTSTSSTN              | JSR > 101001 (and)
NSTTSTSSSN              | JSR > 101000 (not)
NSTTSTSSTN              | JSR > 101001 (and)
NTN                     | RTS

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@ Name:
@   rshift (101100)
@ Description:
@   Shifts 'X' right by 'shiftcount' bits with sign extension.
@ Call Stack:
@   X
@   shiftcount
@ Return Stack:
@   X >> shiftcount
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
NSSVTSTTSSN             | Mark: 101100 (rshift)

@ Test for loop completion first since it is allowable to shift by zero.
NSSVSSTSTTSSSSSSSSSTN   | Mark: 00101100 00000001
SNS                     | DUP
NTSSSTSTTSSSSSSSSSSN    | BRZ > 00101100 00000000
@ Shift by one bit on each pass.
SNT                     | SWAP
SSSTSN                  | PUSH 2
TSTS                    | DIVIDE
@ Decrement the counter.
SNT                     | SWAP
SSSTN                   | PUSH 1
TSST                    | SUBTRACT
@ Loop again.
NSNSSTSTTSSSSSSSSSTN    | JMP > 00101100 00000001

@ Clean up and return.
NSSVSSTSTTSSSSSSSSSSN   | Mark: 00101100 00000000
SNN                     | DROP
NTN                     | RTS

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@ Name:
@   lshift (101101)
@ Description:
@   Shifts 'X' left by 'shiftcount' bits with zero filling.
@ Call Stack:
@   X
@   shiftcount
@ Return Stack:
@   X << shiftcount
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
NSSVTSTTSTN             | Mark: 101101 (lshift)

@ Test for loop completion first since it is allowable to shift by zero.
NSSVSSTSTTSTSSSSSSSTN   | Mark: 00101101 00000001
SNS                     | DUP
NTSSSTSTTSTSSSSSSSSN    | BRZ > 00101101 00000000
@ Shift by one bit on each pass.
SNT                     | SWAP
SSSTSN                  | PUSH 2
TSSN                    | MULTIPLY
@ Decrement the counter.
SNT                     | SWAP
SSSTN                   | PUSH 1
TSST                    | SUBTRACT
@ Loop again.
NSNSSTSTTSTSSSSSSSTN    | JMP > 00101101 00000001

@ Clean up and return.
NSSVSSTSTTSTSSSSSSSSN   | Mark: 00101101 00000000
SNN                     | DROP
NTN                     | RTS

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@ Name:
@   lowbitand (1000000)
@ Description:
@   Performs logical AND on the least-significant bit of 'X' and 'Y'.
@   Returns either 1 or 0, no other values.
@ Call Stack:
@   X
@   Y
@ Return Stack:
@   lsb(X) AND lsb(Y)
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
NSSVTSSSSSSN            | Mark: 1000000 (lowbitand)
SSSTSN                  | PUSH 2
TSTT                    | MODULO
SNT                     | SWAP
SSSTSN                  | PUSH 2
TSTT                    | MODULO
TSSS                    | ADD
SSSTSN                  | PUSH 2
TSTS                    | DIVIDE
NTN                     | RTS

#endif
Commit	Line	Data
0c56152e AT	1	#ifndef VVS_STDLIB_LOGIC
	2	#define VVS_STDLIB_LOGIC
	3
	4	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	5	@ These subroutines assume they are running on the official VVS interpreter
	6	@ which internally uses a twos-complement representation.
	7	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	8
	9	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	10	@ Name:
	11	@ not (101000)
	12	@ Description:
	13	@ Performs a bitwise NOT on the TOS word.
	14	@ Call Stack:
	15	@ X
	16	@ Return Stack:
	17	@ NOT(X)
	18	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	19	NSSVTSTSSSN \| Mark: 101000 (not)
	20	@ In twos-complement, NOT(X) = (-X)-1
	21	SSTTN \| PUSH -1
	22	TSSN \| MULTIPLY
76974914	23	SSSTN \| PUSH 1
0c56152e AT	24	TSST \| SUBTRACT
	25	NTN \| RTS
	26
3eaa958a AT	27	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	28	@ Name:
	29	@ and (101001)
	30	@ Description:
	31	@ Performs a bitwise AND on the TOS word.
	32	@ Call Stack:
	33	@ X
	34	@ Y
	35	@ Return Stack:
	36	@ X ^ Y
	37	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	38	NSSVTSTSSTN \| Mark: 101001 (and)
	39
	40	@ Prepare the stack for computation.
	41	SSSSN \| PUSH 0 (result)
	42	SSSTTTTTTN \| PUSH 63 (shift counter)
	43
	44	@ Loop through the bits one at a time.
	45	NSSVSSTSTSSTSSSSSSSSN \| Mark: 00101001 00000000
76974914	46	@ Prepare copy of X for the AND
3eaa958a AT	47	SNS \| DUP
	48	SSSTSTN \| PUSH 5
	49	NSTTTSSN \| JSR > 1100 (deepdup)
	50	SNT \| SWAP
	51	NSTTSTTSSN \| JSR > 101100 (rshift)
76974914	52	@ Prepare copy of Y for the AND
3eaa958a AT	53	SSSTSSN \| PUSH 4
	54	NSTTTSSN \| JSR > 1100 (deepdup)
	55	SSSTTN \| PUSH 3
	56	NSTTTSSN \| JSR > 1100 (deepdup)
	57	NSTTSTTSSN \| JSR > 101100 (rshift)
	58	@ Do the AND and store in result.
	59	NSTTSSSSSSN \| JSR > 1000000 (lowbitand)
	60	SSSTTN \| PUSH 3
	61	NSTTSTTN \| JSR > 1011 (stackrotatereverse)
	62	SSSTN \| PUSH 1
	63	NSTTSTTSTN \| JSR > 101101 (lshift)
	64	TSSS \| ADD
	65	SSSTSN \| PUSH 2
	66	NSTTSTSN \| JSR > 1010 (stackrotate)
	67	@ Test for end of loop.
	68	SNS \| DUP
	69	NTSSSTSTSSTSSSSSSSTN \| BRZ > 00101001 00000001
	70	@ Decrement the counter and loop again.
	71	SSSTN \| PUSH 1
	72	TSST \| SUBTRACT
	73	NSNSSTSTSSTSSSSSSSSN \| JMP > 00101001 00000000
	74
	75	@ Clean up and return.
	76	NSSVSSTSTSSTSSSSSSSTN \| Mark: 00101001 00000001
	77	SNN \| DROP
	78	SNT \| SWAP
	79	SNN \| DROP
	80	SNT \| SWAP
	81	SNN \| DROP
	82	NTN \| RTS
	83
76974914 AT	84	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	85	@ Name:
	86	@ or (101010)
	87	@ Description:
	88	@ Performs a bitwise OR on the TOS word.
	89	@ Call Stack:
	90	@ X
	91	@ Y
	92	@ Return Stack:
	93	@ X v Y
	94	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	95	NSSVTSTSTSN \| Mark: 101010 (or)
	96	NSTTSTSSSN \| JSR > 101000 (not)
	97	SNT \| SWAP
	98	NSTTSTSSSN \| JSR > 101000 (not)
	99	NSTTSTSSTN \| JSR > 101001 (and)
	100	NSTTSTSSSN \| JSR > 101000 (not)
	101	NTN \| RTS
	102
	103	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	104	@ Name:
	105	@ xor (101011)
	106	@ Description:
	107	@ Performs a bitwise XOR on the TOS word.
	108	@ Call Stack:
	109	@ X
	110	@ Y
	111	@ Return Stack:
	112	@ X xor Y
	113	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	114	NSSVTSTSTTN \| Mark: 101011 (xor)
	115	SNS \| DUP
	116	SSSTTN \| PUSH 3
	117	NSTTTSSN \| JSR > 1100 (deepdup)
	118	NSTTSTSTSN \| JSR > 101010 (or)
	119	SNT \| SWAP
	120	SSSTTN \| PUSH 3
	121	NSTTSTTN \| JSR > 1011 (stackrotatereverse)
	122	NSTTSTSSTN \| JSR > 101001 (and)
	123	NSTTSTSSSN \| JSR > 101000 (not)
	124	NSTTSTSSTN \| JSR > 101001 (and)
	125	NTN \| RTS
	126
0c56152e AT	127	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	128	@ Name:
	129	@ rshift (101100)
	130	@ Description:
	131	@ Shifts 'X' right by 'shiftcount' bits with sign extension.
	132	@ Call Stack:
	133	@ X
	134	@ shiftcount
	135	@ Return Stack:
	136	@ X >> shiftcount
	137	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	138	NSSVTSTTSSN \| Mark: 101100 (rshift)
	139
3eaa958a	140	@ Test for loop completion first since it is allowable to shift by zero.
0c56152e AT	141	NSSVSSTSTTSSSSSSSSSTN \| Mark: 00101100 00000001
	142	SNS \| DUP
	143	NTSSSTSTTSSSSSSSSSSN \| BRZ > 00101100 00000000
	144	@ Shift by one bit on each pass.
	145	SNT \| SWAP
	146	SSSTSN \| PUSH 2
	147	TSTS \| DIVIDE
	148	@ Decrement the counter.
	149	SNT \| SWAP
	150	SSSTN \| PUSH 1
	151	TSST \| SUBTRACT
	152	@ Loop again.
	153	NSNSSTSTTSSSSSSSSSTN \| JMP > 00101100 00000001
	154
	155	@ Clean up and return.
	156	NSSVSSTSTTSSSSSSSSSSN \| Mark: 00101100 00000000
	157	SNN \| DROP
	158	NTN \| RTS
	159
	160	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	161	@ Name:
	162	@ lshift (101101)
	163	@ Description:
	164	@ Shifts 'X' left by 'shiftcount' bits with zero filling.
	165	@ Call Stack:
	166	@ X
	167	@ shiftcount
	168	@ Return Stack:
	169	@ X << shiftcount
	170	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	171	NSSVTSTTSTN \| Mark: 101101 (lshift)
	172
3eaa958a	173	@ Test for loop completion first since it is allowable to shift by zero.
0c56152e AT	174	NSSVSSTSTTSTSSSSSSSTN \| Mark: 00101101 00000001
	175	SNS \| DUP
	176	NTSSSTSTTSTSSSSSSSSN \| BRZ > 00101101 00000000
	177	@ Shift by one bit on each pass.
	178	SNT \| SWAP
	179	SSSTSN \| PUSH 2
	180	TSSN \| MULTIPLY
	181	@ Decrement the counter.
	182	SNT \| SWAP
	183	SSSTN \| PUSH 1
	184	TSST \| SUBTRACT
	185	@ Loop again.
	186	NSNSSTSTTSTSSSSSSSTN \| JMP > 00101101 00000001
	187
	188	@ Clean up and return.
	189	NSSVSSTSTTSTSSSSSSSSN \| Mark: 00101101 00000000
	190	SNN \| DROP
	191	NTN \| RTS
	192
e0d5136c AT	193	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	194	@ Name:
	195	@ lowbitand (1000000)
	196	@ Description:
	197	@ Performs logical AND on the least-significant bit of 'X' and 'Y'.
	198	@ Returns either 1 or 0, no other values.
	199	@ Call Stack:
	200	@ X
	201	@ Y
	202	@ Return Stack:
	203	@ lsb(X) AND lsb(Y)
	204	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	205	NSSVTSSSSSSN \| Mark: 1000000 (lowbitand)
	206	SSSTSN \| PUSH 2
	207	TSTT \| MODULO
	208	SNT \| SWAP
	209	SSSTSN \| PUSH 2
	210	TSTT \| MODULO
	211	TSSS \| ADD
	212	SSSTSN \| PUSH 2
	213	TSTS \| DIVIDE
	214	NTN \| RTS
	215
0c56152e	216	#endif