Implement FILE-STATUS
[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
8d2c2052 63false value verbose
593eb738
HE
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
593eb738
HE
76TESTING File Access word set
77
78DECIMAL
79
80TEST{
81
82\ ----------------------------------------------------------------------------
83TESTING CREATE-FILE CLOSE-FILE
84
85: FN1 S" fatest1.txt" ;
86VARIABLE FID1
87
88T{ FN1 R/W CREATE-FILE SWAP FID1 ! -> 0 }T
89T{ FID1 @ CLOSE-FILE -> 0 }T
90
91\ ----------------------------------------------------------------------------
92TESTING OPEN-FILE W/O WRITE-LINE
93
94: LINE1 S" Line 1" ;
95
96T{ FN1 W/O OPEN-FILE SWAP FID1 ! -> 0 }T
97T{ LINE1 FID1 @ WRITE-LINE -> 0 }T
98T{ FID1 @ CLOSE-FILE -> 0 }T
99
100\ ----------------------------------------------------------------------------
101TESTING R/O FILE-POSITION (simple) READ-LINE
102
103200 CONSTANT BSIZE
104CREATE BUF BSIZE ALLOT
105VARIABLE #CHARS
106
107T{ FN1 R/O OPEN-FILE SWAP FID1 ! -> 0 }T
108T{ FID1 @ FILE-POSITION -> 0. 0 }T
109T{ BUF 100 FID1 @ READ-LINE ROT DUP #CHARS ! -> TRUE 0 LINE1 SWAP DROP }T
110T{ BUF #CHARS @ LINE1 S= -> TRUE }T
111T{ FID1 @ CLOSE-FILE -> 0 }T
112
938d9dba
HE
113\ Test with buffer shorter than line.
114T{ FN1 R/O OPEN-FILE SWAP FID1 ! -> 0 }T
115T{ FID1 @ FILE-POSITION -> 0. 0 }T
116T{ BUF 0 FID1 @ READ-LINE ROT DUP #CHARS ! -> TRUE 0 0 }T
117T{ BUF 3 FID1 @ READ-LINE ROT DUP #CHARS ! -> TRUE 0 3 }T
118T{ BUF #CHARS @ LINE1 DROP 3 S= -> TRUE }T
119T{ BUF 100 FID1 @ READ-LINE ROT DUP #CHARS ! -> TRUE 0 LINE1 NIP 3 - }T
120T{ BUF #CHARS @ LINE1 3 /STRING S= -> TRUE }T
121T{ FID1 @ CLOSE-FILE -> 0 }T
122
123\ Test with buffer exactly as long as the line.
124T{ FN1 R/O OPEN-FILE SWAP FID1 ! -> 0 }T
125T{ FID1 @ FILE-POSITION -> 0. 0 }T
126T{ BUF LINE1 NIP FID1 @ READ-LINE ROT DUP #CHARS ! -> TRUE 0 LINE1 NIP }T
127T{ BUF #CHARS @ LINE1 S= -> TRUE }T
128T{ FID1 @ CLOSE-FILE -> 0 }T
129
593eb738
HE
130\ ----------------------------------------------------------------------------
131TESTING S" in interpretation mode (compile mode tested in Core tests)
132
133T{ S" abcdef" $" abcdef" S= -> TRUE }T
134T{ S" " $" " S= -> TRUE }T
135T{ S" ghi"$" ghi" S= -> TRUE }T
136
137\ ----------------------------------------------------------------------------
138TESTING R/W WRITE-FILE REPOSITION-FILE READ-FILE FILE-POSITION S"
139
140: LINE2 S" Line 2 blah blah blah" ;
141: RL1 BUF 100 FID1 @ READ-LINE ;
1422VARIABLE FP
143
144T{ FN1 R/W OPEN-FILE SWAP FID1 ! -> 0 }T
145T{ FID1 @ FILE-SIZE DROP FID1 @ REPOSITION-FILE -> 0 }T
146T{ FID1 @ FILE-SIZE -> FID1 @ FILE-POSITION }T
147T{ LINE2 FID1 @ WRITE-FILE -> 0 }T
148T{ 10. FID1 @ REPOSITION-FILE -> 0 }T
149T{ FID1 @ FILE-POSITION -> 10. 0 }T
150T{ 0. FID1 @ REPOSITION-FILE -> 0 }T
151T{ RL1 -> LINE1 SWAP DROP TRUE 0 }T
152T{ RL1 ROT DUP #CHARS ! -> TRUE 0 LINE2 SWAP DROP }T
153T{ BUF #CHARS @ LINE2 S= -> TRUE }T
154T{ RL1 -> 0 FALSE 0 }T
155T{ FID1 @ FILE-POSITION ROT ROT FP 2! -> 0 }T
156T{ FP 2@ FID1 @ FILE-SIZE DROP D= -> TRUE }T
157T{ S" " FID1 @ WRITE-LINE -> 0 }T
158T{ S" " FID1 @ WRITE-LINE -> 0 }T
159T{ FP 2@ FID1 @ REPOSITION-FILE -> 0 }T
160T{ RL1 -> 0 TRUE 0 }T
161T{ RL1 -> 0 TRUE 0 }T
162T{ RL1 -> 0 FALSE 0 }T
163T{ FID1 @ CLOSE-FILE -> 0 }T
164
165\ ----------------------------------------------------------------------------
166TESTING BIN READ-FILE FILE-SIZE
167
168: CBUF BUF BSIZE 0 FILL ;
169: FN2 S" FATEST2.TXT" ;
170VARIABLE FID2
171: SETPAD PAD 50 0 DO I OVER C! CHAR+ LOOP DROP ;
172
173SETPAD \ If anything else is defined setpad must be called again
174 \ as pad may move
175
176T{ FN2 R/W BIN CREATE-FILE SWAP FID2 ! -> 0 }T
177T{ PAD 50 FID2 @ WRITE-FILE FID2 @ FLUSH-FILE -> 0 0 }T
178T{ FID2 @ FILE-SIZE -> 50. 0 }T
179T{ 0. FID2 @ REPOSITION-FILE -> 0 }T
180T{ CBUF BUF 29 FID2 @ READ-FILE -> 29 0 }T
181T{ PAD 29 BUF 29 S= -> TRUE }T
182T{ PAD 30 BUF 30 S= -> FALSE }T
183T{ CBUF BUF 29 FID2 @ READ-FILE -> 21 0 }T
184T{ PAD 29 + 21 BUF 21 S= -> TRUE }T
185T{ FID2 @ FILE-SIZE DROP FID2 @ FILE-POSITION DROP D= -> TRUE }T
186T{ BUF 10 FID2 @ READ-FILE -> 0 0 }T
187T{ FID2 @ CLOSE-FILE -> 0 }T
188
189\ ----------------------------------------------------------------------------
190TESTING RESIZE-FILE
191
192T{ FN2 R/W BIN OPEN-FILE SWAP FID2 ! -> 0 }T
193T{ 37. FID2 @ RESIZE-FILE -> 0 }T
194T{ FID2 @ FILE-SIZE -> 37. 0 }T
195T{ 0. FID2 @ REPOSITION-FILE -> 0 }T
196T{ CBUF BUF 100 FID2 @ READ-FILE -> 37 0 }T
197T{ PAD 37 BUF 37 S= -> TRUE }T
198T{ PAD 38 BUF 38 S= -> FALSE }T
199T{ 500. FID2 @ RESIZE-FILE -> 0 }T
200T{ FID2 @ FILE-SIZE -> 500. 0 }T
201T{ 0. FID2 @ REPOSITION-FILE -> 0 }T
202T{ CBUF BUF 100 FID2 @ READ-FILE -> 100 0 }T
203T{ PAD 37 BUF 37 S= -> TRUE }T
204T{ FID2 @ CLOSE-FILE -> 0 }T
205
206\ ----------------------------------------------------------------------------
207TESTING DELETE-FILE
208
209T{ FN2 DELETE-FILE -> 0 }T
210T{ FN2 R/W BIN OPEN-FILE SWAP DROP 0= -> FALSE }T
211T{ FN2 DELETE-FILE 0= -> FALSE }T
212
213\ ----------------------------------------------------------------------------
fe6f537b
HE
214TESTING multi-line ( comments
215
216T{ ( 1 2 3
2174 5 6
2187 8 9 ) 11 22 33 -> 11 22 33 }T
219
593eb738
HE
220\ ----------------------------------------------------------------------------
221TESTING SOURCE-ID (can only test it does not return 0 or -1)
222
223T{ SOURCE-ID DUP -1 = SWAP 0= OR -> FALSE }T
224
225\ ----------------------------------------------------------------------------
226TESTING RENAME-FILE FILE-STATUS FLUSH-FILE
227
228: FN3 S" fatest3.txt" ;
6f3de396 229: >END FID1 @ FILE-SIZE DROP FID1 @ REPOSITION-FILE ;
593eb738
HE
230
231
232T{ FN3 DELETE-FILE DROP -> }T
233T{ FN1 FN3 RENAME-FILE 0= -> TRUE }T
234T{ FN1 FILE-STATUS SWAP DROP 0= -> FALSE }T
235T{ FN3 FILE-STATUS SWAP DROP 0= -> TRUE }T \ Return value is undefined
236T{ FN3 R/W OPEN-FILE SWAP FID1 ! -> 0 }T
6f3de396
HE
237T{ >END -> 0 }T
238T{ S" Final line" fid1 @ WRITE-LINE -> 0 }T
593eb738 239
6f3de396
HE
240T{ FID1 @ FLUSH-FILE -> 0 }T \ Can only test FLUSH-FILE doesn't fail
241T{ FID1 @ CLOSE-FILE -> 0 }T
593eb738
HE
242
243\ Tidy the test folder
244T{ fn3 DELETE-FILE DROP -> }T
245
246\ ----------------------------------------------------------------------------
247TESTING two buffers available for S" and/or S\" (Forth 2012)
248
249: SSQ12 S" abcd" ; : SSQ13 S" 1234" ;
250T{ S" abcd" S" 1234" SSQ13 S= ROT ROT SSQ12 S= -> TRUE TRUE }T
251\ nyi T{ S\" abcd" S\" 1234" SSQ13 S= ROT ROT SSQ12 S= -> TRUE TRUE }T
252\ nyi T{ S" abcd" S\" 1234" SSQ13 S= ROT ROT SSQ12 S= -> TRUE TRUE }T
253\ nyi T{ S\" abcd" S" 1234" SSQ13 S= ROT ROT SSQ12 S= -> TRUE TRUE }T
254
255
256\ -----------------------------------------------------------------------------
257TESTING SAVE-INPUT and RESTORE-INPUT with a file source
258
259VARIABLE SIV -1 SIV !
260
261: NEVEREXECUTED
262 CR ." This should never be executed" CR
263;
264
265T{ 11111 SAVE-INPUT
266
267SIV @
268
269[IF]
270 TESTING the -[IF]- part is executed
271 0 SIV !
272 RESTORE-INPUT
273 NEVEREXECUTED
274 33333
275[ELSE]
276
277 TESTING the -[ELSE]- part is executed
278 22222
279
280[THEN]
281
282 -> 11111 0 22222 }T \ 0 comes from RESTORE-INPUT
283
284TESTING nested SAVE-INPUT, RESTORE-INPUT and REFILL from a file
285
286: READ_A_LINE
287 REFILL 0=
288 ABORT" REFILL FAILED"
289;
290
291VARIABLE SI_INC 0 SI_INC !
292
293: SI1
294 SI_INC @ >IN +!
295 15 SI_INC !
296;
297
298: S$ S" SAVE-INPUT SI1 RESTORE-INPUT 12345" ;
299
300CREATE 2RES -1 , -1 , \ Don't use 2VARIABLE from Double number word set
301
302: SI2
303 READ_A_LINE
304 READ_A_LINE
305 SAVE-INPUT
306 READ_A_LINE
307 READ_A_LINE
308 S$ EVALUATE 2RES 2!
309 RESTORE-INPUT
310;
311
312\ WARNING: do not delete or insert lines of text after si2 is called
313\ otherwise the next test will fail
314
315T{ SI2
31633333 \ This line should be ignored
3172RES 2@ 44444 \ RESTORE-INPUT should return to this line
318
31955555
320TESTING the nested results
321 -> 0 0 2345 44444 55555 }T
322
323\ End of warning
324
325\ ----------------------------------------------------------------------------
326
327\ CR .( End of File-Access word set tests) CR
328
329}TEST