Diff for /gforth/blocks.fs between versions 1.17 and 1.35

version 1.17, 1997/07/31 16:17:06 version 1.35, 2002/09/14 08:34:03
Line 1 Line 1
 \ A less simple implementation of the blocks wordset.   \ A less simple implementation of the blocks wordset. 
   
 \ Copyright (C) 1995 Free Software Foundation, Inc.  \ Copyright (C) 1995,1996,1997,1998,2000 Free Software Foundation, Inc.
   
 \ This file is part of Gforth.  \ This file is part of Gforth.
   
Line 16 Line 16
   
 \ You should have received a copy of the GNU General Public License  \ You should have received a copy of the GNU General Public License
 \ along with this program; if not, write to the Free Software  \ along with this program; if not, write to the Free Software
 \ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  \ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
   
   
 \ A more efficient implementation would use mmap on OSs that  \ A more efficient implementation would use mmap on OSs that
Line 45  Variable last-block Line 45  Variable last-block
 $20 Value buffers  $20 Value buffers
   
 User block-fid  User block-fid
   User block-offset ( -- addr ) \ gforth
   \G User variable containing the number of the first block (default
   \G since 0.5.0: 0).  Block files created with Gforth versions before
   \G 0.5.0 have the offset 1.  If you use these files you can: @code{1
   \G offset !}; or add 1 to every block number used; or prepend 1024
   \G characters to the file.
   0 block-offset !  \ store 1 here fore 0.4.0 compatibility
   
   ' block-offset alias offset \ !! eliminate this?
   
 : block-cold ( -- )  : block-cold ( -- )
     block-fid off  last-block off      block-fid off  last-block off
