Annotation of gforth/test/ttester.fs, revision 1.5
1.2 anton 1: \ for the original tester
1.1 anton 2: \ From: John Hayes S1I
3: \ Subject: tester.fr
4: \ Date: Mon, 27 Nov 95 13:10:09 PST
5: \ (C) 1995 JOHNS HOPKINS UNIVERSITY / APPLIED PHYSICS LABORATORY
6: \ MAY BE DISTRIBUTED FREELY AS LONG AS THIS COPYRIGHT NOTICE REMAINS.
7: \ VERSION 1.1
8:
1.2 anton 9: \ for the FNEARLY= stuff:
1.4 anton 10: \ from ftester.fs written by David N. Williams, based on the idea of
1.2 anton 11: \ approximate equality in Dirk Zoller's float.4th
1.4 anton 12: \ public domain
1.2 anton 13:
14: \ for the rest:
1.4 anton 15: \ revised by Anton Ertl 2007-08-12, 2007-08-19, 2007-08-28
1.2 anton 16: \ public domain
17:
1.1 anton 18: \ The original has the following shortcomings:
19:
20: \ - It does not work as expected if the stack is non-empty before the {.
21:
22: \ - It does not check FP results if the system has a separate FP stack.
23:
24: \ - There is a conflict with the use of } for FSL arrays and { for locals.
25:
26: \ I have revised it to address these shortcomings. You can find the
27: \ result at
28:
29: \ http://www.forth200x.org/tests/tester.fs
30: \ http://www.forth200x.org/tests/ttester.fs
31:
32: \ tester.fs is intended to be a drop-in replacement of the original.
1.4 anton 33:
34: \ ttester.fs is a version that uses T{ and }T instead of { and } and
35: \ keeps the BASE as it was before loading ttester.fs
1.1 anton 36:
37: \ In spirit of the original, I have strived to avoid any potential
38: \ non-portabilities and stayed as much within the CORE words as
39: \ possible; e.g., FLOATING words are used only if the FLOATING wordset
40: \ is present
41:
42: \ There are a few things to be noted:
43:
1.5 ! anton 44: \ - Loading ttester.fs does not change BASE. Loading tester.fs
! 45: \ changes BASE to HEX (like the original tester). Floating-point
! 46: \ input is ambiguous when the base is not decimal, so you have to set
! 47: \ it to decimal yourself when you want to deal with decimal numbers.
1.1 anton 48:
49: \ - For FP it is often useful to use approximate equality for checking
50: \ the results. You can turn on approximate matching with SET-NEAR
51: \ (and turn it off (default) with SET-EXACT, and you can tune it by
52: \ setting the variables REL-NEAR and ABS-NEAR. If you want your tests
53: \ to work with a shared stack, you have to specify the types of the
54: \ elements on the stack by using one of the closing words that specify
55: \ types, e.g. RRRX}T for checking the stack picture ( r r r x ).
56: \ There are such words for all combination of R and X with up to 4
57: \ stack items, and defining more if you need them is straightforward
58: \ (see source). If your tests are only intended for a separate-stack
59: \ system or if you need only exact matching, you can use the plain }T
60: \ instead.
61:
1.4 anton 62: BASE @
1.1 anton 63: HEX
64:
65: \ SET THE FOLLOWING FLAG TO TRUE FOR MORE VERBOSE OUTPUT; THIS MAY
66: \ ALLOW YOU TO TELL WHICH TEST CAUSED YOUR SYSTEM TO HANG.
67: VARIABLE VERBOSE
68: FALSE VERBOSE !
69:
70: VARIABLE ACTUAL-DEPTH \ STACK RECORD
71: CREATE ACTUAL-RESULTS 20 CELLS ALLOT
72: VARIABLE START-DEPTH
73: VARIABLE XCURSOR \ FOR ...}T
74: VARIABLE ERROR-XT
75:
76: : ERROR ERROR-XT @ EXECUTE ;
77:
78: : "FLOATING" S" FLOATING" ; \ ONLY COMPILED S" IN CORE
79: : "FLOATING-STACK" S" FLOATING-STACK" ;
80: "FLOATING" ENVIRONMENT? [IF]
81: [IF]
82: TRUE
83: [ELSE]
84: FALSE
85: [THEN]
86: [ELSE]
87: FALSE
88: [THEN] CONSTANT HAS-FLOATING
89: "FLOATING-STACK" ENVIRONMENT? [IF]
90: [IF]
91: TRUE
92: [ELSE]
93: FALSE
94: [THEN]
95: [ELSE] \ WE DON'T KNOW WHETHER THE FP STACK IS SEPARATE
96: HAS-FLOATING \ IF WE HAVE FLOATING, WE ASSUME IT IS
97: [THEN] CONSTANT HAS-FLOATING-STACK
98:
99: HAS-FLOATING [IF]
100: \ SET THE FOLLOWING TO THE RELATIVE AND ABSOLUTE TOLERANCES YOU
101: \ WANT FOR APPROXIMATE FLOAT EQUALITY, TO BE USED WITH F~ IN
102: \ FNEARLY=. KEEP THE SIGNS, BECAUSE F~ NEEDS THEM.
1.5 ! anton 103: FVARIABLE REL-NEAR DECIMAL 1E-12 HEX REL-NEAR F!
1.1 anton 104: FVARIABLE ABS-NEAR DECIMAL 0E HEX ABS-NEAR F!
105:
106: \ WHEN EXACT? IS TRUE, }F USES FEXACTLY=, OTHERWISE FNEARLY=.
107:
108: TRUE VALUE EXACT?
109: : SET-EXACT ( -- ) TRUE TO EXACT? ;
110: : SET-NEAR ( -- ) FALSE TO EXACT? ;
111:
112: DECIMAL
113: : FEXACTLY= ( F: X Y -- S: FLAG )
114: (
115: LEAVE TRUE IF THE TWO FLOATS ARE IDENTICAL.
116: )
117: 0E F~ ;
118: HEX
119:
120: : FABS= ( F: X Y -- S: FLAG )
121: (
122: LEAVE TRUE IF THE TWO FLOATS ARE EQUAL WITHIN THE TOLERANCE
123: STORED IN ABS-NEAR.
124: )
125: ABS-NEAR F@ F~ ;
126:
127: : FREL= ( F: X Y -- S: FLAG )
128: (
129: LEAVE TRUE IF THE TWO FLOATS ARE RELATIVELY EQUAL BASED ON THE
130: TOLERANCE STORED IN ABS-NEAR.
131: )
132: REL-NEAR F@ FNEGATE F~ ;
133:
134: : F2DUP FOVER FOVER ;
135: : F2DROP FDROP FDROP ;
136:
137: : FNEARLY= ( F: X Y -- S: FLAG )
138: (
139: LEAVE TRUE IF THE TWO FLOATS ARE NEARLY EQUAL. THIS IS A
140: REFINEMENT OF DIRK ZOLLER'S FEQ TO ALSO ALLOW X = Y, INCLUDING
141: BOTH ZERO, OR TO ALLOW APPROXIMATE EQUALITY WHEN X AND Y ARE TOO
142: SMALL TO SATISFY THE RELATIVE APPROXIMATION MODE IN THE F~
143: SPECIFICATION.
144: )
145: F2DUP FEXACTLY= IF F2DROP TRUE EXIT THEN
146: F2DUP FREL= IF F2DROP TRUE EXIT THEN
147: FABS= ;
148:
149: : FCONF= ( R1 R2 -- F )
150: EXACT? IF
151: FEXACTLY=
152: ELSE
153: FNEARLY=
154: THEN ;
155: [THEN]
156:
157: HAS-FLOATING-STACK [IF]
158: VARIABLE ACTUAL-FDEPTH
159: CREATE ACTUAL-FRESULTS 20 FLOATS ALLOT
160: VARIABLE START-FDEPTH
161: VARIABLE FCURSOR
162:
163: : EMPTY-FSTACK ( ... -- ... )
164: FDEPTH START-FDEPTH @ < IF
165: FDEPTH START-FDEPTH @ SWAP DO 0E LOOP
166: THEN
167: FDEPTH START-FDEPTH @ > IF
168: FDEPTH START-FDEPTH @ DO FDROP LOOP
169: THEN ;
170:
171: : F{ ( -- )
172: FDEPTH START-FDEPTH ! 0 FCURSOR ! ;
173:
174: : F-> ( ... -- ... )
175: FDEPTH DUP ACTUAL-FDEPTH !
176: START-FDEPTH @ > IF
177: FDEPTH START-FDEPTH @ DO ACTUAL-FRESULTS I FLOATS + F! LOOP
178: THEN ;
179:
180: : F} ( ... -- ... )
181: FDEPTH ACTUAL-FDEPTH @ = IF
182: FDEPTH START-FDEPTH @ > IF
183: FDEPTH START-FDEPTH @ DO
184: ACTUAL-FRESULTS I FLOATS + F@ FCONF= INVERT IF
185: S" INCORRECT FP RESULT: " ERROR LEAVE
186: THEN
187: LOOP
188: THEN
189: ELSE
190: S" WRONG NUMBER OF FP RESULTS: " ERROR
191: THEN ;
192:
193: : F...}T ( -- )
194: FDEPTH START-FDEPTH @ = 0= IF
195: S" WRONG NUMBER OF FP RESULTS" ERROR
196: THEN
197: FCURSOR @ ACTUAL-FDEPTH @ <> IF
198: S" WRONG NUMBER OF FP RESULTS" ERROR
199: THEN ;
200:
201: : FTESTER ( R -- )
202: FDEPTH 0= ACTUAL-FDEPTH @ FCURSOR @ 1+ < OR IF
203: S" WRONG NUMBER OF FP RESULTS: " ERROR EXIT
204: THEN
205: ACTUAL-FRESULTS FCURSOR @ FLOATS + F@ FCONF= 0= IF
206: S" INCORRECT FP RESULT: " ERROR
207: THEN
208: 1 FCURSOR +! ;
209:
210: [ELSE]
211: : EMPTY-FSTACK ;
212: : F{ ;
213: : F-> ;
214: : F} ;
215: : F...}T ;
216:
1.3 anton 217: DECIMAL
1.1 anton 218: : COMPUTE-CELLS-PER-FP ( -- U )
1.3 anton 219: DEPTH 0E DEPTH 1- >R FDROP R> SWAP - ;
220: HEX
1.1 anton 221:
222: COMPUTE-CELLS-PER-FP CONSTANT CELLS-PER-FP
223:
224: : FTESTER ( R -- )
225: DEPTH CELLS-PER-FP < ACTUAL-DEPTH @ XCURSOR @ CELLS-PER-FP + < OR IF
226: S" WRONG NUMBER OF RESULTS: " ERROR EXIT
227: THEN
228: ACTUAL-RESULTS XCURSOR @ CELLS + F@ FCONF= 0= IF
229: S" INCORRECT FP RESULT: " ERROR
230: THEN
231: CELLS-PER-FP XCURSOR +! ;
232: [THEN]
233:
234: : EMPTY-STACK \ ( ... -- ) EMPTY STACK: HANDLES UNDERFLOWED STACK TOO.
235: DEPTH START-DEPTH @ < IF
236: DEPTH START-DEPTH @ SWAP DO 0 LOOP
237: THEN
238: DEPTH START-DEPTH @ > IF
239: DEPTH START-DEPTH @ DO DROP LOOP
240: THEN
241: EMPTY-FSTACK ;
242:
243: : ERROR1 \ ( C-ADDR U -- ) DISPLAY AN ERROR MESSAGE FOLLOWED BY
244: \ THE LINE THAT HAD THE ERROR.
245: TYPE SOURCE TYPE CR \ DISPLAY LINE CORRESPONDING TO ERROR
246: EMPTY-STACK \ THROW AWAY EVERY THING ELSE
247: ;
248:
249: ' ERROR1 ERROR-XT !
250:
251: : T{ \ ( -- ) SYNTACTIC SUGAR.
1.3 anton 252: DEPTH START-DEPTH ! 0 XCURSOR ! F{ ;
1.1 anton 253:
254: : -> \ ( ... -- ) RECORD DEPTH AND CONTENT OF STACK.
255: DEPTH DUP ACTUAL-DEPTH ! \ RECORD DEPTH
256: START-DEPTH @ > IF \ IF THERE IS SOMETHING ON STACK
257: DEPTH START-DEPTH @ DO ACTUAL-RESULTS I CELLS + ! LOOP \ SAVE THEM
258: THEN
259: F-> ;
260:
261: : }T \ ( ... -- ) COMPARE STACK (EXPECTED) CONTENTS WITH SAVED
262: \ (ACTUAL) CONTENTS.
263: DEPTH ACTUAL-DEPTH @ = IF \ IF DEPTHS MATCH
264: DEPTH START-DEPTH @ > IF \ IF THERE IS SOMETHING ON THE STACK
265: DEPTH START-DEPTH @ DO \ FOR EACH STACK ITEM
266: ACTUAL-RESULTS I CELLS + @ \ COMPARE ACTUAL WITH EXPECTED
267: <> IF S" INCORRECT RESULT: " ERROR LEAVE THEN
268: LOOP
269: THEN
270: ELSE \ DEPTH MISMATCH
271: S" WRONG NUMBER OF RESULTS: " ERROR
272: THEN
273: F} ;
274:
275: : ...}T ( -- )
276: DEPTH START-DEPTH @ = 0= IF
277: S" WRONG NUMBER OF RESULTS" ERROR
278: THEN
279: XCURSOR @ ACTUAL-DEPTH @ <> IF
280: S" WRONG NUMBER OF RESULTS" ERROR
281: THEN
282: F...}T ;
283:
284: : XTESTER ( X -- )
285: DEPTH 0= ACTUAL-DEPTH @ XCURSOR @ 1+ < OR IF
286: S" WRONG NUMBER OF RESULTS: " ERROR EXIT
287: THEN
288: ACTUAL-RESULTS XCURSOR @ CELLS + @ <> IF
289: S" INCORRECT CELL RESULT: " ERROR
290: THEN
291: 1 XCURSOR +! ;
292:
293: : X}T XTESTER ...}T ;
294: : R}T FTESTER ...}T ;
295: : XX}T XTESTER XTESTER ...}T ;
296: : XR}T FTESTER XTESTER ...}T ;
297: : RX}T XTESTER FTESTER ...}T ;
298: : RR}T FTESTER FTESTER ...}T ;
299: : XXX}T XTESTER XTESTER XTESTER ...}T ;
300: : XXR}T FTESTER XTESTER XTESTER ...}T ;
301: : XRX}T XTESTER FTESTER XTESTER ...}T ;
302: : XRR}T FTESTER FTESTER XTESTER ...}T ;
303: : RXX}T XTESTER XTESTER FTESTER ...}T ;
304: : RXR}T FTESTER XTESTER FTESTER ...}T ;
305: : RRX}T XTESTER FTESTER FTESTER ...}T ;
306: : RRR}T FTESTER FTESTER FTESTER ...}T ;
307: : XXXX}T XTESTER XTESTER XTESTER XTESTER ...}T ;
308: : XXXR}T FTESTER XTESTER XTESTER XTESTER ...}T ;
309: : XXRX}T XTESTER FTESTER XTESTER XTESTER ...}T ;
310: : XXRR}T FTESTER FTESTER XTESTER XTESTER ...}T ;
311: : XRXX}T XTESTER XTESTER FTESTER XTESTER ...}T ;
312: : XRXR}T FTESTER XTESTER FTESTER XTESTER ...}T ;
313: : XRRX}T XTESTER FTESTER FTESTER XTESTER ...}T ;
314: : XRRR}T FTESTER FTESTER FTESTER XTESTER ...}T ;
315: : RXXX}T XTESTER XTESTER XTESTER FTESTER ...}T ;
316: : RXXR}T FTESTER XTESTER XTESTER FTESTER ...}T ;
317: : RXRX}T XTESTER FTESTER XTESTER FTESTER ...}T ;
318: : RXRR}T FTESTER FTESTER XTESTER FTESTER ...}T ;
319: : RRXX}T XTESTER XTESTER FTESTER FTESTER ...}T ;
320: : RRXR}T FTESTER XTESTER FTESTER FTESTER ...}T ;
321: : RRRX}T XTESTER FTESTER FTESTER FTESTER ...}T ;
322: : RRRR}T FTESTER FTESTER FTESTER FTESTER ...}T ;
323:
324: : TESTING \ ( -- ) TALKING COMMENT.
325: SOURCE VERBOSE @
326: IF DUP >R TYPE CR R> >IN !
327: ELSE >IN ! DROP
328: THEN ;
1.4 anton 329:
330: BASE !
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to ttester.fs CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [gforth] / gforth / test