Implement FLUSH-FILE
[pforth] / fth / t_file.fth
CommitLineData
593eb738
HE
1\ Test PForth FILE wordset
2
3\ To test the ANS File Access word set and extension words
4
5\ This program was written by Gerry Jackson in 2006, with contributions from
6\ others where indicated, and is in the public domain - it can be distributed
7\ and/or modified in any way but please retain this notice.
8
9\ This program is distributed in the hope that it will be useful,
10\ but WITHOUT ANY WARRANTY; without even the implied warranty of
11\ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12
13\ The tests are not claimed to be comprehensive or correct
14
15\ ----------------------------------------------------------------------------
16\ Version 0.13 S" in interpretation mode tested.
17\ Added SAVE-INPUT RESTORE-INPUT REFILL in a file, (moved from
18\ coreexttest.fth).
19\ Calls to COMPARE replaced with S= (in utilities.fth)
20\ 0.11 25 April 2015 S\" in interpretation mode test added
21\ REQUIRED REQUIRE INCLUDE tests added
22\ Two S" and/or S\" buffers availability tested
23\ 0.5 1 April 2012 Tests placed in the public domain.
24\ 0.4 22 March 2009 { and } replaced with T{ and }T
25\ 0.3 20 April 2007 ANS Forth words changed to upper case.
26\ Removed directory test from the filenames.
27\ 0.2 30 Oct 2006 updated following GForth tests to remove
28\ system dependency on file size, to allow for file
29\ buffering and to allow for PAD moving around.
30\ 0.1 Oct 2006 First version released.
31
32\ ----------------------------------------------------------------------------
33\ The tests are based on John Hayes test program for the core word set
34\ and requires those files to have been loaded
35
36\ Words tested in this file are:
37\ ( BIN CLOSE-FILE CREATE-FILE DELETE-FILE FILE-POSITION FILE-SIZE
38\ OPEN-FILE R/O R/W READ-FILE READ-LINE REPOSITION-FILE RESIZE-FILE
39\ S" S\" SOURCE-ID W/O WRITE-FILE WRITE-LINE
40\ FILE-STATUS FLUSH-FILE RENAME-FILE SAVE-INPUT RESTORE-INPUT
41\ REFILL
42
43\ Words not tested:
44\ INCLUDED INCLUDE-FILE (as these will likely have been
45\ tested in the execution of the test files)
46\ ----------------------------------------------------------------------------
47\ Assumptions, dependencies and notes:
48\ - tester.fr (or ttester.fs), errorreport.fth and utilities.fth have been
49\ included prior to this file
50\ - the Core word set is available and tested
51\ - These tests create files in the current directory, if all goes
52\ well these will be deleted. If something fails they may not be
53\ deleted. If this is a problem ensure you set a suitable
54\ directory before running this test. There is no ANS standard
55\ way of doing this. Also be aware of the file names used below
56\ which are: fatest1.txt, fatest2.txt and fatest3.txt
57\ ----------------------------------------------------------------------------
58
59include? }T{ t_tools.fth
60
61true fp-require-e !
62
63true value verbose
64
65: testing
66 verbose IF
67 source >in @ /string ." TESTING: " type cr
68 THEN
69 source nip >in !
70; immediate
71
72: -> }T{ ;
73: s= compare 0= ;
74: $" state IF postpone s" else ['] s" execute THEN ; immediate
75
8bf2fe25 76\ FIXME: stubs for missing definitions
593eb738
HE
77: resize-file drop 2drop -1 ;
78: rename-file 2drop 2drop -1 ;
79: file-status 2drop 0 -1 ;
80
593eb738
HE
81TESTING File Access word set
82
83DECIMAL
84
85TEST{
86
87\ ----------------------------------------------------------------------------
88TESTING CREATE-FILE CLOSE-FILE
89
90: FN1 S" fatest1.txt" ;
91VARIABLE FID1
92
93T{ FN1 R/W CREATE-FILE SWAP FID1 ! -> 0 }T
94T{ FID1 @ CLOSE-FILE -> 0 }T
95
96\ ----------------------------------------------------------------------------
97TESTING OPEN-FILE W/O WRITE-LINE
98
99: LINE1 S" Line 1" ;
100
101T{ FN1 W/O OPEN-FILE SWAP FID1 ! -> 0 }T
102T{ LINE1 FID1 @ WRITE-LINE -> 0 }T
103T{ FID1 @ CLOSE-FILE -> 0 }T
104
105\ ----------------------------------------------------------------------------
106TESTING R/O FILE-POSITION (simple) READ-LINE
107
108200 CONSTANT BSIZE
109CREATE BUF BSIZE ALLOT
110VARIABLE #CHARS
111
112T{ FN1 R/O OPEN-FILE SWAP FID1 ! -> 0 }T
113T{ FID1 @ FILE-POSITION -> 0. 0 }T
114T{ BUF 100 FID1 @ READ-LINE ROT DUP #CHARS ! -> TRUE 0 LINE1 SWAP DROP }T
115T{ BUF #CHARS @ LINE1 S= -> TRUE }T
116T{ FID1 @ CLOSE-FILE -> 0 }T
117
938d9dba
HE
118\ Test with buffer shorter than line.
119T{ FN1 R/O OPEN-FILE SWAP FID1 ! -> 0 }T
120T{ FID1 @ FILE-POSITION -> 0. 0 }T
121T{ BUF 0 FID1 @ READ-LINE ROT DUP #CHARS ! -> TRUE 0 0 }T
122T{ BUF 3 FID1 @ READ-LINE ROT DUP #CHARS ! -> TRUE 0 3 }T
123T{ BUF #CHARS @ LINE1 DROP 3 S= -> TRUE }T
124T{ BUF 100 FID1 @ READ-LINE ROT DUP #CHARS ! -> TRUE 0 LINE1 NIP 3 - }T
125T{ BUF #CHARS @ LINE1 3 /STRING S= -> TRUE }T
126T{ FID1 @ CLOSE-FILE -> 0 }T
127
128\ Test with buffer exactly as long as the line.
129T{ FN1 R/O OPEN-FILE SWAP FID1 ! -> 0 }T
130T{ FID1 @ FILE-POSITION -> 0. 0 }T
131T{ BUF LINE1 NIP FID1 @ READ-LINE ROT DUP #CHARS ! -> TRUE 0 LINE1 NIP }T
132T{ BUF #CHARS @ LINE1 S= -> TRUE }T
133T{ FID1 @ CLOSE-FILE -> 0 }T
134
593eb738
HE
135\ ----------------------------------------------------------------------------
136TESTING S" in interpretation mode (compile mode tested in Core tests)
137
138T{ S" abcdef" $" abcdef" S= -> TRUE }T
139T{ S" " $" " S= -> TRUE }T
140T{ S" ghi"$" ghi" S= -> TRUE }T
141
142\ ----------------------------------------------------------------------------
143TESTING R/W WRITE-FILE REPOSITION-FILE READ-FILE FILE-POSITION S"
144
145: LINE2 S" Line 2 blah blah blah" ;
146: RL1 BUF 100 FID1 @ READ-LINE ;
1472VARIABLE FP
148
149T{ FN1 R/W OPEN-FILE SWAP FID1 ! -> 0 }T
150T{ FID1 @ FILE-SIZE DROP FID1 @ REPOSITION-FILE -> 0 }T
151T{ FID1 @ FILE-SIZE -> FID1 @ FILE-POSITION }T
152T{ LINE2 FID1 @ WRITE-FILE -> 0 }T
153T{ 10. FID1 @ REPOSITION-FILE -> 0 }T
154T{ FID1 @ FILE-POSITION -> 10. 0 }T
155T{ 0. FID1 @ REPOSITION-FILE -> 0 }T
156T{ RL1 -> LINE1 SWAP DROP TRUE 0 }T
157T{ RL1 ROT DUP #CHARS ! -> TRUE 0 LINE2 SWAP DROP }T
158T{ BUF #CHARS @ LINE2 S= -> TRUE }T
159T{ RL1 -> 0 FALSE 0 }T
160T{ FID1 @ FILE-POSITION ROT ROT FP 2! -> 0 }T
161T{ FP 2@ FID1 @ FILE-SIZE DROP D= -> TRUE }T
162T{ S" " FID1 @ WRITE-LINE -> 0 }T
163T{ S" " FID1 @ WRITE-LINE -> 0 }T
164T{ FP 2@ FID1 @ REPOSITION-FILE -> 0 }T
165T{ RL1 -> 0 TRUE 0 }T
166T{ RL1 -> 0 TRUE 0 }T
167T{ RL1 -> 0 FALSE 0 }T
168T{ FID1 @ CLOSE-FILE -> 0 }T
169
170\ ----------------------------------------------------------------------------
171TESTING BIN READ-FILE FILE-SIZE
172
173: CBUF BUF BSIZE 0 FILL ;
174: FN2 S" FATEST2.TXT" ;
175VARIABLE FID2
176: SETPAD PAD 50 0 DO I OVER C! CHAR+ LOOP DROP ;
177
178SETPAD \ If anything else is defined setpad must be called again
179 \ as pad may move
180
181T{ FN2 R/W BIN CREATE-FILE SWAP FID2 ! -> 0 }T
182T{ PAD 50 FID2 @ WRITE-FILE FID2 @ FLUSH-FILE -> 0 0 }T
183T{ FID2 @ FILE-SIZE -> 50. 0 }T
184T{ 0. FID2 @ REPOSITION-FILE -> 0 }T
185T{ CBUF BUF 29 FID2 @ READ-FILE -> 29 0 }T
186T{ PAD 29 BUF 29 S= -> TRUE }T
187T{ PAD 30 BUF 30 S= -> FALSE }T
188T{ CBUF BUF 29 FID2 @ READ-FILE -> 21 0 }T
189T{ PAD 29 + 21 BUF 21 S= -> TRUE }T
190T{ FID2 @ FILE-SIZE DROP FID2 @ FILE-POSITION DROP D= -> TRUE }T
191T{ BUF 10 FID2 @ READ-FILE -> 0 0 }T
192T{ FID2 @ CLOSE-FILE -> 0 }T
193
194\ ----------------------------------------------------------------------------
195TESTING RESIZE-FILE
196
197T{ FN2 R/W BIN OPEN-FILE SWAP FID2 ! -> 0 }T
198T{ 37. FID2 @ RESIZE-FILE -> 0 }T
199T{ FID2 @ FILE-SIZE -> 37. 0 }T
200T{ 0. FID2 @ REPOSITION-FILE -> 0 }T
201T{ CBUF BUF 100 FID2 @ READ-FILE -> 37 0 }T
202T{ PAD 37 BUF 37 S= -> TRUE }T
203T{ PAD 38 BUF 38 S= -> FALSE }T
204T{ 500. FID2 @ RESIZE-FILE -> 0 }T
205T{ FID2 @ FILE-SIZE -> 500. 0 }T
206T{ 0. FID2 @ REPOSITION-FILE -> 0 }T
207T{ CBUF BUF 100 FID2 @ READ-FILE -> 100 0 }T
208T{ PAD 37 BUF 37 S= -> TRUE }T
209T{ FID2 @ CLOSE-FILE -> 0 }T
210
211\ ----------------------------------------------------------------------------
212TESTING DELETE-FILE
213
214T{ FN2 DELETE-FILE -> 0 }T
215T{ FN2 R/W BIN OPEN-FILE SWAP DROP 0= -> FALSE }T
216T{ FN2 DELETE-FILE 0= -> FALSE }T
217
218\ ----------------------------------------------------------------------------
219\ TESTING multi-line ( comments
220\
221\ T{ ( 1 2 3
222\ 4 5 6
223\ 7 8 9 ) 11 22 33 -> 11 22 33 }T
224\
225\ ----------------------------------------------------------------------------
226TESTING SOURCE-ID (can only test it does not return 0 or -1)
227
228T{ SOURCE-ID DUP -1 = SWAP 0= OR -> FALSE }T
229
230\ ----------------------------------------------------------------------------
231TESTING RENAME-FILE FILE-STATUS FLUSH-FILE
232
233: FN3 S" fatest3.txt" ;
234: >END FID1 @ FILE-SIZE .s DROP FID1 @ REPOSITION-FILE ;
235
236
237T{ FN3 DELETE-FILE DROP -> }T
238T{ FN1 FN3 RENAME-FILE 0= -> TRUE }T
239T{ FN1 FILE-STATUS SWAP DROP 0= -> FALSE }T
240T{ FN3 FILE-STATUS SWAP DROP 0= -> TRUE }T \ Return value is undefined
241T{ FN3 R/W OPEN-FILE SWAP FID1 ! -> 0 }T
242\ nyi T{ >END -> 0 }T
243\ nyi T{ S" Final line" fid1 @ WRITE-LINE -> 0 }T
244
245\ nyi T{ FID1 @ FLUSH-FILE -> 0 }T \ Can only test FLUSH-FILE doesn't fail
246\ nyi T{ FID1 @ CLOSE-FILE -> 0 }T
247
248\ Tidy the test folder
249T{ fn3 DELETE-FILE DROP -> }T
250
251\ ----------------------------------------------------------------------------
252TESTING two buffers available for S" and/or S\" (Forth 2012)
253
254: SSQ12 S" abcd" ; : SSQ13 S" 1234" ;
255T{ S" abcd" S" 1234" SSQ13 S= ROT ROT SSQ12 S= -> TRUE TRUE }T
256\ nyi T{ S\" abcd" S\" 1234" SSQ13 S= ROT ROT SSQ12 S= -> TRUE TRUE }T
257\ nyi T{ S" abcd" S\" 1234" SSQ13 S= ROT ROT SSQ12 S= -> TRUE TRUE }T
258\ nyi T{ S\" abcd" S" 1234" SSQ13 S= ROT ROT SSQ12 S= -> TRUE TRUE }T
259
260
261\ -----------------------------------------------------------------------------
262TESTING SAVE-INPUT and RESTORE-INPUT with a file source
263
264VARIABLE SIV -1 SIV !
265
266: NEVEREXECUTED
267 CR ." This should never be executed" CR
268;
269
270T{ 11111 SAVE-INPUT
271
272SIV @
273
274[IF]
275 TESTING the -[IF]- part is executed
276 0 SIV !
277 RESTORE-INPUT
278 NEVEREXECUTED
279 33333
280[ELSE]
281
282 TESTING the -[ELSE]- part is executed
283 22222
284
285[THEN]
286
287 -> 11111 0 22222 }T \ 0 comes from RESTORE-INPUT
288
289TESTING nested SAVE-INPUT, RESTORE-INPUT and REFILL from a file
290
291: READ_A_LINE
292 REFILL 0=
293 ABORT" REFILL FAILED"
294;
295
296VARIABLE SI_INC 0 SI_INC !
297
298: SI1
299 SI_INC @ >IN +!
300 15 SI_INC !
301;
302
303: S$ S" SAVE-INPUT SI1 RESTORE-INPUT 12345" ;
304
305CREATE 2RES -1 , -1 , \ Don't use 2VARIABLE from Double number word set
306
307: SI2
308 READ_A_LINE
309 READ_A_LINE
310 SAVE-INPUT
311 READ_A_LINE
312 READ_A_LINE
313 S$ EVALUATE 2RES 2!
314 RESTORE-INPUT
315;
316
317\ WARNING: do not delete or insert lines of text after si2 is called
318\ otherwise the next test will fail
319
320T{ SI2
32133333 \ This line should be ignored
3222RES 2@ 44444 \ RESTORE-INPUT should return to this line
323
32455555
325TESTING the nested results
326 -> 0 0 2345 44444 55555 }T
327
328\ End of warning
329
330\ ----------------------------------------------------------------------------
331
332\ CR .( End of File-Access word set tests) CR
333
334}TEST