Line 55  User block-fid Line 64  User block-fid
   
 block-cold  block-cold
   
 Defer flush-blocks  Defer flush-blocks ( -- ) \ gforth
   
 : open-blocks ( addr u -- ) \ gforth  : open-blocks ( c-addr u -- ) \ gforth
     \g use the file, whose name is given by @var{addr u}, as blocks file       \g Use the file, whose name is given by @i{c-addr u}, as the blocks file.
     2dup ['] open-fpath-file catch 0<>      2dup open-fpath-file 0<>
     if      if
         2drop r/w bin create-file throw          r/w bin create-file throw
     else      else
         rot close-file throw  2dup file-status throw bin open-file throw          rot close-file throw  2dup file-status throw bin open-file throw
         >r 2drop r>          >r 2drop r>
Line 70  Defer flush-blocks Line 79  Defer flush-blocks
     block-fid ! ;      block-fid ! ;
   
 : use ( "file" -- ) \ gforth  : use ( "file" -- ) \ gforth
     \g use @var{file} as blocks file      \g Use @i{file} as the blocks file.
     name open-blocks ;      name open-blocks ;
   
 \ the file is opened as binary file, since it either will contain text  \ the file is opened as binary file, since it either will contain text
 \ without newlines or binary data  \ without newlines or binary data
 : get-block-fid ( -- fid )  : get-block-fid ( -- wfileid ) \ gforth
       \G Return the file-id of the current blocks file. If no blocks
       \G file has been opened, use @file{blocks.fb} as the default
       \G blocks file.
     block-fid @ 0=      block-fid @ 0=
     if      if
         s" blocks.fb" open-blocks          s" blocks.fb" open-blocks
     then      then
     block-fid @ ;      block-fid @ ;
   
 : block-position ( u -- )  : block-position ( u -- ) \ block
     \ positions the block file to the start of block u      \G Position the block file to the start of block @i{u}.
     1- chars/block chars um* get-block-fid reposition-file throw ;      offset @ - chars/block chars um* get-block-fid reposition-file throw ;
   
 : update ( -- )  : update ( -- ) \ block
       \G Mark the state of the current block buffer as assigned-dirty.
     last-block @ ?dup IF  buffer-dirty on  THEN ;      last-block @ ?dup IF  buffer-dirty on  THEN ;
   
 : save-buffer ( buffer -- ) >r  : save-buffer ( buffer -- ) \ gforth
       >r
     r@ buffer-dirty @ r@ buffer-block @ 0<> and      r@ buffer-dirty @ r@ buffer-block @ 0<> and
     if      if
         r@ buffer-block @ block-position          r@ buffer-block @ block-position
         r@ block-buffer chars/block  r@ buffer-fid @  write-file throw          r@ block-buffer chars/block  r@ buffer-fid @  write-file throw
           buffer-fid @ flush-file throw
         r@ buffer-dirty off          r@ buffer-dirty off
     endif      endif
     rdrop ;      rdrop ;
   
 : empty-buffer ( buffer -- )  : empty-buffer ( buffer -- ) \ gforth
     buffer-block off ;      buffer-block off ;
   
 : save-buffers  ( -- )    block-buffers @  : save-buffers  ( -- ) \ block
     buffers 0 ?DO  dup save-buffer  next-buffer  LOOP  drop ;      \G Transfer the contents of each @code{update}d block buffer to
       \G mass storage, then mark all block buffers as assigned-clean.
 : empty-buffers ( -- )    block-buffers @      block-buffers @
     buffers 0 ?DO  dup empty-buffer  next-buffer  LOOP  drop ;      buffers 0 ?DO dup save-buffer next-buffer LOOP drop ;
   
 : flush ( -- )  : empty-buffers ( -- ) \ block-ext
       \G Mark all block buffers as unassigned; if any had been marked as
       \G assigned-dirty (by @code{update}), the changes to those blocks
       \G will be lost.
       block-buffers @
       buffers 0 ?DO dup empty-buffer next-buffer LOOP drop ;
   
   : flush ( -- ) \ block
       \G Perform the functions of @code{save-buffers} then
       \G @code{empty-buffers}.
     save-buffers      save-buffers
     empty-buffers ;      empty-buffers ;
   
 ' flush IS flush-blocks  ' flush IS flush-blocks
   
 : get-buffer ( n -- a-addr )  : get-buffer ( u -- a-addr ) \ gforth
     buffers mod buffer-struct %size * block-buffers @ + ;      0 buffers um/mod drop buffer-struct %size * block-buffers @ + ;
   
 : block ( u -- a-addr )  : block ( u -- a-addr ) \ gforthman- block
     dup 0= -35 and throw      \G If a block buffer is assigned for block @i{u}, return its
       \G start address, @i{a-addr}. Otherwise, assign a block buffer
       \G for block @i{u} (if the assigned block buffer has been
       \G @code{update}d, transfer the contents to mass storage), read
       \G the block into the block buffer and return its start address,
       \G @i{a-addr}.
       dup offset @ u< -35 and throw
     dup get-buffer >r      dup get-buffer >r
     dup r@ buffer-block @ <>      dup r@ buffer-block @ <>
     r@ buffer-fid @ block-fid @ <> or      r@ buffer-fid @ block-fid @ <> or
Line 134  Defer flush-blocks Line 164  Defer flush-blocks
     then      then
     r> dup last-block ! block-buffer ;      r> dup last-block ! block-buffer ;
   
 : buffer ( u -- a-addr )  : buffer ( u -- a-addr ) \ block
       \G If a block buffer is assigned for block @i{u}, return its
       \G start address, @i{a-addr}. Otherwise, assign a block buffer
       \G for block @i{u} (if the assigned block buffer has been
       \G @code{update}d, transfer the contents to mass storage) and
       \G return its start address, @i{a-addr}.  The subtle difference
       \G between @code{buffer} and @code{block} mean that you should
       \G only use @code{buffer} if you don't care about the previous
       \G contents of block @i{u}. In Gforth, this simply calls
       \G @code{block}.
     \ reading in the block is unnecessary, but simpler      \ reading in the block is unnecessary, but simpler
     block ;      block ;
   
 User scr 0 scr !  User scr ( -- a-addr ) \ block-ext s-c-r
       \G @code{User} variable -- @i{a-addr} is the address of a cell containing
 : updated?  ( n -- f )   scr @ buffer      \G the block number of the block most recently processed by
       \G @code{list}.
   0 scr !
   
   \ nac31Mar1999 moved "scr @" to list to make the stack comment correct
   : updated?  ( n -- f ) \ gforth
       \G Return true if @code{updated} has been used to mark block @i{n}
       \G as assigned-dirty.
       buffer
     [ 0 buffer-dirty 0 block-buffer - ] Literal + @ ;      [ 0 buffer-dirty 0 block-buffer - ] Literal + @ ;
   
 : list ( u -- )  : list ( u -- ) \ block-ext
       \G Display block @i{u}. In Gforth, the block is displayed as 16
       \G numbered lines, each of 64 characters.
     \ calling block again and again looks inefficient but is necessary      \ calling block again and again looks inefficient but is necessary
     \ in a multitasking environment      \ in a multitasking environment
     dup scr !      dup scr !
     ." Screen " u.      ." Screen " u.
     updated?  0= IF ." not "  THEN  ." modified     " cr      scr @ updated?  0= IF ." not "  THEN  ." modified     " cr
     16 0      16 0
     ?do      ?do
         i 2 .r space scr @ block i 64 * chars + 64 type cr          i 2 .r space scr @ block i 64 * chars + 64 type cr
     loop ;      loop ;
   
 : (source)  ( -- addr len )  [IFDEF] current-input
   :noname  2 <> -12 and throw >in ! blk ! ;
                                 \ restore-input
   :noname  blk @ >in @ 2 ;      \ save-input
   :noname  2 ;                  \ source-id "*a block*"
   :noname  1 blk +! 1 loadline +! true ;      \ refill
   :noname  blk @ block chars/block ;  \ source
   
   Create block-input   A, A, A, A, A,
   
   : load  ( i*x n -- j*x ) \ block
       \G Save the current input source specification. Store @i{n} in
       \G @code{BLK}, set @code{>IN} to 0 and interpret. When the parse
       \G area is exhausted, restore the input source specification.
       block-input 0 new-tib dup loadline ! blk !  2 loadfilename# !
       ['] interpret catch pop-file throw ;
   [ELSE]
   : (source)  ( -- c-addr u )
   blk @ ?dup    blk @ ?dup
   IF    block chars/block    IF    block chars/block
   ELSE  tib #tib @    ELSE  tib #tib @
   THEN ;    THEN ;
   
 ' (source) IS source  ' (source) IS source ( -- c-addr u ) \ core
   \G @i{c-addr} is the address of the input buffer and @i{u} is the
 : load ( i*x n -- j*x )  \G number of characters in it.
   push-file  
   dup loadline ! blk ! >in off ( ['] ) interpret ( catch )  : load ( i*x n -- j*x ) \ block
   pop-file ( throw ) ;      \G Save the current input source specification. Store @i{n} in
       \G @code{BLK}, set @code{>IN} to 0 and interpret. When the parse
 : thru ( i*x n1 n2 -- j*x )      \G area is exhausted, restore the input source specification.
   1+ swap ?DO  I load  LOOP ;      loadfilename# @ >r
       2 loadfilename# ! \ "*a block*"
 : +load ( i*x n -- j*x )  blk @ + load ;      push-file
       dup loadline ! blk ! >in off ['] interpret catch
 : +thru ( i*x n1 n2 -- j*x )      pop-file
   1+ swap ?DO  I +load  LOOP ;      r> loadfilename# !
       throw ;
 : --> ( -- )  refill drop ; immediate  [THEN]
   
 : block-included ( addr u -- )  : thru ( i*x n1 n2 -- j*x ) \ block-ext
       \G @code{load} the blocks @i{n1} through @i{n2} in sequence.
       1+ swap ?DO  I load  LOOP ;
   
   : +load ( i*x n -- j*x ) \ gforth
       \G Used within a block to load the block specified as the
       \G current block + @i{n}.
       blk @ + load ;
   
   : +thru ( i*x n1 n2 -- j*x ) \ gforth
       \G Used within a block to load the range of blocks specified as the
       \G current block + @i{n1} thru the current block + @i{n2}.
       1+ swap ?DO  I +load  LOOP ;
   
   : --> ( -- ) \ gforthman- gforth chain
       \G If this symbol is encountered whilst loading block @i{n},
       \G discard the remainder of the block and load block @i{n+1}. Used
       \G for chaining multiple blocks together as a single loadable
       \G unit.  Not recommended, because it destroys the independence of
       \G loading.  Use @code{thru} (which is standard) or @code{+thru}
       \G instead.
       refill drop ; immediate
   
   : block-included ( a-addr u -- ) \ gforth
       \G Use within a block that is to be processed by @code{load}. Save
       \G the current blocks file specification, open the blocks file
       \G specified by @i{a-addr u} and @code{load} block 1 from that
       \G file (which may in turn chain or load other blocks). Finally,
       \G close the blocks file and restore the original blocks file.
     block-fid @ >r block-fid off open-blocks      block-fid @ >r block-fid off open-blocks
     1 load block-fid @ close-file throw flush      1 load block-fid @ close-file throw flush
     r> block-fid ! ;      r> block-fid ! ;
Line 192  true constant block Line 286  true constant block
 true constant block-ext  true constant block-ext
 set-current  set-current
   
 : bye  ['] flush catch drop bye ;  : bye ( -- ) \ tools-ext
     \G Return control to the host operating system (if any).
     ['] flush catch drop bye ;

Removed from v.1.17  
changed lines
  Added in v.1.35


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>