[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
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
#include <stack.pvvs>
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
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
#include <stack.pvvs>
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.
SNS                     | DUP
NTSSSTSTTSSSSSSSSSSN    | BRZ > 00101100 00000000

@ Negative numbers need special handling.
SNT                     | SWAP
SNS                     | DUP
NTTSSTSTTSSSSSSSTSTN    | BMI > 00101100 00000101

@ Shift by one bit on each pass.
NSSVSSTSTTSSSSSSSTSSN   | Mark: 00101100 00000100
SSSTSN                  | PUSH 2
TSTS                    | DIVIDE
@ Decrement the counter.
SNT                     | SWAP
SSSTN                   | PUSH 1
TSST                    | SUBTRACT
@ Loop again.
NSNTSTTSSN              | JMP > 101100 (rshift)

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

@ Found a negative number. Subtract one before proceeding if odd.
NSSVSSTSTTSSSSSSSTSTN   | Mark: 00101100 00000101
SNS                     | DUP
SSSTSN                  | PUSH 2
TSTT                    | MODULO
NTSSSTSTTSSSSSSSTSSN    | BRZ > 00101100 00000100
SSSTN                   | PUSH 1
TSST                    | SUBTRACT
NSNSSTSTTSSSSSSSTSSN    | JMP > 00101100 00000100

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@ 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	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
149f16fd	38	#include <stack.pvvs>
3eaa958a AT	39	NSSVTSTSSTN \| Mark: 101001 (and)
	40
	41	@ Prepare the stack for computation.
	42	SSSSN \| PUSH 0 (result)
	43	SSSTTTTTTN \| PUSH 63 (shift counter)
	44
	45	@ Loop through the bits one at a time.
	46	NSSVSSTSTSSTSSSSSSSSN \| Mark: 00101001 00000000
76974914	47	@ Prepare copy of X for the AND
3eaa958a AT	48	SNS \| DUP
	49	SSSTSTN \| PUSH 5
	50	NSTTTSSN \| JSR > 1100 (deepdup)
	51	SNT \| SWAP
	52	NSTTSTTSSN \| JSR > 101100 (rshift)
76974914	53	@ Prepare copy of Y for the AND
3eaa958a AT	54	SSSTSSN \| PUSH 4
	55	NSTTTSSN \| JSR > 1100 (deepdup)
	56	SSSTTN \| PUSH 3
	57	NSTTTSSN \| JSR > 1100 (deepdup)
	58	NSTTSTTSSN \| JSR > 101100 (rshift)
	59	@ Do the AND and store in result.
	60	NSTTSSSSSSN \| JSR > 1000000 (lowbitand)
	61	SSSTTN \| PUSH 3
	62	NSTTSTTN \| JSR > 1011 (stackrotatereverse)
	63	SSSTN \| PUSH 1
	64	NSTTSTTSTN \| JSR > 101101 (lshift)
	65	TSSS \| ADD
	66	SSSTSN \| PUSH 2
	67	NSTTSTSN \| JSR > 1010 (stackrotate)
	68	@ Test for end of loop.
	69	SNS \| DUP
	70	NTSSSTSTSSTSSSSSSSTN \| BRZ > 00101001 00000001
	71	@ Decrement the counter and loop again.
	72	SSSTN \| PUSH 1
	73	TSST \| SUBTRACT
	74	NSNSSTSTSSTSSSSSSSSN \| JMP > 00101001 00000000
	75
	76	@ Clean up and return.
	77	NSSVSSTSTSSTSSSSSSSTN \| Mark: 00101001 00000001
	78	SNN \| DROP
	79	SNT \| SWAP
	80	SNN \| DROP
	81	SNT \| SWAP
	82	SNN \| DROP
	83	NTN \| RTS
	84
76974914 AT	85	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	86	@ Name:
	87	@ or (101010)
	88	@ Description:
	89	@ Performs a bitwise OR on the TOS word.
	90	@ Call Stack:
	91	@ X
	92	@ Y
	93	@ Return Stack:
	94	@ X v Y
	95	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	96	NSSVTSTSTSN \| Mark: 101010 (or)
	97	NSTTSTSSSN \| JSR > 101000 (not)
	98	SNT \| SWAP
	99	NSTTSTSSSN \| JSR > 101000 (not)
	100	NSTTSTSSTN \| JSR > 101001 (and)
	101	NSTTSTSSSN \| JSR > 101000 (not)
	102	NTN \| RTS
	103
	104	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	105	@ Name:
	106	@ xor (101011)
	107	@ Description:
	108	@ Performs a bitwise XOR on the TOS word.
	109	@ Call Stack:
	110	@ X
	111	@ Y
	112	@ Return Stack:
	113	@ X xor Y
	114	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
149f16fd	115	#include <stack.pvvs>
76974914 AT	116	NSSVTSTSTTN \| Mark: 101011 (xor)
	117	SNS \| DUP
	118	SSSTTN \| PUSH 3
	119	NSTTTSSN \| JSR > 1100 (deepdup)
	120	NSTTSTSTSN \| JSR > 101010 (or)
	121	SNT \| SWAP
	122	SSSTTN \| PUSH 3
	123	NSTTSTTN \| JSR > 1011 (stackrotatereverse)
	124	NSTTSTSSTN \| JSR > 101001 (and)
	125	NSTTSTSSSN \| JSR > 101000 (not)
	126	NSTTSTSSTN \| JSR > 101001 (and)
	127	NTN \| RTS
	128
0c56152e AT	129	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	130	@ Name:
	131	@ rshift (101100)
	132	@ Description:
	133	@ Shifts 'X' right by 'shiftcount' bits with sign extension.
	134	@ Call Stack:
	135	@ X
	136	@ shiftcount
	137	@ Return Stack:
	138	@ X >> shiftcount
	139	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	140	NSSVTSTTSSN \| Mark: 101100 (rshift)
3eaa958a	141	@ Test for loop completion first since it is allowable to shift by zero.
0c56152e AT	142	SNS \| DUP
0c56152e AT	143	NTSSSTSTTSSSSSSSSSSN \| BRZ > 00101100 00000000
0750ec76 AT	144
0750ec76 AT	145	@ Negative numbers need special handling.
0c56152e	146	SNT \| SWAP
0750ec76 AT	147	SNS \| DUP
	148	NTTSSTSTTSSSSSSSTSTN \| BMI > 00101100 00000101
	149
	150	@ Shift by one bit on each pass.
	151	NSSVSSTSTTSSSSSSSTSSN \| Mark: 00101100 00000100
0c56152e AT	152	SSSTSN \| PUSH 2
	153	TSTS \| DIVIDE
	154	@ Decrement the counter.
	155	SNT \| SWAP
	156	SSSTN \| PUSH 1
	157	TSST \| SUBTRACT
	158	@ Loop again.
0750ec76	159	NSNTSTTSSN \| JMP > 101100 (rshift)
0c56152e	160
0750ec76	161	@ Clean up
0c56152e AT	162	NSSVSSTSTTSSSSSSSSSSN \| Mark: 00101100 00000000
	163	SNN \| DROP
	164	NTN \| RTS
	165
0750ec76 AT	166	@ Found a negative number. Subtract one before proceeding if odd.
	167	NSSVSSTSTTSSSSSSSTSTN \| Mark: 00101100 00000101
	168	SNS \| DUP
	169	SSSTSN \| PUSH 2
	170	TSTT \| MODULO
	171	NTSSSTSTTSSSSSSSTSSN \| BRZ > 00101100 00000100
	172	SSSTN \| PUSH 1
	173	TSST \| SUBTRACT
	174	NSNSSTSTTSSSSSSSTSSN \| JMP > 00101100 00000100
	175
0c56152e AT	176	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	177	@ Name:
	178	@ lshift (101101)
	179	@ Description:
	180	@ Shifts 'X' left by 'shiftcount' bits with zero filling.
	181	@ Call Stack:
	182	@ X
	183	@ shiftcount
	184	@ Return Stack:
	185	@ X << shiftcount
	186	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	187	NSSVTSTTSTN \| Mark: 101101 (lshift)
	188
3eaa958a	189	@ Test for loop completion first since it is allowable to shift by zero.
0c56152e AT	190	NSSVSSTSTTSTSSSSSSSTN \| Mark: 00101101 00000001
	191	SNS \| DUP
	192	NTSSSTSTTSTSSSSSSSSN \| BRZ > 00101101 00000000
	193	@ Shift by one bit on each pass.
	194	SNT \| SWAP
	195	SSSTSN \| PUSH 2
	196	TSSN \| MULTIPLY
	197	@ Decrement the counter.
	198	SNT \| SWAP
	199	SSSTN \| PUSH 1
	200	TSST \| SUBTRACT
	201	@ Loop again.
	202	NSNSSTSTTSTSSSSSSSTN \| JMP > 00101101 00000001
	203
	204	@ Clean up and return.
	205	NSSVSSTSTTSTSSSSSSSSN \| Mark: 00101101 00000000
	206	SNN \| DROP
	207	NTN \| RTS
	208
e0d5136c AT	209	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	210	@ Name:
	211	@ lowbitand (1000000)
	212	@ Description:
	213	@ Performs logical AND on the least-significant bit of 'X' and 'Y'.
	214	@ Returns either 1 or 0, no other values.
	215	@ Call Stack:
	216	@ X
	217	@ Y
	218	@ Return Stack:
	219	@ lsb(X) AND lsb(Y)
	220	@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
	221	NSSVTSSSSSSN \| Mark: 1000000 (lowbitand)
	222	SSSTSN \| PUSH 2
	223	TSTT \| MODULO
	224	SNT \| SWAP
	225	SSSTSN \| PUSH 2
	226	TSTT \| MODULO
	227	TSSS \| ADD
	228	SSSTSN \| PUSH 2
	229	TSTS \| DIVIDE
	230	NTN \| RTS
	231
0c56152e	232	#endif