Annotation of gforth/blocks.fs, revision 1.41
1.5 pazsan 1: \ A less simple implementation of the blocks wordset.
1.1 anton 2:
1.41 ! anton 3: \ Copyright (C) 1995,1996,1997,1998,2000,2003 Free Software Foundation, Inc.
1.7 anton 4:
5: \ This file is part of Gforth.
6:
7: \ Gforth is free software; you can redistribute it and/or
8: \ modify it under the terms of the GNU General Public License
9: \ as published by the Free Software Foundation; either version 2
10: \ of the License, or (at your option) any later version.
11:
12: \ This program is distributed in the hope that it will be useful,
13: \ but WITHOUT ANY WARRANTY; without even the implied warranty of
14: \ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15: \ GNU General Public License for more details.
16:
17: \ You should have received a copy of the GNU General Public License
18: \ along with this program; if not, write to the Free Software
1.33 anton 19: \ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
1.7 anton 20:
21:
22: \ A more efficient implementation would use mmap on OSs that
1.1 anton 23: \ provide it and many buffers on OSs that do not provide mmap.
24:
1.5 pazsan 25: \ Now, the replacement algorithm is "direct mapped"; change to LRU
26: \ if too slow. Using more buffers helps, too.
27:
1.1 anton 28: \ I think I avoid the assumption 1 char = 1 here, but I have not tested this
29:
1.2 pazsan 30: \ 1024 constant chars/block \ mandated by the standard
1.1 anton 31:
1.5 pazsan 32: require struct.fs
33:
34: struct
1.17 anton 35: cell% field buffer-block \ the block number
36: cell% field buffer-fid \ the block's fid
37: cell% field buffer-dirty \ the block dirty flag
38: char% chars/block * field block-buffer \ the data
39: cell% 0 * field next-buffer
1.5 pazsan 40: end-struct buffer-struct
41:
42: Variable block-buffers
43: Variable last-block
44:
45: $20 Value buffers
46:
1.36 anton 47: \ limit block files to 2GB; gforth <0.6.0 erases larger block files on
48: \ 32-bit systems
49: $200000 Value block-limit
50:
1.5 pazsan 51: User block-fid
1.30 anton 52: User block-offset ( -- addr ) \ gforth
53: \G User variable containing the number of the first block (default
54: \G since 0.5.0: 0). Block files created with Gforth versions before
55: \G 0.5.0 have the offset 1. If you use these files you can: @code{1
56: \G offset !}; or add 1 to every block number used; or prepend 1024
57: \G characters to the file.
58: 0 block-offset ! \ store 1 here fore 0.4.0 compatibility
59:
60: ' block-offset alias offset \ !! eliminate this?
1.1 anton 61:
1.17 anton 62: : block-cold ( -- )
1.16 jwilke 63: block-fid off last-block off
1.17 anton 64: buffer-struct buffers * %alloc dup block-buffers ! ( addr )
65: buffer-struct %size buffers * erase ;
1.1 anton 66:
1.16 jwilke 67: ' block-cold INIT8 chained
1.5 pazsan 68:
69: block-cold
70:
1.24 crook 71: Defer flush-blocks ( -- ) \ gforth
1.5 pazsan 72:
1.24 crook 73: : open-blocks ( c-addr u -- ) \ gforth
1.36 anton 74: \g Use the file, whose name is given by @i{c-addr u}, as the blocks file.
75: try ( c-addr u )
76: 2dup open-fpath-file throw
1.8 pazsan 77: rot close-file throw 2dup file-status throw bin open-file throw
78: >r 2drop r>
1.36 anton 79: recover ( c-addr u ior )
80: >r 2dup file-status nip 0= r> and throw \ does it really not exist?
81: r/w bin create-file throw
82: endtry
83: block-fid @ IF
84: flush-blocks block-fid @ close-file throw
85: THEN
1.5 pazsan 86: block-fid ! ;
1.8 pazsan 87:
1.10 anton 88: : use ( "file" -- ) \ gforth
1.24 crook 89: \g Use @i{file} as the blocks file.
1.11 anton 90: name open-blocks ;
1.1 anton 91:
1.3 anton 92: \ the file is opened as binary file, since it either will contain text
93: \ without newlines or binary data
1.24 crook 94: : get-block-fid ( -- wfileid ) \ gforth
95: \G Return the file-id of the current blocks file. If no blocks
96: \G file has been opened, use @file{blocks.fb} as the default
97: \G blocks file.
1.1 anton 98: block-fid @ 0=
99: if
1.11 anton 100: s" blocks.fb" open-blocks
1.1 anton 101: then
102: block-fid @ ;
103:
1.20 pazsan 104: : block-position ( u -- ) \ block
1.36 anton 105: \G Position the block file to the start of block @i{u}.
106: dup block-limit u>= -35 and throw
1.26 pazsan 107: offset @ - chars/block chars um* get-block-fid reposition-file throw ;
1.1 anton 108:
1.20 pazsan 109: : update ( -- ) \ block
1.29 crook 110: \G Mark the state of the current block buffer as assigned-dirty.
1.5 pazsan 111: last-block @ ?dup IF buffer-dirty on THEN ;
1.1 anton 112:
1.20 pazsan 113: : save-buffer ( buffer -- ) \ gforth
114: >r
1.5 pazsan 115: r@ buffer-dirty @ r@ buffer-block @ 0<> and
1.1 anton 116: if
1.5 pazsan 117: r@ buffer-block @ block-position
118: r@ block-buffer chars/block r@ buffer-fid @ write-file throw
1.36 anton 119: r@ buffer-fid @ flush-file throw
120: r@ buffer-dirty off
1.5 pazsan 121: endif
122: rdrop ;
123:
1.20 pazsan 124: : empty-buffer ( buffer -- ) \ gforth
1.5 pazsan 125: buffer-block off ;
126:
1.20 pazsan 127: : save-buffers ( -- ) \ block
1.24 crook 128: \G Transfer the contents of each @code{update}d block buffer to
1.30 anton 129: \G mass storage, then mark all block buffers as assigned-clean.
1.20 pazsan 130: block-buffers @
1.24 crook 131: buffers 0 ?DO dup save-buffer next-buffer LOOP drop ;
1.1 anton 132:
1.24 crook 133: : empty-buffers ( -- ) \ block-ext
134: \G Mark all block buffers as unassigned; if any had been marked as
135: \G assigned-dirty (by @code{update}), the changes to those blocks
136: \G will be lost.
1.20 pazsan 137: block-buffers @
1.24 crook 138: buffers 0 ?DO dup empty-buffer next-buffer LOOP drop ;
1.1 anton 139:
1.20 pazsan 140: : flush ( -- ) \ block
1.24 crook 141: \G Perform the functions of @code{save-buffers} then
142: \G @code{empty-buffers}.
1.1 anton 143: save-buffers
144: empty-buffers ;
145:
1.12 anton 146: ' flush IS flush-blocks
1.5 pazsan 147:
1.26 pazsan 148: : get-buffer ( u -- a-addr ) \ gforth
149: 0 buffers um/mod drop buffer-struct %size * block-buffers @ + ;
1.5 pazsan 150:
1.28 crook 151: : block ( u -- a-addr ) \ gforthman- block
1.24 crook 152: \G If a block buffer is assigned for block @i{u}, return its
153: \G start address, @i{a-addr}. Otherwise, assign a block buffer
154: \G for block @i{u} (if the assigned block buffer has been
155: \G @code{update}d, transfer the contents to mass storage), read
156: \G the block into the block buffer and return its start address,
157: \G @i{a-addr}.
1.26 pazsan 158: dup offset @ u< -35 and throw
1.5 pazsan 159: dup get-buffer >r
160: dup r@ buffer-block @ <>
1.9 pazsan 161: r@ buffer-fid @ block-fid @ <> or
1.1 anton 162: if
1.5 pazsan 163: r@ save-buffer
1.1 anton 164: dup block-position
1.5 pazsan 165: r@ block-buffer chars/block get-block-fid read-file throw
1.1 anton 166: \ clear the rest of the buffer if the file is too short
1.5 pazsan 167: r@ block-buffer over chars + chars/block rot chars - blank
168: r@ buffer-block !
169: get-block-fid r@ buffer-fid !
1.1 anton 170: else
171: drop
172: then
1.5 pazsan 173: r> dup last-block ! block-buffer ;
1.1 anton 174:
1.20 pazsan 175: : buffer ( u -- a-addr ) \ block
1.24 crook 176: \G If a block buffer is assigned for block @i{u}, return its
177: \G start address, @i{a-addr}. Otherwise, assign a block buffer
178: \G for block @i{u} (if the assigned block buffer has been
179: \G @code{update}d, transfer the contents to mass storage) and
180: \G return its start address, @i{a-addr}. The subtle difference
181: \G between @code{buffer} and @code{block} mean that you should
182: \G only use @code{buffer} if you don't care about the previous
183: \G contents of block @i{u}. In Gforth, this simply calls
184: \G @code{block}.
1.1 anton 185: \ reading in the block is unnecessary, but simpler
186: block ;
187:
1.28 crook 188: User scr ( -- a-addr ) \ block-ext s-c-r
1.27 crook 189: \G @code{User} variable -- @i{a-addr} is the address of a cell containing
1.21 crook 190: \G the block number of the block most recently processed by
1.24 crook 191: \G @code{list}.
192: 0 scr !
1.1 anton 193:
1.24 crook 194: \ nac31Mar1999 moved "scr @" to list to make the stack comment correct
1.20 pazsan 195: : updated? ( n -- f ) \ gforth
1.29 crook 196: \G Return true if @code{updated} has been used to mark block @i{n}
197: \G as assigned-dirty.
1.24 crook 198: buffer
1.5 pazsan 199: [ 0 buffer-dirty 0 block-buffer - ] Literal + @ ;
200:
1.24 crook 201: : list ( u -- ) \ block-ext
202: \G Display block @i{u}. In Gforth, the block is displayed as 16
203: \G numbered lines, each of 64 characters.
1.1 anton 204: \ calling block again and again looks inefficient but is necessary
205: \ in a multitasking environment
206: dup scr !
1.5 pazsan 207: ." Screen " u.
1.24 crook 208: scr @ updated? 0= IF ." not " THEN ." modified " cr
1.1 anton 209: 16 0
210: ?do
1.4 anton 211: i 2 .r space scr @ block i 64 * chars + 64 type cr
1.1 anton 212: loop ;
213:
1.34 pazsan 214: [IFDEF] current-input
215: :noname 2 <> -12 and throw >in ! blk ! ;
216: \ restore-input
217: :noname blk @ >in @ 2 ; \ save-input
218: :noname 2 ; \ source-id "*a block*"
219: :noname 1 blk +! 1 loadline +! true ; \ refill
220: :noname blk @ block chars/block ; \ source
221:
222: Create block-input A, A, A, A, A,
223:
224: : load ( i*x n -- j*x ) \ block
225: \G Save the current input source specification. Store @i{n} in
226: \G @code{BLK}, set @code{>IN} to 0 and interpret. When the parse
227: \G area is exhausted, restore the input source specification.
1.39 anton 228: block-input 0 new-tib dup loadline ! blk ! s" * a block*" loadfilename 2!
1.34 pazsan 229: ['] interpret catch pop-file throw ;
230: [ELSE]
1.23 crook 231: : (source) ( -- c-addr u )
1.2 pazsan 232: blk @ ?dup
233: IF block chars/block
234: ELSE tib #tib @
235: THEN ;
236:
1.23 crook 237: ' (source) IS source ( -- c-addr u ) \ core
1.24 crook 238: \G @i{c-addr} is the address of the input buffer and @i{u} is the
1.23 crook 239: \G number of characters in it.
1.2 pazsan 240:
1.20 pazsan 241: : load ( i*x n -- j*x ) \ block
1.24 crook 242: \G Save the current input source specification. Store @i{n} in
243: \G @code{BLK}, set @code{>IN} to 0 and interpret. When the parse
244: \G area is exhausted, restore the input source specification.
1.40 anton 245: s" * a block*" loadfilename>r
1.24 crook 246: push-file
247: dup loadline ! blk ! >in off ['] interpret catch
1.31 anton 248: pop-file
1.40 anton 249: r>loadfilename
1.31 anton 250: throw ;
1.34 pazsan 251: [THEN]
1.24 crook 252:
253: : thru ( i*x n1 n2 -- j*x ) \ block-ext
254: \G @code{load} the blocks @i{n1} through @i{n2} in sequence.
255: 1+ swap ?DO I load LOOP ;
256:
257: : +load ( i*x n -- j*x ) \ gforth
258: \G Used within a block to load the block specified as the
259: \G current block + @i{n}.
1.20 pazsan 260: blk @ + load ;
1.2 pazsan 261:
1.24 crook 262: : +thru ( i*x n1 n2 -- j*x ) \ gforth
263: \G Used within a block to load the range of blocks specified as the
264: \G current block + @i{n1} thru the current block + @i{n2}.
265: 1+ swap ?DO I +load LOOP ;
266:
1.28 crook 267: : --> ( -- ) \ gforthman- gforth chain
1.24 crook 268: \G If this symbol is encountered whilst loading block @i{n},
269: \G discard the remainder of the block and load block @i{n+1}. Used
1.25 anton 270: \G for chaining multiple blocks together as a single loadable
271: \G unit. Not recommended, because it destroys the independence of
272: \G loading. Use @code{thru} (which is standard) or @code{+thru}
273: \G instead.
1.20 pazsan 274: refill drop ; immediate
1.5 pazsan 275:
1.24 crook 276: : block-included ( a-addr u -- ) \ gforth
277: \G Use within a block that is to be processed by @code{load}. Save
278: \G the current blocks file specification, open the blocks file
279: \G specified by @i{a-addr u} and @code{load} block 1 from that
280: \G file (which may in turn chain or load other blocks). Finally,
281: \G close the blocks file and restore the original blocks file.
1.11 anton 282: block-fid @ >r block-fid off open-blocks
1.5 pazsan 283: 1 load block-fid @ close-file throw flush
284: r> block-fid ! ;
285:
1.13 anton 286: \ thrown out because it may provide unpleasant surprises - anton
287: \ : include ( "name" -- )
288: \ name 2dup dup 3 - /string s" .fb" compare
289: \ 0= IF block-included ELSE included THEN ;
1.5 pazsan 290:
1.4 anton 291: get-current environment-wordlist set-current
292: true constant block
293: true constant block-ext
294: set-current
1.5 pazsan 295:
1.21 crook 296: : bye ( -- ) \ tools-ext
297: \G Return control to the host operating system (if any).
298: ['] flush catch drop bye ;
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>