git.gag.com Git - debian/pforth/blob - fth/t_file.fth

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